Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/subscan-explorer/subscan-essentials
Polkadot Substrate Explorer Subscan
https://github.com/subscan-explorer/subscan-essentials
blockchain blockchain-explorer explorer substrate
Last synced: 3 months ago
JSON representation
Polkadot Substrate Explorer Subscan
- Host: GitHub
- URL: https://github.com/subscan-explorer/subscan-essentials
- Owner: subscan-explorer
- License: gpl-3.0
- Created: 2019-09-26T06:27:05.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T07:02:30.000Z (3 months ago)
- Last Synced: 2024-04-12T15:05:45.054Z (3 months ago)
- Topics: blockchain, blockchain-explorer, explorer, substrate
- Language: Go
- Homepage: https://www.subscan.io
- Size: 9.86 MB
- Stars: 185
- Watchers: 14
- Forks: 105
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-substrate - Subscan Go Utilities - SS58 and more, developed by Subscan. (Client Libraries)
README
# Subscan Essentials
[](https://goreportcard.com/report/github.com/itering/subscan)
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](https://www.subscan.io/).
Developers are free to use the codebase to extend functionalities and develop unique user experiences for their audiences.
## Contents
- [Feature](#Feature)
- [QuickStart](#QuickStart)
- [Requirement](#Requirement)
- [Structure](docs/tree.md)
- [Installation](#Install)
- [UI](#UI)
- [Config](#Config)
- [Usage](#Usage)
- [Docker](#Docker)
- [Test](#Test)
- [Contributions](#Contributions)
- [LICENSE](#LICENSE)
- [Resource](#Resource)
## Feature
1. Support Substrate network [custom](/custom_type.md) type registration
2. Support index Block, Extrinsic, Event, log
3. More data can be indexed by custom [plugins](/plugins)
4. [Gen](https://github.com/itering/subscan-plugin/tree/master/tools) tool can automatically generate plugin templates
5. Built-in default HTTP API [DOC](/docs/index.md)
## QuickStart
### Requirement
* Linux / Mac OSX
* Git
* Golang 1.12.4+
* Redis 3.0.4+
* MySQL 5.6+
* Node 8.9.0+
### Install
```bash
./build.sh build
//UI
cd ui && yarn && yarn dev
```
### UI
The ui part is built with [nuxt.js](https://nuxtjs.org/) and [amis](https://github.com/baidu/amis)
Demo: [blocks](/ui/plugins/blocks.js), refer to [amis docs](https://baidu.gitee.io/amis/docs/index) for further detail.
[Online Demo](https://crab.demo.subscan.io/)
Please change proxy target in nuxt.config.js to your server name in development.
```js
proxy: {
"/api": {
target: "https://your_server_name.com",
secure: false,
changeOrigin: true,
pathRewrite: {
"^/api": "/api"
}
},
}
```
Please change browserBaseURL in nuxt.config.js to your server name in production.
```js
axios: {
proxy: process.env.NODE_ENV !== 'production',
browserBaseURL: process.env.NODE_ENV !== 'production' ? "" : "https://your_server_name.com"
},
```
#### Example
First choose a search type, and enter search content.
Then click search button, result will be shown in the output section.
#### Feature Supported
- search block detail by block number or block hash
- search extrinsic detail by extrinsic index or extrinsic hash
- search runtime info by spec version
- plugin (blocks, events)
### Config
#### Init config file
```bash
cp configs/config.yaml.example configs/config.yaml
```
#### Set
1. Redis configs/redis.toml
> addr： redis host and port (default: 127.0.0.1:6379)
2. Mysql configs/mysql.toml
> host: mysql host (default: 127.0.0.1)
> user: mysql user (default: root)
> pass: mysql user passwd (default: "")
> db: mysql db name (default: "subscan")
3. Http configs/http.toml
> addr: local http server port (default: 0.0.0.0:4399)
### Usage
- Start DB
**Make sure you have started redis and mysql**
- Substrate Daemon
```bash
cd cmd
./subscan start substrate
```
- Api Server
```bash
cd cmd
./subscan
```
- 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
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
Use [docker-compose](https://docs.docker.com/compose/) can start projects quickly
Create local network
```
docker network create app_net
```
Run mysql and redis container
```bash
docker-compose -f docker-compose.db.yml up -d
```
Run subscan service
```bash
docker-compose build
docker-compose up -d
```
### Test
**default test mysql database is subscan_test. Please CREATE it or change configs/mysql.toml**
```bash
go test ./...
//UI
cd ui && yarn && yarn test
```
## Contributions
We welcome contributions of any kind. Issues labeled can be good (first) contributions.
## LICENSE
GPL-3.0
## Resource
- [ITERING] https://github.com/itering
- [Darwinia] https://github.com/darwinia-network/darwinia