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.

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

GenesisConfig

Can be used to configure the genesis state of this pallet.

Pallet

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

RewardInfo

Stores info about the rewards owed as well as how much has been vested so far. For a primer on this kind of design, see the recipe on compounding interest https://substrate.dev/recipes/fixed-point.html#continuously-compounding

Enums

Call

Contains a variant per dispatchable extrinsic that this pallet has.

Error

The Error enum of this pallet.

Event

The Event enum of this pallet

Constants

PALLET_ID

WRAPPED_BYTES_POSTFIX

WRAPPED_BYTES_PREFIX

Traits

Config

Configuration trait of this pallet.

Type Aliases

AccountsPayable

Storage type is [StorageMap] with key type T :: AccountId and value type RewardInfo < T >.

BalanceOf

ClaimedRelayChainIds

Storage type is [StorageMap] with key type T :: RelayChainAccountId and value type ().

ContributorData

Type alias for contributor data: (relay_account, optional_native_account, reward)

Initialized

Storage type is [StorageValue] with value type bool.

ModuleDeprecated

Type alias to Pallet, to be used by construct_runtime.

UnassociatedContributions

Storage type is [StorageMap] with key type T :: RelayChainAccountId and value type RewardInfo < T >.