contracts: update standard version to v1.6.0, CGT to v2.0.0-beta.3 #895
Conversation
WalkthroughThe changes in this pull request update the recommended release versions for deploying Layer 1 (L1) smart contracts and custom gas tokens. The documentation now advises users to utilize the "Fault Proof Fixes release" version 1.6.0 instead of the previously recommended "Multi-Chain Prep (MCP) L1 release" version 1.3.0. Additionally, references to the custom gas token feature have been updated from version Changes
Possibly related issues
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
|
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Thanks for the update, with the fault proof rollout we're also suggesting a staggered approach at the moment. Starting permissioned gives chain operators some breathing room to learn how to run the new economics and infrastructure requirements in a safe environment. Switching to permissionless is just a configuration change away at that point.
bitwiseguy
changed the title
![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
Outside diff range and nitpick comments (2)
pages/builders/chain-operators/features/custom-gas-token.mdx (1)
21-21: Rephrase the sentence for better clarity.The version update to
v2.0.0-beta.3looks good.To improve clarity, consider rephrasing the sentence to start with a verb or insert a comma:
- * Checkout the [`v2.0.0-beta.3` of the contracts](https://github.com/ethereum-optimism/optimism/tree/op-contracts/v2.0.0-beta.3) and use the commit to deploy. + * Check out [`v2.0.0-beta.3` of the contracts](https://github.com/ethereum-optimism/optimism/tree/op-contracts/v2.0.0-beta.3), and use the commit to deploy.Tools
LanguageTool
[grammar] ~21-~21: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...> ### Deploying Your Contracts * Checkout the [v2.0.0-beta.3of the contracts](...(SENT_START_NN_DT)
pages/stack/smart-contracts.mdx (1)
40-40: Looks good! Just a minor suggestion.The change accurately updates the recommended contract release version for new production chains to
op-contracts/v1.6.0. This ensures that the documentation reflects the latest preferred version for deployment.To maintain consistency in communal documentation, consider using proper nouns like "Optimism" in place of personal pronouns like "we":
- Note: While these are a governance approved contract release, the recommended + Note: While these are a governance approved contract release, the recommended - release for new production chains is `op-contracts/v1.6.0`. + release for new production chains on Optimism is `op-contracts/v1.6.0`.
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (3)
- pages/builders/chain-operators/deploy/smart-contracts.mdx (1 hunks)
- pages/builders/chain-operators/features/custom-gas-token.mdx (2 hunks)
- pages/stack/smart-contracts.mdx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- pages/builders/chain-operators/deploy/smart-contracts.mdx
Additional context used
Path-based instructions (2)
pages/builders/chain-operators/features/custom-gas-token.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. Use bold for prominence instead of all caps or italics.
- 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).
"pages/stack/smart-contracts.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. Use bold for prominence instead of all caps or italics.
- 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).
"
LanguageTool
pages/builders/chain-operators/features/custom-gas-token.mdx
[grammar] ~21-~21: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...> ### Deploying Your Contracts * Checkout the [v2.0.0-beta.3of the contracts](...(SENT_START_NN_DT)
Additional comments not posted (1)
pages/builders/chain-operators/features/custom-gas-token.mdx (1)
50-50: LGTM!The version update to
v2.0.0-beta.3is accurate.
Description
The recommended monorepo contracts tag/release is now v1.6.0.
The recommended monorepo contracts tag for CustomGasToken is now v2.0.0-beta.3
Tests
No tests added. Just changed some text.