EverstakeSplStakePool | @unstake-it/sol-ag

Hierarchy

SplStakePool
- EverstakeSplStakePool

Constructors

constructor

new EverstakeSplStakePool(stakePoolAddr: PublicKey, stakePoolAccountInfo: AccountInfo<Buffer>, __namedParameters: SplStakePoolCtorParams): EverstakeSplStakePool

Inherited from SplStakePool.constructor
- Defined in src/stakePools/splStakePool/splStakePool.ts:96
Parameters
- stakePoolAddr: PublicKey
- stakePoolAccountInfo: AccountInfo<Buffer>
- __namedParameters: SplStakePoolCtorParams
Returns EverstakeSplStakePool

Properties

_depositAuth

_depositAuth: PublicKey

label

mustUseKeypairForSplitStake

mustUseKeypairForSplitStake: boolean = false

outputToken

outputToken: PublicKey

programId

programId: PublicKey

stakePool

stakePool: null | EverstakeStakePoolStruct

stakePoolAddr

stakePoolAddr: PublicKey

validatorList

validatorList: null | ValidatorList

validatorListAddr

validatorListAddr: PublicKey

withdrawAuth

withdrawAuth: PublicKey

withdrawStakeToken

withdrawStakeToken: PublicKey

Static DEFAULT_VALIDATOR_YIELD_PER_EPOCH_NUMERATOR

DEFAULT_VALIDATOR_YIELD_PER_EPOCH_NUMERATOR: number = 60_144

Static MINIMUM_DEPOSIT_LAMPORTS

MINIMUM_DEPOSIT_LAMPORTS: number = 1_000_000

Static VALIDATOR_YIELD_PER_EPOCH_DENOMINATOR

VALIDATOR_YIELD_PER_EPOCH_DENOMINATOR: number = 100_000_000

Accessors

depositAuth

get depositAuth(): PublicKey

Inherited from SplStakePool.depositAuth
- Defined in src/stakePools/splStakePool/splStakePool.ts:92
Returns PublicKey

Methods

calcWithdrawalReceipt

calcWithdrawalReceipt(withdrawStakeTokens: bigint): { lamportsReceived: bigint; withdrawStakeTokensFeePaid: bigint }

Overrides SplStakePool.calcWithdrawalReceipt
- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:268
Assumes this.stakePool already fetched. Returns lamportsReceived and stakePoolToken fee paid for a given stakePoolToken withdrawal

Parameters
- withdrawStakeTokens: bigint
Returns { lamportsReceived: bigint; withdrawStakeTokensFeePaid: bigint }
- lamportsReceived: bigint
- withdrawStakeTokensFeePaid: bigint

Private calculateDepositAmountByRewardSimulation

calculateDepositAmountByRewardSimulation(totalDepositLamports: JSBI): JSBI

- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:349
See: https://github.com/everstake/solana-program-library/blob/22534fe3885e698598e92b2fe20da3a8adbfc5ff/stake-pool/program/src/state.rs#L558 Assumes this.stakePool already fetched

Parameters
- totalDepositLamports: JSBI
Returns JSBI

canAcceptStakeAccount

canAcceptStakeAccount(params: CanAcceptStakeAccountParams): boolean

Overrides SplStakePool.canAcceptStakeAccount
- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:230
SPL stake pools only accept:
- active stake accounts (can cancel deactivation in setup)
- staked to validators in the validator list
- no lockup
Parameters
- params: CanAcceptStakeAccountParams
Returns boolean

Private convertAmountOfLamportsToAmountOfPoolTokens

convertAmountOfLamportsToAmountOfPoolTokens(lamports: JSBI): JSBI

- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:375
See: https://github.com/everstake/solana-program-library/blob/22534fe3885e698598e92b2fe20da3a8adbfc5ff/stake-pool/program/src/state.rs#L186 Assumes this.stakePool already fetched

Parameters
- lamports: JSBI
Returns JSBI

Private convertAmountOfPoolTokensToAmountOfLamports

convertAmountOfPoolTokensToAmountOfLamports(poolTokens: bigint): bigint

- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:395
See: https://github.com/everstake/solana-program-library/blob/22534fe3885e698598e92b2fe20da3a8adbfc5ff/stake-pool/program/src/state.rs#L186 Assumes this.stakePool already fetched

Parameters
- poolTokens: bigint
Returns bigint

createCleanupInstruction

createCleanupInstruction(): TransactionInstruction[]

Inherited from SplStakePool.createCleanupInstruction
- Defined in src/stakePools/splStakePool/splStakePool.ts:245
Returns TransactionInstruction[]

createSetupInstructions

createSetupInstructions(__namedParameters: CreateSetupInstructionsParams): TransactionInstruction[]

Inherited from SplStakePool.createSetupInstructions
- Defined in src/stakePools/splStakePool/splStakePool.ts:177
Commmon setup instructions:
- un-deactivate stake account
Common setup instructions that are not covered:
- split stake. Why?
  - This involves generation and returning of a Keypair and Signer. Simpler to just handle this outside of this interface
- creating outputToken ATA if user does not have it yet. Why?
  - This involves a RPC call to check if the user's ATA exists.
Parameters
- __namedParameters: CreateSetupInstructionsParams
Returns TransactionInstruction[]

createSwapInstructions

createSwapInstructions(args: CreateSwapInstructionsParams): TransactionInstruction[]

Overrides SplStakePool.createSwapInstructions
- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:238
Create the instructions for swapping the given stake account to outputToken assuming setup is done Only accepts entire stake accounts.

Parameters
- args: CreateSwapInstructionsParams
Returns TransactionInstruction[]

createWithdrawStakeInstructions

createWithdrawStakeInstructions(args: CreateWithdrawStakeInstructionsParams): TransactionInstruction[]

Overrides SplStakePool.createWithdrawStakeInstructions
- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:246
Parameters
- args: CreateWithdrawStakeInstructionsParams
Returns TransactionInstruction[]

findTransientStakeAccount

findTransientStakeAccount(validatorStakeInfo: ValidatorStakeInfo): PublicKey

Overrides SplStakePool.findTransientStakeAccount
- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:254
Parameters
- validatorStakeInfo: ValidatorStakeInfo
Returns PublicKey

Protected findValidatorStakeAccount

findValidatorStakeAccount(stakeAccountVotePubkey: PublicKey): PublicKey

Inherited from SplStakePool.findValidatorStakeAccount
- Defined in src/stakePools/splStakePool/splStakePool.ts:544
Parameters
- stakeAccountVotePubkey: PublicKey
Returns PublicKey

getAccountsForUpdate

getAccountsForUpdate(): PublicKey[]

Inherited from SplStakePool.getAccountsForUpdate
- Defined in src/stakePools/splStakePool/splStakePool.ts:249
Returns PublicKey[]

getQuote

getQuote(__namedParameters: StakePoolQuoteParams): StakeQuote

Overrides SplStakePool.getQuote
- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:297
Assumes that the passed stake account has passed this.canAcceptStakeAccount()

Parameters
- __namedParameters: StakePoolQuoteParams
Returns StakeQuote

getWithdrawStakeQuote

getWithdrawStakeQuote(__namedParameters: WithdrawStakeQuoteParams): WithdrawStakeQuote

Inherited from SplStakePool.getWithdrawStakeQuote
- Defined in src/stakePools/splStakePool/splStakePool.ts:370
Only handles withdrawing max 1 stake account

Parameters
- __namedParameters: WithdrawStakeQuoteParams
Returns WithdrawStakeQuote

Protected isUpdated

isUpdated(currentEpoch: number): boolean

Inherited from SplStakePool.isUpdated
- Defined in src/stakePools/splStakePool/splStakePool.ts:571
Assumes this.stakePool is fetched

Parameters
- currentEpoch: number
Returns boolean

update

update(accountInfoMap: AccountInfoMap): void

Overrides SplStakePool.update
- Defined in src/stakePools/splStakePool/everstakeStakePool.ts:286
Parameters
- accountInfoMap: AccountInfoMap
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

stakePoolAddr: PublicKey

stakePoolAccountInfo: AccountInfo<Buffer>

__namedParameters: SplStakePoolCtorParams

Returns EverstakeSplStakePool

Properties

_depositAuth

label

mustUseKeypairForSplitStake

outputToken

programId

stakePool

stakePoolAddr

validatorList

validatorListAddr

withdrawAuth

withdrawStakeToken

Static DEFAULT_VALIDATOR_YIELD_PER_EPOCH_NUMERATOR

Static MINIMUM_DEPOSIT_LAMPORTS

Static VALIDATOR_YIELD_PER_EPOCH_DENOMINATOR

Accessors

depositAuth

Returns PublicKey

Methods

calcWithdrawalReceipt

Parameters

withdrawStakeTokens: bigint

Returns { lamportsReceived: bigint; withdrawStakeTokensFeePaid: bigint }

lamportsReceived: bigint

withdrawStakeTokensFeePaid: bigint

Private calculateDepositAmountByRewardSimulation

Parameters

totalDepositLamports: JSBI

Returns JSBI

canAcceptStakeAccount

Parameters

params: CanAcceptStakeAccountParams

Returns boolean

Private convertAmountOfLamportsToAmountOfPoolTokens

Parameters

lamports: JSBI

Returns JSBI

Private convertAmountOfPoolTokensToAmountOfLamports

Parameters

poolTokens: bigint

Returns bigint

createCleanupInstruction

Returns TransactionInstruction[]

createSetupInstructions

Parameters

__namedParameters: CreateSetupInstructionsParams

Returns TransactionInstruction[]

createSwapInstructions

Parameters

args: CreateSwapInstructionsParams

Returns TransactionInstruction[]

createWithdrawStakeInstructions

Parameters

args: CreateWithdrawStakeInstructionsParams

Returns TransactionInstruction[]

findTransientStakeAccount

Parameters

validatorStakeInfo: ValidatorStakeInfo

Returns PublicKey

Protected findValidatorStakeAccount

Parameters

stakeAccountVotePubkey: PublicKey

Returns PublicKey

getAccountsForUpdate

Returns PublicKey[]

getQuote

Parameters