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§

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.

CommitHelpers 🔒: Internal helper struct for implementing low-level commitment trait operations.
GenesisConfig: No-BalanceOp Genesis configuration for the 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.
Pallet: Primary Marker type for the Commitment pallet.

Call: Contains a variant per dispatchable extrinsic that this pallet has.
Error: Commitment Pallet Errors
Event: The Event enum of this pallet
FreezeReason: Commitment pallet FreezeReason, merged into the runtime composite enum.
HoldReason: Commitment pallet HoldReason, merged into the runtime composite enum.

AssetToIssue: Tracks the total amount of assets that are scheduled to be issued/minted.
AssetToReap: Tracks the total amount of assets that are scheduled to be reaped/burned.
BalanceSnapShots: Snapshot storage for LazyBalance state.
CommitMap: Maps each Proprietor and the committed reason (CommitReason) to their commitment information.
DigestMap: Maps each CommitReason and its associated Digest to the digest’s information.
EntryMap: Stores commit information for individual entries within an index, scoped by both a CommitReason and the corresponding Proprietor.
IndexMap: Stores index information for a given CommitReason additionally keyed by IndexDigest.
ModuleDeprecated: Type alias to Pallet, to be used by construct_runtime.
PoolManager: Tracks the manager of each pool for a given reason.
PoolMap: Stores pool-level information associated with a specific CommitReason.
ReasonValue: Tracks the total committed asset value for a specific CommitReason.