Struct sc_cli::NodeKeyParams

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

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

Fields

node_key: Option<String>

Secret key to use for p2p 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 (64 hex chars)

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

Crypto primitive to use for p2p 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>

File from which to read the node’s secret key to use for p2p 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.

unsafe_force_node_key_generation: bool

Forces key generation if node-key-file file does not exist.

This is an unsafe feature for production networks, because as an active authority other authorities may depend on your node having a stable identity and they might not being able to reach you if your identity changes after entering the active set.

For minimal node downtime if no custom node-key-file argument is provided the network-key is usually persisted accross nodes restarts, in the network folder from directory provided in --base-path

Warning!! If you ever run the node with this argument, make sure you remove it for the subsequent restarts.

Implementations

impl NodeKeyParams

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

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

Trait Implementations

impl Args for NodeKeyParams

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.

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

Append to [Command] so it can update self.

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 FromArgMatches for NodeKeyParams

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.