Enum bdk_cli::KeySubCommand

pub enum KeySubCommand {
    Generate {
        word_count: usize,
        password: Option<String>,
    },
    Restore {
        mnemonic: String,
        password: Option<String>,
    },
    Derive {
        xprv: ExtendedPrivKey,
        path: DerivationPath,
    },
}

Key sub-command

Provides basic key operations that are not related to a specific wallet such as generating a new random master extended key or restoring a master extended key from mnemonic words.

These sub-commands are EXPERIMENTAL and should only be used for testing. Do not use this feature to create keys that secure actual funds on the Bitcoin mainnet.

Variants

Generate

Fields

word_count: usize

Entropy level based on number of random seed mnemonic words

password: Option<String>

Seed password

Generates new random seed mnemonic phrase and corresponding master extended key

Restore

Fields

mnemonic: String

Seed mnemonic words, must be quoted (eg. “word1 word2 …”)

password: Option<String>

Seed password

Restore a master extended key from seed backup mnemonic words

Derive

Fields

xprv: ExtendedPrivKey

Extended private key to derive from

path: DerivationPath

Path to use to derive extended public key from extended private key

Derive a child key pair from a master extended key and a derivation path string (eg. “m/84’/1’/0’/0” or “m/84h/1h/0h/0”)

Trait Implementations

impl Clone for KeySubCommand

fn clone(&self) -> KeySubCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeySubCommand

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

Formats the value using the given formatter.

impl PartialEq<KeySubCommand> for KeySubCommand

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

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

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

This method tests for !=.

impl StructOpt for KeySubCommand

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 KeySubCommand