Enum VoteInstruction 

pub enum VoteInstruction {
    InitializeAccount(VoteInit),
    Authorize(Address, VoteAuthorize),
    Vote(Vote),
    Withdraw(u64),
    UpdateValidatorIdentity,
    UpdateCommission(u8),
    VoteSwitch(Vote, Hash),
    AuthorizeChecked(VoteAuthorize),
    UpdateVoteState(VoteStateUpdate),
    UpdateVoteStateSwitch(VoteStateUpdate, Hash),
    AuthorizeWithSeed(VoteAuthorizeWithSeedArgs),
    AuthorizeCheckedWithSeed(VoteAuthorizeCheckedWithSeedArgs),
    CompactUpdateVoteState(VoteStateUpdate),
    CompactUpdateVoteStateSwitch(VoteStateUpdate, Hash),
    TowerSync(TowerSync),
    TowerSyncSwitch(TowerSync, Hash),
    InitializeAccountV2(VoteInitV2),
    UpdateCommissionCollector(CommissionKind),
    UpdateCommissionBps {
        commission_bps: u16,
        kind: CommissionKind,
    },
    DepositDelegatorRewards {
        deposit: u64,
    },
}

Variants

InitializeAccount(VoteInit)

Initialize a vote account

Account references

0. [WRITE] Uninitialized vote account
1. [] Rent sysvar
2. [] Clock sysvar
3. [SIGNER] New validator identity (node_pubkey)

Authorize(Address, VoteAuthorize)

Authorize a key to send votes or issue a withdrawal

Account references

0. [WRITE] Vote account to be updated with the Pubkey for authorization
1. [] Clock sysvar
2. [SIGNER] Vote or withdraw authority

When SIMD-0387 is enabled, the VoteAuthorize::Voter variant is disallowed for any vote accounts whose BLS pubkey is set to Some.

Vote(Vote)

A Vote instruction with recent votes

Account references

0. [WRITE] Vote account to vote with
1. [] Slot hashes sysvar
2. [] Clock sysvar
3. [SIGNER] Vote authority

Withdraw(u64)

Withdraw some amount of funds

Account references

0. [WRITE] Vote account to withdraw from
1. [WRITE] Recipient account
2. [SIGNER] Withdraw authority

UpdateValidatorIdentity

Update the vote account’s validator identity (node_pubkey)

Account references

0. [WRITE] Vote account to be updated with the given authority public key
1. [SIGNER] New validator identity (node_pubkey)
2. [SIGNER] Withdraw authority

UpdateCommission(u8)

Update the commission for the vote account

Account references

0. [WRITE] Vote account to be updated
1. [SIGNER] Withdraw authority

VoteSwitch(Vote, Hash)

A Vote instruction with recent votes

Account references

0. [WRITE] Vote account to vote with
1. [] Slot hashes sysvar
2. [] Clock sysvar
3. [SIGNER] Vote authority

AuthorizeChecked(VoteAuthorize)

Authorize a key to send votes or issue a withdrawal

This instruction behaves like Authorize with the additional requirement that the new vote or withdraw authority must also be a signer.

Account references

0. [WRITE] Vote account to be updated with the Pubkey for authorization
1. [] Clock sysvar
2. [SIGNER] Vote or withdraw authority
3. [SIGNER] New vote or withdraw authority

When SIMD-0387 is enabled, the VoteAuthorize::Voter variant is disallowed for any vote accounts whose BLS pubkey is set to Some.

UpdateVoteState(VoteStateUpdate)

Update the onchain vote state for the signer.

Account references

0. [Write] Vote account to vote with
1. [SIGNER] Vote authority

UpdateVoteStateSwitch(VoteStateUpdate, Hash)

Update the onchain vote state for the signer along with a switching proof.

Account references

0. [Write] Vote account to vote with
1. [SIGNER] Vote authority

AuthorizeWithSeed(VoteAuthorizeWithSeedArgs)

Given that the current Voter or Withdrawer authority is a derived key, this instruction allows someone who can sign for that derived key’s base key to authorize a new Voter or Withdrawer for a vote account.

Account references

0. [Write] Vote account to be updated
1. [] Clock sysvar
2. [SIGNER] Base key of current Voter or Withdrawer authority’s derived key

When SIMD-0387 is enabled, the VoteAuthorize::Voter variant in authorization_type is disallowed for any vote accounts whose BLS pubkey is set to Some.

AuthorizeCheckedWithSeed(VoteAuthorizeCheckedWithSeedArgs)

Given that the current Voter or Withdrawer authority is a derived key, this instruction allows someone who can sign for that derived key’s base key to authorize a new Voter or Withdrawer for a vote account.

This instruction behaves like AuthorizeWithSeed with the additional requirement that the new vote or withdraw authority must also be a signer.

Account references

0. [Write] Vote account to be updated
1. [] Clock sysvar
2. [SIGNER] Base key of current Voter or Withdrawer authority’s derived key
3. [SIGNER] New vote or withdraw authority

When SIMD-0387 is enabled, the VoteAuthorize::Voter variant in authorization_type is disallowed for any vote accounts whose BLS pubkey is set to Some.

CompactUpdateVoteState(VoteStateUpdate)

Update the onchain vote state for the signer.

Account references

0. [Write] Vote account to vote with
1. [SIGNER] Vote authority

CompactUpdateVoteStateSwitch(VoteStateUpdate, Hash)

Update the onchain vote state for the signer along with a switching proof.

Account references

0. [Write] Vote account to vote with
1. [SIGNER] Vote authority

TowerSync(TowerSync)

Sync the onchain vote state with local tower

Account references

0. [Write] Vote account to vote with
1. [SIGNER] Vote authority

TowerSyncSwitch(TowerSync, Hash)

Sync the onchain vote state with local tower along with a switching proof

Account references

0. [Write] Vote account to vote with
1. [SIGNER] Vote authority

InitializeAccountV2(VoteInitV2)

Initialize a vote account with all vote state v4 fields, including BLS public key and collector accounts.

The vote program performs BLS proof-of-possession verification on the submitted BLS public key (per SIMD-0387). For each collector account (indices 2 and 3), the program performs the same validation as UpdateCommissionCollector (per SIMD-0232): if the collector is not the vote account itself, it must be system-program owned, rent-exempt, and writable (not a reserved account).

Account references

0. [WRITE] Uninitialized vote account
1. [SIGNER] New validator identity (node_pubkey)
2. [WRITE] Inflation rewards collector
3. [WRITE] Block revenue collector

UpdateCommissionCollector(CommissionKind)

Update the commission collector for the vote account

Account references

0. [WRITE] Vote account to be updated with the new collector public key
1. [WRITE] New collector account. Must be set to the vote account or a system program owned account. Must be writable to ensure the account is not reserved.
2. [SIGNER] Vote account withdraw authority

UpdateCommissionBps

Update the commission rate in basis points for the specified commission rate kind in a vote account.

Account references

0. [WRITE] Vote account to be updated with the new commission
1. [SIGNER] Vote account withdraw authority

Fields

commission_bps: u16

kind: CommissionKind

DepositDelegatorRewards

Deposit lamports for distribution to stake delegators

Account references

0. [WRITE] Vote account to be updated with the deposit
1. [SIGNER, WRITE] Source account for deposit funds

Fields

deposit: u64

Implementations

impl VoteInstruction

pub fn is_simple_vote(&self) -> bool

pub fn is_single_vote_state_update(&self) -> bool

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

Only to be used on vote instructions (guard with is_simple_vote), panics otherwise

pub fn hash(&self) -> Hash

Only to be used on vote instructions (guard with is_simple_vote), panics otherwise

pub fn timestamp(&self) -> Option<i64>

Only to be used on vote instructions (guard with is_simple_vote), panics otherwise

Trait Implementations

impl Clone for VoteInstruction

fn clone(&self) -> VoteInstruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VoteInstruction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VoteInstruction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for VoteInstruction

impl PartialEq for VoteInstruction

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for VoteInstruction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StableAbi for VoteInstruction

fn random_with_context( rng: &mut (impl RngCore + ?Sized), _ctx: (), ) -> VoteInstruction

fn random(rng: &mut (impl RngCore + ?Sized)) -> Self

where Ctx: Default,

impl StructuralPartialEq for VoteInstruction