Trait frame_support::inherent::ProvideInherent

pub trait ProvideInherent {
    type Call;
    type Error: Encode + IsFatalError;

    const INHERENT_IDENTIFIER: InherentIdentifier;

    // Required methods
    fn create_inherent(data: &InherentData) -> Option<Self::Call>;
    fn is_inherent(call: &Self::Call) -> bool;

    // Provided methods
    fn is_inherent_required(
        _: &InherentData,
    ) -> Result<Option<Self::Error>, Self::Error> { ... }
    fn check_inherent(
        _: &Self::Call,
        _: &InherentData,
    ) -> Result<(), Self::Error> { ... }
}

A pallet that provides or verifies an inherent extrinsic will implement this trait.

The pallet may provide an inherent, verify an inherent, or both provide and verify.

Briefly, inherent extrinsics (“inherents”) are extrinsics that are added to a block by the block producer. See sp_inherents for more documentation on inherents.

Required Associated Types

type Call

The call type of the pallet.

type Error: Encode + IsFatalError

The error returned by check_inherent.

Required Associated Constants

const INHERENT_IDENTIFIER: InherentIdentifier

The inherent identifier used by this inherent.

Required Methods

fn create_inherent(data: &InherentData) -> Option<Self::Call>

Create an inherent out of the given InherentData.

NOTE: All checks necessary to ensure that the inherent is correct and that can be done in the runtime should happen in the returned Call. E.g. if this provides the timestamp, the call will check that the given timestamp is increasing the old timestamp by more than a minimum and it will also check that the timestamp hasn’t already been set in the current block.

fn is_inherent(call: &Self::Call) -> bool

Return whether the call is an inherent call.

NOTE: Signed extrinsics are not inherents, but a signed extrinsic with the given call variant can be dispatched.

Warning

In FRAME, inherents are enforced to be executed before other extrinsics. For this reason, pallets with unsigned transactions must ensure that no unsigned transaction call is an inherent call, when implementing ValidateUnsigned::validate_unsigned. Otherwise block producers can produce invalid blocks by including them after non inherents.

Provided Methods

fn is_inherent_required( _: &InherentData, ) -> Result<Option<Self::Error>, Self::Error>

Determines whether this inherent is required in this block.

• Ok(None) indicates that this inherent is not required in this block. The default implementation returns this.

• Ok(Some(e)) indicates that this inherent is required in this block. construct_runtime! will call this function in its implementation of fn check_extrinsics. If the inherent is not present, it will return e.

• Err(_) indicates that this function failed and further operations should be aborted.

NOTE: If the inherent is required then the runtime asserts that the block contains at least one inherent for which:

• type is Self::Call,
• Self::is_inherent returns true.

NOTE: This is currently only checked by block producers, not all full nodes.

fn check_inherent(_: &Self::Call, _: &InherentData) -> Result<(), Self::Error>

Check whether the given inherent is valid. Checking the inherent is optional and can be omitted by using the default implementation.

When checking an inherent, the first parameter represents the inherent that is actually included in the block by its author. Whereas the second parameter represents the inherent data that the verifying node calculates.

This is intended to allow for checks that cannot be done within the runtime such as, e.g., the timestamp.

Warning

This check is not guaranteed to be run by all full nodes and cannot be relied upon for ensuring that the block is correct.

Object Safety

This trait is not object safe.

Implementors