Class StakeProgram

Factory class for transactions to interact with the Stake program

Index

Properties

programId space

Methods

authorize authorizeWithSeed createAccount createAccountWithSeed deactivate delegate initialize merge split splitWithSeed withdraw

Properties

`Static`programId

programId: PublicKey = ...

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 src/programs/stake.ts:714

`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 src/programs/stake.ts:752

`Static`createAccount

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

`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 src/programs/stake.ts:642

`Static`deactivate

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

`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 src/programs/stake.ts:686

`Static`initialize

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

`Static`merge

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

`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 src/programs/stake.ts:811

`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 src/programs/stake.ts:833

`Static`withdraw

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