Struct frame_benchmarking_cli::BenchmarkCmd

pub struct BenchmarkCmd {

    pub pallet: Option<String>,
    pub extrinsic: Option<String>,
    pub steps: u32,
    pub lowest_range_values: Vec<u32>,
    pub highest_range_values: Vec<u32>,
    pub repeat: u32,
    pub external_repeat: u32,
    pub raw_data: bool,
    pub no_median_slopes: bool,
    pub no_min_squares: bool,
    pub output: Option<PathBuf>,
    pub header: Option<PathBuf>,
    pub template: Option<PathBuf>,
    pub output_analysis: Option<String>,
    pub heap_pages: Option<u64>,
    pub no_verify: bool,
    pub extra: bool,
    pub record_proof: bool,
    pub shared_params: SharedParams,
    pub execution: Option<ExecutionStrategy>,
    pub wasm_method: WasmExecutionMethod,
    pub database_cache_size: u32,
    pub list: bool,
}

The benchmark command used to benchmark FRAME Pallets.

Fields

pallet: Option<String>

Select a FRAME Pallet to benchmark, or * for all (in which case extrinsic must be *).

extrinsic: Option<String>

Select an extrinsic inside the pallet to benchmark, or * for all.

steps: u32

Select how many samples we should take across the variable components.

lowest_range_values: Vec<u32>

Indicates lowest values for each of the component ranges.

highest_range_values: Vec<u32>

Indicates highest values for each of the component ranges.

repeat: u32

Select how many repetitions of this benchmark should run from within the wasm.

external_repeat: u32

Select how many repetitions of this benchmark should run from the client.

NOTE: Using this alone may give slower results, but will afford you maximum Wasm memory.

raw_data: bool

Print the raw results.

no_median_slopes: bool

Don’t print the median-slopes linear regression analysis.

no_min_squares: bool

Don’t print the min-squares linear regression analysis.

output: Option<PathBuf>

Output the benchmarks to a Rust file at the given path.

header: Option<PathBuf>

Add a header file to your outputted benchmarks

template: Option<PathBuf>

Path to Handlebars template file used for outputting benchmark results. (Optional)

output_analysis: Option<String>

Which analysis function to use when outputting benchmarks:

• min-squares (default)
• median-slopes
• max (max of min squares and median slopes for each value)

heap_pages: Option<u64>

Set the heap pages while running benchmarks. If not set, the default value from the client is used.

no_verify: bool

Disable verification logic when running benchmarks.

extra: bool

Display and run extra benchmarks that would otherwise not be needed for weight construction.

record_proof: bool

Estimate PoV size.

shared_params: SharedParams

execution: Option<ExecutionStrategy>

The execution strategy that should be used for benchmarks

wasm_method: WasmExecutionMethod

Method for executing Wasm runtime code.

database_cache_size: u32

Limit the memory the database cache can use.

list: bool

List the benchmarks that match your query rather than running them.

When nothing is provided, we list all benchmarks.

Implementations

impl BenchmarkCmd

pub fn run<BB, ExecDispatch>(&self, config: Configuration) -> Result<()> where
    BB: BlockT + Debug,
    <<<BB as BlockT>::Header as HeaderT>::Number as FromStr>::Err: Debug,
    <BB as BlockT>::Hash: FromStr,
    ExecDispatch: NativeExecutionDispatch + 'static, 

Runs the command and benchmarks the chain.

Trait Implementations

impl CliConfiguration<()> for BenchmarkCmd

fn shared_params(&self) -> &SharedParams

Get the SharedParams for this object

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

Get the chain ID (string).

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 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 base_path(&self) -> Result<Option<BasePath>, Error>

Get the base path of the configuration (if any)

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

Returns true if the node is for development or not

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

Gets the role

fn transaction_pool(&self) -> Result<Options, Error>

Get the transaction pool options

fn network_config(
    &self,
    chain_spec: &Box<dyn ChainSpec + 'static, Global>,
    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, Error>

Get the network configuration

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

Get the keystore configuration.

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

Get the database cache size.

fn database_transaction_storage(&self) -> Result<TransactionStorageMode, Error>

Get the database transaction storage scheme.

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

Get the database backend variant.

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

Get the database configuration object for the parameters provided

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

Get the state cache size.

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

Get the state cache child ratio (if any).

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

Get the state pruning mode.

fn keep_blocks(&self) -> Result<KeepBlocks, Error>

Get the block pruning mode.

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

Get the name of the node.

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

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, Error>

Get the execution strategies.

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

Get the RPC HTTP address (None if disabled).

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

Get the RPC IPC path (None if disabled).

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

Get the RPC websocket address (None if disabled).

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

Returns the RPC method set to expose.

fn rpc_ws_max_connections(&self) -> Result<Option<usize>, Error>

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

fn rpc_http_threads(&self) -> Result<Option<usize>, Error>

Get the RPC HTTP thread pool size (None for a default 4-thread pool config).

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

Get the RPC cors (None if disabled)

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

Get maximum RPC payload.

fn prometheus_config(
    &self,
    _default_listen_port: u16
) -> Result<Option<PrometheusConfig>, Error>

Get the prometheus configuration (None if disabled)

fn telemetry_endpoints(
    &self,
    chain_spec: &Box<dyn ChainSpec + 'static, Global>
) -> Result<Option<TelemetryEndpoints>, Error>

Get the telemetry endpoints (if any)

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

Get the telemetry external transport

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

Get the default value for heap pages

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

Returns an offchain worker config wrapped in Ok(_)

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

Returns Ok(true) if authoring should be forced

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

Returns Ok(true) if grandpa should be disabled

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

Get the development key seed from the current object

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

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

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

Get the TracingReceiver value from the current object

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

Get the node key from the current object

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

Get maximum runtime instances

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

Activate or not the automatic announcing of blocks after import

fn create_configuration<C>(
    &self,
    cli: &C,
    task_executor: TaskExecutor
) -> Result<Configuration, Error> where
    C: SubstrateCli, 

Create a Configuration object from the current object

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

Get the filters for the logging.

fn is_log_filter_reloading_disabled(&self) -> Result<bool, Error>

Is log reloading disabled (enabled by default)

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

Should the log color output be disabled?

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

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

impl Debug for BenchmarkCmd

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

Formats the value using the given formatter.

impl StructOpt for BenchmarkCmd

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by [StructOpt::clap] called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike [StructOpt::from_args], returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

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.