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 send( origin: OriginFor<T>, dest: Box<VersionedLocation>, message: Box<VersionedXcm<()>>, ) -> DispatchResult

pub fn teleport_assets( origin: OriginFor<T>, dest: Box<VersionedLocation>, beneficiary: Box<VersionedLocation>, assets: Box<VersionedAssets>, fee_asset_item: u32, ) -> DispatchResult

👎Deprecated: This extrinsic uses WeightLimit::Unlimited, please migrate to limited_teleport_assets or transfer_assets

Teleport some assets from the local chain to some destination chain.

This function is deprecated: Use limited_teleport_assets instead.

Fee payment on the destination side is made from the asset in the assets vector of index fee_asset_item. The weight limit for fees is not provided and thus is unlimited, with all fees taken as needed from the asset.

• origin: Must be capable of withdrawing the assets and executing XCM.
• dest: Destination context for the assets. Will typically be [Parent, Parachain(..)] to send from parachain to parachain, or [Parachain(..)] to send from relay to parachain.
• beneficiary: A beneficiary location for the assets in the context of dest. Will generally be an AccountId32 value.
• assets: The assets to be withdrawn. This should include the assets used to pay the fee on the dest chain.
• fee_asset_item: The index into assets of the item which should be used to pay fees.

pub fn reserve_transfer_assets( origin: OriginFor<T>, dest: Box<VersionedLocation>, beneficiary: Box<VersionedLocation>, assets: Box<VersionedAssets>, fee_asset_item: u32, ) -> DispatchResult

👎Deprecated: This extrinsic uses WeightLimit::Unlimited, please migrate to limited_reserve_transfer_assets or transfer_assets

Transfer some assets from the local chain to the destination chain through their local, destination or remote reserve.

assets must have same reserve location and may not be teleportable to dest.

• assets have local reserve: transfer assets to sovereign account of destination chain and forward a notification XCM to dest to mint and deposit reserve-based assets to beneficiary.
• assets have destination reserve: burn local assets and forward a notification to dest chain to withdraw the reserve assets from this chain’s sovereign account and deposit them to beneficiary.
• assets have remote reserve: burn local assets, forward XCM to reserve chain to move reserves from this chain’s SA to dest chain’s SA, and forward another XCM to dest to mint and deposit reserve-based assets to beneficiary.

This function is deprecated: Use limited_reserve_transfer_assets instead.

Fee payment on the destination side is made from the asset in the assets vector of index fee_asset_item. The weight limit for fees is not provided and thus is unlimited, with all fees taken as needed from the asset.

• origin: Must be capable of withdrawing the assets and executing XCM.
• dest: Destination context for the assets. Will typically be [Parent, Parachain(..)] to send from parachain to parachain, or [Parachain(..)] to send from relay to parachain.
• beneficiary: A beneficiary location for the assets in the context of dest. Will generally be an AccountId32 value.
• assets: The assets to be withdrawn. This should include the assets used to pay the fee on the dest (and possibly reserve) chains.
• fee_asset_item: The index into assets of the item which should be used to pay fees.

pub fn execute( origin: OriginFor<T>, message: Box<VersionedXcm<<T as Config>::RuntimeCall>>, max_weight: Weight, ) -> DispatchResultWithPostInfo

Execute an XCM message from a local, signed, origin.

An event is deposited indicating whether msg could be executed completely or only partially.

No more than max_weight will be used in its attempted execution. If this is less than the maximum amount of weight that the message could take to be executed, then no execution attempt will be made.

pub fn force_xcm_version( origin: OriginFor<T>, location: Box<Location>, version: XcmVersion, ) -> DispatchResult

Extoll that a particular destination can be communicated with through a particular version of XCM.

• origin: Must be an origin specified by AdminOrigin.
• location: The destination that is being described.
• xcm_version: The latest version of XCM that location supports.

pub fn force_default_xcm_version( origin: OriginFor<T>, maybe_xcm_version: Option<XcmVersion>, ) -> DispatchResult

Set a safe XCM version (the version that XCM should be encoded with if the most recent version a destination can accept is unknown).

• origin: Must be an origin specified by AdminOrigin.
• maybe_xcm_version: The default XCM encoding version, or None to disable.

pub fn force_subscribe_version_notify( origin: OriginFor<T>, location: Box<VersionedLocation>, ) -> DispatchResult

Ask a location to notify us regarding their XCM version and any changes to it.

• origin: Must be an origin specified by AdminOrigin.
• location: The location to which we should subscribe for XCM version notifications.

pub fn force_unsubscribe_version_notify( origin: OriginFor<T>, location: Box<VersionedLocation>, ) -> DispatchResult

Require that a particular destination should no longer notify us regarding any XCM version changes.

• origin: Must be an origin specified by AdminOrigin.
• location: The location to which we are currently subscribed for XCM version notifications which we no longer desire.

pub fn limited_reserve_transfer_assets( origin: OriginFor<T>, dest: Box<VersionedLocation>, beneficiary: Box<VersionedLocation>, assets: Box<VersionedAssets>, fee_asset_item: u32, weight_limit: WeightLimit, ) -> DispatchResult

Transfer some assets from the local chain to the destination chain through their local, destination or remote reserve.

assets must have same reserve location and may not be teleportable to dest.

• assets have local reserve: transfer assets to sovereign account of destination chain and forward a notification XCM to dest to mint and deposit reserve-based assets to beneficiary.
• assets have destination reserve: burn local assets and forward a notification to dest chain to withdraw the reserve assets from this chain’s sovereign account and deposit them to beneficiary.
• assets have remote reserve: burn local assets, forward XCM to reserve chain to move reserves from this chain’s SA to dest chain’s SA, and forward another XCM to dest to mint and deposit reserve-based assets to beneficiary.

Fee payment on the destination side is made from the asset in the assets vector of index fee_asset_item, up to enough to pay for weight_limit of weight. If more weight is needed than weight_limit, then the operation will fail and the sent assets may be at risk.

• origin: Must be capable of withdrawing the assets and executing XCM.
• dest: Destination context for the assets. Will typically be [Parent, Parachain(..)] to send from parachain to parachain, or [Parachain(..)] to send from relay to parachain.
• beneficiary: A beneficiary location for the assets in the context of dest. Will generally be an AccountId32 value.
• assets: The assets to be withdrawn. This should include the assets used to pay the fee on the dest (and possibly reserve) chains.
• fee_asset_item: The index into assets of the item which should be used to pay fees.
• weight_limit: The remote-side weight limit, if any, for the XCM fee purchase.

pub fn limited_teleport_assets( origin: OriginFor<T>, dest: Box<VersionedLocation>, beneficiary: Box<VersionedLocation>, assets: Box<VersionedAssets>, fee_asset_item: u32, weight_limit: WeightLimit, ) -> DispatchResult

Teleport some assets from the local chain to some destination chain.

Fee payment on the destination side is made from the asset in the assets vector of index fee_asset_item, up to enough to pay for weight_limit of weight. If more weight is needed than weight_limit, then the operation will fail and the sent assets may be at risk.

• origin: Must be capable of withdrawing the assets and executing XCM.
• dest: Destination context for the assets. Will typically be [Parent, Parachain(..)] to send from parachain to parachain, or [Parachain(..)] to send from relay to parachain.
• beneficiary: A beneficiary location for the assets in the context of dest. Will generally be an AccountId32 value.
• assets: The assets to be withdrawn. This should include the assets used to pay the fee on the dest chain.
• fee_asset_item: The index into assets of the item which should be used to pay fees.
• weight_limit: The remote-side weight limit, if any, for the XCM fee purchase.

pub fn force_suspension(origin: OriginFor<T>, suspended: bool) -> DispatchResult

Set or unset the global suspension state of the XCM executor.

• origin: Must be an origin specified by AdminOrigin.
• suspended: true to suspend, false to resume.

pub fn transfer_assets( origin: OriginFor<T>, dest: Box<VersionedLocation>, beneficiary: Box<VersionedLocation>, assets: Box<VersionedAssets>, fee_asset_item: u32, weight_limit: WeightLimit, ) -> DispatchResult

Transfer some assets from the local chain to the destination chain through their local, destination or remote reserve, or through teleports.

Fee payment on the destination side is made from the asset in the assets vector of index fee_asset_item (hence referred to as fees), up to enough to pay for weight_limit of weight. If more weight is needed than weight_limit, then the operation will fail and the sent assets may be at risk.

assets (excluding fees) must have same reserve location or otherwise be teleportable to dest, no limitations imposed on fees.

• for local reserve: transfer assets to sovereign account of destination chain and forward a notification XCM to dest to mint and deposit reserve-based assets to beneficiary.

• for destination reserve: burn local assets and forward a notification to dest chain to withdraw the reserve assets from this chain’s sovereign account and deposit them to beneficiary.

• for remote reserve: burn local assets, forward XCM to reserve chain to move reserves from this chain’s SA to dest chain’s SA, and forward another XCM to dest to mint and deposit reserve-based assets to beneficiary.

• for teleports: burn local assets and forward XCM to dest chain to mint/teleport assets and deposit them to beneficiary.

• origin: Must be capable of withdrawing the assets and executing XCM.

• dest: Destination context for the assets. Will typically be X2(Parent, Parachain(..)) to send from parachain to parachain, or X1(Parachain(..)) to send from relay to parachain.

• beneficiary: A beneficiary location for the assets in the context of dest. Will generally be an AccountId32 value.

• assets: The assets to be withdrawn. This should include the assets used to pay the fee on the dest (and possibly reserve) chains.

• fee_asset_item: The index into assets of the item which should be used to pay fees.

• weight_limit: The remote-side weight limit, if any, for the XCM fee purchase.

pub fn claim_assets( origin: OriginFor<T>, assets: Box<VersionedAssets>, beneficiary: Box<VersionedLocation>, ) -> DispatchResult

Claims assets trapped on this pallet because of leftover assets during XCM execution.

• origin: Anyone can call this extrinsic.
• assets: The exact assets that were trapped. Use the version to specify what version was the latest when they were trapped.
• beneficiary: The location/account where the claimed assets will be deposited.

pub fn transfer_assets_using_type_and_then( origin: OriginFor<T>, dest: Box<VersionedLocation>, assets: Box<VersionedAssets>, assets_transfer_type: Box<TransferType>, remote_fees_id: Box<VersionedAssetId>, fees_transfer_type: Box<TransferType>, custom_xcm_on_dest: Box<VersionedXcm<()>>, weight_limit: WeightLimit, ) -> DispatchResult

Transfer assets from the local chain to the destination chain using explicit transfer types for assets and fees.

assets must have same reserve location or may be teleportable to dest. Caller must provide the assets_transfer_type to be used for assets:

• TransferType::LocalReserve: transfer assets to sovereign account of destination chain and forward a notification XCM to dest to mint and deposit reserve-based assets to beneficiary.
• TransferType::DestinationReserve: burn local assets and forward a notification to dest chain to withdraw the reserve assets from this chain’s sovereign account and deposit them to beneficiary.
• TransferType::RemoteReserve(reserve): burn local assets, forward XCM to reserve chain to move reserves from this chain’s SA to dest chain’s SA, and forward another XCM to dest to mint and deposit reserve-based assets to beneficiary. Typically the remote reserve is Asset Hub.
• TransferType::Teleport: burn local assets and forward XCM to dest chain to mint/teleport assets and deposit them to beneficiary.

On the destination chain, as well as any intermediary hops, BuyExecution is used to buy execution using transferred assets identified by remote_fees_id. Make sure enough of the specified remote_fees_id asset is included in the given list of assets. remote_fees_id should be enough to pay for weight_limit. If more weight is needed than weight_limit, then the operation will fail and the sent assets may be at risk.

remote_fees_id may use different transfer type than rest of assets and can be specified through fees_transfer_type.

The caller needs to specify what should happen to the transferred assets once they reach the dest chain. This is done through the custom_xcm_on_dest parameter, which contains the instructions to execute on dest as a final step. This is usually as simple as: Xcm(vec![DepositAsset { assets: Wild(AllCounted(assets.len())), beneficiary }]), but could be something more exotic like sending the assets even further.

• origin: Must be capable of withdrawing the assets and executing XCM.
• dest: Destination context for the assets. Will typically be [Parent, Parachain(..)] to send from parachain to parachain, or [Parachain(..)] to send from relay to parachain, or (parents: 2, (GlobalConsensus(..), ..)) to send from parachain across a bridge to another ecosystem destination.
• assets: The assets to be withdrawn. This should include the assets used to pay the fee on the dest (and possibly reserve) chains.
• assets_transfer_type: The XCM TransferType used to transfer the assets.
• remote_fees_id: One of the included assets to be used to pay fees.
• fees_transfer_type: The XCM TransferType used to transfer the fees assets.
• custom_xcm_on_dest: The XCM to be executed on dest chain as the last step of the transfer, which also determines what happens to the assets on the destination chain.
• weight_limit: The remote-side weight limit, if any, for the XCM fee purchase.

pub fn add_authorized_alias( origin: OriginFor<T>, aliaser: Box<VersionedLocation>, expires: Option<u64>, ) -> DispatchResult

Authorize another aliaser location to alias into the local origin making this call. The aliaser is only authorized until the provided expiry block number. The call can also be used for a previously authorized alias in order to update its expiry block number.

Usually useful to allow your local account to be aliased into from a remote location also under your control (like your account on another chain).

WARNING: make sure the caller origin (you) trusts the aliaser location to act in their/your name. Once authorized using this call, the aliaser can freely impersonate origin in XCM programs executed on the local chain.

pub fn remove_authorized_alias( origin: OriginFor<T>, aliaser: Box<VersionedLocation>, ) -> DispatchResult

Remove a previously authorized aliaser from the list of locations that can alias into the local origin making this call.

pub fn remove_all_authorized_aliases(origin: OriginFor<T>) -> DispatchResult

Remove all previously authorized aliasers that can alias into the local origin making this call.

impl<T: Config> Pallet<T>

pub fn query(query_id: &QueryId) -> Option<QueryStatus<BlockNumberFor<T>>>

The ongoing queries.

pub fn asset_trap(trap_id: &H256) -> u32

The existing asset traps.

Key is the blake2 256 hash of (origin, versioned Assets) pair. Value is the number of times this pair has been trapped (usually just 1 if it exists at all).

pub fn request_version_notify(dest: impl Into<Location>) -> XcmResult

Request that dest informs us of its version.

pub fn unrequest_version_notify(dest: impl Into<Location>) -> XcmResult

Request that dest ceases informing us of its version.

pub fn send_xcm( interior: impl Into<Junctions>, dest: impl Into<Location>, message: Xcm<()>, ) -> Result<XcmHash, SendError>

Relay an XCM message from a given interior location in this context to a given dest location. The fee_payer is charged for the delivery unless None in which case fees are not charged (and instead borne by the chain).

pub fn check_account() -> T::AccountId

pub fn dry_run_call<Runtime, Router, OriginCaller, RuntimeCall>( origin: OriginCaller, call: RuntimeCall, result_xcms_version: XcmVersion, ) -> Result<CallDryRunEffects<<Runtime as Config>::RuntimeEvent>, XcmDryRunApiError>

where Runtime: Config, Router: InspectMessageQueues, RuntimeCall: Dispatchable<PostInfo = PostDispatchInfo>, <RuntimeCall as Dispatchable>::RuntimeOrigin: From<OriginCaller>,

Dry-runs call with the given origin.

Returns not only the call result and events, but also the local XCM, if any, and any XCMs forwarded to other locations. Meant to be used in the xcm_runtime_apis::dry_run::DryRunApi runtime API.

pub fn dry_run_xcm<Runtime, Router, RuntimeCall: Decode + GetDispatchInfo, XcmConfig>( origin_location: VersionedLocation, xcm: VersionedXcm<RuntimeCall>, ) -> Result<XcmDryRunEffects<<Runtime as Config>::RuntimeEvent>, XcmDryRunApiError>

where Runtime: Config, Router: InspectMessageQueues, XcmConfig: Config<RuntimeCall = RuntimeCall>,

Dry-runs xcm with the given origin_location.

Returns execution result, events, and any forwarded XCMs to other locations. Meant to be used in the xcm_runtime_apis::dry_run::DryRunApi runtime API.

pub fn query_acceptable_payment_assets( version: Version, asset_ids: Vec<AssetId>, ) -> Result<Vec<VersionedAssetId>, XcmPaymentApiError>

Given a list of asset ids, returns the correct API response for XcmPaymentApi::query_acceptable_payment_assets.

The assets passed in have to be supported for fee payment.

pub fn query_xcm_weight( message: VersionedXcm<()>, ) -> Result<Weight, XcmPaymentApiError>

pub fn query_weight_to_asset_fee<Trader: WeightTrader>( weight: Weight, asset: VersionedAssetId, ) -> Result<u128, XcmPaymentApiError>

Computes the weight cost using the provided WeightTrader. This function is supposed to be used ONLY in XcmPaymentApi::query_weight_to_asset_fee.

The provided WeightTrader must be the same as the one used in the XcmExecutor to ensure uniformity in the weight cost calculation.

NOTE: Currently this function uses a workaround that should be good enough for all practical uses: passes u128::MAX / 2 == 2^127 of the specified asset to the WeightTrader as payment and computes the weight cost as the difference between this and the unspent amount.

Some weight traders could add the provided payment to some account’s balance. However, it should practically never result in overflow because even currencies with a lot of decimal digits (say 18) usually have the total issuance of billions (x * 10^9) or trillions (x * 10^12) at max, much less than 2^127 / 10^18 =~ 1.7 * 10^20 (170 billion billion). Thus, any account’s balance most likely holds less than 2^127, so adding 2^127 won’t result in u128 overflow.

pub fn query_delivery_fees( destination: VersionedLocation, message: VersionedXcm<()>, ) -> Result<VersionedAssets, XcmPaymentApiError>

Given a destination and XCM message, return assets to be charged as XCM delivery fees.

pub fn is_trusted_reserve( asset: VersionedAsset, location: VersionedLocation, ) -> Result<bool, TrustedQueryApiError>

Given an Asset and a Location, returns if the provided location is a trusted reserve for the given asset.

pub fn is_trusted_teleporter( asset: VersionedAsset, location: VersionedLocation, ) -> Result<bool, TrustedQueryApiError>

Given an Asset and a Location, returns if the asset can be teleported to provided location.

pub fn authorized_aliasers( target: VersionedLocation, ) -> Result<Vec<OriginAliaser>, AuthorizedAliasersApiError>

Returns locations allowed to alias into and act as target.

pub fn is_authorized_alias( origin: VersionedLocation, target: VersionedLocation, ) -> Result<bool, AuthorizedAliasersApiError>

Given an origin and a target, returns if the origin location was added by target as an authorized aliaser.

Effectively says whether origin is allowed to alias into and act as target.

pub fn report_outcome_notify( message: &mut Xcm<()>, responder: impl Into<Location>, notify: impl Into<<T as Config>::RuntimeCall>, timeout: BlockNumberFor<T>, ) -> Result<(), XcmError>

Consume message and return another which is equivalent to it except that it reports back the outcome and dispatches notify on this chain.

• message: The message whose outcome should be reported.
• responder: The origin from which a response should be expected.
• notify: A dispatchable function which will be called once the outcome of message is known. It may be a dispatchable in any pallet of the local chain, but other than the usual origin, it must accept exactly two arguments: query_id: QueryId and outcome: Response, and in that order. It should expect that the origin is Origin::Response and will contain the responder’s location.
• timeout: The block number after which it is permissible for notify not to be called even if a response is received.

report_outcome_notify may return an error if the responder is not invertible.

It is assumed that the querier of the response will be Here.

NOTE: notify gets called as part of handling an incoming message, so it should be lightweight. Its weight is estimated during this function and stored ready for weighing ReportOutcome on the way back. If it turns out to be heavier once it returns then reporting the outcome will fail. Furthermore if the estimate is too high, then it may be put in the overweight queue and need to be manually executed.

pub fn new_notify_query( responder: impl Into<Location>, notify: impl Into<<T as Config>::RuntimeCall>, timeout: BlockNumberFor<T>, match_querier: impl Into<Location>, ) -> u64

Attempt to create a new query ID and register it as a query that is yet to respond, and which will call a dispatchable when a response happens.

pub fn do_try_state() -> Result<(), TryRuntimeError>

Ensure the correctness of the state of this pallet.

This should be valid before and after each state transition of this pallet.

Invariants

All entries stored in the SupportedVersion / VersionNotifiers / VersionNotifyTargets need to be migrated to the XCM_VERSION. If they are not, then CurrentMigration has to be set.

Trait Implementations

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

type LockTicket = LockTicket<T>

Enact implementer for prepare_lock. This type may be dropped safely to avoid doing the lock.

type UnlockTicket = UnlockTicket<T>

Enact implementer for prepare_unlock. This type may be dropped safely to avoid doing the unlock.

type ReduceTicket = ReduceTicket<T>

Enact implementer for prepare_reduce_unlockable. This type may be dropped safely to avoid doing the unlock.

fn prepare_lock( unlocker: Location, asset: Asset, owner: Location, ) -> Result<LockTicket<T>, LockError>

Prepare to lock an asset. On success, a Self::LockTicket it returned, which can be used to actually enact the lock.

fn prepare_unlock( unlocker: Location, asset: Asset, owner: Location, ) -> Result<UnlockTicket<T>, LockError>

Prepare to unlock an asset. On success, a Self::UnlockTicket it returned, which can be used to actually enact the lock.

fn note_unlockable( locker: Location, asset: Asset, owner: Location, ) -> Result<(), LockError>

Handler for when a location reports to us that an asset has been locked for us to unlock at a later stage.

fn prepare_reduce_unlockable( locker: Location, asset: Asset, owner: Location, ) -> Result<Self::ReduceTicket, LockError>

Handler for when an owner wishes to unlock an asset on a remote chain.

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

type RuntimeCall = Call<T>

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

fn is_suspended<Call>( _origin: &Location, _instructions: &mut [Instruction<Call>], _max_weight: Weight, _properties: &mut Properties, ) -> bool

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

fn claim_assets( origin: &Location, ticket: &Location, assets: &Assets, _context: &XcmContext, ) -> bool

Claim any assets available to origin and return them in a single Assets value, together with the weight used by this operation.

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy 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> DropAssets for Pallet<T>

fn drop_assets( origin: &Location, assets: AssetsInHolding, _context: &XcmContext, ) -> Weight

Handler for receiving dropped assets. Returns the weight consumed by this operation.

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

fn emit_sent_event( origin: Location, destination: Location, message: Option<Xcm<()>>, message_id: XcmHash, )

Emits an event when an XCM is successfully sent.

fn emit_send_failure_event( origin: Location, destination: Location, error: SendError, message_id: XcmHash, )

Emits an event when an XCM fails to send.

fn emit_process_failure_event( origin: Location, error: XcmError, message_id: XcmHash, )

Emits an event when an XCM fails to process.

impl<T: Config> ExecuteController<<T as Config>::RuntimeOrigin, <T as Config>::RuntimeCall> for Pallet<T>

type WeightInfo = Pallet<T>

Weight information for ExecuteController functions.

fn execute( origin: OriginFor<T>, message: Box<VersionedXcm<<T as Config>::RuntimeCall>>, max_weight: Weight, ) -> Result<Weight, DispatchErrorWithPostInfo>

Attempt to execute an XCM locally, returns Ok with the weight consumed if the execution complete successfully, Err otherwise.

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

fn execute() -> Weight

Weight for [ExecuteController::execute]

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> GetVersion for Pallet<T>

fn get_version_for(dest: &Location) -> Option<XcmVersion>

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

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

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

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

Execute the sanity checks of this pallet, per block.

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.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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> OnResponse for Pallet<T>

fn expecting_response( origin: &Location, query_id: QueryId, querier: Option<&Location>, ) -> bool

Returns true if we are expecting a response from origin for query query_id that was queried by querier.

fn on_response( origin: &Location, query_id: QueryId, querier: Option<&Location>, response: Response, max_weight: Weight, _context: &XcmContext, ) -> Weight

Handler for receiving a response from origin relating to query_id initiated by querier.

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> QueryController<<T as Config>::RuntimeOrigin, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

type WeightInfo = Pallet<T>

Weight information for QueryController functions.

fn query( origin: OriginFor<T>, timeout: BlockNumberFor<T>, match_querier: VersionedLocation, ) -> Result<QueryId, DispatchError>

Query a remote location.

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

fn query() -> Weight

Weight for [QueryController::query]

fn take_response() -> Weight

Weight for [QueryHandler::take_response]

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

fn new_query( responder: impl Into<Location>, timeout: BlockNumberFor<T>, match_querier: impl Into<Location>, ) -> QueryId

Attempt to create a new query ID and register it as a query that is yet to respond.

fn report_outcome( message: &mut Xcm<()>, responder: impl Into<Location>, timeout: Self::BlockNumber, ) -> Result<QueryId, Self::Error>

To check the status of the query, use fn query() passing the resultant QueryId value.

fn take_response(query_id: QueryId) -> QueryResponseStatus<Self::BlockNumber>

Removes response when ready and emits Event::ResponseTaken event.

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

type Error = Error

type UniversalLocation = <T as Config>::UniversalLocation

fn expect_response(id: QueryId, response: Response)

Makes sure to expect a response with the given id.

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

fn should_record() -> bool

Whether or not we should record incoming XCMs.

fn set_record_xcm(enabled: bool)

Enable or disable recording.

fn recorded_xcm() -> Option<Xcm<()>>

Get recorded XCM. Returns None if no message was sent, or if recording was off.

fn record(xcm: Xcm<()>)

Record xcm.

impl<T: Config> SendController<<T as Config>::RuntimeOrigin> for Pallet<T>

type WeightInfo = Pallet<T>

Weight information for SendController functions.

fn send( origin: OriginFor<T>, dest: Box<VersionedLocation>, message: Box<VersionedXcm<()>>, ) -> Result<XcmHash, DispatchError>

Send an XCM to be executed by a remote location.

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

fn send() -> Weight

Weight for [SendController::send]

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> VersionChangeNotifier for Pallet<T>

fn start( dest: &Location, query_id: QueryId, max_weight: Weight, _context: &XcmContext, ) -> XcmResult

Start notifying location should the XCM version of this chain change.

When it does, this type should ensure a QueryResponse message is sent with the given query_id & max_weight and with a response of Response::Version. This should happen until/unless stop is called with the correct query_id.

If the location has an ongoing notification and when this function is called, then an error should be returned.

fn stop(dest: &Location, _context: &XcmContext) -> XcmResult

Stop notifying location should the XCM change. This is a no-op if there was never a subscription.

fn is_subscribed(dest: &Location) -> bool

Return true if a location is subscribed to XCM version changes.

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: Config> WrapVersion for Pallet<T>

fn wrap_version<RuntimeCall: Decode + GetDispatchInfo>( dest: &Location, xcm: impl Into<VersionedXcm<RuntimeCall>>, ) -> Result<VersionedXcm<RuntimeCall>, ()>

impl<T> Eq for Pallet<T>