Skip to content

README.md

Latest commit

 

History

History
110 lines (79 loc) · 4.72 KB

README.md

File metadata and controls

110 lines (79 loc) · 4.72 KB
Raw

Rewards Eligibility Oracle Dashboard

The Rewards Eligibility Oracle (REO) dashboard monitors indexer eligibility for rewards based on service quality metrics in The Graph Protocol.

Live Dashboard: https://hub.thegraph.foundation/reo/

What It Does

The REO links indexer eligibility for rewards to service quality provision. Only indexers meeting performance standards receive rewards.

Features:

  • 🎯 Real-time eligibility tracking for all active indexers
  • 🌍 Multi-environment toggle (compare deployments)
  • 📊 Status categories: Active, Grace, Expired, Unqualified
  • 🔔 Optional Telegram notifications for status changes
  • 🔄 Auto-refreshes every 5 minutes

Quick Start

# Clone and setup
git clone https://github.com/graphprotocol/rewards-eligibility-oracle-dashboard.git
cd rewards-eligibility-oracle-dashboard
pip3 install -r requirements.txt
cp env.example .env

# Build the frontend once (needs Node.js >= 20). This compiles the renderer and
# the GDS stylesheet that generate_dashboard.py renders through.
bash scripts/build_frontend.sh

# Edit .env with your API keys and RPC endpoints, then:
python3 generate_dashboard.py
open output/index.html

After deploying, verify visually — an HTTP 200 does not mean the page rendered:

cd frontend && npm run verify -- https://hub.thegraph.foundation/reo

This drives a real browser, asserts styling/data/hydration, saves screenshots to verification-shots/, and exits non-zero on failure.

The dashboard is written to output/index.html (override with REO_OUTPUT_DIR). Re-run scripts/build_frontend.sh only when frontend code changes; day-to-day data refreshes just need python3 generate_dashboard.py. Each environment queries its own chain, so mainnet needs RPC_ENDPOINT_MAINNET and testnet needs RPC_ENDPOINT_TESTNET (see env.example).

Environments

Contract addresses are resolved dynamically per network from the GitHub registry (addresses.json). The values below reflect the current registry entries:

Environment Contract Address Network
mainnet 0x8ec2767a9d9ba02b4e09e8ff4fac2e14a340f304 Arbitrum One (42161)
testnet 0x6ba849fbd33257162552578b2a432d30784f2f80 Arbitrum Sepolia (421614)

The Sepolia registry exposes several oracle variants (RewardsEligibilityOracleA/B/Mock); the auto-pick lands on A. To pin an explicit address, set TESTNET_CONTRACT_ADDRESS (or MAINNET_CONTRACT_ADDRESS) in .env.

Architecture

Two halves, one contract between them:

generate_dashboard.py  ->  output/data.json  ->  React (SSG)  ->  output/index.html

generate_dashboard.py fetches on-chain data and writes JSON; the React frontend in frontend/ renders that JSON to static HTML. The frontend reads only data.json, and Python emits no markup.

Nothing is fetched in the browser — freshness comes from regenerating every ~5 minutes, so the page is a snapshot that is never more than one cycle stale. The UI is built on The Graph Design System (@graphprotocol/gds-react).

Data Sources

  • Network Subgraph: Active indexers (stakedTokens > 0) — both environments query the Arbitrum One network subgraph, so testnet scores the real mainnet indexer set against the testnet oracle
  • ENS Subgraph: Indexer ENS names
  • RPC Calls: Contract state (eligibility, timestamps)
  • GitHub Registry: Contract addresses (addresses.json)

Documentation

For AI agents and developers:

Telegram Bot (Optional)

# Add to .env:
TELEGRAM_BOT_TOKEN=your_bot_token_here

# Run the bot
python3 telegram_bot.py

Commands: /start, /watch <address>, /unwatch <address>, /watchlist, /status, /help

License

MIT License - see LICENSE file.

Links: