Skip to content

Latest commit

 

History

History
116 lines (79 loc) · 3.24 KB

README.md

File metadata and controls

116 lines (79 loc) · 3.24 KB
Raw

Quorum Reporting

Quorum Reporting is a tool that indexes blocks and transactions in a Quorum network and generates reports to give users insights into what is happening with their contracts.

It generates reports of the contract's state, allowing you to see how the contract changes and evolves over its lifetime. It will also interpret and parse events that the contract emits so that they can be viewed in a dashboard or other application using the reporting API.

Usage

Pre-requisites

  • Running Quorum

    • Quorum v20.10.0
    • Quorum needs to be run with GraphQL and websockets open, with eth, admin and debug RPC APIs available.
    • Quorum Reporting fetches a lot of historic data that is pruned by Quorum under default full gcmode. It is recommended to run Quorum in archive mode.
    • If connecting using a hostname, make sure Geth is started with the correct graphql.vhosts attribute suitable to your environment. For testing, --graphql.vhosts '*' is sufficient.

    e.g. geth --graphql --graphql.vhosts=* --ws --wsport 23000 --wsapi admin,eth,debug --wsorigins=* --gcmode=archive ...

  • ElasticSearch v7 (For Production)

    • Quorum Reporting uses ElasticSearch as its data store. Click here to get started with ElasticSearch.

  • In-memory database (For development only)

    • Quorum Reporting supports In-memory database for development purpose. Data is stored in primary storage only during the run and its deleted when the process is shutdown.

Up & Running

Using Binary

Build
go build [-o quorum-reporting]
Run
  • Running with the default configuration file path of config.toml
./quorum-report
  • Running with a custom configuration path
./quorum-report -config <path to config file>
  • Help command
./quorum-report -help

Using Docker

Build
docker build . -t quorum-reporting
Run
  • A configuration must be supplied to the Docker container
docker run -p <port mapping> --mount type=bind,source=<path to config>,target=/config.toml quorum-reporting:latest

Configuration

A sample configuration file has been provided with details about each of the options. Remove ElasticSearch configuration section from config.toml to enable In-memory database for development mode.

Additionally, application logging verbosity can be controlled with the -verbosity <level> flag, where <level> corresponds to:

0: ERROR
1: WARNING
2: INFO
3: DEBUG

Interact with Quorum Reporting through RPC

The application has a set of RPC APIs that are used to interact with the application. See here for all the available RPC APIs.

Development

Pre-Requisites

  • golang 1.13+

Development Environment

  • Clone the Git repo
git clone https://github.com/ConsenSys/quorum-reporting.git
  • Fetch dependencies using gomod
go get ./...

Design

Architecture

Architecture & Design

Database Schema

Elasticsearch Database Schema Reference

RPC API Specification

Reference