Generating absolute prestate and preimage files for permissionless proofs #1610
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
📝 WalkthroughWalkthroughThe changes introduce a new tutorial titled "Generating absolute prestate and preimage files" for chain operators, explaining how to prepare these files for permissionless fault proofs on the OP Stack. The tutorial is added as a new Markdown file and referenced in the tutorials listing and metadata JSON. Additionally, the order of existing tutorial cards is adjusted, specifically moving the "Deploying new dispute games with OPCM" card and inserting the new tutorial card immediately after it. The metadata JSON is updated to include entries for both the dispute games and absolute prestate tutorials. Sequence Diagram(s)sequenceDiagram
participant Operator
participant DocsSite
participant MetadataJSON
participant TutorialsList
Operator->>DocsSite: Access tutorials page
DocsSite->>MetadataJSON: Load tutorial entries
DocsSite->>TutorialsList: Render tutorials in new order
Operator->>DocsSite: Select "Generating absolute prestate and preimage files"
DocsSite->>Operator: Display new tutorial content
sequenceDiagram
participant Operator
participant GitRepo
participant BuildSystem
participant OpChallenger
Operator->>GitRepo: Clone Optimism monorepo
Operator->>GitRepo: Checkout release tag
Operator->>BuildSystem: Build op-program binary
Operator->>BuildSystem: Generate absolute prestate file
BuildSystem-->>Operator: Output prestate hashes and preimage file
Operator->>OpChallenger: Configure with prestate and preimage files
OpChallenger-->>Operator: Ready for permissionless fault proofs
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure 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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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: 2
🧹 Nitpick comments (4)
pages/operators/chain-operators/tutorials/_meta.json (1)
8-9: Ensure consistent JSON spacing.
Add a space after the colon in the new entries to match the existing style of key–value pairs.Apply this diff:
- "dispute-games":"Deploying new dispute games with OPCM", + "dispute-games": "Deploying new dispute games with OPCM", - "absolute-prestate":"Generating absolute prestate and preimage files", + "absolute-prestate": "Generating absolute prestate and preimage files",pages/operators/chain-operators/tutorials/absolute-prestate.mdx (3)
1-15: Frontmatter validation and title casing.
All required metadata fields are present and non-empty. Please confirm thattopic: generating absolute prestate filesis a valid key inkeywords.config.yaml.
Additionally, page names should use Title Case in thetitlefrontmatter:- title: Generating absolute prestate and preimage files + title: Generating Absolute Prestate and Preimage Files
123-129: Capitalize the proper noun “Superchain Registry.”
The registry name should have both words capitalized:-## Official prestate hashes for Superchain registry chains +## Official prestate hashes for Superchain Registry chains
245-247: Header sentence case.
Use sentence case for headers; change “Next Steps” to:-## Next Steps +## Next steps
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (3)
pages/operators/chain-operators/tutorials.mdx(1 hunks)pages/operators/chain-operators/tutorials/_meta.json(1 hunks)pages/operators/chain-operators/tutorials/absolute-prestate.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.mdxpages/operators/chain-operators/tutorials/absolute-prestate.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
[misspelling] ~33-~33: This word is normally spelled as one.
Context: ... and memory ## Using the latest AP and multi-threaded Cannon As of the latest releases, OP S...
(EN_COMPOUNDS_MULTI_THREADED)
[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...chains should utilize the 64-bit MIPS multi-threaded version of Cannon. This upgrade offers...
(EN_COMPOUNDS_MULTI_THREADED)
[grammar] ~72-~72: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...enerate the absolute prestate Generate the prestate by running the op-program binary direct...
(A_INFINITIVE)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...three prestate hashes: * Cannon64: The current production absolute prestat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~109-~109: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...e the preimage file After generating the prestate, find the preimage file. You should s...
(A_INFINITIVE)
[duplication] ~135-~135: Possible typo: you repeated a word.
Context: ...onfiguration. This applies to: * New chains * Chains with custom configurations For these c...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~168-~168: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...rocess using op-deployer. ### Generate the prestate From the root of the monorepo, run: `...
(A_INFINITIVE)
[grammar] ~248-~248: This phrase is duplicated. You should probably use “fault proofs” only once.
Context: ...games) * Migrating to permissionless fault proofs * [Fault proofs explainer](/stack/fault-proofs/explaine...
(PHRASE_REPETITION)
🔇 Additional comments (2)
pages/operators/chain-operators/tutorials.mdx (2)
43-44: New tutorial card approved.
The insertion of the “Deploying new dispute games with OPCM” card follows the sentence-case style of surrounding entries and thehrefmatches the new tutorial file.
45-46: New tutorial card approved.
The “Generating absolute prestate and preimage files” card is correctly placed, uses sentence case, and thehrefpoints to the added MDX file.
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Adrian Sutton <adrian@symphonious.net>
Co-authored-by: Adrian Sutton <adrian@symphonious.net>
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (2)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (2)
30-31: Inconsistent bullet phrasing in prerequisites.
The prerequisites mix a noun phrase ([Docker] running) and an imperative (Have sufficient disk space and memory). Switch to a consistent style. For example:-* [Docker](https://docs.docker.com/engine/install/) running -* Have sufficient disk space and memory +* Docker installation (see https://docs.docker.com/engine/install/) +* Sufficient disk space and memory
230-233:⚠️ Potential issuePlaceholder mismatch.
The text instructs replacing<URL_TO_PRESTATES_DIRECTORY>but the Docker command uses<YOUR_PRESTATES_URL>. Standardize to<YOUR_PRESTATES_URL>:- Replace `<URL_TO_PRESTATES_DIRECTORY>` with the URL where you've stored your prestate files. + Replace `<YOUR_PRESTATES_URL>` with the URL where you've stored your prestate files.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
pages/operators/chain-operators/tutorials/absolute-prestate.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/absolute-prestate.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
[misspelling] ~33-~33: This word is normally spelled as one.
Context: ... Using the latest absolute prestate and multi-threaded Cannon As of the latest releases, OP S...
(EN_COMPOUNDS_MULTI_THREADED)
[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...chains should utilize the 64-bit MIPS multi-threaded version of Cannon. This upgrade offers...
(EN_COMPOUNDS_MULTI_THREADED)
[grammar] ~72-~72: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...enerate the absolute prestate Generate the prestate by running the op-program binary direct...
(A_INFINITIVE)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...three prestate hashes: * Cannon64: The current production absolute prestat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~108-~108: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...e the preimage file After generating the prestate, the preimage file will be located in `...
(A_INFINITIVE)
[duplication] ~132-~132: Possible typo: you repeated a word.
Context: ...onfiguration. This applies to: * New chains * Chains with custom configurations For these c...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~165-~165: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...rocess using op-deployer. ### Generate the prestate From the root of the monorepo, run: `...
(A_INFINITIVE)
[grammar] ~246-~246: This phrase is duplicated. You should probably use “fault proofs” only once.
Context: ...games) * Migrating to permissionless fault proofs * [Fault proofs explainer](/stack/fault-proofs/explaine...
(PHRASE_REPETITION)
🔇 Additional comments (23)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (23)
1-15: Frontmatter validation: all required metadata present.
All required frontmatter fields (title, lang, description, topic, personas, categories, content_type) are present and non-empty.
17-17: Import statement is correct.
The import ofCalloutandStepsfromnextra/componentsis valid and used appropriately below.
19-25: Clear and concise overview.
The Overview section avoids first-person pronouns and clearly explains the role of absolute prestate and preimage files in permissionless fault proofs.
33-35: Section header formatting is appropriate.
The H2 header uses sentence case and correctly capitalizes “multi-threaded Cannon.”🧰 Tools
🪛 LanguageTool
[misspelling] ~33-~33: This word is normally spelled as one.
Context: ... Using the latest absolute prestate and multi-threaded Cannon As of the latest releases, OP S...(EN_COMPOUNDS_MULTI_THREADED)
[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...chains should utilize the64-bitMIPS multi-threaded version of Cannon. This upgrade offers...(EN_COMPOUNDS_MULTI_THREADED)
38-41: Benefit list is well-structured.
The bullet list under advantages uses clear noun phrases and aligns with style guidelines.
42-45: Callout clarity and consistency.
The info callout correctly references Upgrade 14, uses proper title case, and maintains consistent hyphenation.
49-60: Clone and checkout steps are clear.
These steps include the necessarygit clone,git checkout, and submodule initialization with a placeholder for the release tag.
62-68: Build instructions are concise and correct.
Themake op-programcommand is clearly presented.
70-77: Generate prestate command is accurate.
Usingmake reproducible-prestatedirectly aligns with the top-level Makefile target.🧰 Tools
🪛 LanguageTool
[grammar] ~72-~72: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...enerate the absolute prestate Generate the prestate by running the op-program binary direct...(A_INFINITIVE)
79-96: Sample output formatting is clear.
The two sections for production and experimental prestates are distinct and easy to follow.
98-104: Explanation of prestate hashes is clear.
The bullet list correctly describes each hash and its intended usage.🧰 Tools
🪛 LanguageTool
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...three prestate hashes: *Cannon64: The current production absolute prestat...(UNLIKELY_OPENING_PUNCTUATION)
106-117: Preimage preparation steps are well-written.
Instructions for renaming and uploading the preimage file are precise.🧰 Tools
🪛 LanguageTool
[grammar] ~108-~108: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...e the preimage file After generating the prestate, the preimage file will be located in `...(A_INFINITIVE)
120-127: Official Superchain registry instructions are precise.
Users are correctly directed to the registry and official prestate tags.
128-134: Handling unannounced configurations header and intro are clear.
The H2 header uses sentence case and the introduction clearly defines when to follow custom steps.🧰 Tools
🪛 LanguageTool
[duplication] ~132-~132: Possible typo: you repeated a word.
Context: ...onfiguration. This applies to: * New chains * Chains with custom configurations For these c...(ENGLISH_WORD_REPEAT_RULE)
139-142: Directory creation command is correct.
Themkdir -pinvocation and path are accurate.
153-157: Copy commands for chain config files are accurate.
Thecpcommands include a placeholder for the chain ID and correct target paths.
158-162: Naming convention note is clear.
The required file naming format is correctly specified.
165-176: Custom prestate generation commands are complete.
Both default and flag-based invocation examples are provided.🧰 Tools
🪛 LanguageTool
[grammar] ~165-~165: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...rocess using op-deployer. ### Generate the prestate From the root of the monorepo, run: `...(A_INFINITIVE)
178-194: Custom prestate sample output is consistent.
This output matches the earlier example and clearly labels each hash.
198-200: Link to preimage preparation step is correct.
The anchor reference aligns with the earlier "Prepare the preimage file" heading.
203-207: Deploying and configuring section header is appropriate.
The H2 header follows sentence case and accurately describes the content.
216-228: Docker run command clarity.
Placeholders are clearly indicated, though see the next comment for a placeholder inconsistency.
242-248: Next Steps navigation is well-formatted.
The bullet list uses title case for page names, aligning with design guidelines.🧰 Tools
🪛 LanguageTool
[grammar] ~246-~246: This phrase is duplicated. You should probably use “fault proofs” only once.
Context: ...games) * Migrating to permissionless fault proofs * [Fault proofs explainer](/stack/fault-proofs/explaine...(PHRASE_REPETITION)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (1)
1-248:⚠️ Potential issueMissing SME review placeholders. The PR description indicates that certain sections require subject matter expert (SME) review before finalizing (e.g., confirming version numbers, registry links, or command accuracy), but no TODOs or callouts are present in the content. Please highlight areas needing SME input with clear placeholders or callouts.
🧰 Tools
🪛 LanguageTool
[misspelling] ~33-~33: This word is normally spelled as one.
Context: ... Using the latest absolute prestate and multi-threaded Cannon As of the latest releases, OP S...(EN_COMPOUNDS_MULTI_THREADED)
[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...chains should utilize the64-bitMIPS multi-threaded version of Cannon. This upgrade offers...(EN_COMPOUNDS_MULTI_THREADED)
[grammar] ~72-~72: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...enerate the absolute prestate Generate the prestate by running the op-program binary direct...(A_INFINITIVE)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...three prestate hashes: *Cannon64: The current production absolute prestat...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~108-~108: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...e the preimage file After generating the prestate, the preimage file will be located in `...(A_INFINITIVE)
[duplication] ~132-~132: Possible typo: you repeated a word.
Context: ...onfiguration. This applies to: * New chains * Chains with custom configurations For these c...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~165-~165: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...rocess using op-deployer. ### Generate the prestate From the root of the monorepo, run: `...(A_INFINITIVE)
[grammar] ~246-~246: This phrase is duplicated. You should probably use “fault proofs” only once.
Context: ...games) * Migrating to permissionless fault proofs * [Fault proofs explainer](/stack/fault-proofs/explaine...(PHRASE_REPETITION)
♻️ Duplicate comments (2)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (2)
30-31: Inconsistent bullet phrasing in prerequisites. The items mix a noun phrase ("Docker running") with an imperative ("Have sufficient disk space and memory"). Please make both items uniform—either both noun phrases (e.g., "Docker installation" / "Sufficient disk space and memory") or both imperatives (e.g., "Install Docker" / "Ensure sufficient disk space and memory").
236-239: 🛠️ Refactor suggestionIncorrect option reference in callout. The callout mentions
--game-factory-address, but the Docker example uses theOP_CHALLENGER_GAME_FACTORY_ADDRESSenvironment variable. Please update the text to reference the correct variable.- The dispute game factory address must be manually specified via the `--game-factory-address` option. + The dispute game factory address must be set using the `OP_CHALLENGER_GAME_FACTORY_ADDRESS` environment variable.
🧹 Nitpick comments (3)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (3)
108-109: Clarify the prestate reference. To improve clarity, specify "absolute prestate file" (to differentiate from other prestates) or simply "prestate file" instead of just "prestate".
For example:- After generating the prestate, the preimage file will be located in `op-program/bin/prestate-mt64.bin.gz`. + After generating the absolute prestate file, the preimage file will be located in `op-program/bin/prestate-mt64.bin.gz`.🧰 Tools
🪛 LanguageTool
[grammar] ~108-~108: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...e the preimage file After generating the prestate, the preimage file will be located in `...(A_INFINITIVE)
130-134: Reduce repetitive wording. The sentence “…generate a custom prestate with your specific chain configuration. This applies to:” repeats “configuration/configurations” closely. Consider rephrasing to avoid redundancy, e.g.:- ...specific chain configuration. This applies to: + ...custom prestates for chains with unique settings. Applicable cases include:🧰 Tools
🪛 LanguageTool
[duplication] ~132-~132: Possible typo: you repeated a word.
Context: ...onfiguration. This applies to: * New chains * Chains with custom configurations For these c...(ENGLISH_WORD_REPEAT_RULE)
236-238: Split run-on sentence in callout. The phrase “Ensure you're using the latest op-challenger version, see the release page” is a comma splice. Split or use a semicolon:- Ensure you're using the latest op-challenger version, see the [release page](https://github.com/ethereum-optimism/optimism/release) + Ensure you're using the latest op-challenger version. See the [release page](https://github.com/ethereum-optimism/optimism/release)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
pages/operators/chain-operators/tutorials/absolute-prestate.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/absolute-prestate.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
[misspelling] ~33-~33: This word is normally spelled as one.
Context: ... Using the latest absolute prestate and multi-threaded Cannon As of the latest releases, OP S...
(EN_COMPOUNDS_MULTI_THREADED)
[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...chains should utilize the 64-bit MIPS multi-threaded version of Cannon. This upgrade offers...
(EN_COMPOUNDS_MULTI_THREADED)
[grammar] ~72-~72: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...enerate the absolute prestate Generate the prestate by running the op-program binary direct...
(A_INFINITIVE)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...three prestate hashes: * Cannon64: The current production absolute prestat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~108-~108: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...e the preimage file After generating the prestate, the preimage file will be located in `...
(A_INFINITIVE)
[duplication] ~132-~132: Possible typo: you repeated a word.
Context: ...onfiguration. This applies to: * New chains * Chains with custom configurations For these c...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~165-~165: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...rocess using op-deployer. ### Generate the prestate From the root of the monorepo, run: `...
(A_INFINITIVE)
[grammar] ~246-~246: This phrase is duplicated. You should probably use “fault proofs” only once.
Context: ...games) * Migrating to permissionless fault proofs * [Fault proofs explainer](/stack/fault-proofs/explaine...
(PHRASE_REPETITION)
⏰ 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 (2)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (2)
1-15: Frontmatter completeness verified. All required metadata fields (title,lang,description,topic,personas,categories,content_type) are present and non-empty, satisfying the project’s metadata validation.
35-36:✅ Verification successful
Verify hyphenation of "multi-threaded". The compound “multi-threaded” vs. “multithreaded” may be inconsistent with existing documentation. Please search for occurrences in other MDX files and align to the project’s preferred style.
🏁 Script executed:
#!/bin/bash # Search for hyphenation variants in MDX files rg -l "multi-threaded" -g "*.mdx" || true rg -l "multithreaded" -g "*.mdx" || trueLength of output: 195
No changes needed—“multi-threaded” is already the project’s preferred style
A search across all MDX files shows only the hyphenated form and no instances of “multithreaded”:
- pages/notices/upgrade-14.mdx
- pages/notices/upgrade-15.mdx
- pages/operators/chain-operators/tutorials/absolute-prestate.mdx
All usages are consistent, so no updates are required.
🧰 Tools
🪛 LanguageTool
[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...chains should utilize the64-bitMIPS multi-threaded version of Cannon. This upgrade offers...(EN_COMPOUNDS_MULTI_THREADED)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (2)
30-31: Consistent bullet style in prerequisites
Your bullet points mix a noun phrase and an imperative (e.g.,[Docker] runningvs.Have sufficient disk space…). To maintain consistency, switch to a single style—either all noun phrases or all imperatives.
272-275:⚠️ Potential issueFix callout to reference environment variable
The callout currently instructs to use the--game-factory-addressCLI option, but the Docker examples useOP_CHALLENGER_GAME_FACTORY_ADDRESS. Update to avoid confusion.<Callout type="info"> - * The dispute game factory address must be manually specified via the `--game-factory-address` option. + * The dispute game factory address must be set using the `OP_CHALLENGER_GAME_FACTORY_ADDRESS` environment variable. </Callout>
🧹 Nitpick comments (1)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (1)
49-52: Use “check out” as a verb phrase
The header “Clone and checkout the tagged version” uses “checkout” (noun). As a verb, it should be two words: “check out”.- ### Clone and checkout the tagged version + ### Clone and check out the tagged version
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (2)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx(1 hunks)words.txt(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- words.txt
🧰 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/absolute-prestate.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
[misspelling] ~33-~33: This word is normally spelled as one.
Context: ... Using the latest absolute prestate and multi-threaded Cannon As of the latest releases, OP S...
(EN_COMPOUNDS_MULTI_THREADED)
[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...chains should utilize the 64-bit MIPS multi-threaded version of Cannon. This upgrade offers ...
(EN_COMPOUNDS_MULTI_THREADED)
[grammar] ~103-~103: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...e the preimage file After generating the prestate, the preimage file will be located in `...
(A_INFINITIVE)
[grammar] ~118-~118: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ... in the Superchain registry at the time the prestate was created. ...
(A_INFINITIVE)
[grammar] ~123-~123: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...r chain was added to the registry after the prestate was created * The configuration for...
(A_INFINITIVE)
[grammar] ~124-~124: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...n for your chain has been updated since the prestate was created Before using a prestate ...
(A_INFINITIVE)
[grammar] ~126-~126: The verb ‘prestate’ does not usually follow articles like ‘a’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...he prestate was created Before using a prestate from the registry, verify that it conta...
(A_INFINITIVE)
[duplication] ~137-~137: Possible typo: you repeated a word.
Context: ...onfiguration. This applies to: * New chains * Chains with custom configurations For these c...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~176-~176: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: .... This ensures you can always rebuild the prestate in the future by checking out that bran...
(A_INFINITIVE)
[grammar] ~178-~178: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...riginal files are lost. ### Generate the prestate After placing your configuration fil...
(A_INFINITIVE)
[grammar] ~251-~251: It appears that the past participle should be used here.
Context: ...ion 2: Using local files If you have prestate files stored locally, you'll need to mo...
(HAVE_PART_AGREEMENT)
[grammar] ~282-~282: This phrase is duplicated. You should probably use “fault proofs” only once.
Context: ...games) * Migrating to permissionless fault proofs * [Fault proofs explainer](/stack/fault-proofs/explaine...
(PHRASE_REPETITION)
⏰ 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 (1)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (1)
1-15: Frontmatter metadata validation
The frontmatter includes all required fields (title,lang,description,topic,personas,categories,content_type) and they are non-empty. Good job on setting up the page metadata.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (1)
30-31: Consistent bullet style in prerequisites.The prerequisite bullets mix a dangling phrase and an imperative. Please standardize on noun phrases:
- * [Docker](https://docs.docker.com/engine/install/) running - * Have sufficient disk space and memory + * Docker installed (see https://docs.docker.com/engine/install/) + * Sufficient disk space and memory
🧹 Nitpick comments (1)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (1)
280-281: Use title case for Next Steps links.Link text should follow title case to match page titles:
- * [Migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) - * [Fault proofs explainer](/stack/fault-proofs/explainer) + * [Migrating to Permissionless Fault Proofs](/operators/chain-operators/tutorials/migrating-permissionless) + * [Fault Proofs Explainer](/stack/fault-proofs/explainer)🧰 Tools
🪛 LanguageTool
[grammar] ~281-~281: This phrase is duplicated. You should probably use “fault proofs” only once.
Context: ...games) * Migrating to permissionless fault proofs * [Fault proofs explainer](/stack/fault-proofs/explaine...(PHRASE_REPETITION)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
pages/operators/chain-operators/tutorials/absolute-prestate.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/absolute-prestate.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
[misspelling] ~33-~33: This word is normally spelled as one.
Context: ... Using the latest absolute prestate and multi-threaded Cannon As of the latest releases, OP S...
(EN_COMPOUNDS_MULTI_THREADED)
[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...chains should utilize the 64-bit MIPS multi-threaded version of Cannon. This upgrade offers ...
(EN_COMPOUNDS_MULTI_THREADED)
[grammar] ~103-~103: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...e the preimage file After generating the prestate, the preimage file will be located in `...
(A_INFINITIVE)
[grammar] ~118-~118: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ... in the Superchain registry at the time the prestate was created. ...
(A_INFINITIVE)
[grammar] ~123-~123: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...r chain was added to the registry after the prestate was created * The configuration for...
(A_INFINITIVE)
[grammar] ~124-~124: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...n for your chain has been updated since the prestate was created Before using a prestate ...
(A_INFINITIVE)
[grammar] ~126-~126: The verb ‘prestate’ does not usually follow articles like ‘a’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...he prestate was created Before using a prestate from the registry, verify that it conta...
(A_INFINITIVE)
[duplication] ~137-~137: Possible typo: you repeated a word.
Context: ...onfiguration. This applies to: * New chains * Chains with custom configurations For these c...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~176-~176: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: .... This ensures you can always rebuild the prestate in the future by checking out that bran...
(A_INFINITIVE)
[grammar] ~178-~178: The verb ‘prestate’ does not usually follow articles like ‘the’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...riginal files are lost. ### Generate the prestate After placing your configuration fil...
(A_INFINITIVE)
[grammar] ~251-~251: It appears that the past participle should be used here.
Context: ...ion 2: Using local files If you have prestate files stored locally, you'll need to mo...
(HAVE_PART_AGREEMENT)
[grammar] ~281-~281: This phrase is duplicated. You should probably use “fault proofs” only once.
Context: ...games) * Migrating to permissionless fault proofs * [Fault proofs explainer](/stack/fault-proofs/explaine...
(PHRASE_REPETITION)
🔇 Additional comments (2)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx (2)
1-15: Frontmatter metadata is complete.All required frontmatter fields (
title,lang,description,topic,personas,categories, andcontent_type) are present and non-empty, satisfying the project’s metadata validation rules.
33-36: The flagged “multi-threaded” compound is intentional technical terminology and does not require modification.🧰 Tools
🪛 LanguageTool
[misspelling] ~33-~33: This word is normally spelled as one.
Context: ... Using the latest absolute prestate and multi-threaded Cannon As of the latest releases, OP S...(EN_COMPOUNDS_MULTI_THREADED)
[misspelling] ~35-~35: This word is normally spelled as one.
Context: ...chains should utilize the64-bitMIPS multi-threaded version of Cannon. This upgrade offers ...(EN_COMPOUNDS_MULTI_THREADED)
3 participants
Description
This PR adds documentation to guide chain operators on how to generate absolute prestate and preimage files needed for running cannon/permissionless proofs on the OP Stack.
Changes
Why this Is Important
As chains migrate from permissioned to permissionless fault proofs, operators need clear guidance on generating and managing the required prestate files. This documentation fills a critical gap for operators deploying or upgrading their chains to use permissionless proofs.
Tests
Additional context
Metadata