foundry-template: A Solidity repository from trozler

My Foundry Template

Extensions used

Install Juan Blanco
Install Solidity Visual Auditor

How to run

$ forge init my-project --template https://github.com/trozler/foundry-template
$ cd my-project

$ forge install
$ npm i

$ forge build
$ forge test

Dependencies and remappings

When installing dependencies to forge, please include the remapping in remappings.txt, this will stop Juan Blanco extension complaining.

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/master branch.

You can edit the CI script in .github/workflows/ci.yml.

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.

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

Deploy

Deploy to Anvil:

$ forge script script/SampleContract.s.sol:SampleContract --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.

Test

Run the tests:

$ forge test

Gas Usage

Get a gas report:

$ forge test --gas-report

Get a gas snapshot:

$ forge snapshot

Lint

Lint the contracts:

$ npm run lint

Format

Format the contracts with Prettier:

$ npm run prettier:write

Resources

https://book.getfoundry.sh/index.html https://github.com/foundry-rs/foundry

Inspired by

Inspired by Rari-Capital/solmate, and paulberg/foundry-template.