Struct Command

pub struct Command {
    sub: SubCommand,
}

Polkadot Omni Benchmarking CLI

The Polkadot Omni benchmarker allows to benchmark the extrinsics of any Polkadot runtime. It is meant to replace the current manual integration of the benchmark pallet into every parachain node. This reduces duplicate code and makes maintenance for builders easier. The CLI is currently only able to benchmark extrinsics. In the future it is planned to extend this to some other areas.

General FRAME runtimes could also be used with this benchmarker, as long as they don’t utilize any host functions that are not part of the Polkadot host specification.

Installation

Directly via crates.io:

cargo install frame-omni-bencher --profile=production

from GitHub:

cargo install --git https://github.com/paritytech/polkadot-sdk frame-omni-bencher --profile=production

or locally from the sources:

cargo install --path substrate/utils/frame/omni-bencher --profile=production

Check the installed version and print the docs:

frame-omni-bencher --help

Usage

First we need to ensure that there is a runtime available. As example we will build the Westend runtime:

cargo build -p westend-runtime --profile production --features runtime-benchmarks

Now as an example, we benchmark the balances pallet:

frame-omni-bencher v1 benchmark pallet \
    --runtime target/release/wbuild/westend-runtime/westend-runtime.compact.compressed.wasm \
    --pallet "pallet_balances" --extrinsic ""

For the exact arguments of the pallet command, please refer to the pallet sub-module.

Backwards Compatibility

The exposed pallet sub-command is identical as the node-integrated CLI. The only difference is that it needs to be prefixed with a v1 to ensure drop-in compatibility.

Fields

sub: SubCommand

Implementations

impl Command

pub fn run(self) -> Result<()>

Trait Implementations

impl Args for Command

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 CommandFactory for Command

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 Command

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

Formats the value using the given formatter.

impl FromArgMatches for Command

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 Command

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.