Struct pallet_dapp_staking::StakeAmount

pub struct StakeAmount { /* private fields */ }

Describes stake amount in an particular era/period.

Implementations

impl StakeAmount

pub fn is_empty(&self) -> bool

true if nothing is staked, false otherwise

pub fn total(&self) -> Balance

Total amount staked in both subperiods.

pub fn for_type(&self, subperiod: Subperiod) -> Balance

Amount staked for the specified subperiod.

pub fn add(&mut self, amount: Balance, subperiod: Subperiod)

Stake the specified amount for the specified subperiod.

pub fn subtract_stake(&mut self, amount: &StakeAmount)

Subtract the specified StakeAmount, updating both subperiods.

pub fn subtract(&mut self, amount: Balance)

Unstake the specified amount.

Attempt to subtract from Build&Earn subperiod amount is done first. Any rollover is subtracted from the Voting subperiod amount.

pub fn saturating_difference(&self, other: &StakeAmount) -> StakeAmount

Returns a new StakeAmount representing the difference between self and other, without modifying era or period.

pub fn convert_bonus_into_regular_stake(&mut self)

Converts all Voting stake into BuildAndEarn, effectively forfeiting bonus eligibility.

This is used when a user loses bonus eligibility, ensuring that previously staked voting amounts are not lost or mixed with destination ‘voting amount’ during a move operation, but instead reallocated to BuildAndEarn.

Trait Implementations

impl Clone for StakeAmount

fn clone(&self) -> StakeAmount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StakeAmount

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

Formats the value using the given formatter.

impl Decode for StakeAmount

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 Default for StakeAmount

fn default() -> StakeAmount

Returns the “default value” for a type.

impl Encode for StakeAmount

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 MaxEncodedLen for StakeAmount

fn max_encoded_len() -> usize

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

impl PartialEq for StakeAmount

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

type Identity = StakeAmount

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for StakeAmount

impl EncodeLike for StakeAmount

impl Eq for StakeAmount

impl StructuralPartialEq for StakeAmount