search

ReneSmeekes / storj_earnings

Earnings calculation script for Storj V3 storagenodes
109 stars 23 forks source link

Better document vetting % formula #27

Open APCBoston opened 5 months ago

APCBoston commented 5 months ago

Currently on my output listing I see in relevant part:

eu1.storj.io:7777 (51% Vetted > 34/100 Audits)

Of course, 34/100 != 0.51. 34/100 == .34, or 34%.

Based on the code below, I see that earnings.py is doing something more... complicated to compute the vetting % but without knowing (or poking around to figure out) the structure of the data variable, it's not making a lot of sense.

To resolve this issue, I request that either the script output or the readme.md file should give some indication of the formula being used to compute vetting % and why it is not the naive fraction of 100 audits that one might expect.

https://github.com/ReneSmeekes/storj_earnings/blob/8e88c73641c1280bbd26158ff552bd1dfff621e7/earnings.py#L425-L427

ReneSmeekes commented 5 months ago

The percentage shown is meant to indicate a timewise progress of the vetting period. Nodes with less data get fewer audits, so vetting starts slow and speed up over time. I try to put as much info in the tool as possible, but there is clearly not enough space to include this information. I'll consider adding it to the readme. Thanks for the feedback.

APCBoston commented 5 months ago

Thanks for the clarification. I just found it super confusing, to the extent that I expected it to be a math error in the code until I went looking. This seems particularly important to me as the consumer of vetting-percent information is most likely to be a new SNO (like me!). If one wanted to include this clarification in the terminal output it could go at the bottom under the table, like a footnote -- but there's already a lot there as you noted. I think it would be fine in the readme.

On Tue, Apr 16, 2024 at 10:24 AM René Smeekes @.***> wrote:

The percentage shown is meant to indicate a timewise progress of the vetting period. Nodes with less data get fewer audits, so vetting starts slow and speed up over time. I try to put as much info in the tool as possible, but there is clearly not enough space to include this information. I'll consider adding it to the readme. Thanks for the feedback.

— Reply to this email directly, view it on GitHub https://github.com/ReneSmeekes/storj_earnings/issues/27#issuecomment-2059224230, or unsubscribe https://github.com/notifications/unsubscribe-auth/AODAH7LWEJAXFW44UCTTJO3Y5UYDBAVCNFSM6AAAAABGJOUV4CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANJZGIZDIMRTGA . You are receiving this because you authored the thread.Message ID: @.***>

-- Andrew W. Piltser-Cowan @.***