@circles/analysis

circles-analysis

Analysis and statistics toolkit for Circles

Handbook | Releases | Contributing

Analysis and statistics toolkit for Circles, displaying basic metrics and exporting tabular data for further analysis in .csv or .json format.

Example

$ circles-analysis --output example.csv --format csv velocity
Analyse "velocity" (transfer velocity):
Request all "notifications" data from Graph ...
◆ Total days recorded: 112
◆ Velocity (Circles / Day): 20.069135714285716134
◆ Max velocity (one day): 553.2
Done processing 112 data entries total!
Stored results in example.csv

Installation

npm i -g @circles/analysis

Usage

Usage: circles-analysis [options] [command]

Circles statistics and analysis toolkit

Options:
  -V, --version                output the version number
  -e, --endpoint <url>         graphQL subgraph endpoint (default: "https://api.thegraph.com/..")
  -f, --format <csv|json>      file format of output file (default: "csv")
  -o, --output <path>          optional file output for tabular data
  -s, --relayer_address <str>  address of relayer funder (default: "0x0739..")
  -h, --help                   display help for command

Commands:
  transitive                transitive transactions in the Circles hub
  transfers                 regular transfer transactions including: transfer steps, ubi payouts, and gas fees
  transfersWithTimestamp    regular transfer transactions with timestamps including: transfer steps, ubi payouts, and gas fees
  trusts                    trust connection events
  ownerships                safe ownership events / device changes
  safes                     safe deployments and balances
  velocity                  transfer velocity
  help [command]            display help for command

Development

# Install dependencies
npm install

# Run commands like ..
node ./index.js --output results.csv velocity

// Import methods like ..
import analysis from '@circles/analysis';

analysis.setConfiguration({
 safeAddress: '...',
 endpoint: '...',
});

const velocity = await analysis.getVelocity();

License

GNU Affero General Public License v3.0 AGPL-3.0

Changelog

[0.6.1] - 2023-04-06

Fixed

• Fix the output of the transfersWithTimestam option #27
• Write in the output file in chunks of data #27
• Add retry logic when error occurs #27

Changed

• Update dependencies