vdl-digital-ventures / tezos-reward-distributor Goto Github PK

DISCLAIMER: TEZOS REWARD DISTRIBUTOR IS PROVIDED AS IS. IT IS UNDER CONSTANT DEVELOPMENT. EVENT THOUGH IT IS WELL TESTED, PLEASE USE IT 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 ONLY UPDATE IF NEEDED.

PRIVACY: TEZOS REWARD DISTRIBUTOR COLLECTS ANONYMOUS STATISTICS. PLEASE READ OUR STATISTICS POLICY FOR MORE INFORMATION.

TRD is a software for distributing staking rewards of Tezos delegators, introduced in detail in this Medium article. This is not a script but a full scale application which can continuously run in the background as a Linux service. It can track cycles and make payments. However, it does not have to be used as a service, but it can also be used interactively.

The documentation can be found here.

You can also ask for support on the TRD channel of the Tezos-Baking Slack group, if you are a member of this group you can view the channel here, if you are not a member you can join the group and find the trd channel from the channel list or simply file an issue.

TRD supports complex payments, pays in batches, and supports three backends for calculations: Tezos RPC, TzStats API and TzKT API. TRD is developed and tested extensively by the community.

Provider notes:

The terms and conditions of TzStats note that a license is needed for the commercial use of the API.

If you wish to use the Data in a manner that is primarily intended for or directed towards commercial advantage or monetary compensation (such use, “Commercial Use”), Blockwatch requires that you enter into a separate commercial license agreement. Entering into a separate commercial license allows us to protect Blockwatch’s investment in the Data and to maintain the integrity of the Data.

Please contact us at [email protected] for more information about Commercial Uses of our Data.

The terms of use of TzKT API allow for commercial and non-commercial use.

TzKT API is free for everyone and for both commercial and non-commercial usage.

If your application or service uses the TzKT API in any forms: directly on frontend or indirectly on backend, you should mention that fact on your website or application by placing the label "Powered by TzKT API" with a direct link to tzkt.io.

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/tezos-reward-distributor-organization/tezos-reward-distributor

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

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

Regularly check and upgrade to the latest available version:

git fetch origin #fetches new branches
git status #see the changes
git pull

Before running TRD, you need to configure it by adding your baker's address and payout settings. The configuration file should be included in the ~/pymnt/cfg/ directory by default. You can use the following command to copy and modify the example configuration:

# create directory
mkdir -p ~/pymnt/cfg/
cp tezos-reward-distributor/examples/tz1boot1pK9h2BVGXdyvfQSv8kd1LQM6H889.yaml ~/pymnt/cfg/
nano ~/pymnt/cfg/tz1boot1pK9h2BVGXdyvfQSv8kd1LQM6H889.yaml

For a list of parameters, read the online documentation, or run:

python3 src/main.py --help

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

python3 src/main.py

TRD necessitates of an interface to get provided with income and delegator data in order to perform the needed calculations.

The default provider is the TzKT API. However, it is possible to change the data provider to a local node with the flag -P rpc. In this case, the default node would be 127.0.0.1:8732. In order to change the node URL for the provider, you can pass it in the form node_url:port using the flag -A (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.

It is also possible to use a public RPC node with flag -P prpc, which defaults to https://mainnet-tezos.giganode.io.