Rollup

This quick start guide shows you how to deploy a CDK rollup (EVM compatible) environment on your local machine that sets up and runs the following components:

zkEVM node databases
Explorer databases
L1 network
Prover
zkEVM node components
Explorers

Note

The documentation describes standard deployments.
Edit the configuration files to implement your own custom setups.

Prerequisites¶

Hardware¶

A Linux-based OS (e.g., Ubuntu Server 22.04 LTS).
At least 16GB RAM with a 4-core CPU.
An AMD64 architecture system.

Warning

Currently the executor/prover does not run on ARM-powered Macs.
For Windows users, WSL/WSL2 use is not recommended.

Software¶

go _{version 1.21}
Docker
Docker Compose

1. Clone the repo¶

git clone https://github.com/0xPolygonHermez/zkevm-node.git
cd zkevm-node

2. Build the Docker image¶

make build-docker

Warning

Rerun this command every time there is a code-change.

3. Test the environment¶

zkevm-node provides commands that allow you to interact with smart contracts, run components, create encryption files, and print out debug information.

Warning

All the data is stored inside Docker containers.
You will lose all the data whenever you remove the container.

3.1 Run the environment¶

The test/ directory contains scripts and files for developing and debugging.

cd test/

Then:

make run

The make run command spins up the containers that run the environment, but nothing else. This means that the L2 has no data yet.

3.2 Test with data¶

Test a use case from the test with sample data section.

3.3 Stop the environment¶

make stop

3.4 Restart the environment¶

make restart

4. Test with sample data¶

4.1 Add example transactions and smart contracts¶

make deploy-sc

4.2 Deploy a full Uniswap environment¶

make deploy-uniswap

4.3 Grant the Pol smart contract a set amount of tokens¶

make run-approve-pol

5. Set up MetaMask¶

Info

MetaMask requires the network to be running during set up.

To configure MetaMask to use your local environment, make sure the network is running and follow these steps.

Log in to your MetaMask wallet.
Click your account picture and then on Settings.
On the left menu, click Networks.
Click the Add Network button.
Enter the following L2 network information:
1. Network name: Polygon zkEVM - local
2. New RPC URL: http://localhost:8123
3. Chain ID: 1001
4. Currency symbol: ETH
5. Block explorer URL: http://localhost:4000
Click Save.
Click the Add Network button,
Enter the following L1 network information:
1. Network name: Geth - local
2. New RPC URL: http://localhost:8545
3. Chain ID: 1337
4. Currency symbol: ETH
Click Save.

Environment configurations¶

Access the running components using the following details.

Databases¶

zkEVM node state database¶

Type: Postgres DB
User: state_user
Password: state_password
Database: state-db
Host: localhost
Port: 5432
URL: postgres://state_user:srare_password@localhost:5432/state-db

zkEVM node pool database¶

Type: Postgres DB
User: pool_user
Password: pool_password
Database: pool_db
Host: localhost
Port: 5433
URL: postgres://pool_user:pool_password@localhost:5433/pool_db

zkEVM node JSON-RPC database¶

Type: Postgres DB
User: rpc_user
Password: rpc_password
Database: rpc_db
Host: localhost
Port: 5434
URL: postgres://rpc_user:rpc_password@localhost:5434/rpc_db

Explorer L1 database¶

Type: Postgres DB
User: l1_explorer_user
Password: l1_explorer_password
Database: l1_explorer_db
Host: localhost
Port: 5435
URL: postgres://l1_explorer_user:l1_explorer_password@localhost:5435/l1_explorer_db

Explorer L2 database¶

Type: Postgres DB
User: l2_explorer_user
Password: l2_explorer_password
Database: l2_explorer_db
Host: localhost
Port: 5436
URL: postgres://l2_explorer_user:l2_explorer_password@localhost:5436/l2_explorer_db

Networks¶

L1 network¶

Type: Geth
Host: localhost
Port: 8545
URL: http://localhost:8545

zkEVM node¶

Type: JSON RPC
Host: localhost
Port: 8123
URL: http://localhost:8123

Explorers¶

Explorer L1¶

Type: Web
Host: localhost
Port: 4000
URL: http://localhost:4000

Explorer L2¶

Type: Web
Host: localhost
Port: 4001
URL: http://localhost:4001

Prover¶

Type: Mock
Host: localhost
Port: Depending on the prover image, if it’s mock or not:
- Prod prover: 50052 for Prover, 50061 for Merkle Tree, 50071 for Executor
- Mock prover: 43061 for MT, 43071 for Executor
URL: http://localhost:50001

Environment addresses¶

The following addresses are configured into the running environment.

L1 addresses¶

Address	Description
0x8dAF17A20c9DBA35f005b6324F493785D239719d	Polygon zkEVM
0x40E0576c0A7dff9dc460B29ba73e79aBf73dD2a9	Polygon bridge
0x5FbDB2315678afecb367f032d93F642f64180aa3	Pol token
0x8A791620dd6260079BF849Dc5567aDC3F2FdC318	Polygon GlobalExitRootManager
0xB7f8BC63BbcaD18155201308C8f3540b07f84F5e	Polygon RollupManager

Deployer account¶

Address	Private Key
0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266	0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

Sequencer account¶

Address	Private Key
0x617b3a3528F9cDd6630fd3301B9c8911F7Bf063D	0x28b2b0318721be8c8339199172cd7cc8f5e273800a35616ec893083a4b32c02e

Aggregator account¶

Address	Private Key
0x70997970C51812dc3A010C7d01b50e0d17dc79C8	0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d

Test accounts with funds¶

The environment also provides a bunch of test accounts that contain funds.

Address	Private Key
0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC	0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a
0x90F79bf6EB2c4f870365E785982E1f101E93b906	0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6
0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65	0x47e179ec197488593b187f80a00eb0da91f1b9d0b13f8733639f19c30a34926a
0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc	0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba
0x976EA74026E726554dB657fA54763abd0C3a0aa9	0x92db14e403b83dfe3df233f83dfa3a0d7096f21ca9b0d6d6b8d88b2b4ec1564e
0x14dC79964da2C08b23698B3D3cc7Ca32193d9955	0x4bbbf85ce3377467afe5d46f804f221813b2bb87f24d81f60f1fcdbf7cbf4356
0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f	0xdbda1821b80551c9d65939329250298aa3472ba22feea921c0cf5d620ea67b97
0xa0Ee7A142d267C1f36714E4a8F75612F20a79720	0x2a871d0798f97d79848a013d4936a73bf4cc922c825d33c1cf7073dff6d409c6
0xBcd4042DE499D14e55001CcbB24a551F3b954096	0xf214f2b2cd398c806f84e317254e0f0b801d0643303237d97a22a48e01628897
0x71bE63f3384f5fb98995898A86B02Fb2426c5788	0x701b615bbdfb9de65240bc28bd21bbc0d996645a3dd57e7b12bc2bdf6f192c82
0xFABB0ac9d68B0B445fB7357272Ff202C5651694a	0xa267530f49f8280200edf313ee7af6b827f2a8bce2897751d06a843f644967b1
0x1CBd3b2770909D4e10f157cABC84C7264073C9Ec	0x47c99abed3324a2707c28affff1267e45918ec8c3f20b8aa892e8b065d2942dd
0xdF3e18d64BC6A983f673Ab319CCaE4f1a57C7097	0xc526ee95bf44d8fc405a158bb884d9d1238d99f0612e9f33d006bb0789009aaa
0xcd3B766CCDd6AE721141F452C550Ca635964ce71	0x8166f546bab6da521a8369cab06c5d2b9e46670292d85c875ee9ec20e84ffb61
0x2546BcD3c84621e976D8185a91A922aE77ECEc30	0xea6c44ac03bff858b476bba40716402b03e41b8e97e276d1baec7c37d42484a0
0xbDA5747bFD65F08deb54cb465eB87D40e51B197E	0x689af8efa8c651a91ad287602527f3af2fe9f6501a7ac4b061667b5a93e037fd
0xdD2FD4581271e230360230F9337D5c0430Bf44C0	0xde9be858da4a475276426320d5e9262ecfc3ba460bfac56360bfa6c4c28b4ee0
0x8626f6940E2eb28930eFb4CeF49B2d1F2C9C1199	0xdf57089febbacf7ba0bc227dafbffa9fc08a93fdc68e1e42411a14efcf23656e

Last update: January 17, 2024

Authors: avenbreaks