|
||
---|---|---|
.github | ||
.vscode | ||
lib | ||
script | ||
src | ||
test | ||
.editorconfig | ||
.env.example | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
.prettierignore | ||
.prettierrc.yml | ||
.solhint.json | ||
LICENSE.md | ||
README.md | ||
foundry.toml | ||
package.json | ||
pnpm-lock.yaml | ||
remappings.txt |
README.md
Foundry Template
![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)
A Foundry-based template for developing Solidity smart contracts, with sensible defaults.
What's Inside
- Forge: compile, test, fuzz, format, and deploy smart contracts
- Forge Std: collection of helpful contracts and cheatcodes for testing
- PRBTest: modern collection of testing assertions and logging utilities
- Prettier: code formatter for non-Solidity files
- Solhint: linter for Solidity code
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.
Or, if you prefer to install the template manually:
forge init my-project --template https://github.com/PaulRBerg/foundry-template
cd my-project
pnpm install # install Solhint, Prettier, and other Node.js deps
If this is your first time with Foundry, check out the installation instructions.
Features
This template builds upon the frameworks and libraries mentioned above, so for details about their specific features, please consult their respective documentation.
For example, if you're interested in exploring Foundry in more detail, you should look at the Foundry Book. In particular, you may be interested in reading the Writing Tests tutorial.
Sensible Defaults
This template comes with a set of sensible default configurations for you to use. These defaults can be found in the following files:
├── .editorconfig
├── .gitignore
├── .prettierignore
├── .prettierrc.yml
├── .solhint.json
├── foundry.toml
└── remappings.txt
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.
For guidance on how to integrate a Foundry project in VSCode, please refer to this guide.
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.
You can edit the CI script in .github/workflows/ci.yml.
Writing Tests
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. If you would like to view the logs in the terminal output you can add the
-vvv
flag and use console.log.
This template comes with an example test contract Foo.t.sol
Usage
This is a list of the most frequently needed commands.
Build
Build the contracts:
$ forge build
Clean
Delete the build artifacts and cache directories:
$ forge clean
Compile
Compile the contracts:
$ forge build
Coverage
Get a test coverage report:
$ forge coverage
Deploy
Deploy to Anvil:
$ forge script script/Deploy.s.sol --broadcast --fork-url http://localhost:8545
For this script to work, you need to have a MNEMONIC
environment variable set to a valid
BIP39 mnemonic.
For instructions on how to deploy to a testnet or mainnet, check out the Solidity Scripting tutorial.
Format
Format the contracts:
$ forge fmt
Gas Usage
Get a gas report:
$ forge test --gas-report
Lint
Lint the contracts:
$ pnpm lint
Test
Run the tests:
$ forge test
Notes
- Foundry uses git submodules to manage dependencies. For detailed instructions on working with dependencies, please refer to the guide in the book
- You don't have to create a
.env
file, but filling in the environment variables may be useful when debugging and testing against a fork.
Related Efforts
- abigger87/femplate
- cleanunicorn/ethereum-smartcontract-template
- foundry-rs/forge-template
- FrankieIsLost/forge-template
License
This project is licensed under MIT.