@gearbox-protocol/sdk 0.0.98 → 0.0.101

package/src/pathfinder/yVault.ts

@@ -1,74 +1,75 @@
-import {BigNumber} from "ethers";
-import {IYVault__factory} from "../types";
-import {Path, LPWithdrawPathFinder} from "./path";
-import {YearnLPToken, yearnTokens} from "../tokens/yearn";
-import {NormalToken} from "../tokens/normal";
-import {CurveLPToken} from "../tokens/curveLP";
-import {SupportedToken, tokenDataByNetwork} from "../tokens/token";
-import {PartialRecord} from "../utils/types";
-import {MCall, multicall} from "../utils/multicall";
-import {IYVaultInterface} from "../types/contracts/integrations/yearn/IYVault";
+import { BigNumber } from "ethers";
+import { IYVault__factory } from "../types";
+import { Path, LPWithdrawPathFinder } from "./path";
+import { YearnLPToken, yearnTokens } from "../tokens/yearn";
+import { NormalToken } from "../tokens/normal";
+import { CurveLPToken } from "../tokens/curveLP";
+import { SupportedToken, tokenDataByNetwork } from "../tokens/token";
+import { PartialRecord } from "../utils/types";
+import { MCall, multicall } from "../utils/multicall";
+import { IYVaultInterface } from "../types/contracts/integrations/yearn/IYVault";
 
 interface WithdrawBalance {
-    token: SupportedToken;
-    balance: BigNumber;
+  token: SupportedToken;
+  balance: BigNumber;
 }
 
 export class YearnVaultPathFinder implements LPWithdrawPathFinder {
-    _vault: YearnLPToken;
-    token: NormalToken | CurveLPToken;
+  _vault: YearnLPToken;
+  token: NormalToken | CurveLPToken;
 
-    constructor(vault: YearnLPToken) {
-        this._vault = vault;
+  constructor(vault: YearnLPToken) {
+    this._vault = vault;
 
-        const currentTokenData = yearnTokens[vault];
+    const currentTokenData = yearnTokens[vault];
 
-        // Yearn Vault only has one lp action
-        this.token = currentTokenData.underlying;
-    }
-
-    async findWithdrawPaths(p: Path): Promise<Array<Path>> {
-        let vaultBalances: PartialRecord<SupportedToken, WithdrawBalance> = {};
+    // Yearn Vault only has one lp action
+    this.token = currentTokenData.underlying;
+  }
 
-        for (let [yVault, tokenData] of Object.entries(yearnTokens)) {
-            const currentBalance = p.popBalance(yVault as YearnLPToken);
-            if (currentBalance.gt(1)) {
-                vaultBalances[yVault as YearnLPToken] = {
-                    token: tokenData.underlying,
-                    balance: currentBalance
-                };
-            }
-        }
+  async findWithdrawPaths(p: Path): Promise<Array<Path>> {
+    let vaultBalances: PartialRecord<SupportedToken, WithdrawBalance> = {};
 
-        const vaultList = Object.keys(vaultBalances) as Array<SupportedToken>;
+    for (let [yVault, tokenData] of Object.entries(yearnTokens)) {
+      const currentBalance = p.popBalance(yVault as YearnLPToken);
+      if (currentBalance.gt(1)) {
+        vaultBalances[yVault as YearnLPToken] = {
+          token: tokenData.underlying,
+          balance: currentBalance
+        };
+      }
+    }
 
-        // Yearn Vault only has one lp action
-        const multicallData: Array<MCall<IYVaultInterface>> = vaultList
-            .map(t => tokenDataByNetwork[p.networkType][t as SupportedToken])
-            .map(addr => ({
-                address: addr,
-                interface: IYVault__factory.createInterface(),
-                method: "pricePerShare()"
-            }));
+    const vaultList = Object.keys(vaultBalances) as Array<SupportedToken>;
 
-        const prices = await multicall<Array<BigNumber>>(multicallData, p.provider);
+    // Yearn Vault only has one lp action
+    const multicallData: Array<MCall<IYVaultInterface>> = vaultList
+      .map(t => tokenDataByNetwork[p.networkType][t as SupportedToken])
+      .map(addr => ({
+        address: addr,
+        interface: IYVault__factory.createInterface(),
+        method: "pricePerShare()"
+      }));
 
-        for (let i = 0; i < vaultList.length; i++) {
-            const vault = vaultList[i];
-            const vb = vaultBalances[vault];
+    const prices = await multicall<Array<BigNumber>>(multicallData, p.provider);
 
-            p.balances[vb!.token] = (p.balances[vb!.token] || BigNumber.from(0)).add(
-                BigNumber.from(vb?.balance || 0).mul(prices[i])
-            );
+    for (let i = 0; i < vaultList.length; i++) {
+      const vault = vaultList[i];
+      const vb = vaultBalances[vault];
 
-            p.calls.push({
-                targetContract:
-                    p.creditManager.adapters[tokenDataByNetwork[p.networkType][vault]],
-                callData:
-                    IYVault__factory.createInterface().encodeFunctionData("withdraw()")
-            });
-        }
+      p.balances[vb!.token] = (p.balances[vb!.token] || BigNumber.from(0)).add(
+        BigNumber.from(vb?.balance || 0).mul(prices[i])
+      );
 
-        return await p.withdrawTokens();
+      // !!!!!!!!!
+      // p.calls.push({
+      //   targetContract:
+      //     p.creditManager.adapters[tokenDataByNetwork[p.networkType][vault]],
+      //   callData:
+      //     IYVault__factory.createInterface().encodeFunctionData("withdraw()")
+      // });
     }
+
+    return await p.withdrawTokens();
+  }
 }

package/src/payload/creditAccount.ts

@@ -1,29 +1,7 @@
-import {BigNumberish} from "ethers";
+import { CreditAccountDataStructOutput } from "../types/contracts/core/DataCompressor";
 
-export interface TokenBalancePayload {
-  token: string;
-  balance: BigNumberish;
-  isAllowed: boolean;
-}
+export type TokenBalancePayload = CreditAccountDataStructOutput["balances"];
 
-export interface CreditAccountDataPayload {
-  addr: string;
-  borrower: string;
-  inUse: boolean;
-  creditManager: string;
-  underlyingToken: string;
-  borrowedAmountPlusInterest: BigNumberish;
-  totalValue: BigNumberish;
-  healthFactor: BigNumberish;
-  borrowRate: BigNumberish;
-  balances?: Array<TokenBalancePayload>;
-}
+export type CreditAccountDataPayload = CreditAccountDataStructOutput;
 
-export interface CreditAccountDataExtendedPayload extends CreditAccountDataPayload {
-  repayAmount: BigNumberish;
-  liquidationAmount: BigNumberish;
-  canBeClosed?: boolean;
-  borrowedAmount: BigNumberish;
-  cumulativeIndexAtOpen: BigNumberish;
-  since: BigNumberish;
-}
+export type CreditAccountDataExtendedPayload = CreditAccountDataStructOutput;

package/src/payload/creditManager.ts

@@ -1,36 +1,24 @@
-import { BigNumberish } from "ethers";
+import { BigNumberish, BigNumber } from "ethers";
+import { CreditManagerDataStructOutput } from "../types/contracts/interfaces/IDataCompressor.sol/IDataCompressor";
 
 export interface AdapterPayload {
   allowedContract: string;
-  adapter: string
+  adapter: string;
 }
 
-export interface CreditManagerDataPayload {
-  addr: string;
-  hasAccount?: boolean;
-  underlyingToken?: string;
-  isWETH?: boolean;
-  canBorrow?: boolean;
-  borrowRate?: BigNumberish;
-  minAmount?: BigNumberish;
-  maxAmount?: BigNumberish;
-  maxLeverageFactor?: BigNumberish;
-  availableLiquidity?: BigNumberish;
-  allowedTokens?: Array<string>;
-  adapters?: Array<AdapterPayload>;
-}
+export type CreditManagerDataPayload = CreditManagerDataStructOutput;
 
-export interface CreditManagerStatPayload {
+export interface CreditManagerStatPayload extends CreditManagerDataPayload {
   addr: string;
   underlyingToken?: string;
-  isWETH?: boolean;
-  canBorrow?: boolean;
-  borrowRate?: BigNumberish;
-  minAmount?: BigNumberish;
-  maxAmount?: BigNumberish;
-  maxLeverageFactor?: BigNumberish;
-  availableLiquidity?: BigNumberish;
-  allowedTokens?: Array<string>;
+  isWETH: boolean;
+  canBorrow: boolean;
+  borrowRate: BigNumber;
+  minAmount: BigNumber;
+  maxAmount: BigNumber;
+  maxLeverageFactor: BigNumber;
+  availableLiquidity: BigNumber;
+  allowedTokens: Array<string>;
   allowedContracts?: Array<string>;
   uniqueUsers: number;
   openedAccountsCount?: number;

package/src/payload/pool.ts

@@ -1,20 +1,3 @@
-import {BigNumberish} from "ethers";
+import { PoolDataStructOutput } from "../types/contracts/interfaces/IDataCompressor.sol/IDataCompressor";
 
-export interface PoolDataPayload {
-  addr: string;
-  underlyingToken: string;
-  dieselToken: string;
-  isWETH: boolean;
-  expectedLiquidity: BigNumberish;
-  expectedLiquidityLimit?: BigNumberish;
-  availableLiquidity: BigNumberish;
-  totalBorrowed: BigNumberish;
-  depositAPY_RAY: BigNumberish;
-  borrowAPY_RAY: BigNumberish;
-  dieselRate_RAY: BigNumberish;
-  withdrawFee: BigNumberish;
-  timestampLU?: BigNumberish;
-  cumulativeIndex_RAY?: BigNumberish
-}
-
-//
+export type PoolDataPayload = PoolDataStructOutput;

package/src/tokens/token.ts

@@ -1,4 +1,9 @@
-import { keyToLowercase, objectEntries, swapKeyValue } from "../utils/mappers";
+import {
+  keyToLowercase,
+  objectEntries,
+  swapKeyValue,
+  filterEmptyKeys
+} from "../utils/mappers";
 import { NetworkType } from "../core/constants";
 import { NormalToken, NormalTokenData, normalTokens } from "./normal";
 import {
@@ -201,13 +206,13 @@ export const tokenDataByNetwork: Record<
     cvxsteCRV: "0xb22c2015327cfbeD480eF45B6382d4bC963a4595",
     cvxcrvPlain3andSUSD: "0xBBeAdEA3C648cF4026d0422EAF2463050202700b",
     cvxFRAX3CRV: "0xBC523005975D86de9226785DD83e4f8d2A87fA73",
-    cvxLUSD3CRV: "0xF1128521595A6CAee02af9DBdb15857954cC2cA0",
+    cvxLUSD3CRV: "0xF90d9a96985a80e6c2cA9952cd2C6Db5B720408F",
     cvxgusd3CRV: "0xa3aDFDf18d166e26bF1Bc0ee63D26d0d1064b056",
 
     // CONVEX PHANTOM TOKEN ADDRESSES
     stkcvx3Crv: "0xf4FC4Aa052346fEa87f1e864f10de0f7383e9502",
     stkcvxFRAX3CRV: "0xd726f9684245065B120E1ac18de389f6b05351Ba",
-    stkcvxLUSD3CRV: "",
+    stkcvxLUSD3CRV: "0x5c355c46413B45Cc58aB61AcaF5BB72E7c2d1465",
     stkcvxgusd3CRV: "0x9A74e8106f6c28b21b1B6a0F985cf1227BE05F04",
     stkcvxsteCRV: "0xd8bAbB7EfBF7F931a69B209f71b27421F8b18516",
     stkcvxcrvPlain3andSUSD: "0x6b45Cab756B41a7204973b71362ef5F73E67F6DA",
@@ -224,6 +229,6 @@ export const tokenDataByNetwork: Record<
 
 export const tokenSymbolByAddress = objectEntries(tokenDataByNetwork).reduce<
   Record<string, SupportedToken>
->((sum, [_, tokens]) => {
-  return { ...sum, ...keyToLowercase(swapKeyValue(tokens)) };
+>((acc, [_, tokens]) => {
+  return { ...acc, ...filterEmptyKeys(keyToLowercase(swapKeyValue(tokens))) };
 }, {});

package/src/utils/formatter.ts

@@ -1,5 +1,5 @@
 import { BigNumber, BigNumberish } from "ethers";
-import { PERCENTAGE_FACTOR, RAY } from "../core/constants";
+import { PERCENTAGE_FACTOR, RAY, LEVERAGE_DECIMALS } from "../core/constants";
 import Decimal from "decimal.js-light";
 
 export function rayToNumber(num: BigNumberish): number {
@@ -136,3 +136,7 @@ export function formatDate(date: Date): string {
 export function formatHf(healthFactor: number): string {
   return (healthFactor / 10000).toFixed(2);
 }
+
+export function formatLeverage(leverage: number, decimals: number = 2) {
+  return (leverage / LEVERAGE_DECIMALS).toFixed(decimals);
+}

package/src/utils/mappers.ts

@@ -7,17 +7,24 @@ const objectEntries = <K extends SupportedValue, T>(
 const swapKeyValue = <K extends SupportedValue, T extends SupportedValue>(
   o: Record<K, T>
 ): Record<T, K> =>
-  objectEntries(o).reduce((sum, [key, value]) => {
-    return { ...sum, [value]: key };
+  objectEntries(o).reduce((acc, [key, value]) => {
+    return { ...acc, [value]: key };
   }, {} as Record<T, K>);
 
 const keyToLowercase = <K extends SupportedValue, T extends SupportedValue>(
   o: Record<K, T>
 ): Record<K, T> =>
-  objectEntries(o).reduce((sum, [key, value]) => {
+  objectEntries(o).reduce((acc, [key, value]) => {
     const keyTransformed = typeof key === "string" ? key.toLowerCase() : key;
-    return { ...sum, [keyTransformed]: value };
+    return { ...acc, [keyTransformed]: value };
+  }, {} as Record<K, T>);
+
+const filterEmptyKeys = <K extends SupportedValue, T extends SupportedValue>(
+  o: Record<K, T>
+): Record<K, T> =>
+  objectEntries(o).reduce((acc, [key, value]) => {
+    return !!key ? { ...acc, [key]: value } : acc;
   }, {} as Record<K, T>);
 
 export type { SupportedValue };
-export { objectEntries, swapKeyValue, keyToLowercase };
+export { objectEntries, swapKeyValue, keyToLowercase, filterEmptyKeys };

package/src/utils/multicall.ts

@@ -1,4 +1,5 @@
 import { ethers } from "ethers";
+import { MULTICALL_ADDRESS } from "../config";
 import { Multicall2, Multicall2__factory } from "../types";
 
 export interface CallData<T extends ethers.utils.Interface> {
@@ -17,10 +18,7 @@ export async function multicall<R extends Array<any>>(
   calls: Array<MCall<any>>,
   p: ethers.providers.Provider
 ): Promise<R> {
-  const multiCallContract = Multicall2__factory.connect(
-    "0x5ba1e12693dc8f9c48aad8770482f4739beed696",
-    p
-  );
+  const multiCallContract = Multicall2__factory.connect(MULTICALL_ADDRESS, p);
 
   const { returnData } = await multiCallContract.callStatic.aggregate(
     calls.map(c => ({
@@ -33,7 +31,7 @@ export async function multicall<R extends Array<any>>(
     .map((d, num) =>
       calls[num].interface.decodeFunctionResult(calls[num].method as string, d)
     )
-    .map(r => r[0]) as R;
+    .map(r => (Array.isArray(r) && r.length <= 1 ? r[0] : r)) as R;
 }
 
 export class MultiCallContract<T extends ethers.utils.Interface> {
@@ -49,10 +47,7 @@ export class MultiCallContract<T extends ethers.utils.Interface> {
     this._address = address;
     this._interface = intrerface;
 
-    this._multiCall = Multicall2__factory.connect(
-      "0x5ba1e12693dc8f9c48aad8770482f4739beed696",
-      provider
-    );
+    this._multiCall = Multicall2__factory.connect(MULTICALL_ADDRESS, provider);
   }
 
   async call<R extends Array<any>>(data: Array<CallData<T>>): Promise<R> {

package/src/utils/types.ts

@@ -1,3 +1,7 @@
 export type PartialRecord<K extends keyof any, T> = {
-    [P in K]?: T;
-};
+  [P in K]?: T;
+};
+
+export type AwaitedRes<T extends (...args: any) => any> = Awaited<
+  ReturnType<T>
+>;

package/lib/core/adapters.d.ts

@@ -1,15 +0,0 @@
-export declare enum AdapterInterface {
-    NO_SWAP = 0,
-    UNISWAP_V2_ROUTER = 1,
-    UNISWAP_V3_ROUTER = 2,
-    CURVE_V1_2ASSETS = 3,
-    CURVE_V1_3ASSETS = 4,
-    CURVE_V1_4ASSETS = 5,
-    CURVE_V1_WRAPPER = 6,
-    CURVE_V1_STECRV_POOL = 7,
-    YEARN_V2 = 8,
-    CONVEX_V1_BASE_REWARD_POOL = 9,
-    CONVEX_V1_BOOSTER = 10,
-    CONVEX_V1_CLAIM_ZAP = 11,
-    LIDO_V1 = 12
-}

package/lib/core/adapters.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdapterInterface = void 0;
-var AdapterInterface;
-(function (AdapterInterface) {
-    AdapterInterface[AdapterInterface["NO_SWAP"] = 0] = "NO_SWAP";
-    AdapterInterface[AdapterInterface["UNISWAP_V2_ROUTER"] = 1] = "UNISWAP_V2_ROUTER";
-    AdapterInterface[AdapterInterface["UNISWAP_V3_ROUTER"] = 2] = "UNISWAP_V3_ROUTER";
-    AdapterInterface[AdapterInterface["CURVE_V1_2ASSETS"] = 3] = "CURVE_V1_2ASSETS";
-    AdapterInterface[AdapterInterface["CURVE_V1_3ASSETS"] = 4] = "CURVE_V1_3ASSETS";
-    AdapterInterface[AdapterInterface["CURVE_V1_4ASSETS"] = 5] = "CURVE_V1_4ASSETS";
-    AdapterInterface[AdapterInterface["CURVE_V1_WRAPPER"] = 6] = "CURVE_V1_WRAPPER";
-    AdapterInterface[AdapterInterface["CURVE_V1_STECRV_POOL"] = 7] = "CURVE_V1_STECRV_POOL";
-    AdapterInterface[AdapterInterface["YEARN_V2"] = 8] = "YEARN_V2";
-    AdapterInterface[AdapterInterface["CONVEX_V1_BASE_REWARD_POOL"] = 9] = "CONVEX_V1_BASE_REWARD_POOL";
-    AdapterInterface[AdapterInterface["CONVEX_V1_BOOSTER"] = 10] = "CONVEX_V1_BOOSTER";
-    AdapterInterface[AdapterInterface["CONVEX_V1_CLAIM_ZAP"] = 11] = "CONVEX_V1_CLAIM_ZAP";
-    AdapterInterface[AdapterInterface["LIDO_V1"] = 12] = "LIDO_V1"; // 11 - 2048
-})(AdapterInterface = exports.AdapterInterface || (exports.AdapterInterface = {}));

package/lib/core/contracts.d.ts

@@ -1,67 +0,0 @@
-import { AdapterInterface } from "./adapters";
-import { NetworkType } from "./constants";
-import { Protocols } from "./protocols";
-import { ConvexStakedPhantomToken } from "../tokens/convex";
-import { CurveLPToken } from "../tokens/curveLP";
-import { NormalToken } from "../tokens/normal";
-export declare type UniswapV2Contract = "UNISWAP_V2_ROUTER" | "SUSHISWAP_ROUTER";
-export declare type CurvePoolContract = "CURVE_3CRV_POOL" | "CURVE_STETH_GATEWAY" | "CURVE_FRAX_POOL" | "CURVE_LUSD_POOL" | "CURVE_GUSD_POOL" | "CURVE_SUSD_POOL" | "CURVE_SUSD_DEPOSIT";
-export declare type YearnVaultContract = "YEARN_DAI_VAULT" | "YEARN_USDC_VAULT" | "YEARN_WETH_VAULT" | "YEARN_WBTC_VAULT" | "YEARN_CURVE_FRAX_VAULT" | "YEARN_CURVE_STETH_VAULT";
-export declare type ConvexPoolContract = "CONVEX_3CRV_POOL" | "CONVEX_GUSD_POOL" | "CONVEX_SUSD_POOL" | "CONVEX_STECRV_POOL" | "CONVEX_FRAX3CRV_POOL";
-export declare type SupportedContract = UniswapV2Contract | "UNISWAP_V3_ROUTER" | CurvePoolContract | YearnVaultContract | "CONVEX_BOOSTER" | ConvexPoolContract | "CONVEX_CLAIM_ZAP" | "LIDO_STETH_GATEWAY";
-export declare const contractsByNetwork: Record<NetworkType, Record<SupportedContract, string>>;
-export declare const UNISWAP_V3_QUOTER = "0xb27308f9f90d607463bb33ea1bebb41c27ce5ab6";
-export interface BaseContractParams {
-    name: string;
-}
-declare type UniswapV2Params = {
-    protocol: Protocols.Uniswap | Protocols.Sushiswap;
-    type: AdapterInterface.UNISWAP_V2_ROUTER;
-} & BaseContractParams;
-declare type UniswapV3Params = {
-    protocol: Protocols.Uniswap;
-    type: AdapterInterface.UNISWAP_V3_ROUTER;
-    quoter: string;
-} & BaseContractParams;
-export declare type CurveParams = {
-    protocol: Protocols.Curve;
-    type: AdapterInterface.CURVE_V1_2ASSETS | AdapterInterface.CURVE_V1_3ASSETS | AdapterInterface.CURVE_V1_4ASSETS | AdapterInterface.CURVE_V1_WRAPPER;
-    lpToken: CurveLPToken;
-    tokens: Array<NormalToken | CurveLPToken>;
-    wrapper?: CurvePoolContract;
-} & BaseContractParams;
-export declare type CurveSteCRVPoolParams = {
-    protocol: Protocols.Curve;
-    type: AdapterInterface.CURVE_V1_STECRV_POOL;
-    pool: Record<NetworkType, string>;
-    lpToken: "steCRV";
-} & BaseContractParams;
-export declare type CurveDepositParams = {
-    protocol: Protocols.Curve;
-    type: AdapterInterface.CURVE_V1_DEPOSIT;
-    pool: Record<NetworkType, string>;
-    lpToken: CurveLPToken;
-    nCoins: number;
-} & BaseContractParams;
-declare type YearnParams = {
-    protocol: Protocols.Yearn;
-    type: AdapterInterface.YEARN_V2;
-} & BaseContractParams;
-declare type ConvexParams = {
-    protocol: Protocols.Convex;
-    type: AdapterInterface.CONVEX_V1_BOOSTER | AdapterInterface.CONVEX_V1_CLAIM_ZAP;
-} & BaseContractParams;
-declare type ConvexPoolParams = {
-    protocol: Protocols.Convex;
-    type: AdapterInterface.CONVEX_V1_BASE_REWARD_POOL;
-    stakedToken: ConvexStakedPhantomToken;
-} & BaseContractParams;
-export declare type LidoParams = {
-    protocol: Protocols.Lido;
-    type: AdapterInterface.LIDO_V1;
-    lpToken: "steCRV";
-} & BaseContractParams;
-export declare type ContractParams = UniswapV2Params | UniswapV3Params | CurveParams | CurveSteCRVPoolParams | CurveDepositParams | YearnParams | ConvexParams | ConvexPoolParams | LidoParams;
-export declare const contractParams: Record<SupportedContract, ContractParams>;
-export declare const contractsByAddress: Record<string, SupportedContract>;
-export {};