Struct ClientConfig 

pub struct ClientConfig {
    pub rpc_endpoint: Endpoint,
    pub rpc_timeout_ms: u64,
    pub prover_endpoint: Option<String>,
    pub note_transport_endpoint: Option<NoteTransportEndpoint>,
    pub fee_funder: Option<Arc<dyn FeeFunder>>,
}

Fields

rpc_endpoint: Endpoint

rpc_timeout_ms: u64

prover_endpoint: Option<String>

Optional remote prover endpoint. If set, the client will use a remote prover instead of the default local prover.

note_transport_endpoint: Option<NoteTransportEndpoint>

Optional note transport endpoint. If set, the client will connect to a note transport service.

fee_funder: Option<Arc<dyn FeeFunder>>

Funder the account-creating test helpers draw the native fee asset from. Shared by every client built from this config and its clones, so consecutive payments from one wallet chain off each other’s nonce.

Implementations

impl ClientConfig

pub fn new(rpc_endpoint: Endpoint, rpc_timeout_ms: u64) -> Self

pub fn with_prover_endpoint(self, prover_endpoint: Option<String>) -> Self

pub fn with_note_transport_endpoint( self, note_transport_endpoint: Option<NoteTransportEndpoint>, ) -> Self

pub fn with_fee_funder(self, fee_funder: Option<Arc<dyn FeeFunder>>) -> Self

Sets the funder the account-creating test helpers draw the native fee asset from.

pub fn with_funders(self, funders: Option<&Path>) -> Result<Self>

Loads the pre-funded wallets at funders, one .mac account file or a directory of them, as the fee funder. A path naming no funder file leaves the config without one, which is all a fee-free chain needs.

pub async fn flush_funder(&self) -> Result<()>

Waits until a block carries every payment the fee funder has submitted.

pub async fn into_unsynced_client(self) -> Result<TestClient>

Creates a TestClient without syncing it, for tests that have to wait for the node first.

The client gets its own store and keystore, the latter reachable through TestClient::keystore. The store is a SQLite database at a temporary location, and the keystore a temporary directory, both created here rather than held on the config, so every client this is called on gets its own.

pub async fn into_client(self) -> Result<TestClient>

Creates a TestClient.

The client gets its own store and keystore, and is synced to the current state before being returned.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Creates a default client config.

TEST_MIDEN_NETWORK sets the top-level preset (defaults for all components):

• testnet: RPC testnet, remote prover testnet, note transport testnet
• devnet: RPC devnet, remote prover devnet, note transport devnet

When unset, only RPC defaults to localhost (local prover, no note transport).

Individual env vars override specific components:

• TEST_MIDEN_RPC_URL: overrides the RPC endpoint
• TEST_MIDEN_PROVER_URL: overrides the prover (local forces local prover)
• TEST_MIDEN_NOTE_TRANSPORT_URL: overrides the note transport endpoint