@nomicfoundation/hardhat-viem 1.0.0

package/src/internal/tasks.ts

@@ -0,0 +1,319 @@
+import type { Artifact, Artifacts } from "hardhat/types";
+import type { ArtifactsEmittedPerFile } from "hardhat/types/builtin-tasks";
+
+import { join, dirname, relative } from "path";
+import { mkdir, writeFile, rm } from "fs/promises";
+
+import { subtask } from "hardhat/config";
+import {
+  TASK_COMPILE_SOLIDITY_EMIT_ARTIFACTS,
+  TASK_COMPILE_SOLIDITY,
+  TASK_COMPILE_REMOVE_OBSOLETE_ARTIFACTS,
+} from "hardhat/builtin-tasks/task-names";
+import {
+  getFullyQualifiedName,
+  parseFullyQualifiedName,
+} from "hardhat/utils/contract-names";
+import { getAllFilesMatching } from "hardhat/internal/util/fs-utils";
+import { replaceBackslashes } from "hardhat/utils/source-names";
+
+interface EmittedArtifacts {
+  artifactsEmittedPerFile: ArtifactsEmittedPerFile;
+}
+
+/**
+ * Override task that generates an `artifacts.d.ts` file with `never`
+ * types for duplicate contract names. This file is used in conjunction with
+ * the `artifacts.d.ts` file inside each contract directory to type
+ * `hre.artifacts`.
+ */
+subtask(TASK_COMPILE_SOLIDITY).setAction(
+  async (_, { config, artifacts }, runSuper) => {
+    const superRes = await runSuper();
+
+    const duplicateContractNames = await findDuplicateContractNames(artifacts);
+
+    const duplicateArtifactsDTs = generateDuplicateArtifactsDefinition(
+      duplicateContractNames
+    );
+
+    try {
+      await writeFile(
+        join(config.paths.artifacts, "artifacts.d.ts"),
+        duplicateArtifactsDTs
+      );
+    } catch (error) {
+      console.error("Error writing artifacts definition:", error);
+    }
+
+    return superRes;
+  }
+);
+
+/**
+ * Override task to emit TypeScript and definition files for each contract.
+ * Generates a `.d.ts` file per contract, and a `artifacts.d.ts` per solidity
+ * file, which is used in conjunction to the root `artifacts.d.ts`
+ * to type `hre.artifacts`.
+ */
+subtask(TASK_COMPILE_SOLIDITY_EMIT_ARTIFACTS).setAction(
+  async (_, { artifacts, config }, runSuper): Promise<EmittedArtifacts> => {
+    const { artifactsEmittedPerFile }: EmittedArtifacts = await runSuper();
+    const duplicateContractNames = await findDuplicateContractNames(artifacts);
+
+    await Promise.all(
+      artifactsEmittedPerFile.map(async ({ file, artifactsEmitted }) => {
+        const srcDir = join(config.paths.artifacts, file.sourceName);
+        await mkdir(srcDir, {
+          recursive: true,
+        });
+
+        const contractTypeData = await Promise.all(
+          artifactsEmitted.map(async (contractName) => {
+            const fqn = getFullyQualifiedName(file.sourceName, contractName);
+            const artifact = await artifacts.readArtifact(fqn);
+            const isDuplicate = duplicateContractNames.has(contractName);
+            const declaration = generateContractDeclaration(
+              artifact,
+              isDuplicate
+            );
+
+            const typeName = `${contractName}$Type`;
+
+            return { contractName, fqn, typeName, declaration };
+          })
+        );
+
+        const fp: Array<Promise<void>> = [];
+        for (const { contractName, declaration } of contractTypeData) {
+          fp.push(writeFile(join(srcDir, `${contractName}.d.ts`), declaration));
+        }
+
+        const dTs = generateArtifactsDefinition(contractTypeData);
+        fp.push(writeFile(join(srcDir, "artifacts.d.ts"), dTs));
+
+        try {
+          await Promise.all(fp);
+        } catch (error) {
+          console.error("Error writing artifacts definition:", error);
+        }
+      })
+    );
+
+    return { artifactsEmittedPerFile };
+  }
+);
+
+/**
+ * Override task for cleaning up outdated artifacts.
+ * Deletes directories with stale `artifacts.d.ts` files that no longer have
+ * a matching `.sol` file.
+ */
+subtask(TASK_COMPILE_REMOVE_OBSOLETE_ARTIFACTS).setAction(
+  async (_, { config, artifacts }, runSuper) => {
+    const superRes = await runSuper();
+
+    const fqns = await artifacts.getAllFullyQualifiedNames();
+    const existingSourceNames = new Set(
+      fqns.map((fqn) => parseFullyQualifiedName(fqn).sourceName)
+    );
+    const allArtifactsDTs = await getAllFilesMatching(
+      config.paths.artifacts,
+      (f) => f.endsWith("artifacts.d.ts")
+    );
+
+    for (const artifactDTs of allArtifactsDTs) {
+      const dir = dirname(artifactDTs);
+      const sourceName = replaceBackslashes(
+        relative(config.paths.artifacts, dir)
+      );
+      // If sourceName is empty, it means that the artifacts.d.ts file is in the
+      // root of the artifacts directory, and we shouldn't delete it.
+      if (sourceName === "") {
+        continue;
+      }
+
+      if (!existingSourceNames.has(sourceName)) {
+        await rm(dir, { force: true, recursive: true });
+      }
+    }
+
+    return superRes;
+  }
+);
+
+const AUTOGENERATED_FILE_PREFACE = `// This file was autogenerated by hardhat-viem, do not edit it.
+// prettier-ignore
+// tslint:disable
+// eslint-disable`;
+
+/**
+ * Generates TypeScript code that extends the `ArtifactsMap` with `never` types
+ * for duplicate contract names.
+ */
+function generateDuplicateArtifactsDefinition(
+  duplicateContractNames: Set<string>
+) {
+  return `${AUTOGENERATED_FILE_PREFACE}
+
+import "hardhat/types/artifacts";
+
+declare module "hardhat/types/artifacts" {
+  interface ArtifactsMap {
+    ${Array.from(duplicateContractNames)
+      .map((name) => `${name}: never;`)
+      .join("\n    ")}
+  }
+}
+`;
+}
+
+/**
+ * Generates TypeScript code to declare a contract and its associated
+ * TypeScript types.
+ */
+function generateContractDeclaration(artifact: Artifact, isDuplicate: boolean) {
+  const { contractName, sourceName } = artifact;
+  const fqn = getFullyQualifiedName(sourceName, contractName);
+  const validNames = isDuplicate ? [fqn] : [contractName, fqn];
+  const json = JSON.stringify(artifact, undefined, 2);
+  const contractTypeName = `${contractName}$Type`;
+
+  const constructorAbi = artifact.abi.find(
+    ({ type }) => type === "constructor"
+  );
+
+  const inputs: Array<{
+    internalType: string;
+    name: string;
+    type: string;
+  }> = constructorAbi !== undefined ? constructorAbi.inputs : [];
+
+  const constructorArgs =
+    inputs.length > 0
+      ? `constructorArgs: [${inputs
+          .map(({ name, type }) => getArgType(name, type))
+          .join(", ")}]`
+      : `constructorArgs?: []`;
+
+  return `${AUTOGENERATED_FILE_PREFACE}
+
+import type { Address } from "viem";
+${
+  inputs.length > 0
+    ? `import type { AbiParameterToPrimitiveType, GetContractReturnType } from "@nomicfoundation/hardhat-viem/types";`
+    : `import type { GetContractReturnType } from "@nomicfoundation/hardhat-viem/types";`
+}
+import "@nomicfoundation/hardhat-viem/types";
+
+export interface ${contractTypeName} ${json}
+
+declare module "@nomicfoundation/hardhat-viem/types" {
+  ${validNames
+    .map(
+      (name) => `export function deployContract(
+    contractName: "${name}",
+    ${constructorArgs},
+    config?: DeployContractConfig
+  ): Promise<GetContractReturnType<${contractTypeName}["abi"]>>;`
+    )
+    .join("\n  ")}
+
+  ${validNames
+    .map(
+      (name) => `export function sendDeploymentTransaction(
+    contractName: "${name}",
+    ${constructorArgs},
+    config?: SendDeploymentTransactionConfig
+  ): Promise<{
+    contract: GetContractReturnType<${contractTypeName}["abi"]>;
+    deploymentTransaction: GetTransactionReturnType;
+  }>;`
+    )
+    .join("\n  ")}
+
+  ${validNames
+    .map(
+      (name) => `export function getContractAt(
+    contractName: "${name}",
+    address: Address,
+    config?: GetContractAtConfig
+  ): Promise<GetContractReturnType<${contractTypeName}["abi"]>>;`
+    )
+    .join("\n  ")}
+}
+`;
+}
+
+/**
+ * Generates TypeScript code to extend the `ArtifactsMap` interface with
+ * contract types.
+ */
+function generateArtifactsDefinition(
+  contractTypeData: Array<{
+    contractName: string;
+    fqn: string;
+    typeName: string;
+    declaration: string;
+  }>
+) {
+  return `${AUTOGENERATED_FILE_PREFACE}
+
+import "hardhat/types/artifacts";
+
+${contractTypeData
+  .map((ctd) => `import { ${ctd.typeName} } from "./${ctd.contractName}";`)
+  .join("\n")}
+
+declare module "hardhat/types/artifacts" {
+  interface ArtifactsMap {
+    ${contractTypeData
+      .map((ctd) => `["${ctd.contractName}"]: ${ctd.typeName};`)
+      .join("\n    ")}
+    ${contractTypeData
+      .map((ctd) => `["${ctd.fqn}"]: ${ctd.typeName};`)
+      .join("\n    ")}
+  }
+}
+`;
+}
+
+/**
+ * Returns the type of a function argument in one of the following formats:
+ * - If the 'name' is provided:
+ *   "name: AbiParameterToPrimitiveType<{ name: string; type: string; }>"
+ *
+ * - If the 'name' is empty:
+ *   "AbiParameterToPrimitiveType<{ name: string; type: string; }>"
+ */
+function getArgType(name: string | undefined, type: string) {
+  const argType = `AbiParameterToPrimitiveType<${JSON.stringify({
+    name,
+    type,
+  })}>`;
+
+  return name !== "" && name !== undefined ? `${name}: ${argType}` : argType;
+}
+
+/**
+ * Returns a set of duplicate contract names.
+ */
+async function findDuplicateContractNames(artifacts: Artifacts) {
+  const fqns = await artifacts.getAllFullyQualifiedNames();
+  const contractNames = fqns.map(
+    (fqn) => parseFullyQualifiedName(fqn).contractName
+  );
+
+  const duplicates = new Set<string>();
+  const existing = new Set<string>();
+
+  for (const name of contractNames) {
+    if (existing.has(name)) {
+      duplicates.add(name);
+    }
+
+    existing.add(name);
+  }
+
+  return duplicates;
+}

package/src/internal/type-extensions.ts

@@ -0,0 +1,54 @@
+import type {
+  Address,
+  PublicClientConfig,
+  WalletClientConfig,
+  TestClientConfig,
+} from "viem";
+import type {
+  PublicClient,
+  TestClient,
+  WalletClient,
+  deployContract,
+  sendDeploymentTransaction,
+  getContractAt,
+} 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;
+    };
+  }
+}
+
+declare module "hardhat/types/artifacts" {
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface ArtifactsMap {}
+
+  interface Artifacts {
+    readArtifact<ArgT extends keyof ArtifactsMap>(
+      contractNameOrFullyQualifiedName: ArgT
+    ): Promise<ArtifactsMap[ArgT]>;
+
+    readArtifactSync<ArgT extends keyof ArtifactsMap>(
+      contractNameOrFullyQualifiedName: ArgT
+    ): ArtifactsMap[ArgT];
+  }
+}

package/src/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../../config/typescript/tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../",
+    "rootDirs": ["."],
+    "composite": true
+  },
+  "include": ["./**/*.ts"],
+  "exclude": [],
+  "references": [
+    {
+      "path": "../../hardhat-core/src"
+    }
+  ]
+}

package/src/types.ts

@@ -0,0 +1,77 @@
+import type * as viemT from "viem";
+import type { ArtifactsMap } from "hardhat/types/artifacts";
+
+export type PublicClient = viemT.PublicClient<viemT.Transport, viemT.Chain>;
+export type WalletClient = viemT.WalletClient<
+  viemT.Transport,
+  viemT.Chain,
+  viemT.Account
+>;
+export type TestClient = viemT.TestClient<
+  TestClientMode,
+  viemT.Transport,
+  viemT.Chain
+>;
+
+export type TestClientMode = Parameters<
+  typeof viemT.createTestClient
+>[0]["mode"];
+
+export interface SendTransactionConfig {
+  walletClient?: WalletClient;
+  gas?: bigint;
+  gasPrice?: bigint;
+  maxFeePerGas?: bigint;
+  maxPriorityFeePerGas?: bigint;
+  value?: bigint;
+}
+
+export interface DeployContractConfig extends SendTransactionConfig {
+  confirmations?: number;
+}
+
+export type SendDeploymentTransactionConfig = SendTransactionConfig;
+
+export interface GetContractAtConfig {
+  walletClient?: WalletClient;
+}
+
+export type GetContractReturnType<
+  TAbi extends viemT.Abi | readonly unknown[] = viemT.Abi
+> = viemT.GetContractReturnType<
+  TAbi,
+  PublicClient,
+  WalletClient,
+  viemT.Address
+>;
+
+export type GetTransactionReturnType = viemT.GetTransactionReturnType<
+  viemT.Chain,
+  "latest"
+>;
+
+export type ContractName<StringT extends string> =
+  StringT extends keyof ArtifactsMap ? never : StringT;
+
+export declare function deployContract<CN extends string>(
+  contractName: ContractName<CN>,
+  constructorArgs?: any[],
+  config?: DeployContractConfig
+): Promise<GetContractReturnType>;
+
+export declare function sendDeploymentTransaction<CN extends string>(
+  contractName: ContractName<CN>,
+  constructorArgs?: any[],
+  config?: SendDeploymentTransactionConfig
+): Promise<{
+  contract: GetContractReturnType;
+  deploymentTransaction: GetTransactionReturnType;
+}>;
+
+export declare function getContractAt<CN extends string>(
+  contractName: ContractName<CN>,
+  address: viemT.Address,
+  config?: GetContractAtConfig
+): Promise<GetContractReturnType>;
+
+export type { AbiParameterToPrimitiveType } from "abitype";

package/types.d.ts

@@ -0,0 +1,32 @@
+import type * as viemT from "viem";
+import type { ArtifactsMap } from "hardhat/types/artifacts";
+export type PublicClient = viemT.PublicClient<viemT.Transport, viemT.Chain>;
+export type WalletClient = viemT.WalletClient<viemT.Transport, viemT.Chain, viemT.Account>;
+export type TestClient = viemT.TestClient<TestClientMode, viemT.Transport, viemT.Chain>;
+export type TestClientMode = Parameters<typeof viemT.createTestClient>[0]["mode"];
+export interface SendTransactionConfig {
+    walletClient?: WalletClient;
+    gas?: bigint;
+    gasPrice?: bigint;
+    maxFeePerGas?: bigint;
+    maxPriorityFeePerGas?: bigint;
+    value?: bigint;
+}
+export interface DeployContractConfig extends SendTransactionConfig {
+    confirmations?: number;
+}
+export type SendDeploymentTransactionConfig = SendTransactionConfig;
+export interface GetContractAtConfig {
+    walletClient?: WalletClient;
+}
+export type GetContractReturnType<TAbi extends viemT.Abi | readonly unknown[] = viemT.Abi> = viemT.GetContractReturnType<TAbi, PublicClient, WalletClient, viemT.Address>;
+export type GetTransactionReturnType = viemT.GetTransactionReturnType<viemT.Chain, "latest">;
+export type ContractName<StringT extends string> = StringT extends keyof ArtifactsMap ? never : StringT;
+export declare function deployContract<CN extends string>(contractName: ContractName<CN>, constructorArgs?: any[], config?: DeployContractConfig): Promise<GetContractReturnType>;
+export declare function sendDeploymentTransaction<CN extends string>(contractName: ContractName<CN>, constructorArgs?: any[], config?: SendDeploymentTransactionConfig): Promise<{
+    contract: GetContractReturnType;
+    deploymentTransaction: GetTransactionReturnType;
+}>;
+export declare function getContractAt<CN extends string>(contractName: ContractName<CN>, address: viemT.Address, config?: GetContractAtConfig): Promise<GetContractReturnType>;
+export type { AbiParameterToPrimitiveType } from "abitype";
+//# sourceMappingURL=types.d.ts.map

package/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,KAAK,MAAM,MAAM,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAE5D,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;AAC5E,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAC3C,KAAK,CAAC,SAAS,EACf,KAAK,CAAC,KAAK,EACX,KAAK,CAAC,OAAO,CACd,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CACvC,cAAc,EACd,KAAK,CAAC,SAAS,EACf,KAAK,CAAC,KAAK,CACZ,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,UAAU,CACrC,OAAO,KAAK,CAAC,gBAAgB,CAC9B,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAEb,MAAM,WAAW,qBAAqB;IACpC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,+BAA+B,GAAG,qBAAqB,CAAC;AAEpE,MAAM,WAAW,mBAAmB;IAClC,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,MAAM,qBAAqB,CAC/B,IAAI,SAAS,KAAK,CAAC,GAAG,GAAG,SAAS,OAAO,EAAE,GAAG,KAAK,CAAC,GAAG,IACrD,KAAK,CAAC,qBAAqB,CAC7B,IAAI,EACJ,YAAY,EACZ,YAAY,EACZ,KAAK,CAAC,OAAO,CACd,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,wBAAwB,CACnE,KAAK,CAAC,KAAK,EACX,QAAQ,CACT,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,MAAM,IAC7C,OAAO,SAAS,MAAM,YAAY,GAAG,KAAK,GAAG,OAAO,CAAC;AAEvD,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,EAAE,SAAS,MAAM,EACtD,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC,EAC9B,eAAe,CAAC,EAAE,GAAG,EAAE,EACvB,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAElC,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,EAAE,SAAS,MAAM,EACjE,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC,EAC9B,eAAe,CAAC,EAAE,GAAG,EAAE,EACvB,MAAM,CAAC,EAAE,+BAA+B,GACvC,OAAO,CAAC;IACT,QAAQ,EAAE,qBAAqB,CAAC;IAChC,qBAAqB,EAAE,wBAAwB,CAAC;CACjD,CAAC,CAAC;AAEH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,EAAE,SAAS,MAAM,EACrD,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC,EAC9B,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,MAAM,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAElC,YAAY,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAC"}

package/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["src/types.ts"],"names":[],"mappings":""}