Class StakeProgram

Factory class for transactions to interact with the Stake program

Properties

`Static`programId

programId: PublicKey = STAKE_PROGRAM_ID

Public key that identifies the Stake program

`Static`space

space: number = 200

Max space of a Stake account

This is generated from the solana-stake-program StakeState struct as StakeStateV2::size_of(): https://docs.rs/solana-stake-program/latest/solana_stake_program/stake_state/enum.StakeStateV2.html

Methods

`Static`authorize

authorize(params: AuthorizeStakeParams): Transaction
Generate a Transaction that authorizes a new PublicKey as Staker or Withdrawer on the Stake account.
Parameters
- params: AuthorizeStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1203

`Static`authorizeChecked

authorizeChecked(params: AuthorizeStakeParams): Transaction
Generate a Transaction that authorizes a new signer as Staker or Withdrawer on the Stake account.
Parameters
- params: AuthorizeStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1231

`Static`authorizeCheckedWithSeed

authorizeCheckedWithSeed(params: AuthorizeWithSeedStakeParams): Transaction
Generate a Transaction that authorizes a new signer as Staker or Withdrawer on the Stake account using a derived key.
Parameters
- params: AuthorizeWithSeedStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1292

`Static`authorizeWithSeed

authorizeWithSeed(params: AuthorizeWithSeedStakeParams): Transaction
Generate a Transaction that authorizes a new PublicKey as Staker or Withdrawer on the Stake account.
Parameters
- params: AuthorizeWithSeedStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1260

`Static`createAccount

createAccount(params: CreateStakeAccountParams): Transaction
Generate a Transaction that creates a new Stake account
Parameters
- params: CreateStakeAccountParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1161

`Static`createAccountWithSeed

createAccountWithSeed(params: CreateStakeAccountWithSeedParams): Transaction
Generate a Transaction that creates a new Stake account at an address generated with from, a seed, and the Stake programId
Parameters
- params: CreateStakeAccountWithSeedParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1138

`Static`deactivate

deactivate(params: DeactivateStakeParams): Transaction
Generate a Transaction that deactivates Stake tokens.
Parameters
- params: DeactivateStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1506

`Static`deactivateDelinquent

deactivateDelinquent(params: DeactivateDelinquentStakeParams): Transaction
Generate a Transaction that deactivates stake delegated to a delinquent vote account.
Parameters
- params: DeactivateDelinquentStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1523

`Static`delegate

delegate(params: DelegateStakeParams): Transaction
Generate a Transaction that delegates Stake tokens to a validator Vote PublicKey. This transaction can also be used to redelegate Stake to a new validator Vote PublicKey.
Parameters
- params: DelegateStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1182

`Static`getMinimumDelegation

getMinimumDelegation(): TransactionInstruction
Generate a get-minimum-delegation instruction.

Returns TransactionInstruction
- Defined in packages/web3.js/src/programs/stake.ts:1476

`Static`initialize

initialize(params: InitializeStakeParams): TransactionInstruction
Generate an Initialize instruction to add to a Stake Create transaction
Parameters
- params: InitializeStakeParams
Returns TransactionInstruction
- Defined in packages/web3.js/src/programs/stake.ts:1104

`Static`initializeChecked

initializeChecked(params: InitializeCheckedStakeParams): TransactionInstruction
Generate an InitializeChecked instruction.
Parameters
- params: InitializeCheckedStakeParams
Returns TransactionInstruction
- Defined in packages/web3.js/src/programs/stake.ts:1120

`Static`merge

merge(params: MergeStakeParams): Transaction
Generate a Transaction that merges Stake accounts.
Parameters
- params: MergeStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1457

`Static`moveLamports

moveLamports(params: MoveLamportsParams): Transaction
Generate a Transaction that moves lamports between compatible stake accounts.
Parameters
- params: MoveLamportsParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1565

`Static`moveStake

moveStake(params: MoveStakeParams): Transaction
Generate a Transaction that moves active stake between stake accounts.
Parameters
- params: MoveStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1542

`Static`setLockup

setLockup(params: SetLockupStakeParams): Transaction
Generate a Transaction that updates a stake account lockup.
Parameters
- params: SetLockupStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1326

`Static`setLockupChecked

setLockupChecked(params: SetLockupCheckedStakeParams): Transaction
Generate a Transaction that updates a stake account lockup using checked authorities.
Parameters
- params: SetLockupCheckedStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1346

`Static`split

split(params: SplitStakeParams, rentExemptReserve: number): Transaction
Generate a Transaction that splits Stake tokens into another stake account
Parameters
- params: SplitStakeParams
- rentExemptReserve: number
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1390

`Static`splitWithSeed

splitWithSeed(
params: SplitStakeWithSeedParams,
rentExemptReserve?: number,
): Transaction
Generate a Transaction that splits Stake tokens into another account derived from a base public key and seed
Parameters
- params: SplitStakeWithSeedParams
- OptionalrentExemptReserve: number
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1412

`Static`withdraw

withdraw(params: WithdrawStakeParams): Transaction
Generate a Transaction that withdraws deactivated Stake tokens.
Parameters
- params: WithdrawStakeParams
Returns Transaction
- Defined in packages/web3.js/src/programs/stake.ts:1483