Struct 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_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>

Public function to access the current set of validators.

pub fn current_index() -> SessionIndex

Public function to access the current session index.

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

Public function to access the queued keys.

pub fn disabled_validators() -> Vec<u32>

Public function to access the disabled validators.

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 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 load_keys(v: &T::ValidatorId) -> Option<T::Keys>

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.

pub fn disable_index_with_severity(i: u32, severity: OffenceSeverity) -> bool

Disable the validator of index i with a specified severity, returns false if the validator is not found.

Note: If validator is already disabled, the severity will be updated if the new one is higher.

pub fn disable_index(i: u32) -> bool

Disable the validator of index i with a default severity (defaults to most severe), returns false if the validator is not found.

pub fn reenable_index(i: u32) -> bool

Re-enable the validator of index i, returns false if the validator was not disabled.

pub fn validator_id_to_index(id: &T::ValidatorId) -> Option<u32>

Convert a validator ID to an index. (If using with the staking pallet, this would be their stash account.)

pub fn report_offence(validator: T::ValidatorId, severity: OffenceSeverity)

Report an offence for the given validator and let disabling strategy decide what changes to disabled validators should be made.

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

fn disabled_validators() -> Vec<u32>

Returns all disabled validators

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

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

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

fn estimate_next_new_session( now: BlockNumberFor<T>, ) -> (Option<BlockNumberFor<T>>, 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() -> BlockNumberFor<T>

Return the average length of a session.

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 on_initialize(n: BlockNumberFor<T>) -> 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)

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.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

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

fn prefix() -> [u8; 16]

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>