referrerpolicy=no-referrer-when-downgrade

Module pallet

Module pallet 

Source
Expand description

The pallet module in each FRAME pallet hosts the most important items needed to construct this pallet.

The main components of this pallet are:

  • Pallet, which implements all of the dispatchable extrinsics of the pallet, among other public functions.
    • The subset of the functions that are dispatchable can be identified either in the dispatchables module or in the Call enum.
  • storage_types, which contains the list of all types that are representing a storage item. Otherwise, all storage items are listed among Type Definitions.
  • Config, which contains the configuration trait of this pallet.
  • Event and Error, which are listed among the Enums.

Re-exports§

pub use crate::weights::WeightInfo;

Modules§

dispatchables
Auto-generated docs-only module listing all defined dispatchables for this pallet.
storage_types
Auto-generated docs-only module listing all (public and private) defined storage types for this pallet.

Structs§

EraCollators
The collators returned for a session from the validator set of era.
EraValidatorSet
A validator set received for an era.
Pallet
The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Enums§

Call
Contains a variant per dispatchable extrinsic that this pallet has.
CollatorDraw
How many validators of the stored set are drawn as collators.
Error
The Error enum of this pallet.
Event
The Event enum of this pallet
RotationState
Progress of the two rotations that bring a received set into force.
UnexpectedKind
The kinds of Event::Unexpected.

Traits§

Config
Configuration trait of this pallet.

Type Aliases§

AuthoredBlocks
Blocks authored since the last report, per author.
DrawnCollators
The collators last returned to pallet-session, taken from ExternalValidatorSet.
EpochRandomness
The relay chain randomness of one epoch ago, read from the relay chain state proof of every block and written when it changes.
ExpectedEraDuration
Expected time from the arrival of a validator set to the end of its era, in milliseconds.
ExternalSetReceivedAt
Time at which we received the last ExternalValidatorSet, in milliseconds. Removed when the report before the expected end of its era is made.
ExternalValidatorSet
The latest received validator set.
MaxCollators
How many validators are returned as collators, see CollatorDraw. Only validators with keys count against the cap. It is Config::DefaultMaxCollators until Pallet::set_max_collators stores a value.
ModuleDeprecated
Type alias to Pallet, to be used by construct_runtime.
PendingRotation
Progress of the forced rotations for the latest received set.
ReportMargin
Time before the expected end of an era at which the counts are reported, in milliseconds. Used up to Config::MaxReportMargin and up to half of ExpectedEraDuration.
ReportPeriod
Number of blocks between two reports of AuthoredBlocks. A report is made in every block whose number is a multiple of it.