Module pallet_society::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.

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.
  • Instance1
    Instance1 to be used for instantiable palllets defined with the #[pallet] macro. Instances 2-16 are also available but are hidden from docs.
  • Pallet
    The Pallet struct, the main type that implements traits and standalone functions within the pallet.

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

Traits

  • Config
    Configuration trait of this pallet.

Type Definitions

  • Candidates
    Storage type is StorageMap with key type T :: AccountId and value type Candidacy < T :: AccountId, BalanceOf < T, I > >.
  • Founder
    The first member.
  • Head
    The most primary from the most recently approved rank 0 members in the society.
  • MemberByIndex
    The current items in Members keyed by their unique index. Keys are densely populated 0..MemberCount (does not include MemberCount).
  • MemberCount
    The number of items in Members currently. (Doesn’t include SuspendedMembers.)
  • Members
    The current members and their rank. Doesn’t include SuspendedMembers.
  • ModuleDeprecated
    Type alias to Pallet, to be used by construct_runtime.
  • NextHead
    At the end of the claim period, this contains the most recently approved members (along with their bid and round ID) who is from the most recent round with the lowest bid. They will become the new Head.
  • Payouts
    Information regarding rank-0 payouts, past and future.
  • Pot
    Amount of our account balance that is specifically for the next round’s bid(s).
  • RawEventDeprecated
    Old name generated by decl_event.
  • RoundCount
    The number of rounds which have passed.
  • Rules
    A hash of the rules of this society concerning membership. Can only be set once and only by the founder.
  • Skeptic
    The current skeptic.
  • SuspendedMembers
    The set of suspended members, with their old membership record.