Move USDC Section to OP Mainnet-Specific #1160
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Warning Rate limit exceeded@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 45 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 Walkthrough📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces significant modifications to the documentation regarding the Standard Bridge, particularly focusing on the handling of USDC tokens. It emphasizes the deprecation of the legacy bridged version (USDC.e) on OP Mainnet, urging users to transition to the native USDC token issued by Circle. The previous description of the bridging process for USDC has been replaced with a warning callout to highlight the importance of using the native version. Additionally, the document's structure has been refined, incorporating callouts that inform users about the limitations of the Standard Bridge, especially regarding fee-on-transfer and rebasing tokens. While the overall flow remains consistent, the updates streamline the information relevant to USDC, ensuring users are aware of current best practices. The bridging mechanisms for both native and non-native tokens continue to be detailed, and minor formatting adjustments along with added links for further reading have been included to enhance user experience. 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
🧹 Outside diff range and nitpick comments (1)
pages/builders/app-developers/bridging/standard-bridge.mdx (1)
244-247: Consider enhancing the warning message with migration guidanceWhile the warning effectively communicates the deprecation of USDC.e, it could be more helpful to include:
- A timeline for the deprecation (if available)
- Steps or a link to documentation about how to migrate from USDC.e to native USDC
The current implementation:
<Callout type="warning"> The legacy bridged version of USDC (USDC.e) at address `0x7f5c764cbc14f9669b88837ca1490cca17c31607` is being deprecated on OP Mainnet. Users and developers should migrate to using the native USDC token issued directly by [Circle](https://www.circle.com/en/), the issuer of [USDC](https://www.circle.com/en/usdc?gad_source=1). </Callout>Suggested enhancement:
<Callout type="warning"> The legacy bridged version of USDC (USDC.e) at address `0x7f5c764cbc14f9669b88837ca1490cca17c31607` is being deprecated on OP Mainnet. Users and developers should migrate to using the native USDC token issued directly by [Circle](https://www.circle.com/en/), the issuer of [USDC](https://www.circle.com/en/usdc?gad_source=1). + For guidance on migrating from USDC.e to native USDC, please refer to our [migration guide](/path-to-migration-guide). </Callout>
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
pages/builders/app-developers/bridging/standard-bridge.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/app-developers/bridging/standard-bridge.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.
"
🔇 Additional comments (1)
pages/builders/app-developers/bridging/standard-bridge.mdx (1)
242-242: LGTM!
The section header follows the correct sentence case format while properly capitalizing the proper nouns (USDC, OP Mainnet).
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
pages/chain/tokenlist.mdx (1)
23-26: Enhance warning message clarityConsider these minor refinements to improve clarity and maintain consistency:
-The legacy bridged version of USDC (USDC.e) at address `0x7f5c764cbc14f9669b88837ca1490cca17c31607` is being deprecated on OP Mainnet. -Users and developers should migrate to using the native USDC token issued directly by [Circle](https://www.circle.com/en/), the issuer of [USDC](https://www.circle.com/en/usdc?gad_source=1). +The legacy bridged version of USDC (USDC.e) at address `0x7f5c764cbc14f9669b88837ca1490cca17c31607` is being deprecated on OP Mainnet. +Users and developers should migrate to the native USDC token issued directly by [Circle](https://www.circle.com/en/), the official issuer of [USDC](https://www.circle.com/en/usdc?gad_source=1).
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
pages/builders/app-developers/bridging/standard-bridge.mdx(1 hunks)pages/chain/tokenlist.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/chain/tokenlist.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/builders/app-developers/bridging/standard-bridge.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.
"
🔇 Additional comments (3)
pages/chain/tokenlist.mdx (2)
21-22: LGTM! Clear and well-structured section header
The header follows the correct sentence case guidelines while preserving the capitalization of proper nouns (USDC, OP Mainnet).
30-33: LGTM! Well-structured token information table
The table provides clear descriptions and properly formatted Etherscan links for both token versions.
pages/builders/app-developers/bridging/standard-bridge.mdx (1)
238-238: LGTM! Proper component closure
The added closing tag properly terminates the Steps component.
Description
This PR reorganizes the standard bridge section to improve clarity around USDC usage on OP Mainnet. The existing section on USDC in the Standard Bridge documentation has been moved to a dedicated "USDC on OP Mainnet" subsection to reduce confusion for chain operators.
Tests
Additional context
Metadata