Struct MockRpcApi 

pub struct MockRpcApi {
    pub mock_chain: Arc<RwLock<MockChain>>,
    /* private fields */
}

Available on crate feature testing only.

Mock RPC API

This struct implements the RPC API used by the client to communicate with the node. It simulates most of the functionality of the actual node, with some small differences:

• It uses a MockChain to simulate the blockchain state.
• Blocks are not automatically created after time passes, but rather new blocks are created when calling the prove_block method.
• Network account and transactions aren’t supported in the current version.
• Account update block numbers aren’t tracked, so any endpoint that returns when certain account updates were made will return the chain tip block number instead.

Fields

mock_chain: Arc<RwLock<MockChain>>

Implementations

impl MockRpcApi

pub fn new(mock_chain: MockChain) -> Self

Creates a new MockRpcApi instance with the state of the provided MockChain.

pub fn get_mmr(&self) -> Mmr

Returns the current MMR of the blockchain.

pub fn get_chain_tip_block_num(&self) -> BlockNumber

Returns the chain tip block number.

pub fn prove_block(&self)

Advances the mock chain by proving the next block, committing all pending objects to the chain in the process.

pub fn get_available_notes(&self) -> Vec<MockChainNote>

pub fn get_public_available_notes(&self) -> Vec<MockChainNote>

pub fn get_private_available_notes(&self) -> Vec<MockChainNote>

pub fn advance_blocks(&self, num_blocks: u32)

Trait Implementations

impl Clone for MockRpcApi

fn clone(&self) -> MockRpcApi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for MockRpcApi

fn default() -> Self

Returns the “default value” for a type.

impl From<MockChain> for MockRpcApi

fn from(mock_chain: MockChain) -> Self

Converts to this type from the input type.

impl NodeRpcClient for MockRpcApi

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,

Returns the next note updates after the specified block number. Only notes that match the provided tags will be returned.

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,

Executes the specified sync state request and returns the response.

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,

Retrieves the block header for the specified block number. If the block number is not provided, the chain tip block header will be returned.

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,

Returns the node’s tracked notes that match the provided note IDs.

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

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

Simulates the submission of a proven transaction to the node. This will create a new block just for the new transaction and return the block number of the newly created block.

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,

Returns the node’s tracked account details for the specified account ID.

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,

Returns the account proof for the specified account. The known_account_code parameter is ignored in the mock implementation and the latest account code is always returned.

fn sync_nullifiers<'life0, 'life1, 'async_trait>( &'life0 self, prefixes: &'life1 [u16], from_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,

Returns the nullifiers created after the specified block number that match the provided prefixes.

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,

Returns proofs for all the provided nullifiers.

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 and reconnects to the node providing the genesis commitment in the request headers. If the genesis commitment is already set, this method does nothing.

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.