Skip to content
This repository has been archived by the owner on Apr 20, 2020. It is now read-only.

Latest commit

 

History

History
218 lines (127 loc) · 6.79 KB

README.md

File metadata and controls

218 lines (127 loc) · 6.79 KB
Raw

MIT CITAHub

English | 简体中文

Overview

Microscope provides an easy-to-use user interface to inspect CITA, you can switch target chain in Metadata Panel of the Microscope.

About Microscope

Microscope is a blockchain explorer built with React for inspecting CITA. It supports searching block, transaction, account and invoking call method of smart contract. It also can work with ReBirth to display a list of blocks and transactions on specified conditions, or even analyzes CITA‘s working status.

Features

  • Open Source Development: This project is welcome anyone to use and PR.
  • Multi-Chain Switch: This project supports switch between CITA chains.
  • Smart Contract Support: This project provides a user friendly interface to call methods of smart contracts.
  • User Customized: This project supports a config page to specify which value should be displayed.
  • Progressive: This project is under progressive development, which means it can work independently, and is able to work with ReBirth, another project for CITA.
  • Internationalized: This project supports i18n, default to 中文 and Englisgh.

Getting Started

Development

  1. clone the repo
git clone https://github.com/cryptape/microscope/ && cd microscope
  1. Install Dependencies
yarn install
  1. Build DLL Packages
yarn run dll
  1. Add Config
cp ./.env.example ./.env

set env variables in ./.env

PUBLIC=  # public content server address
CHAIN_SERVERS= # default appchain addresses
APP_NAME= # explorer name
DEBUG_ACCOUNTS= # built-in debug account's private key, e.g. 0xaeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee,0xaeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeea

NOTICE: Our CDN for static assets is available at https://cdn.cryptape.com/, namely icons and images can be added by setting PUBLIC=https://cdn.cryptape.com/ on .env.

  1. Developing
yarn start
  1. Building
yarn run build:prod

Use Docker

At first, you should install docker and learn how to use it.

  1. Clone the repo
git clone https://github.com/cryptape/microscope/
  1. Add Config
cp ./.env.example ./.env

set env variables in ./.env

PUBLIC=  # public content server address
CHAIN_SERVERS= # default appchain addresses
APP_NAME= # explorer name
DEBUG_ACCOUNTS= # built-in debug account's private key, e.g. 0xaeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee,0xaeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeea

NOTICE: Our CDN for static assets is available at https://cdn.cryptape.com/, namely icons and images can be added by setting PUBLIC=https://cdn.cryptape.com/ on .env.

Change nginx config in ./nginx.conf.example

  1. Start Docker Compose. This step may take a long time.
yarn docker:init

If success, you can use Microscope at 0.0.0.0:8089.

Next time, use:

yarn docker:start

to reload it.

Usage

Set CITA

If you visit the explorer for the first time, the side panel will pop up asking to set CITA address you want to listen to.

Data in Microscope

The main sections consists of homepage, block, transaction, account, statistics, config, and most of them can be accessed via navigation bar.

Homepage

On homeage it displays Latest 10 Blocks and Latest 10 Transactions.

Block

NOTICE: This page only works with ReBirth, the cache server for CITA.

Block Page show list of blocks, the table items can be specified in Config Page

Filters can be set in Advanced Selector, available params are numberFrom, numberTo, transactionFrom, transactionTo.

numberFrom and numberTo limit the range of block number.

transactionFrom and transactionTo limit the range of transaction count in one block.

Block Detail can be inspected via table link.

Transaction

NOTICE: This page only works with ReBirth, the cache server for CITA.

Transaction Page show list of transaction, the table items can be specified in Config Page

Filters can be set in Advanced Selector, available params are from, to.

from and to limit transaction.from and transaction.to.

Transaction Detail can be inspected via hash.

Block Detail can be inspected via height.

Account Detail can be inspected via from and to.

Data Detail can be inspected via Hex , if ABI files are uploaded, then according to the ABI files the data can also be parsed into readable text and can be inspected via Parameters.

Statisitcs

NOTICE: Partial diagrams works with ReBirth, the cache server for CITA.

Statistics Page show list of diagrams, the displaying items can be specified in Config Page

For now, Statistics Page includes Interval/Block, Transactions/Block, Quota Used/Block, Quota Used/Transaction, Proposals/Validator diagrams.

Account

Account Page displays its balance and transaction records, and if the account is an contract and upload ABI files, the abi panel will also be available.

Other Widgets

Header

Important Functionalities are shown as badges in the right of header, they are Chain Name, TPS, Search, Languages, all of them has their own panel.

Metadata Panel

On click of Chain Name the Metapata Panel will be called out.

The Metadata Panel is used to check metadata of active chain, or inspect and switch to other chain by entering IP in the search field.

Statistics Panel

NOTICE: this panel is hidden by default, corresponding code is at src/containers/Header/index.tsx

On click of TPS the Statistics Panel will be called out.

The Statistics Panel is used to inspect current status of active chain.

Search Panel

On click of Search the Search Panel will be called out.

The Search Panel is used to inspect block, transaction and account's detail by searching hash or number.

Languages

For now, some languages('zh', 'en', 'jp', 'ko', 'de', 'it', 'fr') can be set by language menu.

Others

NOTICE: Block Detail can be visited localhost/#/block/:blockHash and localhost/#/height/:blockNumber

Transaction Detail can be visited localhost/#/transaction/:transactionHash

Account Detail can be visited localhost/#/account/:accountAddress