@dhedge/v2-sdk 1.10.6 → 1.10.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhedge/v2-sdk",
-  "version": "1.10.6",
+  "version": "1.10.7",
   "license": "MIT",
   "description": "🛠 An SDK for building applications on top of dHEDGE V2",
   "main": "dist/index.js",

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

@@ -81,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

@@ -80,6 +80,7 @@ import {
   getCompoundV3LendTxData,
   getCompoundV3WithdrawTxData
 } from "../services/compound/lending";
+import { getCompoundV3ClaimTxData } from "../services/compound/rewards";
 
 export class Pool {
   public readonly poolLogic: Contract;
@@ -1040,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

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/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/types.ts

@@ -27,7 +27,8 @@ export enum Dapp {
   RAMSES = "ramses",
   AERODROME = "aerodrome",
   AERODROMECL = "aerodromeCL",
-  RAMSESCL = "ramsesCL"
+  RAMSESCL = "ramsesCL",
+  COMPOUNDV3 = "compoundV3"
 }
 
 export enum Transaction {