Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nomicfoundation/hardhat-ignition
Hardhat Ignition is a declarative deployment system that enables you to deploy your smart contracts without navigating the mechanics of the deployment process.
https://github.com/nomicfoundation/hardhat-ignition
deployment hardhat solidity
Last synced: 3 days ago
JSON representation
Hardhat Ignition is a declarative deployment system that enables you to deploy your smart contracts without navigating the mechanics of the deployment process.
- Host: GitHub
- URL: https://github.com/nomicfoundation/hardhat-ignition
- Owner: NomicFoundation
- License: mit
- Created: 2021-09-21T14:07:23.000Z (over 3 years ago)
- Default Branch: development
- Last Pushed: 2025-01-07T17:23:14.000Z (15 days ago)
- Last Synced: 2025-01-19T07:06:21.801Z (3 days ago)
- Topics: deployment, hardhat, solidity
- Language: TypeScript
- Homepage: https://hardhat.org/ignition
- Size: 5.78 MB
- Stars: 112
- Watchers: 3
- Forks: 32
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@nomicfoundation/hardhat-ignition) [](https://hardhat.org) [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/NomicFoundation/hardhat-ignition.git)
---
# 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](https://nomic.foundation/) for the Ethereum community.
Join the Hardhat Ignition channel of our [Hardhat Community Discord server](https://hardhat.org/ignition-discord) to stay up to date on new releases and tutorials.
## Installation
```bash
# 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``:
```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``:
```js
// ethers users
import "@nomicfoundation/hardhat-ignition-ethers";
// viem users
import "@nomicfoundation/hardhat-ignition-viem";
```
## Documentation
On [Hardhat Ignition's website](https://hardhat.org/ignition) you will find guides for:
- [Getting started](https://hardhat.org/ignition/docs/getting-started)
- [Creating Modules](https://hardhat.org/ignition/docs/guides/creating-modules)
- [Deploying a module](https://hardhat.org/ignition/docs/guides/deploy)
- [Visualizing your module](https://hardhat.org/ignition/docs/guides/visualize)
- [Handling errors](https://hardhat.org/ignition/docs/guides/error-handling)
- [Modifying an existing module](https://hardhat.org/ignition/docs/guides/modifications)
- [Using Hardhat Ignition in your tests](https://hardhat.org/ignition/docs/guides/tests)
## Contributing
Contributions are always welcome! Feel free to open any issue or send a pull request.
Go to [CONTRIBUTING.md](https://github.com/NomicFoundation/hardhat-ignition/blob/main/CONTRIBUTING.md) to learn about how to set up Hardhat Ignition's development environment.
## Feedback, help and news
[Hardhat Ignition on Discord](https://hardhat.org/ignition-discord): for questions and feedback.
Follow [Hardhat](https://twitter.com/HardhatHQ) and [Nomic Foundation](https://twitter.com/NomicFoundation) on Twitter.