Add slashing of rewards

Author: gretzke

docs/autogen/src/src/UVN/L1/StakingMiddleware.sol/contract.StakingMiddleware.md

@@ -1,8 +1,8 @@
 # StakingMiddleware
-[Git Source](https://github.com/Uniswap/unichain-contracts/blob/24150a287633bc355fa0bd43e8e420b312a5ca02/src/UVN/L1/StakingMiddleware.sol)
+[Git Source](https://github.com/Uniswap/unichain-contracts/blob/b65aa4f5b827097e05d9ccfdf4601e76462b77b0/src/UVN/L1/StakingMiddleware.sol)
 
 **Inherits:**
-[ProtocolRewardDistributor](/src/UVN/L1/StakingMiddleware/ProtocolRewardDistributor.sol/abstract.ProtocolRewardDistributor.md), [SlashingManager](/src/UVN/L1/StakingMiddleware/SlashingManager.sol/abstract.SlashingManager.md), [IStakingMiddleware](/src/interfaces/UVN/L1/IStakingMiddleware.sol/interface.IStakingMiddleware.md)
+[SlashingManager](/src/UVN/L1/StakingMiddleware/SlashingManager.sol/abstract.SlashingManager.md), [IStakingMiddleware](/src/interfaces/UVN/L1/IStakingMiddleware.sol/interface.IStakingMiddleware.md)
 
 
 ## State Variables
@@ -22,8 +22,11 @@ constructor(
     address initialAdmin,
     IUniStaker unistaker_,
     uint256 withdrawalDelay_,
+    address slashingBeneficiary_,
     IDelegationManager delegationManager_
-) UniStakerWrapper(unistaker_) StakingMiddlewareParams(initialAdmin, withdrawalDelay_, delegationManager_);
+)
+    UniStakerWrapper(unistaker_)
+    StakingMiddlewareParams(initialAdmin, withdrawalDelay_, slashingBeneficiary_, delegationManager_);
 ```
 
 ### updateGovernanceDelegatee
@@ -68,3 +71,10 @@ function withdrawFromUniStaker() external;
 function alterGovernanceDelegatee(address newGovernanceDelegatee) external;
 ```
 
+### deselectOperator
+
+
+```solidity
+function deselectOperator() public override;
+```
+

docs/autogen/src/src/UVN/L1/StakingMiddleware/ProtocolRewardDistributor.sol/abstract.ProtocolRewardDistributor.md

@@ -1,5 +1,5 @@
 # ProtocolRewardDistributor
-[Git Source](https://github.com/Uniswap/unichain-contracts/blob/dbd11eeb90f59abe0099dfbb1022b6093132bf21/src/UVN/L1/StakingMiddleware/ProtocolRewardDistributor.sol)
+[Git Source](https://github.com/Uniswap/unichain-contracts/blob/b65aa4f5b827097e05d9ccfdf4601e76462b77b0/src/UVN/L1/StakingMiddleware/ProtocolRewardDistributor.sol)
 
 **Inherits:**
 [UniStakerWrapper](/src/UVN/L1/StakingMiddleware/UniStakerWrapper.sol/contract.UniStakerWrapper.md), [IProtocolRewardDistributor](/src/interfaces/UVN/L1/StakingMiddleware/IProtocolRewardDistributor.sol/interface.IProtocolRewardDistributor.md)
@@ -16,21 +16,21 @@ uint256 private constant PRECISION = 1e27;
 ### _globalRewardCheckpoint
 
 ```solidity
-uint256 private _globalRewardCheckpoint;
+uint256 internal _globalRewardCheckpoint;
 ```
 
 
 ### _rewardCheckpointOf
 
 ```solidity
-mapping(address account => uint256 checkpoint) private _rewardCheckpointOf;
+mapping(address account => uint256 checkpoint) internal _rewardCheckpointOf;
 ```
 
 
 ### _earnedRewardsOf
 
 ```solidity
-mapping(address account => uint256 earnedRewards) private _earnedRewardsOf;
+mapping(address account => uint256 earnedRewards) internal _earnedRewardsOf;
 ```
 
 
@@ -39,21 +39,21 @@ mapping(address account => uint256 earnedRewards) private _earnedRewardsOf;
 
 
 ```solidity
-function withdrawRewards(address to) external returns (uint256 reward);
+function withdrawRewards(address to) public virtual returns (uint256 reward);
 ```
 
 ### rewardsOf
 
 
 ```solidity
-function rewardsOf(address account) public view returns (uint256);
+function rewardsOf(address account) public view virtual returns (uint256);
 ```
 
-### _updateRewardIndex
+### _updateGlobalRewardCheckpoint
 
 
 ```solidity
-function _updateRewardIndex() internal;
+function _updateGlobalRewardCheckpoint() internal returns (uint256 newGlobalRewardCheckpoint);
 ```
 
 ### _updateRewardCheckpoint
@@ -63,10 +63,24 @@ function _updateRewardIndex() internal;
 function _updateRewardCheckpoint(address account) internal;
 ```
 
-### _calculateRewardSinceLastCheckpoint
+### _getNewGlobalRewardCheckpoint
 
 
 ```solidity
-function _calculateRewardSinceLastCheckpoint(address account) internal view returns (uint256);
+function _getNewGlobalRewardCheckpoint(uint256 reward) internal view returns (uint256);
+```
+
+### _calculateRewardUntil
+
+
+```solidity
+function _calculateRewardUntil(address account, uint256 checkpoint) internal view returns (uint256);
+```
+
+### _calculateRewardFromTo
+
+
+```solidity
+function _calculateRewardFromTo(uint256 balance, uint256 from, uint256 to) internal pure returns (uint256);
 ```
 

docs/autogen/src/src/UVN/L1/StakingMiddleware/SlashingManager.sol/abstract.SlashingManager.md

@@ -1,8 +1,8 @@
 # SlashingManager
-[Git Source](https://github.com/Uniswap/unichain-contracts/blob/24150a287633bc355fa0bd43e8e420b312a5ca02/src/UVN/L1/StakingMiddleware/SlashingManager.sol)
+[Git Source](https://github.com/Uniswap/unichain-contracts/blob/b65aa4f5b827097e05d9ccfdf4601e76462b77b0/src/UVN/L1/StakingMiddleware/SlashingManager.sol)
 
 **Inherits:**
-[OperatorManager](/src/UVN/L1/StakingMiddleware/OperatorManager.sol/abstract.OperatorManager.md)
+[ProtocolRewardDistributor](/src/UVN/L1/StakingMiddleware/ProtocolRewardDistributor.sol/abstract.ProtocolRewardDistributor.md), [OperatorManager](/src/UVN/L1/StakingMiddleware/OperatorManager.sol/abstract.OperatorManager.md)
 
 
 ## State Variables
@@ -39,7 +39,14 @@ function selectOperator(address operator) public override;
 
 
 ```solidity
-function deselectOperator() public override;
+function deselectOperator() public virtual override;
+```
+
+### withdrawRewards
+
+
+```solidity
+function withdrawRewards(address to) public override returns (uint256 reward);
 ```
 
 ### slashAmount
@@ -77,6 +84,13 @@ function isDelegatorSlashed(address delegator) external view returns (bool);
 function delegatorStake(address delegator) public view override returns (uint96);
 ```
 
+### rewardsOf
+
+
+```solidity
+function rewardsOf(address delegator) public view override returns (uint256);
+```
+
 ### _slash
 
 
@@ -86,12 +100,16 @@ function _slash(address operator, uint96 remainingPercentage) internal;
 
 ### _calculateSlashing
 
+*iterates over slashing occurrences by the operator a delegator has selected. For every slashing instance, it calculates the new stake based on the total percentage of the total delegated stake slashed.*
+
+*In case a delegator has deposited their tokens into UniStaker, to ensure they do not accrue rewards for slashed stake, rewards are also adjusted by the slashed amount. As the slashed stake remains in the UniStaker contract until slashing is applied, the slashed stake is treated as a deposit by the slashing beneficiary, meaning the slashing beneficiary accrues the rewards for the slashed stake instead of the delegator until slashing is applied and the underlying stake is withdrawn.*
+
 
 ```solidity
-function _calculateSlashing(address delegator, uint256 n)
+function _calculateSlashing(address delegator, uint256 n, uint256 globalCheckpoint)
     internal
     view
-    returns (uint96 newStake, bytes32 delegatorHead);
+    returns (uint96 newStake, bytes32 delegatorHead, uint256 newRewards, uint256 slashedRewards, uint256 newCheckpoint);
 ```
 
 ### _isDelegatorSlashed
@@ -114,6 +132,8 @@ function SLASHER_ROLE() public view returns (bytes32);
 ```solidity
 struct SlashingInstance {
     uint96 remainingPercentage;
+    uint40 timestamp;
+    uint256 rewardCheckpoint;
     bytes32 next;
 }
 ```

docs/autogen/src/src/UVN/L1/StakingMiddleware/StakingMiddlewareParams.sol/contract.StakingMiddlewareParams.md

@@ -1,5 +1,5 @@
 # StakingMiddlewareParams
-[Git Source](https://github.com/Uniswap/unichain-contracts/blob/6b285bfe59012065422d5d75fc08ddb0d2404ce9/src/UVN/L1/StakingMiddleware/StakingMiddlewareParams.sol)
+[Git Source](https://github.com/Uniswap/unichain-contracts/blob/b65aa4f5b827097e05d9ccfdf4601e76462b77b0/src/UVN/L1/StakingMiddleware/StakingMiddlewareParams.sol)
 
 **Inherits:**
 [IStakingMiddlewareParams](/src/interfaces/UVN/L1/StakingMiddleware/IStakingMiddlewareParams.sol/interface.IStakingMiddlewareParams.md), AccessControl
@@ -20,10 +20,17 @@ uint256 private _withdrawalDelay;
 ```
 
 
+### _slashingBeneficiary
+
+```solidity
+address private _slashingBeneficiary;
+```
+
+
 ### _delegationManager
 
 ```solidity
-IDelegationManager private _delegationManager;
+IDelegationManager private immutable _delegationManager;
 ```
 
 
@@ -32,7 +39,12 @@ IDelegationManager private _delegationManager;
 
 
 ```solidity
-constructor(address initialAdmin, uint256 withdrawalDelay_, IDelegationManager delegationManager_);
+constructor(
+    address initialAdmin,
+    uint256 withdrawalDelay_,
+    address slashingBeneficiary_,
+    IDelegationManager delegationManager_
+);
 ```
 
 ### withdrawalDelay
@@ -42,6 +54,13 @@ constructor(address initialAdmin, uint256 withdrawalDelay_, IDelegationManager d
 function withdrawalDelay() public view returns (uint256);
 ```
 
+### slashingBeneficiary
+
+
+```solidity
+function slashingBeneficiary() public view returns (address);
+```
+
 ### delegationManager
 
 
@@ -56,11 +75,11 @@ function delegationManager() public view returns (IDelegationManager);
 function updateWithdrawalDelay(uint256 withdrawalDelay_) external onlyRole(PARAMS_SETTER_ROLE);
 ```
 
-### updateDelegationManager
+### updateSlashingBeneficiary
 
 
 ```solidity
-function updateDelegationManager(IDelegationManager delegationManager_) external onlyRole(PARAMS_SETTER_ROLE);
+function updateSlashingBeneficiary(address slashingBeneficiary_) external onlyRole(PARAMS_SETTER_ROLE);
 ```
 
 ### _setWithdrawalDelay
@@ -70,10 +89,10 @@ function updateDelegationManager(IDelegationManager delegationManager_) external
 function _setWithdrawalDelay(uint256 withdrawalDelay_) internal;
 ```
 
-### _updateDelegationManager
+### _setSlashingBeneficiary
 
 
 ```solidity
-function _updateDelegationManager(IDelegationManager delegationManager_) internal;
+function _setSlashingBeneficiary(address slashingBeneficiary_) internal;
 ```
 

docs/autogen/src/src/UVN/L1/StakingMiddleware/UniStakerWrapper.sol/contract.UniStakerWrapper.md

@@ -1,5 +1,5 @@
 # UniStakerWrapper
-[Git Source](https://github.com/Uniswap/unichain-contracts/blob/6b285bfe59012065422d5d75fc08ddb0d2404ce9/src/UVN/L1/StakingMiddleware/UniStakerWrapper.sol)
+[Git Source](https://github.com/Uniswap/unichain-contracts/blob/b65aa4f5b827097e05d9ccfdf4601e76462b77b0/src/UVN/L1/StakingMiddleware/UniStakerWrapper.sol)
 
 
 ## State Variables
@@ -53,6 +53,13 @@ function _depositIntoUniStaker(uint96 amount, address delegatee) internal return
 function _withdrawFromUniStaker(uint96 amount) internal;
 ```
 
+### _withdrawFromUniStaker
+
+
+```solidity
+function _withdrawFromUniStaker(address delegator, uint96 amount) internal;
+```
+
 ### _stakedBalanceOf
 
 
@@ -64,7 +71,7 @@ function _stakedBalanceOf(address delegator) internal view returns (uint96);
 
 
 ```solidity
-function _totalAmountStaked() internal view returns (uint256);
+function _totalAmountStaked() internal view returns (uint96);
 ```
 
 ### _isDepositedIntoUniStaker

docs/autogen/src/src/interfaces/UVN/L1/StakingMiddleware/IStakingMiddlewareParams.sol/interface.IStakingMiddlewareParams.md

@@ -1,5 +1,5 @@
 # IStakingMiddlewareParams
-[Git Source](https://github.com/Uniswap/unichain-contracts/blob/5b98eecce12fe90fe24abd37da1a3642b02cfbd3/src/interfaces/UVN/L1/StakingMiddleware/IStakingMiddlewareParams.sol)
+[Git Source](https://github.com/Uniswap/unichain-contracts/blob/b65aa4f5b827097e05d9ccfdf4601e76462b77b0/src/interfaces/UVN/L1/StakingMiddleware/IStakingMiddlewareParams.sol)
 
 
 ## Functions
@@ -18,6 +18,21 @@ function updateWithdrawalDelay(uint256 withdrawalDelay) external;
 |`withdrawalDelay`|`uint256`|The new withdrawal delay in seconds|
 
 
+### updateSlashingBeneficiary
+
+Updates the slashing beneficiary that receives slashed stake and rewards
+
+
+```solidity
+function updateSlashingBeneficiary(address slashingBeneficiary) external;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`slashingBeneficiary`|`address`|The new slashing beneficiary|
+
+
 ### withdrawalDelay
 
 The delay before a user can withdraw their stake or change their operator
@@ -33,6 +48,21 @@ function withdrawalDelay() external view returns (uint256);
 |`<none>`|`uint256`|The withdrawal delay in seconds|
 
 
+### slashingBeneficiary
+
+The slashing beneficiary that receives slashed stake and rewards
+
+
+```solidity
+function slashingBeneficiary() external view returns (address);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|The slashing beneficiary|
+
+
 ### PARAMS_SETTER_ROLE
 
 The role that can set parameters
@@ -49,3 +79,9 @@ function PARAMS_SETTER_ROLE() external view returns (bytes32);
 event WithdrawalDelayUpdated(uint256 oldWithdrawalDelay, uint256 newWithdrawalDelay);
 ```
 
+### SlashingBeneficiaryUpdated
+
+```solidity
+event SlashingBeneficiaryUpdated(address oldSlashingBeneficiary, address newSlashingBeneficiary);
+```
+