Skip to content

Commit fbfd00c

Browse files
chore: CrossChainRegistry clarifications (#1553)
**Motivation:** `CrossChainRegistry` had an outdated natspec comment regarding the `owner` **Modifications:** Update natspec comment Use "an authorized caller" instead of UAM **Result:** Correct docs --------- Co-authored-by: Nadir Akhtar <[email protected]>
1 parent cc81736 commit fbfd00c

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

docs/multichain/source/CrossChainRegistry.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ The `CrossChainRegistry` manages the registration/deregistration of operatorSets
2121
```solidity
2222
/**
2323
* @notice A per-operatorSet configuration struct that is transported from the CrossChainRegistry on L1.
24-
* @param owner the permissioned owner of the OperatorSet on L2 that can call the CertificateVerifier specific setters
24+
* @param owner the permissioned owner of the OperatorSet on L2 that can be used by downstream contracts to authorize actions
2525
* @param maxStalenessPeriod the maximum staleness period of the operatorSet
26-
*
26+
*
2727
* @dev A staleness period of 0 allows for certificates to be verified against any timestamp in the past
2828
* @dev Staleness periods should not be greater than 0 and less than the update cadence of the `OperatorTables`, since
29-
* certificates would be unable to be validated against. The update cadence is communicated off-chain
29+
* certificates would be unable to be validated against. The update cadence is set by the owner of the CrossChainRegistry
3030
*/
3131
struct OperatorSetConfig {
3232
address owner;
@@ -38,7 +38,7 @@ struct OperatorSetConfig {
3838
* `SupportedChains` (via `getSupportedChains`) are `Mainnet` and `Base`
3939
* These are chains to which tables can be transported to
4040
* On Testnet, the supported chains are `Sepolia` and `Base-Sepolia`
41-
* `TableUpdateCadence` is the frequency at which tables are *expected* to be transported to destination chains
41+
* `TableUpdateCadence` is the frequency at which tables are *expected* to be transported to destination chains. 1 day on testnet. Weekly on mainnet
4242
* When setting an operator set config, the `maxStalenessPeriod` must be either:
4343
* 0 (special case allowing certificates to always be valid)
4444
* Greater than or equal to the table update cadence
@@ -57,7 +57,7 @@ A generation reservation registers the operatorSet to be included in the `Global
5757
* @param operatorSet the operatorSet to make a reservation for
5858
* @param operatorTableCalculator the address of the operatorTableCalculator
5959
* @param config the config to set for the operatorSet
60-
* @dev msg.sender must be UAM permissioned for operatorSet.avs
60+
* @dev msg.sender must be an authorized caller for operatorSet.avs
6161
*/
6262
function createGenerationReservation(
6363
OperatorSet calldata operatorSet,
@@ -80,7 +80,7 @@ Note that the `operatorTableCalculator` must be deployed by the AVS onto the sou
8080

8181
*Requirements*:
8282
* The global paused status MUST NOT be set: `PAUSED_GENERATION_RESERVATIONS`
83-
* Caller MUST be UAM permissioned for `operatorSet.avs`
83+
* Caller MUST be an authorized caller for `operatorSet.avs`
8484
* The `operatorSet` MUST exist in the `AllocationManager`
8585
* A generation reservation MUST NOT already exist for the `operatorSet`
8686

@@ -90,7 +90,7 @@ Note that the `operatorTableCalculator` must be deployed by the AVS onto the sou
9090
/**
9191
* @notice Removes a generation reservation for a given operatorSet
9292
* @param operatorSet the operatorSet to remove
93-
* @dev msg.sender must be UAM permissioned for operatorSet.avs
93+
* @dev msg.sender must be an authorized caller for operatorSet.avs
9494
*/
9595
function removeGenerationReservation(
9696
OperatorSet calldata operatorSet
@@ -109,7 +109,7 @@ Removes a generation reservation for a given `operatorSet` and clears all associ
109109

110110
*Requirements*:
111111
* The global paused status MUST NOT be set: `PAUSED_GENERATION_RESERVATIONS`
112-
* Caller MUST be UAM permissioned for `operatorSet.avs`
112+
* Caller MUST be an authorized caller for `operatorSet.avs`
113113
* The `operatorSet` MUST exist in the `AllocationManager`
114114
* A generation reservation MUST exist for the `operatorSet`
115115

@@ -125,7 +125,7 @@ For a given operatorSet, an AVS can set the [`OperatorTableCalculator`](./Operat
125125
* @notice Sets the operatorTableCalculator for the operatorSet
126126
* @param operatorSet the operatorSet whose operatorTableCalculator is desired to be set
127127
* @param operatorTableCalculator the contract to call to calculate the operator table
128-
* @dev msg.sender must be UAM permissioned for operatorSet.avs
128+
* @dev msg.sender must be an authorized caller for operatorSet.avs
129129
* @dev operatorSet must have an active reservation
130130
*/
131131
function setOperatorTableCalculator(
@@ -146,7 +146,7 @@ For more information on the `operatorTableCalculator`, please see full documenta
146146

147147
*Requirements*:
148148
* The global paused status MUST NOT be set: `PAUSED_OPERATOR_TABLE_CALCULATOR`
149-
* Caller MUST be UAM permissioned for `operatorSet.avs`
149+
* Caller MUST be an authorized caller for `operatorSet.avs`
150150
* The `operatorSet` MUST exist in the `AllocationManager`
151151
* A generation reservation MUST exist for the `operatorSet`
152152

@@ -157,7 +157,7 @@ For more information on the `operatorTableCalculator`, please see full documenta
157157
* @notice Sets the operatorSetConfig for a given operatorSet
158158
* @param operatorSet the operatorSet to set the operatorSetConfig for
159159
* @param config the config to set
160-
* @dev msg.sender must be UAM permissioned for operatorSet.avs
160+
* @dev msg.sender must be an authorized caller for operatorSet.avs
161161
* @dev operatorSet must have an active generation reservation
162162
* @dev The max staleness period is NOT checkpointed and is applied globally regardless of the reference timestamp of a certificate
163163
*/
@@ -177,7 +177,7 @@ Updates the operator set configuration for a given `operatorSet`. The config con
177177

178178
*Requirements*:
179179
* The global paused status MUST NOT be set: `PAUSED_OPERATOR_SET_CONFIG`
180-
* Caller MUST be UAM permissioned for `operatorSet.avs`
180+
* Caller MUST be an authorized caller for `operatorSet.avs`
181181
* The `operatorSet` MUST exist in the `AllocationManager`
182182
* A generation reservation MUST exist for the `operatorSet`
183183
* The `maxStalenessPeriod` MUST be either:

src/contracts/interfaces/ICrossChainRegistry.sol

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ interface ICrossChainRegistryErrors {
3939
interface ICrossChainRegistryTypes {
4040
/**
4141
* @notice A per-operatorSet configuration struct that is transported from the CrossChainRegistry on L1.
42-
* @param owner the permissioned owner of the OperatorSet on L2 that can call the CertificateVerifier specific setters
42+
* @param owner the permissioned owner of the OperatorSet on L2 that can be used by downstream contracts to authorize actions
4343
* @param maxStalenessPeriod the maximum staleness period of the operatorSet
4444
*
4545
* @dev A staleness period of 0 allows for certificates to be verified against any timestamp in the past
4646
* @dev Staleness periods should not be greater than 0 and less than the update cadence of the `OperatorTables`, since
47-
* certificates would be unable to be validated against. The update cadence is communicated off-chain
47+
* certificates would be unable to be validated against. The update cadence is set by the owner of the CrossChainRegistry
4848
*/
4949
struct OperatorSetConfig {
5050
address owner;
@@ -87,7 +87,7 @@ interface ICrossChainRegistry is ICrossChainRegistryErrors, ICrossChainRegistryE
8787
* @param operatorSet the operatorSet to make a reservation for
8888
* @param operatorTableCalculator the address of the operatorTableCalculator
8989
* @param config the config to set for the operatorSet
90-
* @dev msg.sender must be UAM permissioned for operatorSet.avs
90+
* @dev msg.sender must be an authorized caller for operatorSet.avs
9191
* @dev Once a generation reservation is created, the operator table will be transported to all chains that are whitelisted
9292
*/
9393
function createGenerationReservation(
@@ -99,7 +99,7 @@ interface ICrossChainRegistry is ICrossChainRegistryErrors, ICrossChainRegistryE
9999
/**
100100
* @notice Removes a generation reservation for a given operatorSet
101101
* @param operatorSet the operatorSet to remove
102-
* @dev msg.sender must be UAM permissioned for operatorSet.avs
102+
* @dev msg.sender must be an authorized caller for operatorSet.avs
103103
*/
104104
function removeGenerationReservation(
105105
OperatorSet calldata operatorSet
@@ -109,7 +109,7 @@ interface ICrossChainRegistry is ICrossChainRegistryErrors, ICrossChainRegistryE
109109
* @notice Sets the operatorTableCalculator for the operatorSet
110110
* @param operatorSet the operatorSet whose operatorTableCalculator is desired to be set
111111
* @param operatorTableCalculator the contract to call to calculate the operator table
112-
* @dev msg.sender must be UAM permissioned for operatorSet.avs
112+
* @dev msg.sender must be an authorized caller for operatorSet.avs
113113
* @dev operatorSet must have an active reservation
114114
*/
115115
function setOperatorTableCalculator(
@@ -121,7 +121,7 @@ interface ICrossChainRegistry is ICrossChainRegistryErrors, ICrossChainRegistryE
121121
* @notice Sets the operatorSetConfig for a given operatorSet
122122
* @param operatorSet the operatorSet to set the operatorSetConfig for
123123
* @param config the config to set
124-
* @dev msg.sender must be UAM permissioned for operatorSet.avs
124+
* @dev msg.sender must be an authorized caller for operatorSet.avs
125125
* @dev operatorSet must have an active generation reservation
126126
* @dev The max staleness period is NOT checkpointed and is applied globally regardless of the reference timestamp of a certificate
127127
*/

0 commit comments

Comments
 (0)