POIfier-client

Python3 deamon to get all deployments being indexed by graph-node and upload their POI (Proof-of-indexing) using referenced INDEXER_ID to the POIfier-server

Goal

The main goal of this project is to help Graphprotocol Indexer to verify consistency of their indexed data by uploading POI (Proof-of-indexing) data to POIfier-server periodically.

Design

• POIfier-client: to be run by Indexer (locally or remotelly).

  • Client queries graph-node to get list of subgraph deployments which are being indexed or were indexed by node
  • Requests graph-node to generate referenced POI for referenced indexer id=0x000..0 for last N=10 Epochs and N=10 Eth Blocks (block of 1000)
  • Uploads report to POIfier-server

• POIfier-server: (developed by Ryabina) collects and organizes POI data provided by POIfier-client

How to use

Docker

Pull docker image

docker pull grassets/poifier-client

Docker compose

version: '2.1'

networks:
  monitor-net:
    driver: bridge
services:
  poifier-client:
    container_name: poifier-client
    image: grassets/poifier-client
    networks:
       - monitor-net
    restart: unless-stopped
    tty: true
    command:
      - '--poifier-token=<POIFIER_TOKEN>'
      - '--poifier-server=POIFIER_SERVER'
      - '--ethereum-endpoint=<ETHEREUM_ENDPOINT>'
      - '--mainnet-subgraph-endpoint=<MAINNET_GRAPH_SUBGRAPH>'
      - '--graph-node-status-endpoint=<GRAPH_NODE_ENDPOINT>'

How to run

$ python3 poifier-client.py --help
usage: poifier-client.py [-h] [--graph-node-status-endpoint GRAPH_NODE_STATUS_ENDPOINT] --poifier-token POIFIER_TOKEN [--poifier-server POIFIER_SERVER]
                         [--mainnet-subgraph-endpoint MAINNET_SUBGRAPH_ENDPOINT] [--ethereum-endpoint ETHEREUM_ENDPOINT]

optional arguments:
  -h, --help            show this help message and exit
  --graph-node-status-endpoint GRAPH_NODE_STATUS_ENDPOINT
                        Graph-node status endpoint, (default: http://index-node-0:8030/graphql)
  --poifier-token POIFIER_TOKEN
                        Auth token, request token via POIfier portal
  --poifier-server POIFIER_SERVER
                        URL of POIfier server (default: https://poifier.io)
  --mainnet-subgraph-endpoint MAINNET_SUBGRAPH_ENDPOINT
                        Graph network endpoint (default: https://gateway.network.thegraph.com/network)
  --ethereum-endpoint ETHEREUM_ENDPOINT
                        Ethereum endpoint to get block hash (default: https://eth-mainnet.alchemyapi.io/v2/demo)

HINT:

For key --mainnet_subgraph_endpoint you can use mainnet subgraph which is indexed locally and stored in graph-node DB. So, in case of docker infrastructure key would be similar to:

• --mainnet_subgraph_endpoint http://query-node-0:8000/subgraphs/id/Qmf5XXWA8zhHbdvWqtPcR3jFkmb5FLR4MAefEYx8E3pHfr

Requirements

Python3 packages

If you run POIfier-client on baremetal do:

pip3 install -r requirements.txt