Update for Hardhat 3

.gitignore

@@ -1,3 +1,4 @@
+/artifacts
 /dist
 
 # Logs

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Nomic Labs LLC
+Copyright (c) 2025 Nomic Foundation LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README-TEMPLATE.md

@@ -18,24 +18,23 @@ This plugin will help you with world domination by implementing a simple tic-tac
 npm install <your npm package name> [list of peer dependencies]
 ```
 
-Import the plugin in your `hardhat.config.js`:
+Import the plugin in your `hardhat.config.ts` and register it in your `HardhatUserConfig`:
 
-```js
-require("<your plugin npm package name>");
-```
-
-Or if you are using TypeScript, in your `hardhat.config.ts`:
+```typescript
+import HardhatExamplePlugin from "<your plugin npm package name>";
 
-```ts
-import "<your plugin npm package name>";
+const config: HardhatUserConfig = {
+  plugins: [
+    HardhatExamplePlugin,
+  ],
+};
 ```
 
-
 ## Required plugins
 
 <_The list of all the required Hardhat plugins if there are any_>
 
-- [@nomiclabs/hardhat-web3](https://github.com/nomiclabs/hardhat/tree/master/packages/hardhat-web3)
+- [@nomicfoundation/hardhat-ethers](https://github.com/NomicFoundation/hardhat/tree/main/packages/hardhat-ethers)
 
 ## Tasks
 
@@ -51,13 +50,6 @@ This plugin adds the _example_ task to Hardhat:
 output of `npx hardhat help example`
 ```
 
-## Environment extensions
-
-<_A description of each extension to the Hardhat Runtime Environment_>
-
-This plugin extends the Hardhat Runtime Environment by adding an `example` field
-whose type is `ExampleHardhatRuntimeEnvironmentField`.
-
 ## Configuration
 
 <_A description of each extension to the HardhatConfig or to its fields_>
@@ -67,11 +59,12 @@ This plugin extends the `HardhatUserConfig`'s `ProjectPathsUserConfig` object wi
 
 This is an example of how to set it:
 
-```js
-module.exports = {
-  paths: {
-    newPath: "new-path"
-  }
+```typescript
+const config: HardhatUserConfig = {
+  examplePlugin: {
+    value: 'asdf',
+  },
+  ...
 };
 ```
 

README.md

@@ -7,7 +7,6 @@ publishing it to npm.
 This sample project contains an example on how to do that, but also comes with
 many more features:
 
-- A mocha test suite ready to use
 - TravisCI already setup
 - A package.json with scripts and publishing info
 - Examples on how to do different things
@@ -26,17 +25,15 @@ Make sure to read our [Plugin Development Guide](https://hardhat.org/advanced/bu
 
 ## Testing
 
-Running `npm run test` will run every test located in the `test/` folder. They
-use [mocha](https://mochajs.org) and [chai](https://www.chaijs.com/),
-but you can customize them.
+Running `npm run test` will run every test located in the `test/` folder.
 
 We recommend creating unit tests for your own modules, and integration tests for
 the interaction of the plugin with Hardhat and its dependencies.
 
 ## Linting and autoformat
 
 All of Hardhat projects use [prettier](https://prettier.io/) and
-[tslint](https://palantir.github.io/tslint/).
+[eslint](https://eslint.org/).
 
 You can check if your code style is correct by running `npm run lint`, and fix
 it with `npm run lint:fix`.
@@ -52,7 +49,3 @@ plugin users.
 
 Take a look at `README-TEMPLATE.md` for an example of what a Hardhat plugin's
 README should look like.
-
-## Migrating from Buidler?
-
-Take a look at [the migration guide](MIGRATION.md)!

eslint.config.js

@@ -0,0 +1,37 @@
+import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
+
+export default [
+  eslintPluginPrettierRecommended,
+  // {
+  //   "extends": [
+  //     "eslint:latest",
+  //     "eslint-plugin-prettier",
+  //   ],
+  //   "rules": {
+  //     "prettier": true,
+  //     "object-literal-sort-keys": false,
+  //     "no-submodule-imports": false,
+  //     "interface-name": false,
+  //     "max-classes-per-file": false,
+  //     "no-empty": false,
+  //     "no-console": false,
+  //     "only-arrow-functions": false,
+  //     "variable-name": [
+  //       true,
+  //       "check-format",
+  //       "allow-leading-underscore",
+  //       "allow-pascal-case"
+  //     ],
+  //     "ordered-imports": [
+  //       true,
+  //       {
+  //         "grouped-imports": true,
+  //         "import-sources-order": "case-insensitive"
+  //       }
+  //     ],
+  //     "no-floating-promises": true,
+  //     "prefer-conditional-expression": false,
+  //     "no-implicit-dependencies": true
+  //   }
+  // }
+];