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
dispatchablesmodule or in theCallenum.
- The subset of the functions that are dispatchable can be identified either in the
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.EventandError, which are listed among the Enums.
Modules
- Auto-generated docs-only module listing all defined dispatchables for this pallet.
- Auto-generated docs-only module listing all (public and private) defined storage types for this pallet.
Structs
- The
Palletstruct, the main type that implements traits and standalone functions within the pallet.
Enums
- Contains a variant per dispatchable extrinsic that this pallet has.
- The
Errorenum of this pallet. - The
Eventenum of this pallet
Traits
- Configuration trait of this pallet.
Type Definitions
- Like frame_system::block_number, but this one only increments if the parachain status is RUNNING. This variable is used to keep track of durations, such as the issue/redeem/replace expiry. If the parachain is not RUNNING, no payment proofs can be submitted, and it wouldn’t be fair to punish the user/vault. By using this variable we ensure that they have sufficient time to submit their proof.
- Storage type is [
StorageValue] with value typebool. - ModuleDeprecatedType alias to
Pallet, to be used byconstruct_runtime. - Integer increment-only counter, used to prevent collisions when generating identifiers for e.g. issue, redeem or replace requests (for OP_RETURN field in Bitcoin).