Struct KeySetOptions 

pub struct KeySetOptions {
    pub mnemonic: Option<Mnemonic<English>>,
    pub index: Option<u64>,
    pub key_file: Option<PathBuf>,
    pub private_staking_key: Option<TaggedBase64>,
    pub private_state_key: Option<TaggedBase64>,
    pub private_x25519_key: Option<TaggedBase64>,
}

Keys can be specified in one of three ways:

• A mnemonic phrase
• A path to a key file
• Individual private keys set via environment variable

Note that the third option always takes precedence, but if not all keys are specified explicitly in this way, one of the first two options may be used to generate the remaining keys.

Fields

mnemonic: Option<Mnemonic<English>>

Mnemonic phrase used to generate keys.

index: Option<u64>

Optional index to enable generating multiple keysets from the same mnemonic.

key_file: Option<PathBuf>

Path to file containing private keys.

The file should follow the .env format, with two keys:

• ESPRESSO_SEQUENCER_PRIVATE_STAKING_KEY
• ESPRESSO_SEQUENCER_PRIVATE_STATE_KEY

Appropriate key files can be generated with the keygen utility program.

private_staking_key: Option<TaggedBase64>

Private staking key.

This can be used as an alternative to MNEMONIC or KEY_FILE.

private_state_key: Option<TaggedBase64>

Private state signing key.

This can be used as an alternative to MNEMONIC or KEY_FILE.

private_x25519_key: Option<TaggedBase64>

Private x25519 key.

This can be used as an alternative to MNEMONIC or KEY_FILE.

Trait Implementations

impl Args for KeySetOptions

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

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

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

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

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

impl Clone for KeySetOptions

fn clone(&self) -> KeySetOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for KeySetOptions

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for KeySetOptions

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

Formats the value using the given formatter.

impl FromArgMatches for KeySetOptions

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for KeySetOptions

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl TryFrom<KeySetOptions> for KeySet

type Error = Error

The type returned in the event of a conversion error.

fn try_from(opt: KeySetOptions) -> Result<Self, Self::Error>

Performs the conversion.