Skip to content

Commit ab76759

Browse files
0xClandestineypatil12
authored andcommitted
docs(redistribution-changes): cleanup (#1513)
**Motivation:** We want to address a few nits. **Modifications:** - slash's -> operator set's. **Result:** Nits addressed.
1 parent 2a592de commit ab76759

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/core/StrategyManager.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -320,12 +320,12 @@ function clearBurnOrRedistributableSharesByStrategy(
320320
) external returns (uint256);
321321
```
322322

323-
Anyone can call this method to transfer slashed shares to the slash's `redistributionRecipient`. This method sets the `burnOrRedistributableShares` for the given `slashId` and `operatorSet` to 0. To accommodate the unlimited number of strategies that can be added to an operatorSet, users can also pass in a strategy to clear via `clearBurnOrRedistributableSharesByStrategy`. The strategies that haven not been cleared can be retrieved by calling `getBurnOrRedistributableShares(operatorSet, slashId)`.
323+
Anyone can call this method to transfer slashed shares to the operator sets's `redistributionRecipient`. This method sets the `burnOrRedistributableShares` for the given `slashId` and `operatorSet` to 0. To accommodate the unlimited number of strategies that can be added to an operatorSet, users can also pass in a strategy to clear via `clearBurnOrRedistributableSharesByStrategy`. The strategies that haven not been cleared can be retrieved by calling `getBurnOrRedistributableShares(operatorSet, slashId)`.
324324

325325
*Effects*:
326326
* Resets the strategy's burn or redistributable shares for the operatorSet and slashId to 0
327327
* If the shares to remove are nonzero:
328-
* Calls `withdraw` on the `strategy`, withdrawing shares and sending a corresponding amount of tokens to the slash's `redistributionRecipient`
328+
* Calls `withdraw` on the `strategy`, withdrawing shares and sending a corresponding amount of tokens to the operator sets's `redistributionRecipient`
329329
* Emits a `BurnOrRedistributableSharesDecreased`
330330

331331
#### `burnShares`

src/contracts/core/AllocationManager.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ contract AllocationManager is
425425
IStrategy strategy,
426426
bool isRedistributing
427427
) internal {
428-
// We do not currently support redistributing beaconchain ETH.
428+
// We do not currently support redistributing beaconchain ETH or EIGEN.
429429
if (isRedistributing) {
430430
require(strategy != BEACONCHAIN_ETH_STRAT && strategy != eigenStrategy, InvalidStrategy());
431431
}

0 commit comments

Comments
 (0)