Skip to content

Commit a37c5c6

Browse files
committed
fix(I5): natspec (#516)
**Motivation:** Update incorrect natspec **Modifications:** - Clarify `KeyRegistrar` usage - Clarify `calculateOperatorTable` usage **Result:** Clearer natspec
1 parent 1fad209 commit a37c5c6

File tree

3 files changed

+4
-5
lines changed

3 files changed

+4
-5
lines changed

src/interfaces/IBN254TableCalculator.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ interface IBN254TableCalculator is IOperatorTableCalculator, IOperatorTableCalcu
1212
* @notice calculates the operatorInfos for a given operatorSet
1313
* @param operatorSet the operatorSet to calculate the operator table for
1414
* @return operatorSetInfo the operatorSetInfo for the given operatorSet
15-
* @dev The output of this function is converted to bytes via the `calculateOperatorTableBytes` function
15+
* @dev The output of this function is used by the multichain protocol to transport operator stake weights to destination chains
1616
*/
1717
function calculateOperatorTable(
1818
OperatorSet calldata operatorSet

src/interfaces/IECDSATableCalculator.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ interface IECDSATableCalculator is IOperatorTableCalculator, IOperatorTableCalcu
1212
* @notice calculates the operatorInfos for a given operatorSet
1313
* @param operatorSet the operatorSet to calculate the operator table for
1414
* @return operatorInfos the list of operatorInfos for the given operatorSet
15-
* @dev The output of this function is converted to bytes via the `calculateOperatorTableBytes` function
15+
* @dev The output of this function is used by the multichain protocol to transport operator stake weights to destination chains
1616
*/
1717
function calculateOperatorTable(
1818
OperatorSet calldata operatorSet

src/middlewareV2/registrar/AVSRegistrar.sol

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ contract AVSRegistrar is Initializable, AVSRegistrarStorage {
4141
) external virtual onlyAllocationManager {
4242
_beforeRegisterOperator(operator, operatorSetIds, data);
4343

44-
// Check that the operator has a valid key and update key if needed
44+
// Check that the operator has a valid key
4545
_validateOperatorKeys(operator, operatorSetIds);
4646

4747
_afterRegisterOperator(operator, operatorSetIds, data);
@@ -81,10 +81,9 @@ contract AVSRegistrar is Initializable, AVSRegistrarStorage {
8181
*/
8282

8383
/**
84-
* @notice Validates that the operator has registered a key for the given operator sets
84+
* @notice Validates that the operator has registered a key for the given operator sets in the `KeyRegistrar`
8585
* @param operator The operator to validate
8686
* @param operatorSetIds The operator sets to validate
87-
* @dev This function assumes the operator has already registered a key in the Key Registrar
8887
*/
8988
function _validateOperatorKeys(
9089
address operator,

0 commit comments

Comments
 (0)