Contains the code defining the Miden node's RPC component. This component serves the user-facing gRPC methods used to submit transactions and sync with the state of the network.
This is the only set of node RPC methods intended to be publicly available.
For more information on the installation and operation of this component, please see the node's readme.
The full gRPC method definitions can be found in the rpc-proto crate.
- CheckNullifiers
- CheckNullifiersByPrefix
- GetAccountDetails
- GetAccountProofs
- GetAccountStateDelta
- GetBlockByNumber
- GetBlockHeaderByNumber
- GetNotesById
- SubmitProvenTransaction
- SyncNotes
- SyncState
Returns a nullifier proof for each of the requested nullifiers.
Returns a list of nullifiers that match the specified prefixes and are recorded in the node.
Only 16-bit prefixes are supported at this time.
Returns the latest state of an account with the specified ID.
Returns the latest state proofs of the specified accounts.
Returns delta of the account states in the range from from_block_num (exclusive) to to_block_num (inclusive).
Returns raw block data for the specified block number.
Retrieves block header by given block number. Optionally, it also returns the MMR path and current chain length to authenticate the block's inclusion.
Returns a list of notes matching the provided note IDs.
Submits proven transaction to the Miden network.
Returns 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 height from which to search for new for matching
notes for. The request will then return the next block containing any note matching the provided tags.
The response includes each note's metadata and inclusion proof.
A basic note sync can be implemented by repeatedly requesting the previous response's block until reaching the tip of the chain.
Returns info which can be used by the client to sync up to the latest state of the chain for the objects (accounts, notes, nullifiers) the client is interested in.
This request returns the next block containing requested data. It also returns chain_tip which is the latest block
number in the chain. Client is expected to repeat these requests in a loop until
response.block_header.block_num == response.chain_tip, at which point the client is fully synchronized with the chain.
Each request also returns info about new notes, nullifiers etc. created. It also returns Chain MMR delta that can be used to update the state of Chain MMR. This includes both chain MMR peaks and chain MMR nodes.
For preserving some degree of privacy, note tags and nullifiers filters contain only high part of hashes. Thus, returned data contains excessive notes and nullifiers, client can make additional filtering of that data on its side.
This project is MIT licensed.