Type Alias Registrar

pub type Registrar = Pallet<Runtime>;

Aliased Type

struct Registrar(/* private fields */);

Implementations

impl<T> Pallet<T>

where T: Config,

pub fn register( origin: <T as Config>::RuntimeOrigin, id: Id, genesis_head: HeadData, validation_code: ValidationCode, ) -> Result<(), DispatchError>

Register head data and validation code for a reserved Para Id.

Arguments

• origin: Must be called by a Signed origin.
• id: The para ID. Must be owned/managed by the origin signing account.
• genesis_head: The genesis head data of the parachain/thread.
• validation_code: The initial validation code of the parachain/thread.

Deposits/Fees

The account with the originating signature must reserve a deposit.

The deposit is required to cover the costs associated with storing the genesis head data and the validation code. This accounts for the potential to store validation code of a size up to the max_code_size, as defined in the configuration pallet

Anything already reserved previously for this para ID is accounted for.

Events

The Registered event is emitted in case of success.

pub fn force_register( origin: <T as Config>::RuntimeOrigin, who: <T as Config>::AccountId, deposit: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, id: Id, genesis_head: HeadData, validation_code: ValidationCode, ) -> Result<(), DispatchError>

Force the registration of a Para Id on the relay chain.

This function must be called by a Root origin.

The deposit taken can be specified for this registration. Any ParaId can be registered, including sub-1000 IDs which are System Parachains.

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

Deregister a Para Id, freeing all data and returning any deposit.

The caller must be Root, the para owner, or the para itself. The para must be an on-demand parachain.

pub fn swap( origin: <T as Config>::RuntimeOrigin, id: Id, other: Id, ) -> Result<(), DispatchError>

Swap a lease holding parachain with another parachain, either on-demand or lease holding.

The origin must be Root, the para owner, or the para itself.

The swap will happen only if there is already an opposite swap pending. If there is not, the swap will be stored in the pending swaps map, ready for a later confirmatory swap.

The ParaIds remain mapped to the same head data and code so external code can rely on ParaId to be a long-term identifier of a notional “parachain”. However, their scheduling info (i.e. whether they’re an on-demand parachain or lease holding parachain), auction information and the auction deposit are switched.

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

Remove a manager lock from a para. This will allow the manager of a previously locked para to deregister or swap a para without using governance.

Can only be called by the Root origin or the parachain.

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

Reserve a Para Id on the relay chain.

This function will reserve a new Para Id to be owned/managed by the origin account. The origin account is able to register head data and validation code using register to create an on-demand parachain. Using the Slots pallet, an on-demand parachain can then be upgraded to a lease holding parachain.

Arguments

• origin: Must be called by a Signed origin. Becomes the manager/owner of the new para ID.

Deposits/Fees

The origin must reserve a deposit of ParaDeposit for the registration.

Events

The Reserved event is emitted in case of success, which provides the ID reserved for use.

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

Add a manager lock from a para. This will prevent the manager of a para to deregister or swap a para.

Can be called by Root, the parachain, or the parachain manager if the parachain is unlocked.

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

Schedule a parachain upgrade.

This will kick off a check of new_code by all validators. After the majority of the validators have reported on the validity of the code, the code will either be enacted or the upgrade will be rejected. If the code will be enacted, the current code of the parachain will be overwritten directly. This means that any PoV will be checked by this new code. The parachain itself will not be informed explicitly that the validation code has changed.

Can be called by Root, the parachain, or the parachain manager if the parachain is unlocked.

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

Set the parachain’s current head.

Can be called by Root, the parachain, or the parachain manager if the parachain is unlocked.

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, Origin: Into<<T as Config>::RuntimeOrigin>,

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

where T: Config,

fn on_new_head(id: Id, _head: &HeadData) -> Weight

Called when a parachain head is updated. Returns the weight consumed by this function.

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

where T: Config,

fn manager_of(id: Id) -> Option<<T as Config>::AccountId>

Return the manager AccountId of a para if one exists.

type AccountId = <T as Config>::AccountId

The account ID type that encodes a parachain manager ID.

fn parachains() -> Vec<Id>

All lease holding parachains. Ordered ascending by ParaId. On-demand parachains are not included.

fn is_parathread(id: Id) -> bool

Return if a ParaId is a Parathread (on-demand parachain).

fn is_parachain(id: Id) -> bool

Return if a ParaId is a lease holding Parachain.

fn apply_lock(id: Id)

Apply a lock to the para registration so that it cannot be modified by the manager directly. Instead the para must use its sovereign governance or the governance of the relay chain.

fn remove_lock(id: Id)

Remove any lock on the para registration.

fn register( manager: <T as Config>::AccountId, id: Id, genesis_head: HeadData, validation_code: ValidationCode, ) -> Result<(), DispatchError>

Register a Para ID under control of who. Registration may be delayed by session rotation.

fn deregister(id: Id) -> Result<(), DispatchError>

Deregister a Para ID, free any data, and return any deposits.

fn make_parachain(id: Id) -> Result<(), DispatchError>

Elevate a para to parachain status.

fn make_parathread(id: Id) -> Result<(), DispatchError>

Downgrade lease holding parachain into parathread (on-demand parachain)

fn worst_head_data() -> HeadData

fn worst_validation_code() -> ValidationCode

fn execute_pending_transitions()

Execute any pending state transitions for paras. For example onboarding to on-demand parachain, or upgrading on-demand to lease holding parachain.

fn is_registered(id: Id) -> bool

Return if a ParaId is registered in the system.

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>