Struct noble_scored_pool::Module

pub struct Module<T: Config<I>, I: Instance = DefaultInstance>(_);

Implementations

impl<T: Config<I> + 'static, I: Instance> Module<T, I>

pub fn pool(
) -> Vec<(<T as Config>::AccountId, Option<<T as Config<I>>::Score>)>

The current pool of candidates, stored as an ordered Vec (ordered descending by score, None last, highest first).

pub fn candidate_exists<K: EncodeLike<T::AccountId>>(key: K) -> bool

A Map of the candidates. The information in this Map is redundant to the information in the Pool. But the Map enables us to easily check if a candidate is already in the pool, without having to iterate over the entire pool (the Pool is not sorted by T::AccountId, but by T::Score instead).

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

The current membership, stored as an ordered Vec.

pub fn member_count() -> u32

Size of the Members set.

impl<T: Config<I>, I: Instance> Module<T, I>

Can also be called using Call.

pub fn submit_candidacy(origin: T::Origin) -> DispatchResult

Add origin to the pool of candidates.

This results in CandidateDeposit being reserved from the origin account. The deposit is returned once candidacy is withdrawn by the candidate or the entity is kicked by KickOrigin.

The dispatch origin of this function must be signed.

The index parameter of this function must be set to the index of the transactor in the Pool.

NOTE: Calling this function will bypass origin filters.

pub fn withdraw_candidacy(origin: T::Origin, index: u32) -> DispatchResult

An entity withdraws candidacy and gets its deposit back.

If the entity is part of the Members, then the highest member of the Pool that is not currently in Members is immediately placed in the set instead.

The dispatch origin of this function must be signed.

The index parameter of this function must be set to the index of the transactor in the Pool.

NOTE: Calling this function will bypass origin filters.

pub fn kick(
    origin: T::Origin,
    dest: <T::Lookup as StaticLookup>::Source,
    index: u32
) -> DispatchResult

Kick a member who from the set.

May only be called from T::KickOrigin.

The index parameter of this function must be set to the index of dest in the Pool.

NOTE: Calling this function will bypass origin filters.

pub fn score(
    origin: T::Origin,
    dest: <T::Lookup as StaticLookup>::Source,
    index: u32,
    score: T::Score
) -> DispatchResult

Score a member who with score.

May only be called from T::ScoreOrigin.

The index parameter of this function must be set to the index of the dest in the Pool.

NOTE: Calling this function will bypass origin filters.

pub fn change_member_count(origin: T::Origin, count: u32) -> DispatchResult

Dispatchable call to change MemberCount.

This will only have an effect the next time a refresh happens (this happens each Period).

May only be called from root.

NOTE: Calling this function will bypass origin filters.

Trait Implementations

impl<T: Config<I>, I: Instance> Callable<T> for Module<T, I>

type Call = Call<T, I>

impl<T: Clone + Config<I>, I: Clone + Instance> Clone for Module<T, I>

fn clone(&self) -> Module<T, I>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy + Config<I>, I: Copy + Instance> Copy for Module<T, I>

impl<T: Config<I>, I: Instance> Debug for Module<T, I> where
    T: Debug,
    I: Debug, 

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

Formats the value using the given formatter.

impl<T: Eq + Config<I>, I: Eq + Instance> Eq for Module<T, I>

impl<T: Config<I>, I: Instance> GetNobleVersion for Module<T, I>

fn current_version() -> NobleVersion

Returns the current version of the noble.

fn storage_version() -> Option<NobleVersion>

Returns the version of the noble that is stored in storage.

impl<T: Config<I>, I: Instance> IntegrityTest for Module<T, I>

pub fn integrity_test()

Run integrity test.

impl<T: Config<I>, I: Instance> ModuleErrorMetadata for Module<T, I>

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

impl<T: Config + Config<I>, I: Instance> OffchainWorker<<T as Config>::BlockNumber> for Module<T, I>

pub fn offchain_worker(_n: BlockNumber)

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

impl<T: Config + Config<I>, I: Instance> OnFinalize<<T as Config>::BlockNumber> for Module<T, I>

pub fn on_finalize(_n: BlockNumber)

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

impl<T: Config<I>, I: Instance> OnGenesis for Module<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config + Config<I>, I: Instance> OnInitialize<<T as Config>::BlockNumber> for Module<T, I>

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

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

impl<T: Config<I>, I: Instance> OnRuntimeUpgrade for Module<T, I>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T: PartialEq + Config<I>, I: PartialEq + Instance> PartialEq<Module<T, I>> for Module<T, I>

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

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

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

This method tests for !=.

impl<T: Config<I>, I: Instance> StructuralEq for Module<T, I>

impl<T: Config<I>, I: Instance> StructuralPartialEq for Module<T, I>