pappyj / solidity

Blockchain Developement Toolkit

Hardhat Boilerplate

Why ?

Thought to have a fast way of bootstraping projects with best practice's in mind. Having linters, prettiers, standards on how to commit, and changelog creation & maintenance.

---

How ?

This is achieved using several hardhat plugins, and external known packages.

---

Tools

This boilerplate includes:

• Hardhat
• Solhint
• Prettier
• Coverage
• Gas reporter
• Commitlint
• Standard version
• Uniswap + Internal tooling

---

Commands

Coverage

yarn coverage

Runs solidity code coverage

Fork

yarn fork

Runs a mainnet fork via hardhat's node forking util.

yarn fork:script {path}

Runs the script in mainnet's fork.

yarn fork:test

Runs tests that should be run in mainnet's fork.

Lint

yarn lint

Runs solhint.

Prettier (lint fix)

yarn lint:fix

Runs prettier

Release

yarn release

Runs standard changelog, changes package.json version and modifies CHANGELOG.md accordingly.

Test

yarn test

Runs all solidity tests.

yarn test:unit

Runs all solidity tests in folder unit

yarn test:e2e

Runs all solidity tests in folder e2e

Gas report

yarn test:gas

Runs all tests and report gas usage.