filecoin-indexer

filecoin-indexer

Data indexer and API service for the Filecoin network

Requirements

• Go 1.14+
• PostgreSQL 10+

Installation

$ go get -u github.com/figment-networks/filecoin-indexer

Usage

$ ./filecoin-indexer --help

Usage of ./filecoin-indexer:
  -cmd string
    	Command to run
  -config string
    	Path to a config file

Executing commands:

$ filecoin-indexer -config path/to/config.json -cmd=COMMAND

Available commands:

Configuration

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

Config file

Example:

{
  "rpc_endpoint": "5.6.7.8:1234",
  "rpc_timeout": "30s",
  "database_dsn": "dbname=filecoin-indexer",
  "server_addr": "localhost",
  "server_port": 8080,
  "initial_height": 0,
  "batch_size": 100,
  "sync_interval": "1s",
  "metrics_addr": "127.0.0.1",
  "metrics_port": "8090",
  "metrics_path": "/metrics",
  "rollbar_token": "a672d00ae7967e33e6f07a9cbdbefb2a",
  "rollbar_server_root": "/home/deploy/filecoin-indexer",
  "debug": true
}

Environment variables

Running Application

Once you have created a database and specified all configuration options, you need to migrate the database:

$ filecoin-indexer -config config.json -cmd=migrate

The synchronization process can be initiated with the command below:

$ filecoin-indexer -config config.json -cmd=sync

To start the API server, you have to run the following command:

$ filecoin-indexer -config config.json -cmd=server

API Reference

For more information see the Miner Reputation System API on Figment Learn.

Score Calculation

The reputation of storage miners is calculated with the following formula:

Where:

Variables

License

This application is dual-licensed under:

• MIT License
• Apache License 2.0