Fix deposit flow tutorial #1648
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for the deposit flow tutorial was updated to clarify the roles of the L1 and L2 networks by explicitly naming Ethereum Sepolia as L1 and OP Sepolia as L2, and specifying their respective RPC URLs. The instructions for sending deposit transactions now emphasize the direction from L1 to L2 and provide an example Infura RPC URL for L1. Additional guidance was added for locating the hash of a failed relay message on L2, outlining three methods: inspecting internal transactions, checking contract events, and querying the contract state with the Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes were identified. Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 0
🧹 Nitpick comments (3)
pages/stack/transactions/deposit-flow.mdx (3)
97-106: Inconsistent placeholder naming
The callout usesYOUR_KEYin the Infura URL, but later steps referenceYOUR_INFURA_KEY. Please standardize onYOUR_INFURA_KEYfor consistency.- * **L1**: Ethereum Sepolia testnet (`https://sepolia.infura.io/v3/YOUR_KEY`) + * **L1**: Ethereum Sepolia testnet (`https://sepolia.infura.io/v3/YOUR_INFURA_KEY`)
152-152: Refine event description for clarity
Consider adjusting verb tense and terminology:- The transaction will be successful on **L1 (Ethereum Sepolia)**, but then emit a fail event on **L2 (OP Sepolia)**. + The transaction will be successful on **L1 (Ethereum Sepolia)**, but will then emit a failure event on **L2 (OP Sepolia)**.
177-180: Use en dash for time range
Replace the hyphen with an en dash to specify the duration range.- This can take 2-5 minutes. + This can take 2–5 minutes.🧰 Tools
🪛 LanguageTool
[typographical] ~180-~180: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...d fail before proceeding. This can take 2-5 minutes. You should see a failed transa...(HYPHEN_TO_EN)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/transactions/deposit-flow.mdx(3 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/stack/transactions/deposit-flow.mdx
🪛 LanguageTool
pages/stack/transactions/deposit-flow.mdx
[typographical] ~180-~180: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...d fail before proceeding. This can take 2-5 minutes. You should see a failed transa...
(HYPHEN_TO_EN)
⏰ 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/stack/transactions/deposit-flow.mdx (2)
69-69: Approved: L2 processing step clarified
Clear description, consistent with step 1, sentence case and proper punctuation.
139-146: Approved: Step 4 command section
The instructions clearly distinguish L1 vs L2 networks, use consistent placeholders, and the shell block is well-formatted.
Co-authored-by: Bradley Camacho <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
pages/stack/transactions/deposit-flow.mdx (5)
143-145: Remove trailing whitespace and add punctuation
Line 145 contains trailing spaces and the comment lacks a terminal period.- L1_RPC=https://sepolia.infura.io/v3/YOUR_INFURA_KEY + L1_RPC=https://sepolia.infura.io/v3/YOUR_INFURA_KEY
152-152: Clarify terminology
Change “fail event” to “failure event” for consistency with theFailedRelayedMessagenaming.-The transaction will be successful on **L1 (Ethereum Sepolia)**, but then emit a fail event on **L2 (OP Sepolia)**. +The transaction will be successful on **L1 (Ethereum Sepolia)**, but then emit a failure event on **L2 (OP Sepolia)**.
156-164: Use sentence case for method headings
The fallback method titles should follow sentence case (only the first word capitalized).- **Method A: Using Etherscan Internal Transactions** + **Method A: Using Etherscan internal transactions** - **Method B: Using Contract Events (if internal transactions aren't visible)** + **Method B: Using contract events (if internal transactions aren't visible)** - **Method C: Using cast to query failed messages** + **Method C: Using cast to query failed messages**
173-173: Refine relay-until phrasing
Use parallel structure for clarity:-If the latest internal transaction is a success, it probably means your transaction hasn't relayed yet. Wait until it is, that may take a few minutes. +If the latest internal transaction is a success, your transaction hasn’t been relayed yet. Wait until it has been relayed, which may take a few minutes.
180-180: Use an en dash for time range
Per style guide, replace the hyphen in “2-5 minutes” with an en dash.-Make sure you wait for the deposit to be processed on L2 and fail before proceeding. This can take 2-5 minutes. +Make sure you wait for the deposit to be processed on L2 and fail before proceeding. This can take 2–5 minutes.🧰 Tools
🪛 LanguageTool
[typographical] ~180-~180: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...d fail before proceeding. This can take 2-5 minutes. You should see a failed transa...(HYPHEN_TO_EN)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/transactions/deposit-flow.mdx(3 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/stack/transactions/deposit-flow.mdx
🪛 LanguageTool
pages/stack/transactions/deposit-flow.mdx
[typographical] ~180-~180: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...d fail before proceeding. This can take 2-5 minutes. You should see a failed transa...
(HYPHEN_TO_EN)
⏰ 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/stack/transactions/deposit-flow.mdx (3)
69-69: Clear L2 conversion step added
Step 2 now explicitly describes howop-nodeconvertsTransactionDepositedevents into deposit transactions, aligning with the protocol spec.
166-171: Fallback query example approved
The shell snippet for queryingfailedMessagesis clear and idiomatic.
184-184: Approve placeholder assignment
UsingTX_HASHas the environment variable for the failed relay hash is clear and consistent with earlier instructions.
Description
Problem
The deposit flow tutorial had critical issues preventing users from completing it:
L1_RPCpointed to OP Sepolia (L2) instead of Ethereum Sepolia (L1)Solution
sepolia.infura.io)Impact
Users can now successfully complete the cross-chain deposit replay tutorial without getting stuck on network configuration or missing transaction data.
Fixes reported issue where users couldn't find internal transactions and were confused about L1/L2 network setup.
Tests
Additional context
Metadata