Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Foundry Setup Template

Test Slither License: MIT Foundry

A template repository for Foundry/Solidity projects with CI, static analysis, and auto-generated docs.

Quick Start

Prerequisites: Install Foundry

# Clone and set up
git clone https://github.com/owieth/foundry-setup
cd foundry-setup
forge install

# Copy environment variables
cp .env.example .env
# Fill in your values, then:
source .env

Local Development

Build & Test

forge build
forge test -vvvv
forge snapshot

Format

forge fmt
forge fmt --check

Generate Docs

forge doc
forge doc --serve  # preview at http://localhost:3000

Deploy

source .env
forge script script/<Script>.s.sol:<Contract> --rpc-url <chain> --broadcast --verify -vvvvv

Local Fork with Anvil

# Fresh local chain
anvil

# Fork Sepolia
anvil -f https://eth-sepolia.g.alchemy.com/v2/<your_api_key>

Contract Layout

Layout of **.sol:

  • version
  • imports
  • interfaces, libraries, contracts
  • usings (using ... for ...)
  • errors
  • type declarations
  • state variables
  • events
  • modifiers
  • functions

Layout of functions (inside **.sol after modifiers):

  • constructor
  • receive (if exists)
  • fallback (if exists)
  • external
  • public
  • internal
  • private
  • view & pure (last per visibility group)

More → STYLE.md