Struct MultisigClientBuilder 

pub struct MultisigClientBuilder { /* private fields */ }

Builder for constructing MultisigClient instances.

Example

use miden_multisig_client::MultisigClient;
use miden_client::rpc::Endpoint;

let client = MultisigClient::builder()
    .miden_endpoint(Endpoint::new("http://localhost:57291"))
    .guardian_endpoint("http://localhost:50051")
    .account_dir("/tmp/multisig-client")
    .prover_config(
        miden_multisig_client::ProverConfig::new()
            .with_url("https://prover.example")?
            .with_retry_policy(miden_multisig_client::ProverRetryPolicy::new(4)),
    )
    .generate_key()
    .build()
    .await?;

Implementations

impl MultisigClientBuilder

pub fn new() -> Self

Creates a new builder with default settings.

pub fn miden_endpoint(self, endpoint: Endpoint) -> Self

Sets the Miden node RPC endpoint.

pub fn note_transport_endpoint(self, endpoint: impl Into<String>) -> Self

Sets the note transport service endpoint used for private note relay.

Overrides the default derived from the Miden endpoint (the public transport services for the testnet and devnet presets). A custom Miden node endpoint has no derivable transport service, so this is the only way to enable note transport there.

pub fn guardian_endpoint(self, endpoint: impl Into<String>) -> Self

Sets the GUARDIAN server endpoint.

pub fn prover_config(self, prover_config: ProverConfig) -> Self

Configures the remote transaction prover and its retry policy.

pub fn rpc_config(self, rpc_config: RpcConfig) -> Self

Configures the Miden node RPC timeout and idempotent-read retry policy.

pub fn account_dir(self, path: impl Into<PathBuf>) -> Self

Sets the account directory for miden-client storage.

This directory will contain the SQLite database for account and transaction data.

pub fn key_manager(self, key_manager: Box<dyn KeyManager>) -> Self

Sets a custom key manager for GUARDIAN authentication and proposal signing.

pub fn with_secret_key(self, secret_key: SecretKey) -> Self

Uses a FalconKeyStore with the given secret key.

pub fn with_ecdsa_secret_key(self, secret_key: EcdsaSecretKey) -> Self

Uses an ECDSA key store with the given secret key.

pub fn generate_key(self) -> Self

Generates a new random key for GUARDIAN authentication.

pub fn generate_ecdsa_key(self) -> Self

Generates a new random ECDSA key for GUARDIAN authentication.

pub async fn build(self) -> Result<MultisigClient>

Builds the MultisigClient.

Trait Implementations

impl Default for MultisigClientBuilder

fn default() -> Self

Returns the “default value” for a type.