Skip to content

Latest commit

 

History

History
176 lines (112 loc) · 4.83 KB

README.md

File metadata and controls

176 lines (112 loc) · 4.83 KB
Raw

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

Quick start

  1. Run npm install in the project directory
  2. Optionally make edits to config/config.yaml and/or .env files

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 (or docker-compose up -d as detached) 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 / Modules

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.

Environment variables

In order to simplify the scripts, the templates will use the following environment variables:

  • NODE_ENV

Description: Defines the environment in which the application runs. This influences various configuration settings.

Possible Values: mainnet, testnet, devnet, infra

Usage: Determines the environment-specific configurations and behaviors of the application.

  • NODE_APP

Description: Specifies which part of the application to start.

Possible Values: api, cache-warmer, transactions-processor, queue-worker

Usage: Selects the specific application module to run.

  • NODE_DEBUG

Description: Enables or disables development debug mode.

Possible Values: true, false

Usage: When set to true, the application starts in debug mode, useful for development.

  • NODE_WATCH

Description: Enables or disables development watch mode.

Possible Values: true, false

Usage: When set to true, the application starts in watch mode, which automatically reloads the app on code changes.

npm run start

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
$ NODE_ENV=devnet NODE_APP=api NODE_WATCH=true npm run start
or
$ NODE_ENV=devnet NODE_WATCH=true npm run start:api

# development debug mode on devnet
$ NODE_ENV=devnet NODE_APP=api NODE_DEBUG=true npm run start
or
$ NODE_ENV=devnet NODE_DEBUG=true npm run start:api

# development mode
$ NODE_ENV=devnet NODE_APP=api npm run start
or
$ NODE_ENV=devnet npm run start:api

# production mode
$ NODE_ENV=mainnet NODE_APP=api npm run start
or
$ NODE_ENV=mainnet npm run start:api

Running the transactions-processor

# development watch mode on devnet
$ NODE_ENV=devnet NODE_APP=transactions-processor NODE_WATCH=true npm run start
or
$ NODE_ENV=devnet NODE_WATCH=true npm run start:transactions-processor

# development debug mode on devnet
$ NODE_ENV=devnet NODE_APP=transactions-processor NODE_DEBUG=true npm run start
or
$ NODE_ENV=devnet NODE_DEBUG=true npm run start:transactions-processor

# development mode on devnet
$ NODE_ENV=devnet NODE_APP=transactions-processor npm run start
or
$ NODE_ENV=devnet npm run start:transactions-processor

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

Running the queue-worker

# development watch mode on devnet
$ NODE_ENV=devnet NODE_APP=queue-worker NODE_WATCH=true npm run start
or
$ NODE_ENV=devnet NODE_WATCH=true npm run start:queue-worker

# development debug mode on devnet
$ NODE_ENV=devnet NODE_APP=queue-worker NODE_DEBUG=true npm run start
or
$ NODE_ENV=devnet NODE_DEBUG=true npm run start:queue-worker

# development mode on devnet
$ NODE_ENV=devnet NODE_APP=queue-worker npm run start
or
$ NODE_ENV=devnet npm run start:queue-worker

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

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