Struct RewardPool

pub struct RewardPool<T: Config> {
    pub last_recorded_reward_counter: T::RewardCounter,
    pub last_recorded_total_payouts: BalanceOf<T>,
    pub total_rewards_claimed: BalanceOf<T>,
    pub total_commission_pending: BalanceOf<T>,
    pub total_commission_claimed: BalanceOf<T>,
}

A reward pool.

A reward pool is not so much a pool anymore, since it does not contain any shares or points. Rather, simply to fit nicely next to bonded pool and unbonding pools in terms of terminology. In reality, a reward pool is just a container for a few pool-dependent data related to the rewards.

Fields

last_recorded_reward_counter: T::RewardCounter

The last recorded value of the reward counter.

This is updated ONLY when the points in the bonded pool change, which means join, bond_extra and unbond, all of which is done through update_recorded.

last_recorded_total_payouts: BalanceOf<T>

The last recorded total payouts of the reward pool.

Payouts is essentially income of the pool.

Update criteria is same as that of last_recorded_reward_counter.

total_rewards_claimed: BalanceOf<T>

Total amount that this pool has paid out so far to the members.

total_commission_pending: BalanceOf<T>

The amount of commission pending to be claimed.

total_commission_claimed: BalanceOf<T>

The amount of commission that has been claimed.

Trait Implementations

impl<T: Config> Clone for RewardPool<T>

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> Debug for RewardPool<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for RewardPool<T>

where T::RewardCounter: Decode, BalanceOf<T>: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Default for RewardPool<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Config> Encode for RewardPool<T>

where T::RewardCounter: Encode, BalanceOf<T>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T> MaxEncodedLen for RewardPool<T>

where T: Config,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T: Config> PartialEq for RewardPool<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> TypeInfo for RewardPool<T>

where T::RewardCounter: TypeInfo + 'static, BalanceOf<T>: TypeInfo + 'static, T: Config + 'static,

type Identity = RewardPool<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> EncodeLike for RewardPool<T>

where T::RewardCounter: Encode, BalanceOf<T>: Encode,

impl<T: Config> Eq for RewardPool<T>