Rsk explorer api

Description

Rsk blockchain explorer

Components

Api server

Blocks service

Imports blockchain data from rsk node to db.

User events service

(Optional) Allows to update fields on the fly and send async response to clients.

Requisites

• mongodb > 4
• node >= 10.16.0

Install

• Install dependecies

    npm install

Configuration file

(optional)

    cp config-example.json config.json

see configuration

Start

services

  node dist/services/blocks

api

  node dist/api

Commands

Run api in development mode

    npm run dev

Run blocks service in development mode

    npm run blocks

Production build to ./dist folder

    npm run build

Configuration

config.json See defaults on: lib/defaultConfig (config.json overrides this values)

Use:

node dist/tools/showConfig.js

to check current configuration

Configurarion Example:

   "source": {
    "node": "localhost",
    "port": 4444
  },
  "api": {
    "address": "localhost",
    "port": 3003
  },
  "db": {
    "server": "localhost",
    "port": 27017,
    "database": "blockDB"
  }

The contractVerifier module requires a connection to a rsk-contract-verifier instance. The url must be provided on api section:

"api":{
  "contractVerifier": {
      "url": "ws://localhost:3008"
    }
}

Source

node: "localhost", port: 4444

db

server": "localhost" port": 27017 database: "explorerDB"

Optionals:

user: < user > password: < password >

blocks

validateCollections :[Boolean] Validate collectios at blocks service start blocksQueueSize:[Number] bcTipSize:[Number] BC tip size

api

address [string] api server bind address port [number] api server port

allowUserEvents [boolean]: enable/disable userEventsApi exposeDoc [boolean]: serve rsk-openapi-ui on /doc to render swagger.json

Documentation

• api documentation
• open api specification