Fixes: ETH Deposit Tutorial #1250
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces modifications to the documentation and code related to bridging ETH from Layer 1 (L1) to Layer 2 (L2) using Viem. The primary change involves updating the contract reference from Assessment against linked issues
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: 0
🧹 Nitpick comments (1)
public/tutorials/cross-dom-bridge-eth.js (1)
52-52: Parameter update looks good!The change from
depositHashto{ hash: depositHash }correctly aligns with Viem's API expectations for thewaitForTransactionReceiptmethod.Minor: Remove extra semicolon.
There's an extra semicolon at the end of the line that can be removed for consistency.
-const depositReceipt = await publicClientL1.waitForTransactionReceipt({ hash: depositHash });; +const depositReceipt = await publicClientL1.waitForTransactionReceipt({ hash: depositHash });🧰 Tools
🪛 eslint
[error] 52-52: Extra semicolon.
(semi)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/builders/app-developers/tutorials/cross-dom-bridge-eth.mdx(3 hunks)public/tutorials/cross-dom-bridge-eth.js(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/app-developers/tutorials/cross-dom-bridge-eth.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.
"
🪛 eslint
public/tutorials/cross-dom-bridge-eth.js
[error] 52-52: Extra semicolon.
(semi)
⏰ 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 (2)
pages/builders/app-developers/tutorials/cross-dom-bridge-eth.mdx (2)
136-136: Contract reference update is accurate!The change from
L1StandardBridgetoOptimismPortalProxycorrectly reflects the actual contract used for ETH deposits, improving technical accuracy.
170-170: Code snippet update maintains implementation consistency!The updated parameter in
waitForTransactionReceiptmatches the JavaScript implementation, ensuring documentation accuracy.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
pages/stack/interop/explainer.mdx (2)
23-23: Fix grammatical error in possessive form.Change "each others'" to "each other's" as it's the correct possessive form.
-Information that comes from other sources is harder to provide in a safe, decentralized, and uncensorable manner (this is called [The Oracle Problem](https://chain.link/education-hub/oracle-problem)). +Information that comes from other sources is harder to provide in a safe, decentralized, and uncensorable manner (this is called [the Oracle Problem](https://chain.link/education-hub/oracle-problem)).🧰 Tools
🪛 LanguageTool
[grammar] ~23-~23: Did you mean “other's”?
Context: ...hat lets OP Stack blockchains read each others' state. Interoperability provides the fo...(EACH_OTHERS)
26-29: Fix bullet point formatting and grammar.The bullet points need consistent formatting and proper punctuation.
-* 1-block latency asset movement, removing the problem of capital fragmentation leading to better capital efficiency. -* Improved experience for both users and developers. -* Secure transfer of assets, such as ETH and ERC-20 tokens, across L2s. -* Horizontal scalability for applications that need it. +* One-block latency asset movement, removing the problem of capital fragmentation and leading to better capital efficiency +* Improved experience for both users and developers +* Secure transfer of assets, such as ETH and ERC-20 tokens, across L2s +* Horizontal scalability for applications that need itpages/stack/interop/security.mdx (2)
28-28: Improve sentence structure.Reposition "also" for better readability.
-In that case, if the information provided to sequencer is incorrect, of course the blocks posted by the sequencer will be also incorrect. +In that case, if the information provided to sequencer is incorrect, of course the blocks posted by the sequencer will also be incorrect.🧰 Tools
🪛 LanguageTool
[style] ~28-~28: To make your writing flow more naturally, try moving ‘also’ before the verb.
Context: ...urse the blocks posted by the sequencer will be also incorrect. In this case, invalid b...(ALSO_PLACEMENT)
35-35: Fix punctuation and remove redundancy.Add missing comma and remove redundant "only".
-Normally the blocks that make it to the canonical blockchain are those posted to L1 by the sequencer. +Normally, the blocks that make it to the canonical blockchain are those posted to L1 by the sequencer. -A deposit only block only contains the deposit transactions and some internal transactions, not the sequencer transactions. +A deposit-only block contains the deposit transactions and some internal transactions, not the sequencer transactions.Also applies to: 45-45
🧰 Tools
🪛 LanguageTool
[typographical] ~35-~35: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...e deposit only blocks? Normally the blocks that make it to the canonica...(RB_LY_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
pages/stack/interop.mdx(1 hunks)pages/stack/interop/explainer.mdx(4 hunks)pages/stack/interop/predeploy.mdx(3 hunks)pages/stack/interop/security.mdx(5 hunks)words.txt(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- pages/stack/interop/predeploy.mdx
🧰 Additional context used
📓 Path-based instructions (3)
pages/stack/interop/explainer.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.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/security.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/stack/interop/explainer.mdx
[grammar] ~23-~23: Did you mean “other's”?
Context: ...hat lets OP Stack blockchains read each others' state. Interoperability provides the fo...
(EACH_OTHERS)
pages/stack/interop/security.mdx
[style] ~28-~28: To make your writing flow more naturally, try moving ‘also’ before the verb.
Context: ...urse the blocks posted by the sequencer will be also incorrect. In this case, invalid b...
(ALSO_PLACEMENT)
[typographical] ~35-~35: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...e deposit only blocks? Normally the blocks that make it to the canonica...
(RB_LY_COMMA)
[grammar] ~45-~45: Adverb repetition.
Context: ...ored by the sequencer. A deposit only block only contains the deposit transactions and s...
(ADVERB_VERB_ADVERB_REPETITION)
words.txt
[duplication] ~81-~81: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...AP datacap DATADIR datadir dependencies Devnet devnet devnets devx direnv DISABLETXPOOLGOSSIP...
(GERMAN_WORD_REPEAT_RULE)
[duplication] ~408-~408: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...etered Unprotect unsubmitted UPNP usafe VERKLE verkle VHOSTS vhosts Viem viem Viem's VMDEBUG ...
(GERMAN_WORD_REPEAT_RULE)
⏰ 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 (1)
pages/stack/interop.mdx (1)
31-33: LGTM! Well-organized card additions.The new cards for predeploys and security are logically placed and properly formatted.
Overview
This PR addresses technical inaccuracies and code issues in the ETH-Viem deposit tutorial docs.
Changes Made
1. Contract Reference Correction
L1StandardBridgecontract usageOptimismPortalProxydirectlyL1StandardBridge2. Code Example Fix
waitForTransactionReceiptfunctionTo
This resolves the BigInt conversion error users were encountering