Struct pallet_xcm::pallet::Pallet

pub struct Pallet<T>(_);

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<VersionedMultiLocation>, message: Box<VersionedXcm<()>> ) -> DispatchResult

pub fn teleport_assets( origin: OriginFor<T>, dest: Box<VersionedMultiLocation>, beneficiary: Box<VersionedMultiLocation>, assets: Box<VersionedMultiAssets>, fee_asset_item: u32 ) -> 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. 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 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. The first item should be the currency used to to pay the fee on the dest side. May not be empty.
• 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<VersionedMultiLocation>, beneficiary: Box<VersionedMultiLocation>, assets: Box<VersionedMultiAssets>, fee_asset_item: u32 ) -> DispatchResult

Transfer some assets from the local chain to the sovereign account of a destination chain and forward a notification XCM.

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 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 side.
• 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 SysConfig>::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.

NOTE: A successful return to this does not imply that the msg was executed successfully to completion; only that some of it was executed.

pub fn force_xcm_version( origin: OriginFor<T>, location: Box<MultiLocation>, 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<VersionedMultiLocation> ) -> 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<VersionedMultiLocation> ) -> 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<VersionedMultiLocation>, beneficiary: Box<VersionedMultiLocation>, assets: Box<VersionedMultiAssets>, fee_asset_item: u32, weight_limit: WeightLimit ) -> DispatchResult

Transfer some assets from the local chain to the sovereign account of a destination chain and forward a notification XCM.

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 assets send may be at risk.

• 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 side.
• 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<VersionedMultiLocation>, beneficiary: Box<VersionedMultiLocation>, assets: Box<VersionedMultiAssets>, 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 assets send may be at risk.

• 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. The first item should be the currency used to to pay the fee on the dest side. May not be empty.
• 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.

impl<T: Config> Pallet<T>

pub fn query<KArg>(k: KArg) -> Option<QueryStatus<BlockNumberFor<T>>>where KArg: EncodeLike<QueryId>,

“ The ongoing queries.“

impl<T: Config> Pallet<T>

pub fn asset_trap<KArg>(k: KArg) -> u32where KArg: EncodeLike<H256>,

“ The existing asset traps.“ “” “ Key is the blake2 256 hash of (origin, versioned MultiAssets) pair. Value is the number of“ “ times this pair has been trapped (usually just 1 if it exists at all).“

impl<T: Config> Pallet<T>

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

Request that dest informs us of its version.

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

Request that dest ceases informing us of its version.

pub fn send_xcm( interior: impl Into<Junctions>, dest: impl Into<MultiLocation>, 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 report_outcome_notify( message: &mut Xcm<()>, responder: impl Into<MultiLocation>, 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. Futhermore 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<MultiLocation>, notify: impl Into<<T as Config>::RuntimeCall>, timeout: BlockNumberFor<T>, match_querier: impl Into<MultiLocation> ) -> 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.

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: MultiLocation, asset: MultiAsset, owner: MultiLocation ) -> 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: MultiLocation, asset: MultiAsset, owner: MultiLocation ) -> 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: MultiLocation, asset: MultiAsset, owner: MultiLocation ) -> 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: MultiLocation, asset: MultiAsset, owner: MultiLocation ) -> Result<Self::ReduceTicket, LockError>

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

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

type RuntimeCall = Call<T>

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

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

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

fn claim_assets( origin: &MultiLocation, ticket: &MultiLocation, assets: &MultiAssets, _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> DropAssets for Pallet<T>

fn drop_assets( origin: &MultiLocation, assets: Assets, _context: &XcmContext ) -> Weight

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

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

type CurrentStorageVersion = StorageVersion

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

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 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_runtime_upgrade() -> Weight

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

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 wasm runtime.

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

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

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

fn on_response( origin: &MultiLocation, query_id: QueryId, querier: Option<&MultiLocation>, 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].

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

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

fn new_query( responder: impl Into<MultiLocation>, timeout: BlockNumberFor<T>, match_querier: impl Into<MultiLocation> ) -> Self::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<MultiLocation>, timeout: Self::BlockNumber ) -> Result<Self::QueryId, Self::Error>

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

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

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

type QueryId = u64

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

type Error = Error

type UniversalLocation = <T as Config>::UniversalLocation

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

fn storage_info() -> Vec<StorageInfo>

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

fn start( dest: &MultiLocation, 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: &MultiLocation, _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: &MultiLocation) -> bool

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

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>( dest: &MultiLocation, xcm: impl Into<VersionedXcm<RuntimeCall>> ) -> Result<VersionedXcm<RuntimeCall>, ()>

impl<T> Eq for Pallet<T>