@gearbox-protocol/sdk 2.1.8 → 2.1.10

package/lib/core/strategy.d.ts

@@ -3,10 +3,10 @@ export interface StrategyPayload {
     apy?: number;
     name: string;
     lpToken: string;
-    pools: Array<string>;
+    creditManagers: Array<string>;
+    baseAssets: Array<string>;
     unleveragableCollateral: Array<string>;
     leveragableCollateral: Array<string>;
-    baseAssets: Array<string>;
 }
 interface LiquidationPriceProps {
     prices: Record<string, bigint>;
@@ -20,18 +20,15 @@ export declare class Strategy {
     apy: number | undefined;
     name: string;
     lpToken: string;
-    pools: Array<string>;
+    baseAssets: Array<string>;
     unleveragableCollateral: Array<string>;
     leveragableCollateral: Array<string>;
-    baseAssets: Array<string>;
+    creditManagers: Array<string>;
     constructor(payload: StrategyPayload);
     static maxLeverage(lpToken: string, cms: Array<PartialCM>): number;
     maxAPY(baseAPY: number, maxLeverage: number, borrowAPY: number): number;
-    overallAPY(apy: number, leverage: number, depositCollateral: string, borrowAPY: number): number;
     static liquidationPrice({ prices, liquidationThresholds, borrowed, underlyingToken, lpAmount, lpToken, }: LiquidationPriceProps): bigint;
-    protected farmLev(leverage: number, depositCollateral: string): number;
-    protected inBaseAssets(depositCollateral: string): boolean;
-    protected inLeveragableAssets(depositCollateral: string): boolean;
+    protected static maxLeverageThreshold(lpToken: string, cms: Array<PartialCM>): readonly [bigint, string];
 }
 type PartialCM = Pick<CreditManagerData, "liquidationThresholds" | "address">;
 export {};

package/lib/core/strategy.js

@@ -9,21 +9,21 @@ class Strategy {
     apy;
     name;
     lpToken;
-    pools;
+    baseAssets;
     unleveragableCollateral;
     leveragableCollateral;
-    baseAssets;
+    creditManagers;
     constructor(payload) {
         this.apy = payload.apy;
         this.name = payload.name;
         this.lpToken = payload.lpToken.toLowerCase();
-        this.pools = payload.pools.map(addr => addr.toLowerCase());
+        this.creditManagers = payload.creditManagers.map(addr => addr.toLowerCase());
+        this.baseAssets = payload.baseAssets.map(addr => addr.toLowerCase());
         this.unleveragableCollateral = payload.unleveragableCollateral.map(addr => addr.toLowerCase());
         this.leveragableCollateral = payload.leveragableCollateral.map(addr => addr.toLowerCase());
-        this.baseAssets = payload.baseAssets.map(addr => addr.toLowerCase());
     }
     static maxLeverage(lpToken, cms) {
-        const [maxThreshold] = maxLeverageThreshold(lpToken, cms);
+        const [maxThreshold] = Strategy.maxLeverageThreshold(lpToken, cms);
         const maxLeverage = (constants_1.PERCENTAGE_FACTOR * constants_1.LEVERAGE_DECIMALS) /
             (constants_1.PERCENTAGE_FACTOR - maxThreshold);
         return Number(maxLeverage - constants_1.LEVERAGE_DECIMALS);
@@ -33,10 +33,6 @@ class Strategy {
             ((baseAPY - borrowAPY) * (maxLeverage - Number(constants_1.LEVERAGE_DECIMALS))) /
                 Number(constants_1.LEVERAGE_DECIMALS));
     }
-    overallAPY(apy, leverage, depositCollateral, borrowAPY) {
-        const farmLev = this.farmLev(leverage, depositCollateral);
-        return roi(apy, farmLev, leverage - Number(constants_1.LEVERAGE_DECIMALS), borrowAPY);
-    }
     static liquidationPrice({ prices, liquidationThresholds, borrowed, underlyingToken, lpAmount, lpToken, }) {
         const underlyingTokenAddressLC = underlyingToken.toLowerCase();
         const underlyingTokenSymbol = token_1.tokenSymbolByAddress[underlyingTokenAddressLC];
@@ -56,36 +52,21 @@ class Strategy {
         }
         return 0n;
     }
-    farmLev(leverage, depositCollateral) {
-        return this.inBaseAssets(depositCollateral) ||
-            this.inLeveragableAssets(depositCollateral)
-            ? leverage
-            : leverage - Number(constants_1.LEVERAGE_DECIMALS);
-    }
-    inBaseAssets(depositCollateral) {
-        return this.baseAssets.some(c => c === depositCollateral.toLowerCase());
-    }
-    inLeveragableAssets(depositCollateral) {
-        return this.leveragableCollateral.some(c => c === depositCollateral.toLowerCase());
+    static maxLeverageThreshold(lpToken, cms) {
+        const lpTokenLC = lpToken.toLowerCase();
+        const ltByCM = cms.map(cm => {
+            const lt = cm.liquidationThresholds[lpTokenLC] || 0n;
+            return [cm.address, lt];
+        });
+        const sorted = ltByCM.sort(([, ltA], [, ltB]) => {
+            if (ltA > ltB)
+                return 1;
+            if (ltB > ltA)
+                return -1;
+            return 0;
+        });
+        const [cm = "", lt = 0n] = sorted[0] || [];
+        return [lt, cm];
     }
 }
 exports.Strategy = Strategy;
-function roi(apy, farmLev, debtLev, borrowAPY) {
-    return (apy * farmLev - borrowAPY * debtLev) / Number(constants_1.LEVERAGE_DECIMALS);
-}
-function maxLeverageThreshold(lpToken, cms) {
-    const lpTokenLC = lpToken.toLowerCase();
-    const ltByCM = cms.map(cm => {
-        const lt = cm.liquidationThresholds[lpTokenLC] || 0n;
-        return [cm.address, lt];
-    });
-    const sorted = ltByCM.sort(([, ltA], [, ltB]) => {
-        if (ltA > ltB)
-            return 1;
-        if (ltB > ltA)
-            return -1;
-        return 0;
-    });
-    const [cm = "", lt = 0n] = sorted[0] || [];
-    return [lt, cm];
-}

package/lib/core/strategy.spec.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const chai_1 = require("chai");
+const contractsRegister_1 = require("../contracts/contractsRegister");
 const decimals_1 = require("../tokens/decimals");
 const token_1 = require("../tokens/token");
 const formatter_1 = require("../utils/formatter");
@@ -10,7 +11,7 @@ const lidoPayload = {
     name: "Lido",
     lpToken: token_1.tokenDataByNetwork.Mainnet.STETH,
     apy: 38434,
-    pools: [token_1.tokenDataByNetwork.Mainnet.WETH],
+    creditManagers: [contractsRegister_1.creditManagerByNetwork.Mainnet.WETH_V2],
     unleveragableCollateral: [
         token_1.tokenDataByNetwork.Mainnet.USDC,
         token_1.tokenDataByNetwork.Mainnet.DAI,
@@ -43,10 +44,6 @@ describe("Strategy test", () => {
         const result = lidoStrategy.maxAPY(53203, 10 * Number(constants_1.LEVERAGE_DECIMALS), pools["0x1"].borrowRate);
         (0, chai_1.expect)(result).to.be.eq(284143);
     });
-    it("overallAPY calculation is correct", () => {
-        const result = lidoStrategy.overallAPY(lidoStrategy.apy || 0, 10 * Number(constants_1.LEVERAGE_DECIMALS), token_1.tokenDataByNetwork.Mainnet.WETH, pools["0x2"].borrowRate);
-        (0, chai_1.expect)(result).to.be.eq(332716);
-    });
     it("liquidationPrice calculation is correct", () => {
         const result = strategy_1.Strategy.liquidationPrice({
             liquidationThresholds,

package/lib/oracles/pricefeedType.d.ts

@@ -26,9 +26,12 @@ export declare enum PriceFeedType {
     ERC4626_VAULT_ORACLE = 16,
     NETWORK_DEPENDENT = 17
 }
+export declare const HOUR_1: number;
+export declare const HOUR_24: number;
 export type PriceFeedData = {
     type: PriceFeedType.CHAINLINK_ORACLE;
     address: string;
+    stalenessPeriod?: number;
 } | {
     type: PriceFeedType.YEARN_ORACLE;
     token: SupportedToken;

package/lib/oracles/pricefeedType.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PriceFeedType = void 0;
+exports.HOUR_24 = exports.HOUR_1 = exports.PriceFeedType = void 0;
 var PriceFeedType;
 (function (PriceFeedType) {
     PriceFeedType[PriceFeedType["CHAINLINK_ORACLE"] = 0] = "CHAINLINK_ORACLE";
@@ -22,3 +22,5 @@ var PriceFeedType;
     PriceFeedType[PriceFeedType["ERC4626_VAULT_ORACLE"] = 16] = "ERC4626_VAULT_ORACLE";
     PriceFeedType[PriceFeedType["NETWORK_DEPENDENT"] = 17] = "NETWORK_DEPENDENT";
 })(PriceFeedType = exports.PriceFeedType || (exports.PriceFeedType = {}));
+exports.HOUR_1 = 60 * 60;
+exports.HOUR_24 = 24 * exports.HOUR_1;

package/lib/pathfinder/pathfinder.d.ts

@@ -15,7 +15,7 @@ export declare class PathFinder {
     network: NetworkType;
     static connectors: Array<SupportedToken>;
     protected readonly _connectors: Array<string>;
-    constructor(address: string, provider: Signer | providers.Provider, network?: NetworkType, connectors?: Array<SupportedToken>);
+    constructor(address: string, provider: Signer | providers.Provider, network?: NetworkType, connectors?: SupportedToken[]);
     findAllSwaps(creditAccount: CreditAccountData, swapOperation: SwapOperation, tokenIn: SupportedToken | string, tokenOut: SupportedToken | string, amount: BigNumberish, slippage: number): Promise<Array<PathFinderResult>>;
     findOneTokenPath(creditAccount: CreditAccountData, tokenIn: SupportedToken | string, tokenOut: SupportedToken | string, amount: BigNumberish, slippage: number): Promise<PathFinderResult>;
     /**
@@ -41,4 +41,6 @@ export declare class PathFinder {
      */
     findBestClosePath(creditAccount: CreditAccountData, slippage: number, noConcurency?: boolean): Promise<PathFinderCloseResult>;
     static compare(r1: CloseResult, r2: CloseResult, gasPriceRAY: bigint): CloseResult;
+    getAvailableConnectors(availableList: Record<string, bigint> | Record<string, true>): string[];
+    static getAvailableConnectors(availableList: Record<string, bigint> | Record<string, true>, connectors: string[]): string[];
 }

package/lib/pathfinder/pathfinder.js

@@ -13,19 +13,22 @@ class PathFinder {
     network;
     static connectors = ["USDC", "WETH", "DAI"];
     _connectors;
-    constructor(address, provider, network = "Mainnet", connectors) {
+    constructor(address, provider, network = "Mainnet", connectors = PathFinder.connectors) {
         this.pathFinder = types_1.IRouter__factory.connect(address, provider);
         this.network = network;
-        this._connectors = (connectors || PathFinder.connectors).map(c => token_1.tokenDataByNetwork[this.network][c]);
+        this._connectors = connectors
+            .map(c => token_1.tokenDataByNetwork[this.network][c]?.toLowerCase())
+            .filter(t => !t);
     }
     async findAllSwaps(creditAccount, swapOperation, tokenIn, tokenOut, amount, slippage) {
+        const connectors = this.getAvailableConnectors(creditAccount.balances);
         const swapTask = {
             swapOperation: swapOperation,
             creditAccount: creditAccount.addr,
             tokenIn: token_1.tokenDataByNetwork[this.network][tokenIn] || tokenIn,
             tokenOut: token_1.tokenDataByNetwork[this.network][tokenOut] ||
                 tokenOut,
-            connectors: this._connectors,
+            connectors,
             amount: amount,
             slippage,
             externalSlippage: false,
@@ -47,10 +50,8 @@ class PathFinder {
     }
     async findOneTokenPath(creditAccount, tokenIn, tokenOut, amount, slippage) {
         const tokenInAddr = token_1.tokenDataByNetwork[this.network][tokenIn] || tokenIn;
-        // if (creditAccount.balances[tokenInAddr.toLowerCase()].lt(amount)) {
-        //   throw new Error(`Not enough balance for token ${tokenIn}`);
-        // }
-        const result = await this.pathFinder.callStatic.findOneTokenPath(tokenInAddr, amount, token_1.tokenDataByNetwork[this.network][tokenOut] || tokenOut, creditAccount.addr, this._connectors, slippage, {
+        const connectors = this.getAvailableConnectors(creditAccount.balances);
+        const result = await this.pathFinder.callStatic.findOneTokenPath(tokenInAddr, amount, token_1.tokenDataByNetwork[this.network][tokenOut] || tokenOut, creditAccount.addr, connectors, slippage, {
             gasLimit: GAS_PER_BLOCK,
         });
         return {
@@ -80,7 +81,8 @@ class PathFinder {
             token,
             balance: expectedBalancesAddr[token] || 0,
         }));
-        const result = await this.pathFinder.callStatic.findOpenStrategyPath(cm.address, balances, targetAddr, this._connectors, slippage, {
+        const connectors = this.getAvailableConnectors(cm.supportedTokens);
+        const result = await this.pathFinder.callStatic.findOpenStrategyPath(cm.address, balances, targetAddr, connectors, slippage, {
             gasLimit: GAS_PER_BLOCK,
         });
         const balancesAfter = result[0].reduce((acc, b) => {
@@ -104,16 +106,17 @@ class PathFinder {
     async findBestClosePath(creditAccount, slippage, noConcurency = false) {
         const loopsPerTx = Math.floor(GAS_PER_BLOCK / MAX_GAS_PER_ROUTE);
         const pathOptions = pathOptions_1.PathOptionFactory.generatePathOptions(creditAccount.allBalances, loopsPerTx);
+        const connectors = this.getAvailableConnectors(creditAccount.balances);
         let results = [];
         if (noConcurency) {
             for (const po of pathOptions) {
-                results.push(await this.pathFinder.callStatic.findBestClosePath(creditAccount.addr, this._connectors, slippage, po, loopsPerTx, false, {
+                results.push(await this.pathFinder.callStatic.findBestClosePath(creditAccount.addr, connectors, slippage, po, loopsPerTx, false, {
                     gasLimit: GAS_PER_BLOCK,
                 }));
             }
         }
         else {
-            const requests = pathOptions.map(po => this.pathFinder.callStatic.findBestClosePath(creditAccount.addr, this._connectors, slippage, po, loopsPerTx, false, {
+            const requests = pathOptions.map(po => this.pathFinder.callStatic.findBestClosePath(creditAccount.addr, connectors, slippage, po, loopsPerTx, false, {
                 gasLimit: GAS_PER_BLOCK,
             }));
             results = await Promise.all(requests);
@@ -137,5 +140,11 @@ class PathFinder {
         const comparator = ({ amount, gasUsage }, gasPrice) => amount - (gasUsage * gasPrice) / constants_1.RAY;
         return comparator(r1, gasPriceRAY) > comparator(r2, gasPriceRAY) ? r1 : r2;
     }
+    getAvailableConnectors(availableList) {
+        return PathFinder.getAvailableConnectors(availableList, this._connectors);
+    }
+    static getAvailableConnectors(availableList, connectors) {
+        return connectors.filter(t => availableList[t] !== undefined);
+    }
 }
 exports.PathFinder = PathFinder;

package/lib/tokens/gear.d.ts

@@ -13,3 +13,4 @@ export type GearboxTokenData = {
     type: TokenType.GEAR_TOKEN;
 } & TokenBase;
 export declare const gearTokens: Record<DieselTokenTypes | GearboxToken, DieselTokenData | GearboxTokenData>;
+export declare const isDieselToken: (t: unknown) => t is DieselTokenTypes;

package/lib/tokens/gear.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gearTokens = void 0;
+exports.isDieselToken = exports.gearTokens = void 0;
 const tokenType_1 = require("./tokenType");
-exports.gearTokens = {
+const dieselTokens = {
     // GEARBOX
     dDAI: {
         name: "dDAI",
@@ -34,9 +34,14 @@ exports.gearTokens = {
         symbol: "dFRAX",
         type: tokenType_1.TokenType.DIESEL_LP_TOKEN,
     },
+};
+exports.gearTokens = {
+    ...dieselTokens,
     GEAR: {
         name: "GEAR",
         symbol: "GEAR",
         type: tokenType_1.TokenType.GEAR_TOKEN,
     },
 };
+const isDieselToken = (t) => typeof t === "string" && !!dieselTokens[t];
+exports.isDieselToken = isDieselToken;

package/lib/tokens/token.js

@@ -258,12 +258,9 @@ exports.tokenDataByNetwork = {
 };
 exports.tokenSymbolByAddress = mappers_1.TypedObjectUtils.entries(exports.tokenDataByNetwork).reduce((acc, [, tokens]) => ({
     ...acc,
-    ...{
-        ...acc,
-        ...mappers_1.TypedObjectUtils.fromEntries(mappers_1.TypedObjectUtils.entries(tokens)
-            .map(([k, v]) => [v.toLowerCase(), k])
-            .filter(k => !!k)),
-    },
+    ...mappers_1.TypedObjectUtils.fromEntries(mappers_1.TypedObjectUtils.entries(tokens)
+        .map(([k, v]) => [v.toLowerCase(), k])
+        .filter(k => !!k)),
 }), {});
 const isSupportedToken = (t) => typeof t === "string" && !!exports.supportedTokens[t];
 exports.isSupportedToken = isSupportedToken;

package/lib/utils/price.d.ts

@@ -3,7 +3,7 @@ interface Target {
     decimals: number | undefined;
 }
 export declare class PriceUtils {
-    static calcTotalPrice: (price: bigint, amount: bigint, decimals?: number) => bigint;
+    static calcTotalPrice: (price: bigint, amount: bigint, decimals?: number | undefined) => bigint;
     static convertByPrice(totalMoney: bigint, { price: targetPrice, decimals: targetDecimals }: Target): bigint;
 }
 export {};

package/package.json

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