Skip to content

Sui AccessControl docs#153

Open
ericnordelo wants to merge 10 commits into
OpenZeppelin:release/sui-v1.2from
ericnordelo:feat/sui-access-control-docs
Open

Sui AccessControl docs#153
ericnordelo wants to merge 10 commits into
OpenZeppelin:release/sui-v1.2from
ericnordelo:feat/sui-access-control-docs

Conversation

@ericnordelo
Copy link
Copy Markdown
Member

No description provided.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 4, 2026

Deploy Preview for openzeppelin-docs-v2 ready!

Name Link
🔨 Latest commit 2ddd897
🔍 Latest deploy log https://app.netlify.com/projects/openzeppelin-docs-v2/deploys/6a05e2fb126e760008e9e3df
😎 Deploy Preview https://deploy-preview-153--openzeppelin-docs-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@ericnordelo ericnordelo requested review from a team and stevep0z as code owners May 14, 2026 14:58
@ericnordelo ericnordelo changed the base branch from main to release/sui-v1.2 May 14, 2026 15:00

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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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;
Copy link
Copy Markdown

@0xNeshi 0xNeshi May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_*.

"children": [
{
"type": "page",
"name": "RBAC",
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. Role Based Access Control
  2. Role Based Access Control (RBAC) <- if the reader sees RBAC anywhere else, they now know what it stands for).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants