docs (OptimismBridgeFacet.md): 404 error link fix
#1128
Conversation
WalkthroughThe documentation for the Optimism Bridge Facet was updated to correct the URL referencing the Optimism Bridge contract, changing it from the master branch location to the develop branch location. No other textual or functional changes were made. Changes
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
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
CodeRabbit Configuration File (
|
![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 (2)
docs/OptimismBridgeFacet.md (2)
5-5: Grammar: use “in exchange for” instead of “in exchange of”.Consider updating the sentence for more natural English:
-The Optimism Bridge Facet works by forwarding Optimism Bridge specific calls to Optimism Bridge [contract](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L1/L1StandardBridge.sol). The standard bridge functionality provides a method for an ERC20 token to be deposited and locked on L1 in exchange of the same amount of an equivalent token on L2. +The Optimism Bridge Facet works by forwarding Optimism Bridge specific calls to the Optimism Bridge [contract](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L1/L1StandardBridge.sol). The standard bridge functionality provides a method for an ERC20 token to be deposited and locked on L1 in exchange for the same amount of an equivalent token on L2.🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: The usual preposition to use after “in exchange” is “for”, not “of”. Did you mean “in exchange for”?
Context: ... token to be deposited and locked on L1 in exchange of the same amount of an equivalent token ...(IN_CHARGE_OF_FROM)
5-5: Avoid brittle links: pin to a specific tag or commit.Linking to the
developbranch may lead to future 404s if the file moves. To ensure stability, consider referencing a release tag or specific commit SHA, for example:[contract](https://github.com/ethereum-optimism/optimism/blob/v1.11.0/packages/contracts-bedrock/src/L1/L1StandardBridge.sol)or
[contract](https://github.com/ethereum-optimism/optimism/blob/<COMMIT_SHA>/packages/contracts-bedrock/src/L1/L1StandardBridge.sol)🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: The usual preposition to use after “in exchange” is “for”, not “of”. Did you mean “in exchange for”?
Context: ... token to be deposited and locked on L1 in exchange of the same amount of an equivalent token ...(IN_CHARGE_OF_FROM)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/OptimismBridgeFacet.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/OptimismBridgeFacet.md
[grammar] ~5-~5: The usual preposition to use after “in exchange” is “for”, not “of”. Did you mean “in exchange for”?
Context: ... token to be deposited and locked on L1 in exchange of the same amount of an equivalent token ...
(IN_CHARGE_OF_FROM)
- Add test_swapAndStartBridgeTokensViaOptimismBridge_RefundsExcessETH() - Tests that excess ETH is refunded when using swapAndStartBridgeTokensViaOptimismBridge - Will catch if refundExcessNative modifier is removed (mutation on line 139) - Sends 1 ETH when only 0.1 ETH needed, verifies 0.9 ETH refund
- Simplify the test logic to directly check total ETH spent vs sent - With refundExcessNative: user loses ~0.1 ETH + gas - Without refundExcessNative: user loses full 1 ETH + gas - More reliable detection of missing refund modifier
2 participants
No description provided.