Skip to content

Latest commit

 

History

History
142 lines (92 loc) · 4.47 KB

README.md

File metadata and controls

142 lines (92 loc) · 4.47 KB

REST API facade template for microservices that interacts with the MultiversX blockchain.

Changes made

v1

  1. Transaction-processor: onTransactionReceived emits an event that communicates the shard_id and transactions value
  2. PubSub: added event route for transactions, that passes the values received to the ApiMetrics
  3. ApiMetrics: added a transactions gauge and its set function. getMetrics will reset the gauge in order not to persist old data when no transactions are received for that shard.
  4. Config: added host settings for mongodb and respective get function in order to be able to set it independently in deployment mode. Also added the possibility to read all relevant config values from env variables, as they are passed as such in deployment mode
  5. Deployment (work in progress) executed through helm charts. Grafana doesn't, as yet, load json file for predefined dashboard, but data can be visualised by creating a new dashboard.

v2 6. Modified TransactionProcessor: a. value is now expressed in egld b. cross shard transactions (sourceShard is not current shard) are ignored in order to avoid doubling the data. c. transaction processor is imported from the mradian1/sdk-transaction-processor repository - branch timestamp, which now provides timestamp and round as parameters to onTransactionReceived 7. Modified getMetrics - clearGauge() function resets gauge values to 0, instead of reset() which resets Gauge values to undefined 8. New Gauge with labels shardId and timestamp added 9. New Grafana dashboard that takes time from transactions timestamp

Quick start

  1. Run npm install in the project directory
  2. Optionally make edits to config.yaml or create config.custom.yaml for each microservice

Dependencies

  1. Redis Server is required to be installed docs.
  2. MySQL Server is required to be installed docs.
  3. MongoDB Server is required to be installed docs.

You can run docker-compose up in a separate terminal to use a local Docker container for all these dependencies.

After running the sample, you can stop the Docker container with docker-compose down

Available Features

These features can be enabled/disabled in config file

Public API

Endpoints that can be used by anyone (public endpoints).

Private API

Endpoints that are not exposed on the internet For example: We do not want to expose our metrics and cache interactions to anyone (/metrics /cache)

Cache Warmer

This is used to keep the application cache in sync with new updates.

Transaction Processor

This is used for scanning the transactions from MultiversX Blockchain.

Queue Worker

This is used for concurrently processing heavy jobs.

Grafana dashboard

You can find a predefined Grafana dashboard with basic metrics at http://localhost:3010

Use admin for user and password fields. Then navigate to Dashboards -> Template Service

Available Scripts

This is a MultiversX project built on Nest.js framework.

npm run start:mainnet

​ Runs the app in the production mode. Make requests to http://localhost:3001.

Redis Server is required to be installed.

Running the api

# development watch mode on devnet
$ npm run start:devnet:watch

# development debug mode on devnet
$ npm run start:devnet:debug

# development mode on devnet
$ npm run start:devnet

# production mode
$ npm run start:mainnet

Running the transactions-processor

# development watch mode on devnet
$ npm run start:transactions-processor:devnet:watch

# development debug mode on devnet
$ npm run start:transactions-processor:devnet:debug

# development mode on devnet
$ npm run start:transactions-processor:devnet

# production mode
$ npm run start:transactions-processor:mainnet

Running the queue-worker

# development watch mode on devnet
$ npm run start:queue-worker:devnet:watch

# development debug mode on devnet
$ npm run start:queue-worker:devnet:debug

# development mode on devnet
$ npm run start:queue-worker:devnet

# production mode
$ npm run start:queue-worker:mainnet

Requests can be made to http://localhost:3001 for the api. The app will reload when you'll make edits (if opened in watch mode). You will also see any lint errors in the console.​

npm run test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov