Skip to content

Commit 74703ae

Browse files
authored
docs(IAccessManager): document locked roles for label/admin/guardian/grantDelay (#6041)
1 parent 9c0046f commit 74703ae

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

contracts/access/manager/IAccessManager.sol

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ interface IAccessManager {
196196
* Requirements:
197197
*
198198
* - the caller must be a global admin
199+
* - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
199200
*
200201
* Emits a {RoleLabel} event.
201202
*/
@@ -254,6 +255,10 @@ interface IAccessManager {
254255
* Requirements:
255256
*
256257
* - the caller must be a global admin
258+
* - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
259+
*
260+
* NOTE: Setting `admin` to the `PUBLIC_ROLE` is allowed, but the target `roleId` itself
261+
* must not be a locked role (`ADMIN_ROLE` or `PUBLIC_ROLE`).
257262
*
258263
* Emits a {RoleAdminChanged} event
259264
*/
@@ -265,6 +270,10 @@ interface IAccessManager {
265270
* Requirements:
266271
*
267272
* - the caller must be a global admin
273+
* - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
274+
*
275+
* NOTE: Setting `guardian` to the `PUBLIC_ROLE` is allowed, but the target `roleId` itself
276+
* must not be a locked role (`ADMIN_ROLE` or `PUBLIC_ROLE`).
268277
*
269278
* Emits a {RoleGuardianChanged} event
270279
*/
@@ -276,6 +285,7 @@ interface IAccessManager {
276285
* Requirements:
277286
*
278287
* - the caller must be a global admin
288+
* - `roleId` must not be the `PUBLIC_ROLE`
279289
*
280290
* Emits a {RoleGrantDelayChanged} event.
281291
*/

0 commit comments

Comments
 (0)