Struct pallet_session::Module

pub struct Module<T: Config>(_);

Implementations

impl<T: Config + 'static> Module<T>

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

The current set of validators.

pub fn current_index() -> SessionIndex

Current index of the session.

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.

pub fn disabled_validators() -> Vec<u32>

Indices of disabled validators.

The set is cleared when on_session_ending returns a new set of identities.

impl<T: Config> Module<T>

Can also be called using Call.

pub fn set_keys(
    origin: T::Origin,
    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.
• DbReads: origin account, T::ValidatorIdOf, NextKeys
• DbWrites: origin account, NextKeys
• DbReads per key id: KeyOwner
• DbWrites per key id: KeyOwner

NOTE: Calling this function will bypass origin filters.

pub fn purge_keys(origin: T::Origin) -> 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.

• Complexity: O(1) in number of key types. Actual cost depends on the number of length of T::Keys::key_ids() which is fixed.
• DbReads: T::ValidatorIdOf, NextKeys, origin account
• DbWrites: NextKeys, origin account
• DbWrites per key id: KeyOwnder

NOTE: Calling this function will bypass origin filters.

impl<T: Config> Module<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: usize) -> bool

Disable the validator of index i.

Returns true if this causes a DisabledValidatorsThreshold of validators to be already disabled.

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

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

Returns Ok(true) if more than DisabledValidatorsThreshold validators in current session is already disabled. If used with the staking module it allows to force a new era in such case.

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

Trait Implementations

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

type Call = Call<T>

impl<T: Clone + Config> Clone for Module<T>

fn clone(&self) -> Module<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy + Config> Copy for Module<T>

impl<T: Config> Debug for Module<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T: Eq + Config> Eq for Module<T>

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

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

This session module 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 weight(now: T::BlockNumber) -> Weight

Return the weight of calling estimate_next_new_session

impl<T: Config> GetPalletVersion for Module<T>

fn current_version() -> PalletVersion

Returns the current version of the pallet.

fn storage_version() -> Option<PalletVersion>

Returns the version of the pallet that is stored in storage.

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

pub fn integrity_test()

Run integrity test.

impl<T: Config> ModuleErrorMetadata for Module<T>

fn metadata() -> &'static [ErrorMetadata]

impl<T: Config + Config> OffchainWorker<<T as Config>::BlockNumber> for Module<T>

pub fn offchain_worker(_n: BlockNumber)

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

impl<T: Config + Config> OnFinalize<<T as Config>::BlockNumber> for Module<T>

pub fn on_finalize(_n: BlockNumber)

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

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config + Config> OnInitialize<<T as Config>::BlockNumber> for Module<T>

fn on_initialize(n: T::BlockNumber) -> Weight

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

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T: PartialEq + Config> PartialEq<Module<T>> for Module<T>

fn eq(&self, other: &Module<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Module<T>) -> bool

This method tests for !=.

impl<T: Config> StructuralEq for Module<T>

impl<T: Config> StructuralPartialEq for Module<T>

impl<T: Config> ValidatorRegistration<<T as Config>::ValidatorId> for Module<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 Module<T>

type ValidatorId = T::ValidatorId

Type for representing validator id in a session.

type ValidatorIdOf = T::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.