Enum pallet_xcm::pallet::Call

pub enum Call<T: Config> {
    send {
        dest: Box<VersionedMultiLocation>,
        message: Box<VersionedXcm<()>>,
    },
    teleport_assets {
        dest: Box<VersionedMultiLocation>,
        beneficiary: Box<VersionedMultiLocation>,
        assets: Box<VersionedMultiAssets>,
        fee_asset_item: u32,
    },
    reserve_transfer_assets {
        dest: Box<VersionedMultiLocation>,
        beneficiary: Box<VersionedMultiLocation>,
        assets: Box<VersionedMultiAssets>,
        fee_asset_item: u32,
    },
    execute {
        message: Box<VersionedXcm<<T as SysConfig>::Call>>,
        max_weight: Weight,
    },
    force_xcm_version {
        location: Box<MultiLocation>,
        xcm_version: XcmVersion,
    },
    force_default_xcm_version {
        maybe_xcm_version: Option<XcmVersion>,
    },
    force_subscribe_version_notify {
        location: Box<VersionedMultiLocation>,
    },
    force_unsubscribe_version_notify {
        location: Box<VersionedMultiLocation>,
    },
    limited_reserve_transfer_assets {
        dest: Box<VersionedMultiLocation>,
        beneficiary: Box<VersionedMultiLocation>,
        assets: Box<VersionedMultiAssets>,
        fee_asset_item: u32,
        weight_limit: WeightLimit,
    },
    limited_teleport_assets {
        dest: Box<VersionedMultiLocation>,
        beneficiary: Box<VersionedMultiLocation>,
        assets: Box<VersionedMultiAssets>,
        fee_asset_item: u32,
        weight_limit: WeightLimit,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

send

Fields

dest: Box<VersionedMultiLocation>

message: Box<VersionedXcm<()>>

teleport_assets

Fields

dest: Box<VersionedMultiLocation>

beneficiary: Box<VersionedMultiLocation>

assets: Box<VersionedMultiAssets>

fee_asset_item: u32

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.

reserve_transfer_assets

Fields

dest: Box<VersionedMultiLocation>

beneficiary: Box<VersionedMultiLocation>

assets: Box<VersionedMultiAssets>

fee_asset_item: u32

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.

execute

Fields

message: Box<VersionedXcm<<T as SysConfig>::Call>>

max_weight: Weight

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.

force_xcm_version

Fields

location: Box<MultiLocation>

xcm_version: XcmVersion

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

• origin: Must be Root.
• location: The destination that is being described.
• xcm_version: The latest version of XCM that location supports.

force_default_xcm_version

Fields

maybe_xcm_version: Option<XcmVersion>

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 Root.
• maybe_xcm_version: The default XCM encoding version, or None to disable.

force_subscribe_version_notify

Fields

location: Box<VersionedMultiLocation>

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

• origin: Must be Root.
• location: The location to which we should subscribe for XCM version notifications.

force_unsubscribe_version_notify

Fields

location: Box<VersionedMultiLocation>

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

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

limited_reserve_transfer_assets

Fields

dest: Box<VersionedMultiLocation>

beneficiary: Box<VersionedMultiLocation>

assets: Box<VersionedMultiAssets>

fee_asset_item: u32

weight_limit: WeightLimit

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.

limited_teleport_assets

Fields

dest: Box<VersionedMultiLocation>

beneficiary: Box<VersionedMultiLocation>

assets: Box<VersionedMultiAssets>

fee_asset_item: u32

weight_limit: WeightLimit

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.

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_send(
    dest: Box<VersionedMultiLocation>,
    message: Box<VersionedXcm<()>>
) -> Self

Create a call with the variant send.

pub fn new_call_variant_teleport_assets(
    dest: Box<VersionedMultiLocation>,
    beneficiary: Box<VersionedMultiLocation>,
    assets: Box<VersionedMultiAssets>,
    fee_asset_item: u32
) -> Self

Create a call with the variant teleport_assets.

pub fn new_call_variant_reserve_transfer_assets(
    dest: Box<VersionedMultiLocation>,
    beneficiary: Box<VersionedMultiLocation>,
    assets: Box<VersionedMultiAssets>,
    fee_asset_item: u32
) -> Self

Create a call with the variant reserve_transfer_assets.

pub fn new_call_variant_execute(
    message: Box<VersionedXcm<<T as SysConfig>::Call>>,
    max_weight: Weight
) -> Self

Create a call with the variant execute.

pub fn new_call_variant_force_xcm_version(
    location: Box<MultiLocation>,
    xcm_version: XcmVersion
) -> Self

Create a call with the variant force_xcm_version.

pub fn new_call_variant_force_default_xcm_version(
    maybe_xcm_version: Option<XcmVersion>
) -> Self

Create a call with the variant force_default_xcm_version.

pub fn new_call_variant_force_subscribe_version_notify(
    location: Box<VersionedMultiLocation>
) -> Self

Create a call with the variant force_subscribe_version_notify.

pub fn new_call_variant_force_unsubscribe_version_notify(
    location: Box<VersionedMultiLocation>
) -> Self

Create a call with the variant force_unsubscribe_version_notify.

pub fn new_call_variant_limited_reserve_transfer_assets(
    dest: Box<VersionedMultiLocation>,
    beneficiary: Box<VersionedMultiLocation>,
    assets: Box<VersionedMultiAssets>,
    fee_asset_item: u32,
    weight_limit: WeightLimit
) -> Self

Create a call with the variant limited_reserve_transfer_assets.

pub fn new_call_variant_limited_teleport_assets(
    dest: Box<VersionedMultiLocation>,
    beneficiary: Box<VersionedMultiLocation>,
    assets: Box<VersionedMultiAssets>,
    fee_asset_item: u32,
    weight_limit: WeightLimit
) -> Self

Create a call with the variant limited_teleport_assets.

Trait Implementations

impl<T: Config> Clone for Call<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: Config> Debug for Call<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names.

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq<Call<T>> for Call<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> TypeInfo for Call<T>where
    PhantomData<(T,)>: TypeInfo + 'static,
    Box<VersionedXcm<<T as SysConfig>::Call>>: TypeInfo + 'static,
    T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type Origin = <T as Config>::Origin

The origin type of the runtime, (i.e. frame_system::Config::Origin).

fn dispatch_bypass_filter(
    self,
    origin: Self::Origin
) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike<Call<T>> for Call<T>

impl<T: Config> Eq for Call<T>