Subscan Essentials

Subscan Essentials is a high-precision blockchain explorer scaffold project. It supports substrate-based blockchain networks with developer-friendly interface, standard or custom module parsing capabilities. It's developed by the Subscan team and used in subscan.io. Developers are free to use the codebase to extend functionalities and develop unique user experiences for their audiences.

Contents

• Subscan Essentials
  • Contents
  • Feature
  • Requirement
  • Installation
  • Usage
  • Docker
  • LICENSE
  • Resource

Feature

1. Support Substrate network custom type registration
2. Support index Block, Extrinsic, Event, log
3. More data can be indexed by custom plugins
4. Gen tool can automatically generate plugin templates
5. Built-in default HTTP API DOC

Requirement

• Linux / Mac OSX
• Golang 1.12.4+
• Redis 3.0.4+
• MySQL 5.6+

Install

./build.sh install

Usage

• Run

./cmd/subscan --conf configs

• Help

NAME:
   SubScan - SubScan Backend Service, use -h get help

USAGE:
   main [global options] command [command options] [arguments...]

VERSION:
   1.0

DESCRIPTION:
   SubScan Backend Service, substrate blockchain explorer

COMMANDS:
     start    Start one worker, E.g substrate
     stop     Stop one worker, E.g substrate
     install  Create database and create default conf file
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --conf value   (default: "../configs")
   --help, -h     show help
   --version, -v  print the version

Docker

db

docker-compose -f docker-compose.db.yml up  -d

subscan

docker-compose build
docker-compose up -d

LICENSE

GPL-3.0

Resource

• [ITERING] https://github.com/itering
• [Darwinia] https://github.com/darwinia-network/darwinia