Struct pallet_nomination_pools::Commission

pub struct Commission<T: Config> {
    pub current: Option<(Perbill, T::AccountId)>,
    pub max: Option<Perbill>,
    pub change_rate: Option<CommissionChangeRate<BlockNumberFor<T>>>,
    pub throttle_from: Option<BlockNumberFor<T>>,
    pub claim_permission: Option<CommissionClaimPermission<T::AccountId>>,
}

Pool commission.

The pool root can set commission configuration after pool creation. By default, all commission values are None. Pool root can also set max and change_rate configurations before setting an initial current commission.

current is a tuple of the commission percentage and payee of commission. throttle_from keeps track of which block current was last updated. A max commission value can only be decreased after the initial value is set, to prevent commission from repeatedly increasing.

An optional commission change_rate allows the pool to set strict limits to how much commission can change in each update, and how often updates can take place.

Fields

current: Option<(Perbill, T::AccountId)>

Optional commission rate of the pool along with the account commission is paid to.

max: Option<Perbill>

Optional maximum commission that can be set by the pool root. Once set, this value can only be updated to a decreased value.

change_rate: Option<CommissionChangeRate<BlockNumberFor<T>>>

Optional configuration around how often commission can be updated, and when the last commission update took place.

throttle_from: Option<BlockNumberFor<T>>

The block from where throttling should be checked from. This value will be updated on all commission updates and when setting an initial change_rate.

claim_permission: Option<CommissionClaimPermission<T::AccountId>>

Trait Implementations

impl<T: Clone + Config> Clone for Commission<T>

where T::AccountId: Clone,

fn clone(&self) -> Commission<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Config> Debug for Commission<T>

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

Formats the value using the given formatter.

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

where Option<(Perbill, T::AccountId)>: Decode, Option<CommissionChangeRate<BlockNumberFor<T>>>: Decode, Option<BlockNumberFor<T>>: Decode, Option<CommissionClaimPermission<T::AccountId>>: 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 Commission<T>

fn default() -> Self

Returns the “default value” for a type.

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

where Option<(Perbill, T::AccountId)>: Encode, Option<CommissionChangeRate<BlockNumberFor<T>>>: Encode, Option<BlockNumberFor<T>>: Encode, Option<CommissionClaimPermission<T::AccountId>>: 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 Commission<T>

where T: Config,

fn max_encoded_len() -> usize

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

impl<T: PartialEq + Config> PartialEq for Commission<T>

where T::AccountId: PartialEq,

fn eq(&self, other: &Commission<T>) -> 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> TypeInfo for Commission<T>

where Option<(Perbill, T::AccountId)>: TypeInfo + 'static, Option<CommissionChangeRate<BlockNumberFor<T>>>: TypeInfo + 'static, Option<BlockNumberFor<T>>: TypeInfo + 'static, Option<CommissionClaimPermission<T::AccountId>>: TypeInfo + 'static, T: Config + 'static,

type Identity = Commission<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Copy + Config> Copy for Commission<T>

where T::AccountId: Copy,

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

where Option<(Perbill, T::AccountId)>: Encode, Option<CommissionChangeRate<BlockNumberFor<T>>>: Encode, Option<BlockNumberFor<T>>: Encode, Option<CommissionClaimPermission<T::AccountId>>: Encode,

impl<T: Config> StructuralPartialEq for Commission<T>