Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ConsenSys/quorum-reporting
https://github.com/ConsenSys/quorum-reporting
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ConsenSys/quorum-reporting
- Owner: Consensys
- License: apache-2.0
- Created: 2020-03-04T04:21:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-01T19:53:48.000Z (over 1 year ago)
- Last Synced: 2024-05-13T14:33:43.781Z (6 months ago)
- Language: Go
- Size: 6.68 MB
- Stars: 2
- Watchers: 9
- Forks: 7
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-quorum - Quorum reporting - Tool that indexes blocks and transactions in a Quorum network and generates reports to give users insights into what is happening with their contracts (Software components / Tools)
README
# 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](https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started.html) 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
```bash
go build [-o quorum-reporting]
```
##### Run
- Running with the default configuration file path of `config.toml`
```bash
./quorum-report
```
- Running with a custom configuration path
```bash
./quorum-report -config
```
- Help command
```bash
./quorum-report -help
```
#### Using Docker
##### Build
```bash
docker build . -t quorum-reporting
```
##### Run
- A configuration must be supplied to the Docker container
```bash
docker run -p --mount type=bind,source=,target=/config.toml quorum-reporting:latest
```
### Configuration
A [sample configuration](./config.sample.toml) 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 ` flag, where ``
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](core/rpc/README.md) for all the available RPC APIs.
## Development
### Pre-Requisites
- golang 1.13+
### Development Environment
- Clone the Git repo
```bash
git clone https://github.com/ConsenSys/quorum-reporting.git
```
- Fetch dependencies using gomod
```bash
go get ./...
```
## Design
#### Architecture
#### Database Schema
Elasticsearch Database Schema [Reference](database/elasticsearch/README.md)
#### RPC API Specification
[Reference](core/rpc/README.md)