Better explanation of what equivocation does #1293
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the documentation for the interop security model in the Sequence DiagramsequenceDiagram
participant Source as Source Layer
participant L1 as Layer 1
participant Dest as Destination Layer
Source->>L1: Write Source Block
L1->>Dest: Initiate Message
alt Message is Safe
Dest->>Dest: Process Block
else Message is Unsafe
Dest->>Dest: Create Deposit-Only Block
end
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 (3)
pages/stack/interop/security.mdx (3)
65-66: Format technical terms consistently.Technical terms should be formatted in code style for clarity:
-Because of equivocation risk, a block that is written to L1 (*local safe*) can only be considered truly safe (the technical term is *cross safe*), for itself and the previous blocks in its blockchain are also written to L1. +Because of equivocation risk, a block that is written to L1 (`local safe`) can only be considered truly safe (the technical term is `cross safe`) when itself and the previous blocks in its blockchain are also written to L1.
67-70: Improve conciseness of the explanation.The explanation can be more direct:
-If the source block is written to L1 first, the destination sequencer can detect it. -If because of equivocation it is missing an initiating message that the sequencer relied upon, the sequencer can detect the error and recalculate the state. -In this case, no significant harm is done. +When the source block is written to L1 first, the destination sequencer can detect missing initiating messages due to equivocation and recalculate the state without significant impact.
71-73: Fix comma usage and improve readability.Address the formatting issues:
-However, it is also possible that the destination block, the one with the executing message that relies on the initiating message, is written to L1 first (for example, because it is a chain with more traffic). +However, it is also possible that the destination block (the one with the executing message that relies on the initiating message) is written to L1 first because it is a chain with more traffic. -In this case the destination block, and any block in any chain that depends upon it, become deposit only blocks. +In this case, the destination block and any block in any chain that depends upon it become deposit-only blocks.🧰 Tools
🪛 LanguageTool
[formatting] ~71-~71: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...age, is written to L1 first (for example, because it is a chain with more traffic). In th...(COMMA_BEFORE_BECAUSE)
[formatting] ~72-~72: Consider inserting a comma after an introductory phrase for better readability.
Context: ...any block that depends on it) is wrong. In this case the destination block, and any block in...(IN_THAT_CASE_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/interop/security.mdx(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/interop/security.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/security.mdx
[formatting] ~71-~71: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...age, is written to L1 first (for example, because it is a chain with more traffic). In th...
(COMMA_BEFORE_BECAUSE)
[formatting] ~72-~72: Consider inserting a comma after an introductory phrase for better readability.
Context: ...any block that depends on it) is wrong. In this case the destination block, and any block in...
(IN_THAT_CASE_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (3)
pages/stack/interop/security.mdx (3)
82-85: LGTM!The diagram syntax is correct, and the notes effectively explain the message flow.
90-93: LGTM!The time passage representation in the diagram is clear and well-structured.
117-120: LGTM!The diagram effectively illustrates the message flow and execution process.
|
lgtm |
Co-authored-by: Blessing Krofegha <bkrofegha@gmail.com>
Co-authored-by: Blessing Krofegha <bkrofegha@gmail.com>
Co-authored-by: Blessing Krofegha <bkrofegha@gmail.com>
3 participants
Description
Explain that equivocation results in deposit-only transactions only if the destination block is written to L1 before the source block.
Tests
N/A
Additional context
N/A
Metadata
N/A