Skip to content

Commit a3253eb

Browse files
authored
Merge pull request #7 from eosrio/docs/hot-first-actions
docs(api): hot_first_actions / hot_first_window + hot_only for get_actions
2 parents d9939e6 + 9bdc776 commit a3253eb

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

docs/api/v2.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,9 @@ Get past actions based on notified account.
6262
| after | query | Filter actions after specified date (ISO8601) | No | string |
6363
| before | query | Filter actions before specified date (ISO8601) | No | string |
6464
| simple | query | Simplified output mode | No | boolean |
65-
| noBinary | query | exclude large binary data | No | boolean
66-
| checkLib | query | perform reversibility check | No | boolean
65+
| noBinary | query | exclude large binary data | No | boolean |
66+
| checkLib | query | perform reversibility check | No | boolean |
67+
| hot_only | query | Search only the newest action partition(s) instead of the full history. Useful for fetching the latest actions without fanning out across old shards | No | boolean |
6768

6869

6970
!!! note

docs/providers/setup/chain.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ with its default value and an example of real usage.
2121
- `"get_links": 1000`
2222
- `"get_deltas": 1000`
2323
- `"access_log": false` ⇒ Enable log API access.
24+
- `"hot_first_actions": false` ⇒ When enabled, an unbounded newest-first `get_actions` account poll (e.g. `?account=eosio.token&sort=desc`, no `before`/`after`, no pagination) searches only the most recent action partition(s) first, widening to the full index set **only** if that window returns fewer than `limit` hits. Keeps high-frequency polling for the latest actions off the older/warm shards. Default off; safe to enable without reindexing. *(Note: while a poll is served from the hot window, the response `total` reflects that window only.)*
25+
- `"hot_first_window": 2` ⇒ Number of newest action partitions searched in the hot window when `hot_first_actions` is enabled. Default `2` (covers the live partition plus the previous one across a rollover).
2426
- `"explorer"` ⇒ Explorer configuration (see [Explorer Setup](../explorer.md))
2527
- `"upstream": "http://127.0.0.1:4777"` ⇒ URL of the Explorer SSR server
2628
- `"theme": "default"` ⇒ Theme name (matches `<name>.theme.mjs` in explorer/themes/)
@@ -159,6 +161,8 @@ to `chains/eos.config.json`. The next step is to edit the file as the following:
159161
"get_deltas": 1000
160162
},
161163
"access_log": false,
164+
"hot_first_actions": false,
165+
"hot_first_window": 2,
162166
"explorer": {
163167
"upstream": "http://127.0.0.1:4777",
164168
"theme": "default",

0 commit comments

Comments
 (0)