Struct pallet_elections::Module

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

Implementations

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

pub fn presentation_duration() -> T::BlockNumber

How long to give each top candidate to present themselves after the vote ends.

pub fn term_duration() -> T::BlockNumber

How long each position is active for.

pub fn desired_seats() -> u32

Number of accounts that should constitute the collective.

pub fn members() -> Vec<(T::AccountId, T::BlockNumber)>

The current membership. When there's a vote going on, this should still be used for executive matters. The block number (second element in the tuple) is the block that their position is active until (calculated by the sum of the block number when the member was elected and their term duration).

pub fn vote_index() -> VoteIndex

The total number of vote rounds that have happened or are in progress.

pub fn approvals_of<K: EncodeLike<(T::AccountId, u32)>>(key: K) -> Vec<u32>

TWOX-NOTE: SAFE as AccountId is a crypto hash and SetIndex is not attacker-controlled.

pub fn candidate_reg_info<K: EncodeLike<T::AccountId>>(
    key: K
) -> Option<(VoteIndex, u32)>

The vote index and list slot that the candidate who was registered or None if they are not currently registered.

TWOX-NOTE: SAFE as AccountId is a crypto hash.

pub fn voter_info<K: EncodeLike<T::AccountId>>(
    key: K
) -> Option<VoterInfo<<<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance>>

Basic information about a voter.

TWOX-NOTE: SAFE as AccountId is a crypto hash.

pub fn voters<K: EncodeLike<u32>>(key: K) -> Vec<Option<T::AccountId>>

The present voter list (chunked and capped at VOTER_SET_SIZE).

TWOX-NOTE: OKAY ― SetIndex is not user-controlled data.

pub fn next_nonfull_voter_set() -> u32

the next free set to store a voter in. This will keep growing.

pub fn voter_count() -> u32

Current number of Voters.

pub fn candidates() -> Vec<T::AccountId>

The present candidate list.

pub fn candidate_count() -> u32

Current number of active candidates

pub fn next_finalize() -> Option<(T::BlockNumber, u32, Vec<T::AccountId>)>

The accounts holding the seats that will become free on the next tally.

pub fn leaderboard(
) -> Option<Vec<(<<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance, T::AccountId)>>

Get the leaderboard if we're in the presentation phase. The first element is the weight of each entry; It may be the direct summed approval stakes, or a weighted version of it. Sorted from low to high.

impl<T: Trait> Module<T>

pub fn presentation_active() -> bool

True if we're currently in a presentation period.

pub fn is_a_candidate(who: &T::AccountId) -> bool

If who a candidate at the moment?

pub fn will_still_be_member_at(who: &T::AccountId, n: T::BlockNumber) -> bool

Iff the member who still has a seat at blocknumber n returns true.

pub fn next_vote_from(n: T::BlockNumber) -> T::BlockNumber

Determine the block that a vote can happen on which is no less than n.

pub fn next_tally() -> Option<T::BlockNumber>

The block number on which the tally for the next election will happen. None only if the desired seats of the set is zero.

pub fn bool_to_flag(x: Vec<bool>) -> Vec<u32>

Convert a vec of boolean approval flags to a vec of integers, as denoted by the type ApprovalFlag. see bool_to_flag_should_work test for examples.

pub fn flag_to_bool(chunk: Vec<u32>) -> Vec<bool>

Convert a vec of flags (u32) to boolean.

Trait Implementations

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

type Call = Call<T>

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

pub 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 + Trait> Copy for Module<T>

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

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

Formats the value using the given formatter.

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

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

pub fn integrity_test()

Run integrity test.

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

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

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

pub fn offchain_worker(_n: BlockNumber)

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

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

pub fn on_finalize(_n: BlockNumber)

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

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

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

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

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

pub fn on_runtime_upgrade() -> u64

Perform a module upgrade.

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

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

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

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

This method tests for !=.

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

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