zkSync local development setup

This repository contains the tooling necessary to bootstrap zkSync locally.

By default, it doesn't use any docker volumes, so all the data is lost when docker is stopped.

Dependencies

To run zkSync locally, you must have docker compose and Docker installed on your machine.

Usage

To bootstrap zkSync locally, just run:

./start.sh

This command will bootstrap three docker containers:

• Postgres (used as the database for zkSync).
• Local Reth node (used as L1 for zkSync).
• zkSync server itself.

By default, the HTTP JSON-RPC API will run on port 3050, while WS API will run on port 3051.

Note, that it is important that the first start script goes uninterrupted. If you face any issues after the bootstrapping process unexpectedly stopped, you should reset the local zkSync state and try again.

Resetting zkSync state

To reset the zkSync state, just run:

./clear.sh

Rich wallets

Local zkSync setup comes with some "rich" wallets with large amounts of ETH on both L1 and L2.

The full list of the addresses of these accounts with the corresponding private keys can be found here.

Also, during the initial bootstrapping of the system, several ERC-20 contracts are deployed locally. Note, that large quantities of these ERC-20 belong to the wallet 0x36615Cf349d7F6344891B1e7CA7C72883F5dc049 (the first one in the list of the rich wallet). Right after bootstrapping the system, these ERC-20 funds are available only on L1.

Using custom database/L1

To use custom Postgres database or Layer 1, you should change the environment parameters in the docker-compose file:

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

• DATABASE_URL is the URL to the Postgres database.
• ETH_CLIENT_WEB3_URL is the URL to the HTTP JSON-RPC interface of the L1 node.

Local testing example

You can an example of hardhat project that utilizes local testing capabilities here.

To run tests, clone the repo and run yarn test:

git clone https://github.com/matter-labs/tutorial-examples.git
cd local-setup-testing
yarn test

ZK Chains

Will start ZK Chains with 3 L2s, L1 and necessary explorers.

To run:

./start-zk-chains.sh

Afterwards, you'll have explorers available at http://localhost:15000 http://localhost:15001 and http://localhost:15005

Manual transfer to ZK Chains

Make sure to get the correct bridgehub address (in this example: 0x35A3783781DE026E1e854A6DA45d7a903664a9dA) from the hyperexplorer.

cast send -r http://localhost:15045  --private-key 0x27593fea79697e947890ecbecce7901b0008345e5d7259710d0dd5e500d040be 0x35A3783781DE026E1e854A6DA45d7a903664a9dA "requestL2TransactionDirect((uint256, uint256, address, uint256, bytes, uint256, uint256, bytes[], address))" "(270,0xde0b6b3a7640000,0x005C43B2063625e9425943Fec65c42d005a2cD1f,10000000000000,"",10000000,800,[0x1234567890123456789012345678901234567890123456789012345678901234],0x005C43B2063625e9425943Fec65c42d005a2cD1f)" --value=1000000000000000000

Resetting zkSync state

To reset the zkSync state, just run:

./clear-zk-chains.sh