Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
emiliorizzo committed Aug 6, 2020
1 parent c5a1343 commit 9a133dd
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ HTTP/WS server, see the documentation [here](doc/api.md).
- **blocksStatus:** checks DB and node status and stores changes in the DB.
- **blocksStats:** gets BC stats and stores in the DB.

### User events service
### API user events service

(Optional)
Allows to update fields on the fly and send async response to clients.
Required by the contract verification module.

## Requisites

Expand Down Expand Up @@ -213,29 +213,30 @@ e.g:

### db

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

**Optionals:**

**user**: < user >
**password**: < password >
- **user**: < user >
- **password**: < password >

### blocks

**validateCollections** :[Boolean] Validate collections at blocks service start, default false
**blocksQueueSize**:[Number] blocksRequester queue size
**bcTipSize**:[Number] Number of confirmations required to check blocks
**debug**:[Boolean] Enable logging of nod3 requests, default false
- **validateCollections** :[Boolean] Validate collections at blocks service start, default false
- **blocksQueueSize**:[Number] blocksRequester queue size
- **bcTipSize**:[Number] Number of confirmations required to check blocks
- **debug**:[Boolean] Enable logging of nod3 requests, default false
- **services**:[Object] {ServiceName:[Boolean]}. All services are enabled as default, to disable a service use: **serviceName:false**

### api

**address** [string] api server bind address
**port** [number] api server port
- **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
- **allowUserEvents** [boolean]: enable/disable userEventsApi
- **exposeDoc** [boolean]: serve rsk-openapi-ui on /doc to render swagger.json

## Documentation

Expand Down

0 comments on commit 9a133dd

Please sign in to comment.