README.md

vechain-better-events

Table of Contents

• vechain-better-events
  • Contents
  • Usage
    • Install the required packages
    • Run the scripts
      • Use common addresses
      • Generate insights XLSX
      • B3TR transfers
        • Get all transfers
        • Get all transfers from a specific address
        • Get all transfers to a specific address
        • Get all transfers from and to a specific address
      • Allocations votes
        • All votes of a specific user
        • All votes of all rounds
        • All votes of a specific round
        • All votes of a specific round from a specific user

Contents

This repo contains a series of scripts useful in order to aggregate and gather analytics from events emitted from the b3tr contracts.

This is what the scripts support at the moment

• Generate a XLSX file containining different sheets:
  • An overview with all the unique users and the total votes casted in every round;
  • A sheet for every round with the details of the vote cast by the user;
• Get the B3TR transfers from or to specific addresses;
• Get the formatted votes of all or specific users for one or more rounds;

Usage

Install the required packages

yarn install

Require to have yarn installed globally

If yarn is not installed, follow this

Run the scripts

Use common addresses

For -v, -f and -t options used with the --transfers and --votes scripts, you can use common names to have their addresses automatically resolved. This is the names we currently support:

• mugshot_treasury;
• mugshot_contract;
• cleanify_treasury;
• cleanify_campaigns;
• cleanify_daily;
• vyvo_treasury;
• treasury;

Generate insights XLSX

yarn start --insights

Will produce a file vebetterdao_insights.xlsx in the same folder

B3TR transfers

Get all transfers

yarn start --transfers

Get all transfers from a specific address

yarn start --transfers -f <address>

Get all transfers to a specific address

yarn start --transfers -t <address>

Get all transfers from and to a specific address

yarn start --transfers -f <address_1> -t <address_2>

Allocations votes

All votes of a specific user

yarn start --votes -v <address>

All votes of all rounds

yarn start --votes

All votes of a specific round

yarn start --votes -r 1

All votes of a specific round from a specific user

yarn start --votes -r <round_number> -v <address>