Enum polkadot_runtime_common::paras_registrar::pallet::Call

pub enum Call<T: Config> {
    register {
        id: Id,
        genesis_head: HeadData,
        validation_code: ValidationCode,
    },
    force_register {
        who: T::AccountId,
        deposit: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
        id: Id,
        genesis_head: HeadData,
        validation_code: ValidationCode,
    },
    deregister {
        id: Id,
    },
    swap {
        id: Id,
        other: Id,
    },
    remove_lock {
        para: Id,
    },
    reserve {},
    add_lock {
        para: Id,
    },
    schedule_code_upgrade {
        para: Id,
        new_code: ValidationCode,
    },
    set_current_head {
        para: Id,
        new_head: HeadData,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

register

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.

Fields

id: Id

genesis_head: HeadData

validation_code: ValidationCode

force_register

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.

Fields

who: T::AccountId

deposit: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

id: Id

genesis_head: HeadData

validation_code: ValidationCode

deregister

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.

Fields

id: Id

swap

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.

Fields

id: Id

other: Id

remove_lock

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.

Fields

para: Id

reserve

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.

add_lock

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.

Fields

para: Id

schedule_code_upgrade

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.

Fields

para: Id

new_code: ValidationCode

set_current_head

Set the parachain’s current head.

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

Fields

para: Id

new_head: HeadData

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_register( id: ParaId, genesis_head: HeadData, validation_code: ValidationCode, ) -> Self

Create a call with the variant register.

pub fn new_call_variant_force_register( who: T::AccountId, deposit: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, id: ParaId, genesis_head: HeadData, validation_code: ValidationCode, ) -> Self

Create a call with the variant force_register.

pub fn new_call_variant_deregister(id: ParaId) -> Self

Create a call with the variant deregister.

pub fn new_call_variant_swap(id: ParaId, other: ParaId) -> Self

Create a call with the variant swap.

pub fn new_call_variant_remove_lock(para: ParaId) -> Self

Create a call with the variant remove_lock.

pub fn new_call_variant_reserve() -> Self

Create a call with the variant reserve.

pub fn new_call_variant_add_lock(para: ParaId) -> Self

Create a call with the variant add_lock.

pub fn new_call_variant_schedule_code_upgrade( para: ParaId, new_code: ValidationCode, ) -> Self

Create a call with the variant schedule_code_upgrade.

pub fn new_call_variant_set_current_head( para: ParaId, new_head: HeadData, ) -> Self

Create a call with the variant set_current_head.

Trait Implementations

impl<T: Config> CheckIfFeeless for Call<T>

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

impl<T: Config> Clone for Call<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: Config> Debug for Call<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallIndex for Call<T>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names in the same order as [GetCallIndex].

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq for Call<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> TypeInfo for Call<T>

where PhantomData<(T,)>: TypeInfo + 'static, T::AccountId: TypeInfo + 'static, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

fn dispatch_bypass_filter( self, origin: Self::RuntimeOrigin, ) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike for Call<T>

impl<T: Config> Eq for Call<T>