Skip to content

docs: Update IAVSRegistar in docs/core/AllocationManager.md #1305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Update IAVSRegistar in docs/core/AllocationManager.md #1305

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
350fa09
Improve `IAVSRegistrar` references in `AllocationManager` docs
HudsonGraeme Apr 17, 2025
3afbe5f
Merge branch 'main' into main
HudsonGraeme Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 29 additions & 6 deletions docs/core/AllocationManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,10 +366,16 @@ This method makes an external call to the `IAVSRegistrar.registerOperator` metho
* for one or more operator sets. This method should revert if registration
* is unsuccessful.
* @param operator the registering operator
* @param avs the AVS the operator is registering for. This should be the same as IAVSRegistrar.avs()
* @param operatorSetIds the list of operator set ids being registered for
* @param data arbitrary data the operator can provide as part of registration
*/
function registerOperator(address operator, uint32[] calldata operatorSetIds, bytes calldata data) external;
*/
function registerOperator(
address operator,
address avs,
uint32[] calldata operatorSetIds,
bytes calldata data
) external;
```

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

*Effects*:
Expand Down Expand Up @@ -853,18 +860,34 @@ interface IAVSRegistrar {
* for one or more operator sets. This method should revert if registration
* is unsuccessful.
* @param operator the registering operator
* @param avs the AVS the operator is registering for. This should be the same as IAVSRegistrar.avs()
* @param operatorSetIds the list of operator set ids being registered for
* @param data arbitrary data the operator can provide as part of registration
*/
function registerOperator(address operator, uint32[] calldata operatorSetIds, bytes calldata data) external;
function registerOperator(
address operator,
address avs,
uint32[] calldata operatorSetIds,
bytes calldata data
) external;

/**
* @notice Called by the AllocationManager when an operator is deregistered from
* one or more operator sets. If this method reverts, it is ignored.
* @param operator the deregistering operator
* @param avs the AVS the operator is deregistering from. This should be the same as IAVSRegistrar.avs()
* @param operatorSetIds the list of operator set ids being deregistered from
*/
function deregisterOperator(address operator, uint32[] calldata operatorSetIds) external;
function deregisterOperator(address operator, address avs, uint32[] calldata operatorSetIds) external;

/**
* @notice Returns true if the AVS is supported by the registrar
* @param avs the AVS to check
* @return true if the AVS is supported, false otherwise
*/
function supportsAVS(
address avs
) external view returns (bool);
}
```

Expand Down