Sui AccessControl docs#153
Open
ericnordelo wants to merge 10 commits into
Open
Conversation
✅ Deploy Preview for openzeppelin-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
0xNeshi
reviewed
May 14, 2026
|
|
||
| The caller is responsible for sharing, embedding, or otherwise positioning the returned `AccessControl<RootRole>` registry. | ||
|
|
||
| The expected call site is the consumer module's `init`, which only runs on the package's first publish. To adopt AccessControl from an already-published protocol, publish a new package that initializes its own registry. |
There was a problem hiding this comment.
Suggested change
| The expected call site is the consumer module's `init`, which only runs on the package's first publish. To adopt AccessControl from an already-published protocol, publish a new package that initializes its own registry. | |
| The expected call site is the consumer module's `init`, which only runs on the package's first publish. To adopt `AccessControl` from an already-published protocol, publish a new package that initializes its own registry. |
| public struct PauserRole {} | ||
| public struct OperatorRole {} | ||
|
|
||
| const DEFAULT_ADMIN_DELAY_MS: u64 = 24 * 60 * 60 * 1_000; |
There was a problem hiding this comment.
I think we should consistently use either default admin or root role, both in code and in docs. Having both can cause confusion. I lean towards root role, as it's more consistent with the role-based contract.
E.g. see this line:
Use the delayed root-role flows (`begin_default_admin_*`,...
Root role type has related functions like begin_default_admin_*. The functions should be aligned to begin_root_role_*.
0xNeshi
reviewed
May 15, 2026
| "children": [ | ||
| { | ||
| "type": "page", | ||
| "name": "RBAC", |
There was a problem hiding this comment.
This name and the Learn > Role Based Access Control name should be aligned, i.e. both names should be the same to avoid confusion.
I think the best name candidates are:
Role Based Access ControlRole Based Access Control (RBAC)<- if the reader sees RBAC anywhere else, they now know what it stands for).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.