@nomicfoundation/hardhat-viem 2.0.6 → 3.0.0-next.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @nomicfoundation/hardhat-viem
+
+## 3.0.0-next.1
+
+### Patch Changes
+
+- 5fbea0d: A small bug fix release for the Hardhat 3 Alpha.

package/LICENSE

@@ -1,21 +1,9 @@
 MIT License
 
-Copyright (c) 2023 Nomic Foundation
+Copyright (c) 2024 Nomic Foundation
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,269 +1,57 @@
-[![npm](https://img.shields.io/npm/v/@nomicfoundation/hardhat-viem.svg)](https://www.npmjs.com/package/@nomicfoundation/hardhat-viem) [![hardhat](https://hardhat.org/buidler-plugin-badge.svg?1)](https://hardhat.org)
+# Hardhat Viem plugin
 
-# hardhat-viem
-
-[Hardhat](https://hardhat.org) plugin for integration with [Viem](https://github.com/wagmi-dev/viem), a lightweight, composable, and type-safe Ethereum library.
-
-## What
-
-This plugin integrates the Viem Ethereum library into your Hardhat development environment. Viem is an alternative to [ethers.js](https://docs.ethers.io/) that offers developers a different way to interact with the Ethereum blockchain.
-
-By installing and configuring `hardhat-viem`, you gain access to the capabilities of the Viem library directly within your Hardhat projects. This integration enables you to perform various Ethereum-related tasks using Viem's features and functionalities.
-
-Note: This plugin relies on the Viem library, so familiarity with [Viem's documentation](https://viem.sh/docs/getting-started.html) can enhance your experience when working with `hardhat-viem`.
+This plugin integrates [Viem](https://viem.sh) into Hardhat, adding a `viem` object to each network connection.
 
 ## Installation
 
-```bash
-npm install --save-dev @nomicfoundation/hardhat-viem viem
-```
-
-And add the following statement to your `hardhat.config.js`:
-
-```js
-require("@nomicfoundation/hardhat-viem");
-```
-
-Or, if you are using TypeScript, add this to your `hardhat.config.ts`:
-
-```js
-import "@nomicfoundation/hardhat-viem";
-```
-
-**Note:** you might want to pin Viem-related dependencies because Viem does not strictly follow semantic versioning for type changes. You can read more [here](https://hardhat.org/hardhat-runner/docs/advanced/using-viem#managing-types-and-version-stability).
-
-## Required plugins
-
-No plugins dependencies.
-
-## Tasks
-
-This plugin creates no additional tasks.
-
-## Environment extensions
-
-This plugins adds a `viem` object to the Hardhat Runtime Environment which provides a minimal set of capabilities for interacting with the blockchain.
-
-### Clients
-
-Viem supports three types of clients:
-
-#### Public client
-
-A Public Client is an interface to "public" JSON-RPC API methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](https://viem.sh/docs/actions/public/introduction.html).
-
-```typescript
-import hre from "hardhat";
-
-const publicClient = await hre.viem.getPublicClient();
-
-const blockNumber = await publicClient.getBlockNumber();
+To install this plugin, run the following command:
 
-const balance = await publicClient.getBalance({
-  address: "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e",
-});
+```bash
+npm install --save-dev @nomicfoundation/hardhat-viem@next
 ```
 
-#### Wallet client
-
-A Wallet Client is an interface to interact with Ethereum Accounts and provides the ability to retrieve accounts, execute transactions, sign messages, etc. through [Wallet Actions](https://viem.sh/docs/actions/wallet/introduction.html).
+and add the following statements to your `hardhat.config.ts` file:
 
 ```typescript
-import hre from "hardhat";
-
-const [fromWalletClient, toWalletClient] = await hre.viem.getWalletClients();
-
-const hash = await fromWalletClient.sendTransaction({
-  to: toWalletClient.account.address,
-  value: parseEther("0.0001"),
-});
-```
+// ...
+import viemPlugin from "@nomicfoundation/hardhat-viem";
 
-```typescript
-import hre from "hardhat";
+// ...
 
-const walletClient = await hre.viem.getWalletClient(
-  "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e"
-);
+export default {
+  // ...
+  plugins: [
+    // ...
+    viemPlugin,
+  ],
 
-const signature = await walletClient.signMessage({
-  account,
-  message: "hello world",
-});
+  // ...
+};
 ```
 
-#### Test client
-
-A Test Client is an interface to "test" JSON-RPC API methods such as mining blocks, impersonating accounts, setting fees, etc. through [Test Actions](https://viem.sh/docs/actions/test/introduction.html).
-
-```typescript
-import hre from "hardhat";
-
-const testClient = await hre.viem.getTestClient();
-
-await testClient.mine({
-  blocks: 1000000,
-});
-```
-
-#### Client options
+## Usage
 
-You can pass options to the `getPublicClient`, `getWalletClient`, and `getTestClient` methods to customize the client's behavior.
+This plugin defines a new `viem` property on every `NetworkConnection` object.
 
-```typescript
-import hre from "hardhat";
+```ts
+const { viem } = await hre.network.connect();
 
-const publicClient = await hre.viem.getPublicClient({
-  pollingInterval: 1000,
-  cacheTime: 2000,
+// public client
+const publicClient = await networkConnection.viem.getPublicClient();
+const balance = await publicClient.getBalance({
+  address: "0x...",
 });
-```
-
-For a complete list of options, see:
-
-- [Public client parameters](https://viem.sh/docs/clients/public.html#parameters)
-- [Wallet client parameters](https://viem.sh/docs/clients/wallet.html#parameters)
-- [Test client parameters](https://viem.sh/docs/clients/test.html#parameters)
-
-### Contracts
-
-The `viem` object provides convenient methods for deploying and interacting with smart contracts on the blockchain.
-
-#### Deploying a Contract
 
-To deploy a contract to the blockchain, use the `deployContract` method:
-
-```typescript
-import hre from "hardhat";
-
-const contract = await hre.viem.deployContract("contractName", [
-  "arg1",
-  50,
-  "arg3",
-]);
-```
-
-By default, the first wallet client retrieved by `hre.viem.getWalletClients()` is used to deploy the contract. You can also specify a different wallet client by passing a third parameter, along with other properties, such as `gas` and `value`:
-
-```typescript
-import hre from "hardhat";
-
-const [_, secondWalletClient] = await hre.viem.getWalletClients();
-
-const contractA = await hre.viem.deployContract(
-  "contractName",
-  ["arg1", 50, "arg3"],
-  {
-    client: { wallet: secondWalletClient }
-    gas: 1000000,
-    value: parseEther("0.0001"),
-    confirmations: 5, // 1 by default
-  }
-);
-```
-
-#### Retrieving an Existing Contract
-
-If the contract is already deployed, you can retrieve an instance of it using the `getContractAt` method:
-
-```typescript
-import hre from "hardhat";
-
-const contract = await hre.viem.getContractAt(
-  "contractName",
-  "0x1234567890123456789012345678901234567890"
-);
-```
-
-By default, the first wallet client retrieved by `hre.viem.getWalletClients()` will be used for interacting with the contract. If you want to specify a different wallet client, you can do so by passing it as a third parameter, just like when deploying a contract:
-
-```typescript
-import hre from "hardhat";
-
-const [_, secondWalletClient] = await hre.viem.getWalletClients();
-
-const contract = await hre.viem.getContractAt(
-  "contractName",
-  "0x1234567890123456789012345678901234567890",
-  { client: { wallet: secondWalletClient } }
-);
-```
-
-#### Interacting with Contracts
-
-Once you have an instance of a contract, you can interact with it by calling its methods:
-
-```typescript
-let response = await contract.read.method1();
-await contract.write.method2([10, "arg2"]);
-```
-
-##### Send deployment transaction
-
-By default, the `deployContract` method sends a deployment transaction to the blockchain and waits for the transaction to be mined. If you want to send the transaction without waiting for it to be mined, you can do so by using `sendDeploymentTransaction`:
-
-```typescript
-import hre from "hardhat";
-
-const { contract: contractName, deploymentTransaction } =
-  await hre.viem.sendDeploymentTransaction(
-    "contractName",
-    ["arg1", 50, "arg3"],
-    {
-      client: { wallet: secondWalletClient },
-      gas: 1000000,
-      value: parseEther("0.0001"),
-    }
-  );
-```
-
-Then, if you want to wait for the transaction to be mined, you can do:
-
-```typescript
-import hre from "hardhat";
-
-const publicClient = await hre.viem.getPublicClient();
-const { contractAddress } = await publicClient.waitForTransactionReceipt({
-  hash: deploymentTransaction.hash,
+// wallet client
+const [walletClient1] = await networkConnection.viem.getWalletClients();
+const hash = await walletClient1.sendTransaction({
+  to: "0x...",
+  value: "1000000000000000000",
 });
-```
-
-##### Library linking
 
-Some contracts need to be linked with libraries before they are deployed. You can pass the addresses of their libraries to the `deployContract` and `sendDeploymentTransaction` functions with an object like this:
-
-```typescript
-const contractA = await hre.viem.deployContract(
-  "contractName",
-  ["arg1", 50, "arg3"],
-  {
-    libraries: {
-      ExampleLib: "0x...",
-    },
-  }
-);
+// contracts
+const counter = await viem.deployContract("Counter");
+const x = await counter.read.x();
+await counter.write.inc();
+const xPlus1 = await counter.read.x();
 ```
-
-This allows you to deploy a contract linked to the `ExampleLib` library at the address `"0x..."`.
-
-To deploy a contract, all libraries must be linked. An error will be thrown if any libraries are missing.
-
-#### Using `ContractTypesMap` for easier contract type imports
-
-To simplify importing contract types in `hardhat-viem`, you can use the `ContractTypesMap`. This map contains the contract types of all contracts in your project, indexed by their names.
-
-```typescript
-import { ContractTypesMap } from "hardhat/types/artifacts";
-
-const contract: ContractTypesMap["ContractName"];
-```
-
-This reduces the need for multiple imports and makes your code cleaner and easier to manage.
-
-## Usage
-
-There are no additional steps you need to take for this plugin to work.
-
-Install it and access Viem through the Hardhat Runtime Environment anywhere you need it (tasks, scripts, tests, etc).
-
-Read the documentation on the [Hardhat Runtime Environment](https://hardhat.org/hardhat-runner/docs/advanced/hardhat-runtime-environment) to learn how to access the HRE in different ways to use Viem from anywhere the HRE is accessible.

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+import type { HardhatPlugin } from "hardhat/types/plugins";
+import "./type-extensions.js";
+declare const hardhatPlugin: HardhatPlugin;
+export default hardhatPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,sBAAsB,CAAC;AAE9B,QAAA,MAAM,aAAa,EAAE,aAMpB,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,10 @@
+import "./type-extensions.js";
+const hardhatPlugin = {
+    id: "hardhat-viem",
+    hookHandlers: {
+        network: import.meta.resolve("./internal/hook-handlers/network.js"),
+    },
+    npmPackage: "@nomicfoundation/hardhat-viem",
+};
+export default hardhatPlugin;
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,sBAAsB,CAAC;AAE9B,MAAM,aAAa,GAAkB;IACnC,EAAE,EAAE,cAAc;IAClB,YAAY,EAAE;QACZ,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,qCAAqC,CAAC;KACpE;IACD,UAAU,EAAE,+BAA+B;CAC5C,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/src/internal/accounts.d.ts

@@ -0,0 +1,4 @@
+import type { EthereumProvider } from "hardhat/types/providers";
+import type { Address as ViemAddress } from "viem";
+export declare function getAccounts(provider: EthereumProvider): Promise<ViemAddress[]>;
+//# sourceMappingURL=accounts.d.ts.map

package/dist/src/internal/accounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../../src/internal/accounts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,MAAM,CAAC;AAInD,wBAAsB,WAAW,CAC/B,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,WAAW,EAAE,CAAC,CAcxB"}

package/dist/src/internal/accounts.js

@@ -0,0 +1,15 @@
+const accountsCache = new WeakMap();
+export async function getAccounts(provider) {
+    const cachedAccounts = accountsCache.get(provider);
+    if (cachedAccounts !== undefined) {
+        return cachedAccounts;
+    }
+    /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    -- We know that the provider is going to return an array of accounts */
+    const accounts = (await provider.request({
+        method: "eth_accounts",
+    }));
+    accountsCache.set(provider, accounts);
+    return accounts;
+}
+//# sourceMappingURL=accounts.js.map

package/dist/src/internal/accounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../../src/internal/accounts.ts"],"names":[],"mappings":"AAGA,MAAM,aAAa,GAAG,IAAI,OAAO,EAAmC,CAAC;AAErE,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,QAA0B;IAE1B,MAAM,cAAc,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACnD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;2EACuE;IACvE,MAAM,QAAQ,GAAG,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC;QACvC,MAAM,EAAE,cAAc;KACvB,CAAC,CAAkB,CAAC;IACrB,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAEtC,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/src/internal/chains.d.ts

@@ -0,0 +1,11 @@
+import type { TestClientMode } from "../types.js";
+import type { ChainType } from "hardhat/types/network";
+import type { EthereumProvider } from "hardhat/types/providers";
+import type { Chain as ViemChain } from "viem";
+export declare function getChain(provider: EthereumProvider, chainType: ChainType | string): Promise<ViemChain>;
+export declare function getChainId(provider: EthereumProvider): Promise<number>;
+export declare function isDevelopmentNetwork(provider: EthereumProvider): Promise<boolean>;
+export declare function isHardhatNetwork(provider: EthereumProvider): Promise<boolean>;
+export declare function isAnvilNetwork(provider: EthereumProvider): Promise<boolean>;
+export declare function getMode(provider: EthereumProvider): Promise<TestClientMode>;
+//# sourceMappingURL=chains.d.ts.map

package/dist/src/internal/chains.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chains.d.ts","sourceRoot":"","sources":["../../../src/internal/chains.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAsB/C,wBAAsB,QAAQ,CAC5B,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,EAAE,SAAS,GAAG,MAAM,GAC5B,OAAO,CAAC,SAAS,CAAC,CAmDpB;AAED,wBAAsB,UAAU,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAU5E;AAED,wBAAsB,oBAAoB,CACxC,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,OAAO,CAAC,CAUlB;AAED,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,OAAO,CAAC,CAUlB;AAED,wBAAsB,cAAc,CAClC,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,OAAO,CAAC,CAUlB;AAED,wBAAsB,OAAO,CAC3B,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,cAAc,CAAC,CAUzB"}

package/dist/src/internal/chains.js

@@ -0,0 +1,116 @@
+import { assertHardhatInvariant, HardhatError, } from "@nomicfoundation/hardhat-errors";
+import { extractChain } from "viem";
+import * as chainsModule from "viem/chains";
+import { hardhat, anvil, optimism } from "viem/chains";
+/* eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+-- TODO: this assertion should not be necessary */
+const chains = Object.values(chainsModule);
+const chainCache = new WeakMap();
+const chainIdCache = new WeakMap();
+const isHardhatNetworkCache = new WeakMap();
+const isAnvilNetworkCache = new WeakMap();
+const HARDHAT_METADATA_METHOD = "hardhat_metadata";
+const ANVIL_NODE_INFO_METHOD = "anvil_nodeInfo";
+export async function getChain(provider, chainType) {
+    const cachedChain = chainCache.get(provider);
+    if (cachedChain !== undefined) {
+        return cachedChain;
+    }
+    const chainId = await getChainId(provider);
+    let chain = extractChain({
+        chains,
+        id: chainId,
+    });
+    if ((await isDevelopmentNetwork(provider)) || chain === undefined) {
+        if (await isHardhatNetwork(provider)) {
+            // TODO: We shoud improve how we handle the chains for the different chain
+            // types, as this is both a hardhat and an optimism chain.
+            //
+            // We are currently creating our chain based off optimism's, but that's
+            // not always the correct behavior, as the user may be connecting to
+            // a different chain.
+            if (chainType === "optimism") {
+                chain = { ...optimism, id: chainId };
+            }
+            else {
+                chain = {
+                    ...hardhat,
+                    id: chainId,
+                };
+            }
+        }
+        else if (await isAnvilNetwork(provider)) {
+            chain = {
+                ...anvil,
+                id: chainId,
+            };
+        }
+        else if (chain === undefined) {
+            // If the chain couldn't be found and we can't detect the development
+            // network we throw an error.
+            throw new HardhatError(HardhatError.ERRORS.VIEM.NETWORK_NOT_FOUND, {
+                chainId,
+            });
+        }
+        else {
+            assertHardhatInvariant(false, "This should not happen, as we check in isDevelopmentNetwork that it's either hardhat or anvil");
+        }
+    }
+    chainCache.set(provider, chain);
+    return chain;
+}
+export async function getChainId(provider) {
+    const cachedChainId = chainIdCache.get(provider);
+    if (cachedChainId !== undefined) {
+        return cachedChainId;
+    }
+    const chainId = Number(await provider.request({ method: "eth_chainId" }));
+    chainIdCache.set(provider, chainId);
+    return chainId;
+}
+export async function isDevelopmentNetwork(provider) {
+    if (await isHardhatNetwork(provider)) {
+        return true;
+    }
+    if (await isAnvilNetwork(provider)) {
+        return true;
+    }
+    return false;
+}
+export async function isHardhatNetwork(provider) {
+    const cachedIsHardhat = isHardhatNetworkCache.get(provider);
+    if (cachedIsHardhat !== undefined) {
+        return cachedIsHardhat;
+    }
+    const isHardhat = await isMethodSupported(provider, HARDHAT_METADATA_METHOD);
+    isHardhatNetworkCache.set(provider, isHardhat);
+    return isHardhat;
+}
+export async function isAnvilNetwork(provider) {
+    const cachedIsAnvil = isAnvilNetworkCache.get(provider);
+    if (cachedIsAnvil !== undefined) {
+        return cachedIsAnvil;
+    }
+    const isAnvil = await isMethodSupported(provider, ANVIL_NODE_INFO_METHOD);
+    isAnvilNetworkCache.set(provider, isAnvil);
+    return isAnvil;
+}
+export async function getMode(provider) {
+    if (await isHardhatNetwork(provider)) {
+        return "hardhat";
+    }
+    if (await isAnvilNetwork(provider)) {
+        return "anvil";
+    }
+    throw new HardhatError(HardhatError.ERRORS.VIEM.UNSUPPORTED_DEVELOPMENT_NETWORK);
+}
+async function isMethodSupported(provider, method) {
+    try {
+        await provider.request({ method });
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=chains.js.map

package/dist/src/internal/chains.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chains.js","sourceRoot":"","sources":["../../../src/internal/chains.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,sBAAsB,EACtB,YAAY,GACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvD;kDACkD;AAClD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAgB,CAAC;AAE1D,MAAM,UAAU,GAAG,IAAI,OAAO,EAA+B,CAAC;AAC9D,MAAM,YAAY,GAAG,IAAI,OAAO,EAA4B,CAAC;AAC7D,MAAM,qBAAqB,GAAG,IAAI,OAAO,EAA6B,CAAC;AACvE,MAAM,mBAAmB,GAAG,IAAI,OAAO,EAA6B,CAAC;AAErE,MAAM,uBAAuB,GAAG,kBAAkB,CAAC;AACnD,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAEhD,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,QAA0B,EAC1B,SAA6B;IAE7B,MAAM,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC7C,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;IAE3C,IAAI,KAAK,GAAG,YAAY,CAAC;QACvB,MAAM;QACN,EAAE,EAAE,OAAO;KACZ,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,oBAAoB,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAClE,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrC,0EAA0E;YAC1E,0DAA0D;YAC1D,EAAE;YACF,uEAAuE;YACvE,oEAAoE;YACpE,qBAAqB;YACrB,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;gBAC7B,KAAK,GAAG,EAAE,GAAG,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,KAAK,GAAG;oBACN,GAAG,OAAO;oBACV,EAAE,EAAE,OAAO;iBACZ,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1C,KAAK,GAAG;gBACN,GAAG,KAAK;gBACR,EAAE,EAAE,OAAO;aACZ,CAAC;QACJ,CAAC;aAAM,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,qEAAqE;YACrE,6BAA6B;YAC7B,MAAM,IAAI,YAAY,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBACjE,OAAO;aACR,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,sBAAsB,CACpB,KAAK,EACL,+FAA+F,CAChG,CAAC;QACJ,CAAC;IACH,CAAC;IAED,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAEhC,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,QAA0B;IACzD,MAAM,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;IAC1E,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEpC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,QAA0B;IAE1B,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,MAAM,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,QAA0B;IAE1B,MAAM,eAAe,GAAG,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5D,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAC;IAC7E,qBAAqB,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAE/C,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,QAA0B;IAE1B,MAAM,aAAa,GAAG,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACxD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;IAC1E,mBAAmB,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAE3C,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,QAA0B;IAE1B,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,MAAM,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,IAAI,YAAY,CACpB,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,CACzD,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,QAA0B,EAAE,MAAc;IACzE,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}

package/dist/src/internal/clients.d.ts

@@ -0,0 +1,10 @@
+import type { GetPublicClientReturnType, GetWalletClientReturnType, TestClient } from "../types.js";
+import type { ChainType } from "hardhat/types/network";
+import type { EthereumProvider } from "hardhat/types/providers";
+import type { Address as ViemAddress, PublicClientConfig as ViemPublicClientConfig, TestClientConfig as ViemTestClientConfig, WalletClientConfig as ViemWalletClientConfig } from "viem";
+export declare function getPublicClient<ChainTypeT extends ChainType | string>(provider: EthereumProvider, chainType: ChainTypeT, publicClientConfig?: Partial<ViemPublicClientConfig>): Promise<GetPublicClientReturnType<ChainTypeT>>;
+export declare function getWalletClients<ChainTypeT extends ChainType | string>(provider: EthereumProvider, chainType: ChainTypeT, walletClientConfig?: Partial<ViemWalletClientConfig>): Promise<Array<GetWalletClientReturnType<ChainTypeT>>>;
+export declare function getWalletClient<ChainTypeT extends ChainType | string>(provider: EthereumProvider, chainType: ChainTypeT, address: ViemAddress, walletClientConfig?: Partial<ViemWalletClientConfig>): Promise<GetWalletClientReturnType<ChainTypeT>>;
+export declare function getDefaultWalletClient<ChainTypeT extends ChainType | string>(provider: EthereumProvider, chainType: ChainTypeT, walletClientConfig?: Partial<ViemWalletClientConfig>): Promise<GetWalletClientReturnType<ChainTypeT>>;
+export declare function getTestClient<ChainTypeT extends ChainType | string>(provider: EthereumProvider, chainType: ChainTypeT, testClientConfig?: Partial<ViemTestClientConfig>): Promise<TestClient>;
+//# sourceMappingURL=clients.d.ts.map

package/dist/src/internal/clients.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../../src/internal/clients.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,yBAAyB,EACzB,UAAU,EACX,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EACV,OAAO,IAAI,WAAW,EACtB,kBAAkB,IAAI,sBAAsB,EAC5C,gBAAgB,IAAI,oBAAoB,EACxC,kBAAkB,IAAI,sBAAsB,EAC7C,MAAM,MAAM,CAAC;AAcd,wBAAsB,eAAe,CAAC,UAAU,SAAS,SAAS,GAAG,MAAM,EACzE,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,EAAE,UAAU,EACrB,kBAAkB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACnD,OAAO,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,CAqBhD;AAED,wBAAsB,gBAAgB,CAAC,UAAU,SAAS,SAAS,GAAG,MAAM,EAC1E,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,EAAE,UAAU,EACrB,kBAAkB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACnD,OAAO,CAAC,KAAK,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,CAAC,CA2BvD;AAED,wBAAsB,eAAe,CAAC,UAAU,SAAS,SAAS,GAAG,MAAM,EACzE,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,WAAW,EACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACnD,OAAO,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,CAsBhD;AAED,wBAAsB,sBAAsB,CAC1C,UAAU,SAAS,SAAS,GAAG,MAAM,EAErC,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,EAAE,UAAU,EACrB,kBAAkB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACnD,OAAO,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,CAoBhD;AAED,wBAAsB,aAAa,CAAC,UAAU,SAAS,SAAS,GAAG,MAAM,EACvE,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,EAAE,UAAU,EACrB,gBAAgB,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAC/C,OAAO,CAAC,UAAU,CAAC,CAcrB"}

package/dist/src/internal/clients.js

@@ -0,0 +1,91 @@
+import { HardhatError } from "@nomicfoundation/hardhat-errors";
+import { createPublicClient, createWalletClient, createTestClient, custom as customTransport, } from "viem";
+import { publicActionsL2, walletActionsL2 } from "viem/op-stack";
+import { getAccounts } from "./accounts.js";
+import { getChain, getMode, isDevelopmentNetwork } from "./chains.js";
+export async function getPublicClient(provider, chainType, publicClientConfig) {
+    const chain = publicClientConfig?.chain ?? (await getChain(provider, chainType));
+    const parameters = {
+        ...(await getDefaultClientParameters(provider)),
+        ...publicClientConfig,
+    };
+    let publicClient = createPublicClient({
+        chain,
+        transport: customTransport(provider),
+        ...parameters,
+    });
+    if (chainType === "optimism") {
+        publicClient = publicClient.extend(publicActionsL2());
+    }
+    /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions --
+    We need to assert the type because TS gets confused with the conditional type */
+    return publicClient;
+}
+export async function getWalletClients(provider, chainType, walletClientConfig) {
+    const chain = walletClientConfig?.chain ?? (await getChain(provider, chainType));
+    const accounts = await getAccounts(provider);
+    const parameters = {
+        ...(await getDefaultClientParameters(provider)),
+        ...walletClientConfig,
+    };
+    let walletClients = accounts.map((account) => createWalletClient({
+        chain,
+        account,
+        transport: customTransport(provider),
+        ...parameters,
+    }));
+    if (chainType === "optimism") {
+        walletClients = walletClients.map((walletClient) => walletClient.extend(walletActionsL2()));
+    }
+    /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions --
+    We need to assert the type because TS gets confused with the conditional type */
+    return walletClients;
+}
+export async function getWalletClient(provider, chainType, address, walletClientConfig) {
+    const chain = walletClientConfig?.chain ?? (await getChain(provider, chainType));
+    const parameters = {
+        ...(await getDefaultClientParameters(provider)),
+        ...walletClientConfig,
+    };
+    let walletClient = createWalletClient({
+        chain,
+        account: address,
+        transport: customTransport(provider),
+        ...parameters,
+    });
+    if (chainType === "optimism") {
+        walletClient = walletClient.extend(walletActionsL2());
+    }
+    /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions --
+    We need to assert the type because TS gets confused with the conditional type */
+    return walletClient;
+}
+export async function getDefaultWalletClient(provider, chainType, walletClientConfig) {
+    const chain = walletClientConfig?.chain ?? (await getChain(provider, chainType));
+    const [defaultAccount] = await getAccounts(provider);
+    if (defaultAccount === undefined) {
+        throw new HardhatError(HardhatError.ERRORS.VIEM.DEFAULT_WALLET_CLIENT_NOT_FOUND, {
+            chainId: chain.id,
+        });
+    }
+    return getWalletClient(provider, chainType, defaultAccount, walletClientConfig);
+}
+export async function getTestClient(provider, chainType, testClientConfig) {
+    const chain = testClientConfig?.chain ?? (await getChain(provider, chainType));
+    const mode = await getMode(provider);
+    const parameters = { ...DEFAULT_CLIENT_PARAMETERS, ...testClientConfig };
+    const testClient = createTestClient({
+        chain,
+        mode,
+        transport: customTransport(provider),
+        ...parameters,
+    });
+    return testClient;
+}
+const DEFAULT_CLIENT_PARAMETERS = { pollingInterval: 50, cacheTime: 0 };
+async function getDefaultClientParameters(provider) {
+    return (await isDevelopmentNetwork(provider))
+        ? DEFAULT_CLIENT_PARAMETERS
+        : {};
+}
+//# sourceMappingURL=clients.js.map

package/dist/src/internal/clients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clients.js","sourceRoot":"","sources":["../../../src/internal/clients.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,MAAM,IAAI,eAAe,GAC1B,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEtE,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,QAA0B,EAC1B,SAAqB,EACrB,kBAAoD;IAEpD,MAAM,KAAK,GACT,kBAAkB,EAAE,KAAK,IAAI,CAAC,MAAM,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IACrE,MAAM,UAAU,GAAG;QACjB,GAAG,CAAC,MAAM,0BAA0B,CAAC,QAAQ,CAAC,CAAC;QAC/C,GAAG,kBAAkB;KACtB,CAAC;IAEF,IAAI,YAAY,GAAG,kBAAkB,CAAC;QACpC,KAAK;QACL,SAAS,EAAE,eAAe,CAAC,QAAQ,CAAC;QACpC,GAAG,UAAU;KACd,CAAC,CAAC;IAEH,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;QAC7B,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;oFACgF;IAChF,OAAO,YAAqD,CAAC;AAC/D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,QAA0B,EAC1B,SAAqB,EACrB,kBAAoD;IAEpD,MAAM,KAAK,GACT,kBAAkB,EAAE,KAAK,IAAI,CAAC,MAAM,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,UAAU,GAAG;QACjB,GAAG,CAAC,MAAM,0BAA0B,CAAC,QAAQ,CAAC,CAAC;QAC/C,GAAG,kBAAkB;KACtB,CAAC;IAEF,IAAI,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAC3C,kBAAkB,CAAC;QACjB,KAAK;QACL,OAAO;QACP,SAAS,EAAE,eAAe,CAAC,QAAQ,CAAC;QACpC,GAAG,UAAU;KACd,CAAC,CACH,CAAC;IAEF,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;QAC7B,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CACjD,YAAY,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CACvC,CAAC;IACJ,CAAC;IAED;oFACgF;IAChF,OAAO,aAA6D,CAAC;AACvE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,QAA0B,EAC1B,SAAqB,EACrB,OAAoB,EACpB,kBAAoD;IAEpD,MAAM,KAAK,GACT,kBAAkB,EAAE,KAAK,IAAI,CAAC,MAAM,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IACrE,MAAM,UAAU,GAAG;QACjB,GAAG,CAAC,MAAM,0BAA0B,CAAC,QAAQ,CAAC,CAAC;QAC/C,GAAG,kBAAkB;KACtB,CAAC;IAEF,IAAI,YAAY,GAAG,kBAAkB,CAAC;QACpC,KAAK;QACL,OAAO,EAAE,OAAO;QAChB,SAAS,EAAE,eAAe,CAAC,QAAQ,CAAC;QACpC,GAAG,UAAU;KACd,CAAC,CAAC;IAEH,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;QAC7B,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;oFACgF;IAChF,OAAO,YAAqD,CAAC;AAC/D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAG1C,QAA0B,EAC1B,SAAqB,EACrB,kBAAoD;IAEpD,MAAM,KAAK,GACT,kBAAkB,EAAE,KAAK,IAAI,CAAC,MAAM,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IACrE,MAAM,CAAC,cAAc,CAAC,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,CAAC;IAErD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,YAAY,CACpB,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,EACxD;YACE,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CACF,CAAC;IACJ,CAAC;IAED,OAAO,eAAe,CACpB,QAAQ,EACR,SAAS,EACT,cAAc,EACd,kBAAkB,CACnB,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,QAA0B,EAC1B,SAAqB,EACrB,gBAAgD;IAEhD,MAAM,KAAK,GACT,gBAAgB,EAAE,KAAK,IAAI,CAAC,MAAM,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,UAAU,GAAG,EAAE,GAAG,yBAAyB,EAAE,GAAG,gBAAgB,EAAE,CAAC;IAEzE,MAAM,UAAU,GAAG,gBAAgB,CAAC;QAClC,KAAK;QACL,IAAI;QACJ,SAAS,EAAE,eAAe,CAAC,QAAQ,CAAC;QACpC,GAAG,UAAU;KACd,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,yBAAyB,GAAG,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;AAExE,KAAK,UAAU,0BAA0B,CAAC,QAA0B;IAClE,OAAO,CAAC,MAAM,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC,yBAAyB;QAC3B,CAAC,CAAC,EAAE,CAAC;AACT,CAAC"}