fix: nativeCurrency supported

Author: luchobonatti

src/test/utils/getTokens.test.ts

@@ -1,14 +1,24 @@
 import { getInstance } from "@/core/uniDevKitV4Factory";
 import { getTokens } from "@/utils/getTokens";
 import { Token } from "@uniswap/sdk-core";
-import { type Address, erc20Abi } from "viem";
+import { type Address, erc20Abi, zeroAddress } from "viem";
 import { beforeEach, describe, expect, it, vi } from "vitest";
 
 // Mock the SDK instance
 vi.mock("@/core/uniDevKitV4Factory", () => ({
 	getInstance: vi.fn(),
 }));
 
+vi.mock("@/constants/chains", () => ({
+	getChainById: () => ({
+		nativeCurrency: {
+			decimals: 18,
+			symbol: "ETH",
+			name: "Ethereum",
+		},
+	}),
+}));
+
 describe("getTokens", () => {
 	const mockClient = {
 		multicall: vi.fn(),
@@ -81,6 +91,54 @@ describe("getTokens", () => {
 		});
 	});
 
+	it("should handle native currency (zeroAddress)", async () => {
+		const addresses: [Address, ...Address[]] = [
+			zeroAddress,
+			"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2" as Address, // WETH
+		];
+
+		const mockResults = [
+			"WETH", // symbol for WETH
+			"Wrapped Ether", // name for WETH
+			18, // decimals for WETH
+		];
+
+		mockClient.multicall.mockResolvedValueOnce(mockResults);
+
+		const result = await getTokens({
+			addresses,
+		});
+
+		expect(result).not.toBeNull();
+		expect(result).toHaveLength(2);
+		expect(result?.[0]).toBeInstanceOf(Token);
+		expect(result?.[1]).toBeInstanceOf(Token);
+
+		// Verify native token
+		expect(result?.[0].symbol).toBe("ETH");
+		expect(result?.[0].name).toBe("Ethereum");
+		expect(result?.[0].decimals).toBe(18);
+		expect(result?.[0].chainId).toBe(1);
+		expect(result?.[0].address).toBe(zeroAddress);
+
+		// Verify WETH token
+		expect(result?.[1].symbol).toBe("WETH");
+		expect(result?.[1].name).toBe("Wrapped Ether");
+		expect(result?.[1].decimals).toBe(18);
+		expect(result?.[1].chainId).toBe(1);
+		expect(result?.[1].address).toBe(addresses[1]);
+
+		// Verify multicall was called only for non-native token
+		expect(mockClient.multicall).toHaveBeenCalledWith({
+			contracts: [
+				{ address: addresses[1], abi: erc20Abi, functionName: "symbol" },
+				{ address: addresses[1], abi: erc20Abi, functionName: "name" },
+				{ address: addresses[1], abi: erc20Abi, functionName: "decimals" },
+			],
+			allowFailure: false,
+		});
+	});
+
 	it("should throw error when SDK instance is not found", async () => {
 		(getInstance as unknown as ReturnType<typeof vi.fn>).mockReturnValue(null);
 

src/utils/getTokens.ts

@@ -1,6 +1,7 @@
+import { getChainById } from "@/constants/chains";
 import { getInstance } from "@/core/uniDevKitV4Factory";
 import { Token } from "@uniswap/sdk-core";
-import { type Address, erc20Abi } from "viem";
+import { type Address, erc20Abi, zeroAddress } from "viem";
 
 /**
  * Retrieves Token instances for a list of token addresses on a specific chain.
@@ -18,18 +19,22 @@ export async function getTokens({
 	chainId?: number;
 }): Promise<Token[] | null> {
 	const sdk = getInstance(chainId);
+	const currentChainId = chainId || sdk.getChainId();
+	const chain = getChainById(currentChainId);
 
 	if (!sdk) {
 		throw new Error("SDK not found. Please create an instance first.");
 	}
 
 	const client = sdk.getClient();
 
-	const calls = addresses.flatMap((address) => [
-		{ address, abi: erc20Abi, functionName: "symbol" },
-		{ address, abi: erc20Abi, functionName: "name" },
-		{ address, abi: erc20Abi, functionName: "decimals" },
-	]);
+	const calls = addresses
+		.filter((address) => address !== zeroAddress) // filter out native currency
+		.flatMap((address) => [
+			{ address, abi: erc20Abi, functionName: "symbol" },
+			{ address, abi: erc20Abi, functionName: "name" },
+			{ address, abi: erc20Abi, functionName: "decimals" },
+		]);
 
 	try {
 		const results = await client.multicall({
@@ -41,12 +46,25 @@ export async function getTokens({
 		let resultIndex = 0;
 
 		for (const address of addresses) {
-			const symbol = results[resultIndex++] as string;
-			const name = results[resultIndex++] as string;
-			const decimals = results[resultIndex++] as number;
-			tokens.push(
-				new Token(sdk.getChainId(), address, decimals, symbol, name) as Token,
-			);
+			if (address === zeroAddress) {
+				// For native currency, use chain data from wagmi
+				const nativeCurrency = chain.nativeCurrency;
+				tokens.push(
+					new Token(
+						currentChainId,
+						address,
+						nativeCurrency.decimals,
+						nativeCurrency.symbol,
+						nativeCurrency.name,
+					),
+				);
+			} else {
+				// For ERC20 tokens, use multicall results
+				const symbol = results[resultIndex++] as string;
+				const name = results[resultIndex++] as string;
+				const decimals = results[resultIndex++] as number;
+				tokens.push(new Token(currentChainId, address, decimals, symbol, name));
+			}
 		}
 
 		return tokens;