Skip to content

Deploy zkEVM

Welcome to your step-by-step guide to implementing a full Polygon zkEVM network on the Goërli testnet as the L1 network.

Users with good internet connection can schedule a 2-hour window for completing the entire process in one go.

However, in order to allow for in-between breaks, the process is aesthetically split into 6 steps.

  • First step: Preliminary setup, checking system requirements and prerequisites variables.

  • Second step: Installing dependencies and downloading mainnet files.

  • Third step: Creating wallets and deploying contracts.

  • Fourth step: Deployment of the zkNode.

  • Fifth step: Configuring the Prover and services.

  • Sixth step: Activating forced txs and bridging/claiming assets.

Caution

Instructions in this document are subject to frequent updates as the zkEVM software is still in early development stages.

Please report here or reach out to our support team on Discord if you encounter any issues.

Overview and setting up

Implementing the full stack Polygon zkEVM involves more than just running an RPC zkNode or the Prover to validate batches, and deploying Smart Contracts. In its entirety, it encompasses all these processes and more.

The common rollup actors, mainly from the zkNode view, are the Sequencer, the Aggregator, the Synchroniser and the JSON RPC node. All these affect the L2 State.

Also, the Aggregator uses the Prover to avail verifiable proofs of sequenced batches. And the sequenced batches are composed of transactions taken from the Pool DB.

This highlights just a few main components. The rest of the zkEVM components and those working in the background, are listed in the next subsection.

Why you need docker

The modular design of the zkEVM allows for most components to be separately instantiated, and we therefore run each of these instances in a separate Docker container.

The below table enlists all the zkEVM components/services and their corresponding container-names.

Our zkEVM deployment-guide provides CLI commands to automatically create these Docker containers.

Component Container Brief Description
Sequencer zkevm-sequencer Fetches txs from Pool DB, checks if valid, then puts valid ones into a batch.
Aggregator zkevm-aggregator Validates sequenced batches by generating verifiable Zero Knowledge proofs.
Synchronizer zkevm-sync Updates the state by fetching data from Ethereum through the Etherman.
JSON RPC zkevm-rpc An interface for interacting with the zkEVM. e.g., Metamask, Etherscan or Bridge.
State DB zkevm-state-db A database for permanently storing state data (apart from the Merkle tree).
Prover zkevm-prover-server Used by the Aggregator to create ZK proofs. Runs on an external cloud server.
Pool DB zkevm-pool-db Stores txs from the RPC nodes, waiting to be put in a batch by the Sequencer.
Executor zkevm-executor Executes all processes. Collects results’ metadata (state root, receipts, logs)
Etherman zkevm-eth-tx-manager Implements methods for all interactions with the L1 network and smart contracts.
Bridge UI zkevm-bridge-ui User-Interface for bridging ERC-20 tokens between L2 and L1 or another L2.
Bridge DB zkevm-bridge-db A database for storing Bridge-related transactions data.
Bridge Service zkevm-bridge-service A backend service enabling clients like the web UI to interact with Bridge smart contracts.
zkEVM Explorer zkevm-explorer-l2 L2 network’s Block explorer. i.e., The zkEVM Etherscan Explorer.
zkEVM Explorer DB zkevm-explorer-l2-db Database for the L2 network’s Block explorer. i.e., Where all the zkEVM Etherscan Explorer queries are made.
Gas Pricer zkevm-l2gaspricer Responsible for suggesting the gas price for the L2 network fees.
Goërli Execution goerli-execution L1 node’s execution layer.
Goërli Consensus goerli-consensus L1 node’s consensus layer.

Info

The first step of this deployment-guide begins here!

Preliminary setup

Implementing the Polygon zkEVM requires either a Linux machine or a virtual machine running Linux as a Guest OS.

Since the zkEVM implementation involves running Docker containers, ensure that a Docker daemon is installed on your machine.

Here’s how to get setup;

For Linux machines, install the Docker engine directly on the machine.

For other Operating Systems (MacOS, Windows), this is achieved in 4 steps, executed in the given sequential order;

  • Install a hypervisor, e.g., VirtualBox, VMware Fusion (MacOS), VMware Workstation (Windows), VMware ESXi (Bare Metal Hypervisor).
  • Setup a virtual machine, e.g., if you are using VirtualBox, which is open-source, Vagrant is the quickest way to automatically setup a virtual machine and also set up ssh private/public keys.
  • Install Linux as Guest OS, preferably the latest version of Ubuntu Linux.
  • Install Docker.

Search the internet for quick guides on creating virtual machines. Here’s an example of a video on How to Create a Linux Virtual Machine on a Mac.

In order to run multiple Docker containers, an extra tool called docker compose needs to be downloaded and installed. As you will see, a YAML file is used for configuring all zkEVM services.

Info

One more thing, since the Prover is resource-heavy, you will need to run its container externally. Access to cloud computing services such as AWS EC2 or DigitalOcean will be required.

Prerequisites

Next, ensure that you have checked your system specs, and have at hand all the variables listed below.

Environment variables

You’ll need the following items to begin:

  • INFURA_PROJECT_ID // Same as API Key in your Infura account
  • ETHERSCAN_API_KEY
  • Public IP address
  • L1 Goërli node RPC
  • Goërli address with 0.5 GöETH

See this guide here for setting up your own Goërli node.

Computing requirements

Keep in mind that the mainnet files you will be downloading are 70GB big.

If the Prover is the only container you will be running externally in a cloud, then it is preferable to have a minimum 300GB of storage in the primary machine.

Depending on the user’s resources, the zkEVM network can be implemented with either the actual full prover or the mock prover.

The full prover is resource-intensive as it utilizes the exact same proving stack employed in the real and live zkEVM network.

Info

The full Prover’s system requirements are:

  • 96-core CPU
  • Minimum 768GB RAM

The Mock Prover is a dummy prover which simply adds a “Valid ✅” checkmark to every batch.

Info

The mock Prover, on the other hand, only requires:

  • 4-core CPU
  • 8GB RAM (16GB recommended)

As an example, the equivalent AWS EC2s for each of these two provers are as follows:

  • r6a.xlarge for mock Prover
  • r6a.24xlarge for full Prover

The initial free disk space requirement is minimal (<2TB), but you should monitor available space as the network is always adding more data.

Once all the layers are setup and all prerequisites are in place, you can proceed to the next step of this guide.


Last update: December 11, 2023
Authors: EmpieichO (80.88%), kmurphypolygon (13.97%), Nadim Kobeissi (5.15%)