Struct frame_benchmarking_cli::PalletCmd

pub struct PalletCmd {

    pub pallet: Option<String>,
    pub extrinsic: Option<String>,
    pub exclude_pallets: Vec<String>,
    pub all: bool,
    pub steps: u32,
    pub lowest_range_values: Vec<u32>,
    pub highest_range_values: Vec<u32>,
    pub repeat: u32,
    pub external_repeat: u32,
    pub json_output: bool,
    pub json_file: Option<PathBuf>,
    pub no_median_slopes: bool,
    pub no_min_squares: bool,
    pub output: Option<PathBuf>,
    pub header: Option<PathBuf>,
    pub template: Option<PathBuf>,
    pub hostinfo_params: HostInfoParams,
    pub output_analysis: Option<String>,
    pub output_pov_analysis: Option<String>,
    pub default_pov_mode: PovEstimationMode,
    pub heap_pages: Option<u64>,
    pub no_verify: bool,
    pub extra: bool,
    pub shared_params: SharedParams,
    pub wasm_method: WasmExecutionMethod,
    pub wasmtime_instantiation_strategy: WasmtimeInstantiationStrategy,
    pub runtime: Option<PathBuf>,
    pub allow_missing_host_functions: bool,
    pub genesis_builder: Option<GenesisBuilderPolicy>,
    pub genesis_builder_preset: String,
    pub execution: Option<String>,
    pub database_cache_size: u32,
    pub list: Option<ListOutput>,
    pub no_csv_header: bool,
    pub no_storage_info: bool,
    pub worst_case_map_values: u32,
    pub additional_trie_layers: u8,
    pub json_input: Option<PathBuf>,
    pub unsafe_overwrite_results: bool,
    /* private fields */
}

Benchmark the extrinsic weight of 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.

exclude_pallets: Vec<String>

Comma separated list of pallets that should be excluded from the benchmark.

all: bool

Run benchmarks for all pallets and extrinsics.

This is equivalent to running --pallet * --extrinsic *.

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.

json_output: bool

Print the raw results in JSON format.

json_file: Option<PathBuf>

Write the raw results in JSON format into the given file.

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)

hostinfo_params: HostInfoParams

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)

output_pov_analysis: Option<String>

Which analysis function to use when analyzing measured proof sizes.

default_pov_mode: PovEstimationMode

The PoV estimation mode of a benchmark if no pov_mode attribute is present.

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.

shared_params: SharedParams

wasm_method: WasmExecutionMethod

Method for executing Wasm runtime code.

wasmtime_instantiation_strategy: WasmtimeInstantiationStrategy

The WASM instantiation method to use.

Only has an effect when wasm-execution is set to compiled.

runtime: Option<PathBuf>

Optional runtime blob to use instead of the one from the genesis config.

allow_missing_host_functions: bool

Do not fail if there are unknown but also unused host functions in the runtime.

genesis_builder: Option<GenesisBuilderPolicy>

How to construct the genesis state.

Uses GenesisBuilderPolicy::Spec by default.

genesis_builder_preset: String

The preset that we expect to find in the GenesisBuilder runtime API.

This can be useful when a runtime has a dedicated benchmarking preset instead of using the default one.

execution: Option<String>

DEPRECATED: This argument has no effect.

database_cache_size: u32

Limit the memory the database cache can use.

list: Option<ListOutput>

List and print available benchmarks in a csv-friendly format.

NOTE: num_args and require_equals are required to allow --list

no_csv_header: bool

Don’t include csv header when listing benchmarks.

no_storage_info: bool

If enabled, the storage info is not displayed in the output next to the analysis.

This is independent of the storage info appearing in the output file. Use a Handlebar template for that purpose.

worst_case_map_values: u32

The assumed default maximum size of any StorageMap.

When the maximum size of a map is not defined by the runtime developer, this value is used as a worst case scenario. It will affect the calculated worst case PoV size for accessing a value in a map, since the PoV will need to include the trie nodes down to the underlying value.

additional_trie_layers: u8

Adjust the PoV estimation by adding additional trie layers to it.

This should be set to log16(n) where n is the number of top-level storage items in the runtime, eg. StorageMaps and StorageValues. A value of 2 to 3 is usually sufficient. Each layer will result in an additional 495 bytes PoV per distinct top-level access. Therefore multiple StorageMap accesses only suffer from this increase once. The exact number of storage items depends on the runtime and the deployed pallets.

json_input: Option<PathBuf>

A path to a .json file with existing benchmark results generated with --json or --json-file. When specified the benchmarks are not actually executed, and the data for the analysis is read from this file.

unsafe_overwrite_results: bool

Allow overwriting a single file with multiple results.

This exists only to restore legacy behaviour. It should never actually be needed.

Implementations

impl PalletCmd

pub fn run<Hasher, ExtraHostFunctions>( &self, config: Configuration, ) -> Result<()>

where Hasher: Hash, ExtraHostFunctions: HostFunctions,

👎Deprecated: run will be removed after December 2024. Use run_with_spec instead or completely remove the code and use the frame-benchmarking-cli instead (see https://github.com/paritytech/polkadot-sdk/pull/3512).

Runs the command and benchmarks a pallet.

pub fn run_with_spec<Hasher, ExtraHostFunctions>( &self, chain_spec: Option<Box<dyn ChainSpec>>, ) -> Result<()>

where Hasher: Hash, ExtraHostFunctions: HostFunctions,

Runs the pallet benchmarking command.

Trait Implementations

impl Args for PalletCmd

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 CliConfiguration for PalletCmd

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, _is_dev: bool, ) -> Result<TransactionPoolOptions, Error>

Get the transaction pool options

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

Get the network configuration

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

Get the keystore configuration.

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

Get the database cache size.

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

Get the trie cache maximum size.

fn state_pruning(&self) -> Result<Option<PruningMode>, Error>

Get the state pruning mode.

fn blocks_pruning(&self) -> Result<BlocksPruning, 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 rpc_addr( &self, _default_listen_port: u16, ) -> Result<Option<Vec<RpcEndpoint>>, Error>

Get the RPC address.

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

Returns the RPC method set to expose.

fn rpc_max_connections(&self) -> Result<u32, Error>

Get the maximum number of RPC server connections.

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

Get the RPC cors (None if disabled)

fn rpc_max_request_size(&self) -> Result<u32, Error>

Get maximum RPC request payload size.

fn rpc_max_response_size(&self) -> Result<u32, Error>

Get maximum RPC response payload size.

fn rpc_max_subscriptions_per_connection(&self) -> Result<u32, Error>

Get maximum number of subscriptions per connection.

fn rpc_buffer_capacity_per_connection(&self) -> Result<u32, Error>

The number of messages the RPC server is allowed to keep in memory per connection.

fn rpc_batch_config(&self) -> Result<BatchRequestConfig, Error>

RPC server batch request configuration.

fn rpc_rate_limit(&self) -> Result<Option<NonZero<u32>>, Error>

RPC rate limit configuration.

fn rpc_rate_limit_whitelisted_ips(&self) -> Result<Vec<IpNetwork>, Error>

RPC rate limit whitelisted ip addresses.

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

RPC rate limit trust proxy headers.

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

Get the prometheus configuration (None if disabled)

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

Get the telemetry endpoints (if any)

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 runtime_cache_size(&self) -> Result<u8, Error>

Get maximum different runtimes in cache

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

Activate or not the automatic announcing of blocks after import

fn create_configuration<C>( &self, cli: &C, tokio_handle: Handle, ) -> 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 detailed_log_output(&self) -> Result<bool, Error>

Should the detailed log output be enabled.

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

Is log reloading enabled?

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

Should the log color output be disabled?

fn init<F>( &self, support_url: &String, impl_version: &String, logger_hook: F, ) -> Result<(), Error>

where F: FnOnce(&mut LoggerBuilder),

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

impl CommandFactory for PalletCmd

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 PalletCmd

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

Formats the value using the given formatter.

impl FromArgMatches for PalletCmd

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 PalletCmd

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.