@dhedge/v2-sdk 1.9.3 → 1.9.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhedge/v2-sdk",
-  "version": "1.9.3",
+  "version": "1.9.5",
   "license": "MIT",
   "description": "🛠 An SDK for building applications on top of dHEDGE V2",
   "main": "dist/index.js",
@@ -22,7 +22,8 @@
     "analyze": "size-limit --why",
     "fork:polygon": "hardhat node --port 8542 --fork $(grep POLYGON_URL .env | cut -d '=' -f2)",
     "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: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)"
   },
   "husky": {
     "hooks": {

package/src/abi/IXRam.json

@@ -0,0 +1,99 @@
+{ "abi": [
+	{
+		"inputs": [
+			{
+				"internalType": "uint256",
+				"name": "_amount",
+				"type": "uint256"
+			}
+		],
+		"name": "createVest",
+		"outputs": [],
+		"stateMutability": "nonpayable",
+		"type": "function"
+	},
+	{
+		"inputs": [
+			{
+				"internalType": "uint256",
+				"name": "_vestID",
+				"type": "uint256"
+			},
+			{
+				"internalType": "bool",
+				"name": "_ve",
+				"type": "bool"
+			}
+		],
+		"name": "exitVest",
+		"outputs": [
+			{
+				"internalType": "bool",
+				"name": "",
+				"type": "bool"
+			}
+		],
+		"stateMutability": "nonpayable",
+		"type": "function"
+	},
+	{
+		"inputs": [
+			{
+				"internalType": "address",
+				"name": "_user",
+				"type": "address"
+			}
+		],
+		"name": "usersTotalVests",
+		"outputs": [
+			{
+				"internalType": "uint256",
+				"name": "",
+				"type": "uint256"
+			}
+		],
+		"stateMutability": "view",
+		"type": "function"
+	},
+	{
+		"inputs": [
+			{
+				"internalType": "address",
+				"name": "user",
+				"type": "address"
+			}
+		],
+		"name": "vestInfo",
+		"outputs": [
+			{
+				"components": [
+					{
+						"internalType": "uint256",
+						"name": "amount",
+						"type": "uint256"
+					},
+					{
+						"internalType": "uint256",
+						"name": "start",
+						"type": "uint256"
+					},
+					{
+						"internalType": "uint256",
+						"name": "maxEnd",
+						"type": "uint256"
+					},
+					{
+						"internalType": "uint256",
+						"name": "vestID",
+						"type": "uint256"
+					}
+				],
+				"internalType": "struct IXRam.VestPosition[]",
+				"name": "",
+				"type": "tuple[]"
+			}
+		],
+		"stateMutability": "view",
+		"type": "function"
+	}
+]}

package/src/config.ts

@@ -16,7 +16,8 @@ export const factoryAddress: AddressNetworkMap = {
     ? "0xDd87eCdB10cFF7004276AAbAbd30e7a08F69bb53"
     : "0xfdc7b8bFe0DD3513Cc669bB8d601Cb83e2F69cB0",
   [Network.OPTIMISM]: "0x5e61a079A178f0E5784107a4963baAe0c5a680c6",
-  [Network.ARBITRUM]: "0xfffb5fb14606eb3a548c113026355020ddf27535"
+  [Network.ARBITRUM]: "0xfffb5fb14606eb3a548c113026355020ddf27535",
+  [Network.BASE]: "0x49Afe3abCf66CF09Fab86cb1139D8811C8afe56F"
 };
 
 export const routerAddress: AddressDappNetworkMap = {
@@ -48,7 +49,12 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.ONEINCH]: "0x1111111254EEB25477B68fb85Ed929f73A960582",
     [Dapp.UNISWAPV3]: "0xe592427a0aece92de3edee1f18e0157c05861564",
     [Dapp.AAVEV3]: "0x794a61358D6845594F94dc1DB02A252b5b4814aD",
-    [Dapp.BALANCER]: "0xBA12222222228d8Ba445958a75a0704d566BF2C8"
+    [Dapp.BALANCER]: "0xBA12222222228d8Ba445958a75a0704d566BF2C8",
+    [Dapp.RAMSES]: "0xaaa87963efeb6f7e0a2711f397663105acb1805e"
+  },
+  [Network.BASE]: {
+    [Dapp.ONEINCH]: "0x1111111254EEB25477B68fb85Ed929f73A960582",
+    [Dapp.ZEROEX]: "0xdef1c0ded9bec7f1a1670819833240f027b25eff"
   }
 };
 
@@ -58,7 +64,8 @@ export const dappFactoryAddress: AddressDappNetworkMap = {
     [Dapp.QUICKSWAP]: "0x5757371414417b8C6CAad45bAeF941aBc7d3Ab32"
   },
   [Network.OPTIMISM]: {},
-  [Network.ARBITRUM]: {}
+  [Network.ARBITRUM]: {},
+  [Network.BASE]: {}
 };
 
 export const stakingAddress: AddressDappNetworkMap = {
@@ -69,7 +76,8 @@ export const stakingAddress: AddressDappNetworkMap = {
     [Dapp.AAVEV3]: "0x929EC64c34a17401F460460D4B9390518E5B473e"
   },
   [Network.OPTIMISM]: {},
-  [Network.ARBITRUM]: {}
+  [Network.ARBITRUM]: {},
+  [Network.BASE]: {}
 };
 
 export const aaveAddressProvider: AddressDappNetworkMap = {
@@ -82,31 +90,40 @@ export const aaveAddressProvider: AddressDappNetworkMap = {
   },
   [Network.ARBITRUM]: {
     [Dapp.AAVEV3]: "0xa97684ead0e402dc232d5a977953df7ecbab3cdb"
+  },
+  [Network.BASE]: {
+    // https://docs.aave.com/developers/deployed-contracts/v3-mainnet/base
+    [Dapp.AAVEV3]: "0xe20fCBdBfFC4Dd138cE8b2E6FBb6CB49777ad64D"
   }
 };
 export const nonfungiblePositionManagerAddress: AddressNetworkMap = {
   [Network.POLYGON]: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88",
   [Network.OPTIMISM]: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88",
-  [Network.ARBITRUM]: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88"
+  [Network.ARBITRUM]: "0xC36442b4a4522E871399CD717aBDD847Ab11FE88",
+  // https://docs.uniswap.org/contracts/v3/reference/deployments
+  [Network.BASE]: "0x03a520b32C04BF3bEEf7BEb72E919cf822Ed34f1"
 };
 
 export const networkChainIdMap: NetworkChainIdMap = {
   [Network.POLYGON]: 137,
   [Network.OPTIMISM]: 10,
-  [Network.ARBITRUM]: 42161
+  [Network.ARBITRUM]: 42161,
+  [Network.BASE]: 8453
 };
 
 export const balancerSubgraph: AddressNetworkMap = {
   [Network.POLYGON]:
     "https://api.thegraph.com/subgraphs/name/balancer-labs/balancer-polygon-v2",
   [Network.OPTIMISM]: "",
-  [Network.ARBITRUM]: ""
+  [Network.ARBITRUM]: "",
+  [Network.BASE]: ""
 };
 
 export const multiCallAddress: AddressNetworkMap = {
   [Network.POLYGON]: "0x275617327c958bD06b5D6b871E7f491D76113dd8",
   [Network.OPTIMISM]: "",
-  [Network.ARBITRUM]: ""
+  [Network.ARBITRUM]: "",
+  [Network.BASE]: ""
 };
 
 export const lyraNetworkMap: LyraNetworkMap = {

package/src/entities/pool.ts

@@ -59,6 +59,10 @@ import {
 import { getFuturesCancelOrderTxData } from "../services/futures/trade";
 import { getZeroExTradeTxData } from "../services/zeroEx/zeroExTrade";
 import { getOneInchSwapTxData } from "../services/oneInch";
+import {
+  getCreateVestTxData,
+  getExitVestTxData
+} from "../services/ramses/vesting";
 
 export class Pool {
   public readonly poolLogic: Contract;
@@ -486,6 +490,7 @@ export class Pool {
         ]);
         break;
       case Dapp.VELODROME:
+      case Dapp.RAMSES:
         stakeTxData = getVelodromeStakeTxData(amount, false);
         break;
       case Dapp.VELODROMEV2:
@@ -1056,6 +1061,7 @@ export class Pool {
         txData = abi.encodeFunctionData("claim_rewards()", []);
         break;
       case Dapp.VELODROME:
+      case Dapp.RAMSES:
         contractAddress = tokenId;
         txData = getVelodromeClaimTxData(this, tokenId, false);
         break;
@@ -1235,6 +1241,73 @@ export class Pool {
     return tx;
   }
 
+  /**
+   * Add liquidity to Velodrome V2 or Ramses pool
+   * @param {Dapp} dapp VelodromeV2 or Ramses
+   * @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 addLiquidityV2(
+    dapp: Dapp.VELODROMEV2 | Dapp.RAMSES,
+    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],
+      await getVelodromeAddLiquidityTxData(
+        this,
+        assetA,
+        assetB,
+        amountA,
+        amountB,
+        isStable
+      ),
+      options
+    );
+    return tx;
+  }
+
+  /**
+   * Remove liquidity from Velodrome V2 or Ramses pool
+   * @param {Dapp} dapp VelodromeV2 or Ramses
+   * @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 removeLiquidityV2(
+    dapp: Dapp.VELODROMEV2 | Dapp.RAMSES,
+    assetA: string,
+    assetB: string,
+    amount: BigNumber | string,
+    isStable: boolean,
+    options: any = null
+  ): Promise<any> {
+    const tx = await this.poolLogic.execTransaction(
+      routerAddress[this.network][dapp],
+      await getVelodromeRemoveLiquidityTxData(
+        this,
+        assetA,
+        assetB,
+        amount,
+        isStable
+      ),
+      options
+    );
+    return tx;
+  }
+
   /**
    * Trade options on lyra
    * @param {LyraOptionMarket} market Underlying market e.g. eth
@@ -1360,4 +1433,46 @@ export class Pool {
     const fee = await this.poolLogic.availableManagerFee();
     return BigNumber.from(fee);
   }
+
+  /** Vest tokens (e.g. Ramses xoRAM)
+   *
+   * @param {string} tokenAddress Address of the token to vest
+   * @param {BigNumber | string } changeAmount Negative for short, positive for long
+   * @param {any} options Transaction options
+   * @returns {Promise<any>} Transaction
+   */
+  async vestTokens(
+    tokenAddress: string,
+    amount: BigNumber | string,
+    options: any = null
+  ): Promise<any> {
+    const txData = await getCreateVestTxData(amount);
+    const tx = await this.poolLogic.execTransaction(
+      tokenAddress,
+      txData,
+      options
+    );
+    return tx;
+  }
+
+  /** Exit position of vested tokens (e.g. Ramses xoRAM)
+   *
+   * @param {string} tokenAddress Address of the token to vest
+   * @param {number } id position Id of the vested tokens
+   * @param {any} options Transaction options
+   * @returns {Promise<any>} Transaction
+   */
+  async exitVestedToken(
+    tokenAddress: string,
+    id: number,
+    options: any = null
+  ): Promise<any> {
+    const txData = await getExitVestTxData(id);
+    const tx = await this.poolLogic.execTransaction(
+      tokenAddress,
+      txData,
+      options
+    );
+    return tx;
+  }
 }

package/src/services/ramses/vesting.ts

@@ -0,0 +1,13 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { BigNumber, ethers } from "ethers";
+import IXRam from "../../abi/IXRam.json";
+
+const iXRam = new ethers.utils.Interface(IXRam.abi);
+
+export function getCreateVestTxData(amount: BigNumber | string): string {
+  return iXRam.encodeFunctionData("createVest", [amount]);
+}
+
+export function getExitVestTxData(vestId: number): string {
+  return iXRam.encodeFunctionData("exitVest", [vestId, false]);
+}

package/src/test/constants.ts

@@ -41,12 +41,14 @@ export const KWENTA_ETH_PERP_V2 = "0x2b3bb4c683bfc5239b029131eef3b1d214478d93";
 export const TEST_POOL = {
   [Network.POLYGON]: "0x699fd4d6eadb216704c7e355cfa0a12f51813163",
   [Network.OPTIMISM]: "0x12573bfdf764ab9d52aca20e2827497a66829716",
-  [Network.ARBITRUM]: "0x2dc2f936c8b6619facc69355d65dd93d2f4cc2bd"
+  [Network.ARBITRUM]: "0x2dc2f936c8b6619facc69355d65dd93d2f4cc2bd",
+  [Network.BASE]: "0x4842b42F68524383F609aa46eAfc18c1459cE3cD"
 };
 
 export const CONTRACT_ADDRESS = {
   [Network.POLYGON]: {
     USDC: "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
+    SWETH: "",
     WETH: "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619",
     WBTC: "0x1BFD67037B42Cf73acF2047067bd4F2C47D9BfD6",
     ARRAKIS_USDC_WETH_GAUGE: "0x33d1ad9Cd88A509397CD924C2d7613C285602C20",
@@ -55,18 +57,33 @@ export const CONTRACT_ADDRESS = {
   [Network.OPTIMISM]: {
     USDC: "0x7F5c764cBc14f9669B88837ca1490cCa17c31607",
     SUSD: "0x8c6f28f2f1a3c87f0f938b96d27520d9751ec8d9",
+    SWETH: "",
     WETH: "0x4200000000000000000000000000000000000006",
     WBTC: "0x68f180fcCe6836688e9084f035309E29Bf0A2095",
     KWENTA_ETH_PERP_V2: "0x2b3bb4c683bfc5239b029131eef3b1d214478d93"
   },
   [Network.ARBITRUM]: {
-    USDC: "0xff970a61a04b1ca14834a43f5de4533ebddb5cc8",
+    USDC: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
+    SWETH: "0xbc011A12Da28e8F0f528d9eE5E7039E22F91cf18",
     WETH: "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
     WBTC: "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",
     WSTETH: "0x5979d7b546e38e414f7e9822514be443a4800529",
     BALANCER_WSTETH_WETH_POOL: "0x36bf227d6bac96e2ab1ebb5492ecec69c691943f",
     BALANCER_WSTETH_WETH_GAUGE: "0x251e51b25afa40f2b6b9f05aaf1bc7eaa0551771"
+  },
+  [Network.BASE]: {
+    USDC: "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
+    WETH: "0x4200000000000000000000000000000000000006",
+    WBTC: "",
+    SWETH: ""
   }
 };
 
 export const MAX_AMOUNT = ethers.constants.MaxUint256;
+
+export const USDC_BALANCEOF_SLOT = {
+  [Network.OPTIMISM]: 0,
+  [Network.ARBITRUM]: 9,
+  [Network.POLYGON]: 0,
+  [Network.BASE]: 9
+};

package/src/test/lyra.test.ts

@@ -6,6 +6,7 @@ import { getTxOptions } from "./txOptions";
 import { wallet } from "./wallet";
 
 jest.setTimeout(100000);
+const TEST_POOL_OP = TEST_POOL.optimism;
 
 describe("pool", () => {
   let dhedge: Dhedge;
@@ -16,7 +17,7 @@ describe("pool", () => {
 
   it("buys 0.1 1400 calls with expiry October 28th", async () => {
     let result;
-    const pool = await dhedge.loadPool(TEST_POOL);
+    const pool = await dhedge.loadPool(TEST_POOL_OP);
     try {
       result = await pool.tradeLyraOption(
         "eth",
@@ -37,7 +38,7 @@ describe("pool", () => {
 
   it("adds 0.05 1400 calls with expiry October 28th", async () => {
     let result;
-    const pool = await dhedge.loadPool(TEST_POOL);
+    const pool = await dhedge.loadPool(TEST_POOL_OP);
     try {
       result = await pool.tradeLyraOption(
         "eth",
@@ -61,7 +62,7 @@ describe("pool", () => {
 
   it("sells 0.1 1300 Covered Call with expiry October 28th", async () => {
     let result;
-    const pool = await dhedge.loadPool(TEST_POOL);
+    const pool = await dhedge.loadPool(TEST_POOL_OP);
     try {
       result = await pool.tradeLyraOption(
         "eth",
@@ -86,7 +87,7 @@ describe("pool", () => {
 
   it("adds 0.05 1300 Covered Call with expiry October 28th", async () => {
     let result;
-    const pool = await dhedge.loadPool(TEST_POOL);
+    const pool = await dhedge.loadPool(TEST_POOL_OP);
     try {
       result = await pool.tradeLyraOption(
         "eth",
@@ -113,7 +114,7 @@ describe("pool", () => {
 
   it("closes all 0.15 1300 Covered Call with expiry October 28th", async () => {
     let result;
-    const pool = await dhedge.loadPool(TEST_POOL);
+    const pool = await dhedge.loadPool(TEST_POOL_OP);
     try {
       result = await pool.tradeLyraOption(
         "eth",
@@ -138,7 +139,7 @@ describe("pool", () => {
 
   it("closes all 0.15 1400 Calls with expiry October 28th", async () => {
     let result;
-    const pool = await dhedge.loadPool(TEST_POOL);
+    const pool = await dhedge.loadPool(TEST_POOL_OP);
     try {
       result = await pool.tradeLyraOption(
         "eth",

package/src/test/oneInch.test.ts

@@ -1,12 +1,18 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
+import BigNumber from "bignumber.js";
 import { Dhedge, Pool } from "..";
 import { routerAddress } from "../config";
 import { Dapp, Network } from "../types";
 import { CONTRACT_ADDRESS, MAX_AMOUNT, TEST_POOL } from "./constants";
-import { TestingRunParams, testingHelper } from "./utils/testingHelper";
+import {
+  TestingRunParams,
+  setUSDCAmount,
+  testingHelper
+} from "./utils/testingHelper";
 import { allowanceDelta, balanceDelta } from "./utils/token";
+import { getTxOptions } from "./txOptions";
 
-const testOneInch = ({ wallet, network }: TestingRunParams) => {
+const testOneInch = ({ wallet, network, provider }: TestingRunParams) => {
   const USDC = CONTRACT_ADDRESS[network].USDC;
   const WETH = CONTRACT_ADDRESS[network].WETH;
 
@@ -18,6 +24,19 @@ const testOneInch = ({ wallet, network }: TestingRunParams) => {
     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(100).times(1e18).toFixed(0),
+        userAddress: pool.address,
+        network,
+        provider
+      });
     });
 
     it("approves unlimited USDC on 1Inch", async () => {
@@ -32,7 +51,14 @@ const testOneInch = ({ wallet, network }: TestingRunParams) => {
     });
 
     it("trades 2 USDC into WETH on 1Inch", async () => {
-      await pool.trade(Dapp.ONEINCH, USDC, WETH, "2000000", 0.5);
+      await pool.trade(
+        Dapp.ONEINCH,
+        USDC,
+        WETH,
+        "2000000",
+        0.5,
+        await getTxOptions(network)
+      );
       const wethBalanceDelta = await balanceDelta(
         pool.address,
         WETH,
@@ -52,3 +78,8 @@ testingHelper({
   network: Network.POLYGON,
   testingRun: testOneInch
 });
+
+testingHelper({
+  network: Network.BASE,
+  testingRun: testOneInch
+});