@dhedge/v2-sdk 2.0.3 → 2.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhedge/v2-sdk",
-  "version": "2.0.3",
+  "version": "2.1.1",
   "license": "MIT",
   "description": "🛠 An SDK for building applications on top of dHEDGE V2",
   "main": "dist/index.js",
@@ -24,7 +24,8 @@
     "fork:optimism": "hardhat node --port 8544 --fork $(grep OPTIMISM_URL .env | cut -d '=' -f2)",
     "fork:arbitrum": "hardhat node --port 8540 --fork $(grep ARBITRUM_URL .env | cut -d '=' -f2)",
     "fork:base": "hardhat node --port 8546 --fork $(grep BASE_URL .env | cut -d '=' -f2)",
-    "fork:ethereum": "hardhat node --port 8547 --fork $(grep ETHEREUM_URL .env | cut -d '=' -f2)"
+    "fork:ethereum": "hardhat node --port 8547 --fork $(grep ETHEREUM_URL .env | cut -d '=' -f2)",
+    "fork:plasma": "hardhat node --port 8548 --fork $(grep PLASMA_URL .env | cut -d '=' -f2)"
   },
   "husky": {
     "hooks": {

package/src/abi/PoolFactory.json

@@ -325,11 +325,26 @@
           "internalType": "string",
           "name": "_fundSymbol",
           "type": "string"
+        },
+         {
+          "internalType": "uint256",
+          "name": "_performanceFeeNumerator",
+          "type": "uint256"
         },
         {
           "internalType": "uint256",
           "name": "_managerFeeNumerator",
           "type": "uint256"
+        },
+         {
+          "internalType": "uint256",
+          "name": "_entryFeeNumerator",
+          "type": "uint256"
+        },
+         {
+          "internalType": "uint256",
+          "name": "_exitFeeNum",
+          "type": "uint256"
         },
         {
           "components": [

package/src/config.ts

@@ -18,7 +18,8 @@ export const factoryAddress: AddressNetworkMap = {
   [Network.OPTIMISM]: "0x5e61a079A178f0E5784107a4963baAe0c5a680c6",
   [Network.ARBITRUM]: "0xfffb5fb14606eb3a548c113026355020ddf27535",
   [Network.BASE]: "0x49Afe3abCf66CF09Fab86cb1139D8811C8afe56F",
-  [Network.ETHEREUM]: "0x96D33bCF84DdE326014248E2896F79bbb9c13D6d"
+  [Network.ETHEREUM]: "0x96D33bCF84DdE326014248E2896F79bbb9c13D6d",
+  [Network.PLASMA]: "0xAec4975Fc8ad911464D2948D771488b30F6eEE87"
 };
 
 export const routerAddress: AddressDappNetworkMap = {
@@ -32,7 +33,8 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.UNISWAPV3]: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45",
     [Dapp.ARRAKIS]: "0xc73fb100a995b33f9fa181d420f4c8d74506df66",
     [Dapp.TOROS]: "0x45b90480D6F643dE2f128db091A357C3c90399f2",
-    [Dapp.ODOS]: "0x4e3288c9ca110bcc82bf38f09a7b425c095d92bf"
+    [Dapp.ODOS]: "0x4e3288c9ca110bcc82bf38f09a7b425c095d92bf",
+    [Dapp.KYBERSWAP]: "0x6131B5fae19EA4f9D964eAc0408E4408b66337b5"
   },
   [Network.OPTIMISM]: {
     [Dapp.UNISWAPV3]: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45",
@@ -45,7 +47,8 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.LYRA]: "0xCCE7819d65f348c64B7Beb205BA367b3fE33763B",
     [Dapp.ARRAKIS]: "0x9ce88a56d120300061593eF7AD074A1B710094d5",
     [Dapp.ODOS]: "0xca423977156bb05b13a2ba3b76bc5419e2fe9680",
-    [Dapp.PENDLE]: "0x888888888889758F76e7103c6CbF23ABbF58F946"
+    [Dapp.PENDLE]: "0x888888888889758F76e7103c6CbF23ABbF58F946",
+    [Dapp.KYBERSWAP]: "0x6131B5fae19EA4f9D964eAc0408E4408b66337b5"
   },
   [Network.ARBITRUM]: {
     [Dapp.ONEINCH]: "0x111111125421ca6dc452d289314280a0f8842a65",
@@ -55,7 +58,8 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.RAMSES]: "0xaaa87963efeb6f7e0a2711f397663105acb1805e",
     [Dapp.TOROS]: "0xA5679C4272A056Bb83f039961fae7D99C48529F5",
     [Dapp.ODOS]: "0xa669e7A0d4b3e4Fa48af2dE86BD4CD7126Be4e13",
-    [Dapp.PENDLE]: "0x888888888889758F76e7103c6CbF23ABbF58F946"
+    [Dapp.PENDLE]: "0x888888888889758F76e7103c6CbF23ABbF58F946",
+    [Dapp.KYBERSWAP]: "0x6131B5fae19EA4f9D964eAc0408E4408b66337b5"
   },
   [Network.BASE]: {
     [Dapp.ONEINCH]: "0x111111125421ca6dc452d289314280a0f8842a65",
@@ -63,13 +67,20 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.AAVEV3]: "0xA238Dd80C259a72e81d7e4664a9801593F98d1c5",
     [Dapp.TOROS]: "0xf067575Eb60c7587C11e867907AA7284833704d1",
     [Dapp.ODOS]: "0x19cEeAd7105607Cd444F5ad10dd51356436095a1",
-    [Dapp.PENDLE]: "0x888888888889758F76e7103c6CbF23ABbF58F946"
+    [Dapp.PENDLE]: "0x888888888889758F76e7103c6CbF23ABbF58F946",
+    [Dapp.KYBERSWAP]: "0x6131B5fae19EA4f9D964eAc0408E4408b66337b5"
   },
   [Network.ETHEREUM]: {
     [Dapp.AAVEV3]: "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
     [Dapp.ODOS]: "0xCf5540fFFCdC3d510B18bFcA6d2b9987b0772559",
     [Dapp.PENDLE]: "0x888888888889758F76e7103c6CbF23ABbF58F946",
-    [Dapp.ONEINCH]: "0x111111125421ca6dc452d289314280a0f8842a65"
+    [Dapp.ONEINCH]: "0x111111125421ca6dc452d289314280a0f8842a65",
+    [Dapp.KYBERSWAP]: "0x6131B5fae19EA4f9D964eAc0408E4408b66337b5"
+  },
+  [Network.PLASMA]: {
+    [Dapp.AAVEV3]: "0x925a2A7214Ed92428B5b1B090F80b25700095e12",
+    [Dapp.PENDLE]: "0x888888888889758F76e7103c6CbF23ABbF58F946",
+    [Dapp.KYBERSWAP]: "0x6131B5fae19EA4f9D964eAc0408E4408b66337b5"
   }
 };
 
@@ -81,7 +92,8 @@ export const dappFactoryAddress: AddressDappNetworkMap = {
   [Network.OPTIMISM]: {},
   [Network.ARBITRUM]: {},
   [Network.BASE]: {},
-  [Network.ETHEREUM]: {}
+  [Network.ETHEREUM]: {},
+  [Network.PLASMA]: {}
 };
 
 export const stakingAddress: AddressDappNetworkMap = {
@@ -102,7 +114,8 @@ export const stakingAddress: AddressDappNetworkMap = {
   [Network.BASE]: {
     [Dapp.PANCAKECL]: "0xC6A2Db661D5a5690172d8eB0a7DEA2d3008665A3"
   },
-  [Network.ETHEREUM]: {}
+  [Network.ETHEREUM]: {},
+  [Network.PLASMA]: {}
 };
 
 export const aaveAddressProvider: AddressDappNetworkMap = {
@@ -122,6 +135,9 @@ export const aaveAddressProvider: AddressDappNetworkMap = {
   },
   [Network.ETHEREUM]: {
     [Dapp.AAVEV3]: "0x2f39d218133AFaB8F2B819B1066c7E434Ad94E9e"
+  },
+  [Network.PLASMA]: {
+    [Dapp.AAVEV3]: "0x061D8e131F26512348ee5FA42e2DF1bA9d6505E9"
   }
 };
 export const nonfungiblePositionManagerAddress: AddressDappNetworkMap = {
@@ -142,7 +158,8 @@ export const nonfungiblePositionManagerAddress: AddressDappNetworkMap = {
     [Dapp.AERODROMECL]: "0x827922686190790b37229fd06084350e74485b72",
     [Dapp.PANCAKECL]: "0x46A15B0b27311cedF172AB29E4f4766fbE7F4364"
   },
-  [Network.ETHEREUM]: {}
+  [Network.ETHEREUM]: {},
+  [Network.PLASMA]: {}
 };
 
 export const networkChainIdMap: NetworkChainIdMap = {
@@ -150,7 +167,8 @@ export const networkChainIdMap: NetworkChainIdMap = {
   [Network.OPTIMISM]: 10,
   [Network.ARBITRUM]: 42161,
   [Network.BASE]: 8453,
-  [Network.ETHEREUM]: 1
+  [Network.ETHEREUM]: 1,
+  [Network.PLASMA]: 9745
 };
 
 export const balancerSubgraph: AddressNetworkMap = {
@@ -159,7 +177,8 @@ export const balancerSubgraph: AddressNetworkMap = {
   [Network.OPTIMISM]: "",
   [Network.ARBITRUM]: "",
   [Network.BASE]: "",
-  [Network.ETHEREUM]: ""
+  [Network.ETHEREUM]: "",
+  [Network.PLASMA]: ""
 };
 
 export const multiCallAddress: AddressNetworkMap = {
@@ -167,7 +186,8 @@ export const multiCallAddress: AddressNetworkMap = {
   [Network.OPTIMISM]: "",
   [Network.ARBITRUM]: "",
   [Network.BASE]: "",
-  [Network.ETHEREUM]: ""
+  [Network.ETHEREUM]: "",
+  [Network.PLASMA]: ""
 };
 
 export const lyraNetworkMap: LyraNetworkMap = {

package/src/entities/dhedge.ts

@@ -33,7 +33,10 @@ export class Dhedge {
    * @param {string} poolName Pool name
    * @param {string} symbol Token symbol
    * @param {tuple[]} supportedAssets Enabled assets to trade
-   * @param {number|BigNumber} managerFeeNumerator Manger fee in percent
+   * @param {number|BigNumber} performanceFeeNumerator Performance fee in percent
+   * @param {number|BigNumber} managerFeeNumerator Manager fee in percent
+   * @param {number|BigNumber} entryFeeNumerator Entry fee in percent
+   * @param {number|BigNumber} exitFeeNumerator Exit fee in percent
    * @param {any} options Transaction options
    * @returns {Pool} Created Pool
    */
@@ -42,7 +45,10 @@ export class Dhedge {
     poolName: string,
     symbol: string,
     supportedAssets: SupportedAsset[],
-    managerFeeNumerator = 20,
+    performanceFeeNumerator = 0,
+    managerFeeNumerator = 0,
+    entryFeeNumerator = 0,
+    exitFeeNumerator = 0,
     options: any = null
   ): Promise<Pool> {
     const pool = await this.factory.createFund(
@@ -51,7 +57,10 @@ export class Dhedge {
       managerName,
       poolName,
       symbol,
+      performanceFeeNumerator * 100,
       managerFeeNumerator * 100,
+      entryFeeNumerator * 100,
+      exitFeeNumerator * 100,
       supportedAssets,
       options
     );

package/src/entities/pool.ts

@@ -86,6 +86,7 @@ import {
 import { getOdosSwapTxData } from "../services/odos";
 import { getPendleSwapTxData } from "../services/pendle";
 import { getCompleteWithdrawalTxData } from "../services/toros/completeWithdrawal";
+import { getKyberSwapTxData } from "../services/kyberSwap";
 
 export class Pool {
   public readonly poolLogic: Contract;
@@ -444,6 +445,15 @@ export class Pool {
           slippage
         ));
         break;
+      case Dapp.KYBERSWAP:
+        ({ swapTxData, minAmountOut } = await getKyberSwapTxData(
+          this,
+          assetFrom,
+          assetTo,
+          amountIn,
+          slippage
+        ));
+        break;
       default:
         const iUniswapV2Router = new ethers.utils.Interface(
           IUniswapV2Router.abi

package/src/services/kyberSwap/index.ts

@@ -0,0 +1,55 @@
+import axios from "axios";
+import { ApiError, ethers } from "../..";
+import { Pool } from "../../entities";
+
+export const kyberBaseUrl = "https://aggregator-api.kyberswap.com";
+
+export async function getKyberSwapTxData(
+  pool: Pool,
+  tokenIn: string,
+  tokenOut: string,
+  amountIn: ethers.BigNumber | string,
+  slippage: number
+): Promise<{ swapTxData: string; minAmountOut: string }> {
+  const params = {
+    tokenIn,
+    tokenOut,
+    amountIn: amountIn.toString()
+  };
+  try {
+    const quoteResult = await axios.get(
+      `${kyberBaseUrl}/${pool.network}/api/v1/routes`,
+      {
+        params,
+        headers: {
+          "x-client-id": "dHEDGE"
+        }
+      }
+    );
+
+    const buildParams = {
+      routeSummary: quoteResult.data.data.routeSummary,
+      sender: pool.address,
+      recipient: pool.address,
+      slippageTolerance: slippage * 100 // in basis points
+    };
+
+    const buildResult = await axios.post(
+      `${kyberBaseUrl}/${pool.network}/api/v1/route/build`,
+      buildParams,
+      {
+        headers: {
+          "x-client-id": "dHEDGE"
+        }
+      }
+    );
+
+    return {
+      swapTxData: buildResult.data.data.data,
+      minAmountOut: buildResult.data.data.amountOut
+    };
+  } catch (e) {
+    console.error("Error in KyberSwap API request:", e);
+    throw new ApiError("Swap api request of KyberSwap failed");
+  }
+}

package/src/test/constants.ts

@@ -43,13 +43,15 @@ export const TEST_POOL = {
   [Network.OPTIMISM]: "0x12573bfdf764ab9d52aca20e2827497a66829716",
   [Network.ARBITRUM]: "0x0b5f6591c8eb23e5a68102d3d39ebbb464ee5c14",
   [Network.BASE]: "0x4842b42F68524383F609aa46eAfc18c1459cE3cD",
-  [Network.ETHEREUM]: "0xe8e74f664d2d6a919a18b911990db0979789b6f7"
+  [Network.ETHEREUM]: "0xe8e74f664d2d6a919a18b911990db0979789b6f7",
+  [Network.PLASMA]: "0xdad21646ebb0997eb59de1f6a68a67059daf4c31"
 };
 
 export const CONTRACT_ADDRESS = {
   [Network.POLYGON]: {
     USDC: "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
     USDT: "",
+    USDE: "",
     SUSD: "",
     SWETH: "",
     WETH: "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619",
@@ -71,6 +73,7 @@ export const CONTRACT_ADDRESS = {
   [Network.OPTIMISM]: {
     USDC: "0x0b2c639c533813f4aa9d7837caf62653d097ff85",
     USDT: "",
+    USDE: "",
     SWETH: "",
     SUSD: "0x8c6f28f2f1a3c87f0f938b96d27520d9751ec8d9",
     WETH: "0x4200000000000000000000000000000000000006",
@@ -95,6 +98,7 @@ export const CONTRACT_ADDRESS = {
     USDC: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
     USDT: "",
     SUSD: "",
+    USDE: "",
     SWETH: "0xbc011A12Da28e8F0f528d9eE5E7039E22F91cf18",
     WETH: "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
     WBTC: "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",
@@ -122,6 +126,7 @@ export const CONTRACT_ADDRESS = {
     USDC: "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
     USDT: "0xfde4c96c8593536e31f229ea8f37b2ada2699bb2",
     SUSD: "",
+    USDE: "",
     WETH: "0x4200000000000000000000000000000000000006",
     WBTC: "",
     SWETH: "",
@@ -143,6 +148,7 @@ export const CONTRACT_ADDRESS = {
     USDC: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
     USDT: "",
     SUSD: "",
+    USDE: "0x4c9edd5852cd905f086c759e8383e09bff1e68b3",
     WETH: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
     WBTC: "",
     SWETH: "",
@@ -159,6 +165,12 @@ export const CONTRACT_ADDRESS = {
     FLUID_WETH: "",
     TOROS: "",
     UNIT: ""
+  },
+  [Network.PLASMA]: {
+    USDC: "",
+    WETH: "0x9895d81bb462a195b4922ed7de0e3acd007c32cb",
+    USDT: "0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb",
+    USDE: "0x5d3a1ff2b6bab83b63cd9ad0787074081a52ef34"
   }
 };
 
@@ -169,7 +181,8 @@ export const USDC_BALANCEOF_SLOT = {
   [Network.ARBITRUM]: 9,
   [Network.POLYGON]: 0,
   [Network.BASE]: 9,
-  [Network.ETHEREUM]: 9
+  [Network.ETHEREUM]: 9,
+  [Network.PLASMA]: 9 //Currently no USDC on Plasma
 };
 
 export const WETH_BALANCEOF_SLOT = {
@@ -177,5 +190,6 @@ export const WETH_BALANCEOF_SLOT = {
   [Network.ARBITRUM]: 51,
   [Network.POLYGON]: 0,
   [Network.BASE]: 0,
-  [Network.ETHEREUM]: 3
+  [Network.ETHEREUM]: 3,
+  [Network.PLASMA]: 1
 };

package/src/test/dhedge.test.ts

@@ -1,49 +1,32 @@
 import { Dhedge } from "..";
-import { factoryAddress } from "../config";
 import { Network } from "../types";
 
-import { wallet } from "./wallet";
+import { testingHelper, TestingRunParams } from "./utils/testingHelper";
 
-const myPool = "0x279ac4c05154fd72a636fce1bc25c50966141fd0";
-// const usdc = "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174";
-// const weth = "0x7ceb23fd6bc0add59e62ac25578270cff1b9f619";
+const testDhedge = ({ wallet, network }: TestingRunParams) => {
+  let dhedge: Dhedge;
 
-// const options = {
-//   gasPrice: ethers.utils.parseUnits("40", "gwei")
-// };
+  jest.setTimeout(200000);
 
-jest.setTimeout(900000);
+  describe(`dHEDGE on ${network}`, () => {
+    beforeAll(async () => {
+      dhedge = new Dhedge(wallet, network);
+    });
 
-let dhedge: Dhedge;
-
-describe("dhedge", () => {
-  beforeAll(() => {
-    dhedge = new Dhedge(wallet, Network.POLYGON);
-  });
-
-  it("loads factory", () => {
-    const factory = dhedge.factory;
-    expect(factory.address).toBe(factoryAddress[dhedge.network]);
-  });
-
-  it("loads a pool by address", async () => {
-    const pool = await dhedge.loadPool(myPool);
-    expect(pool.poolLogic.address).toBe(myPool);
+    it("create a pool", async () => {
+      const pool = await dhedge.createPool("Test", "Test", "TEST", [
+        ["0x5d3a1ff2b6bab83b63cd9ad0787074081a52ef34", true],
+        ["0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb", false],
+        ["0x925a2A7214Ed92428B5b1B090F80b25700095e12", false]
+      ]);
+      console.log(pool.address);
+      expect(pool.poolLogic.address).toBe(pool.address);
+    });
   });
+};
 
-  // it("create a pool", async () => {
-  //   const pool = await dhedge.createPool(
-  //     "Batman",
-  //     "Gotham Pool",
-  //     "DHHH",
-  //     [
-  //       [usdc, true],
-  //       [weth, true]
-  //     ],
-  //     25,
-  //     options
-  //   );
-  //   console.log(pool.address);
-  //   expect(pool.poolLogic.address).toBe(pool.address);
-  // });
+testingHelper({
+  network: Network.PLASMA,
+  onFork: false,
+  testingRun: testDhedge
 });

package/src/test/kyberSwap.test.ts

@@ -0,0 +1,106 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+
+import { Dhedge, Pool } from "..";
+
+import { Dapp, Network } from "../types";
+import { CONTRACT_ADDRESS, MAX_AMOUNT, TEST_POOL } from "./constants";
+import {
+  TestingRunParams,
+  setUSDCAmount,
+  testingHelper,
+  wait
+} from "./utils/testingHelper";
+
+import { allowanceDelta, balanceDelta } from "./utils/token";
+import { routerAddress } from "../config";
+import BigNumber from "bignumber.js";
+
+const testKyberSwap = ({ wallet, network, provider }: TestingRunParams) => {
+  const USDC = CONTRACT_ADDRESS[network].USDC;
+  const WETH = CONTRACT_ADDRESS[network].WETH;
+
+  let dhedge: Dhedge;
+  let pool: Pool;
+  jest.setTimeout(100000);
+
+  describe(`kyberswap on ${network}`, () => {
+    beforeAll(async () => {
+      dhedge = new Dhedge(wallet, network);
+      pool = await dhedge.loadPool(TEST_POOL[network]);
+      // top up gas
+      await provider.send("hardhat_setBalance", [
+        wallet.address,
+        "0x10000000000000000"
+      ]);
+      await provider.send("evm_mine", []);
+      // top up USDC
+      await setUSDCAmount({
+        amount: new BigNumber(2).times(1e6).toFixed(0),
+        userAddress: pool.address,
+        network,
+        provider
+      });
+    });
+
+    it("approves unlimited USDC on KyberSwap", async () => {
+      await pool.approve(Dapp.KYBERSWAP, USDC, MAX_AMOUNT);
+      const usdcAllowanceDelta = await allowanceDelta(
+        pool.address,
+        USDC,
+        routerAddress[network]["kyberswap"]!,
+        pool.signer
+      );
+      await expect(usdcAllowanceDelta.gt(0));
+    });
+
+    it("gets only amount and txData for 2 USDC into WETH on KyberSwap", async () => {
+      const usdcBalance = await pool.utils.getBalance(USDC, pool.address);
+      const result = await pool.trade(
+        Dapp.KYBERSWAP,
+        USDC,
+        WETH,
+        usdcBalance,
+        1,
+        null,
+        { estimateGas: false, onlyGetTxData: true }
+      );
+      expect(result.txData).not.toBeNull();
+      expect(result.minAmountOut).not.toBeNull();
+    });
+
+    it("trades USDC balance into WETH on KyberSwap", async () => {
+      await wait(1);
+      const usdcBalance = await pool.utils.getBalance(USDC, pool.address);
+      await pool.trade(Dapp.KYBERSWAP, USDC, WETH, usdcBalance, 1);
+      const wethBalanceDelta = await balanceDelta(
+        pool.address,
+        WETH,
+        pool.signer
+      );
+      expect(wethBalanceDelta.gt(0));
+    });
+  });
+};
+
+// testingHelper({
+//   network: Network.PLASMA,
+//   onFork: false,
+//   testingRun: testKyberSwap
+// });
+
+testingHelper({
+  network: Network.ARBITRUM,
+  testingRun: testKyberSwap
+});
+
+// testingHelper({
+//   network: Network.POLYGON,
+//   onFork: false,
+//   testingRun: testOdos
+// });
+
+// testingHelper({
+//   network: Network.BASE,
+//   onFork: false,
+//   testingRun: testOdos
+// });