Skip to content

Commit

Permalink
Update rpc-protocol.md with populate_backlog command
Browse files Browse the repository at this point in the history
Adding populate_backlog rpc command documentation, per nanocurrency/nano-node#3860
  • Loading branch information
qwahzi authored Jan 24, 2023
1 parent 25a72fc commit 7cb1cfb
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/commands/rpc-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -1835,6 +1835,25 @@ Deprecated in V23.0+. Replaced by [receivable_exists](#receivable_exists)

---

### populate_backlog

Scans all accounts, checks for unconfirmed blocks in account chains, and then queues those blocks for confirmation via the election scheduler. Useful for local test networks, where default backlog population is done in 5 minute intervals.

**Request**
```json
{
"action": "populate_backlog"
}
```
**Response**
```json
{
"success": ""
}
```

---

### process
Publish **block** to the network. Using the optional `json_block` is recommended since v19.0. In v20.0-v21.3, blocks are watched for confirmation by default (see optional `watch_work`). If `enable_control` is not set to `true` on the node, then the optional `watch_work` must be set to `false`. In V22.0+ the work watcher has been removed.

Expand Down Expand Up @@ -1892,7 +1911,6 @@ Boolean, default "true". If "true", **block** will be placed on watch for confir
_version 22.0+_
Boolean, default "false". If "true", requests will add the blocks to the block processor queue and `{"started":"1"}` will be immediately returned, instead of waiting for block process completion to return. To know if the block was properly processed, monitor the [WebSocket topic `new_unconfirmed_block`](../integration-guides/websockets.md#new-unconfirmed-blocks) and a notification for that successful block will be sent.


---

### receivable
Expand Down

0 comments on commit 7cb1cfb

Please # to comment.