Enum ClientCmd

pub enum ClientCmd {
    Info,
    Reissue {
        oob_notes: OOBNotes,
        wait: bool,
    },
    Spend {
        amount: Amount,
        allow_overpay: bool,
        timeout: u64,
        include_invite: bool,
    },
    Validate {
        oob_notes: OOBNotes,
    },
    Split {
        oob_notes: OOBNotes,
    },
    Combine {
        oob_notes: Vec<OOBNotes>,
    },
    LnInvoice {
        amount: Amount,
        description: String,
        expiry_time: Option<u64>,
        gateway_id: Option<PublicKey>,
        force_internal: bool,
    },
    AwaitInvoice {
        operation_id: OperationId,
    },
    LnPay {
        payment_info: String,
        amount: Option<Amount>,
        lnurl_comment: Option<String>,
        finish_in_background: bool,
        gateway_id: Option<PublicKey>,
        force_internal: bool,
    },
    AwaitLnPay {
        operation_id: OperationId,
    },
    ListGateways {
        no_update: bool,
    },
    DepositAddress,
    AwaitDeposit {
        operation_id: OperationId,
    },
    Withdraw {
        amount: BitcoinAmountOrAll,
        address: Address<NetworkUnchecked>,
    },
    Backup {
        metadata: Vec<String>,
    },
    DiscoverVersion,
    Restore {
        mnemonic: String,
        invite_code: String,
    },
    PrintSecret,
    ListOperations {
        limit: usize,
    },
    Module {
        module: Option<ModuleSelector>,
        args: Vec<OsString>,
    },
    Config,
    SessionCount,
}

Variants

Info

Display wallet info (holdings, tiers)

Reissue

Reissue notes received from a third party to avoid double spends

Fields

oob_notes: OOBNotes

wait: bool

Spend

Prepare notes to send to a third party as a payment

Fields

amount: Amount

The amount of e-cash to spend

allow_overpay: bool

If the exact amount cannot be represented, return e-cash of a higher value instead of failing

timeout: u64

After how many seconds we will try to reclaim the e-cash if it hasn’t been redeemed by the recipient. Defaults to one week.

include_invite: bool

If the necessary information to join the federation the e-cash belongs to should be included in the serialized notes

Validate

Verifies the signatures of e-cash notes, but not if they have been spent already

Fields

oob_notes: OOBNotes

Split

Splits a string containing multiple e-cash notes (e.g. from the spend command) into ones that contain exactly one.

Fields

oob_notes: OOBNotes

Combine

Combines two or more serialized e-cash notes strings

Fields

oob_notes: Vec<OOBNotes>

LnInvoice

Create a lightning invoice to receive payment via gateway

Fields

amount: Amount

description: String

expiry_time: Option<u64>

gateway_id: Option<PublicKey>

force_internal: bool

AwaitInvoice

Wait for incoming invoice to be paid

Fields

operation_id: OperationId

LnPay

Pay a lightning invoice or lnurl via a gateway

Fields

payment_info: String

Lightning invoice or lnurl

amount: Option<Amount>

Amount to pay, used for lnurl

lnurl_comment: Option<String>

Invoice comment/description, used on lnurl

finish_in_background: bool

Will return immediately after funding the payment

gateway_id: Option<PublicKey>

force_internal: bool

AwaitLnPay

Wait for a lightning payment to complete

Fields

operation_id: OperationId

ListGateways

List registered gateways

Fields

no_update: bool

Don’t fetch the registered gateways from the federation

DepositAddress

Generate a new deposit address, funds sent to it can later be claimed

AwaitDeposit

Wait for deposit on previously generated address

Fields

operation_id: OperationId

Withdraw

Withdraw funds from the federation

Fields

amount: BitcoinAmountOrAll

address: Address<NetworkUnchecked>

Backup

Upload the (encrypted) snapshot of mint notes to federation

Fields

metadata: Vec<String>

Backup metadata, encoded as key=value (use --metadata=key=value, possibly multiple times)

DiscoverVersion

Discover the common api version to use to communicate with the federation

Restore

Join federation and restore modules that support it

Fields

mnemonic: String

invite_code: String

PrintSecret

Print the secret key of the client

ListOperations

Fields

limit: usize

Module

Call a module subcommand

Fields

module: Option<ModuleSelector>

Module selector (either module id or module kind)

args: Vec<OsString>

Config

Returns the client config

SessionCount

Gets the current fedimint AlephBFT session count

Trait Implementations

impl Clone for ClientCmd

fn clone(&self) -> ClientCmd

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientCmd

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

Formats the value using the given formatter.

impl FromArgMatches for ClientCmd

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for ClientCmd

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand