Skip to content

Comments

Update standard-bridge-custom-token.mdx#766

Merged
cpengilly merged 1 commit intoethereum-optimism:mainfrom
evanlikn:patch-1
Jun 27, 2024
Merged

Update standard-bridge-custom-token.mdx#766
cpengilly merged 1 commit intoethereum-optimism:mainfrom
evanlikn:patch-1

Conversation

@evanlikn
Copy link
Contributor

the constructor's bridge params should be L2StandardBridge.sol deployed address, not L2CrossDomainMessenger's address

Description

Change bridge address to L2StandardBridge address when custom L2 token deployed.

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

  • Fixes #[Link to Issue]

the constructor's bridge params should be L2StandardBridge.sol deployed address, not L2CrossDomainMessenger's address
@evanlikn evanlikn requested a review from a team as a code owner June 25, 2024 09:46
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 25, 2024

Walkthrough

The primary change in this update is the modification of the _BRIDGE address value in the tutorial for the standard bridge custom token. The address has been altered from "0x4200000000000000000000000000000000000007" to "0x4200000000000000000000000000000000000010". This update ensures the accuracy and correctness of the address used in the documentation.

Changes

Files Change Summary
pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx Updated _BRIDGE address in the tutorial for clarity and accuracy.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7c8db33 and 28c799a.

Files selected for processing (1)
  • pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx (1 hunks)
Additional context used
Path-based instructions (1)
pages/builders/app-developers/tutorials/standard-bridge-custom-token.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. Use bold for prominence instead of all caps or italics.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for headers, 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).
    "
Learnings (1)
pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx (3)
User: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2023-12-01T23:09:27.659Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
User: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2023-12-01T23:09:27.659Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
User: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2023-12-01T23:05:12.155Z
Learning: The user has expressed a desire for reviews on `.mdx` files, which are typically used for documentation in Markdown with embedded JSX. This preference should be remembered for future interactions.
LanguageTool
pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx

[typographical] ~16-~16: It appears that a comma is missing. (DURING_THAT_TIME_COMMA)
Context: ...-dom-bridge-erc20). In this tutorial you'll learn how to bridge a custom ERC...


[style] ~31-~31: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... contract must implement this interface in order to be bridged using the Standard Bridge sy...


[style] ~52-~52: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...d the OP Sepolia network to your wallet in order to follow this tutorial. You can use [this...


[style] ~122-~122: Consider an alternative for the overused word “exactly”. (EXACTLY_PRECISELY)
Context: ...for the token you just created! This is exactly what this tutorial was meant to demonst...

Additional comments not posted (1)
pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx (1)

109-109: Update to bridge address confirmed.

The change from "0x4200000000000000000000000000000000000007" to "0x4200000000000000000000000000000000000010" is accurate as per the PR description. This aligns with the intended use of the L2StandardBridge.sol address.


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@netlify
Copy link

netlify bot commented Jun 25, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 28c799a
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/667a91fd95ba0a000860f3f6
😎 Deploy Preview https://deploy-preview-766--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range and nitpick comments (3)
pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx (3)

Line range hint 16-16: Grammar Improvement: Missing Comma

Consider adding a comma after "ERC-20 tokens" for better readability.

- In this tutorial you'll learn how to bridge a custom ERC-20 token from Ethereum to an OP Stack chain using the Standard Bridge system.
+ In this tutorial, you'll learn how to bridge a custom ERC-20 token from Ethereum to an OP Stack chain using the Standard Bridge system.

Line range hint 31-31: Simplify Language

The phrase "in order to" could be simplified to "to" to make the sentences less wordy and more direct.

- Your L2 token contract must implement this interface in order to be bridged using the Standard Bridge system.
+ Your L2 token contract must implement this interface to be bridged using the Standard Bridge system.

- You will need to add the OP Sepolia network to your wallet in order to follow this tutorial.
+ You will need to add the OP Sepolia network to your wallet to follow this tutorial.

Also applies to: 52-52


Line range hint 122-122: Word Choice Improvement: Avoid Overused Phrases

The word "exactly" could be replaced with a less frequently used alternative like "precisely" to enhance the tone of the documentation.

- This is exactly what this tutorial was meant to demonstrate.
+ This is precisely what this tutorial was meant to demonstrate.

@cpengilly cpengilly merged commit 348d942 into ethereum-optimism:main Jun 27, 2024
@evanlikn evanlikn deleted the patch-1 branch July 1, 2024 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants