Skip to main content

EpochRewards

Struct EpochRewards 

Source
pub struct EpochRewards {
    pub distribution_starting_block_height: u64,
    pub num_partitions: u64,
    pub parent_blockhash: [u8; 32],
    pub total_points: u128,
    pub total_rewards: u64,
    pub distributed_rewards: u64,
    pub active: bool,
}
Expand description

EpochRewards sysvar data (SIMD-0118).

Surfaces the partitioned-rewards distribution state for the current epoch: how many lamports are being paid out, how far distribution has progressed, and whether the rewards period is still active. Staking and airdrop programs read it to gate behaviour during the distribution window.

Fields§

§distribution_starting_block_height: u64

First block height at which rewards distribution begins this epoch.

§num_partitions: u64

Number of partitions the distribution is split across.

§parent_blockhash: [u8; 32]

Blockhash of the parent of the epoch’s first block.

§total_points: u128

Total rewards points calculated for the epoch.

§total_rewards: u64

Total rewards (lamports) calculated for the epoch.

§distributed_rewards: u64

Rewards (lamports) distributed so far this epoch.

§active: bool

Whether the rewards period (calculation + distribution) is active.

Trait Implementations§

Source§

impl Clone for EpochRewards

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EpochRewards

Source§

impl Debug for EpochRewards

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EpochRewards

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for EpochRewards

Source§

impl PartialEq for EpochRewards

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EpochRewards

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.