Expand description
Fullnode RPC method catalogue.
One {Method}Request + {Method}Response struct pair per method. The
catalogue follows the table in
dig-network/docs/resources/02-subsystems/08-binaries/supplement/02-rpc-method-matrix.md.
Method classification:
| Class | Examples | Role requirement |
|---|---|---|
| Blockchain state | get_blockchain_state, get_network_info, healthz | Explorer+ |
| Blocks | get_block, get_block_by_height, get_block_records | Explorer+ |
| Coins | get_coin_record, get_coin_records_by_hint, get_coin_records_by_puzzle_hash | Explorer+ |
| Mempool | get_mempool, push_tx | Explorer+ (read), Admin (write) |
| Peers | get_connections, ban_peer | Admin |
| Checkpoint | submit_partial_checkpoint_signature, get_checkpoint_pool | Validator |
| Validator set | get_validator, get_active_validators, get_current_proposer | Explorer+ |
| Admin | stop_node, get_recovery_status, get_version | Admin |
§Method name convention
Method names on the JSON-RPC wire are snake_case strings, declared via
the associated METHOD constant on each request struct. Request / response
struct names follow PascalCase of the method with Request / Response
suffixes — GetBlockchainStateRequest etc.
Structs§
- BanPeer
Request ban_peer— evict and ban a peer.- BanPeer
Response - Response for
BanPeerRequest. - Block
Full - Full block envelope used by
get_block*responses. - Block
Header Wire - Block header in wire form.
- Checkpoint
Epoch Status - Per-epoch aggregation status.
- Coin
Record Wire - Coin record in wire form.
- GetActive
Validators Request get_active_validators— page through the current active set.- GetActive
Validators Response - Response for
GetActiveValidatorsRequest. - GetBlock
ByHeight Request get_block_by_height— fetch a full canonical block by height.- GetBlock
ByHeight Response - Response for
GetBlockByHeightRequest.Nonemeans out-of-range. - GetBlock
Records Request get_block_records— compact summaries of a contiguous height range.- GetBlock
Records Response - Response for
GetBlockRecordsRequest.records.len()may be less thancountat the chain tip. - GetBlock
Request get_block— fetch a full block by hash.- GetBlock
Response - Response for
GetBlockRequest.Nonemeans not found. - GetBlockchain
State Request get_blockchain_state— overall chain state.- GetBlockchain
State Response - Response for
GetBlockchainStateRequest. - GetCheckpoint
Pool Request get_checkpoint_pool— status of the checkpoint aggregation pool.- GetCheckpoint
Pool Response - Response for
GetCheckpointPoolRequest. - GetCoin
Record Request get_coin_record— fetch a single coin record by coin id.- GetCoin
Record Response - Response for
GetCoinRecordRequest.Nonemeans not found. - GetCoin
Records ByHint Request get_coin_records_by_hint— look up coins by CLVM hint.- GetCoin
Records ByHint Response - Response for
GetCoinRecordsByHintRequest. - GetCoin
Records ByPuzzle Hash Request get_coin_records_by_puzzle_hash— look up coins owned by a puzzle.- GetCoin
Records ByPuzzle Hash Response - Response for
GetCoinRecordsByPuzzleHashRequest. - GetConnections
Request get_connections— enumerate connected peers.- GetConnections
Response - Response for
GetConnectionsRequest. - GetCurrent
Proposer Request get_current_proposer— who is elected proposer at a height.- GetCurrent
Proposer Response - Response for
GetCurrentProposerRequest. - GetMempool
Request get_mempool— summary of pending transactions.- GetMempool
Response - Response for
GetMempoolRequest. - GetNetwork
Info Request get_network_info— genesis / network identity.- GetNetwork
Info Response - Response for
GetNetworkInfoRequest. - GetRecovery
Status Request get_recovery_status— fullnode recovery-journal state.- GetRecovery
Status Response - Response for
GetRecoveryStatusRequest. - GetValidator
Request get_validator— look up a validator by pubkey.- GetValidator
Response - Response for
GetValidatorRequest.Noneif no such validator. - GetVersion
Request get_version— binary identification.- GetVersion
Response - Response for
GetVersionRequest. - Healthz
Request healthz— liveness probe.- Healthz
Response - Response for
HealthzRequest. - Mempool
Item - One entry in the mempool summary.
- Peer
Info Wire - Peer info in wire form.
- Push
TxRequest push_tx— submit a spend bundle to the mempool.- Push
TxResponse - Response for
PushTxRequest. - Stop
Node Request stop_node— request a graceful shutdown.- Stop
Node Response - Response for
StopNodeRequest. - Submit
Partial Checkpoint Signature Request submit_partial_checkpoint_signature— validator submits a partial sig for the current epoch.- Submit
Partial Checkpoint Signature Response - Response for
SubmitPartialCheckpointSignatureRequest.
Enums§
- Push
TxStatus - Admission outcome of
PushTxRequest. - Recovery
Mode - Recovery state machine values.