SuperchainERC20 best practices #1061
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
This doc is a bit barebones in places. If there are any "gotchas" or things folks should know, drop a comment and we'll get them included! |
|
Warning Rate limit exceeded@bradleycamacho has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 47 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. WalkthroughThe changes in this pull request include the addition of a new entry in the JSON metadata file for SuperchainERC20 best practices, the creation of a new documentation file detailing these best practices, and modifications to an existing words list file. The new documentation emphasizes consistent token management across Superchain networks and outlines essential practices for deployment and testing. Additionally, several terms were removed from the words list, and one new term was added. Changes
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: 3
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (3)
pages/stack/interop/_meta.json(1 hunks)pages/stack/interop/superchainerc20-best-practices.mdx(1 hunks)words.txt(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- pages/stack/interop/_meta.json
- words.txt
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/interop/superchainerc20-best-practices.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.
"
🪛 LanguageTool
pages/stack/interop/superchainerc20-best-practices.mdx
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...s such as maximum balance transfers and inter-chain latency to ensure asset reliability acr...
(EN_COMPOUNDS_INTER_CHAIN)
🪛 GitHub Check: lint
pages/stack/interop/superchainerc20-best-practices.mdx
[warning] 23-23:
Remove 1 space before this heading’s content
🔇 Additional comments (3)
pages/stack/interop/superchainerc20-best-practices.mdx (3)
1-5: LGTM! Frontmatter is well-structured.
The metadata is properly formatted with clear title and description.
7-11: LGTM! Clear title and introduction.
The introduction effectively sets the context and includes crucial information about token supply behavior.
31-35: LGTM! Well-structured next steps section.
The section provides clear, relevant follow-up resources with properly formatted links.
There was a problem hiding this comment.
Approved but see this comment: https://github.com/ethereum-optimism/docs/pull/1061/files#r1833042592
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
pages/stack/interop/superchainerc20-best-practices.mdx (1)
15-17: Consider making the deployment guidance more actionable.The explanation about predefined addresses could be more specific about implementation steps.
-Use predefined addresses: Assign and verify the same address for each `SuperchainERC20` instance on every chain. Predefined addresses reduce deployment conflicts and ensure tokens are accurately recognized across chains. Otherwise, the SuperchainERC20Bridge would need a way to verify if the tokens they mint on destination correspond to the tokens that were burned on source. +To ensure consistent addresses across chains: +1. Use `Create2Deployer` or [predeploys](https://specs.optimism.io/interop/predeploys.html) to generate deterministic addresses +2. Verify the same address is used for each `SuperchainERC20` instance on every chain +3. Document the deployment addresses for future reference + +This approach prevents deployment conflicts and ensures reliable token recognition across chains, eliminating the need for additional verification in the SuperchainERC20Bridge.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
pages/stack/interop/superchainerc20-best-practices.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/interop/superchainerc20-best-practices.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.
"
🪛 LanguageTool
pages/stack/interop/superchainerc20-best-practices.mdx
[misspelling] ~25-~25: This word is normally spelled as one.
Context: ...s such as maximum balance transfers and inter-chain latency to ensure asset reliability acr...
(EN_COMPOUNDS_INTER_CHAIN)
🔇 Additional comments (5)
pages/stack/interop/superchainerc20-best-practices.mdx (5)
1-5: LGTM! Frontmatter follows the documentation guidelines.
The metadata is well-structured with appropriate title case and description.
7-11: LGTM! Clear and well-structured introduction.
The introduction effectively sets context and maintains consistent technical terminology.
23-23: Remove personal pronoun.
Replace "We recommend" to maintain consistency in communal documentation.
-We recommend using [Supersim](https://supersim.pages.dev/introduction) as an easy way to simulate the Superchain and test your SuperchainERC20 deployment.
+Using [Supersim](https://supersim.pages.dev/introduction) provides an easy way to simulate the Superchain and test your SuperchainERC20 deployment.25-25: Fix compound word spelling.
"inter-chain" should be written as "interchain".
-Test edge cases such as maximum balance transfers and inter-chain latency to ensure asset reliability across different scenarios.
+Test edge cases such as maximum balance transfers and interchain latency to ensure asset reliability across different scenarios.🧰 Tools
🪛 LanguageTool
[misspelling] ~25-~25: This word is normally spelled as one.
Context: ...s such as maximum balance transfers and inter-chain latency to ensure asset reliability acr...
(EN_COMPOUNDS_INTER_CHAIN)
27-31: LGTM! Well-structured next steps section.
The links are properly formatted and provide a clear learning path.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This explainer covers best practices for deploying SuperchainERC20 tokens
Closes https://github.com/ethereum-optimism/devrel/issues/379