Update Docs for Deploying OP Stack Smart Contracts Using op-deployer #1281
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 1 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 (1)
📝 WalkthroughWalkthroughThe pull request introduces significant updates to the documentation for deploying OP Stack smart contracts, focusing on transitioning from legacy deployment methods to the recommended Possibly related issues
Possibly related PRs
Suggested labels
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? 🪧 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 (11)
words.txt (4)
2-2: Remove duplicate entry.The term
accountqueueappears to be a duplicate ofACCOUNTQUEUE. Consider removing one of these entries to maintain consistency.🧰 Tools
🪛 LanguageTool
[duplication] ~2-~2: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ACCOUNTQUEUE accountqueue ACCOUNTSLOTS accountslots ADDI ADDIU ADDU airgap Allnodes Allocs ...(GERMAN_WORD_REPEAT_RULE)
38-38: Remove duplicate entry.The term
BLOCKLOGSappears to be a duplicate ofblocklogs. Consider removing one of these entries to maintain consistency.
88-88: Standardize capitalization.The term
Devnetsappears alongsidedevnetanddevnets. Consider standardizing the capitalization across all variants.
423-423: Standardize capitalization.The term
zorashould be capitalized asZorato maintain consistency with other proper nouns in the dictionary.pages/builders/chain-operators/deploy/smart-contracts.mdx (4)
11-13: Standardize capitalization in callout.The term "OP Stack" is correctly capitalized, but consider using sentence case for the rest of the callout text to maintain consistency with documentation guidelines.
Apply this diff:
- Standard OP Stack chains must use the latest governance approved and audited versions of the smart contract code. + Standard OP Stack chains must use the latest governance-approved and audited versions of the smart contract code.
21-24: Standardize capitalization in callout.Use sentence case for the callout text to maintain consistency with documentation guidelines.
Apply this diff:
-The following deployment information outlines the legacy method for deploying the OP Stack L1 contracts. -We do not recommend using this method, and it is provided here only for historical context. +The following deployment information outlines the legacy method for deploying the OP Stack L1 contracts. +This method is not recommended and is provided here only for historical context.
26-29: Use sentence case for headers.According to the documentation guidelines, use sentence case for headers.
Apply this diff:
-## Deployment Configuration +## Deployment configuration
84-128: Enhance clarity in the op-deployer section.The new section provides good structure but could benefit from additional clarity:
- Add a brief description of what op-deployer is and its benefits.
- Clarify the prerequisites before the steps.
- Add troubleshooting guidance.
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (1)
422-459: Enhance clarity and completeness of the op-deployer section.The section needs improvements in the following areas:
- Add a brief introduction explaining what op-deployer is and its benefits.
- Add version requirements for op-deployer.
- Add expected output examples.
- Add error handling guidance.
pages/builders/chain-operators/configuration/batcher.mdx (1)
846-850: Fix grammar and formatting in the policy table.The table has the following issues:
- Remove the comma before "because" in the Notes column for Data Availability Type.
- Ensure consistent formatting of technical terms.
Apply this diff to fix the grammar:
-| Data Availability Type | Specifies whether the batcher uses **blobs** or **calldata** to post transaction data to L1. | Batch submitter address | Ethereum (Blobs or Calldata) | - Alternative data availability (Alt-DA) is not yet supported in the standard configuration.<br />- The sequencer can switch at will between blob transactions and calldata, with no restrictions, because both are fully secured by L1. | +| Data Availability Type | Specifies whether the batcher uses **blobs** or **calldata** to post transaction data to L1. | Batch submitter address | Ethereum (Blobs or Calldata) | - Alternative data availability (Alt-DA) is not yet supported in the standard configuration.<br />- The sequencer can switch at will between blob transactions and calldata with no restrictions because both are fully secured by L1. |🧰 Tools
🪛 LanguageTool
[formatting] ~848-~848: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...tions and calldata, with no restrictions, because both are fully secured by L1. | | Batch...(COMMA_BEFORE_BECAUSE)
pages/stack/interop/op-supervisor.mdx (1)
55-62: Improve wording for better clarity.Consider revising the repetitive phrase "To do this" for better readability.
Apply this diff to improve the wording:
- To do this, the execution client looks at every executing message and queries `op-supervisor` to see if there is a corresponding initiating message. + The execution client examines every executing message and queries `op-supervisor` to verify the existence of a corresponding initiating message.🧰 Tools
🪛 LanguageTool
[style] ~56-~56: Consider a more expressive alternative.
Context: ...is sufficiently safe to include. To do this, the execution client looks at eve...(DO_ACHIEVE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
pages/builders/chain-operators/configuration/batcher.mdx(29 hunks)pages/builders/chain-operators/deploy/smart-contracts.mdx(3 hunks)pages/builders/chain-operators/tutorials/create-l2-rollup.mdx(1 hunks)pages/stack/interop/op-supervisor.mdx(2 hunks)words.txt(5 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
pages/builders/chain-operators/deploy/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:
- 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/builders/chain-operators/configuration/batcher.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:
- 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/builders/chain-operators/tutorials/create-l2-rollup.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:
- 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/stack/interop/op-supervisor.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:
- 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.
"
🪛 LanguageTool
words.txt
[duplication] ~2-~2: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ACCOUNTQUEUE accountqueue ACCOUNTSLOTS accountslots ADDI ADDIU ADDU airgap Allnodes Allocs ...
(GERMAN_WORD_REPEAT_RULE)
[duplication] ~411-~411: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...e VHOSTS vhosts Viem viem Viem's viem's VMDEBUG vmdebug VMODULE vmodule voxel xlarge XORI xtens...
(GERMAN_WORD_REPEAT_RULE)
pages/builders/chain-operators/configuration/batcher.mdx
[formatting] ~848-~848: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...tions and calldata, with no restrictions, because both are fully secured by L1. | | Batch...
(COMMA_BEFORE_BECAUSE)
pages/stack/interop/op-supervisor.mdx
[style] ~56-~56: Consider a more expressive alternative.
Context: ...is sufficiently safe to include. To do this, the execution client looks at eve...
(DO_ACHIEVE)
🔇 Additional comments (5)
pages/builders/chain-operators/configuration/batcher.mdx (3)
854-856: LGTM!The data availability types section is well-structured and correctly formatted.
859-861: LGTM!The batch submission frequency section is clear and properly formatted.
864-866: LGTM!The output frequency section is well-structured and correctly formatted.
pages/stack/interop/op-supervisor.mdx (2)
14-16: LGTM!The introduction is clear and properly formatted.
17-22: LGTM!The blockchain heads list is well-structured and properly formatted.
|
NB: Technically this is ready for review, once i get the correct |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
pages/builders/chain-operators/deploy/smart-contracts.mdx (1)
102-104: Fix typo in the sentence.Remove the extra period after "L1":
-* This file specifies the deployment parameters for both L1. +* This file specifies the deployment parameters for L1.pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (1)
483-484: Add explanatory comments for configuration files.Consider adding brief descriptions of what each configuration file is used for:
-op-deployer inspect genesis --workdir .deployer <l2-chain-id> > .deployer/genesis.json -op-deployer inspect rollup --workdir .deployer <l2-chain-id> > .deployer/rollup.json +# Generate genesis.json - defines the initial state of your L2 chain +op-deployer inspect genesis --workdir .deployer <l2-chain-id> > .deployer/genesis.json +# Generate rollup.json - contains configuration for the consensus client +op-deployer inspect rollup --workdir .deployer <l2-chain-id> > .deployer/rollup.json
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
pages/builders/chain-operators/deploy/smart-contracts.mdx(3 hunks)pages/builders/chain-operators/tools/op-deployer.mdx(2 hunks)pages/builders/chain-operators/tutorials/create-l2-rollup.mdx(1 hunks)words.txt(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- words.txt
🧰 Additional context used
📓 Path-based instructions (3)
pages/builders/chain-operators/tools/op-deployer.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:
- 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/builders/chain-operators/deploy/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:
- 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/builders/chain-operators/tutorials/create-l2-rollup.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:
- 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.
"
⏰ 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 (4)
pages/builders/chain-operators/deploy/smart-contracts.mdx (1)
11-13: LGTM!The callout effectively communicates the requirement for using governance-approved smart contract versions.
pages/builders/chain-operators/tools/op-deployer.mdx (2)
34-35: LGTM!The instruction clearly guides users to replace the L2 chain ID placeholder.
101-103: LGTM!The instructions clearly explain how to use the apply command and replace the placeholders.
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (1)
420-424: LGTM!The introduction effectively sets up the section on using op-deployer.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
pages/builders/chain-operators/deploy/smart-contracts.mdx (1)
21-24: 🛠️ Refactor suggestionUpdate language to follow documentation guidelines.
Replace personal pronoun with more direct language.
-We do not recommend using this method, and it is provided here only for historical context. +This method is not recommended and is provided here only for historical context.pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (1)
420-458: 🛠️ Refactor suggestionRemove duplicate environment requirements.
The environment requirements are duplicated.
* Access to the L1 blockchain (e.g., Sepolia or Mainnet) via an RPC URL. * A private key with sufficient funds to cover deployment costs. -* Access to the L1 blockchain (e.g., Sepolia or Mainnet) via an RPC URL. -* A private key with sufficient funds to cover deployment costs.🧰 Tools
🪛 LanguageTool
[uncategorized] ~431-~431: Possible missing comma found.
Context: ...lease, download the binary for your platform then extract it somewhere on your `PATH...(AI_HYDRA_LEO_MISSING_COMMA)
🧹 Nitpick comments (1)
pages/builders/chain-operators/deploy/smart-contracts.mdx (1)
95-95: Add missing comma for better readability.Add a comma after "platform" to properly separate the clauses.
-for your platform then extract it somewhere on your `PATH`. +for your platform, then extract it somewhere on your `PATH`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~95-~95: Possible missing comma found.
Context: ...lease, download the binary for your platform then extract it somewhere on your `PATH...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
pages/builders/chain-operators/deploy/smart-contracts.mdx(3 hunks)pages/builders/chain-operators/tools/op-deployer.mdx(4 hunks)pages/builders/chain-operators/tutorials/create-l2-rollup.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/builders/chain-operators/tools/op-deployer.mdx
🧰 Additional context used
📓 Path-based instructions (2)
pages/builders/chain-operators/tutorials/create-l2-rollup.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:
- 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/builders/chain-operators/deploy/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:
- 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.
"
🪛 LanguageTool
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx
[uncategorized] ~431-~431: Possible missing comma found.
Context: ...lease, download the binary for your platform then extract it somewhere on your `PATH...
(AI_HYDRA_LEO_MISSING_COMMA)
pages/builders/chain-operators/deploy/smart-contracts.mdx
[uncategorized] ~95-~95: Possible missing comma found.
Context: ...lease, download the binary for your platform then extract it somewhere on your `PATH...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (3)
pages/builders/chain-operators/deploy/smart-contracts.mdx (2)
11-13: LGTM! Clear and important security notice.The callout effectively communicates the critical requirement to use governance-approved smart contract versions.
84-127: Well-structured introduction of op-deployer.The section effectively introduces op-deployer as the recommended deployment method with clear, step-by-step instructions.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~95-~95: Possible missing comma found.
Context: ...lease, download the binary for your platform then extract it somewhere on your `PATH...(AI_HYDRA_LEO_MISSING_COMMA)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (1)
473-495: LGTM! Clear instructions for configuration generation.The section provides clear instructions with well-formatted commands for generating the necessary configuration files.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
pages/builders/chain-operators/deploy/smart-contracts.mdx (1)
94-95: Add missing comma for better readability.Add a comma after "platform" to properly separate the clauses.
- for your platform then extract it somewhere on your `PATH`. + for your platform, then extract it somewhere on your `PATH`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~95-~95: Possible missing comma found.
Context: ...lease, download the binary for your platform then extract it somewhere on your `PATH...(AI_HYDRA_LEO_MISSING_COMMA)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (2)
438-438: Improve sentence clarity.The sentence structure can be improved by removing redundant words.
-* This file specifies the deployment parameters for deploying the L1 smart contract. +* This file specifies the parameters for deploying the L1 smart contract.
480-481: Add command descriptions for better clarity.Consider adding brief descriptions of what each command generates to help users understand their purpose.
+# Generate L2 genesis state for the execution client op-deployer inspect genesis --workdir .deployer <l2-chain-id> > .deployer/genesis.json +# Generate rollup configuration for the consensus client op-deployer inspect rollup --workdir .deployer <l2-chain-id> > .deployer/rollup.json
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/builders/chain-operators/deploy/smart-contracts.mdx(3 hunks)pages/builders/chain-operators/tutorials/create-l2-rollup.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/builders/chain-operators/deploy/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:
- 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/builders/chain-operators/tutorials/create-l2-rollup.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:
- 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.
"
🪛 LanguageTool
pages/builders/chain-operators/deploy/smart-contracts.mdx
[uncategorized] ~95-~95: Possible missing comma found.
Context: ...lease, download the binary for your platform then extract it somewhere on your `PATH...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (5)
pages/builders/chain-operators/deploy/smart-contracts.mdx (3)
11-13: LGTM! Clear and concise callout.The callout effectively communicates the requirement to use governance-approved smart contract versions.
21-24: LGTM! Clear warning about legacy method.The warning effectively communicates that this is a legacy method and sets appropriate expectations.
124-127: LGTM! Clear explanation of CREATE2 usage.The callout effectively explains when and why to use the CREATE2 method for deterministic deployment.
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (2)
432-433: Remove duplicate environment requirements.These requirements are already stated in the environment setup section above.
-* Access to the L1 blockchain (e.g., Sepolia or Mainnet) via an RPC URL. -* A private key with sufficient funds to cover deployment costs.
491-492: LGTM! Well-documented inspect commands.The commands are clear and include helpful comments explaining their purpose.
|
Closing this in favour of #1292 , it has more context, and covers more details. |
Description
This PR updates and standardizes the L1 contract deployment documentation across the OP Stack docs, emphasizing the use of op-deployer as the recommended deployment method. The changes aim to provide clear, consistent guidance while maintaining historical context.
Key changes:
Modified Pages
/builders/chain-operators/deploy/smart-contracts/builders/chain-operators/tutorials/create-l2-rollupTests
Additional context
Metadata
Include a link to any github issues that this may close in the following form:
- [L2 Testnet Tutorial] L2 genesis and rollup configuration file creation #1262