Merge pull request #5398 from beepidibop/Add-ContractTypesMap

Add contract types map to hardhat-viem

.changeset/smooth-rabbits-wait.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/hardhat-viem": patch
+---
+
+Added `ContractTypesMap` to simplify contract type imports (thanks @beepidibop!)

packages/hardhat-viem/README.md

@@ -248,6 +248,18 @@ This allows you to deploy a contract linked to the `ExampleLib` library at the a
 
 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.

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

@@ -164,6 +164,12 @@ declare module "hardhat/types/artifacts" {
       .map((name) => `${name}: never;`)
       .join("\n    ")}
   }
+
+  interface ContractTypesMap {
+    ${Array.from(duplicateContractNames)
+      .map((name) => `${name}: never;`)
+      .join("\n    ")}
+  }
 }
 `;
 }
@@ -260,6 +266,7 @@ function generateArtifactsDefinition(
   return `${AUTOGENERATED_FILE_PREFACE}
 
 import "hardhat/types/artifacts";
+import type { GetContractReturnType } from "@nomicfoundation/hardhat-viem/types";
 
 ${contractTypeData
   .map((ctd) => `import { ${ctd.typeName} } from "./${ctd.contractName}";`)
@@ -274,6 +281,21 @@ declare module "hardhat/types/artifacts" {
       .map((ctd) => `["${ctd.fqn}"]: ${ctd.typeName};`)
       .join("\n    ")}
   }
+
+  interface ContractTypesMap {
+    ${contractTypeData
+      .map(
+        (ctd) =>
+          `["${ctd.contractName}"]: GetContractReturnType<${ctd.typeName}["abi"]>;`
+      )
+      .join("\n    ")}
+    ${contractTypeData
+      .map(
+        (ctd) =>
+          `["${ctd.fqn}"]: GetContractReturnType<${ctd.typeName}["abi"]>;`
+      )
+      .join("\n    ")}
+  }
 }
 `;
 }

packages/hardhat-viem/test/fixture-projects/type-generation/snapshots/artifacts.d.ts

@@ -9,4 +9,8 @@ declare module "hardhat/types/artifacts" {
   interface ArtifactsMap {
     B: never;
   }
+
+  interface ContractTypesMap {
+    B: never;
+  }
 }

packages/hardhat-viem/test/fixture-projects/type-generation/snapshots/contracts/A.sol/artifacts.d.ts

@@ -4,6 +4,7 @@
 // eslint-disable
 
 import "hardhat/types/artifacts";
+import type { GetContractReturnType } from "@nomicfoundation/hardhat-viem/types";
 
 import { A$Type } from "./A";
 import { B$Type } from "./B";
@@ -15,4 +16,11 @@ declare module "hardhat/types/artifacts" {
     ["contracts/A.sol:A"]: A$Type;
     ["contracts/A.sol:B"]: B$Type;
   }
+
+  interface ContractTypesMap {
+    ["A"]: GetContractReturnType<A$Type["abi"]>;
+    ["B"]: GetContractReturnType<B$Type["abi"]>;
+    ["contracts/A.sol:A"]: GetContractReturnType<A$Type["abi"]>;
+    ["contracts/A.sol:B"]: GetContractReturnType<B$Type["abi"]>;
+  }
 }

packages/hardhat-viem/test/fixture-projects/type-generation/snapshots/contracts/C.sol/artifacts.d.ts

@@ -4,6 +4,7 @@
 // eslint-disable
 
 import "hardhat/types/artifacts";
+import type { GetContractReturnType } from "@nomicfoundation/hardhat-viem/types";
 
 import { B$Type } from "./B";
 import { C$Type } from "./C";
@@ -15,4 +16,11 @@ declare module "hardhat/types/artifacts" {
     ["contracts/C.sol:B"]: B$Type;
     ["contracts/C.sol:C"]: C$Type;
   }
+
+  interface ContractTypesMap {
+    ["B"]: GetContractReturnType<B$Type["abi"]>;
+    ["C"]: GetContractReturnType<C$Type["abi"]>;
+    ["contracts/C.sol:B"]: GetContractReturnType<B$Type["abi"]>;
+    ["contracts/C.sol:C"]: GetContractReturnType<C$Type["abi"]>;
+  }
 }