Merge pull request #24 from Layr-Labs/auto-doc-update

Auto doc update

Author: ChaoticWalrus

docs/Guaranteed-stake-updates.md

@@ -8,7 +8,7 @@ Below, a whitelisted contract refers to a contract that is a part of a middlewar
 
 For each operator, the Slasher contract stores:
 
-1. A `mapping(address => mapping(address => MiddlewareDetails))`, from operator address to contract whitelisted by the operator to slash them, to [details](https://github.com/Layr-Labs/eignlayr-contracts/blob/master/src/contracts/interfaces/ISlasher.sol) about that contract formatted as
+1. A `mapping(address => mapping(address => MiddlewareDetails))`, from operator address to contract whitelisted by the operator to slash them, to [details](../src/contracts/contracts/interfaces/ISlasher.sol) about that contract formatted as
 ```solidity
     struct MiddlewareDetails {
         // the UTC timestamp before which the contract is allowed to slash the user

docs/docgen/core/DelegationManager.md

@@ -20,6 +20,12 @@ uint8 PAUSED_NEW_DELEGATION
 bytes4 ERC1271_MAGICVALUE
 ```
 
+### ORIGINAL_CHAIN_ID
+
+```solidity
+uint256 ORIGINAL_CHAIN_ID
+```
+
 ### onlyStrategyManager
 
 ```solidity

docs/docgen/core/DelegationManagerStorage.md

@@ -58,30 +58,32 @@ The Slasher contract for EigenLayer
 mapping(address => mapping(contract IStrategy => uint256)) operatorShares
 ```
 
-returns the total number of shares in `strategy` that are delegated to `operator`.
+Mapping: operator => strategy => total number of shares in the strategy delegated to the operator
 
 ### delegationTerms
 
 ```solidity
 mapping(address => contract IDelegationTerms) delegationTerms
 ```
 
-returns the DelegationTerms of the `operator`, which may mediate their interactions with stakers who delegate to them.
+Mapping: operator => delegation terms contract
 
 ### delegatedTo
 
 ```solidity
 mapping(address => address) delegatedTo
 ```
 
-returns the address of the operator that `staker` is delegated to.
+Mapping: staker => operator whom the staker has delegated to
 
 ### nonces
 
 ```solidity
 mapping(address => uint256) nonces
 ```
 
+Mapping: delegator => number of signed delegation nonce (used in delegateToBySignature)
+
 ### constructor
 
 ```solidity

docs/docgen/core/Slasher.md

@@ -93,7 +93,7 @@ operator =>
 ### MiddlewareTimesAdded
 
 ```solidity
-event MiddlewareTimesAdded(address operator, uint256 index, uint32 stalestUpdateBlock, uint32 latestServeUntil)
+event MiddlewareTimesAdded(address operator, uint256 index, uint32 stalestUpdateBlock, uint32 latestServeUntilBlock)
 ```
 
 Emitted when a middleware times is added to `operator`'s array.
@@ -109,10 +109,10 @@ Emitted when `operator` begins to allow `contractAddress` to slash them.
 ### SlashingAbilityRevoked
 
 ```solidity
-event SlashingAbilityRevoked(address operator, address contractAddress, uint32 contractCanSlashOperatorUntil)
+event SlashingAbilityRevoked(address operator, address contractAddress, uint32 contractCanSlashOperatorUntilBlock)
 ```
 
-Emitted when `contractAddress` signals that it will no longer be able to slash `operator` after the UTC timestamp `contractCanSlashOperatorUntil`.
+Emitted when `contractAddress` signals that it will no longer be able to slash `operator` after the `contractCanSlashOperatorUntilBlock`.
 
 ### OperatorFrozen
 
@@ -192,11 +192,11 @@ _Callable only by the contract owner (i.e. governance)._
 ### recordFirstStakeUpdate
 
 ```solidity
-function recordFirstStakeUpdate(address operator, uint32 serveUntil) external
+function recordFirstStakeUpdate(address operator, uint32 serveUntilBlock) external
 ```
 
 this function is a called by middlewares during an operator's registration to make sure the operator's stake at registration 
-        is slashable until serveUntil
+        is slashable until serveUntilBlock
 
 _adds the middleware's slashing contract to the operator's linked list_
 
@@ -205,16 +205,16 @@ _adds the middleware's slashing contract to the operator's linked list_
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | operator | address | the operator whose stake update is being recorded |
-| serveUntil | uint32 | the timestamp until which the operator's stake at the current block is slashable |
+| serveUntilBlock | uint32 | the block until which the operator's stake at the current block is slashable |
 
 ### recordStakeUpdate
 
 ```solidity
-function recordStakeUpdate(address operator, uint32 updateBlock, uint32 serveUntil, uint256 insertAfter) external
+function recordStakeUpdate(address operator, uint32 updateBlock, uint32 serveUntilBlock, uint256 insertAfter) external
 ```
 
 this function is a called by middlewares during a stake update for an operator (perhaps to free pending withdrawals)
-        to make sure the operator's stake at updateBlock is slashable until serveUntil
+        to make sure the operator's stake at updateBlock is slashable until serveUntilBlock
 
 _insertAfter should be calculated offchain before making the transaction that calls this. this is subject to race conditions, 
      but it is anticipated to be rare and not detrimental._
@@ -225,35 +225,35 @@ _insertAfter should be calculated offchain before making the transaction that ca
 | ---- | ---- | ----------- |
 | operator | address | the operator whose stake update is being recorded |
 | updateBlock | uint32 | the block for which the stake update is being recorded |
-| serveUntil | uint32 | the timestamp until which the operator's stake at updateBlock is slashable |
+| serveUntilBlock | uint32 | the block until which the operator's stake at updateBlock is slashable |
 | insertAfter | uint256 | the element of the operators linked list that the currently updating middleware should be inserted after |
 
 ### recordLastStakeUpdateAndRevokeSlashingAbility
 
 ```solidity
-function recordLastStakeUpdateAndRevokeSlashingAbility(address operator, uint32 serveUntil) external
+function recordLastStakeUpdateAndRevokeSlashingAbility(address operator, uint32 serveUntilBlock) external
 ```
 
 this function is a called by middlewares during an operator's deregistration to make sure the operator's stake at deregistration 
-        is slashable until serveUntil
+        is slashable until serveUntilBlock
 
 _removes the middleware's slashing contract to the operator's linked list and revokes the middleware's (i.e. caller's) ability to
-slash `operator` once `serveUntil` is reached_
+slash `operator` once `serveUntilBlock` is reached_
 
 #### Parameters
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | operator | address | the operator whose stake update is being recorded |
-| serveUntil | uint32 | the timestamp until which the operator's stake at the current block is slashable |
+| serveUntilBlock | uint32 | the block until which the operator's stake at the current block is slashable |
 
-### contractCanSlashOperatorUntil
+### contractCanSlashOperatorUntilBlock
 
 ```solidity
-function contractCanSlashOperatorUntil(address operator, address serviceContract) external view returns (uint32)
+function contractCanSlashOperatorUntilBlock(address operator, address serviceContract) external view returns (uint32)
 ```
 
-Returns the UTC timestamp until which `serviceContract` is allowed to slash the `operator`.
+Returns the block until which `serviceContract` is allowed to slash the `operator`.
 
 ### latestUpdateBlock
 
@@ -339,13 +339,13 @@ function getMiddlewareTimesIndexBlock(address operator, uint32 index) external v
 
 Getter function for fetching `_operatorToMiddlewareTimes[operator][index].stalestUpdateBlock`.
 
-### getMiddlewareTimesIndexServeUntil
+### getMiddlewareTimesIndexServeUntilBlock
 
 ```solidity
-function getMiddlewareTimesIndexServeUntil(address operator, uint32 index) external view returns (uint32)
+function getMiddlewareTimesIndexServeUntilBlock(address operator, uint32 index) external view returns (uint32)
 ```
 
-Getter function for fetching `_operatorToMiddlewareTimes[operator][index].latestServeUntil`.
+Getter function for fetching `_operatorToMiddlewareTimes[operator][index].latestServeUntilBlock`.
 
 ### operatorWhitelistedContractsLinkedListSize
 
@@ -398,7 +398,7 @@ function _optIntoSlashing(address operator, address contractAddress) internal
 ### _revokeSlashingAbility
 
 ```solidity
-function _revokeSlashingAbility(address operator, address contractAddress, uint32 serveUntil) internal
+function _revokeSlashingAbility(address operator, address contractAddress, uint32 serveUntilBlock) internal
 ```
 
 ### _freezeOperator
@@ -416,7 +416,7 @@ function _resetFrozenStatus(address previouslySlashedAddress) internal
 ### _recordUpdateAndAddToMiddlewareTimes
 
 ```solidity
-function _recordUpdateAndAddToMiddlewareTimes(address operator, uint32 updateBlock, uint32 serveUntil) internal
+function _recordUpdateAndAddToMiddlewareTimes(address operator, uint32 updateBlock, uint32 serveUntilBlock) internal
 ```
 
 records the most recent updateBlock for the currently updating middleware and appends an entry to the operator's list of 
@@ -429,8 +429,8 @@ _this function is only called during externally called stake updates by middlewa
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | operator | address | the entity whose stake update is being recorded |
-| updateBlock | uint32 | the block number for which the currently updating middleware is updating the serveUntil for |
-| serveUntil | uint32 | the timestamp until which the operator's stake at updateBlock is slashable |
+| updateBlock | uint32 | the block number for which the currently updating middleware is updating the serveUntilBlock for |
+| serveUntilBlock | uint32 | the block until which the operator's stake at updateBlock is slashable |
 
 ### _updateMiddlewareList
 

docs/docgen/core/StrategyManager.md

@@ -28,6 +28,12 @@ uint8 PAUSED_DEPOSITS
 uint8 PAUSED_WITHDRAWALS
 ```
 
+### ORIGINAL_CHAIN_ID
+
+```solidity
+uint256 ORIGINAL_CHAIN_ID
+```
+
 ### ERC1271_MAGICVALUE
 
 ```solidity
@@ -89,7 +95,7 @@ Emitted when a new withdrawal is queued by `depositor`.
 ### WithdrawalCompleted
 
 ```solidity
-event WithdrawalCompleted(address depositor, address withdrawer, bytes32 withdrawalRoot)
+event WithdrawalCompleted(address depositor, uint96 nonce, address withdrawer, bytes32 withdrawalRoot)
 ```
 
 Emitted when a queued withdrawal is completed
@@ -144,12 +150,6 @@ modifier onlyFrozen(address staker)
 modifier onlyEigenPodManager()
 ```
 
-### onlyEigenPod
-
-```solidity
-modifier onlyEigenPod(address podOwner, address pod)
-```
-
 ### onlyStrategyWhitelister
 
 ```solidity
@@ -179,7 +179,7 @@ constructor(contract IDelegationManager _delegation, contract IEigenPodManager _
 ### initialize
 
 ```solidity
-function initialize(address initialOwner, contract IPauserRegistry _pauserRegistry, uint256 initialPausedStatus, uint256 _withdrawalDelayBlocks) external
+function initialize(address initialOwner, address initialStrategyWhitelister, contract IPauserRegistry _pauserRegistry, uint256 initialPausedStatus, uint256 _withdrawalDelayBlocks) external
 ```
 
 Initializes the strategy manager contract. Sets the `pauserRegistry` (currently **not** modifiable after being set),
@@ -190,6 +190,7 @@ and transfers contract ownership to the specified `initialOwner`.
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | initialOwner | address | Ownership of this contract is transferred to this address. |
+| initialStrategyWhitelister | address | The initial value of `strategyWhitelister` to set. |
 | _pauserRegistry | contract IPauserRegistry | Used for access control of pausing. |
 | initialPausedStatus | uint256 |  |
 | _withdrawalDelayBlocks | uint256 | The initial value of `withdrawalDelayBlocks` to set. |
@@ -238,7 +239,10 @@ function depositIntoStrategy(contract IStrategy strategy, contract IERC20 token,
 Deposits `amount` of `token` into the specified `strategy`, with the resultant shares credited to `depositor`
 
 _The `msg.sender` must have previously approved this contract to transfer at least `amount` of `token` on their behalf.
-Cannot be called by an address that is 'frozen' (this function will revert if the `msg.sender` is frozen)._
+Cannot be called by an address that is 'frozen' (this function will revert if the `msg.sender` is frozen).
+
+WARNING: Depositing tokens that allow reentrancy (eg. ERC-777) into a strategy is not recommended.  This can lead to attack vectors
+         where the token balance and corresponding strategy shares are not in syncupon reentrancy._
 
 #### Parameters
 
@@ -260,7 +264,10 @@ who must sign off on the action
 _The `msg.sender` must have previously approved this contract to transfer at least `amount` of `token` on their behalf.
 A signature is required for this function to eliminate the possibility of griefing attacks, specifically those
 targetting stakers who may be attempting to undelegate.
-Cannot be called on behalf of a staker that is 'frozen' (this function will revert if the `staker` is frozen)._
+Cannot be called on behalf of a staker that is 'frozen' (this function will revert if the `staker` is frozen).
+
+ WARNING: Depositing tokens that allow reentrancy (eg. ERC-777) into a strategy is not recommended.  This can lead to attack vectors
+         where the token balance and corresponding strategy shares are not in syncupon reentrancy_
 
 #### Parameters
 
@@ -334,6 +341,17 @@ _middlewareTimesIndex should be calculated off chain before calling this functio
 | middlewareTimesIndex | uint256 | is the index in the operator that the staker who triggered the withdrawal was delegated to's middleware times array |
 | receiveAsTokens | bool | If true, the shares specified in the queued withdrawal will be withdrawn from the specified strategies themselves and sent to the caller, through calls to `queuedWithdrawal.strategies[i].withdraw`. If false, then the shares in the specified strategies will simply be transferred to the caller directly. |
 
+### completeQueuedWithdrawals
+
+```solidity
+function completeQueuedWithdrawals(struct IStrategyManager.QueuedWithdrawal[] queuedWithdrawals, contract IERC20[][] tokens, uint256[] middlewareTimesIndexes, bool[] receiveAsTokens) external
+```
+
+Used to complete the specified `queuedWithdrawals`. The function caller must match `queuedWithdrawals[...].withdrawer`
+
+_Array-ified version of `completeQueuedWithdrawal`
+middlewareTimesIndex should be calculated off chain before calling this function by finding the first index that satisfies `slasher.canWithdraw`_
+
 ### slashShares
 
 ```solidity
@@ -456,6 +474,14 @@ Removes `strategy` from `depositor`'s dynamic array of strategies, i.e. from `st
 _the provided `strategyIndex` input is optimistically used to find the strategy quickly in the list. If the specified
 index is incorrect, then we revert to a brute-force search._
 
+### _completeQueuedWithdrawal
+
+```solidity
+function _completeQueuedWithdrawal(struct IStrategyManager.QueuedWithdrawal queuedWithdrawal, contract IERC20[] tokens, uint256 middlewareTimesIndex, bool receiveAsTokens) internal
+```
+
+Internal function for completeing the given `queuedWithdrawal`.
+
 ### _undelegate
 
 ```solidity

docs/docgen/core/StrategyManagerStorage.md

@@ -151,7 +151,7 @@ constructor(contract IDelegationManager _delegation, contract IEigenPodManager _
 ### __gap
 
 ```solidity
-uint256[41] __gap
+uint256[40] __gap
 ```
 
 _This empty reserved space is put in place to allow future versions to add new

docs/docgen/interfaces/IBLSRegistry.md

@@ -46,16 +46,16 @@ function apkUpdateBlockNumbers(uint256 index) external view returns (uint32)
 
 returns the block number at which the `index`th APK update occurred
 
-### whitelister
+### operatorWhitelister
 
 ```solidity
-function whitelister() external view returns (address)
+function operatorWhitelister() external view returns (address)
 ```
 
-### whitelistEnabled
+### operatorWhitelistEnabled
 
 ```solidity
-function whitelistEnabled() external view returns (bool)
+function operatorWhitelistEnabled() external view returns (bool)
 ```
 
 ### whitelisted
@@ -64,10 +64,10 @@ function whitelistEnabled() external view returns (bool)
 function whitelisted(address) external view returns (bool)
 ```
 
-### setWhitelistStatus
+### setOperatorWhitelistStatus
 
 ```solidity
-function setWhitelistStatus(bool _whitelistEnabled) external
+function setOperatorWhitelistStatus(bool _operatorWhitelistEnabled) external
 ```
 
 ### addToOperatorWhitelist

docs/docgen/interfaces/IBeaconChainOracle.md

@@ -18,7 +18,7 @@ function beaconStateRootAtBlockNumber(uint64 blockNumber) external view returns
 
 Mapping: Beacon Chain blockNumber => the Beacon Chain state root at the specified blockNumber.
 
-_This will return `bytes32(0)` if the state root is not yet finalized at the blockNumber._
+_This will return `bytes32(0)` if the state root at the specified blockNumber is not yet confirmed._
 
 ### isOracleSigner
 

docs/docgen/interfaces/IDelayedWithdrawalRouter.md

@@ -75,6 +75,14 @@ function userWithdrawals(address user) external view returns (struct IDelayedWit
 
 Getter function for the mapping `_userWithdrawals`
 
+### claimableUserDelayedWithdrawals
+
+```solidity
+function claimableUserDelayedWithdrawals(address user) external view returns (struct IDelayedWithdrawalRouter.DelayedWithdrawal[])
+```
+
+Getter function to get all delayedWithdrawals that are currently claimable by the `user`
+
 ### userDelayedWithdrawalByIndex
 
 ```solidity

docs/docgen/interfaces/IEigenPod.md

@@ -129,6 +129,14 @@ function hasRestaked() external view returns (bool)
 
 an indicator of whether or not the podOwner has ever "fully restaked" by successfully calling `verifyCorrectWithdrawalCredentials`.
 
+### mostRecentWithdrawalBlockNumber
+
+```solidity
+function mostRecentWithdrawalBlockNumber() external view returns (uint64)
+```
+
+block number of the most recent withdrawal
+
 ### provenPartialWithdrawal
 
 ```solidity