VSC-HAF

VSC HAF indexer and API server. Indexes Hive from the VSC genesis block number for the relevant VSC operations using the HAF app sync algorithm.

Required Dependencies

• nodejs and npm (Latest LTS, v18 minimum supported)
• Synced HAF node, ideally using haf_api_node compose

Docker Setup

This assumes HAF is running through haf_api_node.

Clone this repository, then add the following in the .env file in haf_api_node directory:

COMPOSE_FILE="${COMPOSE_FILE}:/path/to/vsc-haf/repo/docker/compose.yml"
VSC_HAF_VERSION=latest
VSC_HAF_GITHUB_API_KEY=YOUR_OPTIONAL_GITHUB_API_KEY
VSC_HAF_IPFS_API_URL=http://YOUR_IPFS_URL:5001
VSC_HAF_SUBINDEXER_LOG_LEVEL=info

Build the Docker image:

cd /path/to/vsc-haf/repo
./scripts/build_instance.sh

Run the HAF app sync:

docker compose up -d vsc-haf-block-processing

Run the subindexer (IPFS daemon must be already running):

docker compose up -d vsc-haf-subindexer

Run the PostgREST server:

docker compose up -d vsc-haf-postgrest

Setup

PostgreSQL Roles

CREATE ROLE vsc_app WITH LOGIN PASSWORD 'vscpass' CREATEROLE INHERIT IN ROLE hive_applications_group;
CREATE ROLE vsc_user WITH LOGIN INHERIT IN ROLE hive_applications_group;
GRANT CREATE ON DATABASE block_log TO vsc_app;
GRANT vsc_user TO vsc_app;

PostgREST Installation

./scripts/postgrest_install.sh

PostgREST API methods

psql -f src/sql/create_apis.sql block_log

Installation

git clone https://github.com/techcoderx/vsc-haf
cd vsc-haf
npm i

Compile

npm run compile

Sync

npm start

Start PostgREST server

./scripts/postgrest_start.sh postgres://vsc_app:<vsc_app_password>@localhost:5432/block_log <server_port>

Periodically fetch latest vsc-node commit in crontab

*/5 * * * * /path/to/this/repo/scripts/github_fetch_head.sh --postgres-url=<psql_url> --api-key=<github_api_key> --run-once