Type Alias Configuration

pub type Configuration = Pallet<Runtime>;

Aliased Type

struct Configuration(/* private fields */);

Implementations

impl<T> Pallet<T>

where T: Config,

pub fn set_coretime_cores_unchecked(new: u32) -> Result<(), DispatchError>

Set coretime cores.

To be used if authorization is checked otherwise.

impl<T> Pallet<T>

where T: Config,

pub fn force_set_active_config( config: HostConfiguration<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>, )

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.

impl<T> Pallet<T>

where T: Config,

pub fn set_validation_upgrade_cooldown( origin: <T as Config>::RuntimeOrigin, new: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Set the validation upgrade cooldown.

pub fn set_validation_upgrade_delay( origin: <T as Config>::RuntimeOrigin, new: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Set the validation upgrade delay.

pub fn set_code_retention_period( origin: <T as Config>::RuntimeOrigin, new: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Set the acceptance period for an included candidate.

pub fn set_max_code_size( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the max validation code size for incoming upgrades.

pub fn set_max_pov_size( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the max POV block size for incoming upgrades.

pub fn set_max_head_data_size( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the max head data size for paras.

pub fn set_coretime_cores( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the number of coretime execution cores.

NOTE: that this configuration is managed by the coretime chain. Only manually change this, if you really know what you are doing!

pub fn set_group_rotation_frequency( origin: <T as Config>::RuntimeOrigin, new: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Set the parachain validator-group rotation frequency

pub fn set_paras_availability_period( origin: <T as Config>::RuntimeOrigin, new: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Set the availability period for paras.

pub fn set_scheduling_lookahead( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_max_validators_per_core( origin: <T as Config>::RuntimeOrigin, new: Option<u32>, ) -> Result<(), DispatchError>

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

pub fn set_max_validators( origin: <T as Config>::RuntimeOrigin, new: Option<u32>, ) -> Result<(), DispatchError>

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

pub fn set_dispute_period( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_dispute_post_conclusion_acceptance_period( origin: <T as Config>::RuntimeOrigin, new: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Set the dispute post conclusion acceptance period.

pub fn set_no_show_slots( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_n_delay_tranches( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the total number of delay tranches.

pub fn set_zeroth_delay_tranche_width( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the zeroth delay tranche width.

pub fn set_needed_approvals( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the number of validators needed to approve a block.

pub fn set_relay_vrf_modulo_samples( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_max_upward_queue_count( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_max_upward_queue_size( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the critical downward message size.

pub fn set_max_upward_message_size( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_hrmp_open_request_ttl( _origin: <T as Config>::RuntimeOrigin, _new: u32, ) -> Result<(), DispatchError>

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

pub fn set_hrmp_sender_deposit( origin: <T as Config>::RuntimeOrigin, new: u128, ) -> Result<(), DispatchError>

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

pub fn set_hrmp_recipient_deposit( origin: <T as Config>::RuntimeOrigin, new: u128, ) -> Result<(), DispatchError>

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

pub fn set_hrmp_channel_max_capacity( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_hrmp_channel_max_total_size( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_hrmp_channel_max_message_size( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_hrmp_max_message_num_per_candidate( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_pvf_voting_ttl( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

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

pub fn set_minimum_validation_upgrade_delay( origin: <T as Config>::RuntimeOrigin, new: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

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: <T as Config>::RuntimeOrigin, new: bool, ) -> Result<(), DispatchError>

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

pub fn set_async_backing_params( origin: <T as Config>::RuntimeOrigin, new: AsyncBackingParams, ) -> Result<(), DispatchError>

Set the asynchronous backing parameters.

pub fn set_executor_params( origin: <T as Config>::RuntimeOrigin, new: ExecutorParams, ) -> Result<(), DispatchError>

Set PVF executor parameters.

pub fn set_on_demand_base_fee( origin: <T as Config>::RuntimeOrigin, new: u128, ) -> Result<(), DispatchError>

Set the on demand (parathreads) base fee.

pub fn set_on_demand_fee_variability( origin: <T as Config>::RuntimeOrigin, new: Perbill, ) -> Result<(), DispatchError>

Set the on demand (parathreads) fee variability.

pub fn set_on_demand_queue_max_size( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the on demand (parathreads) queue max size.

pub fn set_on_demand_target_queue_utilization( origin: <T as Config>::RuntimeOrigin, new: Perbill, ) -> Result<(), DispatchError>

Set the on demand (parathreads) fee variability.

pub fn set_minimum_backing_votes( origin: <T as Config>::RuntimeOrigin, new: u32, ) -> Result<(), DispatchError>

Set the minimum backing votes threshold.

pub fn set_node_feature( origin: <T as Config>::RuntimeOrigin, index: u8, value: bool, ) -> Result<(), DispatchError>

Set/Unset a node feature.

pub fn set_approval_voting_params( origin: <T as Config>::RuntimeOrigin, new: ApprovalVotingParams, ) -> Result<(), DispatchError>

Set approval-voting-params.

pub fn set_scheduler_params( origin: <T as Config>::RuntimeOrigin, new: SchedulerParams<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>, ) -> Result<(), DispatchError>

Set scheduler-params.

Trait Implementations

impl<T> BeforeAllRuntimeMigrations for Pallet<T>

where T: Config,

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

where T: Config,

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Pallet<T>

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<(), Error>

Formats the value using the given formatter.

impl<T> DispatchViewFunction for Pallet<T>

where T: Config,

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

where O: Output,

impl<T> GetStorageVersion for Pallet<T>

where T: Config,

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> <Pallet<T> as GetStorageVersion>::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> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn integrity_test()

Check the integrity of this pallet’s configuration.

fn on_initialize(_n: BlockNumber) -> Weight

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

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end 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.

impl<T> IntegrityTest for Pallet<T>

where T: Config,

fn integrity_test()

See Hooks::integrity_test.

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

where T: Config,

fn offchain_worker( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

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

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

where T: Config,

fn on_finalize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

See Hooks::on_finalize.

impl<T> OnGenesis for Pallet<T>

where T: Config,

fn on_genesis()

Something that should happen at genesis.

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

where T: Config,

fn on_idle( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, remaining_weight: Weight, ) -> Weight

See Hooks::on_idle.

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

where T: Config,

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Weight

See Hooks::on_initialize.

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

where T: Config,

fn on_poll( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, weight: &mut WeightMeter, )

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

impl<T> OnRuntimeUpgrade for Pallet<T>

where T: Config,

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

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

See Hooks::pre_upgrade.

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

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

where T: Config,

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

where T: Config,

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: &Pallet<T>) -> 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> StorageInfoTrait for Pallet<T>

where T: Config,

fn storage_info() -> Vec<StorageInfo>

impl<T> TryDecodeEntireStorage for Pallet<T>

where T: Config,

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

where T: Config,

fn try_state( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, _s: Select, ) -> Result<(), DispatchError>

Execute the state checks.

impl<T> ViewFunctionIdPrefix for Pallet<T>

where T: Config,

fn prefix() -> [u8; 16]

impl<T> WhitelistedStorageKeys for Pallet<T>

where T: Config,

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>