@exponent-labs/exponent-types 0.1.7 → 0.9.0

package/src/index.ts

@@ -1,11 +1,12 @@
-export { SyEmissionRaw, SyEmissionJson } from "./common"
+export { SyEmissionRaw, SyEmissionJson, AnchorizedPNum, AnchorizedPNumJson } from "./common"
 export * from "./flavor"
 export * from "./jito-restaking"
 export * from "./kamino"
 export * from "./marginfi"
 export * from "./perena"
 export * from "./vault"
+export * from "./orderbook"
 export * from "./cpi"
 export * from "./trade"
 export * from "./liquidity"
-export * from "./generic"
+export * from "./generic"

package/src/jito-restaking.ts

@@ -1,38 +1,38 @@
-import { BN, web3 } from "@coral-xyz/anchor"
 import { AnchorizedPNum, AnchorizedPNumJson, SyEmissionRaw, SyEmissionJson } from "./common"
-
+import { PublicKey } from "@solana/web3.js"
+import BN from 'bn.js'
 export interface InterfaceType {
   splStakePool: {}
 }
 
 export interface JitoRestakingSyState {
-  selfAddress: web3.PublicKey
+  selfAddress: PublicKey
   account: JitoRestakingSyMetaAccount
   /** The value of SY tokens in terms of the base asset */
   syRate: string
   underlyingExchangeRate: number
-  mintBase: web3.PublicKey
-  tokenProgramBase: web3.PublicKey
+  mintBase: PublicKey
+  tokenProgramBase: PublicKey
 }
 
 export interface JitoRestakingSyMetaAccountRaw {
-  jitoVault: web3.PublicKey
-  mintSy: web3.PublicKey
-  tokenSyEscrow: web3.PublicKey
+  jitoVault: PublicKey
+  mintSy: PublicKey
+  tokenSyEscrow: PublicKey
   maxSySupply: BN
   minMintSize: BN
   minRedeemSize: BN
   selfAddressBump: number[]
   emissions: SyEmissionRaw[]
-  interfaceAccounts: web3.PublicKey[]
+  interfaceAccounts: PublicKey[]
   interfaceType: InterfaceType
 }
 
 export interface JitoRestakingSyMetaAccount {
-  jitoVault: web3.PublicKey
-  mintSy: web3.PublicKey
-  tokenSyEscrow: web3.PublicKey
-  interfaceAccounts: web3.PublicKey[]
+  jitoVault: PublicKey
+  mintSy: PublicKey
+  tokenSyEscrow: PublicKey
+  interfaceAccounts: PublicKey[]
   interfaceType: InterfaceType
   maxSySupply: BN
   minMintSize: BN
@@ -75,4 +75,4 @@ export interface JitoRestakingSyStateJson {
   underlyingExchangeRate: number
   mintBase: string
   tokenProgramBase: string
-}
+}

package/src/kamino.ts

@@ -1,18 +1,19 @@
-import { BN } from "@coral-xyz/anchor"
-import { web3 } from "@coral-xyz/anchor"
+import BN  from "bn.js"
 
 import { SyEmissionJson, SyEmissionRaw, SyEmissionRaw2 } from "./common"
+import { PublicKey } from "@solana/web3.js"
 
 export interface KaminoSyState {
-  selfAddress: web3.PublicKey
+  selfAddress: PublicKey
   account: KaminoSyMetaAccount
-  klendSyProgramId: web3.PublicKey
+  klendSyProgramId: PublicKey
   /** The value of SY tokens in terms of the base asset */
   syRate: string
-  mintBase: web3.PublicKey
-  tokenProgramBase: web3.PublicKey
-  klendProgramId: web3.PublicKey
-  klendMarketId: web3.PublicKey
+  mintBase: PublicKey
+  tokenProgramBase: PublicKey
+  klendProgramId: PublicKey
+  klendMarketId: PublicKey
+  scopePriceFeed?: PublicKey
 }
 
 export interface KaminoSyStateJson {
@@ -24,17 +25,18 @@ export interface KaminoSyStateJson {
   tokenProgramBase: string
   klendProgramId: string
   klendMarketId: string
+  scopePriceFeed?: string
 }
 
 export interface KaminoSyMetaAccount {
-  kaminoReserve: web3.PublicKey
-  kaminoObligation: web3.PublicKey
-  kaminoFarm: web3.PublicKey
-  kaminoUserMetadata: web3.PublicKey
-  mintSy: web3.PublicKey
+  kaminoReserve: PublicKey
+  kaminoObligation: PublicKey
+  kaminoFarm: PublicKey
+  kaminoUserMetadata: PublicKey
+  mintSy: PublicKey
   /** Where deposited SY tokens reside */
-  tokenSyEscrow: web3.PublicKey
-  userState: web3.PublicKey
+  tokenSyEscrow: PublicKey
+  userState: PublicKey
   maxSySupply: string
   minMintSize: string
   minRedeemSize: string
@@ -56,22 +58,22 @@ interface KaminoSyMetaAccountJson {
 }
 
 export interface KaminoSyMetaAccountRaw {
-  kamino_reserve: web3.PublicKey
-  kamino_obligation: web3.PublicKey
-  kamino_farm: web3.PublicKey
-  kamino_user_metadata: web3.PublicKey
-  mint_sy: web3.PublicKey
+  kamino_reserve: PublicKey
+  kamino_obligation: PublicKey
+  kamino_farm: PublicKey
+  kamino_user_metadata: PublicKey
+  mint_sy: PublicKey
   /** Where deposited SY tokens reside */
-  token_sy_escrow: web3.PublicKey
+  token_sy_escrow: PublicKey
   /** Robot authority over the Mfi Account */
-  authority_klend_account: web3.PublicKey
+  authority_klend_account: PublicKey
   /** Authority over the SY token escrow account */
-  authority_escrow: web3.PublicKey
+  authority_escrow: PublicKey
   /** Authority over the sy mint */
-  mint_authority: web3.PublicKey
-  user_state: web3.PublicKey
+  mint_authority: PublicKey
+  user_state: PublicKey
   max_sy_supply: BN
   min_mint_size: BN
   min_redeem_size: BN
   emissions: SyEmissionRaw2[]
-}
+}

package/src/marginfi.ts

@@ -1,19 +1,19 @@
-import { BN, web3 } from "@coral-xyz/anchor"
+import { PublicKey } from "@solana/web3.js"
 import { SyEmissionRaw, SyEmissionJson } from "./common"
-
+import BN from 'bn.js'
 export interface MfiSyState {
-  selfAddress: web3.PublicKey
+  selfAddress: PublicKey
   account: MarginfiSyMeta
-  marginfiSyProgramId: web3.PublicKey
+  marginfiSyProgramId: PublicKey
 
   /** The value of SY tokens in terms of the base asset taken directly from the bank */
   syRate: string
-  mintBase: web3.PublicKey
-  tokenProgramBase: web3.PublicKey
-  marginfiProgramId: web3.PublicKey
-  marginfiGroupId: web3.PublicKey
-  emissionsMint: web3.PublicKey | null
-  emissionsTokenProgram: web3.PublicKey | null
+  mintBase: PublicKey
+  tokenProgramBase: PublicKey
+  marginfiProgramId: PublicKey
+  marginfiGroupId: PublicKey
+  emissionsMint: PublicKey | null
+  emissionsTokenProgram: PublicKey | null
 }
 
 export interface MfiSyStateJson {
@@ -43,11 +43,11 @@ export interface SyMetaJson {
 }
 
 export interface MarginfiSyMeta {
-  marginfiBank: web3.PublicKey
-  marginfiAccount: web3.PublicKey
-  mintSy: web3.PublicKey
+  marginfiBank: PublicKey
+  marginfiAccount: PublicKey
+  mintSy: PublicKey
   /** Where the SY tokens get deposited */
-  tokenSyEscrow: web3.PublicKey
+  tokenSyEscrow: PublicKey
   maxSySupply: bigint
   minMintSize: bigint
   minRedeemSize: bigint
@@ -66,16 +66,16 @@ export interface MarginfiSyMetaJson {
 }
 
 export interface MarginfiSyMetaRaw {
-  marginfiBank: web3.PublicKey
-  marginfiAccount: web3.PublicKey
-  mintSy: web3.PublicKey
+  marginfiBank: PublicKey
+  marginfiAccount: PublicKey
+  mintSy: PublicKey
   maxSySupply: BN
   minMintSize: BN
   minRedeemSize: BN
   /** Where the SY tokens get deposited */
-  tokenSyEscrow: web3.PublicKey
+  tokenSyEscrow: PublicKey
   emissions: SyEmissionRaw[]
 }
 
 export type AnchorizedPNum = { 0: BN[] }
-export type AnchorizedPNumJson = { 0: string[] }
+export type AnchorizedPNumJson = { 0: string[] }

package/src/orderbook.ts

@@ -0,0 +1,195 @@
+
+import { PublicKey } from "@solana/web3.js"
+import { CpiAccountsRaw, ExponentCoreCpiAccountsRaw } from "./cpi"
+import { Flavor } from "./flavor"
+
+export const MAX_PRICE_NODES = 1000
+export const MAX_OFFERS = 2500
+export const MAX_USER_ESCROWS = 1500
+// RedBlackTree uses 3 registers per node: parent, left, right
+export const PRICE_NODE_REGISTERS = 3
+// Offer allocator uses 1 register per node (free‐list pointer)
+export const OFFER_REGISTERS = 1
+// UserEscrow allocator uses 0 registers
+export const ESCROW_REGISTERS = 0
+
+/** ─── Orderbook Financials ─────────────────────────────────────────────────── */
+export interface OrderbookFinancials {
+  /** Expiration timestamp (unix seconds) */
+  expirationTs: number
+  /** SY token balance */
+  syBalance: bigint
+  /** YT token balance */
+  ytBalance: bigint
+  /** PT token balance */
+  ptBalance: bigint
+
+  /// Balance of YT fee in the orderbook
+  /// This amount is tracked separately to prevent bugs from token transfers directly to the orderbook
+  ytFeeBalance: bigint
+
+  /// Balance of SY fee in the orderbook
+  /// This amount is tracked separately to prevent bugs from token transfers directly to the orderbook
+  syFeeBalance: bigint
+
+  /// Balance of PT fee in the orderbook
+  /// This amount is tracked separately to prevent bugs from token transfers directly to the orderbook
+  ptFeeBalance: bigint
+
+  /// Balance of staged SY in the orderbook
+  stagedSy: bigint
+}
+
+/** ─── Configuration Options ─────────────────────────────────────────────────── */
+export interface ConfigurationOptions {
+  priceDecimals: number
+  thresholdAmount: bigint
+  lnMakerFeeRate: number
+  lnTakerFeeRate: number
+}
+
+export interface PriceTreeNode {
+  /** The price tick (key into the tree) */
+  key: number
+  /** Head indexes of the linked lists of offers at this price */
+  firstOfferSellYt: number
+  firstOfferBuyYt: number
+  lastOfferSellYt: number
+  lastOfferBuyYt: number
+  /** Index of this node’s parent in the price_nodes slab */
+  parent: number
+  /** Index of this node’s left child */
+  left: number
+  /** Index of this node’s right child */
+  right: number
+}
+
+export interface OfferNode {
+  /** Actual NodeAllocator slot for this offer (0 is sentinel, live offers are 1-based) */
+  offerIndex: number
+
+  /** Internal register 1 (the free‐list link when unused) */
+  nextOfferPointer: number
+
+  /** Internal register 3 (the free‐list link when unused) */
+  pricePointer: number
+
+  /** SY/PT/YT amount deposited */
+  amount: bigint
+  /** Index of the user escrow that owns this offer */
+  userVaultPointer: number
+  /** Expiry timestamp (unix seconds) */
+  expiryAt: number
+  /** Creation timestamp (unix seconds) */
+  createdAt: number
+  /** True if this is a PT order */
+  virtualOffer: boolean
+  /** Offer‐type flag */
+  orderTypeFlag: number
+  /** Fill‐or‐kill flag */
+  fillOrKill: boolean
+}
+
+export interface UserEscrowNode {
+  /** The user’s Pubkey */
+  user: PublicKey
+  /** Last seen SY exchange rate for this user escrow */
+  yieldIndex: number
+  /** Token amounts held */
+  ptAmount: bigint
+  syAmount: bigint
+  ytAmount: bigint
+  stakedYtAmount: bigint
+  /** When unused, the free‐list link */
+  staged: bigint
+}
+
+/** ─── Full On-chain Orderbook ───────────────────────────────────────────────── */
+export interface Orderbook {
+  /** PDA link to vault */
+  vault: PublicKey
+  /** PDA link to a vault-owned YT position */
+  yieldPosition: PublicKey
+  /** Address Lookup Table key for the orderbook */
+  addressLookupTable: PublicKey
+  /** Address of the Exponent Core program */
+  exponentCoreProgram: PublicKey
+  /** Address of the Sy program */
+  syProgram: PublicKey
+  /** Orderbook-owned escrow for SY tokens */
+  tokenEscrowSy: PublicKey
+  /** Orderbook-owned escrow for YT tokens */
+  tokenEscrowYt: PublicKey
+  /** Orderbook-owned escrow for PT tokens */
+  tokenEscrowPt: PublicKey
+
+  /// Admin key
+  admin: PublicKey
+
+  /** CPI accounts storage key */
+  cpiAccountOrderbook: PublicKey
+
+  /** How many price nodes are currently in use */
+  nodeCount: number
+
+  financials: OrderbookFinancials
+
+  /** All PriceNode entries (fixed capacity) */
+  prices: PriceTreeNode[]
+
+  /** All Offer entries (fixed capacity) */
+  offers: OfferNode[]
+
+  /** All UserEscrow entries (fixed capacity) */
+  userEscrows: UserEscrowNode[]
+
+  /** PDA bump seed for the orderbook authority */
+  signerBump: number
+}
+
+export interface OrderbookState {
+  /** PDA link to vault */
+  vault: PublicKey
+  /** PDA link to a vault-owned YT position */
+  yieldPosition: PublicKey
+  /** Address Lookup Table key for the orderbook */
+  addressLookupTable: PublicKey
+  /** Address of the Exponent Core program */
+  exponentCoreProgram: PublicKey
+  /** Address of the Exponent Core program */
+  syProgram: PublicKey
+  /** Orderbook-owned escrow for SY tokens */
+  tokenEscrowSy: PublicKey
+  /** Orderbook-owned escrow for YT tokens */
+  tokenEscrowYt: PublicKey
+  /** Orderbook-owned escrow for PT tokens */
+  tokenEscrowPt: PublicKey
+  /** CPI accounts storage key */
+  cpiAccountOrderbook: PublicKey
+  /** Admin key */
+  admin: PublicKey
+
+  configurationOptions: ConfigurationOptions
+
+  financials: OrderbookFinancials
+
+  /** All PriceNode entries (fixed capacity) */
+  prices: PriceTreeNode[]
+
+  /** All Offer entries (fixed capacity) */
+  offers: OfferNode[]
+
+  /** All UserEscrow entries (fixed capacity) */
+  userEscrows: UserEscrowNode[]
+
+  syCpiAccounts: CpiAccountsRaw
+
+  exponentCoreCpiAccounts: ExponentCoreCpiAccountsRaw
+
+  flavor: Flavor
+
+  /** Next offer index that will be allocated (from NodeAllocator free list) */
+  offersFreeListHead: number
+  /** Bump index boundary for offers allocator */
+  offersBumpIndex: number
+}

package/src/perena.ts

@@ -1,32 +1,32 @@
-import { BN, web3 } from "@coral-xyz/anchor"
+import { PublicKey } from "@solana/web3.js"
 import { AnchorizedPNum, AnchorizedPNumJson, SyEmissionRaw, SyEmissionJson } from "./common"
-
+import BN from 'bn.js'
 export interface PerenaSyState {
-  selfAddress: web3.PublicKey
+  selfAddress: PublicKey
   account: PerenaSyMetaAccount
   /** The value of SY tokens in terms of the base asset */
   syRate: string
-  tokenProgramBase: web3.PublicKey
-  lpMint: web3.PublicKey
+  tokenProgramBase: PublicKey
+  lpMint: PublicKey
 }
 
 export interface PerenaSyMetaAccountRaw {
-  perenaStablePool: web3.PublicKey
-  mintSy: web3.PublicKey
-  tokenSyEscrow: web3.PublicKey
+  perenaStablePool: PublicKey
+  mintSy: PublicKey
+  tokenSyEscrow: PublicKey
   maxSySupply: BN
   minMintSize: BN
   minRedeemSize: BN
   selfAddressBump: number[]
   emissions: SyEmissionRaw[]
-  interfaceAccounts: web3.PublicKey[]
+  interfaceAccounts: PublicKey[]
 }
 
 export interface PerenaSyMetaAccount {
-  perenaStablePool: web3.PublicKey
-  mintSy: web3.PublicKey
-  tokenSyEscrow: web3.PublicKey
-  interfaceAccounts: web3.PublicKey[]
+  perenaStablePool: PublicKey
+  mintSy: PublicKey
+  tokenSyEscrow: PublicKey
+  interfaceAccounts: PublicKey[]
   maxSySupply: BN
   minMintSize: BN
   minRedeemSize: BN
@@ -64,4 +64,4 @@ export interface PerenaSyStateJson {
   underlyingExchangeRate: number
   mintBase: string
   tokenProgramBase: string
-}
+}

package/src/vault.ts

@@ -1,8 +1,8 @@
-import { BN, web3 } from "@coral-xyz/anchor"
 import { IFlavorState, IFlavorStateJson, Flavor } from "./flavor"
 import { CpiAccountsRaw, CpiAccountsRawJson } from "./cpi"
 import { AnchorizedPNum, AnchorizedPNumJson } from "./common"
-
+import { PublicKey } from "@solana/web3.js"
+import BN from 'bn.js'
 export type VaultJson = {
   /** When does the vault start, as a UNIX timestamp */
   startTs: number
@@ -83,6 +83,8 @@ export type VaultJson = {
   emissions: VaultEmissionJson[]
 
   maxPySupply: string
+
+  state: VaultStateJson
 }
 export interface VaultState {
   /** supply of PT */
@@ -97,28 +99,28 @@ export interface VaultState {
   durationSeconds: number
 
   /** Vault signer for token accounts, mints, SY position etc */
-  authority: web3.PublicKey
+  authority: PublicKey
 
-  addressLookupTable: web3.PublicKey
+  addressLookupTable: PublicKey
 
   lastSeenSyExchangeRate: number
 
   allTimeHighSyExchangeRate: number
 
   /** Vault-owned account for passing SY between SY program and user */
-  escrowSy: web3.PublicKey
+  escrowSy: PublicKey
 
   /** Escrow account for holding deposited YT */
-  escrowYt: web3.PublicKey
+  escrowYt: PublicKey
 
   /** Key to SY Program */
-  syProgram: web3.PublicKey
+  syProgram: PublicKey
 
   syPosition: SyPosition
 
   cpiAccounts: CpiAccountsRaw
 
-  mintPt: web3.PublicKey
+  mintPt: PublicKey
 
   status: number
 
@@ -126,15 +128,15 @@ export interface VaultState {
 
   minOperationSizeMerge: bigint
 
-  mintYt: web3.PublicKey
+  mintYt: PublicKey
 
-  mintSy: web3.PublicKey
+  mintSy: PublicKey
 
-  yieldPositonAddress: web3.PublicKey
+  yieldPositonAddress: PublicKey
 
   // yieldPosition: YtPosition
 
-  treasurySyTokenAccount: web3.PublicKey
+  treasurySyTokenAccount: PublicKey
 
   interestBpsFee: number
 
@@ -149,6 +151,69 @@ export interface VaultState {
   maxPySupply: bigint
 }
 
+export interface VaultStateJson {
+  /** supply of PT */
+  ptSupply: string
+
+  syForPt: string
+
+  /** When does the vault start, as a UNIX timestamp */
+  startTs: number
+
+  /** For how long is the vault active */
+  durationSeconds: number
+
+  /** Vault signer for token accounts, mints, SY position etc */
+  authority: string
+
+  addressLookupTable: string
+
+  lastSeenSyExchangeRate: number
+
+  allTimeHighSyExchangeRate: number
+
+  /** Vault-owned account for passing SY between SY program and user */
+  escrowSy: string
+
+  /** Escrow account for holding deposited YT */
+  escrowYt: string
+
+  /** Key to SY Program */
+  syProgram: string
+
+  syPosition: SyPositionJson
+
+  cpiAccounts: CpiAccountsRawJson
+
+  mintPt: string
+
+  status: number
+
+  minOperationSizeStrip: string
+
+  minOperationSizeMerge: string
+
+  mintYt: string
+
+  mintSy: string
+
+  yieldPositonAddress: string
+
+  treasurySyTokenAccount: string
+
+  interestBpsFee: number
+
+  totalSyInEscrow: string
+
+  flavor: IFlavorStateJson
+
+  finalSyExchangeRate: number
+
+  emissions: VaultEmissionJson[]
+
+  maxPySupply: string
+}
+
 export interface SyPositionJson {
   balanceSy: string
   owner: string
@@ -161,23 +226,23 @@ export interface SyPositionJson {
 
 export interface SyPosition {
   balanceSy: bigint
-  owner: web3.PublicKey
+  owner: PublicKey
   emissions: {
     /** Last seen index for SY-to-emission exchange rate */
     lastSeenIndex: number
     /** mint of emission token */
-    mint: web3.PublicKey
+    mint: PublicKey
     /** How many emissions are staged to claim */
     staged: bigint
   }[]
 }
 
 export interface VaultEmission {
-  tokenAccount: web3.PublicKey
+  tokenAccount: PublicKey
   initialIndex: AnchorizedPNum
   lastSeenIndex: AnchorizedPNum
   finalIndex: AnchorizedPNum
-  treasuryTokenAccount: web3.PublicKey
+  treasuryTokenAccount: PublicKey
   feeBps: number
   treasuryEmission: BN
 }
@@ -190,4 +255,4 @@ export interface VaultEmissionJson {
   treasuryTokenAccount: string
   feeBps: number
   treasuryEmission: string
-}
+}