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

Wiki - Consensus Layer #185

Closed
11 of 16 tasks
shyam-patel-kira opened this issue Apr 17, 2024 · 3 comments · Fixed by #246
Closed
11 of 16 tasks

Wiki - Consensus Layer #185

shyam-patel-kira opened this issue Apr 17, 2024 · 3 comments · Fixed by #246
Assignees
Labels
help wanted Extra attention is needed looking-for-collaboration Collaborators needed missing-content Important domain not covered by wiki page-request Add a new page

Comments

@shyam-patel-kira
Copy link
Member

shyam-patel-kira commented Apr 17, 2024

What content is missing?

  • Consensus layer architecture
  • Consensus specs

Proposed Content to cover

  • Overview of CL and beacon-chain
  • Slots and epochs
  • Validators and attestations
  • Committees
  • Beacon-chain checkpoints and Finality
  • Staking rewards and Penalties
  • Consensus mechanisms, algorithms etc
    • Fork-choice rules, BFT, pBFT
    • Reorgs and Reversion
    • Architecture
    • State Transition function
    • Casper FFG and LMD-Ghost
  • Consensus Specs
  • using Pyspec
  • Beacon chain apis
  • examples using the prysm client

Related content in the wiki

  • There's one PR for cl-architecture but it's kinda misleading cuz it only give high level overview on variation of CL clients
@shyam-patel-kira shyam-patel-kira added page-request Add a new page missing-content Important domain not covered by wiki labels Apr 17, 2024
@shyam-patel-kira shyam-patel-kira self-assigned this Apr 17, 2024
@shyam-patel-kira shyam-patel-kira changed the title Consensus Layer Wiki - Consensus Layer Apr 17, 2024
@shyam-patel-kira shyam-patel-kira added the looking-for-collaboration Collaborators needed label Apr 17, 2024
@ultraviolet10
Copy link
Contributor

Would love to collaborate!

@taxmeifyoucan
Copy link
Contributor

The structure and each page should reflect its EL counterpart to keep the same style across the wiki.
Quick ideas on the structure:

  • The intro and overview page. Right now it's in ok state, there could be links to each section
  • CL clients, I recently updated it with list of all clients. But there needs to be more info on each, some basic tips and links. In progress Consensus Layer clients brief overview. #107
  • Specs, this page should explain how and where CL is specified, how to use pyspec. Based on week 6 dev presentation
  • Client architecture, should follow a structure started in Updates to el-architecture #184, explaining how the client works, its services and processes, inspiration in week 8 dev
  • Beacon APIs page dedicated to their specification, changes and usage
  • Proof of stake diving into the consensus mechanism, explaining gasper from more abstract perspective. This was an early idea and maybe it's already covered well in eth.org docs, I don't feel strong about this one

@shyam-patel-kira
Copy link
Member Author

Thanks for the suggestion @taxmeifyoucan! The update on this got slightly delayed because I was working BLS page, will get started on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed looking-for-collaboration Collaborators needed missing-content Important domain not covered by wiki page-request Add a new page
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants