Struct solana_stake_program::stake_state::Stake

pub struct Stake {
    pub delegation: Delegation,
    pub credits_observed: u64,
}

Fields

delegation: Delegation

credits_observed: u64

credits observed is credits from vote account state when delegated or redeemed

Implementations

impl Stake

pub fn stake(
    &self,
    epoch: Epoch,
    history: Option<&StakeHistory>,
    fix_stake_deactivate: bool
) -> u64

pub fn redeem_rewards(
    &mut self,
    point_value: &PointValue,
    vote_state: &VoteState,
    stake_history: Option<&StakeHistory>,
    inflation_point_calc_tracer: &mut Option<impl FnMut(&InflationPointCalculationEvent)>,
    fix_stake_deactivate: bool
) -> Option<(u64, u64)>

pub fn calculate_points(
    &self,
    vote_state: &VoteState,
    stake_history: Option<&StakeHistory>,
    inflation_point_calc_tracer: &mut Option<impl FnMut(&InflationPointCalculationEvent)>,
    fix_stake_deactivate: bool
) -> u128

pub fn calculate_rewards(
    &self,
    point_value: &PointValue,
    vote_state: &VoteState,
    stake_history: Option<&StakeHistory>,
    inflation_point_calc_tracer: &mut Option<impl FnMut(&InflationPointCalculationEvent)>,
    fix_stake_deactivate: bool
) -> Option<(u64, u64, u64)>

for a given stake and vote_state, calculate what distributions and what updates should be made returns a tuple in the case of a payout of:

• staker_rewards to be distributed
• voter_rewards to be distributed
• new value for credits_observed in the stake returns None if there’s no payout or if any deserved payout is < 1 lamport

Trait Implementations

impl Clone for Stake

fn clone(&self) -> Stake

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Stake

impl Debug for Stake

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

Formats the value using the given formatter.

impl Default for Stake

fn default() -> Stake

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Stake

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Stake> for Stake

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Stake

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Stake