Tezos Reward Distributor: Introduction

TRD is an open source reward distribution software for tezos bakers. It is simple to use. On the other hand, it has many configuration options available for those who need them. Its motto is Run&Forget. It is actively developed with an active community.

TRD is suitable for small to large scale bakers. It is suitable for home bakers to staking as a service providers. For more information see our getting starting article.

https://medium.com/@huseyinabanox/tezos-reward-distributor-getting-started-8e7030ff121f

Key Features

  • Batch payments: Payments are split into batches due to block size limitations. Each batch is paid independent of another.

Open Source

TRD is developed using python programming language. Python is widely known and very easy to understand. Choice of Python makes TRD source base open to a large audience. It is neatly coded.

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

Source code is hosted on Github. Development activity can be tracked. The number of issues open/closed may give an idea about the amount of effort given.

Over the time community members contributed to the development of TRD which makes it a community effort.

Simple To Use

TRD is designed to require a very little technical background. A configuration tool can be used to generate baking configuration. Once the configuration file is present, TRD can be either run in background service mode or in regular mode.

Background service mode is advised. It requires the least attention from the delegate. This way, the delegate can focus on other tasks. Report emails can help the delegate monitor if everything is running fine. A tool to set up the Linux service is provided with TRD. For set up steps please refer to the related page in TRD wiki.

https://github.com/habanoz/tezos-reward-distributor/wiki/Linux-Service

Calculation and payment details are reported in form of CSV files. CSV files can be opened with any spreadsheet application from which report can be filtered, formatted and analysed.

TRD has many command line options. If it is run in source code built tezos environment to pay mainnet rewards beginning from the latest unfrozen rewards, which is the most common use case, then no option is needed.

If docker environment is used, run with -d switch. If you are running tests in zeronet or alphanet environments run with -N to specify the network. If you want to pay for a single cycle and exit, run with -M 3. If you want to pay for a specific cycle run with -C to specify the cycle. Please note that, even if a cycle is explicitly specified with -C option, it will not be paid if there is an existing payment report.

If you want to make a dry run before actual run, run with -D option. With this switch, TRD will make calculations and run payment steps but do not inject the operation to the node, avoiding any actual payments. If you just want to create calculation report without any simulated payments run with -Dc switch.

In order to choose calculation back end, run with -P option. If you want to use custom configuration or reporting base directories run with -f or -r options to specify. If you want to pay for unfrozen cycles, run with -R option. To see more options run with ” — help” option.

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

Run&Forget

TRD is here to take reward distribution burden from your shoulders. Try TRD now, ask questions, create issue reports and feature requests in GitHub. Once satisfied with it, setup Linux service and forget about it. Just check report emails and make deposit to your wallet.

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

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store