Hardhat Template

A Hardhat-based template for developing Solidity smart contracts, with sensible defaults.

• Hardhat: compile, run and test smart contracts
• TypeChain: generate TypeScript bindings for smart contracts
• Ethers: renowned Ethereum library and wallet implementation
• Solhint: code linter
• Solcover: code coverage
• Prettier Plugin Solidity: code formatter

Getting Started

Click the Use this template button at the top of the page to create a new repository with this repo as the initial state.

Features

This template builds upon the frameworks and libraries mentioned above, so for details about their specific features, please consult their respective documentations.

For example, for Hardhat, you can refer to the Hardhat Tutorial and the Hardhat Docs. You might be in particular interested in reading the Testing Contracts section.

Sensible Defaults

This template comes with sensible default configurations in the following files:

├── .editorconfig
├── .eslintignore
├── .eslintrc.yml
├── .gitignore
├── .prettierignore
├── .prettierrc.yml
├── .solcover.js
├── .solhint.json
└── hardhat.config.ts

VSCode Integration

This template is IDE agnostic, but for the best user experience, you may want to use it in VSCode alongside Nomic Foundation's Solidity extension.

GitHub Actions

This template comes with GitHub Actions pre-configured. Your contracts will be linted and tested on every push and pull request made to the main branch.

Note though that to make this work, you must use your INFURA_API_KEY and your MNEMONIC as GitHub secrets.

For more information on how to set up GitHub secrets, check out the docs.

You can edit the CI script in .github/workflows/ci.yml.

Usage

Pre Requisites

First, you need to install the dependencies:

$ bun install

Then, you need to set up all the required Hardhat Configuration Variables. You might also want to install some that are optional.

To assist with the setup process, run bunx hardhat vars setup. To set a particular value, such as a BIP-39 mnemonic variable, execute this:

$ bunx hardhat vars set MNEMONIC
? Enter value: ‣ here is where your twelve words mnemonic should be put my friend

If you do not already have a mnemonic, you can generate one using this website.

Compile

Compile the smart contracts with Hardhat:

$ bun run compile

TypeChain

Compile the smart contracts and generate TypeChain bindings:

$ bun run typechain

Test

Run the tests with Hardhat:

$ bun run test

Lint Solidity

Lint the Solidity code:

$ bun run lint:sol

Lint TypeScript

Lint the TypeScript code:

$ bun run lint:ts

Coverage

Generate the code coverage report:

$ bun run coverage

Report Gas

See the gas usage per unit test and average gas per method call:

$ REPORT_GAS=true bun run test

Clean

Delete the smart contract artifacts, the coverage reports and the Hardhat cache:

$ bun run clean

Deploy

Deploy the contracts to Hardhat Network:

$ bun run deploy:contracts

Tasks

Deploy Lock

Deploy a new instance of the Lock contract via a task:

$ bun run task:deployLock --unlock 100 --value 0.1

Syntax Highlighting

If you use VSCode, you can get Solidity syntax highlighting with the hardhat-solidity extension.

Using GitPod

GitPod is an open-source developer platform for remote development.

To view the coverage report generated by bun run coverage, just click Go Live from the status bar to turn the server on/off.

Local development with Ganache

Install Ganache

$ npm i -g ganache

Run a Development Blockchain

$ ganache -s test

The -s test passes a seed to the local chain and makes it deterministic

Make sure to set the mnemonic in your .env file to that of the instance running with Ganache.

License

This project is licensed under MIT.