Sygma Explorer Indexer

Table of Contents

• Preparations
• Install
• Usage

Stack

• NodeJS + Typescript

Install

yarn install

Usage

Stub server

You can run stub server that will follow swagger API definition inside swagger.yml by:

yarn start:stub

Stub server will be exposed on localhost:8080. This will also expose Swagger documentation on localhost:80/swagger.

Env definition

This are the env variables that are required:

DATABASE_URL="mongodb://<HOST>:<PORT>/<DATABASE_NAME>?replicaSet=<REPLICA_NAME>&authSource=admin&retryWrites=true&w=majority"
STAGE=""
CHAIN_ANALYSIS_API_KEY=""
CHAIN_ANALYSIS_URL=""
ENVIRONMENT="" # testnet || devnet
RPC_URL_CONFIG="[ { "id": DOMAIN_ID, "endpoint": DOMAIN_ENDPOINT } ]"
COINMARKETCAP_API_KEY=""
COINMARKETCAP_API_URL=""
SNS_REGION=
TOPIC_ARN=
CRON_TIME="* */10 * * * *"
INCIDENT_TIME_MINUTES=45
WARNING_TIME_MINUTES=15
INCIDENT_TEMPLATE_PATH="incidentTemplate.ejs"
WARNING_TEMPLATE_PATH="warningTemplate.ejs"
CACHE_TTL_IN_MINS=5

Running locally

docker compose up

Build

For production build use the command:

yarn build

Testing

For testing use the command:

yarn test

Rerunning price calculations

For running a script that reruns $ price calculations using the CoinMarketCap service use the command:

yarn run fix:price-calculations

Removing duplicates and fix timestamp

This scripts is created for fixing production database entries For removing duplicates and move timestamp from transfer cllection to deposit/execution schema, in .env file define DATABASE_URL env variable, and run the script with command:

yarn run fix:remove-duplicates