Skip to content

Commit

Permalink
Wiki update Aug 27 (#313)
Browse files Browse the repository at this point in the history
* Add study group info (#298)

* ✨ feat: Prehistory of Ethereum (#226)

* ✨ feat: p2p computing

* ✨ feat: Overview: Bitcoin

* ✨ feat: Overview: Ethereum world comptuer

* ✨ feat: Overview: Applications

* 🥢 nit:

* nit

Co-authored-by: Mário Havel <61149543+taxmeifyoucan@users.noreply.github.com>

* ✨ feat: Revised intro

* ✨ feat: Internet

* ✨ feat: Map of ARPANET

* ✨ feat: Unix

* ✨ feat: fin

* 🥢 nit: intro

* ✨ feat: Documentary GNU/Linux, Crypto Anarchy

---------

Co-authored-by: rahul <raxhvl@users.noreply.github.com>
Co-authored-by: Mário Havel <61149543+taxmeifyoucan@users.noreply.github.com>

* Add files via upload (#302)

* Create content for scourge under the staking economics track (#300)

* change title lowercase to uppercase

* create content for scourge under the staking economics track

* remove extra space in reference

* add words to wordlist

* reordered the numbering and removed unsed content

* MEV-track and staking economics track in the same table

removed the added tablea header: MEV-track and staking economics track can be in the same table

* reordered the staking economics table content

---------

Co-authored-by: DanGoron <97026899+gorondan@users.noreply.github.com>

* Design rationale for DHT (#304)

* design rationale for DHT

* Apply suggestions from code review

Co-authored-by: Mário Havel <61149543+taxmeifyoucan@users.noreply.github.com>

---------

Co-authored-by: Mário Havel <61149543+taxmeifyoucan@users.noreply.github.com>

* Meeting #5 notes (#307)

* ✨ feat: Meeting #2 notes

* 🥢 nit: link

* 🥢 nit:

* update notes 2

* Notes for wiki contributors meeting #3

* Formatting

* Spell check

* ✨ feat: Meeting 4 notes by Rory

* ✨ feat: Meeting notes 5, closes #299

---------

Co-authored-by: rahul <raxhvl@users.noreply.github.com>
Co-authored-by: Mário Havel <61149543+taxmeifyoucan@users.noreply.github.com>
Co-authored-by: Siddharth Vaderaa <svaderaa@gmail.com>

* Consensus Layer Wiki Page (#246)

* CL init, Update overview of CL

* Update ordering

* Add validators section to overview

* add iamges; added Beacon chain explainer; checkpoints and finality; slots and epochs

* Added validator life cylce

* fix typo; update wordlist

* Update state of validators

* Improve flow of the page;added simpler explanations; added some links

* add introduction; minor fixes

* Minor typos ffix

* add introduction; added byzantine generals problem

* revamp overview structure

* fix dark background in svg

* complete overview of CL; added cl-architecture structure

* Added Blocktree and fork-choice rules

* fix some typos; update wordlist

* add reorgs and reversion

* Add liveness and safey comparision

* Add some more details on consensus protocol

* Add architecture and blobs

* stf; control flow

* fix a broken link; added gasper file

* Use consistent naming for PoW and PoS

* Complete cl-architecture

* Update structure of cl-networking

* fix typos; added words to wordlist

* remove whitespace

* address some nits

* Omit some redudant content

* remove redundant content; fix broken links

* Update proposer and validator set wording

Co-authored-by: Mário Havel <61149543+taxmeifyoucan@users.noreply.github.com>

* Address some more nits

* Add resources; omit whitespace

* fix typos

* Update wordlist

* nit: grammar

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: space

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: word

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: word

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* clean up

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: spell

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: content captilization

* Update wordlist

* nit: diagram name

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: word

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: clean up

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: clean up

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: title

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: wording

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* nit: title

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* fix flow for the transition

* Update beacon-api.md

---------

Co-authored-by: Mário Havel <61149543+taxmeifyoucan@users.noreply.github.com>
Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>

* add links to mirrors (#308)

closes #297

* Update wordlist.txt

* Modified EVM Resources section (#311)

* fixed type

* enhanced EVM wiki

* enhanced EVM wiki

* fixed titles

* fixed titles

---------

Co-authored-by: rahul <10168946+raxhvl@users.noreply.github.com>
Co-authored-by: rahul <raxhvl@users.noreply.github.com>
Co-authored-by: Rory Arredondo <93159440+arredr2@users.noreply.github.com>
Co-authored-by: Glory Agatevure <agatevureglory@gmail.com>
Co-authored-by: DanGoron <97026899+gorondan@users.noreply.github.com>
Co-authored-by: Chirag Parmar <chiragparmar12209@gmail.com>
Co-authored-by: Siddharth Vaderaa <svaderaa@gmail.com>
Co-authored-by: kira <shyampkira@gmail.com>
Co-authored-by: Zaryab <zaryabafser2000@gmail.com>
  • Loading branch information
10 people committed Aug 27, 2024
1 parent ef0b759 commit e1b0904
Show file tree
Hide file tree
Showing 38 changed files with 3,107 additions and 71 deletions.
6 changes: 3 additions & 3 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
- [RLP Serialization](/wiki/EL/RLP.md)
- Consensus Layer
- [Overview](/wiki/CL/overview.md)
- [Client architecture](/wiki/CL/cl-architecture.md)
- [CL Networking](/wiki/CL/cl-networking.md)
- [CL Specs](/wiki/CL/cl-specs.md)
- [Client architecture](/wiki/CL/client-architecture.md)
- [CL Clients](/wiki/CL/cl-clients.md)
- [Beacon API](/wiki/CL/beacon-api.md)
- [CL Networking](/wiki/CL/cl-networking.md)
- [CL Clients](/wiki/CL/cl-clients.md)
- [SSZ Serialization](/wiki/CL/SSZ.md)
- [Merkleization](/wiki/CL/merkleization.md)
- Development
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Write contributions based on what you learned about the protocol along the way,

Before you start with editing, please read the code of conduct, following guide and make yourself familiar with the overall wiki structure.

The wiki source is hosted in github repository at [github.com/eth-protocol-fellows/protocol-studies](https://github.com/eth-protocol-fellows/protocol-studies). Mirrored at //TODO
The wiki source is hosted in Github repository at [github.com/eth-protocol-fellows/protocol-studies](https://github.com/eth-protocol-fellows/protocol-studies). Github repo is the main coordination and hosting platform but wiki source is also mirrored on [radicle](https://app.radicle.xyz/nodes/seed.radicle.garden/rad:zkV49UANVb2w2g5eE4Le197Wuasz) and [independent centralized host](https://git.ethquokkaops.io/eth-protocol-fellows/protocol-studies).

> The wiki is served from `wiki-pages` branch which is regularly updated from `main`. When contributing, open a PR to a branch related to the change or `main` for smaller quick fixes. PRs from other branches are reviewed before merging to `main` and collected updates are then pushed to update the `wiki-pages`.
Expand Down
Binary file added docs/images/cl/RANDAO.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/blobs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
491 changes: 491 additions & 0 deletions docs/images/cl/blockchain.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
657 changes: 657 additions & 0 deletions docs/images/cl/blocktree.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/checkpoints.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/cl-ideal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/cl-networking-overview.webp
Binary file not shown.
Binary file added docs/images/cl/cl-real.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/cl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/client-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/committees.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/el.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/finalization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/network.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
478 changes: 478 additions & 0 deletions docs/images/cl/reorg-0.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
518 changes: 518 additions & 0 deletions docs/images/cl/reorg-1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/slots-and-epochs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/validator-lifecycle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cl/validators.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 57 additions & 4 deletions docs/wiki/CL/beacon-api.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,60 @@
# Beacon API
# Beacon Chain Spec and APIs

> :warning: This article is a [stub](https://en.wikipedia.org/wiki/Wikipedia:Stub), help the wiki by [contributing](/contributing.md) and expanding it.
At the core of Ethereum Proof-of-Stake is a system chain called the "Beacon Chain". The beacon chain stores and manages the registry of validators. In the initial deployment phases of Proof-of-Stake, the only mechanism to become a validator is to make a one-way(withdrawable after Capella) ETH transaction to a deposit contract on the Ethereum proof-of-work chain. Activation as a validator happens when deposit receipts are processed by the Beacon Chain, the activation balance is reached, and a queuing process is completed. Exit is either voluntary or done forcibly as a penalty for misbehavior. The primary source of load on the beacon chain is "attestations". Attestations are simultaneously availability votes for a shard block (in a later upgrade) and proof-of-stake votes for a beacon block (Phase 0).

Beacon API is the endpoint provided by consensus layer clients. It's the interface for interacting with consensus for users and validators.
This section will cover some important parts of Beacon Chain Spec and APIs. Also checkout complete [Beacon Chain Spec](https://github.com/ethereum/consensus-specs/blob/dev/specs/phase0/beacon-chain.md) and [Beacon API reference](https://ethereum.github.io/beacon-APIs/#/).

Check the [Beacon API reference](https://ethereum.github.io/beacon-APIs/#/).
Beacon API is the REST endpoint provided by consensus layer clients (beacon nodes). It's the interface to read information about the consensus and used by validator clients.

## Containers

`BeaconState`

```python
class BeaconState(Container):
# Versioning
genesis_time: uint64
genesis_validators_root: Root
slot: Slot
fork: Fork
# History
latest_block_header: BeaconBlockHeader
block_roots: Vector[Root, SLOTS_PER_HISTORICAL_ROOT]
state_roots: Vector[Root, SLOTS_PER_HISTORICAL_ROOT]
historical_roots: List[Root, HISTORICAL_ROOTS_LIMIT]
# Eth1
eth1_data: Eth1Data
eth1_deposit_index: uint64
application_state_root: Bytes32
# Registry
validators: List[Validator, VALIDATOR_REGISTRY_LIMIT]
balances: List[Gwei, VALIDATOR_REGISTRY_LIMIT]
# Randomness
randao_mixes: Vector[Bytes32, EPOCHS_PER_HISTORICAL_VECTOR]
# Slashings
slashings: Vector[Gwei, EPOCHS_PER_SLASHINGS_VECTOR]
# Attestations
previous_epoch_attestations: List[PendingAttestation, MAX_ATTESTATIONS * SLOTS_PER_EPOCH]
current_epoch_attestations: List[PendingAttestation, MAX_ATTESTATIONS * SLOTS_PER_EPOCH]
# Finality
justification_bits: Bitvector[JUSTIFICATION_BITS_LENGTH] # Bit set for every recent justified epoch
previous_justified_checkpoint: Checkpoint # Previous epoch snapshot
current_justified_checkpoint: Checkpoint
finalized_checkpoint: Checkpoint
```

#### `BeaconBlockBody`

```python
class BeaconBlockBody(Container):
randao_reveal: BLSSignature
eth1_data: Eth1Data # Eth1 data vote
graffiti: Bytes32 # Arbitrary data
# Operations
proposer_slashings: List[ProposerSlashing, MAX_PROPOSER_SLASHINGS]
attester_slashings: List[AttesterSlashing, MAX_ATTESTER_SLASHINGS]
attestations: List[Attestation, MAX_ATTESTATIONS]
deposits: List[Deposit, MAX_DEPOSITS]
voluntary_exits: List[SignedVoluntaryExit, MAX_VOLUNTARY_EXITS]
application_payload: ApplicationPayload
```
Loading

0 comments on commit e1b0904

Please sign in to comment.