Draft U16 notice page #1618
Draft U16 notice page #1618
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new upgrade notice for "Upgrade 16" has been introduced, describing protocol changes for the OP Stack, including interoperability-ready smart contracts, updates to core contracts, and operational instructions for chain operators, users, and bridges. The notice details technical updates such as contract modifications, increased gas limits, and security reviews. The metadata for this notice was added to the notices JSON file. The word list was updated by removing "custom-bridge," adding "extensibly," and reordering "Devnets" and "devnet." Sequence Diagram(s)sequenceDiagram
participant User
participant Bridge
participant ChainOperator
participant OPStackContracts
participant DisputeGameFactory
User->>Bridge: Initiate withdrawal
Bridge->>OPStackContracts: Submit withdrawal transaction
Note over OPStackContracts: Before Upgrade 16<br/>Withdrawal proofs are valid
ChainOperator->>OPStackContracts: Activate Upgrade 16
Note over OPStackContracts: All existing withdrawal proofs invalidated
User->>Bridge: Attempt to finalize withdrawal
Bridge->>OPStackContracts: Re-prove withdrawal (if not finalized before upgrade)
OPStackContracts->>DisputeGameFactory: Use new proveWithdrawalTransaction variant
DisputeGameFactory-->>OPStackContracts: Confirm or dispute withdrawal
Possibly related PRs
Suggested reviewers
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
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: 2
🧹 Nitpick comments (6)
pages/notices/_meta.json (1)
2-2: Meta description style inconsistency.Other upgrade entries use a colon and Title Case (e.g.,
"Upgrade 15: Isthmus Hard Fork"). Consider updating this line to:- "upgrade-16": "Upgrade 16 - Preparing for Interop protocol upgrade", + "upgrade-16": "Upgrade 16: Preparing for Interop Protocol Upgrade",pages/notices/upgrade-16.mdx (5)
37-37: Replace “prior to” with “before” for conciseness.- finalize withdrawals prior to the activation + finalize withdrawals before activation🧰 Tools
🪛 LanguageTool
[style] ~37-~37: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...drawals can either finalize withdrawals prior to the activation of Upgrade 16 or will be...(EN_WORDINESS_PREMIUM_PRIOR_TO)
39-39: Add missing comma after introductory clause.- Depending on the current state of the chain the execution times will vary. + Depending on the current state of the chain, the execution times will vary.🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: A comma might be missing here.
Context: .... Depending on the current state of the chain the execution times will vary. If your ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
102-102: Replace “prior to” with “before” for clarity.- validate that the expected output prior to executing the transaction. + validate that the expected output before executing the transaction.🧰 Tools
🪛 LanguageTool
[style] ~102-~102: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...e and validate that the expected output prior to executing the transaction. ##...(EN_WORDINESS_PREMIUM_PRIOR_TO)
2-2: Unify title punctuation.The frontmatter title uses a hyphen, while the H1 uses a colon. Consider making both consistent:
--- - title: Upgrade 16 - Protocol upgrade + title: Upgrade 16: Protocol upgrade --- # Upgrade 16: Protocol upgradeAlso applies to: 19-19
14-14: Use a boolean foris_imported_content.Frontmatter boolean fields should not be quoted:
- is_imported_content: 'false' + is_imported_content: false
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
pages/notices/_meta.json(1 hunks)pages/notices/upgrade-16.mdx(1 hunks)words.txt(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- 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.
"
pages/notices/upgrade-16.mdx
🪛 LanguageTool
words.txt
[duplication] ~128-~128: Možný preklep: zopakovali ste slovo
Context: ...XITWHENSYNCED exitwhensynced extensibly EXTRADATA extradata Farcaster Faultproof FDLIMIT fdlimit Fl...
(WORD_REPEAT_RULE)
pages/notices/upgrade-16.mdx
[style] ~37-~37: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...drawals can either finalize withdrawals prior to the activation of Upgrade 16 or will be...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~39-~39: A comma might be missing here.
Context: .... Depending on the current state of the chain the execution times will vary. If your ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~56-~56: The verb ‘prestate’ is plural. Did you mean: “prestates”? Did you use a verb instead of a noun?
Context: ...Metal You can verify this absolute prestate by running the following [command](http...
(PLURAL_VERB_AFTER_THIS)
[style] ~102-~102: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...e and validate that the expected output prior to executing the transaction. ##...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
⏰ 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 (2)
words.txt (2)
95-98: Alphabetical ordering of term entries is consistent.The uppercase and lowercase variants for “Devnet”/“devnet” and “Devnets”/“devnets” now follow the established uppercase-lowercase pair order and proper alphabetical sequence.
🧰 Tools
🪛 LanguageTool
[duplication] ~96-~96: Možný preklep: zopakovali ste slovo
Context: ...p DATADIR datadir devdocs Devnet devnet Devnets devnets direnv DISABLETXPOOLGOSSIP disabletxpoo...(WORD_REPEAT_RULE)
128-128: New term inserted in correct alphabetical position.The word “extensibly” has been added after “exitwhensynced” and before “extradata,” maintaining the sorted order.
🧰 Tools
🪛 LanguageTool
[duplication] ~128-~128: Možný preklep: zopakovali ste slovo
Context: ...XITWHENSYNCED exitwhensynced extensibly EXTRADATA extradata Farcaster Faultproof FDLIMIT fdlimit Fl...(WORD_REPEAT_RULE)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
pages/notices/upgrade-16.mdx (2)
7-9: Include ‘user’ in the personas array
The notice also addresses end-users, so add- useralongside- chain-operator.
35-35: Refine upgrade description for grammar and tone
- Use singular “smart contract upgrade” instead of “smart contracts upgrade.”
- Remove the personal pronoun “We”; use passive voice.
Apply this diff:- Upgrade 16 is an L1 smart contracts upgrade for the OP Stack. We do not expect any downtime or changes in performance. + Upgrade 16 is an L1 smart contract upgrade for the OP Stack. No downtime or performance changes are expected.
🧹 Nitpick comments (6)
pages/notices/upgrade-16.mdx (6)
19-19: Apply sentence case to the H1 header
Only the first word should be capitalized (except proper nouns). Change# Upgrade 16: Protocol upgradeto# Upgrade 16: protocol upgrade.
37-37: Replace ‘prior to’ with ‘before’
‘Prior to’ is wordy—use ‘before’ for clarity.- finalize withdrawals prior to the activation of Upgrade 16 + finalize withdrawals before the activation of Upgrade 16🧰 Tools
🪛 LanguageTool
[style] ~37-~37: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...drawals can either finalize withdrawals prior to the activation of Upgrade 16 or will be...(EN_WORDINESS_PREMIUM_PRIOR_TO)
39-39: Fix comma placement and trailing space in the chain list
Add a comma after “chain,” and remove the extra space inside the backticks aroundMetal.- ...both Mainnet and Sepolia. Depending on the current state of the chain the execution times will vary. If your Optimism governed chain is not in this list, please reach out to OP Labs Solutions Engineering... + ...both Mainnet and Sepolia. Depending on the current state of the chain, the execution times will vary. If your Optimism-governed chain is not in this list, please reach out to OP Labs Solutions Engineering... - `...`, `World Chain`, and `Metal ` + `...`, `World Chain`, and `Metal`🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: A comma might be missing here.
Context: .... Depending on the current state of the chain the execution times will vary. If your ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
41-41: Hyphenate compound adjectives
Use hyphens for clarity:- ### For permissionless fault proof enabled chains + ### For permissionless-fault-proof-enabled chains
49-49: Hyphenate numeric compound modifier
Change “64 bit” to “64-bit” in the callout:- As of upgrade 14, the 64 bit multi-threaded version of cannon is utilized. + As of upgrade 14, the 64-bit multi-threaded version of Cannon is utilized.
101-101: Replace ‘prior to’ with ‘before’ in step instruction
Use ‘before’ for conciseness in the step description.- simulate and validate that the expected output prior to executing the transaction. + simulate and validate that the expected output before executing the transaction.🧰 Tools
🪛 LanguageTool
[style] ~101-~101: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...e and validate that the expected output prior to executing the transaction. ##...(EN_WORDINESS_PREMIUM_PRIOR_TO)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/notices/upgrade-16.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- 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.
"
pages/notices/upgrade-16.mdx
🪛 LanguageTool
pages/notices/upgrade-16.mdx
[style] ~37-~37: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...drawals can either finalize withdrawals prior to the activation of Upgrade 16 or will be...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~39-~39: A comma might be missing here.
Context: .... Depending on the current state of the chain the execution times will vary. If your ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~56-~56: The verb ‘prestate’ is plural. Did you mean: “prestates”? Did you use a verb instead of a noun?
Context: ...Metal You can verify this absolute prestate by running the following [command](http...
(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~87-~87: Possible missing comma found.
Context: ... have the absolute prestate hash as the filename so it looks like PRESTATEHASH.bin.gz....
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~101-~101: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...e and validate that the expected output prior to executing the transaction. ##...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
pages/notices/upgrade-16.mdx (5)
19-19: Use sentence case for H1 heading
According to style guidelines, only the first word should be capitalized. Change to:# Upgrade 16: protocol upgrade
35-35: Refine pronoun usage and correct pluralization
Replace “smart contracts” with “smart contract” and avoid the pronoun “We.” For example:Upgrade 16 is an L1 smart contract upgrade for the OP Stack. No downtime or performance changes are expected.
37-37: Replace “prior to” with “before”
To improve readability, use “before”:- finalize withdrawals prior to the activation + finalize withdrawals before activation🧰 Tools
🪛 LanguageTool
[style] ~37-~37: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...drawals can either finalize withdrawals prior to the activation of Upgrade 16 or will be...(EN_WORDINESS_PREMIUM_PRIOR_TO)
39-39: Fix punctuation and remove trailing space
Add a comma after “chain” and remove the extra space after “Metal”:- ... on both Mainnet and Sepolia. Depending on the current state of the chain the execution times will vary. + ... on both Mainnet and Sepolia. Depending on the current state of the chain, the execution times will vary.Ensure the ticked name is
Metal(no trailing space).🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: A comma might be missing here.
Context: .... Depending on the current state of the chain the execution times will vary. If your ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
103-103: Use “before” instead of “prior to” in instructions
To streamline the wording:- validate that the expected output prior to executing the transaction. + validate that the expected output before executing the transaction.🧰 Tools
🪛 LanguageTool
[style] ~103-~103: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...e and validate that the expected output prior to executing the transaction. ##...(EN_WORDINESS_PREMIUM_PRIOR_TO)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/notices/upgrade-16.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- 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.
"
pages/notices/upgrade-16.mdx
🪛 LanguageTool
pages/notices/upgrade-16.mdx
[style] ~37-~37: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...drawals can either finalize withdrawals prior to the activation of Upgrade 16 or will be...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~39-~39: A comma might be missing here.
Context: .... Depending on the current state of the chain the execution times will vary. If your ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~58-~58: The verb ‘prestate’ is plural. Did you mean: “prestates”? Did you use a verb instead of a noun?
Context: ...Metal You can verify this absolute prestate by running the following [command](http...
(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~89-~89: Possible missing comma found.
Context: ... have the absolute prestate hash as the filename so it looks like PRESTATEHASH.bin.gz....
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~103-~103: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...e and validate that the expected output prior to executing the transaction. ##...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
No description provided.