TN data service API

⚠️ This service is currently in v0. Breaking changes are coming in v1 (also possible, but not likely, within v0 releases). Please use with caution.

This is an API aimed at retrieving data from blockchain quickly and conveniently. We support public APIs for:

Mainnet
- https://api.blackturtle.eu/v0/ The provided links should redirect to Swagger API documentation automatically. If not, visit /docs for reference.

Data service on-premise

It is possible to create your own instance of this service. To do so, follow the guide below.

Requirements

PostgreSQL 10 database with a table stricture found in wavesplatform/blockchain-postgres-sync
Downloaded and continuously updated blockchain data in the database
NodeJS or Docker for either running the service directly, or in a container

Installation and start

The service uses following environment variables:

# server starts at localhost:PORT
PORT=<xxxx -- optional -- default 3000>

# standart postgres env vars
PGHOST=<hostname.com -- required>
PGPORT=<xxxx -- optional -- default 5432>
PGDATABASE=<mainnet -- required>
PGUSER=<myuser -- required>
PGPASSWORD=<password -- required>

# postgres connection pool size
PGPOOLSIZE=<xx -- optional -- default 20>

PGPOOLSIZE is used by the pg-pool library to determine Postgres connection pool size per NodeJS process instance. A good value depends on your server and db configuration and can be found empirically. You can leave it at the default value to start with.

Set those variables to a variables.env file in the root of the project for convenience. In the next steps we will assume this file exists.

If you would like to use some other way of setting environment variables, just replace relevant commands below with custom alternatives.

Docker

Build a Docker image from the project root

docker build -t wavesplatform/data-service .

Run the container

docker run -p=<port>:3000 --env-file=variables.env wavesplatform/data-service

A server will start at localhost:<port> (used in the docker run command). Logs will be handled by Docker. Use any other Docker options if necessary.

When using the container in production, we recommend establishing a Docker logging and restart policy.

NodeJS

Install dependencies

npm install    # or `yarn install`, if you prefer

Start the server

export $(cat variables.env | xargs) && NODE_ENV=production node src/index.js

Server will start at localhost:PORT (defaults to 3000). Logs will be directed to stdout.

If you decide to use NodeJS directly (without Docker), we recommend using a process manager, such as pm2.

General recommendations

Set up a dedicated web server such as Nginx in front of data-service backends (for ssl/caching/balancing)
Implement a caching strategy. Different endpoints may need different cache time (or no cache at all)
Run several process instances behind a load balancer per machine. docker-compose --scale can help with that, or it can be done manually. A good rule of thumb is to use as many instances as CPU cores available.
Use several machines in different data centers and a balancer to minimize downtime
Experiment with PostgreSQL settings to find out what works best for your configuration. Tweaking PGPOOLSIZE also can help performance.