feat: removeLiquidity & CollectFees

Author: luchobonatti

package.json

@@ -1,6 +1,6 @@
 {
   "name": "uniswap-dev-kit",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "description": "A modern TypeScript library for integrating Uniswap into your dapp.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/core/uniDevKitV4.ts

@@ -5,6 +5,8 @@ import type {
   BuildAddLiquidityCallDataResult,
   BuildAddLiquidityParams,
 } from '@/types/utils/buildAddLiquidityCallData'
+import type { BuildCollectFeesCallDataParams } from '@/types/utils/buildCollectFeesCallData'
+import type { BuildRemoveLiquidityCallDataParams } from '@/types/utils/buildRemoveLiquidityCallData'
 import type { PoolParams } from '@/types/utils/getPool'
 import type { GetPoolKeyFromPoolIdParams } from '@/types/utils/getPoolKeyFromPoolId'
 import type { GetPositionParams, GetPositionResponse } from '@/types/utils/getPosition'
@@ -17,10 +19,8 @@ import type {
   PreparePermit2DataResult,
 } from '@/types/utils/permit2'
 import { buildAddLiquidityCallData } from '@/utils/buildAddLiquidityCallData'
-import {
-  type BuildRemoveLiquidityCallDataParams,
-  buildRemoveLiquidityCallData,
-} from '@/utils/buildRemoveLiquidityCallData'
+import { buildCollectFeesCallData } from '@/utils/buildCollectFeesCallData'
+import { buildRemoveLiquidityCallData } from '@/utils/buildRemoveLiquidityCallData'
 import { buildSwapCallData } from '@/utils/buildSwapCallData'
 import { getPool } from '@/utils/getPool'
 import { getPoolKeyFromPoolId } from '@/utils/getPoolKeyFromPoolId'
@@ -248,4 +248,14 @@ export class UniDevKitV4 {
   async buildRemoveLiquidityCallData(params: BuildRemoveLiquidityCallDataParams) {
     return buildRemoveLiquidityCallData(params, this.instance)
   }
+
+  /**
+   * Builds a collect fees call data for a given collect fees parameters.
+   * @param params @type {BuildCollectFeesCallDataParams}
+   * @returns Promise resolving to collect fees call data including calldata and value
+   * @throws Error if SDK instance is not found or if collect fees call data is invalid
+   */
+  async buildCollectFeesCallData(params: BuildCollectFeesCallDataParams) {
+    return buildCollectFeesCallData(params, this.instance)
+  }
 }

src/types/utils/buildCollectFeesCallData.ts

@@ -0,0 +1,24 @@
+/**
+ * Parameters required to build the calldata for collecting fees from a Uniswap v4 position.
+ */
+export interface BuildCollectFeesCallDataParams {
+  /**
+   * The tokenId of the position to collect fees from.
+   */
+  tokenId: string
+
+  /**
+   * The recipient address for collected fees.
+   */
+  recipient: string
+
+  /**
+   * Optional deadline for the transaction (default: 5 minutes from now).
+   */
+  deadline?: string
+
+  /**
+   * The slippage tolerance for the transaction.
+   */
+  slippageTolerance?: number
+}

src/types/utils/buildRemoveLiquidityCallData.ts

@@ -0,0 +1,24 @@
+/**
+ * Parameters required to build the calldata for removing liquidity from a Uniswap v4 position.
+ */
+export interface BuildRemoveLiquidityCallDataParams {
+  /**
+   * The percentage of liquidity to remove from the position.
+   */
+  liquidityPercentage: number
+
+  /**
+   * The tokenId of the position to remove liquidity from.
+   */
+  tokenId: string
+
+  /**
+   * The slippage tolerance for the transaction.
+   */
+  slippageTolerance?: number
+
+  /**
+   * The deadline for the transaction. (default: 5 minutes from now)
+   */
+  deadline?: string
+}

src/utils/buildCollectFeesCallData.ts

@@ -0,0 +1,64 @@
+import { DEFAULT_SLIPPAGE_TOLERANCE } from '@/constants/common'
+import { percentFromBips } from '@/helpers/percent'
+import type { UniDevKitV4Instance } from '@/types'
+import type { BuildCollectFeesCallDataParams } from '@/types/utils/buildCollectFeesCallData'
+import { getDefaultDeadline } from '@/utils/getDefaultDeadline'
+import { getPosition } from '@/utils/getPosition'
+import { V4PositionManager } from '@uniswap/v4-sdk'
+
+/**
+ * Builds the calldata and value required to collect fees from a Uniswap v4 position.
+ *
+ * @param params - The parameters for collecting fees.
+ * @param instance - The UniDevKit instance for accessing pool state.
+ * @returns An object containing the calldata and the value to send with the transaction.
+ *
+ * @example
+ * ```ts
+ * const { calldata, value } = await buildCollectFeesCallData({
+ *   tokenId: '1234',
+ *   recipient: userAddress,
+ *   slippageTolerance: 50, // 0.5%
+ *   deadline: '1234567890',
+ * }, instance)
+ *
+ * const tx = await sendTransaction({
+ *   to: PositionManager.address,
+ *   data: calldata,
+ *   value,
+ * })
+ * ```
+ */
+export async function buildCollectFeesCallData(
+  {
+    tokenId,
+    recipient,
+    deadline: deadlineParam,
+    slippageTolerance,
+  }: BuildCollectFeesCallDataParams,
+  instance: UniDevKitV4Instance,
+) {
+  const positionData = await getPosition({ tokenId }, instance)
+  if (!positionData) {
+    throw new Error('Position not found')
+  }
+
+  const deadline = deadlineParam ?? (await getDefaultDeadline(instance)).toString()
+
+  try {
+    const { calldata, value } = V4PositionManager.collectCallParameters(positionData.position, {
+      recipient,
+      deadline,
+      tokenId,
+      slippageTolerance: percentFromBips(slippageTolerance ?? DEFAULT_SLIPPAGE_TOLERANCE),
+    })
+
+    return {
+      calldata,
+      value,
+    }
+  } catch (error) {
+    console.error(error)
+    throw error
+  }
+}

src/utils/buildRemoveLiquidityCallData.ts

@@ -1,35 +1,11 @@
 import { DEFAULT_SLIPPAGE_TOLERANCE } from '@/constants/common'
 import { percentFromBips } from '@/helpers/percent'
 import type { UniDevKitV4Instance } from '@/types'
+import type { BuildRemoveLiquidityCallDataParams } from '@/types/utils/buildRemoveLiquidityCallData'
 import { getDefaultDeadline } from '@/utils/getDefaultDeadline'
 import { getPosition } from '@/utils/getPosition'
 import { V4PositionManager } from '@uniswap/v4-sdk'
 
-/**
- * Parameters required to build the calldata for removing liquidity from a Uniswap v4 position.
- */
-export interface BuildRemoveLiquidityCallDataParams {
-  /**
-   * The percentage of liquidity to remove from the position.
-   */
-  liquidityPercentage: number
-
-  /**
-   * The tokenId of the position to remove liquidity from.
-   */
-  tokenId: string
-
-  /**
-   * The slippage tolerance for the transaction.
-   */
-  slippageTolerance?: number
-
-  /**
-   * The deadline for the transaction. (default: 5 minutes from now)
-   */
-  deadline?: string
-}
-
 /**
  * Builds the calldata and value required to remove liquidity from a Uniswap v4 position.
  *