Class VoteProgram

Factory class for transactions to interact with the Vote program

Index

Constructors

Properties

Methods

authorize authorizeChecked authorizeCheckedWithSeed authorizeWithSeed createAccount initializeAccount safeWithdraw updateCommission updateValidatorIdentity withdraw

Constructors

constructor

new VoteProgram(): VoteProgram

Returns VoteProgram

Properties

`Static`programId

programId: PublicKey = VOTE_PROGRAM_ID

Public key that identifies the Vote program

`Static`space

space: number = 3762

Max Space for newly created vote accounts using the current Agave vote-state layout targeted by this client.

Vote Program v3.1.13 (https://docs.rs/solana-vote-program/3.1.13/solana_vote_program/) reports:

VoteStateV4::size_of() == 3762
VoteStateV3::size_of() == 3762
VoteState1_14_11::size_of() == 3731

The smaller legacy VoteState1_14_11 size does not change this constant: existing historical vote accounts may still use that older layout, but new accounts should allocate enough space for the current V3/V4 layout.

Keep this in sync with Agave vote-program sizing in https://github.com/anza-xyz/agave/blob/3134055b562e95902233be308453fffa1c4a8902/programs/vote/src/vote_state/mod.rs.

Methods

`Static`authorize

authorize(params: AuthorizeVoteParams): Transaction
Generate a transaction that authorizes a new Voter or Withdrawer on the Vote account.
Parameters
- params: AuthorizeVoteParams
Returns Transaction
- Defined in packages/web3.js/src/programs/vote.ts:714

`Static`authorizeChecked

authorizeChecked(params: AuthorizeVoteParams): Transaction
Generate a transaction that authorizes a new Voter or Withdrawer and requires the new authority to sign.
Parameters
- params: AuthorizeVoteParams
Returns Transaction
- Defined in packages/web3.js/src/programs/vote.ts:748

`Static`authorizeCheckedWithSeed

authorizeCheckedWithSeed(params: AuthorizeVoteWithSeedParams): Transaction
Generate a transaction that authorizes a new Voter or Withdrawer from a derived key and requires the new authority to sign.
Parameters
- params: AuthorizeVoteWithSeedParams
Returns Transaction
- Defined in packages/web3.js/src/programs/vote.ts:823

`Static`authorizeWithSeed

authorizeWithSeed(params: AuthorizeVoteWithSeedParams): Transaction
Generate a transaction that authorizes a new Voter or Withdrawer on the Vote account where the current Voter or Withdrawer authority is a derived key.
Parameters
- params: AuthorizeVoteWithSeedParams
Returns Transaction
- Defined in packages/web3.js/src/programs/vote.ts:778

`Static`createAccount

createAccount(params: CreateVoteAccountParams): Transaction
Generate a transaction that creates a new Vote account.
Parameters
- params: CreateVoteAccountParams
Returns Transaction
- Defined in packages/web3.js/src/programs/vote.ts:690

`Static`initializeAccount

initializeAccount(params: InitializeAccountParams): TransactionInstruction
Generate an Initialize instruction.
Parameters
- params: InitializeAccountParams
Returns TransactionInstruction
- Defined in packages/web3.js/src/programs/vote.ts:660

`Static`safeWithdraw

safeWithdraw(
    params: WithdrawFromVoteAccountParams,
    currentVoteAccountBalance: number | bigint,
    rentExemptMinimum: number | bigint,
): Transaction
Generate a transaction to withdraw safely from a Vote account.

This function was created as a safeguard for vote accounts running validators, safeWithdraw checks that the withdraw amount will not exceed the specified balance while leaving enough left to cover rent. If you wish to close the vote account by withdrawing the full amount, call the withdraw method directly.
Parameters
- params: WithdrawFromVoteAccountParams
- currentVoteAccountBalance: number | bigint
- rentExemptMinimum: number | bigint
Returns Transaction
- Defined in packages/web3.js/src/programs/vote.ts:894

`Static`updateCommission

updateCommission(params: UpdateCommissionVoteParams): Transaction
Generate a transaction to update the commission on a Vote account.
Parameters
- params: UpdateCommissionVoteParams
Returns Transaction
- Defined in packages/web3.js/src/programs/vote.ts:921

`Static`updateValidatorIdentity

updateValidatorIdentity(params: UpdateValidatorIdentityParams): Transaction
Generate a transaction to update the validator identity (node pubkey) of a Vote account.
Parameters
- params: UpdateValidatorIdentityParams
Returns Transaction
- Defined in packages/web3.js/src/programs/vote.ts:947

`Static`withdraw

withdraw(params: WithdrawFromVoteAccountParams): Transaction
Generate a transaction to withdraw from a Vote account.
Parameters
- params: WithdrawFromVoteAccountParams
Returns Transaction
- Defined in packages/web3.js/src/programs/vote.ts:865

Class VoteProgram

Index

Constructors

Properties

Methods

Constructors

constructor

Returns VoteProgram

Properties

StaticprogramId

Staticspace

Methods

Staticauthorize

Parameters

Returns Transaction

StaticauthorizeChecked

Parameters

Returns Transaction

StaticauthorizeCheckedWithSeed

Parameters

Returns Transaction

StaticauthorizeWithSeed

Parameters

Returns Transaction

StaticcreateAccount

Parameters

Returns Transaction

StaticinitializeAccount

Parameters

Returns TransactionInstruction

StaticsafeWithdraw

Parameters

Returns Transaction

StaticupdateCommission

Parameters

Returns Transaction

StaticupdateValidatorIdentity

Parameters

Returns Transaction

Staticwithdraw

Parameters

Returns Transaction

Settings

On This Page

`Static`programId

`Static`space

`Static`authorize

`Static`authorizeChecked

`Static`authorizeCheckedWithSeed

`Static`authorizeWithSeed

`Static`createAccount

`Static`initializeAccount

`Static`safeWithdraw

`Static`updateCommission

`Static`updateValidatorIdentity

`Static`withdraw