Struct bdk_cli::WalletOpt

pub struct WalletOpt {
    pub network: Network,
    pub wallet: String,
    pub proxy: Option<String>,
    pub descriptor: String,
    pub change_descriptor: Option<String>,
    pub esplora: Option<String>,
    pub esplora_concurrency: u8,
    pub electrum: String,
    pub subcommand: WalletSubCommand,
}

Wallet global options and sub-command

A structopt struct that parses wallet global options and sub-command from the command line or from a String vector. See WalletSubCommand for details on parsing sub-commands.

Example

let cli_args = vec!["bdk-cli", "--network", "testnet",
                    "--descriptor", "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/44'/1'/0'/0/*)",
                    "sync", "--max_addresses", "50"];

// to get WalletOpt from OS command line args use:
// let wallet_opt = WalletOpt::from_args();

let wallet_opt = WalletOpt::from_iter(&cli_args);

let expected_wallet_opt = WalletOpt {
        network: Network::Testnet,
        wallet: "main".to_string(),
        proxy: None,
        descriptor: "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/44'/1'/0'/0/*)".to_string(),
        change_descriptor: None,
        #[cfg(feature = "esplora")]
        esplora: None,
        #[cfg(feature = "esplora")]
        esplora_concurrency: 4,
        electrum: "ssl://electrum.blockstream.info:60002".to_string(),
        subcommand: WalletSubCommand::Sync {
            max_addresses: Some(50)
        },
};

assert_eq!(expected_wallet_opt, wallet_opt);

Fields

network: Network

Sets the network

wallet: String

Selects the wallet to use

proxy: Option<String>

Sets the SOCKS5 proxy for the Electrum client

descriptor: String

Sets the descriptor to use for the external addresses

change_descriptor: Option<String>

Sets the descriptor to use for internal addresses

esplora: Option<String>

Use the esplora server if given as parameter

esplora_concurrency: u8

Concurrency of requests made to the esplora server

electrum: String

Sets the Electrum server to use

subcommand: WalletSubCommand

Wallet sub-command

Trait Implementations

impl Clone for WalletOpt

pub fn clone(&self) -> WalletOpt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WalletOpt

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

Formats the value using the given formatter.

impl PartialEq<WalletOpt> for WalletOpt

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

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

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

This method tests for !=.

impl StructOpt for WalletOpt

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 WalletOpt

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

pub fn is_subcommand() -> bool

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

impl StructuralPartialEq for WalletOpt