Foundry Book

Foundry is a smart contract development toolchain.

Foundry manages your dependencies, compiles your project, runs tests, deploys, and lets you interact with the chain from the command-line and via Solidity scripts.

✨ Announcements

Stay up to date with the latest changes to Foundry.

📖 Contributing

You can contribute to this book on GitHub.

Sections

Getting Started

To get started with Foundry, install Foundry and set up your first project.

Projects

This section will give you an overview of how to create and work with existing projects.

Forge Overview

The overview will give you all you need to know about how to use forge to develop, test, and deploy smart contracts.

Cast Overview

Learn how to use cast to interact with smart contracts, send transactions, and get chain data from the command-line.

Anvil Overview

Learn about anvil, Foundry’s local node.

Chisel Overview

Learn how to use chisel, Foundry’s integrated Solidity REPL.

Configuration

Guides on configuring Foundry.

• Configuring with foundry.toml
• Continuous Integration
• Integrating with VSCode
• Shell Autocompletion
• Static Analyzers
• Integrating with Hardhat
• Vyper support

Guides

Guides for building smart contracts with Foundry.

• Foundry v1.0 migration guide
• Best Practices
• Scripting with Solidity
• Deterministic deployments using CREATE2
• Forking Mainnet with Cast and Anvil
• Running Foundry inside of Docker
• Video tutorials

Contributing

Help us improve Foundry: Contributing

Appendix

References, troubleshooting, and more.

• Announcements
• FAQ
• CLI Reference
• forge Commands
• cast Commands
• anvil Commands
• chisel Commands
• Config Reference
• Cheatcodes Reference
• Forge Standard Library Reference
• DSTest Reference
• Miscellaneous

You can also check out Awesome Foundry, a curated list of awesome Foundry resources, guides, tools, and libraries!