Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Warning Rate limit exceeded@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 17 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (3)
📝 Walkthrough""" WalkthroughA new tutorial document titled "Deploying new dispute games with OPCM" has been added to the OP Stack documentation. This tutorial provides detailed instructions for chain operators and protocol developers on deploying permissionless dispute games using the OP Contracts Manager (OPCM). It covers prerequisites, explains the difference between permissioned and permissionless dispute games, and provides a step-by-step guide for using the Sequence Diagram(s)sequenceDiagram
participant Operator as Chain Operator
participant OPCM as OP Contracts Manager
participant DGF as DisputeGameFactory
participant Portal as OptimismPortal
Operator->>OPCM: Call addGameType(AddGameInput)
OPCM->>DGF: Register new dispute game type
DGF-->>OPCM: Confirm registration
Operator->>Portal: Update respectedGameType (post-deployment)
Portal-->>Operator: Acknowledge update
Possibly related PRs
Suggested labels
Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
pages/operators/chain-operators/tutorials/dispute-games.mdx (3)
57-57: Use imperative phrasing in step 1 heading
Change “1. Finding the correct OPCM instance” to “1. Find the correct OPCM instance” to follow the guideline of using the imperative form for instructions.
68-68: Align step 2 heading with sentence case and imperative style
Adjust “2. Preparing theaddGameTypeCall” to “2. Prepare theaddGameTypecall” (imperative verb + lowercase “call”).
146-147: Convert gerund to imperative in step 4 and standardize TODO formatting
- Rename “4. Setting the respected game type” to “4. Set the respected game type.”
- For inline TODOs (
[Todo: Update this once it goes live–...]) and the “## Todo: Update the next steps” header, either hyphenate to “To-do” or migrate these into<Callout>components for consistent visibility.Also applies to: 149-151
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/operators/chain-operators/tutorials/dispute-games.mdx(1 hunks)words.txt(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- 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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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/operators/chain-operators/tutorials/dispute-games.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/dispute-games.mdx
[grammar] ~149-~149: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...missionless fault proofs, refer to the [Todo: Update this once it goes live- Migrati...
(TO_DO_HYPHEN)
[grammar] ~151-~151: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...utorials/migrating-permissionless). ## Todo: Update the next steps
(TO_DO_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (3)
words.txt (2)
271-271: Addition ofopcmfor lowercase dictionary recognition
Addingopcmalongside the existingOPCMentry ensures that the lowercase term is recognized by spellcheckers. Placement under theOP*block maintains alphabetical order.
388-388: Addition ofstructsto support new terminology
Includingstructsafterstatefulsetcovers the new documentation’s references to data structures. The insertion preserves the file’s alphabetical ordering.pages/operators/chain-operators/tutorials/dispute-games.mdx (1)
1-17: Frontmatter completeness
The frontmatter contains all required fields (title,lang,description,topic,personas,categories,content_type) and adheres to metadata validation rules.
krofax
changed the title
sbvegan
left a comment
sbvegan
left a comment
There was a problem hiding this comment.
Looks good, I didn't test the code yet, but I left some comments to address
Co-authored-by: soyboy <85043086+sbvegan@users.noreply.github.com>
Co-authored-by: soyboy <85043086+sbvegan@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
pages/operators/chain-operators/tutorials/dispute-games.mdx (2)
23-23: Add internal link to OPCM reference
Consider linking “OPCM (OP Contracts Manager)” to the internal OP Contracts Manager reference page for faster navigation, as suggested previously.
40-44: Use internal link for challenger role documentation
Swap the external link to the OP Stack configurability spec with the internal privileged-roles doc for the challenger role, e.g.:/operators/chain-operators/privileged-roles#challenger.
🧹 Nitpick comments (3)
pages/operators/chain-operators/tutorials/dispute-games.mdx (3)
68-68: Header sentence case: lowercase “Call”
Per sentence-case rules, change:### 2. Preparing the `addGameType` Callto:
### 2. Preparing the `addGameType` call
102-103: Promote step 3 to an H3 for consistency
Convert the plain list item into an H3, matching steps 1 and 2:### 3. Execute the addGameType function
147-152: Fix “To-do” hyphenation & clean up placeholder
- Change “Todo” to “To-do” in both the link text and heading.
- Convert steps 3 and 4 into H3 headings for uniformity.
- Replace or remove the placeholder link once the migrating guide is published.
🧰 Tools
🪛 LanguageTool
[grammar] ~149-~149: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...missionless fault proofs, refer to the [Todo: Update this once it goes live- Migrati...(TO_DO_HYPHEN)
[grammar] ~151-~151: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...utorials/migrating-permissionless). ## Todo: Update the next steps(TO_DO_HYPHEN)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/tutorials/dispute-games.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- 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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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/operators/chain-operators/tutorials/dispute-games.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/dispute-games.mdx
[style] ~30-~30: You can shorten this phrase to avoid wordiness.
Context: ...op-contracts/v2.0.0 or higher * You are the owner of the chain's L1 ProxyAdmin contract * ...
(BE_THE_MAKER_OF_WORDINESS)
[grammar] ~149-~149: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...missionless fault proofs, refer to the [Todo: Update this once it goes live- Migrati...
(TO_DO_HYPHEN)
[grammar] ~151-~151: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...utorials/migrating-permissionless). ## Todo: Update the next steps
(TO_DO_HYPHEN)
🔇 Additional comments (1)
pages/operators/chain-operators/tutorials/dispute-games.mdx (1)
1-17: Frontmatter fields validation
The required metadata fields (title, lang, description, topic, personas, categories, content_type) are all present and non-empty in the frontmatter.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
pages/operators/chain-operators/tutorials/dispute-games.mdx (2)
23-24: Add internal link to the OPCM reference
Consider linking the first mention of “OPCM (OP Contracts Manager)” to your internal OPCM reference doc (e.g.,/operators/chain-operators/reference/opcm) for quick navigation.
39-43: Link to challenger role
Link the protocol-level challenger role phrase to the internal privileged roles page at/superchain/privileged-roles#challengerto provide context.
🧹 Nitpick comments (5)
pages/operators/chain-operators/tutorials/dispute-games.mdx (5)
89-98: Bullet capitalization consistency
For sentence-case clarity, lowercase the first word after each colon in the bullets:-* **saltMixer:** A string used... +* **saltMixer:** a string used...
99-100: Convert second-person phrasing to imperative
Replace “For a permissionless game, you’ll generally want to mirror…” with an imperative instruction:-For a permissionless game, you’ll generally want to mirror most parameters... +Mirror most parameters from your existing permissioned game, but set `permissioned` to `false` and `disputeGameType` to `CANNON`.
146-149: Format code identifiers and polish text
WraprespectedGameTypein backticks and tighten the sentence:-After deploying the permissionless dispute game, you'll need to update the respectedGameType in the OptimismPortal to start using it. +After deploying the permissionless dispute game, update the `respectedGameType` in the OptimismPortal.🧰 Tools
🪛 LanguageTool
[grammar] ~148-~148: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...missionless fault proofs, refer to the [Todo: Update this once it goes live- Migrati...(TO_DO_HYPHEN)
148-148: Hyphenate “To-do” in link text
Consider changing “[Todo: Update this once it goes live – Migrating to permissionless fault proofs guide]” to use “To-do” for noun consistency.🧰 Tools
🪛 LanguageTool
[grammar] ~148-~148: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...missionless fault proofs, refer to the [Todo: Update this once it goes live- Migrati...(TO_DO_HYPHEN)
150-151: Header punctuation and sentence case
Adjust the to-do header to sentence case and hyphenate “To-do”:-## Todo: Update the next steps +## To-do: update the next steps🧰 Tools
🪛 LanguageTool
[grammar] ~150-~150: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...utorials/migrating-permissionless). ## Todo: Update the next steps(TO_DO_HYPHEN)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/tutorials/dispute-games.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- 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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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/operators/chain-operators/tutorials/dispute-games.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/dispute-games.mdx
[grammar] ~148-~148: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...missionless fault proofs, refer to the [Todo: Update this once it goes live- Migrati...
(TO_DO_HYPHEN)
[grammar] ~150-~150: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...utorials/migrating-permissionless). ## Todo: Update the next steps
(TO_DO_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (8)
pages/operators/chain-operators/tutorials/dispute-games.mdx (8)
1-17: Frontmatter completeness
The frontmatter includes all required fields (title, lang, description, topic, personas, categories, content_type) with non-empty values and uses a validtutorialcontent type.
25-31: Prerequisites list follows style guidelines
The bulleted list correctly uses imperative form and includes a Foundry link as recommended.
32-38: Section header and bullet style
“Understanding dispute games” header is sentence case and bullets are clear.
45-46: Permissioned game overview
This sentence clearly sets up the purpose of the guide. No changes needed.
47-55:addGameTypefunction description
The descriptive list items correctly use sentence case for headers and concisely explain each step.
56-64: Finding the correct OPCM instance
Header and steps are clear, and external links to the Superchain Registry are accurate.
67-87: Struct definition formatting
Thestruct AddGameInputsnippet is well-formatted and aligns with Solidity conventions.
101-144: Forge script example
Thecastexample is comprehensive, well-formatted, and follows best practices for reproducibility.
3 participants
Description
This PR adds a new documentation page that provides detailed instructions for deploying new dispute games to OP Stack chains using the OP Contracts Manager (OPCM). This guide is particularly relevant for chain operators looking to upgrade their chains to support permissionless dispute games.
Key content
addGameTypefunction callRelated docs
This guide complements the existing documentation on migrating to permissionless fault proofs and serves as a technical reference for chain operators implementing these upgrades.
Tests
Additional context
Metadata