Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SplStakePool Abstract

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns SplStakePool

Properties

_depositAuth

_depositAuth: PublicKey

label

label: "Socean" | "Eversol" | "JPool" | "SolBlaze" | "DAOPool" | "Jito" | "Laine" | "Cogent" | "Risk.lol" | "mrgn"

mustUseKeypairForSplitStake

mustUseKeypairForSplitStake: boolean = false

outputToken

outputToken: PublicKey

programId

programId: PublicKey

stakePool

stakePool: null | StakePool

stakePoolAddr

stakePoolAddr: PublicKey

validatorList

validatorList: null | ValidatorList

validatorListAddr

validatorListAddr: PublicKey

withdrawAuth

withdrawAuth: PublicKey

withdrawStakeToken

withdrawStakeToken: PublicKey

Accessors

depositAuth

  • get depositAuth(): PublicKey

  • Returns PublicKey

Methods

Protected calcWithdrawalReceipt

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

  • 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

canAcceptStakeAccount

  • SPL stake pools only accept:

    • active stake accounts (can cancel deactivation in setup)
    • staked to validators in the validator list
    • no lockup

    Parameters

    Returns boolean

createCleanupInstruction

  • createCleanupInstruction(): TransactionInstruction[]

createSetupInstructions

  • 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

    Returns TransactionInstruction[]

createSwapInstructions

  • Create the instructions for swapping the given stake account to outputToken assuming setup is done Only accepts entire stake accounts.

    Parameters

    Returns TransactionInstruction[]

createWithdrawStakeInstructions

Protected findTransientStakeAccount

  • findTransientStakeAccount(validatorStakeInfo: ValidatorStakeInfo): PublicKey

  • Parameters

    • validatorStakeInfo: ValidatorStakeInfo

    Returns PublicKey

Protected findValidatorStakeAccount

  • findValidatorStakeAccount(stakeAccountVotePubkey: PublicKey): PublicKey

  • Parameters

    • stakeAccountVotePubkey: PublicKey

    Returns PublicKey

getAccountsForUpdate

  • getAccountsForUpdate(): PublicKey[]

getQuote

  • Assumes that the passed stake account has passed this.canAcceptStakeAccount()

    Parameters

    Returns StakeQuote

getWithdrawStakeQuote

Protected isUpdated

  • isUpdated(currentEpoch: number): boolean

  • Assumes this.stakePool is fetched

    Parameters

    • currentEpoch: number

    Returns boolean

update

  • update(accountInfoMap: AccountInfoMap): void

  • Parameters

    • accountInfoMap: AccountInfoMap

    Returns void

Generated using TypeDoc