πŸ”ŒRPC

This file defines the JSON-RPC spec of CometBFT vs Landslide SDK. This is meant to be implemented by all clients.

βœ…

βœ…

βœ…

βœ…

NetInfo

βœ…

❌

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

❌

βœ…

❌

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

βœ…

BroadcastEvidence

βœ…

❌

Info Routes


Health

Node heartbeat

Parameters

None

Request

JSONRPC

Response

Status

Get CometBFT status including node info, pubkey, latest block hash, app hash, block height and time.

Parameters

None

Request

JSONRPC

Response

Blockchain

Get block headers. Returned in descending order. May be limited in quantity.

Parameters

  • minHeight (integer): The lowest block to be returned in the response

  • maxHeight (integer): The highest block to be returned in the response

Request

JSONRPC

Response

Block

Get block at a specified height.

Parameters

  • height (integer): height of the requested block. If no height is specified the latest block will be used.

Request

JSONRPC

Response

BlockByHash

Parameters

  • hash (string): Hash of the block to query for.

Request

JSONRPC

Response

BlockResults

Parameters

  • height (integer): Height of the block which contains the results. If no height is specified, the latest block height will be used

Request

JSONRPC

Response

Commit

Parameters

  • height (integer): Height of the block the requested commit pertains to. If no height is set the latest commit will be returned.

Request

JSONRPC

Response

Validators

Parameters

  • height (integer): Block height at which the validators were present on. If no height is set the latest commit will be returned.

  • page (integer):

  • per_page (integer):

Request

JSONRPC

Response

Genesis

Get Genesis of the chain. If the response is large, this operation will return an error: use genesis_chunked instead.

Request

JSONRPC

Response

GenesisChunked

Get the genesis document in a chunks to support easily transferring larger documents.

Parameters

  • chunk (integer): the index number of the chunk that you wish to fetch. These IDs are 0 indexed.

Request

JSONRPC

Response

ConsensusParams

Get the consensus parameters.

Parameters

  • height (integer): Block height at which the consensus params would like to be fetched for.

Request

JSONRPC

Response

UnconfirmedTxs

Get a list of unconfirmed transactions.

Parameters

  • limit (integer) The amount of txs to respond with.

Request

JSONRPC

Response

NumUnconfirmedTxs

Get data about unconfirmed transactions.

Parameters

None

Request

JSONRPC

Response

Tx

Parameters

  • hash (string): The hash of the transaction

  • prove (bool): If the response should include proof the transaction was included in a block.

Request

JSONRPC

Response

TxSearch

Searches for transactions based on a query condition. Returns matching transactions along with their details.

Parameters

  • query (string): The query condition for searching transactions (e.g., "tx.height=1").

  • prove (boolean): Indicates whether to include proof data for each transaction.

  • page (string): The page number for paginated results.

  • per_page (string): The number of transactions to show per page.

  • order_by (string): Specifies the sort order ("asc" or "desc").

Request

JSONRPC

Response

BlockSearch

Searches for blocks based on a query condition. Returns matching blocks along with their details.

Parameters

  • query (string): The query condition for searching blocks (e.g., "block.height > 1").

  • page (string): The page number for paginated results.

  • per_page (string): The number of blocks to show per page.

  • order_by (string): Specifies the sort order ("asc" or "desc").

Request

JSONRPC

Response

Transaction Routes


BroadCastTxSync

Returns with the response from CheckTx. Does not wait for DeliverTx result.

Parameters

  • tx (string): The transaction encoded

Request

JSONRPC

Response

BroadCastTxAsync

Returns right away, with no response. Does not wait for CheckTx nor DeliverTx results.

Parameters

  • tx (string): The transaction encoded

Request

JSONRPC

Response

CheckTx

Checks the transaction without executing it.

Parameters

  • tx (string): String of the encoded transaction

Request

JSONRPC

Response

ABCI Routes


ABCIInfo

Get some info about the application.

Parameters

None

Request

JSONRPC

Response

ABCIQuery

Query the application for some information.

Parameters

  • path (string): A request path for the application to interpret analogously to a URI path component in e.g. routing.

  • data (string): Request parameters for the application to interpret analogously to a URI query component, expressed as hexadecimal-serialized bytes (convert WasmApp to hex is 5761736d417070).

  • height (integer): The block height against which to query.

  • prove (bool): Return Merkle proof with response if possible.

Request

JSONRPC

Response

Last updated

Was this helpful?