Enum xcm::v0::prelude::Order

pub enum Order<Call> {
    Null,
    DepositAsset {
        assets: Vec<MultiAsset>,
        dest: MultiLocation,
    },
    DepositReserveAsset {
        assets: Vec<MultiAsset>,
        dest: MultiLocation,
        effects: Vec<Order<()>>,
    },
    ExchangeAsset {
        give: Vec<MultiAsset>,
        receive: Vec<MultiAsset>,
    },
    InitiateReserveWithdraw {
        assets: Vec<MultiAsset>,
        reserve: MultiLocation,
        effects: Vec<Order<()>>,
    },
    InitiateTeleport {
        assets: Vec<MultiAsset>,
        dest: MultiLocation,
        effects: Vec<Order<()>>,
    },
    QueryHolding {
        query_id: u64,
        dest: MultiLocation,
        assets: Vec<MultiAsset>,
    },
    BuyExecution {
        fees: MultiAsset,
        weight: u64,
        debt: u64,
        halt_on_error: bool,
        xcm: Vec<Xcm<Call>>,
    },
}

An instruction to be executed on some or all of the assets in holding, used by asset-related XCM messages.

Variants

Null

Do nothing. Not generally used.

DepositAsset

Fields

assets: Vec<MultiAsset>

dest: MultiLocation

Remove the asset(s) (assets) from holding and place equivalent assets under the ownership of dest within this consensus system.

• assets: The asset(s) to remove from holding.
• dest: The new owner for the assets.

Errors:

DepositReserveAsset

Fields

assets: Vec<MultiAsset>

dest: MultiLocation

effects: Vec<Order<()>>

Remove the asset(s) (assets) from holding and place equivalent assets under the ownership of dest within this consensus system.

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

• assets: The asset(s) to remove from holding.
• dest: The new owner for the assets.
• effects: The orders that should be contained in the ReserveAssetDeposit which is sent onwards to dest.

Errors:

ExchangeAsset

Fields

give: Vec<MultiAsset>

receive: Vec<MultiAsset>

Remove the asset(s) (give) from holding and replace them with alternative assets.

The minimum amount of assets to be received into holding for the order not to fail may be stated.

• give: The asset(s) to remove from holding.
• receive: The minimum amount of assets(s) which give should be exchanged for. The meaning of wildcards is undefined and they should be not be used.

Errors:

InitiateReserveWithdraw

Fields

assets: Vec<MultiAsset>

reserve: MultiLocation

effects: Vec<Order<()>>

Remove the asset(s) (assets) from holding and send a WithdrawAsset XCM message to a reserve location.

• assets: The asset(s) to remove from holding.
• reserve: A valid location that acts as a reserve for all asset(s) in assets. The sovereign account of this consensus system on the reserve location will have appropriate assets withdrawn and effects will be executed on them. There will typically be only one valid location on any given asset/chain combination.
• effects: The orders to execute on the assets once withdrawn on the reserve location.

Errors:

InitiateTeleport

Fields

assets: Vec<MultiAsset>

dest: MultiLocation

effects: Vec<Order<()>>

Remove the asset(s) (assets) from holding and send a TeleportAsset XCM message to a destination location.

• assets: The asset(s) to remove from holding.
• destination: A valid location that has a bi-lateral teleportation arrangement.
• effects: The orders to execute on the assets once arrived on the destination location.

Errors:

QueryHolding

Fields

query_id: u64

dest: MultiLocation

assets: Vec<MultiAsset>

Send a Balances XCM message with the assets value equal to the holding contents, or a portion thereof.

• query_id: An identifier that will be replicated into the returned XCM message.
• dest: A valid destination for the returned XCM message. This may be limited to the current origin.
• assets: A filter for the assets that should be reported back. The assets reported back will be, asset- wise, the lesser of this value and the holding account. No wildcards will be used when reporting assets back.

Errors:

BuyExecution

Fields

fees: MultiAsset

weight: u64

debt: u64

halt_on_error: bool

xcm: Vec<Xcm<Call>>

Pay for the execution of some XCM with up to weight picoseconds of execution time, paying for this with up to fees from the holding account.

Errors:

Implementations

impl<Call> Order<Call>

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

pub fn from<C>(order: Order<C>) -> Self

Trait Implementations

impl<Call> Clone for Order<Call>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Call> Debug for Order<Call>

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

Formats the value using the given formatter.

impl<Call> Decode for Order<Call>

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<Call> Encode for Order<Call>

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<Call> PartialEq<Order<Call>> for Order<Call>

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<Call> TryFrom<Order<Call>> for Order<Call>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(old: Order1<Call>) -> Result<Order<Call>, ()>

Performs the conversion.

impl<Call> TryFrom<Order<Call>> for Order<Call>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(old: OldOrder<Call>) -> Result<Order<Call>, ()>

Performs the conversion.

impl<Call> TypeInfo for Order<Call>where
    Call: 'static,

type Identity = Order<Call>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<Call> EncodeLike<Order<Call>> for Order<Call>

impl<Call> Eq for Order<Call>