AtHeartEngineer/staking-reward-streamer
1
0
Fork 0
mirror of https://github.com/vacp2p/staking-reward-streamer.git synced 2026-01-06 22:14:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: minor latex and typo fixes

Browse Source 
* MPMaximum Latex syntax fix

* Update T_RATE to reflect block time on SN Sepolia

* Pending Latex syntax fix

* Global Reward Latex syntax fix

* NewIndex Latex syntax fix

* reward example value typo fix

* format MathSpec table

* explicitly state T_RATE is chain dependent value
This commit is contained in:
Filip Pajic
2025-08-19 12:55:55 +02:00
committed by GitHub
parent 04f9c446ee
commit 1f9e9f678c
3 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/MathSpec.md
View File

@@ -17,7 +17,7 @@
| $\mathtt{APY}$ | | 100 | percent | Annual percentage yield for multiplier points. |
| $\mathsf{MPY}$ | $M_{MAX} \times \mathtt{APY}$ | 400 | percent | Multiplier points accrued maximum percentage yield. |
| $\mathsf{MPY}^\mathit{abs}$ | $100 + (2 \times M_{\text{MAX}} \times \mathtt{APY})$ | 900 | percent | Multiplier points absolute maximum percentage yield. |
| $T_{RATE}$ | (minimal blocktime) | 12 | seconds | The accrue rate period of time over which multiplier points are calculated. |
| $T_{RATE}$ | (minimal blocktime) | 2 (chain dependent) | seconds | The accrue rate period of time over which multiplier points are calculated. |
| $T_{DAY}$ | | 86400 | seconds | One day. |
| $T_{YEAR}$ | $\lfloor365.242190 \times T_{DAY}\rfloor$ | 31556925 | seconds | One (mean) tropical year. |
| $A_{MIN}$ | $\lceil\tfrac{T_{YEAR} \times 100}{T_{RATE} \times \mathtt{APY}}\rceil$ | 2629744 | tokens per period | Minimal value to generate 1 multiplier point in the accrue rate period ($T_{RATE}$). ($A_{MIN} \propto T_{RATE}$) |

2
docs/multiplier-points.md
View File

@@ -143,7 +143,7 @@ up.
Generally, the maximum amount of MP an account can accrue is capped at:
$$
\text{MP}_\text{Maximum} = \text{MP}_ \text{Initial} + \text{MP}_ \text{Potential}
\text{MP}_ \text{Maximum} = \text{MP}_ \text{Initial} + \text{MP}_ \text{Potential}
$$
- $\text{MP}_ \text{Initial}$: The initial MP an account receives when staking, \*_including the bonus MP_.

9
docs/rewards.md
View File

@@ -14,7 +14,7 @@ For example, if 1000 tokens are to be distributed over the next 10 days, the rat
tokens are then distributed to accounts based on their relative weights in the system.
In other words, if Alice and Bob both own exactly 50% of the total stake in the system (including MP), they would each
receive 50% of the rewards, or 5 tokens per day in this example.
receive 50% of the rewards, or 50 tokens per day in this example.
This is a rather trivial example. In practice we'll run into much more complex scenarios. Alice and Bob might have the
same stake, but participated in the system for different amounts of time. Or, one of them might have unstaked some
@@ -90,7 +90,7 @@ We consider any real-time rewards "pending" rewards until the account interacts
are calculated as:
$$
\text{Pending Rewards} = \text{Account Weight} \times \left( \text{Current Reward Index} \minus \text{Account's Last Reward Index} \right)
\text{Pending Rewards} = \text{Account Weight} \times \left( \text{Current Reward Index} - \text{Account's Last Reward Index} \right)
$$
The indicies are a new concept we'll cover next.
@@ -104,9 +104,10 @@ approach ensures fair distribution even as accounts enter and exit the system or
The global reward index represents the cumulative rewards per unit of weight since the system's inception. It increases
whenever new rewards are added to the system:
$
$$
\text{New Index} = \text{Current Index} + \frac{\text{New Rewards} \times \text{Scale Factor}}{\text{Total System Weight}}
$
$$
Where: