Struct sc_cli::NodeKeyParams

pub struct NodeKeyParams {
    pub node_key: Option<String>,
    pub node_key_type: NodeKeyType,
    pub node_key_file: Option<PathBuf>,
}

Parameters used to create the NodeKeyConfig, which determines the keypair used for libp2p networking.

Fields

node_key: Option<String>

The secret key to use for libp2p networking.

The value is a string that is parsed according to the choice of --node-key-type as follows:

ed25519: The value is parsed as a hex-encoded Ed25519 32 byte secret key, i.e. 64 hex characters.

The value of this option takes precedence over --node-key-file.

WARNING: Secrets provided as command-line arguments are easily exposed. Use of this option should be limited to development and testing. To use an externally managed secret key, use --node-key-file instead.

node_key_type: NodeKeyType

The type of secret key to use for libp2p networking.

The secret key of the node is obtained as follows:

• If the --node-key option is given, the value is parsed as a secret key according to the type. See the documentation for --node-key.

• If the --node-key-file option is given, the secret key is read from the specified file. See the documentation for --node-key-file.

• Otherwise, the secret key is read from a file with a predetermined, type-specific name from the chain-specific network config directory inside the base directory specified by --base-dir. If this file does not exist, it is created with a newly generated secret key of the chosen type.

The node’s secret key determines the corresponding public key and hence the node’s peer ID in the context of libp2p.

node_key_file: Option<PathBuf>

The file from which to read the node’s secret key to use for libp2p networking.

The contents of the file are parsed according to the choice of --node-key-type as follows:

ed25519: The file must contain an unencoded 32 byte or hex encoded Ed25519 secret key.

If the file does not exist, it is created with a newly generated secret key of the chosen type.

Implementations

impl NodeKeyParams

pub fn node_key(&self, net_config_dir: &PathBuf) -> Result<NodeKeyConfig>

Create a NodeKeyConfig from the given NodeKeyParams in the context of an optional network config storage directory.

Trait Implementations

impl Clone for NodeKeyParams

fn clone(&self) -> NodeKeyParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeKeyParams

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

Formats the value using the given formatter.

impl StructOpt for NodeKeyParams

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.