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

update readme

Browse Source
This commit is contained in:
Andrea Franz
2024-09-10 02:13:52 +02:00
parent e25743e2a4
commit bc58f131ae
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,4 +1,9 @@
## StakeManager
# Staking Rewards
- [Stake Manager](#stake-manager)
- [Time-Weighted Boost Stake Manager](#time-weighted-boost-stake-manager)
## Stake Manager
The rewardIndex is a crucial part of the reward distribution mechanism.
@@ -21,11 +26,13 @@ Here's how it works:
Instead of updating each user's rewards every time new rewards are added, we only need to update a
single global variable (rewardIndex).
We don't need to assign Rewards to epochs, so we don't need to finalize Rewords for each epoch and each user.
User-specific calculations are done only when a user interacts with the contract.
`SCALE_FACTOR` is used to maintain precision in calculations.
### StakeManager Example
### Stake Manager Example
Initial setup:
@@ -125,3 +132,7 @@ Final state:
* Charlie received: 30 tokens and 499.9 Rewards
* Total Rewards distributed: 2000 Rewards
* Rewards remaining in contract: 0
## Time-Weighted Boost Stake Manager
TODO