Foundry Boilerplate

Simple boilerplate for getting started quickly developing Foundry projects.

Getting started

Make sure to read the installation guide if this is the first time when using Foundry.

Create a new Foundry project based on this template using the following command:

forge init myProject --template https://github.com/gabrielstoica/foundry-boilerplate/
cd myProject
forge compile

Features

The foundry.toml file contains the most used foundry configurations in order to interact with custom rpc_endpoints, verify your smart contracts on etehrscan or adjust the verbosity level and the amount of fuzz runs.

In order to update the rpc_endpoints, create a new .env file based on the existing .env.example file and customize it to your needs. Currently, there are only two rpc_endpoints available: mainnet and sepolia:

[rpc_endpoints]
mainnet = "${MAINNET_RPC_URL}"
sepolia = "${SEPOLIA_RPC_URL}"

Usage

Compile

Use the following command to compile all the project's smart contracts:

forge compile

Build

Use the following command to build all the project's smart contracts:

forge build

Clean

Use the following command to remove the build artifacts and cache directories:

forge clean

Test

Use the following command to run all the project's tests:

forge test

Deploy

Use the following command to deploy the smart contract on Sepolia testnet:

forge script script/Counter.s.sol FOO_VALUE BAR_VALUE --sig "run(uint256,string)" --rpc-url sepolia --broadcast --verify

If you want to test the deployment process locally:

1. Start Anvil:

anvil

2. Update the .env file with a private key given to you by Anvil.
3. Run the deployment command:

forge script script/Counter.s.sol:Counter FOO_VALUE BAR_VALUE --sig "run(uint256,string)" --fork-url http://localhost:8545 --broadcast