docs icon indicating copy to clipboard operation
docs copied to clipboard

Draft U16 notice page

Open bradleycamacho opened this issue 6 months ago • 1 comments
trafficstars

bradleycamacho avatar May 20 '25 16:05 bradleycamacho

Deploy Preview for docs-optimism ready!

Name Link
Latest commit c20409647c234893e77f2cb15187147cbd8d73b3
Latest deploy log https://app.netlify.com/projects/docs-optimism/deploys/684091d4e5fd620008ae0783
Deploy Preview https://deploy-preview-1618--docs-optimism.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar May 20 '25 16:05 netlify[bot]

📝 Walkthrough

Walkthrough

A 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

  • ethereum-optimism/docs#1491: Adds a notice page for Upgrade 15 with similar structure and metadata updates in the notices directory, related by purpose and content type.
  • ethereum-optimism/docs#1522: Adds an Upgrade 16 notice with withdrawal reproving instructions, conceptually related to Upgrade 13 notice updates involving withdrawal reproving and upgrade warnings.
  • ethereum-optimism/docs#1444: Documents op-contracts v1.8.0 release with contract version updates including SystemConfig and OptimismPortal, related to the Upgrade 16 contract changes and versioning.

Suggested reviewers

  • bradleycamacho

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 04 '25 18:06 coderabbitai[bot]