Struct astar_collator::Cli

pub struct Cli {
    pub subcommand: Option<Subcommand>,
    pub run: RunCmd,
    pub eth_api_options: EthApiOptions,
    pub enable_evm_rpc: bool,
    pub relaychain_args: Vec<String>,
    pub proposer_block_size_limit: usize,
    pub proposer_soft_deadline_percent: u8,
    pub no_hardware_benchmarks: bool,
}

An overarching CLI command definition.

Fields

subcommand: Option<Subcommand>

Possible subcommand with parameters.

run: RunCmd

eth_api_options: EthApiOptions

enable_evm_rpc: bool

Enable Ethereum compatible JSON-RPC servers (disabled by default).

relaychain_args: Vec<String>

Relaychain arguments

proposer_block_size_limit: usize

Proposer’s maximum block size limit in bytes

proposer_soft_deadline_percent: u8

Proposer’s soft deadline in percents of block size

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.

Trait Implementations

impl Args for Cli

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 via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl CommandFactory for Cli

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 Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

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 Cli

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 SubstrateCli for Cli

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: Parser + Sized,

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: Parser + Sized, 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: Parser + Sized, 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.