Introduction
Getting Started
1.
Installation
2.
First Steps with Foundry
Projects
3.
Creating a New Project
4.
Working on an Existing Project
5.
Dependencies
6.
Project Layout
Forge Overview
7.
Overview of Forge
8.
Tests
❱
8.1.
Writing Tests
8.2.
Cheatcodes
8.3.
Forge Standard Library Overview
8.4.
Understanding Traces
8.5.
Fork Testing
9.
Advanced Testing
❱
9.1.
Fuzz Testing
9.2.
Invariant Testing
9.3.
Differential Testing
10.
Deploying and Verifying
11.
Gas Tracking
❱
11.1.
Gas Reports
11.2.
Gas Snapshots
12.
Debugger
Cast Overview
13.
Overview of Cast
Anvil Overview
14.
Overview of Anvil
Chisel Overview
15.
Overview of Chisel
Configuration
16.
Configuring with foundry.toml
17.
Continuous Integration
18.
Integrating with VSCode
19.
Shell Autocompletion
20.
Static Analyzers
21.
Integrating with Hardhat
Tutorials
22.
Best Practices
23.
Creating an NFT with Solmate
24.
Docker and Foundry
25.
Testing EIP-712 Signatures
26.
Solidity Scripting
27.
Deterministic deployment using CREATE2
28.
Forking Mainnet with Cast and Anvil
29.
Learning Foundry Videos
Appendix
30.
FAQ
31.
Help us improve Foundry
32.
References
❱
32.1.
CLI Reference
❱
32.1.1.
forge
❱
32.1.1.1.
forge bind
32.1.1.2.
forge build
32.1.1.3.
forge cache
❱
32.1.1.3.1.
forge cache clean
32.1.1.3.2.
forge cache ls
32.1.1.4.
forge clean
32.1.1.5.
forge completions
32.1.1.6.
forge config
32.1.1.7.
forge coverage
32.1.1.8.
forge create
32.1.1.9.
forge debug
32.1.1.10.
forge doc
32.1.1.11.
forge flatten
32.1.1.12.
forge fmt
32.1.1.13.
forge geiger
32.1.1.14.
forge generate
❱
32.1.1.14.1.
forge generate test
32.1.1.15.
forge generate-fig-spec
32.1.1.16.
forge init
32.1.1.17.
forge inspect
32.1.1.18.
forge install
32.1.1.19.
forge remappings
32.1.1.20.
forge remove
32.1.1.21.
forge script
32.1.1.22.
forge selectors
❱
32.1.1.22.1.
forge selectors collision
32.1.1.22.2.
forge selectors upload
32.1.1.22.3.
forge selectors list
32.1.1.23.
forge snapshot
32.1.1.24.
forge test
32.1.1.25.
forge tree
32.1.1.26.
forge update
32.1.1.27.
forge verify-check
32.1.1.28.
forge verify-contract
32.1.2.
cast
❱
32.1.2.1.
cast 4byte
32.1.2.2.
cast 4byte-decode
32.1.2.3.
cast 4byte-event
32.1.2.4.
cast abi-decode
32.1.2.5.
cast abi-encode
32.1.2.6.
cast access-list
32.1.2.7.
cast address-zero
32.1.2.8.
cast admin
32.1.2.9.
cast age
32.1.2.10.
cast balance
32.1.2.11.
cast base-fee
32.1.2.12.
cast bind
32.1.2.13.
cast block
32.1.2.14.
cast block-number
32.1.2.15.
cast call
❱
32.1.2.15.1.
cast call --create
32.1.2.16.
cast calldata
32.1.2.17.
cast calldata-decode
32.1.2.18.
cast chain
32.1.2.19.
cast chain-id
32.1.2.20.
cast client
32.1.2.21.
cast code
32.1.2.22.
cast codesize
32.1.2.23.
cast completions
32.1.2.24.
cast compute-address
32.1.2.25.
cast concat-hex
32.1.2.26.
cast create2
32.1.2.27.
cast decode-transaction
32.1.2.28.
cast disassemble
32.1.2.29.
cast estimate
❱
32.1.2.29.1.
cast estimate --create
32.1.2.30.
cast etherscan-source
32.1.2.31.
cast find-block
32.1.2.32.
cast format-bytes32-string
32.1.2.33.
cast from-bin
32.1.2.34.
cast from-fixed-point
32.1.2.35.
cast from-rlp
32.1.2.36.
cast from-utf8
32.1.2.37.
cast from-wei
32.1.2.38.
cast gas-price
32.1.2.39.
cast generate-fig-spec
32.1.2.40.
cast hash-zero
32.1.2.41.
cast implementation
32.1.2.42.
cast index
32.1.2.43.
cast interface
32.1.2.44.
cast keccak
32.1.2.45.
cast logs
32.1.2.46.
cast lookup-address
32.1.2.47.
cast max-int
32.1.2.48.
cast max-uint
32.1.2.49.
cast min-int
32.1.2.50.
cast namehash
32.1.2.51.
cast nonce
32.1.2.52.
cast parse-bytes32-address
32.1.2.53.
cast parse-bytes32-string
32.1.2.54.
cast pretty-calldata
32.1.2.55.
cast proof
32.1.2.56.
cast publish
32.1.2.57.
cast receipt
32.1.2.58.
cast resolve-name
32.1.2.59.
cast rpc
32.1.2.60.
cast run
32.1.2.61.
cast selectors
32.1.2.62.
cast send
❱
32.1.2.62.1.
cast send --create
32.1.2.63.
cast shl
32.1.2.64.
cast shr
32.1.2.65.
cast sig
32.1.2.66.
cast sig-event
32.1.2.67.
cast storage
32.1.2.68.
cast to-ascii
32.1.2.69.
cast to-base
32.1.2.70.
cast to-bytes32
32.1.2.71.
cast to-check-sum-address
32.1.2.72.
cast to-dec
32.1.2.73.
cast to-fixed-point
32.1.2.74.
cast to-hex
32.1.2.75.
cast to-hexdata
32.1.2.76.
cast to-int256
32.1.2.77.
cast to-rlp
32.1.2.78.
cast to-uint256
32.1.2.79.
cast to-unit
32.1.2.80.
cast to-wei
32.1.2.81.
cast tx
32.1.2.82.
cast upload-signature
32.1.2.83.
cast wallet
❱
32.1.2.83.1.
cast wallet new
32.1.2.83.2.
cast wallet new-mnemonic
32.1.2.83.3.
cast wallet vanity
32.1.2.83.4.
cast wallet address
32.1.2.83.5.
cast wallet sign
32.1.2.83.6.
cast wallet verify
32.1.2.83.7.
cast wallet import
32.1.2.83.8.
cast wallet list
32.1.2.83.9.
cast wallet derive-private-key
32.1.3.
anvil
❱
32.1.3.1.
anvil completions
32.1.3.2.
anvil generate-fig-spec
32.1.4.
chisel
❱
32.1.4.1.
chisel list
32.1.4.2.
chisel load
32.1.4.3.
chisel view
32.1.4.4.
chisel clear-cache
32.2.
forge Commands
❱
32.2.1.
General Commands
❱
32.2.1.1.
forge
32.2.1.2.
forge help
32.2.1.3.
forge completions
32.2.2.
Project Commands
❱
32.2.2.1.
forge init
32.2.2.2.
forge install
32.2.2.3.
forge update
32.2.2.4.
forge remove
32.2.2.5.
forge config
32.2.2.6.
forge remappings
32.2.2.7.
forge tree
32.2.2.8.
forge geiger
32.2.3.
Build Commands
❱
32.2.3.1.
forge build
32.2.3.2.
forge clean
32.2.3.3.
forge inspect
32.2.4.
Test Commands
❱
32.2.4.1.
forge test
32.2.4.2.
forge snapshot
32.2.4.3.
forge coverage
32.2.5.
Deploy Commands
❱
32.2.5.1.
forge create
32.2.5.2.
forge verify-contract
32.2.5.3.
forge verify-check
32.2.5.4.
forge flatten
32.2.6.
Utility Commands
❱
32.2.6.1.
forge debug
32.2.6.2.
forge bind
32.2.6.3.
forge cache
32.2.6.4.
forge cache clean
32.2.6.5.
forge cache ls
32.2.6.6.
forge script
32.2.6.7.
forge upload-selectors
32.2.6.8.
forge doc
32.3.
cast Commands
❱
32.3.1.
General Commands
❱
32.3.1.1.
cast
32.3.1.2.
cast help
32.3.1.3.
cast completions
32.3.2.
Chain Commands
❱
32.3.2.1.
cast chain-id
32.3.2.2.
cast chain
32.3.2.3.
cast client
32.3.3.
Transaction Commands
❱
32.3.3.1.
cast publish
32.3.3.2.
cast receipt
32.3.3.3.
cast send
32.3.3.4.
cast call
32.3.3.5.
cast rpc
32.3.3.6.
cast tx
32.3.3.7.
cast run
32.3.3.8.
cast estimate
32.3.3.9.
cast access-list
32.3.3.10.
cast logs
32.3.4.
Block Commands
❱
32.3.4.1.
cast find-block
32.3.4.2.
cast gas-price
32.3.4.3.
cast block-number
32.3.4.4.
cast basefee
32.3.4.5.
cast block
32.3.4.6.
cast age
32.3.5.
Account Commands
❱
32.3.5.1.
cast balance
32.3.5.2.
cast storage
32.3.5.3.
cast proof
32.3.5.4.
cast nonce
32.3.5.5.
cast code
32.3.5.6.
cast codesize
32.3.6.
ENS Commands
❱
32.3.6.1.
cast lookup-address
32.3.6.2.
cast resolve-name
32.3.6.3.
cast namehash
32.3.7.
Etherscan Commands
❱
32.3.7.1.
cast etherscan-source
32.3.8.
ABI Commands
❱
32.3.8.1.
cast abi-decode
32.3.8.2.
cast abi-encode
32.3.8.3.
cast 4byte
32.3.8.4.
cast 4byte-decode
32.3.8.5.
cast 4byte-event
32.3.8.6.
cast calldata
32.3.8.7.
cast calldata-decode
32.3.8.8.
cast pretty-calldata
32.3.8.9.
cast selectors
32.3.8.10.
cast upload-signature
32.3.9.
Conversion Commands
❱
32.3.9.1.
cast format-bytes32-string
32.3.9.2.
cast from-bin
32.3.9.3.
cast from-fixed-point
32.3.9.4.
cast from-rlp
32.3.9.5.
cast from-utf8
32.3.9.6.
cast from-wei
32.3.9.7.
cast parse-bytes32-address
32.3.9.8.
cast parse-bytes32-string
32.3.9.9.
cast to-ascii
32.3.9.10.
cast to-base
32.3.9.11.
cast to-bytes32
32.3.9.12.
cast to-dec
32.3.9.13.
cast to-fixed-point
32.3.9.14.
cast to-hex
32.3.9.15.
cast to-hexdata
32.3.9.16.
cast to-int256
32.3.9.17.
cast to-rlp
32.3.9.18.
cast to-uint256
32.3.9.19.
cast to-unit
32.3.9.20.
cast to-wei
32.3.9.21.
cast shl
32.3.9.22.
cast shr
32.3.10.
Utility Commands
❱
32.3.10.1.
cast sig
32.3.10.2.
cast sig-event
32.3.10.3.
cast keccak
32.3.10.4.
cast compute-address
32.3.10.5.
cast create2
32.3.10.6.
cast interface
32.3.10.7.
cast index
32.3.10.8.
cast concat-hex
32.3.10.9.
cast max-int
32.3.10.10.
cast min-int
32.3.10.11.
cast max-uint
32.3.10.12.
cast to-check-sum-address
32.3.11.
Wallet Commands
❱
32.3.11.1.
cast wallet
32.3.11.2.
cast wallet new
32.3.11.3.
cast wallet new-mnemonic
32.3.11.4.
cast wallet address
32.3.11.5.
cast wallet sign
32.3.11.6.
cast wallet vanity
32.3.11.7.
cast wallet verify
32.3.11.8.
cast wallet import
32.3.11.9.
cast wallet list
32.4.
anvil Reference
32.5.
chisel Reference
32.6.
Config Reference
❱
32.6.1.
Overview
32.6.2.
Project
32.6.3.
Solidity Compiler
32.6.4.
Testing
32.6.5.
In-line Configuration Testing
32.6.6.
Formatter
32.6.7.
Documentation Generator
32.6.8.
Etherscan
32.7.
Cheatcodes Reference
❱
32.7.1.
Environment
❱
32.7.1.1.
warp
32.7.1.2.
roll
32.7.1.3.
fee
32.7.1.4.
getBlockTimestamp
32.7.1.5.
getBlockNumber
32.7.1.6.
difficulty
32.7.1.7.
prevrandao
32.7.1.8.
chainId
32.7.1.9.
store
32.7.1.10.
load
32.7.1.11.
etch
32.7.1.12.
deal
32.7.1.13.
prank
32.7.1.14.
startPrank
32.7.1.15.
stopPrank
32.7.1.16.
readCallers
32.7.1.17.
record
32.7.1.18.
accesses
32.7.1.19.
recordLogs
32.7.1.20.
getRecordedLogs
32.7.1.21.
setNonce
32.7.1.22.
getNonce
32.7.1.23.
mockCall
32.7.1.24.
mockCallRevert
32.7.1.25.
clearMockedCalls
32.7.1.26.
coinbase
32.7.1.27.
broadcast
32.7.1.28.
startBroadcast
32.7.1.29.
stopBroadcast
32.7.1.30.
pauseGasMetering
32.7.1.31.
resumeGasMetering
32.7.1.32.
txGasPrice
32.7.1.33.
startStateDiffRecording
32.7.1.34.
stopAndReturnStateDiff
32.7.2.
Assertions
❱
32.7.2.1.
expectRevert
32.7.2.2.
expectEmit
32.7.2.3.
expectCall
32.7.3.
Fuzzer
❱
32.7.3.1.
assume
32.7.4.
Forking
❱
32.7.4.1.
createFork
32.7.4.2.
selectFork
32.7.4.3.
createSelectFork
32.7.4.4.
activeFork
32.7.4.5.
rollFork
32.7.4.6.
makePersistent
32.7.4.7.
revokePersistent
32.7.4.8.
isPersistent
32.7.4.9.
allowCheatcodes
32.7.4.10.
transact
32.7.5.
External
❱
32.7.5.1.
ffi
32.7.5.2.
projectRoot
32.7.5.3.
getCode
32.7.5.4.
getDeployedCode
32.7.5.5.
sleep
32.7.5.6.
unixTime
32.7.5.7.
setEnv
32.7.5.8.
envOr
32.7.5.9.
envBool
32.7.5.10.
envUint
32.7.5.11.
envInt
32.7.5.12.
envAddress
32.7.5.13.
envBytes32
32.7.5.14.
envString
32.7.5.15.
envBytes
32.7.5.16.
parseJson
32.7.5.17.
keyExists
32.7.5.18.
parseJsonKeys
32.7.5.19.
serializeJson
32.7.5.20.
writeJson
32.7.6.
Utilities
❱
32.7.6.1.
addr
32.7.6.2.
sign
32.7.6.3.
skip
32.7.6.4.
label
32.7.6.5.
getLabel
32.7.6.6.
deriveKey
32.7.6.7.
parseBytes
32.7.6.8.
parseAddress
32.7.6.9.
parseUint
32.7.6.10.
parseInt
32.7.6.11.
parseBytes32
32.7.6.12.
parseBool
32.7.6.13.
rememberKey
32.7.6.14.
toString
32.7.6.15.
breakpoint
32.7.6.16.
createWallet
32.7.7.
Snapshots
32.7.8.
RPC
32.7.9.
Files
32.8.
Forge Standard Library Reference
❱
32.8.1.
Std Logs
32.8.2.
Std Assertions
❱
32.8.2.1.
fail
32.8.2.2.
assertFalse
32.8.2.3.
assertEq
32.8.2.4.
assertApproxEqAbs
32.8.2.5.
assertApproxEqRel
32.8.3.
Std Cheats
❱
32.8.3.1.
skip
32.8.3.2.
rewind
32.8.3.3.
hoax
32.8.3.4.
startHoax
32.8.3.5.
deal
32.8.3.6.
deployCode
32.8.3.7.
deployCodeTo
32.8.3.8.
bound
32.8.3.9.
changePrank
32.8.3.10.
makeAddr
32.8.3.11.
makeAddrAndKey
32.8.3.12.
noGasMetering
32.8.3.13.
assumeNoPrecompiles
32.8.3.14.
assumePayable
32.8.4.
Std Errors
❱
32.8.4.1.
assertionError
32.8.4.2.
arithmeticError
32.8.4.3.
divisionError
32.8.4.4.
enumConversionError
32.8.4.5.
encodeStorageError
32.8.4.6.
popError
32.8.4.7.
indexOOBError
32.8.4.8.
memOverflowError
32.8.4.9.
zeroVarError
32.8.5.
Std Storage
❱
32.8.5.1.
target
32.8.5.2.
sig
32.8.5.3.
with_key
32.8.5.4.
depth
32.8.5.5.
checked_write
32.8.5.6.
find
32.8.5.7.
read
32.8.6.
Std Math
❱
32.8.6.1.
abs
32.8.6.2.
delta
32.8.6.3.
percentDelta
32.8.7.
Script Utils
❱
32.8.7.1.
computeCreateAddress
32.8.7.2.
deriveRememberKey
32.8.8.
Console Logging
32.9.
DSTest Reference
33.
Miscellaneous
❱
33.1.
Struct encoding
33.2.
Precompile Registry
Light
Rust
Coal
Navy
Ayu (default)
Foundry Book
Config Reference
Overview
Project
Solidity Compiler
Testing
In-line test configuration
Formatter
Documentation Generator
Etherscan