Docker L1 - L2 Nodes

Welcome to this step-by-step guide on establishing a local testing environment using Docker for ZKsync development. With this guide, you can effortlessly emulate the ZKsync environment on your local system, making it simpler to test and develop features. Let's get started!

Prerequisites:

Docker and docker-compose: Ensure that Docker and docker-compose are installed on your machine. If you haven't already installed them, follow the installation guide.
ZKsync Hardhat plugins: A foundational understanding of the ZKsync Hardhat plugins will be beneficial. New to ZKsync development with Hardhat? Explore the Getting Started section.

The matterlabs/local-node Docker image is currently based on the protocol Version19 (deprecated on February 5, 2024), and it will be upgraded in the coming months. It should only be used for testing L1 <-> L2 communication.

Set up the testing environment

Clone the dockerized ZKsync project repository to your local machine:
```
git clone https://github.com/matter-labs/local-setup
```
To start the local node, navigate to the cloned directory:
```
cd local-setup
```
Launch the ZKsync Era node locally using the start.sh script:
```
./start.sh
```
This script spins up three essential docker containers:
1. Postgres: The database supporting ZKsync.
2. Local Geth node: Acts as the Layer 1 (L1) for ZKsync.
3. ZKsync node: The core component.

The first execution of the start.sh script should proceed without interruptions. If it halts unexpectedly, you might need to reset the local ZKsync state and retry. The initialization might take up to 10 minutes initially.

Network Details

HTTP JSON-RPC API: Accessible via port 3050.
WebSocket (WS) API: Accessible through port 3051.
Default endpoints:
L1 RPC: http://localhost:8545
L2 RPC: http://localhost:3050
WS API: http://localhost:3051
Network Id: 270

Reset the ZKsync State

If you need to revert the ZKsync state to its initial configuration, execute the clear.sh script:

./clear.sh

In the event of a "permission denied" error, run the following script with root access:

sudo ./clear.sh

Leverage rich wallets

The local ZKsync setup generously equips test wallets with ample amounts of ETH on both L1 and L2, making testing easier.

Custom configurations (advanced)

To operate with a custom Postgres database or a distinct Layer 1 node, you'll need to adjust environment variables within the docker-compose file:

environment:
  - DATABASE_URL=postgres://postgres@postgres/zksync_local
  - ETH_CLIENT_WEB3_URL=http://geth:8545

DATABASE_URL is the connection URL to the Postgres database, and ETH_CLIENT_WEB3_URL is the endpoint URL for the HTTP JSON-RPC interface of the L1 node.

Getting Started

Learn about the recommended paths of testing and debugging your projects on ZKsync.

In-Memory Node

Learn how to setup a local in-memory era_test_node.