feat: use extractChain to return first match instead of filtering duplicates

Author: schaable

packages/hardhat-viem/src/internal/chains.ts

@@ -4,51 +4,46 @@ import type { TestClientMode } from "../types";
 
 import memoize from "lodash.memoize";
 
-import {
-  UnknownDevelopmentNetworkError,
-  NetworkNotFoundError,
-  MultipleMatchingNetworksError,
-} from "./errors";
+import { UnknownDevelopmentNetworkError, NetworkNotFoundError } from "./errors";
 
 export async function getChain(provider: EthereumProvider): Promise<Chain> {
-  const chains: Record<string, Chain> = require("viem/chains");
+  const { extractChain } = await import("viem");
+  const chainsModule = await import("viem/chains");
+  const chains = Object.values(chainsModule) as Chain[];
   const chainId = await getChainId(provider);
 
   if (isDevelopmentNetwork(chainId)) {
     if (await isHardhatNetwork(provider)) {
-      return chains.hardhat;
+      return chainsModule.hardhat;
     } else if (await isFoundryNetwork(provider)) {
-      return chains.foundry;
+      return chainsModule.foundry;
     } else {
       throw new UnknownDevelopmentNetworkError();
     }
   }
 
-  const matchingChains = Object.values(chains).filter(
-    ({ id }) => id === chainId
-  );
+  const chain = extractChain({
+    chains,
+    id: chainId,
+  });
 
-  if (matchingChains.length === 0) {
+  if (chain === undefined) {
     if (await isHardhatNetwork(provider)) {
       return {
-        ...chains.hardhat,
+        ...chainsModule.hardhat,
         id: chainId,
       };
     } else if (await isFoundryNetwork(provider)) {
       return {
-        ...chains.foundry,
+        ...chainsModule.foundry,
         id: chainId,
       };
     } else {
       throw new NetworkNotFoundError(chainId);
     }
   }
 
-  if (matchingChains.length > 1) {
-    throw new MultipleMatchingNetworksError(chainId);
-  }
-
-  return matchingChains[0];
+  return chain;
 }
 
 export function isDevelopmentNetwork(chainId: number) {

packages/hardhat-viem/src/internal/errors.ts

@@ -31,22 +31,6 @@ You can find a list of supported networks here: https://github.com/wevm/viem/blo
   }
 }
 
-export class MultipleMatchingNetworksError extends HardhatViemError {
-  constructor(chainId: number) {
-    super(
-      `Multiple networks with chain id ${chainId} found. You can override the chain by passing it as a parameter to the client getter:
-
-import { someChain } from "viem/chains";
-const client = await hre.viem.getPublicClient({
-  chain: someChain,
-  ...
-});
-
-You can find a list of supported networks here: https://github.com/wevm/viem/blob/main/src/chains/index.ts`
-    );
-  }
-}
-
 export class DefaultWalletClientNotFoundError extends HardhatViemError {
   constructor(networkName: string) {
     super(

packages/hardhat-viem/test/chains.ts

@@ -52,41 +52,41 @@ describe("chains", () => {
       expect(chain).to.deep.equal(chains.foundry);
     });
 
-    it("should throw if the chain id is 31337 and the network is neither hardhat nor foundry", async () => {
+    it("should return the first matching chain if the chain id is not 31337 and there are multiple chains with that id", async () => {
       const provider: EthereumProvider = new EthereumMockedProvider();
       const sendStub = sinon.stub(provider, "send");
-      sendStub.withArgs("eth_chainId").returns(Promise.resolve("0x7a69")); // 31337 in hex
+      // chain id 999 corresponds to wanchainTestnet but also zoraTestnet
+      sendStub.withArgs("eth_chainId").returns(Promise.resolve("0x3e7"));
       sendStub.withArgs("hardhat_metadata").throws();
       sendStub.withArgs("anvil_nodeInfo").throws();
 
-      await expect(getChain(provider)).to.be.rejectedWith(
-        `The chain id corresponds to a development network but we couldn't detect which one.
-Please report this issue if you're using Hardhat or Foundry.`
-      );
+      const chain = await getChain(provider);
+
+      expect(chain).to.deep.equal(chains.wanchainTestnet);
     });
 
-    it("should throw if the chain id is not 31337 and there is no chain with that id", async () => {
+    it("should throw if the chain id is 31337 and the network is neither hardhat nor foundry", async () => {
       const provider: EthereumProvider = new EthereumMockedProvider();
       const sendStub = sinon.stub(provider, "send");
-      sendStub.withArgs("eth_chainId").returns(Promise.resolve("0x0")); // fake chain id 0
+      sendStub.withArgs("eth_chainId").returns(Promise.resolve("0x7a69")); // 31337 in hex
       sendStub.withArgs("hardhat_metadata").throws();
       sendStub.withArgs("anvil_nodeInfo").throws();
 
       await expect(getChain(provider)).to.be.rejectedWith(
-        /No network with chain id 0 found/
+        `The chain id corresponds to a development network but we couldn't detect which one.
+Please report this issue if you're using Hardhat or Foundry.`
       );
     });
 
-    it("should throw if the chain id is not 31337 and there are multiple chains with that id", async () => {
+    it("should throw if the chain id is not 31337 and there is no chain with that id", async () => {
       const provider: EthereumProvider = new EthereumMockedProvider();
       const sendStub = sinon.stub(provider, "send");
-      // chain id 999 corresponds to Wanchain Testnet but also Zora Goerli Testnet
-      sendStub.withArgs("eth_chainId").returns(Promise.resolve("0x3e7"));
+      sendStub.withArgs("eth_chainId").returns(Promise.resolve("0x0")); // fake chain id 0
       sendStub.withArgs("hardhat_metadata").throws();
       sendStub.withArgs("anvil_nodeInfo").throws();
 
       await expect(getChain(provider)).to.be.rejectedWith(
-        /Multiple networks with chain id 999 found./
+        /No network with chain id 0 found/
       );
     });
   });