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
• Deploy: replicable deployments and easy testing
• Ethers: renowned Ethereum library and wallet implementation
• Solhint: code linter
• SolCoverage: code coverage
• Prettier: code formatter
• DocsGen: docs generator

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.

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.

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
├── .npmrc
└── hardhat.config.ts

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 se your INFURA_API_KEY and your MNEMONIC as GitHub secrets.

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

This template enforces the Conventional Commits standard for git commit messages. This is a lightweight convention that creates an explicit commit history, which makes it easier to write automated tools on top of.

This template uses Husky to run automated checks on commit messages, and Lint Staged to automatically format the code with Prettier when making a git commit.

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:

$ pnpm install

Compile & Build the smart contracts with Hardhat:

$ pnpm build

Compile the smart contracts and generate TypeChain bindings:

$ pnpm typechain

Lint the Solidity code:

$ pnpm lint:sol

Lint the TypeScript code:

$ pnpm lint:ts

Run the tests with Hardhat:

$ pnpm test

Generate the code coverage report:

$ pnpm coverage

Generate docs for smart contracts:

$ pnpm docgen

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

$ pnpm report-gas

Startup local network:

$ pnpm localnet

Deploy the contracts to default network (Hardhat):

$ pnpm run deploy

For specific network, we need to add network flag

$ pnpm run deploy --network <network-name>

Export the contract deployed to a file with a simple format containing only contract addresses and abi:

$ pnpm export <filepath> --network <network-name>

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

$ pnpm clean

If you want more flexible over the existing scripts in the template, but tired to typing npx hardhat all the time and lazy to remember all the commands. Let's try this hardhat-completion packages.

Instead of typing npx hardhat, use hh then tab to see available commands.

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

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

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

MIT © Paul Razvan Berg