Struct fedimint_client::Client

pub struct Client { /* private fields */ }

Implementations

impl Client

pub async fn create_backup(&self, metadata: Metadata) -> Result<ClientBackup>

Create a backup, include provided metadata

pub async fn create_encrypted_backup( &self, metadata: Metadata ) -> Result<EncryptedClientBackup>

Create a backup, include provided metadata, and encrypt it with a (derived) client root key

pub async fn backup_to_federation(&self, metadata: Metadata) -> Result<()>

Prepare an encrypted backup and send it to federation for storing

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

Wipe the client state (including module state)

pub async fn upload_backup(&self, backup: EncryptedClientBackup) -> Result<()>

Upload backup to federation

pub async fn restore_from_backup( &self, backup: Option<ClientBackup> ) -> Result<Metadata>

Restore client state from backup if provided or from scratch.

This will restore (or initialize restoration process) in all sub-modules that support it.

pub async fn download_backup_from_federation( &self ) -> Result<Option<ClientBackup>>

Download most recent valid backup found from the Federation

pub fn get_backup_id(&self) -> PublicKey

Backup id derived from the root secret key (public key used to self-sign backup requests)

pub async fn get_decoded_client_secret<T: Decodable>(&self) -> Result<T>

impl Client

pub fn builder() -> ClientBuilder

Initialize a client builder that can be configured to create a new client.

pub fn api(&self) -> &(dyn IGlobalFederationApi + 'static)

pub fn api_clone(&self) -> DynGlobalApi

pub async fn start_executor(self: &Arc<Self>)

pub fn federation_id(&self) -> FederationId

pub fn decoders(&self) -> &ModuleDecoderRegistry

pub fn get_internal_payment_markers(&self) -> Result<(PublicKey, u64)>

pub fn get_meta(&self, key: &str) -> Option<String>

pub async fn add_state_machines( &self, dbtx: &mut DatabaseTransaction<'_>, states: Vec<DynState<DynGlobalClientContext>> ) -> AddStateMachinesResult

pub async fn get_active_operations(&self) -> HashSet<OperationId>

pub fn operation_log(&self) -> &OperationLog

pub async fn finalize_and_submit_transaction<F, M>( &self, operation_id: OperationId, operation_type: &str, operation_meta: F, tx_builder: TransactionBuilder ) -> Result<(TransactionId, Vec<OutPoint>)>

where F: Fn(TransactionId, Vec<OutPoint>) -> M + Clone + MaybeSend + MaybeSync, M: Serialize + MaybeSend,

Add funding and/or change to the transaction builder as needed, finalize the transaction and submit it to the federation.

Errors

The function will return an error if the operation with given ID already exists.

Panics

The function will panic if the database transaction collides with other and fails with others too often, this should not happen except for excessively concurrent scenarios.

pub async fn await_primary_module_output( &self, operation_id: OperationId, out_point: OutPoint ) -> Result<Amount>

Waits for an output from the primary module to reach its final state.

pub async fn has_active_states(&self, operation_id: OperationId) -> bool

pub fn get_first_module<M: ClientModule>(&self) -> ClientModuleInstance<'_, M>

Returns a reference to a typed module client instance by kind

pub fn get_module_client_dyn( &self, instance_id: ModuleInstanceId ) -> Result<&(dyn IClientModule + Send + Sync)>

pub fn db(&self) -> &Database

pub async fn transaction_updates( &self, operation_id: OperationId ) -> TransactionUpdates

Returns a stream of transaction updates for the given operation id that can later be used to watch for a specific transaction being accepted.

pub fn get_first_instance( &self, module_kind: &ModuleKind ) -> Option<ModuleInstanceId>

Returns the instance id of the first module of the given kind. The primary module will always be returned before any other modules (which themselves are ordered by their instance ID).

pub async fn root_secret_encoding<T: Decodable>(&self) -> Result<T>

Returns the data from which the client’s root secret is derived (e.g. BIP39 seed phrase struct).

pub async fn await_primary_module_outputs( &self, operation_id: OperationId, outputs: Vec<OutPoint> ) -> Result<Amount>

Waits for outputs from the primary module to reach its final state.

pub fn get_config(&self) -> &ClientConfig

Returns the config with which the client was initialized.

pub fn get_config_json(&self) -> JsonClientConfig

Returns the config of the client in JSON format.

Compared to the consensus module format where module configs are binary encoded this format cannot be cryptographically verified but is easier to consume and to some degree human-readable.

pub fn primary_module(&self) -> &DynClientModule

Get the primary module

pub async fn get_balance(&self) -> Amount

Balance available to the client for spending

pub async fn subscribe_balance_changes(&self) -> BoxStream<'static, Amount>

Returns a stream that yields the current client balance every time it changes.

pub async fn discover_common_api_version(&self) -> Result<ApiVersionSet>

pub async fn discover_common_api_version_static( config: &ClientConfig, client_module_init: &ClientModuleInitRegistry, api: &DynGlobalApi ) -> Result<ApiVersionSet>

Query the federation for API version support and then calculate the best API version to use (supported by most guardians).

pub async fn supported_api_versions_summary_static( config: &ClientConfig, client_module_init: &ClientModuleInitRegistry ) -> SupportedApiVersionsSummary

SupportedApiVersionsSummary that the client and its modules support

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.