Struct EpochRewards

#[repr(C, align(16))]
pub struct EpochRewards {
    pub distribution_starting_block_height: u64,
    pub num_partitions: u64,
    pub parent_blockhash: Hash,
    pub total_points: u128,
    pub total_rewards: u64,
    pub distributed_rewards: u64,
    pub active: bool,
}

Fields

distribution_starting_block_height: u64

The starting block height of the rewards distribution in the current epoch

num_partitions: u64

Number of partitions in the rewards distribution in the current epoch, used to generate an EpochRewardsHasher

parent_blockhash: Hash

The blockhash of the parent block of the first block in the epoch, used to seed an EpochRewardsHasher

total_points: u128

The total rewards points calculated for the current epoch, where points equals the sum of (delegated stake * credits observed) for all delegations

total_rewards: u64

The total rewards calculated for the current epoch. This may be greater than the total distributed_rewards at the end of the rewards period, due to rounding and inability to deliver rewards smaller than 1 lamport.

distributed_rewards: u64

The rewards currently distributed for the current epoch, in lamports

active: bool

Whether the rewards period (including calculation and distribution) is active

Implementations

impl EpochRewards

pub fn distribute(&mut self, amount: u64)

Trait Implementations

impl Clone for EpochRewards

fn clone(&self) -> EpochRewards

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EpochRewards

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

Formats the value using the given formatter.

impl Default for EpochRewards

fn default() -> EpochRewards

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EpochRewards

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EpochRewards

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sysvar for EpochRewards

fn get() -> Result<EpochRewards, ProgramError>

Load the sysvar directly from the runtime.

fn size_of() -> usize

The size in bytes of the sysvar as serialized account data.

fn from_account_info( account_info: &AccountInfo<'_>, ) -> Result<Self, ProgramError>

Deserializes the sysvar from its AccountInfo.

fn to_account_info(&self, account_info: &mut AccountInfo<'_>) -> Option<()>

Serializes the sysvar to AccountInfo.

impl SysvarId for EpochRewards

fn id() -> Pubkey

The Pubkey of the sysvar.

fn check_id(pubkey: &Pubkey) -> bool

Returns true if the given pubkey is the program ID.

impl Eq for EpochRewards

impl StructuralPartialEq for EpochRewards