@raac/rpc 2.0.0-beta.17 → 2.0.0-beta.18

package/dist/contracts/curve/common/getPoolState.js

@@ -0,0 +1,105 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPoolState = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+const amount_1 = require("../../../utils/amount");
+const rpcError_1 = require("../../../utils/rpcError");
+const _helpers_1 = require("./_helpers");
+const getPools_1 = require("./getPools");
+const COMMON = [
+    "function balances(uint256) view returns (uint256)",
+    "function totalSupply() view returns (uint256)",
+    "function get_virtual_price() view returns (uint256)",
+    "function fee() view returns (uint256)",
+    "function A() view returns (uint256)",
+];
+/**
+ * Price getters per flavour. twocrypto-ng has one price and no index; tricrypto-ng and stableswap-ng take k for
+ * coin k + 1. All price in coin 0.
+ */
+const PRICE_ABI = {
+    twocrypto: [
+        "function price_oracle() view returns (uint256)",
+        "function last_prices() view returns (uint256)",
+        "function price_scale() view returns (uint256)",
+        "function lp_price() view returns (uint256)",
+        "function mid_fee() view returns (uint256)",
+        "function out_fee() view returns (uint256)",
+    ],
+    tricrypto: [
+        "function price_oracle(uint256) view returns (uint256)",
+        "function last_prices(uint256) view returns (uint256)",
+        "function price_scale(uint256) view returns (uint256)",
+        "function lp_price() view returns (uint256)",
+        "function mid_fee() view returns (uint256)",
+        "function out_fee() view returns (uint256)",
+    ],
+    stableswap: ["function price_oracle(uint256) view returns (uint256)", "function get_p(uint256) view returns (uint256)"],
+};
+const FEE_DECIMALS = 10;
+const ONE = BigInt(10) ** BigInt(amount_1.WAD_DECIMALS);
+/**
+ * Reads a Curve pool's composition, prices and fees in one go: balances, LP supply, virtual and LP price, the
+ * oracle, spot and (crypto) scale price of every coin in coin 0, each balance's value in coin 0, and the fee and A.
+ *
+ * @param chainId - The chain/network to use.
+ * @param poolAddressOrId - The pool's key in the chain config's `curve` section, or its address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The pool's state; values and TVL are in coin 0's units at the oracle price.
+ */
+const getPoolState = async (chainId, poolAddressOrId, provider) => {
+    const entry = (0, _helpers_1.resolveCurvePool)(chainId, poolAddressOrId);
+    const pool = (0, getPools_1.getPool)(chainId, entry.id);
+    if (!provider)
+        provider = new ethers_1.ethers.JsonRpcProvider(chains_1.default[chainId].rpcs[0]);
+    const contract = new ethers_1.ethers.Contract(entry.contract, [...COMMON, ...PRICE_ABI[entry.flavour]], provider);
+    const crypto = entry.flavour !== "stableswap";
+    const others = pool.coins.slice(1).map((_, k) => k);
+    // twocrypto-ng's price getters take no index; it has a single other coin.
+    const each = (method) => Promise.all(others.map((k) => (entry.flavour === "twocrypto" ? contract[method]() : contract[method](k))));
+    try {
+        const [balances, supply, virtualPrice, fee, A, oracle, spot, scale, lpPrice, mid, out] = await Promise.all([
+            Promise.all(pool.coins.map((_, i) => contract.balances(i))),
+            contract.totalSupply(),
+            contract.get_virtual_price(),
+            contract.fee(),
+            contract.A(),
+            each("price_oracle"),
+            each(crypto ? "last_prices" : "get_p"),
+            crypto ? each("price_scale") : Promise.resolve(null),
+            crypto ? contract.lp_price() : Promise.resolve(null),
+            crypto ? contract.mid_fee() : Promise.resolve(null),
+            crypto ? contract.out_fee() : Promise.resolve(null),
+        ]);
+        const unit = pool.coins[0];
+        const prices = (p) => [ONE, ...p].map((v) => (0, amount_1.toAmount)(v, amount_1.WAD_DECIMALS, unit.symbol));
+        const oraclePrices = prices(oracle);
+        // balance (coin decimals) * price (1e18) -> coin 0 decimals
+        const values = balances.map((b, i) => (0, amount_1.toAmount)((b * oraclePrices[i].value * BigInt(10) ** BigInt(unit.decimals)) / (BigInt(10) ** BigInt(pool.coins[i].decimals) * ONE), unit.decimals, unit.symbol));
+        const tvl = values.reduce((sum, v) => sum + v.value, BigInt(0));
+        const lp = lpPrice ?? (supply > BigInt(0) ? (tvl * BigInt(10) ** BigInt(amount_1.WAD_DECIMALS + amount_1.WAD_DECIMALS - unit.decimals)) / supply : BigInt(0));
+        return {
+            pool,
+            balances: balances.map((b, i) => (0, amount_1.toAmount)(b, pool.coins[i].decimals, pool.coins[i].symbol)),
+            totalSupply: (0, amount_1.toAmount)(supply, amount_1.WAD_DECIMALS, "LP"),
+            virtualPrice: (0, amount_1.toAmount)(virtualPrice, amount_1.WAD_DECIMALS),
+            lpPrice: (0, amount_1.toAmount)(lp, amount_1.WAD_DECIMALS, unit.symbol),
+            oraclePrices,
+            spotPrices: prices(spot),
+            priceScale: scale ? prices(scale) : null,
+            values,
+            tvl: (0, amount_1.toAmount)(tvl, unit.decimals, unit.symbol),
+            fee: (0, amount_1.toScaled)(fee, FEE_DECIMALS),
+            feeRange: mid !== null && out !== null ? { mid: (0, amount_1.toScaled)(mid, FEE_DECIMALS), out: (0, amount_1.toScaled)(out, FEE_DECIMALS) } : null,
+            A,
+        };
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("curve.common.getPoolState", error, { chainId, address: entry.contract });
+    }
+};
+exports.getPoolState = getPoolState;

package/dist/contracts/curve/common/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./calcWithdrawOneCoin"), exports);
 __exportStar(require("./exchange"), exports);
 __exportStar(require("./getDy"), exports);
 __exportStar(require("./getPools"), exports);
+__exportStar(require("./getPoolState"), exports);
 __exportStar(require("./getVirtualPrice"), exports);
 __exportStar(require("./removeLiquidity"), exports);
 __exportStar(require("./removeLiquidityOneCoin"), exports);

package/dist/types/contracts/curve/common/getPoolState.d.ts

@@ -0,0 +1,43 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { ScaledValue, TokenAmount } from "../../../utils/amount";
+import { CurvePool } from "./getPools";
+export interface CurvePoolState {
+    pool: CurvePool;
+    /** Coin balances in pool index order, each in its own decimals and symbol. */
+    balances: TokenAmount[];
+    /** LP tokens in circulation (the pool is its own LP token, 18 decimals). */
+    totalSupply: TokenAmount;
+    /** `get_virtual_price()`: underlying per LP token, only grows with fees. */
+    virtualPrice: TokenAmount;
+    /** Value of one LP token in coin 0: `lp_price()` on crypto pools, the balances at oracle prices on stableswap pools. */
+    lpPrice: TokenAmount;
+    /** Price of each coin in coin 0, 18 decimals, from the pool's EMA oracle; `oraclePrices[0]` is 1. */
+    oraclePrices: TokenAmount[];
+    /** Price of each coin in coin 0 right now: `last_prices` on crypto pools, `get_p` on stableswap pools. */
+    spotPrices: TokenAmount[];
+    /** Crypto pools only: where liquidity is concentrated (`price_scale`), in coin 0. Null on stableswap pools. */
+    priceScale: TokenAmount[] | null;
+    /** Each balance valued in coin 0 at the oracle price; their sum is the pool's TVL in coin 0. */
+    values: TokenAmount[];
+    tvl: TokenAmount;
+    /** Current swap fee as a fraction (Curve's 1e10 scale). */
+    fee: ScaledValue;
+    /** Crypto pools: the fee range the current fee moves in, as fractions. Null on stableswap pools. */
+    feeRange: {
+        mid: ScaledValue;
+        out: ScaledValue;
+    } | null;
+    /** Amplification, as the pool's `A()` reports it (crypto pools scale it by 10000). */
+    A: bigint;
+}
+/**
+ * Reads a Curve pool's composition, prices and fees in one go: balances, LP supply, virtual and LP price, the
+ * oracle, spot and (crypto) scale price of every coin in coin 0, each balance's value in coin 0, and the fee and A.
+ *
+ * @param chainId - The chain/network to use.
+ * @param poolAddressOrId - The pool's key in the chain config's `curve` section, or its address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The pool's state; values and TVL are in coin 0's units at the oracle price.
+ */
+export declare const getPoolState: (chainId: ChainId, poolAddressOrId: string, provider?: Provider) => Promise<CurvePoolState>;

package/dist/types/contracts/curve/common/index.d.ts

@@ -4,6 +4,7 @@ export * from "./calcWithdrawOneCoin";
 export * from "./exchange";
 export * from "./getDy";
 export * from "./getPools";
+export * from "./getPoolState";
 export * from "./getVirtualPrice";
 export * from "./removeLiquidity";
 export * from "./removeLiquidityOneCoin";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@raac/rpc",
-	"version": "2.0.0-beta.17",
+	"version": "2.0.0-beta.18",
 	"description": "RPC Library for RAAC",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",