Struct cumulus_pallet_parachain_system::pallet::Pallet

pub struct Pallet<T>(_);

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

Implementations

impl<T: Config> Pallet<T>

pub fn set_validation_data( origin: OriginFor<T>, data: ParachainInherentData ) -> DispatchResultWithPostInfo

Set the current validation data.

This should be invoked exactly once per block. It will panic at the finalization phase if the call was not invoked.

The dispatch origin for this call must be Inherent

As a side effect, this function upgrades the current validation function if the appropriate time has come.

pub fn sudo_send_upward_message( origin: OriginFor<T>, message: UpwardMessage ) -> DispatchResult

pub fn authorize_upgrade( origin: OriginFor<T>, code_hash: T::Hash, check_version: bool ) -> DispatchResult

Authorize an upgrade to a given code_hash for the runtime. The runtime can be supplied later.

The check_version parameter sets a boolean flag for whether or not the runtime’s spec version and name should be verified on upgrade. Since the authorization only has a hash, it cannot actually perform the verification.

This call requires Root origin.

pub fn enact_authorized_upgrade( _: OriginFor<T>, code: Vec<u8> ) -> DispatchResultWithPostInfo

Provide the preimage (runtime binary) code for an upgrade that has been authorized.

If the authorization required a version check, this call will ensure the spec name remains unchanged and that the spec version has increased.

Note that this function will not apply the new code, but only attempt to schedule the upgrade with the Relay Chain.

All origins are allowed.

impl<T: Config> Pallet<T>

pub fn new_validation_function() -> Vec<u8>

“ In case of a scheduled upgrade, this storage field contains the validation code to be“ “ applied.“ “” “ As soon as the relay chain gives us the go-ahead signal, we will overwrite the“ “ [:code][sp_core::storage::well_known_keys::CODE] which will result the next block process“ “ with the new validation code. This concludes the upgrade process.“

impl<T: Config> Pallet<T>

pub fn validation_data() -> Option<PersistedValidationData>

“ 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.“

impl<T: Config> Pallet<T>

pub fn relay_state_proof() -> Option<StorageProof>

“ The state proof for the last relay parent block.“ “” “ This field is meant to be updated each block with the validation data inherent. Therefore,“ “ before processing of the inherent, e.g. in on_initialize this data may be stale.“ “” “ This data is also absent from the genesis.“

impl<T: Config> Pallet<T>

pub fn relevant_messaging_state() -> Option<MessagingStateSnapshot>

“ The snapshot of some state related to messaging relevant to the current parachain as per“ “ the relay parent.“ “” “ This field is meant to be updated each block with the validation data inherent. Therefore,“ “ before processing of the inherent, e.g. in on_initialize this data may be stale.“ “” “ This data is also absent from the genesis.“

impl<T: Config> Pallet<T>

pub fn host_configuration() -> Option<AbridgedHostConfiguration>

“ The parachain host configuration that was obtained from the relay parent.“ “” “ This field is meant to be updated each block with the validation data inherent. Therefore,“ “ before processing of the inherent, e.g. in on_initialize this data may be stale.“ “” “ This data is also absent from the genesis.“

impl<T: Config> Pallet<T>

pub fn unincluded_segment_size_after(included_hash: T::Hash) -> u32

Get the unincluded segment size after the given hash.

If the unincluded segment doesn’t contain the given hash, this returns the length of the entire unincluded segment.

This is intended to be used for determining how long the unincluded segment would be in runtime APIs related to authoring.

impl<T: Config> Pallet<T>

pub fn max_code_size() -> Option<u32>

The maximum code size permitted, in bytes.

Returns None if the relay chain parachain host configuration hasn’t been submitted yet.

pub fn schedule_code_upgrade(validation_function: Vec<u8>) -> DispatchResult

The implementation of the runtime upgrade functionality for parachains.

pub fn collect_collation_info(header: &HeaderFor<T>) -> CollationInfo

Returns the CollationInfo of the current active block.

The given header is the header of the built block we are collecting the collation info for.

This is expected to be used by the CollectCollationInfo runtime api.

pub fn set_custom_validation_head_data(head_data: Vec<u8>)

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

This will overwrite the head data that is returned as result of validate_block while validating a PoV on the relay chain. Normally the head data that is being returned by validate_block is the header of the block that is validated, thus it can be enacted as the new best block. However, for features like forking it can be useful to overwrite the head data with a custom header.

Attention

This should only be used when you are sure what you are doing as this can brick your Parachain.

impl<T: Config> Pallet<T>

pub fn send_upward_message( message: UpwardMessage ) -> Result<(u32, XcmHash), MessageSendError>

Trait Implementations

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> GetChannelInfo for Pallet<T>

fn get_channel_status(id: ParaId) -> ChannelStatus

fn get_channel_max(id: ParaId) -> Option<usize>

impl<T: Config> GetStorageVersion for Pallet<T>

type CurrentStorageVersion = StorageVersion

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(_: BlockNumberFor<T>)

Block finalization hook. This is called at the very end of block execution.

fn on_initialize(_n: BlockNumberFor<T>) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main wasm runtime.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> ProvideInherent for Pallet<T>

type Call = Call<T>

The call type of the pallet.

type Error = MakeFatalError<()>

The error returned by check_inherent.

const INHERENT_IDENTIFIER: InherentIdentifier = cumulus_primitives_parachain_inherent::INHERENT_IDENTIFIER

The inherent identifier used by this inherent.

fn create_inherent(data: &InherentData) -> Option<Self::Call>

Create an inherent out of the given InherentData.

fn is_inherent(call: &Self::Call) -> bool

Return whether the call is an inherent call.

fn is_inherent_required( _: &InherentData ) -> Result<Option<Self::Error>, Self::Error>

Determines whether this inherent is required in this block.

fn check_inherent(_: &Self::Call, _: &InherentData) -> Result<(), Self::Error>

Check whether the given inherent is valid. Checking the inherent is optional and can be omitted by using the default implementation.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> UpwardMessageSender for Pallet<T>

fn send_upward_message( message: UpwardMessage ) -> Result<(u32, XcmHash), MessageSendError>

Send the given UMP message; return the expected number of blocks before the message will be dispatched or an error if the message cannot be sent. return the hash of the message sent

impl<T: Config> ValidateUnsigned for Pallet<T>

type Call = Call<T>

The call to validate

fn validate_unsigned( _source: TransactionSource, call: &Self::Call ) -> TransactionValidity

Return the validity of the call

fn pre_dispatch(call: &Self::Call) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>