miden-multisig-client 0.14.3

High-level SDK for interacting with multisig accounts on Miden via GUARDIAN
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

//! Miden Multisig Client SDK
//!
//! A high-level SDK for interacting with multisig accounts on Miden,
//! coordinated through Guardian servers.
//!
//! # Quick Start
//!
//! ```ignore
//! use miden_multisig_client::MultisigClient;
//! use miden_client::rpc::Endpoint;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     // Create a client with auto-generated keys
//!     let mut client = MultisigClient::builder()
//!         .miden_endpoint(Endpoint::new("http://localhost:57291"))
//!         .data_dir("/tmp/multisig-client")
//!         .generate_key()
//!         .build()
//!         .await?;
//!
//!     // Print your commitment for sharing with cosigners
//!     println!("Your commitment: {}", client.user_commitment_hex());
//!
//!     // Create a 2-of-3 multisig
//!     let account = client.create_account(2, vec![signer1, signer2, signer3]).await?;
//!
//!     // Register with GUARDIAN so other cosigners can pull
//!     client.push_account().await?;
//!
//!     Ok(())
//! }
//! ```
//!

use miden_client::Client;
use miden_client::keystore::FilesystemKeyStore;

mod account;
mod builder;
mod client;
mod error;
mod execution;
mod export;
mod guardian_endpoint;
mod keystore;
mod payload;
mod procedures;
mod proposal;
mod transaction;
mod utils;

pub(crate) type MidenSdkClient = Client<FilesystemKeyStore>;

// Main client
pub use builder::MultisigClientBuilder;
pub use client::{
    ConsumableNote, MultisigClient, NoteFilter, ProposalResult, StateVerificationResult,
};

// Procedures
pub use procedures::{ProcedureName, ProcedureThreshold};

// Account types
pub use account::MultisigAccount;

// Key management and hex utilities
pub use keystore::{
    EcdsaGuardianKeyStore,
    FalconKeyStore,
    GuardianKeyStore,
    KeyManager,
    // Hex utilities
    commitment_from_hex,
    ensure_hex_prefix,
    proposal_public_key_hex,
    strip_hex_prefix,
    validate_commitment_hex,
    word_from_hex,
};

// Proposals
pub use payload::{ProposalMetadataPayload, ProposalPayload};
pub use proposal::{Proposal, ProposalMetadata, ProposalStatus, TransactionType};
pub use transaction::ProposalBuilder;

// Export/Import
pub use export::{EXPORT_VERSION, ExportedMetadata, ExportedProposal, ExportedSignature};

// Errors
pub use error::{MultisigError, Result};

// Re-exports for convenience
pub use guardian_shared::SignatureScheme;
pub use miden_client::rpc::Endpoint;
pub use miden_protocol::Word;
pub use miden_protocol::account::AccountId;
pub use miden_protocol::asset::Asset;
pub use miden_protocol::crypto::dsa::ecdsa_k256_keccak::SecretKey as EcdsaSecretKey;
pub use miden_protocol::crypto::dsa::falcon512_poseidon2::SecretKey;
pub use miden_protocol::note::NoteId;