Class StakeProgram

Factory class for transactions to interact with the Stake program

Hierarchy

StakeProgram

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StakeProgram(): StakeProgram

Returns StakeProgram

Properties

Static programId

programId: PublicKey

Public key that identifies the Stake program

Static space

space: number

Max space of a Stake account

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

Methods

Static authorize

authorize(params: AuthorizeStakeParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:985
Generate a Transaction that authorizes a new PublicKey as Staker or Withdrawer on the Stake account.

Parameters
- params: AuthorizeStakeParams
Returns Transaction

Static authorizeWithSeed

authorizeWithSeed(params: AuthorizeWithSeedStakeParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:990
Generate a Transaction that authorizes a new PublicKey as Staker or Withdrawer on the Stake account.

Parameters
- params: AuthorizeWithSeedStakeParams
Returns Transaction

Static createAccount

createAccount(params: CreateStakeAccountParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:974
Generate a Transaction that creates a new Stake account

Parameters
- params: CreateStakeAccountParams
Returns Transaction

Static createAccountWithSeed

createAccountWithSeed(params: CreateStakeAccountWithSeedParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:968
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

Static deactivate

deactivate(params: DeactivateStakeParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:1011
Generate a Transaction that deactivates Stake tokens.

Parameters
- params: DeactivateStakeParams
Returns Transaction

Static delegate

delegate(params: DelegateStakeParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:980
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

Static initialize

initialize(params: InitializeStakeParams): TransactionInstruction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:963
Generate an Initialize instruction to add to a Stake Create transaction

Parameters
- params: InitializeStakeParams
Returns TransactionInstruction

Static merge

merge(params: MergeStakeParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:1003
Generate a Transaction that merges Stake accounts.

Parameters
- params: MergeStakeParams
Returns Transaction

Static split

split(params: SplitStakeParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:994
Generate a Transaction that splits Stake tokens into another stake account

Parameters
- params: SplitStakeParams
Returns Transaction

Static splitWithSeed

splitWithSeed(params: SplitStakeWithSeedParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:999
Generate a Transaction that splits Stake tokens into another account derived from a base public key and seed

Parameters
- params: SplitStakeWithSeedParams
Returns Transaction

Static withdraw

withdraw(params: WithdrawStakeParams): Transaction

- Defined in node_modules/@solana/web3.js/lib/index.d.ts:1007
Generate a Transaction that withdraws deactivated Stake tokens.

Parameters
- params: WithdrawStakeParams
Returns Transaction

Generated using TypeDoc