fix: docs & getPool params

Author: luchobonatti

README.md

@@ -19,12 +19,13 @@ npm install uniswap-dev-kit
 
 ## Quick Start
 
-### 1. Configure and create an SDK instance
+### 1. Configure and create SDK instances
 
 ```ts
 import { createInstance } from "uniswap-dev-kit";
 
-const config = {
+// Create instance for Ethereum mainnet
+createInstance({
   chainId: 1,
   rpcUrl: "https://eth.llamarpc.com",
   contracts: {
@@ -36,9 +37,29 @@ const config = {
     universalRouter: "0x...",
     permit2: "0x..."
   }
-};
+});
 
-createInstance(config);
+// Create instance for another chain (e.g., Base)
+createInstance({
+  chainId: 8453,
+  rpcUrl: "https://mainnet.base.org",
+  contracts: {
+    // Base Uniswap V4 contract addresses...
+  }
+});
+```
+
+The SDK automatically manages multiple instances based on chainId. When using hooks or utilities, just specify the chainId to use the corresponding instance:
+
+```ts
+// Will use Ethereum mainnet instance
+const ethPool = await getPool({ tokens: [...] }, 1);
+
+// Will use Base instance
+const basePool = await getPool({ tokens: [...] }, 8453);
+
+// If you only have one instance, chainId is optional
+const singleChainPool = await getPool({ tokens: [...] });
 ```
 
 ### 2. Get a quote (vanilla JS/TS)
@@ -47,16 +68,25 @@ createInstance(config);
 import { getQuote } from "uniswap-dev-kit";
 import { parseEther } from "viem";
 
-const quote = await getQuote({
-  tokens: [
-    "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
-    "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"  // WETH
-  ],
-  feeTier: 3000,
-  tickSpacing: 60,
-  amountIn: parseEther("1"),
-  zeroForOne: true
-});
+const quote = await getQuote(
+  {
+    tokens: [
+      "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
+      "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
+    ],
+    feeTier: 3000,
+    tickSpacing: 60,
+    amountIn: parseEther("1"),
+  },
+  1,
+  {
+    enabled: true,
+    staleTime: 30000,
+    gcTime: 300000,
+    retry: 3,
+    onSuccess: (data) => console.log("Quote received:", data),
+  },
+);
 console.log(quote.amountOut);
 ```
 
@@ -79,7 +109,8 @@ function QuoteComponent() {
       tickSpacing: 60,
       amountIn: parseEther("1"),
       zeroForOne: true
-    }
+    },
+    chainId: 1
   });
 
   if (isLoading) return <span>Loading...</span>;
@@ -101,8 +132,8 @@ function PoolComponent() {
         "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
       ],
       fee: 3000,
-      chainId: 1
-    }
+    },
+    chainId: 1
   });
 
   if (isLoading) return <span>Loading...</span>;

src/hooks/useGetPool.ts

@@ -15,10 +15,10 @@ import { useQuery } from "@tanstack/react-query";
  * const { data, isLoading, error, refetch } = useGetPool({
  *   params: {
  *     tokens: [token0, token1],
- *     chainId: 1,
  *     fee: FeeTier.MEDIUM,
  *     hooks: "0x0000000000000000000000000000000000000000"
  *   },
+ *   chainId: 1,
  *   queryOptions: {
  *     enabled: true,
  *     staleTime: 30000,
@@ -39,12 +39,13 @@ function serializeParams(params?: PoolParams) {
 
 export function useGetPool({
 	params,
+	chainId,
 	queryOptions = {},
 }: UseGetPoolOptions = {}) {
 	if (!params) throw new Error("No params provided");
 	return useQuery<PoolResponse, Error, PoolResponse, unknown[]>({
-		queryKey: ["pool", serializeParams(params)],
-		queryFn: () => getPool(params),
+		queryKey: ["pool", serializeParams(params), chainId],
+		queryFn: () => getPool(params, chainId),
 		...queryOptions,
 	});
 }

src/index.ts

@@ -8,7 +8,7 @@ export * from "@/hooks/useGetQuote";
 
 // Utils
 export * from "@/utils/getQuote";
-export * from "@/utils/getTokenInstance";
+export * from "@/utils/getTokens";
 
 // Types
 export * from "@/types";

src/test/hooks/useGetPool.test.ts

@@ -3,6 +3,7 @@ import type { UseGetPoolOptions } from "@/types/hooks/useGetPool";
 import { getPool } from "@/utils/getPool";
 import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
 import { renderHook, waitFor } from "@testing-library/react";
+import { Token } from "@uniswap/sdk-core";
 import { jsx as _jsx } from "react/jsx-runtime";
 import type { Mock } from "vitest";
 import { beforeEach, describe, expect, it, vi } from "vitest";
@@ -35,18 +36,8 @@ describe("useGetPool", () => {
 
 	it("should fetch pool data successfully", async () => {
 		const mockPool = {
-			token0: {
-				address: USDC,
-				decimals: 6,
-				name: "USD Coin",
-				symbol: "USDC",
-			},
-			token1: {
-				address: WETH,
-				decimals: 18,
-				name: "Wrapped Ether",
-				symbol: "WETH",
-			},
+			token0: new Token(1, USDC, 6, "USDC", "USD Coin"),
+			token1: new Token(1, WETH, 18, "WETH", "Wrapped Ether"),
 			fee: 3000,
 			tickSpacing: 60,
 		};
@@ -59,8 +50,8 @@ describe("useGetPool", () => {
 					params: {
 						tokens: [USDC, WETH],
 						fee: 3000,
-						chainId: 1,
 					},
+					chainId: 1,
 				}),
 			{ wrapper },
 		);
@@ -73,11 +64,13 @@ describe("useGetPool", () => {
 		expect(result.current.error).toBeNull();
 		expect(result.current.isLoading).toBe(false);
 		expect(result.current.status).toBe("success");
-		expect(getPool).toHaveBeenCalledWith({
-			tokens: [USDC, WETH],
-			fee: 3000,
-			chainId: 1,
-		});
+		expect(getPool).toHaveBeenCalledWith(
+			{
+				tokens: [USDC, WETH],
+				fee: 3000,
+			},
+			1,
+		);
 	});
 
 	it("should handle errors", async () => {
@@ -92,8 +85,8 @@ describe("useGetPool", () => {
 					params: {
 						tokens: [USDC, WETH],
 						fee: 3000,
-						chainId: 1,
 					},
+					chainId: 1,
 				}),
 			{ wrapper },
 		);
@@ -118,18 +111,8 @@ describe("useGetPool", () => {
 
 	it("should handle custom query options", async () => {
 		const mockPool = {
-			token0: {
-				address: USDC,
-				decimals: 6,
-				name: "USD Coin",
-				symbol: "USDC",
-			},
-			token1: {
-				address: WETH,
-				decimals: 18,
-				name: "Wrapped Ether",
-				symbol: "WETH",
-			},
+			token0: new Token(1, USDC, 6, "USDC", "USD Coin"),
+			token1: new Token(1, WETH, 18, "WETH", "Wrapped Ether"),
 			fee: 3000,
 			tickSpacing: 60,
 		};
@@ -142,8 +125,8 @@ describe("useGetPool", () => {
 					params: {
 						tokens: [USDC, WETH],
 						fee: 3000,
-						chainId: 1,
 					},
+					chainId: 1,
 					queryOptions: {
 						enabled: true,
 						staleTime: 5000,

src/test/utils/getPool.test.ts

@@ -5,15 +5,15 @@ import { type Address, zeroAddress } from "viem";
 import { beforeEach, describe, expect, it, vi } from "vitest";
 
 const mockGetInstance = vi.fn();
-const mockGetTokenInstances = vi.fn();
+const mockGetTokens = vi.fn();
 const mockUseReadContracts = vi.fn();
 
 vi.mock("@/core/uniDevKitV4Factory", () => ({
 	getInstance: () => mockGetInstance(),
 }));
 
-vi.mock("@/utils/getTokenInstance", () => ({
-	getTokenInstances: () => mockGetTokenInstances(),
+vi.mock("@/utils/getTokens", () => ({
+	getTokens: () => mockGetTokens(),
 }));
 
 vi.mock("wagmi", () => ({
@@ -35,11 +35,13 @@ describe("useV4Pool", () => {
 	it("should throw error if SDK instance not found", async () => {
 		mockGetInstance.mockReturnValueOnce(undefined);
 		await expect(
-			getPool({
-				tokens: mockTokens,
-				chainId: mockChainId,
-				fee: FeeTier.MEDIUM,
-			}),
+			getPool(
+				{
+					tokens: mockTokens,
+					fee: FeeTier.MEDIUM,
+				},
+				mockChainId,
+			),
 		).rejects.toThrow("SDK not found");
 	});
 
@@ -48,14 +50,16 @@ describe("useV4Pool", () => {
 			getClient: vi.fn(),
 			getContractAddress: vi.fn(),
 		});
-		mockGetTokenInstances.mockResolvedValueOnce(null);
+		mockGetTokens.mockResolvedValueOnce(null);
 
 		await expect(
-			getPool({
-				tokens: mockTokens,
-				chainId: mockChainId,
-				fee: FeeTier.MEDIUM,
-			}),
+			getPool(
+				{
+					tokens: mockTokens,
+					fee: FeeTier.MEDIUM,
+				},
+				mockChainId,
+			),
 		).rejects.toThrow("Failed to fetch token instances");
 	});
 
@@ -78,17 +82,19 @@ describe("useV4Pool", () => {
 			getContractAddress: vi.fn(() => "0xMockAddress"),
 		});
 
-		mockGetTokenInstances.mockResolvedValueOnce(mockTokenInstances);
+		mockGetTokens.mockResolvedValueOnce(mockTokenInstances);
 		mockUseReadContracts.mockReturnValueOnce({
 			data: mockPoolData,
 			isLoading: false,
 		});
 
-		const result = await getPool({
-			tokens: mockTokens,
-			chainId: mockChainId,
-			fee: FeeTier.MEDIUM,
-		});
+		const result = await getPool(
+			{
+				tokens: mockTokens,
+				fee: FeeTier.MEDIUM,
+			},
+			mockChainId,
+		);
 
 		expect(result.data).toBeDefined();
 		expect(result.isLoading).toBe(false);
@@ -106,17 +112,19 @@ describe("useV4Pool", () => {
 			getContractAddress: vi.fn(() => "0xMockAddress"),
 		});
 
-		mockGetTokenInstances.mockResolvedValueOnce(mockTokenInstances);
+		mockGetTokens.mockResolvedValueOnce(mockTokenInstances);
 		mockUseReadContracts.mockReturnValueOnce({
 			data: null,
 			isLoading: false,
 		});
 
-		const result = await getPool({
-			tokens: mockTokens,
-			chainId: mockChainId,
-			fee: FeeTier.MEDIUM,
-		});
+		const result = await getPool(
+			{
+				tokens: mockTokens,
+				fee: FeeTier.MEDIUM,
+			},
+			mockChainId,
+		);
 
 		expect(result.data).toBeUndefined();
 		expect(result.isLoading).toBe(false);
@@ -140,17 +148,19 @@ describe("useV4Pool", () => {
 			getContractAddress: vi.fn(() => "0xMockAddress"),
 		});
 
-		mockGetTokenInstances.mockResolvedValueOnce(mockTokenInstances);
+		mockGetTokens.mockResolvedValueOnce(mockTokenInstances);
 		mockUseReadContracts.mockReturnValueOnce({
 			data: mockPoolData,
 			isLoading: false,
 		});
 
-		const result = await getPool({
-			tokens: mockTokens,
-			chainId: mockChainId,
-			fee: FeeTier.MEDIUM,
-		});
+		const result = await getPool(
+			{
+				tokens: mockTokens,
+				fee: FeeTier.MEDIUM,
+			},
+			mockChainId,
+		);
 
 		expect(result.data).toBeUndefined();
 		expect(result.isLoading).toBe(false);