search

novalabsxyz / devdocs

Helium developer documentation site
https://developer.helium.com
46 stars 45 forks source link

Suggested changes to 'mining-token-rewards.md' #133

Closed anthonyra closed 4 years ago

anthonyra commented 4 years ago

Starting from the top of the article. I'm not sure if this is a convention around the world when it comes to technical (ish) documents but with my past experience U.S Navy Nuclear Power Plant Operator. There are two different types of tips (what Gitbook calls them) "notes" and "warnings". "notes" are things that amplify some information but doesn't affect you personally overall. "warnings" are ones that if done improperly could lead to you or someone getting hurt. I don't think there are any potential "warnings" in regards to Helium.. however the major difference is a location in the document. "notes" go after the item it's amplifying and "warnings" come before.

TL;DR - I think the tip should go after the table.

The Tip "Rewards Change Over Time" contents might need to be cleaned up a little bit. I understand that HNT rewards are scheduled to change over time, which is currently referenced. But I believe what HIP 10 does can also be seen as the rewards changing.

Recommendation: In the above table you can see the maximum allotted rewards per reward type in accordance with HIP 10.

If you're interested in the current reward type % you can check out the Chain Variables API. (However, I think it would be cool to have a refresh button that taps into the blockchain API)

The next maximum allotted rewards change is currently scheduled for August 1, 2021.

I feel the paragraph under the table could read more like this?

"HIP10 was introduced by Helium Community Member hashc0de and was adopted by the Helium Community, HIP10 ensures that HNT is rewarded at a rate of 1:1 to the amount of Data Credits (DC) routed by any given Hotspot per epoch. In doing so the Data Network Traffic reward is proportional to the DC spent that epoch. This proportional relationship between Data Network Traffic reward type and DC is capped at 32.5% (1113.0145 HNT). Therefore, if the DC burned doesn't equal the value of 1113.0145 HNT the remaining HNT is redistributed to the Proof of Coverage (PoC) rewards groups pro-rata.

Here are a few examples to illustrate how this works in practice:"

My final suggestion is with your examples. I think it would be cool if there were tables that showed the reward break down but by Hotspot types. The reason is to help buyers be a little more educated when buying. If they saw the potential rewards for having only 1 hotspot in the area vice 3 it would help allow them to make a better judgment call when ordering the hotspots.

I think you can just show the difference between 1 hotspot, 3 hotspots (minimum earnings while being a challengee and witness), and the consensus group.

PharkMillups commented 4 years ago

Thanks, Anthony. Excellent feedback. I'll integrate most of this in the next few days.

PharkMillups commented 4 years ago

Ok. I made most of the first three changes. I still need to spend some time making the rewards breakdown more granular. I'll do that soon. Going to close this for now though. Good stuff. Thanks.