package rpc
Get desktop application:
View/edit binary Protocol Buffers messages
service Api
rpc.proto:16RPC API for the RPC component
rpc BlockSubscription (, stream )
rpc.proto:92Streams committed blocks starting from the given block number (inclusive). Replays historical blocks first, then streams live blocks as they are committed. On lag (replica falls too far behind), the stream is closed with a DATA_LOSS error and the client should reconnect from its local tip.
message
rpc.proto:117Request to subscribe to the committed block stream.
fixed32 block_from = 1
The block number to start streaming from (inclusive).
message
rpc.proto:123A committed block streamed to a replica.
bytes block = 1
The block encoded using [miden_serde_utils::Serializable] implementation for [miden_protocol::block::SignedBlock].
fixed32 committed_chain_tip = 2
The committed chain tip when this item was emitted.
rpc GetAccount (, )
rpc.proto:28Returns the latest details of the specified account.
message
rpc.proto:244Defines the request for account details.
optional account_id = 1
ID of the account for which we want to get data
optional block_num = 2
Optional block height at which to return the proof. Defaults to current chain tip if unspecified.
optional details = 3
Request for additional account details; valid only for public accounts.
message
rpc.proto:312Represents the result of getting account proof.
optional block_num = 1
The block number at which the account witness was created and the account details were observed.
optional witness = 2
Account ID, current state commitment, and SMT path.
optional details = 3
Additional details for public accounts.
rpc GetBlockByNumber (, )
rpc.proto:31Returns raw block data for the specified block number, optionally including the block proof.
rpc GetBlockHeaderByNumber (, )
rpc.proto:35Retrieves block header by given block number. Optionally, it also returns the MMR path and current chain length to authenticate the block's inclusion.
message
rpc.proto:212Returns the block header corresponding to the requested block number, as well as the merkle path and current forest which validate the block's inclusion in the chain. The Merkle path is an MMR proof for the block's leaf, based on the current chain length.
optional uint32 block_num = 1
The target block height, defaults to latest if not provided.
optional bool include_mmr_proof = 2
Whether or not to return authentication data for the block header.
message
rpc.proto:220Represents the result of getting a block header by block number.
optional block_header = 1
The requested block header.
optional mmr_path = 2
Merkle path to verify the block's inclusion in the MMR at the returned `chain_length`.
optional fixed32 chain_length = 3
Current chain length.
rpc GetLimits (, )
rpc.proto:25Returns the query parameter limits configured for RPC methods. These define the maximum number of each parameter a method will accept. Exceeding the limit will result in the request being rejected and you should instead send multiple smaller requests.
message
rpc.proto:710Represents the query parameter limits for RPC endpoints.
map<string, > endpoints = 1
Maps RPC endpoint names to their parameter limits. Key: endpoint name (e.g., "SyncNullifiers") Value: map of parameter names to their limit values
rpc GetNetworkNoteStatus (, )
rpc.proto:110Returns the current status of a network note. The status indicates where the note is in its lifecycle: pending execution, processed (consumed by a transaction in the mempool), or discarded after too many failed attempts. Returns `NOT_FOUND` if the note ID is not tracked by the network transaction builder.
rpc GetNoteScriptByRoot (, )
rpc.proto:41Returns the script for a note by its root.
message
rpc.proto:235Represents a note script or nothing.
optional script = 1
The script for a note by its root.
rpc GetNotesById (, )
rpc.proto:38Returns a list of notes matching the provided note IDs.
rpc ProofSubscription (, stream )
rpc.proto:98Streams block proofs starting from the given block number (inclusive). Replays existing proofs first, then streams new proofs as they are generated. On lag, the stream is closed with a DATA_LOSS error.
message
rpc.proto:136Request to subscribe to the block proof stream.
fixed32 block_from = 1
The block number to start streaming from (inclusive).
message
rpc.proto:142A block proof streamed to a replica.
fixed32 block_num = 1
The block number this proof corresponds to.
bytes proof = 2
The block proof encoded using [miden_serde_utils::Serializable] implementation for [miden_protocol::block::BlockProof].
fixed32 proven_chain_tip = 3
The proven chain tip when this item was emitted.
rpc Status (, )
rpc.proto:18Returns the status info of the node.
message
rpc.proto:158Represents the status of the node.
string version = 1
The rpc component's running version.
optional genesis_commitment = 2
The genesis commitment.
fixed32 chain_tip = 3
Number of the latest block in the chain.
optional block_producer = 4
The block producer status.
rpc SubmitProvenTx (, )
rpc.proto:47Submits proven transaction to the Miden network. Returns the node's current block height.
rpc SubmitProvenTxBatch (, )
rpc.proto:54Submits a batch of transactions to the Miden network. All transactions in this batch will be considered atomic, and be committed together or not all. Returns the node's current block height.
rpc SyncAccountStorageMaps (, )
rpc.proto:82Returns storage map updates for specified account and storage slots within a block range.
message
rpc.proto:568Storage map synchronization request. Allows requesters to sync storage map values for specific public accounts within a block range, with support for cursor-based pagination to handle large storage maps.
optional block_range = 1
Block range from which to start synchronizing. If the `block_to` is specified, this block must be close to the chain tip (i.e., within 30 blocks), otherwise an error will be returned.
optional account_id = 3
Account for which we want to sync storage maps.
message
rpc.proto:579optional pagination_info = 1
Pagination information.
repeated updates = 2
The list of storage map updates. Multiple updates can be returned for a single slot index and key combination, and the one with a higher `block_num` is expected to be retained by the caller.
rpc SyncAccountVault (, )
rpc.proto:79Returns account vault updates for specified account within a block range.
message
rpc.proto:442Account vault synchronization request. Allows requesters to sync asset values for specific public accounts within a block range.
optional block_range = 1
Block range from which to start synchronizing. If the `block_to` is specified, this block must be close to the chain tip (i.e., within 30 blocks), otherwise an error will be returned.
optional account_id = 2
Account for which we want to sync asset vault.
message
rpc.proto:453optional pagination_info = 1
Pagination information.
repeated updates = 2
List of asset updates for the account. Multiple updates can be returned for a single asset, and the one with a higher `block_num` is expected to be retained by the caller.
rpc SyncChainMmr (, )
rpc.proto:85Returns MMR delta needed to synchronize the chain MMR within the requested block range.
message
rpc.proto:536Chain MMR synchronization request.
fixed32 current_client_block_height = 1
Block number from which to synchronize. Set this to the last block already present in the caller's MMR so the delta begins at the next block.
FinalityLevel finality_level = 2
Sync target: either the committed or the proven tip.
message
rpc.proto:546Represents the result of syncing chain MMR.
optional block_range = 1
For which block range the MMR delta is returned.
optional mmr_delta = 2
Data needed to update the partial MMR from `request.current_client_block_height + 1` to the sync target.
optional block_header = 3
Block header for the sync target.
optional block_signature = 4
Validator signature for the sync target.
rpc SyncNotes (, )
rpc.proto:71Returns info which can be used by the client to sync up to the tip of chain for the notes they are interested in. Client specifies the `note_tags` they are interested in, and the block range to search. The response contains all blocks with matching notes that fit within the response payload limit, along with each note's metadata and inclusion proof. If `response.pagination_info.block_num` is less than the requested range end, make another request starting from `response.pagination_info.block_num + 1` to continue syncing.
message
rpc.proto:484Note synchronization request. Specifies note tags that the requester is interested in. The server will return blocks containing notes matching `note_tags` within the specified block range, batching as many blocks as fit within the response payload limit.
optional block_range = 1
Block range from which to start synchronizing.
repeated fixed32 note_tags = 2
Specifies the tags which the requester is interested in.
message
rpc.proto:493Represents the result of syncing notes request.
optional pagination_info = 1
Pagination information. `chain_tip` is the current chain tip. `block_num` is the last block checked. If it equals the requested `block_to` (or the chain tip when unset), the sync is complete. Otherwise the response was paginated and the client should resume from `block_num + 1`.
repeated blocks = 2
Blocks containing matching notes, ordered by block number ascending. May be empty if no notes matched in the range.
rpc SyncNullifiers (, )
rpc.proto:76Returns a list of nullifiers that match the specified prefixes and are recorded in the node. Note that only 16-bit prefixes are supported at this time.
message
rpc.proto:406Returns a list of nullifiers that match the specified prefixes and are recorded in the node.
optional block_range = 1
Block number from which the nullifiers are requested (inclusive).
uint32 prefix_len = 2
Number of bits used for nullifier prefix. Currently the only supported value is 16.
repeated uint32 nullifiers = 3
List of nullifiers to check. Each nullifier is specified by its prefix with length equal to `prefix_len`.
message
rpc.proto:419Represents the result of syncing nullifiers.
optional pagination_info = 1
Pagination information.
repeated nullifiers = 2
List of nullifiers matching the prefixes specified in the request.
rpc SyncTransactions (, )
rpc.proto:60Returns transactions records for specific accounts within a block range.
message
rpc.proto:646Transactions synchronization request. Allows requesters to sync transactions for specific accounts within a block range.
optional block_range = 1
Block range from which to start synchronizing.
repeated account_ids = 2
Accounts to sync transactions for.
message
rpc.proto:655Represents the result of syncing transactions request.
optional pagination_info = 1
Pagination information.
repeated transactions = 2
List of transaction records.
message
rpc.proto:246Request the details for a public account.
Used in:
optional code_commitment = 1
Last known code commitment to the requester. The response will include account code only if its commitment is different from this value. If the field is ommiteed, the response will not include the account code.
optional asset_vault_commitment = 2
Last known asset vault commitment to the requester. The response will include asset vault data only if its commitment is different from this value. If the value is not present in the request, the response will not contain one either. If the number of to-be-returned asset entries exceed a threshold, they have to be requested separately, which is signaled in the response message with dedicated flag.
oneof storage_request
bool all_storage_maps = 3
Request all entries for all storage map slots in the account. Each map response is still capped independently. If a map exceeds the entry threshold, the response will set `too_many_entries` for that map and clients should use `SyncAccountStorageMaps` to fetch it.
storage_maps = 4
Request details for explicitly selected storage map slots.
message
rpc.proto:248Represents a storage slot index and the associated map keys.
Used in:
string slot_name = 1
Storage slot name.
oneof slot_data
bool all_entries = 2
Request to return all storage map data. If the number exceeds a threshold of 1000 entries, the response will not contain them but must be requested separately.
map_keys = 3
A list of map keys associated with the given storage slot identified by `slot_name`.
message
rpc.proto:250Indirection required for use in `oneof {..}` block.
Used in:
repeated map_keys = 1
A list of map keys associated with this storage slot.
message
rpc.proto:281Wrapper required because protobuf `oneof` fields cannot be `repeated`.
Used in:
repeated storage_maps = 1
Additional request per storage map.
message
rpc.proto:313Used in:
optional header = 1
Account header.
optional storage_details = 2
Account storage data
optional bytes code = 3
Account code; empty if code commitments matched or none was requested.
optional vault_details = 4
Account asset vault data; empty if vault commitments matched or the requester omitted it in the request.
message
rpc.proto:351Account storage details for AccountResponse
Used in:
optional header = 1
Account storage header (storage slot info for up to 256 slots)
repeated map_details = 2
Additional data for the requested storage maps
message
rpc.proto:352Used in:
string slot_name = 1
Storage slot name.
bool too_many_entries = 2
True when the number of entries exceeds the response limit. When set, clients should use the `SyncAccountStorageMaps` endpoint.
oneof entries
The map entries (with or without proofs). Empty when too_many_entries is true.
all_entries = 3
All storage entries without proofs (for small maps or full requests).
entries_with_proofs = 4
Specific entries with their SMT proofs (for partial requests).
message
rpc.proto:368Wrapper for repeated storage map entries (without proofs). Used when all entries are requested for small maps.
Used in:
repeated entries = 1
message
rpc.proto:370Definition of individual storage entries.
Used in:
optional key = 1
optional value = 2
message
rpc.proto:355Wrapper for repeated storage map entries including their proofs. Used when specific keys are requested to enable client-side verification.
Used in:
repeated entries = 1
message
rpc.proto:357Definition of individual storage entries including a proof.
Used in:
optional key = 1
optional value = 2
optional proof = 3
message
rpc.proto:339Account vault details for AccountResponse
Used in:
bool too_many_assets = 1
A flag that is set to true if the account contains too many assets. This indicates to the user that `SyncAccountVault` endpoint should be used to retrieve the account's assets
repeated assets = 2
When too_many_assets == false, this will contain the list of assets in the account's vault
message
rpc.proto:464Used in:
optional vault_key = 1
Vault key associated with the asset.
optional asset = 2
Asset value related to the vault key. If not present, the asset was removed from the vault.
fixed32 block_num = 3
Block number at which the above asset was updated in the account vault.
message
rpc.proto:176Represents the status of the block producer.
Used in:
string version = 1
The block producer's running version.
string status = 2
The block producer's status.
fixed32 chain_tip = 4
The block producer's current view of the chain tip height. This is the height of the latest block that the block producer considers to be part of the canonical chain.
optional mempool_stats = 3
Statistics about the mempool.
message
rpc.proto:609Represents a block range.
Used in: , , , , ,
fixed32 block_from = 1
Block number from which to start (inclusive).
fixed32 block_to = 2
Block number up to which to check (inclusive).
message
rpc.proto:718Represents the parameter limits for a single endpoint.
Used in:
map<string, uint32> parameters = 1
Maps parameter names to their limit values. Key: parameter name (e.g., "nullifier", "account_id") Value: limit value
Finality level we'd like to sync up to.
Used in:
FINALITY_LEVEL_UNSPECIFIED = 0
FINALITY_LEVEL_COMMITTED = 1
Sync up to the latest committed block (chain tip).
FINALITY_LEVEL_PROVEN = 2
Sync up to the latest proven block.
message
rpc.proto:695Response containing the lifecycle status and latest execution error for a network note.
Used as response type in: ntx_builder.Api.GetNetworkNoteStatus, Api.GetNetworkNoteStatus
NetworkNoteStatus status = 1
Current lifecycle status of the note.
optional string last_error = 2
The latest error message from execution, if any.
uint32 attempt_count = 3
Number of failed execution attempts.
optional fixed32 last_attempt_block_num = 4
Block number of the last failed attempt, if any.
message
rpc.proto:194Statistics about the mempool.
Used in:
uint64 unbatched_transactions = 1
Number of transactions currently in the mempool waiting to be batched.
uint64 proposed_batches = 2
Number of batches currently being proven.
uint64 proven_batches = 3
Number of proven batches waiting for block inclusion.
Lifecycle status of a network note within the transaction builder.
Used in:
NETWORK_NOTE_STATUS_UNSPECIFIED = 0
Default / unspecified status.
NETWORK_NOTE_STATUS_PENDING = 1
The note is awaiting execution or being retried after transient failures.
NETWORK_NOTE_STATUS_NULLIFIER_INFLIGHT = 2
The note has been consumed by a transaction that was sent to the block producer.
NETWORK_NOTE_STATUS_DISCARDED = 3
The note exceeded the maximum retry count and will not be retried.
NETWORK_NOTE_STATUS_NULLIFIER_COMMITTED = 4
The note's consuming transaction has been committed on-chain.
message
rpc.proto:628Represents pagination information for chunked responses. Pagination is done using block numbers as the axis, allowing requesters to request data in chunks by specifying block ranges and continuing from where the previous response left off. To request the next chunk, the requester should use `block_num + 1` from the previous response as the `block_from` for the next request.
Used in: , , , ,
fixed32 chain_tip = 1
Current chain tip
fixed32 block_num = 2
The block number of the last check included in this response. For chunked responses, this may be less than `request.block_range.block_to`. If it is less than request.block_range.block_to, the user is expected to make a subsequent request starting from the next block to this one (ie, request.block_range.block_from = block_num + 1).
message
rpc.proto:591Represents a single storage map update.
Used in:
fixed32 block_num = 1
Block number in which the slot was updated.
string slot_name = 2
Storage slot name.
optional key = 3
The storage map key.
optional value = 4
The storage map value.
message
rpc.proto:495A single block's worth of note sync data.
Used in:
optional block_header = 1
Block header of the block containing the matching notes.
optional mmr_path = 2
Merkle path to verify the block's inclusion in the MMR. The proof is valid for an MMR of forest `N + 1`, where `N` is the requested `block_range.block_to` (or the chain tip if `block_to` was not specified).
repeated notes = 3
List of notes matching the specified criteria in this block, together with the Merkle paths from `block_header.note_root`.
message
rpc.proto:421Represents a single nullifier update.
Used in:
optional nullifier = 1
Nullifier ID.
fixed32 block_num = 2
Block number.
message
rpc.proto:664Represents a transaction record.
Used in:
fixed32 block_num = 1
Block number in which the transaction was included.
optional header = 2
The transaction header.
repeated output_note_proofs = 3
Inclusion proofs for committed output notes. Erased notes (created and consumed within the same batch) can be identified by comparing note IDs here with `header.output_notes`. Any note present in the header but absent here was erased.