@nomicfoundation/hardhat-viem 1.0.0

package/.eslintrc.js

@@ -0,0 +1,24 @@
+const {
+  slowImportsCommonIgnoredModules,
+} = require("../../config/eslint/constants");
+
+module.exports = {
+  extends: [`${__dirname}/../../config/eslint/eslintrc.js`],
+  parserOptions: {
+    project: `${__dirname}/src/tsconfig.json`,
+    sourceType: "module",
+  },
+  overrides: [
+    {
+      files: ["src/index.ts"],
+      rules: {
+        "@nomicfoundation/slow-imports/no-top-level-external-import": [
+          "error",
+          {
+            ignoreModules: [...slowImportsCommonIgnoredModules],
+          },
+        ],
+      },
+    },
+  ],
+};

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 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:
+
+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.

package/README.md

@@ -0,0 +1,237 @@
+[![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
+
+[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`.
+
+## 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();
+
+const balance = await publicClient.getBalance({
+  address: "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e",
+});
+```
+
+#### 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).
+
+```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"),
+});
+```
+
+```typescript
+import hre from "hardhat";
+
+const walletClient = await hre.viem.getWalletClient(
+  "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e"
+);
+
+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
+
+You can pass options to the `getPublicClient`, `getWalletClient`, and `getTestClient` methods to customize the client's behavior.
+
+```typescript
+import hre from "hardhat";
+
+const publicClient = await hre.viem.getPublicClient({
+  pollingInterval: 1000,
+  cacheTime: 2000,
+});
+```
+
+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"],
+  {
+    walletClient: 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",
+  { walletClient: 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"],
+    {
+      walletClient: 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,
+});
+```
+
+## 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/index.d.ts

@@ -0,0 +1,3 @@
+import "./internal/type-extensions";
+import "./internal/tasks";
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAaA,OAAO,4BAA4B,CAAC;AACpC,OAAO,kBAAkB,CAAC"}

package/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("hardhat/config");
+const clients_1 = require("./internal/clients");
+const contracts_1 = require("./internal/contracts");
+require("./internal/type-extensions");
+require("./internal/tasks");
+(0, config_1.extendEnvironment)((hre) => {
+    const { provider } = hre.network;
+    hre.viem = {
+        getPublicClient: (publicClientConfig) => (0, clients_1.getPublicClient)(provider, publicClientConfig),
+        getWalletClients: (walletClientConfig) => (0, clients_1.getWalletClients)(provider, walletClientConfig),
+        getWalletClient: (address, walletClientConfig) => (0, clients_1.getWalletClient)(provider, address, walletClientConfig),
+        getTestClient: (testClientConfig) => (0, clients_1.getTestClient)(provider, testClientConfig),
+        deployContract: (contractName, constructorArgs, config) => (0, contracts_1.deployContract)(hre, contractName, constructorArgs, config),
+        sendDeploymentTransaction: (contractName, constructorArgs, config) => (0, contracts_1.sendDeploymentTransaction)(hre, contractName, constructorArgs, config),
+        getContractAt: (contractName, address, config) => (0, contracts_1.getContractAt)(hre, contractName, address, config),
+    };
+});
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";;AAAA,2CAAmD;AAEnD,gDAK4B;AAC5B,oDAI8B;AAC9B,sCAAoC;AACpC,4BAA0B;AAE1B,IAAA,0BAAiB,EAAC,CAAC,GAAG,EAAE,EAAE;IACxB,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC;IAEjC,GAAG,CAAC,IAAI,GAAG;QACT,eAAe,EAAE,CAAC,kBAAkB,EAAE,EAAE,CACtC,IAAA,yBAAe,EAAC,QAAQ,EAAE,kBAAkB,CAAC;QAE/C,gBAAgB,EAAE,CAAC,kBAAkB,EAAE,EAAE,CACvC,IAAA,0BAAgB,EAAC,QAAQ,EAAE,kBAAkB,CAAC;QAEhD,eAAe,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,EAAE,CAC/C,IAAA,yBAAe,EAAC,QAAQ,EAAE,OAAO,EAAE,kBAAkB,CAAC;QAExD,aAAa,EAAE,CAAC,gBAAgB,EAAE,EAAE,CAClC,IAAA,uBAAa,EAAC,QAAQ,EAAE,gBAAgB,CAAC;QAE3C,cAAc,EAAE,CAAC,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,CACxD,IAAA,0BAAc,EAAC,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,CAAC;QAE5D,yBAAyB,EAAE,CAAC,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,CACnE,IAAA,qCAAyB,EAAC,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,CAAC;QAEvE,aAAa,EAAE,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAC/C,IAAA,yBAAa,EAAC,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC;KACpD,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/internal/accounts.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="lodash" />
+import type { EthereumProvider } from "hardhat/types";
+import type { Address } from "viem";
+export declare const getAccounts: ((provider: EthereumProvider) => Promise<Address[]>) & import("lodash").MemoizedFunction;
+//# sourceMappingURL=accounts.d.ts.map

package/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,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAIpC,eAAO,MAAM,WAAW,cACL,gBAAgB,KAAG,QAAQ,OAAO,EAAE,CAAC,qCAEvD,CAAC"}

package/internal/accounts.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAccounts = void 0;
+const lodash_memoize_1 = __importDefault(require("lodash.memoize"));
+exports.getAccounts = (0, lodash_memoize_1.default)(async (provider) => provider.send("eth_accounts"));
+//# sourceMappingURL=accounts.js.map

package/internal/accounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../src/internal/accounts.ts"],"names":[],"mappings":";;;;;;AAGA,oEAAqC;AAExB,QAAA,WAAW,GAAG,IAAA,wBAAO,EAChC,KAAK,EAAE,QAA0B,EAAsB,EAAE,CACvD,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAChC,CAAC"}

package/internal/chains.d.ts

@@ -0,0 +1,7 @@
+import type { EthereumProvider } from "hardhat/types";
+import type { Chain } from "viem";
+import type { TestClientMode } from "../types";
+export declare function getChain(provider: EthereumProvider): Promise<Chain>;
+export declare function isDevelopmentNetwork(chainId: number): boolean;
+export declare function getMode(provider: EthereumProvider): Promise<TestClientMode>;
+//# sourceMappingURL=chains.d.ts.map

package/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,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAU/C,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,CAiCzE;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,WAEnD;AAED,wBAAsB,OAAO,CAC3B,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,cAAc,CAAC,CAQzB"}

package/internal/chains.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMode = exports.isDevelopmentNetwork = exports.getChain = void 0;
+const lodash_memoize_1 = __importDefault(require("lodash.memoize"));
+const errors_1 = require("./errors");
+async function getChain(provider) {
+    const chains = require("viem/chains");
+    const chainId = await getChainId(provider);
+    if (isDevelopmentNetwork(chainId)) {
+        if (await isHardhatNetwork(provider)) {
+            return chains.hardhat;
+        }
+        else if (await isFoundryNetwork(provider)) {
+            return chains.foundry;
+        }
+        else {
+            throw new errors_1.UnknownDevelopmentNetworkError();
+        }
+    }
+    const matchingChains = Object.values(chains).filter(({ id }) => id === chainId);
+    if (matchingChains.length === 0) {
+        if (await isHardhatNetwork(provider)) {
+            return chains.hardhat;
+        }
+        else if (await isFoundryNetwork(provider)) {
+            return chains.foundry;
+        }
+        else {
+            throw new errors_1.NetworkNotFoundError(chainId);
+        }
+    }
+    if (matchingChains.length > 1) {
+        throw new errors_1.MultipleMatchingNetworksError(chainId);
+    }
+    return matchingChains[0];
+}
+exports.getChain = getChain;
+function isDevelopmentNetwork(chainId) {
+    return chainId === 31337;
+}
+exports.isDevelopmentNetwork = isDevelopmentNetwork;
+async function getMode(provider) {
+    if (await isHardhatNetwork(provider)) {
+        return "hardhat";
+    }
+    else if (await isFoundryNetwork(provider)) {
+        return "anvil";
+    }
+    else {
+        throw new errors_1.UnknownDevelopmentNetworkError();
+    }
+}
+exports.getMode = getMode;
+const getChainId = (0, lodash_memoize_1.default)(async (provider) => Number(await provider.send("eth_chainId")));
+const isHardhatNetwork = (0, lodash_memoize_1.default)(async (provider) => detectNetworkByMethodName(provider, NetworkMethod.HARDHAT_METADATA));
+const isFoundryNetwork = (0, lodash_memoize_1.default)(async (provider) => detectNetworkByMethodName(provider, NetworkMethod.ANVIL_NODE_INFO));
+var NetworkMethod;
+(function (NetworkMethod) {
+    NetworkMethod["HARDHAT_METADATA"] = "hardhat_metadata";
+    NetworkMethod["ANVIL_NODE_INFO"] = "anvil_nodeInfo";
+})(NetworkMethod || (NetworkMethod = {}));
+async function detectNetworkByMethodName(provider, methodName) {
+    try {
+        await provider.send(methodName);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=chains.js.map

package/internal/chains.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chains.js","sourceRoot":"","sources":["../src/internal/chains.ts"],"names":[],"mappings":";;;;;;AAIA,oEAAqC;AAErC,qCAIkB;AAEX,KAAK,UAAU,QAAQ,CAAC,QAA0B;IACvD,MAAM,MAAM,GAA0B,OAAO,CAAC,aAAa,CAAC,CAAC;IAC7D,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;IAE3C,IAAI,oBAAoB,CAAC,OAAO,CAAC,EAAE;QACjC,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAE;YACpC,OAAO,MAAM,CAAC,OAAO,CAAC;SACvB;aAAM,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAE;YAC3C,OAAO,MAAM,CAAC,OAAO,CAAC;SACvB;aAAM;YACL,MAAM,IAAI,uCAA8B,EAAE,CAAC;SAC5C;KACF;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CACjD,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,OAAO,CAC3B,CAAC;IAEF,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;QAC/B,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAE;YACpC,OAAO,MAAM,CAAC,OAAO,CAAC;SACvB;aAAM,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAE;YAC3C,OAAO,MAAM,CAAC,OAAO,CAAC;SACvB;aAAM;YACL,MAAM,IAAI,6BAAoB,CAAC,OAAO,CAAC,CAAC;SACzC;KACF;IAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;QAC7B,MAAM,IAAI,sCAA6B,CAAC,OAAO,CAAC,CAAC;KAClD;IAED,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC;AAC3B,CAAC;AAjCD,4BAiCC;AAED,SAAgB,oBAAoB,CAAC,OAAe;IAClD,OAAO,OAAO,KAAK,KAAK,CAAC;AAC3B,CAAC;AAFD,oDAEC;AAEM,KAAK,UAAU,OAAO,CAC3B,QAA0B;IAE1B,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAE;QACpC,OAAO,SAAS,CAAC;KAClB;SAAM,IAAI,MAAM,gBAAgB,CAAC,QAAQ,CAAC,EAAE;QAC3C,OAAO,OAAO,CAAC;KAChB;SAAM;QACL,MAAM,IAAI,uCAA8B,EAAE,CAAC;KAC5C;AACH,CAAC;AAVD,0BAUC;AAED,MAAM,UAAU,GAAG,IAAA,wBAAO,EAAC,KAAK,EAAE,QAA0B,EAAE,EAAE,CAC9D,MAAM,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAC3C,CAAC;AAEF,MAAM,gBAAgB,GAAG,IAAA,wBAAO,EAAC,KAAK,EAAE,QAA0B,EAAE,EAAE,CACpE,yBAAyB,CAAC,QAAQ,EAAE,aAAa,CAAC,gBAAgB,CAAC,CACpE,CAAC;AAEF,MAAM,gBAAgB,GAAG,IAAA,wBAAO,EAAC,KAAK,EAAE,QAA0B,EAAE,EAAE,CACpE,yBAAyB,CAAC,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,CACnE,CAAC;AAEF,IAAK,aAGJ;AAHD,WAAK,aAAa;IAChB,sDAAqC,CAAA;IACrC,mDAAkC,CAAA;AACpC,CAAC,EAHI,aAAa,KAAb,aAAa,QAGjB;AAED,KAAK,UAAU,yBAAyB,CACtC,QAA0B,EAC1B,UAAkB;IAElB,IAAI;QACF,MAAM,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;KACb;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC"}

package/internal/clients.d.ts

@@ -0,0 +1,45 @@
+import type { EthereumProvider } from "hardhat/types";
+import type { Address, Chain, PublicClientConfig, WalletClientConfig, TestClientConfig } from "viem";
+import type { PublicClient, TestClient, TestClientMode, WalletClient } from "../types";
+/**
+ * Get a PublicClient instance. This is a read-only client that can be used to
+ * query the blockchain.
+ *
+ * @param provider The Ethereum provider used to connect to the blockchain.
+ * @param publicClientConfig Optional configuration for the PublicClient instance. See the viem documentation for more information.
+ * @returns A PublicClient instance.
+ */
+export declare function getPublicClient(provider: EthereumProvider, publicClientConfig?: Partial<PublicClientConfig>): Promise<PublicClient>;
+export declare function innerGetPublicClient(provider: EthereumProvider, chain: Chain, publicClientConfig?: Partial<PublicClientConfig>): Promise<PublicClient>;
+/**
+ * Get a list of WalletClient instances. These are read-write clients that can
+ * be used to send transactions to the blockchain. Each client is associated
+ * with a an account obtained from the provider using `eth_accounts`.
+ *
+ * @param provider The Ethereum provider used to connect to the blockchain.
+ * @param walletClientConfig Optional configuration for the WalletClient instances. See the viem documentation for more information.
+ * @returns A list of WalletClient instances.
+ */
+export declare function getWalletClients(provider: EthereumProvider, walletClientConfig?: Partial<WalletClientConfig>): Promise<WalletClient[]>;
+export declare function innerGetWalletClients(provider: EthereumProvider, chain: Chain, accounts: Address[], walletClientConfig?: Partial<WalletClientConfig>): Promise<WalletClient[]>;
+/**
+ * Get a WalletClient instance for a specific address. This is a read-write
+ * client that can be used to send transactions to the blockchain.
+ *
+ * @param provider The Ethereum provider used to connect to the blockchain.
+ * @param address The public address of the account to use.
+ * @param walletClientConfig Optional configuration for the WalletClient instance. See the viem documentation for more information.
+ * @returns A WalletClient instance.
+ */
+export declare function getWalletClient(provider: EthereumProvider, address: Address, walletClientConfig?: Partial<WalletClientConfig>): Promise<WalletClient>;
+/**
+ * Get a TestClient instance. This is a read-write client that can be used to
+ * perform actions only available on test nodes such as hardhat or anvil.
+ *
+ * @param provider The Ethereum provider used to connect to the blockchain.
+ * @param testClientConfig Optional configuration for the TestClient instance. See the viem documentation for more information.
+ * @returns A TestClient instance.
+ */
+export declare function getTestClient(provider: EthereumProvider, testClientConfig?: Partial<TestClientConfig>): Promise<TestClient>;
+export declare function innerGetTestClient(provider: EthereumProvider, chain: Chain, mode: TestClientMode, testClientConfig?: Partial<TestClientConfig>): Promise<TestClient>;
+//# sourceMappingURL=clients.d.ts.map

package/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,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EACV,OAAO,EACP,KAAK,EACL,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,MAAM,CAAC;AACd,OAAO,KAAK,EACV,YAAY,EACZ,UAAU,EACV,cAAc,EACd,YAAY,EACb,MAAM,UAAU,CAAC;AAKlB;;;;;;;GAOG;AACH,wBAAsB,eAAe,CACnC,QAAQ,EAAE,gBAAgB,EAC1B,kBAAkB,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAC/C,OAAO,CAAC,YAAY,CAAC,CAGvB;AAED,wBAAsB,oBAAoB,CACxC,QAAQ,EAAE,gBAAgB,EAC1B,KAAK,EAAE,KAAK,EACZ,kBAAkB,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAC/C,OAAO,CAAC,YAAY,CAAC,CAcvB;AAED;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,gBAAgB,EAC1B,kBAAkB,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAC/C,OAAO,CAAC,YAAY,EAAE,CAAC,CAIzB;AAED,wBAAsB,qBAAqB,CACzC,QAAQ,EAAE,gBAAgB,EAC1B,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,OAAO,EAAE,EACnB,kBAAkB,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAC/C,OAAO,CAAC,YAAY,EAAE,CAAC,CAiBzB;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CACnC,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,EAAE,OAAO,EAChB,kBAAkB,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAC/C,OAAO,CAAC,YAAY,CAAC,CAKvB;AAED;;;;;;;GAOG;AACH,wBAAsB,aAAa,CACjC,QAAQ,EAAE,gBAAgB,EAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAC3C,OAAO,CAAC,UAAU,CAAC,CAIrB;AAED,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,gBAAgB,EAC1B,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,cAAc,EACpB,gBAAgB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAC3C,OAAO,CAAC,UAAU,CAAC,CAarB"}

package/internal/clients.js

@@ -0,0 +1,127 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.innerGetTestClient = exports.getTestClient = exports.getWalletClient = exports.innerGetWalletClients = exports.getWalletClients = exports.innerGetPublicClient = exports.getPublicClient = void 0;
+const chains_1 = require("./chains");
+const accounts_1 = require("./accounts");
+/**
+ * Get a PublicClient instance. This is a read-only client that can be used to
+ * query the blockchain.
+ *
+ * @param provider The Ethereum provider used to connect to the blockchain.
+ * @param publicClientConfig Optional configuration for the PublicClient instance. See the viem documentation for more information.
+ * @returns A PublicClient instance.
+ */
+async function getPublicClient(provider, publicClientConfig) {
+    const chain = publicClientConfig?.chain ?? (await (0, chains_1.getChain)(provider));
+    return innerGetPublicClient(provider, chain, publicClientConfig);
+}
+exports.getPublicClient = getPublicClient;
+async function innerGetPublicClient(provider, chain, publicClientConfig) {
+    const viem = await Promise.resolve().then(() => __importStar(require("viem")));
+    const defaultParameters = (0, chains_1.isDevelopmentNetwork)(chain.id)
+        ? { pollingInterval: 50, cacheTime: 0 }
+        : {};
+    const parameters = { ...defaultParameters, ...publicClientConfig };
+    const publicClient = viem.createPublicClient({
+        chain,
+        transport: viem.custom(provider),
+        ...parameters,
+    });
+    return publicClient;
+}
+exports.innerGetPublicClient = innerGetPublicClient;
+/**
+ * Get a list of WalletClient instances. These are read-write clients that can
+ * be used to send transactions to the blockchain. Each client is associated
+ * with a an account obtained from the provider using `eth_accounts`.
+ *
+ * @param provider The Ethereum provider used to connect to the blockchain.
+ * @param walletClientConfig Optional configuration for the WalletClient instances. See the viem documentation for more information.
+ * @returns A list of WalletClient instances.
+ */
+async function getWalletClients(provider, walletClientConfig) {
+    const chain = walletClientConfig?.chain ?? (await (0, chains_1.getChain)(provider));
+    const accounts = await (0, accounts_1.getAccounts)(provider);
+    return innerGetWalletClients(provider, chain, accounts, walletClientConfig);
+}
+exports.getWalletClients = getWalletClients;
+async function innerGetWalletClients(provider, chain, accounts, walletClientConfig) {
+    const viem = await Promise.resolve().then(() => __importStar(require("viem")));
+    const defaultParameters = (0, chains_1.isDevelopmentNetwork)(chain.id)
+        ? { pollingInterval: 50, cacheTime: 0 }
+        : {};
+    const parameters = { ...defaultParameters, ...walletClientConfig };
+    const walletClients = accounts.map((account) => viem.createWalletClient({
+        chain,
+        account,
+        transport: viem.custom(provider),
+        ...parameters,
+    }));
+    return walletClients;
+}
+exports.innerGetWalletClients = innerGetWalletClients;
+/**
+ * Get a WalletClient instance for a specific address. This is a read-write
+ * client that can be used to send transactions to the blockchain.
+ *
+ * @param provider The Ethereum provider used to connect to the blockchain.
+ * @param address The public address of the account to use.
+ * @param walletClientConfig Optional configuration for the WalletClient instance. See the viem documentation for more information.
+ * @returns A WalletClient instance.
+ */
+async function getWalletClient(provider, address, walletClientConfig) {
+    const chain = walletClientConfig?.chain ?? (await (0, chains_1.getChain)(provider));
+    return (await innerGetWalletClients(provider, chain, [address], walletClientConfig))[0];
+}
+exports.getWalletClient = getWalletClient;
+/**
+ * Get a TestClient instance. This is a read-write client that can be used to
+ * perform actions only available on test nodes such as hardhat or anvil.
+ *
+ * @param provider The Ethereum provider used to connect to the blockchain.
+ * @param testClientConfig Optional configuration for the TestClient instance. See the viem documentation for more information.
+ * @returns A TestClient instance.
+ */
+async function getTestClient(provider, testClientConfig) {
+    const chain = testClientConfig?.chain ?? (await (0, chains_1.getChain)(provider));
+    const mode = await (0, chains_1.getMode)(provider);
+    return innerGetTestClient(provider, chain, mode, testClientConfig);
+}
+exports.getTestClient = getTestClient;
+async function innerGetTestClient(provider, chain, mode, testClientConfig) {
+    const viem = await Promise.resolve().then(() => __importStar(require("viem")));
+    const defaultParameters = { pollingInterval: 50, cacheTime: 0 };
+    const parameters = { ...defaultParameters, ...testClientConfig };
+    const testClient = viem.createTestClient({
+        mode,
+        chain,
+        transport: viem.custom(provider),
+        ...parameters,
+    });
+    return testClient;
+}
+exports.innerGetTestClient = innerGetTestClient;
+//# sourceMappingURL=clients.js.map

package/internal/clients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clients.js","sourceRoot":"","sources":["../src/internal/clients.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAeA,qCAAmE;AACnE,yCAAyC;AAEzC;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CACnC,QAA0B,EAC1B,kBAAgD;IAEhD,MAAM,KAAK,GAAG,kBAAkB,EAAE,KAAK,IAAI,CAAC,MAAM,IAAA,iBAAQ,EAAC,QAAQ,CAAC,CAAC,CAAC;IACtE,OAAO,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC;AACnE,CAAC;AAND,0CAMC;AAEM,KAAK,UAAU,oBAAoB,CACxC,QAA0B,EAC1B,KAAY,EACZ,kBAAgD;IAEhD,MAAM,IAAI,GAAG,wDAAa,MAAM,GAAC,CAAC;IAClC,MAAM,iBAAiB,GAAG,IAAA,6BAAoB,EAAC,KAAK,CAAC,EAAE,CAAC;QACtD,CAAC,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE;QACvC,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,UAAU,GAAG,EAAE,GAAG,iBAAiB,EAAE,GAAG,kBAAkB,EAAE,CAAC;IAEnE,MAAM,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC3C,KAAK;QACL,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChC,GAAG,UAAU;KACd,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC;AACtB,CAAC;AAlBD,oDAkBC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,gBAAgB,CACpC,QAA0B,EAC1B,kBAAgD;IAEhD,MAAM,KAAK,GAAG,kBAAkB,EAAE,KAAK,IAAI,CAAC,MAAM,IAAA,iBAAQ,EAAC,QAAQ,CAAC,CAAC,CAAC;IACtE,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAW,EAAC,QAAQ,CAAC,CAAC;IAC7C,OAAO,qBAAqB,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;AAC9E,CAAC;AAPD,4CAOC;AAEM,KAAK,UAAU,qBAAqB,CACzC,QAA0B,EAC1B,KAAY,EACZ,QAAmB,EACnB,kBAAgD;IAEhD,MAAM,IAAI,GAAG,wDAAa,MAAM,GAAC,CAAC;IAClC,MAAM,iBAAiB,GAAG,IAAA,6BAAoB,EAAC,KAAK,CAAC,EAAE,CAAC;QACtD,CAAC,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE;QACvC,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,UAAU,GAAG,EAAE,GAAG,iBAAiB,EAAE,GAAG,kBAAkB,EAAE,CAAC;IAEnE,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAC7C,IAAI,CAAC,kBAAkB,CAAC;QACtB,KAAK;QACL,OAAO;QACP,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChC,GAAG,UAAU;KACd,CAAC,CACH,CAAC;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC;AAtBD,sDAsBC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,eAAe,CACnC,QAA0B,EAC1B,OAAgB,EAChB,kBAAgD;IAEhD,MAAM,KAAK,GAAG,kBAAkB,EAAE,KAAK,IAAI,CAAC,MAAM,IAAA,iBAAQ,EAAC,QAAQ,CAAC,CAAC,CAAC;IACtE,OAAO,CACL,MAAM,qBAAqB,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAC5E,CAAC,CAAC,CAAC,CAAC;AACP,CAAC;AATD,0CASC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,aAAa,CACjC,QAA0B,EAC1B,gBAA4C;IAE5C,MAAM,KAAK,GAAG,gBAAgB,EAAE,KAAK,IAAI,CAAC,MAAM,IAAA,iBAAQ,EAAC,QAAQ,CAAC,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,MAAM,IAAA,gBAAO,EAAC,QAAQ,CAAC,CAAC;IACrC,OAAO,kBAAkB,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC;AACrE,CAAC;AAPD,sCAOC;AAEM,KAAK,UAAU,kBAAkB,CACtC,QAA0B,EAC1B,KAAY,EACZ,IAAoB,EACpB,gBAA4C;IAE5C,MAAM,IAAI,GAAG,wDAAa,MAAM,GAAC,CAAC;IAClC,MAAM,iBAAiB,GAAG,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;IAChE,MAAM,UAAU,GAAG,EAAE,GAAG,iBAAiB,EAAE,GAAG,gBAAgB,EAAE,CAAC;IAEjE,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACvC,IAAI;QACJ,KAAK;QACL,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChC,GAAG,UAAU;KACd,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC;AAlBD,gDAkBC"}

package/internal/contracts.d.ts

@@ -0,0 +1,11 @@
+import type { HardhatRuntimeEnvironment } from "hardhat/types";
+import type { Abi, Address, Hex } from "viem";
+import type { DeployContractConfig, GetContractAtConfig, GetContractReturnType, GetTransactionReturnType, PublicClient, SendDeploymentTransactionConfig, WalletClient } from "../types";
+export declare function deployContract({ artifacts, network }: HardhatRuntimeEnvironment, contractName: string, constructorArgs?: any[], config?: DeployContractConfig): Promise<GetContractReturnType>;
+export declare function innerDeployContract(publicClient: PublicClient, walletClient: WalletClient, contractAbi: Abi, contractBytecode: Hex, constructorArgs: any[], deployContractParameters?: DeployContractConfig, confirmations?: number): Promise<GetContractReturnType>;
+export declare function sendDeploymentTransaction({ artifacts, network }: HardhatRuntimeEnvironment, contractName: string, constructorArgs?: any[], config?: SendDeploymentTransactionConfig): Promise<{
+    contract: GetContractReturnType;
+    deploymentTransaction: GetTransactionReturnType;
+}>;
+export declare function getContractAt({ artifacts, network }: HardhatRuntimeEnvironment, contractName: string, address: Address, config?: GetContractAtConfig): Promise<GetContractReturnType>;
+//# sourceMappingURL=contracts.d.ts.map

package/internal/contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../src/internal/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,yBAAyB,EAC1B,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAC9C,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,YAAY,EACZ,+BAA+B,EAC/B,YAAY,EACb,MAAM,UAAU,CAAC;AAUlB,wBAAsB,cAAc,CAClC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,yBAAyB,EACjD,YAAY,EAAE,MAAM,EACpB,eAAe,GAAE,GAAG,EAAO,EAC3B,MAAM,GAAE,oBAAyB,GAChC,OAAO,CAAC,qBAAqB,CAAC,CAsBhC;AAED,wBAAsB,mBAAmB,CACvC,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY,EAC1B,WAAW,EAAE,GAAG,EAChB,gBAAgB,EAAE,GAAG,EACrB,eAAe,EAAE,GAAG,EAAE,EACtB,wBAAwB,GAAE,oBAAyB,EACnD,aAAa,GAAE,MAAU,GACxB,OAAO,CAAC,qBAAqB,CAAC,CAkDhC;AAED,wBAAsB,yBAAyB,CAC7C,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,yBAAyB,EACjD,YAAY,EAAE,MAAM,EACpB,eAAe,GAAE,GAAG,EAAO,EAC3B,MAAM,GAAE,+BAAoC,GAC3C,OAAO,CAAC;IACT,QAAQ,EAAE,qBAAqB,CAAC;IAChC,qBAAqB,EAAE,wBAAwB,CAAC;CACjD,CAAC,CAkBD;AAuDD,wBAAsB,aAAa,CACjC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,yBAAyB,EACjD,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,OAAO,EAChB,MAAM,GAAE,mBAAwB,GAC/B,OAAO,CAAC,qBAAqB,CAAC,CAchC"}