mina-indexer

README

mina-indexer

Blockchain data indexer and API service for Mina blockchain protocol

Requirements

• PostgreSQL 10.x+
• Go 1.15+

Installation

Not available yet

Configuration

You can configure the service using either a config file or environment variables.

Config File

Example:

{
  "app_env": "production",
  "mina_endpoint": "http://YOUR_NODE_IP:3085/graphql",
  "archive_endpoint": "http://YOUR_NODE_IP:3088",
  "server_addr": "127.0.0.1",
  "server_port": 8080,
  "database_url": "postgres://user:pass@host/dbname",
  "sync_interval": "30s",
  "cleanup_interval": "10m"
}

Environment Variables

Name	Description	Default
DATABASE_URL	PostgreSQL database URL
MINA_ENDPOINT	Mina GraphQL Endpoint
ARCHIVE_ENDPOINT	Mina Archive API Endpoint
APP_ENV	Application environment	development
SERVER_ADDR	Server listen address	0.0.0.0
SERVER_PORT	Server listen port	8080
SYNC_INTERVAL	Data sync interval	10s
CLEANUP_INTERVAL	Data cleanup interval	10min
LOG_LEVEL	Application log level	info
LOG_FORMAT	Application log format	text. Available: text, json

Running Application

Once you have created a database and specified all configuration options, you need to migrate the database. You can do that by running the command below:

mina-indexer -config path/to/config.json -cmd=migrate

Start the data indexer:

mina-indexer -config path/to/config.json -cmd=worker

Start the API server:

mina-indexer -config path/to/config.json -cmd=server

API Reference

Method	Path	Description
GET	/health	Healthcheck endpoint
GET	/height	Current indexed blockchain height
GET	/blocks	Blocks search
GET	/blocks/:hash	Block details by ID or Hash
GET	/block_times	Block times stats
GET	/block_times_interval	Block creation stats
GET	/transactions	Transactions search
GET	/pending_transactions	Pending Transactions
GET	/transactions/:id	Transaction details by ID or Hash
GET	/accounts	Accounts search
GET	/accounts/:id	Account details by ID or Key