Files
pezkuwi-subxt/substrate/utils/frame/benchmarking-cli
Bastian Köcher ca5f10567a sc-block-builder: Remove BlockBuilderProvider (#2099)
The `BlockBuilderProvider` was a trait that was defined in
`sc-block-builder`. The trait was implemented for `Client`. This
basically meant that you needed to import `sc-block-builder` any way to
have access to the block builder. So, this trait was not providing any
real value. This pull request is removing the said trait. Instead of the
trait it introduces a builder for creating a `BlockBuilder`. The builder
currently has the quite fabulous name `BlockBuilderBuilder` (I'm open to
any better name 😅). The rest of the pull request is about
replacing the old trait with the new builder.

# Downstream code changes

If you used `new_block` or `new_block_at` before you now need to switch
it over to the new `BlockBuilderBuilder` pattern:

```rust
// `new` requires a type that implements `CallApiAt`. 
let mut block_builder = BlockBuilderBuilder::new(client)
                // Then you need to specify the hash of the parent block the block will be build on top of
		.on_parent_block(at)
                // The block builder also needs the block number of the parent block. 
                // Here it is fetched from the given `client` using the `HeaderBackend`
                // However, there also exists `with_parent_block_number` for directly passing the number
		.fetch_parent_block_number(client)
		.unwrap()
                // Enable proof recording if required. This call is optional.
		.enable_proof_recording()
                // Pass the digests. This call is optional.
                .with_inherent_digests(digests)
		.build()
		.expect("Creates new block builder");
```

---------

Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
Co-authored-by: command-bot <>
2023-11-03 19:06:31 +01:00
..
2023-09-04 12:02:32 +03:00

The Benchmarking CLI

This crate contains commands to benchmark various aspects of Substrate and the hardware. All commands are exposed by the Substrate node but can be exposed by any Substrate client. The goal is to have a comprehensive suite of benchmarks that cover all aspects of Substrate and the hardware that its running on.

Invoking the root benchmark command prints a help menu:

$ cargo run --profile=production -- benchmark

Sub-commands concerned with benchmarking.

USAGE:
    substrate benchmark <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    block       Benchmark the execution time of historic blocks
    machine     Command to benchmark the hardware.
    overhead    Benchmark the execution overhead per-block and per-extrinsic
    pallet      Benchmark the extrinsic weight of FRAME Pallets
    storage     Benchmark the storage speed of a chain snapshot

All examples use the production profile for correctness which makes the compilation very slow; for testing you can use --release. For the final results the production profile and reference hardware should be used, otherwise the results are not comparable.

The sub-commands are explained in depth here:

  • block Compare the weight of a historic block to its actual resource usage
  • machine Gauges the speed of the hardware
  • overhead Creates weight files for the Block- and Extrinsic-base weights
  • pallet Creates weight files for a Pallet
  • storage Creates weight files for Read and Write storage operations

License: Apache-2.0