Struct Client

pub struct Client {
    name: String,
}

fedimint-cli instance (basically path with client state: config + db)

Fields

name: String

Implementations

impl Client

fn clients_dir() -> PathBuf

fn client_dir(&self) -> PathBuf

pub fn client_name_lock(name: &str) -> Result<FileLock>

pub async fn create(name: impl ToString) -> Result<Client>

Create a Client that starts with a fresh state.

pub fn open_or_create(name: &str) -> Result<Client>

Open or create a Client that starts with a fresh state.

pub async fn join_federation(&self, invite_code: String) -> Result<()>

Client to join a federation

pub async fn restore_federation( &self, invite_code: String, mnemonic: String, ) -> Result<()>

Client to join a federation with a restore procedure

pub async fn new_restored( &self, name: &str, invite_code: String, ) -> Result<Self>

Client to join a federation

pub async fn new_forked(&self, name: impl ToString) -> Result<Client>

Create a Client that starts with a state that is a copy of of another one.

pub async fn balance(&self) -> Result<u64>

pub async fn use_gateway(&self, gw: &Gatewayd) -> Result<()>

pub async fn get_deposit_addr(&self) -> Result<(String, String)>

pub async fn await_deposit(&self, operation_id: &str) -> Result<()>

pub fn cmd(&self) -> Command

pub fn get_name(&self) -> &str

pub async fn get_session_count(&self) -> Result<u64>

Returns the current consensus session count

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

Returns once all active state machines complete

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

Returns once the current session completes

pub async fn wait_session_outcome(&self, session_count: u64) -> Result<()>

Returns once the provided session count completes

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.