@exponent-labs/exponent-types 0.0.3

package/src/kamino.ts

@@ -0,0 +1,76 @@
+import { BN } from "@coral-xyz/anchor"
+import { web3 } from "@coral-xyz/anchor"
+import { SyEmissionRaw, SyEmissionJson } from "./common"
+
+export interface KaminoSyState {
+  selfAddress: web3.PublicKey
+  account: KaminoSyMetaAccount
+  klendSyProgramId: web3.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
+}
+
+export interface KaminoSyStateJson {
+  selfAddress: string
+  account: KaminoSyMetaAccountJson
+  klendSyProgramId: string
+  syRate: string
+  mintBase: string
+  tokenProgramBase: string
+  klendProgramId: string
+  klendMarketId: string
+}
+
+export interface KaminoSyMetaAccount {
+  kaminoReserve: web3.PublicKey
+  kaminoObligation: web3.PublicKey
+  kaminoFarm: web3.PublicKey
+  kaminoUserMetadata: web3.PublicKey
+  mintSy: web3.PublicKey
+  /** Where deposited SY tokens reside */
+  tokenSyEscrow: web3.PublicKey
+  userState: web3.PublicKey
+  maxSySupply: string
+  minMintSize: string
+  minRedeemSize: string
+  emissions: SyEmissionRaw[]
+}
+
+interface KaminoSyMetaAccountJson {
+  kaminoReserve: string
+  kaminoObligation: string
+  kaminoFarm: string
+  kaminoUserMetadata: string
+  mintSy: string
+  tokenSyEscrow: string
+  userState: string
+  maxSySupply: string
+  minMintSize: string
+  minRedeemSize: string
+  emissions: SyEmissionJson[]
+}
+
+export interface KaminoSyMetaAccountRaw {
+  kamino_reserve: web3.PublicKey
+  kamino_obligation: web3.PublicKey
+  kamino_farm: web3.PublicKey
+  kamino_user_metadata: web3.PublicKey
+  mint_sy: web3.PublicKey
+  /** Where deposited SY tokens reside */
+  token_sy_escrow: web3.PublicKey
+  /** Robot authority over the Mfi Account */
+  authority_klend_account: web3.PublicKey
+  /** Authority over the SY token escrow account */
+  authority_escrow: web3.PublicKey
+  /** Authority over the sy mint */
+  mint_authority: web3.PublicKey
+  user_state: web3.PublicKey
+  max_sy_supply: BN
+  min_mint_size: BN
+  min_redeem_size: BN
+  emissions: SyEmissionRaw[]
+}

package/src/liquidity.ts

@@ -0,0 +1,17 @@
+export type LiquidityHistory = {
+  deposits: LiquidityAddEvent[]
+  // TODO: add withdraws
+  // withdraws: todo[]
+}
+
+type LiquidityAddEvent = {
+  timestamp: Date
+  // raw amount of base tokens
+  baseTokensIn: string
+
+  // raw amount of LP tokens
+  lpTokensOut: string
+
+  // raw amount of YT minted as a side-effect
+  yieldTokensMinted: string
+}

package/src/marginfi.ts

@@ -0,0 +1,81 @@
+import { BN, web3 } from "@coral-xyz/anchor"
+import { SyEmissionRaw, SyEmissionJson } from "./common"
+
+export interface MfiSyState {
+  selfAddress: web3.PublicKey
+  account: MarginfiSyMeta
+  marginfiSyProgramId: web3.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
+}
+
+export interface MfiSyStateJson {
+  selfAddress: string
+  account: MarginfiSyMetaJson
+  marginfiSyProgramId: string
+  syRate: string
+  mintBase: string
+  tokenProgramBase: string
+  marginfiProgramId: string
+  marginfiGroupId: string
+  emissionsMint: string | null
+  emissionsTokenProgram: string | null
+}
+
+export interface SyMetaJson {
+  selfAddress: string
+  marginfiBank: string
+  marginfiAccount: string
+  mintSy: string
+  tokenSyEscrow: string
+  emissions: SyEmissionJson[]
+  maxSySupply: string
+  minMintSize: string
+  minRedeemSize: string
+  syRate: string
+}
+
+export interface MarginfiSyMeta {
+  marginfiBank: web3.PublicKey
+  marginfiAccount: web3.PublicKey
+  mintSy: web3.PublicKey
+  /** Where the SY tokens get deposited */
+  tokenSyEscrow: web3.PublicKey
+  maxSySupply: bigint
+  minMintSize: bigint
+  minRedeemSize: bigint
+  emissions: SyEmissionRaw[]
+}
+
+export interface MarginfiSyMetaJson {
+  marginfiBank: string
+  marginfiAccount: string
+  mintSy: string
+  tokenSyEscrow: string
+  maxSySupply: string
+  minMintSize: string
+  minRedeemSize: string
+  emissions: SyEmissionJson[]
+}
+
+export interface MarginfiSyMetaRaw {
+  marginfiBank: web3.PublicKey
+  marginfiAccount: web3.PublicKey
+  mintSy: web3.PublicKey
+  maxSySupply: BN
+  minMintSize: BN
+  minRedeemSize: BN
+  /** Where the SY tokens get deposited */
+  tokenSyEscrow: web3.PublicKey
+  emissions: SyEmissionRaw[]
+}
+
+export type AnchorizedPNum = { 0: BN[] }
+export type AnchorizedPNumJson = { 0: string[] }

package/src/perena.ts

@@ -0,0 +1,67 @@
+import { BN, web3 } from "@coral-xyz/anchor"
+import { AnchorizedPNum, AnchorizedPNumJson, SyEmissionRaw, SyEmissionJson } from "./common"
+
+export interface PerenaSyState {
+  selfAddress: web3.PublicKey
+  account: PerenaSyMetaAccount
+  /** The value of SY tokens in terms of the base asset */
+  syRate: string
+  tokenProgramBase: web3.PublicKey
+  lpMint: web3.PublicKey
+}
+
+export interface PerenaSyMetaAccountRaw {
+  perenaStablePool: web3.PublicKey
+  mintSy: web3.PublicKey
+  tokenSyEscrow: web3.PublicKey
+  maxSySupply: BN
+  minMintSize: BN
+  minRedeemSize: BN
+  selfAddressBump: number[]
+  emissions: SyEmissionRaw[]
+  interfaceAccounts: web3.PublicKey[]
+}
+
+export interface PerenaSyMetaAccount {
+  perenaStablePool: web3.PublicKey
+  mintSy: web3.PublicKey
+  tokenSyEscrow: web3.PublicKey
+  interfaceAccounts: web3.PublicKey[]
+  maxSySupply: BN
+  minMintSize: BN
+  minRedeemSize: BN
+  emissions: SyEmissionRaw[]
+}
+
+export interface PerenaSyMetaAccountJson {
+  perenaStablePool: string
+  mintSy: string
+  tokenSyEscrow: string
+  interfaceAccounts: string[]
+  maxSySupply: string
+  minMintSize: string
+  minRedeemSize: string
+  emissions: SyEmissionJson[]
+}
+
+export function deserializePerenaSyMetaAccountRaw(raw: PerenaSyMetaAccountRaw): PerenaSyMetaAccount {
+  return {
+    perenaStablePool: raw.perenaStablePool,
+    mintSy: raw.mintSy,
+    tokenSyEscrow: raw.tokenSyEscrow,
+    interfaceAccounts: raw.interfaceAccounts,
+    maxSySupply: raw.maxSySupply,
+    minMintSize: raw.minMintSize,
+    minRedeemSize: raw.minRedeemSize,
+    emissions: raw.emissions,
+  }
+}
+
+export interface PerenaSyStateJson {
+  selfAddress: string
+  account: PerenaSyMetaAccountJson
+  syRate: string
+  underlyingExchangeRate: number
+  mintBase: string
+  tokenProgramBase: string
+}

package/src/trade.ts

@@ -0,0 +1,37 @@
+export type UserTrade = {
+  user_address: string
+  market: string
+  is_buy: boolean
+  in_amount: string
+  out_amount: string
+  created_at: Date
+  tx_signature: string
+}
+
+export type Trade = {
+  marketAddress: MarketAddress
+  amountInTokens: number
+  amountOutTokens: number
+  amountUsd: number
+  price: number
+  date: number
+  kind: "buy" | "sell"
+  annualizedYield: number
+  txHash: string
+  decimals: number
+  mint: string
+  created_at: string
+}
+
+export type MarketAddress = string
+
+export type AllTrades = {
+  ytTrades: Trade[]
+  ptTrades: Trade[]
+}
+
+export type TradeHistory = Record<MarketAddress, AllTrades>
+
+export type ApiReturnData = {
+  tradeHistory: TradeHistory
+}

package/src/vault.ts

@@ -0,0 +1,191 @@
+import { BN, web3 } from "@coral-xyz/anchor"
+import { IFlavorState, IFlavorStateJson, Flavor } from "./flavor"
+import { CpiAccountsRaw, CpiAccountsRawJson } from "./cpi"
+import { AnchorizedPNum, AnchorizedPNumJson } from "./common"
+
+export type VaultJson = {
+  /** When does the vault start, as a UNIX timestamp */
+  startTs: number
+  /** For how long is the vault active */
+  duration: number
+  /** When does the vault start, formatted as YYYY-MM-DD */
+  startDateString: string
+
+  /** Vault signer for token accounts, mints, SY position etc */
+  authority: string
+
+  /** SY balance of the vault in the SY program */
+  syBalance: string
+
+  /** Address of the address lookup table */
+  addressLookupTable: string
+
+  /** Last seen SY exchange rate, according to the Vault state */
+  lastSeenSyExchangeRate: number
+
+  /** Current SY exchange rate, according to underlying program */
+  currentSyExchangeRate: number
+
+  /** Address of the vault */
+  selfAddress: string
+
+  /** SY program address */
+  syProgram: string
+
+  /** PT mint */
+  mintPt: string
+  /** YT mint */
+  mintYt: string
+
+  /** SY mint */
+  mintSy: string
+
+  /** Escrow SY token account */
+  escrowSy: string
+
+  /** Escrow YT token account */
+  escrowYt: string
+
+  /** Treasury SY token account */
+  treasurySyTokenAccount: string
+
+  /** All time high SY exchange rate */
+  allTimeHighSyExchangeRate: number
+
+  /** Exchange rate for SY when the vault expires */
+  finalSyExchangeRate: number
+
+  /** Supply of PT */
+  ptSupply: string
+
+  /** SY in escrow */
+  totalSyInEscrow: string
+
+  /** SY for PT */
+  syForPt: string
+
+  status: number
+
+  syPosition: SyPositionJson
+
+  minOperationSizeStrip: string
+
+  minOperationSizeMerge: string
+
+  yieldPositonAddress: string
+
+  interestFeeBps: number
+
+  cpiAccounts: CpiAccountsRawJson
+
+  flavor: IFlavorStateJson
+
+  emissions: VaultEmissionJson[]
+
+  maxPySupply: string
+}
+export interface VaultState {
+  /** supply of PT */
+  ptSupply: bigint
+
+  syForPt: bigint
+
+  /** 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: web3.PublicKey
+
+  addressLookupTable: web3.PublicKey
+
+  lastSeenSyExchangeRate: number
+
+  allTimeHighSyExchangeRate: number
+
+  /** Vault-owned account for passing SY between SY program and user */
+  escrowSy: web3.PublicKey
+
+  /** Escrow account for holding deposited YT */
+  escrowYt: web3.PublicKey
+
+  /** Key to SY Program */
+  syProgram: web3.PublicKey
+
+  syPosition: SyPosition
+
+  cpiAccounts: CpiAccountsRaw
+
+  mintPt: web3.PublicKey
+
+  status: number
+
+  minOperationSizeStrip: bigint
+
+  minOperationSizeMerge: bigint
+
+  mintYt: web3.PublicKey
+
+  mintSy: web3.PublicKey
+
+  yieldPositonAddress: web3.PublicKey
+
+  // yieldPosition: YtPosition
+
+  treasurySyTokenAccount: web3.PublicKey
+
+  interestBpsFee: number
+
+  totalSyInEscrow: bigint
+
+  flavor: Flavor
+
+  finalSyExchangeRate: number
+
+  emissions: VaultEmission[]
+
+  maxPySupply: bigint
+}
+
+export interface SyPositionJson {
+  balanceSy: string
+  owner: string
+  emissions: {
+    lastSeenIndex: number
+    mint: string
+    staged: string
+  }[]
+}
+
+export interface SyPosition {
+  balanceSy: bigint
+  owner: web3.PublicKey
+  emissions: {
+    /** Last seen index for SY-to-emission exchange rate */
+    lastSeenIndex: number
+    /** mint of emission token */
+    mint: web3.PublicKey
+    /** How many emissions are staged to claim */
+    staged: bigint
+  }[]
+}
+
+export interface VaultEmission {
+  tokenAccount: web3.PublicKey
+  initialIndex: AnchorizedPNum
+  lastSeenIndex: AnchorizedPNum
+  treasuryTokenAccount: web3.PublicKey
+  feeBps: number
+  treasuryEmission: BN
+}
+
+export interface VaultEmissionJson {
+  tokenAccount: string
+  initialIndex: AnchorizedPNumJson
+  lastSeenIndex: AnchorizedPNumJson
+  treasuryTokenAccount: string
+  feeBps: number
+  treasuryEmission: string
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "sourceMap": true,
+    "incremental": true /* Save .tsbuildinfo files to allow for incremental compilation of projects. */,
+    "composite": true /* Enable constraints that allow a TypeScript project to be used with project references. */,
+    "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "module": "CommonJS" /* Specify what module code is generated. */,
+    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+    "outDir": "./build" /* Specify an output folder for all emitted files. */,
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */,
+    "types": ["jest"]
+  },
+  "references": [
+    {
+      "path": "../precise-number"
+    }
+  ],
+  "include": ["src"],
+  "exclude": ["build"]
+}