indexer-service-rs

Experimental rust impl for The Graph indexer service

Dependency choices

• switching from actix-web to axum for the service server
• App profiling should utilize perf, flamegraphs or cpu profilers, and benches to track and collect performance data. The typescript implementation uses gcloud-profile
• Consider replacing and adding parts from TAP manager

Don't know if receipt validation is actually correct, need testing

Components checklist (basic, not extensive)

• Server path routing
  • basic structure
  • CORS
  • timeouts
  • Rate limiting levels
  • Logger stream
• Query processor
  • graph node query endpoint at specific subgraph path
  • wrap request to and response from graph node
  • extract receipt header
  • Free query
    • Query struct
    • Free query auth token check
    • Query routes + responses
    • set graph-attestable in response header to true
  • Network subgraph query
    • Query struct
    • serve network subgraph boolean + auth token check
    • Query routes + responses
    • set graph-attestable in response header to false
  • Paid query
    • receipts graphQL schema
    • TAP manager to handle receipts logic
      • derive, cache, and look up attestation signers
        • contracts - connect by network chain id
          • network provider
      • validate receipt format (need unit tests)
      • parse receipt (need unit tests)
      • validate signature (need unit tests)
      • store
    • extract graph-attestable from graph node response header
    • monitor eligible allocations
      • network subgraph
      • operator wallet -> indexer address
  • subgraph health check
  • query timing logs
• Deployment health server
  • query status endpoint and process result
• Status server
  • indexing status resolver - to query indexingStatuses
  • Filter for unsupported queries
• Cost server
  • Cost graphQL schema
  • query indexer management client for Cost model
• Constant service paths
  • health
  • ready to roll
  • versions
  • operator public key
    • validate mnemonics to public key
• Import indexer native
• Metrics
  • Metrics setup
  • serve basic indexer service metrics
  • Add cost model metrics
• CLI args
• App profiling
  • No gcloud profiling, can use perf to collect performance data.

Indexer common components

Temporarily live inside the indexer-service package under src/common.

Indexer native dependency

Linked dependency could not be linked directly with git url "https://github.com/graphprotocol/indexer" and path "packages/indexer-native/native" at the same time, and could not access it on crates.io. So copid the folder to local repo with the version at https://github.com/graphprotocol/indexer/blob/972658b3ce8c512ad7b4dc575d29cd9d5377e3fe/packages/indexer-native/native.

Since indexer-service will be written in Rust and no need for typescript, indexer-native's neon build and util has been removed.

Component NativeSignatureVerifier renamed to SignatureVerifier.

Separate package in the workspace under 'native'.

common-ts components

Temporarily live inside the indexer-service package under src/types

• Address
• readNumber

Quick attempts

Configure required start-up args, check description by

cargo run -p service -- --help

Set up configurations. To run with toml configurations

cargo run -- config "template.toml"

To run with CLI args

cargo run -- --ethereum <eth-node-provider> \
  --mnemonic <operator-mnemonic> \
  --indexer-address  <indexer-address ></indexer-address> \
  --port 7300 \
  --metrics-port 7500 \
  --graph-node-query-endpoint http://localhost:8000 \
  --graph-node-status-endpoint http://localhost:8030 \ 
  --free-query-auth-token "free-query-auth" \
  --postgres-host "127.0.0.1" \
  --postgres-port 5432 \
  --postgres-database postgres  \
  --postgres-username <postgres-username> \
  --postgres-password <postgres-password> \
  --network-subgraph-endpoint "https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network \
  --network-subgraph-auth-token "network-subgraph-auth" \
  --serve-network-subgraph true \
  --client-signer-address "0xe1EC4339019eC9628438F8755f847e3023e4ff9c" \

After service start up, try with command

curl -X POST \
	-H 'Content-Type: application/json' \
  --data '{"query": "{_meta{block{number}}}"}' \
	http://127.0.0.1:7300/network

Supported requests

✗ curl http://localhost:7300/
Ready to roll! 

✗ curl http://localhost:7300/health
{"healthy":true}

✗ curl http://localhost:7300/version
{"version":"0.1.0","dependencies":{}}

✗ curl http://localhost:7300/operator/info
{"publicKey":"0xacb05407d78129b5717bb51712d3e23a78a10929"}

# Subgraph queries
# Checks for receipts and authorization
✗ curl -X POST -H 'Content-Type: application/json' -H 'Authorization: token-for-graph-node-query-endpoint' --data '{"query": "{_meta{block{number}}}"}' http://localhost:7300/subgraphs/id/QmVhiE4nax9i86UBnBmQCYDzvjWuwHShYh7aspGPQhU5Sj
"{\"data\":{\"_meta\":{\"block\":{\"number\":9425787}}}}"

# Network queries
# Checks for auth and configuration to serve-network-subgraph
✗ curl -X POST -H 'Content-Type: application/json' -H 'Authorization: token-for-network-subgraph' --data '{"query": "{_meta{block{number}}}"}' http://localhost:7300/network 
"Not enabled or authorized query"

# Indexing status resolver - Route supported root field queries to graph node status endpoint
✗ curl -X POST -H 'Content-Type: application/json' --data '{"query": "{blockHashFromNumber(network:\"goerli\", blockNumber: 9069120)}"}' http://localhost:7300/status 
{"data":{"blockHashFromNumber":"e1e5472636db73ba5496aee098dc21310683c95eb30fc46f9ba6c36d8b28d58e"}}%                

# Indexing status resolver - 
✗ curl -X POST -H 'Content-Type: application/json' --data '{"query": "{indexingStatuses {subgraph health} }"}' http://localhost:7300/status 
{"data":{"indexingStatuses":[{"subgraph":"QmVhiE4nax9i86UBnBmQCYDzvjWuwHShYh7aspGPQhU5Sj","health":"healthy"},{"subgraph":"QmWVtsWk8Pqn3zY3czDjyoVreshRLmoz9jko3mQ4uvxQDj","health":"healthy"},{"subgraph":"QmacQnSgia4iDPWHpeY6aWxesRFdb8o5DKZUx96zZqEWrB","health":"healthy"}]}}

# Indexing status resolver - Filter out the unsupported queries
✗ curl -X POST -H 'Content-Type: application/json' --data '{"query": "{_meta{block{number}}}"}' http://localhost:7300/status 
{"errors":[{"locations":[{"line":1,"column":2}],"message":"Type `Query` has no field `_meta`"}]}%