Struct sc_cli::commands::RunCmd

pub struct RunCmd {

    pub validator: bool,
    pub no_grandpa: bool,
    pub rpc_external: bool,
    pub unsafe_rpc_external: bool,
    pub rpc_methods: RpcMethods,
    pub rpc_rate_limit: Option<NonZeroU32>,
    pub rpc_rate_limit_whitelisted_ips: Vec<IpNetwork>,
    pub rpc_rate_limit_trust_proxy_headers: bool,
    pub rpc_max_request_size: u32,
    pub rpc_max_response_size: u32,
    pub rpc_max_subscriptions_per_connection: u32,
    pub rpc_port: Option<u16>,
    pub rpc_max_connections: u32,
    pub rpc_message_buffer_capacity_per_connection: u32,
    pub rpc_disable_batch_requests: bool,
    pub rpc_max_batch_request_len: Option<u32>,
    pub rpc_cors: Option<Cors>,
    pub name: Option<String>,
    pub telemetry_params: TelemetryParams,
    pub prometheus_params: PrometheusParams,
    pub runtime_params: RuntimeParams,
    pub offchain_worker_params: OffchainWorkerParams,
    pub shared_params: SharedParams,
    pub import_params: ImportParams,
    pub network_params: NetworkParams,
    pub pool_config: TransactionPoolParams,
    pub keystore_params: KeystoreParams,
    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 tmp: bool,
}

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).

no_grandpa: bool

Disable GRANDPA.

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

rpc_external: bool

Listen to all RPC interfaces (default: local).

Not all RPC methods are safe to be exposed publicly.

Use an RPC proxy server to filter out dangerous methods. More details: https://docs.substrate.io/build/remote-procedure-calls/#public-rpc-interfaces.

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.

rpc_methods: RpcMethods

RPC methods to expose.

rpc_rate_limit: Option<NonZeroU32>

RPC rate limiting (calls/minute) for each connection.

This is disabled by default.

For example --rpc-rate-limit 10 will maximum allow 10 calls per minute per connection.

rpc_rate_limit_whitelisted_ips: Vec<IpNetwork>

Disable RPC rate limiting for certain ip addresses.

Each IP address must be in CIDR notation such as 1.2.3.4/24.

rpc_rate_limit_trust_proxy_headers: bool

Trust proxy headers for disable rate limiting.

By default the rpc server will not trust headers such X-Real-IP, X-Forwarded-For and Forwarded and this option will make the rpc server to trust these headers.

For instance this may be secure if the rpc server is behind a reverse proxy and that the proxy always sets these headers.

rpc_max_request_size: u32

Set the maximum RPC request payload size for both HTTP and WS in megabytes.

rpc_max_response_size: u32

Set the maximum RPC response payload size for both HTTP and WS in megabytes.

rpc_max_subscriptions_per_connection: u32

Set the maximum concurrent subscriptions per connection.

rpc_port: Option<u16>

Specify JSON-RPC server TCP port.

rpc_max_connections: u32

Maximum number of RPC server connections.

rpc_message_buffer_capacity_per_connection: u32

The number of messages the RPC server is allowed to keep in memory.

If the buffer becomes full then the server will not process new messages until the connected client start reading the underlying messages.

This applies per connection which includes both JSON-RPC methods calls and subscriptions.

rpc_disable_batch_requests: bool

Disable RPC batch requests

rpc_max_batch_request_len: Option<u32>

Limit the max length per RPC batch request

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.

name: Option<String>

The human-readable name for this node.

It’s used as network node name.

telemetry_params: TelemetryParams

prometheus_params: PrometheusParams

runtime_params: RuntimeParams

offchain_worker_params: OffchainWorkerParams

shared_params: SharedParams

import_params: ImportParams

network_params: NetworkParams

pool_config: TransactionPoolParams

keystore_params: KeystoreParams

alice: bool

Shortcut for --name Alice --validator.

Session keys for Alice are added to keystore.

bob: bool

Shortcut for --name Bob --validator.

Session keys for Bob are added to keystore.

charlie: bool

Shortcut for --name Charlie --validator.

Session keys for Charlie are added to keystore.

dave: bool

Shortcut for --name Dave --validator.

Session keys for Dave are added to keystore.

eve: bool

Shortcut for --name Eve --validator.

Session keys for Eve are added to keystore.

ferdie: bool

Shortcut for --name Ferdie --validator.

Session keys for Ferdie are added to keystore.

one: bool

Shortcut for --name One --validator.

Session keys for One are added to keystore.

two: bool

Shortcut for --name Two --validator.

Session keys for Two are added to keystore.

force_authoring: bool

Enable authoring even when offline.

tmp: bool

Run a temporary node.

A temporary directory will be created to store the configuration and will be deleted at the end of the process.

Note: the directory is random per process execution. This directory is used as base path which includes: database, node key and keystore.

When --dev is given and no explicit --base-path, this option is implied.

Implementations

impl RunCmd

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

Get the Sr25519Keyring matching one of the flag.

Trait Implementations

impl Args for RunCmd

fn group_id() -> Option<Id>

Report the 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 CliConfiguration for RunCmd

fn shared_params(&self) -> &SharedParams

Get the SharedParams for this object

fn import_params(&self) -> Option<&ImportParams>

Get the ImportParams for this object

fn network_params(&self) -> Option<&NetworkParams>

Get the NetworkParams for this object

fn keystore_params(&self) -> Option<&KeystoreParams>

Get the KeystoreParams for this object

fn offchain_worker_params(&self) -> Option<&OffchainWorkerParams>

Get a reference to OffchainWorkerParams for this object.

fn node_name(&self) -> Result<String>

Get the name of the node.

fn dev_key_seed(&self, is_dev: bool) -> Result<Option<String>>

Get the development key seed from the current object

fn telemetry_endpoints( &self, chain_spec: &Box<dyn ChainSpec> ) -> Result<Option<TelemetryEndpoints>>

Get the telemetry endpoints (if any)

fn role(&self, is_dev: bool) -> Result<Role>

Gets the role

fn force_authoring(&self) -> Result<bool>

Returns Ok(true) if authoring should be forced

fn prometheus_config( &self, default_listen_port: u16, chain_spec: &Box<dyn ChainSpec> ) -> Result<Option<PrometheusConfig>>

Get the prometheus configuration (None if disabled)

fn disable_grandpa(&self) -> Result<bool>

Returns Ok(true) if grandpa should be disabled

fn rpc_max_connections(&self) -> Result<u32>

Get the maximum number of RPC server connections.

fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>>

Get the RPC cors (None if disabled)

fn rpc_addr(&self, default_listen_port: u16) -> Result<Option<SocketAddr>>

Get the RPC address.

fn rpc_methods(&self) -> Result<RpcMethods>

Returns the RPC method set to expose.

fn rpc_max_request_size(&self) -> Result<u32>

Get maximum RPC request payload size.

fn rpc_max_response_size(&self) -> Result<u32>

Get maximum RPC response payload size.

fn rpc_max_subscriptions_per_connection(&self) -> Result<u32>

Get maximum number of subscriptions per connection.

fn rpc_buffer_capacity_per_connection(&self) -> Result<u32>

The number of messages the RPC server is allowed to keep in memory per connection.

fn rpc_batch_config(&self) -> Result<RpcBatchRequestConfig>

RPC server batch request configuration.

fn rpc_rate_limit(&self) -> Result<Option<NonZeroU32>>

RPC rate limit configuration.

fn rpc_rate_limit_whitelisted_ips(&self) -> Result<Vec<IpNetwork>>

RPC rate limit whitelisted ip addresses.

fn rpc_rate_limit_trust_proxy_headers(&self) -> Result<bool>

RPC rate limit trust proxy headers.

fn transaction_pool(&self, is_dev: bool) -> Result<TransactionPoolOptions>

Get the transaction pool options

fn max_runtime_instances(&self) -> Result<Option<usize>>

Get maximum runtime instances

fn runtime_cache_size(&self) -> Result<u8>

Get maximum different runtimes in cache

fn base_path(&self) -> Result<Option<BasePath>>

Get the base path of the configuration (if any)

fn pruning_params(&self) -> Option<&PruningParams>

Get the PruningParams for this object

fn node_key_params(&self) -> Option<&NodeKeyParams>

Get the NodeKeyParams for this object

fn database_params(&self) -> Option<&DatabaseParams>

Get the DatabaseParams for this object

fn is_dev(&self) -> Result<bool>

Returns true if the node is for development or not

fn network_config( &self, chain_spec: &Box<dyn ChainSpec>, is_dev: bool, is_validator: bool, net_config_dir: PathBuf, client_id: &str, node_name: &str, node_key: NodeKeyConfig, default_listen_port: u16 ) -> Result<NetworkConfiguration>

Get the network configuration

fn keystore_config(&self, config_dir: &PathBuf) -> Result<KeystoreConfig>

Get the keystore configuration.

fn database_cache_size(&self) -> Result<Option<usize>>

Get the database cache size.

fn database(&self) -> Result<Option<Database>>

Get the database backend variant.

fn database_config( &self, base_path: &PathBuf, cache_size: usize, database: Database ) -> Result<DatabaseSource>

Get the database configuration object for the parameters provided

fn trie_cache_maximum_size(&self) -> Result<Option<usize>>

Get the trie cache maximum size.

fn state_pruning(&self) -> Result<Option<PruningMode>>

Get the state pruning mode.

fn blocks_pruning(&self) -> Result<BlocksPruning>

Get the block pruning mode.

fn chain_id(&self, is_dev: bool) -> Result<String>

Get the chain ID (string).

fn wasm_method(&self) -> Result<WasmExecutionMethod>

Get the WASM execution method.

fn wasm_runtime_overrides(&self) -> Option<PathBuf>

Get the path where WASM overrides live.

fn default_heap_pages(&self) -> Result<Option<u64>>

Get the default value for heap pages

fn offchain_worker(&self, role: &Role) -> Result<OffchainWorkerConfig>

Returns an offchain worker config wrapped in Ok(_)

fn tracing_targets(&self) -> Result<Option<String>>

Get the tracing targets from the current object (if any)

fn tracing_receiver(&self) -> Result<TracingReceiver>

Get the TracingReceiver value from the current object

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

Get the node key from the current object

fn announce_block(&self) -> Result<bool>

Activate or not the automatic announcing of blocks after import

fn create_configuration<C: SubstrateCli>( &self, cli: &C, tokio_handle: Handle ) -> Result<Configuration>

Create a Configuration object from the current object

fn log_filters(&self) -> Result<String>

Get the filters for the logging.

fn detailed_log_output(&self) -> Result<bool>

Should the detailed log output be enabled.

fn enable_log_reloading(&self) -> Result<bool>

Is log reloading enabled?

fn disable_log_color(&self) -> Result<bool>

Should the log color output be disabled?

fn init<F>( &self, support_url: &String, impl_version: &String, logger_hook: F, config: &Configuration ) -> Result<()>

where F: FnOnce(&mut LoggerBuilder, &Configuration),

Initialize substrate. This must be done only once per process.

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

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 RunCmd

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

Formats the value using the given formatter.

impl FromArgMatches for RunCmd

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 RunCmd

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.