@nomicfoundation/hardhat-ignition

Hardhat Ignition

Hardhat Ignition is a declarative system for deploying smart contracts on Ethereum. It enables you to define smart contract instances you want to deploy, and any operation you want to run on them. By taking over the deployment and execution, Hardhat Ignition lets you focus on your project instead of getting caught up in the deployment details.

Built by the Nomic Foundation for the Ethereum community.

Join the Hardhat Ignition channel of our Hardhat Community Discord server to stay up to date on new releases and tutorials.

Installation

# ethers users
npm install --save-dev @nomicfoundation/hardhat-ignition-ethers

# viem users
npm install --save-dev @nomicfoundation/hardhat-ignition-viem

Import the plugin in your `hardhat.config.js``:

// ethers users
require("@nomicfoundation/hardhat-ignition-ethers");

// viem users
require("@nomicfoundation/hardhat-ignition-viem");

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

// ethers users
import "@nomicfoundation/hardhat-ignition-ethers";

// viem users
import "@nomicfoundation/hardhat-ignition-viem";

Documentation

On Hardhat Ignition's website you will find guides for:

• Getting started
• Creating Modules
• Deploying a module
• Visualizing your module
• Handling errors
• Modifying an existing module
• Using Hardhat Ignition in your tests

Contributing

Contributions are always welcome! Feel free to open any issue or send a pull request.

Go to CONTRIBUTING.md to learn about how to set up Hardhat Ignition's development environment.

Feedback, help and news

Hardhat Ignition on Discord: for questions and feedback.

Follow Hardhat and Nomic Foundation on Twitter.