Struct pallet_rewards::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>

where <<T as Config<I>>::RewardMechanism as RewardMechanism>::Account: FullCodec + Default,

pub fn list_currencies(account_id: &T::AccountId) -> Vec<T::CurrencyId>

Trait Implementations

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

where <<T as Config<I>>::RewardMechanism as RewardMechanism>::Group: FullCodec + Default, <<T as Config<I>>::RewardMechanism as RewardMechanism>::Account: FullCodec + Default, <<T as Config<I>>::RewardMechanism as RewardMechanism>::Currency: FullCodec + Default,

type Balance = <<T as Config<I>>::RewardMechanism as RewardMechanism>::Balance

Type used as balance for all currencies and reward.

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

Type used to identify the currency.

fn deposit_stake( currency_id: Self::CurrencyId, account_id: &T::AccountId, amount: Self::Balance ) -> DispatchResult

Deposit a stake amount for a account_id associated to a currency_id. The account_id must have enough currency to make the deposit, if not, an Err will be returned.

fn withdraw_stake( currency_id: Self::CurrencyId, account_id: &T::AccountId, amount: Self::Balance ) -> DispatchResult

Withdraw a stake amount for an account_id associated to a currency_id. The account_id must have enough currency staked to perform a withdraw, if not, an Err will be returned.

fn compute_reward( currency_id: Self::CurrencyId, account_id: &T::AccountId ) -> Result<Self::Balance, DispatchError>

Computes the reward the account_id can receive for a currency_id. This action does not modify the account currency balance.

fn claim_reward( currency_id: Self::CurrencyId, account_id: &T::AccountId ) -> Result<Self::Balance, DispatchError>

Computes the reward the account_id can receive for a currency_id and claim it. A reward using the native currency will be sent to the account_id.

fn account_stake( currency_id: Self::CurrencyId, account_id: &T::AccountId ) -> Self::Balance

Retrieve the total staked amount of currency in an account.

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

where <<T as Config<I>>::RewardMechanism as RewardMechanism>::Group: FullCodec + Default, <<T as Config<I>>::RewardMechanism as RewardMechanism>::Currency: FullCodec + Default,

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

Type used to identify the currency.

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

Type used to identify the group.

fn attach_currency( currency_id: Self::CurrencyId, next_group_id: Self::GroupId ) -> DispatchResult

Associate the currency to a group. If the currency was previously associated to another group, the associated stake is moved to the new group.

fn currency_group(currency_id: Self::CurrencyId) -> Option<Self::GroupId>

Returns the associated group of a currency.

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>

type CurrentStorageVersion = NoStorageVersionSet

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

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

where <<T as Config<I>>::RewardMechanism as RewardMechanism>::Group: FullCodec + Default,

type Balance = <<T as Config<I>>::RewardMechanism as RewardMechanism>::Balance

Type used as balance for all currencies and reward.

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

Type used to identify the group

fn is_ready(group_id: Self::GroupId) -> bool

Check if the group is ready to be rewarded. Most of the cases it means that the group has stake that should be rewarded.

fn reward_group( group_id: Self::GroupId, reward: Self::Balance ) -> Result<Self::Balance, DispatchError>

Reward a group distributing the reward amount proportionally to all associated accounts. This method is called by distribution method only when the group is considered ready, check [GroupRewards::is_ready()]. The method returns the minted reward. Depending on the implementation it may be less than requested.

fn group_stake(group_id: Self::GroupId) -> Self::Balance

Retrieve the total staked amount.

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

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_runtime_upgrade() -> Weight

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

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 wasm runtime.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn integrity_test()

See [Hooks::integrity_test].

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_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 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> StorageInfoTrait for Pallet<T, I>

where <<T as Config<I>>::RewardMechanism as RewardMechanism>::Currency: TypeInfo + MaxEncodedLen + FullCodec + Default, <<T as Config<I>>::RewardMechanism as RewardMechanism>::Group: TypeInfo + MaxEncodedLen + FullCodec + Default, <<T as Config<I>>::RewardMechanism as RewardMechanism>::Account: TypeInfo + MaxEncodedLen + FullCodec + Default,

fn storage_info() -> Vec<StorageInfo>

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

where <<T as Config<I>>::RewardMechanism as RewardMechanism>::Currency: TypeInfo + MaxEncodedLen + FullCodec + Default, <<T as Config<I>>::RewardMechanism as RewardMechanism>::Group: TypeInfo + MaxEncodedLen + FullCodec + Default, <<T as Config<I>>::RewardMechanism as RewardMechanism>::Account: TypeInfo + MaxEncodedLen + FullCodec + Default,

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>