From 7979fe6e9c74dc81adc7b6c752288ca10f99a080 Mon Sep 17 00:00:00 2001 From: Yash Patil Date: Tue, 10 Sep 2024 12:27:50 -0400 Subject: [PATCH 1/2] docs: rewards for all earners --- docs/core/RewardsCoordinator.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/core/RewardsCoordinator.md b/docs/core/RewardsCoordinator.md index fa473077c..82244ec39 100644 --- a/docs/core/RewardsCoordinator.md +++ b/docs/core/RewardsCoordinator.md @@ -153,7 +153,7 @@ function createRewardsForAllSubmission( This method is identical in function to [`createAVSRewardsSubmission`](#createavsrewardssubmission) above, except: * It can only be called by a whitelisted "rewards for all submitter" -* ALL Stakers/Operators are eligible for rewards, instead of those specifically registered for a given AVS +* ALL Stakers are eligible for rewards, instead of those specifically registered for a given AVS *Effects*: * See [`createAVSRewardsSubmission`](#createavsrewardssubmission) above. The only differences are that: @@ -163,6 +163,30 @@ This method is identical in function to [`createAVSRewardsSubmission`](#createav *Requirements*: * See [`createAVSRewardsSubmission`](#createavsrewardssubmission) above. The only difference is that each calculated rewards submission hash MUST NOT already exist in the `isRewardsSubmissionForAllHash` mapping. +#### `createRewardsForAllEarners` + +```solidity +function createRewardsForAllEarners( + RewardsSubmission[] calldata RewardsSubmissions +) + external + onlyWhenNotPaused(PAUSED_REWARDS_FOR_ALL_SUBMISSION) + onlyRewardsForAllSubmitter + nonReentrant +``` + +This method is identical in function to [`createAVSRewardsSubmission`](#createavsrewardssubmission) above, except: +* It can only be called by a whitelisted "rewards for all submitter" +* Only operators who have opted into at least one AVS and the operator's delegated stakers are eligible for rewards + +*Effects*: +* See [`createAVSRewardsSubmission`](#createavsrewardssubmission) above. The only differences are that: + * Each rewards submission hash is stored in the `isRewardsSubmissionForAllEarnersHash` mapping + * Emits a `RewardsSubmissionForAllEarnersCreated` event + +*Requirements*: +* See [`createAVSRewardsSubmission`](#createavsrewardssubmission) above. The only difference is that each calculated rewards submission hash MUST NOT already exist in the `isRewardsSubmissionForAllEarnersHash` mapping. + --- ### Distributing and Claiming Rewards From 4dc8b3609f400b198fd0fee6b9d5a159e310e0a0 Mon Sep 17 00:00:00 2001 From: wadealexc Date: Tue, 10 Sep 2024 20:23:38 +0000 Subject: [PATCH 2/2] docs: add missing link --- docs/core/RewardsCoordinator.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/core/RewardsCoordinator.md b/docs/core/RewardsCoordinator.md index 82244ec39..970e72896 100644 --- a/docs/core/RewardsCoordinator.md +++ b/docs/core/RewardsCoordinator.md @@ -61,6 +61,7 @@ Rewards are initially submitted to the contract to be distributed to Operators a * [`RewardsCoordinator.createAVSRewardsSubmission`](#createavsrewardssubmission) * [`RewardsCoordinator.createRewardsForAllSubmission`](#createrewardsforallsubmission) +* [`RewardsCoordinator.createRewardsForAllEarners`](#createrewardsforallearners) #### `createAVSRewardsSubmission`