• Collector(Indexer)

  • Takes block and tx from LCD and stores into the database in a usable form
  • Stores issuance, network and staking information to database every minute
  • Collect & cache validator info and store in db
  • Calculate validator daily return
  • Collect & cache proposal info

• Rest API server

  • Serves data via RESTFul API

1. Node.js v16.x or later
2. PostgreSQL v12.x or later

$ git clone https://github.com/terra-money/fcd.git

npm i

FCD requires PostgreSQL as a backend database and TypeORM as an ORM.

postgres=> CREATE DATABASE fcd OWNER terra;

Table schema has to be synced before running Collector by setting synchronize to true. There is many way to configure TypeORM. Example is below:

ormconfig.js

module.exports = {
  name: 'default',
  type: 'postgres',
  host: 'localhost',
  database: 'fcd',
  username: 'terra',
  password: '<password>',
  synchronize: true
}

You shall not use CLI method, and it is good to disable synchronize option after the first sync.

In Terra, we use direnv for managing environment variable for development. See sample of .envrc

• Collector

  npm run coldev

• API

  npm run dev

• Test

  npm run test

  • Tests are designed to use testnet

• Collector

  npm run collector

• API

  npm run start

• Generate by npm run apidoc
• Access UI from: http://localhost:3060/apidoc

• Generate by npm run swagger
• Access UI from: http://localhost:3060/swagger
• Access the definition from: http://localhost:3060/static/swagger.json

npm run swagger -- --apigateway

• Generated file can be directly imported to aws api gateway
• NB : its uses empty schema for response object as api gateway support object and properties name only having alphanum.

npm run mergeswagger -- -o filename

• Combined swagger file will be saved in static directory in project root
• If no filename provided as command line argument then default saved file name is combined-swagger.json
• To generate combined swagger for AWS API Gateway add --apigateway parameter

https://github.com/terra-money/localterra