@ignitionfi/spl-stake-pool 1.1.20 → 1.1.21

package/dist/instructions.d.ts

@@ -4,7 +4,7 @@ import { InstructionType } from './utils';
 /**
  * An enumeration of valid StakePoolInstructionType's
  */
-export type StakePoolInstructionType = 'IncreaseValidatorStake' | 'DecreaseValidatorStake' | 'UpdateValidatorListBalance' | 'UpdateStakePoolBalance' | 'CleanupRemovedValidatorEntries' | 'DepositStake' | 'DepositSol' | 'WithdrawStake' | 'WithdrawSol' | 'IncreaseAdditionalValidatorStake' | 'DecreaseAdditionalValidatorStake' | 'DecreaseValidatorStakeWithReserve' | 'Redelegate' | 'AddValidatorToPool' | 'RemoveValidatorFromPool' | 'DepositWsolWithSession' | 'WithdrawWsolWithSession';
+export type StakePoolInstructionType = 'IncreaseValidatorStake' | 'DecreaseValidatorStake' | 'UpdateValidatorListBalance' | 'UpdateStakePoolBalance' | 'CleanupRemovedValidatorEntries' | 'DepositStake' | 'DepositSol' | 'WithdrawStake' | 'WithdrawSol' | 'IncreaseAdditionalValidatorStake' | 'DecreaseAdditionalValidatorStake' | 'DecreaseValidatorStakeWithReserve' | 'Redelegate' | 'AddValidatorToPool' | 'RemoveValidatorFromPool' | 'DepositWsolWithSession' | 'WithdrawWsolWithSession' | 'WithdrawStakeWithSession';
 export declare function tokenMetadataLayout(instruction: number, nameLength: number, symbolLength: number, uriLength: number): {
     index: number;
     layout: BufferLayout.Structure<any>;
@@ -163,6 +163,24 @@ export type WithdrawWsolWithSessionParams = {
     payer?: PublicKey;
     solWithdrawAuthority?: PublicKey;
 };
+export type WithdrawStakeWithSessionParams = {
+    programId: PublicKey;
+    stakePool: PublicKey;
+    validatorList: PublicKey;
+    withdrawAuthority: PublicKey;
+    stakeToSplit: PublicKey;
+    stakeToReceive: PublicKey;
+    /** The session signer (user or session) - used as both stake authority and transfer authority */
+    sessionSigner: PublicKey;
+    burnFromPool: PublicKey;
+    managerFeeAccount: PublicKey;
+    poolMint: PublicKey;
+    tokenProgramId: PublicKey;
+    /** The program signer PDA derived from PROGRAM_SIGNER_SEED */
+    programSigner: PublicKey;
+    poolTokensIn: number;
+    minimumLamportsOut: number;
+};
 /**
  * Deposit SOL directly into the pool's reserve account. The output is a "pool" token
  * representing ownership into the pool. Inputs are converted to the current ratio.
@@ -306,6 +324,10 @@ export declare class StakePoolInstruction {
      * Creates a transaction instruction to withdraw WSOL from a stake pool using a session.
      */
     static withdrawWsolWithSession(params: WithdrawWsolWithSessionParams): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to withdraw stake from a stake pool using a Fogo session.
+     */
+    static withdrawStakeWithSession(params: WithdrawStakeWithSessionParams): TransactionInstruction;
     /**
      * Creates an instruction to create metadata
      * using the mpl token metadata program for the pool token

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ignitionfi/spl-stake-pool",
-  "version": "1.1.20",
+  "version": "1.1.21",
   "description": "Ignition Stake Pool SDK for FOGO",
   "contributors": [
     "Anza Maintainers <maintainers@anza.xyz>",

package/src/index.ts

@@ -890,6 +890,164 @@ export async function withdrawWsolWithSession(
   }
 }
 
+/**
+ * Creates instructions required to withdraw stake from a stake pool using a Fogo session.
+ * The withdrawn stake account will be authorized to the user's wallet.
+ */
+export async function withdrawStakeWithSession(
+  connection: Connection,
+  stakePoolAddress: PublicKey,
+  signerOrSession: PublicKey,
+  userPubkey: PublicKey,
+  amount: number,
+  useReserve = false,
+  voteAccountAddress?: PublicKey,
+  minimumLamportsOut: number = 0,
+  payer?: PublicKey,
+  validatorComparator?: (_a: ValidatorAccount, _b: ValidatorAccount) => number,
+) {
+  const stakePoolAccount = await getStakePoolAccount(connection, stakePoolAddress)
+  const stakePoolProgramId = getStakePoolProgramId(connection.rpcEndpoint)
+  const stakePool = stakePoolAccount.account.data
+  const poolTokens = solToLamports(amount)
+  const poolAmount = new BN(poolTokens)
+
+  const poolTokenAccount = getAssociatedTokenAddressSync(stakePool.poolMint, userPubkey)
+  const tokenAccount = await getAccount(connection, poolTokenAccount)
+
+  if (tokenAccount.amount < poolTokens) {
+    throw new Error(
+      `Not enough token balance to withdraw ${amount} pool tokens.
+          Maximum withdraw amount is ${lamportsToSol(tokenAccount.amount)} pool tokens.`,
+    )
+  }
+
+  const [programSigner] = PublicKey.findProgramAddressSync(
+    [Buffer.from('fogo_session_program_signer')],
+    stakePoolProgramId,
+  )
+
+  const withdrawAuthority = await findWithdrawAuthorityProgramAddress(
+    stakePoolProgramId,
+    stakePoolAddress,
+  )
+
+  const stakeAccountRentExemption = await connection.getMinimumBalanceForRentExemption(StakeProgram.space)
+
+  // Determine which stake accounts to withdraw from
+  const withdrawAccounts: WithdrawAccount[] = []
+
+  if (useReserve) {
+    withdrawAccounts.push({
+      stakeAddress: stakePool.reserveStake,
+      voteAddress: undefined,
+      poolAmount,
+    })
+  } else if (voteAccountAddress) {
+    const stakeAccountAddress = await findStakeProgramAddress(
+      stakePoolProgramId,
+      voteAccountAddress,
+      stakePoolAddress,
+    )
+    const stakeAccount = await connection.getAccountInfo(stakeAccountAddress)
+    if (!stakeAccount) {
+      throw new Error(`Validator stake account not found for vote address ${voteAccountAddress.toBase58()}`)
+    }
+
+    const availableLamports = new BN(
+      stakeAccount.lamports - MINIMUM_ACTIVE_STAKE - stakeAccountRentExemption,
+    )
+    if (availableLamports.lt(new BN(0))) {
+      throw new Error('Invalid Stake Account')
+    }
+    const availableForWithdrawal = calcLamportsWithdrawAmount(
+      stakePool,
+      availableLamports,
+    )
+
+    if (availableForWithdrawal.lt(poolAmount)) {
+      throw new Error(
+        `Not enough lamports available for withdrawal from ${stakeAccountAddress},
+          ${poolAmount} asked, ${availableForWithdrawal} available.`,
+      )
+    }
+    withdrawAccounts.push({
+      stakeAddress: stakeAccountAddress,
+      voteAddress: voteAccountAddress,
+      poolAmount,
+    })
+  } else {
+    // Get the list of accounts to withdraw from automatically
+    withdrawAccounts.push(
+      ...(await prepareWithdrawAccounts(
+        connection,
+        stakePool,
+        stakePoolAddress,
+        poolAmount,
+        validatorComparator,
+        poolTokenAccount.equals(stakePool.managerFeeAccount),
+      )),
+    )
+  }
+
+  const instructions: TransactionInstruction[] = []
+  const signers: Signer[] = []
+  const stakeAccountPubkeys: PublicKey[] = []
+
+  // Max 5 accounts to prevent an error: "Transaction too large"
+  const maxWithdrawAccounts = 5
+  let i = 0
+
+  for (const withdrawAccount of withdrawAccounts) {
+    if (i >= maxWithdrawAccounts) {
+      break
+    }
+
+    // Create a new stake account to receive the withdrawal
+    const stakeReceiver = Keypair.generate()
+    signers.push(stakeReceiver)
+    stakeAccountPubkeys.push(stakeReceiver.publicKey)
+
+    // Create the stake account that will receive the split stake
+    instructions.push(
+      SystemProgram.createAccount({
+        fromPubkey: payer ?? userPubkey,
+        newAccountPubkey: stakeReceiver.publicKey,
+        lamports: stakeAccountRentExemption,
+        space: StakeProgram.space,
+        programId: StakeProgram.programId,
+      }),
+    )
+
+    // Add the withdraw stake with session instruction
+    instructions.push(
+      StakePoolInstruction.withdrawStakeWithSession({
+        programId: stakePoolProgramId,
+        stakePool: stakePoolAddress,
+        validatorList: stakePool.validatorList,
+        withdrawAuthority,
+        stakeToSplit: withdrawAccount.stakeAddress,
+        stakeToReceive: stakeReceiver.publicKey,
+        sessionSigner: signerOrSession,
+        burnFromPool: poolTokenAccount,
+        managerFeeAccount: stakePool.managerFeeAccount,
+        poolMint: stakePool.poolMint,
+        tokenProgramId: stakePool.tokenProgramId,
+        programSigner,
+        poolTokensIn: withdrawAccount.poolAmount.toNumber(),
+        minimumLamportsOut: solToLamports(minimumLamportsOut),
+      }),
+    )
+    i++
+  }
+
+  return {
+    instructions,
+    signers,
+    stakeAccountPubkeys,
+  }
+}
+
 export async function addValidatorToPool(
   connection: Connection,
   stakePoolAddress: PublicKey,

package/src/instructions.ts

@@ -41,6 +41,7 @@ export type StakePoolInstructionType
     | 'RemoveValidatorFromPool'
     | 'DepositWsolWithSession'
     | 'WithdrawWsolWithSession'
+    | 'WithdrawStakeWithSession'
 
 // 'UpdateTokenMetadata' and 'CreateTokenMetadata' have dynamic layouts
 
@@ -193,7 +194,8 @@ export const STAKE_POOL_INSTRUCTION_LAYOUTS: {
     index: 24,
     layout: BufferLayout.struct<any>([
       BufferLayout.u8('instruction'),
-      BufferLayout.ns64('lamports'),
+      BufferLayout.ns64('poolTokensIn'),
+      BufferLayout.ns64('minimumLamportsOut'),
     ]),
   },
   DepositSolWithSlippage: {
@@ -226,6 +228,14 @@ export const STAKE_POOL_INSTRUCTION_LAYOUTS: {
       BufferLayout.ns64('minimumLamportsOut'),
     ]),
   },
+  WithdrawStakeWithSession: {
+    index: 29,
+    layout: BufferLayout.struct<any>([
+      BufferLayout.u8('instruction'),
+      BufferLayout.ns64('poolTokensIn'),
+      BufferLayout.ns64('minimumLamportsOut'),
+    ]),
+  },
 })
 
 /**
@@ -391,6 +401,25 @@ export type WithdrawWsolWithSessionParams = {
   solWithdrawAuthority?: PublicKey
 }
 
+export type WithdrawStakeWithSessionParams = {
+  programId: PublicKey
+  stakePool: PublicKey
+  validatorList: PublicKey
+  withdrawAuthority: PublicKey
+  stakeToSplit: PublicKey
+  stakeToReceive: PublicKey
+  /** The session signer (user or session) - used as both stake authority and transfer authority */
+  sessionSigner: PublicKey
+  burnFromPool: PublicKey
+  managerFeeAccount: PublicKey
+  poolMint: PublicKey
+  tokenProgramId: PublicKey
+  /** The program signer PDA derived from PROGRAM_SIGNER_SEED */
+  programSigner: PublicKey
+  poolTokensIn: number
+  minimumLamportsOut: number
+}
+
 /**
  * Deposit SOL directly into the pool's reserve account. The output is a "pool" token
  * representing ownership into the pool. Inputs are converted to the current ratio.
@@ -1163,6 +1192,40 @@ export class StakePoolInstruction {
     })
   }
 
+  /**
+   * Creates a transaction instruction to withdraw stake from a stake pool using a Fogo session.
+   */
+  static withdrawStakeWithSession(params: WithdrawStakeWithSessionParams): TransactionInstruction {
+    const type = STAKE_POOL_INSTRUCTION_LAYOUTS.WithdrawStakeWithSession
+    const data = encodeData(type, {
+      poolTokensIn: params.poolTokensIn,
+      minimumLamportsOut: params.minimumLamportsOut,
+    })
+
+    const keys = [
+      { pubkey: params.stakePool, isSigner: false, isWritable: true },
+      { pubkey: params.validatorList, isSigner: false, isWritable: true },
+      { pubkey: params.withdrawAuthority, isSigner: false, isWritable: false },
+      { pubkey: params.stakeToSplit, isSigner: false, isWritable: true },
+      { pubkey: params.stakeToReceive, isSigner: false, isWritable: true },
+      { pubkey: params.sessionSigner, isSigner: true, isWritable: false }, // user_stake_authority_info (signer_or_session)
+      { pubkey: params.sessionSigner, isSigner: false, isWritable: false }, // user_transfer_authority_info (not used in session path)
+      { pubkey: params.burnFromPool, isSigner: false, isWritable: true },
+      { pubkey: params.managerFeeAccount, isSigner: false, isWritable: true },
+      { pubkey: params.poolMint, isSigner: false, isWritable: true },
+      { pubkey: SYSVAR_CLOCK_PUBKEY, isSigner: false, isWritable: false },
+      { pubkey: params.tokenProgramId, isSigner: false, isWritable: false },
+      { pubkey: StakeProgram.programId, isSigner: false, isWritable: false },
+      { pubkey: params.programSigner, isSigner: false, isWritable: false },
+    ]
+
+    return new TransactionInstruction({
+      programId: params.programId,
+      keys,
+      data,
+    })
+  }
+
   /**
    * Creates an instruction to create metadata
    * using the mpl token metadata program for the pool token