My favorite setup for writing Solidity smart contracts.
- Hardhat: compile and run the smart contracts on a local development network
- TypeChain: generate TypeScript types for smart contracts
- Ethers: renowned Ethereum library and wallet implementation
- Waffle: tooling for writing comprehensive smart contract tests
- Solhint: linter
- Solcover: code coverage
- Prettier Plugin Solidity: code formatter
This is a GitHub template, which means you can reuse it as many times as you want. You can do that by clicking the "Use this template" button at the top of the page.
Before running any command, you need to create a .env
file and set a BIP-39 compatible mnemonic as an environment
variable. Follow the example in .env.example
. If you don't already have a mnemonic, use this website to generate one.
Then, proceed with installing dependencies:
$ yarn install
Compile the smart contracts with Hardhat:
$ yarn compile
Compile the smart contracts and generate TypeChain artifacts:
$ yarn typechain
Lint the Solidity code:
$ yarn lint:sol
Lint the TypeScript code:
$ yarn lint:ts
Run the Mocha tests:
$ yarn test
Generate the code coverage report:
$ yarn coverage
See the gas usage per unit test and average gas per method call:
$ REPORT_GAS=true yarn test
Delete the smart contract artifacts, the coverage reports and the Hardhat cache:
$ yarn clean
Deploy the contracts to Hardhat Network:
$ yarn deploy --greeting "Bonjour, le monde!"
If you use VSCode, you can enjoy syntax highlighting for your Solidity code via the hardhat-vscode extension.
If you can't get the Waffle matchers to work, try to
make your ethers
package version match the version used by the @ethereum-waffle/chai
package. Seem
#111 for more details.
Install tronbox
npm install -g tronbox
Create .env file and change PRIVATE_KEY_SHASTA
tronbox compile --compile-all
source .env && tronbox migrate --reset --network shasta
Clean CRUD operations thanks to sets lib by https://github.com/rob-Hitchens!
If you experience problems with Node. Enforce version 16. nvm use -g 16