Add detail on how to finalize a withdrawal #1313
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request updates the documentation for the withdrawal transaction process on L1. A new section is added to detail the use and behavior of the Sequence Diagram(s)sequenceDiagram
participant Caller as EOA/Contract
participant Portal as OptimismPortal
participant Proxy as Chugsplash Proxy
Caller->>Portal: Call finalizeWithdrawalTransaction()
Note right of Portal: Verify fault challenge period passed
Portal->>Proxy: Execute withdrawal finalization logic
Proxy-->>Portal: Internal revert (expected, non-failure)
Portal-->>Caller: Complete withdrawal transaction
Possibly related PRs
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)
pages/stack/transactions/withdrawal-flow.mdx (1)
82-83: Clear explanation for finalizing a withdrawal transaction.The added section clearly describes that after the fault challenge period, a user—be it an externally owned account (EOA) or a contract acting on behalf of an EOA—must call the
finalizeWithdrawalTransactionfunction of theOptimismPortalcontract. This addition directly addresses the documentation gap by linking to the relevant contract code.Consider adding a brief note on the prerequisites (for example, after the withdrawal proving step and fault challenge period) to further guide users on when this function should be called.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/transactions/withdrawal-flow.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/transactions/withdrawal-flow.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 (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
Description
The docs don't include exactly how to finalize a withdrawal transaction in the same way that they specify other steps. Fixed that by including a link to the function that is called to do so.