Skip to content

Commit e8ba06f

Browse files
authored
chore: rename to rewards everywhere (#565)
* chore: rename to rewards * chore: fix remaining file names * chore: remove old doc * fix: try pushing bindings * fix: deploy scripts
1 parent 4866d42 commit e8ba06f

File tree

54 files changed

+9927
-9916
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+9927
-9916
lines changed

docs/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This document provides an overview of system components, contracts, and user rol
1212
* [`EigenPodManager`](#eigenpodmanager)
1313
* [`StrategyManager`](#strategymanager)
1414
* [`DelegationManager`](#delegationmanager)
15-
* [`PaymentCoordinator`](#paymentcoordinator)
15+
* [`RewardsCoordinator`](#rewardscoordinator)
1616
* [`AVSDirectory`](#avsdirectory)
1717
* [`Slasher`](#slasher)
1818
* [Roles and Actors](#roles-and-actors)
@@ -67,18 +67,18 @@ The `DelegationManager` sits between the `EigenPodManager` and `StrategyManager`
6767

6868
See full documentation in [`/core/DelegationManager.md`](./core/DelegationManager.md).
6969

70-
#### PaymentCoordinator
70+
#### RewardsCoordinator
7171

7272
| File | Type | Proxy |
7373
| -------- | -------- | -------- |
74-
| [`PaymentCoordinator.sol`](../src/contracts/core/PaymentCoordinator.sol) | Singleton | Transparent proxy |
74+
| [`RewardsCoordinator.sol`](../src/contracts/core/RewardsCoordinator.sol) | Singleton | Transparent proxy |
7575

76-
The `PaymentCoordinator` is the main entry point of submission and claiming of ERC20 payments in EigenLayer. It carries out three basic functions:
77-
* AVSs (via the AVS's contracts) submit "range payments" to their registered Operators and Stakers over a specific time period
78-
* *Off-chain*, the payment updater will use each range payment's time period to apply payment amounts to historical Staker/Operator stake weights. This is consolidated into a merkle root that is posted *on-chain* to the `PaymentCoordinator`, allowing Stakers/Operators to claim their allocated payments.
79-
* Stakers/Operators can claim payments posted by the payment updater.
76+
The `RewardsCoordinator` is the main entry point of submission and claiming of ERC20 rewards in EigenLayer. It carries out three basic functions:
77+
* AVSs (via the AVS's contracts) submit "rewards submissions" to their registered Operators and Stakers over a specific time period
78+
* *Off-chain*, the rewards updater will use each RewardsSubmission time period to apply reward amounts to historical Staker/Operator stake weights. This is consolidated into a merkle root that is posted *on-chain* to the `RewardsCoordinator`, allowing Stakers/Operators to claim their allocated rewards.
79+
* Stakers/Operators can claim rewards posted by the rewards updater.
8080

81-
See full documentation in [`/core/PaymentCoordinator.md`](./core/PaymentCoordinator.md).
81+
See full documentation in [`/core/RewardsCoordinator.md`](./core/RewardsCoordinator.md).
8282

8383
#### AVSDirectory
8484

docs/core/AVSDirectory.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Currently, the only interactions between AVSs and the core contracts is to track
1414
* [`AVSDirectory.registerOperatorToAVS`](#registeroperatortoavs)
1515
* [`AVSDirectory.deregisterOperatorFromAVS`](#deregisteroperatorfromavs)
1616

17-
In a future release, this contract will implement additional interactions that relate to (i) paying Operators for the services they provide and (ii) slashing Operators that misbehave. Currently, these features are not implemented.
17+
In a future release, this contract will implement additional interactions that relate to (i) rewarding Operators for the services they provide and (ii) slashing Operators that misbehave. Currently, these features are not implemented.
1818

1919
---
2020

@@ -41,7 +41,7 @@ Allows the caller (an AVS) to register an `operator` with itself, given the prov
4141
* `operatorSignature` must be a valid, unused, unexpired signature from the `operator`. The signature is an ECDSA signature by the operator over the [`OPERATOR_AVS_REGISTRATION_TYPEHASH`](../../src/contracts/core/DelegationManagerStorage.sol). Expiry is a utc timestamp in seconds. Salt is used only once per signature to prevent replay attacks.
4242

4343
*As of M2*:
44-
* Operator registration/deregistration does not have any sort of consequences for the Operator or its shares. Eventually, this will tie into payments for services and slashing for misbehavior.
44+
* Operator registration/deregistration does not have any sort of consequences for the Operator or its shares. Eventually, this will tie into rewards for services and slashing for misbehavior.
4545

4646
#### `deregisterOperatorFromAVS`
4747

@@ -63,7 +63,7 @@ Allows the caller (an AVS) to deregister an `operator` with itself
6363
* `operator` MUST already be registered with the AVS
6464

6565
*As of M2*:
66-
* Operator registration/deregistration does not have any sort of consequences for the Operator or its shares. Eventually, this will tie into payments for services and slashing for misbehavior.
66+
* Operator registration/deregistration does not have any sort of consequences for the Operator or its shares. Eventually, this will tie into rewards for services and slashing for misbehavior.
6767

6868
#### `cancelSalt`
6969

0 commit comments

Comments
 (0)