Enum xcm::v1::Xcm

pub enum Xcm<RuntimeCall> {
    WithdrawAsset {
        assets: MultiAssets,
        effects: Vec<Order<RuntimeCall>>,
    },
    ReserveAssetDeposited {
        assets: MultiAssets,
        effects: Vec<Order<RuntimeCall>>,
    },
    ReceiveTeleportedAsset {
        assets: MultiAssets,
        effects: Vec<Order<RuntimeCall>>,
    },
    QueryResponse {
        query_id: u64,
        response: Response,
    },
    TransferAsset {
        assets: MultiAssets,
        beneficiary: MultiLocation,
    },
    TransferReserveAsset {
        assets: MultiAssets,
        dest: MultiLocation,
        effects: Vec<Order<()>>,
    },
    Transact {
        origin_type: OriginKind,
        require_weight_at_most: u64,
        call: DoubleEncoded<RuntimeCall>,
    },
    HrmpNewChannelOpenRequest {
        sender: u32,
        max_message_size: u32,
        max_capacity: u32,
    },
    HrmpChannelAccepted {
        recipient: u32,
    },
    HrmpChannelClosing {
        initiator: u32,
        sender: u32,
        recipient: u32,
    },
    RelayedFrom {
        who: InteriorMultiLocation,
        message: Box<Xcm<RuntimeCall>>,
    },
    SubscribeVersion {
        query_id: u64,
        max_response_weight: u64,
    },
    UnsubscribeVersion,
}

Cross-Consensus Message: A message from one consensus system to another.

Consensus systems that may send and receive messages include blockchains and smart contracts.

All messages are delivered from a known origin, expressed as a MultiLocation.

This is the inner XCM format and is version-sensitive. Messages are typically passed using the outer XCM format, known as VersionedXcm.

Variants

WithdrawAsset

Fields

assets: MultiAssets

effects: Vec<Order<RuntimeCall>>

Withdraw asset(s) (assets) from the ownership of origin and place them into holding. Execute the orders (effects).

• assets: The asset(s) to be withdrawn into holding.
• effects: The order(s) to execute on the holding register.

Kind: Instruction.

Errors:

ReserveAssetDeposited

Fields

assets: MultiAssets

effects: Vec<Order<RuntimeCall>>

Asset(s) (assets) have been received into the ownership of this system on the origin system.

Some orders are given (effects) which should be executed once the corresponding derivative assets have been placed into holding.

• assets: The asset(s) that are minted into holding.
• effects: The order(s) to execute on the holding register.

Safety: origin must be trusted to have received and be storing assets such that they may later be withdrawn should this system send a corresponding message.

Kind: Trusted Indication.

Errors:

ReceiveTeleportedAsset

Fields

assets: MultiAssets

effects: Vec<Order<RuntimeCall>>

Asset(s) (assets) have been destroyed on the origin system and equivalent assets should be created on this system.

Some orders are given (effects) which should be executed once the corresponding derivative assets have been placed into the Holding Register.

• assets: The asset(s) that are minted into the Holding Register.
• effects: The order(s) to execute on the Holding Register.

Safety: origin must be trusted to have irrevocably destroyed the corresponding assets prior as a consequence of sending this message.

Kind: Trusted Indication.

Errors:

QueryResponse

Fields

query_id: u64

response: Response

Indication of the contents of the holding register corresponding to the QueryHolding order of query_id.

• query_id: The identifier of the query that resulted in this message being sent.
• assets: The message content.

Safety: No concerns.

Kind: Information.

Errors:

TransferAsset

Fields

assets: MultiAssets

beneficiary: MultiLocation

Withdraw asset(s) (assets) from the ownership of origin and place equivalent assets under the ownership of beneficiary.

• assets: The asset(s) to be withdrawn.
• beneficiary: The new owner for the assets.

Safety: No concerns.

Kind: Instruction.

Errors:

TransferReserveAsset

Fields

assets: MultiAssets

dest: MultiLocation

effects: Vec<Order<()>>

Withdraw asset(s) (assets) from the ownership of origin and place equivalent assets under the ownership of dest within this consensus system (i.e. its sovereign account).

Send an onward XCM message to dest of ReserveAssetDeposited with the given effects.

• assets: The asset(s) to be withdrawn.
• dest: The location whose sovereign account will own the assets and thus the effective beneficiary for the assets and the notification target for the reserve asset deposit message.
• effects: The orders that should be contained in the ReserveAssetDeposited which is sent onwards to dest.

Safety: No concerns.

Kind: Instruction.

Errors:

Transact

Fields

origin_type: OriginKind

require_weight_at_most: u64

call: DoubleEncoded<RuntimeCall>

Apply the encoded transaction call, whose dispatch-origin should be origin as expressed by the kind of origin origin_type.

• origin_type: The means of expressing the message origin as a dispatch origin.
• max_weight: The weight of call; this should be at least the chain’s calculated weight and will be used in the weight determination arithmetic.
• call: The encoded transaction to be applied.

Safety: No concerns.

Kind: Instruction.

Errors:

HrmpNewChannelOpenRequest

Fields

sender: u32

max_message_size: u32

max_capacity: u32

A message to notify about a new incoming HRMP channel. This message is meant to be sent by the relay-chain to a para.

• sender: The sender in the to-be opened channel. Also, the initiator of the channel opening.
• max_message_size: The maximum size of a message proposed by the sender.
• max_capacity: The maximum number of messages that can be queued in the channel.

Safety: The message should originate directly from the relay-chain.

Kind: System Notification

HrmpChannelAccepted

Fields

recipient: u32

A message to notify about that a previously sent open channel request has been accepted by the recipient. That means that the channel will be opened during the next relay-chain session change. This message is meant to be sent by the relay-chain to a para.

Safety: The message should originate directly from the relay-chain.

Kind: System Notification

Errors:

HrmpChannelClosing

Fields

initiator: u32

sender: u32

recipient: u32

A message to notify that the other party in an open channel decided to close it. In particular, initiator is going to close the channel opened from sender to the recipient. The close will be enacted at the next relay-chain session change. This message is meant to be sent by the relay-chain to a para.

Safety: The message should originate directly from the relay-chain.

Kind: System Notification

Errors:

RelayedFrom

Fields

who: InteriorMultiLocation

message: Box<Xcm<RuntimeCall>>

A message to indicate that the embedded XCM is actually arriving on behalf of some consensus location within the origin.

Kind: Instruction

Errors:

SubscribeVersion

Fields

query_id: u64

max_response_weight: u64

Ask the destination system to respond with the most recent version of XCM that they support in a QueryResponse instruction. Any changes to this should also elicit similar responses when they happen.

Kind: Instruction

UnsubscribeVersion

Cancel the effect of a previous SubscribeVersion instruction.

Kind: Instruction

Implementations

impl<RuntimeCall> Xcm<RuntimeCall>

pub fn into<C>(self) -> Xcm<C>

pub fn from<C>(xcm: Xcm<C>) -> Self

Trait Implementations

impl<RuntimeCall> Clone for Xcm<RuntimeCall>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<RuntimeCall> Debug for Xcm<RuntimeCall>

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

Formats the value using the given formatter.

impl<RuntimeCall> Decode for Xcm<RuntimeCall>

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<RuntimeCall> Encode for Xcm<RuntimeCall>

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<RuntimeCall> From<Xcm<RuntimeCall>> for VersionedXcm<RuntimeCall>

fn from(x: Xcm<RuntimeCall>) -> Self

Converts to this type from the input type.

impl<RuntimeCall> PartialEq<Xcm<RuntimeCall>> for Xcm<RuntimeCall>

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<RuntimeCall> TryFrom<VersionedXcm<RuntimeCall>> for Xcm<RuntimeCall>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(x: VersionedXcm<RuntimeCall>) -> Result<Self, ()>

Performs the conversion.

impl<RuntimeCall> TryFrom<Xcm<RuntimeCall>> for Xcm<RuntimeCall>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(old: OldXcm<RuntimeCall>) -> Result<Xcm<RuntimeCall>, ()>

Performs the conversion.

impl<RuntimeCall> TryFrom<Xcm<RuntimeCall>> for Xcm<RuntimeCall>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(x: Xcm1<RuntimeCall>) -> Result<Xcm<RuntimeCall>, ()>

Performs the conversion.

impl<RuntimeCall> TryFrom<Xcm<RuntimeCall>> for Xcm<RuntimeCall>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(old: NewXcm<RuntimeCall>) -> Result<Xcm<RuntimeCall>, ()>

Performs the conversion.

impl<RuntimeCall> TryFrom<Xcm<RuntimeCall>> for Xcm<RuntimeCall>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(old: OldXcm<RuntimeCall>) -> Result<Xcm<RuntimeCall>, ()>

Performs the conversion.

impl<RuntimeCall> TypeInfo for Xcm<RuntimeCall>where RuntimeCall: 'static,

type Identity = Xcm<RuntimeCall>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<RuntimeCall> EncodeLike<Xcm<RuntimeCall>> for Xcm<RuntimeCall>

impl<RuntimeCall> Eq for Xcm<RuntimeCall>