Crate cumulus_primitives_core
source ·Expand description
Cumulus related core primitive types and traits.
Modules§
- A module that re-exports relevant relay chain definitions.
Structs§
- Abridged version of
HostConfiguration
(from theConfiguration
parachains host runtime module) meant to be used by a parachain or PDK such as cumulus. - Abridged version of
HrmpChannel
(from theHrmp
parachains host runtime module) meant to be used by a parachain or PDK such as cumulus. - A unit struct which can be converted into a
Location
of the innerparents
value. - A unit struct which can be converted into a
Location
of the innerparents
value and the inner interior. - Either an amount of a single fungible asset, or a single well-identified non-fungible asset.
- Location to identify an asset.
- A
Vec
ofAsset
s. - Information about an XCMP channel.
- An offset in the relay chain claim queue.
- Information about a collation.
- Information about a collation.
- A strictly increasing sequence number, typically this would be the least significant byte of the block number.
- Generic header digest.
- A wrapped version of
DownwardMessage
. The difference is that it has attached the block number when the message was sent. - A relative path between state-bearing consensus systems.
- Unique identifier of a parachain.
- The parachain block that is created by a collator.
- A unit struct which can be converted into a
Location
ofparents
value 1. - A tuple struct which can be converted into a
Location
ofparents
value 1 with the inner interior. - The validation data provides information about how to create the inputs for validation of a candidate. This information is derived from the chain state and will vary from para to para, although some fields may be the same for every para.
- Information regarding the composition of a query response.
- Validation parameters for evaluating the parachain validity function.
- Contextual data pertaining to a specific list of XCM instructions.
Enums§
- The origin of an inbound message.
Asset
collection, defined either by a number ofAssets
or a single wildcard.- A general identifier for an instance of a non-fungible asset class.
- An identifier of a pluralistic body.
- A part of a pluralistic body.
- The status of a channel.
- Consensus header digests for Cumulus parachains.
- Digest item that is able to encode/decode ‘system’ digest items and provide opaque access to other items.
- Classification of whether an asset is fungible or not, along with a mandatory amount or instance.
- Cross-Consensus Message: A message from one consensus system to another.
- A single item in a path to describe the relative location of a consensus system.
- Non-parent junctions that can be constructed, up to the length of 8. This specific
Junctions
implementation uses a Rustenum
in order to make pattern matching easier. - Error description of a message send failure.
- A global identifier of a data structure existing within consensus.
- Basically just the XCM (more general) version of
ParachainDispatchOrigin
. - Outcome of an XCM execution.
- Response data to a query.
- Error result value when attempting to send an XCM message.
- The “quality of service” considerations for message sending.
- An optional weight limit.
- A wildcard representing a set of assets.
- Classification of whether an asset is fungible or not.
- 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.
- The aggregate XCMP message format.
Constants§
- A consensus engine ID indicating that this is a Cumulus Parachain.
Traits§
- Something which fulfills the abstract idea of a Substrate block. It has types for
Extrinsic
pieces of information as well as aHeader
. - Runtime api to collect information about a collation.
- Something that should be called when a downward message is received.
- Type of XCM message executor.
- Runtime api used to select the core for which the next block will be built.
- Determine if a parachain is a system parachain or not.
- List all open outgoing channels.
- Utility for sending an XCM message to a given location.
- Something that should be called when sending an upward message.
- Something that should be called for each batch of messages received over XCMP.
- A means of figuring out what outbound XCMP messages should be being sent.
Functions§
- Extract the relay-parent from the provided header digest. Returns
None
if none were found. - Convenience function for using a
SendXcm
implementation. Just interprets thedest
and wraps both inSome
before passing them as as mutable references intoT::send_xcm
. - Convenience function for using a
SendXcm
implementation. Just interprets thedest
and wraps both inSome
before passing them as as mutable references intoT::send_xcm
.
Type Aliases§
- Consensus engine unique ID.
- An inbound HRMP message.
- A relative location which is constrained to be an interior location of the context.
- And outbound HRMP message
- An identifier for a query.
- Result value when attempting to send an XCM message.
- A message from a parachain to its Relay Chain.
- A hash type for identifying messages.