Type Alias Paras

pub type Paras = Pallet<Runtime>;

Aliased Type

struct Paras(/* private fields */);

Implementations

impl<T> Pallet<T>

where T: Config,

pub fn remove_upgrade_cooldown_cost( para: Id, ) -> <<T as Config>::Fungible as Inspect<<T as Config>::AccountId>>::Balance

Returns the cost for removing an upgrade cooldown for the given para.

impl<T> Pallet<T>

where T: Config,

pub fn sorted_para_heads() -> Vec<(u32, Vec<u8>)>

Get a list of the first MAX_PARA_HEADS para heads sorted by para_id. This method is likely to be removed in the future.

pub fn can_schedule_para_initialize(id: &Id) -> bool

Verify that schedule_para_initialize can be called successfully.

Returns false if para is already registered in the system.

pub fn lifecycle(id: Id) -> Option<ParaLifecycle>

Returns the current lifecycle state of the para.

pub fn is_valid_para(id: Id) -> bool

Returns whether the given ID refers to a valid para.

Paras that are onboarding or offboarding are not included.

pub fn is_offboarding(id: Id) -> bool

Returns whether the given ID refers to a para that is offboarding.

An invalid or non-offboarding para ID will return false.

pub fn is_parachain(id: Id) -> bool

Whether a para ID corresponds to any live lease holding parachain.

Includes lease holding parachains which will downgrade to a on-demand parachains in the future.

pub fn is_parathread(id: Id) -> bool

Whether a para ID corresponds to any live parathread (on-demand parachain).

Includes on-demand parachains which will upgrade to lease holding parachains in the future.

pub fn test_on_new_session()

Test function for triggering a new session in this pallet.

pub fn heads_insert(para_id: &Id, head_data: HeadData)

impl<T> Pallet<T>

where T: Config,

pub fn force_set_current_code( origin: <T as Config>::RuntimeOrigin, para: Id, new_code: ValidationCode, ) -> Result<(), DispatchError>

Set the storage for the parachain validation code immediately.

pub fn force_set_current_head( origin: <T as Config>::RuntimeOrigin, para: Id, new_head: HeadData, ) -> Result<(), DispatchError>

Set the storage for the current parachain head data immediately.

pub fn force_schedule_code_upgrade( origin: <T as Config>::RuntimeOrigin, para: Id, new_code: ValidationCode, relay_parent_number: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Schedule an upgrade as if it was scheduled in the given relay parent block.

pub fn force_note_new_head( origin: <T as Config>::RuntimeOrigin, para: Id, new_head: HeadData, ) -> Result<(), DispatchError>

Note a new block head for para within the context of the current block.

pub fn force_queue_action( origin: <T as Config>::RuntimeOrigin, para: Id, ) -> Result<(), DispatchError>

Put a parachain directly into the next session’s action queue. We can’t queue it any sooner than this without going into the initializer…

pub fn add_trusted_validation_code( origin: <T as Config>::RuntimeOrigin, validation_code: ValidationCode, ) -> Result<(), DispatchError>

Adds the validation code to the storage.

The code will not be added if it is already present. Additionally, if PVF pre-checking is running for that code, it will be instantly accepted.

Otherwise, the code will be added into the storage. Note that the code will be added into storage with reference count 0. This is to account the fact that there are no users for this code yet. The caller will have to make sure that this code eventually gets used by some parachain or removed from the storage to avoid storage leaks. For the latter prefer to use the poke_unused_validation_code dispatchable to raw storage manipulation.

This function is mainly meant to be used for upgrading parachains that do not follow the go-ahead signal while the PVF pre-checking feature is enabled.

pub fn poke_unused_validation_code( origin: <T as Config>::RuntimeOrigin, validation_code_hash: ValidationCodeHash, ) -> Result<(), DispatchError>

Remove the validation code from the storage iff the reference count is 0.

This is better than removing the storage directly, because it will not remove the code that was suddenly got used by some parachain while this dispatchable was pending dispatching.

pub fn include_pvf_check_statement( origin: <T as Config>::RuntimeOrigin, stmt: PvfCheckStatement, signature: Signature, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Includes a statement for a PVF pre-checking vote. Potentially, finalizes the vote and enacts the results if that was the last vote before achieving the supermajority.

pub fn force_set_most_recent_context( origin: <T as Config>::RuntimeOrigin, para: Id, context: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Set the storage for the current parachain head data immediately.

pub fn remove_upgrade_cooldown( origin: <T as Config>::RuntimeOrigin, para: Id, ) -> Result<(), DispatchError>

Remove an upgrade cooldown for a parachain.

The cost for removing the cooldown earlier depends on the time left for the cooldown multiplied by Config::CooldownRemovalMultiplier. The paid tokens are burned.

pub fn authorize_force_set_current_code_hash( origin: <T as Config>::RuntimeOrigin, para: Id, new_code_hash: ValidationCodeHash, valid_period: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Sets the storage for the authorized current code hash of the parachain. If not applied, it will be removed at the System::block_number() + valid_period block.

This can be useful, when triggering Paras::force_set_current_code(para, code) from a different chain than the one where the Paras pallet is deployed.

The main purpose is to avoid transferring the entire code Wasm blob between chains. Instead, we authorize code_hash with root, which can later be applied by Paras::apply_authorized_force_set_current_code(para, code) by anyone.

Authorizations are stored in an overwriting manner.

pub fn apply_authorized_force_set_current_code( _origin: <T as Config>::RuntimeOrigin, para: Id, new_code: ValidationCode, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Applies the already authorized current code for the parachain, triggering the same functionality as force_set_current_code.

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 = NoStorageVersionSet

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

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

where T: Config,

type Call = Call<T>

The call to validate

fn validate_unsigned( _source: TransactionSource, call: &<Pallet<T> as ValidateUnsigned>::Call, ) -> Result<ValidTransaction, TransactionValidityError>

Return the validity of the call

fn pre_dispatch( _call: &<Pallet<T> as ValidateUnsigned>::Call, ) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

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>