U16 contract upgrades #1661
U16 contract upgrades #1661
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe changes update the Upgrade 16 notice documentation. The description of the "Interop-Ready smart contracts" feature is clarified to state that interoperability is not activated by this upgrade, but all necessary smart contract changes are included for future support. A new "Implementation" section is added under the chain operators instructions, specifying that the upgrade uses OP Contracts Manager (OPCM) version 4.0.0, linking to the OPCM source code release and providing the deployment address from the superchain-registry. No changes were made to exported or public entity declarations. 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: 1
🧹 Nitpick comments (2)
pages/notices/upgrade-16.mdx (2)
27-27: Refine wording for conciseness
Consider removing “of” to make the sentence more concise (“includes all the smart contract changes” rather than “includes all of the smart contract changes”).🧰 Tools
🪛 LanguageTool
[style] ~27-~27: Consider removing “of” to be more concise
Context: ...6 does not turn interop on, it includes all of the smart contract changes required to supp...(ALL_OF_THE)
50-52: Improve link text and punctuation
- Use title case for link text (e.g., “Release op-contracts/v3.0.0-rc.2”).
- Remove the colon inside the bracket for the superchain-registry link and place it after the link for correct punctuation.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/notices/upgrade-16.mdx(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
pages/notices/upgrade-16.mdx
[style] ~27-~27: Consider removing “of” to be more concise
Context: ...6 does not turn interop on, it includes all of the smart contract changes required to supp...
(ALL_OF_THE)
[uncategorized] ~46-~46: 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)
⏰ 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 (1)
pages/notices/upgrade-16.mdx (1)
44-44: Header formatting is correct
The “Implementation” header follows sentence-case conventions for H3.
pages/notices/upgrade-16.mdx
Outdated
| If this proposal is accepted, multisig ceremonies will be coordinated to execute upgrade transactions. The following transactions will be executed on the respective chains: `OP`, `Soneium`, `Ink`, `Base`, `Unichain`, `Mode`, `Zora`, `Arena Z`, `Swell`, `World Chain`, and `Metal ` on 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 to coordinate your upgrade. These upgrade tasks will be prepared in the [superchain-ops repo](https://github.com/ethereum-optimism/superchain-ops/tree/main/src/improvements/tasks). | ||
|
|
||
| The upgrade will be executed using OP Contracts Manager (OPCM) version 4.0.0 | ||
|
|
||
| * The OPCM source code for this release is available at [release op-contracts/v3.0.0-rc.2](https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv3.0.0-rc.2) |
There was a problem hiding this comment.
This will actually be v4 and the registry hasn't been updated yet
There was a problem hiding this comment.
This was supposed to be a comment on line 51 and it looks like it was pinned to an old commit, the latest on develop has more recent releases: https://github.com/ethereum-optimism/superchain-registry/blob/main/validation/standard/standard-versions-mainnet.toml
There was a problem hiding this comment.
Pushed up some fixes; looks like v4 was updated on main + found here https://github.com/ethereum-optimism/optimism/releases/tag/op-contracts%2Fv4.0.0-rc.7
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
pages/notices/upgrade-16.mdx (1)
48-51: Mismatch between OPCM version and link target
The text referencesop-contracts/v4.0.0but the link below points tov4.0.0-rc.7. Please confirm the intended OPCM release and align both the text and link.🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Possible missing comma found.
Context: ...ng a newly deployed OP Contracts Manger instance which brings these OP Stack chains to o...(AI_HYDRA_LEO_MISSING_COMMA)
🧹 Nitpick comments (3)
pages/notices/upgrade-16.mdx (3)
27-27: Conciseness: remove "of"
Consider changing "includes all of the smart contract changes required" to "includes all the smart contract changes required" to improve readability.🧰 Tools
🪛 LanguageTool
[style] ~27-~27: Consider removing “of” to be more concise
Context: ...6 does not turn interop on, it includes all of the smart contract changes required to supp...(ALL_OF_THE)
46-46: Add missing comma after introductory clause
Insert a comma after "chain" in "Depending on the current state of the chain, the execution times will vary."🧰 Tools
🪛 LanguageTool
[uncategorized] ~46-~46: 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)
51-51: Remove unnecessary colon in link text
Adjust the bracketed text in the bullet to remove the trailing colon for smoother reading:- This deployment address for this OPCM is [available in the superchain-registry:](...) + This deployment address for this OPCM is [available in the superchain-registry](...)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/notices/upgrade-16.mdx(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
pages/notices/upgrade-16.mdx
[style] ~27-~27: Consider removing “of” to be more concise
Context: ...6 does not turn interop on, it includes all of the smart contract changes required to supp...
(ALL_OF_THE)
[uncategorized] ~46-~46: 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)
[uncategorized] ~48-~48: Possible missing comma found.
Context: ...ng a newly deployed OP Contracts Manger instance which brings these OP Stack chains to o...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: pr-workflow
🔇 Additional comments (1)
pages/notices/upgrade-16.mdx (1)
1-15: Frontmatter validation passed
All required metadata fields (title, lang, description, topic, personas, categories, content_type) are present and non-empty.
| If this proposal is accepted, multisig ceremonies will be coordinated to execute upgrade transactions. The following transactions will be executed on the respective chains: `OP`, `Soneium`, `Ink`, `Base`, `Unichain`, `Mode`, `Zora`, `Arena Z`, `Swell`, `World Chain`, and `Metal ` on 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 to coordinate your upgrade. These upgrade tasks will be prepared in the [superchain-ops repo](https://github.com/ethereum-optimism/superchain-ops/tree/main/src/improvements/tasks). | ||
|
|
||
| This upgrade will be executed using a newly deployed OP Contracts Manger instance which brings these OP Stack chains to op-contracts/v4.0.0. |
There was a problem hiding this comment.
Typo in "Manger"
Correct "OP Contracts Manger" to "OP Contracts Manager" and add a comma for clarity:
- This upgrade will be executed using a newly deployed OP Contracts Manger instance which brings these OP Stack chains to op-contracts/v4.0.0.
+ This upgrade will be executed using a newly deployed OP Contracts Manager instance, which brings these OP Stack chains to op-contracts/v4.0.0.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| This upgrade will be executed using a newly deployed OP Contracts Manger instance which brings these OP Stack chains to op-contracts/v4.0.0. | |
| This upgrade will be executed using a newly deployed OP Contracts Manager instance, which brings these OP Stack chains to op-contracts/v4.0.0. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Possible missing comma found.
Context: ...ng a newly deployed OP Contracts Manger instance which brings these OP Stack chains to o...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In pages/notices/upgrade-16.mdx at line 48, correct the typo "OP Contracts
Manger" to "OP Contracts Manager" and add a comma after "instance" to improve
clarity in the sentence.
Adds OPCM info for U16