Struct sc_cli::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 ws_external: bool,
    pub unsafe_ws_external: bool,
    pub rpc_max_payload: Option<usize>,
    pub rpc_max_request_size: Option<usize>,
    pub rpc_max_response_size: Option<usize>,
    pub rpc_max_subscriptions_per_connection: Option<usize>,
    pub prometheus_external: bool,
    pub ipc_path: Option<String>,
    pub rpc_port: Option<u16>,
    pub ws_port: Option<u16>,
    pub ws_max_connections: Option<usize>,
    pub ws_max_out_buffer_capacity: 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_params: OffchainWorkerParams,
    pub shared_params: SharedParams,
    pub import_params: ImportParams,
    pub network_params: NetworkParams,
    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_params: KeystoreParams,
    pub max_runtime_instances: Option<usize>,
    pub runtime_cache_size: u8,
    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 voter when running in validator mode, otherwise disable the GRANDPA observer.

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://docs.substrate.io/main-docs/build/custom-rpc/#public-rpcs. 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.

• unsafe: Exposes every RPC method.
• safe: Exposes only a safe subset of RPC methods, denying unsafe RPC methods.
• auto: Acts as safe if RPC is served externally, e.g. when --{rpc,ws}-external is passed, otherwise acts as unsafe.

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://docs.substrate.io/main-docs/build/custom-rpc/#public-rpcs. 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.

rpc_max_payload: Option<usize>

DEPRECATED, this has no affect anymore. Use rpc_max_request_size or rpc_max_response_size instead.

rpc_max_request_size: Option<usize>

Set the the maximum RPC request payload size for both HTTP and WS in megabytes. Default is 15MiB.

rpc_max_response_size: Option<usize>

Set the the maximum RPC response payload size for both HTTP and WS in megabytes. Default is 15MiB.

rpc_max_subscriptions_per_connection: Option<usize>

Set the the maximum concurrent subscriptions per connection. Default is 1024.

prometheus_external: bool

Expose Prometheus exporter on all interfaces.

Default is local.

ipc_path: Option<String>

DEPRECATED, IPC support has been removed.

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.

ws_max_out_buffer_capacity: Option<usize>

DEPRECATED, this has no affect anymore. Use rpc_max_response_size instead.

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 exporter TCP Port.

no_prometheus: bool

Do not expose a Prometheus exporter 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. Expected format is ‘URL VERBOSITY’, e.g. --telemetry-url 'wss://foo/bar 0'.

offchain_worker_params: OffchainWorkerParams

shared_params: SharedParams

import_params: ImportParams

network_params: NetworkParams

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_params: KeystoreParams

max_runtime_instances: Option<usize>

The size of the instances cache for each runtime.

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

runtime_cache_size: u8

Maximum number of different runtimes that can be cached.

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.

Examples found in repository

src/commands/run_cmd.rs (line 318)

	fn node_name(&self) -> Result<String> {
		let name: String = match (self.name.as_ref(), self.get_keyring()) {
			(Some(name), _) => name.to_string(),
			(_, Some(keyring)) => keyring.to_string(),
			(None, None) => crate::generate_node_name(),
		};

		is_node_name_valid(&name).map_err(|msg| {
			Error::Input(format!(
				"Invalid node name '{}'. Reason: {}. If unsure, use none.",
				name, msg
			))
		})?;

		Ok(name)
	}

	fn dev_key_seed(&self, is_dev: bool) -> Result<Option<String>> {
		Ok(self.get_keyring().map(|a| format!("//{}", a)).or_else(|| {
			if is_dev {
				Some("//Alice".into())
			} else {
				None
			}
		}))
	}

	fn telemetry_endpoints(
		&self,
		chain_spec: &Box<dyn ChainSpec>,
	) -> Result<Option<TelemetryEndpoints>> {
		Ok(if self.no_telemetry {
			None
		} else if !self.telemetry_endpoints.is_empty() {
			Some(
				TelemetryEndpoints::new(self.telemetry_endpoints.clone())
					.map_err(|e| e.to_string())?,
			)
		} else {
			chain_spec.telemetry_endpoints().clone()
		})
	}

	fn role(&self, is_dev: bool) -> Result<Role> {
		let keyring = self.get_keyring();
		let is_authority = self.validator || is_dev || keyring.is_some();

		Ok(if is_authority { sc_service::Role::Authority } else { sc_service::Role::Full })
	}

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_ws_max_connections(&self) -> Result<Option<usize>>

Get the RPC websockets maximum connections (None if unlimited).

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

Get the RPC cors (None if disabled)

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

Get the RPC HTTP address (None if disabled).

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

Get the RPC IPC path (None if disabled).

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

Get the RPC websocket address (None if disabled).

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

Returns the RPC method set to expose.

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

Get maximum RPC payload.

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

Get maximum RPC request payload size.

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

Get maximum RPC response payload size.

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

Get maximum number of subscriptions per connection.

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

Get maximum WS output buffer capacity.

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<(Option<String>, 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 execution_strategies(
    &self,
    is_dev: bool,
    is_validator: bool
) -> Result<ExecutionStrategies>

Get the execution strategies.

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<RichFormatter>>

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

fn parse_from<I, T>(itr: I) -> Selfwhere
    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<RichFormatter>>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<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, return Err on error.