Struct Cli

pub struct Cli<Config: CliConfig> {
    pub subcommand: Option<Subcommand>,
    pub run: RunCmd,
    pub dev_block_time: Option<u64>,
    pub experimental_use_slot_based: bool,
    pub authoring: AuthoringPolicy,
    pub no_hardware_benchmarks: bool,
    pub export_pov_to_path: Option<PathBuf>,
    pub relay_chain_args: Vec<String>,
    pub enable_statement_store: bool,
    /* private fields */
}

CLI Options shipped with polkadot-omni-node.

Fields

subcommand: Option<Subcommand>

Possible subcommands. See Subcommand.

run: RunCmd

The shared parameters with all cumulus-based parachain nodes.

dev_block_time: Option<u64>

Start a dev node that produces a block each dev_block_time ms.

This is a dev option. It enables a manual sealing, meaning blocks are produced manually rather than being part of an actual network consensus process. Using the option won’t result in starting or connecting to a parachain network. The resulting node will work on its own, running the wasm blob and artificially producing a block each dev_block_time ms, as if it was part of a parachain.

The --dev flag sets the dev_block_time to a default value of 3000ms unless explicitly provided.

experimental_use_slot_based: bool

DEPRECATED: This feature has been stabilized, pLease use --authoring slot-based instead.

Use slot-based collator which can handle elastic scaling. Use with care, this flag is unstable and subject to change.

authoring: AuthoringPolicy

Authoring style to use.

no_hardware_benchmarks: bool

Disable automatic hardware benchmarks.

By default these benchmarks are automatically ran at startup and measure the CPU speed, the memory bandwidth and the disk speed.

The results are then printed out in the logs, and also sent as part of telemetry, if telemetry is enabled.

export_pov_to_path: Option<PathBuf>

Export all PoVs build by this collator to the given folder.

This is useful for debugging issues that are occurring while validating these PoVs on the relay chain.

relay_chain_args: Vec<String>

Relay chain arguments

enable_statement_store: bool

Enable the statement store.

The statement store is a store for statements validated using the runtime API validate_statement. It should be enabled for chains that provide this runtime API.

Trait Implementations

impl<Config: CliConfig> Args for Cli<Config>

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<Config: CliConfig> CommandFactory for Cli<Config>

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<Config: CliConfig> FromArgMatches for Cli<Config>

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<Config: CliConfig> Parser for Cli<Config>

fn parse() -> Self

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

impl<Config: CliConfig> SubstrateCli for Cli<Config>

fn impl_name() -> String

Implementation name.

fn impl_version() -> String

Implementation version.

fn description() -> String

Executable file description.

fn author() -> String

Executable file author.

fn support_url() -> String

Support URL.

fn copyright_start_year() -> i32

Copyright starting year (x-current year)

fn load_spec(&self, id: &str) -> Result<Box<dyn ChainSpec>, String>

Chain spec factory

fn executable_name() -> String

Executable file name.

fn from_args() -> Self

where Self: Sized + Parser,

Helper function used to parse the command line arguments. This is the equivalent of [clap::Parser::parse()].

fn from_iter<I>(iter: I) -> Self

where Self: Sized + Parser, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Helper function used to parse the command line arguments. This is the equivalent of [clap::Parser::parse_from].

fn try_from_iter<I>(iter: I) -> Result<Self, Error>

where Self: Sized + Parser, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Helper function used to parse the command line arguments. This is the equivalent of [clap::Parser::try_parse_from]

fn client_id() -> String

Returns the client ID: {impl_name}/v{impl_version}

fn create_configuration<T, DVC>( &self, command: &T, tokio_handle: Handle, ) -> Result<Configuration, Error>

where T: CliConfiguration<DVC>, DVC: DefaultConfigurationValues,

Only create a Configuration for the command provided in argument

fn create_runner<T, DVC>(&self, command: &T) -> Result<Runner<Self>, Error>

where T: CliConfiguration<DVC>, DVC: DefaultConfigurationValues,

Create a runner for the command provided in argument. This will create a Configuration and a tokio runtime

fn create_runner_with_logger_hook<T, DVC, F>( &self, command: &T, logger_hook: F, ) -> Result<Runner<Self>, Error>

where T: CliConfiguration<DVC>, DVC: DefaultConfigurationValues, F: FnOnce(&mut LoggerBuilder, &Configuration),

Create a runner for the command provided in argument. The logger_hook can be used to setup a custom profiler or update the logger configuration before it is initialized.

fn setup_command(cmd: Command) -> Command

Augments a clap::Command with standard metadata like name, version, author, description, etc.