tezos-reward-distributor-organization/tezos-reward-distributor v10.0

Tezos Reward Distributor: Hangzhou (stable)

on GitHub

List of merged pull requests

General remarks:
There have been many changes in the development of the TRD since a new grant was awarded by the Tezos Foundation a couple of months ago. The new milestones are now closely tied to upcoming protocol upgrades. Unfortunately, we see a significant amount of bakers using the tool without dedicating time and resources to it. To maintain the tool the way we do now, we need way more resources and support from its users. The grant is intended to serve as an interim solution for an independent open-source tool in the future. To encourage attraction for code contributions, the hourly wage was increased to $70, and the compensation with tez is done via a multi-sig wallet depending on the effort spent. We would also like to appeal to the bakers, who are still developing their own payout tool to finally bundle the resources. Last but not least, here you can find instructions about how TRD can be used to send funds to the community-driven donation contracts for Ukraine or use it as a template to donate to any other address.

Important:
This release serves as a stable release before the Ithaca PR will be merged after the confidence is high enough that there are no severe bugs. This release and the current master branch will automatically shut down after 01.04.2022. We especially need help with testing from the community after the Ithaca upgrade will be live. For testing, please switch to branch "ithaca2" because the master branch will not be able to do payouts on Ithaca. Always use the dry-run option for testing! Furthermore, please SHUT DOWN THE TRD LINUX SERVICE BEFORE THE UPGRADE GOES LIVE!**

Additional Features:

• Attention: Added safety check to avoid usage of master branch after 01.04.2022 due to Ithaca transition. Switch to branch ithaca2 and carefully test.

• Breaking: The reward_type estimated is deprecated in #540.

  • You can now payout early by using --release_override -11 and adjust the payouts afterwards to the reward_types actual or ideal

  • Read about the new feature here

  • Introduced new fields in the calculations csv for overestimate, adjusted_amount and adjustment for new feature

    old	new
    estimated	adjusted_early_payouts
    actual	actual
    ideal	ideal

• Potentially Breaking. Created new trd-data folder structure. Before, in rare cases the calculations csv was overwritten.

  • deprecate --reports_base and --config_dir

  • unified --log-file to --log_file

  • introduce --base_directory

  • logs by default in base directory

    # ~/pymnt/
    # └──cfg
    #    └── tz1xx.yaml
    # └──logs
    #    └── verbose_backup
    #    │   └── app_verbose.gz
    #    └── app.log
    #    └── app_verbose.log
    # └──simulations
    #    └── tz1xxx
    #       ├── calculations
    #       │   └── 449.csv
    #       └── payments
    #           ├── done
    #           │   └── 449.csv
    #           └── failed
    #               └── 449.csv
    # └──reports
    #    └── tz1xxx
    #       ├── calculations
    #       │   └── 449.csv
    #       └── payments
    #           ├── done
    #           │   └── 449.csv
    #           └── failed
    #               └── 449.csv
    

• Payment reporting, see #549 :
  Important debugging advice:

  • The payments have been correct for all tz accounts
  • kt accounts with burn fees have been incorrect as burn was always subtracted from the delegator (edge case)
  • kt burn fee is now also controlled by delegator_pays_ra_fee configuration
  • Reported overall payout amount has been incorrect and is fixed
  • Added simulated transaction fees into the calculations report csv: delegate_transaction_fee and delegator_transaction_fee
  • Added description field with error messages in payment csv for unsuccessful transactions
  • payment_logs had missing items regarding items with the status AVOIDED
  • payments that are below zero_threshold are now set to status DONE according to the definition
  • Using user friendly enum names for the payment status now
  • Changed all occurrences of XTZ and tez to mutez properly as formatted int( ) for consistency

• Plugin for Discord available

• Support all Tezos curves now

• Packages now available HERE

Changes:

• TRD checks disk size to avoid double payments when running out of space
• Improved --helpsection
• Using black formatting now
• Reduced Docker size
• Fixed versioning for docker images on DockerHub
• Optimization/corrections of fees, gas limits to avoid failed payments
• Unit testing has been increased
• Improved logging
• Exception handling and robustness has been increased
• Documentation improvements
• A lot of code cleanups
• Fixed several bugs (see PR list)