@gearbox-protocol/sdk 0.0.65 → 0.0.68

package/src/pathfinder/path.ts

@@ -1,11 +1,15 @@
 import {BigNumber, ethers} from "ethers";
 import {CreditManagerData} from "../core/creditManager";
 import {MultiCall} from "../core/multicall";
-import {SupportedToken, supportedTokens} from "../tokens/token";
+import {
+    SupportedToken,
+    supportedTokens,
+    tokenSymbolByAddress
+} from "../tokens/token";
 import {NetworkType} from "../core/constants";
 import {CreditAccountData} from "../core/creditAccount";
 
-import {PathFinder__factory, UniswapV2Adapter__factory} from "../types";
+import {PathFinder__factory} from "../types";
 import {priority} from "./priority";
 import {YearnLPToken} from "../tokens/yearn";
 import {YearnVaultPathFinder} from "./yVault";
@@ -77,9 +81,21 @@ export class Path {
         creditManager: CreditManagerData,
         provider: ethers.providers.Provider
     ) {
-        const networkType = await detectNetwork(provider)
+        const networkType = await detectNetwork(provider);
+
+        const balances = Object.entries(creditAccount.balances)
+            .map(([address, balance]) => ({
+                token: tokenSymbolByAddress[address.toLowerCase()],
+                balance
+            }))
+            .filter(t => t.balance.gt(1))
+            .reduce(
+                (obj, curValue) => ({...obj, [curValue.token]: curValue.balance}),
+                {}
+            );
+
         const initialPath = new Path({
-            balances: {}, // {...creditAccount.balances},
+            balances,
             creditAccount,
             creditManager,
             networkType,
@@ -94,7 +110,7 @@ export class Path {
             provider
         );
 
-        console.log(lpPaths)
+        console.log(lpPaths);
         console.log(pathFinder);
         // const bestPath = await pathFinder.bestPath();
     }
@@ -145,52 +161,6 @@ export class Path {
     }
 }
 
-export interface ActionData {
-    callData: MultiCall;
-    amountOut: BigNumber;
-    gasLimit: BigNumber;
-}
-
-export abstract class LPWithdrawPathFinder {
-    abstract findWithdrawPaths(p: Path): Promise<Array<Path>>;
-
-    async getUniswapV2SwapData(
-        adapterAddress: string,
-        currentTokenAddress: string,
-        currentBalance: BigNumber,
-        nextTokenAddress: string,
-        p: Path
-    ): Promise<ActionData> {
-        const deadline = Math.floor(Date.now() / 1000) + 1200;
-        const uniswapV2Adapter = UniswapV2Adapter__factory.connect(
-            adapterAddress,
-            p.provider
-        );
-        const path: Array<string> = [currentTokenAddress, nextTokenAddress];
-        const amountsOut: Array<BigNumber> = await uniswapV2Adapter.getAmountsOut(
-            currentBalance,
-            path
-        );
-
-        const amountOut: BigNumber = amountsOut[amountsOut.length - 1];
-        const gasLimit: BigNumber =
-            await uniswapV2Adapter.estimateGas.swapExactTokensForTokens(
-                currentBalance,
-                amountOut,
-                path,
-                p.creditAccount.addr,
-                deadline
-            );
-        const call: MultiCall = {
-            targetContract: adapterAddress,
-            callData: UniswapV2Adapter__factory.createInterface().encodeFunctionData(
-                "swapExactTokensForTokens",
-                [currentBalance, amountOut, path, p.creditAccount.addr, deadline]
-            )
-        };
-
-        return {callData: call, amountOut: amountOut, gasLimit: gasLimit};
-    }
-
-
+export interface LPWithdrawPathFinder {
+    findWithdrawPaths(p: Path): Promise<Array<Path>>;
 }

package/src/pathfinder/trade.ts

@@ -0,0 +1,83 @@
+import {BigNumber} from "ethers";
+import {BytesLike} from "@ethersproject/bytes";
+import {PERCENTAGE_FACTOR, WAD} from "../core/constants";
+import {SwapType} from "./tradeTypes";
+
+export interface CloseTradePath {
+    path: Array<string>;
+    amountOutMin: BigNumber;
+}
+
+export class TradePath {
+    public readonly swapType: SwapType;
+    public readonly amount: BigNumber;
+    public readonly rate: BigNumber;
+    public readonly path: Array<string>;
+    public readonly expectedAmount: BigNumber;
+    public readonly pathUniV3: BytesLike | undefined;
+    public readonly i: number | undefined;
+    public readonly j: number | undefined;
+    public readonly operationName: string | undefined;
+
+    constructor(params: {
+        swapType: SwapType;
+        amount: BigNumber;
+        path: Array<string>;
+        expectedAmount: BigNumber;
+        pathUniV3?: BytesLike;
+        i?: number;
+        j?: number;
+        operationName?: string;
+    }) {
+        this.swapType = params.swapType;
+        this.amount = params.amount;
+        this.path = params.path;
+        this.expectedAmount = params.expectedAmount;
+        this.pathUniV3 = params.pathUniV3;
+        this.rate =
+            params.swapType !== SwapType.ExactInput
+                ? params.expectedAmount.mul(WAD).div(params.amount)
+                : WAD.mul(params.amount).div(params.expectedAmount);
+        this.i = params.i;
+        this.j = params.j;
+        this.operationName = params.operationName;
+    }
+
+    getExpectedAmountWithSlippage(slippage: number): BigNumber {
+        return this.swapType === SwapType.ExactInput
+            ? this.getAmountOutMin(slippage)
+            : this.getAmountInMax(slippage);
+    }
+
+    getAmountInMax(slippage: number): BigNumber {
+        return this.expectedAmount
+            .mul(PERCENTAGE_FACTOR + slippage)
+            .div(PERCENTAGE_FACTOR);
+    }
+
+    getAmountOutMin(slippage: number): BigNumber {
+        return this.expectedAmount
+            .mul(PERCENTAGE_FACTOR)
+            .div(PERCENTAGE_FACTOR + slippage);
+    }
+
+    public get from(): string {
+        return this.path[0];
+    }
+
+    public get to(): string {
+        return this.path[this.path.length - 1];
+    }
+
+    getFromAmount(slippage: number): BigNumber {
+        return this.swapType === SwapType.ExactInput
+            ? this.amount
+            : this.getExpectedAmountWithSlippage(slippage);
+    }
+
+    getToAmount(slippage: number): BigNumber {
+        return this.swapType === SwapType.ExactOutput
+            ? this.amount
+            : this.getExpectedAmountWithSlippage(slippage);
+    }
+}

package/src/{core → pathfinder}/tradeTypes.ts

@@ -1,9 +1,4 @@
-import {
-    ConvexPoolContract,
-    CurvePoolContract,
-    UniswapV2Contract,
-    YearnVaultContract
-} from "./contracts";
+import {ConvexPoolContract, CurvePoolContract, UniswapV2Contract, YearnVaultContract} from "../contracts/contracts";
 import {NormalToken} from "../tokens/normal";
 import {CurveLPToken} from "../tokens/curveLP";
 import {YearnLPToken} from "../tokens/yearn";
@@ -99,3 +94,8 @@ export type TradeAction =
     contract: ConvexPoolContract;
     tokenOut: CurveLPToken;
 };
+
+export enum SwapType {
+    ExactInput = 1,
+    ExactOutput = 2,
+}

package/src/pathfinder/yVault.ts

@@ -14,12 +14,11 @@ interface WithdrawBalance {
     balance: BigNumber;
 }
 
-export class YearnVaultPathFinder extends LPWithdrawPathFinder {
+export class YearnVaultPathFinder implements LPWithdrawPathFinder {
     _vault: YearnLPToken;
     token: NormalToken | CurveLPToken;
 
     constructor(vault: YearnLPToken) {
-        super();
         this._vault = vault;
 
         const currentTokenData = yearnTokens[vault];

package/src/tokens/convex.ts

@@ -1,6 +1,6 @@
-import {TradeAction, TradeType} from "../core/tradeTypes";
+import {TradeAction, TradeType} from "../pathfinder/tradeTypes";
 import {TokenBase} from "./token";
-import {ConvexPoolContract} from "../core/contracts";
+import {ConvexPoolContract} from "../contracts/contracts";
 import {CurveLPToken} from "./curveLP";
 import {TokenType} from "./tokenType";
 

package/src/tokens/curveLP.ts

@@ -1,4 +1,4 @@
-import {TradeAction, TradeType} from "../core/tradeTypes";
+import {TradeAction, TradeType} from "../pathfinder/tradeTypes";
 import {SupportedToken, TokenBase} from "./token";
 import {PartialRecord} from "../utils/types";
 import {BigNumber} from "ethers";

package/src/tokens/gear.ts

@@ -1,5 +1,5 @@
 import {TokenBase} from "./token";
-import {TradeAction} from "../core/tradeTypes";
+import {TradeAction} from "../pathfinder/tradeTypes";
 import {TokenType} from "./tokenType";
 
 export type DieselTokenTypes = "dDAI" | "dUSDC" | "dWBTC" | "dWETH";

package/src/tokens/normal.ts

@@ -1,4 +1,4 @@
-import {TradeAction, TradeType} from "../core/tradeTypes";
+import {TradeAction, TradeType} from "../pathfinder/tradeTypes";
 import {TokenBase} from "./token";
 import {TokenType} from "./tokenType";
 

package/src/tokens/token.ts

@@ -1,7 +1,12 @@
 import {keyToLowercase, objectEntries, swapKeyValue} from "../utils/mappers";
 import {NetworkType} from "../core/constants";
 import {NormalToken, NormalTokenData, normalTokens} from "./normal";
-import {CurveLPToken, CurveLPTokenData, curveTokens, MetaCurveLPTokenData} from "./curveLP";
+import {
+    CurveLPToken,
+    CurveLPTokenData,
+    curveTokens,
+    MetaCurveLPTokenData
+} from "./curveLP";
 import {
     YearnLPToken,
     yearnTokens,
@@ -16,8 +21,13 @@ import {
     ConvexStakedPhantomToken,
     convexTokens
 } from "./convex";
-import {DieselTokenData, DieselTokenTypes, GearboxToken, GearboxTokenData, gearTokens} from "./gear";
-
+import {
+    DieselTokenData,
+    DieselTokenTypes,
+    GearboxToken,
+    GearboxTokenData,
+    gearTokens
+} from "./gear";
 
 export type SupportedToken =
     | NormalToken
@@ -120,7 +130,7 @@ export const tokenDataByNetwork: Record<NetworkType,
 
         // YEARN- CURVE TOKENS
         yvCurve_stETH: "0xdCD90C7f6324cfa40d7169ef80b12031770B4325",
-        yvCURVE_FRAX_POOL: "0xB4AdA607B9d6b2c9Ee07A275e9616B84AC560139",
+        yvCurve_FRAX: "0xB4AdA607B9d6b2c9Ee07A275e9616B84AC560139",
 
         //GEARBOX
         dDAI: "0x6CFaF95457d7688022FC53e7AbE052ef8DFBbdBA",
@@ -177,7 +187,7 @@ export const tokenDataByNetwork: Record<NetworkType,
         "3Crv": "0x8eA3677599d5199c2c93c468fD2Fa6F102d3605b",
         steCRV: "0x6636910D55D34505c08d53932Da526FB18D3869C",
         FRAX3CRV: "0x76508F5398E50EFEC53d5Afd4B506990B43AdBFB",
-        LUSD3CRV: "0x04366d7ee3210B9eAd6f36696220d697b7885ED7",
+        LUSD3CRV: "0x2b72b528723DEe00e9BB02839f0794A66594922E",
         crvPlain3andSUSD: "0x540f5ea2A0601e27368661CB231AE04c23A14C24",
         gusd3CRV: "0x428A500D8209fef5a1b5a0A35C9412b71F03aAdA",
 
@@ -197,7 +207,7 @@ export const tokenDataByNetwork: Record<NetworkType,
 
         // YEARN- CURVE TOKENS
         yvCurve_stETH: "",
-        yvCURVE_FRAX_POOL: "",
+        yvCurve_FRAX: "",
 
         //GEARBOX
         dDAI: "0x6CFaF95457d7688022FC53e7AbE052ef8DFBbdBA",
@@ -209,6 +219,6 @@ export const tokenDataByNetwork: Record<NetworkType,
     }
 };
 
-export const tokenDataByAddress = objectEntries(tokenDataByNetwork).reduce<Record<string, SupportedToken>>((sum, [_, tokens]) => {
+export const tokenSymbolByAddress = objectEntries(tokenDataByNetwork).reduce<Record<string, SupportedToken>>((sum, [_, tokens]) => {
     return {...sum, ...keyToLowercase(swapKeyValue(tokens))};
 }, {});

package/src/tokens/yearn.ts

@@ -1,4 +1,4 @@
-import {TradeAction, TradeType} from "../core/tradeTypes";
+import {TradeAction, TradeType} from "../pathfinder/tradeTypes";
 import {TokenBase} from "./token";
 import {CurveLPToken} from "./curveLP";
 import {NormalToken} from "./normal";
@@ -10,7 +10,7 @@ export type YearnLPToken =
     | "yvWETH"
     | "yvWBTC"
     | "yvCurve_stETH"
-    | "yvCURVE_FRAX_POOL";
+    | "yvCurve_FRAX";
 
 export type YearnVaultTokenData = {
     symbol: YearnLPToken;
@@ -119,11 +119,11 @@ export const yearnTokens: Record<YearnLPToken,
         ]
     },
 
-    yvCURVE_FRAX_POOL: {
+    yvCurve_FRAX: {
         name: "yvCurve-FRAX",
         decimals: 18,
 
-        symbol: "yvCURVE_FRAX_POOL",
+        symbol: "yvCurve_FRAX",
         type: TokenType.YEARN_VAULT_OF_META_CURVE_LP,
         underlying: "FRAX3CRV",
         lpActions: [

package/src/core/creditCard.ts

@@ -1,15 +0,0 @@
-export interface CardCustomisation {
-  id: string;
-  name: string;
-  background: string;
-}
-
-export interface CardBackground {
-  id: string;
-  background: string
-}
-
-export interface CardCollection {
-  id: string;
-  backgrounds: Array<CardBackground>;
-}