Module pallet_ranked_collective::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

  • 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

  • IdToIndex
    The index of each ranks’s member into the group of members who have at least that rank.
  • IndexToId
    The members in the collective by index. All indices in the range 0..MemberCount will return Some, however a member’s index is not guaranteed to remain unchanged over time.
  • MemberCount
    The number of members in the collective who have at least the rank according to the index of the vec.
  • Members
    The current members of the collective.
  • ModuleDeprecated
    Type alias to Pallet, to be used by construct_runtime.
  • Voting
    Votes on a given proposal, if it is ongoing.
  • VotingCleanup
    Storage type is StorageMap with key type PollIndexOf < T, I > and value type BoundedVec < u8, KeyLenOf < Voting < T, I > > >.