Badass hardhat setup

With this setup you get the following awesome things:

1. As you type in code it being compiled and deployed in real time to your local hardhat.
2. The address & ABI of the contract(s) is also being stored neatly in a json file.
3. No more accidentally re-deploying old contracts as it will skip them.
4. One command to verify contracts

This is all possible because of 🎉🎉 hardhat-deploy 🎉🎉.

Short video

In this video you will see what your setup will become like.

How to add new contracts

1. Add your contracts by creating a new *.sol file in the contracts directory.
2. Then create a *.js deployment script in the deploy directory for each contract you add.
3. You may copy-paste existing files to reduce errors.

How to run

1. In development do:
   1. npm run chain to get a local hardhat node going
   2. npm run deploy to monitor & deploy your contracts to your local chain.
2. When ready to move to testnet do:
   1. npm run deploy-goerli to deploy your new code to goerli chain.
   2. npm run verify-goerli to verify your new code on etherscan.
3. When ready to move to mainnet do:
   1. npm run deploy-mainnet to deploy your new code to mainnet chain.
   2. npm run verify-mainnet to verify your new code on etherscan.

Keys

Copy .env.example and setup your own .env file. In this file add your keys. Very Important to use your own keys.

Common Errors

1. When doing npm i or npm run chain you are getting error:

Error HH801: Plugin @nomicfoundation/hardhat-toolbox requires the following dependencies to be installed: @nomicfoundation/hardhat-network-helpers, @nomicfoundation/hardhat-chai-matchers, @nomiclabs/hardhat-ethers, @nomiclabs/hardhat-etherscan, @types/chai, @types/mocha, @typechain/ethers-v5, @typechain/hardhat, chai, hardhat-gas-reporter, solidity-coverage, ts-node, typechain, typescript.
Please run: npm install --save-dev "@nomicfoundation/hardhat-network-helpers@^1.0.0" "@nomicfoundation/hardhat-chai-matchers@^1.0.0" "@nomiclabs/hardhat-ethers@^2.0.0" "@nomiclabs/hardhat-etherscan@^3.0.0" "@types/chai@^4.2.0" "@types/mocha@^9.1.0" "@typechain/ethers-v5@^10.1.0" "@typechain/hardhat@^6.1.2" "chai@^4.2.0" "hardhat-gas-reporter@^1.0.8" "solidity-coverage@^0.8.1" "ts-node@>=8.0.0" "typechain@^8.1.0" "typescript@>=4.5.0"

The solution is to just install ☝️ the missing dependencies the error is telling you to install.

References

1. hardhat-deploy

Contribute

Please create a PR 🙏