Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Join in-tandem upgrades as one entry in /history; add naming explainer #12411

Merged
merged 9 commits into from
Mar 13, 2024

Conversation

wackerow
Copy link
Member

@wackerow wackerow commented Mar 9, 2024

Description

  • Update history page to join together upgrades that occur in-tandem (ie Shanghai-Capella, and Cancun-Deneb) and display short name for each (ie. "Shapella" and "Dencun")
  • Adds ExpandableCard with explanation of naming conventions used for upgrades

Related Issue

Dencun updates

Preview link

Summary by CodeRabbit

  • New Features
    • Introduced a new naming convention for Ethereum network upgrades, combining locations and celestial stars (e.g., "Shapella" for Shanghai-Capella).
  • Documentation
    • Updated the history and translations sections to reflect the renaming of the "Shanghai" upgrade to "Shapella" and provided related summaries and references.
  • Refactor
    • Updated variable and data value assignments in line with the new naming convention for network upgrades, including changes from "cancun" to "dencun" and "shanghai" to "shapella".

Copy link
Contributor

coderabbitai bot commented Mar 9, 2024

Walkthrough

The recent updates involve renaming network upgrades to align with a new naming convention based on Devcon locations and celestial stars. The "Shanghai" upgrade is now known as "Shanghai-Capella" or "Shapella", while the "Cancun" upgrade has been updated to "Dencun" across various files. These changes aim to streamline the upgrade naming process and align with post-"The Merge" execution and consensus upgrades.

Changes

Files Change Summary
public/content/history/index.md,
.../translations/*/history/index.md
Renamed "Shanghai" to "Shanghai-Capella" ("Shapella") and introduced a new naming convention for upgrades.
src/components/DencunBanner.tsx Updated variable assignment from cancun to dencun.
src/data/NetworkUpgradeSummaryData.ts Renamed network upgrades (cancun to dencun, removed deneb, shanghai to shapella), updated associated data values.

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?

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>.
    • Generate unit-tests for this file.
    • 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 generate unit tests for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added content 🖋️ This involves copy additions or edits review needed 👀 labels Mar 9, 2024
Copy link

netlify bot commented Mar 9, 2024

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit 0285c40
🔍 Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/65f14ec5292b8a0008e03334
😎 Deploy Preview https://deploy-preview-12411--ethereumorg.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 site configuration.

@wackerow wackerow changed the title Dencun updates part 2 Join in-tandem upgrades as one entry in /history; add naming explainer Mar 9, 2024
@wackerow wackerow marked this pull request as ready for review March 9, 2024 20:59
coderabbitai[bot]

This comment was marked as off-topic.

@corwintines corwintines merged commit d419871 into dev Mar 13, 2024
5 of 6 checks passed
@corwintines corwintines deleted the dencun branch March 13, 2024 06:59
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 105e9a0 and 0285c40.
Files selected for processing (1)
  • public/content/history/index.md (5 hunks)
Check Runs (2)
chromatic-deployment completed (2)
label completed (2)
Additional comments: 5
public/content/history/index.md (5)
  • 22-63: The introduction of the new naming convention for Ethereum upgrades, such as "Shapella" for Shanghai-Capella and "Dencun" for Cancun-Deneb, is clearly explained through the <ExpandableCard> component. This approach enhances the readability and understanding of the relationship between execution and consensus layer upgrades post-The Merge. The use of tables to list the upgrades and their corresponding names is effective in providing a quick reference for readers.
  • 70-80: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [73-101]

The summary of the Cancun-Deneb ("Dencun") upgrade provides a concise overview of the improvements introduced in the Cancun execution layer upgrade, notably including EIP-4844 (Proto-Danksharding). The explanation of how Proto-Danksharding decreases the cost of data storage for layer 2 rollups through the introduction of data "blobs" is clear and informative. The list of EIPs included in the Cancun upgrade is well-organized, offering readers easy access to further details on each proposal.

  • 98-104: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [101-127]

The section detailing the Deneb consensus layer upgrade complements the Cancun execution layer upgrade summary by highlighting improvements aimed at enhancing scalability and decentralization. The mention of pre-generated signed "voluntary exit messages" and the capping of the "churn" rate for validator entry are significant points that underline Ethereum's ongoing efforts to improve user control and network efficiency. The list of EIPs included in the Deneb upgrade is similarly well-organized, providing a comprehensive overview of the changes.

  • 124-134: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [127-149]

The summary of the Shanghai-Capella ("Shapella") upgrade effectively communicates the key features of the Shanghai upgrade, particularly the introduction of staking withdrawals to the execution layer. This section, along with the detailed list of EIPs, offers readers a clear understanding of the upgrade's focus on enhancing the staking experience on Ethereum. The consistent format between the summaries of different upgrades aids in maintaining readability and coherence throughout the document.

  • 146-152: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [149-164]

The Capella summary provides a succinct explanation of the consensus layer improvements accompanying the Shanghai upgrade, emphasizing the facilitation of staking withdrawals. The inclusion of automatic account sweeping functionality is a notable detail that underscores the upgrade's aim to streamline the withdrawal process for validators. This section, like the others, benefits from a clear presentation and a structured list of EIPs, contributing to a comprehensive historical account of Ethereum's development.

@corwintines corwintines mentioned this pull request Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 🖋️ This involves copy additions or edits
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants