@dhedge/v2-sdk 1.10.5 → 1.10.7

package/src/abi/compound/ICometRewards.json

@@ -0,0 +1,241 @@
+[
+  {
+    "inputs": [
+      { "internalType": "address", "name": "governor_", "type": "address" }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "inputs": [{ "internalType": "address", "name": "", "type": "address" }],
+    "name": "AlreadyConfigured",
+    "type": "error"
+  },
+  { "inputs": [], "name": "BadData", "type": "error" },
+  {
+    "inputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "name": "InvalidUInt64",
+    "type": "error"
+  },
+  {
+    "inputs": [{ "internalType": "address", "name": "", "type": "address" }],
+    "name": "NotPermitted",
+    "type": "error"
+  },
+  {
+    "inputs": [{ "internalType": "address", "name": "", "type": "address" }],
+    "name": "NotSupported",
+    "type": "error"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "", "type": "address" },
+      { "internalType": "uint256", "name": "", "type": "uint256" }
+    ],
+    "name": "TransferOutFailed",
+    "type": "error"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "oldGovernor",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "newGovernor",
+        "type": "address"
+      }
+    ],
+    "name": "GovernorTransferred",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "src",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "recipient",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "token",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "RewardClaimed",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "user",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "comet",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "RewardsClaimedSet",
+    "type": "event"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "comet", "type": "address" },
+      { "internalType": "address", "name": "src", "type": "address" },
+      { "internalType": "bool", "name": "shouldAccrue", "type": "bool" }
+    ],
+    "name": "claim",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "comet", "type": "address" },
+      { "internalType": "address", "name": "src", "type": "address" },
+      { "internalType": "address", "name": "to", "type": "address" },
+      { "internalType": "bool", "name": "shouldAccrue", "type": "bool" }
+    ],
+    "name": "claimTo",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "comet", "type": "address" },
+      { "internalType": "address", "name": "account", "type": "address" }
+    ],
+    "name": "getRewardOwed",
+    "outputs": [
+      {
+        "components": [
+          { "internalType": "address", "name": "token", "type": "address" },
+          { "internalType": "uint256", "name": "owed", "type": "uint256" }
+        ],
+        "internalType": "struct CometRewards.RewardOwed",
+        "name": "",
+        "type": "tuple"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "governor",
+    "outputs": [{ "internalType": "address", "name": "", "type": "address" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [{ "internalType": "address", "name": "", "type": "address" }],
+    "name": "rewardConfig",
+    "outputs": [
+      { "internalType": "address", "name": "token", "type": "address" },
+      { "internalType": "uint64", "name": "rescaleFactor", "type": "uint64" },
+      { "internalType": "bool", "name": "shouldUpscale", "type": "bool" },
+      { "internalType": "uint256", "name": "multiplier", "type": "uint256" }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "", "type": "address" },
+      { "internalType": "address", "name": "", "type": "address" }
+    ],
+    "name": "rewardsClaimed",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "comet", "type": "address" },
+      { "internalType": "address", "name": "token", "type": "address" }
+    ],
+    "name": "setRewardConfig",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "comet", "type": "address" },
+      { "internalType": "address", "name": "token", "type": "address" },
+      { "internalType": "uint256", "name": "multiplier", "type": "uint256" }
+    ],
+    "name": "setRewardConfigWithMultiplier",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "comet", "type": "address" },
+      { "internalType": "address[]", "name": "users", "type": "address[]" },
+      {
+        "internalType": "uint256[]",
+        "name": "claimedAmounts",
+        "type": "uint256[]"
+      }
+    ],
+    "name": "setRewardsClaimed",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "newGovernor", "type": "address" }
+    ],
+    "name": "transferGovernor",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      { "internalType": "address", "name": "token", "type": "address" },
+      { "internalType": "address", "name": "to", "type": "address" },
+      { "internalType": "uint256", "name": "amount", "type": "uint256" }
+    ],
+    "name": "withdrawToken",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  }
+]

package/src/config.ts

@@ -30,7 +30,7 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.BALANCER]: "0xBA12222222228d8Ba445958a75a0704d566BF2C8",
     [Dapp.UNISWAPV3]: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45",
     [Dapp.ARRAKIS]: "0xc73fb100a995b33f9fa181d420f4c8d74506df66",
-    [Dapp.TOROS]: "0xB2F1498983bf9c9442c35F772e6C1AdE66a8DeDE",
+    [Dapp.TOROS]: "0x45b90480D6F643dE2f128db091A357C3c90399f2",
     [Dapp.ZEROEX]: "0xdef1c0ded9bec7f1a1670819833240f027b25eff"
   },
   [Network.OPTIMISM]: {
@@ -38,7 +38,7 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.SYNTHETIX]: "0x8700dAec35aF8Ff88c16BdF0418774CB3D7599B4",
     [Dapp.AAVEV3]: "0x794a61358D6845594F94dc1DB02A252b5b4814aD",
     [Dapp.ONEINCH]: "0x111111125421ca6dc452d289314280a0f8842a65",
-    [Dapp.TOROS]: "0x3988513793bCE39f0167064A9F7fC3617FaF35AB",
+    [Dapp.TOROS]: "0x2Ed1bd7f66e47113672f3870308b5E867C5bb743",
     [Dapp.VELODROME]: "0x9c12939390052919aF3155f41Bf4160Fd3666A6f",
     [Dapp.VELODROMEV2]: "0xa062ae8a9c5e11aaa026fc2670b0d65ccc8b2858",
     [Dapp.LYRA]: "0xCCE7819d65f348c64B7Beb205BA367b3fE33763B",
@@ -51,13 +51,15 @@ export const routerAddress: AddressDappNetworkMap = {
     [Dapp.AAVEV3]: "0x794a61358D6845594F94dc1DB02A252b5b4814aD",
     [Dapp.BALANCER]: "0xBA12222222228d8Ba445958a75a0704d566BF2C8",
     [Dapp.RAMSES]: "0xaaa87963efeb6f7e0a2711f397663105acb1805e",
-    [Dapp.ZEROEX]: "0xdef1c0ded9bec7f1a1670819833240f027b25eff"
+    [Dapp.ZEROEX]: "0xdef1c0ded9bec7f1a1670819833240f027b25eff",
+    [Dapp.TOROS]: "0xA5679C4272A056Bb83f039961fae7D99C48529F5"
   },
   [Network.BASE]: {
     [Dapp.ONEINCH]: "0x111111125421ca6dc452d289314280a0f8842a65",
     [Dapp.ZEROEX]: "0xdef1c0ded9bec7f1a1670819833240f027b25eff",
     [Dapp.AERODROME]: "0xcF77a3Ba9A5CA399B7c97c74d54e5b1Beb874E43",
-    [Dapp.AAVEV3]: "0xA238Dd80C259a72e81d7e4664a9801593F98d1c5"
+    [Dapp.AAVEV3]: "0xA238Dd80C259a72e81d7e4664a9801593F98d1c5",
+    [Dapp.TOROS]: "0xf067575Eb60c7587C11e867907AA7284833704d1"
   }
 };
 
@@ -79,9 +81,12 @@ export const stakingAddress: AddressDappNetworkMap = {
     [Dapp.AAVEV3]: "0x929EC64c34a17401F460460D4B9390518E5B473e"
   },
   [Network.OPTIMISM]: {
-    [Dapp.AAVEV3]: "0x929EC64c34a17401F460460D4B9390518E5B473e"
+    [Dapp.AAVEV3]: "0x929EC64c34a17401F460460D4B9390518E5B473e",
+    [Dapp.COMPOUNDV3]: "0x443ea0340cb75a160f31a440722dec7b5bc3c2e9"
+  },
+  [Network.ARBITRUM]: {
+    [Dapp.COMPOUNDV3]: "0x88730d254a2f7e6ac8388c3198afd694ba9f7fae"
   },
-  [Network.ARBITRUM]: {},
   [Network.BASE]: {}
 };
 

package/src/entities/pool.ts

@@ -40,7 +40,10 @@ import {
   getUniswapV3MintTxData
 } from "../services/uniswap/V3Liquidity";
 import { getUniswapV3SwapTxData } from "../services/uniswap/V3Trade";
-import { getEasySwapperTxData } from "../services/toros/easySwapper";
+import {
+  getCompleteWithdrawalTxData,
+  getEasySwapperTxData
+} from "../services/toros/easySwapper";
 import { getAaveV3ClaimTxData } from "../services/aave/incentives";
 import {
   getVelodromeAddLiquidityTxData,
@@ -77,6 +80,7 @@ import {
   getCompoundV3LendTxData,
   getCompoundV3WithdrawTxData
 } from "../services/compound/lending";
+import { getCompoundV3ClaimTxData } from "../services/compound/rewards";
 
 export class Pool {
   public readonly poolLogic: Contract;
@@ -371,13 +375,13 @@ export class Pool {
         );
         break;
       case Dapp.ONEINCH:
-        swapTxData = await getOneInchSwapTxData(
+        ({ swapTxData } = await getOneInchSwapTxData(
           this,
           assetFrom,
           assetTo,
           amountIn,
           slippage
-        );
+        ));
         break;
       case Dapp.BALANCER:
         swapTxData = await this.utils.getBalancerSwapTx(
@@ -1037,6 +1041,31 @@ export class Pool {
     return tx;
   }
 
+  /**
+   * Claim rewards from CompoundV3
+   * @param {string} asset Compound lending asset
+   * @param {any} options Transaction options
+   * @param {boolean} estimateGas Simulate/estimate gas
+   * @returns {Promise<any>} Transaction
+   */
+  async harvestCompoundV3Rewards(
+    asset: string,
+    options: any = null,
+    estimateGas = false
+  ): Promise<any> {
+    const claimTxData = await getCompoundV3ClaimTxData(this, asset);
+    const tx = await getPoolTxOrGasEstimate(
+      this,
+      [
+        stakingAddress[this.network][Dapp.COMPOUNDV3] as string,
+        claimTxData,
+        options
+      ],
+      estimateGas
+    );
+    return tx;
+  }
+
   /**
    * Create UniswapV3 liquidity pool
    * @param {dapp} Platform UniswapV3, VelodromeCL, AerodromeCL or RamesesCL
@@ -1842,4 +1871,31 @@ export class Pool {
     const tx = await cancelOrderViaFlatMoney(this, options, estimateGas);
     return tx;
   }
+
+  /**
+   * Complete a Toros withdrawal to a single asset
+   * @param {string} destinationToken Address of destination asset
+   * @param {number} slippage Slippage tolerance in %
+   * @param {any} options Transaction options
+   * @param {boolean} estimateGas Simulate/estimate gas
+   * @returns {Promise<any>} Transaction
+   */
+  async completeTorosWithdrawal(
+    destinationToken: string,
+    slippage = 0.5,
+    options: any = null,
+    estimateGas = false
+  ): Promise<any> {
+    const txData = await getCompleteWithdrawalTxData(
+      this,
+      destinationToken,
+      slippage
+    );
+    const tx = await getPoolTxOrGasEstimate(
+      this,
+      [routerAddress[this.network].toros, txData, options],
+      estimateGas
+    );
+    return tx;
+  }
 }

package/src/services/compound/rewards.ts

@@ -0,0 +1,9 @@
+import { ethers } from "ethers";
+import ICometRewards from "../../abi/compound/ICometRewards.json";
+import { Pool } from "../..";
+
+export function getCompoundV3ClaimTxData(pool: Pool, asset: string): string {
+  const iCometRewards = new ethers.utils.Interface(ICometRewards);
+
+  return iCometRewards.encodeFunctionData("claim", [asset, pool.address, true]);
+}

package/src/services/oneInch/index.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import axios from "axios";
 import { ApiError, ethers } from "../..";
-import { networkChainIdMap } from "../../config";
+import { networkChainIdMap, routerAddress } from "../../config";
 import { Pool } from "../../entities";
 
 const oneInchBaseUrl = "https://api.1inch.dev/swap/v6.0/";
@@ -11,8 +11,9 @@ export async function getOneInchSwapTxData(
   assetFrom: string,
   assetTo: string,
   amountIn: ethers.BigNumber | string,
-  slippage: number
-): Promise<string> {
+  slippage: number,
+  forEasySwapper = false
+): Promise<{ swapTxData: string; dstAmount: string }> {
   if (!process.env.ONEINCH_API_KEY)
     throw new Error("ONEINCH_API_KEY not configured in .env file");
 
@@ -22,8 +23,8 @@ export async function getOneInchSwapTxData(
     src: assetFrom,
     dst: assetTo,
     amount: amountIn.toString(),
-    from: pool.address,
-    origin: pool.signer.address,
+    from: forEasySwapper ? routerAddress[pool.network].toros : pool.address,
+    receiver: forEasySwapper ? routerAddress[pool.network].toros : pool.address,
     slippage: slippage,
     disableEstimate: true,
     usePermit2: false
@@ -35,7 +36,9 @@ export async function getOneInchSwapTxData(
       },
       params
     });
-    return response.data.tx.data;
+    const swapTxData = response.data.tx.data;
+    const dstAmount = response.data.dstAmount;
+    return { swapTxData, dstAmount };
   } catch (e) {
     throw new ApiError("Swap api request of 1inch failed");
   }

package/src/services/toros/easySwapper.ts

@@ -5,6 +5,8 @@ import IDhedgeEasySwapper from "../../abi/IDhedgeEasySwapper.json";
 import { routerAddress } from "../../config";
 import { getChainlinkPriceInUsd } from "../chainLink/price";
 import { isPool, loadPool } from "./pool";
+import { getOneInchSwapTxData } from "../oneInch";
+import { wait } from "../../test/utils/testingHelper";
 
 export async function getPoolDepositAsset(
   pool: Pool,
@@ -33,22 +35,15 @@ export async function getEasySwapperDepositQuote(
   pool: Pool,
   torosAsset: string,
   investAsset: string,
-  depositAsset: string,
   amountIn: ethers.BigNumber
 ): Promise<ethers.BigNumber> {
   const easySwapper = new ethers.Contract(
     routerAddress[pool.network][Dapp.TOROS] as string,
-    IDhedgeEasySwapper.abi,
+    IDhedgeEasySwapper,
     pool.signer
   );
 
-  return await easySwapper.depositQuote(
-    torosAsset,
-    investAsset,
-    amountIn,
-    depositAsset,
-    true
-  );
+  return await easySwapper.depositQuote(torosAsset, investAsset, amountIn);
 }
 
 export async function getEasySwapperWithdrawalQuote(
@@ -82,19 +77,12 @@ export async function getEasySwapperTxData(
   const [torosAsset, investAsset] = isWithdrawal
     ? [assetFrom, assetTo]
     : [assetTo, assetFrom];
-  const iDhedgeEasySwapper = new ethers.utils.Interface(IDhedgeEasySwapper.abi);
+  const iDhedgeEasySwapper = new ethers.utils.Interface(IDhedgeEasySwapper);
   if (isWithdrawal) {
-    const minAmountOut = await getEasySwapperWithdrawalQuote(
-      pool,
-      torosAsset,
-      investAsset,
-      amountIn
-    );
-    return iDhedgeEasySwapper.encodeFunctionData("withdraw", [
+    return iDhedgeEasySwapper.encodeFunctionData("initWithdrawal", [
       torosAsset,
       amountIn,
-      investAsset,
-      minAmountOut.mul(10000 - slippage * 100).div(10000)
+      slippage * 100
     ]);
   } else {
     const depositAsset = await getPoolDepositAsset(
@@ -103,19 +91,73 @@ export async function getEasySwapperTxData(
       investAsset
     );
     if (!depositAsset) throw new Error("no deposit assets");
+    if (depositAsset.toLowerCase() !== investAsset.toLowerCase())
+      throw new Error("can only trade deposit asset");
     const minAmountOut = await getEasySwapperDepositQuote(
       pool,
       torosAsset,
       investAsset,
-      depositAsset,
       amountIn
     );
     return iDhedgeEasySwapper.encodeFunctionData("depositWithCustomCooldown", [
       torosAsset,
-      investAsset,
-      amountIn,
       depositAsset,
+      amountIn,
       minAmountOut.mul(10000 - slippage * 100).div(10000)
     ]);
   }
 }
+
+export async function getCompleteWithdrawalTxData(
+  pool: Pool,
+  destToken: string,
+  slippage: number
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+): Promise<string> {
+  const easySwapper = new ethers.Contract(
+    routerAddress[pool.network][Dapp.TOROS] as string,
+    IDhedgeEasySwapper,
+    pool.signer
+  );
+  const trackedAssets: {
+    token: string;
+    balance: ethers.BigNumber;
+  }[] = await easySwapper.getTrackedAssets(pool.address);
+  const trackedAssetsExcludingDestToken = trackedAssets.filter(
+    ({ token }) => token.toLowerCase() !== destToken.toLowerCase()
+  );
+
+  const srcData = [];
+  let minDestAmount = ethers.BigNumber.from(0);
+  for (const { token, balance } of trackedAssetsExcludingDestToken) {
+    const { swapTxData, dstAmount } = await getOneInchSwapTxData(
+      pool,
+      token,
+      destToken,
+      balance,
+      slippage,
+      true
+    );
+    srcData.push({
+      token,
+      amount: balance,
+      aggregatorData: {
+        routerKey: ethers.utils.formatBytes32String("ONE_INCH"),
+        swapData: swapTxData
+      }
+    });
+    minDestAmount = minDestAmount.add(dstAmount);
+    await wait(2);
+  }
+
+  return easySwapper.interface.encodeFunctionData("completeWithdrawal", [
+    {
+      srcData,
+      destData: {
+        destToken,
+        minDestAmount
+      }
+    },
+    minDestAmount.mul(10000 - slippage * 100).div(10000)
+  ]);
+}

package/src/test/compoundV3.test.ts

@@ -81,6 +81,10 @@ const testCompoundV3 = ({ network, provider }: TestingRunParams) => {
       const wethBalance = await balanceDelta(pool.address, WETH, pool.signer);
       expect(wethBalance.gt(0));
     });
+
+    it("harvests rewards from CompundV3", async () => {
+      await pool.harvestCompoundV3Rewards(COMPOUNDV3_WETH);
+    });
   });
 };
 

package/src/test/constants.ts

@@ -49,6 +49,7 @@ export const CONTRACT_ADDRESS = {
   [Network.POLYGON]: {
     USDC: "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
     USDT: "",
+    SUSD: "",
     SWETH: "",
     WETH: "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619",
     WBTC: "0x1BFD67037B42Cf73acF2047067bd4F2C47D9BfD6",
@@ -60,7 +61,8 @@ export const CONTRACT_ADDRESS = {
     },
     VELODROME_CL_USDC_WETH_GAUGE: "",
     VELO: "",
-    COMPOUNDV3_WETH: ""
+    COMPOUNDV3_WETH: "",
+    TOROS: ""
   },
 
   [Network.OPTIMISM]: {
@@ -81,11 +83,13 @@ export const CONTRACT_ADDRESS = {
     ARRAKIS_USDC_WETH_LP: "",
     VELODROME_CL_USDC_WETH_GAUGE: "0xa75127121d28a9BF848F3B70e7Eea26570aa7700",
     VELO: "0x9560e827aF36c94D2Ac33a39bCE1Fe78631088Db",
-    COMPOUNDV3_WETH: ""
+    COMPOUNDV3_WETH: "",
+    TOROS: "0x49bf093277bf4dde49c48c6aa55a3bda3eedef68" //USDmny
   },
   [Network.ARBITRUM]: {
     USDC: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
     USDT: "",
+    SUSD: "",
     SWETH: "0xbc011A12Da28e8F0f528d9eE5E7039E22F91cf18",
     WETH: "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
     WBTC: "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",
@@ -103,11 +107,13 @@ export const CONTRACT_ADDRESS = {
     WMATIC: "",
     VELODROME_CL_USDC_WETH_GAUGE: "",
     VELO: "",
-    COMPOUNDV3_WETH: "0x6f7D514bbD4aFf3BcD1140B7344b32f063dEe486"
+    COMPOUNDV3_WETH: "0x6f7D514bbD4aFf3BcD1140B7344b32f063dEe486",
+    TOROS: ""
   },
   [Network.BASE]: {
     USDC: "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
     USDT: "0xfde4c96c8593536e31f229ea8f37b2ada2699bb2",
+    SUSD: "",
     WETH: "0x4200000000000000000000000000000000000006",
     WBTC: "",
     SWETH: "",
@@ -120,7 +126,8 @@ export const CONTRACT_ADDRESS = {
     WMATIC: "",
     VELODROME_CL_USDC_WETH_GAUGE: "0xF33a96b5932D9E9B9A0eDA447AbD8C9d48d2e0c8",
     VELO: "0x940181a94A35A4569E4529A3CDfB74e38FD98631",
-    COMPOUNDV3_WETH: ""
+    COMPOUNDV3_WETH: "",
+    TOROS: ""
   }
 };