@gearbox-protocol/sdk 0.0.1

package/src/core/history.ts

@@ -0,0 +1,55 @@
+import { BigNumber } from "ethers";
+
+export type BasicEvent = {
+    protocol: string; // address of creditManager. Address of target account for EXECUTE event
+    txHash: string;
+    timestamp: number; // timestamp in Unix format
+};
+
+export type BasicSwapEvent = BasicEvent & {
+    from: string; //address
+    fromAmount: BigNumber;
+    to: string; // address
+    toAmount: BigNumber;
+};
+
+export type HistoryEvent =
+    | (BasicEvent & {
+    action: "OpenCreditAccount";
+    initialFunds: BigNumber;
+    leverage: number; // x100, so 420 => 4.2
+})
+    | (BasicEvent & {
+    action: "CloseCreditAccount";
+    remainingFunds: BigNumber;
+})
+    | (BasicEvent & {
+    action: "LiquidateCreditAccount";
+    remainingFunds: BigNumber;
+})
+    | (BasicEvent & {
+    action: "IncreaseBorrowedAmount";
+    amount: BigNumber;
+})
+    | (BasicEvent & {
+    action: "AddCollateral";
+    token: string; // token address
+    amount: BigNumber;
+})
+    | (BasicEvent & {
+    action: "RepayCreditAccount";
+    repayAmount: BigNumber;
+})
+    | (BasicEvent & {
+    action: "TransferAccount";
+    newAccount: string; // Address
+})
+    | (BasicSwapEvent & {
+    action: "Swap";
+})
+    | (BasicSwapEvent & {
+    action: "Deposit";
+})
+    | (BasicSwapEvent & {
+    action: "Withdraw";
+});

package/src/core/operations.ts

@@ -0,0 +1,35 @@
+import moment from "moment";
+
+export class OperationData {
+  public readonly id: number;
+  public readonly address: string;
+  public readonly txHash: string;
+  public readonly blockNum: number;
+  public readonly operation: string;
+  public readonly timestamp: number;
+  public readonly date: string;
+
+  constructor(payload: OperationDataPayload) {
+    this.id = payload.id;
+    this.address = payload.address;
+    this.txHash = payload.txHash;
+    this.blockNum = payload.blockNum;
+    this.operation = payload.operation;
+    this.timestamp = payload.timestamp;
+    this.date = moment(payload.timestamp * 1000).format("Do MMM YYYY");
+  }
+}
+
+export interface OperationDataPayload {
+  id: number;
+  address: string;
+  txHash: string;
+  blockNum: number;
+  operation: string;
+  timestamp: number;
+}
+
+export interface OperationsList {
+  id: string;
+  data: Array<OperationData>;
+}

package/src/core/oracles.ts

@@ -0,0 +1,7 @@
+import { BigNumberish } from "ethers";
+
+export interface YearnPriceFeedConfig {
+  yVault: string;
+  lowerBound: BigNumberish;
+  upperBound: BigNumberish;
+}

package/src/core/pool.ts

@@ -0,0 +1,60 @@
+import { BigNumber, Signer } from "ethers";
+import { IAppPoolService, IPoolService__factory } from "../types";
+import { PoolDataPayload } from "../payload/pool";
+import { rayToNumber } from "../utils/formatter";
+
+export class PoolData {
+  public readonly id: string;
+  public readonly address: string;
+
+  public readonly underlyingToken: string;
+  public readonly dieselToken: string;
+  public readonly isWETH: boolean;
+
+  // Information
+  public readonly expectedLiquidity: BigNumber;
+  public readonly expectedLiquidityLimit: BigNumber;
+  public readonly availableLiquidity: BigNumber;
+  public readonly totalBorrowed: BigNumber;
+  public readonly depositAPY: number;
+  public readonly borrowAPY: number;
+  public readonly borrowAPYRay: BigNumber;
+  public readonly dieselRate: number;
+  public readonly dieselRateRay: BigNumber;
+  public readonly withdrawFee: number;
+  public readonly timestampLU: BigNumber;
+  public readonly cumulativeIndex_RAY: BigNumber;
+
+  constructor(payload: PoolDataPayload) {
+    this.id = payload.addr;
+    this.address = payload.addr;
+    this.underlyingToken = payload.underlyingToken || "";
+    this.dieselToken = payload.dieselToken || "";
+
+    this.isWETH = payload.isWETH || false;
+
+    this.expectedLiquidity = BigNumber.from(payload.expectedLiquidity);
+    this.expectedLiquidityLimit = BigNumber.from(
+      payload.expectedLiquidityLimit || 0
+    );
+    this.availableLiquidity = BigNumber.from(payload.availableLiquidity);
+    this.totalBorrowed = BigNumber.from(payload.totalBorrowed);
+    this.depositAPY = rayToNumber(payload.depositAPY_RAY) * 100;
+    this.borrowAPY = rayToNumber(payload.borrowAPY_RAY) * 100;
+    this.borrowAPYRay = BigNumber.from(payload.borrowAPY_RAY);
+    this.dieselRate = rayToNumber(payload.dieselRate_RAY);
+    this.dieselRateRay = BigNumber.from(payload.dieselRate_RAY);
+    this.withdrawFee = BigNumber.from(payload.withdrawFee).toNumber() / 100;
+    this.timestampLU = BigNumber.from(payload.timestampLU || 0);
+    this.cumulativeIndex_RAY = BigNumber.from(payload.cumulativeIndex_RAY || 0);
+  }
+
+  getContractETH(signer: Signer): IAppPoolService {
+    return IPoolService__factory.connect(this.address, signer);
+  }
+}
+
+export interface PoolsStat {
+  tvl: number;
+  totalBorrowed: number;
+}

package/src/core/swap.ts

@@ -0,0 +1,4 @@
+export enum SwapType {
+  ExactInput = 1,
+  ExactOutput = 2,
+}

package/src/core/token.ts

@@ -0,0 +1,275 @@
+import { NetworkType } from "./constants";
+import { TokenSavedData } from "./tokenData";
+
+export const tokenDataByNetwork: Record<
+  NetworkType,
+  Record<string, TokenSavedData>
+> = {
+  //
+  // MAINNET NETWORK
+  // 1INCH  ETH  AAVE  BADGER  BAL  BTC  COMP  CREAM  CRV
+  // DAI  DPI  GRT  LINK  SNX  SRM  SUSHI  UNI USDC
+  // USDT  YFI  ZRX
+  Mainnet: {
+    "1INCH": {
+      address: "0x111111111117dc0aa78b770fa6a738034120c302",
+      type: "volatile"
+    },
+
+    AAVE: {
+      address: "0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9",
+      type: "volatile"
+    },
+
+    COMP: {
+      address: "0xc00e94cb662c3520282e6f5717214004a7f26888",
+      type: "volatile"
+    },
+
+    CRV: {
+      address: "0xD533a949740bb3306d119CC777fa900bA034cd52",
+      type: "volatile"
+    },
+
+    DAI: {
+      address: "0x6B175474E89094C44Da98b954EedeAC495271d0F",
+      type: "stable"
+    },
+
+    DPI: {
+      address: "0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b",
+      type: "volatile"
+    },
+
+    FEI: {
+      address: "0x956F47F50A910163D8BF957Cf5846D573E7f87CA",
+      type: "stable"
+    },
+
+    LINK: {
+      address: "0x514910771AF9Ca656af840dff83E8264EcF986CA",
+      type: "volatile"
+    },
+
+    SNX: {
+      address: "0xc011a73ee8576fb46f5e1c5751ca3b9fe0af2a6f",
+      type: "volatile"
+    },
+
+    SUSHI: {
+      address: "0x6b3595068778dd592e39a122f4f5a5cf09c90fe2",
+      type: "volatile"
+    },
+
+    UNI: {
+      address: "0x1f9840a85d5af5bf1d1762f925bdaddc4201f984",
+      type: "volatile"
+    },
+
+    USDC: {
+      address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+      type: "stable"
+    },
+
+    USDT: {
+      address: "0xdac17f958d2ee523a2206206994597c13d831ec7",
+      type: "stable"
+    },
+
+    WBTC: {
+      address: "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599",
+      type: "core"
+    },
+
+    WETH: {
+      address: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+      type: "core"
+    },
+
+    YFI: {
+      address: "0x0bc529c00c6401aef6d220be8c6ea1667f6ad93e",
+      type: "volatile"
+    },
+
+    /// UPDATE
+    STETH: {
+      address: "0xae7ab96520de3a18e5e111b5eaab095312d7fe84",
+      type: "volatile"
+    },
+
+    FTM: {
+      address: "0x4E15361FD6b4BB609Fa63C81A2be19d873717870",
+      type: "volatile"
+    },
+
+    CVX: {
+      address: "0x4e3fbd56cd56c3e72c1403e103b45db9da5b9d2b",
+      type: "volatile"
+    },
+
+    FRAX: {
+      address: "0x853d955acef822db058eb8505911ed77f175b99e",
+      type: "stable"
+    },
+
+    FXS: {
+      address: "0x3432B6A60D23Ca0dFCa7761B7ab56459D9C964D0",
+      type: "volatile"
+    },
+
+    LDO: {
+      address: "0x5A98FcBEA516Cf06857215779Fd812CA3beF1B32",
+      type: "volatile"
+    },
+
+    SPELL: {
+      address: "0x090185f2135308BaD17527004364eBcC2D37e5F6",
+      type: "volatile"
+    },
+
+    LUSD: {
+      address: "0x5f98805A4E8be255a32880FDeC7F6728C6568bA0",
+      type: "stable"
+    },
+
+    SUSD: {
+      address: "0x57Ab1ec28D129707052df4dF418D58a2D46d5f51",
+      type: "stable"
+    },
+
+    GUSD: {
+      address: "0x056fd409e1d7a124bd7017459dfea2f387b6d5cd",
+      type: "stable"
+    },
+
+    // YEARN TOKENS
+    yvDAI: {
+      address: "0xdA816459F1AB5631232FE5e97a05BBBb94970c95",
+      type: "lp"
+    },
+    yvUSDC: {
+      address: "0xa354f35829ae975e850e23e9615b11da1b3dc4de",
+      type: "lp"
+    },
+    yvWETH: {
+      address: "0xa258C4606Ca8206D8aA700cE2143D7db854D168c",
+      type: "lp"
+    },
+    yvWBTC: {
+      address: "0xA696a63cc78DfFa1a63E9E50587C197387FF6C7E",
+      type: "lp"
+    },
+
+    // CURVE LP TOKENS
+
+    "3Crv": {
+      address: "0x6c3F90f043a72FA612cbac8115EE7e52BDe6E490",
+      type: "lp"
+    },
+
+    steCRV: {
+      address: "0x06325440d014e39736583c165c2963ba99faf14e",
+      type: "lp"
+    },
+    FRAX3CRV: {
+      address: "0xd632f22692fac7611d2aa1c0d552930d43caed3b",
+      type: "lp"
+    },
+    LUSD3CRV: {
+      address: "0xEd279fDD11cA84bEef15AF5D39BB4d4bEE23F0cA",
+      type: "lp"
+    },
+
+    crvPlain3andSUSD: {
+      address: "0xC25a3A3b969415c80451098fa907EC722572917F",
+      type: "lp"
+    },
+
+    gusd3CRV: {
+      address: "0xD2967f45c4f384DEEa880F807Be904762a3DeA07",
+      type: "lp"
+    },
+
+    // CONVEX LP TOKENS
+
+    cvx3Crv: {
+      address: "0x30D9410ED1D5DA1F6C8391af5338C93ab8d4035C",
+      type: "lp"
+    },
+
+    cvxsteCRV: {
+      address: "0x9518c9063eB0262D791f38d8d6Eb0aca33c63ed0",
+      type: "lp"
+    },
+
+    cvxFRAX3CRV: {
+      address: "0xbE0F6478E0E4894CFb14f32855603A083A57c7dA",
+      type: "lp"
+    },
+
+    cvxcrvPlain3andSUSD: {
+      address: "0x11D200ef1409cecA8D6d23e6496550f707772F11",
+      type: "lp"
+    },
+
+    cvxgusd3CRV: {
+      address: "0x15c2471ef46Fa721990730cfa526BcFb45574576",
+      type: "lp"
+    },
+
+    // YEARN- CURVE TOKENS
+    yvCurve_stETH: {
+      address: "0xdCD90C7f6324cfa40d7169ef80b12031770B4325",
+      type: "lp"
+    },
+    yvCurve_FRAX: {
+      address: "0xB4AdA607B9d6b2c9Ee07A275e9616B84AC560139",
+      type: "lp"
+    },
+
+    yvCurve_d3pool: {
+      address: "0x16825039dfe2a5b01F3E1E6a2BBF9a576c6F95c4",
+      type: "lp"
+    }
+  },
+
+  //
+  // KOVAN NETWORK
+  // DAI  LINK  REP  SNX  USDC  WBTC  ZRX
+  //
+  Kovan: {
+    DAI: {
+      address: "0x9DC7B33C3B63fc00ed5472fBD7813eDDa6a64752",
+      type: "stable"
+    },
+
+    LINK: {
+      address: "0x6C994935826574E870549F09efF43BA8089A3D25",
+      type: "volatile"
+    },
+    // REP: {
+    //   address: "0x633317172c0D41451F62025D73CE59065A370a50",
+    //   priceFeedETH: "0x3A7e6117F2979EFf81855de32819FBba48a63e9e",
+    //   type: "volatile",
+    // },
+    SNX: {
+      address: "0xB48891df9267EF65AABd32F497F6F2d1eB22A186",
+      type: "volatile"
+    },
+
+    USDC: {
+      address: "0x31EeB2d0F9B6fD8642914aB10F4dD473677D80df",
+      type: "stable"
+    },
+    WBTC: {
+      address: "0xE36bC5d8b689AD6d80e78c3e736670e80d4b329D",
+      type: "core"
+    }
+
+    // ZRX: {
+    //   address: "0xB730c1449c58f29C69df33ccD5bd9d3cA66b23C1",
+    //   priceFeedETH: "0xBc3f28Ccc21E9b5856E81E6372aFf57307E2E883",
+    //   type: "volatile",
+    // },
+  }
+};

package/src/core/tokenData.ts

@@ -0,0 +1,84 @@
+import { BigNumber } from "ethers";
+import { TokenDataPayload } from "../payload/token";
+import { STATIC_TOKEN } from "../config";
+import { NetworkType } from "./constants";
+import { tokenDataByNetwork } from "./token";
+
+export class TokenData {
+  public readonly id: string;
+  // public readonly name: string;
+  public readonly symbol: string;
+  public readonly address: string;
+  public readonly decimals: number;
+  public readonly icon?: string;
+
+  constructor(payload: TokenDataPayload) {
+    this.id = payload.addr;
+    this.address = payload.addr;
+    // this.name = payload.name;
+    this.symbol = payload.symbol;
+    if (this.symbol === "WETH" || this.symbol === "dWETH") {
+      this.symbol = this.symbol.replace("WETH", "ETH");
+    }
+    this.decimals = payload.decimals;
+    this.icon = `${STATIC_TOKEN}${payload.symbol?.toLowerCase()}.svg`;
+  }
+
+  compareBySymbol(b: TokenData): number {
+    return this.symbol > b.symbol ? 1 : -1;
+  }
+}
+
+export interface TokenBalance {
+  id: string;
+  balance: BigNumber;
+}
+
+export interface TokenAllowance {
+  id: string;
+  allowance: BigNumber;
+}
+
+export type TokenType = "core" | "stable" | "volatile" | "lp";
+
+export interface TokenSavedData {
+  address: string;
+  type: TokenType;
+}
+
+export const WETHToken: Record<NetworkType, string> = {
+  Mainnet: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+  Kovan: "0xd0a1e359811322d97991e03f863a0c30c2cf029c",
+};
+
+export const connectors: Record<NetworkType, Array<string>> = {
+  Mainnet: [
+    "WETH",
+    "1INCH",
+    "DAI",
+    "USDC",
+    // "USDT",
+    "WBTC",
+    // "stETH",
+    // "PAX",
+    // "TUSD",
+    // "BNT",
+    // "BAL",
+    // "sUSD",
+  ],
+  Kovan: ["WETH", "DAI", "USDC", "WBTC"],
+};
+
+export function getConnectors(networkType: NetworkType) {
+  return connectors[networkType].map((e) => {
+    const result =
+      e === "WETH"
+        ? WETHToken[networkType]
+        : tokenDataByNetwork[networkType][e]?.address;
+
+    if (!result) {
+      throw new Error(`connector token ${e} not found`);
+    }
+    return result;
+  });
+}

package/src/core/tokenDistributor.ts

@@ -0,0 +1,14 @@
+import {BigNumber} from "ethers";
+
+export interface TokenShare {
+  holder: string;
+  amount: BigNumber;
+  share: number;
+  isCompany: boolean;
+}
+
+export enum VotingPower {
+  A, // A-type voting power & A-type vesting parameters
+  B, // B-type voting power & B-type vesting parameters
+  ZERO_VOTING_POWER, // zero voting power & B-type vesting parameters
+}

package/src/core/trade.ts

@@ -0,0 +1,83 @@
+import { BigNumber } from "ethers";
+import { SwapType } from "./swap";
+import { BytesLike } from "@ethersproject/bytes";
+import { PERCENTAGE_FACTOR, WAD } from "./constants";
+
+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);
+  }
+}