Module pallet

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§

config_preludes: Default implementations of DefaultConfig, which can be used to implement Config.
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.

AffectedPrefixesViewFunction: Returns the storage prefixes affected by the current migration.
OngoingStatusViewFunction: Returns the ongoing status of migrations.
Pallet: The Pallet struct, the main type that implements traits and standalone functions within the pallet.
ProgressViewFunction: Returns progress information about the current migration, if any.
StatusViewFunction: Returns the comprehensive status of multi-block migrations.

Config: Configuration trait of this pallet.
DefaultConfig: Based on Config. Auto-generated by #[pallet::config(with_default)]. Can be used in tandem with #[register_default_config] and #[derive_impl] to derive test config traits based on existing pallet config traits in a safe and developer-friendly way.

Cursor: The currently active migration to run and its cursor.
Historic: Set of all successfully executed migrations.
ModuleDeprecated: Type alias to Pallet, to be used by construct_runtime.