Reverting #1171 #1186
Reverting #1171 #1186
Conversation
Reverting #1171 due to ethereum-optimism/optimism#13457 Preventing sends to outside dependency set can be explored via app-layer solution eg onchain tokenlist
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request modifies the "Interoperability explainer" document for the OP Stack, focusing on enhancing the explanation of interoperability features. The changes provide a more detailed description of interop clusters, emphasizing the flexible nature of the protocol that allows chain operators to selectively choose their dependencies. The document expands on the Superchain interop cluster, describing its mesh network structure where each blockchain connects directly to every other blockchain. A significant update is the introduction of new predeploys, including The "Considerations" section has been updated to inform chain operators about the requirement of running the Sequence DiagramsequenceDiagram
participant ChainA
participant ChainB
participant OpSupervisor
participant CrossL2Inbox
ChainA->>CrossL2Inbox: Send cross-chain message
CrossL2Inbox->>OpSupervisor: Validate message
OpSupervisor-->>CrossL2Inbox: Validation result
CrossL2Inbox->>ChainB: Deliver message
Possibly related PRs
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
🧹 Nitpick comments (2)
pages/stack/interop/explainer.mdx (2)
38-40: Enhance clarity of dependency set explanationConsider refining the explanation to be more specific about the dependency relationship:
-The interop protocol works via a dependency set which is configured on a per-chain basis. The dependency set defines the set of chains that a chain will accept incoming messages from. +The interop protocol operates through a dependency set, configured individually for each chain. This dependency set explicitly defines which other chains are authorized to send messages to this chain. -This gives the OP Stack an unopinionated and flexible foundation, so chain operators can choose which chains their chains depend on, and it is not a requirement that chains are in each other's dependency set. +This architecture provides the OP Stack with an unopinionated and flexible foundation, allowing chain operators to selectively configure their message acceptance policies without requiring mutual dependency between chains.
Line range hint
1-24: Improve documentation consistencyThe document would benefit from the following improvements:
- Add periods at the end of bullet points for consistency:
-* 1-block latency asset movement that is both maximally capital efficient and non-fragmenting -* improved user experience for developers on the Superchain -* secure transfer of ETH and ERC-20s across L2s -* horizontally scalable applications +* 1-block latency asset movement that is both maximally capital efficient and non-fragmenting. +* improved user experience for developers on the Superchain. +* secure transfer of ETH and ERC-20s across L2s. +* horizontally scalable applications.
- Consider adding links to technical terms like "ProxyAdmin" and "Protocol Upgrade" to improve documentation navigability.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/interop/explainer.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/interop/explainer.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.
"
Reverting #1171 due to ethereum-optimism/optimism#13457
Preventing sends to outside dependency set can be explored via app-layer solution eg onchain tokenlist