Skip to content

Conversation

qbzzt
Copy link
Contributor

@qbzzt qbzzt commented Feb 14, 2025

Description

One of the devnet OptimismPortal addresses was wrong.

Tests

N/A

Additional context

N/A

Metadata

N/A

@qbzzt qbzzt requested a review from a team as a code owner February 14, 2025 17:39
Copy link

netlify bot commented Feb 14, 2025

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 8748a50
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/67af7fd250ca9a00083beeb1
😎 Deploy Preview https://deploy-preview-1369--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 bot commented Feb 14, 2025

📝 Walkthrough

Walkthrough

This pull request updates the message-passing.mdx tutorial to enhance documentation on cross-chain communication using the L2ToL2CrossDomainMessenger contract. It introduces a new event, CrossDomainSetGreeting, in the Greeter contract to log the sender's address and chain ID during cross-domain message processing. The setGreeting method in the Greeter contract has been updated with additional logic. The tutorial now also includes a section on manual message relaying, providing step-by-step instructions on setting up a Node project for executing messages without the autorelay mechanism. Additionally, the instructions for using the devnet have been revised to account for updated contract addresses and the need for ETH on the Sepolia network, along with clarifications on the redeployment process for both the Greeter and GreetingSender contracts.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GreetingSender
    participant L2ToL2CrossDomainMessenger
    participant Greeter

    User->>GreetingSender: Initiate greeting message
    GreetingSender->>L2ToL2CrossDomainMessenger: Relay cross-chain message
    L2ToL2CrossDomainMessenger->>Greeter: Forward message for processing
    Greeter->>Greeter: Execute setGreeting logic
    Greeter->>Greeter: Emit event CrossDomainSetGreeting(sender, chainId, greeting)
Loading
sequenceDiagram
    participant User
    participant ManualRelayNode
    participant Greeter

    User->>ManualRelayNode: Trigger manual relay process
    ManualRelayNode->>Greeter: Execute setGreeting transaction
    Greeter->>Greeter: Log event CrossDomainSetGreeting(sender, chainId, greeting)
Loading

Possibly related PRs

Suggested reviewers

  • krofax
  • zainbacchus

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

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

🧹 Nitpick comments (2)
pages/stack/interop/tutorials/message-passing.mdx (2)

579-582: Parameterize hardcoded addresses in ETH sending commands.

The commands use hardcoded addresses which could become outdated. Consider using environment variables or configuration files to store these addresses.

-cast send --rpc-url https://endpoints.omniatech.io/v1/eth/sepolia/public --private-key $PRIV_KEY --value 0.001ether 0x7385d89d38ab79984e7c84fab9ce5e6f4815468a
-cast send --rpc-url https://endpoints.omniatech.io/v1/eth/sepolia/public --private-key $PRIV_KEY --value 0.001ether 0x55f5c4653dbcde7d1254f9c690a5d761b315500c
+cast send --rpc-url https://endpoints.omniatech.io/v1/eth/sepolia/public --private-key $PRIV_KEY --value 0.001ether $CHAIN_A_BRIDGE
+cast send --rpc-url https://endpoints.omniatech.io/v1/eth/sepolia/public --private-key $PRIV_KEY --value 0.001ether $CHAIN_B_BRIDGE

584-584: Improve clarity of waiting instruction.

The current instruction could be more specific about what users should look for.

-Wait a few minutes until you can see the ETH [on your explorer](https://sid.testnet.routescan.io/).
+Wait approximately 5-10 minutes for the ETH to appear in your wallet balance [on the block explorer](https://sid.testnet.routescan.io/).
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f84e1ad and 8748a50.

📒 Files selected for processing (1)
  • pages/stack/interop/tutorials/message-passing.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...

**/*.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:
    1. Use sentence case, capitalizing only the first word.
    2. 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.
    3. 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/stack/interop/tutorials/message-passing.mdx
🔇 Additional comments (2)
pages/stack/interop/tutorials/message-passing.mdx (2)

13-13: Review header capitalization for consistency.

Headers should follow sentence case while preserving the capitalization of proper nouns and technical terms. For example:

  • "Interop message passing tutorial" → "Interop Message Passing tutorial"
  • "What you'll learn" → "What You'll Learn"

Please check nouns.txt in the root directory to confirm the correct capitalization of technical terms and proper nouns.

Also applies to: 15-15, 20-20, 26-26, 39-39, 41-41, 45-45, 52-52, 58-58, 83-83, 259-259, 364-364, 598-598, 613-613


554-557:

❓ Verification inconclusive

Verify contract addresses and explorer links.

The contract addresses provided in the table are critical for user interaction. These should be regularly verified to ensure they remain valid and accessible.


🏁 Script executed:

#!/bin/bash
# Description: Verify contract addresses are accessible and contain the expected code

# Check if the contracts are accessible
for addr in "0x1A183FCf61053B7dcd2322BbE766f7E1946d3718" "0x9De9f84a4EB3616B44CF1d68cD1A9098Df6cB25f"; do
  # Get contract code length to verify it's not empty
  curl -s -X POST -H "Content-Type: application/json" \
    --data "{\"jsonrpc\":\"2.0\",\"method\":\"eth_getCode\",\"params\":[\"$addr\", \"latest\"],\"id\":1}" \
    "https://sid.testnet.routescan.io" | jq -r '.result'
done

Length of output: 775


Manual Verification Needed: Contract Addresses and Explorer Links

The table in pages/stack/interop/tutorials/message-passing.mdx provides critical contract information, but the verification script ran into JSON parsing errors (suggesting issues with the endpoint’s response format). Please manually verify the following:

  • Ensure the contract at address 0x1A183FCf61053B7dcd2322BbE766f7E1946d3718 returns valid bytecode.
  • Confirm the contract at address 0x9De9f84a4EB3616B44CF1d68cD1A9098Df6cB25f is deployed as expected.
  • Validate that the provided explorer links correctly direct users to the deployed contracts.

@krofax krofax merged commit 12af374 into ethereum-optimism:main Feb 14, 2025
4 checks passed
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.

3 participants