forked from jayjaynl/LTO_LPoSDistributor
-
Notifications
You must be signed in to change notification settings - Fork 1
/
juicy.js
605 lines (507 loc) · 22.3 KB
/
juicy.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
/* =================================================================================================================
* V1.0.0 - LTO_LPoSDistributor
*
* A fork of Plukkies version of the LPoSdistribution script for LTO.network (https://github.com/plukkie/WavesLPoSDistributer)
*
* Massive thank you to Rob / G1zm0 (http://dev.pywaves.org/LTO/generators/) and Sven Stam from LTO team for helping out and fixing bugs.
*
* You can lease to '3JqGGBMvkMtQQqNhGVD6knEzhncb55Y7JJ5' for Liquid Leasing Network
*
* or to Rob/G1zm0: '3JeUGgoCUy5wXpNKHqhaLpvGZrshtvwt9b9'
*
* Please see CHANGELOG.txt for all features/changes
* Please see README.md for complete explanation of LPoSdistributor package
*
* Bare minimum changes to edit:
* - put your address here: const myleasewallet = '<Put your Leasewallet address here>';
* - put the blockchain node and port where you access the API: const myquerynode = "http://<node ip/name:port here>";
* - How many percentage fees do you want to share with your leasers: const feedistributionpercentage = <nr here>;
* - How many blocks do you want to collect in every collector run: const blockwindowsize = <nr here>;
*
* Don't forget to set values in batchinfo.json only once! :-)
* See README.md for explanation
*
* ================================================================================================================= */
// START - Put your settings here
const myleasewallet = 'your address'; //Put here the address of the wallet that your node uses
const myquerynode = "http://localhost:6869"; //The node and API port that you use (defaults to localhost)
const feedistributionpercentage = 95; //How many % do you want to share with your leasers (defaults to 90%)
const specialfeedistributionpercentage = 97; //How many % do you want to share with specific addresses? (set in: specialfeearray)
const blockwindowsize = 5000; //how many blocks to proces for every paymentcycle
// Put here wallet addresses that will receive no fees
// var nofeearray = [ "3P6CwqcnK1wyW5TLzD15n79KbAsqAjQWXYZ", //index0
// "3P9AodxBATXqFC3jtUydXv9YJ8ExAD2WXYZ" ];
var nofeearray = [ ];
// Put here wallet addresses that will be handled with special fees
// var specialfeearray = [
// "3Jqib5pvD9iERGqNN6J7AyfM84sXkB56MvG",
// "3P6CwqcnK1wyW5TLzD15n79KbAsqAjQWXYZ"
// ];
var specialfeearray = [ ];
// END - your settings
var request = require('sync-request');
var fs = require('fs');
// file with the batch data to start collecting. Will be updated after succesfull appng run
var batchinfofile = "batchinfo.json";
var payqueuefile = "payqueue.dat";
function nodeVersionCheck (oldVer, newVer) {
const oldParts = oldVer.split('.')
const newParts = newVer.split('.')
for (var i = 0; i < newParts.length; i++) {
const a = ~~newParts[i]
const b = ~~oldParts[i]
if (oldVer === "1.6.3-10-g899de90") return true // nightly build
if (oldVer === "1.6.3-12-g1589928") return true // nightly build
if (a < b) return true
if (a > b) return false
}
return false
}
if (fs.existsSync(batchinfofile)) {
var rawbatchinfo = fs.readFileSync(batchinfofile);
var batchinfo = JSON.parse(rawbatchinfo);
mybatchdata = batchinfo["batchdata"];
paymentstartblock = parseInt(mybatchdata["paystartblock"]);
paymentstopblock = parseInt(mybatchdata["paystopblock"]);
startscanblock = parseInt(mybatchdata["scanstartblock"]);
payid = parseInt(mybatchdata["paymentid"]);
// Collect height of last block in lto blockchain
let options = {
uri: "/blocks/height",
baseUrl: myquerynode,
method: "GET",
headers: {
json: true
}
};
// Get node version
let optionsVersion = {
uri: "/node/version",
baseUrl: myquerynode,
method: "GET",
headers: {
json: true
}
};
let blockchainresponse = request(options.method, options.baseUrl + options.uri, options.headers)
let lastblockheight = parseInt(JSON.parse(blockchainresponse.body).height)
let getnodeversion = request(optionsVersion.method, optionsVersion.baseUrl + optionsVersion.uri, optionsVersion.headers)
let nodeversion = JSON.parse(getnodeversion.body).version.replace("LTO v", "")
if(nodeVersionCheck(nodeversion, "1.6.3") === false){
console.log("\n Current node version is " + nodeversion + ". This script works on nodes running 1.6.4 or higher.")
process.exit()
}else if (paymentstopblock > lastblockheight) {
let blocksleft = paymentstopblock - lastblockheight
console.log("\n Current blockheight is " + lastblockheight + ". Waiting to reach " + paymentstopblock + " for next payment round.")
console.log(" This is approximaly in ~" + Math.round((blocksleft)/60) + " hrs (" + (Math.round((blocksleft/60/24)*100))/100 + " days).\n")
process.exit()
} else { var backupbatchinfo = fs.writeFileSync(batchinfofile + ".bak",fs.readFileSync(batchinfofile)) } //Create backup of batchdatafile
}
else {
console.log("\nError, batchfile",batchinfofile,"missing. Will stop now.\n");
process.exit() //if the batchinfofile doesn't exist stop further processing
}
var config = {
address: myleasewallet,
startBlockHeight: paymentstartblock,
endBlock: paymentstopblock,
filename: 'ltoleaserpayouts', //.json added automatically
paymentid: payid,
node: myquerynode,
feeAmount: 100000000,
percentageOfFeesToDistribute: feedistributionpercentage,
specialpercentageOfFeesToDistribute: specialfeedistributionpercentage
};
var myLeases = {};
var myCanceledLeases = {};
var currentStartBlock = startscanblock;
var prevleaseinfofile = config.startBlockHeight + "_" + config.address + ".json";
if (fs.existsSync(prevleaseinfofile))
{
console.log("reading " + prevleaseinfofile + " file");
var data=fs.readFileSync(prevleaseinfofile);
var prevleaseinfo=JSON.parse(data);
myLeases = prevleaseinfo["leases"];
myCanceledLeases = prevleaseinfo["canceledleases"];
currentStartBlock = config.startBlockHeight;
}
//do some cleaning
var cleancount = 0;
for(var cancelindex in myCanceledLeases)
{
if(myCanceledLeases[cancelindex].leaseId in myLeases)
{
//remove from both arrays, we don't need them anymore
delete myLeases[cancelindex];
delete myCanceledLeases[cancelindex];
cleancount++;
}
}
console.log("done cleaning, removed: " + cleancount);
var payments = [];
var myAliases = [];
var BlockCount = 0;
var LastBlock = {};
var myForgedBlocks = [];
/**
* This method starts the overall process by first downloading the blocks,
* preparing the necessary datastructures and finally preparing the payments
* and serializing them into a file that could be used as input for the
* masspayment tool.
*/
var start = function() {
// console.log('get aliases');
// myAliases = getAllAlias();
console.log('getting blocks...');
var blocks = getAllBlocks();
console.log('preparing datastructures...');
prepareDataStructure(blocks);
console.log('preparing payments...');
myForgedBlocks.forEach(function(block) {
if (block.height >= config.startBlockHeight && block.height <= config.endBlock) {
var blockLeaseData = getActiveLeasesAtBlock(block);
var activeLeasesForBlock = blockLeaseData.activeLeases;
var amountTotalLeased = blockLeaseData.totalLeased;
distribute(activeLeasesForBlock, amountTotalLeased, block);
BlockCount++;
}
});
//Get last block
LastBlock = blocks.slice(-1)[0] ;
pay();
console.log("blocks forged: " + BlockCount);
};
/**
* This method organizes the datastructures that are later on necessary
* for the block-exact analysis of the leases.
*
* @param blocks all blocks that should be considered
*/
var prepareDataStructure = function(blocks) {
blocks.forEach(function(block,index) {
var myblock = false;
var ltoFees = 0;
if (block.generator === config.address)
{
myForgedBlocks.push(block);
myblock = true;
}
var blockltofees=0;
block.transactions.forEach(function(transaction) {
// type 8 are leasing tx
if (transaction.type === 8 && transaction.recipient === config.address){
transaction.block = block.height;
myLeases[transaction.id] = transaction;
} else if (transaction.type === 9 && myLeases[transaction.leaseId]) { // checking for lease cancel tx
transaction.block = block.height;
myCanceledLeases[transaction.leaseId] = transaction;
}
});
if(myblock) {
blockltofees = block.generatorReward;
blockfee = block.fee;
blockburned = block.burnedFees;
blockminingReward = block.miningReward;
}
//console.log(`Block ${block.height}: ${ltoFees} | ${blockltofees}`)
// if(blockltofees > 0){
// fs.writeFile('./output.txt', `${block.height}; ${blockltofees}; ${blockfee}; ${blockburned}; ${blockminingReward} \n`, { flag: 'a+' }, err => {});
// }
block.ltoFees = blockltofees;
blockltofees=0;
});
};
/**
* Method that returns all relevant blocks.
*
* @returns {Array} all relevant blocks
*/
var getAllBlocks = function() {
var blocks = [];
while (currentStartBlock < config.endBlock) {
var currentBlocks;
if (currentStartBlock + 99 < config.endBlock) {
console.log('getting blocks from ' + currentStartBlock + ' to ' + (currentStartBlock + 99));
currentBlocks = JSON.parse(request('GET', config.node + '/blocks/seq/' + currentStartBlock + '/' + (currentStartBlock + 99), {
'headers': {
'Connection': 'keep-alive'
}
}).getBody('utf8'));
} else {
console.log('getting blocks from ' + currentStartBlock + ' to ' + config.endBlock);
currentBlocks = JSON.parse(request('GET', config.node + '/blocks/seq/' + currentStartBlock + '/' + config.endBlock, {
'headers': {
'Connection': 'keep-alive'
}
}).getBody('utf8'));
}
currentBlocks.forEach(function(block)
{
if (block.height <= config.endBlock) {
blocks.push(block);
}
});
if (currentStartBlock + 100 < config.endBlock) {
currentStartBlock += 100;
} else {
currentStartBlock = config.endBlock;
}
}
return blocks;
};
/**
* This method distributes lto fees
* the given block.
*
* @param activeLeases active leases for the block in question
* @param amountTotalLeased total amount of leased lto in this particular block
* @param block the block to consider
*/
var distribute = function(activeLeases, amountTotalLeased, block) {
var fee = block.ltoFees;
for (var address in activeLeases) {
if ( nofeearray.indexOf(address) == -1 ) { // leaseaddress is not marked as 'no pay address'
var share = (activeLeases[address] / amountTotalLeased);
var payout = true;
} else {
var share = (activeLeases[address] / amountTotalLeased);
var payout = false;
}
var amount = fee * share;
if (address in payments) {
if (specialfeearray.indexOf(address) != -1 ){
payments[address] += amount * (config.specialpercentageOfFeesToDistribute / 100);
}else {
payments[address] += amount * (config.percentageOfFeesToDistribute / 100);
}
} else {
if (specialfeearray.indexOf(address) != -1 ){
payments[address] = amount * (config.specialpercentageOfFeesToDistribute / 100);
}else {
payments[address] = amount * (config.percentageOfFeesToDistribute / 100);
}
}
if ( payout == true ) {
let specialfee = ''
if (specialfeearray.indexOf(address) != -1 ){
specialfee = ' ('+config.specialpercentageOfFeesToDistribute+')'
}else {
specialfee = ' ('+config.percentageOfFeesToDistribute+')'
}
console.log(address + ' will receive ' + amount + ' of (' + fee + ') share: ' + share + ' ' + specialfee);
} else if ( payout == false ) {
console.log(address + ' marked as NOPAYOUT, will not receive fee share.');
}
}
};
/**
* Method that creates the concrete payment tx and writes it to the file
* configured in the config section.
*/
var pay = function() {
var transactions = [];
var totalfees =0;
var html = "";
var html = "<!DOCTYPE html>" +
"<html lang=\"en\">" +
"<head>" +
" <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">" +
" <link rel=\"stylesheet\" href=\"https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/css/bootstrap.min.css\">" +
" <script src=\"https://code.jquery.com/jquery-3.3.1.min.js\"></script>" +
" <script src=\"https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js\"></script>" +
"</head>" +
"<body>" +
"<div class=\"container\">" +
" <h3>Fee's between blocks " + config.startBlockHeight + " - " + config.endBlock + ", Payout #" + config.paymentid + "</h3>" +
" <h4>(LPOS address: " + config.address + ")</h4>" +
" <h5>Blocks forged: " + BlockCount + "</h5>" +
" <table class=\"table table-striped table-hover pt-5\">" +
" <thead> " +
" <tr>" +
" <th>Address</th>" +
" <th>LTO</th>" +
" </tr>" +
" </thead>" +
" <tbody>";
for (var address in payments) {
var payment = (payments[address] / Math.pow(10, 8));
if ( nofeearray.indexOf(address) == -1 ) {
console.log(address + ' will receive ' + parseFloat(payment).toFixed(8) )
//send lto fee
if (Number(Math.round(payments[address])) > 0) {
transactions.push({
"amount": Number(Math.round(payments[address])),
"fee": config.feeAmount,
"sender": config.address,
"recipient": address
});
}
} else {
console.log(address + ' marked as NOPAYOUT, will not receive fee share.')
}
totalfees += payments[address];
html += "<tr><td>" + address + "</td><td>" + //address column
((payments[address]/100000000).toFixed(8)) + "</td></tr>" + //lto fee's
"\r\n";
} //End for loop
html += "<tr><td><b>Total</b></td><td><b>" + ((totalfees/100000000).toFixed(8)) + "</b></td></tr>" +
"\r\n";
html += "</tbody>" +
" </table>" +
"</div>" +
"</body>" +
"</html>";
console.log("total lto fees: " + (totalfees/100000000) );
var paymentfile = config.filename + config.paymentid + ".json";
var htmlfile = config.filename + config.paymentid + ".html";
//if ( !BlockCount == 0 ) { transactions.push( { "forgedblocks:": BlockCount } ) }
fs.writeFile(paymentfile, JSON.stringify(transactions), {}, function(err) {
if (!err) {
console.log('Planned payments written to ' + paymentfile + '!');
} else {
console.log(err);
}
});
fs.writeFile(htmlfile, html, {}, function(err) {
if (!err) {
console.log('HTML written to ' + config.filename + config.paymentid + '.html!');
} else {
console.log(err);
}
});
// Create logfile with paymentinfo for reference and troubleshooting
fs.writeFile(config.filename + config.paymentid + ".log", "total lto fees: " + (totalfees/100000000) + "\n"
+ "Total blocks forged: " + BlockCount + "\n"
+ "Payment ID of batch session: " + config.paymentid + "\n"
+ "Payment startblock: " + paymentstartblock + "\n"
+ "Payment stopblock: " + paymentstopblock + "\n"
+ "Following addresses are skipped for payment; \n"
+ JSON.stringify(nofeearray) + "\n", function(err) {
if (!err) {
console.log('Summarized payoutinfo is written to ' + config.filename + config.paymentid + ".log!");
console.log();
} else {
console.log(err);
}
});
// End create logfile
var latestblockinfo = {};
latestblockinfo["leases"]=myLeases;
latestblockinfo["canceledleases"]=myCanceledLeases;
var blockleases = config.endBlock + "_" + config.address + ".json" ;
fs.writeFile(blockleases, JSON.stringify(latestblockinfo), {}, function(err) {
if (!err) {
console.log('Leaseinfo written to ' + blockleases + '!');
} else {
console.log(err);
}
});
var ActiveLeaseData = getActiveLeasesAtBlock(LastBlock);
fs.writeFile("LastBlockLeasers.json", JSON.stringify(ActiveLeaseData), {}, function(err) {
if (!err) {
console.log('ActiveLeasers written to LastBlockLeasers.json!');
} else {
console.log(err);
}
});
// Write the current payid of the batch to the payment queue file. This is used by the masspayment tool
let paymentqueue = function (callback) {
payarray = [ ];
if ( fs.existsSync(payqueuefile) == false ) { //There is no paymentqueue file!
console.log("\nApparently there's no paymentqueue file yet. Adding paymentid '" + payid + "' of current batch to queuefile " + payqueuefile);
console.log("You can now either start the next collector session, when finished it will automatically be added to the payment queue.");
console.log("You can also verify the payment queue with the payment check tool (checkPayment.js). All pending payments are");
console.log("automatically found and checked.");
console.log("Or you can run the payment tool (masspayment.js), which automatically executes the transactions to all leasers for all");
console.log("jobs in the payment queue. Whenever a job is finished, it is automatically removed from the payment queue file.\n");
payarray = [ payid ];
} else { // there is a paymentqueue file!
rawarray = fs.readFileSync(payqueuefile, function(err, data) { //read it into array
if (err) { console.log("\nWARNING! Error reading paymentqueue file. terminating tool. Run batch " + payid + " again.\n");return; }
});
payarray = JSON.parse(rawarray); //read it into array
//case 1. It's empty
if ( payarray.length == 0 ) {
console.log("\nCurrently there are no payments pending in the queue.");
console.log("Adding paymentid '" + payid + "' to queuefile " + payqueuefile + ". This is the only payment in the queue now :-)\n");
console.log("You can now either start the next collector session, when finished it will automatically be added to the payment queue.");
console.log("You can also verify the payment queue with the payment check tool (checkPayment.js). All pending payments are");
console.log("automatically found and checked.");
console.log("Or you can run the payment tool (masspayment.js), which automatically executes the transactions to all leasers for all");
console.log("jobs in the payment queue. Whenever a job is finished, it is automatically removed from the payment queue file.\n");
payarray = [ payid ]
}
//case 2. It's not empty, but has paymentid duplicates waiting
else if ( payarray.includes (payid) == true ) {
console.log("\nWARNING! Found paymentid " + payid + " already in queue. This means there has already ran a batch with this id,\n"
+"for which payments were not done yet. If you expect this because you used the old batchinfo file again, then it's fine.\n"
+"The paymentqueue stays the same and has following payments waiting [" + payarray + "]. The batchinfo that was used in current run is:\n");
console.log(mybatchdata);
console.log("\nYou can verify the actual payments that will be done in a dry run first by starting the checkPaymentsFile.js script.");
console.log("\nHowever, if you weren't expecting a job with same paymentid in the queue (which normally shouldn't), then check logs!!!\n");
}
//case 3. It's not empty. Add current batch to queue
else {
console.log("\nFound " + payarray.length + " pending payments already in queue. Adding current batch with paymentid " + payid + " to the queue.")
payarray.push(payid);
console.log("The total queue waiting for payouts is now: " + payarray);
}
}
nextpayid = payid + 1
console.log("The next batch session will be '" + nextpayid + "'\n");
fs.writeFileSync(payqueuefile, JSON.stringify(payarray), function (err) {
if (err) {
console.log("\nWARNING! Error updating payment queue file. Terminating tool. Run batch " + payid + " again.\n");
return;
}
});
callback();
};
// update json batchdata for next collection round
let nextbatchdata = function () {
mybatchdata["paymentid"] = (payid + 1).toString()
mybatchdata["paystartblock"] = (paymentstopblock).toString()
mybatchdata["paystopblock"] = (paymentstopblock + blockwindowsize).toString()
fs.writeFile(batchinfofile, JSON.stringify(batchinfo), (err) => {
if (err) {
console.log("Something went wrong updating the file:" + batchinfofile + "!");
console.log(err);
} else {
console.log("Batchinfo for next payment round is updated in file " + batchinfofile + "!");
console.log();
}
});
};
// update the paymentqueue and callback update batchdata function
paymentqueue(nextbatchdata);
};
/**
* This method returns (block-exact) the active leases and the total amount
* of leased lto for a given block.
*
* @param block the block to consider
* @returns {{totalLeased: number, activeLeases: {}}} total amount of leased lto and active leases for the given block
*/
var getActiveLeasesAtBlock = function(block) {
var activeLeases = [];
var totalLeased = 0;
var activeLeasesPerAddress = {};
for (var leaseId in myLeases) {
var currentLease = myLeases[leaseId];
if (!myCanceledLeases[leaseId] || myCanceledLeases[leaseId].block > block.height) {
activeLeases.push(currentLease);
}
}
activeLeases.forEach(function (lease) {
if (block.height > lease.block + 1000) {
if (!activeLeasesPerAddress[lease.sender]) {
activeLeasesPerAddress[lease.sender] = lease.amount;
} else {
activeLeasesPerAddress[lease.sender] += lease.amount;
}
totalLeased += lease.amount;
}
});
return { totalLeased: totalLeased, activeLeases: activeLeasesPerAddress };
};
start();