Struct pallet_bags_list::pallet::Pallet

pub struct Pallet<T, I = ()>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

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. Fee is payed by the origin under all circumstances.

Only works if:

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

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

Same as Pallet::put_in_front_of, but it can be called by anyone.

Fee is paid by the origin under all circumstances.

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

pub fn do_try_state() -> Result<(), TryRuntimeError>

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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 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 From<<Pallet<Runtime> as Callable<Runtime>>::RuntimeCall> for RuntimeCall

fn from(call: CallableCallFor<BagsList, Runtime>) -> Self

Converts to this type from the input type.

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

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn integrity_test()

Check the integrity of this pallet’s configuration.

fn try_state(_: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block.

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

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

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

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

fn integrity_test()

See [Hooks::integrity_test].

impl IsSubType<<Pallet<Runtime> as Callable<Runtime>>::RuntimeCall> for RuntimeCall

fn is_sub_type(&self) -> Option<&CallableCallFor<BagsList, Runtime>>

Returns Some(_) if self is an instance of sub type T.

impl<T: Config<I>, I: 'static> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config<I>, I: 'static> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config<I>, I: 'static> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config<I>, I: 'static> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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 name_hash() -> [u8; 16]

Two128 hash of name.

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 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, benchmarks and fuzzing, 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<(), TryRuntimeError>

Check internal state of the 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: Config<I>, I: 'static> TryDecodeEntireStorage for Pallet<T, I>

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T: Config<I>, I: 'static> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

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>