@ignitionfi/fogo-stake-pool 1.0.0

package/dist/utils/instruction.d.ts

@@ -0,0 +1,21 @@
+import { Buffer } from 'node:buffer';
+import * as BufferLayout from '@solana/buffer-layout';
+/**
+ * @internal
+ */
+export type InstructionType = {
+    /** The Instruction index (from solana upstream program) */
+    index: number;
+    /** The BufferLayout to use to build data */
+    layout: BufferLayout.Layout<any>;
+};
+/**
+ * Populate a buffer of instruction data using an InstructionType
+ * @internal
+ */
+export declare function encodeData(type: InstructionType, fields?: any): Buffer;
+/**
+ * Decode instruction data buffer using an InstructionType
+ * @internal
+ */
+export declare function decodeData(type: InstructionType, buffer: Buffer): any;

package/dist/utils/math.d.ts

@@ -0,0 +1,3 @@
+import BN from 'bn.js';
+export declare function solToLamports(amount: number): number;
+export declare function lamportsToSol(lamports: number | BN | bigint): number;

package/dist/utils/program-address.d.ts

@@ -0,0 +1,31 @@
+import { PublicKey } from '@solana/web3.js';
+import BN from 'bn.js';
+/**
+ * Generates the wSOL transient program address for the stake pool
+ */
+export declare function findWsolTransientProgramAddress(programId: PublicKey, userPubkey: PublicKey): PublicKey;
+/**
+ * Generates the withdraw authority program address for the stake pool
+ */
+export declare function findWithdrawAuthorityProgramAddress(programId: PublicKey, stakePoolAddress: PublicKey): Promise<PublicKey>;
+/**
+ * Generates the stake program address for a validator's vote account
+ */
+export declare function findStakeProgramAddress(programId: PublicKey, voteAccountAddress: PublicKey, stakePoolAddress: PublicKey, seed?: number): Promise<PublicKey>;
+/**
+ * Generates the stake program address for a validator's vote account
+ */
+export declare function findTransientStakeProgramAddress(programId: PublicKey, voteAccountAddress: PublicKey, stakePoolAddress: PublicKey, seed: BN): Promise<PublicKey>;
+/**
+ * Generates the ephemeral program address for stake pool redelegation
+ */
+export declare function findEphemeralStakeProgramAddress(programId: PublicKey, stakePoolAddress: PublicKey, seed: BN): Promise<PublicKey>;
+/**
+ * Generates the metadata program address for the stake pool
+ */
+export declare function findMetadataAddress(stakePoolMintAddress: PublicKey): PublicKey;
+/**
+ * Generates the user stake account PDA for session-based withdrawals.
+ * The PDA is derived from the user's wallet and a unique seed.
+ */
+export declare function findUserStakeProgramAddress(programId: PublicKey, userWallet: PublicKey, seed: BN | number): PublicKey;

package/dist/utils/stake.d.ts

@@ -0,0 +1,29 @@
+import { Connection, Keypair, PublicKey, TransactionInstruction } from '@solana/web3.js';
+import BN from 'bn.js';
+import { WithdrawAccount } from '../index';
+import { StakePool, ValidatorList } from '../layouts';
+export declare function getValidatorListAccount(connection: Connection, pubkey: PublicKey): Promise<{
+    pubkey: PublicKey;
+    account: {
+        data: ValidatorList;
+        executable: boolean;
+        lamports: number;
+        owner: PublicKey;
+    };
+}>;
+export interface ValidatorAccount {
+    type: 'preferred' | 'active' | 'transient' | 'reserve';
+    voteAddress?: PublicKey | undefined;
+    stakeAddress: PublicKey;
+    lamports: BN;
+}
+export declare function prepareWithdrawAccounts(connection: Connection, stakePool: StakePool, stakePoolAddress: PublicKey, amount: BN, compareFn?: (a: ValidatorAccount, b: ValidatorAccount) => number, skipFee?: boolean): Promise<WithdrawAccount[]>;
+/**
+ * Calculate the pool tokens that should be minted for a deposit of `stakeLamports`
+ */
+export declare function calcPoolTokensForDeposit(stakePool: StakePool, stakeLamports: BN): BN;
+/**
+ * Calculate lamports amount on withdrawal
+ */
+export declare function calcLamportsWithdrawAmount(stakePool: StakePool, poolTokens: BN): BN;
+export declare function newStakeAccount(feePayer: PublicKey, instructions: TransactionInstruction[], lamports: number): Keypair;

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@ignitionfi/fogo-stake-pool",
+  "version": "1.0.0",
+  "description": "Fogo Stake Pool SDK",
+  "contributors": [
+    "Anza Maintainers <maintainers@anza.xyz>",
+    "Lieu Zheng Hong",
+    "mFactory Team (https://mfactory.ch/)",
+    "SolBlaze <contact@solblaze.org> (https://solblaze.org/)",
+    "Ignition Team (https://ignitionfi.xyz/)"
+  ],
+  "license": "ISC",
+  "homepage": "https://ignitionfi.xyz",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tempest-finance/fogo-stake-pool"
+  },
+  "keywords": [],
+  "publishConfig": {
+    "access": "public"
+  },
+  "browser": {
+    "./dist/index.cjs.js": "./dist/index.browser.cjs.js",
+    "./dist/index.esm.js": "./dist/index.browser.esm.js"
+  },
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "browserslist": [
+    "defaults",
+    "not IE 11",
+    "maintained node versions"
+  ],
+  "files": [
+    "/dist",
+    "/src"
+  ],
+  "dependencies": {
+    "@solana/buffer-layout": "^4.0.1",
+    "@solana/spl-token": "0.4.13",
+    "@solana/web3.js": "^1.95.5",
+    "bn.js": "^5.2.0",
+    "buffer": "^6.0.3",
+    "buffer-layout": "^1.2.2",
+    "superstruct": "^2.0.2"
+  },
+  "devDependencies": {
+    "@rollup/plugin-alias": "^5.1.1",
+    "@rollup/plugin-commonjs": "^28.0.1",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-multi-entry": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.1",
+    "@types/bn.js": "^5.1.6",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.0.0",
+    "@types/node-fetch": "^2.6.12",
+    "cross-env": "^10.0.0",
+    "jest": "^30.0.3",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.28.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "ts-jest": "^29.2.5"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": ".",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "testRegex": ".*\\.test\\.ts$",
+    "testEnvironment": "node"
+  },
+  "scripts": {
+    "build": "tsc && cross-env NODE_ENV=production rollup -c",
+    "dev": "tsc && cross-env NODE_ENV=production rollup -c -w",
+    "build:program": "cargo build-sbf --manifest-path=../program/Cargo.toml",
+    "format": "prettier --check src test",
+    "format:fix": "prettier --write src test",
+    "lint": "eslint --max-warnings 0 .",
+    "lint:fix": "eslint . --fix",
+    "test": "jest",
+    "clean": "rimraf ./dist"
+  }
+}

package/src/codecs.ts

@@ -0,0 +1,159 @@
+import { PublicKey } from '@solana/web3.js'
+import BN from 'bn.js'
+import { blob, Layout as LayoutCls, offset, seq, struct, u8, u32 } from 'buffer-layout'
+
+export interface Layout<T> {
+  span: number
+  property?: string
+
+  decode: (b: Buffer, offset?: number) => T
+
+  encode: (src: T, b: Buffer, offset?: number) => number
+
+  getSpan: (b: Buffer, offset?: number) => number
+
+  replicate: (name: string) => this
+}
+
+class BNLayout extends LayoutCls<BN> {
+  blob: Layout<Buffer>
+  signed: boolean
+
+  constructor(span: number, signed: boolean, property?: string) {
+    super(span, property)
+    this.blob = blob(span)
+    this.signed = signed
+  }
+
+  decode(b: Buffer, offset = 0) {
+    const num = new BN(this.blob.decode(b, offset), 10, 'le')
+    if (this.signed) {
+      return num.fromTwos(this.span * 8).clone()
+    }
+    return num
+  }
+
+  encode(src: BN, b: Buffer, offset = 0) {
+    if (this.signed) {
+      src = src.toTwos(this.span * 8)
+    }
+    return this.blob.encode(src.toArrayLike(Buffer, 'le', this.span), b, offset)
+  }
+}
+
+export function u64(property?: string): Layout<BN> {
+  return new BNLayout(8, false, property)
+}
+
+class WrappedLayout<T, U> extends LayoutCls<U> {
+  layout: Layout<T>
+  decoder: (data: T) => U
+  encoder: (src: U) => T
+
+  constructor(
+    layout: Layout<T>,
+    decoder: (data: T) => U,
+    encoder: (src: U) => T,
+    property?: string,
+  ) {
+    super(layout.span, property)
+    this.layout = layout
+    this.decoder = decoder
+    this.encoder = encoder
+  }
+
+  decode(b: Buffer, offset?: number): U {
+    return this.decoder(this.layout.decode(b, offset))
+  }
+
+  encode(src: U, b: Buffer, offset?: number): number {
+    return this.layout.encode(this.encoder(src), b, offset)
+  }
+
+  getSpan(b: Buffer, offset?: number): number {
+    return this.layout.getSpan(b, offset)
+  }
+}
+
+export function publicKey(property?: string): Layout<PublicKey> {
+  return new WrappedLayout(
+    blob(32),
+    (b: Buffer) => new PublicKey(b),
+    (key: PublicKey) => key.toBuffer(),
+    property,
+  )
+}
+
+class OptionLayout<T> extends LayoutCls<T | null> {
+  layout: Layout<T>
+  discriminator: Layout<number>
+
+  constructor(layout: Layout<T>, property?: string) {
+    super(-1, property)
+    this.layout = layout
+    this.discriminator = u8()
+  }
+
+  encode(src: T | null, b: Buffer, offset = 0): number {
+    if (src === null || src === undefined) {
+      return this.discriminator.encode(0, b, offset)
+    }
+    this.discriminator.encode(1, b, offset)
+    return this.layout.encode(src, b, offset + 1) + 1
+  }
+
+  decode(b: Buffer, offset = 0): T | null {
+    const discriminator = this.discriminator.decode(b, offset)
+    if (discriminator === 0) {
+      return null
+    } else if (discriminator === 1) {
+      return this.layout.decode(b, offset + 1)
+    }
+    throw new Error(`Invalid option ${this.property}`)
+  }
+
+  getSpan(b: Buffer, offset = 0): number {
+    const discriminator = this.discriminator.decode(b, offset)
+    if (discriminator === 0) {
+      return 1
+    } else if (discriminator === 1) {
+      return this.layout.getSpan(b, offset + 1) + 1
+    }
+    throw new Error(`Invalid option ${this.property}`)
+  }
+}
+
+export function option<T>(layout: Layout<T>, property?: string): Layout<T | null> {
+  return new OptionLayout<T>(layout, property)
+}
+
+export function bool(property?: string): Layout<boolean> {
+  return new WrappedLayout(u8(), decodeBool, encodeBool, property)
+}
+
+function decodeBool(value: number): boolean {
+  if (value === 0) {
+    return false
+  } else if (value === 1) {
+    return true
+  }
+  throw new Error(`Invalid bool: ${value}`)
+}
+
+function encodeBool(value: boolean): number {
+  return value ? 1 : 0
+}
+
+export function vec<T>(elementLayout: Layout<T>, property?: string): Layout<T[]> {
+  const length = u32('length')
+  const layout: Layout<{ values: T[] }> = struct([
+    length,
+    seq(elementLayout, offset(length, -length.span), 'values'),
+  ])
+  return new WrappedLayout(
+    layout,
+    ({ values }) => values,
+    values => ({ values }),
+    property,
+  )
+}

package/src/constants.ts

@@ -0,0 +1,30 @@
+import { Buffer } from 'node:buffer'
+import { LAMPORTS_PER_SOL, PublicKey } from '@solana/web3.js'
+
+// Public key that identifies the metadata program.
+export const METADATA_PROGRAM_ID = new PublicKey('metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s')
+export const METADATA_MAX_NAME_LENGTH = 32
+export const METADATA_MAX_SYMBOL_LENGTH = 10
+export const METADATA_MAX_URI_LENGTH = 200
+
+// Public key that identifies the SPL Stake Pool program.
+export const STAKE_POOL_PROGRAM_ID = new PublicKey('SP1s4uFeTAX9jsXXmwyDs1gxYYf7cdDZ8qHUHVxE1yr')
+
+// Public key that identifies the SPL Stake Pool program deployed to devnet.
+export const DEVNET_STAKE_POOL_PROGRAM_ID = new PublicKey('DPoo15wWDqpPJJtS2MUZ49aRxqz5ZaaJCJP4z8bLuib')
+
+// Maximum number of validators to update during UpdateValidatorListBalance.
+export const MAX_VALIDATORS_TO_UPDATE = 4
+
+// Seed for ephemeral stake account
+export const EPHEMERAL_STAKE_SEED_PREFIX = Buffer.from('ephemeral')
+
+// Seed used to derive transient stake accounts.
+export const TRANSIENT_STAKE_SEED_PREFIX = Buffer.from('transient')
+
+// Seed for user stake account created during session withdrawal
+export const USER_STAKE_SEED_PREFIX = Buffer.from('user_stake')
+
+// Minimum amount of staked SOL required in a validator stake account to allow
+// for merges without a mismatch on credits observed
+export const MINIMUM_ACTIVE_STAKE = LAMPORTS_PER_SOL