A Foundry-based template for developing Solidity smart contracts, with sensible defaults.
This is a fork of PaulRBerg's template and adjusted to Vac's smart contracts unit's needs. See Upstream differences to learn more about how this template differs from Paul's.
- Forge: compile, test, fuzz, format, and deploy smart contracts
- Forge Std: collection of helpful contracts and cheatcodes for testing
- Solhint Community: linter for Solidity code
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:
$ mkdir my-project
$ cd my-project
$ forge init --template vacp2p/foundry-template
$ pnpm install # install Solhint, Prettier, and other Node.js depsIf 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 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.
As mentioned above, this template is a fork with adjustments specific to the needs of Vac's smart contract service unit. These differences are:
- Removal of PRBTest - In an attempt to keep dependence on third-party code low, we've decided to remove this library as a standard dependency of every project within Vac. If we do see a need for it, we might bring it back in the future.
- PROPERTIES.md - For invariant testing and formal verification, we've introduced a
PROPERTIES.mdto document all protocol properties that must hold true.
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
└── slither.config.json
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.
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.
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
This is a list of the most frequently needed commands.
Build the contracts:
$ forge buildDelete the build artifacts and cache directories:
$ forge cleanCompile the contracts:
$ forge buildGet a test coverage report:
$ forge coverageDeploy to Anvil:
$ forge script script/Deploy.s.sol --broadcast --fork-url http://localhost:8545For 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 the contracts:
$ forge fmtGet a gas report:
$ forge test --gas-reportLint the contracts:
$ pnpm lintFor any errors in solidity files, run forge fmt. For errors in any other file type, run pnpm prettier:write.
Run the tests:
$ forge test- 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
.envfile, but filling in the environment variables may be useful when debugging and testing against a fork.
- abigger87/femplate
- cleanunicorn/ethereum-smartcontract-template
- foundry-rs/forge-template
- FrankieIsLost/forge-template
This project is licensed under MIT.