Skip to content

Commit decf99c

Browse files
ypatil12wadealexc
andauthored
docs: rewards for all earners (#737)
* docs: rewards for all earners * docs: add missing link --------- Co-authored-by: wadealexc <[email protected]>
1 parent a3c2e5e commit decf99c

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

docs/core/RewardsCoordinator.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Rewards are initially submitted to the contract to be distributed to Operators a
6161

6262
* [`RewardsCoordinator.createAVSRewardsSubmission`](#createavsrewardssubmission)
6363
* [`RewardsCoordinator.createRewardsForAllSubmission`](#createrewardsforallsubmission)
64+
* [`RewardsCoordinator.createRewardsForAllEarners`](#createrewardsforallearners)
6465

6566
#### `createAVSRewardsSubmission`
6667

@@ -153,7 +154,7 @@ function createRewardsForAllSubmission(
153154

154155
This method is identical in function to [`createAVSRewardsSubmission`](#createavsrewardssubmission) above, except:
155156
* It can only be called by a whitelisted "rewards for all submitter"
156-
* ALL Stakers/Operators are eligible for rewards, instead of those specifically registered for a given AVS
157+
* ALL Stakers are eligible for rewards, instead of those specifically registered for a given AVS
157158

158159
*Effects*:
159160
* See [`createAVSRewardsSubmission`](#createavsrewardssubmission) above. The only differences are that:
@@ -163,6 +164,30 @@ This method is identical in function to [`createAVSRewardsSubmission`](#createav
163164
*Requirements*:
164165
* See [`createAVSRewardsSubmission`](#createavsrewardssubmission) above. The only difference is that each calculated rewards submission hash MUST NOT already exist in the `isRewardsSubmissionForAllHash` mapping.
165166

167+
#### `createRewardsForAllEarners`
168+
169+
```solidity
170+
function createRewardsForAllEarners(
171+
RewardsSubmission[] calldata RewardsSubmissions
172+
)
173+
external
174+
onlyWhenNotPaused(PAUSED_REWARDS_FOR_ALL_SUBMISSION)
175+
onlyRewardsForAllSubmitter
176+
nonReentrant
177+
```
178+
179+
This method is identical in function to [`createAVSRewardsSubmission`](#createavsrewardssubmission) above, except:
180+
* It can only be called by a whitelisted "rewards for all submitter"
181+
* Only operators who have opted into at least one AVS and the operator's delegated stakers are eligible for rewards
182+
183+
*Effects*:
184+
* See [`createAVSRewardsSubmission`](#createavsrewardssubmission) above. The only differences are that:
185+
* Each rewards submission hash is stored in the `isRewardsSubmissionForAllEarnersHash` mapping
186+
* Emits a `RewardsSubmissionForAllEarnersCreated` event
187+
188+
*Requirements*:
189+
* See [`createAVSRewardsSubmission`](#createavsrewardssubmission) above. The only difference is that each calculated rewards submission hash MUST NOT already exist in the `isRewardsSubmissionForAllEarnersHash` mapping.
190+
166191
---
167192

168193
### Distributing and Claiming Rewards

0 commit comments

Comments
 (0)