Skip to content

Latest commit

 

History

History
 
 

app

README.md

zkSync Era Block Explorer App

Overview

zkSync Era Block Explorer App is a front-end app providing an easy-to-use interface for users to view and inspect transactions, blocks, contracts and more on zkSync Era blockchain.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Installation

$ npm install

Environment configs

Public environment configs are stored in src/configs folder and are named as <appEnvironment>.config.json where appEnvironment is the name of the environment set in VITE_APP_ENVIRONMENT env variable. Currently there are 3 different environments for the project: local, staging and production, each with its corresponding configuration file.

Adding a new network to the config

In order to change the configuration for the environment, you need to change its configuration file. By default, there are 4 networks configured for the local environment: local, stage, testnet and mainnet. Your local network might be different from what is configured in local.config.json in such case you should edit the config and set correct values for your setup. You can also add new items to the networks array and they will automatically appear in the networks dropdown on UI.

Example of local.config.json extended with the new network:

import stagingConfig from "./staging.config";

import type { EnvironmentConfig } from ".";

const config: EnvironmentConfig = {
  networks: [
    {
      apiUrl: "http://localhost:3020",
      verificationApiUrl: "https://zksync2-testnet-explorer.zksync.dev",
      hostnames: ["localhost"],
      icon: "/images/icons/zksync-arrows.svg",
      l2ChainId: 270,
      l2NetworkName: "Local",
      maintenance: false,
      name: "local",
      published: true,
      rpcUrl: "http://localhost:3050",
    },
    // next network has been just added
    {
      apiUrl: "http://localhost:3030",
      verificationApiUrl: "https://zksync2-testnet-explorer.zksync.dev",
      hostnames: ["localhost"],
      icon: "/images/icons/zksync-arrows.svg",
      l2ChainId: 270,
      l2NetworkName: "Local Hyperchain",
      maintenance: false,
      name: "local-hyperchain",
      published: true,
      rpcUrl: "http://localhost:3070",
    },
    ...stagingConfig.networks,
  ],
};

export default config;

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test

Run End-to-End Tests with Playwright

npm run test:e2e

Lint with ESLint

npm run lint

Production links

Verify Block Explorer UI test results in GitHub Actions

GitHub Actions test results are available in:

  • GitHub Actions --> Summary page at the very end of a page.
  • Inside of each test run in the log: Feature on Mainnet + Sepolia --> @search --> Upload test results to Allure reporter --> https://raw.githack.com/matter-labs/block-explorer/gh-pages/_github.run_number_/index.html
  • Directly via a link https://raw.githack.com/matter-labs/block-explorer/gh-pages/_github.run_number_/index.html after each PR running. The history of test runs for public view locates in gh-pages branch.

In case of 404 page, make sure that the folder with its github.run_number exists in the gh-pages. If the folder exist, try again in a few minutes as https://raw.githack.com needs to update the data. Public report link will be available when the 'Allure Report' job will be succesfully executed.