Struct polkadot_runtime_common::slots::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn force_lease(
    origin: OriginFor<T>,
    para: ParaId,
    leaser: T::AccountId,
    amount: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    period_begin: <T as Config>::BlockNumber,
    period_count: <T as Config>::BlockNumber
) -> DispatchResult

Just a connect into the lease_out call, in case Root wants to force some lease to happen independently of any other on-chain mechanism to use it.

The dispatch origin for this call must match T::ForceOrigin.

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

Clear all leases for a Para Id, refunding any deposits back to the original owners.

The dispatch origin for this call must match T::ForceOrigin.

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

Try to onboard a parachain that has a lease for the current lease period.

This function can be useful if there was some state issue with a para that should have onboarded, but was unable to. As long as they have a lease period, we can let them onboard from here.

Origin must be signed, but can be called by anyone.

impl<T: Config> Pallet<T>

pub fn lease<KArg>(
    k: KArg
) -> Vec<Option<(T::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance)>> where
    KArg: EncodeLike<ParaId>,

Amounts held on deposit for each (possibly future) leased parachain.

The actual amount locked on its behalf by any account at any time is the maximum of the second values of the items in this list whose first value is the account.

The first item in the list is the amount locked for the current Lease Period. Following items are for the subsequent lease periods.

The default value (an empty list) implies that the parachain no longer exists (or never existed) as far as this pallet is concerned.

If a parachain doesn’t exist yet but is scheduled to exist in the future, then it will be left-padded with one or more Nones to denote the fact that nothing is held on deposit for the non-existent chain currently, but is held at some point in the future.

It is illegal for a None value to trail in the list.

Trait Implementations

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: 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_initialize(n: T::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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_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> Leaser<<T as Config>::BlockNumber> for Pallet<T>

type AccountId = <T as Config>::AccountId

An account identifier for a leaser.

type LeasePeriod = <T as Config>::BlockNumber

The measurement type for counting lease periods (generally just a BlockNumber).

type Currency = <T as Config>::Currency

The currency type in which the lease is taken.

fn lease_out(
    para: ParaId,
    leaser: &Self::AccountId,
    amount: <Self::Currency as Currency<Self::AccountId>>::Balance,
    period_begin: Self::LeasePeriod,
    period_count: Self::LeasePeriod
) -> Result<(), LeaseError>

Lease a new parachain slot for para.

fn deposit_held(
    para: ParaId,
    leaser: &Self::AccountId
) -> <Self::Currency as Currency<Self::AccountId>>::Balance

Return the amount of balance currently held in reserve on leaser’s account for leasing para. This won’t go down outside a lease period.

fn lease_period_length() -> (T::BlockNumber, T::BlockNumber)

The length of a lease period, and any offset which may be introduced. This is only used in benchmarking to automate certain calls.

fn lease_period_index(b: T::BlockNumber) -> Option<(Self::LeasePeriod, bool)>

Returns the lease period at block, and if this is the first block of a new lease period.

fn already_leased(
    para_id: ParaId,
    first_period: Self::LeasePeriod,
    last_period: Self::LeasePeriod
) -> bool

Returns true if the parachain already has a lease in any of lease periods in the inclusive range [first_period, last_period], intersected with the unbounded range [current_lease_period..] .

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

fn on_swap(one: ParaId, other: ParaId)

Updates any needed state/references to enact a logical swap of two parachains. Identity, code and head_data remain equivalent for all parachains/threads, however other properties such as leases, deposits held and thread/chain nature are swapped.

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

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>