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
dispatchables
module or in theCall
enum.
- 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.Event
andError
, which are listed among the Enums.
Re-exports§
pub use __tt_error_token_49 as tt_error_token;
pub use __tt_default_parts_55 as tt_default_parts;
pub use __tt_extra_parts_55 as tt_extra_parts;
pub use __tt_default_parts_v2_55 as tt_default_parts_v2;
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
Pallet
struct, the main type that implements traits and standalone functions within the pallet.
Enums§
- Contains a variant per dispatchable extrinsic that this pallet has.
- The
Error
enum of this pallet. - The
Event
enum of this pallet
Traits§
- Configuration trait of this pallet.
Type Aliases§
- This mapping tracks how many open channel requests were accepted by a given recipient para. Invariant:
HrmpOpenChannelRequests
should contain the same number of items(_, X)
withconfirmed
set to true, as the number ofHrmpAcceptedChannelRequestCount
forX
. - Storage for the messages for each channel. Invariant: cannot be non-empty if the corresponding channel in
HrmpChannels
isNone
. - 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 typeParaId
and 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:
HrmpOpenChannelRequests
should contain the same number of items that has(X, _)
as the number ofHrmpOpenChannelRequestCount
forX
. - 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
.