Module pallet

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

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.

Structs

MigrationLimits

The limits of a migration.

MigrationTask

A migration task stored in state.

Pallet

The outer Pallet struct.

Enums

Call

Contains a variant per dispatchable extrinsic that this pallet has.

Error

The Error enum of this pallet.

Event

Inner events of this pallet.

HoldReason

The reason for this pallet placing a hold on funds.

MigrationCompute

How a migration was computed.

Progress

The progress of either the top or child keys.

Traits

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.

Type Aliases

AutoLimits

The limits that are imposed on automatic migrations.

MigrationProcess

Migration progress.

ModuleDeprecated

Type alias to Pallet, to be used by construct_runtime.

ProgressOf

Convenience type for easier usage of Progress.

SignedMigrationMaxLimits

The maximum limits that the signed migration could use.