Struct pallet_collator_selection::pallet::Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

pub fn set_invulnerables( origin: OriginFor<T>, new: Vec<T::AccountId> ) -> DispatchResult

Set the list of invulnerable (fixed) collators. These collators must do some preparation, namely to have registered session keys.

The call will remove any accounts that have not registered keys from the set. That is, it is non-atomic; the caller accepts all AccountIds passed in new individually as acceptable Invulnerables, and is not proposing a set of new Invulnerables.

This call does not maintain mutual exclusivity of Invulnerables and Candidates. It is recommended to use a batch of add_invulnerable and remove_invulnerable instead. A batch_all can also be used to enforce atomicity. If any candidates are included in new, they should be removed with remove_invulnerable_candidate after execution.

Must be called by the UpdateOrigin.

pub fn set_desired_candidates( origin: OriginFor<T>, max: u32 ) -> DispatchResultWithPostInfo

Set the ideal number of non-invulnerable collators. If lowering this number, then the number of running collators could be higher than this figure. Aside from that edge case, there should be no other way to have more candidates than the desired number.

The origin for this call must be the UpdateOrigin.

pub fn set_candidacy_bond( origin: OriginFor<T>, bond: <<T as Config>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance ) -> DispatchResultWithPostInfo

Set the candidacy bond amount.

If the candidacy bond is increased by this call, all current candidates which have a deposit lower than the new bond will be kicked from the list and get their deposits back.

The origin for this call must be the UpdateOrigin.

pub fn register_as_candidate(origin: OriginFor<T>) -> DispatchResultWithPostInfo

Register this account as a collator candidate. The account must (a) already have registered session keys and (b) be able to reserve the CandidacyBond.

This call is not available to Invulnerable collators.

pub fn leave_intent(origin: OriginFor<T>) -> DispatchResultWithPostInfo

Deregister origin as a collator candidate. Note that the collator can only leave on session change. The CandidacyBond will be unreserved immediately.

This call will fail if the total number of candidates would drop below MinEligibleCollators.

pub fn add_invulnerable( origin: OriginFor<T>, who: T::AccountId ) -> DispatchResultWithPostInfo

Add a new account who to the list of Invulnerables collators. who must have registered session keys. If who is a candidate, they will be removed.

The origin for this call must be the UpdateOrigin.

pub fn remove_invulnerable( origin: OriginFor<T>, who: T::AccountId ) -> DispatchResult

Remove an account who from the list of Invulnerables collators. Invulnerables must be sorted.

The origin for this call must be the UpdateOrigin.

pub fn update_bond( origin: OriginFor<T>, new_deposit: <<T as Config>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance ) -> DispatchResultWithPostInfo

Update the candidacy bond of collator candidate origin to a new amount new_deposit.

Setting a new_deposit that is lower than the current deposit while origin is occupying a top-DesiredCandidates slot is not allowed.

This call will fail if origin is not a collator candidate, the updated bond is lower than the minimum candidacy bond, and/or the amount cannot be reserved.

pub fn take_candidate_slot( origin: OriginFor<T>, deposit: <<T as Config>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance, target: T::AccountId ) -> DispatchResultWithPostInfo

The caller origin replaces a candidate target in the collator candidate list by reserving deposit. The amount deposit reserved by the caller must be greater than the existing bond of the target it is trying to replace.

This call will fail if the caller is already a collator candidate or invulnerable, the caller does not have registered session keys, the target is not a collator candidate, and/or the deposit amount cannot be reserved.

impl<T: Config> Pallet<T>

pub fn account_id() -> T::AccountId

Get a unique, inaccessible account ID from the PotId.

pub fn assemble_collators() -> Vec<T::AccountId>

Assemble the current set of candidates and invulnerables into the next collator set.

This is done on the fly, as frequent as we are told to do so, as the session manager.

pub fn kick_stale_candidates( candidates: impl IntoIterator<Item = T::AccountId> ) -> u32

Kicks out candidates that did not produce a block in the kick threshold and refunds their deposits.

Return value is the number of candidates left in the list.

impl<T: Config> Pallet<T>

pub fn invulnerables() -> BoundedVec<T::AccountId, T::MaxInvulnerables>

An auto-generated getter for Invulnerables.

impl<T: Config> Pallet<T>

pub fn candidate_list( ) -> BoundedVec<CandidateInfo<T::AccountId, <<T as Config>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>, T::MaxCandidates>

An auto-generated getter for CandidateList.

impl<T: Config> Pallet<T>

pub fn last_authored_block<KArg>(k: KArg) -> BlockNumberFor<T>

where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for LastAuthoredBlock.

impl<T: Config> Pallet<T>

pub fn desired_candidates() -> u32

An auto-generated getter for DesiredCandidates.

impl<T: Config> Pallet<T>

pub fn candidacy_bond( ) -> <<T as Config>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance

An auto-generated getter for CandidacyBond.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

type RuntimeCall = 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 + Config> EventHandler<<T as Config>::AccountId, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

Keep track of number of authored blocks per authority, uncles are counted as well since they’re a valid proof of being online.

fn note_author(author: T::AccountId)

Note that the given account ID is the author of the current block.

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

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::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: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

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

fn integrity_test()

See Hooks::integrity_test.

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See Hooks::on_finalize.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See Hooks::on_idle.

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See Hooks::on_initialize.

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

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

fn on_runtime_upgrade() -> Weight

See Hooks::on_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 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: 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 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> SessionManager<<T as Config>::AccountId> for Pallet<T>

Play the role of the session manager.

fn new_session(index: SessionIndex) -> Option<Vec<T::AccountId>>

Plan a new session, and optionally provide the new validator set.

fn start_session(_: SessionIndex)

Start an already planned session.

fn end_session(_: SessionIndex)

End the session.

fn new_session_genesis(new_index: u32) -> Option<Vec<ValidatorId>>

Same as new_session, but it this should only be called at genesis.

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

fn storage_info() -> Vec<StorageInfo>

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

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>