@gearbox-protocol/sdk 0.0.102 → 0.0.103

package/src/pathfinder/tradeTypes.ts

@@ -1,101 +1,105 @@
-import {ConvexPoolContract, CurvePoolContract, UniswapV2Contract, YearnVaultContract} from "../contracts/contracts";
-import {NormalToken} from "../tokens/normal";
-import {CurveLPToken} from "../tokens/curveLP";
-import {YearnLPToken} from "../tokens/yearn";
-import {ConvexLPToken, ConvexStakedPhantomToken} from "../tokens/convex";
-
+import type {
+  ConvexPoolContract,
+  CurvePoolContract,
+  UniswapV2Contract,
+  YearnVaultContract
+} from "../contracts/contracts";
+import type { NormalToken } from "../tokens/normal";
+import type { CurveLPToken } from "../tokens/curveLP";
+import type { YearnLPToken } from "../tokens/yearn";
+import type { ConvexLPToken, ConvexStakedPhantomToken } from "../tokens/convex";
 
 export enum TradeType {
-    UniswapV2Swap,
-    UniswapV3Swap,
-    CurveExchange,
-    CurveExchangeUnderlying,
-    CurveDepositLP,
-    CurveWithdrawLP,
-    YearnDeposit,
-    YearnWithdraw,
-    LidoStake,
-    ConvexDepositLP,
-    ConvexStake,
-    ConvexDepositLPAndStake,
-    ConvexWithdrawLP,
-    ConvexWithdraw,
-    ConvexWithdrawAndUnwrap
+  UniswapV2Swap,
+  UniswapV3Swap,
+  CurveExchange,
+  CurveExchangeUnderlying,
+  CurveDepositLP,
+  CurveWithdrawLP,
+  YearnDeposit,
+  YearnWithdraw,
+  LidoStake,
+  ConvexDepositLP,
+  ConvexStake,
+  ConvexDepositLPAndStake,
+  ConvexWithdrawLP,
+  ConvexWithdraw,
+  ConvexWithdrawAndUnwrap
 }
 
 export type TradeAction =
-    | {
-    type: TradeType.UniswapV2Swap;
-    contract: UniswapV2Contract;
-    tokenOut?: NormalToken;
-}
-    | {
-    type: TradeType.UniswapV3Swap;
-    contract: "UNISWAP_V3_ROUTER";
-    tokenOut?: NormalToken;
-}
-    | {
-    type: TradeType.CurveExchange;
-    contract: CurvePoolContract;
-    tokenOut: Array<NormalToken | CurveLPToken>;
-}
-    | {
-    type: TradeType.CurveDepositLP;
-    contract: CurvePoolContract;
-    tokenOut: CurveLPToken;
-}
-    | {
-    type: TradeType.CurveWithdrawLP;
-    contract: CurvePoolContract;
-    tokenOut: Array<CurveLPToken | NormalToken>;
-}
-    | {
-    type: TradeType.YearnDeposit;
-    contract: YearnVaultContract;
-    tokenOut: YearnLPToken;
-}
-    | {
-    type: TradeType.YearnWithdraw;
-    contract: YearnVaultContract;
-    tokenOut: NormalToken | CurveLPToken;
-}
-    | {
-    type: TradeType.LidoStake;
-    contract: "LIDO_STETH_GATEWAY";
-    tokenOut: NormalToken;
-}
-    | {
-    type: TradeType.ConvexDepositLP;
-    contract: "CONVEX_BOOSTER";
-    tokenOut: ConvexLPToken;
-}
-    | {
-    type: TradeType.ConvexStake;
-    contract: ConvexPoolContract;
-    tokenOut: ConvexStakedPhantomToken;
-}
-    | {
-    type: TradeType.ConvexDepositLPAndStake;
-    contract: "CONVEX_BOOSTER";
-    tokenOut: ConvexStakedPhantomToken;
-}
-    | {
-    type: TradeType.ConvexWithdrawLP;
-    contract: "CONVEX_BOOSTER";
-    tokenOut: CurveLPToken;
-}
-    | {
-    type: TradeType.ConvexWithdraw;
-    contract: ConvexPoolContract;
-    tokenOut: ConvexLPToken;
-}
-    | {
-    type: TradeType.ConvexWithdrawAndUnwrap;
-    contract: ConvexPoolContract;
-    tokenOut: CurveLPToken;
-};
+  | {
+      type: TradeType.UniswapV2Swap;
+      contract: UniswapV2Contract;
+      tokenOut?: NormalToken;
+    }
+  | {
+      type: TradeType.UniswapV3Swap;
+      contract: "UNISWAP_V3_ROUTER";
+      tokenOut?: NormalToken;
+    }
+  | {
+      type: TradeType.CurveExchange;
+      contract: CurvePoolContract;
+      tokenOut: Array<NormalToken | CurveLPToken>;
+    }
+  | {
+      type: TradeType.CurveDepositLP;
+      contract: CurvePoolContract;
+      tokenOut: CurveLPToken;
+    }
+  | {
+      type: TradeType.CurveWithdrawLP;
+      contract: CurvePoolContract;
+      tokenOut: Array<CurveLPToken | NormalToken>;
+    }
+  | {
+      type: TradeType.YearnDeposit;
+      contract: YearnVaultContract;
+      tokenOut: YearnLPToken;
+    }
+  | {
+      type: TradeType.YearnWithdraw;
+      contract: YearnVaultContract;
+      tokenOut: NormalToken | CurveLPToken;
+    }
+  | {
+      type: TradeType.LidoStake;
+      contract: "LIDO_STETH_GATEWAY";
+      tokenOut: NormalToken;
+    }
+  | {
+      type: TradeType.ConvexDepositLP;
+      contract: "CONVEX_BOOSTER";
+      tokenOut: ConvexLPToken;
+    }
+  | {
+      type: TradeType.ConvexStake;
+      contract: ConvexPoolContract;
+      tokenOut: ConvexStakedPhantomToken;
+    }
+  | {
+      type: TradeType.ConvexDepositLPAndStake;
+      contract: "CONVEX_BOOSTER";
+      tokenOut: ConvexStakedPhantomToken;
+    }
+  | {
+      type: TradeType.ConvexWithdrawLP;
+      contract: "CONVEX_BOOSTER";
+      tokenOut: CurveLPToken;
+    }
+  | {
+      type: TradeType.ConvexWithdraw;
+      contract: ConvexPoolContract;
+      tokenOut: ConvexLPToken;
+    }
+  | {
+      type: TradeType.ConvexWithdrawAndUnwrap;
+      contract: ConvexPoolContract;
+      tokenOut: CurveLPToken;
+    };
 
 export enum SwapType {
-    ExactInput = 1,
-    ExactOutput = 2,
-}
+  ExactInput = 1,
+  ExactOutput = 2
+}

package/src/pathfinder/yVault.ts

@@ -1,14 +1,19 @@
 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 { objectEntries } from "../utils/mappers";
+
+import { IYVault__factory } from "../types";
 import { IYVaultInterface } from "../types/contracts/integrations/yearn/IYVault";
 
+import type { Path, LPWithdrawPathFinder } from "./path";
+
 interface WithdrawBalance {
   token: SupportedToken;
   balance: BigNumber;
@@ -16,6 +21,7 @@ interface WithdrawBalance {
 
 export class YearnVaultPathFinder implements LPWithdrawPathFinder {
   _vault: YearnLPToken;
+
   token: NormalToken | CurveLPToken;
 
   constructor(vault: YearnLPToken) {
@@ -27,18 +33,27 @@ export class YearnVaultPathFinder implements LPWithdrawPathFinder {
     this.token = currentTokenData.underlying;
   }
 
-  async findWithdrawPaths(p: Path): Promise<Array<Path>> {
-    let vaultBalances: PartialRecord<SupportedToken, WithdrawBalance> = {};
-
-    for (let [yVault, tokenData] of Object.entries(yearnTokens)) {
-      const currentBalance = p.popBalance(yVault as YearnLPToken);
+  // eslint-disable-next-line class-methods-use-this
+  async findWithdrawPaths(path: Path): Promise<Array<Path>> {
+    // make path copy
+    const p: Path = Object.assign(
+      Object.create(Object.getPrototypeOf(path)),
+      path
+    );
+
+    const vaultBalances = objectEntries(yearnTokens).reduce<
+      PartialRecord<SupportedToken, WithdrawBalance>
+    >((acc, [yVault, tokenData]) => {
+      const typedVault = yVault;
+      const currentBalance = p.popBalance(typedVault);
       if (currentBalance.gt(1)) {
-        vaultBalances[yVault as YearnLPToken] = {
+        acc[typedVault] = {
           token: tokenData.underlying,
           balance: currentBalance
         };
       }
-    }
+      return acc;
+    }, {});
 
     const vaultList = Object.keys(vaultBalances) as Array<SupportedToken>;
 
@@ -53,7 +68,7 @@ export class YearnVaultPathFinder implements LPWithdrawPathFinder {
 
     const prices = await multicall<Array<BigNumber>>(multicallData, p.provider);
 
-    for (let i = 0; i < vaultList.length; i++) {
+    for (let i = 0; i < vaultList.length; i += 1) {
       const vault = vaultList[i];
       const vb = vaultBalances[vault];
 
@@ -70,6 +85,6 @@ export class YearnVaultPathFinder implements LPWithdrawPathFinder {
       p.calls.push({ target: adapterAddress, callData });
     }
 
-    return await p.withdrawTokens();
+    return p.withdrawTokens();
   }
 }

package/src/payload/token.ts

@@ -1,5 +1,5 @@
 export interface TokenDataPayload {
-    addr: string;
-    symbol: string;
-    decimals: number;
+  addr: string;
+  symbol: string;
+  decimals: number;
 }