Struct pallet_scored_pool::pallet::Pallet

pub struct Pallet<T, I = ()>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn submit_candidacy(origin: OriginFor<T>) -> 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.

pub fn withdraw_candidacy(origin: OriginFor<T>, 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.

pub fn kick(
    origin: OriginFor<T>,
    dest: <<T as Config>::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.

pub fn score(
    origin: OriginFor<T>,
    dest: <<T as Config>::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.

pub fn change_member_count(origin: OriginFor<T>, 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.

impl<T: Config<I>, I: 'static> Pallet<T, I>

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

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

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn candidate_exists<KArg>(k: KArg) -> boolwhere
    KArg: EncodeLike<T::AccountId>,

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

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn members(
) -> BoundedVec<<T as Config>::AccountId, <T as Config<I>>::MaximumMembers>

The current membership, stored as an ordered Vec.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn member_count() -> u32

Size of the Members set.

Trait Implementations

impl<T: Config<I>, I: 'static> Callable<T> for Pallet<T, I>

type RuntimeCall = Call<T, I>

impl<T, I> Clone for Pallet<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, I> Debug for Pallet<T, I>

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>

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<I>, I: 'static> Hooks<<T as Config>::BlockNumber> for Pallet<T, I>

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

Every Period blocks the Members set is refreshed from the highest scoring members in the pool.

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 try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8, Global>, &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8, Global>) -> Result<(), &'static str>

Execute some post-checks after a runtime 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.

fn integrity_test()

Run integrity test.

impl<T: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>

fn integrity_test()

Run integrity test.

impl<T: Config<I>, I: 'static> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T, I>

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

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

impl<T: Config<I>, I: 'static> OnFinalize<<T as Config>::BlockNumber> for Pallet<T, I>

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

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

impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config<I>, I: 'static> OnIdle<<T as Config>::BlockNumber> for Pallet<T, I>

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<I>, I: 'static> OnInitialize<<T as Config>::BlockNumber> for Pallet<T, I>

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

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

impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<Vec<u8>, &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(state: Vec<u8>) -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, &'static str>

Same as on_runtime_upgrade, but perform the optional pre_upgrade and post_upgrade as well.

impl<T: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>

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<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>

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, I> PartialEq<Pallet<T, I>> for Pallet<T, I>

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<I>, I: 'static> StorageInfoTrait for Pallet<T, I>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, I: 'static> TryState<<T as Config>::BlockNumber> for Pallet<T, I>

fn try_state(
    n: <T as Config>::BlockNumber,
    _s: TryStateSelect
) -> Result<(), &'static str>

Execute the state checks.

impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>

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, I> Eq for Pallet<T, I>