@exponent-labs/exponent-fetcher 0.0.3

package/src/index.ts

@@ -0,0 +1,2 @@
+// TODO - rename to "sol"
+export * from "./exponentFetcher"

package/src/utils/meteora.ts

@@ -0,0 +1,126 @@
+import { CurveType, VaultState } from "@exponent-labs/meteora-idl"
+import { BN } from "@coral-xyz/anchor"
+import sqrt from "bn-sqrt"
+
+/**
+ * Calculates the unlocked (withdrawable) amount of tokens in a Meteora vault.
+ *
+ * @param onChainTime - Current blockchain timestamp in seconds
+ * @param vaultState - The state of the Meteora vault
+ * @returns A BN representing the unlocked amount that can be withdrawn from the vault
+ *
+ */
+export function calculateUnlockedAmount(onChainTime: number, vaultState: VaultState) {
+  const {
+    lockedProfitTracker: { lastReport, lockedProfitDegradation, lastUpdatedLockedProfit },
+    totalAmount: vaultTotalAmount,
+  } = vaultState
+  const lockedProfitDegradationDenominator = new BN(1_000_000_000_000)
+
+  const duration = new BN(onChainTime).sub(lastReport)
+
+  const lockedFundRatio = duration.mul(lockedProfitDegradation)
+  if (lockedFundRatio.gt(lockedProfitDegradationDenominator)) {
+    return vaultTotalAmount
+  }
+
+  const lockedProfit = lastUpdatedLockedProfit
+    .mul(lockedProfitDegradationDenominator.sub(lockedFundRatio))
+    .div(lockedProfitDegradationDenominator)
+
+  return vaultTotalAmount.sub(lockedProfit)
+}
+
+/**
+ * Calculates the amount of tokens corresponding to a share of the vault.
+ *
+ * @param share - Share amount of LP tokens
+ * @param totalSupply - Total supply of LP tokens
+ * @param vaultState - Current state of the vault
+ * @param onChainTime - Current blockchain timestamp in seconds
+ * @returns The amount of underlying tokens represented by the shares
+ *
+ */
+export function getAmountByShare(share: BN, totalSupply: BN, vaultState: VaultState, onChainTime: number): BN {
+  const withdrawableAmount = calculateUnlockedAmount(onChainTime, vaultState)
+
+  return totalSupply.isZero() ? new BN(0) : share.mul(withdrawableAmount).div(totalSupply)
+}
+
+/**
+ * Computes the StableSwap invariant (D) based on the Curve Finance formula.
+ *
+ * This function implements the iterative algorithm to find the value D such that:
+ * Ann * S + D * P / (A * N^n) = D^(n+1) / (n^n * prod(x_i))
+ *
+ * Where:
+ * - Ann is amplification coefficient * n^n
+ * - S is the sum of all coin amounts
+ * - P is the product of all coin amounts
+ * - n is the number of coins (2 in this case)
+ *
+ * @param ampFactor - Amplification coefficient (A)
+ * @param amountA - Amount of token A in the pool
+ * @param amountB - Amount of token B in the pool
+ * @returns The computed invariant D
+ *
+ */
+export const computeStableSwapInvariant = (ampFactor: BN, amountA: BN, amountB: BN): BN => {
+  const N_COINS = new BN(2)
+  const ZERO = new BN(0)
+  const ONE = new BN(1)
+  const MAX_ITERS = 20
+
+  const Ann = ampFactor.mul(N_COINS) // A*n^n
+  const S = amountA.add(amountB) // sum(x_i), a.k.a S
+  if (S === ZERO) {
+    return ZERO
+  }
+
+  let dPrev = ZERO
+  let d = S
+
+  for (let i = 0; d.sub(dPrev).abs().gt(ONE) && i < MAX_ITERS; i++) {
+    dPrev = d
+    let dP = d
+    dP = dP.mul(d).div(amountA.mul(N_COINS))
+    dP = dP.mul(d).div(amountB.mul(N_COINS))
+
+    const dNumerator = d.mul(Ann.mul(S).add(dP.mul(N_COINS)))
+    const dDenominator = d.mul(Ann.sub(ONE)).add(dP.mul(N_COINS.add(ONE)))
+    d = dNumerator.div(dDenominator)
+  }
+
+  return d
+}
+
+/**
+ * Computes the invariant D value for a token pair based on curve type.
+ *
+ * @param curve - Type of curve (ConstantProduct or Stable with parameters)
+ * @param tokenAmountA - Amount of token A
+ * @param tokenAmountB - Amount of token B
+ * @returns The calculated invariant D value
+ *
+ * Corresponds to `compute_d` function in Rust implementation.
+ *
+ */
+export function computeD(curve: CurveType, tokenAmountA: BN, tokenAmountB: BN): BN {
+  if ("cosntantProduct" in curve) {
+    return sqrt(tokenAmountA.mul(tokenAmountB))
+  } else if ("stable" in curve) {
+    const PRECISION = new BN(1_000_000)
+    const { amp, tokenMultiplier, depeg } = curve.stable
+
+    const upscaledTokenA = tokenMultiplier.tokenAMultiplier.mul(tokenAmountA)
+    const upscaledTokenB = tokenMultiplier.tokenBMultiplier.mul(tokenAmountB)
+
+    let invariantD = computeStableSwapInvariant(amp, upscaledTokenA, upscaledTokenB)
+
+    if (!depeg.depegType["none"]) {
+      return invariantD.div(PRECISION)
+    }
+
+    return invariantD
+  }
+}

package/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "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. */
+  },
+  "include": ["src"],
+  "exclude": ["build"],
+  "references": [
+    { "path": "../exponent-idl" },
+    { "path": "../exponent-ix" },
+    { "path": "../exponent-pda" },
+    { "path": "../precise-number" },
+    { "path": "../rust-decimal" },
+    { "path": "../marginfi-sy-idl" },
+    { "path": "../json-api-client" },
+    { "path": "../kamino-reserve-deserializer" },
+    { "path": "../exponent-types" },
+    { "path": "../jito-restaking-sy-idl" },
+    { "path": "../generic-sy-idl" },
+    { "path": "../generic-sy-pda" },
+    { "path": "../perena-sy-idl" },
+    { "path": "../fragmetric-idl" },
+    { "path": "../meteora-idl" }
+  ]
+}