Add info on expected internal reverts for withdrawal transactions #853
Conversation
WalkthroughThe update introduces a new section in the documentation that clarifies the expected behavior of internal reverts during withdrawal transactions on the Optimism platform. It explains that these reverts are normal due to the operation of the Chugsplash Proxy and do not indicate transaction failure. The section offers reassurance and includes links to additional resources for users seeking more information. Changes
Assessment against linked issues
Recent review detailsConfiguration used: .coderabbit.yaml Files selected for processing (2)
Files skipped from review due to trivial changes (1)
Additional comments not posted (3)
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 as PR comments)
Additionally, you can add Documentation and Community
|
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (3)
pages/stack/protocol/rollup/withdrawal-flow.mdx (3)
82-84: Clarify the introduction of the new section.The introduction effectively sets the context for the new section. However, consider rephrasing for clarity and conciseness:
-During the withdrawal process, users may observe internal reverts when viewing the transaction on Etherscan. This is a common point of confusion but is expected behavior. +During the withdrawal process, internal reverts may appear on Etherscan. This common point of confusion is expected behavior.
86-86: Improve readability and clarity.The paragraph explains why internal reverts occur. Consider breaking it into two sentences for better readability:
-These internal reverts often show up in yellow on the Etherscan UI and may cause concern that something went wrong with the transaction. However, these reverts occur due to the non-standard proxy used in Optimism, specifically the **Chugsplash Proxy**. The Chugsplash Proxy sometimes triggers internal calls that revert as part of the designed flow of the withdrawal process. +These internal reverts often show up in yellow on the Etherscan UI and may cause concern that something went wrong with the transaction. However, these reverts occur due to the non-standard proxy used in Optimism, specifically the **Chugsplash Proxy**. The Chugsplash Proxy sometimes triggers internal calls that revert as part of the designed withdrawal process.
88-90: Enhance explanation of why reverts happen.The paragraph provides a good explanation of why reverts happen. Consider adding a sentence to emphasize that these reverts are not errors:
-The Chugsplash Proxy operates differently than standard proxies. During a withdrawal transaction, it may trigger internal contract calls that result in reverts, but these reverts do not indicate that the withdrawal has failed. Instead, they are part of the internal logic of the system and are expected in certain scenarios. +The Chugsplash Proxy operates differently than standard proxies. During a withdrawal transaction, it may trigger internal contract calls that result in reverts. These reverts do not indicate that the withdrawal has failed. Instead, they are part of the internal logic of the system and are expected in certain scenarios.
2 participants
Description
This modification adds a section to the existing
withdrawal-flow.mdxdocumentation to explain the expected internal reverts that users often see on Etherscan during withdrawal transactions.Tests
Please describe any tests you've added. If you've added no tests, or left important behavior untested, please explain why not.
Additional context
Add any other context about the problem you're solving.
Metadata