A Foundry-based template for developing Solidity smart contracts, with sensible defaults.
- Forge: compile, test, fuzz, debug and deploy smart contracts
- PRBTest: modern collection of testing assertions and logging utilities
- Forge Std: collection of helpful contracts and cheatcodes for testing
- Solhint: code linter
- Prettier Plugin Solidity: code formatter
Click the Use this template button at the top of the page to
create a new repository with this repo as the initial state.
Or, if you prefer to install the template manually:
forge init my-project --template https://github.com/paulrberg/foundry-template
cd my-project
yarn install # install solhint and prettier and other goodiesIf this is your first time with Foundry, check out the installation instructions.
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 Foundry, you can refer to the Foundry Book. You might be in particular interested in reading the Writing Tests guide.
This template comes with sensible default configurations in the following files:
├── .commitlintrc.yml
├── .editorconfig
├── .gitignore
├── .prettierignore
├── .prettierrc.yml
├── .solhintignore
├── .solhint.json
├── .yarnrc.yml
├── foundry.toml
└── remappings.txt
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.
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.
To write a new test contract, you start by importing PRBTest and inherit from
it in your test contract. PRBTest comes with a pre-instantiated cheatcodes
environment accessible via the vm property. You can also use
console.log, whose logs you can see in
the terminal output by adding the -vvvv flag.
This template comes with an example test contract Foo.t.sol.
Here's a list of the most frequently needed commands.
Build the contracts:
$ forge buildDelete the build artifacts and cache directories:
$ forge cleanCompile the contracts:
$ forge buildDeploy to Anvil:
$ forge script script/Foo.s.sol:FooScript --fork-url http://localhost:8545 \
--broadcast --private-key $PRIVATE_KEYFor instructions on how to deploy to a testnet or mainnet, check out the Solidity Scripting tutorial.
Format the contracts with Prettier:
$ yarn prettierGet a gas report:
$ forge test --gas-reportLint the contracts:
$ yarn lintRun the tests:
$ forge test- Foundry piggybacks off git submodules to manage dependencies. There's a guide about how to work with dependencies in the book.
- You don't have to create a
.envfile, but filling in the environment variables may be useful when debugging and testing against a mainnet fork.
- abigger87/femplate
- cleanunicorn/ethereum-smartcontract-template
- foundry-rs/forge-template
- FrankieIsLost/forge-template
MIT © Paul Razvan Berg