@gearbox-protocol/sdk 0.0.109 → 0.0.110

package/src/core/creditManager.ts

@@ -100,7 +100,7 @@ export class CreditManagerData {
     >((acc, threshold, index) => {
       const address = payload.collateralTokens[index];
 
-      if (address) acc[address] = BigNumber.from(threshold);
+      if (address) acc[address.toLowerCase()] = BigNumber.from(threshold);
 
       return acc;
     }, {});
@@ -161,25 +161,50 @@ export class CreditManagerData {
     };
   }
 
-  validateOpenAccount(totalAmount: BigNumber, leverage: number): true {
-    if (totalAmount.lt(this.minAmount))
+  validateOpenAccount(collateral: BigNumber, debt: BigNumber): true {
+    return this.version === 2
+      ? this.validateOpenAccountV2(debt)
+      : this.validateOpenAccountV1(collateral, debt);
+  }
+
+  protected validateOpenAccountV1(
+    collateral: BigNumber,
+    debt: BigNumber
+  ): true {
+    if (collateral.lt(this.minAmount))
       throw new OpenAccountError("amountLessMin", this.minAmount);
 
-    if (totalAmount.gt(this.maxAmount))
+    if (collateral.gt(this.maxAmount))
       throw new OpenAccountError("amountGreaterMax", this.maxAmount);
 
+    const leverage = debt.mul(LEVERAGE_DECIMALS).div(collateral).toNumber();
+
+    if (!leverage || leverage < 0)
+      throw new OpenAccountError("wrongLeverage", BigNumber.from(0));
+
     if (leverage > this.maxLeverageFactor)
       throw new OpenAccountError(
         "leverageGreaterMax",
         BigNumber.from(this.maxLeverageFactor)
       );
 
-    if (
-      totalAmount
-        .mul(leverage)
-        .div(LEVERAGE_DECIMALS)
-        .gt(this.availableLiquidity)
-    )
+    if (debt.gt(this.availableLiquidity))
+      throw new OpenAccountError(
+        "insufficientPoolLiquidity",
+        BigNumber.from(this.availableLiquidity)
+      );
+
+    return true;
+  }
+
+  protected validateOpenAccountV2(debt: BigNumber): true {
+    if (debt.lt(this.minAmount))
+      throw new OpenAccountError("amountLessMin", this.minAmount);
+
+    if (debt.gt(this.maxAmount))
+      throw new OpenAccountError("amountGreaterMax", this.maxAmount);
+
+    if (debt.gt(this.availableLiquidity))
       throw new OpenAccountError(
         "insufficientPoolLiquidity",
         BigNumber.from(this.availableLiquidity)

package/src/core/errors.ts

@@ -49,6 +49,7 @@ export class AccountsInAlllCreditManagersError extends Error {
 export type OpenAccountErrorTypes =
   | "insufficientPoolLiquidity"
   | "leverageGreaterMax"
+  | "wrongLeverage"
   | "amountGreaterMax"
   | "amountLessMin";
 

package/src/core/pool.ts

@@ -46,10 +46,10 @@ export class PoolData {
   public readonly isPaused: boolean = false;
 
   constructor(payload: PoolDataPayload) {
-    this.id = payload.addr;
-    this.address = payload.addr;
-    this.underlyingToken = payload.underlying || "";
-    this.dieselToken = payload.dieselToken || "";
+    this.id = payload.addr.toLowerCase();
+    this.address = payload.addr.toLowerCase();
+    this.underlyingToken = payload.underlying.toLowerCase();
+    this.dieselToken = payload.dieselToken.toLowerCase();
 
     this.isWETH = payload.isWETH || false;
 

package/src/core/strategy.ts

@@ -1,9 +1,11 @@
 import { BigNumber } from "ethers";
+import { calcTotalPrice } from "../utils/price";
+import { TokensWithAPY } from "../apy";
 import { LEVERAGE_DECIMALS, PERCENTAGE_FACTOR, WAD } from "./constants";
-import { calcTotalPrice } from "./price";
 
 export interface StrategyPayload {
   apy?: number;
+  apyTokenSymbol: TokensWithAPY;
 
   name: string;
   lpToken: string;
@@ -53,7 +55,7 @@ export class Strategy {
     this.baseAssets = payload.baseAssets;
   }
 
-  public maxAPY(maxLeverage: number, poolApy: PoolList) {
+  maxAPY(maxLeverage: number, poolApy: PoolList) {
     const minApy = minBorrowApy(poolApy);
 
     return roi(
@@ -64,7 +66,7 @@ export class Strategy {
     );
   }
 
-  public overallAPY(
+  overallAPY(
     apy: number,
     leverage: number,
     depositCollateral: string,
@@ -76,7 +78,7 @@ export class Strategy {
   }
 
   // eslint-disable-next-line class-methods-use-this
-  public liquidationPrice(
+  liquidationPrice(
     borrowed: TokenDescription,
     collateral: TokenDescription,
     lp: TokenDescription,
@@ -96,25 +98,29 @@ export class Strategy {
       .div(PERCENTAGE_FACTOR);
     const lpMoney = calcTotalPrice(lp.price, lp.amount, lp.decimals);
 
-    return lpMoney.gt(0)
-      ? borrowedMoney.sub(collateralMoney).mul(WAD).div(lpMoney)
-      : BigNumber.from(0);
+    if (lpMoney.gt(0)) {
+      const lqPrice = borrowedMoney.sub(collateralMoney).mul(WAD).div(lpMoney);
+
+      return lqPrice.gte(0) ? lqPrice : BigNumber.from(0);
+    }
+
+    return BigNumber.from(0);
   }
 
-  private farmLev(leverage: number, depositCollateral: string) {
+  protected farmLev(leverage: number, depositCollateral: string) {
     return this.inBaseAssets(depositCollateral) ||
       this.inLeveragableAssets(depositCollateral)
       ? leverage
       : leverage - LEVERAGE_DECIMALS;
   }
 
-  private inBaseAssets(depositCollateral: string) {
+  protected inBaseAssets(depositCollateral: string) {
     return this.baseAssets.some(
       c => c.toLowerCase() === depositCollateral.toLowerCase()
     );
   }
 
-  private inLeveragableAssets(depositCollateral: string) {
+  protected inLeveragableAssets(depositCollateral: string) {
     return this.leveragableCollateral.some(
       c => c.toLowerCase() === depositCollateral.toLowerCase()
     );

package/src/index.ts

@@ -1,5 +1,4 @@
 export * from "./core/constants";
-export * from "./core/price";
 export * from "./core/creditAccount";
 export * from "./core/creditManager";
 export * from "./core/creditSession";
@@ -40,13 +39,13 @@ export * from "./tokens/gear";
 export * from "./tokens/normal";
 export * from "./tokens/yearn";
 
-export * from "./apy/lidoAPY";
-export * from "./apy/convexAPY";
+export * from "./apy";
 
 export * from "./core/history";
 export * from "./utils/multicall";
 export * from "./utils/types";
 export * from "./utils/errors";
+export * from "./utils/price";
 
 export * from "./strategies/convex";
 export * from "./strategies/creditFacade";
@@ -60,5 +59,6 @@ export { callRepeater } from "./utils/repeater";
 export { getContractName } from "./contracts/contractsRegister";
 export { AdapterInterface } from "./contracts/adapters";
 export { objectEntries, swapKeyValue, keyToLowercase } from "./utils/mappers";
+export { getPoolTokens, getUnderlyingToken } from "./utils/extracter";
 
-export { SwapType } from "./pathfinder/tradeTypes";
+export * from "./pathfinder/tradeTypes";

package/src/tokens/convex.ts

@@ -39,13 +39,9 @@ export type ConvexPhantomTokenData = {
   lpToken: ConvexLPToken;
 } & BaseConvexToken;
 
-export const convexTokens: Record<
-  ConvexLPToken | ConvexStakedPhantomToken,
-  ConvexLPTokenData | ConvexPhantomTokenData
-> = {
-  // CONVEX LP TOKENS
+const convexLpTokens: Record<ConvexLPToken, ConvexLPTokenData> = {
   cvx3Crv: {
-    name: "cvx3Crv",
+    name: "Convex cvx3Crv",
     decimals: 18,
 
     symbol: "cvx3Crv",
@@ -69,7 +65,7 @@ export const convexTokens: Record<
   },
 
   cvxsteCRV: {
-    name: "cvxsteCRV",
+    name: "Convex cvxsteCRV",
     decimals: 18,
 
     symbol: "cvxsteCRV",
@@ -93,7 +89,7 @@ export const convexTokens: Record<
   },
 
   cvxFRAX3CRV: {
-    name: "cvxFRAX3CRV-f",
+    name: "Convex cvxFRAX3CRV-f",
     decimals: 18,
 
     symbol: "cvxFRAX3CRV",
@@ -117,7 +113,7 @@ export const convexTokens: Record<
   },
 
   cvxLUSD3CRV: {
-    name: "cvxLUSD3CRV-f",
+    name: "Convex cvxLUSD3CRV-f",
     decimals: 18,
 
     symbol: "cvxLUSD3CRV",
@@ -141,7 +137,7 @@ export const convexTokens: Record<
   },
 
   cvxcrvPlain3andSUSD: {
-    name: "cvxcrvPlain3andSUSD",
+    name: "Convex cvxcrvPlain3andSUSD",
     decimals: 18,
 
     symbol: "cvxcrvPlain3andSUSD",
@@ -165,7 +161,7 @@ export const convexTokens: Record<
   },
 
   cvxgusd3CRV: {
-    name: "cvxgusd3CRV",
+    name: "Convex cvxgusd3CRV",
     decimals: 18,
 
     symbol: "cvxgusd3CRV",
@@ -186,11 +182,15 @@ export const convexTokens: Record<
         tokenOut: "stkcvxgusd3CRV"
       }
     ]
-  },
+  }
+};
 
-  // STAKED CONVEX
+const convexStakedPhantomTokens: Record<
+  ConvexStakedPhantomToken,
+  ConvexPhantomTokenData
+> = {
   stkcvx3Crv: {
-    name: "stkcvx3Crv",
+    name: "Convex stkcvx3Crv",
     decimals: 18,
 
     symbol: "stkcvx3Crv",
@@ -214,7 +214,7 @@ export const convexTokens: Record<
   },
 
   stkcvxsteCRV: {
-    name: "stkcvxsteCRV",
+    name: "Convex stkcvxsteCRV",
     decimals: 18,
 
     symbol: "stkcvxsteCRV",
@@ -238,7 +238,7 @@ export const convexTokens: Record<
   },
 
   stkcvxFRAX3CRV: {
-    name: "stkcvxFRAX3CRV-f",
+    name: "Convex stkcvxFRAX3CRV-f",
     decimals: 18,
 
     symbol: "stkcvxFRAX3CRV",
@@ -262,13 +262,13 @@ export const convexTokens: Record<
   },
 
   stkcvxLUSD3CRV: {
-    name: "stkcvxLUSD3CRV-f",
+    name: "Convex stkcvxLUSD3CRV-f",
     decimals: 18,
 
     symbol: "stkcvxLUSD3CRV",
     type: TokenType.CONVEX_STAKED_PHANTOM_TOKEN,
     pool: "CONVEX_LUSD3CRV_POOL",
-    pid: 32,
+    pid: 33,
     underlying: "LUSD3CRV",
     lpToken: "cvxLUSD3CRV",
     lpActions: [
@@ -286,7 +286,7 @@ export const convexTokens: Record<
   },
 
   stkcvxcrvPlain3andSUSD: {
-    name: "stkcvxcrvPlain3andSUSD",
+    name: "Convex stkcvxcrvPlain3andSUSD",
     decimals: 18,
 
     symbol: "stkcvxcrvPlain3andSUSD",
@@ -310,7 +310,7 @@ export const convexTokens: Record<
   },
 
   stkcvxgusd3CRV: {
-    name: "stkcvxgusd3CRV",
+    name: "Convex stkcvxgusd3CRV",
     decimals: 18,
 
     symbol: "stkcvxgusd3CRV",
@@ -333,3 +333,26 @@ export const convexTokens: Record<
     ]
   }
 };
+
+export const convexTokens: Record<
+  ConvexLPToken | ConvexStakedPhantomToken,
+  ConvexLPTokenData | ConvexPhantomTokenData
+> = {
+  ...convexLpTokens,
+  ...convexStakedPhantomTokens
+};
+
+export const isConvexToken = (
+  t: unknown
+): t is ConvexLPToken | ConvexStakedPhantomToken =>
+  typeof t === "string" &&
+  !!convexTokens[t as ConvexLPToken | ConvexStakedPhantomToken];
+
+export const isConvexLPToken = (t: unknown): t is ConvexLPToken =>
+  typeof t === "string" && !!convexLpTokens[t as ConvexLPToken];
+
+export const isConvexStakedPhantomToken = (
+  t: unknown
+): t is ConvexStakedPhantomToken =>
+  typeof t === "string" &&
+  !!convexStakedPhantomTokens[t as ConvexStakedPhantomToken];

package/src/tokens/curveLP.ts

@@ -45,7 +45,7 @@ export const curveTokens: Record<
 > = {
   // CURVE LP TOKENS
   "3Crv": {
-    name: "3Crv",
+    name: "Curve 3Crv",
     decimals: 18,
     symbol: "3Crv",
     type: TokenType.CURVE_LP,
@@ -70,7 +70,7 @@ export const curveTokens: Record<
   },
 
   steCRV: {
-    name: "steCRV",
+    name: "Curve steCRV",
     decimals: 18,
     symbol: "steCRV",
     type: TokenType.CURVE_LP,
@@ -95,7 +95,7 @@ export const curveTokens: Record<
   },
 
   crvPlain3andSUSD: {
-    name: "crvPlain3andSUSD",
+    name: "Curve crvPlain3andSUSD",
     decimals: 18,
     symbol: "crvPlain3andSUSD",
     type: TokenType.CURVE_LP,
@@ -122,7 +122,7 @@ export const curveTokens: Record<
 
   //  META CURVE LP TOKENS
   FRAX3CRV: {
-    name: "FRAX3CRV-f",
+    name: "Curve FRAX3CRV-f",
     decimals: 18,
     symbol: "FRAX3CRV",
     type: TokenType.META_CURVE_LP,
@@ -147,7 +147,7 @@ export const curveTokens: Record<
   },
 
   LUSD3CRV: {
-    name: "LUSD3CRV-f",
+    name: "Curve LUSD3CRV-f",
     decimals: 18,
     symbol: "LUSD3CRV",
     type: TokenType.META_CURVE_LP,
@@ -162,7 +162,7 @@ export const curveTokens: Record<
   },
 
   gusd3CRV: {
-    name: "gusd3CRV",
+    name: "Curve gusd3CRV",
     decimals: 18,
     symbol: "gusd3CRV",
     type: TokenType.META_CURVE_LP,
@@ -186,3 +186,6 @@ export const curveTokens: Record<
     ]
   }
 };
+
+export const isCurveLPToken = (t: unknown): t is CurveLPToken =>
+  typeof t === "string" && !!curveTokens[t as CurveLPToken];

package/src/tokens/normal.ts

@@ -807,3 +807,6 @@ export const normalTokens: Record<NormalToken, NormalTokenData> = {
     ]
   }
 };
+
+export const isNormalToken = (t: unknown): t is NormalToken =>
+  typeof t === "string" && !!normalTokens[t as NormalToken];

package/src/tokens/token.ts

@@ -34,12 +34,15 @@ import {
   gearTokens
 } from "./gear";
 
-export type SupportedToken =
-  | NormalToken
+export type LPTokens =
   | YearnLPToken
   | CurveLPToken
   | ConvexLPToken
-  | ConvexStakedPhantomToken
+  | ConvexStakedPhantomToken;
+
+export type SupportedToken =
+  | NormalToken
+  | LPTokens
   | DieselTokenTypes
   | GearboxToken;
 
@@ -49,18 +52,27 @@ export interface TokenBase {
   decimals: number;
 }
 
-export type TokenDataI =
-  | NormalTokenData
+export type LPTokenDataI =
   | CurveLPTokenData
   | MetaCurveLPTokenData
   | YearnVaultTokenData
   | YearnVaultOfCurveLPTokenData
   | YearnVaultOfMetaCurveLPTokenData
   | ConvexLPTokenData
-  | ConvexPhantomTokenData
+  | ConvexPhantomTokenData;
+
+export type TokenDataI =
+  | NormalTokenData
+  | LPTokenDataI
   | DieselTokenData
   | GearboxTokenData;
 
+export const lpTokens: Record<LPTokens, LPTokenDataI> = {
+  ...curveTokens,
+  ...convexTokens,
+  ...yearnTokens
+};
+
 export const supportedTokens: Record<SupportedToken, TokenDataI> = {
   ...normalTokens,
   ...curveTokens,
@@ -236,3 +248,9 @@ export const tokenSymbolByAddress = objectEntries(tokenDataByNetwork).reduce<
   }),
   {}
 );
+
+export const isSupportedToken = (t: unknown): t is SupportedToken =>
+  typeof t === "string" && !!supportedTokens[t as SupportedToken];
+
+export const isLPToken = (t: unknown): t is LPTokens =>
+  typeof t === "string" && !!supportedTokens[t as LPTokens];

package/src/tokens/tokenData.ts

@@ -13,7 +13,6 @@ const defaultSymbolReplacement: SymbolReplacements = {
 export class TokenData {
   public readonly id: string;
 
-  // public readonly name: string;
   public readonly symbol: string;
 
   public readonly address: string;
@@ -26,9 +25,8 @@ export class TokenData {
     payload: TokenDataPayload,
     symbolReplacements: SymbolReplacements = defaultSymbolReplacement
   ) {
-    this.id = payload.addr;
-    this.address = payload.addr;
-    // this.name = payload.name;
+    this.id = payload.addr.toLowerCase();
+    this.address = payload.addr.toLowerCase();
     this.symbol = symbolReplacements[payload.symbol] || payload.symbol;
     this.decimals = payload.decimals;
     this.icon = `${STATIC_TOKEN}${payload.symbol?.toLowerCase()}.svg`;

package/src/tokens/yearn.ts

@@ -45,7 +45,7 @@ export const yearnTokens: Record<
 > = {
   // YEARN TOKENS
   yvDAI: {
-    name: "yvDAI",
+    name: "Yearn yvDAI",
     decimals: 18,
     symbol: "yvDAI",
     type: TokenType.YEARN_VAULT,
@@ -61,7 +61,7 @@ export const yearnTokens: Record<
   },
 
   yvUSDC: {
-    name: "yvUSDC",
+    name: "Yearn yvUSDC",
     decimals: 6,
     symbol: "yvUSDC",
     type: TokenType.YEARN_VAULT,
@@ -77,7 +77,7 @@ export const yearnTokens: Record<
   },
 
   yvWETH: {
-    name: "yvWETH",
+    name: "Yearn yvWETH",
     decimals: 18,
     symbol: "yvWETH",
     type: TokenType.YEARN_VAULT,
@@ -93,7 +93,7 @@ export const yearnTokens: Record<
   },
 
   yvWBTC: {
-    name: "yvWBTC",
+    name: "Yearn yvWBTC",
     decimals: 8,
     symbol: "yvWBTC",
     type: TokenType.YEARN_VAULT,
@@ -110,7 +110,7 @@ export const yearnTokens: Record<
 
   // YEARN- CURVE TOKENS
   yvCurve_stETH: {
-    name: "yvCurve-stETH",
+    name: "Yearn yvCurve-stETH",
     decimals: 18,
     symbol: "yvCurve_stETH",
     type: TokenType.YEARN_VAULT_OF_CURVE_LP,
@@ -126,7 +126,7 @@ export const yearnTokens: Record<
   },
 
   yvCurve_FRAX: {
-    name: "yvCurve-FRAX",
+    name: "Yearn yvCurve-FRAX",
     decimals: 18,
     symbol: "yvCurve_FRAX",
     type: TokenType.YEARN_VAULT_OF_META_CURVE_LP,
@@ -141,3 +141,6 @@ export const yearnTokens: Record<
     ]
   }
 };
+
+export const isYearnLPToken = (t: unknown): t is YearnLPToken =>
+  typeof t === "string" && !!yearnTokens[t as YearnLPToken];

package/src/utils/extracter.ts

@@ -0,0 +1,30 @@
+import { PoolData } from "../core/pool";
+
+export interface PoolTokens {
+  dieselToken: string | undefined;
+  underlyingToken: string | undefined;
+}
+
+export function getPoolTokens(pool: PoolData | undefined | Error): PoolTokens {
+  const safePool = pool instanceof Error ? undefined : pool;
+  const { dieselToken, underlyingToken } = safePool || {};
+
+  return {
+    dieselToken,
+    underlyingToken
+  };
+}
+
+interface WithUnderlyingToken {
+  readonly underlyingToken: string;
+}
+
+export function getUnderlyingToken(
+  c: WithUnderlyingToken | undefined | Error
+): string | undefined {
+  if (!c || c instanceof Error) {
+    return undefined;
+  }
+
+  return c.underlyingToken;
+}

package/src/utils/mappers.ts

@@ -12,7 +12,7 @@ const swapKeyValue = <K extends SupportedValue, T extends SupportedValue>(
     {} as Record<T, K>
   );
 
-const keyToLowercase = <K extends SupportedValue, T extends SupportedValue>(
+const keyToLowercase = <K extends SupportedValue, T>(
   o: Record<K, T>
 ): Record<K, T> =>
   objectEntries(o).reduce((acc, [key, value]) => {
@@ -20,7 +20,7 @@ const keyToLowercase = <K extends SupportedValue, T extends SupportedValue>(
     return { ...acc, [keyTransformed]: value };
   }, {} as Record<K, T>);
 
-const filterEmptyKeys = <K extends SupportedValue, T extends SupportedValue>(
+const filterEmptyKeys = <K extends SupportedValue, T>(
   o: Record<K, T>
 ): Record<K, T> =>
   objectEntries(o).reduce(

package/src/utils/price.ts

@@ -0,0 +1,33 @@
+import { BigNumber } from "ethers";
+import { WAD, PRICE_DECIMALS } from "../core/constants";
+
+export const calcTotalPrice = (
+  price: BigNumber,
+  amount: BigNumber,
+  decimals: number = 18
+) =>
+  amount
+    .mul(WAD)
+    .mul(price)
+    .div(BigNumber.from(10).pow(decimals))
+    .div(PRICE_DECIMALS);
+
+interface Target {
+  price: BigNumber;
+  decimals: number | undefined;
+}
+
+export function convertByPrice(
+  totalMoney: BigNumber,
+  { price: targetPrice, decimals: targetDecimals = 18 }: Target
+) {
+  const isWrongTargetPrice = targetPrice.isZero() || targetPrice.isNegative();
+
+  return isWrongTargetPrice
+    ? BigNumber.from(0)
+    : totalMoney
+        .mul(BigNumber.from(10).pow(targetDecimals))
+        .mul(PRICE_DECIMALS)
+        .div(targetPrice)
+        .div(WAD);
+}

package/lib/core/price.d.ts

@@ -1,2 +0,0 @@
-import { BigNumber } from "ethers";
-export declare const calcTotalPrice: (price: BigNumber, amount: BigNumber, decimals?: number) => BigNumber;

package/lib/core/price.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.calcTotalPrice = void 0;
-var ethers_1 = require("ethers");
-var constants_1 = require("./constants");
-var calcTotalPrice = function (price, amount, decimals) {
-    if (decimals === void 0) { decimals = 18; }
-    return amount
-        .mul(constants_1.WAD)
-        .mul(price)
-        .div(ethers_1.BigNumber.from(10).pow(decimals))
-        .div(constants_1.PRICE_DECIMALS);
-};
-exports.calcTotalPrice = calcTotalPrice;

package/lib/types/@chainlink/contracts/src/v0.6/index.d.ts

@@ -1,2 +0,0 @@
-import type * as interfaces from "./interfaces";
-export type { interfaces };

package/lib/types/@chainlink/contracts/src/v0.6/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });