longhoangwkm / eth2-book

A book about Ethereum

The Eth2 Book

I started working on this book on Eth2 more than two years ago while taking a year-long leave of absence from more traditional work in the crypto space. The Quilt team over at ConsenSys was kind enough to sponsor development of this work for a period of several months. I also recieved a grant for parts of this book via MolochDAO for which I'm extremely grateful. Unfortunately, I wasn't able to finish the book before I ran out of money and turned back towards full-time employment (with Optimism, where I still currently work).

This book has sat in a private GitHub repository for far too long now, waiting to be finished one day. I'm now back on my feet financially, and I feel a responsibility to complete the work that I started. I never released this work publicly because I felt it needed to be more polished in order to be useful (and there's perhaps always a sense of embarassment about showing others your unedited writing). I've since changed my mind about how a book like this should be developed. I do all of my other development out in the open, why should this be any different?

I've therefore decided to open this repository up and show it to the world. Maybe the only impact of making this public will be to force myself to work on it more regularly. Hopefully, though, others will read through this make suggestions and improvements that make the book better than anything I could've worked on by myself. Who knows what the result of this will be, but I'm committed to creating a resource that will help people understand Ethereum (and Eth2 in particular) in much more detail. Let's give the Eth2 book another shot!

But what is it?

The Eth2 book is... a book about Eth2. Of course, it's also much more than that. When I first started working on this project, the idea was to create a resource that explained Eth2 to developers who were already quite familiar with Eth1. However, it quickly became clear that explaining Eth2 in a vacuum like this is only useful to the small group of people who already have access to the resources necessary to learn more about Eth2. Eth2 is also quite a departure from the origins of Ethereum (even though some of the core concepts still apply) and there's a requirement to return to some of the more traditional ideas in distributed systems to really understand the protocol design.

I also felt like this was a great opportunity to create a resource that could help lots of new people dive into Ethereum. So I changed the scope of the project and tried to go for something much bigger. The Eth2 book is now an introduction to Ethereum as it will be when Eth2 goes live. It's meant to be a complete overview of consensus, blockchains, and the way in which Ethereum applies these concepts to create something truly amazing.

A quick note on the Eth2 rebrand

Long after work on this project started, the Ethereum community rebranded "Eth2" to refer to the new consensus layer instead of using Eth2 as the name for the entire system itself. I have no strong opinions on the change, but this does now mean that it's necessary to go back and edit large parts of this work. Conveniently, this is a great excuse for going over the entire book to do some edits. I think this is probably an important first task to start working on now that the book is public.

On the general state of the book

Currently, the book is mostly unpolished and unedited. Large portions of the skeleton of the book have been filled in, but there are likely to be many missing details, spelling errors, and grammatical mistakes. My philosophy in writing this book has been a "breadth-first" approach as I find that overall content structure and layout is the most important part of an educational work. Smaller details, like headings, links, citations, etc., are best to be left toward the end of the project (lest we remove an entire section and waste a significant amount of effort).

I still feel this is the right way to work on a project of this magnitude, but I acknowledge that it may make parts of the book hard to read in its current state. I hope that by making the work public I can start to crowd-source a lot of these smaller details. Anyway, this is all to say that the book is definitely not complete in any sense of the word and I hope you'll bear with me as the kinks get worked out.

It's also worth noting that Eth2 has changed quite a bit since this project was started. Some parts of this book (particularly in the later chapters) are likely wholly inaccurate or outdated. As referenced in the above section regarding the Eth2 rebrand, it's a top priority to review the book for any inaccuracies and to make sure that it matches the narrative around Eth2 as it stands today.

Reading the book

Now that you've read all of my disclaimers, you can find the latest version of the book at the following link:

https://eth2.incessant.ink

Content on that page should update automatically whenever changes are made to this repository.

Contributing

Any and all contributions to this work are very much appreciated. As a way of saying thank you to contributors, I will be creating hand-drawn NFTs for everyone who submits suggestions, edits, or other similar contributions (on Optimism, because I'm biased and also because it's way cheaper than sending NFTs on L1 and I'm not made of money). You'll also be credited as a contributor within the book itself.

Please see the Contributing Guide for more information about the contributing process. If you're interested in contributing frequently, I've set up a Telegram group to coordinate the project.