Module xcm::v3

source ·
Expand description

Version 3 of the Cross-Consensus Message format data structures.

Re-exports

Modules

  • opaque
  • prelude
    A prelude for importing all types typically used when interacting with XCM messages.

Structs

  • Ancestor
    A unit struct which can be converted into a MultiLocation of the inner parents value.
  • AncestorThen
    A unit struct which can be converted into a MultiLocation of the inner parents value and the inner interior.
  • MaxDispatchErrorLen
    Maximum size of the encoded error code coming from a Dispatch result, used for MaybeErrorCode. This is not (yet) enforced, so it’s just an indication of expectation.
  • MaxPalletNameLen
  • MaxPalletsInfo
  • MultiAsset
    Either an amount of a single fungible asset, or a single well-identified non-fungible asset.
  • MultiAssets
    A Vec of MultiAssets.
  • MultiLocation
    A relative path between state-bearing consensus systems.
  • PalletInfo
  • Parent
    A unit struct which can be converted into a MultiLocation of parents value 1.
  • ParentThen
    A tuple struct which can be converted into a MultiLocation of parents value 1 with the inner interior.
  • QueryResponseInfo
    Information regarding the composition of a query response.
  • Weight
  • Xcm
  • XcmContext
    Contextual data pertaining to a specific list of XCM instructions.

Enums

  • AssetId
    Classification of an asset being concrete or abstract.
  • AssetInstance
    A general identifier for an instance of a non-fungible asset class.
  • BodyId
    An identifier of a pluralistic body.
  • BodyPart
    A part of a pluralistic body.
  • Error
    Error codes used in XCM. The first errors codes have explicit indices and are part of the XCM format. Those trailing are merely part of the XCM implementation; there is no expectation that they will retain the same index over time.
  • Fungibility
    Classification of whether an asset is fungible or not, along with a mandatory amount or instance.
  • Instruction
    Cross-Consensus Message: A message from one consensus system to another.
  • Junction
    A single item in a path to describe the relative location of a consensus system.
  • Junctions
    Non-parent junctions that can be constructed, up to the length of 8. This specific Junctions implementation uses a Rust enum in order to make pattern matching easier.
  • MaybeErrorCode
  • MultiAssetFilter
    MultiAsset collection, defined either by a number of MultiAssets or a single wildcard.
  • NetworkId
    A global identifier of a data structure existing within consensus.
  • Outcome
    Outcome of an XCM execution.
  • Response
    Response data to a query.
  • SendError
    Error result value when attempting to send an XCM message.
  • WeightLimit
    An optional weight limit.
  • WildFungibility
    Classification of whether an asset is fungible or not.
  • WildMultiAsset
    A wildcard representing a set of assets.

Constants

  • VERSION
    This module’s XCM version.

Traits

Functions

  • send_xcm
    Convenience function for using a SendXcm implementation. Just interprets the dest and wraps both in Some before passing them as as mutable references into T::send_xcm.
  • validate_send
    Convenience function for using a SendXcm implementation. Just interprets the dest and wraps both in Some before passing them as as mutable references into T::send_xcm.

Type Definitions