Crate cumulus_pallet_parachain_system

cumulus-pallet-parachain-system is a base pallet for Cumulus-based parachains.

This pallet handles low-level details of being a parachain. Its responsibilities include:

• ingestion of the parachain validation data;
• ingestion and dispatch of incoming downward and lateral messages;
• coordinating upgrades with the Relay Chain; and
• communication of parachain outputs, such as sent messages, signaling an upgrade, etc.

Users must ensure that they register this pallet as an inherent provider.

Re-exports

pub use weights::WeightInfo;

pub use consensus_hook::ConsensusHook;

pub use consensus_hook::ExpectParentIncluded;

pub use relay_state_snapshot::MessagingStateSnapshot;

pub use relay_state_snapshot::RelayChainStateProof;

pub use pallet::*;

Modules

consensus_hook

The definition of a ConsensusHook trait for consensus logic to manage the backlog of parachain blocks ready to submit to the relay chain, as well as some basic implementations.

migration

pallet

The pallet module in each FRAME pallet hosts the most important items needed to construct this pallet.

parachain_inherent

Cumulus parachain inherent related structures.

relay_state_snapshot

Relay chain state proof provides means for accessing part of relay chain storage for reads.

ump_constants

validate_block

A module that enables a runtime to work as parachain.

weights

Autogenerated weights for cumulus_pallet_parachain_system

Macros

register_validate_block

Register the validate_block function that is used by parachains to validate blocks on a validator.

Structs

Ancestor

Ancestor of the block being currently executed, not yet included into the relay chain.

AnyRelayNumber

Provides an implementation of CheckAssociatedRelayNumber.

ParachainSetCode

Type that implements SetCode.

RelayChainState

Holds the most recent relay-parent state root and block number of the current parachain block.

RelayNumberMonotonicallyIncreases

Provides an implementation of CheckAssociatedRelayNumber.

RelayNumberStrictlyIncreases

Provides an implementation of CheckAssociatedRelayNumber.

RelaychainDataProvider

Implements [BlockNumberProvider] and RelaychainStateProvider that returns relevant relay data fetched from validation data.

UsedBandwidth

Bandwidth used by a parachain block(s).

Traits

CheckAssociatedRelayNumber

Something that can check the associated relay block number.

OnSystemEvent

Something that should be informed about system related events.

RelaychainStateProvider

This exposes the RelayChainState to other runtime modules.

Type Aliases

MaxDmpMessageLenOf

The max length of a DMP message.

RelaychainBlockNumberProviderDeprecated

Implements [BlockNumberProvider] that returns relay chain block number fetched from validation data.