Type Alias Module

pub type Module<T> = Pallet<T>;

👎Deprecated: use Pallet instead

Type alias to Pallet, to be used by construct_runtime.

Generated by pallet attribute macro.

Aliased Type

struct Module<T>(/* private fields */);

Implementations

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 core_selector() -> (CoreSelector, ClaimQueueOffset)

Returns the core selector for the next block.

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.

pub fn open_outbound_hrmp_channel_for_benchmarks_or_tests( target_parachain: ParaId, )

Open HRMP channel for using it in benchmarks or tests.

The caller assumes that the pallet will accept regular outbound message to the sibling target_parachain after this call. No other assumptions are made.

pub fn open_custom_outbound_hrmp_channel_for_benchmarks_or_tests( target_parachain: ParaId, channel: AbridgedHrmpChannel, )

Open HRMP channel for using it in benchmarks or tests.

The caller assumes that the pallet will accept regular outbound message to the sibling target_parachain after this call. No other assumptions are made.

pub fn initialize_for_set_code_benchmark(max_code_size: u32)

Prepare/insert relevant data for schedule_code_upgrade for benchmarks.

impl<T: Config> Pallet<T>

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

Puts a message in the PendingUpwardMessages storage item. The message will be later sent in on_finalize. Checks host configuration to see if message is too big. Increases the delivery fee factor if the queue is sufficiently (see ump_constants::THRESHOLD_FACTOR) congested.

pub fn last_relay_block_number() -> RelayChainBlockNumber

Get the relay chain block number which was used as an anchor for the last block in this chain.

impl<T: Config> Pallet<T>

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

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

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.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T> Benchmarking for Pallet<T>

where T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32, ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

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> DispatchViewFunction for Pallet<T>

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

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

fn ensure(para_id: ParaId)

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

type Id = ()

Type used for assigning different fee factors to different destinations

fn get_fee_factor(_: Self::Id) -> FixedU128

Returns the evolving exponential fee factor which will be used to calculate the delivery fees.

fn increase_fee_factor(_: Self::Id, message_size_factor: FixedU128) -> FixedU128

Increases the delivery fee factor by a factor based on message size and records the result.

fn decrease_fee_factor(_: Self::Id) -> FixedU128

Decreases the delivery fee factor by a constant factor and records the result.

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

fn get_channel_status(id: ParaId) -> ChannelStatus

fn get_channel_info(id: ParaId) -> Option<ChannelInfo>

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

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

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

fn on_finalize(_: BlockNumberFor<T>)

Handles actually sending upward messages by moving them from PendingUpwardMessages to UpwardMessages. Decreases the delivery fee factor if after sending messages, the queue total size is less than the threshold (see ump_constants::THRESHOLD_FACTOR). Also does the sending for HRMP messages it takes from OutboundXcmpMessageSource.

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_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

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

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

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 blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn clear_messages()

Clear the queues at the beginning of Runtime API call, so that subsequent Self::get_messages() will return only messages generated by said Runtime API.

fn get_messages() -> Vec<(VersionedLocation, Vec<VersionedXcm<()>>)>

Get queued messages and their destinations.

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

fn integrity_test()

See [Hooks::integrity_test].

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

fn outgoing_channels() -> Vec<ParaId>

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> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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 name_hash() -> [u8; 16]

Two128 hash of name.

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 for Pallet<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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>

const INHERENT_IDENTIFIER: InherentIdentifier = cumulus_primitives_parachain_inherent::INHERENT_IDENTIFIER

The inherent identifier used by this inherent.

type Call = Call<T>

The call type of the pallet.

type Error = MakeFatalError<()>

The error returned by check_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> TryDecodeEntireStorage for Pallet<T>

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

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

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

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> ViewFunctionIdPrefix for Pallet<T>

fn prefix() -> [u8; 16]

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>