@ignitionfi/spl-stake-pool 1.1.20 → 1.1.21

package/dist/index.browser.esm.js

@@ -1062,7 +1062,8 @@ const STAKE_POOL_INSTRUCTION_LAYOUTS = Object.freeze({
         index: 24,
         layout: BufferLayout.struct([
             BufferLayout.u8('instruction'),
-            BufferLayout.ns64('lamports'),
+            BufferLayout.ns64('poolTokensIn'),
+            BufferLayout.ns64('minimumLamportsOut'),
         ]),
     },
     DepositSolWithSlippage: {
@@ -1095,6 +1096,14 @@ const STAKE_POOL_INSTRUCTION_LAYOUTS = Object.freeze({
             BufferLayout.ns64('minimumLamportsOut'),
         ]),
     },
+    WithdrawStakeWithSession: {
+        index: 29,
+        layout: BufferLayout.struct([
+            BufferLayout.u8('instruction'),
+            BufferLayout.ns64('poolTokensIn'),
+            BufferLayout.ns64('minimumLamportsOut'),
+        ]),
+    },
 });
 /**
  * Stake Pool Instruction class
@@ -1570,6 +1579,37 @@ class StakePoolInstruction {
             data,
         });
     }
+    /**
+     * Creates a transaction instruction to withdraw stake from a stake pool using a Fogo session.
+     */
+    static withdrawStakeWithSession(params) {
+        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
@@ -2179,6 +2219,106 @@ async function withdrawWsolWithSession(connection, stakePoolAddress, signerOrSes
         signers,
     };
 }
+/**
+ * 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.
+ */
+async function withdrawStakeWithSession(connection, stakePoolAddress, signerOrSession, userPubkey, amount, useReserve = false, voteAccountAddress, minimumLamportsOut = 0, payer, validatorComparator) {
+    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 = [];
+    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 = [];
+    const signers = [];
+    const stakeAccountPubkeys = [];
+    // 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 !== null && payer !== void 0 ? 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,
+    };
+}
 async function addValidatorToPool(connection, stakePoolAddress, validatorVote, seed) {
     const stakePoolAccount = await getStakePoolAccount(connection, stakePoolAddress);
     const stakePoolProgramId = getStakePoolProgramId(connection.rpcEndpoint);
@@ -2541,5 +2681,5 @@ async function updatePoolTokenMetadata(connection, stakePoolAddress, name, symbo
     };
 }
 
-export { DEVNET_STAKE_POOL_PROGRAM_ID, STAKE_POOL_INSTRUCTION_LAYOUTS, STAKE_POOL_PROGRAM_ID, StakePoolInstruction, StakePoolLayout, ValidatorListLayout, ValidatorStakeInfoLayout, addValidatorToPool, createPoolTokenMetadata, decreaseValidatorStake, depositSol, depositStake, depositWsolWithSession, getStakeAccount, getStakePoolAccount, getStakePoolAccounts, getStakePoolProgramId, increaseValidatorStake, removeValidatorFromPool, stakePoolInfo, tokenMetadataLayout, updatePoolTokenMetadata, updateStakePool, withdrawSol, withdrawStake, withdrawWsolWithSession };
+export { DEVNET_STAKE_POOL_PROGRAM_ID, STAKE_POOL_INSTRUCTION_LAYOUTS, STAKE_POOL_PROGRAM_ID, StakePoolInstruction, StakePoolLayout, ValidatorListLayout, ValidatorStakeInfoLayout, addValidatorToPool, createPoolTokenMetadata, decreaseValidatorStake, depositSol, depositStake, depositWsolWithSession, getStakeAccount, getStakePoolAccount, getStakePoolAccounts, getStakePoolProgramId, increaseValidatorStake, removeValidatorFromPool, stakePoolInfo, tokenMetadataLayout, updatePoolTokenMetadata, updateStakePool, withdrawSol, withdrawStake, withdrawStakeWithSession, withdrawWsolWithSession };
 //# sourceMappingURL=index.browser.esm.js.map