Struct pallet_bags_list::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 rebag(
    origin: OriginFor<T>,
    dislocated: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult

Declare that some dislocated account has, through rewards or penalties, sufficiently changed its score that it should properly fall into a different bag than its current one.

Anyone can call this function about any potentially dislocated account.

Will always update the stored score of dislocated to the correct score, based on ScoreProvider.

If dislocated does not exists, it returns an error.

pub fn put_in_front_of(
    origin: OriginFor<T>,
    lighter: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult

Move the caller’s Id directly in front of lighter.

The dispatch origin for this call must be Signed and can only be called by the Id of the account going in front of lighter.

Only works if

• both nodes are within the same bag,
• and origin has a greater Score than lighter.

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

pub fn do_rebag(
    account: &T::AccountId,
    new_score: T::Score
) -> Result<Option<(T::Score, T::Score)>, ListError>

Move an account from one bag to another, depositing an event on success.

If the account changed bags, returns Ok(Some((from, to))).

pub fn list_bags_get(score: T::Score) -> Option<Bag<T, I>>

Equivalent to ListBags::get, but public. Useful for tests in outside of this crate.

Trait Implementations

impl<T, I: 'static> Benchmarking for Pallet<T, I>where
    T: Config + Config<I>,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

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

type Call = 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 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_initialize(_n: BlockNumber) -> Weight

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

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<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> 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.

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<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

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

Execute some post-checks after a runtime upgrade.

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> ScoreProvider<<T as Config>::AccountId> for Pallet<T, I>

type Score = <Pallet<T, I> as SortedListProvider<<T as Config>::AccountId>>::Score

fn score(id: &T::AccountId) -> T::Score

Get the current Score of who.

fn set_score_of(id: &T::AccountId, new_score: T::Score)

For tests and benchmarks, set the score.

impl<T: Config<I>, I: 'static> SortedListProvider<<T as Config>::AccountId> for Pallet<T, I>

type Error = ListError

The list’s error type.

type Score = <T as Config<I>>::Score

The type used by the list to compare nodes for ordering.

fn iter() -> Box<dyn Iterator<Item = T::AccountId>>

An iterator over the list, which can have take called on it.

fn iter_from(
    start: &T::AccountId
) -> Result<Box<dyn Iterator<Item = T::AccountId>>, Self::Error>

Returns an iterator over the list, starting right after from the given voter.

fn count() -> u32

The current count of ids in the list.

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

Return true if the list already contains id.

fn on_insert(id: T::AccountId, score: T::Score) -> Result<(), ListError>

Hook for inserting a new id.

fn get_score(id: &T::AccountId) -> Result<T::Score, ListError>

Get the score of id.

fn on_update(id: &T::AccountId, new_score: T::Score) -> Result<(), ListError>

Hook for updating a single id.

fn on_remove(id: &T::AccountId) -> Result<(), ListError>

Hook for removing am id from the list.

fn unsafe_regenerate(
    all: impl IntoIterator<Item = T::AccountId>,
    score_of: Box<dyn Fn(&T::AccountId) -> T::Score>
) -> u32

Regenerate this list from scratch. Returns the count of items inserted.

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

Check internal state of list. Only meant for debugging.

fn unsafe_clear()

Remove all items from the list.

fn score_update_worst_case(who: &T::AccountId, is_increase: bool) -> Self::Score

If who changes by the returned amount they are guaranteed to have a worst case change in their list position.

fn on_increase(
    id: &AccountId,
    additional: Self::Score
) -> Result<(), Self::Error>

Same as on_update, but incorporate some increased score.

fn on_decrease(id: &AccountId, decreased: Self::Score) -> Result<(), Self::Error>

Same as on_update, but incorporate some decreased score.

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

fn storage_info() -> Vec<StorageInfo>

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