Hardhat template

Template hardhat repository for ad-hoc smart contracts development.

How to use

The template works out of the box. To clean up the repo, you may need to delete the mock contracts, tests and migration files.

Compilation

To compile the contracts, use the next script:

npm run compile

Test

To run the tests, execute the following command:

npm run test

Or to see the coverage, run:

npm run coverage

Local deployment

To deploy the contracts locally, run the following commands (in the different terminals):

npm run private-network
npm run deploy-localhost

Bindings

The command to generate the bindings is as follows:

npm run generate-types

See the full list of available commands in the package.json file.

Integrated plugins

• Hardhat official ethers + ethers-v6
• Typechain
• hardhat-migrate, hardhat-markup, hardhat-gobind
• hardhat-zkit, chai-zkit
• hardhat-contract-sizer
• hardhat-gas-reporter
• solidity-coverage

Other niceties

• The template comes with presetup prettier, solhint and eslint that lint the project via husky before compilation hook.
• The .env.example file is provided to check what is required as ENVs
• Preinstalled @openzeppelin/contracts and @solarity/solidity-lib

Install the ESLint extension in VSCode to enable ESLint.