0xGabi / ignition

Ignition is Hardhat's deployment solution

Ignition

WARNING: This repository is highly experimental, and is under active development. Any code or binaries produced from this project should not be used in any production or critical workloads. The API is preliminary, the API will change.

Ignition is Hardhat's deployment solution. It is a Hardhat plugin that allows you to create declarative deployments that can be reproduced across different networks.

Built by the Nomic Foundation for the Ethereum community.

Join our Hardhat Support Discord server to stay up to date on new releases, plugins and tutorials.

Installation

npm install --save-dev @ignored/hardhat-ignition

And add the following statement to your hardhat.config.js:

require("@ignored/hardhat-ignition");

Or, if you are using TypeScript, add this to your hardhat.config.ts:

import "@ignored/hardhat-ignition";

Getting Started

See our Getting started guide for a worked example of Ignition usage.

Documentation

• Getting started
• Explanation
• Creating Modules for Deployments
  • Deploying a Contract
  • Calling contract methods
  • Including modules within modules
  • Module Parameters
  • Switching based on the Network Chain ID
• Using Ignition in Hardhat tests
• Running a deployment
  • Visualizing your deployment with the plan task
  • Executing the deployment

Examples

This repo contains example projects that show Ignition features in context (under ./examples):

• Sample - the Hardhat starter project enhanced with Ignition
• Typescript Sample - the Hardhat typescript starter project enhanced with Ignition
• ENS - deploy ENS and its registry for local testing
• Uniswap - deploy Uniswap and test swaps

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 Ignition's development environment.

Feedback, help and news

Hardhat Support Discord server: for questions and feedback.

Follow Hardhat on Twitter.