Struct pallet_committee_management::pallet::Pallet

pub struct Pallet<T>(PhantomData<T>);

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

Tuple Fields

0: PhantomData<T>

Implementations

impl<T: Config> Pallet<T>

pub(crate) fn update_validator_total_rewards(era: EraIndex)

fn reward_for_session_non_committee( non_committee: Vec<T::AccountId>, nr_of_sessions: SessionIndex, blocks_per_session: u32, validator_totals: &BTreeMap<T::AccountId, u32>, threshold: Perquintill ) -> impl IntoIterator<Item = (T::AccountId, u32)> + '_

fn reward_for_session_committee( committee: Vec<T::AccountId>, nr_of_sessions: SessionIndex, blocks_per_session: u32, validator_totals: &BTreeMap<T::AccountId, u32>, threshold: Perquintill ) -> impl IntoIterator<Item = (T::AccountId, u32)> + '_

fn blocks_to_produce_per_session() -> u32

pub fn adjust_rewards_for_session()

fn store_session_validators( committee: &[T::AccountId], reserved: Vec<T::AccountId>, non_reserved: Vec<T::AccountId> )

pub(crate) fn select_committee( era_validators: &EraValidators<T::AccountId>, committee_seats: CommitteeSeats, current_session: SessionIndex ) -> Option<SessionCommittee<T::AccountId>>

pub(crate) fn rotate_committee( current_session: SessionIndex ) -> Option<SessionCommittee<T::AccountId>>

where T::AccountId: Clone + PartialEq,

pub(crate) fn calculate_underperforming_validators()

fn mark_validator_underperformance( thresholds: &BanConfigStruct, validator: &T::AccountId )

pub(crate) fn clear_underperformance_session_counter(session: SessionIndex)

pub fn clear_expired_bans(active_era: EraIndex)

pub fn ban_validator(validator: &T::AccountId, reason: BanReason)

pub fn emit_fresh_bans_event()

pub fn predict_session_committee_for_session( session: SessionIndex ) -> Result<SessionCommittee<T::AccountId>, SessionValidatorError>

Predict finality committee and block producers for the given session. session must be within the current era (current, in the staking context).

If the active era E starts in the session a, and ends in session b then from session a to session b-1 this function can answer question who will be in the committee in the era E. In the last session of the era E (b) this can be used to determine all of the sessions in the era E+1.

impl<T: Config> Pallet<T>

pub fn set_ban_config( origin: OriginFor<T>, minimal_expected_performance: Option<u8>, underperformed_session_count_threshold: Option<u32>, clean_session_counter_delay: Option<u32>, ban_period: Option<EraIndex> ) -> DispatchResult

Sets ban config, it has an immediate effect

pub fn ban_from_committee( origin: OriginFor<T>, banned: T::AccountId, ban_reason: Vec<u8> ) -> DispatchResult

Schedule a non-reserved node to be banned out from the committee at the end of the era

pub fn cancel_ban(origin: OriginFor<T>, banned: T::AccountId) -> DispatchResult

Cancel the ban of the node

pub fn set_lenient_threshold( origin: OriginFor<T>, threshold_percent: u8 ) -> DispatchResult

Set lenient threshold

impl<T: Config> Pallet<T>

pub(crate) fn deposit_event(event: Event<T>)

Trait Implementations

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

type AccountId = <T as Config>::AccountId

fn banned() -> Vec<Self::AccountId>

returns currently banned validators

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

where T: Config,

We assume that block B ends session nr S, and current era index is E.

1. Block B initialized
2. End_session(S) is called

• Based on block count we might mark the session for a given validator as underperformed
• We update rewards and clear block count for the session S.

3. Start_session(S + 1) is called.

• If session S+1 starts a new era, we populate totals and unban all validators whose ban expired.
• If session S+1 % clean_session_counter_delay == 0, we clean up underperformed session counter.
• Clean_session_counter_delay is read from pallet’s storage

4. New_session(S + 2) is called.

• If session S+2 starts a new era, we emit fresh bans events
• We rotate the validators for sessionS + 2 using the information about reserved and non-reserved validators.

fn note_author(validator: T::AccountId)

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

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

type CurrentStorageVersion = StorageVersion

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

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

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