Struct pallet_elections::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> Pallet<T>

where T: Config,

fn populate_next_era_validators_on_next_era_start(era: EraIndex)

impl<T: Config> Pallet<T>

pub fn change_validators( origin: OriginFor<T>, reserved_validators: Option<Vec<T::AccountId>>, non_reserved_validators: Option<Vec<T::AccountId>>, committee_size: Option<CommitteeSeats> ) -> DispatchResult

pub fn set_elections_openness( origin: OriginFor<T>, openness: ElectionOpenness ) -> DispatchResult

Set openness of the elections

impl<T: Config> Pallet<T>

fn ensure_validators_are_ok( reserved_validators: Vec<T::AccountId>, non_reserved_validators: Vec<T::AccountId>, committee_size: CommitteeSeats ) -> DispatchResult

impl<T: Config> Pallet<T>

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

Trait Implementations

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

type AccountId = <T as Config>::AccountId

fn can_ban(account_id: &Self::AccountId) -> bool

returns whether the account can be banned

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

fn elect() -> Result<BoundedSupportsOf<Self>, Self::Error>

We calculate the supports for each validator. The external validators are chosen as:

1. “NextEraNonReservedValidators that are staking and are not banned” in case of Permissioned ElectionOpenness
2. “All staking and not banned validators” in case of Permissionless ElectionOpenness

fn ongoing() -> bool

Indicate if this election provider is currently ongoing an asynchronous election or not.

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

type AccountId = <T as Config>::AccountId

The account identifier type.

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

The block number type.

type Error = ElectionError

The error type that is returned by the provider.

type MaxWinners = <T as Config>::MaxWinners

The upper bound on election winners that can be returned.

type DataProvider = <T as Config>::DataProvider

The data provider of the election.

fn desired_targets_checked() -> Result<u32, &'static str>

checked call to Self::DataProvider::desired_targets() ensuring the value never exceeds [Self::MaxWinners].

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

fn on_new_era(era: EraIndex)

new era has been planned

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 + Config> ValidatorProvider for Pallet<T>

type AccountId = <T as Config>::AccountId

fn current_era_validators() -> EraValidators<Self::AccountId>

returns validators for the current era.

fn current_era_committee_size() -> CommitteeSeats

returns committee seats for the current era.

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>