@gearbox-protocol/sdk 0.0.109 → 0.0.110

package/lib/tokens/yearn.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.yearnTokens = void 0;
+exports.isYearnLPToken = exports.yearnTokens = void 0;
 var tradeTypes_1 = require("../pathfinder/tradeTypes");
 var tokenType_1 = require("./tokenType");
 exports.yearnTokens = {
     // YEARN TOKENS
     yvDAI: {
-        name: "yvDAI",
+        name: "Yearn yvDAI",
         decimals: 18,
         symbol: "yvDAI",
         type: tokenType_1.TokenType.YEARN_VAULT,
@@ -21,7 +21,7 @@ exports.yearnTokens = {
         ]
     },
     yvUSDC: {
-        name: "yvUSDC",
+        name: "Yearn yvUSDC",
         decimals: 6,
         symbol: "yvUSDC",
         type: tokenType_1.TokenType.YEARN_VAULT,
@@ -36,7 +36,7 @@ exports.yearnTokens = {
         ]
     },
     yvWETH: {
-        name: "yvWETH",
+        name: "Yearn yvWETH",
         decimals: 18,
         symbol: "yvWETH",
         type: tokenType_1.TokenType.YEARN_VAULT,
@@ -51,7 +51,7 @@ exports.yearnTokens = {
         ]
     },
     yvWBTC: {
-        name: "yvWBTC",
+        name: "Yearn yvWBTC",
         decimals: 8,
         symbol: "yvWBTC",
         type: tokenType_1.TokenType.YEARN_VAULT,
@@ -67,7 +67,7 @@ exports.yearnTokens = {
     },
     // YEARN- CURVE TOKENS
     yvCurve_stETH: {
-        name: "yvCurve-stETH",
+        name: "Yearn yvCurve-stETH",
         decimals: 18,
         symbol: "yvCurve_stETH",
         type: tokenType_1.TokenType.YEARN_VAULT_OF_CURVE_LP,
@@ -82,7 +82,7 @@ exports.yearnTokens = {
         ]
     },
     yvCurve_FRAX: {
-        name: "yvCurve-FRAX",
+        name: "Yearn yvCurve-FRAX",
         decimals: 18,
         symbol: "yvCurve_FRAX",
         type: tokenType_1.TokenType.YEARN_VAULT_OF_META_CURVE_LP,
@@ -97,3 +97,7 @@ exports.yearnTokens = {
         ]
     }
 };
+var isYearnLPToken = function (t) {
+    return typeof t === "string" && !!exports.yearnTokens[t];
+};
+exports.isYearnLPToken = isYearnLPToken;

package/lib/utils/extracter.d.ts

@@ -0,0 +1,11 @@
+import { PoolData } from "../core/pool";
+export interface PoolTokens {
+    dieselToken: string | undefined;
+    underlyingToken: string | undefined;
+}
+export declare function getPoolTokens(pool: PoolData | undefined | Error): PoolTokens;
+interface WithUnderlyingToken {
+    readonly underlyingToken: string;
+}
+export declare function getUnderlyingToken(c: WithUnderlyingToken | undefined | Error): string | undefined;
+export {};

package/lib/utils/extracter.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUnderlyingToken = exports.getPoolTokens = void 0;
+function getPoolTokens(pool) {
+    var safePool = pool instanceof Error ? undefined : pool;
+    var _a = safePool || {}, dieselToken = _a.dieselToken, underlyingToken = _a.underlyingToken;
+    return {
+        dieselToken: dieselToken,
+        underlyingToken: underlyingToken
+    };
+}
+exports.getPoolTokens = getPoolTokens;
+function getUnderlyingToken(c) {
+    if (!c || c instanceof Error) {
+        return undefined;
+    }
+    return c.underlyingToken;
+}
+exports.getUnderlyingToken = getUnderlyingToken;

package/lib/utils/mappers.d.ts

@@ -1,7 +1,7 @@
 declare type SupportedValue = string | number;
 declare const objectEntries: <K extends SupportedValue, T>(o: Record<K, T>) => [K, T][];
 declare const swapKeyValue: <K extends SupportedValue, T extends SupportedValue>(o: Record<K, T>) => Record<T, K>;
-declare const keyToLowercase: <K extends SupportedValue, T extends SupportedValue>(o: Record<K, T>) => Record<K, T>;
-declare const filterEmptyKeys: <K extends SupportedValue, T extends SupportedValue>(o: Record<K, T>) => Record<K, T>;
+declare const keyToLowercase: <K extends SupportedValue, T>(o: Record<K, T>) => Record<K, T>;
+declare const filterEmptyKeys: <K extends SupportedValue, T>(o: Record<K, T>) => Record<K, T>;
 export type { SupportedValue };
 export { objectEntries, swapKeyValue, keyToLowercase, filterEmptyKeys };

package/lib/utils/price.d.ts

@@ -0,0 +1,8 @@
+import { BigNumber } from "ethers";
+export declare const calcTotalPrice: (price: BigNumber, amount: BigNumber, decimals?: number) => BigNumber;
+interface Target {
+    price: BigNumber;
+    decimals: number | undefined;
+}
+export declare function convertByPrice(totalMoney: BigNumber, { price: targetPrice, decimals: targetDecimals }: Target): BigNumber;
+export {};

package/lib/utils/price.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertByPrice = exports.calcTotalPrice = void 0;
+var ethers_1 = require("ethers");
+var constants_1 = require("../core/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;
+function convertByPrice(totalMoney, _a) {
+    var targetPrice = _a.price, _b = _a.decimals, targetDecimals = _b === void 0 ? 18 : _b;
+    var isWrongTargetPrice = targetPrice.isZero() || targetPrice.isNegative();
+    return isWrongTargetPrice
+        ? ethers_1.BigNumber.from(0)
+        : totalMoney
+            .mul(ethers_1.BigNumber.from(10).pow(targetDecimals))
+            .mul(constants_1.PRICE_DECIMALS)
+            .div(targetPrice)
+            .div(constants_1.WAD);
+}
+exports.convertByPrice = convertByPrice;

package/package.json

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

package/src/apy/convexAPY.ts

@@ -1,15 +1,13 @@
 import { BigNumber, providers } from "ethers";
-import axios from "axios";
 import {
   ConvexPoolContract,
   ConvexPoolParams,
   contractsByNetwork,
-  contractParams,
-  CurvePoolContract
+  contractParams
 } from "../contracts/contracts";
 
 import { tokenDataByNetwork, supportedTokens } from "../tokens/token";
-import { CurveLPToken } from "../tokens/curveLP";
+import { CurveLPTokenData } from "../tokens/curveLP";
 import { ConvexPhantomTokenData } from "../tokens/convex";
 
 import {
@@ -22,49 +20,32 @@ import {
 } from "../types";
 
 import { multicall, MCall } from "../utils/multicall";
-import { toBN } from "../utils/formatter";
 import { AwaitedRes } from "../utils/types";
 
 import {
   SECONDS_PER_YEAR,
   WAD,
-  WAD_DECIMALS_POW,
   NetworkType,
   PRICE_DECIMALS
 } from "../core/constants";
 
-type SupportedPools = Extract<
-  ConvexPoolContract,
-  | "CONVEX_3CRV_POOL"
-  | "CONVEX_FRAX3CRV_POOL"
-  | "CONVEX_LUSD3CRV_POOL"
-  | "CONVEX_GUSD_POOL"
-  | "CONVEX_SUSD_POOL"
->;
-
-type SupportedConvex = Extract<
-  CurvePoolContract,
-  | "CURVE_3CRV_POOL"
-  | "CURVE_FRAX_POOL"
-  | "CURVE_LUSD_POOL"
-  | "CURVE_GUSD_POOL"
-  | "CURVE_SUSD_POOL"
->;
-
-const curveSwapByPool: Record<SupportedPools, SupportedConvex> = {
-  CONVEX_3CRV_POOL: "CURVE_3CRV_POOL",
-  CONVEX_FRAX3CRV_POOL: "CURVE_FRAX_POOL",
-  CONVEX_LUSD3CRV_POOL: "CURVE_LUSD_POOL",
-  CONVEX_GUSD_POOL: "CURVE_GUSD_POOL",
-  CONVEX_SUSD_POOL: "CURVE_SUSD_POOL"
-};
-
-export async function getConvexApy(
-  pool: SupportedPools,
-  provider: providers.Provider,
-  networkType: NetworkType,
-  getTokenPrice: (tokenAddress: string) => BigNumber
-) {
+import { CurveAPYResult } from "./curveAPY";
+
+export interface GetConvexAPYProps {
+  pool: ConvexPoolContract;
+  provider: providers.Provider;
+  networkType: NetworkType;
+  getTokenPrice: (tokenAddress: string) => BigNumber;
+  curveAPY: CurveAPYResult;
+}
+
+export async function getConvexAPY({
+  pool,
+  provider,
+  networkType,
+  getTokenPrice,
+  curveAPY
+}: GetConvexAPYProps) {
   const tokenList = tokenDataByNetwork[networkType];
   const contractsList = contractsByNetwork[networkType];
 
@@ -75,7 +56,10 @@ export async function getConvexApy(
 
   const { underlying } = stakedTokenParams;
   const basePoolAddress = contractsList[pool];
-  const swapPoolAddress = contractsList[curveSwapByPool[pool]];
+
+  const crvParams = supportedTokens[underlying] as CurveLPTokenData;
+
+  const swapPoolAddress = contractsList[crvParams.pool];
   const cvxAddress = tokenList.CVX;
 
   const extraPoolAddresses = poolParams.extraRewards.map(
@@ -83,13 +67,13 @@ export async function getConvexApy(
   );
 
   const [basePoolRate, basePoolSupply, vPrice, cvxSupply, ...extra] =
-    await getPoolData(
+    await getPoolData({
       basePoolAddress,
       swapPoolAddress,
       cvxAddress,
       extraPoolAddresses,
       provider
-    );
+    });
 
   const cvxPrice = getTokenPrice(tokenList.CVX);
   const crvPrice = getTokenPrice(tokenList.CRV);
@@ -101,8 +85,8 @@ export async function getConvexApy(
   const crvPerYear = crvPerUnderlying.mul(SECONDS_PER_YEAR);
   const cvxPerYear = getCVXMintAmount(crvPerYear, cvxSupply);
 
-  const crvAPY = crvPerYear.mul(cvxPrice).div(PRICE_DECIMALS);
-  const cvxAPY = cvxPerYear.mul(crvPrice).div(PRICE_DECIMALS);
+  const crvAPY = crvPerYear.mul(crvPrice).div(PRICE_DECIMALS);
+  const cvxAPY = cvxPerYear.mul(cvxPrice).div(PRICE_DECIMALS);
 
   const extraAPRs = await Promise.all(
     extraPoolAddresses.map(async (_, index) => {
@@ -112,9 +96,9 @@ export async function getConvexApy(
       const perUnderlying = extraPoolRate.mul(WAD).div(virtualSupply);
       const perYear = perUnderlying.mul(SECONDS_PER_YEAR);
 
-      const extraPrise = getTokenPrice(tokenList[extraRewardSymbol]);
+      const extraPrice = getTokenPrice(tokenList[extraRewardSymbol]);
 
-      const extraAPY = perYear.mul(extraPrise).div(PRICE_DECIMALS);
+      const extraAPY = perYear.mul(extraPrice).div(PRICE_DECIMALS);
 
       return extraAPY;
     })
@@ -125,9 +109,9 @@ export async function getConvexApy(
     BigNumber.from(0)
   );
 
-  const baseApyRAY = await getCurveBaseApy(underlying);
+  const baseApyWAD = curveAPY[underlying];
 
-  return baseApyRAY.add(crvAPY).add(cvxAPY).add(extraAPYTotal);
+  return baseApyWAD.add(crvAPY).add(cvxAPY).add(extraAPYTotal);
 }
 
 const CVX_MAX_SUPPLY = WAD.mul(100000000);
@@ -154,13 +138,21 @@ type IBaseRewardPoolInterface = IBaseRewardPool["interface"];
 type IConvexTokenInterface = IConvexToken["interface"];
 type CurveV1AdapterStETHInterface = CurveV1AdapterStETH["interface"];
 
-async function getPoolData(
-  basePoolAddress: string,
-  underlying: string,
-  cvxAddress: string,
-  extraPoolAddresses: string[],
-  provider: providers.Provider
-) {
+interface GetPoolDataProps {
+  basePoolAddress: string;
+  swapPoolAddress: string;
+  cvxAddress: string;
+  extraPoolAddresses: string[];
+  provider: providers.Provider;
+}
+
+async function getPoolData({
+  basePoolAddress,
+  swapPoolAddress,
+  cvxAddress,
+  extraPoolAddresses,
+  provider
+}: GetPoolDataProps) {
   const calls: [
     MCall<IBaseRewardPoolInterface>,
     MCall<IBaseRewardPoolInterface>,
@@ -179,7 +171,7 @@ async function getPoolData(
       method: "totalSupply()"
     },
     {
-      address: underlying,
+      address: swapPoolAddress,
       interface: CurveV1AdapterStETH__factory.createInterface(),
       method: "get_virtual_price()"
     },
@@ -207,44 +199,3 @@ async function getPoolData(
     ]
   >(calls, provider);
 }
-
-interface CurveAPRData {
-  baseApy: number;
-  crvApy: number;
-  crvBoost: number;
-  crvPrice: number;
-}
-
-interface APYResponse {
-  apys: Record<string, CurveAPRData>;
-}
-
-const curveLPTokenToPoolName: Record<CurveLPToken, string> = {
-  "3Crv": "3pool",
-  FRAX3CRV: "frax",
-  gusd3CRV: "gusd",
-  LUSD3CRV: "lusd",
-  crvPlain3andSUSD: "susdv2",
-  steCRV: "steth"
-};
-
-const RESPONSE_DECIMALS = 100;
-
-// https://www.convexfinance.com/api/curve-apys
-
-export async function getCurveBaseApy(
-  curveLPToken: CurveLPToken
-): Promise<BigNumber> {
-  const poolName = curveLPTokenToPoolName[curveLPToken];
-
-  try {
-    const url = "https://www.convexfinance.com/api/curve-apys";
-    const result = await axios.get<APYResponse>(url);
-
-    const { baseApy = 0 } = result.data.apys[poolName] || {};
-
-    return toBN((baseApy / RESPONSE_DECIMALS).toString(), WAD_DECIMALS_POW);
-  } catch (e) {
-    return BigNumber.from(0);
-  }
-}

package/src/apy/curveAPY.ts

@@ -0,0 +1,68 @@
+import { BigNumber } from "ethers";
+import axios from "axios";
+
+import { CurveLPToken } from "../tokens/curveLP";
+
+import { toBN } from "../utils/formatter";
+
+import { WAD_DECIMALS_POW } from "../core/constants";
+import { objectEntries } from "../utils/mappers";
+
+interface CurveAPYData {
+  baseApy: number;
+  crvApy: number;
+  crvBoost: number;
+  crvPrice: number;
+}
+
+interface Response {
+  apys: Record<string, CurveAPYData>;
+}
+
+const NAME_DICTIONARY: Record<CurveLPToken, string> = {
+  "3Crv": "3pool",
+  FRAX3CRV: "frax",
+  gusd3CRV: "gusd",
+  LUSD3CRV: "lusd",
+  crvPlain3andSUSD: "susdv2",
+  steCRV: "steth"
+};
+
+const RESPONSE_DECIMALS = 100;
+const ZERO = BigNumber.from(0);
+
+// https://www.convexfinance.com/api/curve-apys
+// http://localhost:8000/api/curve-apys
+const URL = "https://www.convexfinance.com/api/curve-apys";
+
+export type CurveAPYResult = Record<CurveLPToken, BigNumber>;
+
+export async function getCurveAPY(): Promise<CurveAPYResult> {
+  try {
+    const { data } = await axios.get<Response>(URL);
+    const { apys } = data || {};
+
+    const curveAPY = objectEntries(NAME_DICTIONARY).reduce<CurveAPYResult>(
+      (acc, [curveSymbol, apiEntry]) => {
+        const { baseApy = 0 } = apys[apiEntry] || {};
+        acc[curveSymbol] = toBN(
+          (baseApy / RESPONSE_DECIMALS).toString(),
+          WAD_DECIMALS_POW
+        );
+        return acc;
+      },
+      {} as CurveAPYResult
+    );
+
+    return curveAPY;
+  } catch (e) {
+    return {
+      "3Crv": ZERO,
+      FRAX3CRV: ZERO,
+      gusd3CRV: ZERO,
+      LUSD3CRV: ZERO,
+      crvPlain3andSUSD: ZERO,
+      steCRV: ZERO
+    };
+  }
+}

package/src/apy/index.ts

@@ -0,0 +1,8 @@
+import { LPTokens, SupportedToken } from "../tokens/token";
+
+export type TokensWithAPY = LPTokens | Extract<SupportedToken, "LDO">;
+
+export * from "./convexAPY";
+export * from "./lidoAPY";
+export * from "./curveAPY";
+export * from "./yearnAPY";

package/src/apy/lidoAPY.ts

@@ -24,7 +24,7 @@ const lidoStEth: Record<NetworkType, string> = {
   Kovan: tokenDataByNetwork.Kovan.STETH
 };
 
-export async function getLidoApy(
+export async function getLidoAPY(
   provider: providers.Provider,
   networkType: NetworkType
 ) {

package/src/apy/yearnAPY.ts

@@ -0,0 +1,66 @@
+import { BigNumber } from "ethers";
+import axios from "axios";
+
+import { YearnLPToken, yearnTokens } from "../tokens/yearn";
+
+import { toBN } from "../utils/formatter";
+
+import { WAD_DECIMALS_POW } from "../core/constants";
+import { objectEntries } from "../utils/mappers";
+
+interface YearnAPYData {
+  apy: {
+    gross_apr: number;
+    net_apy: number;
+  };
+
+  symbol: string;
+  display_name: string;
+}
+
+type Response = Array<YearnAPYData>;
+
+const RESPONSE_DECIMALS = 1;
+const ZERO = BigNumber.from(0);
+
+const URL = "https://api.yearn.finance/v1/chains/1/vaults/all";
+
+export type YearnAPYResult = Record<YearnLPToken, BigNumber>;
+
+const transformSymbol = (s: string) => s.replaceAll("_", "-").toLowerCase();
+
+export async function getYearnAPY(): Promise<YearnAPYResult> {
+  try {
+    const { data } = await axios.get<Response>(URL);
+
+    const dataBySymbol = data.reduce<Record<string, YearnAPYData>>((acc, d) => {
+      acc[d.symbol.toLowerCase()] = d;
+      return acc;
+    }, {});
+
+    const yearnAPY = objectEntries(yearnTokens).reduce<YearnAPYResult>(
+      (acc, [yearnSymbol]) => {
+        const { apy } = dataBySymbol[transformSymbol(yearnSymbol)] || {};
+        const { net_apy: netApy } = apy || {};
+
+        acc[yearnSymbol] = toBN(
+          (netApy / RESPONSE_DECIMALS).toString(),
+          WAD_DECIMALS_POW
+        );
+        return acc;
+      },
+      {} as YearnAPYResult
+    );
+
+    return yearnAPY;
+  } catch (e) {
+    return {
+      yvDAI: ZERO,
+      yvUSDC: ZERO,
+      yvWETH: ZERO,
+      yvWBTC: ZERO,
+      yvCurve_stETH: ZERO,
+      yvCurve_FRAX: ZERO
+    };
+  }
+}

package/src/contracts/contractsRegister.ts

@@ -1,4 +1,5 @@
 import { keyToLowercase } from "../utils/mappers";
+import { shortAddress } from "../utils/formatter";
 import { contractsByAddress, contractParams } from "./contracts";
 
 export const deployedContracts: Record<string, string> = {
@@ -63,5 +64,5 @@ const contractsFullList = {
 };
 
 export function getContractName(address: string): string {
-  return contractsFullList[address.toLowerCase()] || address;
+  return contractsFullList[address.toLowerCase()] || shortAddress(address);
 }

package/src/core/creditAccount.ts

@@ -3,6 +3,8 @@ import {
   CreditAccountDataExtendedPayload,
   CreditAccountDataPayload
 } from "../payload/creditAccount";
+import { calcTotalPrice } from "../utils/price";
+
 import {
   PERCENTAGE_FACTOR,
   RAY,
@@ -10,7 +12,6 @@ import {
   PRICE_DECIMALS
 } from "./constants";
 import { TokenData } from "../tokens/tokenData";
-import { calcTotalPrice } from "./price";
 
 export type Balance = { address: string; balance: BigNumber };
 
@@ -48,12 +49,12 @@ export class CreditAccountData {
   public readonly version: number = 1;
 
   constructor(payload: CreditAccountDataPayload) {
-    this.id = payload.creditManager;
-    this.addr = payload.addr;
-    this.borrower = payload.borrower;
+    this.id = payload.creditManager.toLowerCase();
+    this.addr = payload.addr.toLowerCase();
+    this.borrower = payload.borrower.toLowerCase();
     this.inUse = payload.inUse;
-    this.creditManager = payload.creditManager;
-    this.underlyingToken = payload.underlying;
+    this.creditManager = payload.creditManager.toLowerCase();
+    this.underlyingToken = payload.underlying.toLowerCase();
     this.borrowedAmountPlusInterest = BigNumber.from(
       payload.borrowedAmountPlusInterest
     );
@@ -68,13 +69,14 @@ export class CreditAccountData {
         .toNumber() / PERCENTAGE_FACTOR;
 
     (payload.balances || []).forEach(b => {
+      const tokenLC = b.token.toLowerCase();
       if (b.isAllowed) {
-        this.balances[b.token] = BigNumber.from(b.balance);
-        this.allowedTokens.push(b.token);
+        this.balances[tokenLC] = BigNumber.from(b.balance);
+        this.allowedTokens.push(tokenLC);
       }
 
-      this.allBalances[b.token] = BigNumber.from(b.balance);
-      this.allTokens.push(b.token);
+      this.allBalances[tokenLC] = BigNumber.from(b.balance);
+      this.allTokens.push(tokenLC);
     });
 
     this.isDeleting = false;
@@ -94,7 +96,7 @@ export function sortBalances(
   balances: Record<string, BigNumber>,
   prices: Record<string, BigNumber>,
   tokens: Record<string, TokenData>
-) {
+): Array<[string, BigNumber]> {
   return Object.entries(balances).sort(([addr1, amount1], [addr2, amount2]) => {
     const addr1Lc = addr1.toLowerCase();
     const addr2Lc = addr2.toLowerCase();
@@ -109,7 +111,9 @@ export function sortBalances(
     const totalPrice2 = calcTotalPrice(price2, amount2, token2?.decimals);
 
     if (totalPrice1.eq(totalPrice2)) {
-      return tokensAbcComparator(token1, token2);
+      return amount1.eq(amount2)
+        ? tokensAbcComparator(token1, token2)
+        : amountAbcComparator(amount1, amount2);
     }
 
     if (totalPrice1.gt(totalPrice2)) {
@@ -127,6 +131,10 @@ export function tokensAbcComparator(t1?: TokenData, t2?: TokenData) {
   return symbol1 > symbol2 ? 1 : -1;
 }
 
+export function amountAbcComparator(t1: BigNumber, t2: BigNumber) {
+  return t1?.gt(t2) ? -1 : 1;
+}
+
 export class CreditAccountDataExtended extends CreditAccountData {
   public readonly repayAmount: BigNumber;