|
||
---|---|---|
.github/workflows | ||
.yarn | ||
lib | ||
script | ||
src | ||
test | ||
.commitlintrc.yml | ||
.editorconfig | ||
.env.example | ||
.gitignore | ||
.gitmodules | ||
.lintstagedrc | ||
.prettierignore | ||
.prettierrc.yml | ||
.solhint.json | ||
.solhintignore | ||
.yarnrc.yml | ||
LICENSE.md | ||
README.md | ||
foundry.toml | ||
package.json | ||
remappings.txt | ||
yarn.lock |
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 and test 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
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
yarn install # install solhint and prettier and other goodies
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 documentations.
For example, for Foundry, you can refer to the Foundry Book. You might be in particular interested in reading the Writing Tests guide.
Sensible Defaults
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
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.
Conventional Commits
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.
Git Hooks
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.
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. 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.
Usage
Here's 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
Deploy
Deploy to Anvil:
$ forge script script/Foo.s.sol:FooScript --fork-url http://localhost:8545 \
--broadcast --private-key $PRIVATE_KEY
For instructions on how to deploy to a testnet or mainnet, check out the Solidity Scripting tutorial.
Format
Format the contracts with Prettier:
$ yarn prettier
Gas Usage
Get a gas report:
$ forge test --gas-report
Lint
Lint the contracts:
$ yarn lint
Test
Run the tests:
$ forge test
Notes
- 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
.env
file, but filling in the environment variables may be useful when debugging and testing against a mainnet fork.
Related Efforts
- abigger87/femplate
- cleanunicorn/ethereum-smartcontract-template
- foundry-rs/forge-template
- FrankieIsLost/forge-template
License
MIT © Paul Razvan Berg