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
dispatchablesmodule or in theCallenum.
- The subset of the functions that are dispatchable can be identified either in the
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.EventandError, 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§
- Ensure
Asset Owner Config::CreateOriginadmitting 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).- External
Asset Info - On-chain record of an external asset approved on a PSM instance.
- Pallet
- The
Palletstruct, the main type that implements traits and standalone functions within the pallet. - PsmAdmin
Info - Admin origins and creation-deposit bookkeeping for a PSM instance. Always written
and removed together with the
Psmentry. - PsmInfo
- On-chain record of a PSM instance.
Enums§
- Call
- Contains a variant per dispatchable extrinsic that this pallet has.
- Circuit
Breaker Level - Circuit breaker levels for emergency control.
- Error
- The
Errorenum of this pallet. - Event
- The
Eventenum of this pallet - Hold
Reason - A reason for this pallet placing a hold on funds.
- PsmManager
Level - 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^diffwell belowu128::MAXso realistic balances cannot overflow during conversion.
Traits§
- Config
- Configuration trait of this pallet.
Type Aliases§
- Module
Deprecated - Type alias to
Pallet, to be used byconstruct_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
Psmso swaps never decode the admin origins. Always written and removed together with the correspondingPsmentry. - PsmDebt
- Internal-asset debt minted through PSM, per
(internal, external)pair.