zkSync Era Documentation

This documentation is intended to assist you in developing on zkSync. It introduces the concepts of zkSync, describes the zkSync network stack, and some advanced topics for complex applications and use cases.

Given this documentation is open-sourced, feel free to suggest new topics, add new content, and provide examples wherever you believe they will be useful. If you're unsure how to proceed, follow these instructions.

Fundamental topics

If this is your first time using zkSync, we recommend that you kick off at the beginning and work your way through the documentation like you would with a book.

• Intro to rollups - A brief overview of rollups.
• zkSync Era basics - A quick overview of zkSync Era technologies.
• Interacting with zkSync Era - A brief intro into zkSync Era Testnet.
• Hyperscaling - Understand hyperchains in zkSync.

Understanding zkSync Era

• Transactions - A guide on how zkSync handles transactions.
• Blocks - Learn how blocks work on zkSync.
• System contracts - A brief overview of zkSync system contracts.
• Account abstraction - Learn about account abstraction.
• Fee mechanism - A quick overview of the zkSync fee structure.
• Bridging of funds - A brief intro on token bridging.
• L1 / L2 Interoperability - A quick brief on data communication between L1 and L2.
• L1 / L2 communication - Learn how to send data from Ethereum to zkSync.
• L2 / L1 communication - Learn how to send data from zkSync to Ethereum.
• Video resources - Watch developer related videos and zkSync Era.

Building on zkSync Era

• Quickstart - Learn how to build a full dApp using the zkSync development toolbox.
• Smart contract deployment - A guide on how to deploy smart contracts on zkSync.
• Verify contracts - A guide on how to verify smart contracts with zkSync block explorer.
• Handling events - Learn how to handle events in zkSync Era.
• JSON-RPC API - Learn how to use our custom JSON-RPC APIs that are similar to Ethereum.

Compiler Toolchain

• Overview - Learn about our compiler toolchain.
• Solidity - Learn about the Solidity support.
• Vyper - Learn about the Vyper support.
• LLVM Framework - Learn about the LLVM framework.

Compiler Toolchain

• Overview - Learn about our compiler toolchain.
• Solidity - Learn about the Solidity support.
• Vyper - Learn about the Vyper support.
• LLVM Framework - Learn about the LLVM framework.

Tutorials

• Cross-chain governance - Learn how to use L1 to L2 contract interaction.
• Account abstraction multisig - Learn how to deploy your custom accounts and interact zkSync system contracts.
• Daily Spending Limit - Learn how to create a daily spend limit in your smart contract using Account Abstraction.
• Building custom paymasters - Learn how to build a custom paymaster to allow users to pay fees in your token.

Troubleshooting

• Changelogs - Get updates, breaking changes and new features on zkSync Era.
• Contribute to documentation - Learn the guidelines needed to be a contributor to the zkSync Era docs.
• FAQs - Popular questions and answers about zkSync Era.

Tools and SDKs

• zkSync Era Portal - Explore Wallet, Bridge and Faucet features.
• Block Explorer - Search for real-time and historical information about blocks, transactions, addresses, and more on zkSync block explorer.
• Javascript SDK - Extending the capabilities of Ethers, our Javascript SDK contains specific classes and methods required to build on zkSync Era.
• Python SDK - Explore all the Python methods and functions required to build on zkSync Era.
• Go SDK - Explore all the GO methods and functions required to build on zkSync Era.
• Java SDK - Explore all the Java methods and functions required to build on zkSync Era.
• Swift SDK - Explore all the Swift methods and functions required to build on zkSync Era.
• Hardhat Plugins - Use our Hardhat zkSync plugins to compile, test, deploy, and verify your Solidity or Vyper based applications.
• zkSync CLI - Simplify your development process and interact with zkSync Era from your terminal with zkSync CLI.