Struct solana_vote_program::vote_state::VoteState

source · [−]

pub struct VoteState {
    pub node_pubkey: Pubkey,
    pub authorized_withdrawer: Pubkey,
    pub commission: u8,
    pub votes: VecDeque<Lockout>,
    pub root_slot: Option<Slot>,
    pub last_timestamp: BlockTimestamp,
    /* private fields */
}

Fields

node_pubkey: Pubkey

the node that votes in this account

authorized_withdrawer: Pubkey

the signer for withdrawals

commission: u8

percentage (0-100) that represents what part of a rewards payout should be given to this VoteAccount

votes: VecDeque<Lockout>root_slot: Option<Slot>last_timestamp: BlockTimestamp

most recent timestamp submitted with a vote

Implementations

source

pub fn to<T: WritableAccount>(
versioned: &VoteStateVersions,
account: &mut T
) -> Option<()>

source

pub fn deserialize(input: &[u8]) -> Result<Self, InstructionError>

source

pub fn serialize(
versioned: &VoteStateVersions,
output: &mut [u8]
) -> Result<(), InstructionError>

source

pub fn credits_from<T: ReadableAccount>(account: &T) -> Option<u64>

source

pub fn commission_split(&self, on: u64) -> (u64, u64, bool)

returns commission split as (voter_portion, staker_portion, was_split) tuple

if commission calculation is 100% one way or other, indicate with false for was_split

source

pub fn contains_slot(&self, candidate_slot: Slot) -> bool

Returns if the vote state contains a slot candidate_slot

source

pub fn process_new_vote_state(
 &mut self,
 new_state: VecDeque<Lockout>,
 new_root: Option<Slot>,
 timestamp: Option<i64>,
 epoch: Epoch
) -> Result<(), VoteError>

source

pub fn process_vote(
 &mut self,
 vote: &Vote,
 slot_hashes: &[SlotHash],
 epoch: Epoch,
 feature_set: Option<&FeatureSet>
) -> Result<(), VoteError>

source

pub fn process_next_vote_slot(&mut self, next_vote_slot: Slot, epoch: Epoch)

source

pub fn increment_credits(&mut self, epoch: Epoch)

increment credits, record credits for last epoch if new epoch

source

pub fn process_vote_unchecked(&mut self, vote: Vote)

“unchecked” functions used by tests and Tower

source

pub fn process_slot_vote_unchecked(&mut self, slot: Slot)

source

pub fn nth_recent_vote(&self, position: usize) -> Option<&Lockout>

source

pub fn last_lockout(&self) -> Option<&Lockout>

source

pub fn last_voted_slot(&self) -> Option<Slot>

source

pub fn tower(&self) -> Vec<Slot>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

source

pub fn credits(&self) -> u64

Number of “credits” owed to this account from the mining pool. Submit this VoteState to the Rewards program to trade credits for lamports.

source

pub fn epoch_credits(&self) -> &Vec<(Epoch, u64, u64)>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

Number of “credits” owed to this account from the mining pool on a per-epoch basis, starting from credits observed. Each tuple of (Epoch, u64, u64) is read as (epoch, credits, prev_credits), where credits for each epoch is credits - prev_credits; while redundant this makes calculating rewards over partial epochs nice and simple

source