Merge pull request #5708 from TateB/viem-small-tweaks

fix(hardhat-viem): type consistency + retryCount 0 on devnet

Author: schaable

.changeset/kind-radios-begin.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/hardhat-viem": patch
+---
+
+Moved types to `HardhatViemHelpers` and initialized `ContractTypesMap` as empty for better extensibility. Improved performance by disabling retries in dev nets (thanks @TateB!)

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

@@ -13,6 +13,26 @@ import type {
   WalletClient,
 } from "../types";
 
+async function getParameters<TConfig extends {} | undefined>(
+  chain: Chain,
+  config: TConfig
+) {
+  const { isDevelopmentNetwork } = await import("./chains");
+
+  const defaultParameters = isDevelopmentNetwork(chain.id)
+    ? { pollingInterval: 50, cacheTime: 0 }
+    : {};
+
+  const transportParameters = isDevelopmentNetwork(chain.id)
+    ? { retryCount: 0 }
+    : {};
+
+  return {
+    clientParameters: { ...defaultParameters, ...config },
+    transportParameters,
+  };
+}
+
 /**
  * Get a PublicClient instance. This is a read-only client that can be used to
  * query the blockchain.
@@ -36,16 +56,15 @@ export async function innerGetPublicClient(
   publicClientConfig?: Partial<PublicClientConfig>
 ): Promise<PublicClient> {
   const viem = await import("viem");
-  const { isDevelopmentNetwork } = await import("./chains");
-  const defaultParameters = isDevelopmentNetwork(chain.id)
-    ? { pollingInterval: 50, cacheTime: 0 }
-    : {};
-  const parameters = { ...defaultParameters, ...publicClientConfig };
+  const { clientParameters, transportParameters } = await getParameters(
+    chain,
+    publicClientConfig
+  );
 
   const publicClient = viem.createPublicClient({
     chain,
-    transport: viem.custom(provider),
-    ...parameters,
+    transport: viem.custom(provider, transportParameters),
+    ...clientParameters,
   });
 
   return publicClient;
@@ -78,18 +97,17 @@ export async function innerGetWalletClients(
   walletClientConfig?: Partial<WalletClientConfig>
 ): Promise<WalletClient[]> {
   const viem = await import("viem");
-  const { isDevelopmentNetwork } = await import("./chains");
-  const defaultParameters = isDevelopmentNetwork(chain.id)
-    ? { pollingInterval: 50, cacheTime: 0 }
-    : {};
-  const parameters = { ...defaultParameters, ...walletClientConfig };
+  const { clientParameters, transportParameters } = await getParameters(
+    chain,
+    walletClientConfig
+  );
 
   const walletClients = accounts.map((account) =>
     viem.createWalletClient({
       chain,
       account,
-      transport: viem.custom(provider),
-      ...parameters,
+      transport: viem.custom(provider, transportParameters),
+      ...clientParameters,
     })
   );
 
@@ -142,14 +160,16 @@ export async function innerGetTestClient(
   testClientConfig?: Partial<TestClientConfig>
 ): Promise<TestClient> {
   const viem = await import("viem");
-  const defaultParameters = { pollingInterval: 50, cacheTime: 0 };
-  const parameters = { ...defaultParameters, ...testClientConfig };
+  const { clientParameters, transportParameters } = await getParameters(
+    chain,
+    testClientConfig
+  );
 
   const testClient = viem.createTestClient({
     mode,
     chain,
-    transport: viem.custom(provider),
-    ...parameters,
+    transport: viem.custom(provider, transportParameters),
+    ...clientParameters,
   });
 
   return testClient;

packages/hardhat-viem/src/internal/type-extensions.ts

@@ -1,47 +1,20 @@
-import type {
-  Address,
-  PublicClientConfig,
-  WalletClientConfig,
-  TestClientConfig,
-} from "viem";
-import type {
-  PublicClient,
-  TestClient,
-  WalletClient,
-  deployContract,
-  sendDeploymentTransaction,
-  getContractAt,
-} from "../types";
+import type { HardhatViemHelpers } from "../types";
 import "hardhat/types/runtime";
 import "hardhat/types/artifacts";
 
 declare module "hardhat/types/runtime" {
   interface HardhatRuntimeEnvironment {
-    viem: {
-      getPublicClient(
-        publicClientConfig?: Partial<PublicClientConfig>
-      ): Promise<PublicClient>;
-      getWalletClients(
-        walletClientConfig?: Partial<WalletClientConfig>
-      ): Promise<WalletClient[]>;
-      getWalletClient(
-        address: Address,
-        walletClientConfig?: Partial<WalletClientConfig>
-      ): Promise<WalletClient>;
-      getTestClient(
-        testClientConfig?: Partial<TestClientConfig>
-      ): Promise<TestClient>;
-      deployContract: typeof deployContract;
-      sendDeploymentTransaction: typeof sendDeploymentTransaction;
-      getContractAt: typeof getContractAt;
-    };
+    viem: HardhatViemHelpers;
   }
 }
 
 declare module "hardhat/types/artifacts" {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface ArtifactsMap {}
 
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface ContractTypesMap {}
+
   interface Artifacts {
     readArtifact<ArgT extends keyof ArtifactsMap>(
       contractNameOrFullyQualifiedName: ArgT

packages/hardhat-viem/src/types.ts

@@ -83,4 +83,23 @@ export declare function getContractAt<CN extends string>(
   config?: GetContractAtConfig
 ): Promise<GetContractReturnType>;
 
+export interface HardhatViemHelpers {
+  getPublicClient(
+    publicClientConfig?: Partial<viemT.PublicClientConfig>
+  ): Promise<PublicClient>;
+  getWalletClients(
+    walletClientConfig?: Partial<viemT.WalletClientConfig>
+  ): Promise<WalletClient[]>;
+  getWalletClient(
+    address: viemT.Address,
+    walletClientConfig?: Partial<viemT.WalletClientConfig>
+  ): Promise<WalletClient>;
+  getTestClient(
+    testClientConfig?: Partial<viemT.TestClientConfig>
+  ): Promise<TestClient>;
+  deployContract: typeof deployContract;
+  sendDeploymentTransaction: typeof sendDeploymentTransaction;
+  getContractAt: typeof getContractAt;
+}
+
 export type { AbiParameterToPrimitiveType } from "abitype";

packages/hardhat-viem/test/clients.ts

@@ -1,6 +1,6 @@
 import type { EthereumProvider } from "hardhat/types";
 
-import { assert } from "chai";
+import { assert, expect } from "chai";
 import * as chains from "viem/chains";
 
 import {
@@ -32,6 +32,7 @@ describe("clients", () => {
 
       assert.equal(client.pollingInterval, 1000);
       assert.equal(client.cacheTime, 2000);
+      assert.equal(client.transport.retryCount, 3);
     });
 
     it("should return a public client with default parameters for development networks", async () => {
@@ -41,6 +42,29 @@ describe("clients", () => {
 
       assert.equal(client.pollingInterval, 50);
       assert.equal(client.cacheTime, 0);
+      assert.equal(client.transport.retryCount, 0);
+    });
+
+    it("should retry failed calls on public client", async () => {
+      const provider = new EthereumMockedProvider();
+
+      const client = await innerGetPublicClient(provider, chains.mainnet);
+
+      await expect(client.getBlockNumber()).to.eventually.be.rejectedWith(
+        /unknown RPC error/
+      );
+      assert.equal(provider.calledCount, 4);
+    });
+
+    it("should not retry failed calls on public client when using a development network", async () => {
+      const provider = new EthereumMockedProvider();
+
+      const client = await innerGetPublicClient(provider, chains.hardhat);
+
+      await expect(client.getBlockNumber()).to.eventually.be.rejectedWith(
+        /unknown RPC error/
+      );
+      assert.equal(provider.calledCount, 1);
     });
   });
 
@@ -97,9 +121,36 @@ describe("clients", () => {
       clients.forEach((client) => {
         assert.equal(client.pollingInterval, 50);
         assert.equal(client.cacheTime, 0);
+        assert.equal(client.transport.retryCount, 0);
       });
     });
 
+    it("should retry failed calls on wallet client", async () => {
+      const provider = new EthereumMockedProvider();
+
+      const [client] = await innerGetWalletClients(provider, chains.mainnet, [
+        "0x1",
+      ]);
+
+      await expect(client.getChainId()).to.eventually.be.rejectedWith(
+        /unknown RPC error/
+      );
+      assert.equal(provider.calledCount, 4);
+    });
+
+    it("should not retry failed calls on wallet client when using a development network", async () => {
+      const provider = new EthereumMockedProvider();
+
+      const [client] = await innerGetWalletClients(provider, chains.hardhat, [
+        "0x1",
+      ]);
+
+      await expect(client.getChainId()).to.eventually.be.rejectedWith(
+        /unknown RPC error/
+      );
+      assert.equal(provider.calledCount, 1);
+    });
+
     it("should return an empty array if there are no accounts owned by the user", async () => {
       const provider: EthereumProvider = new EthereumMockedProvider();
 
@@ -169,6 +220,22 @@ describe("clients", () => {
 
       assert.equal(client.pollingInterval, 50);
       assert.equal(client.cacheTime, 0);
+      assert.equal(client.transport.retryCount, 0);
+    });
+
+    it("should not retry failed calls on test client", async () => {
+      const provider = new EthereumMockedProvider();
+
+      const client = await innerGetTestClient(
+        provider,
+        chains.hardhat,
+        "hardhat"
+      );
+
+      await expect(client.getAutomine()).to.eventually.be.rejectedWith(
+        /unknown RPC error/
+      );
+      assert.equal(provider.calledCount, 1);
     });
   });
 });

packages/hardhat-viem/test/mocks/provider.ts

@@ -11,7 +11,12 @@ export class EthereumMockedProvider
   extends EventEmitter
   implements EthereumProvider
 {
-  public async request(_args: RequestArguments): Promise<any> {}
+  public calledCount = 0;
+
+  public async request(_args: RequestArguments): Promise<any> {
+    this.calledCount++;
+    throw new Error();
+  }
 
   public async send(_method: string, _params: any[] = []) {}