@dhedge/v2-sdk 1.10.6 → 1.10.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhedge/v2-sdk",
-  "version": "1.10.6",
+  "version": "1.10.8",
   "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.19.3",
+    "hardhat": "2.22.18",
     "husky": "^7.0.1",
     "jest": "^28.1.3",
     "size-limit": "^5.0.1",

package/src/abi/INonfungiblePositionManager.json

@@ -822,34 +822,6 @@
       "stateMutability": "nonpayable",
       "type": "function"
     },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "from",
-          "type": "address"
-        },
-        {
-          "internalType": "address",
-          "name": "to",
-          "type": "address"
-        },
-        {
-          "internalType": "uint256",
-          "name": "tokenId",
-          "type": "uint256"
-        },
-        {
-          "internalType": "bytes",
-          "name": "_data",
-          "type": "bytes"
-        }
-      ],
-      "name": "safeTransferFrom",
-      "outputs": [],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
     {
       "inputs": [
         {

package/src/abi/IPancakeMasterChefV3.json

@@ -0,0 +1,115 @@
+[
+	{
+		"inputs": [
+			{
+				"internalType": "uint256",
+				"name": "tokenId",
+				"type": "uint256"
+			},
+			{
+				"internalType": "address",
+				"name": "to",
+				"type": "address"
+			}
+		],
+		"name": "harvest",
+		"outputs": [
+			{
+				"internalType": "uint256",
+				"name": "reward",
+				"type": "uint256"
+			}
+		],
+		"stateMutability": "nonpayable",
+		"type": "function"
+	},
+	{
+		"inputs": [
+			{
+				"internalType": "uint256",
+				"name": "_tokenId",
+				"type": "uint256"
+			},
+			{
+				"internalType": "address",
+				"name": "_to",
+				"type": "address"
+			}
+		],
+		"name": "withdraw",
+		"outputs": [
+			{
+				"internalType": "uint256",
+				"name": "reward",
+				"type": "uint256"
+			}
+		],
+		"stateMutability": "nonpayable",
+		"type": "function"
+	},
+	{
+		"inputs": [
+		  {
+			"internalType": "bytes[]",
+			"name": "data",
+			"type": "bytes[]"
+		  }
+		],
+		"name": "multicall",
+		"outputs": [
+		  {
+			"internalType": "bytes[]",
+			"name": "results",
+			"type": "bytes[]"
+		  }
+		],
+		"stateMutability": "payable",
+		"type": "function"
+	  },
+	  {
+		"inputs": [
+		  {
+			"components": [
+			  {
+				"internalType": "uint256",
+				"name": "tokenId",
+				"type": "uint256"
+			  },
+			  {
+				"internalType": "address",
+				"name": "recipient",
+				"type": "address"
+			  },
+			  {
+				"internalType": "uint128",
+				"name": "amount0Max",
+				"type": "uint128"
+			  },
+			  {
+				"internalType": "uint128",
+				"name": "amount1Max",
+				"type": "uint128"
+			  }
+			],
+			"internalType": "struct INonfungiblePositionManager.CollectParams",
+			"name": "params",
+			"type": "tuple"
+		  }
+		],
+		"name": "collect",
+		"outputs": [
+		  {
+			"internalType": "uint256",
+			"name": "amount0",
+			"type": "uint256"
+		  },
+		  {
+			"internalType": "uint256",
+			"name": "amount1",
+			"type": "uint256"
+		  }
+		],
+		"stateMutability": "payable",
+		"type": "function"
+	  }
+]

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,10 +81,15 @@ export const stakingAddress: AddressDappNetworkMap = {
     [Dapp.AAVEV3]: "0x929EC64c34a17401F460460D4B9390518E5B473e"
   },
   [Network.OPTIMISM]: {
-    [Dapp.AAVEV3]: "0x929EC64c34a17401F460460D4B9390518E5B473e"
+    [Dapp.AAVEV3]: "0x929EC64c34a17401F460460D4B9390518E5B473e",
+    [Dapp.COMPOUNDV3]: "0x443ea0340cb75a160f31a440722dec7b5bc3c2e9"
   },
-  [Network.ARBITRUM]: {},
-  [Network.BASE]: {}
+  [Network.ARBITRUM]: {
+    [Dapp.COMPOUNDV3]: "0x88730d254a2f7e6ac8388c3198afd694ba9f7fae"
+  },
+  [Network.BASE]: {
+    [Dapp.PANCAKECL]: "0xC6A2Db661D5a5690172d8eB0a7DEA2d3008665A3"
+  }
 };
 
 export const aaveAddressProvider: AddressDappNetworkMap = {
@@ -117,7 +122,8 @@ export const nonfungiblePositionManagerAddress: AddressDappNetworkMap = {
   },
   [Network.BASE]: {
     [Dapp.UNISWAPV3]: "0x03a520b32C04BF3bEEf7BEb72E919cf822Ed34f1",
-    [Dapp.AERODROMECL]: "0x827922686190790b37229fd06084350e74485b72"
+    [Dapp.AERODROMECL]: "0x827922686190790b37229fd06084350e74485b72",
+    [Dapp.PANCAKECL]: "0x46A15B0b27311cedF172AB29E4f4766fbE7F4364"
   }
 };
 

package/src/entities/pool.ts

@@ -46,8 +46,8 @@ import {
 } from "../services/toros/easySwapper";
 import { getAaveV3ClaimTxData } from "../services/aave/incentives";
 import {
+  getClOwner,
   getVelodromeAddLiquidityTxData,
-  getVelodromeClOwner,
   getVelodromeRemoveLiquidityTxData
 } from "../services/velodrome/liquidity";
 import {
@@ -80,6 +80,12 @@ import {
   getCompoundV3LendTxData,
   getCompoundV3WithdrawTxData
 } from "../services/compound/lending";
+import { getCompoundV3ClaimTxData } from "../services/compound/rewards";
+import {
+  getPancakeHarvestClaimTxData,
+  getPancakeStakeTxData,
+  getPancakeUnStakeTxData
+} from "../services/pancake/staking";
 
 export class Pool {
   public readonly poolLogic: Contract;
@@ -581,12 +587,19 @@ export class Pool {
       case Dapp.AERODROMECL:
         stakeTxData = getVelodromeStakeTxData(amount, true);
         break;
+      case Dapp.PANCAKECL:
+        stakeTxData = getPancakeStakeTxData(this, amount.toString(), gauge);
+        break;
       default:
         throw new Error("dapp not supported");
     }
+    const txTo =
+      dapp !== Dapp.PANCAKECL
+        ? gauge
+        : nonfungiblePositionManagerAddress[this.network][dapp];
     const tx = await getPoolTxOrGasEstimate(
       this,
-      [gauge, stakeTxData, options],
+      [txTo, stakeTxData, options],
       estimateGas
     );
     return tx;
@@ -637,10 +650,18 @@ export class Pool {
     options: any = null,
     estimateGas = false
   ): Promise<any> {
+    let unstakeTxData;
     const rewardsGauge = new ethers.utils.Interface(IBalancerRewardsGauge.abi);
-    const unstakeTxData = rewardsGauge.encodeFunctionData("withdraw(uint256)", [
-      amount
-    ]);
+    if (
+      gauge.toLowerCase() ===
+      stakingAddress[this.network][Dapp.PANCAKECL]?.toLowerCase()
+    ) {
+      unstakeTxData = getPancakeUnStakeTxData(this, amount.toString());
+    } else {
+      unstakeTxData = rewardsGauge.encodeFunctionData("withdraw(uint256)", [
+        amount
+      ]);
+    }
     const tx = await getPoolTxOrGasEstimate(
       this,
       [gauge, unstakeTxData, options],
@@ -1040,6 +1061,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
@@ -1057,7 +1103,12 @@ export class Pool {
    * @returns {Promise<any>} Transaction
    */
   async addLiquidityUniswapV3(
-    dapp: Dapp.UNISWAPV3 | Dapp.VELODROMECL | Dapp.AERODROMECL | Dapp.RAMSESCL,
+    dapp:
+      | Dapp.UNISWAPV3
+      | Dapp.VELODROMECL
+      | Dapp.AERODROMECL
+      | Dapp.RAMSESCL
+      | Dapp.PANCAKECL,
     assetA: string,
     assetB: string,
     amountA: BigNumber | string,
@@ -1130,7 +1181,8 @@ export class Pool {
         break;
       case Dapp.VELODROMECL:
       case Dapp.AERODROMECL:
-        const tokenIdOwner = await getVelodromeClOwner(this, dapp, tokenId);
+      case Dapp.PANCAKECL:
+        const tokenIdOwner = await getClOwner(this, dapp, tokenId);
         if (tokenIdOwner.toLowerCase() === this.address.toLowerCase()) {
           dappAddress = nonfungiblePositionManagerAddress[this.network][dapp];
         } else {
@@ -1145,8 +1197,14 @@ export class Pool {
       default:
         throw new Error("dapp not supported");
     }
-    if (!isStaked) {
-      txData = await getDecreaseLiquidityTxData(this, dapp, tokenId, amount);
+    if (!isStaked || dapp === Dapp.PANCAKECL) {
+      txData = await getDecreaseLiquidityTxData(
+        this,
+        dapp,
+        tokenId,
+        amount,
+        isStaked
+      );
     } else {
       throw new Error(
         "unsupported decreaseStakedLiquidity: unstake first to decrease lp"
@@ -1188,7 +1246,8 @@ export class Pool {
         break;
       case Dapp.VELODROMECL:
       case Dapp.AERODROMECL:
-        const tokenIdOwner = await getVelodromeClOwner(this, dapp, tokenId);
+      case Dapp.PANCAKECL:
+        const tokenIdOwner = await getClOwner(this, dapp, tokenId);
         if (tokenIdOwner.toLowerCase() === this.address.toLowerCase()) {
           dappAddress = nonfungiblePositionManagerAddress[this.network][dapp];
         } else {
@@ -1203,7 +1262,8 @@ export class Pool {
       default:
         throw new Error("dapp not supported");
     }
-    if (!isStaked) {
+    //PancakeCL supports increase liquidity to staked position
+    if (!isStaked || dapp === Dapp.PANCAKECL) {
       txData = await getIncreaseLiquidityTxData(
         this,
         dapp,
@@ -1270,7 +1330,8 @@ export class Pool {
         break;
       case Dapp.VELODROMECL:
       case Dapp.AERODROMECL:
-        const tokenIdOwner = await getVelodromeClOwner(this, dapp, tokenId);
+      case Dapp.PANCAKECL:
+        const tokenIdOwner = await getClOwner(this, dapp, tokenId);
         if (tokenIdOwner.toLowerCase() === this.address.toLowerCase()) {
           contractAddress =
             nonfungiblePositionManagerAddress[this.network][dapp];
@@ -1279,9 +1340,13 @@ export class Pool {
             [[tokenId, this.address, MaxUint128, MaxUint128]]
           );
         } else {
-          //staked in gauge
+          //staked in gauge or pancake masterchef
           contractAddress = tokenIdOwner;
-          txData = getVelodromeCLClaimTxData(tokenId);
+          if (dapp === Dapp.PANCAKECL) {
+            txData = getPancakeHarvestClaimTxData(this, tokenId);
+          } else {
+            txData = getVelodromeCLClaimTxData(tokenId);
+          }
         }
         break;
       default:

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/pancake/staking.ts

@@ -0,0 +1,46 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { ethers } from "ethers";
+import INonfungiblePositionManager from "../../abi/INonfungiblePositionManager.json";
+import IPanncakeMasterChef from "../../abi/IPancakeMasterChefV3.json";
+import { Pool } from "../../entities";
+import { Transaction } from "../../types";
+import { MaxUint128 } from "../../config";
+const iNonfungiblePositionManager = new ethers.utils.Interface(
+  INonfungiblePositionManager.abi
+);
+const iMasterChef = new ethers.utils.Interface(IPanncakeMasterChef);
+
+export function getPancakeStakeTxData(
+  pool: Pool,
+  tokenId: string,
+  stakingAddress: string
+): string {
+  return iNonfungiblePositionManager.encodeFunctionData("safeTransferFrom", [
+    pool.address,
+    stakingAddress,
+    tokenId
+  ]);
+}
+
+export function getPancakeUnStakeTxData(pool: Pool, tokenId: string): string {
+  return iMasterChef.encodeFunctionData("withdraw", [tokenId, pool.address]);
+}
+
+export function getPancakeHarvestClaimTxData(
+  pool: Pool,
+  tokenId: string
+): string {
+  const harvestTxData = iMasterChef.encodeFunctionData(Transaction.HARVEST, [
+    tokenId,
+    pool.address
+  ]);
+  const collectTxData = iMasterChef.encodeFunctionData(Transaction.COLLECT, [
+    [tokenId, pool.address, MaxUint128, MaxUint128]
+  ]);
+
+  const multicallParams = [harvestTxData, collectTxData];
+
+  return iMasterChef.encodeFunctionData(Transaction.MULTI_CALL, [
+    multicallParams
+  ]);
+}