Skip to content

Commit 7f427b2

Browse files
committed
docs: add notes about the rewards getters [L01]
1 parent 10a7a63 commit 7f427b2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

contracts/rewards/RewardsManager.sol

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@ import "./IRewardsManager.sol";
1717
* towards each subgraph. Then each Subgraph can have multiple Indexers Staked on it. Thus, the
1818
* total rewards for the Subgraph are split up for each Indexer based on much they have Staked on
1919
* that Subgraph.
20+
*
21+
* Note:
22+
* The contract provides getter functions to query the state of accrued rewards:
23+
* - getAccRewardsPerSignal
24+
* - getAccRewardsForSubgraph
25+
* - getAccRewardsPerAllocatedToken
26+
* - getRewards
27+
* These functions may overestimate the actual rewards due to changes in the total supply
28+
* until the actual takeRewards function is called.
2029
*/
2130
contract RewardsManager is RewardsManagerV2Storage, GraphUpgradeable, IRewardsManager {
2231
using SafeMath for uint256;

0 commit comments

Comments
 (0)