Struct miden_client::Client

pub struct Client<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthenticator> { /* private fields */ }

A light client for connecting to the Miden rollup network.

Miden client is responsible for managing a set of accounts. Specifically, the client:

• Keeps track of the current and historical states of a set of accounts and related objects such as notes and transactions.
• Connects to one or more Miden nodes to periodically sync with the current state of the network.
• Executes, proves, and submits transactions to the network as directed by the user.

Implementations

impl<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthenticator> Client<N, R, S, A>

pub fn new_account( &mut self, template: AccountTemplate, ) -> Result<(Account, Word), ClientError>

Creates a new Account based on an AccountTemplate and saves it in the store

pub fn import_account( &mut self, account_data: AccountData, ) -> Result<(), ClientError>

Saves in the store the Account corresponding to account_data.

Errors

Will return an error if trying to import a new account without providing its seed

Panics

Will panic when trying to import a non-new account without a seed since this functionality is not currently implemented

pub fn insert_account( &mut self, account: &Account, account_seed: Option<Word>, auth_info: &AuthSecretKey, ) -> Result<(), ClientError>

Inserts a new account into the client’s store.

Errors

If an account is new and no seed is provided, the function errors out because the client cannot execute transactions against new accounts for which it does not know the seed.

pub fn get_account_stubs( &self, ) -> Result<Vec<(AccountStub, Option<Word>)>, ClientError>

Returns summary info about the accounts managed by this client.

pub fn get_account( &self, account_id: AccountId, ) -> Result<(Account, Option<Word>), ClientError>

Returns summary info about the specified account.

pub fn get_account_stub_by_id( &self, account_id: AccountId, ) -> Result<(AccountStub, Option<Word>), ClientError>

Returns summary info about the specified account.

pub fn get_account_auth( &self, account_id: AccountId, ) -> Result<AuthSecretKey, ClientError>

Returns an AuthSecretKey object utilized to authenticate an account.

Errors

Returns a ClientError::StoreError with a StoreError::AccountDataNotFound if the provided ID does not correspond to an existing account.

impl<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthenticator> Client<N, R, S, A>

pub async fn import_note( &mut self, note_file: NoteFile, ) -> Result<NoteId, ClientError>

Imports a new input note into the client’s store. The information stored depends on the type of note file provided.

• If the note file is a NoteFile::NoteId, the note is fetched from the node and stored in the client’s store. If the note is private or does not exist, an error is returned. If the ID was already stored, the inclusion proof and metadata are updated.
• If the note file is a NoteFile::NoteDetails, a new note is created with the provided details. The note is marked as ignored if it contains no tag or if the tag is not relevant.
• If the note file is a NoteFile::NoteWithProof, the note is stored with the provided inclusion proof and metadata. The MMR data is only fetched from the node if the note is committed in the past relative to the client.

impl<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthenticator> Client<N, R, S, A>

pub fn get_input_notes( &self, filter: NoteFilter<'_>, ) -> Result<Vec<InputNoteRecord>, ClientError>

Returns input notes managed by this client.

pub fn get_consumable_notes( &self, account_id: Option<AccountId>, ) -> Result<Vec<(InputNoteRecord, Vec<NoteConsumability>)>, ClientError>

Returns the input notes and their consumability.

If account_id is None then all consumable input notes are returned.

pub fn get_note_consumability( &self, note: InputNoteRecord, ) -> Result<Vec<NoteConsumability>, ClientError>

Returns the consumability of the provided note.

pub fn get_input_note( &self, note_id: NoteId, ) -> Result<InputNoteRecord, ClientError>

Returns the input note with the specified hash.

pub fn get_output_notes( &self, filter: NoteFilter<'_>, ) -> Result<Vec<OutputNoteRecord>, ClientError>

Returns output notes managed by this client.

pub fn get_output_note( &self, note_id: NoteId, ) -> Result<OutputNoteRecord, ClientError>

Returns the output note with the specified hash.

pub fn compile_note_script( &self, note_script_ast: &str, ) -> Result<NoteScript, ClientError>

Compiles the provided program into a NoteScript

impl<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthenticator> Client<N, R, S, A>

pub fn get_note_tags(&self) -> Result<Vec<NoteTag>, ClientError>

Returns the list of note tags tracked by the client.

When syncing the state with the node, these tags will be added to the sync request and note-related information will be retrieved for notes that have matching tags.

Note: Tags for accounts that are being tracked by the client are managed automatically by the client and do not need to be added here. That is, notes for managed accounts will be retrieved automatically by the client when syncing.

pub fn add_note_tag(&mut self, tag: NoteTag) -> Result<(), ClientError>

Adds a note tag for the client to track.

pub fn remove_note_tag(&mut self, tag: NoteTag) -> Result<(), ClientError>

Removes a note tag for the client to track.

impl<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthenticator> Client<N, R, S, A>

pub fn get_sync_height(&self) -> Result<u32, ClientError>

Returns the block number of the last state sync block.

pub async fn sync_state(&mut self) -> Result<SyncSummary, ClientError>

Syncs the client’s state with the current state of the Miden network. Before doing so, it ensures the genesis block exists in the local store.

Returns the block number the client has been synced to.

pub async fn update_ignored_notes(&mut self) -> Result<SyncSummary, ClientError>

Updates the inclusion proof and metadata for notes that are being ignored by the client. This will not change their ignored status.

This function will not update the current block number as the notes will not be updated via a sync request. Because of this, the returned SyncSummary will not have the corresponding block number.

impl<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthenticator> Client<N, R, S, A>

pub fn get_transactions( &self, filter: TransactionFilter, ) -> Result<Vec<TransactionRecord>, ClientError>

Retrieves tracked transactions, filtered by TransactionFilter.

pub fn new_transaction( &mut self, account_id: AccountId, transaction_request: TransactionRequest, ) -> Result<TransactionResult, ClientError>

Creates and executes a transaction specified by the request against the specified account, but does not change the local database.

Errors

• Returns ClientError::MissingOutputNotes if the TransactionRequest ouput notes are not a subset of executor’s output notes
• Returns a ClientError::TransactionExecutorError if the execution fails
• Returns a ClientError::TransactionRequestError if the request is invalid

pub async fn submit_transaction( &mut self, tx_result: TransactionResult, ) -> Result<(), ClientError>

Proves the specified transaction, submits it to the network, and saves the transaction into the local database for tracking.

pub fn compile_tx_script<T>( &self, inputs: T, program: &str, ) -> Result<TransactionScript, ClientError>

where T: IntoIterator<Item = (Word, Vec<Felt>)>,

Compiles the provided transaction script source and inputs into a TransactionScript

pub fn validate_request( &self, account_id: AccountId, transaction_request: &TransactionRequest, ) -> Result<(), ClientError>

Validates that the specified transaction request can be executed by the specified account.

This function checks that the account has enough balance to cover the outgoing assets. This does’t guarantee that the transaction will succeed, but it’s useful to avoid submitting transactions that are guaranteed to fail.

impl<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthenticator> Client<N, R, S, A>

pub fn new( api: N, rng: R, store: Rc<S>, authenticator: A, in_debug_mode: bool, ) -> Self

Returns a new instance of Client.

Arguments

• api: An instance of NodeRpcClient which provides a way for the client to connect to the Miden node.
• store: An instance of Store, which provides a way to write and read entities to provide persistence.
• executor_store: An instance of Store that provides a way for TransactionExecutor to retrieve relevant inputs at the moment of transaction execution. It should be the same store as the one for store, but it doesn’t have to be the same instance.
• authenticator: Defines the transaction authenticator that will be used by the transaction executor whenever a signature is requested from within the VM.
• in_debug_mode: Instantiates the transaction executor (and in turn, its compiler) in debug mode, which will enable debug logs for scripts compiled with this mode for easier MASM debugging.

Errors

Returns an error if the client could not be instantiated.

pub fn rng(&mut self) -> &mut R

Returns a reference to the client’s random number generator. This can be used to generate randomness for various purposes such as serial numbers, keys, etc.