Struct pallet_dapp_staking::ContractStakeAmount

pub struct ContractStakeAmount { /* private fields */ }

Composite type that holds information about how much was staked on a contract in up to two distinct eras.

This is needed since ‘stake’ operation only makes the staked amount valid from the next era. In a situation when stake is called in era N, the staked amount is valid from era N+1, hence the need for ‘future’ entry.

NOTE: The ‘future’ entry term is only valid in the era when stake is called. It’s possible contract stake isn’t changed in consecutive eras, so we might end up in a situation where era is N + 10 but staked entry refers to era N and staked_future entry refers to era N+1. This is still valid since these values are expected to be updated lazily.

Implementations

impl ContractStakeAmount

pub fn is_empty(&self) -> bool

true if series is empty, false otherwise.

pub fn latest_stake_period(&self) -> Option<PeriodNumber>

Latest period for which stake entry exists.

pub fn latest_stake_era(&self) -> Option<EraNumber>

Latest era for which stake entry exists.

pub fn get(&self, era: EraNumber, period: PeriodNumber) -> Option<StakeAmount>

Returns the StakeAmount type for the specified era & period, if it exists.

pub fn total_staked_amount(&self, active_period: PeriodNumber) -> Balance

Total staked amount on the contract, in the active period.

pub fn staked_amount( &self, active_period: PeriodNumber, subperiod: Subperiod, ) -> Balance

Staked amount on the contract, for specified subperiod, in the active period.

pub fn stake( &mut self, amount: StakeAmount, current_era: EraNumber, period_number: PeriodNumber, )

Stake the specified amount on the contract, for the specified subperiod and era.

pub fn unstake( &mut self, stake_amount_entries: &Vec<StakeAmount>, period_info: PeriodInfo, current_era: EraNumber, )

Unstake the specified StakeAmount entries from the contract.

Trait Implementations

impl Clone for ContractStakeAmount

fn clone(&self) -> ContractStakeAmount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContractStakeAmount

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

Formats the value using the given formatter.

impl Decode for ContractStakeAmount

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 ContractStakeAmount

fn default() -> ContractStakeAmount

Returns the “default value” for a type.

impl Encode for ContractStakeAmount

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 ContractStakeAmount

fn max_encoded_len() -> usize

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

impl PartialEq for ContractStakeAmount

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

type Identity = ContractStakeAmount

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl EncodeLike for ContractStakeAmount

impl Eq for ContractStakeAmount

impl StructuralPartialEq for ContractStakeAmount