Struct WalletClientModule

pub struct WalletClientModule {
    pub(crate) data: WalletClientModuleData,
    pub(crate) db: Database,
    pub(crate) module_api: DynModuleApi,
    pub(crate) notifier: ModuleNotifier<WalletClientStates>,
    pub(crate) rpc: DynBitcoindRpc,
    pub(crate) client_ctx: ClientContext<Self>,
    pub(crate) pegin_monitor_wakeup_sender: Sender<()>,
    pub(crate) pegin_monitor_wakeup_receiver: Receiver<()>,
    pub(crate) pegin_claimed_sender: Sender<()>,
    pub(crate) pegin_claimed_receiver: Receiver<()>,
    pub(crate) task_group: TaskGroup,
    pub(crate) admin_auth: Option<ApiAuth>,
}

Fields

data: WalletClientModuleData

db: Database

module_api: DynModuleApi

notifier: ModuleNotifier<WalletClientStates>

rpc: DynBitcoindRpc

client_ctx: ClientContext<Self>

pegin_monitor_wakeup_sender: Sender<()>

Updated to wake up pegin monitor

pegin_monitor_wakeup_receiver: Receiver<()>

pegin_claimed_sender: Sender<()>

Called every time a peg-in was claimed

pegin_claimed_receiver: Receiver<()>

task_group: TaskGroup

admin_auth: Option<ApiAuth>

Implementations

impl WalletClientModule

pub(crate) fn cfg(&self) -> &WalletClientConfig

pub(crate) fn get_rpc_config(cfg: &WalletClientConfig) -> BitcoinRpcConfig

pub fn get_network(&self) -> Network

pub fn get_fee_consensus(&self) -> FeeConsensus

pub(crate) async fn allocate_deposit_address_inner( &self, dbtx: &mut DatabaseTransaction<'_>, ) -> (OperationId, Address, TweakIdx)

pub async fn get_withdraw_fees( &self, address: Address<NetworkUnchecked>, amount: Amount, ) -> Result<PegOutFees>

Fetches the fees that would need to be paid to make the withdraw request using Self::withdraw work right now.

Note that we do not receive a guarantee that these fees will be valid in the future, thus even the next second using these fees may fail. The caller should be prepared to retry with a new fee estimate.

pub async fn get_wallet_summary(&self) -> Result<WalletSummary>

Returns a summary of the wallet’s coins

pub fn create_withdraw_output( &self, operation_id: OperationId, address: &Address<NetworkUnchecked>, amount: Amount, fees: PegOutFees, ) -> Result<ClientOutputBundle<WalletOutput, WalletClientStates>>

pub fn create_rbf_withdraw_output( &self, operation_id: OperationId, rbf: &Rbf, ) -> Result<ClientOutputBundle<WalletOutput, WalletClientStates>>

pub async fn allocate_deposit_address_expert_only<M>( &self, extra_meta: M, ) -> Result<(OperationId, Address, TweakIdx)>

where M: Serialize + MaybeSend + MaybeSync,

Allocates a deposit address that is controlled by the federation.

This is an EXPERT ONLY method intended for power users such as Lightning gateways allocating liquidity, and we discourage exposing peg-in functionality to everyday users of a Fedimint wallet due to the following two limitations:

The transaction sending to this address needs to be smaller than 40KB in order for the peg-in to be claimable. If the transaction is too large, funds will be lost.

In the future, federations will also enforce a minimum peg-in amount to prevent accumulation of dust UTXOs. Peg-ins under this minimum cannot be claimed and funds will be lost.

Everyday users should rely on Lightning to move funds into the federation.

pub async fn subscribe_deposit( &self, operation_id: OperationId, ) -> Result<UpdateStreamOrOutcome<DepositStateV2>>

Returns a stream of updates about an ongoing deposit operation created with WalletClientModule::allocate_deposit_address_expert_only. Returns an error for old deposit operations created prior to the 0.4 release and not driven to completion yet. This should be rare enough that an indeterminate state is ok here.

pub async fn find_tweak_idx_by_operation_id( &self, operation_id: OperationId, ) -> Result<TweakIdx>

pub async fn get_pegin_tweak_idx( &self, tweak_idx: TweakIdx, ) -> Result<PegInTweakIndexData>

pub async fn get_claimed_pegins( &self, dbtx: &mut DatabaseTransaction<'_>, tweak_idx: TweakIdx, ) -> Vec<(OutPoint, TransactionId, Vec<OutPoint>)>

pub async fn recheck_pegin_address_by_op_id( &self, operation_id: OperationId, ) -> Result<()>

Like Self::recheck_pegin_address but by operation_id

pub async fn recheck_pegin_address(&self, tweak_idx: TweakIdx) -> Result<()>

Schedule given address for immediate re-check for deposits

pub async fn await_num_deposit_by_operation_id( &self, operation_id: OperationId, num_deposits: usize, ) -> Result<()>

Await for num deposit by OperationId

pub async fn await_num_deposits( &self, tweak_idx: TweakIdx, num_deposits: usize, ) -> Result<()>

pub async fn withdraw<M: Serialize + MaybeSend + MaybeSync>( &self, address: Address<NetworkUnchecked>, amount: Amount, fee: PegOutFees, extra_meta: M, ) -> Result<OperationId>

Attempt to withdraw a given amount of Bitcoin to a destination address. The caller has to supply the fee rate to be used which can be fetched using Self::get_withdraw_fees and should be acknowledged by the user since it can be unexpectedly high.

pub async fn rbf_withdraw<M: Serialize + MaybeSync + MaybeSend>( &self, rbf: Rbf, extra_meta: M, ) -> Result<OperationId>

👎Deprecated since 0.4.0: RBF withdrawals are rejected by the federation

Attempt to increase the fee of a onchain withdraw transaction using replace by fee (RBF). This can prevent transactions from getting stuck in the mempool

pub async fn subscribe_withdraw_updates( &self, operation_id: OperationId, ) -> Result<UpdateStreamOrOutcome<WithdrawState>>

Trait Implementations

impl ClientModule for WalletClientModule

type Init = WalletClientInit

type Common = WalletModuleTypes

Common module types shared between client and server

type Backup = WalletModuleBackup

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

type ModuleStateMachineContext = WalletClientContext

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

type States = WalletClientStates

All possible states this client can submit to the executor

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

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

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

Initialize client.

fn supports_backup(&self) -> bool

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

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

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

Returns the fee the processing of this input requires.

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

Returns the fee the processing of this output requires.

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

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

fn decoder() -> Decoder

fn kind() -> ModuleKind

fn handle_rpc<'life0, 'async_trait>( &'life0 self, _method: String, _request: Value, ) -> Pin<Box<dyn Future<Output = Pin<Box<dyn Stream<Item = Result<Value, Error>> + Send + 'life0>>> + Send + 'async_trait>>

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

fn supports_being_primary(&self) -> bool

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, _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>), Error>> + 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. The function returns an error if and only if the client’s funds are not sufficient to create the inputs necessary to fully fund the transaction.

fn await_primary_module_output<'life0, 'async_trait>( &'life0 self, _operation_id: OperationId, _out_point: OutPoint, ) -> Pin<Box<dyn Future<Output = Result<Amount, Error>> + 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>, ) -> 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 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<(), Error>> + Send + 'async_trait>>

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

Leave the federation

impl Debug for WalletClientModule

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

Formats the value using the given formatter.