Rated CLI

A tool to interact with the Rated Network API.

Beacon Chain validator ratings from the command line.

Usage:
  rated-cli [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  watch       Watch performances of Ethereum validator keys

Flags:
      --config string   config file (default is $HOME/.rated-cli.yaml)
  -h, --help            help for rated-cli

Use "rated-cli [command] --help" for more information about a command.

Configuration

Example of a configuration file:

rated:
  # Endpoint to the Rated Network API
  apiEndpoint: https://api.rated.network

  # JWT Access token to the Rated Network API
  accessToken: sometoken

  # Optional: network to query, currently supports mainnet and prater
  network: mainnet {'mainnet', 'prater'}

  # Interface to listen on to expose Prometheus metrics and health probes handlers
  listenOn: :8080
  
  # Configuration of the watcher service
  watcher:
    # Can be `day` or `hour` {'day', 'hour'}
    # Note: Days run on 24h intervals (225 epochs) from genesis. This means noon UTC to noon UTC the following day.
    # Note: "hours" are 57.6 minute intervals (9 epochs). A day contains exactly 25 such intervals.
    # Note: Prater will default to 'day'
    granularity: hour

    # List of validation keys to monitor
    validationKeys:
      label1:
        - a26c2959d31d3f143eedd9f7377e33d842be77dffadaa4b12f8be2ccee725e797b2d7e93d5c55dbc1cb35177181401f4
      label2:
        - a4a962fa6a13b57cb04c24821abc04dc219d4f3ffc65308bb483792e12402a983d68eb304a3af87e95ea9f9d8163ef46

Building & Running

make
bin/rated-cli --config config.yaml watch

Features

Grafana

If you are running it in an environment with Prometheus & Grafana, you can install the ready-to-use dashboard in Grafana by:

clicking on the + icon on the left menu and selecting Import,
pasting the JSON and clicking the Load button.

You will end up with a similar-looking dashboard:

Watcher