zkSync Era Block Explorer

Online blockchain browser for viewing and analyzing zkSync Era blockchain.

📌 Overview

This repository is a monorepo consisting of 3 packages:

• Worker - an indexer service for zkSync Era blockchain data. The purpose of the service is to read the data from the blockchain in real time, transform it and fill in it's database with the data in a way that makes it easy to be queried by the API service.
• API - a service providing Web API for retrieving structured zkSync Era blockchain data collected by Worker. It connects to the Worker's database to be able to query the collected data.
• App - a front-end app providing an easy-to-use interface for users to view and inspect transactions, blocks, contracts and more. It makes requests to the API to get the data and presents it in a way that's easy to read and understand.

🏛 Architecture

The following diagram illustrates how are the block explorer components connected:

flowchart
  subgraph blockchain[Blockchain]
    Blockchain[zkSync Era JSON-RPC API]
  end

  subgraph explorer[Block explorer]
    Database[("Block explorer DB<br/>(PostgreSQL)")]
    Worker(Worker service)
    API(API service)
    App(App)

    Worker-.Save processed data.->Database
    API-.Query data.->Database
    App-."Request data (HTTP)".->API
    App-."Request data (HTTP)".->Blockchain
  end

  Worker-."Request data (HTTP)".->Blockchain

Loading

Worker service is responsible for getting data from blockchain using zkSync Era JSON-RPC API, processing it and saving into the database. API service is connected to the same database where it gets the data from to handle API requests. It performs only read requests to the database. The front-end App makes HTTP calls to the Block Explorer API to get blockchain data and to the zkSync Era JSON-RPC API for reading contracts, performing transactions etc.

🚀 Features

• ✅ View transactions, blocks, transfers and logs.
• ✅ Inspect accounts, contracts, tokens and balances.
• ✅ Verify smart contracts.
• ✅ Interact with smart contracts.
• ✅ Standalone HTTP API.
• ✅ Local node support.

📋 Prerequisites

• Ensure you have node >= 18.0.0 and npm >= 9.0.0 installed.

🛠 Installation

$ npm install

⚙️ Setting up env variables

Make sure you have set up all the necessary env variables. Follow Setting up env variables for Worker and Setting up env variables for API for instructions.

👨‍💻 Running locally

Before running the solution, make sure you have a database server up and running, you have created a database and set up all the required environment variables.

To run all the packages (Worker, API and front-end App) in development mode run the following command from the root directory.

$ npm run dev

For production mode run:

$ npm run build
$ npm run start

Each component can also be started individually. Follow individual packages README for details.

🐳 Running in Docker

There is a docker compose configuration that allows you to run Block Explorer and all its dependencies in docker. Just run the following command to spin up the whole environment:

docker-compose up

It will run local Ethereum node, ZkSync Era, Postgres DB and all Block Explorer services.

🔍 Verify Block Explorer is up and running

To verify front-end App is running open http://localhost:3010 in your browser. API should be available at http://localhost:3000. Worker - http://localhost:3001.

🕵️‍♂️ Testing

Run unit tests for all packages:

$ npm run test

Run e2e tests for all packages:

$ npm run test:e2e

Run tests for a specific package:

$ npm run test -w {package}

For more details on testing please check individual packages README.

💻 Conventional Commits

We follow the Conventional Commits specification.

📘 License

zkSync Era Block Explorer is distributed under the terms of either

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

🔗 Production links

• Testnet API: https://block-explorer-api.testnets.zksync.dev
• Mainnet API: https://block-explorer-api.mainnet.zksync.io
• Testnet App: https://goerli.explorer.zksync.io
• Mainnet App: https://explorer.zksync.io