CodeChain Indexer

A blockchain data indexing tool for CodeChain

Table of Contents

• Install
• Before start
• Run

Install

Requirements

The software dependencies required to install and run CodeChain-indexer are:

• Latest version of the CodeChain
• PostgreSQL v11.*
• Nodejs higher than version 8

Download

Download CodeChain-indexer code from the GitHub repository

git clone [email protected]:kodebox-io/codechain-indexer.git
cd codechain-indexer

Install packages

Use yarn package manager to install packages

yarn install

Before start

Dependency

• Get CodeChain ready with the CodeChain RPC server
• Get PostgreSQL database ready for indexing block data

Create the database and user on the PostgreSQL

# download postgresql with Homebrew
brew install postgresql
brew services start postgresql

# Create the user and db with supporting sql script
psql postgres -f create_user_and_db.sql

# Create the schema of the database
yarn run migrate

Run

Run codechain-indexer to create indices on ElasticSearch

yarn run start

# You can change the host of CodeChain and DB host on the config/dev.json

Test

# Create the test database
NODE_ENV=test yarn run migrate

# Start testing
yarn run test

API document

NODE_ENV=dev yarn run start

# Swagger UI is running at "http://host:port/api-docs/"

Tools

Delete all database data

yarn run reset