Skip to content

A script that automatically claims Block Producer (BP) rewards 🛠️

License

Notifications You must be signed in to change notification settings

eoscostarica/claim-bp-rewards

Repository files navigation

Claim Block Producer Rewards

This script is meant to be run as a cron job that checks if a Block Producer's account has claimed rewards in the last 24 hours.

If the BP has not claimed rwards in the last 24hrs it will call the claimrewards action to collect payment.

Installation

Basic knowledge about Docker and NodeJS is required.

Getting started

Some things you need before getting started:

Running for the first time

  1. Clone this repo using git clone --depth=1 https://github.com/eoscostarica/claim-bp-rewards.git <YOUR_PROJECT_NAME>
  2. Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.
  3. Copy and rename the .env.example to .env then update the environment variables according to your needs
  4. For the CLAIM_NETWORK, the supports networks are: libre,libre-testnet, antelope, jungle, telos, telos-testnet, proton, proton-testnet, wax, wax-testnet

Quick start

At this point you can execute make run to execute the resource watcher locally.

File Structure

Within the project repository you will find the following directories and files:

claim-bp-rewards/
├── src ..................... Project Source Code
| ├── index.js .............. Claim Rewards Script
| ├── config ................ Configuration Parameters
│ └── utils ................. EOSJS Utilities
├── package.json ............ NPM Project Metadata
├── yarn-lock.json .......... NPM Packages Lock File
├── .env.example ............ Environmental Variables Example File
├── .gitignore .............. Files Ignored by Git
├── Dockerfile .............. Docker Build 
├── LICENSE ................. MIT License Terms
└── README.md ............... Project Documentation

Contributing

Please Read EOS Costa Rica's Open Source Contributing Guidelines.

Please report bugs big and small by opening an issue

About EOS Costa Rica

image

Twitter Discord

EOS Costa Rica is an independently-owned, self-funded, bare-metal Genesis block producer that provides stable and secure infrastructure for the EOS mainnet. We support open source software for our community while offering enterprise solutions and custom smart contract development for our clients.