Module polkadot_runtime_parachains::hrmp::pallet
source · Expand description
The pallet module in each FRAME pallet hosts the most important items needed
to construct this pallet.
The main components of this pallet are:
Pallet, which implements all of the dispatchable extrinsics of the pallet, among other public functions.- The subset of the functions that are dispatchable can be identified either in the
dispatchablesmodule or in theCallenum.
- The subset of the functions that are dispatchable can be identified either in the
storage_types, which contains the list of all types that are representing a storage item. Otherwise, all storage items are listed among Type Definitions.Config, which contains the configuration trait of this pallet.EventandError, which are listed among the Enums.
Modules
- Auto-generated docs-only module listing all defined dispatchables for this pallet.
- Auto-generated docs-only module listing all (public and private) defined storage types for this pallet.
Structs
- Preopen the given HRMP channels.
- The
Palletstruct, the main type that implements traits and standalone functions within the pallet.
Enums
- Contains a variant per dispatchable extrinsic that this pallet has.
- The
Errorenum of this pallet. - The
Eventenum of this pallet
Traits
- Configuration trait of this pallet.
Type Definitions
- This mapping tracks how many open channel requests were accepted by a given recipient para. Invariant:
HrmpOpenChannelRequestsshould contain the same number of items(_, X)withconfirmedset to true, as the number ofHrmpAcceptedChannelRequestCountforX. - Storage for the messages for each channel. Invariant: cannot be non-empty if the corresponding channel in
HrmpChannelsisNone. - Maintains a mapping that can be used to answer the question: What paras sent a message at the given block number for a given receiver. Invariants:
- HRMP channel data associated with each para. Invariant:
- A set of pending HRMP close channel requests that are going to be closed during the session change. Used for checking if a given channel is registered for closure.
- Storage type is [
StorageValue] with value typeVec < HrmpChannelId >. - Storage type is [
StorageMap] with key typeParaIdand value typeVec < ParaId >. - Ingress/egress indexes allow to find all the senders and receivers given the opposite side. I.e.
- This mapping tracks how many open channel requests are initiated by a given sender para. Invariant:
HrmpOpenChannelRequestsshould contain the same number of items that has(X, _)as the number ofHrmpOpenChannelRequestCountforX. - The set of pending HRMP open channel requests.
- Storage type is [
StorageValue] with value typeVec < HrmpChannelId >. - The HRMP watermark associated with each para. Invariant:
- ModuleDeprecatedType alias to
Pallet, to be used byconstruct_runtime.