@gearbox-protocol/sdk 0.0.101 → 0.0.104

package/src/tokens/curveLP.ts

@@ -1,177 +1,188 @@
-import {TradeAction, TradeType} from "../pathfinder/tradeTypes";
-import {SupportedToken, TokenBase} from "./token";
-import {PartialRecord} from "../utils/types";
-import {BigNumber} from "ethers";
-import {TokenType} from "./tokenType";
+import { BigNumber } from "ethers";
+import type { CurvePoolContract } from "src/contracts/contracts";
+import { TradeAction, TradeType } from "../pathfinder/tradeTypes";
+import type { SupportedToken, TokenBase } from "./token";
+import { PartialRecord } from "../utils/types";
+import { TokenType } from "./tokenType";
 
 export type CurveLPToken =
-    | "3Crv"
-    | "steCRV"
-    | "FRAX3CRV"
-    | "LUSD3CRV"
-    | "crvPlain3andSUSD"
-    | "gusd3CRV";
+  | "3Crv"
+  | "steCRV"
+  | "FRAX3CRV"
+  | "LUSD3CRV"
+  | "crvPlain3andSUSD"
+  | "gusd3CRV";
 
 export type CurveLPTokenData = {
-    symbol: CurveLPToken;
-    type: TokenType.CURVE_LP;
-    swapActions?: Array<TradeAction>;
-    lpActions: Array<TradeAction>;
+  symbol: CurveLPToken;
+  type: TokenType.CURVE_LP;
+  swapActions?: Array<TradeAction>;
+  lpActions: Array<TradeAction>;
+  pool: CurvePoolContract;
+  wrapper?: CurvePoolContract;
 } & TokenBase;
 
 export type MetaCurveLPTokenData = {
-    symbol: CurveLPToken;
-    type: TokenType.META_CURVE_LP;
-    lpActions: Array<TradeAction>;
+  symbol: CurveLPToken;
+  type: TokenType.META_CURVE_LP;
+  lpActions: Array<TradeAction>;
+  pool: CurvePoolContract;
+  wrapper?: CurvePoolContract;
 } & TokenBase;
 
-export const Curve3CrvUnderlyingTokenIndex: PartialRecord<SupportedToken,
-    BigNumber> = {
-    DAI: BigNumber.from(0),
-    USDC: BigNumber.from(1),
-    USDT: BigNumber.from(2)
+export const Curve3CrvUnderlyingTokenIndex: PartialRecord<
+  SupportedToken,
+  BigNumber
+> = {
+  DAI: BigNumber.from(0),
+  USDC: BigNumber.from(1),
+  USDT: BigNumber.from(2)
 };
 
-export const curveTokens: Record<CurveLPToken, CurveLPTokenData | MetaCurveLPTokenData> = {
-    // CURVE LP TOKENS
-    "3Crv": {
-        name: "3Crv",
-        decimals: 18,
-
-        symbol: "3Crv",
-        type: TokenType.CURVE_LP,
-        lpActions: [
-            {
-                type: TradeType.CurveWithdrawLP,
-                contract: "CURVE_3CRV_POOL",
-                tokenOut: ["DAI", "USDC", "USDT"]
-            },
-            {
-                type: TradeType.ConvexDepositLP,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "cvx3Crv"
-            },
-            {
-                type: TradeType.ConvexDepositLPAndStake,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "stkcvx3Crv"
-            }
-        ]
-    },
-
-    steCRV: {
-        name: "steCRV",
-        decimals: 18,
-
-        symbol: "steCRV",
-        type: TokenType.CURVE_LP,
-        lpActions: [
-            {
-                type: TradeType.CurveWithdrawLP,
-                contract: "CURVE_STETH_GATEWAY",
-                tokenOut: ["STETH", "WETH"]
-            },
-            {
-                type: TradeType.ConvexDepositLP,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "cvxsteCRV"
-            },
-            {
-                type: TradeType.ConvexDepositLPAndStake,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "stkcvxsteCRV"
-            }
-        ]
-    },
-
-    crvPlain3andSUSD: {
-        name: "crvPlain3andSUSD",
-        decimals: 18,
-
-        symbol: "crvPlain3andSUSD",
-        type: TokenType.CURVE_LP,
-        lpActions: [
-            {
-                type: TradeType.CurveWithdrawLP,
-                contract: "CURVE_SUSD_POOL",
-                tokenOut: ["DAI", "USDC", "USDT", "sUSD"]
-            },
-            {
-                type: TradeType.ConvexDepositLP,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "cvxcrvPlain3andSUSD"
-            },
-            {
-                type: TradeType.ConvexDepositLPAndStake,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "stkcvxcrvPlain3andSUSD"
-            }
-        ]
-    },
-
-    //  META CURVE LP TOKENS
-    FRAX3CRV: {
-        name: "FRAX3CRV-f",
-        decimals: 18,
-
-        symbol: "FRAX3CRV",
-        type: TokenType.META_CURVE_LP,
-        lpActions: [
-            {
-                type: TradeType.CurveWithdrawLP,
-                contract: "CURVE_FRAX_POOL",
-                tokenOut: ["FRAX", "3Crv"]
-            },
-            {
-                type: TradeType.ConvexDepositLP,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "cvxFRAX3CRV"
-            },
-            {
-                type: TradeType.ConvexDepositLPAndStake,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "stkcvxFRAX3CRV"
-            }
-        ]
-    },
-
-    LUSD3CRV: {
-        name: "LUSD3CRV-f",
-        decimals: 18,
-
-        symbol: "LUSD3CRV",
-        type: TokenType.META_CURVE_LP,
-        lpActions: [
-            {
-                type: TradeType.CurveWithdrawLP,
-                contract: "CURVE_LUSD_POOL",
-                tokenOut: ["LUSD", "3Crv"]
-            }
-        ]
-    },
-
-    gusd3CRV: {
-        name: "gusd3CRV",
-        decimals: 18,
-
-        symbol: "gusd3CRV",
-        type: TokenType.META_CURVE_LP,
-        lpActions: [
-            {
-                type: TradeType.CurveWithdrawLP,
-                contract: "CURVE_GUSD_POOL",
-                tokenOut: ["GUSD", "3Crv"]
-            },
-            {
-                type: TradeType.ConvexDepositLP,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "cvxgusd3CRV"
-            },
-            {
-                type: TradeType.ConvexDepositLPAndStake,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "stkcvxgusd3CRV"
-            }
-        ]
-    }
+export const curveTokens: Record<
+  CurveLPToken,
+  CurveLPTokenData | MetaCurveLPTokenData
+> = {
+  // CURVE LP TOKENS
+  "3Crv": {
+    name: "3Crv",
+    decimals: 18,
+    symbol: "3Crv",
+    type: TokenType.CURVE_LP,
+    pool: "CURVE_3CRV_POOL",
+    lpActions: [
+      {
+        type: TradeType.CurveWithdrawLP,
+        contract: "CURVE_3CRV_POOL",
+        tokenOut: ["DAI", "USDC", "USDT"]
+      },
+      {
+        type: TradeType.ConvexDepositLP,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "cvx3Crv"
+      },
+      {
+        type: TradeType.ConvexDepositLPAndStake,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "stkcvx3Crv"
+      }
+    ]
+  },
+
+  steCRV: {
+    name: "steCRV",
+    decimals: 18,
+    symbol: "steCRV",
+    type: TokenType.CURVE_LP,
+    pool: "CURVE_STETH_GATEWAY",
+    lpActions: [
+      {
+        type: TradeType.CurveWithdrawLP,
+        contract: "CURVE_STETH_GATEWAY",
+        tokenOut: ["STETH", "WETH"]
+      },
+      {
+        type: TradeType.ConvexDepositLP,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "cvxsteCRV"
+      },
+      {
+        type: TradeType.ConvexDepositLPAndStake,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "stkcvxsteCRV"
+      }
+    ]
+  },
+
+  crvPlain3andSUSD: {
+    name: "crvPlain3andSUSD",
+    decimals: 18,
+    symbol: "crvPlain3andSUSD",
+    type: TokenType.CURVE_LP,
+    pool: "CURVE_SUSD_POOL",
+    wrapper: "CURVE_SUSD_DEPOSIT",
+    lpActions: [
+      {
+        type: TradeType.CurveWithdrawLP,
+        contract: "CURVE_SUSD_POOL",
+        tokenOut: ["DAI", "USDC", "USDT", "sUSD"]
+      },
+      {
+        type: TradeType.ConvexDepositLP,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "cvxcrvPlain3andSUSD"
+      },
+      {
+        type: TradeType.ConvexDepositLPAndStake,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "stkcvxcrvPlain3andSUSD"
+      }
+    ]
+  },
+
+  //  META CURVE LP TOKENS
+  FRAX3CRV: {
+    name: "FRAX3CRV-f",
+    decimals: 18,
+    symbol: "FRAX3CRV",
+    type: TokenType.META_CURVE_LP,
+    pool: "CURVE_FRAX_POOL",
+    lpActions: [
+      {
+        type: TradeType.CurveWithdrawLP,
+        contract: "CURVE_FRAX_POOL",
+        tokenOut: ["FRAX", "3Crv"]
+      },
+      {
+        type: TradeType.ConvexDepositLP,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "cvxFRAX3CRV"
+      },
+      {
+        type: TradeType.ConvexDepositLPAndStake,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "stkcvxFRAX3CRV"
+      }
+    ]
+  },
+
+  LUSD3CRV: {
+    name: "LUSD3CRV-f",
+    decimals: 18,
+    symbol: "LUSD3CRV",
+    type: TokenType.META_CURVE_LP,
+    pool: "CURVE_LUSD_POOL",
+    lpActions: [
+      {
+        type: TradeType.CurveWithdrawLP,
+        contract: "CURVE_LUSD_POOL",
+        tokenOut: ["LUSD", "3Crv"]
+      }
+    ]
+  },
+
+  gusd3CRV: {
+    name: "gusd3CRV",
+    decimals: 18,
+    symbol: "gusd3CRV",
+    type: TokenType.META_CURVE_LP,
+    pool: "CURVE_GUSD_POOL",
+    lpActions: [
+      {
+        type: TradeType.CurveWithdrawLP,
+        contract: "CURVE_GUSD_POOL",
+        tokenOut: ["GUSD", "3Crv"]
+      },
+      {
+        type: TradeType.ConvexDepositLP,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "cvxgusd3CRV"
+      },
+      {
+        type: TradeType.ConvexDepositLPAndStake,
+        contract: "CONVEX_BOOSTER",
+        tokenOut: "stkcvxgusd3CRV"
+      }
+    ]
+  }
 };

package/src/tokens/gear.ts

@@ -1,56 +1,58 @@
-import {TokenBase} from "./token";
-import {TradeAction} from "../pathfinder/tradeTypes";
-import {TokenType} from "./tokenType";
+import type { TokenBase } from "./token";
+import type { TradeAction } from "../pathfinder/tradeTypes";
+import { TokenType } from "./tokenType";
 
 export type DieselTokenTypes = "dDAI" | "dUSDC" | "dWBTC" | "dWETH";
 export type GearboxToken = "GEAR";
 
 export type DieselTokenData = {
-    symbol: DieselTokenTypes;
-    type: TokenType.DIESEL_LP_TOKEN;
+  symbol: DieselTokenTypes;
+  type: TokenType.DIESEL_LP_TOKEN;
 } & TokenBase;
 
 export type GearboxTokenData = {
-    symbol: GearboxToken;
-    swapActions?: Array<TradeAction>;
-    type: TokenType.NORMAL_TOKEN;
+  symbol: GearboxToken;
+  swapActions?: Array<TradeAction>;
+  type: TokenType.NORMAL_TOKEN;
 } & TokenBase;
 
-export const gearTokens: Record<DieselTokenTypes | GearboxToken,
-    DieselTokenData | GearboxTokenData> = {
-    //GEARBOX
-    dDAI: {
-        name: "dDAI",
-        decimals: 18,
-        symbol: "dDAI",
-        type: TokenType.DIESEL_LP_TOKEN
-    },
-
-    dUSDC: {
-        name: "dUSDC",
-        decimals: 6,
-        symbol: "dUSDC",
-        type: TokenType.DIESEL_LP_TOKEN
-    },
-
-    dWBTC: {
-        name: "dWBTC",
-        decimals: 8,
-        symbol: "dWBTC",
-        type: TokenType.DIESEL_LP_TOKEN
-    },
-
-    dWETH: {
-        name: "dWETH",
-        decimals: 18,
-        symbol: "dWETH",
-        type: TokenType.DIESEL_LP_TOKEN
-    },
-
-    GEAR: {
-        name: "GEAR",
-        decimals: 18,
-        symbol: "GEAR",
-        type: TokenType.NORMAL_TOKEN
-    }
+export const gearTokens: Record<
+  DieselTokenTypes | GearboxToken,
+  DieselTokenData | GearboxTokenData
+> = {
+  // GEARBOX
+  dDAI: {
+    name: "dDAI",
+    decimals: 18,
+    symbol: "dDAI",
+    type: TokenType.DIESEL_LP_TOKEN
+  },
+
+  dUSDC: {
+    name: "dUSDC",
+    decimals: 6,
+    symbol: "dUSDC",
+    type: TokenType.DIESEL_LP_TOKEN
+  },
+
+  dWBTC: {
+    name: "dWBTC",
+    decimals: 8,
+    symbol: "dWBTC",
+    type: TokenType.DIESEL_LP_TOKEN
+  },
+
+  dWETH: {
+    name: "dWETH",
+    decimals: 18,
+    symbol: "dWETH",
+    type: TokenType.DIESEL_LP_TOKEN
+  },
+
+  GEAR: {
+    name: "GEAR",
+    decimals: 18,
+    symbol: "GEAR",
+    type: TokenType.NORMAL_TOKEN
+  }
 };