docs icon indicating copy to clipboard operation
docs copied to clipboard

interop: recorrect the logic between CrossL2Inbox and op-supervisor

Open joohhnnn opened this issue 6 months ago • 2 comments

The CrossL2Inbox is not directly interact with op-supervisor, the op-supervisor is work together with OP-geth and only allow the valid message transaction(aka the CrossL2Inbox call) to be included to the next block content reference

joohhnnn avatar May 11 '25 12:05 joohhnnn

Deploy Preview for docs-optimism ready!

Built without sensitive environment variables

Name Link
Latest commit 7e10bb9ac87e1443803a475cc066d197d94d9a9c
Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/6820970f2ba7760008247833
Deploy Preview https://deploy-preview-1603--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.

netlify[bot] avatar May 11 '25 12:05 netlify[bot]

📝 Walkthrough

Walkthrough

The documentation for the cross-chain attestation verification process was updated to clarify the sequence of operations between the OP-Supervisor service and the CrossL2Inbox contract. The revised text now specifies that the OP-Supervisor service checks for the existence of a specified log on the source chain before the CrossL2Inbox contract is called, rather than implying that the contract initiates this interaction. No changes were made to exported or public entities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OP-Supervisor
    participant CrossL2Inbox

    User->>OP-Supervisor: Request log existence check on source chain
    OP-Supervisor->>OP-Supervisor: Check if log exists
    OP-Supervisor-->>User: Confirm log existence
    User->>CrossL2Inbox: Call contract (after confirmation)

Possibly related PRs

  • ethereum-optimism/docs#1103: Updates documentation for cross-chain interoperability flows and clarifies the OP-Supervisor's role in verification steps.
  • ethereum-optimism/docs#1598: Updates documentation links to specific code lines in the CrossL2Inbox contract, related to the same components but with a different focus.
  • ethereum-optimism/docs#1501: Adds the initial reading-logs.mdx documentation, which is refined and expanded upon by the current PR.

Suggested reviewers

  • krofax
  • qbzzt

[!TIP]

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


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.

❤️ 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.

Support

Need 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)

  • @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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

coderabbitai[bot] avatar May 11 '25 12:05 coderabbitai[bot]

Hey @joohhnnn, it's been a while! Sorry I haven't been maintaining the docs lately and this PR is pretty stale so I'm going to go ahead and close it. I know the team internally is still cooking on the interopability feature, but I think some things have changed. I'll need to have them audit our current docs before we take new PRs on this functionality

sbvegan avatar Oct 28 '25 07:10 sbvegan