Struct MetaClientModule 

pub struct MetaClientModule {
    pub(crate) module_api: DynModuleApi,
    pub(crate) admin_auth: Option<ApiAuth>,
}

Fields

module_api: DynModuleApi

admin_auth: Option<ApiAuth>

Implementations

impl MetaClientModule

pub(crate) fn admin_auth(&self) -> Result<ApiAuth, MetaAdminError>

The admin credentials this client was built with.

Errors

Fails with MetaAdminError::AdminAuthMissing if the client was built without them.

pub async fn submit( &self, key: MetaKey, value: MetaValue, ) -> Result<(), MetaAdminError>

Submit a meta consensus value

When threshold amount of peers submits the exact same value it becomes a new consensus value.

To “cancel” previous vote, peer can submit a value equal to the current consensus value.

Errors

Fails with MetaAdminError::AdminAuthMissing if this client holds no admin credentials, and with MetaAdminError::Federation if the guardians could not be asked to record the vote.

pub async fn get_consensus_value( &self, key: MetaKey, ) -> Result<Option<MetaConsensusValue>, FederationError>

Get the current meta consensus value along with it’s revision

See Self::get_consensus_value_rev to use when checking for updates.

Errors

Fails with a FederationError if the federation could not be asked for the value.

pub async fn get_consensus_value_rev( &self, key: MetaKey, ) -> Result<Option<u64>, FederationError>

Get the current meta consensus value revision

Each time a meta consensus value changes, the revision increases, so checking just the revision can save a lot of bandwidth in periodic checks.

Errors

Fails with a FederationError if the federation could not be asked for the revision.

pub async fn get_submissions( &self, key: MetaKey, ) -> Result<BTreeMap<PeerId, MetaValue>, MetaAdminError>

Get current submissions to change the meta consensus value.

Upon changing the consensus

Errors

Fails with MetaAdminError::AdminAuthMissing if this client holds no admin credentials, and with MetaAdminError::Federation if the guardians could not be asked for their submissions.

Trait Implementations

impl ClientModule for MetaClientModule

type Init = MetaClientInit

type Common = MetaModuleTypes

Common module types shared between client and server

type Backup = NoModuleBackup

Data stored in regular backups so that restoring doesn’t have to start from epoch 0

type ModuleStateMachineContext = MetaClientContext

Data and API clients available to state machine transitions of this module

type States = MetaStateMachine

All possible states this client can submit to the executor

fn context(&self) -> Self::ModuleStateMachineContext

fn input_fee( &self, _amount: &Amounts, _input: &<Self::Common as ModuleCommon>::Input, ) -> Option<Amounts>

Returns the fee the processing of this input requires.

fn output_fee( &self, _amount: &Amounts, _output: &<Self::Common as ModuleCommon>::Output, ) -> Option<Amounts>

Returns the fee the processing of this output requires.

fn handle_rpc<'life0, 'async_trait>( &'life0 self, method: String, request: Value, ) -> Pin<Box<dyn Future<Output = BoxStream<'_, Result<Value, ClientModuleError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Serves a JSON request, such as one fedimint-client-rpc forwards.

fn handle_cli_command<'life0, 'life1, 'async_trait>( &'life0 self, args: &'life1 [OsString], ) -> Pin<Box<dyn Future<Output = Result<Value, ClientModuleError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Runs a fedimint-cli module command, given as its arguments.

fn decoder() -> Decoder

fn kind() -> ModuleKind

fn start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Initialize client.

fn supports_backup(&self) -> bool

fn backup<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self::Backup, ClientModuleError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

The module’s part of a client backup.

fn supports_being_primary(&self) -> PrimaryModuleSupport

Does this module support being a primary module

fn create_final_inputs_and_outputs<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _dbtx: &'life1 mut DatabaseTransaction<'life2>, _operation_id: OperationId, _unit: AmountUnit, _input_amount: Amount, _output_amount: Amount, ) -> Pin<Box<dyn Future<Output = Result<(ClientInputBundle<<Self::Common as ModuleCommon>::Input, Self::States>, ClientOutputBundle<<Self::Common as ModuleCommon>::Output, Self::States>), ClientModuleError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: Sync + 'async_trait,

Creates all inputs and outputs necessary to balance the transaction.

fn await_primary_module_output<'life0, 'async_trait>( &'life0 self, _operation_id: OperationId, _out_point: OutPoint, ) -> Pin<Box<dyn Future<Output = Result<(), ClientModuleError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Waits for the funds from an output created by [Self::create_final_inputs_and_outputs] to become available. This function returning typically implies a change in the output of [Self::get_balance].

fn get_balance<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _dbtx: &'life1 mut DatabaseTransaction<'life2>, _unit: AmountUnit, ) -> Pin<Box<dyn Future<Output = Amount> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: Sync + 'async_trait,

Returns the balance held by this module and available for funding transactions.

fn get_balances<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _dbtx: &'life1 mut DatabaseTransaction<'life2>, ) -> Pin<Box<dyn Future<Output = Amounts> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: Sync + 'async_trait,

Returns the balance held by this module and available for funding transactions.

fn subscribe_balance_changes<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Pin<Box<dyn Stream<Item = ()> + Send>>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Returns a stream that will output the updated module balance each time it changes.

fn leave<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _dbtx: &'life1 mut DatabaseTransaction<'life2>, ) -> Pin<Box<dyn Future<Output = Result<(), ClientModuleError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: Sync + 'async_trait,

Leave the federation

impl Debug for MetaClientModule

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

Formats the value using the given formatter.