Struct polkadot_sdk_frame::prelude::frame_system::limits::BlockWeights

pub struct BlockWeights {
    pub base_block: Weight,
    pub max_block: Weight,
    pub per_class: PerDispatchClass<WeightsPerClass>,
}

Block weight limits & base values configuration.

This object is responsible for defining weight limits and base weight values tracked during extrinsic execution.

Each block starts with base_block weight being consumed right away. Next up the on_initialize pallet callbacks are invoked and their cost is added before any extrinsic is executed. This cost is tracked as Mandatory dispatch class.

|   | `max_block`    |   |
|   |                |   |
|   |                |   |
|   |                |   |
|   |                |  #| `on_initialize`
|  #| `base_block`   |  #|
|NOM|                |NOM|
 ||\_ Mandatory
 |\__ Operational
 \___ Normal

The remaining capacity can be used to dispatch extrinsics. Note that each dispatch class is being tracked separately, but the sum can’t exceed max_block (except for reserved). Below you can see a picture representing full block with 3 extrinsics (two Operational and one Normal). Each class has it’s own limit max_total, but also the sum cannot exceed max_block value.

                         -- `Mandatory` limit (unlimited)
| # |                 |   |
| # | `Ext3`          | - - `Operational` limit
|#  | `Ext2`          |-  - `Normal` limit
| # | `Ext1`          | # |
|  #| `on_initialize` | ##|
|  #| `base_block`    |###|
|NOM|                 |NOM|

It should be obvious now that it’s possible for one class to reach it’s limit (say Normal), while the block has still capacity to process more transactions (max_block not reached, Operational transactions can still go in). Setting max_total to None disables the per-class limit. This is generally highly recommended for Mandatory dispatch class, while it can be dangerous for Normal class and should only be done with extra care and consideration.

Often it’s desirable for some class of transactions to be added to the block despite it being full. For instance one might want to prevent high-priority Normal transactions from pushing out lower-priority Operational transactions. In such cases you might add a reserved capacity for given class.

             _
  #           \
  #   `Ext8`   - `reserved`
  #          _/
| # | `Ext7                 | - - `Operational` limit
|#  | `Ext6`                |   |
|#  | `Ext5`                |-# - `Normal` limit
|#  | `Ext4`                |## |
|  #| `on_initialize`       |###|
|  #| `base_block`          |###|
|NOM|                       |NOM|

In the above example, Ext4-6 fill up the block almost up to max_block. Ext7 would not fit if there wasn’t the extra reserved space for Operational transactions. Note that max_total limit applies to reserved space as well (i.e. the sum of weights of Ext7 & Ext8 mustn’t exceed it). Setting reserved to None allows the extrinsics to always get into the block up to their max_total limit. If max_total is set to None as well, all extrinsics witch dispatchables of given class will always end up in the block (recommended for Mandatory dispatch class).

As a consequence of reserved space, total consumed block weight might exceed max_block value, so this parameter should rather be thought of as “target block weight” than a hard limit.

Fields

base_block: Weight

Base weight of block execution.

max_block: Weight

Maximal total weight consumed by all kinds of extrinsics (without reserved space).

per_class: PerDispatchClass<WeightsPerClass>

Weight limits for extrinsics of given dispatch class.

Implementations

impl BlockWeights

pub fn get(&self, class: DispatchClass) -> &WeightsPerClass

Get per-class weight settings.

pub fn validate(self) -> Result<BlockWeights, ValidationErrors>

Verifies correctness of this BlockWeights object.

pub fn simple_max(block_weight: Weight) -> BlockWeights

Create new weights definition, with both Normal and Operational classes limited to given weight.

Note there is no reservation for Operational class, so this constructor is not suitable for production deployments.

pub fn with_sensible_defaults( expected_block_weight: Weight, normal_ratio: Perbill, ) -> BlockWeights

Create a sensible default weights system given only expected maximal block weight and the ratio that Normal extrinsics should occupy.

Assumptions:

• Average block initialization is assumed to be 10%.
• Operational transactions have reserved allowance (1.0 - normal_ratio)

pub fn builder() -> BlockWeightsBuilder

Start constructing new BlockWeights object.

By default all kinds except of Mandatory extrinsics are disallowed.

Trait Implementations

impl Clone for BlockWeights

fn clone(&self) -> BlockWeights

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BlockWeights

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

Formats the value using the given formatter.

impl Decode for BlockWeights

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<BlockWeights, Error>

where __CodecInputEdqy: Input,

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for BlockWeights

fn default() -> BlockWeights

Returns the “default value” for a type.

impl Encode for BlockWeights

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl TypeInfo for BlockWeights

type Identity = BlockWeights

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl EncodeLike for BlockWeights