@dhedge/v2-sdk 1.10.10 → 1.10.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhedge/v2-sdk",
-  "version": "1.10.10",
+  "version": "1.10.12",
   "license": "MIT",
   "description": "🛠 An SDK for building applications on top of dHEDGE V2",
   "main": "dist/index.js",
@@ -34,7 +34,7 @@
     "@size-limit/preset-small-lib": "^5.0.1",
     "@types/jest": "^28.1.7",
     "@types/lodash": "^4.14.178",
-    "hardhat": "2.22.18",
+    "hardhat": "2.23.0",
     "husky": "^7.0.1",
     "jest": "^28.1.3",
     "size-limit": "^5.0.1",

package/src/abi/flatmoney/v2/IOrderExecutionModule.json

@@ -0,0 +1,96 @@
+[
+    {
+        "type": "function",
+        "name": "cancelExistingOrder",
+        "inputs": [
+            {
+                "name": "account",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "outputs": [],
+        "stateMutability": "nonpayable"
+    },
+    {
+        "type": "function",
+        "name": "cancelOrderByModule",
+        "inputs": [
+            {
+                "name": "account",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "outputs": [],
+        "stateMutability": "nonpayable"
+    },
+    {
+        "type": "function",
+        "name": "executeLimitOrder",
+        "inputs": [
+            {
+                "name": "tokenId",
+                "type": "uint256",
+                "internalType": "uint256"
+            },
+            {
+                "name": "priceUpdateData",
+                "type": "bytes[]",
+                "internalType": "bytes[]"
+            }
+        ],
+        "outputs": [],
+        "stateMutability": "payable"
+    },
+    {
+        "type": "function",
+        "name": "executeOrder",
+        "inputs": [
+            {
+                "name": "account",
+                "type": "address",
+                "internalType": "address"
+            },
+            {
+                "name": "priceUpdateData",
+                "type": "bytes[]",
+                "internalType": "bytes[]"
+            }
+        ],
+        "outputs": [],
+        "stateMutability": "payable"
+    },
+    {
+        "type": "function",
+        "name": "hasOrderExpired",
+        "inputs": [
+            {
+                "name": "account",
+                "type": "address",
+                "internalType": "address"
+            }
+        ],
+        "outputs": [
+            {
+                "name": "expired",
+                "type": "bool",
+                "internalType": "bool"
+            }
+        ],
+        "stateMutability": "view"
+    },
+    {
+        "type": "function",
+        "name": "maxExecutabilityAge",
+        "inputs": [],
+        "outputs": [
+            {
+                "name": "maxExecutabilityAge",
+                "type": "uint64",
+                "internalType": "uint64"
+            }
+        ],
+        "stateMutability": "view"
+    }
+]

package/src/config.ts

@@ -31,7 +31,6 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.UNISWAPV3]: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45",
     [Dapp.ARRAKIS]: "0xc73fb100a995b33f9fa181d420f4c8d74506df66",
     [Dapp.TOROS]: "0x45b90480D6F643dE2f128db091A357C3c90399f2",
-    [Dapp.ZEROEX]: "0xdef1c0ded9bec7f1a1670819833240f027b25eff",
     [Dapp.ODOS]: "0x4e3288c9ca110bcc82bf38f09a7b425c095d92bf"
   },
   [Network.OPTIMISM]: {
@@ -44,7 +43,6 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.VELODROMEV2]: "0xa062ae8a9c5e11aaa026fc2670b0d65ccc8b2858",
     [Dapp.LYRA]: "0xCCE7819d65f348c64B7Beb205BA367b3fE33763B",
     [Dapp.ARRAKIS]: "0x9ce88a56d120300061593eF7AD074A1B710094d5",
-    [Dapp.ZEROEX]: "0xdef1abe32c034e558cdd535791643c58a13acc10",
     [Dapp.ODOS]: "0xca423977156bb05b13a2ba3b76bc5419e2fe9680"
   },
   [Network.ARBITRUM]: {
@@ -53,13 +51,11 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.AAVEV3]: "0x794a61358D6845594F94dc1DB02A252b5b4814aD",
     [Dapp.BALANCER]: "0xBA12222222228d8Ba445958a75a0704d566BF2C8",
     [Dapp.RAMSES]: "0xaaa87963efeb6f7e0a2711f397663105acb1805e",
-    [Dapp.ZEROEX]: "0xdef1c0ded9bec7f1a1670819833240f027b25eff",
     [Dapp.TOROS]: "0xA5679C4272A056Bb83f039961fae7D99C48529F5",
     [Dapp.ODOS]: "0xa669e7A0d4b3e4Fa48af2dE86BD4CD7126Be4e13"
   },
   [Network.BASE]: {
     [Dapp.ONEINCH]: "0x111111125421ca6dc452d289314280a0f8842a65",
-    [Dapp.ZEROEX]: "0xdef1c0ded9bec7f1a1670819833240f027b25eff",
     [Dapp.AERODROME]: "0xcF77a3Ba9A5CA399B7c97c74d54e5b1Beb874E43",
     [Dapp.AAVEV3]: "0xA238Dd80C259a72e81d7e4664a9801593F98d1c5",
     [Dapp.TOROS]: "0xf067575Eb60c7587C11e867907AA7284833704d1",
@@ -170,10 +166,11 @@ export const flatMoneyContractAddresses: Readonly<Partial<
   Record<
     Network,
     {
+      OrderExecution?: string;
       DelayedOrder: string;
       FlatcoinVault: string;
       StableModule: string;
-      RETH: string;
+      COLLATERAL: string;
     }
   >
 >> = {
@@ -181,6 +178,13 @@ export const flatMoneyContractAddresses: Readonly<Partial<
     DelayedOrder: "0x6D857e9D24a7566bB72a3FB0847A3E0e4E1c2879",
     FlatcoinVault: "0x95Fa1ddc9a78273f795e67AbE8f1Cd2Cd39831fF",
     StableModule: "0xb95fB324b8A2fAF8ec4f76e3dF46C718402736e2",
-    RETH: "0xb6fe221fe9eef5aba221c348ba20a1bf5e73624c"
+    COLLATERAL: "0xb6fe221fe9eef5aba221c348ba20a1bf5e73624c" // RETH
+  },
+  [Network.OPTIMISM]: {
+    OrderExecution: "0x7805CB7fb2C2e70FDdF92949065D9Ee1Fc2F72a8",
+    DelayedOrder: "0xd917A0C9B21Bb71DF1209d2c211Ad83004F01554", // OrderAnnouncementModule
+    FlatcoinVault: "0x86C7b9640302082B0dF78023F930d8612bFcaD3f",
+    COLLATERAL: "0x68f180fcCe6836688e9084f035309E29Bf0A2095", // WBTC
+    StableModule: "0x357CB23571EF7a3d6189b7FAcFC361eA71f7CAB5"
   }
 };

package/src/entities/dhedge.ts

@@ -23,7 +23,6 @@ export class Dhedge {
       PoolFactory.abi,
       this.signer
     );
-
     this.utils = new Utils(this.network, this.signer);
   }
 
@@ -87,9 +86,10 @@ export class Dhedge {
    * @param {string} address Pool address
    * @returns {Pool} Loaded Pool
    */
-  public async loadPool(address: string): Promise<Pool> {
+  public async loadPool(address: string, isDhedge = true): Promise<Pool> {
     const poolLogic = new Contract(address, PoolLogic.abi, this.signer);
-    const managerLogicAddress = await poolLogic.poolManagerLogic();
+    let managerLogicAddress = address;
+    if (isDhedge) managerLogicAddress = await poolLogic.poolManagerLogic();
     const managerLogic = new Contract(
       managerLogicAddress,
       ManagerLogic.abi,
@@ -102,7 +102,8 @@ export class Dhedge {
       poolLogic,
       managerLogic,
       this.utils,
-      this.factory
+      this.factory,
+      isDhedge
     );
   }
 

package/src/entities/pool.ts

@@ -63,7 +63,6 @@ import {
   getFuturesChangeMarginTxData
 } from "../services/futures";
 import { getFuturesCancelOrderTxData } from "../services/futures/trade";
-import { getZeroExTradeTxData } from "../services/zeroEx/zeroExTrade";
 import { getOneInchSwapTxData } from "../services/oneInch";
 import {
   getCreateVestTxData,
@@ -96,6 +95,7 @@ export class Pool {
   public readonly address: string;
   public readonly utils: Utils;
   public readonly network: Network;
+  public readonly isDhedge: boolean;
 
   public constructor(
     network: Network,
@@ -103,7 +103,8 @@ export class Pool {
     poolLogic: Contract,
     mangerLogic: Contract,
     utils: Utils,
-    factory: Contract
+    factory: Contract,
+    isDhedge = true
   ) {
     this.network = network;
     this.poolLogic = poolLogic;
@@ -112,6 +113,7 @@ export class Pool {
     this.signer = signer;
     this.utils = utils;
     this.factory = factory;
+    this.isDhedge = isDhedge;
   }
 
   /**
@@ -370,16 +372,6 @@ export class Pool {
   ): Promise<any> {
     let swapTxData: string;
     switch (dapp) {
-      case Dapp.ZEROEX:
-        swapTxData = await getZeroExTradeTxData(
-          this.network,
-          assetFrom,
-          assetTo,
-          amountIn,
-          slippage,
-          this.address
-        );
-        break;
       case Dapp.ONEINCH:
         ({ swapTxData } = await getOneInchSwapTxData(
           this,

package/src/services/flatmoney/keeperFee.ts

@@ -4,6 +4,7 @@ import IFlatcoinVaultAbi from "../../abi/flatmoney/IFlatcoinVault.json";
 import KeeperFeeAbi from "../../abi/flatmoney/KeeperFee.json";
 import { flatMoneyContractAddresses } from "../../config";
 import BigNumber from "bignumber.js";
+import { JsonRpcProvider } from "@ethersproject/providers";
 
 export const getKeeperFeeContract = async (pool: Pool): Promise<Contract> => {
   const flatMoneyContracts = flatMoneyContractAddresses[pool.network];
@@ -35,12 +36,16 @@ export const getKeeperFee = async (
   maxKeeperFeeInUsd: number | null
 ): Promise<ethers.BigNumber> => {
   const keeperFeeContract = await getKeeperFeeContract(pool);
-  const gasPrice = await pool.signer.provider.getGasPrice();
+
+  const feeHistory = await (pool.signer
+    .provider as JsonRpcProvider).send("eth_feeHistory", [1, "latest"]);
+
+  const gasPrice = Number(feeHistory.baseFeePerGas[0]);
 
   let keeperfee: ethers.BigNumber;
   if (gasPrice) {
     keeperfee = await keeperFeeContract["getKeeperFee(uint256)"](
-      new BigNumber(gasPrice.toString()).times(1.2).toFixed(0)
+      new BigNumber(gasPrice.toString()).times(1.5).toFixed(0)
     );
   } else {
     keeperfee = await keeperFeeContract["getKeeperFee()"]();
@@ -72,7 +77,7 @@ export const getKeeperFeeInUsd = async (
   const filteredFc = fundComposition.filter(
     fc =>
       fc.asset.toLocaleLowerCase() ===
-      flatMoneyContracts.RETH.toLocaleLowerCase()
+      flatMoneyContracts.COLLATERAL.toLocaleLowerCase()
   );
 
   if (!filteredFc[0])
@@ -80,5 +85,8 @@ export const getKeeperFeeInUsd = async (
 
   const rateD1 = new BigNumber(filteredFc[0].rate.toString()).div(1e18);
 
-  return rateD1.times(keeperFee.toString()).div(1e18);
+  const assetDecimal = await pool.utils.getDecimals(
+    flatMoneyContracts.COLLATERAL
+  );
+  return rateD1.times(keeperFee.toString()).div(10 ** assetDecimal);
 };

package/src/services/flatmoney/stableLp.ts

@@ -3,6 +3,7 @@
 import BigNumber from "bignumber.js";
 import { Pool, ethers } from "../..";
 import DelayedOrderAbi from "../../abi/flatmoney/DelayedOrder.json";
+import IOrderExecutionModuleAbi from "../../abi/flatmoney/v2/IOrderExecutionModule.json";
 import { flatMoneyContractAddresses } from "../../config";
 import { getPoolTxOrGasEstimate } from "../../utils/contract";
 import { getStableDepositQuote, getStableWithdrawQuote } from "./stableModule";
@@ -42,6 +43,12 @@ export function getCancelExistingOrderTxData(account: string): string {
   ).encodeFunctionData("cancelExistingOrder", [account]);
 }
 
+export function getCancelExistingOrderTxDataForV2(account: string): string {
+  return new ethers.utils.Interface(
+    IOrderExecutionModuleAbi
+  ).encodeFunctionData("cancelExistingOrder", [account]);
+}
+
 export async function mintUnitViaFlatMoney(
   pool: Pool,
   depositAmount: ethers.BigNumber | string,
@@ -55,7 +62,7 @@ export async function mintUnitViaFlatMoney(
     throw new Error("mintUnitViaFlatMoney: network not supported");
   }
 
-  const keeperfee = await getKeeperFee(pool, maxKeeperFeeInUsd); // in RETH
+  const keeperfee = await getKeeperFee(pool, maxKeeperFeeInUsd); // in COLLATERAL
 
   const adjustedDepositAmount = new BigNumber(depositAmount.toString()).minus(
     keeperfee.toString() // keeper fee deducted from amountIn
@@ -125,11 +132,26 @@ export async function cancelOrderViaFlatMoney(
   if (!flatMoneyContracts) {
     throw new Error("cancelOrderViaFlatMoney: network not supported");
   }
-  const cancelOrderTxData = await getCancelExistingOrderTxData(pool.address);
-  const tx = await getPoolTxOrGasEstimate(
-    pool,
-    [flatMoneyContracts.DelayedOrder, cancelOrderTxData, options],
-    estimateGas
-  );
-  return tx;
+  // flat money v2
+  // use OrderExecution module to cancel order
+  let toAddress = flatMoneyContracts.DelayedOrder;
+  let cancelOrderTxData = getCancelExistingOrderTxData(pool.address);
+  if (flatMoneyContracts.OrderExecution) {
+    toAddress = flatMoneyContracts.OrderExecution;
+    cancelOrderTxData = await getCancelExistingOrderTxDataForV2(pool.address);
+  }
+  // use trader address to cancel order
+  if (estimateGas) {
+    return pool.signer.estimateGas({
+      to: toAddress,
+      data: cancelOrderTxData
+    });
+  } else {
+    const tx = await pool.signer.sendTransaction({
+      to: toAddress,
+      data: cancelOrderTxData,
+      ...options
+    });
+    return tx;
+  }
 }

package/src/test/constants.ts

@@ -62,7 +62,8 @@ export const CONTRACT_ADDRESS = {
     VELODROME_CL_USDC_WETH_GAUGE: "",
     VELO: "",
     COMPOUNDV3_WETH: "",
-    TOROS: ""
+    TOROS: "",
+    UNIT: ""
   },
 
   [Network.OPTIMISM]: {
@@ -77,6 +78,7 @@ export const CONTRACT_ADDRESS = {
       nonfungiblePositionManager: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88"
     },
 
+    UNIT: "0x357CB23571EF7a3d6189b7FAcFC361eA71f7CAB5",
     WMATIC: "",
     //
     ARRAKIS_USDC_WETH_GAUGE: "",
@@ -101,6 +103,8 @@ export const CONTRACT_ADDRESS = {
       nonfungiblePositionManager: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88"
     },
 
+    UNIT: "",
+
     //
     ARRAKIS_USDC_WETH_GAUGE: "",
     ARRAKIS_USDC_WETH_LP: "",
@@ -117,6 +121,7 @@ export const CONTRACT_ADDRESS = {
     WETH: "0x4200000000000000000000000000000000000006",
     WBTC: "",
     SWETH: "",
+    UNIT: "0xb95fB324b8A2fAF8ec4f76e3dF46C718402736e2",
     uniswapV3: {
       nonfungiblePositionManager: ""
     },

package/src/test/flatmoney.test.ts

@@ -4,6 +4,7 @@ import { Dhedge, Pool } from "../entities";
 import { AssetEnabled, Network } from "../types";
 import {
   TestingRunParams,
+  runWithImpersonateAccount,
   setTokenAmount,
   testingHelper
 } from "./utils/testingHelper";
@@ -14,9 +15,7 @@ import DelayedOrderAbi from "../abi/flatmoney/DelayedOrder.json";
 import { allowanceDelta } from "./utils/token";
 import { getKeeperFee } from "../services/flatmoney/keeperFee";
 
-const RETH = "0xb6fe221fe9eef5aba221c348ba20a1bf5e73624c";
-const RETH_SLOT = 0;
-const UNIT = "0xb95fB324b8A2fAF8ec4f76e3dF46C718402736e2";
+const COLLATERAL_SLOT = 0; // same for RETH(base) and WBTC(optimism)
 // https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/blob/master/contracts/token/ERC20/ERC20Upgradeable.sol#L31
 // https://eips.ethereum.org/EIPS/eip-7201
 const UNIT_SLOT =
@@ -31,16 +30,26 @@ const testFlatMoney = ({
   let dhedge: Dhedge;
   let pool: Pool;
   let delayOrderContract: Contract;
+  let COLLATERAL: string;
   jest.setTimeout(200000);
   describe(`flatmoney on ${network}`, () => {
     beforeAll(async () => {
+      await provider.send("evm_mine", []);
       dhedge = new Dhedge(wallet, network);
       pool = await dhedge.loadPool(TEST_POOL[network]);
 
+      await runWithImpersonateAccount(
+        { provider, account: await pool.managerLogic.manager() },
+        async ({ signer }) => {
+          await pool.managerLogic.connect(signer).setTrader(wallet.address);
+        }
+      );
+
       const flatMoneyContracts = flatMoneyContractAddresses[pool.network];
       if (!flatMoneyContracts) {
         throw new Error("testFlatMoney: network not supported");
       }
+      COLLATERAL = flatMoneyContracts.COLLATERAL;
       delayOrderContract = new Contract(
         flatMoneyContracts.DelayedOrder,
         DelayedOrderAbi,
@@ -57,14 +66,14 @@ const testFlatMoney = ({
       await setTokenAmount({
         amount: new BigNumber(100).times(1e18).toString(),
         provider,
-        tokenAddress: RETH,
-        slot: RETH_SLOT,
+        tokenAddress: COLLATERAL,
+        slot: COLLATERAL_SLOT,
         userAddress: pool.address
       });
       await setTokenAmount({
         amount: new BigNumber(100).times(1e18).toString(),
         provider,
-        tokenAddress: UNIT,
+        tokenAddress: CONTRACT_ADDRESS[network].UNIT,
         slot: UNIT_SLOT,
         userAddress: pool.address
       });
@@ -82,11 +91,11 @@ const testFlatMoney = ({
         { asset: CONTRACT_ADDRESS[network].USDC, isDeposit: true },
         { asset: CONTRACT_ADDRESS[network].WETH, isDeposit: true },
         {
-          asset: UNIT,
+          asset: CONTRACT_ADDRESS[network].UNIT,
           isDeposit: false
         },
         {
-          asset: RETH,
+          asset: COLLATERAL,
           isDeposit: false
         }
       ];
@@ -95,10 +104,14 @@ const testFlatMoney = ({
 
     it("mint UNIT", async () => {
       //approve
-      await pool.approveSpender(delayOrderContract.address, RETH, MAX_AMOUNT);
+      await pool.approveSpender(
+        delayOrderContract.address,
+        COLLATERAL,
+        MAX_AMOUNT
+      );
       const collateralAllowanceDelta = await allowanceDelta(
         pool.address,
-        RETH,
+        COLLATERAL,
         delayOrderContract.address,
         pool.signer
       );
@@ -129,7 +142,13 @@ const testFlatMoney = ({
     });
 
     it("redeem UNIT", async () => {
-      const withdrawAmountStr = new BigNumber(2).times(1e18).toString();
+      let withdrawAmountStr;
+      if (Network.OPTIMISM === network) {
+        withdrawAmountStr = new BigNumber(2).times(1e8).toString(); // smaller amount
+      } else {
+        withdrawAmountStr = new BigNumber(2).times(1e18).toString();
+      }
+
       const tx = await pool.redeemUnitViaFlatMoney(
         withdrawAmountStr,
         0.5,

package/src/types.ts

@@ -23,7 +23,6 @@ export enum Dapp {
   VELODROMEV2 = "velodromeV2",
   VELODROMECL = "velodromeCL",
   LYRA = "lyra",
-  ZEROEX = "0x",
   RAMSES = "ramses",
   AERODROME = "aerodrome",
   AERODROMECL = "aerodromeCL",

package/src/utils/contract.ts

@@ -99,13 +99,25 @@ export const getPoolTxOrGasEstimate = async (
   args: any[],
   estimateGas: boolean
 ): Promise<any> => {
-  if (estimateGas) {
-    return await pool.poolLogic.estimateGas.execTransaction(
-      args[0],
-      args[1],
-      args[2]
-    );
+  if (pool.isDhedge) {
+    if (estimateGas) {
+      return await pool.poolLogic.estimateGas.execTransaction(
+        args[0],
+        args[1],
+        args[2]
+      );
+    } else {
+      return await pool.poolLogic.execTransaction(args[0], args[1], args[2]);
+    }
   } else {
-    return await pool.poolLogic.execTransaction(args[0], args[1], args[2]);
+    if (estimateGas) {
+      return await pool.signer.estimateGas({ to: args[0], data: args[1] });
+    } else {
+      return await pool.signer.sendTransaction({
+        to: args[0],
+        data: args[1],
+        ...args[2]
+      });
+    }
   }
 };

package/dist/services/zeroEx/zeroExTrade.d.ts

@@ -1,3 +0,0 @@
-import { BigNumber } from "ethers";
-import { Network } from "../../types";
-export declare const getZeroExTradeTxData: (network: Network, assetFrom: string, assetTo: string, amountIn: BigNumber | string, slippage: number | undefined, takerAddress: string) => Promise<string>;

package/src/services/zeroEx/zeroExTrade.ts

@@ -1,52 +0,0 @@
-import axios from "axios";
-import { BigNumber } from "ethers";
-import { Network } from "../../types";
-import { ApiError } from "../../errors";
-
-// slippage of 0x is different from that of 1Inch
-// in 0x, e.g. 0.03 for 3% slippage allowed
-// 1inch slippage 0.5% represented by 0.5
-// 0x slippage 0.5% represented by 0.005
-const getZeroExSlippage = (slippage: number): number => {
-  return Number(slippage) / 100;
-};
-
-export const getZeroExTradeTxData = async (
-  network: Network,
-  assetFrom: string,
-  assetTo: string,
-  amountIn: BigNumber | string,
-  slippage = 0.5,
-  takerAddress: string
-): Promise<string> => {
-  if (!process.env.ZEROEX_API_KEY)
-    throw new Error("ZEROEX_API_KEY not configured in .env file");
-  try {
-    const slippagePercentage = getZeroExSlippage(slippage);
-    const params = {
-      buyToken: assetTo,
-      sellToken: assetFrom,
-      sellAmount: amountIn.toString(),
-      // necessary to skip quote validation is that in which the takerAddress refers to a smart contract
-      skipValidation: true,
-      // Used to enable RFQ-T liquidity
-      intentOnFilling: true,
-      takerAddress,
-      slippagePercentage
-      // excludedSourcesParam
-    };
-    const response = await axios.get(
-      `https://${network}.api.0x.org/swap/v1/quote`,
-      {
-        params,
-        headers: {
-          "0x-api-key": process.env.ZEROEX_API_KEY
-        }
-      }
-    );
-
-    return response.data.data;
-  } catch (e) {
-    throw new ApiError("Swap api request of 0x failed");
-  }
-};