Book

📖 Foundry Docs

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

<!-- ALL-CONTRIBUTORS-BADGE:END -->

Documentation on all things Foundry. Read now.

Contributing

Check our contributing guidelines. Feel free to contribute wording, sentences, chapters, and guides!

The book is built with vocs. Install dependencies with bun install.

To see the book change live run:

bun dev

To add a new section (file) to the book, add it to sidebar.ts.

For a more structured overview of the current issues, see the GitHub project.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ZeroEkkusu"><img src="https://avatars.githubusercontent.com/u/94782988?v=4?s=100" width="100px;" alt="Zero Ekkusu"/><br />_{<b>Zero Ekkusu</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=ZeroEkkusu" title="Documentation">📖</a> <a href="https://github.com/foundry-rs/book/pulls?q=is%3Apr+reviewed-by%3AZeroEkkusu" title="Reviewed Pull Requests">👀</a> <a href="#maintenance-ZeroEkkusu" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="https://rootulp.xyz"><img src="https://avatars.githubusercontent.com/u/3699047?v=4?s=100" width="100px;" alt="Rootul Patel"/><br />_{<b>Rootul Patel</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=rootulp" title="Documentation">📖</a> <a href="#maintenance-rootulp" title="Maintenance">🚧</a> <a href="https://github.com/foundry-rs/book/pulls?q=is%3Apr+reviewed-by%3Arootulp" title="Reviewed Pull Requests">👀</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/zk-tarts"><img src="https://avatars.githubusercontent.com/u/78189066?v=4?s=100" width="100px;" alt="zk-tarts"/><br />_{<b>zk-tarts</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=zk-tarts" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/nnnnicholas"><img src="https://avatars.githubusercontent.com/u/1418561?v=4?s=100" width="100px;" alt="Nicholas"/><br />_{<b>Nicholas</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=nnnnicholas" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/metehan"><img src="https://avatars.githubusercontent.com/u/747125?v=4?s=100" width="100px;" alt="metehan"/><br />_{<b>metehan</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=metehan" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/hjubb"><img src="https://avatars.githubusercontent.com/u/9816161?v=4?s=100" width="100px;" alt="Harris"/><br />_{<b>Harris</b>}</a><br /><a href="#maintenance-hjubb" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/codingnirvana"><img src="https://avatars.githubusercontent.com/u/1348422?v=4?s=100" width="100px;" alt="Rajesh Muppalla"/><br />_{<b>Rajesh Muppalla</b>}</a><br /><a href="#maintenance-codingnirvana" title="Maintenance">🚧</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://mattsolomon.dev"><img src="https://avatars.githubusercontent.com/u/17163988?v=4?s=100" width="100px;" alt="Matt Solomon"/><br />_{<b>Matt Solomon</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=mds1" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ruvaag"><img src="https://avatars.githubusercontent.com/u/81832128?v=4?s=100" width="100px;" alt="Ruvaag"/><br />_{<b>Ruvaag</b>}</a><br /><a href="#maintenance-ruvaag" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="http://linkedin.com/in/alexandre-wolff/"><img src="https://avatars.githubusercontent.com/u/55669233?v=4?s=100" width="100px;" alt="awolff"/><br />_{<b>awolff</b>}</a><br /><a href="#maintenance-alexandrewolff" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="https://www.kayaba-attribution.dev/"><img src="https://avatars.githubusercontent.com/u/63566185?v=4?s=100" width="100px;" alt="kayaba-attribution"/><br />_{<b>kayaba-attribution</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=Kayaba-Attribution" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ncitron"><img src="https://avatars.githubusercontent.com/u/16858330?v=4?s=100" width="100px;" alt="Noah Citron"/><br />_{<b>Noah Citron</b>}</a><br /><a href="https://github.com/foundry-rs/book/pulls?q=is%3Apr+reviewed-by%3Ancitron" title="Reviewed Pull Requests">👀</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Sabnock01"><img src="https://avatars.githubusercontent.com/u/24715302?v=4?s=100" width="100px;" alt="Sabnock"/><br />_{<b>Sabnock</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=Sabnock01" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://bandism.net/"><img src="https://avatars.githubusercontent.com/u/22633385?v=4?s=100" width="100px;" alt="Ikko Ashimine"/><br />_{<b>Ikko Ashimine</b>}</a><br /><a href="#maintenance-eltociear" title="Maintenance">🚧</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/wildmolasses"><img src="https://avatars.githubusercontent.com/u/5423313?v=4?s=100" width="100px;" alt="Ed Mazurek"/><br />_{<b>Ed Mazurek</b>}</a><br /><a href="#maintenance-wildmolasses" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/devtooligan"><img src="https://avatars.githubusercontent.com/u/71567643?v=4?s=100" width="100px;" alt="devtooligan"/><br />_{<b>devtooligan</b>}</a><br /><a href="#maintenance-devtooligan" title="Maintenance">🚧</a> <a href="https://github.com/foundry-rs/book/commits?author=devtooligan" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/0xfoobar"><img src="https://avatars.githubusercontent.com/u/83792390?v=4?s=100" width="100px;" alt="0xfoobar"/><br />_{<b>0xfoobar</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=0xfoobar" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://odyslam.com"><img src="https://avatars.githubusercontent.com/u/13405632?v=4?s=100" width="100px;" alt="odyslam.eth"/><br />_{<b>odyslam.eth</b>}</a><br /><a href="#maintenance-odyslam" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="http://git.live"><img src="https://avatars.githubusercontent.com/u/43670554?v=4?s=100" width="100px;" alt="FredCoen"/><br />_{<b>FredCoen</b>}</a><br /><a href="#tutorial-FredCoen" title="Tutorials">✅</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/bblanc42"><img src="https://avatars.githubusercontent.com/u/100454995?v=4?s=100" width="100px;" alt="bblanc42"/><br />_{<b>bblanc42</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=bblanc42" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/0xMySt1c"><img src="https://avatars.githubusercontent.com/u/101825630?v=4?s=100" width="100px;" alt="0xMySt1c"/><br />_{<b>0xMySt1c</b>}</a><br /><a href="#maintenance-0xMySt1c" title="Maintenance">🚧</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/onbjerg"><img src="https://avatars.githubusercontent.com/u/8862627?v=4?s=100" width="100px;" alt="Bjerg"/><br />_<b>Bjerg</b></a><br /><a href="#maintenance-onbjerg" title="Maintenance">🚧</a> <a href="https://github.com/foundry-rs/book/commits?author=onbjerg" title="Documentation">📖</a> <a href="https://github.com/foundry-rs/book/pulls?q=is%3Apr+reviewed-by%3Aonbjerg" title="Reviewed Pull Requests">👀</a></td> <td align="center" valign="top" width="14.28%"><a href="https://gakonst.com"><img src="https://avatars.githubusercontent.com/u/17802178?v=4?s=100" width="100px;" alt="Georgios Konstantopoulos"/><br />_{<b>Georgios Konstantopoulos</b>}</a><br /><a href="https://github.com/foundry-rs/book/pulls?q=is%3Apr+reviewed-by%3Agakonst" title="Reviewed Pull Requests">👀</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/devanonon"><img src="https://avatars.githubusercontent.com/u/89424366?v=4?s=100" width="100px;" alt="Devan Non"/><br />_{<b>Devan Non</b>}</a><br /><a href="https://github.com/foundry-rs/book/commits?author=devanonon" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/jtardioli"><img src="https://avatars.githubusercontent.com/u/85530348?v=4?s=100" width="100px;" alt="josht"/><br />_<b>josht</b></a><br /><a href="#maintenance-jtardioli" title="Maintenance">🚧</a></td> <td align="center" valign="top" width="14.28%">