solana_program/
epoch_stake.rs

1//! API for retrieving epoch stake information.
2//!
3//! On-chain programs can use this API to retrieve the total stake for the
4//! current epoch or the stake for a specific vote account using the
5//! `sol_get_epoch_stake` syscall.
6
7use crate::pubkey::Pubkey;
8
9fn get_epoch_stake(var_addr: *const u8) -> u64 {
10    #[cfg(target_os = "solana")]
11    let result = unsafe { crate::syscalls::sol_get_epoch_stake(var_addr) };
12
13    #[cfg(not(target_os = "solana"))]
14    let result = crate::program_stubs::sol_get_epoch_stake(var_addr);
15
16    result
17}
18
19/// Get the current epoch's total stake.
20pub fn get_epoch_total_stake() -> u64 {
21    get_epoch_stake(std::ptr::null::<Pubkey>() as *const u8)
22}
23
24/// Get the current epoch stake for a given vote address.
25///
26/// If the provided vote address corresponds to an account that is not a vote
27/// account or does not exist, returns `0` for active stake.
28pub fn get_epoch_stake_for_vote_account(vote_address: &Pubkey) -> u64 {
29    get_epoch_stake(vote_address as *const _ as *const u8)
30}