Merge branch 'mike/slashing-invariants' into slashing-integration-tests

.github/workflows/certora-prover.yml

@@ -32,7 +32,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
       - name: Install forge dependencies
         run: forge install
       - name: Install python

.github/workflows/coverage.yml

@@ -50,7 +50,7 @@ jobs:
     - name: Install Foundry
       uses: foundry-rs/foundry-toolchain@v1
       with:
-        version: nightly
+        version: stable
     - name: Run coverage
       run: forge coverage --report lcov
       env:

.github/workflows/deploy-local.yml

@@ -30,7 +30,7 @@ jobs:
     - name: Install Foundry
       uses: foundry-rs/foundry-toolchain@v1
       with:
-        version: nightly
+        version: stable
     - name: Run forge install
       run: forge install
     - name: Start anvil and deploy

.github/workflows/format.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
       - name: Run forge fmt
         run: |
           forge fmt --check src/contracts

.github/workflows/storage-report.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - name: "Generate and prepare the storage reports for current branch"
         run: |

.github/workflows/testinparallel.yml

@@ -34,7 +34,7 @@ jobs:
     - name: Install Foundry
       uses: foundry-rs/foundry-toolchain@v1
       with:
-        version: nightly
+        version: stable
 
     - name: Run Forge build
       run: |

Makefile

@@ -45,4 +45,4 @@ gha-docker:
 	docker run -v $(PWD):/build -w /build --rm -i ${CONTAINER_NAME}:latest bash -c "make gha"
 
 storage-report:
-	bash "bin/storage-report.sh" "docs/storage-report/"
+	bash "bin/storage-report.sh" "docs/storage-report/"

docs/README.md

@@ -16,6 +16,7 @@ This document provides an overview of system components, contracts, and user rol
     * [`RewardsCoordinator`](#rewardscoordinator)
     * [`AVSDirectory`](#avsdirectory)
     * [`AllocationManager`](#allocationmanager)
+    * [`PermissionController`](#permissioncontroller)
 * [Roles and Actors](#roles-and-actors)
 * [Common User Flows](#common-user-flows)
     * [Depositing Into EigenLayer](#depositing-into-eigenlayer)
@@ -64,10 +65,13 @@ See full documentation in [`/core/StrategyManager.md`](./core/StrategyManager.md
 | -------- | -------- | -------- |
 | [`DelegationManager.sol`](../src/contracts/core/DelegationManager.sol) | Singleton | Transparent proxy |
 
-The `DelegationManager` sits between the `EigenPodManager` and `StrategyManager` to manage delegation and undelegation of Stakers to Operators. Its primary features are to allow Operators to register as Operators (`registerAsOperator`), to keep track of delegated shares to Operators across different strategies, and to manage withdrawals on behalf of the `EigenPodManager` and `StrategyManager`.
-The `DelegationManager` is tightly coupled with the `AllocationManager` as withdrawable shares for a Staker is dependent on reading state from the `AllocationManager`. That is, a staker's withdrawable shares is decreased in the event their delegated Operator was slashed by an AVS (more specifically an operatorSet but more on this later).
+The `DelegationManager` sits between the `EigenPodManager` and `StrategyManager` to manage delegation and undelegation of stakers to operators. Its primary features are to allow users to become operators, to keep track of delegated shares to operators across different strategies, and to manage withdrawals on behalf of stakers via the `EigenPodManager` and `StrategyManager`.
 
-See full documentation in [`/core/DelegationManager.md`](./core/DelegationManager.md).
+The `DelegationManager` is tightly coupled with the `AllocationManager`. The `DelegationManager` ingests information about slashing as part of managing share accounting for stakers whose operators have been slashed. It also receives directives to slash/burn operator shares when an AVS slashes an operator.
+
+See:
+* full documentation in [`/core/DelegationManager.md`](./core/DelegationManager.md)
+* share accounting documentation in [`/core/accounting/SharesAccounting.md`](./core/accounting/SharesAccounting.md)
 
 #### RewardsCoordinator
 
@@ -76,9 +80,9 @@ See full documentation in [`/core/DelegationManager.md`](./core/DelegationManage
 | [`RewardsCoordinator.sol`](../src/contracts/core/RewardsCoordinator.sol) | Singleton | Transparent proxy |
 
 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.
+* 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/RewardsCoordinator.md`](./core/RewardsCoordinator.md).
 
@@ -88,9 +92,9 @@ See full documentation in [`/core/RewardsCoordinator.md`](./core/RewardsCoordina
 | -------- | -------- | -------- |
 | [`AVSDirectory.sol`](../src/contracts/core/AVSDirectory.sol) | Singleton | Transparent proxy |
 
-##### Note: This contract is left unchanged for backwards compatability. Operator<>AVS Registrations are to be replaced entirely with the `AllocationManager` and this contract will be deprecated(no longer indexed) in a future release.
+##### Note: This contract is left unchanged for backwards compatability. Operator<>AVS Registrations are to be replaced entirely with the `AllocationManager` and this contract will be deprecated in a future release.
 
-The `AVSDirectory` handles interactions between AVSs and the EigenLayer core contracts. Once registered as an Operator in EigenLayer core (via the `DelegationManager`), Operators can register with one or more AVSs (via the AVS's contracts) to begin providing services to them offchain. As a part of registering with an AVS, the AVS will record this registration in the core contracts by calling into the `AVSDirectory`. 
+Previously, the `AVSDirectory` handled interactions between AVSs and the EigenLayer core contracts. Once registered as an operator in EigenLayer core (via the `DelegationManager`), operators could register with one or more AVSs (via the AVS's contracts) to begin providing services to them offchain. As a part of registering with an AVS, the AVS would record this registration in the core contracts by calling into the `AVSDirectory`. As of the slashing release, this process is now managed by the [`AllocationManager`](#allocationmanager).
 
 See full documentation in [`/core/AVSDirectory.md`](./core/AVSDirectory.md).
 
@@ -102,19 +106,28 @@ For more information on AVS contracts, see the [middleware repo][middleware-repo
 | -------- | -------- | -------- |
 | [`AllocationManager.sol`](../src/contracts/core/AllocationManager.sol) | Singleton | Transparent proxy |
 
-The `AllocationManager` is meant to replace the AVSDirectory with the introduction of OperatorSets as well as introduce the core functionality of Slashing. It handles several use cases:
-* AVSs can create OperatorSets and can define the EigenLayer Strategies within them
-* Operators can register/deregister with AVS operatorSets
-* Operators can make slashable security commitments to an operatorSet by allocating a proportion of their total delegated stake for a Strategy to be slashable. Ex. As an operator, I can allocate 50% of my stETH to be slashable by a specific OperatorSet
-* AVSs can slash an operator (without being objectively attributable) who has slashable allocations to the AVS's corresponding OperatorSet.
+The `AllocationManager` is replaces the AVSDirectory with the introduction of _operator sets_ and slashing. It handles several use cases:
+* AVSs can create operator sets and can define the EigenLayer Strategies within them
+* Operators can register to or deregister from an AVS's operator sets
+* Operators can make slashable security commitments to an operator set by allocating a proportion of their total delegated stake for a Strategy to be slashable. Ex. As an operator, I can allocate 50% of my delegated stETH to be slashable by a specific operator set
+* AVSs can slash an operator who has allocated to and is registered for one of the AVS's operator sets
 
 See full documentation in [`/core/AllocationManager.md`](./core/AllocationManager.md).
 
----
+#### PermissionController
+
+| File | Type | Proxy |
+| -------- | -------- | -------- |
+| [`PermissionController.sol`](../src/contracts/permissions/PermissionController.sol) | Singleton | Transparent proxy |
+
+The `PermissionController` allows AVSs and operators to delegate the ability to call certain core contract functions to other addresses. This delegation ability is not available to stakers, and is not available in ALL core contract functions.
 
-#### Shares Accounting
+The following core contracts use the `PermissionController` in certain methods:
+* `DelegationManager`
+* `AllocationManager`
+* `RewardsCoordinator`
 
-TODO
+See full documentation in [`/permissions/PermissionController.md`](./permissions/PermissionController.md).
 
 ---
 
@@ -124,39 +137,33 @@ To see an example of the user flows described in this section, check out our int
 
 ##### Staker
 
-A Staker is any party who has assets deposited (or "restaked") into EigenLayer. Currently, these assets can be:
+A staker is any party who has assets deposited (or "restaked") into EigenLayer. Currently, these assets can be:
 * Native beacon chain ETH (via the EigenPodManager)
-* Liquid staking tokens (via the StrategyManager): cbETH, rETH, stETH, ankrETH, OETH, osETH, swETH, wBETH
+* Arbitrary ERC20s (via the StrategyManager)
 
-Stakers can restake any combination of these: a Staker may hold ALL of these assets, or only one of them.
+Stakers can restake any combination of these: a staker may hold ALL of these assets, or only one of them.
 
 *Flows:*
-* Stakers **deposit** assets into EigenLayer via either the StrategyManager (for LSTs) or EigenPodManager (for beacon chain ETH)
+* Stakers **deposit** assets into EigenLayer via either the StrategyManager (for ERC20s) or the EigenPodManager (for beacon chain ETH)
 * Stakers **withdraw** assets via the DelegationManager, *no matter what assets they're withdrawing*
-* Stakers **delegate** to an Operator via the DelegationManager
-
-*Unimplemented as of v0.4.0:*
-* Stakers are at risk of being slashed if the Operator misbehaves
+* Stakers **delegate** to an operator via the DelegationManager
 
 ##### Operator
 
-An Operator is a user who helps run the software built on top of EigenLayer (AVSs). Operators register in EigenLayer and allow Stakers to delegate to them, then opt in to provide various services built on top of EigenLayer. Operators may themselves be Stakers; these are not mutually exclusive.
+An operator is a user who helps run the software built on top of EigenLayer (AVSs). operators register in EigenLayer and allow stakers to delegate to them, then opt in to provide various services built on top of EigenLayer. operators may themselves be stakers; these are not mutually exclusive.
 
 *Flows:*
-* User can **register** as an Operator via the DelegationManager
-* Operators can **deposit** and **withdraw** assets just like Stakers can
+* Users can **register** as an operator via the DelegationManager
+* Operators can **deposit** and **withdraw** assets just like stakers can
 * Operators can opt in to providing services for an AVS using that AVS's middleware contracts. See the [EigenLayer middleware][middleware-repo] repo for more details.
 
-*Unimplemented as of v0.4.0:*
-* Operators may be slashed by the services they register with (if they misbehave)
-
 ---
 
 #### Common User Flows
 
 ##### Depositing Into EigenLayer
 
-Depositing into EigenLayer varies depending on whether the Staker is depositing Native ETH or LSTs:
+Depositing into EigenLayer varies depending on whether the staker is depositing Native ETH or LSTs:
 
 ![.](./images/Staker%20Flow%20Diagrams/Depositing.png)
 
@@ -166,13 +173,13 @@ Depositing into EigenLayer varies depending on whether the Staker is depositing
 
 ##### Undelegating or Queueing a Withdrawal
 
-Undelegating from an Operator automatically queues a withdrawal that needs to go through the `DelegationManager's` withdrawal delay. Stakers that want to withdraw can choose to `undelegate`, or can simply call `queueWithdrawals` directly.
+Undelegating from an operator automatically queues a withdrawal that needs to go through the `DelegationManager's` withdrawal delay. Stakers that want to withdraw can choose to `undelegate`, or can simply call `queueWithdrawals` directly.
 
 ![.](./images/Staker%20Flow%20Diagrams/Queue%20Withdrawal.png)
 
 ##### Completing a Withdrawal as Shares
 
-This flow is mostly useful if a Staker wants to change which Operator they are delegated to. The Staker first needs to undelegate (see above). At this point, they can delegate to a different Operator. However, the new Operator will only be awarded shares once the Staker completes their queued withdrawal "as shares":
+This flow is mostly useful if a staker wants to change which operator they are delegated to. The staker first needs to undelegate (see above). At this point, they can delegate to a different operator. However, the new operator will only be awarded shares once the staker completes their queued withdrawal "as shares":
 
 ![.](./images/Staker%20Flow%20Diagrams/Complete%20Withdrawal%20as%20Shares.png)
 
@@ -186,12 +193,12 @@ However, note that *before* a withdrawal can be completed, native ETH stakers wi
 
 ##### `EigenPods`: Processing Validator Exits
 
-If a Staker wants to fully withdraw from the beacon chain, they need to perform these additional steps before their withdrawal is completable:
+If a staker wants to fully withdraw from the beacon chain, they need to perform these additional steps before their withdrawal is completable:
 
 ![.](./images/Staker%20Flow%20Diagrams/Validator%20Exits.png)
 
 ##### `EigenPods`: Processing Validator Yield
 
-As the Staker's `EigenPod` accumulates consensus layer or execution layer yield, the `EigenPod's` balance will increase. The Staker can Checkpoint their validator to claim this yield as shares, which can either remain staked in EigenLayer or be withdrawn via the `DelegationManager` withdrawal queue:
+As the staker's `EigenPod` accumulates consensus layer or execution layer yield, the `EigenPod's` balance will increase. The staker can Checkpoint their validator to claim this yield as shares, which can either remain staked in EigenLayer or be withdrawn via the `DelegationManager` withdrawal queue:
 
 ![.](./images/Staker%20Flow%20Diagrams/Validator%20Yield.png)