Skip to content

Commit

Permalink
chore: rename to rewards everywhere (#565)
Browse files Browse the repository at this point in the history
* chore: rename to rewards

* chore: fix remaining file names

* chore: remove old doc

* fix: try pushing bindings

* fix: deploy scripts
  • Loading branch information
8sunyuan authored May 28, 2024
1 parent 4866d42 commit e8ba06f
Show file tree
Hide file tree
Showing 54 changed files with 9,927 additions and 9,916 deletions.
16 changes: 8 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document provides an overview of system components, contracts, and user rol
* [`EigenPodManager`](#eigenpodmanager)
* [`StrategyManager`](#strategymanager)
* [`DelegationManager`](#delegationmanager)
* [`PaymentCoordinator`](#paymentcoordinator)
* [`RewardsCoordinator`](#rewardscoordinator)
* [`AVSDirectory`](#avsdirectory)
* [`Slasher`](#slasher)
* [Roles and Actors](#roles-and-actors)
Expand Down Expand Up @@ -67,18 +67,18 @@ The `DelegationManager` sits between the `EigenPodManager` and `StrategyManager`

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

#### PaymentCoordinator
#### RewardsCoordinator

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

The `PaymentCoordinator` is the main entry point of submission and claiming of ERC20 payments in EigenLayer. It carries out three basic functions:
* AVSs (via the AVS's contracts) submit "range payments" to their registered Operators and Stakers over a specific time period
* *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.
* Stakers/Operators can claim payments posted by the payment updater.
The `RewardsCoordinator` is the main entry point of submission and claiming of ERC20 rewards in EigenLayer. It carries out three basic functions:
* AVSs (via the AVS's contracts) submit "rewards submissions" to their registered Operators and Stakers over a specific time period
* *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.
* Stakers/Operators can claim rewards posted by the rewards updater.

See full documentation in [`/core/PaymentCoordinator.md`](./core/PaymentCoordinator.md).
See full documentation in [`/core/RewardsCoordinator.md`](./core/RewardsCoordinator.md).

#### AVSDirectory

Expand Down
6 changes: 3 additions & 3 deletions docs/core/AVSDirectory.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Currently, the only interactions between AVSs and the core contracts is to track
* [`AVSDirectory.registerOperatorToAVS`](#registeroperatortoavs)
* [`AVSDirectory.deregisterOperatorFromAVS`](#deregisteroperatorfromavs)

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.
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.

---

Expand All @@ -41,7 +41,7 @@ Allows the caller (an AVS) to register an `operator` with itself, given the prov
* `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.

*As of M2*:
* 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.
* 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.

#### `deregisterOperatorFromAVS`

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

*As of M2*:
* 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.
* 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.

#### `cancelSalt`

Expand Down
Loading

0 comments on commit e8ba06f

Please sign in to comment.