Solidity Template

Template for Solidity projects with a suite of useful tools pre-installed.

Tools used

• foundry: compiles, tests and deploys Solidity smart contracts
• yarn: manages project dependencies
• prettier: formats non-Solidity files
• solhint-community: lints Solidity smart contracts
• husky: runs git hooks
• lint-staged: lints only staged files (in hooks)
• codecov: coverage report and enforcing

Note: Make sure foundry and yarn are installed before proceeding

Recommended VSCode extensions

• Prettier Formatter
• Solidity by Nomic Foundation
• EditorConfig

Github Actions

CI is preconfigured to:

1. check formatting and linting
2. build smart contracts
3. run tests
4. check test coverage percentage and upload report to codecov

Note: You need to set a CODECOV_TOKEN repository secret that holds your access token, see Codecov docs explaining how to generate and set your token

Installing Dependencies

While Foundry typically uses Git submodules to manage dependencies, this template opts for Node.js packages for better scalability.

To install dependencies:

1. Install an npm dependency:

yarn add dependency-name

1. Install a GitHub dependency:

yarn add github:username/repo-name#tag-branch-or-hash

2. Add the dependency to remappings.txt:

@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/
forge-std/=node_modules/forge-std/src/
dependency-name=node_modules/dependency-name

Note: OpenZeppelin Contracts is pre-installed. You can follow its example for other dependencies.

Useful commands

Build smart contracts:

yarn build

Clean build artifacts and cache :

yarn clean

Generate test coverage:

yarn coverage

Format files:

yarn fmt

Lint files:

yarn lint

Run tests:

yarn test

Inspiration

This template is inspired by the following repositories:

• https://github.com/PaulRBerg/foundry-template
• https://github.com/OpenZeppelin/openzeppelin-contracts
• https://github.com/zkemail/email-recovery

License

This project is licensed under MIT.