Update upgrade-op-contracts-1-3-1-8.mdx #1692
Merged
+4
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for upgrading OP contracts from version 1.3 to 1.8, specifically clarifying the configuration instructions for the deploy_config.json file.
- Updates guidance comments to clarify that default values should be used unless different values are expected
- Adds instruction to contact OP Labs support for clarification when non-default values are needed
Contributor
📝 WalkthroughWalkthroughThe documentation was updated to clarify instructions about adding configuration values during the upgrade of OP contracts. A new note was added after the Holocene upgrade overview, informing users that after upgrading to OP Stack contracts v1.8.0 with permissioned fault proofs enabled, all pending (unfinalized) withdrawal proofs on L1 become invalidated, requiring manual reproving of withdrawals. The guidance now instructs users to add the provided default values and to contact OP Labs support if they expect different values for their chain, instead of simply adding missing values and verifying correctness themselves. No changes were made to configuration keys, values, or code. 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx (2)
102-102: Refine phrasing & punctuation for readabilityThe sentence is a run-on and mixes lowercase with an imperative instruction. Consider splitting it and adding the missing comma after “chain” for clearer guidance.
- add the below default values, if you expect different values for your chain reach out to OP Labs support for clarification before proceeding + Add the following default values. If you expect different values for your chain, reach out to OP Labs support before proceeding.
113-113: Apply consistent imperative style here as wellSame stylistic issue as above—break the idea into two sentences and insert the comma after “chain”.
- add the below default values, if you expect different values for your chain reach out to OP Labs support for clarification before proceeding + Add the following default values. If you expect different values for your chain, reach out to OP Labs support before proceeding.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.mdx
Instructions used from:
Sources:
⚙️ CodeRabbit Configuration File
🧠 Learnings (2)
📓 Common learnings
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-06-10T19:38:04.907Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-10-13T07:16:50.980Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1525
File: pages/stack/interop/tutorials/upgrade-to-superchain-erc20.mdx:500-503
Timestamp: 2025-04-03T01:38:08.988Z
Learning: Private keys in the "Upgrading ERC20 to SuperchainERC20" tutorial document are test/demo keys intentionally included for educational purposes and do not represent security concerns.
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx (4)
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-06-10T19:38:04.907Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-10-13T07:16:50.980Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx (2)
104-111: Bullet wording & punctuation need polishPrevious feedback about the missing comma still applies. Additionally, capitalize the imperative verb and avoid personal pronouns for consistency with the style guide.
- - add the below default values, if you expect different values for your chain reach out to OP Labs support for clarification before proceeding + - Add the default values below. If different values are expected for the chain, contact OP Labs support for clarification before proceeding.
115-118: Duplicate issue: apply same fix to the second bulletMirror the wording update made above for consistency.
- - add the below default values, if you expect different values for your chain reach out to OP Labs support for clarification before proceeding + - Add the default values below. If different values are expected for the chain, contact OP Labs support for clarification before proceeding.
🧹 Nitpick comments (1)
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx (1)
30-31: Grammar and clarity: replace “reproven” & tighten wordingSmall wording tweak improves correctness and flow.
-After upgrading to OP Stack contracts v1.8.0 and enabling permissioned fault proofs, all pending (unfinalized) withdrawal proofs created on L1 are invalidated. This means that withdrawals must be manually reproven by users after the upgrade; the process is not automatic. +After upgrading to OP Stack contracts v1.8.0 and enabling permissioned fault proofs, all pending (unfinalized) withdrawal proofs on L1 become invalid. Users must manually re-prove these withdrawals after the upgrade; the reproving process is not automatic.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.mdx
Instructions used from:
Sources:
⚙️ CodeRabbit Configuration File
🧠 Learnings (2)
📓 Common learnings
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-06-10T19:38:04.907Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-10-13T07:16:50.980Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1525
File: pages/stack/interop/tutorials/upgrade-to-superchain-erc20.mdx:500-503
Timestamp: 2025-04-03T01:38:08.988Z
Learning: Private keys in the "Upgrading ERC20 to SuperchainERC20" tutorial document are test/demo keys intentionally included for educational purposes and do not represent security concerns.
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx (3)
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
🪛 LanguageTool
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx
[grammar] ~30-~30: Ensure spelling is correct
Context: ...means that withdrawals must be manually reproven by users after the upgrade; the process...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
krofax
approved these changes
Jul 16, 2025
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx (1)
104-115: Comment lines inside ajsonblock break JSON validity & need punctuation fixesThe bullet comments (
- …) placed inside the ```json code fence render the example invalid JSON and will trip up users who copy-paste the snippet.
At the same time, both comment lines are run-on sentences lacking the Oxford comma and proper capitalization.Proposed fix:
- - add the below default values, if you expect different values for your chain reach out to OP Labs support for clarification before proceeding + // Add the following default values. If you expect different values for your chain, contact OP Labs support for clarification before proceeding. ... - - add the below default values, if you expect different values for your chain, reach out to OP Labs support for clarification before proceeding + // Add the following default values. If you expect different values for your chain, contact OP Labs support for clarification before proceeding.• Switch to a
//comment (widely accepted in doc snippets) or move the guidance outside the fenced block.
• Start with “Add”, use “following”, capitalize “OP Labs”, and split into two sentences for readability.
• Removes duplicated trailing spaces.Failure to address this will cause syntax errors for users and lower trust in the docs.
🧹 Nitpick comments (1)
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx (1)
30-30: Refine sentence structure and verb choice for clarity“Manually reproven” is uncommon and the semicolon makes the sentence feel heavy. Consider the more readable variant below:
-After upgrading to OP Stack contracts v1.8.0 and enabling permissioned fault proofs, all pending (unfinalized) withdrawal proofs created on L1 are invalidated. This means that withdrawals must be manually reproven by users after the upgrade; the process is not automatic. +After upgrading to OP Stack contracts v1.8.0 with permissioned fault proofs enabled, all pending (unfinalized) withdrawal proofs created on L1 become invalid. Users must manually re-prove their withdrawals after the upgrade; this process is not automatic.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.mdx
Instructions used from:
Sources:
⚙️ CodeRabbit Configuration File
🧠 Learnings (2)
📓 Common learnings
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-06-10T19:38:04.907Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-10-13T07:16:50.980Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1525
File: pages/stack/interop/tutorials/upgrade-to-superchain-erc20.mdx:500-503
Timestamp: 2025-04-03T01:38:08.988Z
Learning: Private keys in the "Upgrading ERC20 to SuperchainERC20" tutorial document are test/demo keys intentionally included for educational purposes and do not represent security concerns.
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx (4)
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1216
File: pages/stack/interop/security.mdx:136-144
Timestamp: 2025-01-08T11:04:45.361Z
Learning: In the ethereum-optimism/docs repository, sections that are commented out in documentation files are intentionally excluded due to accuracy concerns and should not be suggested for inclusion until the information becomes accurate.
Learnt from: smartcontracts
PR: ethereum-optimism/docs#241
File: public/tutorials/standard-bridge-standard-token.sh:3-6
Timestamp: 2024-06-10T19:38:04.907Z
Learning: User `smartcontracts` has requested that `.mdx` files always be reviewed according to the instructions in the `.yaml` configuration file. This preference should be remembered for future interactions.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
🪛 LanguageTool
pages/stack/smart-contracts/upgrade-op-contracts-1-3-1-8.mdx
[grammar] ~30-~30: Ensure spelling is correct.
Context: ...means that withdrawals must be manually reproven by users after the upgrade; the process...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_000051)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Minor fix on the deploy_config.json for the 1.3 to 1.8 upgrade