Struct pallet_elections_phragmen::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn vote(
    origin: OriginFor<T>,
    votes: Vec<T::AccountId>,
    value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance
) -> DispatchResultWithPostInfo

Vote for a set of candidates for the upcoming round of election. This can be called to set the initial votes, or update already existing votes.

Upon initial voting, value units of who’s balance is locked and a deposit amount is reserved. The deposit is based on the number of votes and can be updated over time.

The votes should:

• not be empty.
• be less than the number of possible candidates. Note that all current members and runners-up are also automatically candidates for the next round.

If value is more than who’s free balance, then the maximum of the two is used.

The dispatch origin of this call must be signed.

Warning

It is the responsibility of the caller to NOT place all of their balance into the lock and keep some for further operations.

pub fn remove_voter(origin: OriginFor<T>) -> DispatchResult

Remove origin as a voter.

This removes the lock and returns the deposit.

The dispatch origin of this call must be signed and be a voter.

pub fn submit_candidacy(
    origin: OriginFor<T>,
    candidate_count: u32
) -> DispatchResult

Submit oneself for candidacy. A fixed amount of deposit is recorded.

All candidates are wiped at the end of the term. They either become a member/runner-up, or leave the system while their deposit is slashed.

The dispatch origin of this call must be signed.

Warning

Even if a candidate ends up being a member, they must call Call::renounce_candidacy to get their deposit back. Losing the spot in an election will always lead to a slash.

The number of current candidates must be provided as witness data.

Complexity

O(C + log(C)) where C is candidate_count.

pub fn renounce_candidacy(
    origin: OriginFor<T>,
    renouncing: Renouncing
) -> DispatchResult

Renounce one’s intention to be a candidate for the next election round. 3 potential outcomes exist:

• origin is a candidate and not elected in any set. In this case, the deposit is unreserved, returned and origin is removed as a candidate.
• origin is a current runner-up. In this case, the deposit is unreserved, returned and origin is removed as a runner-up.
• origin is a current member. In this case, the deposit is unreserved and origin is removed as a member, consequently not being a candidate for the next round anymore. Similar to remove_member, if replacement runners exists, they are immediately used. If the prime is renouncing, then no prime will exist until the next round.

The dispatch origin of this call must be signed, and have one of the above roles. The type of renouncing must be provided as witness data.

Complexity

• Renouncing::Candidate(count): O(count + log(count))
• Renouncing::Member: O(1)
• Renouncing::RunnerUp: O(1)

pub fn remove_member(
    origin: OriginFor<T>,
    who: <<T as Config>::Lookup as StaticLookup>::Source,
    slash_bond: bool,
    rerun_election: bool
) -> DispatchResult

Remove a particular member from the set. This is effective immediately and the bond of the outgoing member is slashed.

If a runner-up is available, then the best runner-up will be removed and replaces the outgoing member. Otherwise, if rerun_election is true, a new phragmen election is started, else, nothing happens.

If slash_bond is set to true, the bond of the member being removed is slashed. Else, it is returned.

The dispatch origin of this call must be root.

Note that this does not affect the designated block number of the next election.

Complexity

• Check details of remove_and_replace_member() and do_phragmen().

pub fn clean_defunct_voters(
    origin: OriginFor<T>,
    _num_voters: u32,
    _num_defunct: u32
) -> DispatchResult

Clean all voters who are defunct (i.e. they do not serve any purpose at all). The deposit of the removed voters are returned.

This is an root function to be used only for cleaning the state.

The dispatch origin of this call must be root.

Complexity

• Check is_defunct_voter() details.

impl<T: Config> Pallet<T>

pub fn members(
) -> Vec<SeatHolder<T::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>>

The current elected members.

Invariant: Always sorted based on account id.

impl<T: Config> Pallet<T>

pub fn runners_up(
) -> Vec<SeatHolder<T::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>>

The current reserved runners-up.

Invariant: Always sorted based on rank (worse to best). Upon removal of a member, the last (i.e. best) runner-up will be replaced.

impl<T: Config> Pallet<T>

pub fn candidates(
) -> Vec<(T::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance)>

The present candidate list. A current member or runner-up can never enter this vector and is always implicitly assumed to be a candidate.

Second element is the deposit.

Invariant: Always sorted based on account id.

impl<T: Config> Pallet<T>

pub fn election_rounds() -> u32

The total number of vote rounds that have happened, excluding the upcoming one.

impl<T: Config> Pallet<T>

pub fn voting<KArg>(
    k: KArg
) -> Voter<T::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>where
    KArg: EncodeLike<T::AccountId>,

Votes and locked stake of a particular voter.

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

Trait Implementations

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: Config> Contains<<T as Config>::AccountId> for Pallet<T>

fn contains(who: &T::AccountId) -> bool

Return true if this “contains” the given value t.

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

fn max_len() -> usize

Implementation uses a parameter type so calling is cost-free.

fn min_len() -> usize

Minimum number of elements contained

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

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

fn current_storage_version() -> StorageVersion

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>::BlockNumber> for Pallet<T>

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

What to do at the end of each block.

Checks if an election needs to happen or not.

fn integrity_test()

Run integrity test.

fn on_finalize(_n: BlockNumber)

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

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

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

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

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

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

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

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

fn on_runtime_upgrade() -> Weight

Perform a module 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<Pallet<T>> 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> SortedMembers<<T as Config>::AccountId> for Pallet<T>

fn contains(who: &T::AccountId) -> bool

Return true if this “contains” the given value t.

fn sorted_members() -> Vec<T::AccountId>

Get a vector of all members in the set, ordered.

fn count() -> usize

Get the number of items in the set.

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>