@curvefi/api 1.13.0 → 1.14.0

package/lib/curve.js

@@ -71,6 +71,7 @@ var address_provider_json_1 = __importDefault(require("./constants/abis/json/add
 var gaugecontroller_json_1 = __importDefault(require("./constants/abis/json/gaugecontroller.json"));
 var router_json_1 = __importDefault(require("./constants/abis/json/router.json"));
 var registry_exchange_json_1 = __importDefault(require("./constants/abis/json/registry_exchange.json"));
+var streamer_json_1 = __importDefault(require("./constants/abis/json/streamer.json"));
 var abis_ethereum_1 = require("./constants/abis/abis-ethereum");
 var abis_polygon_1 = require("./constants/abis/abis-polygon");
 var coins_ethereum_1 = require("./constants/coins-ethereum");
@@ -314,6 +315,16 @@ var Curve = /** @class */ (function () {
                                     };
                                 }
                             }
+                            if (pool.crv_reward_contract) {
+                                this.contracts[pool.crv_reward_contract] = {
+                                    contract: new ethers_1.Contract(pool.crv_reward_contract, streamer_json_1.default, this.signer || this.provider),
+                                    multicallContract: new ethcall_1.Contract(pool.crv_reward_contract, streamer_json_1.default),
+                                };
+                                this.contracts[pool.crv_reward_contract.toLowerCase()] = {
+                                    contract: new ethers_1.Contract(pool.crv_reward_contract, streamer_json_1.default, this.signer || this.provider),
+                                    multicallContract: new ethcall_1.Contract(pool.crv_reward_contract, streamer_json_1.default),
+                                };
+                            }
                         }
                         this.contracts[exports.ALIASES.crv] = {
                             contract: new ethers_1.Contract(exports.ALIASES.crv, ERC20_json_1.default, this.signer || this.provider),

package/lib/interfaces.d.ts

@@ -2,6 +2,7 @@ export interface DictInterface<T> {
     [index: string]: T;
 }
 export interface PoolDataInterface {
+    reference_asset: 'USD' | 'EUR' | 'BTC' | 'ETH' | 'LINK' | 'CRYPTO';
     N_COINS: number;
     underlying_decimals: number[];
     decimals: number[];
@@ -48,4 +49,5 @@ export interface PoolDataInterface {
     reward_token?: string;
     reward_tokens?: string[];
     pool_type?: string;
+    crv_reward_contract?: string;
 }

package/lib/pools.d.ts

@@ -3,10 +3,12 @@ import BigNumber from 'bignumber.js';
 import { DictInterface } from './interfaces';
 export declare class Pool {
     name: string;
+    referenceAsset: string;
     swap: string;
     zap: string | null;
     lpToken: string;
     gauge: string;
+    crvRewardContract: string | null;
     underlyingCoins: string[];
     coins: string[];
     underlyingCoinAddresses: string[];
@@ -41,12 +43,31 @@ export declare class Pool {
         exchangeWrappedApprove: (inputCoin: string | number, amount: string) => Promise<number>;
         exchangeWrapped: (inputCoin: string | number, outputCoin: string | number, amount: string, maxSlippage: number) => Promise<number>;
     };
+    stats: {
+        getParameters: () => Promise<{
+            virtualPrice: string;
+            fee: string;
+            adminFee: string;
+            A: string;
+            gamma?: string;
+        }>;
+        getPoolBalances: () => Promise<string[]>;
+        getPoolWrappedBalances: () => Promise<string[]>;
+        getTotalLiquidity: () => Promise<string>;
+        getVolume: () => Promise<string>;
+        getBaseApy: () => Promise<[daily: string, weekly: string, monthly: string, total: string]>;
+        getTokenApy: () => Promise<[baseApy: string, boostedApy: string]>;
+    };
     constructor(name: string);
     calcLpTokenAmount: (amounts: string[], isDeposit?: boolean) => Promise<string>;
     calcLpTokenAmountWrapped: (amounts: string[], isDeposit?: boolean) => Promise<string>;
-    getVirtualPrice: () => Promise<string>;
-    getPoolBalances: () => Promise<string[]>;
-    getPoolWrappedBalances: () => Promise<string[]>;
+    private getParameters;
+    private getPoolBalances;
+    private getPoolWrappedBalances;
+    private getTotalLiquidity;
+    private getVolume;
+    private getBaseApy;
+    private getTokenApy;
     addLiquidityExpected: (amounts: string[]) => Promise<string>;
     addLiquiditySlippage: (amounts: string[]) => Promise<string>;
     addLiquidityIsApproved: (amounts: string[]) => Promise<boolean>;
@@ -121,7 +142,6 @@ export declare class Pool {
     gaugeMaxBoostedDeposit: (...addresses: string[]) => Promise<DictInterface<string>>;
     gaugeOptimalDeposits: (...accounts: string[]) => Promise<DictInterface<string>>;
     boost: (address: string) => Promise<string>;
-    getApy: () => Promise<string[]>;
     private _getCoinIdx;
     private _getRates;
     private _balances;

package/lib/pools.js

@@ -126,14 +126,30 @@ var Pool = /** @class */ (function () {
                 });
             });
         };
-        this.getVirtualPrice = function () { return __awaiter(_this, void 0, void 0, function () {
-            var _virtualPrice;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, curve_1.curve.contracts[this.swap].contract.get_virtual_price(curve_1.curve.constantOptions)];
+        this.getParameters = function () { return __awaiter(_this, void 0, void 0, function () {
+            var calls, _a, _virtualPrice, _fee, _adminFee, _A, _gamma, _c, virtualPrice, fee, adminFee, A, gamma;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        calls = [
+                            curve_1.curve.contracts[this.swap].multicallContract.get_virtual_price(),
+                            curve_1.curve.contracts[this.swap].multicallContract.fee(),
+                            curve_1.curve.contracts[this.swap].multicallContract.admin_fee(),
+                            curve_1.curve.contracts[this.swap].multicallContract.A(),
+                        ];
+                        if (this.isCrypto)
+                            calls.push(curve_1.curve.contracts[this.swap].multicallContract.gamma());
+                        return [4 /*yield*/, curve_1.curve.multicallProvider.all(calls)];
                     case 1:
-                        _virtualPrice = _a.sent();
-                        return [2 /*return*/, ethers_1.ethers.utils.formatUnits(_virtualPrice)];
+                        _a = _d.sent(), _virtualPrice = _a[0], _fee = _a[1], _adminFee = _a[2], _A = _a[3], _gamma = _a[4];
+                        _c = [
+                            ethers_1.ethers.utils.formatUnits(_virtualPrice),
+                            ethers_1.ethers.utils.formatUnits(_fee, 8),
+                            ethers_1.ethers.utils.formatUnits(_adminFee.mul(_fee)),
+                            ethers_1.ethers.utils.formatUnits(_A, 0),
+                            _gamma ? ethers_1.ethers.utils.formatUnits(_gamma) : _gamma,
+                        ], virtualPrice = _c[0], fee = _c[1], adminFee = _c[2], A = _c[3], gamma = _c[4];
+                        return [2 /*return*/, { virtualPrice: virtualPrice, fee: fee, adminFee: adminFee, A: A, gamma: gamma }];
                 }
             });
         }); };
@@ -180,9 +196,6 @@ var Pool = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (this.isFake) {
-                            throw Error("".concat(this.name, " pool doesn't have this method"));
-                        }
                         swapContract = curve_1.curve.contracts[this.swap].multicallContract;
                         contractCalls = this.coins.map(function (_, i) { return swapContract.balances(i); });
                         return [4 /*yield*/, curve_1.curve.multicallProvider.all(contractCalls)];
@@ -192,6 +205,107 @@ var Pool = /** @class */ (function () {
                 }
             });
         }); };
+        this.getTotalLiquidity = function () { return __awaiter(_this, void 0, void 0, function () {
+            var balances, promises, _i, _a, addr, prices, totalLiquidity;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0: return [4 /*yield*/, this.getPoolWrappedBalances()];
+                    case 1:
+                        balances = _c.sent();
+                        promises = [];
+                        for (_i = 0, _a = this.coinAddresses; _i < _a.length; _i++) {
+                            addr = _a[_i];
+                            promises.push((0, utils_1._getUsdRate)(addr));
+                        }
+                        return [4 /*yield*/, Promise.all(promises)];
+                    case 2:
+                        prices = _c.sent();
+                        totalLiquidity = balances.reduce(function (liquidity, b, i) { return liquidity + (Number(b) * prices[i]); }, 0);
+                        return [2 /*return*/, String(totalLiquidity)];
+                }
+            });
+        }); };
+        this.getVolume = function () { return __awaiter(_this, void 0, void 0, function () {
+            var name, statsUrl, volume, usdRate, _a;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        name = (this.name === 'ren' && curve_1.curve.chainId === 1) ? 'ren2' : this.name === 'sbtc' ? 'rens' : this.name;
+                        statsUrl = (0, utils_1._getStatsUrl)(this.isCrypto);
+                        return [4 /*yield*/, axios_1.default.get(statsUrl)];
+                    case 1:
+                        volume = (_c.sent()).data.volume[name] || 0;
+                        if (!this.isCrypto) return [3 /*break*/, 2];
+                        _a = 1;
+                        return [3 /*break*/, 4];
+                    case 2: return [4 /*yield*/, (0, utils_1._getUsdRate)(this.referenceAsset)];
+                    case 3:
+                        _a = _c.sent();
+                        _c.label = 4;
+                    case 4:
+                        usdRate = _a;
+                        return [2 /*return*/, String(volume * usdRate)];
+                }
+            });
+        }); };
+        this.getBaseApy = function () { return __awaiter(_this, void 0, void 0, function () {
+            var name, statsUrl, apy;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        name = (this.name === 'ren' && curve_1.curve.chainId === 1) ? 'ren2' : this.name === 'sbtc' ? 'rens' : this.name;
+                        statsUrl = (0, utils_1._getStatsUrl)(this.isCrypto);
+                        return [4 /*yield*/, axios_1.default.get(statsUrl)];
+                    case 1:
+                        apy = (_a.sent()).data.apy;
+                        return [2 /*return*/, [apy.day[name], apy.week[name], apy.month[name], apy.total[name]].map(function (x) { return (x * 100).toFixed(4); })];
+                }
+            });
+        }); };
+        this.getTokenApy = function () { return __awaiter(_this, void 0, void 0, function () {
+            var rewardContract, totalLiquidityUSD, crvRate, inflation, _a, baseApy, gaugeContract, lpTokenContract, gaugeControllerContract, totalLiquidityUSD, _c, inflation, weight, workingSupply, totalSupply, rate, crvRate, baseApy, boostedApy;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        if (!(curve_1.curve.chainId === 137)) return [3 /*break*/, 4];
+                        rewardContract = curve_1.curve.contracts[this.crvRewardContract].contract;
+                        return [4 /*yield*/, this.getTotalLiquidity()];
+                    case 1:
+                        totalLiquidityUSD = _d.sent();
+                        return [4 /*yield*/, (0, utils_1._getUsdRate)(curve_1.ALIASES.crv)];
+                    case 2:
+                        crvRate = _d.sent();
+                        _a = utils_1.toBN;
+                        return [4 /*yield*/, rewardContract.reward_data(curve_1.ALIASES.crv, curve_1.curve.constantOptions)];
+                    case 3:
+                        inflation = _a.apply(void 0, [(_d.sent()).rate]);
+                        baseApy = inflation.times(31536000).times(crvRate).div(Number(totalLiquidityUSD));
+                        return [2 /*return*/, [baseApy.times(100).toFixed(4), ""]];
+                    case 4:
+                        gaugeContract = curve_1.curve.contracts[this.gauge].multicallContract;
+                        lpTokenContract = curve_1.curve.contracts[this.lpToken].multicallContract;
+                        gaugeControllerContract = curve_1.curve.contracts[curve_1.ALIASES.gauge_controller].multicallContract;
+                        return [4 /*yield*/, this.getTotalLiquidity()];
+                    case 5:
+                        totalLiquidityUSD = _d.sent();
+                        return [4 /*yield*/, curve_1.curve.multicallProvider.all([
+                                gaugeContract.inflation_rate(),
+                                gaugeControllerContract.gauge_relative_weight(this.gauge),
+                                gaugeContract.working_supply(),
+                                lpTokenContract.totalSupply(),
+                            ])];
+                    case 6:
+                        _c = (_d.sent()).map(function (value) { return (0, utils_1.toBN)(value); }), inflation = _c[0], weight = _c[1], workingSupply = _c[2], totalSupply = _c[3];
+                        rate = inflation.times(weight).times(31536000).times(0.4).div(workingSupply).times(totalSupply).div(Number(totalLiquidityUSD));
+                        return [4 /*yield*/, (0, utils_1._getUsdRate)(curve_1.ALIASES.crv)];
+                    case 7:
+                        crvRate = _d.sent();
+                        baseApy = rate.times(crvRate);
+                        boostedApy = baseApy.times(2.5);
+                        return [2 /*return*/, [baseApy.times(100).toFixed(4), boostedApy.times(100).toFixed(4)]];
+                }
+            });
+        }); };
         this.addLiquidityExpected = function (amounts) { return __awaiter(_this, void 0, void 0, function () {
             var _this = this;
             return __generator(this, function (_a) {
@@ -1718,32 +1832,6 @@ var Pool = /** @class */ (function () {
                 }
             });
         }); };
-        this.getApy = function () { return __awaiter(_this, void 0, void 0, function () {
-            var swapContract, gaugeContract, gaugeControllerContract, _a, inflation, weight, workingSupply, virtualPrice, rate, crvRate, baseApy, boostedApy;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        swapContract = curve_1.curve.contracts[this.swap].multicallContract;
-                        gaugeContract = curve_1.curve.contracts[this.gauge].multicallContract;
-                        gaugeControllerContract = curve_1.curve.contracts[curve_1.ALIASES.gauge_controller].multicallContract;
-                        return [4 /*yield*/, curve_1.curve.multicallProvider.all([
-                                gaugeContract.inflation_rate(),
-                                gaugeControllerContract.gauge_relative_weight(this.gauge),
-                                gaugeContract.working_supply(),
-                                swapContract.get_virtual_price(),
-                            ])];
-                    case 1:
-                        _a = (_c.sent()).map(function (value) { return (0, utils_1.toBN)(value); }), inflation = _a[0], weight = _a[1], workingSupply = _a[2], virtualPrice = _a[3];
-                        rate = inflation.times(weight).times(31536000).div(workingSupply).times(0.4).div(virtualPrice);
-                        return [4 /*yield*/, (0, utils_1.getCrvRate)()];
-                    case 2:
-                        crvRate = _c.sent();
-                        baseApy = rate.times(crvRate);
-                        boostedApy = baseApy.times(2.5);
-                        return [2 /*return*/, [baseApy.toFixed(4), boostedApy.toFixed(4)]];
-                }
-            });
-        }); };
         this._getCoinIdx = function (coin, useUnderlying) {
             if (useUnderlying === void 0) { useUnderlying = true; }
             if (typeof coin === 'number') {
@@ -2647,10 +2735,12 @@ var Pool = /** @class */ (function () {
         }); };
         var poolData = curve_1.POOLS_DATA[name];
         this.name = name;
+        this.referenceAsset = poolData.reference_asset;
         this.swap = poolData.swap_address;
         this.zap = poolData.deposit_address || null;
         this.lpToken = poolData.token_address;
         this.gauge = poolData.gauge_address;
+        this.crvRewardContract = poolData.crv_reward_contract || null;
         this.underlyingCoins = poolData.underlying_coins;
         this.coins = poolData.coins;
         this.underlyingCoinAddresses = poolData.underlying_coin_addresses;
@@ -2685,6 +2775,15 @@ var Pool = /** @class */ (function () {
             exchangeWrappedApprove: this.exchangeWrappedApproveEstimateGas,
             exchangeWrapped: this.exchangeWrappedEstimateGas,
         };
+        this.stats = {
+            getParameters: this.getParameters,
+            getPoolBalances: this.getPoolBalances,
+            getPoolWrappedBalances: this.getPoolWrappedBalances,
+            getTotalLiquidity: this.getTotalLiquidity,
+            getVolume: this.getVolume,
+            getBaseApy: this.getBaseApy,
+            getTokenApy: this.getTokenApy,
+        };
         if (this.isMeta && !this.isFake) {
             var metaCoins = poolData.meta_coin_addresses;
             var metaCoinDecimals = poolData.meta_coin_decimals;

package/lib/utils.d.ts

@@ -20,5 +20,5 @@ export declare const _ensureAllowance: (coins: string[], amounts: ethers.BigNumb
 export declare const ensureAllowanceEstimateGas: (coins: string[], amounts: string[], spender: string) => Promise<number>;
 export declare const ensureAllowance: (coins: string[], amounts: string[], spender: string) => Promise<string[]>;
 export declare const getPoolNameBySwapAddress: (swapAddress: string) => string;
-export declare const getCrvRate: () => Promise<number>;
 export declare const _getUsdRate: (assetId: string) => Promise<number>;
+export declare const _getStatsUrl: (isCrypto?: boolean) => string;

package/lib/utils.js

@@ -59,7 +59,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._getUsdRate = exports.getCrvRate = exports.getPoolNameBySwapAddress = exports.ensureAllowance = exports.ensureAllowanceEstimateGas = exports._ensureAllowance = exports.hasAllowance = exports.getAllowance = exports._getAllowance = exports.getBalances = exports._prepareAddresses = exports._getBalances = exports._getCoinDecimals = exports._getCoinAddresses = exports.getEthIndex = exports.isEth = exports.fromBN = exports.toStringFromBN = exports.toBN = exports.BN = exports.MAX_ALLOWANCE = void 0;
+exports._getStatsUrl = exports._getUsdRate = exports.getPoolNameBySwapAddress = exports.ensureAllowance = exports.ensureAllowanceEstimateGas = exports._ensureAllowance = exports.hasAllowance = exports.getAllowance = exports._getAllowance = exports.getBalances = exports._prepareAddresses = exports._getBalances = exports._getCoinDecimals = exports._getCoinAddresses = exports.getEthIndex = exports.isEth = exports.fromBN = exports.toStringFromBN = exports.toBN = exports.BN = exports.MAX_ALLOWANCE = void 0;
 var axios_1 = __importDefault(require("axios"));
 var ethers_1 = require("ethers");
 var bignumber_js_1 = __importDefault(require("bignumber.js"));
@@ -72,12 +72,12 @@ var BN = function (val) { return new bignumber_js_1.default(val); };
 exports.BN = BN;
 var toBN = function (n, decimals) {
     if (decimals === void 0) { decimals = 18; }
-    return (0, exports.BN)(ethers_1.ethers.utils.formatUnits(n, decimals)).times(decimals);
+    return (0, exports.BN)(ethers_1.ethers.utils.formatUnits(n, decimals));
 };
 exports.toBN = toBN;
 var toStringFromBN = function (bn, decimals) {
     if (decimals === void 0) { decimals = 18; }
-    return bn.div(decimals).toFixed(decimals);
+    return bn.toFixed(decimals);
 };
 exports.toStringFromBN = toStringFromBN;
 var fromBN = function (bn, decimals) {
@@ -373,41 +373,39 @@ var getPoolNameBySwapAddress = function (swapAddress) {
     })[0][0];
 };
 exports.getPoolNameBySwapAddress = getPoolNameBySwapAddress;
-var _crvRateCache = {
-    'rate': 0,
-    'time': 0,
-};
-var getCrvRate = function () { return __awaiter(void 0, void 0, void 0, function () {
-    var crvAddress, response;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0:
-                crvAddress = "0xd533a949740bb3306d119cc777fa900ba034cd52";
-                crvAddress = crvAddress.toLowerCase();
-                if (!(_crvRateCache.time + 60000 < Date.now())) return [3 /*break*/, 2];
-                return [4 /*yield*/, axios_1.default.get("https://api.coingecko.com/api/v3/simple/token_price/ethereum?contract_addresses=".concat(crvAddress, "&vs_currencies=usd"))];
-            case 1:
-                response = _a.sent();
-                _crvRateCache['rate'] = response.data[crvAddress]['usd'];
-                _crvRateCache['time'] = Date.now();
-                _a.label = 2;
-            case 2: return [2 /*return*/, _crvRateCache['rate']];
-        }
-    });
-}); };
-exports.getCrvRate = getCrvRate;
 var _usdRatesCache = {};
 var _getUsdRate = function (assetId) { return __awaiter(void 0, void 0, void 0, function () {
-    var url, response;
+    var chainName, url, response;
     var _a;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
+                if (assetId === 'USD' || (curve_1.curve.chainId === 137 && (assetId.toLowerCase() === curve_2.COINS.am3crv.toLowerCase())))
+                    return [2 /*return*/, 1];
+                chainName = {
+                    1: 'ethereum',
+                    137: 'polygon-pos',
+                    1337: 'ethereum',
+                }[curve_1.curve.chainId];
+                if (chainName === undefined) {
+                    throw Error('curve object is not initialized');
+                }
+                assetId = {
+                    'EUR': curve_2.COINS.eurt,
+                    'BTC': 'bitcoin',
+                    'ETH': 'ethereum',
+                    'LINK': 'link',
+                }[assetId] || assetId;
                 assetId = (0, exports.isEth)(assetId) ? "ethereum" : assetId.toLowerCase();
+                // No EURT on Coingecko Polygon
+                if (assetId.toLowerCase() === curve_2.COINS.eurt.toLowerCase()) {
+                    chainName = 'ethereum';
+                    assetId = '0xC581b735A1688071A1746c968e0798D642EDE491'.toLowerCase(); // EURT Ethereum
+                }
                 if (!((((_a = _usdRatesCache[assetId]) === null || _a === void 0 ? void 0 : _a.time) || 0) + 600000 < Date.now())) return [3 /*break*/, 2];
-                url = assetId.toLowerCase() === "ethereum" ?
+                url = ['bitcoin', 'ethereum', 'link'].includes(assetId.toLowerCase()) ?
                     "https://api.coingecko.com/api/v3/simple/price?ids=".concat(assetId, "&vs_currencies=usd") :
-                    "https://api.coingecko.com/api/v3/simple/token_price/ethereum?contract_addresses=".concat(assetId, "&vs_currencies=usd");
+                    "https://api.coingecko.com/api/v3/simple/token_price/".concat(chainName, "?contract_addresses=").concat(assetId, "&vs_currencies=usd");
                 return [4 /*yield*/, axios_1.default.get(url)];
             case 1:
                 response = _b.sent();
@@ -418,3 +416,16 @@ var _getUsdRate = function (assetId) { return __awaiter(void 0, void 0, void 0,
     });
 }); };
 exports._getUsdRate = _getUsdRate;
+var _getStatsUrl = function (isCrypto) {
+    if (isCrypto === void 0) { isCrypto = false; }
+    if (curve_1.curve.chainId === 1 || curve_1.curve.chainId === 1337) {
+        return isCrypto ? "http://stats.curve.fi/raw-stats-crypto/apys.json" : "http://stats.curve.fi/raw-stats/apys.json";
+    }
+    else if (curve_1.curve.chainId === 137) {
+        return "http://stats.curve.fi/raw-stats-polygon/apys.json";
+    }
+    else {
+        throw Error("Unsupported network id".concat(curve_1.curve.chainId));
+    }
+};
+exports._getStatsUrl = _getStatsUrl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curvefi/api",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "JavaScript library for curve.fi",
   "main": "lib/index.js",
   "scripts": {