Skip to content

Commit

Permalink
Deploying to gh-pages from @ c852b20 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
jdsika committed Nov 4, 2023
1 parent 9a71f90 commit ae9afcb
Show file tree
Hide file tree
Showing 28 changed files with 187 additions and 108 deletions.
Binary file modified .doctrees/configuration.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/index.doctree
Binary file not shown.
Binary file modified .doctrees/run.doctree
Binary file not shown.
8 changes: 7 additions & 1 deletion _sources/configuration.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,13 @@ Available configuration parameters are:
tz1V9SpwXaGFiYdDfGJtWjA61EumAH3DwSyT: tz1fgX6oRWQb4HYHUT6eRjW8diNFrqjEfgq7 #(redirects payment from tz1V9S... to tz1fgX...)
tz1RMmSzPSWPSSaKU193Voh4PosWSZx1C7Hs: Dexter #(indicates address is a dexter pool; TRD will send rewards to pool members)
mindelegation: TOE #(mindelegation will be shared with everyone)

**tzpro_api_key**
Generate a tzpro API key [here](https://tzpro.io/) if you want to use it as reward or block API.

Example::
tzpro_api_key: XXXXXXXXXX

**plugins**
Please consult the `plugins docs`_ for more details on the configuring the various plugins.

Expand Down
18 changes: 8 additions & 10 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ PRIVACY : TEZOS REWARD DISTRIBUTOR COLLECTS ANONYMOUS STATISTICS. PLEASE READ OU
What's TRD?
------------------------------------------------

TRD is an open-source software for distributing staking rewards from bakers to delegators introduced in detail in this Medium article_. This is not a python script but a full scale application which can continuously run in the background as a Linux service. However it does not have to be used as a service, but it can also be used interactively. The tool convinces with its simplicity and yet leaves no configuration wish unfulfilled. Whether minimum delegation threshold, special fees for some delegators, or actual vs ideal rewards - the TRD covers just about all possible constellations. Furthermore, the tool supports complex payments, pays in batches, and provides three back ends for calculations: Tezos RPC, tzstats_ API and TzKT_ API. TRD is developed and tested extensively by the community and the source code which can be found in the following Github_ repo.
TRD is an open-source software for distributing staking rewards from bakers to delegators introduced in detail in this Medium article_. This is not a python script but a full scale application which can continuously run in the background as a Linux service. However it does not have to be used as a service, but it can also be used interactively. The tool convinces with its simplicity and yet leaves no configuration wish unfulfilled. Whether minimum delegation threshold, special fees for some delegators, or actual vs ideal rewards - the TRD covers just about all possible constellations. Furthermore, the tool supports complex payments, pays in batches, and provides three back ends for calculations: Tezos RPC, tzpro_ API and TzKT_ API. TRD is developed and tested extensively by the community and the source code which can be found in the following Github_ repo.

Who needs TRD?
------------------------------------------------
Expand All @@ -23,21 +23,19 @@ What else do you need for TRD?
There are currently the following options to run TRD:

a. If you want to use RPC (not public RPC) for the reward calculation, you need a Tezos archive node.
b. If you want to use an provider (pRPC, tzstats, tzkt) for the reward calculation, but want to inject your own transactions, at least a Tezos rolling node is needed.
c. If you want to use an provider (pRPC, tzstats, tzkt) for the reward calculation and don't want to inject your own transactions, only the Tezos signer is needed.
b. If you want to use an provider (pRPC, TZPRO, tzkt) for the reward calculation, but want to inject your own transactions, at least a Tezos rolling node is needed.
c. If you want to use an provider (pRPC, TZPRO, tzkt) for the reward calculation and don't want to inject your own transactions, only the Tezos signer is needed.

However, for all options the Tezos signer is needed.

**Provider notes:**

TZStats
Blockwatch: TZPRO
-----------

The terms_ of tzstats note that a license is needed for the commercial use of their API:
The terms_ of TZPRO note that an account and API key are needed for the use of the API. Please review the [pricing](https://tzpro.io/#pricing) information. For further help contact hello@blockwatch.cc for more information.

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 license@blockwatch.cc for more information about Commercial Uses of our Data.
In order to use your API key in the application copy and rename the .env.example to .env and add the API key for TZPRO.

TzKT
-----------
Expand All @@ -52,11 +50,11 @@ With PR232_ the backend of the Tezos Reward Distributor can be optionally `Power

.. _article : https://medium.com/@huseyinabanox/tezos-reward-distributor-e6588c4d27e7

.. _tzstats : https://tzstats.com/
.. _tzpro: https://tzpro.io/

.. _TzKT : https://api.tzkt.io/

.. _terms : https://tzstats.com/terms
.. _terms : https://tzpro.io/terms

.. _Github : https://github.com/tezos-reward-distributor-organization/tezos-reward-distributor

Expand Down
12 changes: 6 additions & 6 deletions _sources/run.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ Options
``-A --node_endpoint <node_url:port>``
Node potentially with protocol prefix especially if TLS encryption is used. Default value: ``http://127.0.0.1:8732``. This is the main Tezos node used by the client for RPC queries and operation injections.

``-P --reward_data_provider <rpc|prpc|tzstats|tzkt>``
Source that provides all needed data for reward calculations. Default value: ``tzkt`` (TzKT API). Set to ``rpc`` to use your own local node defined with the ``-A`` flag, (it must be an ARCHIVE node in this case). Set to ``prpc`` to use a public RPC node defined with the ``-Ap`` flag. An alternative for providing reward data is ``tzstats``, but pay attention for license in case of commercial use!
``-P --reward_data_provider <rpc|prpc|tzpro|tzkt>``
Source that provides all needed data for reward calculations. Default value: ``tzkt`` (TzKT API). Set to ``rpc`` to use your own local node defined with the ``-A`` flag, (it must be an ARCHIVE node in this case). Set to ``prpc`` to use a public RPC node defined with the ``-Ap`` flag. An alternative for providing reward data is ``tzpro``, but an API key associated with your account needs to be provided in the .env file!

``-Ap --node_addr_public <url>``
Public node base URL. Default is ``https://rpc.tzstats.com``. This argument will only be used in case the reward provider is set to ``prpc``. This node will only be used to query reward data and delegator list. It must be an ARCHIVE node.
Public node base URL. Default is ``https://mainnet.smartpy.io``. This argument will only be used in case the reward provider is set to ``prpc``. This node will only be used to query reward data and delegator list. It must be an ARCHIVE node.

``-b --base_directory <path>``
Directory for reports, configuration and logs. Default value: ``~/pymnt``.
Expand Down Expand Up @@ -131,13 +131,13 @@ Run in dry-run mode on MAINNET, make payouts only for cycle 300, for calculation

::

python3 src/main.py -C 300 -P prpc -Ap https://rpc.tzstats.com -M 3 -V -D
python3 src/main.py -C 300 -P prpc -Ap https://mainnet.smartpy.io -M 3 -V -D

Run in dry-run mode on MAINNET, retry failed payouts only for cycle 300, for calculations use data provided by the TzStats API:
Run in dry-run mode on MAINNET, retry failed payouts only for cycle 300, for calculations use data provided by the TZPRO API:

::

python3 src/main.py -C 300 -P tzstats -M 4 -V -D
python3 src/main.py -C 300 -P tzpro -M 4 -V -D

For help, run:

Expand Down
2 changes: 1 addition & 1 deletion _static/css/badge_only.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit ae9afcb

Please sign in to comment.