Skip to content

docs(IAccessManager): document locked roles for label/admin/guardian/grantDelay #6041

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

Merged
merged 1 commit into from
Nov 3, 2025
Merged

docs(IAccessManager): document locked roles for label/admin/guardian/grantDelay #6041

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions contracts/access/manager/IAccessManager.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@ interface IAccessManager {
* Requirements:
*
* - the caller must be a global admin
* - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
*
* Emits a {RoleLabel} event.
*/
Expand Down Expand Up @@ -254,6 +255,10 @@ interface IAccessManager {
* Requirements:
*
* - the caller must be a global admin
* - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
*
* NOTE: Setting `admin` to the `PUBLIC_ROLE` is allowed, but the target `roleId` itself
* must not be a locked role (`ADMIN_ROLE` or `PUBLIC_ROLE`).
*
* Emits a {RoleAdminChanged} event
*/
Expand All @@ -265,6 +270,10 @@ interface IAccessManager {
* Requirements:
*
* - the caller must be a global admin
* - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
*
* NOTE: Setting `guardian` to the `PUBLIC_ROLE` is allowed, but the target `roleId` itself
* must not be a locked role (`ADMIN_ROLE` or `PUBLIC_ROLE`).
*
* Emits a {RoleGuardianChanged} event
*/
Expand All @@ -276,6 +285,7 @@ interface IAccessManager {
* Requirements:
*
* - the caller must be a global admin
* - `roleId` must not be the `PUBLIC_ROLE`
*
* Emits a {RoleGrantDelayChanged} event.
*/
Expand Down
Loading