Module pallet

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 the Call enum.
• 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 and Error, which are listed among the Enums.

Modules

dispatchables

Auto-generated docs-only module listing all defined dispatchables for this pallet.

storage_types

Auto-generated docs-only module listing all (public and private) defined storage types for this pallet.

Structs

GenesisConfig

Can be used to configure the genesis state of this pallet.

Pallet

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Enums

Call

Contains a variant per dispatchable extrinsic that this pallet has.

Error

The Error enum of this pallet.

Event

The Event enum of this pallet

Traits

Config

Configuration trait of this pallet.

Type Aliases

AggregatedUnincludedSegment

Storage field that keeps track of bandwidth used by the unincluded segment along with the latest HRMP watermark. Used for limiting the acceptance of new blocks with respect to relay chain constraints.

AnnouncedHrmpMessagesPerCandidate

The number of HRMP messages we observed in on_initialize and thus used that number for announcing the weight of on_initialize and on_finalize.

CustomValidationHeadData

A custom head data that should be returned as result of validate_block.

DidSetValidationCode

Were the validation data set to notify the relay chain?

HostConfiguration

The parachain host configuration that was obtained from the relay parent.

HrmpOutboundMessages

HRMP messages that were sent in a block.

HrmpWatermark

HRMP watermark that was set in a block.

LastDmqMqcHead

The last downward message queue chain head we have observed.

LastHrmpMqcHeads

The message queue chain heads we have observed per each channel incoming channel.

LastProcessedDownwardMessage

The last processed downward message.

LastProcessedHrmpMessage

The last processed HRMP message.

LastRelayChainBlockNumber

The relay chain block number associated with the last parachain block.

ModuleDeprecated

Type alias to Pallet, to be used by construct_runtime.

NewValidationCode

Validation code that is set by the parachain and is to be communicated to collator and consequently the relay-chain.

PendingUpwardMessages

Upward messages that are still pending and not yet send to the relay chain.

PendingValidationCode

In case of a scheduled upgrade, this storage field contains the validation code to be applied.

ProcessedDownwardMessages

Number of downward messages processed in a block.

RelayStateProof

The state proof for the last relay parent block.

RelevantMessagingState

The snapshot of some state related to messaging relevant to the current parachain as per the relay parent.

ReservedDmpWeightOverride

The weight we reserve at the beginning of the block for processing DMP messages. This overrides the amount set in the Config trait.

ReservedXcmpWeightOverride

The weight we reserve at the beginning of the block for processing XCMP messages. This overrides the amount set in the Config trait.

UnincludedSegment

Latest included block descendants the runtime accepted. In other words, these are ancestors of the currently executing block which have not been included in the observed relay-chain state.

UpgradeGoAhead

Optional upgrade go-ahead signal from the relay-chain.

UpgradeRestrictionSignal

An option which indicates if the relay-chain restricts signalling a validation code upgrade. In other words, if this is Some and NewValidationCode is Some then the produced candidate will be invalid.

UpwardDeliveryFeeFactor

The factor to multiply the base delivery fee by for UMP.

UpwardMessages

Upward messages that were sent in a block.

ValidationData

The [PersistedValidationData] set for this block. This value is expected to be set only once per block and it’s never stored in the trie.