Enum sc_cli::Subcommand

pub enum Subcommand {
    BuildSpec(BuildSpecCmd),
    ExportBlocks(ExportBlocksCmd),
    ImportBlocks(ImportBlocksCmd),
    CheckBlock(CheckBlockCmd),
    Revert(RevertCmd),
    PurgeChain(PurgeChainCmd),
    ExportState(ExportStateCmd),
}

All core commands that are provided by default.

The core commands are split into multiple subcommands and Run is the default subcommand. From the CLI user perspective, it is not visible that Run is a subcommand. So, all parameters of Run are exported as main executable parameters.

Variants

BuildSpec(BuildSpecCmd)

Build a spec.json file, outputs to stdout.

ExportBlocks(ExportBlocksCmd)

Export blocks to a file.

ImportBlocks(ImportBlocksCmd)

Import blocks from file.

CheckBlock(CheckBlockCmd)

Validate a single block.

Revert(RevertCmd)

Revert chain to the previous state.

PurgeChain(PurgeChainCmd)

Remove the whole chain data.

ExportState(ExportStateCmd)

Export state as raw chain spec.

Trait Implementations

impl CliConfiguration for Subcommand

fn shared_params(&self) -> &SharedParams

Get the SharedParams for this object

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

Get the ImportParams for this object

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

Get the PruningParams for this object

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

Get the KeystoreParams for this object

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

Get the NetworkParams for this object

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

Get a reference to OffchainWorkerParams for this object.

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

Get the DatabaseParams for this object

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

Get the base path of the configuration (if any)

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

Returns true if the node is for development or not

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

Gets the role

fn transaction_pool(&self) -> Result<TransactionPoolOptions>

Get the transaction pool options

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

Get the network configuration

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

Get the keystore configuration.

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

Get the database cache size.

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

Get the database configuration object for the parameters provided

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

Get the database backend variant.

fn state_cache_size(&self) -> Result<usize>

Get the state cache size.

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

Get the state cache child ratio (if any).

fn pruning(&self, unsafe_pruning: bool, role: &Role) -> Result<PruningMode>

Get the pruning mode.

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

Get the chain ID (string).

fn init<C: SubstrateCli>(&self) -> Result<()>

Initialize substrate. This must be done only once.

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

Get the name of the node.

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

Get the WASM execution method.

fn execution_strategies(&self, is_dev: bool) -> Result<ExecutionStrategies>

Get the execution strategies.

fn rpc_http(&self) -> Result<Option<SocketAddr>>

Get the RPC HTTP address (None if disabled).

fn rpc_ws(&self) -> 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_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 prometheus_config(&self) -> Result<Option<PrometheusConfig>>

Get the prometheus configuration (None if disabled)

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

Get the telemetry endpoints (if any)

fn telemetry_external_transport(&self) -> Result<Option<ExtTransport>>

Get the telemetry external transport

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 force_authoring(&self) -> Result<bool>

Returns Ok(true) if authoring should be forced

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

Returns Ok(true) if grandpa should be disabled

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

Get the development key seed from the current object

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

Get maximum runtime instances

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

Get the filters for the logging.

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

Get the NodeKeyParams for this 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,
    task_executor: Arc<dyn Fn(Pin<Box<dyn Future<Output = ()> + Send>>, TaskType) + Send + Sync>
) -> Result<Configuration>

Create a Configuration object from the current object

impl Clone for Subcommand

fn clone(&self) -> Subcommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Subcommand

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

Formats the value using the given formatter.

impl StructOpt for Subcommand

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 Subcommand

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

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

fn is_subcommand() -> bool