Struct frame_system::CheckWeight

pub struct CheckWeight<T: Config + Send + Sync>(/* private fields */);

Block resource (weight) limit check.

Transaction Validity

This extension does not influence any fields of TransactionValidity in case the transaction is valid.

Implementations

impl<T: Config + Send + Sync> CheckWeight<T>

where T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,

pub fn new() -> Self

Creates new TransactionExtension to check weight of the extrinsic.

pub fn do_validate( info: &DispatchInfoOf<T::RuntimeCall>, len: usize, ) -> Result<(ValidTransaction, u32), TransactionValidityError>

Do the validate checks. This can be applied to both signed and unsigned.

It only checks that the block weight and length limit will not exceed.

Returns the transaction validity and the next block length, to be used in prepare.

pub fn do_prepare( info: &DispatchInfoOf<T::RuntimeCall>, len: usize, next_len: u32, ) -> Result<(), TransactionValidityError>

Do the pre-dispatch checks. This can be applied to both signed and unsigned.

It checks and notes the new weight and length.

pub fn do_post_dispatch( info: &DispatchInfoOf<T::RuntimeCall>, post_info: &PostDispatchInfoOf<T::RuntimeCall>, ) -> Result<(), TransactionValidityError>

Trait Implementations

impl<T: Clone + Config + Send + Sync> Clone for CheckWeight<T>

fn clone(&self) -> CheckWeight<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Config + Send + Sync> Debug for CheckWeight<T>

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

Formats the value using the given formatter.

impl<T: Config + Send + Sync> Decode for CheckWeight<T>

where PhantomData<T>: Decode,

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

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<T: Default + Config + Send + Sync> Default for CheckWeight<T>

fn default() -> CheckWeight<T>

Returns the “default value” for a type.

impl<T: Config + Send + Sync> Encode for CheckWeight<T>

where PhantomData<T>: Encode,

fn size_hint(&self) -> usize

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

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

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<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: PartialEq + Config + Send + Sync> PartialEq for CheckWeight<T>

fn eq(&self, other: &CheckWeight<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config + Send + Sync> TransactionExtension<<T as Config>::RuntimeCall> for CheckWeight<T>

where T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,

const IDENTIFIER: &'static str = "CheckWeight"

Unique identifier of this signed extension.

type Implicit = ()

Any additional data which was known at the time of transaction construction and can be useful in authenticating the transaction. This is determined dynamically in part from the on-chain environment using the implicit function and not directly contained in the transaction itself and therefore is considered “implicit”.

type Pre = ()

The type that encodes information that can be passed from prepare to post_dispatch.

type Val = u32

The type that encodes information that can be passed from validate to prepare.

fn weight(&self, _: &T::RuntimeCall) -> Weight

The weight consumed by executing this extension instance fully during transaction dispatch.

fn validate( &self, origin: T::RuntimeOrigin, _call: &T::RuntimeCall, info: &DispatchInfoOf<T::RuntimeCall>, len: usize, _self_implicit: Self::Implicit, _inherited_implication: &impl Encode, ) -> ValidateResult<Self::Val, T::RuntimeCall>

Validate a transaction for the transaction queue.

fn prepare( self, val: Self::Val, _origin: &T::RuntimeOrigin, _call: &T::RuntimeCall, info: &DispatchInfoOf<T::RuntimeCall>, len: usize, ) -> Result<Self::Pre, TransactionValidityError>

Do any pre-flight stuff for a transaction after validation.

fn post_dispatch_details( _pre: Self::Pre, info: &DispatchInfoOf<T::RuntimeCall>, post_info: &PostDispatchInfoOf<T::RuntimeCall>, _len: usize, _result: &DispatchResult, ) -> Result<Weight, TransactionValidityError>

Do any post-flight stuff for an extrinsic.

fn bare_validate( _call: &T::RuntimeCall, info: &DispatchInfoOf<T::RuntimeCall>, len: usize, ) -> TransactionValidity

Validation logic for bare extrinsics.

fn bare_validate_and_prepare( _call: &T::RuntimeCall, info: &DispatchInfoOf<T::RuntimeCall>, len: usize, ) -> Result<(), TransactionValidityError>

All pre-flight logic run before dispatching bare extrinsics.

fn bare_post_dispatch( info: &DispatchInfoOf<T::RuntimeCall>, post_info: &mut PostDispatchInfoOf<T::RuntimeCall>, _len: usize, _result: &DispatchResult, ) -> Result<(), TransactionValidityError>

Post dispatch logic run after dispatching bare extrinsics.

fn implicit(&self) -> Result<Self::Implicit, TransactionValidityError>

Determine any additional data which was known at the time of transaction construction and can be useful in authenticating the transaction. The expected usage of this is to include in any data which is signed and verified as part of transaction validation. Also perform any pre-signature-verification checks and return an error if needed.

fn metadata() -> Vec<TransactionExtensionMetadata>

Returns the metadata for this extension.

fn post_dispatch( pre: Self::Pre, info: &<Call as Dispatchable>::Info, post_info: &mut <Call as Dispatchable>::PostInfo, len: usize, result: &Result<(), DispatchError>, ) -> Result<(), TransactionValidityError>

A wrapper for post_dispatch_details that refunds the unspent weight consumed by this extension into the post dispatch information.

impl<T> TypeInfo for CheckWeight<T>

where PhantomData<T>: TypeInfo + 'static, T: Config + Send + Sync + 'static,

type Identity = CheckWeight<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config + Send + Sync> EncodeLike for CheckWeight<T>

where PhantomData<T>: Encode,

impl<T: Eq + Config + Send + Sync> Eq for CheckWeight<T>

impl<T: Config + Send + Sync> StructuralPartialEq for CheckWeight<T>