magurh/flare-metrics

Tools for extracting live analytics about the Flare Networks.

Flare Metrics

A set of tools for web-scrapping and analysing Flare Network's data providers.

1. FTSOv2 metrics (delegating):

   • Flare Systems Explorer
     • Songbird delegation data for current entities
     • Songbird delegation data for specific reward epochs
   • Useyourspark monitor

2. FTSO (v1) metrics (delegating):

   • flaremetrics.io - Compatibility for both Flare and Songbird
   • FTSO monitor
   • flare-base.io
   • solidifi

3. Validator metrics (staking):

   • flaremetrics.io
   • solidifi
   • flare.builders
   • flarescan

Note: Staking is currently live only on Flare. The data of the FTSO providers from flare-metrics.io does not include C-chain addresses. As such, matching FTSO addresses with validator nodes can be done only based on the names. An alternative is to use a different source for extracting FTSO data, such as the FTSO monitor, which only includes FTSO data.

Setup

Poetry is used for dependency management. Whenever new dependencies are added, run:

poetry install

To use Jupyter Lab, set the kernel to the flare-metrics environment created by poetry and run:

poetry run python -m ipykernel install --user --name=flare-metrics
poetry run jupyter lab

For simply activating the virtual environment, run poetry shell. To add new dependencies, use: poetry add <dependency>.

Web scrapping

There are two types of data that one can import: validator data which refers to the validator nodes on the P-chains, and FTSO data for the data providers on the C-chains. To import validator data, navigate to the root directory and run:

poetry run collect-validators flare-metrics

where in the above example flare-metrics is used as the source for the validator data. This will create a dataframe within the data sub-directory, with information about all current validators on Flare.

For FTSO data, there are multiple available sources: flaremetrics.io, Flare Systems Explorer (currently supporting only Songbird and testnets for FTSOv2), and FTSO monitor for FTSOv1. Run one of the following from the root directory:

poetry run collect-ftso <source> <network>

Currently supported sources are flare-metrics and sys-explorer, with available networks flr and sgb.

For FTSOv2, one can further uses the Flare Systems Explorer to extract data for a specific reward epoch by running -- check the Systems Explorer for the desired epochs:

poetry run collect-epoch 220