wownmedia/cryptology_tbw

Cryptology - True Block Weight Voter share payout script for ARK Core blockchains

The Cryptology True BlockWeight payout script is licenced under a Creative Commons Attribution-NoDerivatives 4.0 International License.

Before you start:

The Cryptology TBW payout script is charging a 0.5% license fee that will automatically be generated and transferred to a wallet in my control. I realize that not every delegate will agree to this and in case you do not agree then I suggest you a) write your own script or b) use one of the other scripts.

Why the license fee?

This script now charges a license fee for 2 reasons; firstly I want to stimulate and enable a new kind of proposal model where a delegate can offer to share payouts from a different income stream. In case of cryptology (on ARK and Compendia) this income stream will be the license fee that will be distributed to my voters. We probably all can agree that ARK and Compendia will thrive well when we can apply new and creative ideas that might draw attention to the projects.

Secondly I think a payout script is an essential tool for a delegate, similar to the need of a server and voters. Part of a delegate skillset would be the ability to create such a script, in case you lack this skillset (or to prevent double work) you can invest in the usage of a 3rd party script such as this one. Nobody questions the need to spend money on their server(s), nor the need to invest in voters (% share and other contributions); so why should the, essential tool, payout script be any different?

Upgrade from V2.6

Version 3.0 no longer looks for a payment signature in the VendorField. Any transfer from a delegate/validator to a voter is interpreted as a payout.

Installation

• Clone the repository to your server;
• go to the directory of the script;
• yarn install
• yarn build
• chmod +x bin/app
• cp example.env .env
• nano .env and fill out the values for your setup

Usage

You can use the script in 4 ways:

1. To calculate the amounts that would be paid out: bin/app
2. To check the transactions that will be generated: bin/app check
3. To payout your voters: bin/app payout
4. To payout your voters and check the transactions that were send to the node(s): bin/app payout check

Or to use the script from a cron job for automated payments add this line to your crontab:

00 12 * * * cd ~/cryptology_tbw && node --max-old-space-size=4096 ~/cryptology_tbw/bin/app payout

cryptology_tbw's Issues

Add configurable block rewards on V2

was added to V1, not to V2 yet

allow for custom payout frequencies

Payout is run every 24 hours, but some voters want every 7 days.

Implement a mechanism to allow operators to set a custom frequencies (in blocks) for individual addresses.

422 error

V2 compatibility

The script uses SQL queries to obtain it's data from the Node database. V2 has a different DB schema and a set of queries for V2 should be prepared.

merge v2 into v2_develop

Pull request creation failed. Validation failed: You can't perform that action at this time.

ADMIN_PAYOUT_LIST uses wrong percentage calc

percentage in ADMIN_PAYOUT_LIST is inconsistent:

Eg:

PAYOUT=0.9 // 90%
ADMIN_PAYOUT_LIST=;{"address": { "percentage": 0.1, "vendorField": ""}} // 1%

Split transaction array in blocks of 50 transactions

Currently I don't check the number of transactions in the transactions array when sending them to the node. For me it's not an issue at this moment because I only have 35 voters... but if a delegate who generates over 50 transactions per payout were to use this script, there will be a problem.

Add payout id / count to vendor field

An id or counter would be useful for checking payout runs, eg:

cryptology - payout [#5]

Check current balance of account

Check the balance of the delegate wallet and cancel all TX if not sufficient.
Send alert to NEXMO in case balance failure

Enable configuration for sidechains

The script is currently written for ARK only and should be configurable for other ARK based blockchains as well.

Add check on received TX IDs

Should add a check on returned transaction IDs to see if all transactions went through

Add whitelist option

when whitelist is set, then everything not in there is blacklisted by default

Add option to send transactions to more than 1 node

Currently the script sends all tx to 1 node. This can slow down forging of the tx.

Refactor the node config so it accepts an object with multiple nodes to POST to

NODES={[ip:"x.x.x.x", port:4003, ip:"y.y.y.y", port: 4003]}

Increase test coverage

Documentation

The title says it all :)

422 error

in Testnet while using bin/app payout and bin/app payout check getting error 422 in last line
3 Payouts initiated
[2022-05-05 01:58:44.615 +0000] INFO (Cryptology TBW): Sending 3 transactions to (ip):6003/.
[2022-05-05 01:58:44.638 +0000] ERROR (Cryptology TBW): Request failed with status code 422