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

Update proof of stake section (wiki migration) #6157

Merged
merged 27 commits into from
May 17, 2022
Merged

Update proof of stake section (wiki migration) #6157

merged 27 commits into from
May 17, 2022

Conversation

jmcook1186
Copy link
Contributor

@jmcook1186 jmcook1186 commented Apr 26, 2022

Description

This PR is part of the migration of materials from eth.wiki to ethereum.org. There is substantial material on eth.wiki concerning proof of stake that was not available at ethereum.org and should not be lost when the wiki is deprecated. The PoS page currently on ethereum.org is also rather sparse and makes frequent reference to sharding designs that have since been deprecated. For these reasons I have reworked the PoS landing page with up-to-date information and also added two new subpages: one on weak subjectivity and another explaining the Gasper protocol. This satisfies the migration of PoS materials from eth.wiki. Note, however, that the material there was written when Casper was the cutting edge of PoS research, meaning it lags significantly behind the mechanism that will be implemented at the merge. Therefore, I have rewritten and updated where necessary.

In summary the following changes are implemented:

  • Substantial rewriting of PoS landing page, includign removal of OOD information
  • Add new "Gasper" page that cointains high-level explanation of Casper and LMD-GHOST as they will be implemented at the merge
  • Add "weak subjectivity" page. This is part of the wiki migration but content rewritten to better fit ethereum.org

Note also that, contrary to the suggestions in the wiki migration issue I decided NOT to migrate the PoS FAQs onto ethereum.org. This is because they are already replicated verbatim on vitalik.ca. I have simply linked out to that page instead.

Related Issue

#5690

@github-actions github-actions bot added content 🖋️ This involves copy additions or edits review needed 👀 labels Apr 26, 2022
@gatsby-cloud
Copy link

gatsby-cloud bot commented Apr 26, 2022

Gatsby Cloud Build Report

ethereum-org-website-dev

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 16m

Performance

Lighthouse report

Metric Score
Performance 🔶 25
Accessibility 💚 100
Best Practices 💚 100
SEO 💚 92

🔗 View full report

@jmcook1186 jmcook1186 marked this pull request as ready for review April 27, 2022 10:57
### The beacon chain {#the-beacon-chain}

When Ethereum replaces proof-of-work with proof-of-stake, there will be the added complexity of [shard chains](/upgrades/shard-chains/). These are separate blockchains that will need validators to process transactions and create new blocks. The plan is to have 64 shard chains, with each having a shared understanding of the state of the network. As a result, extra coordination is necessary and will be done by [the beacon chain](/upgrades/beacon-chain/).
- better energy efficiency – there is no need to use lots of energy on PoW computations
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we use proof-of-work / proof-of-stake over the acronym as per the style guide

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmmm I had to fix a bunch of these and realised that this maybe isn't actually clear:

We stick to spelling out full terms (proof-of-stake) over acronyms (PoS) to avoid the potential cognitive overhead it causes.

See this section of the Google Technical Writing Guide for the reasoning we used to inform this choice.

Copy link
Contributor

@minimalsm minimalsm left a comment

Choose a reason for hiding this comment

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

Hey @jmcook1186, this looks great ❤️❤️. Left some high-level comments but will try to do a full review by tomorrow.

@@ -0,0 +1,42 @@
---
title: Gasper
description: An explanation of the Gasper PoS mechanism.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: An explanation of the Gasper PoS mechanism.
description: An explanation of the Gasper proof-of-stake mechanism.

Copy link
Contributor

@minimalsm minimalsm left a comment

Choose a reason for hiding this comment

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

This is great @jmcook1186 (And I actually learned a bunch, thanks 😀)! I've committed some formatting changes but nothing major.

Left two comments for you to consider but not blocking this PR; we can definitely merge this and work on those later.

I also think we want to consider where we want these to live as they seem a little bit beyond 'Foundational' (definitely not something to worry about just now, we can do this at a later date).

Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

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

@jmcook1186 This is great! Love to see the expansion of these resources within the repo.
Left a few small comments/suggestions/questions, but overall think this is great and looking forward to pulling it in!

@minimalsm
Copy link
Contributor

Just waiting on another review before merging.

@minimalsm minimalsm added the Status: Blocked 🛑 This is blocked label May 12, 2022
@@ -3,85 +3,63 @@ title: Proof-of-stake (PoS)
description: An explanation of the proof-of-stake consensus protocol and its role in Ethereum.
lang: en
sidebar: true
incomplete: true
incomplete: false
Copy link
Member

Choose a reason for hiding this comment

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

FYI having incomplete: false, while more explicit, isn't necessary. We can just remove this frontmatter prop ✂️

We only need to add incomplete: true if we want to display the incomplete banner & callouts on a docs page.

Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

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

💪🏻

@wackerow wackerow changed the title update proof of stake section (wiki migration) Update proof of stake section (wiki migration) May 17, 2022
@wackerow wackerow merged commit 28bef6c into ethereum:dev May 17, 2022
@wackerow wackerow mentioned this pull request May 17, 2022
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 Status: Blocked 🛑 This is blocked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants