This is a list of the most frequently needed commands.

Build the contracts:

$ forge build

Delete the build artifacts and cache directories:

$ forge clean

Compile the contracts:

$ forge build

Get a test coverage report:

$ forge coverage

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 the contracts:

$ forge fmt

Get a gas report:

$ forge test --gas-report

Lint the contracts:

$ bun run lint

Run the tests:

$ forge test

Generate test coverage and output result to the terminal:

$ bun run test:coverage

Generate test coverage with lcov report (you'll have to open the ./coverage/index.html file in your browser, to do so simply copy paste the path):

$ bun run test:coverage:report

• abigger87/femplate
• cleanunicorn/ethereum-smartcontract-template
• foundry-rs/forge-template
• FrankieIsLost/forge-template

This project is licensed under BUSL 1.1.

Follow instructions to install solstat locally and run. Currently, named parameters in mappings causes solstat to panic and is unable to produce the solstat_report.md (issue).