Port internal knowledge base info to doc #998
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request updates the document "Differences between Ethereum and OP Mainnet," adding new sections and content on bridging mechanisms, transaction fees, mempool rules, and chain finality specific to OP Mainnet. It introduces subsections on deposit and withdrawal transactions, expands on transaction fees, clarifies mempool rules, and explains concepts of chain finality. Additionally, a "What's Next" section with links to relevant tools and resources is included. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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: 1
🧹 Outside diff range and nitpick comments (2)
pages/chain/differences.mdx (2)
14-22: Approve changes with minor suggestionThe new Bridging section provides valuable information about deposit and withdrawal transactions, enhancing the document's completeness. The content is clear, concise, and relevant.
Consider adjusting the capitalization in the subheadings for consistency with the coding guidelines:
-### Bridging - Deposit Transactions +### Bridging - deposit transactions -### Bridging - Withdrawal Transactions and Fault Proofs +### Bridging - withdrawal transactions and fault proofs
91-93: Approve Chain Finality section with minor suggestionThe new Chain Finality section provides crucial information about the different states of finality in OP-Stack chains. The content is informative and includes a helpful link to the glossary for more details.
Consider rephrasing the first sentence for clarity:
-Unlike L1s such as Ethereum OP-Stack chains have Unsafe, Safe, and Finalized Heads which indicate the state of finality for a given L2 block. +Unlike L1s such as Ethereum, OP-Stack chains have Unsafe, Safe, and Finalized Heads, which indicate the state of finality for a given L2 block.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- pages/chain/differences.mdx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/chain/differences.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 headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🪛 LanguageTool
pages/chain/differences.mdx
[uncategorized] ~99-~99: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...rs.js for op-stack chains. We had an SDK but that is deprecated now. * [Specs](ht...(COMMA_COMPOUND_SENTENCE_2)
🔇 Additional comments (2)
pages/chain/differences.mdx (2)
68-69: Approve addition of viem library informationThe new information about using the viem library for estimating transaction gas costs is a valuable addition. It provides developers with a practical tool for working with OP Mainnet transactions.
90-90: Approve addition of Sequencer behavior informationThe added information about the Sequencer executing transactions from the mempool in priority fee order is valuable. It clarifies an important aspect of transaction processing on OP Mainnet.
pages/chain/differences.mdx
Outdated
| ## What's Next | ||
|
|
||
| There are various useful tools linked above. Here are a few more tools and links you may want to check out: | ||
|
|
||
| * [OP-viem](https://viem.sh/op-stack): JS framework that can handle many of these unique functions on OP-Chains. It is similar to Ethers.js for op-stack chains. We had an SDK but that is deprecated now. | ||
|
|
||
| * [Specs](https://specs.optimism.io/root.html): For more in-depth technical explanations and examples. |
There was a problem hiding this comment.
Approve What's Next section with minor correction
The new What's Next section is a valuable addition, providing users with links to useful tools and resources for working with OP-Stack chains.
There's a minor grammatical issue in the sentence about the SDK. Please apply the following correction:
-* [OP-viem](https://viem.sh/op-stack): JS framework that can handle many of these unique functions on OP-Chains. It is similar to Ethers.js for op-stack chains. We had an SDK but that is deprecated now.
+* [OP-viem](https://viem.sh/op-stack): JS framework that can handle many of these unique functions on OP-Chains. It is similar to Ethers.js for op-stack chains. We had an SDK, but it is deprecated now.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## What's Next | |
| There are various useful tools linked above. Here are a few more tools and links you may want to check out: | |
| * [OP-viem](https://viem.sh/op-stack): JS framework that can handle many of these unique functions on OP-Chains. It is similar to Ethers.js for op-stack chains. We had an SDK but that is deprecated now. | |
| * [Specs](https://specs.optimism.io/root.html): For more in-depth technical explanations and examples. | |
| ## What's Next | |
| There are various useful tools linked above. Here are a few more tools and links you may want to check out: | |
| * [OP-viem](https://viem.sh/op-stack): JS framework that can handle many of these unique functions on OP-Chains. It is similar to Ethers.js for op-stack chains. We had an SDK, but it is deprecated now. | |
| * [Specs](https://specs.optimism.io/root.html): For more in-depth technical explanations and examples. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~99-~99: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...rs.js for op-stack chains. We had an SDK but that is deprecated now. * [Specs](ht...(COMMA_COMPOUND_SENTENCE_2)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
pages/chain/differences.mdx (3)
68-69: Approve update with minor suggestionThe addition of information about using the viem library for estimating transaction gas costs is valuable. To enhance clarity, consider adding a brief explanation of what the L1 Data Fee is or linking to a relevant section that explains it.
Consider modifying the sentence as follows:
-You can use the [JS library viem](https://viem.sh/op-stack) to estimate the entire transaction gas costs, including the L1 Data Fee. +You can use the [JS library viem](https://viem.sh/op-stack) to estimate the entire transaction gas costs, including the L1 Data Fee (additional cost for publishing transaction data on L1).
90-91: Approve update with minor grammatical correctionThe updated Mempool Rules section provides valuable information about how the OP Mainnet Sequencer mempool differs from Ethereum's. To improve readability, a minor punctuation correction is suggested.
Please apply the following correction:
-The Sequencer executes transactions from the mempool in priority fee order (highest fee first). +The Sequencer executes transactions from the mempool in priority fee order (highest fee first).
91-93: Approve new Chain Finality section with minor correctionThe new Chain Finality section is a valuable addition, introducing important concepts specific to OP-Stack chains. The link to the glossary for more detailed explanations is particularly helpful. To improve clarity, a minor grammatical correction is suggested.
Please apply the following correction:
-Unlike L1s such as Ethereum OP-Stack chains have Unsafe, Safe, and Finalized Heads which indicate the state of finality for a given L2 block. +Unlike L1s such as Ethereum, OP-Stack chains have Unsafe, Safe, and Finalized Heads, which indicate the state of finality for a given L2 block.🧰 Tools
🪛 LanguageTool
[uncategorized] ~93-~93: Possible missing comma found.
Context: ... ## Chain Finality Unlike L1s such as Ethereum OP-Stack chains have Unsafe, Safe, and ...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- pages/chain/differences.mdx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/chain/differences.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 headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🪛 LanguageTool
pages/chain/differences.mdx
[uncategorized] ~93-~93: Possible missing comma found.
Context: ... ## Chain Finality Unlike L1s such as Ethereum OP-Stack chains have Unsafe, Safe, and ...(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (2)
pages/chain/differences.mdx (2)
14-22: Excellent addition of the Bridging sectionThe new Bridging section provides valuable information about deposit and withdrawal transactions, enhancing the document's comprehensiveness. The explanations are clear and concise, and the links to further resources are helpful.
95-101: Approve What's Next sectionThe new What's Next section is a valuable addition, providing users with links to useful tools and resources for working with OP-Stack chains. The information about OP-viem and the link to the specifications are particularly helpful.
Note: A previous review has already addressed the minor grammatical issue in the sentence about the SDK. Please refer to that comment for the suggested correction.
There was a problem hiding this comment.
This is great, here's what I want to do:
- Migrate these updates into https://docs.optimism.io/stack/differences
- Delete this page
- Add a redirect from this page to the
Differences between Ethereum and OP Stack Chainspage - add this to the MDX header thing at the top:
tags: ["eng-protocol"]
Ports internal knowledge base info to the Eth/OP differences doc. Adds info on bridging, chain finality, and useful tools.