Skip to content

Commit

Permalink
Merge pull request #62 from eth-protocol-fellows/main
Browse files Browse the repository at this point in the history
Wiki update, Mar 1
  • Loading branch information
taxmeifyoucan authored Mar 1, 2024
2 parents 7a2119f + effdeb4 commit f0ce8c4
Show file tree
Hide file tree
Showing 18 changed files with 463 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [Overview](/wiki/protocol/overview.md)
- [History](/wiki/protocol/history.md)
- [Coordination](/wiki/protocol/pm.md)
- [Data Structures](/wiki/protocol/data-structures.md)
- [CS Resources]
- Execution Layer
- [EL Clients](/wiki/EL/el-clients.md)
Expand Down Expand Up @@ -56,10 +57,9 @@
- ASE
- EOF
- Portal Network
- Cryptography
- Eliptic curves
- ECDSA
- BLS
- [Cryptography](/wiki/Cryptography/intro.md)
- [ECDSA](/wiki/Cryptography/ecdsa.md)
- BLS
- [Commitments]
- Polynomials
- Commitment schemes
Expand Down
8 changes: 6 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ It **does not** cover onchain protocols/dapps, layer 2s/rollups or any other too

### Structure and collaboration

The wiki is supposed to cover all important parts of Ethereum core protocol and its development. The protocol architecture and related topics is reflected in the wiki format. The whole wiki lives under `/docs/wiki` and the [sidebar](_sidebar.md) defines the main documentation structure. High level areas are abstracted to directories which include all subtopics.
The wiki is supposed to cover all important parts of Ethereum core protocol and its development. The protocol architecture and related topics is reflected in the wiki format. The whole wiki lives under `/docs/wiki` and the [sidebar](_sidebar.md) defines the main documentation structure.
High level areas are abstracted to directories which include all subtopics. Focus your contributions to wiki itself. Week pages in `eps` directory are meant for weekly presentations information, not main place for resources.

For contributors, we recommend focusing on specific topics contained in corresponding documents. It's best to own a single topic and work out all the details. Create a new document and add the topic to the sidebar if it's not there yet. Join the [discord server](https://discord.gg/epfsg), let others know what you are working on in the group channel and collaborate with other contributors writing about related topics. If you are working with multiple people on a significant piece of content, you can have a dedicated branch in the repo for easier coordination.

Expand All @@ -53,7 +54,9 @@ docsify serve ./docs

Wiki pages follow standard Markdown which can be rendered by Github or Docsify. For details on using it, look into the Markdown [guide](https://www.markdownguide.org/).

The audience of this wiki is technical and the content should reflect that. There are many guides on technical and documentation writing you can learn from. Here are few guidelines to follow when writing this wiki:
The audience of this wiki is technical and the content should reflect that. There are many guides on technical and documentation writing you can learn from, for example you can check [this lecture](https://www.youtube.com/watch?v=vtIzMaLkCaM) to get started.

Here are main guidelines to follow when writing this wiki:

- Write in an objective, clear and explanatory tone
- Avoid unnecessary simplifications, describe the technical reality
Expand All @@ -73,6 +76,7 @@ The audience of this wiki is technical and the content should reflect that. Ther

Goal is to produce a credible neutral text which is formal, well-structured, and maintains a clear progression of ideas. The content should be purely technical and shouldn't waste space on introducing high level/well known concepts. Introductory topics are necessary and can use comparisons, historical anecdotes, and concrete examples to make complex concepts more accessible.


### Content standardization

The wiki uses American English over British spelling. Terminology, capitalization and nomenclature should match across all pages. Use [Ethereum.org guide](https://ethereum.org/contributing/style-guide/content-standardization) for the reference.
Expand Down
2 changes: 1 addition & 1 deletion docs/eps/week1.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ To explore various parts of the Ethereum protocol, check out what people have be
https://github.com/eth-protocol-fellows/cohort-three/tree/master/projects
https://github.com/eth-protocol-fellows/cohort-four/tree/master/projects

[Devcon archive](archive.devcon.org) is full of incredible talks diving into various technical and non-technical aspects of Ethereum.
[Devcon archive](https://archive.devcon.org/archive/) is full of incredible talks diving into various technical and non-technical aspects of Ethereum.

A [retrospective document](https://notes.ethereum.org/@mikeneuder/rcr2vmsvftv) on recent roadmap by Alex and Mike comes with great insights into Ethereum development, values and goals.

Expand Down
10 changes: 7 additions & 3 deletions docs/eps/week2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

During the second week, we will dive into the Execution layer of Ethereum.

Watch the presentation diving into EL internals with Lightclient on [StreamEth](https://streameth.org/watch?event=&session=65dcdef0a6d370a1ab326de1) or [Youtube](https://www.youtube.com/watch?v=pniTkWo70OY). The overview document is available here.
Watch the presentation diving into EL internals with Lightclient on [StreamEth](https://streameth.org/watch?event=&session=65dcdef0a6d370a1ab326de1) or [Youtube](https://www.youtube.com/watch?v=pniTkWo70OY).

The overview document created in the presentation is [available here](https://github.com/eth-protocol-fellows/protocol-studies/blob/main/docs/eps/presentations/week2_notes.md?plain=1).

[recording](https://streameth.org/embed/?playbackId=70f6rq6un48dy74q&vod=true&streamId=&playerName=Execution+Layer+Overview+%7C+lightclient+%7C+Week+2 ':include :type=iframe width=100% height=520 frameborder="0" allow="fullscreen" allowfullscreen')

For archive of the discussion during the talk, check [this thread](https://discord.com/channels/1205546645496795137/1210292746817110027/1210292751158222848) in our [Discord server](https://discord.gg/epfsg).
For written summary of week 2 presentation, check the [notes](https://ab9jvcjkej.feishu.cn/docx/BRDdd8kP9o00a2x6F4scRo0fnJh)

For archive of the discussion during the talk, check [this thread](https://discord.com/channels/1205546645496795137/1210292746817110027/1210292751158222848) in our [Discord server](https://discord.gg/epfsg).

## Pre-reading

Expand Down Expand Up @@ -67,6 +70,7 @@ Additionally, you should read through the following documents to prepare for the
- https://github.com/ethereum/execution-apis
- https://blog.ethereum.org/2022/01/24/the-great-eth2-renaming
- https://blog.ethereum.org/2021/11/29/how-the-merge-impacts-app-layer
- [How The Execution Client and the Consensus Client Can Work Together](https://www.youtube.com/watch?v=91-GArv6lKo)
- [Engine API: A Visual Guide](https://hackmd.io/@danielrachi/engine_api) by [Daniel Ramirez](https://hackmd.io/@danielrachi)
- [Understanding Ethereum by studying its source code](https://gisli.hamstur.is/2020/08/understanding-ethereum-by-studying-the-source-code/)

Lightclient's vim and shell setup https://github.com/lightclient/dotfiles
21 changes: 21 additions & 0 deletions docs/eps/week3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Study Group Week 3 | Consensus Layer

The third week will dive into the Consensus layer of Ethereum.

Join the presentation by [Alex Stokes](https://twitter.com/ralexstokes) on [Monday, March 4, 4PM UTC](https://savvytime.com/converter/utc-to-germany-berlin-united-kingdom-london-ny-new-york-city-ca-san-francisco-china-shanghai-japan-tokyo-australia-sydney/mar-04-2024/4pm).

The link to stream will be provided here and announced in [Discord group](https://discord.gg/epfsg).

## Pre-reading

Before starting with the week 3 content, make yourself familiar with resources in [week 2](/eps/week1.md).

Additionally, you can read get ready by reading following resources:
- [Ethereum.org docs on Proof-of-stake](https://ethereum.org/developers/docs/consensus-mechanisms/pos) and its subtopics

## Outline

## Additional reading and exercises

- [Gasper paper](https://arxiv.org/pdf/2003.03052.pdf)
- [Eth2book, annotated spec](https://eth2book.info/)
Binary file added docs/images/elliptic-curves/addition.gif
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/elliptic-curves/clock.gif
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/elliptic-curves/examples.gif
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/elliptic-curves/finite-field.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/elliptic-curves/postcard.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/elliptic-curves/secp256k1.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/merkle-tree.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/tries.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f0ce8c4

Please sign in to comment.