Enum bdk_cli::WalletSubCommand

pub enum WalletSubCommand {
    GetNewAddress,
    Sync {
        max_addresses: Option<u32>,
    },
    ListUnspent,
    ListTransactions,
    GetBalance,
    CreateTx {
        recipients: Vec<(Script, u64)>,
        send_all: bool,
        enable_rbf: bool,
        offline_signer: bool,
        utxos: Option<Vec<OutPoint>>,
        unspendable: Option<Vec<OutPoint>>,
        fee_rate: Option<f32>,
        external_policy: Option<String>,
        internal_policy: Option<String>,
    },
    BumpFee {
        txid: String,
        send_all: bool,
        offline_signer: bool,
        utxos: Option<Vec<OutPoint>>,
        unspendable: Option<Vec<OutPoint>>,
        fee_rate: f32,
    },
    Policies,
    PublicDescriptor,
    Sign {
        psbt: String,
        assume_height: Option<u32>,
    },
    Broadcast {
        psbt: Option<String>,
        tx: Option<String>,
    },
    ExtractPsbt {
        psbt: String,
    },
    FinalizePsbt {
        psbt: String,
        assume_height: Option<u32>,
    },
    CombinePsbt {
        psbt: Vec<String>,
    },
    Repl,
}

Wallet sub-command

A structopt enum that parses wallet sub-command arguments from the command line or from a String vector, such as in the bdk-cli example cli wallet.

Example

let sync_sub_command = WalletSubCommand::from_iter(&["bdk-cli", "sync", "--max_addresses", "50"]);
assert!(matches!(
    sync_sub_command,
    WalletSubCommand::Sync {
        max_addresses: Some(50)
    }
));

To capture wallet sub-commands from a string vector without a preceeding binary name you can create a custom struct the includes the NoBinaryName clap setting and wraps the WalletSubCommand enum. See also the bdk-cli example app.

Example

#[derive(Debug, StructOpt, Clone, PartialEq)]
#[structopt(name = "BDK CLI", setting = AppSettings::NoBinaryName,
version = option_env ! ("CARGO_PKG_VERSION").unwrap_or("unknown"),
author = option_env ! ("CARGO_PKG_AUTHORS").unwrap_or(""))]
struct ReplOpt {
    /// Wallet sub-command
    #[structopt(subcommand)]
    pub subcommand: WalletSubCommand,
}

Variants

GetNewAddress

Generates a new external address

Sync

Syncs with the chosen blockchain server

Fields of Sync

max_addresses: Option<u32>

max addresses to consider

ListUnspent

Lists the available spendable UTXOs

ListTransactions

Lists all the incoming and outgoing transactions of the wallet

GetBalance

Returns the current wallet balance

CreateTx

Creates a new unsigned transaction

Fields of CreateTx

recipients: Vec<(Script, u64)>

Adds a recipient to the transaction

send_all: bool

Sends all the funds (or all the selected utxos). Requires only one recipients of value 0

enable_rbf: bool

Enables Replace-By-Fee (BIP125)

offline_signer: bool

Make a PSBT that can be signed by offline signers and hardware wallets. Forces the addition of non_witness_utxo and more details to let the signer identify the change output.

utxos: Option<Vec<OutPoint>>

Selects which utxos must be spent

unspendable: Option<Vec<OutPoint>>

Marks a utxo as unspendable

fee_rate: Option<f32>

Fee rate to use in sat/vbyte

external_policy: Option<String>

Selects which policy should be used to satisfy the external descriptor

internal_policy: Option<String>

Selects which policy should be used to satisfy the internal descriptor

BumpFee

Bumps the fees of an RBF transaction

Fields of BumpFee

txid: String

TXID of the transaction to update

send_all: bool

Allows the wallet to reduce the amount of the only output in order to increase fees. This is generally the expected behavior for transactions originally created with send_all

offline_signer: bool

Make a PSBT that can be signed by offline signers and hardware wallets. Forces the addition of non_witness_utxo and more details to let the signer identify the change output.

utxos: Option<Vec<OutPoint>>

Selects which utxos must be added to the tx. Unconfirmed utxos cannot be used

unspendable: Option<Vec<OutPoint>>

Marks an utxo as unspendable, in case more inputs are needed to cover the extra fees

fee_rate: f32

The new targeted fee rate in sat/vbyte

Policies

Returns the available spending policies for the descriptor

PublicDescriptor

Returns the public version of the wallet's descriptor(s)

Sign

Signs and tries to finalize a PSBT

Fields of Sign

psbt: String

Sets the PSBT to sign

assume_height: Option<u32>

Assume the blockchain has reached a specific height. This affects the transaction finalization, if there are timelocks in the descriptor

Broadcast

Broadcasts a transaction to the network. Takes either a raw transaction or a PSBT to extract

Fields of Broadcast

psbt: Option<String>

Sets the PSBT to sign

tx: Option<String>

Sets the raw transaction to broadcast

ExtractPsbt

Extracts a raw transaction from a PSBT

Fields of ExtractPsbt

psbt: String

Sets the PSBT to extract

FinalizePsbt

Finalizes a PSBT

Fields of FinalizePsbt

psbt: String

Sets the PSBT to finalize

assume_height: Option<u32>

Assume the blockchain has reached a specific height

CombinePsbt

Combines multiple PSBTs into one

Fields of CombinePsbt

psbt: Vec<String>

Add one PSBT to combine. This option can be repeated multiple times, one for each PSBT

Repl

Enter REPL command loop mode

Trait Implementations

impl Clone for WalletSubCommand

pub fn clone(&self) -> WalletSubCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WalletSubCommand

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

Formats the value using the given formatter.

impl PartialEq<WalletSubCommand> for WalletSubCommand

pub fn eq(&self, other: &WalletSubCommand) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &WalletSubCommand) -> bool

This method tests for !=.

impl StructOpt for WalletSubCommand

pub fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

pub fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It's guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

pub fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

pub fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

pub fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for WalletSubCommand

pub fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

pub fn from_subcommand<'a, 'b>(
    sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>

pub fn is_subcommand() -> bool

impl StructuralPartialEq for WalletSubCommand