Skip to content

Commit 350fa09

Browse files
committed
Improve IAVSRegistrar references in AllocationManager docs
1 parent 74b876a commit 350fa09

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

docs/core/AllocationManager.md

+29-6
Original file line numberDiff line numberDiff line change
@@ -366,10 +366,16 @@ This method makes an external call to the `IAVSRegistrar.registerOperator` metho
366366
* for one or more operator sets. This method should revert if registration
367367
* is unsuccessful.
368368
* @param operator the registering operator
369+
* @param avs the AVS the operator is registering for. This should be the same as IAVSRegistrar.avs()
369370
* @param operatorSetIds the list of operator set ids being registered for
370371
* @param data arbitrary data the operator can provide as part of registration
371-
*/
372-
function registerOperator(address operator, uint32[] calldata operatorSetIds, bytes calldata data) external;
372+
*/
373+
function registerOperator(
374+
address operator,
375+
address avs,
376+
uint32[] calldata operatorSetIds,
377+
bytes calldata data
378+
) external;
373379
```
374380

375381
*Effects*:
@@ -431,9 +437,10 @@ This method makes an external call to the `IAVSRegistrar.deregisterOperator` met
431437
* @notice Called by the AllocationManager when an operator is deregistered from
432438
* one or more operator sets. If this method reverts, it is ignored.
433439
* @param operator the deregistering operator
440+
* @param avs the AVS the operator is deregistering from. This should be the same as IAVSRegistrar.avs()
434441
* @param operatorSetIds the list of operator set ids being deregistered from
435-
*/
436-
function deregisterOperator(address operator, uint32[] calldata operatorSetIds) external;
442+
*/
443+
function deregisterOperator(address operator, address avs, uint32[] calldata operatorSetIds) external;
437444
```
438445

439446
*Effects*:
@@ -853,18 +860,34 @@ interface IAVSRegistrar {
853860
* for one or more operator sets. This method should revert if registration
854861
* is unsuccessful.
855862
* @param operator the registering operator
863+
* @param avs the AVS the operator is registering for. This should be the same as IAVSRegistrar.avs()
856864
* @param operatorSetIds the list of operator set ids being registered for
857865
* @param data arbitrary data the operator can provide as part of registration
858866
*/
859-
function registerOperator(address operator, uint32[] calldata operatorSetIds, bytes calldata data) external;
867+
function registerOperator(
868+
address operator,
869+
address avs,
870+
uint32[] calldata operatorSetIds,
871+
bytes calldata data
872+
) external;
860873
861874
/**
862875
* @notice Called by the AllocationManager when an operator is deregistered from
863876
* one or more operator sets. If this method reverts, it is ignored.
864877
* @param operator the deregistering operator
878+
* @param avs the AVS the operator is deregistering from. This should be the same as IAVSRegistrar.avs()
865879
* @param operatorSetIds the list of operator set ids being deregistered from
866880
*/
867-
function deregisterOperator(address operator, uint32[] calldata operatorSetIds) external;
881+
function deregisterOperator(address operator, address avs, uint32[] calldata operatorSetIds) external;
882+
883+
/**
884+
* @notice Returns true if the AVS is supported by the registrar
885+
* @param avs the AVS to check
886+
* @return true if the AVS is supported, false otherwise
887+
*/
888+
function supportsAVS(
889+
address avs
890+
) external view returns (bool);
868891
}
869892
```
870893

0 commit comments

Comments
 (0)