Struct Client 

pub struct Client<AUTH> { /* private fields */ }

A light client for connecting to the Miden 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 a Miden node 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<AUTH> Client<AUTH>

This section of the Client contains methods for:

• Account creation: Use the AccountBuilder to construct new accounts, specifying account visibility (AccountType::Public / AccountType::Private) and attaching necessary components (e.g., basic wallet or fungible faucet). Prefer AccountBuilderSchemaCommitmentExt::build_with_schema_commitment so the account includes merged storage schema commitment metadata; use plain AccountBuilder::build only when you need to opt out. After creation, accounts can be added to the client.

• Account tracking: Accounts added via the client are persisted to the local store, where their state (including nonce, balance, and metadata) is updated upon every synchronization with the network.

• Data retrieval: The module also provides methods to fetch account-related data.

pub async fn add_account( &mut self, account: &Account, overwrite: bool, ) -> Result<(), ClientError>

Adds the provided Account in the store so it can start being tracked by the client.

If the account is already being tracked and overwrite is set to true, the account will be overwritten. Newly created accounts must embed their seed (account.seed() must return Some(_)).

Errors

• If the account is new but it does not contain the seed.
• If the account is already tracked and overwrite is set to false.
• If overwrite is set to true and the account_data nonce is lower than the one already being tracked.
• If overwrite is set to true and the account_data commitment doesn’t match the network’s account commitment.

pub async fn import_account_by_id( &mut self, account_id: AccountId, ) -> Result<(), ClientError>

Imports an account from the network to the client’s store. The account needs to be public and be tracked by the network, it will be fetched by its ID. If the account was already being tracked by the client, its state will be overwritten.

To import an account as watched (state-tracking only, no note sync), use Self::import_watched_account_by_id instead. Switching an already-tracked account between Native and Watched is not supported.

Errors

• If the account is not found on the network.
• If the account is private.
• If the account is already tracked as watched.
• There was an error sending the request to the network.

pub async fn import_watched_account_by_id( &mut self, account_id: AccountId, ) -> Result<(), ClientError>

Starts watching an on-chain account (ClientAccountType::Watched).

Like Self::import_account_by_id, the account is fetched from the network by its ID. Unlike import_account_by_id, the account is added without registering its derived note tag: sync_state will keep the account’s commitment, nonce and storage up to date but will not pull notes targeted at it.

If the account is already being tracked as watched its state is overwritten. Switching an already-tracked native account to watched is not supported.

Errors

• If the account is not found on the network.
• If the account is private.
• If the account is already tracked as native.
• There was an error sending the request to the network.

pub async fn fetch_remote_token_metadata( &self, faucet_id: AccountId, ) -> Result<Option<FaucetMetadata>, ClientError>

Fetches a public faucet’s display metadata from the network.

Uses get_account with a minimal request so that the node does not return vault data. The faucet’s token config lives in a single value slot, which is always present in the returned storage header.

Returns:

• Ok(Some(_)) — the account is public and its token config storage slot decoded.
• Ok(None) — the account is private, not on chain, or the storage slot does not parse as a token config. Caller should fall back to a raw display.
• Err(_) — transport-level RPC error.

pub async fn add_address( &mut self, address: Address, account_id: AccountId, ) -> Result<(), ClientError>

Adds an Address to the associated AccountId, alongside its derived NoteTag. If the account is tracked as watched, the note tag is not registered.

Errors

• If the account is not found on the network.
• If the address is already being tracked.

pub async fn remove_address( &mut self, address: Address, account_id: AccountId, ) -> Result<(), ClientError>

Removes an Address from the associated AccountId, alongside its derived NoteTag. If no address was tracked for the given account, this is a no-op.

pub async fn get_account_vault( &self, account_id: AccountId, ) -> Result<AssetVault, ClientError>

Retrieves the asset vault for a specific account.

To check the balance for a single asset, use Client::account_reader instead.

pub async fn get_account_storage( &self, account_id: AccountId, ) -> Result<AccountStorage, ClientError>

Retrieves the whole account storage for a specific account.

To only load a specific slot, use Client::account_reader instead.

pub async fn get_account_code( &self, account_id: AccountId, ) -> Result<Option<AccountCode>, ClientError>

Retrieves the account code for a specific account.

Returns None if the account is not found.

pub async fn get_account_headers( &self, ) -> Result<Vec<(AccountHeader, AccountStatus)>, ClientError>

Returns a list of AccountHeader of all accounts stored in the database along with their statuses.

Said accounts’ state is the state after the last performed sync.

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

Retrieves the full Account object from the store, returning None if not found.

This method loads the complete account state including vault, storage, and code.

For lazy access that fetches only the data you need, use Client::account_reader instead.

Use Client::try_get_account if you want to error when the account is not found.

pub async fn try_get_account( &self, account_id: AccountId, ) -> Result<Account, ClientError>

Retrieves the full Account object from the store, erroring if not found.

This method loads the complete account state including vault, storage, and code.

Use Client::get_account if you want to handle missing accounts gracefully.

pub fn account_reader(&self, account_id: AccountId) -> AccountReader

Creates an AccountReader for lazy access to account data.

The AccountReader provides lazy access to account state - each method call fetches fresh data from storage, ensuring you always see the current state.

For loading the full Account object, use Client::get_account instead.

Example

let reader = client.account_reader(account_id);

// Each call fetches fresh data
let nonce = reader.nonce().await?;
let balance = reader.get_balance(faucet_id).await?;

// Storage access is integrated
let value = reader.get_storage_item("my_slot").await?;
let (map_value, witness) = reader.get_storage_map_witness("balances", key).await?;

pub async fn prune_account_history( &self, account_id: AccountId, up_to_nonce: Felt, ) -> Result<usize, ClientError>

Prunes historical account states for the specified account up to the given nonce.

Deletes all historical entries with replaced_at_nonce <= up_to_nonce and any orphaned account code.

Returns the total number of rows deleted, including historical entries and orphaned account code.

impl<AUTH> Client<AUTH>

where AUTH: TransactionAuthenticator + Sync + 'static,

Note importing methods.

pub async fn import_notes( &mut self, note_files: &[NoteFile], ) -> Result<Vec<NoteDetailsCommitment>, ClientError>

Imports a batch of new input notes into the client’s store. The information stored depends on the type of note files provided. If the notes existed previously, it will be updated with the new information. The tags specified by the NoteFiles will start being tracked. Returns the details commitments of notes that were successfully imported or updated. The details commitment is used (rather than the note ID) because notes imported without metadata — e.g. from NoteFile::NoteDetails in an Expected state — have no note ID yet, whereas the details commitment is always available.

• If the note files are NoteFile::NoteId, the notes are fetched from the node and stored in the client’s store. If the note is private or doesn’t exist, an error is returned.
• If the note files are NoteFile::NoteDetails, new notes are created with the provided details and tags.
• If the note files are NoteFile::NoteWithProof, the notes are stored with the provided inclusion proof and metadata. The block header data is only fetched from the node if the note is committed in the past relative to the client.

Errors

• If an attempt is made to overwrite a note that is currently processing.

Note: This operation is atomic. If any note file is invalid or any existing note is in the processing state, the entire operation fails and no notes are imported.

impl<AUTH> Client<AUTH>

where AUTH: TransactionAuthenticator + Sync,

Note retrieval methods.

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

Retrieves the input notes managed by the client from the store.

Errors

Returns a ClientError::StoreError if the filter is NoteFilter::Unique and there is no Note with the provided ID.

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

Returns the input notes and their consumability. Assuming the notes will be consumed by a normal consume transaction. If account_id is None then all consumable input notes are returned.

The note screener runs a series of checks to determine whether the note can be executed as part of a transaction for a specific account. If the specific account ID can consume it (ie, if it’s compatible with the account), it will be returned as part of the result list.

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

Returns the consumability conditions for the provided note.

The note screener runs a series of checks to determine whether the note can be executed as part of a transaction for a specific account. If the specific account ID can consume it (ie, if it’s compatible with the account), it will be returned as part of the result list.

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

Retrieves the input note given a NoteId. Returns None if the note is not found.

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

Returns output notes managed by this client.

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

Retrieves the output note given a NoteId. Returns None if the note is not found.

pub fn input_note_reader(&self, consumer: AccountId) -> InputNoteReader

Returns an InputNoteReader that lazily iterates over consumed input notes for the given consumer account.

The consumer is required because ordering is only guaranteed among notes consumed by the same account.

Example

let mut reader = client.input_note_reader(account_id);

while let Some(note) = reader.next().await? {
    process(note);
}

impl<AUTH> Client<AUTH>

Client note transport methods.

pub fn is_note_transport_enabled(&self) -> bool

Check if note transport connection is configured

pub async fn send_private_note( &mut self, note: Note, _address: &Address, ) -> Result<(), ClientError>

Send a note through the note transport network.

The note will be end-to-end encrypted (unimplemented, currently plaintext) using the provided recipient’s address details. The recipient will be able to retrieve this note through the note’s NoteTag.

Durability. The relay payload is persisted to the outbox before the transport call. If the call fails or is interrupted, the entry stays in the outbox and is retried on the next Client::flush_relay_outbox (which Client::sync_note_transport runs), so a transient transport failure does not drop the note. The receiver dedupes by note id, so a re-send after a partial success is harmless.

pub async fn flush_relay_outbox(&self) -> Result<(), ClientError>

Re-attempt every relay payload in the durable outbox. Each entry is a private note whose previous transport delivery failed. Successful re-sends are dropped; failures are kept for the next call. Every entry is attempted independently, so one persistently-failing note does not block the others.

Client::sync_note_transport runs this automatically and ignores its error, so a relay failure can’t block a sync. Callers driving retries themselves can invoke it directly and inspect the returned error.

impl<AUTH> Client<AUTH>

where AUTH: TransactionAuthenticator + Sync + 'static,

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

Fetch notes for tracked note tags.

The client will query the configured note transport node for all tracked note tags. To list tracked tags please use Client::get_note_tags. To add a new note tag please use Client::add_note_tag. Only notes directed at your addresses will be stored and readable given the use of end-to-end encryption (unimplemented). Fetched notes will be stored into the client’s store.

An internal pagination mechanism is employed to reduce the number of downloaded notes. To fetch the full history of private notes for the tracked tags, use Client::fetch_all_private_notes.

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

Fetches all notes for tracked note tags, draining the server’s paginated response by looping until the cursor stops advancing.

Similar to Client::fetch_private_notes but ignores the stored pagination cursor and re-scans from the beginning. The server-side transport caps each response at a fixed batch size; this method issues repeated fetch calls until one returns the same cursor it was given (i.e. no new notes), so the documented “fetches all notes” semantics hold regardless of how large the backlog is. Prefer Client::fetch_private_notes for steady-state syncing to avoid re-downloading already-seen notes.

impl<AUTH> Client<AUTH>

This section of the Client contains methods for:

• Settings accessors: Methods to get, set, and delete setting values from the store.
• Default account ID: Methods to get, set, and delete the default account ID. This is a wrapper around a specific setting value.

pub async fn set_setting<T: Serializable>( &mut self, key: String, value: T, ) -> Result<(), ClientError>

Sets a setting value in the store. It can then be retrieved using get_setting.

pub async fn get_setting<T: Deserializable>( &self, key: String, ) -> Result<Option<T>, ClientError>

Retrieves the value for key, or None if it hasn’t been set.

pub async fn remove_setting(&mut self, key: String) -> Result<(), ClientError>

Deletes the setting value from the store.

pub async fn list_setting_keys(&self) -> Result<Vec<String>, ClientError>

Returns all the setting keys from the store.

impl<AUTH> Client<AUTH>

Network information management methods.

pub async fn get_block_header_by_num( &self, block_num: BlockNumber, ) -> Result<Option<(BlockHeader, BlockRelevance)>, ClientError>

Retrieves a block header by its block number from the store.

Returns None if the block header is not found in the store.

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

Ensures that the genesis block is available. If the genesis commitment is already cached in the RPC client, returns early. Otherwise, fetches the genesis block from the node, stores it, and sets the commitment in the RPC client.

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

Available on crate feature testing only.

Seeds local state for offline account creation and debugging without a real node.

Applies default RPC limits, then either aligns the RPC genesis with an existing stored genesis, or replaces the RPC client with MockRpcApi and runs Self::ensure_genesis_in_place so genesis comes from the mock chain.

pub async fn get_current_partial_mmr(&self) -> Result<PartialMmr, ClientError>

Returns the cached PartialMmr if in-memory caching is enabled and its fingerprint matches the current store state, otherwise rebuilds from the store.

impl<AUTH> Client<AUTH>

Tag management methods

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

Returns the list of note tags tracked by the client along with their source.

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. The source of the tag indicates its origin. It helps distinguish between:

• Tags added manually by the user.
• Tags automatically added by the client to track notes.
• Tags added for accounts tracked by the client.

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

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

Adds a note tag for the client to track. This tag’s source will be marked as User.

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

Removes a note tag for the client to track. Only tags added by the user can be removed.

impl<AUTH> Client<AUTH>

where AUTH: TransactionAuthenticator + Sync + 'static,

Client synchronization methods.

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

Returns the block number of the last state sync block.

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

Syncs the client’s on-chain state with the current state of the Miden network and returns a SyncSummary corresponding to the local state update.

Does not fetch private notes from the Note Transport Layer. Use Client::sync_state for the combined sync, or call Client::sync_note_transport separately.

Builds the default sync input, runs StateSync::sync_state (see that method for the detailed pipeline), applies the resulting update to the store, caches the partial MMR, and prunes irrelevant blocks according to the configured cadence.

pub async fn sync_note_transport(&mut self) -> Result<Vec<NoteId>, ClientError>

Fetches private notes from the Note Transport Layer for the tracked note tags.

Returns the IDs of notes imported in this call. No-op (returns an empty vec) if note transport is disabled.

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

Runs the full client sync.

First fetches private notes from the Note Transport Layer (see Client::sync_note_transport), then syncs the client’s on-chain state with the Miden node (see Client::sync_chain). If note transport is disabled, this is equivalent to Client::sync_chain.

Fails fast on the first error. Private notes delivered via NTL are imported before the chain sync reads its input set, so their nullifiers are checked in the same call.

pub async fn build_sync_input(&self) -> Result<StateSyncInput, ClientError>

Builds a default StateSyncInput from the current client state.

This includes all tracked account headers, all unique note tags, all unspent input and output notes, and all uncommitted transactions.

pub async fn apply_state_sync( &mut self, update: StateSyncUpdate, ) -> Result<(), ClientError>

Applies the state sync update to the store and prunes irrelevant blocks according to the configured cadence.

See crate::Store::apply_state_sync() for what the update implies.

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

Ensures that the RPC limits are set in the RPC client. If not already cached, fetches them from the node and persists them in the store.

impl<AUTH> Client<AUTH>

where AUTH: TransactionAuthenticator + Sync + 'static,

Transaction management methods

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

Retrieves tracked transactions, filtered by TransactionFilter.

pub fn new_transaction_batch(&self) -> BatchBuilder<'_, AUTH>

Open a new BatchBuilder for accumulating transactions across one or more local accounts.

See crate::transaction::batch for usage and constraints.

pub async fn submit_new_transaction( &mut self, account_id: AccountId, transaction_request: TransactionRequest, ) -> Result<TransactionId, ClientError>

Executes a transaction specified by the request against the specified account, proves it, submits it to the network, and updates the local database.

Uses the client’s default prover (configured via crate::builder::ClientBuilder::prover).

pub async fn submit_new_transaction_with_prover( &mut self, account_id: AccountId, transaction_request: TransactionRequest, tx_prover: Arc<dyn TransactionProver>, ) -> Result<TransactionId, ClientError>

Executes a transaction specified by the request against the specified account, proves it with the provided prover, submits it to the network, and updates the local database.

This is useful for falling back to a different prover (e.g., local) when the default prover (e.g., remote) fails with a ClientError::TransactionProvingError.

pub async fn execute_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 doesn’t change the local database.

Errors

• Returns ClientError::MissingOutputRecipients if the TransactionRequest output 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 prove_transaction( &self, tx_result: &TransactionResult, ) -> Result<ProvenTransaction, ClientError>

Proves the specified transaction using the prover configured for this client.

pub async fn prove_transaction_with( &self, tx_result: &TransactionResult, tx_prover: Arc<dyn TransactionProver>, ) -> Result<ProvenTransaction, ClientError>

Proves the specified transaction using the provided prover.

pub async fn submit_proven_transaction( &mut self, proven_transaction: ProvenTransaction, transaction_inputs: impl Into<TransactionInputs>, ) -> Result<BlockNumber, ClientError>

Submits a previously proven transaction to the RPC endpoint and returns the node’s chain tip upon mempool admission.

pub async fn get_transaction_store_update( &self, tx_result: &TransactionResult, submission_height: BlockNumber, ) -> Result<TransactionStoreUpdate, TransactionStoreUpdateError>

Builds a TransactionStoreUpdate for the provided transaction result at the specified submission height.

pub async fn apply_transaction( &self, tx_result: &TransactionResult, submission_height: BlockNumber, ) -> Result<(), ClientError>

Persists the effects of a submitted transaction into the local store, updating account data, note metadata, and future note tracking.

pub async fn apply_transaction_update( &self, tx_update: TransactionStoreUpdate, ) -> Result<(), ClientError>

pub async fn execute_program( &mut self, account_id: AccountId, tx_script: TransactionScript, advice_inputs: AdviceInputs, foreign_accounts: BTreeMap<AccountId, ForeignAccount>, ) -> Result<[Felt; 16], ClientError>

Executes the provided transaction script against the specified account, and returns the resulting stack. Advice inputs and foreign accounts can be provided for the execution.

The transaction will use the current sync height as the block reference.

pub async fn execute_program_with_dap( &mut self, account_id: AccountId, tx_script: TransactionScript, advice_inputs: AdviceInputs, foreign_accounts: BTreeMap<AccountId, ForeignAccount>, ) -> Result<[Felt; 16], ClientError>

Available on crate feature dap only.

Executes the provided transaction script with a DAP debug adapter listening for connections, allowing interactive debugging via any DAP-compatible client.

pub async 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 does’t guarantee that the transaction will succeed, but it’s useful to avoid submitting transactions that are guaranteed to fail. Some of the validations include:

• That the account has enough balance to cover the outgoing assets.
• That the client is not too far behind the chain tip.

pub async fn ensure_ntx_scripts_registered( &mut self, account_id: AccountId, scripts: &[NoteScript], tx_prover: Arc<dyn TransactionProver>, ) -> Result<(), ClientError>

Checks whether the node’s note_scripts registry already has each of the expected NTX scripts. For any script that is missing, creates and submits a registration transaction that produces a public note carrying that script.

account_id is the account that will execute the registration transaction.

Standard note scripts are skipped — the NTX builder resolves those directly, so they never need registering. A missing non-standard script is registered, not an error.

This method is called automatically by Self::submit_new_transaction_with_prover when the TransactionRequest contains expected NTX scripts. It can also be called directly if you want to register scripts ahead of time.

impl<AUTH> Client<AUTH>

where AUTH: BuilderAuthenticator,

Constructors.

pub fn builder() -> ClientBuilder<AUTH>

Returns a new ClientBuilder for constructing a client.

This is a convenience method equivalent to calling ClientBuilder::new().

Example

let client = Client::builder()
    .rpc(rpc_client)
    .store(store)
    .authenticator(Arc::new(keystore))
    .build()
    .await?;

impl<AUTH> Client<AUTH>

where AUTH: TransactionAuthenticator,

Access methods.

pub fn in_debug_mode(&self) -> bool

Returns true if the client is in debug mode.

pub fn code_builder(&self) -> CodeBuilder

Returns an instance of the CodeBuilder

pub fn note_screener(&self) -> NoteScreener

Returns an instance of note::NoteScreener configured for this client.

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

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.

pub fn prover(&self) -> Arc<dyn TransactionProver + Send + Sync>

pub fn authenticator(&self) -> Option<&Arc<AUTH>>

pub fn source_manager(&self) -> Arc<dyn SourceManagerSync>

Returns the shared source manager used to retain MASM source information for assembled programs.

impl<AUTH> Client<AUTH>

pub fn store_identifier(&self) -> &str

Returns the identifier of the underlying store (e.g. IndexedDB database name, SQLite file path).

pub async fn network_id(&self) -> Result<NetworkId, ClientError>

Returns the network ID of the node the client is connected to.

pub fn test_rpc_api(&mut self) -> &mut Arc<dyn NodeRpcClient>

Available on crate features testing only.

pub fn test_store(&mut self) -> &mut Arc<dyn Store>

Available on crate features testing only.

pub fn test_has_cached_partial_mmr(&self) -> bool

Available on crate features testing only.