@gearbox-protocol/sdk 0.0.1

package/lib/core/history.d.ts

@@ -0,0 +1,42 @@
+import { BigNumber } from "ethers";
+export declare type BasicEvent = {
+    protocol: string;
+    txHash: string;
+    timestamp: number;
+};
+export declare type BasicSwapEvent = BasicEvent & {
+    from: string;
+    fromAmount: BigNumber;
+    to: string;
+    toAmount: BigNumber;
+};
+export declare type HistoryEvent = (BasicEvent & {
+    action: "OpenCreditAccount";
+    initialFunds: BigNumber;
+    leverage: number;
+}) | (BasicEvent & {
+    action: "CloseCreditAccount";
+    remainingFunds: BigNumber;
+}) | (BasicEvent & {
+    action: "LiquidateCreditAccount";
+    remainingFunds: BigNumber;
+}) | (BasicEvent & {
+    action: "IncreaseBorrowedAmount";
+    amount: BigNumber;
+}) | (BasicEvent & {
+    action: "AddCollateral";
+    token: string;
+    amount: BigNumber;
+}) | (BasicEvent & {
+    action: "RepayCreditAccount";
+    repayAmount: BigNumber;
+}) | (BasicEvent & {
+    action: "TransferAccount";
+    newAccount: string;
+}) | (BasicSwapEvent & {
+    action: "Swap";
+}) | (BasicSwapEvent & {
+    action: "Deposit";
+}) | (BasicSwapEvent & {
+    action: "Withdraw";
+});

package/lib/core/history.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/core/operations.d.ts

@@ -0,0 +1,22 @@
+export declare class OperationData {
+    readonly id: number;
+    readonly address: string;
+    readonly txHash: string;
+    readonly blockNum: number;
+    readonly operation: string;
+    readonly timestamp: number;
+    readonly date: string;
+    constructor(payload: OperationDataPayload);
+}
+export interface OperationDataPayload {
+    id: number;
+    address: string;
+    txHash: string;
+    blockNum: number;
+    operation: string;
+    timestamp: number;
+}
+export interface OperationsList {
+    id: string;
+    data: Array<OperationData>;
+}

package/lib/core/operations.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationData = void 0;
+var moment_1 = __importDefault(require("moment"));
+var OperationData = /** @class */ (function () {
+    function OperationData(payload) {
+        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 = (0, moment_1.default)(payload.timestamp * 1000).format("Do MMM YYYY");
+    }
+    return OperationData;
+}());
+exports.OperationData = OperationData;

package/lib/core/oracles.d.ts

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

package/lib/core/oracles.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/core/pool.d.ts

@@ -0,0 +1,28 @@
+import { BigNumber, Signer } from "ethers";
+import { IAppPoolService } from "../types";
+import { PoolDataPayload } from "../payload/pool";
+export declare class PoolData {
+    readonly id: string;
+    readonly address: string;
+    readonly underlyingToken: string;
+    readonly dieselToken: string;
+    readonly isWETH: boolean;
+    readonly expectedLiquidity: BigNumber;
+    readonly expectedLiquidityLimit: BigNumber;
+    readonly availableLiquidity: BigNumber;
+    readonly totalBorrowed: BigNumber;
+    readonly depositAPY: number;
+    readonly borrowAPY: number;
+    readonly borrowAPYRay: BigNumber;
+    readonly dieselRate: number;
+    readonly dieselRateRay: BigNumber;
+    readonly withdrawFee: number;
+    readonly timestampLU: BigNumber;
+    readonly cumulativeIndex_RAY: BigNumber;
+    constructor(payload: PoolDataPayload);
+    getContractETH(signer: Signer): IAppPoolService;
+}
+export interface PoolsStat {
+    tvl: number;
+    totalBorrowed: number;
+}

package/lib/core/pool.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PoolData = void 0;
+var ethers_1 = require("ethers");
+var types_1 = require("../types");
+var formatter_1 = require("../utils/formatter");
+var PoolData = /** @class */ (function () {
+    function PoolData(payload) {
+        this.id = payload.addr;
+        this.address = payload.addr;
+        this.underlyingToken = payload.underlyingToken || "";
+        this.dieselToken = payload.dieselToken || "";
+        this.isWETH = payload.isWETH || false;
+        this.expectedLiquidity = ethers_1.BigNumber.from(payload.expectedLiquidity);
+        this.expectedLiquidityLimit = ethers_1.BigNumber.from(payload.expectedLiquidityLimit || 0);
+        this.availableLiquidity = ethers_1.BigNumber.from(payload.availableLiquidity);
+        this.totalBorrowed = ethers_1.BigNumber.from(payload.totalBorrowed);
+        this.depositAPY = (0, formatter_1.rayToNumber)(payload.depositAPY_RAY) * 100;
+        this.borrowAPY = (0, formatter_1.rayToNumber)(payload.borrowAPY_RAY) * 100;
+        this.borrowAPYRay = ethers_1.BigNumber.from(payload.borrowAPY_RAY);
+        this.dieselRate = (0, formatter_1.rayToNumber)(payload.dieselRate_RAY);
+        this.dieselRateRay = ethers_1.BigNumber.from(payload.dieselRate_RAY);
+        this.withdrawFee = ethers_1.BigNumber.from(payload.withdrawFee).toNumber() / 100;
+        this.timestampLU = ethers_1.BigNumber.from(payload.timestampLU || 0);
+        this.cumulativeIndex_RAY = ethers_1.BigNumber.from(payload.cumulativeIndex_RAY || 0);
+    }
+    PoolData.prototype.getContractETH = function (signer) {
+        return types_1.IPoolService__factory.connect(this.address, signer);
+    };
+    return PoolData;
+}());
+exports.PoolData = PoolData;

package/lib/core/swap.d.ts

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

package/lib/core/swap.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwapType = void 0;
+var SwapType;
+(function (SwapType) {
+    SwapType[SwapType["ExactInput"] = 1] = "ExactInput";
+    SwapType[SwapType["ExactOutput"] = 2] = "ExactOutput";
+})(SwapType = exports.SwapType || (exports.SwapType = {}));

package/lib/core/token.d.ts

@@ -0,0 +1,3 @@
+import { NetworkType } from "./constants";
+import { TokenSavedData } from "./tokenData";
+export declare const tokenDataByNetwork: Record<NetworkType, Record<string, TokenSavedData>>;

package/lib/core/token.js

@@ -0,0 +1,229 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tokenDataByNetwork = void 0;
+exports.tokenDataByNetwork = {
+    //
+    // 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/lib/core/tokenData.d.ts

@@ -0,0 +1,28 @@
+import { BigNumber } from "ethers";
+import { TokenDataPayload } from "../payload/token";
+import { NetworkType } from "./constants";
+export declare class TokenData {
+    readonly id: string;
+    readonly symbol: string;
+    readonly address: string;
+    readonly decimals: number;
+    readonly icon?: string;
+    constructor(payload: TokenDataPayload);
+    compareBySymbol(b: TokenData): number;
+}
+export interface TokenBalance {
+    id: string;
+    balance: BigNumber;
+}
+export interface TokenAllowance {
+    id: string;
+    allowance: BigNumber;
+}
+export declare type TokenType = "core" | "stable" | "volatile" | "lp";
+export interface TokenSavedData {
+    address: string;
+    type: TokenType;
+}
+export declare const WETHToken: Record<NetworkType, string>;
+export declare const connectors: Record<NetworkType, Array<string>>;
+export declare function getConnectors(networkType: NetworkType): string[];

package/lib/core/tokenData.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConnectors = exports.connectors = exports.WETHToken = exports.TokenData = void 0;
+var config_1 = require("../config");
+var token_1 = require("./token");
+var TokenData = /** @class */ (function () {
+    function TokenData(payload) {
+        var _a;
+        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 = "".concat(config_1.STATIC_TOKEN).concat((_a = payload.symbol) === null || _a === void 0 ? void 0 : _a.toLowerCase(), ".svg");
+    }
+    TokenData.prototype.compareBySymbol = function (b) {
+        return this.symbol > b.symbol ? 1 : -1;
+    };
+    return TokenData;
+}());
+exports.TokenData = TokenData;
+exports.WETHToken = {
+    Mainnet: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+    Kovan: "0xd0a1e359811322d97991e03f863a0c30c2cf029c",
+};
+exports.connectors = {
+    Mainnet: [
+        "WETH",
+        "1INCH",
+        "DAI",
+        "USDC",
+        // "USDT",
+        "WBTC",
+        // "stETH",
+        // "PAX",
+        // "TUSD",
+        // "BNT",
+        // "BAL",
+        // "sUSD",
+    ],
+    Kovan: ["WETH", "DAI", "USDC", "WBTC"],
+};
+function getConnectors(networkType) {
+    return exports.connectors[networkType].map(function (e) {
+        var _a;
+        var result = e === "WETH"
+            ? exports.WETHToken[networkType]
+            : (_a = token_1.tokenDataByNetwork[networkType][e]) === null || _a === void 0 ? void 0 : _a.address;
+        if (!result) {
+            throw new Error("connector token ".concat(e, " not found"));
+        }
+        return result;
+    });
+}
+exports.getConnectors = getConnectors;

package/lib/core/tokenDistributor.d.ts

@@ -0,0 +1,12 @@
+import { BigNumber } from "ethers";
+export interface TokenShare {
+    holder: string;
+    amount: BigNumber;
+    share: number;
+    isCompany: boolean;
+}
+export declare enum VotingPower {
+    A = 0,
+    B = 1,
+    ZERO_VOTING_POWER = 2
+}

package/lib/core/tokenDistributor.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VotingPower = void 0;
+var VotingPower;
+(function (VotingPower) {
+    VotingPower[VotingPower["A"] = 0] = "A";
+    VotingPower[VotingPower["B"] = 1] = "B";
+    VotingPower[VotingPower["ZERO_VOTING_POWER"] = 2] = "ZERO_VOTING_POWER";
+})(VotingPower = exports.VotingPower || (exports.VotingPower = {}));

package/lib/core/trade.d.ts

@@ -0,0 +1,35 @@
+import { BigNumber } from "ethers";
+import { SwapType } from "./swap";
+import { BytesLike } from "@ethersproject/bytes";
+export interface CloseTradePath {
+    path: Array<string>;
+    amountOutMin: BigNumber;
+}
+export declare class TradePath {
+    readonly swapType: SwapType;
+    readonly amount: BigNumber;
+    readonly rate: BigNumber;
+    readonly path: Array<string>;
+    readonly expectedAmount: BigNumber;
+    readonly pathUniV3: BytesLike | undefined;
+    readonly i: number | undefined;
+    readonly j: number | undefined;
+    readonly operationName: string | undefined;
+    constructor(params: {
+        swapType: SwapType;
+        amount: BigNumber;
+        path: Array<string>;
+        expectedAmount: BigNumber;
+        pathUniV3?: BytesLike;
+        i?: number;
+        j?: number;
+        operationName?: string;
+    });
+    getExpectedAmountWithSlippage(slippage: number): BigNumber;
+    getAmountInMax(slippage: number): BigNumber;
+    getAmountOutMin(slippage: number): BigNumber;
+    get from(): string;
+    get to(): string;
+    getFromAmount(slippage: number): BigNumber;
+    getToAmount(slippage: number): BigNumber;
+}

package/lib/core/trade.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TradePath = void 0;
+var swap_1 = require("./swap");
+var constants_1 = require("./constants");
+var TradePath = /** @class */ (function () {
+    function TradePath(params) {
+        this.swapType = params.swapType;
+        this.amount = params.amount;
+        this.path = params.path;
+        this.expectedAmount = params.expectedAmount;
+        this.pathUniV3 = params.pathUniV3;
+        this.rate =
+            params.swapType !== swap_1.SwapType.ExactInput
+                ? params.expectedAmount.mul(constants_1.WAD).div(params.amount)
+                : constants_1.WAD.mul(params.amount).div(params.expectedAmount);
+        this.i = params.i;
+        this.j = params.j;
+        this.operationName = params.operationName;
+    }
+    TradePath.prototype.getExpectedAmountWithSlippage = function (slippage) {
+        return this.swapType === swap_1.SwapType.ExactInput
+            ? this.getAmountOutMin(slippage)
+            : this.getAmountInMax(slippage);
+    };
+    TradePath.prototype.getAmountInMax = function (slippage) {
+        return this.expectedAmount
+            .mul(constants_1.PERCENTAGE_FACTOR + slippage)
+            .div(constants_1.PERCENTAGE_FACTOR);
+    };
+    TradePath.prototype.getAmountOutMin = function (slippage) {
+        return this.expectedAmount
+            .mul(constants_1.PERCENTAGE_FACTOR)
+            .div(constants_1.PERCENTAGE_FACTOR + slippage);
+    };
+    Object.defineProperty(TradePath.prototype, "from", {
+        get: function () {
+            return this.path[0];
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(TradePath.prototype, "to", {
+        get: function () {
+            return this.path[this.path.length - 1];
+        },
+        enumerable: false,
+        configurable: true
+    });
+    TradePath.prototype.getFromAmount = function (slippage) {
+        return this.swapType === swap_1.SwapType.ExactInput
+            ? this.amount
+            : this.getExpectedAmountWithSlippage(slippage);
+    };
+    TradePath.prototype.getToAmount = function (slippage) {
+        return this.swapType === swap_1.SwapType.ExactOutput
+            ? this.amount
+            : this.getExpectedAmountWithSlippage(slippage);
+    };
+    return TradePath;
+}());
+exports.TradePath = TradePath;