chore: update README & package version

Author: luchobonatti

README.md

@@ -125,14 +125,40 @@ const poolKey = await uniDevKit.getPoolKeyFromPoolId({
 ```
 
 ### `buildSwapCallData`
-Construct calldata and value for a Universal Router swap.
+Construct calldata for a Universal Router swap.
 ```ts
+// Basic swap
 const { calldata, value } = await uniDevKit.buildSwapCallData({
-  tokenIn,
-  tokenOut,
-  amountIn: "1000000000000000000",
-  recipient,
-  slippageBips: 50
+  tokenIn: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
+  amountIn: parseUnits("100", 6), // 100 USDC
+  pool: pool,
+  slippageTolerance: 50, // 0.5%
+  recipient: "0x..."
+});
+
+// Swap with permit2
+const permitData = await uniDevKit.preparePermit2Data({
+  token: tokenIn,
+  spender: uniDevKit.getContractAddress('universalRouter'),
+  owner: userAddress
+});
+
+const signature = await signer._signTypedData(permitData.toSign);
+const permitWithSignature = permitData.buildPermit2DataWithSignature(signature);
+
+const { calldata: calldataWithPermit, value: valueWithPermit } = await uniDevKit.buildSwapCallData({
+  tokenIn: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+  amountIn: parseUnits("100", 6),
+  pool: pool,
+  slippageTolerance: 50,
+  recipient: "0x...",
+  permit2Signature: permitWithSignature
+});
+
+const tx = await sendTransaction({
+  to: uniDevKit.getContractAddress('universalRouter'),
+  data: calldata,
+  value
 });
 ```
 
@@ -208,4 +234,4 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
 - Releases are automated with [semantic-release](https://semantic-release.gitbook.io/semantic-release/).
 
 ## License
-MIT
+MIT

package.json

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

src/utils/buildSwapCallData.ts

@@ -36,14 +36,32 @@ const buildPermit2StructInput = (permit: PermitSingle, signature: Hex) => {
  *
  * @example
  * ```typescript
+ * // Basic swap
  * const swapParams = {
  *   tokenIn: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
  *   amountIn: parseUnits("100", 6), // 100 USDC
  *   pool: pool,
  *   slippageTolerance: 50, // 0.5%
  * };
  *
- * const calldata = await buildSwapCallData(swapParams);
+ * const calldata = await buildSwapCallData(swapParams, instance);
+ *
+ * // Swap with permit2
+ * const permitData = await preparePermit2Data({
+ *   token: tokenIn,
+ *   spender: universalRouterAddress,
+ *   owner: userAddress
+ * }, instance);
+ *
+ * const signature = await signer._signTypedData(permitData.toSign);
+ * const permitWithSignature = permitData.buildPermit2DataWithSignature(signature);
+ *
+ * const swapParamsWithPermit = {
+ *   ...swapParams,
+ *   permit2Signature: permitWithSignature
+ * };
+ *
+ * const calldataWithPermit = await buildSwapCallData(swapParamsWithPermit, instance);
  *
  * // Send transaction
  * const tx = await sendTransaction({