foundry-zksync book

Foundry-ZKsync is a smart contract development toolchain for ZKsync, built upon Foundry.

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

📖 Contributing

You can contribute to this book on GitHub.

Sections

Getting Started

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

Projects

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

ZKsync Specific

This section will give you an the necessary information to write and run tests for zkEVM.

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

Not officially supported.

Chisel Overview

Not officially supported.

Configuration

Guides on configuring Foundry.

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

Tutorials

Tutorials on building smart contracts with Foundry.

• Creating an NFT with Solmate
• Testing EIP-712 Signatures
• Solidity Scripting
• Forking Mainnet with Cast and Anvil

Contributing

Help us improve Foundry-ZKsync: Contributing

Appendix

References, troubleshooting, and more.

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