Struct polkadot_runtime_parachains::configuration::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn set_validation_upgrade_cooldown(
    origin: OriginFor<T>,
    new: T::BlockNumber
) -> DispatchResult

Set the validation upgrade cooldown.

pub fn set_validation_upgrade_delay(
    origin: OriginFor<T>,
    new: T::BlockNumber
) -> DispatchResult

Set the validation upgrade delay.

pub fn set_code_retention_period(
    origin: OriginFor<T>,
    new: T::BlockNumber
) -> DispatchResult

Set the acceptance period for an included candidate.

pub fn set_max_code_size(origin: OriginFor<T>, new: u32) -> DispatchResult

Set the max validation code size for incoming upgrades.

pub fn set_max_pov_size(origin: OriginFor<T>, new: u32) -> DispatchResult

Set the max POV block size for incoming upgrades.

pub fn set_max_head_data_size(origin: OriginFor<T>, new: u32) -> DispatchResult

Set the max head data size for paras.

pub fn set_parathread_cores(origin: OriginFor<T>, new: u32) -> DispatchResult

Set the number of parathread execution cores.

pub fn set_parathread_retries(origin: OriginFor<T>, new: u32) -> DispatchResult

Set the number of retries for a particular parathread.

pub fn set_group_rotation_frequency(
    origin: OriginFor<T>,
    new: T::BlockNumber
) -> DispatchResult

Set the parachain validator-group rotation frequency

pub fn set_chain_availability_period(
    origin: OriginFor<T>,
    new: T::BlockNumber
) -> DispatchResult

Set the availability period for parachains.

pub fn set_thread_availability_period(
    origin: OriginFor<T>,
    new: T::BlockNumber
) -> DispatchResult

Set the availability period for parathreads.

pub fn set_scheduling_lookahead(origin: OriginFor<T>, new: u32) -> DispatchResult

Set the scheduling lookahead, in expected number of blocks at peak throughput.

pub fn set_max_validators_per_core(
    origin: OriginFor<T>,
    new: Option<u32>
) -> DispatchResult

Set the maximum number of validators to assign to any core.

pub fn set_max_validators(
    origin: OriginFor<T>,
    new: Option<u32>
) -> DispatchResult

Set the maximum number of validators to use in parachain consensus.

pub fn set_dispute_period(
    origin: OriginFor<T>,
    new: SessionIndex
) -> DispatchResult

Set the dispute period, in number of sessions to keep for disputes.

pub fn set_dispute_post_conclusion_acceptance_period(
    origin: OriginFor<T>,
    new: T::BlockNumber
) -> DispatchResult

Set the dispute post conclusion acceptance period.

pub fn set_dispute_max_spam_slots(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Set the maximum number of dispute spam slots.

pub fn set_dispute_conclusion_by_time_out_period(
    origin: OriginFor<T>,
    new: T::BlockNumber
) -> DispatchResult

Set the dispute conclusion by time out period.

pub fn set_no_show_slots(origin: OriginFor<T>, new: u32) -> DispatchResult

Set the no show slots, in number of number of consensus slots. Must be at least 1.

pub fn set_n_delay_tranches(origin: OriginFor<T>, new: u32) -> DispatchResult

Set the total number of delay tranches.

pub fn set_zeroth_delay_tranche_width(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Set the zeroth delay tranche width.

pub fn set_needed_approvals(origin: OriginFor<T>, new: u32) -> DispatchResult

Set the number of validators needed to approve a block.

pub fn set_relay_vrf_modulo_samples(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Set the number of samples to do of the RelayVRFModulo approval assignment criterion.

pub fn set_max_upward_queue_count(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum items that can present in a upward dispatch queue at once.

pub fn set_max_upward_queue_size(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum total size of items that can present in a upward dispatch queue at once.

pub fn set_max_downward_message_size(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Set the critical downward message size.

pub fn set_ump_service_total_weight(
    origin: OriginFor<T>,
    new: Weight
) -> DispatchResult

Sets the soft limit for the phase of dispatching dispatchable upward messages.

pub fn set_max_upward_message_size(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum size of an upward message that can be sent by a candidate.

pub fn set_max_upward_message_num_per_candidate(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum number of messages that a candidate can contain.

pub fn set_hrmp_open_request_ttl(
    _origin: OriginFor<T>,
    _new: u32
) -> DispatchResult

Sets the number of sessions after which an HRMP open channel request expires.

pub fn set_hrmp_sender_deposit(
    origin: OriginFor<T>,
    new: Balance
) -> DispatchResult

Sets the amount of funds that the sender should provide for opening an HRMP channel.

pub fn set_hrmp_recipient_deposit(
    origin: OriginFor<T>,
    new: Balance
) -> DispatchResult

Sets the amount of funds that the recipient should provide for accepting opening an HRMP channel.

pub fn set_hrmp_channel_max_capacity(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum number of messages allowed in an HRMP channel at once.

pub fn set_hrmp_channel_max_total_size(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum total size of messages in bytes allowed in an HRMP channel at once.

pub fn set_hrmp_max_parachain_inbound_channels(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum number of inbound HRMP channels a parachain is allowed to accept.

pub fn set_hrmp_max_parathread_inbound_channels(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum number of inbound HRMP channels a parathread is allowed to accept.

pub fn set_hrmp_channel_max_message_size(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum size of a message that could ever be put into an HRMP channel.

pub fn set_hrmp_max_parachain_outbound_channels(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum number of outbound HRMP channels a parachain is allowed to open.

pub fn set_hrmp_max_parathread_outbound_channels(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum number of outbound HRMP channels a parathread is allowed to open.

pub fn set_hrmp_max_message_num_per_candidate(
    origin: OriginFor<T>,
    new: u32
) -> DispatchResult

Sets the maximum number of outbound HRMP messages can be sent by a candidate.

pub fn set_ump_max_individual_weight(
    origin: OriginFor<T>,
    new: Weight
) -> DispatchResult

Sets the maximum amount of weight any individual upward message may consume.

pub fn set_pvf_checking_enabled(
    origin: OriginFor<T>,
    new: bool
) -> DispatchResult

Enable or disable PVF pre-checking. Consult the field documentation prior executing.

pub fn set_pvf_voting_ttl(
    origin: OriginFor<T>,
    new: SessionIndex
) -> DispatchResult

Set the number of session changes after which a PVF pre-checking voting is rejected.

pub fn set_minimum_validation_upgrade_delay(
    origin: OriginFor<T>,
    new: T::BlockNumber
) -> DispatchResult

Sets the minimum delay between announcing the upgrade block for a parachain until the upgrade taking place.

See the field documentation for information and constraints for the new value.

pub fn set_bypass_consistency_check(
    origin: OriginFor<T>,
    new: bool
) -> DispatchResult

Setting this to true will disable consistency checks for the configuration setters. Use with caution.

impl<T: Config> Pallet<T>

pub fn config() -> HostConfiguration<T::BlockNumber>

The active configuration for the current session.

impl<T: Config> Pallet<T>

pub fn force_set_active_config(config: HostConfiguration<T::BlockNumber>)

Forcibly set the active config. This should be used with extreme care, and typically only when enabling parachains runtime pallets for the first time on a chain which has been running without them.

Trait Implementations

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 Call = 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> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

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

fn integrity_test()

Run integrity test.

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

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

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

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

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a 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> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>