Struct sc_cli::RunCmd

pub struct RunCmd {
    pub validator: bool,
    pub sentry: bool,
    pub no_grandpa: bool,
    pub light: bool,
    pub rpc_external: bool,
    pub unsafe_rpc_external: bool,
    pub ws_external: bool,
    pub unsafe_ws_external: bool,
    pub prometheus_external: bool,
    pub rpc_port: Option<u16>,
    pub ws_port: Option<u16>,
    pub ws_max_connections: Option<usize>,
    pub rpc_cors: Option<Cors>,
    pub prometheus_port: Option<u16>,
    pub no_prometheus: bool,
    pub name: Option<String>,
    pub no_telemetry: bool,
    pub telemetry_endpoints: Vec<(String, u8)>,
    pub offchain_worker: OffchainWorkerEnabled,
    pub shared_params: SharedParams,
    pub import_params: ImportParams,
    pub network_config: NetworkConfigurationParams,
    pub pool_config: TransactionPoolParams,
    pub alice: bool,
    pub bob: bool,
    pub charlie: bool,
    pub dave: bool,
    pub eve: bool,
    pub ferdie: bool,
    pub one: bool,
    pub two: bool,
    pub force_authoring: bool,
    pub keystore_path: Option<PathBuf>,
    pub password_interactive: bool,
    pub password: Option<String>,
    pub password_filename: Option<PathBuf>,
    pub max_runtime_instances: usize,
}

The run command used to run a node.

Fields

validator: bool

Enable validator mode.

The node will be started with the authority role and actively participate in any consensus task that it can (e.g. depending on availability of local keys).

sentry: bool

Enable sentry mode.

The node will be started with the authority role and participate in consensus tasks as an "observer", it will never actively participate regardless of whether it could (e.g. keys are available locally). This mode is useful as a secure proxy for validators (which would run detached from the network), since we want this node to participate in the full consensus protocols in order to have all needed consensus data available to relay to private nodes.

no_grandpa: bool

Disable GRANDPA voter when running in validator mode, otherwise disable the GRANDPA observer.

light: bool

Experimental: Run in light client mode.

rpc_external: bool

Listen to all RPC interfaces.

Default is local. Note: not all RPC methods are safe to be exposed publicly. Use an RPC proxy server to filter out dangerous methods. More details: https://github.com/paritytech/substrate/wiki/Public-RPC. Use --unsafe-rpc-external to suppress the warning if you understand the risks.

unsafe_rpc_external: bool

Listen to all RPC interfaces.

Same as --rpc-external.

ws_external: bool

Listen to all Websocket interfaces.

Default is local. Note: not all RPC methods are safe to be exposed publicly. Use an RPC proxy server to filter out dangerous methods. More details: https://github.com/paritytech/substrate/wiki/Public-RPC. Use --unsafe-ws-external to suppress the warning if you understand the risks.

unsafe_ws_external: bool

Listen to all Websocket interfaces.

Same as --ws-external but doesn't warn you about it.

prometheus_external: bool

Listen to all Prometheus data source interfaces.

Default is local.

rpc_port: Option<u16>

Specify HTTP RPC server TCP port.

ws_port: Option<u16>

Specify WebSockets RPC server TCP port.

ws_max_connections: Option<usize>

Maximum number of WS RPC server connections.

rpc_cors: Option<Cors>

Specify browser Origins allowed to access the HTTP & WS RPC servers.

A comma-separated list of origins (protocol://domain or special null value). Value of all will disable origin validation. Default is to allow localhost and https://polkadot.js.org origins. When running in --dev mode the default is to allow all origins.

prometheus_port: Option<u16>

Specify Prometheus data source server TCP Port.

no_prometheus: bool

Do not expose a Prometheus metric endpoint.

Prometheus metric endpoint is enabled by default.

name: Option<String>

The human-readable name for this node.

The node name will be reported to the telemetry server, if enabled.

no_telemetry: bool

Disable connecting to the Substrate telemetry server.

Telemetry is on by default on global chains.

telemetry_endpoints: Vec<(String, u8)>

The URL of the telemetry server to connect to.

This flag can be passed multiple times as a means to specify multiple telemetry endpoints. Verbosity levels range from 0-9, with 0 denoting the least verbosity. If no verbosity level is specified the default is 0.

offchain_worker: OffchainWorkerEnabled

Should execute offchain workers on every block.

By default it's only enabled for nodes that are authoring new blocks.

shared_params: SharedParams

import_params: ImportParams

network_config: NetworkConfigurationParams

pool_config: TransactionPoolParams

alice: bool

Shortcut for --name Alice --validator with session keys for Alice added to keystore.

bob: bool

Shortcut for --name Bob --validator with session keys for Bob added to keystore.

charlie: bool

Shortcut for --name Charlie --validator with session keys for Charlie added to keystore.

dave: bool

Shortcut for --name Dave --validator with session keys for Dave added to keystore.

eve: bool

Shortcut for --name Eve --validator with session keys for Eve added to keystore.

ferdie: bool

Shortcut for --name Ferdie --validator with session keys for Ferdie added to keystore.

one: bool

Shortcut for --name One --validator with session keys for One added to keystore.

two: bool

Shortcut for --name Two --validator with session keys for Two added to keystore.

force_authoring: bool

Enable authoring even when offline.

keystore_path: Option<PathBuf>

Specify custom keystore path.

password_interactive: bool

Use interactive shell for entering the password used by the keystore.

password: Option<String>

Password used by the keystore.

password_filename: Option<PathBuf>

File that contains the password used by the keystore.

max_runtime_instances: usize

The size of the instances cache for each runtime.

The default value is 8 and the values higher than 256 are ignored.

Methods

impl RunCmd

pub fn get_keyring(&self) -> Option<Sr25519Keyring>

Get the Sr25519Keyring matching one of the flag.

pub fn update_config<F>(
    &self,
    config: &mut Configuration,
    spec_factory: F,
    version: &VersionInfo
) -> Result<()> where
    F: FnOnce(&str) -> Result<Box<dyn ChainSpec>, String>, 

Update and prepare a Configuration with command line parameters of RunCmd and VersionInfo.

pub fn run<FNL, FNF, SL, SF>(
    self,
    config: Configuration,
    new_light: FNL,
    new_full: FNF,
    version: &VersionInfo
) -> Result<()> where
    FNL: FnOnce(Configuration) -> Result<SL, Error>,
    FNF: FnOnce(Configuration) -> Result<SF, Error>,
    SL: AbstractService + Unpin,
    SF: AbstractService + Unpin, 

Run the command that runs the node.

pub fn init(&self, version: &VersionInfo) -> Result<()>

Initialize substrate. This must be done only once.

This method:

1. Set the panic handler
2. Raise the FD limit
3. Initialize the logger

Trait Implementations

impl Clone for RunCmd

fn clone(&self) -> RunCmd

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RunCmd

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

Formats the value using the given formatter.

impl StructOpt for RunCmd

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

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

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 StructOptInternal for RunCmd

fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

fn is_subcommand() -> bool

fn from_subcommand(_sub: (&'b str, Option<&'b ArgMatches<'a>>)) -> Option<Self>