Struct frame_benchmarking_cli::BlockCmd

pub struct BlockCmd {
    pub shared_params: SharedParams,
    pub import_params: ImportParams,
    pub params: BenchmarkParams,
    pub enable_trie_cache: bool,
}

Benchmark the execution time of historic blocks.

This can be used to verify that blocks do not use more weight than they consumed in their WeightInfo. Example:

Let’s say you are on a Substrate chain and want to verify that the first 3 blocks did not use more weight than declared which would otherwise be an issue. To test this with a dev node, first create one with a temp directory:

$ substrate –dev -d /tmp/my-dev –execution wasm –wasm-execution compiled

And wait some time to let it produce 3 blocks. Then benchmark them with:

$ substrate benchmark-block –from 1 –to 3 –dev -d /tmp/my-dev –execution wasm –wasm-execution compiled –pruning archive

The output will be similar to this:

Block 1 with 1 tx used 77.34% of its weight ( 5,308,964 of 6,864,645 ns) Block 2 with 1 tx used 77.99% of its weight ( 5,353,992 of 6,864,645 ns) Block 3 with 1 tx used 75.91% of its weight ( 5,305,938 of 6,989,645 ns)

The percent number is important and indicates how much weight was used as compared to the consumed weight. This number should be below 100% for reference hardware.

Fields

shared_params: SharedParams

import_params: ImportParams

params: BenchmarkParams

enable_trie_cache: bool

Enable the Trie cache.

This should only be used for performance analysis and not for final results.

Implementations

impl BlockCmd

pub fn run<Block, BA, C>(&self, client: Arc<C>) -> Result<()>where Block: BlockT<Extrinsic = OpaqueExtrinsic>, BA: ClientBackend<Block>, C: BlockBuilderProvider<BA, Block, C> + BlockBackend<Block> + ProvideRuntimeApi<Block> + StorageProvider<Block, BA> + UsageProvider<Block> + HeaderBackend<Block>, C::Api: ApiExt<Block, StateBackend = BA::State> + BlockBuilderApi<Block>,

Benchmark the execution time of historic blocks and compare it to their consumed weight.

Output will be printed to console.

Trait Implementations

impl Args for BlockCmd

fn group_id() -> Option<Id>

Report the 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 BlockCmd

fn shared_params(&self) -> &SharedParams

Get the SharedParams for this object

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

Get the ImportParams for this object

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

Get the trie cache maximum size.

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

Get the transaction pool options

fn network_config( &self, chain_spec: &Box<dyn ChainSpec, 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(&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_pruning(&self) -> Result<Option<PruningMode>, Error>

Get the state pruning mode.

fn blocks_pruning(&self) -> Result<BlocksPruning, Error>

Get the block pruning mode.

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

Get the chain ID (string).

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

Get maximum RPC request payload size.

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

Get maximum RPC response payload size.

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

Get maximum number of subscriptions per connection.

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

Get maximum WS output buffer capacity.

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

Get the prometheus configuration (None if disabled)

fn telemetry_endpoints( &self, chain_spec: &Box<dyn ChainSpec, Global> ) -> 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, config: &Configuration ) -> Result<(), Error>where F: FnOnce(&mut LoggerBuilder, &Configuration),

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

impl CommandFactory for BlockCmd

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 BlockCmd

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

Formats the value using the given formatter.

impl FromArgMatches for BlockCmd

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 BlockCmd

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>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 on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.