Struct StakeCache 

pub struct StakeCache(/* private fields */);

A cache of stake and validator accounts.

This wraps StakeCacheData in Arc<RwLock<...>> to allow thread-safe shared access during parallel transaction execution. The Arc allows the same data to be shared between the Bank and StakesHandle, so mutations to pending stake data by builtin programs are visible to the Bank.

Implementations

impl StakeCache

pub fn new() -> Self

Create a new empty stake cache.

pub fn with_data(data: StakeCacheData) -> Self

Create a stake cache with the given data.

pub fn from_arc(arc: Arc<RwLock<StakeCacheData>>) -> Self

Create a stake cache from an existing Arc (for sharing references).

pub fn arc_clone(&self) -> Arc<RwLock<StakeCacheData>>

Get a clone of the inner Arc for sharing.

pub fn read(&self) -> RwLockReadGuard<'_, StakeCacheData>

Acquire a read lock on the inner data.

pub fn write(&self) -> RwLockWriteGuard<'_, StakeCacheData>

Acquire a write lock on the inner data.

pub fn get_stake_account(&self, pubkey: &Pubkey) -> Option<StakeAccount>

Get a stake account by pubkey.

Note: This is a single-layer lookup on just this cache. For layered lookup across baseline/frozen/pending, use StakesHandle::get_stake_account.

pub fn get_validator_account(&self, pubkey: &Pubkey) -> Option<ValidatorAccount>

Get a validator account by pubkey.

Note: This is a single-layer lookup on just this cache. For layered lookup across baseline/frozen/pending, use StakesHandle::get_validator_account.

pub fn get_all_validator_accounts(&self) -> Vec<(Pubkey, ValidatorAccount)>

Get all validator accounts from this cache (single layer).

Note: This is a single-layer lookup. For merged view across all layers, use StakesHandle::get_all_validator_accounts.

pub fn contains_stake_account(&self, pubkey: &Pubkey) -> bool

Check if a stake account exists in this cache (single layer).

pub fn contains_validator_account(&self, pubkey: &Pubkey) -> bool

Check if a validator account exists in this cache (single layer).

pub fn insert_stake_account(&self, pubkey: Pubkey, account: StakeAccount)

Insert or update a stake account.

Also tracks the pubkey as modified for persistence.

pub fn insert_validator_account( &self, pubkey: Pubkey, account: ValidatorAccount, )

Insert or update a validator account.

Also tracks the pubkey as modified for persistence.

pub fn tombstone_stake_account(&self, pubkey: Pubkey)

Insert a tombstone for a stake account (marks as deleted).

Also tracks the pubkey as modified for persistence.

pub fn tombstone_validator_account(&self, pubkey: Pubkey)

Insert a tombstone for a validator account (marks as deleted).

Also tracks the pubkey as modified for persistence.

pub fn epoch(&self) -> Epoch

Get the epoch of this cache.

pub fn timestamp(&self) -> u64

Get the timestamp of this cache.

pub fn set_epoch(&self, epoch: Epoch)

Set the epoch of this cache.

pub fn set_timestamp(&self, timestamp: u64)

Set the timestamp of this cache.

pub fn check_and_update(&self, pubkey: &Pubkey, account: &impl ReadableAccount)

Check an account and store it in the appropriate cache if it belongs to StakeManager or ValidatorRegistry programs.

• If the account has zero kelvins, it is evicted from the cache (tombstoned)
• If the account is owned by StakeManager, it is stored in stake_accounts
• If the account is owned by ValidatorRegistry, it is stored in validator_accounts

Trait Implementations

impl Clone for StakeCache

fn clone(&self) -> StakeCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StakeCache

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

Formats the value using the given formatter.

impl Default for StakeCache

fn default() -> Self

Returns the “default value” for a type.