Skip to content
TRD: A reward distribution software for tezos bakers
Python
Branch: master
Clone or download

readme.md

DISCLAIMER : TEZOS REWARD DISTRIBUTOR IS PROVIDED AS IS. IT IS UNDER CONSTANT DEVELOPMENT. EVENT THOUGH IT IS WELL TESTED, PLEASE USE WITH CARE. ALWAYS MAKE A PRE-RUN IN DRY MODE BEFORE MAKING ACTUAL PAYMENTS. IF YOU WANT TO RUN IN SERVICE MODE DO IT AFTER YOU ARE CONFIDENT WITH THE APPLICATION. IN SERVICE MODE DO NOT UPDATE OFTEN.

Tezos Reward Distributor : Run & Forget Build Status

TRD is a software for distributing baking rewards with delegators. The documentation can be found here. This is not a script but a full scale application which can run in the background all the time. It can track cycles and make payments. It does not have to be used as a service, It can also be used interactively.

TRD supports complex payments, pays in batches, provides two back ends for calculations: rpc and tzstats. Developed and tested extensively by the community. For more information please check following article.

Medium article

Requirements and Setup:

Python 3 is required. You can use the following commands to install it.

sudo apt-get update
sudo apt-get -y install python3-pip

Download the application repository using git clone:

git clone https://github.com/habanoz/tezos-reward-distributor

To install required modules, use pip with requirements.txt provided.

cd tezos-reward-distributor
pip3 install -r requirements.txt

Regularly check and upgrade to the latest available version:

git pull

Sample configuration:

Before running the TRD, you need to configure a few stuff including the baking address and the payout process. The configuration file should be by default included in ~/pymnt/cfg/.

cp tezos-reward-distributor/examples/tz1boot1pK9h2BVGXdyvfQSv8kd1LQM6H889.yaml ~/pymnt/cfg/

How to Run:

For a list of parameters, run:

python3 src/main.py --help

The most common use case is to run in mainnet and start to make payments from last released rewards or continue making payments from the cycle last payment is done.

python3 src/main.py

TRD necessitates an interface to get provided with income and delegator data in order to perform the needed calculations. The default provider is the public rpc node mainnet.tezrpc.me. However, it is possible to change the data provider with the flag -P rpc. Please note that in this case, the default node would be localhost:8732. In order to change the node url for the provider, you can give the desired url under the flag -A followed with node_url:port (e.g. -P rpc -A 127.0.0.1:8733). Please note that the node should be an archive node, and that the port should be the rpc port specified while launching the node.

For more example commands please see wiki page:

https://github.com/habanoz/tezos-reward-distributor/wiki/How-to-Run

Funding

TRD is an open source project and will stay like this. It is not funded by any organization. A grant request is rejected by Tezos Foundation. However, I will try to continue to enhance the software and support the community.

You can’t perform that action at this time.