Struct xcm_builder::PayOverXcm

pub struct PayOverXcm<Interior, Router, Querier, Timeout, Beneficiary, AssetKind, AssetKindToLocatableAsset, BeneficiaryRefToLocation>(_);

Implementation of the frame_support::traits::tokens::Pay trait, to allow for XCM-based payments of a given Balance of some asset ID existing on some chain under ownership of some Interior location of the local chain to a particular Beneficiary. The AssetKind value is not itself bounded (to avoid the issue of needing to wrap some preexisting datatype), however a converter type AssetKindToLocatableAsset must be provided in order to translate it into a LocatableAsset, which comprises both an XCM MultiLocation describing the XCM endpoint on which the asset to be paid resides and an XCM AssetId to identify the specific asset at that endpoint.

This relies on the XCM TransferAsset instruction. A trait BeneficiaryRefToLocation must be provided in order to convert the Beneficiary reference into a location usable by TransferAsset.

PayOverXcm::pay is asynchronous, and returns a QueryId which can then be used in check_payment to check the status of the XCM transaction.

See also PayAccountId32OverXcm which is similar to this except that BeneficiaryRefToLocation need not be supplied and Beneficiary must implement Into<[u8; 32]>.

Trait Implementations

impl<Interior: Get<InteriorMultiLocation>, Router: SendXcm, Querier: QueryHandler, Timeout: Get<Querier::BlockNumber>, Beneficiary: Clone, AssetKind, AssetKindToLocatableAsset: Convert<AssetKind, LocatableAssetId>, BeneficiaryRefToLocation: for<'a> Convert<&'a Beneficiary, MultiLocation>> Pay for PayOverXcm<Interior, Router, Querier, Timeout, Beneficiary, AssetKind, AssetKindToLocatableAsset, BeneficiaryRefToLocation>

type Beneficiary = Beneficiary

The type by which we identify the beneficiaries to whom a payment may be made.

type AssetKind = AssetKind

The type for the kinds of asset that are going to be paid.

type Balance = u128

The type by which we measure units of the currency in which we make payments.

type Id = <Querier as QueryHandler>::QueryId

An identifier given to an individual payment.

type Error = Error

An error which could be returned by the Pay type

fn pay( who: &Self::Beneficiary, asset_kind: Self::AssetKind, amount: Self::Balance ) -> Result<Self::Id, Self::Error>

Make a payment and return an identifier for later evaluation of success in some off-chain mechanism (likely an event, but possibly not on this chain).

fn check_payment(id: Self::Id) -> PaymentStatus

Check how a payment has proceeded. id must have been previously returned by pay for the result of this call to be meaningful. Once this returns anything other than InProgress for some id it must return Unknown rather than the actual result value.