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.

A FRAME based pallet. This mod is the entry point for everything else. All #[pallet::xxx] macros must be defined in this mod. Although, frame also provides an experimental feature to break these parts into different mods. See [pallet_examples] for more.

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§

Pallet
A mandatory struct in each pallet. All functions callable by external users (aka. transactions) must be attached to this type (see [frame::pallet_macros::call]). For convenience, internal (private) functions can also be attached to this type.

Enums§

Call
All dispatchable call functions (aka. transactions) are attached to Pallet in a impl block.
Event
The events that this pallet can emit.

Traits§

Config
Configuration trait of this pallet.

Type Aliases§

ModuleDeprecated
Type alias to Pallet, to be used by construct_runtime.
Value
A storage item that this pallet contains. This will be part of the state root trie of the blockchain.