fix: permitBatch can be used by viem and ethers

Author: luchobonatti

src/types/utils/preparePermit2BatchData.ts

@@ -1,6 +1,6 @@
 import type { PermitBatch } from "@uniswap/permit2-sdk";
 import type { BatchPermitOptions } from "@uniswap/v4-sdk";
-import type { TypedDataDomain, TypedDataField } from "ethers";
+import type { TypedDataField } from "ethers";
 import type { Address, Hex } from "viem";
 
 /**
@@ -32,10 +32,19 @@ export interface PreparePermit2BatchDataResult {
 	/** Data needed to sign the permit2 batch data */
 	toSign: {
 		/** Domain of the permit2 batch data */
-		domain: TypedDataDomain;
+		domain: {
+			name: string;
+			version: string;
+			chainId: number;
+			verifyingContract: `0x${string}`;
+		};
 		/** Types of the permit2 batch data */
 		types: Record<string, TypedDataField[]>;
 		/** Values of the permit2 batch data */
 		values: PermitBatch;
+		/** Primary type of the permit2 batch data */
+		primaryType: "PermitBatch";
+		/** Message of the permit2 batch data */
+		message: Record<string, unknown>;
 	};
 }

src/utils/preparePermit2BatchData.ts

@@ -10,16 +10,14 @@ import {
 	type PermitBatch,
 } from "@uniswap/permit2-sdk";
 import type { BatchPermitOptions } from "@uniswap/v4-sdk";
-import type { TypedDataDomain, TypedDataField } from "ethers";
-import { zeroAddress } from "viem";
-import type { Hex } from "viem/_types/types/misc";
-
-/**
+import type { TypedDataField } from "ethers";
+import type { Hex } from "viem";
+import { zeroAddress } from "viem"; /**
  * Prepares the permit2 batch data for multiple tokens
  *
  * This function creates a batch permit that allows a spender to use multiple tokens
  * on behalf of the user. It fetches current allowance details for each token and
- * prepares the data needed for signing.
+ * prepares the data needed for signing. You can use with viem or ethers.
  *
  * The complete flow to use this function is:
  * 1. Prepare the permit data:
@@ -33,10 +31,14 @@ import type { Hex } from "viem/_types/types/misc";
  *
  * 2. Sign the permit data using your signer:
  * ```typescript
+ * // viem
+ * const signature = await signer._signTypedData(permitData.toSign)
+ *
+ * // ethers
  * const signature = await signer.signTypedData(
  *   permitData.toSign.domain,
  *   permitData.toSign.types,
- *   permitData.toSign.values
+ *   permitData.toSign.values,
  * )
  * ```
  *
@@ -135,7 +137,7 @@ export async function preparePermit2BatchData(
 		PERMIT2_ADDRESS,
 		chainId,
 	) as {
-		domain: TypedDataDomain;
+		domain: PreparePermit2BatchDataResult["toSign"]["domain"];
 		types: Record<string, TypedDataField[]>;
 		values: PermitBatch;
 	};
@@ -158,6 +160,8 @@ export async function preparePermit2BatchData(
 			domain,
 			types,
 			values,
+			primaryType: "PermitBatch",
+			message: values as unknown as Record<string, unknown>,
 		},
 	};
 }