Skip to content

Commit 40bba0e

Browse files
committed
chore: natspec updates
1 parent 206d1f0 commit 40bba0e

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

src/interfaces/ISocketRegistryV2.sol

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ interface ISocketRegistryV2 is ISocketRegistryErrors, ISocketRegistryEvents {
2929
* @param operator The operator to set the socket for.
3030
* @param socket The socket to set for the operator.
3131
* @dev This function can only be called by the operator themselves.
32+
* @dev Reverts for:
33+
* - CallerNotOperator: The caller is not the operator
3234
*/
3335
function updateSocket(address operator, string memory socket) external;
3436
}

src/middlewareV2/registrar/AVSRegistrar.sol

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ abstract contract AVSRegistrar is Initializable, AVSRegistrarStorage {
3939
}
4040

4141
/// @inheritdoc IAVSRegistrar
42+
/// @dev Reverts for:
43+
/// - NotAllocationManager: The caller is not the allocation manager
44+
/// - KeyNotRegistered: The operator has not registered a key for the given operator sets in the `KeyRegistrar`
4245
function registerOperator(
4346
address operator,
4447
address, /* avs */
@@ -56,6 +59,8 @@ abstract contract AVSRegistrar is Initializable, AVSRegistrarStorage {
5659
}
5760

5861
/// @inheritdoc IAVSRegistrar
62+
/// @dev Reverts for:
63+
/// - NotAllocationManager: The caller is not the allocation manager
5964
function deregisterOperator(
6065
address operator,
6166
address, /* avs */
@@ -85,6 +90,8 @@ abstract contract AVSRegistrar is Initializable, AVSRegistrarStorage {
8590
* @notice Validates that the operator has registered a key for the given operator sets in the `KeyRegistrar`
8691
* @param operator The operator to validate
8792
* @param operatorSetIds The operator sets to validate
93+
* @dev Reverts for:
94+
* - KeyNotRegistered: The operator has not registered a key for the given operator sets in the `KeyRegistrar`
8895
*/
8996
function _validateOperatorKeys(
9097
address operator,

src/middlewareV2/registrar/presets/AVSRegistrarWithAllowlist.sol

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ contract AVSRegistrarWithAllowlist is AVSRegistrar, Allowlist, IAVSRegistrarWith
2525
}
2626

2727
/// @notice Before registering operator, check if the operator is in the allowlist
28+
/// @dev Reverts for:
29+
/// - OperatorNotInAllowlist: The operator is not in the allowlist
2830
function _beforeRegisterOperator(
2931
address operator,
3032
uint32[] calldata operatorSetIds,

0 commit comments

Comments
 (0)