Struct solana_vote_api::vote_state::VoteState

pub struct VoteState {
    pub node_pubkey: Pubkey,
    pub authorized_voter: Pubkey,
    pub authorized_withdrawer: Pubkey,
    pub commission: u8,
    pub votes: VecDeque<Lockout>,
    pub root_slot: Option<u64>,
    // some fields omitted
}

Fields

node_pubkey: Pubkey

the node that votes in this account

authorized_voter: Pubkey

the signer for vote transactions

authorized_withdrawer: Pubkey

the signer for withdrawals

commission: u8

fraction of std::u8::MAX that represents what part of a rewards payout should be given to this VoteAccount

votes: VecDeque<Lockout>

root_slot: Option<u64>

Methods

impl VoteState

pub fn new(vote_init: &VoteInit) -> Self

pub fn size_of() -> usize

pub fn from(account: &Account) -> Option<VoteState>

pub fn to(&self, account: &mut Account) -> Option<()>

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

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

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

pub fn commission_split(&self, on: f64) -> (f64, f64, 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

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

pub fn process_slot(&mut self, slot: Slot, epoch: Epoch)

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

increment credits, record credits for last epoch if new epoch

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

"unchecked" functions used by tests and Tower

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

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

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.

pub fn epoch_credits(&self) -> impl Iterator<Item = &(Epoch, u64, u64)>

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

Trait Implementations

impl Clone for VoteState

fn clone(&self) -> VoteState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for VoteState

fn default() -> VoteState

Returns the "default value" for a type.

impl Eq for VoteState

impl PartialEq<VoteState> for VoteState

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for VoteState

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

Formats the value using the given formatter.

impl StructuralPartialEq for VoteState

impl StructuralEq for VoteState

impl Serialize for VoteState

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for VoteState

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

Deserialize this value from the given Serde deserializer.