@gearbox-protocol/sdk 1.18.0 → 1.18.2

package/lib/apy/convexAPY.d.ts

@@ -1,13 +1,14 @@
 import { BigNumber, providers } from "ethers";
 import { ConvexPoolContract, ConvexPoolParams } from "../contracts/contracts";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { CurveLPToken } from "../tokens/curveLP";
 import { SupportedToken } from "../tokens/token";
 import { CurveAPYResult } from "./curveAPY";
+declare type GetTokenPriceCallback = (tokenAddress: string, currency?: string) => BigNumber;
 export interface GetConvexAPYBaseProps {
     provider: providers.Provider;
     networkType: NetworkType;
-    getTokenPrice: (tokenAddress: string) => BigNumber;
+    getTokenPrice: GetTokenPriceCallback;
     curveAPY: CurveAPYResult;
 }
 export interface GetConvexAPYBulkProps extends GetConvexAPYBaseProps {
@@ -28,7 +29,8 @@ export interface CalculateConvexAPYProps {
     extraPoolAddresses: string[];
     poolParams: ConvexPoolParams;
     underlying: CurveLPToken;
-    getTokenPrice: (tokenAddress: string) => BigNumber;
+    getTokenPrice: GetTokenPriceCallback;
     curveAPY: CurveAPYResult;
     tokenList: Record<SupportedToken, string>;
 }
+export {};

package/lib/apy/convexAPY.js

@@ -203,10 +203,15 @@ function getCVXMintAmount(crvAmount, cvxSupply) {
     return ethers_1.BigNumber.from(0);
 }
 exports.getCVXMintAmount = getCVXMintAmount;
+var CURRENCY_LIST = {
+    stkcvxsteCRV: "WETH",
+};
 function calculateConvexAPY(_a) {
     var basePoolRate = _a.basePoolRate, basePoolSupply = _a.basePoolSupply, vPrice = _a.vPrice, cvxSupply = _a.cvxSupply, extra = _a.extra, extraPoolAddresses = _a.extraPoolAddresses, poolParams = _a.poolParams, underlying = _a.underlying, getTokenPrice = _a.getTokenPrice, curveAPY = _a.curveAPY, tokenList = _a.tokenList;
-    var cvxPrice = getTokenPrice(tokenList.CVX);
-    var crvPrice = getTokenPrice(tokenList.CRV);
+    var currencySymbol = CURRENCY_LIST[poolParams.stakedToken];
+    var currency = currencySymbol && tokenList[currencySymbol || ""];
+    var cvxPrice = getTokenPrice(tokenList.CVX, currency);
+    var crvPrice = getTokenPrice(tokenList.CRV, currency);
     var crvPerSecond = basePoolRate;
     var virtualSupply = basePoolSupply.mul(vPrice).div(constants_1.WAD);
     var crvPerUnderlying = crvPerSecond.mul(constants_1.WAD).div(virtualSupply);
@@ -219,7 +224,7 @@ function calculateConvexAPY(_a) {
         var extraPoolRate = extra[index];
         var perUnderlying = extraPoolRate.mul(constants_1.WAD).div(virtualSupply);
         var perYear = perUnderlying.mul(constants_1.SECONDS_PER_YEAR);
-        var extraPrice = getTokenPrice(tokenList[extraRewardSymbol]);
+        var extraPrice = getTokenPrice(tokenList[extraRewardSymbol], currency);
         var extraAPY = perYear.mul(extraPrice).div(constants_1.PRICE_DECIMALS);
         return extraAPY;
     });

package/lib/apy/lidoAPY.d.ts

@@ -1,4 +1,4 @@
 import { providers } from "ethers";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 export declare function getLidoAPY(provider: providers.Provider, networkType: NetworkType): Promise<readonly [import("ethers").BigNumber, number]>;
 export declare const LIDO_FEE_DECIMALS = 10000;

package/lib/contracts/contracts.d.ts

@@ -1,4 +1,4 @@
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { ConvexStakedPhantomToken } from "../tokens/convex";
 import type { CurveLPToken } from "../tokens/curveLP";
 import { NormalToken } from "../tokens/normal";

package/lib/contracts/contractsRegister.d.ts

@@ -1,4 +1,4 @@
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 export declare const stEthPoolWrapper: Record<NetworkType, string>;
 export declare const CREDIT_MANAGER_DAI_V2_MAINNET: string;
 export declare const CREDIT_MANAGER_USDC_V2_MAINNET: string;

package/lib/core/chains.d.ts

@@ -0,0 +1,15 @@
+import { ethers } from "ethers";
+export declare const MAINNET_NETWORK = 1;
+export declare const GOERLI_NETWORK = 5;
+export declare const LOCAL_NETWORK = 1337;
+export declare const HARDHAT_NETWORK = 31337;
+export declare const CHAINS: {
+    readonly Mainnet: 1;
+    readonly Goerli: 5;
+    readonly Local: 1337;
+    readonly Hardhat: 31337;
+};
+export declare type NetworkType = "Mainnet" | "Goerli";
+export declare const getNetworkType: (chainId: number, localAs?: NetworkType) => NetworkType;
+export declare const isSupportedNetwork: (chainId: number | undefined) => chainId is number;
+export declare function detectNetwork(provider: ethers.providers.Provider): Promise<NetworkType>;

package/lib/{utils/network.js → core/chains.js}

@@ -35,11 +35,41 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEtherscan = exports.detectNetwork = void 0;
-var constants_1 = require("../core/constants");
+exports.detectNetwork = exports.isSupportedNetwork = exports.getNetworkType = exports.CHAINS = exports.HARDHAT_NETWORK = exports.LOCAL_NETWORK = exports.GOERLI_NETWORK = exports.MAINNET_NETWORK = void 0;
 var token_1 = require("../tokens/token");
 var types_1 = require("../types");
+var constants_1 = require("./constants");
+exports.MAINNET_NETWORK = 1;
+exports.GOERLI_NETWORK = 5;
+exports.LOCAL_NETWORK = 1337;
+exports.HARDHAT_NETWORK = 31337;
+exports.CHAINS = {
+    Mainnet: exports.MAINNET_NETWORK,
+    Goerli: exports.GOERLI_NETWORK,
+    Local: exports.LOCAL_NETWORK,
+    Hardhat: exports.HARDHAT_NETWORK,
+};
+var SUPPORTED_CHAINS = (_a = {},
+    _a[exports.CHAINS.Mainnet] = "Mainnet",
+    _a[exports.CHAINS.Goerli] = "Goerli",
+    _a[exports.CHAINS.Local] = "Mainnet",
+    _a);
+var getNetworkType = function (chainId, localAs) {
+    if (localAs === void 0) { localAs = "Mainnet"; }
+    var chainType = SUPPORTED_CHAINS[chainId];
+    if (chainId === exports.CHAINS.Local) {
+        return localAs;
+    }
+    else if (chainType) {
+        return chainType;
+    }
+    throw new Error("Unsupported network");
+};
+exports.getNetworkType = getNetworkType;
+var isSupportedNetwork = function (chainId) { return chainId !== undefined && !!SUPPORTED_CHAINS[chainId]; };
+exports.isSupportedNetwork = isSupportedNetwork;
 function detectNetwork(provider) {
     return __awaiter(this, void 0, void 0, function () {
         var usdcMainnet, _a, usdcMainnet, _b;
@@ -64,7 +94,7 @@ function detectNetwork(provider) {
                     return [2 /*return*/, "Goerli"];
                 case 5:
                     _b = _c.sent();
-                    throw new Error("Unknown network");
+                    throw new Error("Unsupported network");
                 case 6: return [3 /*break*/, 7];
                 case 7: return [2 /*return*/];
             }
@@ -72,14 +102,3 @@ function detectNetwork(provider) {
     });
 }
 exports.detectNetwork = detectNetwork;
-function getEtherscan(chainId) {
-    switch (chainId) {
-        case constants_1.MAINNET_NETWORK:
-            return "https://etherscan.io";
-        case constants_1.GOERLI_NETWORK:
-            return "https://goerli.etherscan.io";
-        default:
-            return "";
-    }
-}
-exports.getEtherscan = getEtherscan;

package/lib/core/constants.d.ts

@@ -1,11 +1,5 @@
 import { BigNumber } from "ethers";
 export declare const MAX_INT: BigNumber;
-export declare const MAINNET_NETWORK = 1;
-export declare const GOERLI_NETWORK = 5;
-export declare const LOCAL_NETWORK = 1337;
-export declare const HARDHAT_NETWORK = 31337;
-export declare type NetworkType = "Mainnet" | "Goerli";
-export declare const getNetworkType: (chainId: number) => NetworkType;
 export declare const RAY_DECIMALS_POW = 27;
 export declare const RAY: BigNumber;
 export declare const halfRAY: BigNumber;

package/lib/core/constants.js

@@ -1,24 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DUMB_ADDRESS4 = exports.DUMB_ADDRESS3 = exports.DUMB_ADDRESS2 = exports.DUMB_ADDRESS = exports.ADDRESS_0X0 = exports.SLIPPAGE_DECIMALS = exports.LEVERAGE_DECIMALS = exports.timeRanges = exports.PERCENTAGE_FACTOR = exports.PERCENTAGE_DECIMALS = exports.SECONDS_PER_YEAR = exports.PRICE_DECIMALS = exports.PRICE_DECIMALS_POW = exports.WAD = exports.WAD_DECIMALS_POW = exports.halfRAY = exports.RAY = exports.RAY_DECIMALS_POW = exports.getNetworkType = exports.HARDHAT_NETWORK = exports.LOCAL_NETWORK = exports.GOERLI_NETWORK = exports.MAINNET_NETWORK = exports.MAX_INT = void 0;
+exports.DUMB_ADDRESS4 = exports.DUMB_ADDRESS3 = exports.DUMB_ADDRESS2 = exports.DUMB_ADDRESS = exports.ADDRESS_0X0 = exports.SLIPPAGE_DECIMALS = exports.LEVERAGE_DECIMALS = exports.timeRanges = exports.PERCENTAGE_FACTOR = exports.PERCENTAGE_DECIMALS = exports.SECONDS_PER_YEAR = exports.PRICE_DECIMALS = exports.PRICE_DECIMALS_POW = exports.WAD = exports.WAD_DECIMALS_POW = exports.halfRAY = exports.RAY = exports.RAY_DECIMALS_POW = exports.MAX_INT = void 0;
 var ethers_1 = require("ethers");
 exports.MAX_INT = ethers_1.BigNumber.from("0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff");
-exports.MAINNET_NETWORK = 1;
-exports.GOERLI_NETWORK = 5;
-exports.LOCAL_NETWORK = 1337;
-exports.HARDHAT_NETWORK = 31337;
-var getNetworkType = function (chainId) {
-    switch (chainId) {
-        case exports.MAINNET_NETWORK:
-        case exports.LOCAL_NETWORK:
-            return "Mainnet";
-        case exports.GOERLI_NETWORK:
-            return "Goerli";
-        default:
-            throw new Error("unknown network");
-    }
-};
-exports.getNetworkType = getNetworkType;
 exports.RAY_DECIMALS_POW = 27;
 exports.RAY = ethers_1.BigNumber.from(10).pow(exports.RAY_DECIMALS_POW);
 exports.halfRAY = exports.RAY.div(2);

package/lib/core/rewardClaimer.d.ts

@@ -2,7 +2,7 @@ import { BigNumber, providers } from "ethers";
 import { SupportedContract } from "../contracts/contracts";
 import { MultiCall } from "../pathfinder/core";
 import { SupportedToken } from "../tokens/token";
-import { NetworkType } from "./constants";
+import { NetworkType } from "./chains";
 import { CreditAccountData } from "./creditAccount";
 import { CreditManagerData } from "./creditManager";
 export interface Rewards {

package/lib/core/rewardConvex.d.ts

@@ -3,7 +3,7 @@ import { SupportedContract } from "../contracts/contracts";
 import { SupportedToken } from "../tokens/token";
 import { IConvexV1BaseRewardPoolAdapterInterface } from "../types/@gearbox-protocol/integrations-v2/contracts/interfaces/convex/IConvexV1BaseRewardPoolAdapter.sol/IConvexV1BaseRewardPoolAdapter";
 import { MCall } from "../utils/multicall";
-import { NetworkType } from "./constants";
+import { NetworkType } from "./chains";
 import { CreditAccountData } from "./creditAccount";
 import { CreditManagerData } from "./creditManager";
 import { AdapterWithType, Rewards } from "./rewardClaimer";

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export * from "./contracts/contracts";
 export * from "./contracts/protocols";
 export * from "./core/adapter";
 export * from "./core/assets";
+export * from "./core/chains";
 export * from "./core/constants";
 export * from "./core/creditAccount";
 export * from "./core/creditManager";
@@ -58,7 +59,6 @@ export * from "./utils/errors";
 export { getPoolTokens, getUnderlyingToken } from "./utils/extracter";
 export { keyToLowercase, objectEntries, swapKeyValue } from "./utils/mappers";
 export * from "./utils/multicall";
-export * from "./utils/network";
 export * from "./utils/price";
 export { callRepeater } from "./utils/repeater";
 export * from "./utils/types";

package/lib/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./contracts/contracts"), exports);
 __exportStar(require("./contracts/protocols"), exports);
 __exportStar(require("./core/adapter"), exports);
 __exportStar(require("./core/assets"), exports);
+__exportStar(require("./core/chains"), exports);
 __exportStar(require("./core/constants"), exports);
 __exportStar(require("./core/creditAccount"), exports);
 __exportStar(require("./core/creditManager"), exports);
@@ -83,7 +84,6 @@ Object.defineProperty(exports, "keyToLowercase", { enumerable: true, get: functi
 Object.defineProperty(exports, "objectEntries", { enumerable: true, get: function () { return mappers_1.objectEntries; } });
 Object.defineProperty(exports, "swapKeyValue", { enumerable: true, get: function () { return mappers_1.swapKeyValue; } });
 __exportStar(require("./utils/multicall"), exports);
-__exportStar(require("./utils/network"), exports);
 __exportStar(require("./utils/price"), exports);
 var repeater_1 = require("./utils/repeater");
 Object.defineProperty(exports, "callRepeater", { enumerable: true, get: function () { return repeater_1.callRepeater; } });

package/lib/oracles/oracles.d.ts

@@ -1,5 +1,5 @@
 import { BigNumber } from "ethers";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { SupportedToken } from "../tokens/token";
 export interface PriceFeed {
     token: string;

package/lib/parsers/txParser.d.ts

@@ -1,5 +1,5 @@
 import { SupportedContract } from "../contracts/contracts";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { SupportedToken } from "../tokens/token";
 import { MultiCallStruct } from "../types/@gearbox-protocol/router/contracts/interfaces/IClosePathResolver";
 import { AbstractParser } from "./abstractParser";

package/lib/pathfinder/pathOptions.d.ts

@@ -1,5 +1,5 @@
 import { BigNumberish } from "ethers";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { CurveLPToken } from "../tokens/curveLP";
 export interface PathOption {
     target: string;

package/lib/pathfinder/pathfinder.d.ts

@@ -1,6 +1,6 @@
 import { Provider } from "@ethersproject/abstract-provider";
 import { BigNumberish, Signer } from "ethers";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { CreditAccountData } from "../core/creditAccount";
 import { CreditManagerData } from "../core/creditManager";
 import { SupportedToken } from "../tokens/token";

package/lib/strategies/convex.d.ts

@@ -1,6 +1,6 @@
 import { BigNumberish } from "ethers";
 import { ConvexPoolContract } from "../contracts/contracts";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { CreditManagerData } from "../core/creditManager";
 import { MultiCallStruct } from "../types/@gearbox-protocol/router/contracts/interfaces/IClosePathResolver";
 export declare class ConvexBoosterCalls {

package/lib/strategies/curve.d.ts

@@ -1,6 +1,6 @@
 import { BigNumberish } from "ethers";
 import { CurvePoolContract } from "../contracts/contracts";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { CreditManagerData } from "../core/creditManager";
 import { MultiCallStruct } from "../types/@gearbox-protocol/router/contracts/interfaces/IClosePathResolver";
 export declare class CurveCalls {

package/lib/strategies/lido.d.ts

@@ -1,5 +1,5 @@
 import { BigNumberish } from "ethers";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { CreditManagerData } from "../core/creditManager";
 import { MultiCallStruct } from "../types/@gearbox-protocol/router/contracts/interfaces/IClosePathResolver";
 export declare class LidoCalls {

package/lib/strategies/yearn.d.ts

@@ -1,6 +1,6 @@
 import { BigNumberish } from "ethers";
 import { YearnVaultContract } from "../contracts/contracts";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { CreditManagerData } from "../core/creditManager";
 import { MultiCallStruct } from "../types/@gearbox-protocol/router/contracts/interfaces/IClosePathResolver";
 export declare class YearnV2Calls {

package/lib/tokens/token.d.ts

@@ -1,4 +1,4 @@
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { ConvexLPToken, ConvexLPTokenData, ConvexPhantomTokenData, ConvexStakedPhantomToken } from "./convex";
 import { CurveLPToken, CurveLPTokenData, MetaCurveLPTokenData } from "./curveLP";
 import { DieselTokenData, DieselTokenTypes, GearboxToken, GearboxTokenData } from "./gear";

package/lib/tokens/tokenData.d.ts

@@ -1,5 +1,5 @@
 import { BigNumber } from "ethers";
-import { NetworkType } from "../core/constants";
+import { NetworkType } from "../core/chains";
 import { TokenDataPayload } from "../payload/token";
 import { SupportedToken } from "./token";
 declare type SymbolReplacements = Record<string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "1.18.0",
+  "version": "1.18.2",
   "description": "Gearbox SDK",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

package/lib/utils/network.d.ts

@@ -1,4 +0,0 @@
-import { ethers } from "ethers";
-import { NetworkType } from "../core/constants";
-export declare function detectNetwork(provider: ethers.providers.Provider): Promise<NetworkType>;
-export declare function getEtherscan(chainId: number): string;