referrerpolicy=no-referrer-when-downgrade

Module pallet

Module 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§

EnsureAssetOwner
Config::CreateOrigin admitting a signed origin only when it owns the internal asset. Prevents creating a PSM over an asset you don’t control (PSM mint/burn bypasses the asset’s issuer checks).
ExternalAssetInfo
On-chain record of an external asset approved on a PSM instance.
Pallet
The Pallet struct, the main type that implements traits and standalone functions within the pallet.
PsmAdminInfo
Admin origins and creation-deposit bookkeeping for a PSM instance. Always written and removed together with the Psm entry.
PsmInfo
On-chain record of a PSM instance.

Enums§

Call
Contains a variant per dispatchable extrinsic that this pallet has.
CircuitBreakerLevel
Circuit breaker levels for emergency control.
Error
The Error enum of this pallet.
Event
The Event enum of this pallet
HoldReason
A reason for this pallet placing a hold on funds.
PsmManagerLevel
Privilege level of an origin acting on a PSM instance.

Constants§

MAX_DECIMALS_DIFF
Maximum absolute difference between an external asset’s decimals and the internal asset’s decimals. Bounds the scaling factor 10^diff well below u128::MAX so realistic balances cannot overflow during conversion.

Traits§

Config
Configuration trait of this pallet.

Type Aliases§

ModuleDeprecated
Type alias to Pallet, to be used by construct_runtime.
Psm
Registered PSM instances, keyed by the internal asset id.
PsmAdmin
Admin origins and creation-deposit bookkeeping per PSM, keyed by the internal asset id. Held separately from Psm so swaps never decode the admin origins. Always written and removed together with the corresponding Psm entry.
PsmDebt
Internal-asset debt minted through PSM, per (internal, external) pair.