adding block time research #1034
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request includes several changes primarily focused on documentation and metadata updates. Notably, a comment in Changes
Possibly related PRs
Suggested labels
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
|
Co-authored-by: Bradley Camacho <[email protected]>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (1)
pages/stack/research/block-time-research.mdx (1)
25-25: Standardize figure caption formatting.Ensure consistent formatting across all figure captions.
Apply this formatting to all captions:
-**Figure 4:** op-geth / archive node / block 13686867 \~ 15074141 +**Figure 4**: op-geth / archive node / block 13686867 \~ 15074141Also applies to: 29-29, 35-35, 41-41, 45-45, 51-51
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
⛔ Files ignored due to path filters (7)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yamlpublic/img/op-stack/protocol/block-time-research-figure-1.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-2.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-3.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-4.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-5.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-6.pngis excluded by!**/*.png
📒 Files selected for processing (12)
- next-env.d.ts (1 hunks)
- pages/stack/_meta.json (1 hunks)
- pages/stack/operators.mdx (0 hunks)
- pages/stack/operators/features.mdx (0 hunks)
- pages/stack/protocol.mdx (0 hunks)
- pages/stack/protocol/fault-proofs.mdx (0 hunks)
- pages/stack/protocol/features.mdx (0 hunks)
- pages/stack/protocol/interop.mdx (0 hunks)
- pages/stack/protocol/rollup.mdx (0 hunks)
- pages/stack/research/_meta.json (1 hunks)
- pages/stack/research/block-time-research.mdx (1 hunks)
- words.txt (9 hunks)
💤 Files with no reviewable changes (7)
- pages/stack/operators.mdx
- pages/stack/operators/features.mdx
- pages/stack/protocol.mdx
- pages/stack/protocol/fault-proofs.mdx
- pages/stack/protocol/features.mdx
- pages/stack/protocol/interop.mdx
- pages/stack/protocol/rollup.mdx
✅ Files skipped from review due to trivial changes (2)
- next-env.d.ts
- pages/stack/research/_meta.json
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/research/block-time-research.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 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🪛 LanguageTool
pages/stack/research/block-time-research.mdx
[uncategorized] ~55-~55: The preposition ‘of’ seems more likely in this position.
Context: ... took less than one second in the block on time and include outliers in the next b...(AI_HYDRA_LEO_REPLACE_ON_OF)
words.txt
[uncategorized] ~356-~356: Hier werden zwei Wörter wiederholt. Meinten Sie „SUPERCHAIN Superchain“?
Context: ...nents subgame subheaders SUBU Sunnyside SUPERCHAIN Superchain superchain Superchain's Superchains Superscan Supersim supers...(DE_PHRASE_REPETITION)
🔇 Additional comments (4)
pages/stack/research/block-time-research.mdx (4)
1-6: LGTM: Metadata section is well-structured.The metadata section follows proper formatting with appropriate title case, tags, and description.
14-19: LGTM: Method and raw data section is well-referenced.The section provides clear links to the research methodology and raw data.
59-69: LGTM: Impact analysis is comprehensive.The section clearly outlines the expected impacts on both verifiers and sequencers.
70-80: LGTM: Limitations and references are well-documented.The section provides a thorough analysis of limitations and includes relevant references.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (4)
words.txt (4)
69-69: Ensure consistent capitalization format.Consider adding both capitalized and lowercase variants of "Crosschain" to match the pattern used for other terms in the file (e.g., like "Superchain"/"superchain").
Crosschain +crosschain
200-200: Add plural form for completeness.Consider adding the plural form "mitigations" to maintain consistency with other terms that have both singular and plural forms.
Mitigations +mitigations
294-295: Consider adding lowercase variant.For consistency with other entries, consider adding the lowercase variant of "Pyth".
Pyth Pyth's +pyth
356-356: Consider adding variants for completeness.Consider adding possessive and lowercase variants of "Sunnyside" for consistency, especially since it's a key term related to the block time research being added.
Sunnyside +Sunnyside's +sunnyside🧰 Tools
🪛 LanguageTool
[uncategorized] ~356-~356: Hier werden zwei Wörter wiederholt. Meinten Sie „SUPERCHAIN Superchain“?
Context: ...nents subgame subheaders SUBU Sunnyside SUPERCHAIN Superchain superchain Superchain's Superchains Superscan Supersim supers...(DE_PHRASE_REPETITION)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
⛔ Files ignored due to path filters (7)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yamlpublic/img/op-stack/protocol/block-time-research-figure-1.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-2.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-3.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-4.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-5.pngis excluded by!**/*.pngpublic/img/op-stack/protocol/block-time-research-figure-6.pngis excluded by!**/*.png
📒 Files selected for processing (12)
- next-env.d.ts (1 hunks)
- pages/stack/_meta.json (1 hunks)
- pages/stack/operators.mdx (0 hunks)
- pages/stack/operators/features.mdx (0 hunks)
- pages/stack/protocol.mdx (0 hunks)
- pages/stack/protocol/fault-proofs.mdx (0 hunks)
- pages/stack/protocol/features.mdx (0 hunks)
- pages/stack/protocol/interop.mdx (0 hunks)
- pages/stack/protocol/rollup.mdx (0 hunks)
- pages/stack/research/_meta.json (1 hunks)
- pages/stack/research/block-time-research.mdx (1 hunks)
- words.txt (9 hunks)
💤 Files with no reviewable changes (7)
- pages/stack/operators.mdx
- pages/stack/operators/features.mdx
- pages/stack/protocol.mdx
- pages/stack/protocol/fault-proofs.mdx
- pages/stack/protocol/features.mdx
- pages/stack/protocol/interop.mdx
- pages/stack/protocol/rollup.mdx
✅ Files skipped from review due to trivial changes (2)
- next-env.d.ts
- pages/stack/research/_meta.json
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/research/block-time-research.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 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🪛 GitHub Check: lint
pages/stack/research/block-time-research.mdx
[warning] 22-22:
Missing final pipe in table fence
[warning] 24-24:
Misaligned table fence
[warning] 26-26:
Cell should be padded with 1 space, not 2
[warning] 26-26:
Missing final pipe in table fence
[warning] 28-28:
Misaligned table fence
[warning] 32-32:
Cell should be padded with 1 space, not 2
[warning] 32-32:
Missing final pipe in table fence
[warning] 34-34:
Misaligned table fence
[warning] 38-38:
Cell should be padded with 1 space, not 2
[warning] 38-38:
Missing final pipe in table fence
🪛 LanguageTool
words.txt
[uncategorized] ~356-~356: Hier werden zwei Wörter wiederholt. Meinten Sie „SUPERCHAIN Superchain“?
Context: ...nents subgame subheaders SUBU Sunnyside SUPERCHAIN Superchain superchain Superchain's Superchains Superscan Supersim supers...(DE_PHRASE_REPETITION)
🔇 Additional comments (8)
pages/stack/_meta.json (1)
19-20: LGTM! The metadata structure is well-organized.The addition of the "research" section follows the established conventions and provides a logical location for the block time research documentation.
words.txt (2)
328-330: LGTM! Complete entry set.The Sepolia entries are well-structured with all necessary variants (uppercase, title case, and lowercase).
Line range hint
1-403: Verify removal of 'Proxyd' term.The removal of 'Proxyd' should be verified as it might still be referenced in the documentation.
🧰 Tools
🪛 LanguageTool
[style] ~291-~291: Möchten Sie die modernere Schreibweise „proxid“ verwenden?
Context: ...uctionize productionized Protip Proxied proxyd pseudorandomly Pyth Pyth's QRNG Quickno...(I_ANSTATT_Y)
[duplication] ~293-~293: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...ed Protip Proxied proxyd pseudorandomly Pyth Pyth's QRNG Quicknode quicknode quickstarts ...(GERMAN_WORD_REPEAT_RULE)
[duplication] ~296-~296: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ... proxyd pseudorandomly Pyth Pyth's QRNG Quicknode quicknode quickstarts RANDAO Regenesis regenesis ...(GERMAN_WORD_REPEAT_RULE)
pages/stack/research/block-time-research.mdx (5)
1-6: LGTM! Frontmatter metadata is well-structured.The metadata provides appropriate tags and a clear description.
14-19: LGTM! Method section is clear and well-referenced.The section provides appropriate links to the test methods and data.
58-68: LGTM! Impact analysis is comprehensive and well-structured.The section clearly outlines the effects on verifiers and sequencers.
69-79: LGTM! Limitations and references are well-documented.The section provides clear analysis of potential challenges and includes relevant references.
22-50:⚠️ Potential issueStandardize table formatting for figure captions.
The table formatting for figure captions needs to be consistent with Markdown standards.
Following the established format from previous reviews, apply consistent formatting to all figure captions. Ensure:
- One space padding in cells
- Proper table fence alignment
- Final pipe in table fence
🧰 Tools
🪛 GitHub Check: lint
[warning] 22-22:
Missing final pipe in table fence
[warning] 24-24:
Misaligned table fence
[warning] 26-26:
Cell should be padded with 1 space, not 2
[warning] 26-26:
Missing final pipe in table fence
[warning] 28-28:
Misaligned table fence
[warning] 32-32:
Cell should be padded with 1 space, not 2
[warning] 32-32:
Missing final pipe in table fence
[warning] 34-34:
Misaligned table fence
[warning] 38-38:
Cell should be padded with 1 space, not 2
[warning] 38-38:
Missing final pipe in table fence
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
- pages/stack/research/block-time-research.mdx (1 hunks)
- words.txt (4 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/research/block-time-research.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 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🪛 LanguageTool
pages/stack/research/block-time-research.mdx
[uncategorized] ~54-~54: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...he block after the block time, it stops to include the transactions and yields the current...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~54-~54: The preposition ‘of’ seems more likely in this position.
Context: ... took less than one second in the block on time and include outliers in the next b...(AI_HYDRA_LEO_REPLACE_ON_OF)
words.txt
[uncategorized] ~348-~348: Hier werden zwei Wörter wiederholt. Meinten Sie „SUPERCHAIN Superchain“?
Context: ...nents subgame subheaders SUBU Sunnyside SUPERCHAIN Superchain superchain Superchain's Superchains Superscan Supersim supers...(DE_PHRASE_REPETITION)
🔇 Additional comments (5)
words.txt (2)
68-68: LGTM! New terms are valid and correctly placed.The additions of "Crosschain", "Sunnyside", and "xlarge" are appropriate and properly alphabetized in the word list.
Also applies to: 348-348, 392-392
303-303: Verify spelling: "replayor"This appears to be a misspelling of "replayer". Please verify if this is intentional or if it should be corrected.
pages/stack/research/block-time-research.mdx (3)
1-6: LGTM: Metadata is well-structured and complete.The metadata section follows documentation guidelines with appropriate tags and description.
10-12: Skip duplicate comment about personal pronouns.A previous review has already addressed the use of personal pronouns in this section.
58-68: LGTM: Impact analysis is clear and technically accurate.The section effectively outlines the implications for both verifiers and sequencers.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
words.txt (1)
356-356: Remove duplicate dictionary entries.There are multiple variations of "Superchain" that appear redundant:
- "SUPERCHAIN"
- "Superchain"
- "superchain"
Consider keeping only the necessary variations to maintain a cleaner dictionary.
Also applies to: 357-359
🧰 Tools
🪛 LanguageTool
[uncategorized] ~356-~356: Hier werden zwei Wörter wiederholt. Meinten Sie „SUPERCHAIN Superchain“?
Context: ...nents subgame subheaders SUBU Sunnyside SUPERCHAIN Superchain superchain Superchain's Superchains Superscan Supersim supers...(DE_PHRASE_REPETITION)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- words.txt (9 hunks)
🧰 Additional context used
🪛 LanguageTool
words.txt
[uncategorized] ~356-~356: Hier werden zwei Wörter wiederholt. Meinten Sie „SUPERCHAIN Superchain“?
Context: ...nents subgame subheaders SUBU Sunnyside SUPERCHAIN Superchain superchain Superchain's Superchains Superscan Supersim supers...(DE_PHRASE_REPETITION)
🔇 Additional comments (1)
words.txt (1)
14-14: LGTM on new dictionary entries.The following new entries are valid and relevant to the blockchain/documentation context:
- Ankr (infrastructure provider)
- Crosschain (cross-blockchain concept)
- Immunefi (security platform)
- Mitigations (technical term)
- Pyth (oracle network)
- SEPOLIA (Ethereum testnet)
- Sunnyside (research contributor)
- voxel (graphics term)
Also applies to: 69-69, 151-151, 200-200, 294-294, 328-328, 356-356, 398-398
Description
Adding Sunnyside's block time research into the docs site: https://docs.google.com/document/d/13dc1x9Vwc4BOq2M1Z-VNKb7w1xFHEEeeKyZ2nX8YnF4/edit?usp=sharing