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

Re-exports

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

  • A single bid, an item of a queue in Queues.
  • Issuance information returned by issuance().
  • The Pallet struct, the main type that implements traits and standalone functions within the pallet.
  • Information representing a receipt.
  • Overall information package on the outstanding receipts.

Enums

  • Contains a variant per dispatchable extrinsic that this pallet has.
  • The Error enum of this pallet.
  • The Event enum of this pallet
  • A reason for the NIS pallet placing a hold on funds.

Traits

  • Configuration trait of this pallet.

Type Definitions

  • ModuleDeprecated
    Type alias to Pallet, to be used by construct_runtime.
  • The totals of items and balances within each queue. Saves a lot of storage reads in the case of sparsely packed queues.
  • The queues of bids. Indexed by duration (in Periods).
  • An index for a receipt.
  • The currently outstanding receipts, indexed according to the order of creation.
  • Summary information over the general state.