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.

Re-exports§

  • pub use __tt_error_token_1 as tt_error_token;
  • pub use __tt_default_parts_7 as tt_default_parts;
  • pub use __tt_extra_parts_7 as tt_extra_parts;
  • pub use __tt_default_parts_v2_7 as tt_default_parts_v2;

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§

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

Enums§

  • Contains a variant per dispatchable extrinsic that this pallet has.
  • The Error enum of this pallet.
  • The Event enum of this pallet

Traits§

  • Configuration trait of this pallet.

Type Aliases§

  • The number of referenda being decided currently.
  • The metadata is a general information concerning the referendum. The Hash refers to the preimage of the Preimages provider which can be a JSON dump or IPFS hash of a JSON file.
  • ModuleDeprecated
    Type alias to Pallet, to be used by construct_runtime.
  • The next free referendum index, aka the number of referenda started so far.
  • Information concerning any given referendum.
  • The sorted list of referenda ready to be decided but not yet being decided, ordered by conviction-weighted approvals.