@ignitionfi/fogo-stake-pool 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,268 @@
+import { AccountInfo, Connection, PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
+import BN from 'bn.js';
+import { StakeAccount, StakePool, ValidatorList } from './layouts';
+import { ValidatorAccount } from './utils';
+export { DEVNET_STAKE_POOL_PROGRAM_ID, STAKE_POOL_PROGRAM_ID, } from './constants';
+export * from './instructions';
+export type { AccountType, StakePool, ValidatorList, ValidatorStakeInfo, } from './layouts';
+export { StakePoolLayout, ValidatorListLayout, ValidatorStakeInfoLayout, } from './layouts';
+export { findEphemeralStakeProgramAddress, findStakeProgramAddress, findTransientStakeProgramAddress, findUserStakeProgramAddress, findWithdrawAuthorityProgramAddress, findWsolTransientProgramAddress, } from './utils';
+export interface ValidatorListAccount {
+    pubkey: PublicKey;
+    account: AccountInfo<ValidatorList>;
+}
+export interface StakePoolAccount {
+    pubkey: PublicKey;
+    account: AccountInfo<StakePool>;
+}
+export interface WithdrawAccount {
+    stakeAddress: PublicKey;
+    voteAddress?: PublicKey;
+    poolAmount: BN;
+}
+/**
+ * Wrapper class for a stake pool.
+ * Each stake pool has a stake pool account and a validator list account.
+ */
+export interface StakePoolAccounts {
+    stakePool: StakePoolAccount | undefined;
+    validatorList: ValidatorListAccount | undefined;
+}
+export declare function getStakePoolProgramId(rpcEndpoint: string): PublicKey;
+/**
+ * Retrieves and deserializes a StakePool account using a web3js connection and the stake pool address.
+ * @param connection An active web3js connection.
+ * @param stakePoolAddress The public key (address) of the stake pool account.
+ */
+export declare function getStakePoolAccount(connection: Connection, stakePoolAddress: PublicKey): Promise<StakePoolAccount>;
+/**
+ * Retrieves and deserializes a Stake account using a web3js connection and the stake address.
+ * @param connection An active web3js connection.
+ * @param stakeAccount The public key (address) of the stake account.
+ */
+export declare function getStakeAccount(connection: Connection, stakeAccount: PublicKey): Promise<StakeAccount>;
+/**
+ * Retrieves all StakePool and ValidatorList accounts that are running a particular StakePool program.
+ * @param connection An active web3js connection.
+ * @param stakePoolProgramAddress The public key (address) of the StakePool program.
+ */
+export declare function getStakePoolAccounts(connection: Connection, stakePoolProgramAddress: PublicKey): Promise<(StakePoolAccount | ValidatorListAccount | undefined)[] | undefined>;
+/**
+ * Creates instructions required to deposit stake to stake pool.
+ */
+export declare function depositStake(connection: Connection, stakePoolAddress: PublicKey, authorizedPubkey: PublicKey, validatorVote: PublicKey, depositStake: PublicKey, poolTokenReceiverAccount?: PublicKey): Promise<{
+    instructions: TransactionInstruction[];
+    signers: Signer[];
+}>;
+/**
+ * Creates instructions required to deposit sol to stake pool.
+ */
+export declare function depositWsolWithSession(connection: Connection, stakePoolAddress: PublicKey, signerOrSession: PublicKey, userPubkey: PublicKey, lamports: number, minimumPoolTokensOut?: number, destinationTokenAccount?: PublicKey, referrerTokenAccount?: PublicKey, depositAuthority?: PublicKey, payer?: PublicKey, 
+/**
+ * Skip WSOL balance validation. Set to true when adding wrap instructions
+ * in the same transaction that will fund the WSOL account before deposit.
+ */
+skipBalanceCheck?: boolean): Promise<{
+    instructions: TransactionInstruction[];
+    signers: never[];
+}>;
+/**
+ * Creates instructions required to deposit sol to stake pool.
+ */
+export declare function depositSol(connection: Connection, stakePoolAddress: PublicKey, from: PublicKey, lamports: number, destinationTokenAccount?: PublicKey, referrerTokenAccount?: PublicKey, depositAuthority?: PublicKey): Promise<{
+    instructions: TransactionInstruction[];
+    signers: Signer[];
+}>;
+/**
+ * Creates instructions required to withdraw stake from a stake pool.
+ */
+export declare function withdrawStake(connection: Connection, stakePoolAddress: PublicKey, tokenOwner: PublicKey, amount: number, useReserve?: boolean, voteAccountAddress?: PublicKey, stakeReceiver?: PublicKey, poolTokenAccount?: PublicKey, validatorComparator?: (_a: ValidatorAccount, _b: ValidatorAccount) => number): Promise<{
+    instructions: TransactionInstruction[];
+    signers: Signer[];
+    stakeReceiver: PublicKey | undefined;
+    totalRentFreeBalances: number;
+}>;
+/**
+ * Creates instructions required to withdraw SOL directly from a stake pool.
+ */
+export declare function withdrawSol(connection: Connection, stakePoolAddress: PublicKey, tokenOwner: PublicKey, solReceiver: PublicKey, amount: number, solWithdrawAuthority?: PublicKey): Promise<{
+    instructions: TransactionInstruction[];
+    signers: Signer[];
+}>;
+/**
+ * Creates instructions required to withdraw wSOL from a stake pool.
+ * Rent for ATA creation (if needed) is paid from the withdrawal amount.
+ */
+export declare function withdrawWsolWithSession(connection: Connection, stakePoolAddress: PublicKey, signerOrSession: PublicKey, userPubkey: PublicKey, amount: number, minimumLamportsOut?: number, solWithdrawAuthority?: PublicKey): Promise<{
+    instructions: TransactionInstruction[];
+    signers: Signer[];
+}>;
+/**
+ * Finds the next available seed for creating a user stake PDA.
+ * Scans from startSeed until an unused PDA is found.
+ *
+ * @param connection - Solana connection
+ * @param programId - The stake pool program ID
+ * @param userPubkey - User's wallet (used for PDA derivation)
+ * @param startSeed - Starting seed to search from (default: 0)
+ * @param maxSeed - Maximum seed to check before giving up (default: 1000)
+ * @returns The next available seed
+ * @throws Error if no available seed found within maxSeed
+ */
+export declare function findNextUserStakeSeed(connection: Connection, programId: PublicKey, userPubkey: PublicKey, startSeed?: number, maxSeed?: number): Promise<number>;
+/**
+ * Represents a user stake account with its details
+ */
+export interface UserStakeAccount {
+    /** The stake account public key (PDA) */
+    pubkey: PublicKey;
+    /** The seed used to derive this PDA */
+    seed: number;
+    /** Lamports in the stake account */
+    lamports: number;
+    /** Parsed stake state */
+    state: 'inactive' | 'activating' | 'active' | 'deactivating';
+    /** Validator vote account (if delegated) */
+    voter?: PublicKey;
+    /** Activation epoch (if active/activating) */
+    activationEpoch?: number;
+    /** Deactivation epoch (if deactivating) */
+    deactivationEpoch?: number;
+}
+/**
+ * Fetches all user stake accounts created via WithdrawStakeWithSession.
+ * These are PDAs derived from [b"user_stake", user_wallet, seed].
+ *
+ * @param connection - Solana connection
+ * @param programId - The stake pool program ID
+ * @param userPubkey - User's wallet address
+ * @param maxSeed - Maximum seed to check (default: 100)
+ * @returns Array of user stake accounts with their details
+ */
+export declare function getUserStakeAccounts(connection: Connection, programId: PublicKey, userPubkey: PublicKey, maxSeed?: number): Promise<UserStakeAccount[]>;
+/**
+ * Withdraws stake from a stake pool using a Fogo session.
+ *
+ * The on-chain program creates stake account PDAs. The rent for these accounts
+ * is paid by the payer (typically the paymaster), not deducted from the user's withdrawal.
+ *
+ * @param connection - Solana connection
+ * @param stakePoolAddress - The stake pool to withdraw from
+ * @param signerOrSession - The session signer public key
+ * @param userPubkey - User's wallet (used for PDA derivation and token ownership)
+ * @param payer - Payer for stake account rent (typically paymaster)
+ * @param amount - Amount of pool tokens to withdraw
+ * @param userStakeSeedStart - Starting seed for user stake PDA derivation (default: 0)
+ * @param useReserve - Whether to withdraw from reserve (default: false)
+ * @param voteAccountAddress - Optional specific validator to withdraw from
+ * @param minimumLamportsOut - Minimum lamports to receive (slippage protection)
+ * @param validatorComparator - Optional comparator for validator selection
+ */
+export declare function withdrawStakeWithSession(connection: Connection, stakePoolAddress: PublicKey, signerOrSession: PublicKey, userPubkey: PublicKey, payer: PublicKey, amount: number, userStakeSeedStart?: number, useReserve?: boolean, voteAccountAddress?: PublicKey, minimumLamportsOut?: number, validatorComparator?: (_a: ValidatorAccount, _b: ValidatorAccount) => number): Promise<{
+    instructions: TransactionInstruction[];
+    stakeAccountPubkeys: PublicKey[];
+    userStakeSeeds: number[];
+}>;
+export declare function addValidatorToPool(connection: Connection, stakePoolAddress: PublicKey, validatorVote: PublicKey, seed?: number): Promise<{
+    instructions: TransactionInstruction[];
+}>;
+export declare function removeValidatorFromPool(connection: Connection, stakePoolAddress: PublicKey, validatorVote: PublicKey, seed?: number): Promise<{
+    instructions: TransactionInstruction[];
+}>;
+/**
+ * Creates instructions required to increase validator stake.
+ */
+export declare function increaseValidatorStake(connection: Connection, stakePoolAddress: PublicKey, validatorVote: PublicKey, lamports: number, ephemeralStakeSeed?: number): Promise<{
+    instructions: TransactionInstruction[];
+}>;
+/**
+ * Creates instructions required to decrease validator stake.
+ */
+export declare function decreaseValidatorStake(connection: Connection, stakePoolAddress: PublicKey, validatorVote: PublicKey, lamports: number, ephemeralStakeSeed?: number): Promise<{
+    instructions: TransactionInstruction[];
+}>;
+/**
+ * Creates instructions required to completely update a stake pool after epoch change.
+ */
+export declare function updateStakePool(connection: Connection, stakePool: StakePoolAccount, noMerge?: boolean): Promise<{
+    updateListInstructions: TransactionInstruction[];
+    finalInstructions: TransactionInstruction[];
+}>;
+/**
+ * Retrieves detailed information about the StakePool.
+ */
+export declare function stakePoolInfo(connection: Connection, stakePoolAddress: PublicKey): Promise<{
+    address: string;
+    poolWithdrawAuthority: string;
+    manager: string;
+    staker: string;
+    stakeDepositAuthority: string;
+    stakeWithdrawBumpSeed: number;
+    maxValidators: number;
+    validatorList: {
+        activeStakeLamports: string;
+        transientStakeLamports: string;
+        lastUpdateEpoch: string;
+        transientSeedSuffixStart: string;
+        transientSeedSuffixEnd: string;
+        status: string;
+        voteAccountAddress: string;
+    }[];
+    validatorListStorageAccount: string;
+    reserveStake: string;
+    poolMint: string;
+    managerFeeAccount: string;
+    tokenProgramId: string;
+    totalLamports: string;
+    poolTokenSupply: string;
+    lastUpdateEpoch: string;
+    lockup: import("./layouts").Lockup;
+    epochFee: import("./layouts").Fee;
+    nextEpochFee: import("./layouts").Fee | undefined;
+    preferredDepositValidatorVoteAddress: PublicKey | undefined;
+    preferredWithdrawValidatorVoteAddress: PublicKey | undefined;
+    stakeDepositFee: import("./layouts").Fee;
+    stakeWithdrawalFee: import("./layouts").Fee;
+    nextStakeWithdrawalFee: import("./layouts").Fee | undefined;
+    stakeReferralFee: number;
+    solDepositAuthority: string | undefined;
+    solDepositFee: import("./layouts").Fee;
+    solReferralFee: number;
+    solWithdrawAuthority: string | undefined;
+    solWithdrawalFee: import("./layouts").Fee;
+    nextSolWithdrawalFee: import("./layouts").Fee | undefined;
+    lastEpochPoolTokenSupply: string;
+    lastEpochTotalLamports: string;
+    details: {
+        reserveStakeLamports: number | undefined;
+        reserveAccountStakeAddress: string;
+        minimumReserveStakeBalance: number;
+        stakeAccounts: {
+            voteAccountAddress: string;
+            stakeAccountAddress: string;
+            validatorActiveStakeLamports: string;
+            validatorLastUpdateEpoch: string;
+            validatorLamports: string;
+            validatorTransientStakeAccountAddress: string;
+            validatorTransientStakeLamports: string;
+            updateRequired: boolean;
+        }[];
+        totalLamports: BN;
+        totalPoolTokens: number;
+        currentNumberOfValidators: number;
+        maxNumberOfValidators: number;
+        updateRequired: boolean;
+    };
+}>;
+/**
+ * Creates instructions required to create pool token metadata.
+ */
+export declare function createPoolTokenMetadata(connection: Connection, stakePoolAddress: PublicKey, payer: PublicKey, name: string, symbol: string, uri: string): Promise<{
+    instructions: TransactionInstruction[];
+}>;
+/**
+ * Creates instructions required to update pool token metadata.
+ */
+export declare function updatePoolTokenMetadata(connection: Connection, stakePoolAddress: PublicKey, name: string, symbol: string, uri: string): Promise<{
+    instructions: TransactionInstruction[];
+}>;