Struct GrpcClient 

pub struct GrpcClient { /* private fields */ }

Available on crate feature tonic only.

Client for the Node RPC API using gRPC.

If the tonic feature is enabled, this client will use a tonic::transport::Channel to communicate with the node. In this case the connection will be established lazily when the first request is made. If the web-tonic feature is enabled, this client will use a tonic_web_wasm_client::Client to communicate with the node.

In both cases, the GrpcClient depends on the types inside the generated module, which are generated by the build script and also depend on the target architecture.

Implementations

impl GrpcClient

pub fn new(endpoint: &Endpoint, timeout_ms: u64) -> GrpcClient

Returns a new instance of GrpcClient that’ll do calls to the provided Endpoint with the given timeout in milliseconds.

pub async fn fetch_full_account_proof( &self, account_id: AccountId, ) -> Result<(BlockNumber, AccountProof), RpcError>

Given an AccountId, return the proof for the account.

If the account also has public state, its details will also be retrieved

Trait Implementations

impl NodeRpcClient for GrpcClient

fn set_genesis_commitment<'life0, 'async_trait>( &'life0 self, commitment: Word, ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets the genesis commitment for the client. If the client is already connected, it will be updated to use the new commitment on subsequent requests. If the client is not connected, the commitment will be stored and used when the client connects. If the genesis commitment is already set, this method does nothing.

fn sync_state<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, block_num: BlockNumber, account_ids: &'life1 [AccountId], note_tags: &'life2 BTreeSet<NoteTag>, ) -> Pin<Box<dyn Future<Output = Result<StateSyncInfo, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Sends a sync state request to the Miden node, validates and converts the response into a StateSyncInfo struct.

fn get_account_details<'life0, 'async_trait>( &'life0 self, account_id: AccountId, ) -> Pin<Box<dyn Future<Output = Result<FetchedAccount, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a GetAccountDetailsRequest to the Miden node, and extracts an FetchedAccount from the GetAccountDetailsResponse response.

Errors

This function will return an error if:

• There was an error sending the request to the node.
• The answer had a None for one of the expected fields (account, summary, account_commitment, details).
• There is an error during Account deserialization.

fn get_account<'life0, 'async_trait>( &'life0 self, foreign_account: ForeignAccount, account_state: AccountStateAt, known_account_code: Option<AccountCode>, ) -> Pin<Box<dyn Future<Output = Result<(BlockNumber, AccountProof), RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a GetAccountProof request to the Miden node, and extracts the AccountProof from the response, as well as the block number that it was retrieved for.

Errors

This function will return an error if:

• The requested Account isn’t returned by the node.
• There was an error sending the request to the node.
• The answer had a None for one of the expected fields.
• There is an error during storage deserialization.

fn sync_notes<'life0, 'life1, 'async_trait>( &'life0 self, block_num: BlockNumber, block_to: Option<BlockNumber>, note_tags: &'life1 BTreeSet<NoteTag>, ) -> Pin<Box<dyn Future<Output = Result<NoteSyncInfo, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a SyncNoteRequest to the Miden node, and extracts a NoteSyncInfo from the response.

fn submit_proven_transaction<'life0, 'async_trait>( &'life0 self, proven_transaction: ProvenTransaction, transaction_inputs: TransactionInputs, ) -> Pin<Box<dyn Future<Output = Result<BlockNumber, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Given a Proven Transaction, send it to the node for it to be included in a future block using the /SubmitProvenTransaction RPC endpoint.

fn get_block_header_by_number<'life0, 'async_trait>( &'life0 self, block_num: Option<BlockNumber>, include_mmr_proof: bool, ) -> Pin<Box<dyn Future<Output = Result<(BlockHeader, Option<MmrProof>), RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Given a block number, fetches the block header corresponding to that height from the node using the /GetBlockHeaderByNumber endpoint. If include_mmr_proof is set to true and the function returns an Ok, the second value of the return tuple should always be Some(MmrProof).

fn get_notes_by_id<'life0, 'life1, 'async_trait>( &'life0 self, note_ids: &'life1 [NoteId], ) -> Pin<Box<dyn Future<Output = Result<Vec<FetchedNote>, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetches note-related data for a list of NoteId using the /GetNotesById RPC endpoint.

fn sync_nullifiers<'life0, 'life1, 'async_trait>( &'life0 self, prefixes: &'life1 [u16], block_num: BlockNumber, block_to: Option<BlockNumber>, ) -> Pin<Box<dyn Future<Output = Result<Vec<NullifierUpdate>, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetches the nullifiers corresponding to a list of prefixes using the /SyncNullifiers RPC endpoint.

fn check_nullifiers<'life0, 'life1, 'async_trait>( &'life0 self, nullifiers: &'life1 [Nullifier], ) -> Pin<Box<dyn Future<Output = Result<Vec<SmtProof>, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetches the nullifier proofs corresponding to a list of nullifiers using the /CheckNullifiers RPC endpoint.

fn get_block_by_number<'life0, 'async_trait>( &'life0 self, block_num: BlockNumber, ) -> Pin<Box<dyn Future<Output = Result<ProvenBlock, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Given a block number, fetches the block corresponding to that height from the node using the /GetBlockByNumber RPC endpoint.

fn get_note_script_by_root<'life0, 'async_trait>( &'life0 self, root: Word, ) -> Pin<Box<dyn Future<Output = Result<NoteScript, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches the note script with the specified root.

fn sync_storage_maps<'life0, 'async_trait>( &'life0 self, block_from: BlockNumber, block_to: Option<BlockNumber>, account_id: AccountId, ) -> Pin<Box<dyn Future<Output = Result<StorageMapInfo, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches storage map updates for specified account and storage slots within a block range, using the /SyncStorageMaps RPC endpoint.

fn sync_account_vault<'life0, 'async_trait>( &'life0 self, block_from: BlockNumber, block_to: Option<BlockNumber>, account_id: AccountId, ) -> Pin<Box<dyn Future<Output = Result<AccountVaultInfo, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches account vault updates for specified account within a block range, using the /SyncAccountVault RPC endpoint.

fn sync_transactions<'life0, 'async_trait>( &'life0 self, block_from: BlockNumber, block_to: Option<BlockNumber>, account_ids: Vec<AccountId>, ) -> Pin<Box<dyn Future<Output = Result<TransactionsInfo, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches transactions records for specific accounts within a block range. Using the /SyncTransactions RPC endpoint.

fn get_network_id<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<NetworkId, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches the network ID of the node. Errors:

fn get_nullifier_commit_heights<'life0, 'async_trait>( &'life0 self, requested_nullifiers: BTreeSet<Nullifier>, block_from: BlockNumber, ) -> Pin<Box<dyn Future<Output = Result<BTreeMap<Nullifier, Option<BlockNumber>>, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches the commit height where the nullifier was consumed. If the nullifier isn’t found, then None is returned. The block_num parameter is the block number to start the search from.

fn get_public_note_records<'life0, 'life1, 'async_trait>( &'life0 self, note_ids: &'life1 [NoteId], current_timestamp: Option<u64>, ) -> Pin<Box<dyn Future<Output = Result<Vec<InputNoteRecord>, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetches public note-related data for a list of NoteId and builds InputNoteRecords with it. If a note is not found or it’s private, it is ignored and will not be included in the returned list.

fn get_updated_public_accounts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, local_accounts: &'life1 [&'life2 AccountHeader], ) -> Pin<Box<dyn Future<Output = Result<Vec<Account>, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetches the public accounts that have been updated since the last known state of the accounts.

fn get_block_header_with_proof<'life0, 'async_trait>( &'life0 self, block_num: BlockNumber, ) -> Pin<Box<dyn Future<Output = Result<(BlockHeader, MmrProof), RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Given a block number, fetches the block header corresponding to that height from the node along with the MMR proof.

fn get_note_by_id<'life0, 'async_trait>( &'life0 self, note_id: NoteId, ) -> Pin<Box<dyn Future<Output = Result<FetchedNote, RpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches the note with the specified ID.