Skip to content

Commit 2e53e2f

Browse files
authored
docs: Clarify AVS Meaning for AllocationManager and Effect of invoking updateAVSMetadataURI (#1259)
**Motivation:** Per Slack DM with @ypatil12 we wish to further clarify what an "AVS" means for an AllocationManager. And per Yash: setting its updateAVSMetadataURI .. doing this "enshrines" the AVS address in the core protocol. In UAM-terminology, it is the "account" of the AVS **Modifications:** Added documentation language to more clearly specify both "What an AVS means for ALM" and what is the purpose of invoking updateAVSMetadataURI function. **Result:** Our core contract docs will be more clear for the user.
2 parents 816e66f + 5e59805 commit 2e53e2f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/core/AllocationManager.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ Libraries and Mixins:
2222

2323
## Overview
2424

25-
The `AllocationManager` manages AVS metadata registration, registration and deregistration of operators to operator sets, handles allocation and slashing of operators' slashable stake, and is the entry point an AVS uses to slash an operator. The `AllocationManager's` responsibilities are broken down into the following concepts:
25+
The `AllocationManager` manages AVS metadata registration, registration and deregistration of operators to operator sets, handles allocation and slashing of operators' slashable stake, and is the entry point an AVS uses to slash an operator. An AVS in the context of `AllocationManager` is defined as the `address` of the contract that implements [ServiceManagerBase](https://github.com/Layr-Labs/eigenlayer-middleware/blob/mainnet/docs/ServiceManagerBase.md). For `PermissionController` purposes, this AVS address is also the AVS [account](https://github.com/Layr-Labs/eigenlayer-contracts/blob/dev/docs/permissions/PermissionController.md#accounts).
26+
27+
28+
29+
The `AllocationManager's` responsibilities are broken down into the following concepts:
2630

2731
* [AVS Metadata](#avs-metadata)
2832
* [Operator Sets](#operator-sets)
@@ -68,6 +72,8 @@ function updateAVSMetadataURI(
6872

6973
_Note: this method can be called directly by an AVS, or by a caller authorized by the AVS. See [`PermissionController.md`](../permissions/PermissionController.md) for details._
7074

75+
Invoking this function effectively "enshrines" the AVS address in the core protocol.
76+
7177
Below is the format AVSs should use when updating their metadata URI initially. This is not validated onchain.
7278

7379
```json

0 commit comments

Comments
 (0)