Trait staging_xcm::v2::SendXcm

source ·

pub trait SendXcm {
    // Required method
    fn send_xcm(
        destination: impl Into<MultiLocation>,
        message: Xcm<()>,
    ) -> SendResult;
}

👎Deprecated: XCMv2 will be removed once XCMv5 is released. Please use XCMv3 or XCMv4 instead.

Expand description

Utility for sending an XCM message.

These can be amalgamated in tuples to form sophisticated routing systems. In tuple format, each router might return NotApplicable to pass the execution to the next sender item. Note that each NotApplicable might alter the destination and the XCM message for to the next router.

§Example


/// A sender that only passes the message through and does nothing.
struct Sender1;
impl SendXcm for Sender1 {
    fn send_xcm(destination: impl Into<MultiLocation>, message: Xcm<()>) -> SendResult {
        return Err(SendError::NotApplicable(destination.into(), message))
    }
}

/// A sender that accepts a message that has two junctions, otherwise stops the routing.
struct Sender2;
impl SendXcm for Sender2 {
    fn send_xcm(destination: impl Into<MultiLocation>, message: Xcm<()>) -> SendResult {
        let destination = destination.into();
        if destination.parents == 0 && destination.interior.len() == 2 {
            Ok(())
        } else {
            Err(SendError::Unroutable)
        }
    }
}

/// A sender that accepts a message from a parent, passing through otherwise.
struct Sender3;
impl SendXcm for Sender3 {
    fn send_xcm(destination: impl Into<MultiLocation>, message: Xcm<()>) -> SendResult {
        let destination = destination.into();
        match destination {
            MultiLocation { parents: 1, interior: Here } => Ok(()),
            _ => Err(SendError::NotApplicable(destination, message)),
        }
    }
}

// A call to send via XCM. We don't really care about this.
let call: Vec<u8> = ().encode();
let message = Xcm(vec![Instruction::Transact {
    origin_type: OriginKind::Superuser,
    require_weight_at_most: 0,
    call: call.into(),
}]);

assert!(
    // Sender2 will block this.
    <(Sender1, Sender2, Sender3) as SendXcm>::send_xcm(Parent, message.clone())
        .is_err()
);

assert!(
    // Sender3 will catch this.
    <(Sender1, Sender3) as SendXcm>::send_xcm(Parent, message.clone())
        .is_ok()
);

Required Methods§

source

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

👎Deprecated: XCMv2 will be removed once XCMv5 is released. Please use XCMv3 or XCMv4 instead.

Send an XCM message to a given destination.

If it is not a destination which can be reached with this type but possibly could by others, then it MUST return NotApplicable. Any other error will cause the tuple implementation to exit early without trying other type fields.

Object Safety§

This trait is not object safe.

Trait staging_xcm::v2::SendXcmCopy item path

§Example

Required Methods§

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

Object Safety§

Implementations on Foreign Types§

impl SendXcm for ()

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

impl<TupleElement0: SendXcm> SendXcm for (TupleElement0,)

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

impl<TupleElement0: SendXcm, TupleElement1: SendXcm> SendXcm for (TupleElement0, TupleElement1)

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

impl<TupleElement0: SendXcm, TupleElement1: SendXcm, TupleElement2: SendXcm> SendXcm for (TupleElement0, TupleElement1, TupleElement2)

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

impl<TupleElement0: SendXcm, TupleElement1: SendXcm, TupleElement2: SendXcm, TupleElement3: SendXcm> SendXcm for (TupleElement0, TupleElement1, TupleElement2, TupleElement3)

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

impl<TupleElement0: SendXcm, TupleElement1: SendXcm, TupleElement2: SendXcm, TupleElement3: SendXcm, TupleElement4: SendXcm> SendXcm for (TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4)

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

impl<TupleElement0: SendXcm, TupleElement1: SendXcm, TupleElement2: SendXcm, TupleElement3: SendXcm, TupleElement4: SendXcm, TupleElement5: SendXcm> SendXcm for (TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5)

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

impl<TupleElement0: SendXcm, TupleElement1: SendXcm, TupleElement2: SendXcm, TupleElement3: SendXcm, TupleElement4: SendXcm, TupleElement5: SendXcm, TupleElement6: SendXcm> SendXcm for (TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4, TupleElement5, TupleElement6)

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

fn send_xcm( destination: impl Into<MultiLocation>, message: Xcm<()>, ) -> SendResult

Implementors§

Trait staging_xcm::v2::SendXcm