Struct polkadot_runtime_common::paras_registrar::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn register(
    origin: OriginFor<T>,
    id: ParaId,
    genesis_head: HeadData,
    validation_code: ValidationCode
) -> DispatchResult

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 origin signed account must reserve a corresponding deposit for the registration. 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: OriginFor<T>,
    who: T::AccountId,
    deposit: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    id: ParaId,
    genesis_head: HeadData,
    validation_code: ValidationCode
) -> DispatchResult

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: OriginFor<T>, id: ParaId) -> DispatchResult

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

pub fn swap(origin: OriginFor<T>, id: ParaId, other: ParaId) -> DispatchResult

Swap a parachain with another parachain or parathread.

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 a parathread or parachain), auction information and the auction deposit are switched.

pub fn force_remove_lock(origin: OriginFor<T>, para: ParaId) -> DispatchResult

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.

pub fn reserve(origin: OriginFor<T>) -> DispatchResult

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 a parathread. Using the Slots pallet, a parathread can then be upgraded to get a parachain slot.

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.

Trait Implementations

impl<T> Benchmarking for Pallet<T>where
    T: Config + Config,
    ParaOrigin: Into<<T as Config>::Origin>,

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

fn integrity_test()

Run integrity test.

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

fn manager_of(id: ParaId) -> Option<T::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<ParaId>

All parachains. Ordered ascending by ParaId. Parathreads are not included.

fn is_parathread(id: ParaId) -> bool

Return if a ParaId is a Parathread.

fn is_parachain(id: ParaId) -> bool

Return if a ParaId is a Parachain.

fn apply_lock(id: ParaId)

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: ParaId)

Remove any lock on the para registration.

fn register(
    manager: T::AccountId,
    id: ParaId,
    genesis_head: HeadData,
    validation_code: ValidationCode
) -> DispatchResult

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

fn deregister(id: ParaId) -> DispatchResult

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

fn make_parachain(id: ParaId) -> DispatchResult

Elevate a para to parachain status.

fn make_parathread(id: ParaId) -> DispatchResult

Lower a para back to normal from parachain status.

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 parathread, or parathread to parachain.

fn is_registered(id: ParaId) -> bool

Return if a ParaId is registered in the system.

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

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>