Update Security FAQ on Fault Proof and redefine Fault Proof contracts

[Red-Pandaz]

Description

This PR pertains to the documentation on Fault Proofs. The FAQ in pages/stack/security/faq.mdx has been updated to reflect the release of Fault Proofs. Additionally, the Fault Proof contracts detailed in pages/stack/smart-contracts.mdx have been rewritten to improve clarity on what they do and how they interact with one another.

Contract descriptions altered:

• DisputeGameFactory
• FaultDisputeGame
• PermissionedDisputeGame
• AnchorStateRegistry
• DelayedWETH
• MIPS
• PreimageOracle

Tests

No new tests were added as this change is purely documentation.

Additional context

This update to the FAQ and the definition of Fault Proof contracts ensures that the documentation accurately reflects the release of Fault Proofs. The revised definition clarifies the purpose and interactions of Fault Proof contracts, making it easier for developers and users to understand how they function within the OP Stack.

[netlify]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	adfb0d3
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/678d485bef66890008749a51
😎 Deploy Preview	https://deploy-preview-1265--docs-optimism.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces significant updates to the OP Stack documentation, focusing on two key files: pages/stack/security/faq.mdx and pages/stack/smart-contracts.mdx. The changes primarily revolve around Fault Proofs, marking their official addition to the OP Stack on June 10, 2024, and activation on OP Mainnet. The documentation has been revised to reflect this milestone, providing more detailed and current information about the smart contracts involved in dispute resolution. The updates enhance the clarity of how various contracts like DisputeGameFactory, FaultDisputeGame, PermissionedDisputeGame, and others interact and function within the OP Stack ecosystem.

Sequence Diagram

sequenceDiagram
    participant User
    participant DisputeGameFactory
    participant FaultDisputeGame
    participant AnchorStateRegistry
    participant PreimageOracle

    User->>DisputeGameFactory: Request dispute game
    DisputeGameFactory->>FaultDisputeGame: Deploy dispute game
    FaultDisputeGame->>AnchorStateRegistry: Store anchor state
    FaultDisputeGame->>PreimageOracle: Retrieve pre-images
    FaultDisputeGame->>User: Resolve dispute

Loading

Possibly related issues

• [DOCS] Update FAQ #842: Directly related to updating the FAQ about Fault Proofs, which aligns with the changes in this PR

Possibly related PRs

• fp updates #732: Updates to the FAQ regarding Fault Proofs
• Update smart-contracts.mdx to fix typo in change log #1017: Enhancements to smart contracts documentation
• Suggested Docs fixes #1251: Updates to Fault Proofs behavior documentation

Suggested labels

flag:merge-pending-release

Suggested reviewers

• sbvegan
• cpengilly

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cea50e4 and adfb0d3.

📒 Files selected for processing (2)

• pages/stack/security/faq.mdx (1 hunks)
• pages/stack/smart-contracts.mdx (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

pages/stack/security/faq.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. Avoid using all caps, italics, or bold for emphasis.
• Ensure proper nouns are capitalized in sentences.
• Apply the Oxford comma.
• Use proper title case for 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).
• For H1, H2, and H3 headers:
  1. Use sentence case, capitalizing only the first word.
  2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
  3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
• Flag any headers that seem to inconsistently apply these rules for manual review.
• When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
  "

pages/stack/smart-contracts.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. Avoid using all caps, italics, or bold for emphasis.
• Ensure proper nouns are capitalized in sentences.
• Apply the Oxford comma.
• Use proper title case for 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).
• For H1, H2, and H3 headers:
  1. Use sentence case, capitalizing only the first word.
  2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
  3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
• Flag any headers that seem to inconsistently apply these rules for manual review.
• When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
  "

🪛 LanguageTool

pages/stack/security/faq.mdx

[inconsistency] ~35-~35: A new year has begun. Did you mean “June 10, 2025”?
Context: ...## Can I use fault proofs? Yes! On June 10, 2024, Fault Proofs were officially added to ...

(DATE_NEW_YEAR)

🔇 Additional comments (8)

pages/stack/security/faq.mdx (1)

35-35: ⚠️ Potential issue

Verify the date of Fault Proofs activation.

The date "June 10, 2024" appears to be incorrect as it's in the future relative to the current date (January 2025). Please verify and update the correct date of Fault Proofs activation.

🧰 Tools

🪛 LanguageTool

[inconsistency] ~35-~35: A new year has begun. Did you mean “June 10, 2025”?
Context: ...## Can I use fault proofs? Yes! On June 10, 2024, Fault Proofs were officially added to ...

(DATE_NEW_YEAR)

pages/stack/smart-contracts.mdx (7)

363-367: LGTM! Clear and comprehensive description.

The description effectively explains the DisputeGameFactory's role and its integration with other contracts.

---

371-376: LGTM! Well-structured explanation.

The description provides a clear understanding of the FaultDisputeGame's functionality and its relationships with other contracts.

---

380-383: LGTM! Clear explanation of inheritance and restrictions.

The description effectively communicates the PermissionedDisputeGame's relationship with FaultDisputeGame and its role-based access controls.

---

387-389: LGTM! Concise explanation of anchor states.

The description clearly explains the purpose and importance of anchor states in the dispute resolution process.

---

393-395: LGTM! Clear explanation of bond management.

The description effectively communicates the DelayedWETH's role in managing dispute bonds and ensuring secure finalization.

---

399-406: LGTM! Comprehensive explanation of the virtual machine.

The description provides a thorough understanding of the MIPS contract's implementation and its integration with other components.

---

410-413: LGTM! Clear explanation of pre-image mapping.

The description effectively communicates the PreimageOracle's role in secure data retrieval and validation.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.