A Hardhat-based template for developing smart contract in Solidity
- Hardhat: compile, run and test smart contracts
- TypeChain: generate TypeScript bindings for smart contracts
- Ethers: renowned Ethereum library and wallet implementation
- Solhint: solidity linter
- Eslint: code linter
- Solcover: code coverage
- Prettier Plugin Solidity: code formatter
- Husky: Git hooks
Click the Use this template button at the top of the page to
create a new repository with this repo as the initial state.
This template builds upon the frameworks and libraries mentioned above, so for details about their specific features, please consult their respective documentations.
This template comes with sensible default configurations in the following files:
├── .commitlintrc.yml
├── .editorconfig
├── .eslintignore
├── .eslintrc.yml
├── .gitignore
├── .prettierignore
├── .prettierrc.yml
├── .solcover.js
├── .solhintignore
├── .solhint.json
├── .yarnrc.yml
└── hardhat.config.ts
Before being able to run any command, you need to create a .env file and set a BIP-39 compatible mnemonic as an
environment variable. You can follow the example in .env.example. If you don't already have a mnemonic, you can use
this website to generate one.
Then, proceed with installing dependencies:
$ yarn installCompile the smart contracts with Hardhat:
$ yarn compileCompile the smart contracts and generate TypeChain bindings:
$ yarn typechainRun the tests with Hardhat:
$ yarn testLint the Solidity code:
$ yarn lint:solLint the TypeScript code:
$ yarn lint:tsGenerate the code coverage report:
$ yarn coverageSee the gas usage per unit test and average gas per method call:
$ REPORT_GAS=true yarn testDelete the smart contract artifacts, the coverage reports and the Hardhat cache:
$ yarn cleanDeploy the contracts to Hardhat Network:
$ yarn deploy --greeting "Bonjour, le monde!"chmod ug+x .husky/*
chmod ug+x .git/hooks/*MIT © Nguyễn Đình Trường