Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

Latest commit

 

History

History
52 lines (38 loc) · 1.23 KB

README.adoc

File metadata and controls

52 lines (38 loc) · 1.23 KB
Raw

Keep Random Beacon Staker Reports

This repository contains tooling for generating Keep Network Random Beacon staker reports.

Installation

To install, first clone this repository on your machine:

git clone [email protected]:boar-network/keep-billings.git

Then, make sure you have the following tools on your machine:

  • Go 1.13

  • Node v11.15.0

  • Solc 0.5.17

  • go-ethereum 1.9.10 (abigen is needed)

  • wkhtmltopdf 0.12.6

If so, you can run the installation script by doing:

./scripts/install.sh

A binary named keep-billings should be created.

Configuration

To generate a report, you should provide a TOML file with basic configuration properties. An example of such config is defined in:

./configs/config.toml.SAMPLE

The default config file location is ./configs/config.toml but it can be overwritten with --config flag.

The config TOML file contains CustomersFile property which should point to a file containing the JSON with customer’s input data. You can find an example of this file in:

./configs/customers.json.SAMPLE

Usage

You can generate reports by doing:

./keep-billings generate

Run this command with -h flag to see all available options.