referrerpolicy=no-referrer-when-downgrade

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.

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§

GenesisConfig
Can be used to configure the genesis state of this pallet.
Instance1
Instance1 to be used for instantiable pallets defined with the #[pallet] macro. Instances 2-16 are also available but are hidden from docs.
MaybeHeadersToKeep
Adapter for using Config::HeadersToKeep as MaxValues bound in our storage maps.
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.
Error
The Error enum of this pallet.
Event
The Event enum of this pallet

Traits§

Config
Configuration trait of this pallet.

Functions§

on_free_header_imported
Called when new free header is imported.

Type Aliases§

BestFinalized
Hash of the best finalized header.
CurrentAuthoritySet
The current GRANDPA Authority set.
FreeHeadersRemaining
Number of free header submissions that we may yet accept in the current block.
ImportedHeaders
Relevant fields of imported headers.
ModuleDeprecated
Type alias to Pallet, to be used by construct_runtime.
PalletOperatingMode
The current operating mode of the pallet.
PalletOwner
Optional pallet owner.