@dhedge/v2-sdk 1.8.3 → 1.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhedge/v2-sdk",
-  "version": "1.8.3",
+  "version": "1.9.1",
   "license": "MIT",
   "description": "🛠 An SDK for building applications on top of dHEDGE V2",
   "main": "dist/index.js",
@@ -21,7 +21,8 @@
     "size": "size-limit",
     "analyze": "size-limit --why",
     "fork:polygon": "hardhat node --fork $(grep POLYGON_URL .env | cut -d '=' -f2)",
-    "fork:optimism": "hardhat node --fork $(grep OPTIMISM_URL .env | cut -d '=' -f2)"
+    "fork:optimism": "hardhat node --fork $(grep OPTIMISM_URL .env | cut -d '=' -f2)",
+    "fork:arbitrum": "hardhat node --fork $(grep ARBITRUM_URL .env | cut -d '=' -f2)"
   },
   "husky": {
     "hooks": {

package/src/abi/IVelodromeGaugeV2.json

@@ -0,0 +1,191 @@
+{
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "user",
+          "type": "address"
+        }
+      ],
+      "name": "balanceOf",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "_amount",
+          "type": "uint256"
+        },
+        {
+          "internalType": "address",
+          "name": "_recipient",
+          "type": "address"
+        }
+      ],
+      "name": "deposit",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "_amount",
+          "type": "uint256"
+        }
+      ],
+      "name": "deposit",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "_account",
+          "type": "address"
+        }
+      ],
+      "name": "earned",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "_earned",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "_account",
+          "type": "address"
+        }
+      ],
+      "name": "getReward",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "isPool",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "_isPool",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "lastTimeRewardApplicable",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "_time",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "left",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "_left",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "amount",
+          "type": "uint256"
+        }
+      ],
+      "name": "notifyRewardAmount",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "rewardPerToken",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "_rewardPerToken",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "rewardToken",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "_token",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "stakingToken",
+      "outputs": [
+        {
+          "internalType": "address",
+          "name": "_pool",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "_amount",
+          "type": "uint256"
+        }
+      ],
+      "name": "withdraw",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    }
+  ]
+  
+}

package/src/config.ts

@@ -15,7 +15,8 @@ export const factoryAddress: AddressNetworkMap = {
   [Network.POLYGON]: process.env.STAGING_CONTRACTS
     ? "0xDd87eCdB10cFF7004276AAbAbd30e7a08F69bb53"
     : "0xfdc7b8bFe0DD3513Cc669bB8d601Cb83e2F69cB0",
-  [Network.OPTIMISM]: "0x5e61a079A178f0E5784107a4963baAe0c5a680c6"
+  [Network.OPTIMISM]: "0x5e61a079A178f0E5784107a4963baAe0c5a680c6",
+  [Network.ARBITRUM]: "0xfffb5fb14606eb3a548c113026355020ddf27535"
 };
 
 export const routerAddress: AddressDappNetworkMap = {
@@ -28,7 +29,8 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.BALANCER]: "0xBA12222222228d8Ba445958a75a0704d566BF2C8",
     [Dapp.UNISWAPV3]: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45",
     [Dapp.ARRAKIS]: "0xc73fb100a995b33f9fa181d420f4c8d74506df66",
-    [Dapp.TOROS]: "0xB2F1498983bf9c9442c35F772e6C1AdE66a8DeDE"
+    [Dapp.TOROS]: "0xB2F1498983bf9c9442c35F772e6C1AdE66a8DeDE",
+    [Dapp.ZEROEX]: "0xdef1c0ded9bec7f1a1670819833240f027b25eff"
   },
   [Network.OPTIMISM]: {
     [Dapp.UNISWAPV3]: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45",
@@ -37,8 +39,16 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.ONEINCH]: "0x1111111254EEB25477B68fb85Ed929f73A960582",
     [Dapp.TOROS]: "0x3988513793bCE39f0167064A9F7fC3617FaF35AB",
     [Dapp.VELODROME]: "0x9c12939390052919aF3155f41Bf4160Fd3666A6f",
+    [Dapp.VELODROMEV2]: "0xa062ae8a9c5e11aaa026fc2670b0d65ccc8b2858",
     [Dapp.LYRA]: "0xCCE7819d65f348c64B7Beb205BA367b3fE33763B",
-    [Dapp.ARRAKIS]: "0x9ce88a56d120300061593eF7AD074A1B710094d5"
+    [Dapp.ARRAKIS]: "0x9ce88a56d120300061593eF7AD074A1B710094d5",
+    [Dapp.ZEROEX]: "0xdef1abe32c034e558cdd535791643c58a13acc10"
+  },
+  [Network.ARBITRUM]: {
+    [Dapp.ONEINCH]: "0x1111111254EEB25477B68fb85Ed929f73A960582",
+    [Dapp.UNISWAPV3]: "0xe592427a0aece92de3edee1f18e0157c05861564",
+    [Dapp.AAVEV3]: "0x794a61358D6845594F94dc1DB02A252b5b4814aD",
+    [Dapp.BALANCER]: "0xBA12222222228d8Ba445958a75a0704d566BF2C8"
   }
 };
 
@@ -47,7 +57,8 @@ export const dappFactoryAddress: AddressDappNetworkMap = {
     [Dapp.SUSHISWAP]: "0xc35DADB65012eC5796536bD9864eD8773aBc74C4",
     [Dapp.QUICKSWAP]: "0x5757371414417b8C6CAad45bAeF941aBc7d3Ab32"
   },
-  [Network.OPTIMISM]: {}
+  [Network.OPTIMISM]: {},
+  [Network.ARBITRUM]: {}
 };
 
 export const stakingAddress: AddressDappNetworkMap = {
@@ -57,7 +68,8 @@ export const stakingAddress: AddressDappNetworkMap = {
     [Dapp.AAVE]: "0x357D51124f59836DeD84c8a1730D72B749d8BC23",
     [Dapp.AAVEV3]: "0x929EC64c34a17401F460460D4B9390518E5B473e"
   },
-  [Network.OPTIMISM]: {}
+  [Network.OPTIMISM]: {},
+  [Network.ARBITRUM]: {}
 };
 
 export const aaveAddressProvider: AddressDappNetworkMap = {
@@ -67,27 +79,34 @@ export const aaveAddressProvider: AddressDappNetworkMap = {
   },
   [Network.OPTIMISM]: {
     [Dapp.AAVEV3]: "0xa97684ead0e402dC232d5A977953DF7ECBaB3CDb"
+  },
+  [Network.ARBITRUM]: {
+    [Dapp.AAVEV3]: "0xa97684ead0e402dc232d5a977953df7ecbab3cdb"
   }
 };
 export const nonfungiblePositionManagerAddress: AddressNetworkMap = {
   [Network.POLYGON]: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88",
-  [Network.OPTIMISM]: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88"
+  [Network.OPTIMISM]: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88",
+  [Network.ARBITRUM]: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88"
 };
 
 export const networkChainIdMap: NetworkChainIdMap = {
   [Network.POLYGON]: 137,
-  [Network.OPTIMISM]: 10
+  [Network.OPTIMISM]: 10,
+  [Network.ARBITRUM]: 42161
 };
 
 export const balancerSubgraph: AddressNetworkMap = {
   [Network.POLYGON]:
     "https://api.thegraph.com/subgraphs/name/balancer-labs/balancer-polygon-v2",
-  [Network.OPTIMISM]: ""
+  [Network.OPTIMISM]: "",
+  [Network.ARBITRUM]: ""
 };
 
 export const multiCallAddress: AddressNetworkMap = {
   [Network.POLYGON]: "0x275617327c958bD06b5D6b871E7f491D76113dd8",
-  [Network.OPTIMISM]: ""
+  [Network.OPTIMISM]: "",
+  [Network.ARBITRUM]: ""
 };
 
 export const lyraNetworkMap: LyraNetworkMap = {

package/src/entities/pool.ts

@@ -59,6 +59,9 @@ import {
   getFuturesChangePositionTxData,
   getFuturesChangeMarginTxData
 } from "../services/futures";
+import { getFuturesCancelOrderTxData } from "../services/futures/trade";
+import { getZeroExTradeTxData } from "../services/zeroEx/zeroExTrade";
+import { ApiError } from "../errors";
 
 export class Pool {
   public readonly poolLogic: Contract;
@@ -285,16 +288,35 @@ 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:
         const chainId = networkChainIdMap[this.network];
         const protocols = await getOneInchProtocols(chainId);
-        const apiUrl = `https://api.1inch.exchange/v5.0/${chainId}/swap?fromTokenAddress=${assetFrom}&toTokenAddress=${assetTo}&amount=${amountIn.toString()}&fromAddress=${
+        if (!process.env.ONEINCH_API_URL)
+          throw new Error("ONEINCH_API_URL not configured in .env file");
+        const apiUrl = `${
+          process.env.ONEINCH_API_URL
+        }/${chainId}/swap?fromTokenAddress=${assetFrom}&toTokenAddress=${assetTo}&amount=${amountIn.toString()}&fromAddress=${
           this.address
         }&destReceiver=${
           this.address
         }&slippage=${slippage.toString()}&disableEstimate=true${protocols}`;
-        const response = await axios.get(apiUrl);
-        swapTxData = response.data.tx.data;
+        try {
+          const response = await axios.get(apiUrl);
+          swapTxData = response.data.tx.data;
+        } catch (e) {
+          throw new ApiError("Swap api request of 1inch failed");
+        }
+
         break;
       case Dapp.BALANCER:
         swapTxData = await this.utils.getBalancerSwapTx(
@@ -478,7 +500,10 @@ export class Pool {
         ]);
         break;
       case Dapp.VELODROME:
-        stakeTxData = getVelodromeStakeTxData(amount);
+        stakeTxData = getVelodromeStakeTxData(amount, false);
+        break;
+      case Dapp.VELODROMEV2:
+        stakeTxData = getVelodromeStakeTxData(amount, true);
         break;
       default:
         throw new Error("dapp not supported");
@@ -521,7 +546,7 @@ export class Pool {
   }
 
   /**
-   * Unstake liquidity pool tokens from gauge contract
+   * Unstake liquidity pool tokens from Velodrome or Balancer gauge
    * @param {string} gauge Gauge contract address
    * @param {BigNumber | string} amount Amount of liquidity pool tokens
    * @param {any} options Transaction options
@@ -1046,7 +1071,11 @@ export class Pool {
         break;
       case Dapp.VELODROME:
         contractAddress = tokenId;
-        txData = getVelodromeClaimTxData(this, tokenId);
+        txData = getVelodromeClaimTxData(this, tokenId, false);
+        break;
+      case Dapp.VELODROMEV2:
+        contractAddress = tokenId;
+        txData = getVelodromeClaimTxData(this, tokenId, true);
         break;
       default:
         throw new Error("dapp not supported");
@@ -1157,6 +1186,69 @@ export class Pool {
     return tx;
   }
 
+  /**
+   * Add liquidity to Velodrome V2 pool
+   * @param {string} assetA First asset
+   * @param {string} assetB Second asset
+   * @param {BigNumber | string} amountA Amount first asset
+   * @param {BigNumber | string} amountB Amount second asset
+   * @param { boolean } isStable Is stable pool
+   * @param {any} options Transaction options
+   * @returns {Promise<any>} Transaction
+   */
+  async addLiquidityVelodromeV2(
+    assetA: string,
+    assetB: string,
+    amountA: BigNumber | string,
+    amountB: BigNumber | string,
+    isStable: boolean,
+    options: any = null
+  ): Promise<any> {
+    const tx = await this.poolLogic.execTransaction(
+      routerAddress[this.network][Dapp.VELODROMEV2],
+      await getVelodromeAddLiquidityTxData(
+        this,
+        assetA,
+        assetB,
+        amountA,
+        amountB,
+        isStable
+      ),
+      options
+    );
+    return tx;
+  }
+
+  /**
+   * Remove liquidity from Velodrome V2 pool
+   * @param {string} assetA First asset
+   * @param {string} assetB Second asset
+   * @param {BigNumber | string} amount Amount of LP tokens
+   * @param { boolean } isStable Is stable pool
+   * @param {any} options Transaction options
+   * @returns {Promise<any>} Transaction
+   */
+  async removeLiquidityVelodromeV2(
+    assetA: string,
+    assetB: string,
+    amount: BigNumber | string,
+    isStable: boolean,
+    options: any = null
+  ): Promise<any> {
+    const tx = await this.poolLogic.execTransaction(
+      routerAddress[this.network][Dapp.VELODROMEV2],
+      await getVelodromeRemoveLiquidityTxData(
+        this,
+        assetA,
+        assetB,
+        amount,
+        isStable
+      ),
+      options
+    );
+    return tx;
+  }
+
   /**
    * Trade options on lyra
    * @param {LyraOptionMarket} market Underlying market e.g. eth
@@ -1251,4 +1343,16 @@ export class Pool {
     const tx = await this.poolLogic.execTransaction(market, txData, options);
     return tx;
   }
+
+  /** Cancels an open oder on Synthetix futures market
+   *
+   * @param {string} market Address of futures market
+   * @param {any} options Transaction options
+   * @returns {Promise<any>} Transaction
+   */
+  async cancelFuturesOrder(market: string, options: any = null): Promise<any> {
+    const txData = await getFuturesCancelOrderTxData(this);
+    const tx = await this.poolLogic.execTransaction(market, txData, options);
+    return tx;
+  }
 }

package/src/errors.ts

@@ -0,0 +1,10 @@
+// see https://stackoverflow.com/a/41102306
+const CAN_SET_PROTOTYPE = "setPrototypeOf" in Object;
+
+export class ApiError extends Error {
+  public constructor(message?: string) {
+    super(message ?? "Api request failed");
+    this.name = this.constructor.name;
+    if (CAN_SET_PROTOTYPE) Object.setPrototypeOf(this, new.target.prototype);
+  }
+}

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from "./entities";
 export * from "./types";
+export * from "./errors";
 export { ethers } from "ethers";

package/src/services/futures/trade.ts

@@ -24,3 +24,9 @@ export async function getFuturesChangePositionTxData(
     ethers.utils.formatBytes32String(FUTURES_TRACKING)
   ]);
 }
+
+export async function getFuturesCancelOrderTxData(pool: Pool): Promise<string> {
+  return new ethers.utils.Interface(
+    ISynthetixFuturesMarketV2.abi
+  ).encodeFunctionData("cancelOffchainDelayedOrder", [pool.address]);
+}

package/src/services/velodrome/staking.ts

@@ -1,31 +1,44 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { BigNumber, ethers } from "ethers";
-import IVelodromeGauge from "../../abi/IVelodromeGauge.json";
+import IVelodromeGaugeV1 from "../../abi/IVelodromeGauge.json";
+import IVelodromeGaugeV2 from "../../abi/IVelodromeGaugeV2.json";
 import { Pool } from "../../entities";
-import { Transaction } from "../../types";
 import { call } from "../../utils/contract";
-const iVelodromeGauge = new ethers.utils.Interface(IVelodromeGauge.abi);
+const iVelodromeGaugeV1 = new ethers.utils.Interface(IVelodromeGaugeV1.abi);
+const iVelodromeGaugeV2 = new ethers.utils.Interface(IVelodromeGaugeV2.abi);
 
-export function getVelodromeStakeTxData(amount: BigNumber | string): any {
-  return iVelodromeGauge.encodeFunctionData(Transaction.DEPOSIT, [amount, "0"]);
+export function getVelodromeStakeTxData(
+  amount: BigNumber | string,
+  v2: boolean
+): any {
+  const depositParams: [string, unknown[]] = v2
+    ? ["deposit(uint256)", [amount]]
+    : ["deposit", [amount, 0]];
+  const iVelodromeGauge = v2 ? iVelodromeGaugeV2 : iVelodromeGaugeV1;
+  return iVelodromeGauge.encodeFunctionData(...depositParams);
 }
 
 export async function getVelodromeClaimTxData(
   pool: Pool,
-  gauge: string
+  gauge: string,
+  v2: boolean
 ): Promise<any> {
-  const rewardAssetCount = await call(pool.signer, IVelodromeGauge.abi, [
-    gauge,
-    "rewardsListLength",
-    []
-  ]);
-  const rewardAssets = await Promise.all(
-    Array.from(Array(rewardAssetCount.toNumber()).keys()).map(e =>
-      call(pool.signer, IVelodromeGauge.abi, [gauge, "rewards", [e]])
-    )
-  );
-  return iVelodromeGauge.encodeFunctionData("getReward", [
-    pool.address,
-    rewardAssets
-  ]);
+  if (v2) {
+    return iVelodromeGaugeV2.encodeFunctionData("getReward", [pool.address]);
+  } else {
+    const rewardAssetCount = await call(pool.signer, IVelodromeGaugeV1.abi, [
+      gauge,
+      "rewardsListLength",
+      []
+    ]);
+    const rewardAssets = await Promise.all(
+      Array.from(Array(rewardAssetCount.toNumber()).keys()).map(e =>
+        call(pool.signer, IVelodromeGaugeV1.abi, [gauge, "rewards", [e]])
+      )
+    );
+    return iVelodromeGaugeV1.encodeFunctionData("getReward", [
+      pool.address,
+      rewardAssets
+    ]);
+  }
 }

package/src/services/zeroEx/zeroExTrade.ts

@@ -0,0 +1,52 @@
+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");
+  }
+};