docs icon indicating copy to clipboard operation
docs copied to clipboard

feat: update guardian capabilities for FPAC

Open smartcontracts opened this issue 1 year ago • 2 comments

Description PR updates the capabilities that the guardian will have with the proposed FPAC upgrade. Keeping as draft until we are ready to merge. Please note that this will only be merged if FPAC upgrade actually makes it to mainnet.

smartcontracts avatar Feb 08 '24 23:02 smartcontracts

Deploy Preview for docs-optimism ready!

Name Link
Latest commit f2e2d317cd61181720c0281453ccad2b5880fbf1
Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/66675ee0268ea5000863b564
Deploy Preview https://deploy-preview-477--docs-optimism.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 site configuration.

netlify[bot] avatar Feb 08 '24 23:02 netlify[bot]

LGTM, this blends so elegantly with builder's existing mental model about the privileged roles. thank you for the thoughtful changes @smartcontracts and @clabby !

zchn avatar Feb 09 '24 16:02 zchn

Walkthrough

The changes redefine roles and capabilities within the system. The L2 Proxy Admin is now linked to the L1 Proxy Admin. The Proposer role is now associated with creating PermissionedDisputeGame instances. The Guardian role gains more control over system contracts, and the Challenger role can now participate in PermissionedDisputeGame instances.

Changes

Files Change Summary
.../privileged-roles.mdx Redefined roles and capabilities: L2 Proxy Admin linked to L1 Proxy Admin, Proposer creates PermissionedDisputeGame instances, Guardian gains more control, and Challenger can participate in PermissionedDisputeGame.

Sequence Diagram(s)

sequenceDiagram
    participant Proposer
    participant PermissionedDisputeGame
    participant Challenger
    participant Guardian
    participant L1 Proxy Admin
    participant System Contracts

    Proposer->>PermissionedDisputeGame: Create instance
    Challenger->>PermissionedDisputeGame: Participate and challenge
    Guardian->>System Contracts: Pause contracts
    Guardian->>OptimismPortal: Manage security concerns
    L1 Proxy Admin->>L2 Proxy Admin: Control and manage

Recent review details

Configuration used: .coderabbit.yaml Review profile: CHILL

Commits

Files that changed from the base of the PR and between 222dc95f2f58dbd378ec12c9c93839a8a23725ea and f2e2d317cd61181720c0281453ccad2b5880fbf1.

Files selected for processing (1)
  • pages/chain/security/privileged-roles.mdx (4 hunks)
Additional context used
Path-based instructions (1)
pages/chain/security/privileged-roles.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Use bold for prominence instead of all caps or italics.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT). "
LanguageTool
pages/chain/security/privileged-roles.mdx

[style] ~21-~21: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) Context: ...H or tokens in the Standard Bridge. * Compromised L1 Proxy Admin could fail to mitigate a...


[uncategorized] ~39-~39: Possible missing article found. (AI_HYDRA_LEO_MISSING_A) Context: ...de contracts to malicious versions. * Compromised L2 Proxy Admin could remove or lock ETH...


[style] ~40-~40: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) Context: ...H or tokens in the Standard Bridge. * Compromised L2 Proxy Admin could fail to mitigate a...


[style] ~64-~64: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) Context: ...o-optimisms-security-council/6885). * System Config Owner can be replaced by the [L1...


[uncategorized] ~135-~135: Possible missing article found. (AI_HYDRA_LEO_MISSING_A) Context: ...d invalidate valid state proposals. * Compromised challenger could fail to challenge inva...


[uncategorized] ~181-~181: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE) Context: ...P tokens on OP Mainnet. ### Risks * Compromised Mint Manager Owner could mint arbitrary...


[uncategorized] ~182-~182: Possible missing article found. (AI_HYDRA_LEO_MISSING_A) Context: ...int arbitrary amounts of OP tokens. * Compromised Mint Manager Owner could prevent OP tok...

Additional comments not posted (4)
pages/chain/security/privileged-roles.mdx (4)

44-44: Clarify the control mechanism for the L2 Proxy Admin.


97-104: Update the description of the Proposer's capabilities.


126-130: Enhance clarity in the description of the Challenger's role.


151-159: Simplify language for better readability.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 10 '24 19:06 coderabbitai[bot]