feat: new types everywhere (#782)

* feat(wip): new types everywhere * refactor: review reconciliations * refactor: review reconciliations * replace names --------- Co-authored-by: gpsanant <gpsanant@gmail.com>
Layr-Labs · Sep 25, 2024 · c2b8c8f · c2b8c8f
1 parent 0033658
commit c2b8c8f
Show file tree

Hide file tree

Showing 23 changed files with 341 additions and 287 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -20,7 +20,7 @@ This document provides an overview of system components, contracts, and user rol
     * [Depositing Into EigenLayer](#depositing-into-eigenlayer)
     * [Delegating to an Operator](#delegating-to-an-operator)
     * [Undelegating or Queueing a Withdrawal](#undelegating-or-queueing-a-withdrawal)
-    * [Completing a Withdrawal as WithdrawableShares](#completing-a-withdrawal-as-shares)
+    * [Completing a Withdrawal as OwnedShares](#completing-a-withdrawal-as-shares)
     * [Completing a Withdrawal as Tokens](#completing-a-withdrawal-as-tokens)
     * [Withdrawal Processing: Validator Exits](#withdrawal-processing-validator-exits)
     * [Withdrawal Processing: Partial Beacon Chain Withdrawals](#withdrawal-processing-partial-beacon-chain-withdrawals)
@@ -156,7 +156,7 @@ Undelegating from an Operator automatically queues a withdrawal that needs to go
 
 ![.](./images/Staker%20Flow%20Diagrams/Queue%20Withdrawal.png)
 
-##### Completing a Withdrawal as WithdrawableShares
+##### Completing a Withdrawal as OwnedShares
 
 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":
 

diff --git a/docs/core/DelegationManager.md b/docs/core/DelegationManager.md
@@ -275,9 +275,9 @@ For each strategy/share pair in the `Withdrawal`:
 
 `Withdrawals` concerning `EigenPodManager` shares have some additional nuance depending on whether a withdrawal is specified to be received as tokens vs shares (read more about "why" in [`EigenPodManager.md`](./EigenPodManager.md)):
 * `EigenPodManager` withdrawals received as shares: 
-    * WithdrawableShares ALWAYS go back to the originator of the withdrawal (rather than the `withdrawer` address). 
-    * WithdrawableShares are also delegated to the originator's Operator, rather than the `withdrawer's` Operator.
-    * WithdrawableShares received by the originator may be lower than the shares originally withdrawn if the originator has debt.
+    * OwnedShares ALWAYS go back to the originator of the withdrawal (rather than the `withdrawer` address). 
+    * OwnedShares are also delegated to the originator's Operator, rather than the `withdrawer's` Operator.
+    * OwnedShares received by the originator may be lower than the shares originally withdrawn if the originator has debt.
 * `EigenPodManager` withdrawals received as tokens:
     * Before the withdrawal can be completed, the originator needs to prove that a withdrawal occurred on the beacon chain (see [`EigenPod.verifyAndProcessWithdrawals`](./EigenPodManager.md#eigenpodverifyandprocesswithdrawals)).
 
@@ -288,10 +288,10 @@ For each strategy/share pair in the `Withdrawal`:
     * See [`EigenPodManager.withdrawSharesAsTokens`](./EigenPodManager.md#eigenpodmanagerwithdrawsharesastokens)
 * If `!receiveAsTokens`:
     * For `StrategyManager` strategies:
-        * WithdrawableShares are awarded to the `withdrawer` and delegated to the `withdrawer's` Operator
+        * OwnedShares are awarded to the `withdrawer` and delegated to the `withdrawer's` Operator
         * See [`StrategyManager.addShares`](./StrategyManager.md#addshares)
     * For the native beacon chain ETH strategy (`EigenPodManager`):
-        * WithdrawableShares are awarded to `withdrawal.staker`, and delegated to the Staker's Operator
+        * OwnedShares are awarded to `withdrawal.staker`, and delegated to the Staker's Operator
         * See [`EigenPodManager.addShares`](./EigenPodManager.md#eigenpodmanageraddshares)
 
 *Requirements*:

diff --git a/docs/core/EigenPod.md b/docs/core/EigenPod.md
@@ -150,7 +150,7 @@ Checkpoint proofs comprise the bulk of proofs submitted to an `EigenPod`. Comple
 * when the pod has accumulated fees / partial withdrawals from validators
 * whether any validators on the beacon chain have increased/decreased in balance
 
-When a checkpoint is completed, shares are updated accordingly for each of these events. WithdrawableShares can be withdrawn via the `DelegationManager` withdrawal queue (see [DelegationManager: Undelegating and Withdrawing](./DelegationManager.md#undelegating-and-withdrawing)), which means an `EigenPod's` checkpoint proofs also play an important role in allowing Pod Owners to exit funds from the system.
+When a checkpoint is completed, shares are updated accordingly for each of these events. OwnedShares can be withdrawn via the `DelegationManager` withdrawal queue (see [DelegationManager: Undelegating and Withdrawing](./DelegationManager.md#undelegating-and-withdrawing)), which means an `EigenPod's` checkpoint proofs also play an important role in allowing Pod Owners to exit funds from the system.
 
 _Important Notes:_
 * `EigenPods` can only have **one active checkpoint** at a given time, and once started, checkpoints **cannot be cancelled** (only completed)