Struct Pallet 

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

pub fn mint( origin: OriginFor<T>, asset_id: T::AssetId, external_amount: <<T as Config>::Fungibles as FungiblesInspect<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

Swap external stablecoin for internal.

Dispatch Origin

Must be Signed by the user performing the swap.

Details

Transfers external_amount of the specified external stablecoin from the caller to the PSM account, then mints internal to the caller minus the minting fee. The fee is calculated using ceiling rounding (mul_ceil), ensuring the protocol never undercharges. The fee is transferred to Config::FeeDestination.

Parameters

• asset_id: The external stablecoin to deposit (must be in ExternalAssets)
• external_amount: Amount of external stablecoin to deposit

Errors

• Error::UnsupportedAsset: If asset_id is not an approved external stablecoin
• Error::MintingStopped: If circuit breaker is at MintingDisabled or higher
• Error::BelowMinimumSwap: If external_amount is below Config::MinSwapAmount
• Error::ExceedsMaxIssuance: If minting would exceed system-wide internal issuance cap
• Error::ExceedsMaxPsmDebt: If minting would exceed PSM debt ceiling (aggregate or per-asset)
• Error::DecimalsMismatch: If the asset’s decimals do not match the internal asset’s decimals
• Error::AmountTooSmallAfterConversion: if the conversion to the counter-asset rounds to zero; swap would transfer nothing

Events

• Event::Minted: Emitted on successful mint

pub fn redeem( origin: OriginFor<T>, asset_id: T::AssetId, amount: <<T as Config>::Fungibles as FungiblesInspect<<T as Config>::AccountId>>::Balance, ) -> DispatchResult

Swap internal for external stablecoin.

Dispatch Origin

Must be Signed by the user performing the swap.

Details

Burns amount internal from the caller minus fee (transferred to Config::FeeDestination), then transfers the resulting amount in external stablecoin from PSM to the caller. The fee is calculated using ceiling rounding (mul_ceil), ensuring the protocol never undercharges.

Parameters

• asset_id: The external stablecoin to receive (must be in ExternalAssets)
• amount: Amount of internal to redeem

Errors

• Error::UnsupportedAsset: If asset_id is not an approved external stablecoin
• Error::AllSwapsStopped: If circuit breaker is at AllDisabled
• Error::BelowMinimumSwap: If amount is below Config::MinSwapAmount
• Error::InsufficientReserve: If PSM has insufficient external stablecoin
• Error::DecimalsMismatch: If the asset’s decimals do not match the internal asset’s decimals
• Error::AmountTooSmallAfterConversion: if the conversion to the counter-asset rounds to zero; swap would transfer nothing

Events

• Event::Redeemed: Emitted on successful redemption

pub fn set_minting_fee( origin: OriginFor<T>, asset_id: T::AssetId, fee: Permill, ) -> DispatchResult

Set the minting fee for a specific asset (external → internal).

Dispatch Origin

Must be Config::ManagerOrigin.

Parameters

• asset_id: The external stablecoin to configure
• fee: The new minting fee as a Permill

Events

• Event::MintingFeeUpdated: Emitted with old and new values

pub fn set_redemption_fee( origin: OriginFor<T>, asset_id: T::AssetId, fee: Permill, ) -> DispatchResult

Set the redemption fee for a specific asset (internal → external).

Dispatch Origin

Must be Config::ManagerOrigin.

Parameters

• asset_id: The external stablecoin to configure
• fee: The new redemption fee as a Permill

Events

• Event::RedemptionFeeUpdated: Emitted with old and new values

pub fn set_max_psm_debt(origin: OriginFor<T>, ratio: Permill) -> DispatchResult

Set the maximum PSM debt as a percentage of total maximum issuance.

Dispatch Origin

Must be Config::ManagerOrigin.

Events

• Event::MaxPsmDebtOfTotalUpdated: Emitted with old and new values

pub fn set_asset_status( origin: OriginFor<T>, asset_id: T::AssetId, status: CircuitBreakerLevel, ) -> DispatchResult

Set the circuit breaker status for a specific external asset.

Dispatch Origin

Must be Config::ManagerOrigin.

Details

Controls which operations are allowed for this asset:

• CircuitBreakerLevel::AllEnabled: All swaps allowed
• CircuitBreakerLevel::MintingDisabled: Only redemptions allowed (useful for draining debt)
• CircuitBreakerLevel::AllDisabled: No swaps allowed

Parameters

• asset_id: The external stablecoin to configure
• status: The new circuit breaker level for this asset

Errors

• Error::AssetNotApproved: If the asset is not in the approved list

Events

• Event::AssetStatusUpdated: Emitted with the asset ID and new status

pub fn set_asset_ceiling_weight( origin: OriginFor<T>, asset_id: T::AssetId, weight: Permill, ) -> DispatchResult

Set the per-asset debt ceiling weight.

Dispatch Origin

Must be Config::ManagerOrigin.

Details

Ratios act as weights normalized against the sum of all asset weights: max_asset_debt = (ratio / sum_of_all_ratios) * MaxPsmDebtOfTotal * MaximumIssuance

With a single asset, the weight always normalizes to 100% of the PSM ceiling.

Parameters

• asset_id: The external stablecoin to configure
• ratio: Weight for this asset’s share of the total PSM ceiling

Events

• Event::AssetCeilingWeightUpdated: Emitted with old and new values

pub fn add_external_asset( origin: OriginFor<T>, asset_id: T::AssetId, ) -> DispatchResult

Add an external stablecoin to the approved list.

Dispatch Origin

Must be Config::ManagerOrigin.

Parameters

• asset_id: The external stablecoin to add

Errors

• Error::AssetAlreadyApproved: If the asset is already in the approved list

Events

• Event::ExternalAssetAdded: Emitted on successful addition

pub fn remove_external_asset( origin: OriginFor<T>, asset_id: T::AssetId, ) -> DispatchResult

Remove an external stablecoin from the approved list.

Dispatch Origin

Must be Config::ManagerOrigin.

Details

The asset cannot be removed if it has non-zero PSM debt outstanding. This prevents orphaned debt that cannot be redeemed.

Upon removal, the associated configuration is also cleaned up:

• MintingFee for this asset
• RedemptionFee for this asset
• AssetCeilingWeight for this asset

Parameters

• asset_id: The external stablecoin to remove

Errors

• Error::AssetNotApproved: If the asset is not in the approved list
• Error::AssetHasDebt: If the asset has non-zero PSM debt

Events

• Event::ExternalAssetRemoved: Emitted on successful removal

Trait Implementations

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T> Benchmarking for Pallet<T>

where T: Config + Config, T::Fungibles: FungiblesCreate<T::AccountId>, T::InternalAsset: FungibleCreate<T::AccountId>,

Available on crate features runtime-benchmarks only.

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32, ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> DispatchViewFunction for Pallet<T>

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

impl<T: Config> GetStorageVersion for Pallet<T>

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn integrity_test()

Check the integrity of this pallet’s configuration.

fn try_state(_n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block.

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> PsmInterface for Pallet<T>

type Balance = <<T as Config>::Fungibles as Inspect<<T as Config>::AccountId>>::Balance

The balance type.

fn reserved_capacity() -> Self::Balance

Get the amount of internal/minting stablecoin issuance capacity reserved by the PSM.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> TryDecodeEntireStorage for Pallet<T>

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

impl<T: Config> ViewFunctionIdPrefix for Pallet<T>

fn prefix() -> [u8; 16]

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>