hardhat-example-plugin

A one line description of the plugin

Hardhat plugin example.

What

<A longer, one paragraph, description of the plugin>

This plugin will help you with world domination by implementing a simple tic-tac-toe in the terminal.

Installation

<A step-by-step guide on how to install the plugin>

npm install <your npm package name> [list of peer dependencies]

Import the plugin in your hardhat.config.js:

require("<your plugin npm package name>");

Or if you are using TypeScript, in your hardhat.config.ts:

import "<your plugin npm package name>";

Required plugins

<The list of all the required Hardhat plugins if there are any>

• @nomiclabs/hardhat-web3

Tasks

<A description of each task added by this plugin. If it just overrides internal tasks, this may not be needed>

This plugin creates no additional tasks.

<or>

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>

This plugin extends the HardhatUserConfig's ProjectPathsUserConfig object with an optional newPath field.

This is an example of how to set it:

module.exports = {
  paths: {
    newPath: "new-path"
  }
};

Usage

<A description of how to use this plugin. How to use the tasks if there are any, etc.>

There are no additional steps you need to take for this plugin to work.

Install it and access ethers through the Hardhat Runtime Environment anywhere you need it (tasks, scripts, tests, etc).