Struct bdk_cli::WalletOpts

pub struct WalletOpts {
    pub wallet: String,
    pub verbose: bool,
    pub descriptor: String,
    pub change_descriptor: Option<String>,
    pub electrum_opts: ElectrumOpts,
    pub proxy_opts: ProxyOpts,
}

Wallet options

The wallet options required for all CliSubCommand::Wallet or CliSubCommand::Repl sub-commands. These options capture wallet descriptor and blockchain client information. The blockchain client details are only used for OnlineWalletSubCommands.

Example

let cli_args = vec!["wallet",
                    "--descriptor", "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/44'/1'/0'/0/*)"];

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

let wallet_opts = WalletOpts::from_iter(&cli_args);

let expected_wallet_opts = WalletOpts {
              wallet: "main".to_string(),
                    verbose: false,
              descriptor: "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/44'/1'/0'/0/*)".to_string(),
              change_descriptor: None,
              #[cfg(feature = "electrum")]
              electrum_opts: ElectrumOpts {
                  timeout: None,
                  server: "ssl://electrum.blockstream.info:60002".to_string(),
                  stop_gap: 10
              },
              #[cfg(feature = "esplora-ureq")]
              esplora_opts: EsploraOpts {
                  server: "https://blockstream.info/testnet/api/".to_string(),
                  read_timeout: 5,
                  write_timeout: 5,
                  stop_gap: 10
              },
              #[cfg(feature = "esplora-reqwest")]
              esplora_opts: EsploraOpts {
                  server: "https://blockstream.info/testnet/api/".to_string(),
                  conc: 4,
                  stop_gap: 10
              },
               #[cfg(feature = "compact_filters")]
               compactfilter_opts: CompactFilterOpts{
                   address: vec!["127.0.0.1:18444".to_string()],
                   conn_count: 4,
                   skip_blocks: 0,
               },
                #[cfg(feature = "rpc")]
                rpc_opts: RpcOpts{
                   address: "127.0.0.1:18443".to_string(),
                   auth: ("user".to_string(), "password".to_string()),
                   skip_blocks: None,
               },
              #[cfg(any(feature="compact_filters", feature="electrum", feature="esplora"))]
                   proxy_opts: ProxyOpts{
                       proxy: None,
                       proxy_auth: None,
                       retries: 5,
              },
};

assert_eq!(expected_wallet_opts, wallet_opts);

Fields

wallet: String

Selects the wallet to use

verbose: bool

Adds verbosity, returns PSBT in JSON format alongside serialized, displays expanded objects

descriptor: String

Sets the descriptor to use for the external addresses

change_descriptor: Option<String>

Sets the descriptor to use for internal addresses

electrum_opts: ElectrumOpts

proxy_opts: ProxyOpts

Trait Implementations

impl Clone for WalletOpts

fn clone(&self) -> WalletOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WalletOpts

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

Formats the value using the given formatter.

impl PartialEq<WalletOpts> for WalletOpts

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

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

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

This method tests for !=.

impl StructOpt for WalletOpts

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

Returns clap::App corresponding to the struct.

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.

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.

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.

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.

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 StructuralPartialEq for WalletOpts