@curvefi/api 1.21.0 → 1.22.0

package/README.md

@@ -241,6 +241,9 @@ import curve from "@curvefi/api";
 
 (async () => {
     await curve.init('JsonRpc', {}, {gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0});
+    
+    console.log(await curve.getTVL());
+    // 19281307454.671753
 
     const aave = new curve.Pool('aave');
 

package/lib/external-api.d.ts

@@ -0,0 +1,3 @@
+import { IExtendedPoolDataFromApi } from "./interfaces";
+import memoize from "memoizee";
+export declare const _getPoolsFromApi: ((network: "ethereum" | "polygon", poolType: "main" | "crypto" | "factory" | "factory-crypto") => Promise<IExtendedPoolDataFromApi>) & memoize.Memoized<(network: "ethereum" | "polygon", poolType: "main" | "crypto" | "factory" | "factory-crypto") => Promise<IExtendedPoolDataFromApi>>;

package/lib/external-api.js

@@ -0,0 +1,67 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._getPoolsFromApi = void 0;
+var axios_1 = __importDefault(require("axios"));
+var memoizee_1 = __importDefault(require("memoizee"));
+exports._getPoolsFromApi = (0, memoizee_1.default)(function (network, poolType) { return __awaiter(void 0, void 0, void 0, function () {
+    var url, response, err_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                url = "https://api.curve.fi/api/getPools/".concat(network, "/").concat(poolType);
+                _a.label = 1;
+            case 1:
+                _a.trys.push([1, 3, , 4]);
+                return [4 /*yield*/, axios_1.default.get(url)];
+            case 2:
+                response = _a.sent();
+                return [2 /*return*/, response.data.data];
+            case 3:
+                err_1 = _a.sent();
+                return [2 /*return*/, { poolData: [], tvl: 0, tvlAll: 0 }];
+            case 4: return [2 /*return*/];
+        }
+    });
+}); }, {
+    promise: true,
+    maxAge: 5 * 60 * 1000, // 5m
+});

package/lib/index.d.ts

@@ -30,6 +30,7 @@ declare const curve: {
     getFactoryPoolList: () => string[];
     getCryptoFactoryPoolList: () => string[];
     getUsdRate: (coin: string) => Promise<number>;
+    getTVL: (chainId?: number) => Promise<number>;
     setCustomFeeData: typeof setCustomFeeData;
     signerAddress: string;
     chainId: number;

package/lib/index.js

@@ -94,6 +94,7 @@ var curve = {
     getFactoryPoolList: utils_1.getFactoryPoolList,
     getCryptoFactoryPoolList: utils_1.getCryptoFactoryPoolList,
     getUsdRate: utils_1.getUsdRate,
+    getTVL: utils_1.getTVL,
     setCustomFeeData: setCustomFeeData,
     signerAddress: '',
     chainId: 0,

package/lib/interfaces.d.ts

@@ -92,6 +92,7 @@ export interface ICoinFromPoolDataApi {
     address: string;
     symbol: string;
     decimals: string;
+    usdPrice: number | string;
 }
 export interface IPoolDataFromApi {
     id: string;
@@ -104,6 +105,12 @@ export interface IPoolDataFromApi {
     implementation: string;
     implementationAddress: string;
     coins: ICoinFromPoolDataApi[];
+    usdTotal: number;
+}
+export interface IExtendedPoolDataFromApi {
+    poolData: IPoolDataFromApi[];
+    tvl?: number;
+    tvlAll: number;
 }
 export interface RewardsApyInterface {
     token: string;

package/lib/pools.d.ts

@@ -64,7 +64,7 @@ export declare class Pool {
         }>;
         getPoolBalances: () => Promise<string[]>;
         getPoolWrappedBalances: () => Promise<string[]>;
-        getTotalLiquidity: () => Promise<string>;
+        getTotalLiquidity: (useApi?: boolean) => Promise<string>;
         getVolume: () => Promise<string>;
         getBaseApy: () => Promise<{
             day: string;

package/lib/pools.js

@@ -60,10 +60,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUserPoolList = exports.crossAssetExchange = exports.crossAssetExchangeEstimateGas = exports.crossAssetExchangeApprove = exports.crossAssetExchangeApproveEstimateGas = exports.crossAssetExchangeIsApproved = exports.crossAssetExchangeExpected = exports.crossAssetExchangeOutputAndSlippage = exports._crossAssetExchangeInfo = exports._getSmallAmountForCoin = exports.crossAssetExchangeAvailable = exports.exchange = exports.exchangeEstimateGas = exports.exchangeApprove = exports.exchangeApproveEstimateGas = exports.exchangeIsApproved = exports.exchangeExpected = exports.getBestPoolAndOutput = exports.Pool = void 0;
+var axios_1 = __importDefault(require("axios"));
 var ethers_1 = require("ethers");
+var external_api_1 = require("./external-api");
 var utils_1 = require("./utils");
 var curve_1 = require("./curve");
-var axios_1 = __importDefault(require("axios"));
 var Pool = /** @class */ (function () {
     function Pool(id) {
         var _this = this;
@@ -224,26 +225,48 @@ 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.getPoolBalances()];
-                    case 1:
-                        balances = _c.sent();
-                        promises = [];
-                        for (_i = 0, _a = this.underlyingCoinAddresses; _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*/, totalLiquidity.toFixed(8)];
-                }
+        this.getTotalLiquidity = function (useApi) {
+            if (useApi === void 0) { useApi = true; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var network, poolType, poolsData, totalLiquidity_1, balances, promises, _i, _a, addr, prices, totalLiquidity;
+                var _this = this;
+                return __generator(this, function (_c) {
+                    switch (_c.label) {
+                        case 0:
+                            if (!useApi) return [3 /*break*/, 2];
+                            network = curve_1.curve.chainId === 137 ? "polygon" : "ethereum";
+                            poolType = !this.isFactory && !this.isCrypto ? "main" :
+                                !this.isFactory ? "crypto" :
+                                    !this.isCryptoFactory ? "factory" :
+                                        "factory-crypto";
+                            return [4 /*yield*/, (0, external_api_1._getPoolsFromApi)(network, poolType)];
+                        case 1:
+                            poolsData = (_c.sent()).poolData;
+                            try {
+                                totalLiquidity_1 = poolsData.filter(function (data) { return data.address.toLowerCase() === _this.swap.toLowerCase(); })[0].usdTotal;
+                                return [2 /*return*/, String(totalLiquidity_1)];
+                            }
+                            catch (err) {
+                                console.log(err.message);
+                            }
+                            _c.label = 2;
+                        case 2: return [4 /*yield*/, this.getPoolBalances()];
+                        case 3:
+                            balances = _c.sent();
+                            promises = [];
+                            for (_i = 0, _a = this.underlyingCoinAddresses; _i < _a.length; _i++) {
+                                addr = _a[_i];
+                                promises.push((0, utils_1._getUsdRate)(addr));
+                            }
+                            return [4 /*yield*/, Promise.all(promises)];
+                        case 4:
+                            prices = _c.sent();
+                            totalLiquidity = balances.reduce(function (liquidity, b, i) { return liquidity + (Number(b) * prices[i]); }, 0);
+                            return [2 /*return*/, totalLiquidity.toFixed(8)];
+                    }
+                });
             });
-        }); };
+        };
         this._getPoolStats = function () { return __awaiter(_this, void 0, void 0, function () {
             var statsUrl, name, key;
             return __generator(this, function (_a) {
@@ -273,7 +296,7 @@ var Pool = /** @class */ (function () {
                         if (!(this.isCrypto || (curve_1.curve.chainId === 1 && this.isFactory))) return [3 /*break*/, 2];
                         _a = 1;
                         return [3 /*break*/, 4];
-                    case 2: return [4 /*yield*/, (0, utils_1._getUsdRate)(this.referenceAsset)];
+                    case 2: return [4 /*yield*/, (0, utils_1._getUsdRate)(this.coinAddresses[0])];
                     case 3:
                         _a = _c.sent();
                         _c.label = 4;

package/lib/utils.d.ts

@@ -21,6 +21,7 @@ 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 _getUsdPricesFromApi: () => Promise<DictInterface<number>>;
 export declare const _getUsdRate: (assetId: string) => Promise<number>;
 export declare const _getFactoryStatsUrl: () => string;
 export declare const _getStatsUrl: (isCrypto?: boolean) => string;
@@ -31,3 +32,4 @@ export declare const getPoolList: () => string[];
 export declare const getFactoryPoolList: () => string[];
 export declare const getCryptoFactoryPoolList: () => string[];
 export declare const getUsdRate: (coin: string) => Promise<number>;
+export declare const getTVL: (chainId?: number) => Promise<number>;

package/lib/utils.js

@@ -59,13 +59,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUsdRate = exports.getCryptoFactoryPoolList = exports.getFactoryPoolList = exports.getPoolList = exports._getFactoryStatsPolygon = exports._getFactoryStatsEthereum = exports._getStats = exports._getStatsUrl = exports._getFactoryStatsUrl = 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;
+exports.getTVL = exports.getUsdRate = exports.getCryptoFactoryPoolList = exports.getFactoryPoolList = exports.getPoolList = exports._getFactoryStatsPolygon = exports._getFactoryStatsEthereum = exports._getStats = exports._getStatsUrl = exports._getFactoryStatsUrl = exports._getUsdRate = exports._getUsdPricesFromApi = 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 memoizee_1 = __importDefault(require("memoizee"));
 var ethers_1 = require("ethers");
 var bignumber_js_1 = __importDefault(require("bignumber.js"));
 var curve_1 = require("./curve");
 var curve_2 = require("./curve");
+var external_api_1 = require("./external-api");
 var ETH_ADDRESS = '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE';
 exports.MAX_ALLOWANCE = ethers_1.ethers.BigNumber.from(2).pow(ethers_1.ethers.BigNumber.from(256)).sub(ethers_1.ethers.BigNumber.from(1));
 // bignumber.js
@@ -374,13 +375,49 @@ var getPoolNameBySwapAddress = function (swapAddress) {
     })[0][0];
 };
 exports.getPoolNameBySwapAddress = getPoolNameBySwapAddress;
+var _getUsdPricesFromApi = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var network, promises, allTypesExtendedPoolData, priceDict, _i, allTypesExtendedPoolData_1, extendedPoolData, _a, _b, pool, _c, _d, coin;
+    return __generator(this, function (_e) {
+        switch (_e.label) {
+            case 0:
+                network = curve_1.curve.chainId === 137 ? "polygon" : "ethereum";
+                promises = [
+                    (0, external_api_1._getPoolsFromApi)(network, "main"),
+                    (0, external_api_1._getPoolsFromApi)(network, "crypto"),
+                    (0, external_api_1._getPoolsFromApi)(network, "factory"),
+                    (0, external_api_1._getPoolsFromApi)(network, "factory-crypto"),
+                ];
+                return [4 /*yield*/, Promise.all(promises)];
+            case 1:
+                allTypesExtendedPoolData = _e.sent();
+                priceDict = {};
+                for (_i = 0, allTypesExtendedPoolData_1 = allTypesExtendedPoolData; _i < allTypesExtendedPoolData_1.length; _i++) {
+                    extendedPoolData = allTypesExtendedPoolData_1[_i];
+                    for (_a = 0, _b = extendedPoolData.poolData; _a < _b.length; _a++) {
+                        pool = _b[_a];
+                        for (_c = 0, _d = pool.coins; _c < _d.length; _c++) {
+                            coin = _d[_c];
+                            if (typeof coin.usdPrice === "number")
+                                priceDict[coin.address.toLowerCase()] = coin.usdPrice;
+                        }
+                    }
+                }
+                return [2 /*return*/, priceDict];
+        }
+    });
+}); };
+exports._getUsdPricesFromApi = _getUsdPricesFromApi;
 var _usdRatesCache = {};
 var _getUsdRate = function (assetId) { return __awaiter(void 0, void 0, void 0, function () {
-    var chainName, url, response;
+    var pricesFromApi, chainName, url, response;
     var _a, _b;
     return __generator(this, function (_c) {
         switch (_c.label) {
-            case 0:
+            case 0: return [4 /*yield*/, (0, exports._getUsdPricesFromApi)()];
+            case 1:
+                pricesFromApi = _c.sent();
+                if (assetId.toLowerCase() in pricesFromApi)
+                    return [2 /*return*/, pricesFromApi[assetId.toLowerCase()]];
                 if (assetId === 'USD' || (curve_1.curve.chainId === 137 && (assetId.toLowerCase() === curve_2.COINS.am3crv.toLowerCase())))
                     return [2 /*return*/, 1];
                 chainName = {
@@ -403,12 +440,12 @@ var _getUsdRate = function (assetId) { return __awaiter(void 0, void 0, void 0,
                     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];
+                if (!((((_a = _usdRatesCache[assetId]) === null || _a === void 0 ? void 0 : _a.time) || 0) + 600000 < Date.now())) return [3 /*break*/, 3];
                 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/".concat(chainName, "?contract_addresses=").concat(assetId, "&vs_currencies=usd");
                 return [4 /*yield*/, axios_1.default.get(url)];
-            case 1:
+            case 2:
                 response = _c.sent();
                 try {
                     _usdRatesCache[assetId] = { 'rate': (_b = response.data[assetId]['usd']) !== null && _b !== void 0 ? _b : 1, 'time': Date.now() };
@@ -416,8 +453,8 @@ var _getUsdRate = function (assetId) { return __awaiter(void 0, void 0, void 0,
                 catch (err) { // TODO pay attention!
                     _usdRatesCache[assetId] = { 'rate': 1, 'time': Date.now() };
                 }
-                _c.label = 2;
-            case 2: return [2 /*return*/, _usdRatesCache[assetId]['rate']];
+                _c.label = 3;
+            case 3: return [2 /*return*/, _usdRatesCache[assetId]['rate']];
         }
     });
 }); };
@@ -546,3 +583,26 @@ var getUsdRate = function (coin) { return __awaiter(void 0, void 0, void 0, func
     });
 }); };
 exports.getUsdRate = getUsdRate;
+var getTVL = function (chainId) {
+    if (chainId === void 0) { chainId = curve_1.curve.chainId; }
+    return __awaiter(void 0, void 0, void 0, function () {
+        var network, promises, allTypesExtendedPoolData;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    network = chainId === 137 ? "polygon" : "ethereum";
+                    promises = [
+                        (0, external_api_1._getPoolsFromApi)(network, "main"),
+                        (0, external_api_1._getPoolsFromApi)(network, "crypto"),
+                        (0, external_api_1._getPoolsFromApi)(network, "factory"),
+                        (0, external_api_1._getPoolsFromApi)(network, "factory-crypto"),
+                    ];
+                    return [4 /*yield*/, Promise.all(promises)];
+                case 1:
+                    allTypesExtendedPoolData = _a.sent();
+                    return [2 /*return*/, allTypesExtendedPoolData.reduce(function (sum, data) { var _a; return sum + ((_a = data.tvl) !== null && _a !== void 0 ? _a : data.tvlAll); }, 0)];
+            }
+        });
+    });
+};
+exports.getTVL = getTVL;

package/package.json

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