Struct pallet_session::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn set_keys(
    origin: OriginFor<T>,
    keys: T::Keys,
    proof: Vec<u8>
) -> DispatchResult

Sets the session key(s) of the function caller to keys. Allows an account to set its session key prior to becoming a validator. This doesn’t take effect until the next session.

The dispatch origin of this function must be signed.

Complexity

• O(1). Actual cost depends on the number of length of T::Keys::key_ids() which is fixed.

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

Removes any session key(s) of the function caller.

This doesn’t take effect until the next session.

The dispatch origin of this function must be Signed and the account must be either be convertible to a validator ID using the chain’s typical addressing system (this usually means being a controller account) or directly convertible into a validator ID (which usually means being a stash account).

Complexity

• O(1) in number of key types. Actual cost depends on the number of length of T::Keys::key_ids() which is fixed.

impl<T: Config> Pallet<T>

pub fn validators() -> Vec<T::ValidatorId>

The current set of validators.

impl<T: Config> Pallet<T>

pub fn current_index() -> SessionIndex

Current index of the session.

impl<T: Config> Pallet<T>

pub fn queued_keys() -> Vec<(T::ValidatorId, T::Keys)>

The queued keys for the next session. When the next session begins, these keys will be used to determine the validator’s session keys.

impl<T: Config> Pallet<T>

pub fn disabled_validators() -> Vec<u32>

Indices of disabled validators.

The vec is always kept sorted so that we can find whether a given validator is disabled using binary search. It gets cleared when on_session_ending returns a new set of identities.

impl<T: Config> Pallet<T>

pub fn rotate_session()

Move on to next session. Register new validator set and session keys. Changes to the validator set have a session of delay to take effect. This allows for equivocation punishment after a fork.

pub fn disable_index(i: u32) -> bool

Disable the validator of index i, returns false if the validator was already disabled.

pub fn disable(c: &T::ValidatorId) -> bool

Disable the validator identified by c. (If using with the staking pallet, this would be their stash account.)

Returns false either if the validator could not be found or it was already disabled.

pub fn upgrade_keys<Old, F>(upgrade: F)where
    Old: OpaqueKeys + Member + Decode,
    F: Fn(T::ValidatorId, Old) -> T::Keys,

Upgrade the key type from some old type to a new type. Supports adding and removing key types.

This function should be used with extreme care and only during an on_runtime_upgrade block. Misuse of this function can put your blockchain into an unrecoverable state.

Care should be taken that the raw versions of the added keys are unique for every ValidatorId, KeyTypeId combination. This is an invariant that the session pallet typically maintains internally.

As the actual values of the keys are typically not known at runtime upgrade, it’s recommended to initialize the keys to a (unique) dummy value with the expectation that all validators should invoke set_keys before those keys are actually required.

pub fn key_owner(id: KeyTypeId, key_data: &[u8]) -> Option<T::ValidatorId>

Query the owner of a session key by returning the owner’s validator ID.

Trait Implementations

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

fn is_disabled(index: u32) -> bool

Returns true if the given validator is disabled.

impl<T: Config> EstimateNextNewSession<<T as Config>::BlockNumber> for Pallet<T>

fn estimate_next_new_session(
    now: T::BlockNumber
) -> (Option<T::BlockNumber>, Weight)

This session pallet always calls new_session and next_session at the same time, hence we do a simple proxy and pass the function to next rotation.

fn average_session_length() -> T::BlockNumber

Return the average length of a session.

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

Called when a block is initialized. Will rotate session if it is the last block of the current session.

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<Vec<u8, Global>, &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8, Global>) -> 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<Vec<u8>, &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(state: Vec<u8>) -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, &'static str>

Same as on_runtime_upgrade, but perform the optional pre_upgrade and post_upgrade as well.

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

fn try_state(
    n: <T as Config>::BlockNumber,
    _s: TryStateSelect
) -> Result<(), &'static str>

Execute the state checks.

impl<T: Config> ValidatorRegistration<<T as Config>::ValidatorId> for Pallet<T>

fn is_registered(id: &T::ValidatorId) -> bool

Returns true if the provided validator ID has been registered with the implementing runtime module

impl<T: Config> ValidatorSet<<T as Config>::AccountId> for Pallet<T>

type ValidatorId = <T as Config>::ValidatorId

Type for representing validator id in a session.

type ValidatorIdOf = <T as Config>::ValidatorIdOf

A type for converting AccountId to ValidatorId.

fn session_index() -> SessionIndex

Returns current session index.

fn validators() -> Vec<Self::ValidatorId>

Returns the active set of validators.

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>