From 95213609e8899ed7ee6a6798ed8d68c9d6ee9ddc Mon Sep 17 00:00:00 2001 From: Paul Hauner Date: Wed, 3 Oct 2018 18:37:28 +1000 Subject: [PATCH 1/5] Re-write readme --- README.md | 274 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 230 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index a3e82b162..ef3052c20 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,245 @@ -# Lighthouse: a (future) Ethereum 2.0 client +# Lighthouse: an Ethereum 2.0 client [![Build Status](https://travis-ci.org/sigp/lighthouse.svg?branch=master)](https://travis-ci.org/sigp/lighthouse) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sigp/lighthouse?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -A **work-in-progress** implementation of the Ethereum 2.0 Beacon Chain in Rust. +A work-in-progress, open-source implementation of the Ethereum 2.0 Beacon Chain, maintained +by Sigma Prime. -It is an implementation of the [Full PoS Casper chain -v2](https://notes.ethereum.org/SCIg8AH5SA-O4C1G1LYZHQ?view) spec and is also -largely based upon the -[ethereum/beacon_chain](https://github.com/ethereum/beacon_chain) repo. +## Introduction -**NOTE: the cryptography libraries used in this implementation are very +Lighthouse is an open-source Ethereum 2.0 client, in development. It is an +Ethereum 2.0-_only_ client, meaning it won't re-implement the present +proof-of-work protocol. This will help it stay focussed on 2.0 without +reproducing the work that other clients are already doing very well. + +This readme is split into two major sections: + +- [Lighthouse Client](#lighthouse-client): information about this + implemenation. +- [What is Ethereum 2.0](#what-is-ethereum-20): an introduction to Ethereum 2.0. + +If you'd like some background on Sigma Prime, please see the [Lighthouse Update +\#00](https://lighthouse.sigmaprime.io/update-00.html) blog post. + +## Lighthouse Client + + +### Goals + +We aim to contribute to the research and development of a secure, efficient and +decentralised Ethereum protocol through the development of an open-source +Ethereum 2.0 client. + +We aim to provide a secure and efficient open-source client. As well as +building an implementation, we seek to help maintain and improve the protocol +wherever possible. + +### Components + +Lighthouse is presently focussed on the Beacon Chain implementation. Here are +some of the components actively under development by the team: + +- **BLS cryptography**: we presently use the [Apache + Milagro](https://milagro.apache.org/) cryptography library to create and +verify BLS aggregate signatures. These signatures are core to Eth 2.0 and allow +the signatures of many validators to be compressed into a constant 96 bytes and +verified efficiently. We're presently maintaining our own [BLS aggregates +library](https://github.com/sigp/signature-schemes), gratefully forked from +@lovesh. +- **DoS-resistant block pre-processing**: processing blocks in proof-of-stake + is more resource intensive than proof-of-work. As such, clients need to +ensure that bad blocks can be rejected as efficiently as possible. We can +presently process a block with 10 million ETH staked in 0.006 seconds and +reject valid blocks even quicker. See the +[issue](https://github.com/ethereum/beacon_chain/issues/103) on +[ethereum/beacon_chain](https://github.com/ethereum/beacon_chain) +. +- **P2P networking**: Eth 2.0 is likely use the [libp2p + framework](https://libp2p.io/), lighthouse hopes to work alongside +[Parity](https://www.parity.io/) to get +[libp2p-rust](https://github.com/libp2p/rust-libp2p) fit-for-purpose. +- **Validator duties** : providing "validator" services to users who wish to + stake ETH. This involves maintaining a consistent view of the chain and +voting upon shard and beacon chain blocks. +- **New serialization formats**: lighthouse is working alongside the EF + researchers to develop "simpleserialize" a purpose-built serialization format +for sending information across the network. Check our our [SSZ +implementation](https://github.com/sigp/lighthouse/tree/master/beacon_chain/utils/ssz) +and our +[research](https://github.com/sigp/serialization_sandbox/blob/report/report/serialization_report.md) +on serialization formats. +- **Casper FFG fork-choice**: the [Casper + FFG](https://arxiv.org/abs/1710.09437) fork-choice rules allow the chain to +select a canonical chain in the case of a fork. +- **Efficient state transition logic**: "state transition" logic deals with + updating the validator set as valiators log in/out, penalising/rewarding +validators, rotating validators across shards, and many other core tasks. +- **Fuzzing and testing environments**: we preparing to implement lab + environments with CI work-flows to provide automated security analysis. + +On top of these components we're also working on database schemas, +RPC frameworks, specification development, database optimizations (e.g., +bloom-filters) and tons of other interesting stuff (at least we think so). + +### Contributing + +**Lighthouse welcomes contributors with open-arms.** + +Layer-1 infrastructure is a critical component of the ecosystem and relies +heavily on community contribution. Building Ethereum 2.0 is a huge task and we +refuse to "do an ICO" or charge licensing fees. Instead, we fund development +through grants and support from Sigma Prime. + +If you would like to learn more about Ethereum 2.0 and/or +[Rust](https://www.rust-lang.org/), we would be more than happy to on-board you +and assign you to some tasks. We aim to be as accepting and understanding as +possible; we are more than happy to up-skill contributors in exchange for their +help on the project. + +Alternatively, if you an ETH/Rust veteran we'd love to have your input. We're +always looking for the best way to do things and will always consider any +respectfully presented criticism. + +If you'd like to contribute, try having a look through the [open +issues](https://github.com/sigp/lighthouse/issues) (tip: look for the [good +first +issue](https://github.com/sigp/lighthouse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +tag) and ping us on the [gitter](https://gitter.im/sigp/lighthouse). We need +your support! + +### Running + +**NOTE: the cryptography libraries used in this implementation are experimental and as such all cryptography should be assumed to be insecure.** -## Motivation +The code-base is still under-development and does not provide any user-facing +functionality. However, there are a lot of tests and some benchmarks if that +sort of thing interests you. -The objective of this project is to build a purely Ethereum 2.0 client from -the ground up. - -As such, the early days of Lighthouse will be very much a research effort -- it -will be evolving on the bleeding-edge of specification without requiring to -maintain prod-grade stability or backwards-compatibility for the existing PoW -chain. - -Whilst the Beacon Chain relies upon the PoW chain for block hashes, Lighthouse -will need to run alongside an existing client (e.g., Geth, Parity Ethereum), -only being able to stand by itself once the PoW chain has been deprecated. - -Lighthouse aims to assist in advancing the progress of the following Ethereum -technologies: - - - Proof-of-Stake - - Sharding - - EVM alternatives (e.g., WASM) - - Scalable, topic-based P2P networks (e.g., libp2p-gossipsub) - - Scalable signature schemes (e.g, BLS aggregates) - -## Progress - -As of 02/08/2018, there is a basic libp2p implementation alongside a series of -state objects and state transition functions. There are no syncing capabilities. - -## Usage - -You can run the tests like this: +To run the tests, use ``` -$ git clone -$ cd rust_beacon_chain -$ cargo test +$ cargo test --all ``` +To run benchmarks, use + +``` +$ cargo bench --all +``` + +Lighthouse presently runs on Rust `stable`, however benchmarks require the +`nightly` version. + +### Engineering Ethos + +Lighthouse aims to produce many small, easily-tested components, each separated +into individual crates wherever possible. + +Generally, tests can be kept in the same file, as is typical in Rust. +Integration tests should be placed in the `tests` directory in the crates root. +Particularity large (line-count) tests should be separated into another file. + +A function is not complete until it is tested. We produce tests to help +ourselves and others understand others code and to provide protection from +regression (breaking stuff accidentally). + +Each PR is to be reviewed by at-least one "core developer" (i.e., someone with +write-access to the repository). This helps to detect bugs, improve consistency +and relieves any one individual of the responsibility of an error. + +Discussion should be respectful and intellectual. Have fun, make jokes but +respect other peoples limits. + +### Directory Structure + +Here we provide an overview of the directory structure: + +- `\beacon_chain`: contains logic derived directly from the specification. + E.g., shuffling algorithms, state transition logic and structs, block +validation, BLS crypto, etc. +- `\lighthouse`: contains logic specific to this client implementation. E.g., + CLI parsing, RPC end-points, databases, etc. +- `\network-libp2p`: contains a proof-of-concept libp2p implementation. Will be + replaced once research around p2p has been finalized. + ## Contact -This repo is presently authored by Paul Hauner as a -[Sigma Prime](https://github.com/sigp) project. +The best place for discussion is the [sigp/lighthouse](https://gitter.im/sigp/lighthouse) gitter. +Ping @paulhauner or @AgeManning to get the quickest response. + + +# What is Ethereum 2.0 + +Ethereum 2.0 is the name that has been given to a new blockchain being +developed by the Ethereum Foundation and the Ethereum community. Ethereum 2.0 +consists of 1,025 proof-of-stake blockchains; the "beacon chain" and 1,024 +"shard chains". + +## Beacon Chain + +The Beacon Chain is a little different to more common blockchains like Bitcoin +and present-Ethereum in that it doesn't process "transactions", per say. +Instead, it maintains a set of bonded (staked) validators and co-ordinates them +to provide services to a static set of "sub-blockchains" (shards). These shards +then process the normal "5 ETH from A to B" transactions in _parallel_ whilst +deferring consensus to the Beacon Chain. + +Here are some of the major services that the beacon chain provides to its +shards: + +- A source of entropy, likely using a [RANDAO + VDF + scheme](https://ethresear.ch/t/minimal-vdf-randomness-beacon/3566). +- Valdidator management, including: + - Inducting and ejecting validators. + - Delegating randomly-shuffled subsets of validators to validate shards. + - Penalising and rewarding validators. +- Proof-of-stake consensus for shard chain blocks. + +## Shard Chains + +Shards can be thought of like CPU cores, they're a lane where transactions can +execute in series (one-after-another). Presently, Ethereum is single-core and +can only _fully_ process one transaction at a time. Sharding allows multiple +transactions to happen in parallel, greatly increasing the per-second +transaction capacity of Ethereum. + +Each shard is proof-of-stake and shares its validators (stakers) with the other +shards as the beacon chain rotates validators pseudo-randomly across shards. +Shards will likely be the basis of very interesting layer-2 transaction +processing schemes, however we won't get into that here. + +## The Proof-of-Work Chain + +The proof-of-work chain will hold a contract to allow addresses to deposit 32 +ETH, a BLS public key and some [other +parameters](https://github.com/ethereum/eth2.0-specs/blob/master/specs/casper_sharding_v2.1.md#pow-chain-changes) +to allow them to become Beacon Chain validators. Each Beacon Chain will +reference a PoW block hash allowing PoW clients to use the Beacon Chain as a +source of [Casper FFG finality](https://arxiv.org/abs/1710.09437), if they +desire. + +## Ethereum 2.0 Progress + +Ethereum 2.0 is not fully specified and there's no working implementation. Some +teams have demos available, however these demos indicate _progress_, not +completion. We look forward to providing user functionality once we are ready +to provide a minimum-viable user experience. + +The work-in-progress specification lives +[here](https://github.com/ethereum/eth2.0-specs/blob/master/specs/casper_sharding_v2.1.md) +in the [ethereum/eth2.0-specs](https://github.com/ethereum/eth2.0-specs) +repository. It is still in a draft phase, however there are several teams +already implementing it. This spec is being developed by Ethereum Foundation +researchers, most notably Vitalik Buterin. There is active discussion about the +spec in the [ethereum/sharding](https://gitter.im/ethereum/sharding) gitter +channel. There is a proof-of-concept implementation in Python at +[ethereum/beacon_chain](https://github.com/ethereum/beacon_chain). + +Presently, the spec almost exclusively defines the Beacon Chain as it +is the focus of present development efforts. Progress on shard chain +specification will soon follow. + + + -The best place for discussion is probably the [ethereum/sharding -gitter](https://gitter.im/ethereum/sharding). From f765f4e08d84346a936e77859b2cb91110a9c007 Mon Sep 17 00:00:00 2001 From: mehdi Date: Wed, 3 Oct 2018 20:29:39 +1000 Subject: [PATCH 2/5] Minor typo fixes --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ef3052c20..2e01f5b2b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ reproducing the work that other clients are already doing very well. This readme is split into two major sections: - [Lighthouse Client](#lighthouse-client): information about this - implemenation. + implementation. - [What is Ethereum 2.0](#what-is-ethereum-20): an introduction to Ethereum 2.0. If you'd like some background on Sigma Prime, please see the [Lighthouse Update @@ -54,7 +54,7 @@ reject valid blocks even quicker. See the [issue](https://github.com/ethereum/beacon_chain/issues/103) on [ethereum/beacon_chain](https://github.com/ethereum/beacon_chain) . -- **P2P networking**: Eth 2.0 is likely use the [libp2p +- **P2P networking**: Eth 2.0 is likely to use the [libp2p framework](https://libp2p.io/), lighthouse hopes to work alongside [Parity](https://www.parity.io/) to get [libp2p-rust](https://github.com/libp2p/rust-libp2p) fit-for-purpose. @@ -72,9 +72,9 @@ on serialization formats. FFG](https://arxiv.org/abs/1710.09437) fork-choice rules allow the chain to select a canonical chain in the case of a fork. - **Efficient state transition logic**: "state transition" logic deals with - updating the validator set as valiators log in/out, penalising/rewarding + updating the validator set as validators log in/out, penalising/rewarding validators, rotating validators across shards, and many other core tasks. -- **Fuzzing and testing environments**: we preparing to implement lab +- **Fuzzing and testing environments**: we are preparing to implement lab environments with CI work-flows to provide automated security analysis. On top of these components we're also working on database schemas, @@ -149,7 +149,7 @@ write-access to the repository). This helps to detect bugs, improve consistency and relieves any one individual of the responsibility of an error. Discussion should be respectful and intellectual. Have fun, make jokes but -respect other peoples limits. +respect other people's limits. ### Directory Structure @@ -190,7 +190,7 @@ shards: - A source of entropy, likely using a [RANDAO + VDF scheme](https://ethresear.ch/t/minimal-vdf-randomness-beacon/3566). -- Valdidator management, including: +- Validator management, including: - Inducting and ejecting validators. - Delegating randomly-shuffled subsets of validators to validate shards. - Penalising and rewarding validators. @@ -239,7 +239,3 @@ channel. There is a proof-of-concept implementation in Python at Presently, the spec almost exclusively defines the Beacon Chain as it is the focus of present development efforts. Progress on shard chain specification will soon follow. - - - - From dde6353efdb9b48f22914bbb076c72fb755d4ae7 Mon Sep 17 00:00:00 2001 From: Paul Hauner Date: Thu, 4 Oct 2018 10:11:02 +1000 Subject: [PATCH 3/5] Implement @peanutFactory's comments --- README.md | 135 ++++++++++++++++++++++++++---------------------------- 1 file changed, 65 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index ef3052c20..c5c5809b2 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,11 @@ by Sigma Prime. ## Introduction -Lighthouse is an open-source Ethereum 2.0 client, in development. It is an -Ethereum 2.0-_only_ client, meaning it won't re-implement the present -proof-of-work protocol. This will help it stay focussed on 2.0 without -reproducing the work that other clients are already doing very well. +Lighthouse is an open-source Ethereum 2.0 client, in development. Designed as +an Ethereum 2.0-only client, Lighthouse will not re-implement the existing +proof-of-work protocol. Maintaining a forward-focus on Ethereum 2.0 ensures +that Lighthouse will avoid reproducing the high-quality work already undertaken +by existing clients. This readme is split into two major sections: @@ -30,40 +31,40 @@ We aim to contribute to the research and development of a secure, efficient and decentralised Ethereum protocol through the development of an open-source Ethereum 2.0 client. -We aim to provide a secure and efficient open-source client. As well as -building an implementation, we seek to help maintain and improve the protocol -wherever possible. +In addition to building an implementation, we seek to help maintain and improve +the protocol wherever possible. ### Components -Lighthouse is presently focussed on the Beacon Chain implementation. Here are -some of the components actively under development by the team: +The following list describes some of the components actively under development +by the team: - **BLS cryptography**: we presently use the [Apache Milagro](https://milagro.apache.org/) cryptography library to create and -verify BLS aggregate signatures. These signatures are core to Eth 2.0 and allow -the signatures of many validators to be compressed into a constant 96 bytes and -verified efficiently. We're presently maintaining our own [BLS aggregates -library](https://github.com/sigp/signature-schemes), gratefully forked from -@lovesh. +verify BLS aggregate signatures. BLS signatures are core to Eth 2.0 as they +allow the signatures of many validators to be compressed into a constant 96 +bytes and verified efficiently.. We're presently maintaining our own [BLS +aggregates library](https://github.com/sigp/signature-schemes), gratefully +forked from @lovesh. - **DoS-resistant block pre-processing**: processing blocks in proof-of-stake is more resource intensive than proof-of-work. As such, clients need to ensure that bad blocks can be rejected as efficiently as possible. We can presently process a block with 10 million ETH staked in 0.006 seconds and -reject valid blocks even quicker. See the +reject invalid blocks even quicker. See the [issue](https://github.com/ethereum/beacon_chain/issues/103) on [ethereum/beacon_chain](https://github.com/ethereum/beacon_chain) . -- **P2P networking**: Eth 2.0 is likely use the [libp2p - framework](https://libp2p.io/), lighthouse hopes to work alongside +- **P2P networking**: Eth 2.0 will likely use the [libp2p + framework](https://libp2p.io/). Lighthouse aims to work alongside [Parity](https://www.parity.io/) to get [libp2p-rust](https://github.com/libp2p/rust-libp2p) fit-for-purpose. -- **Validator duties** : providing "validator" services to users who wish to - stake ETH. This involves maintaining a consistent view of the chain and -voting upon shard and beacon chain blocks. -- **New serialization formats**: lighthouse is working alongside the EF - researchers to develop "simpleserialize" a purpose-built serialization format -for sending information across the network. Check our our [SSZ +- **Validator duties** : the project involves the development of "validator" + services for users who wish to stake ETH. To fulfil their duties, validators +require a consistent view of the chain and the ability to vote upon both shard +and beacon chain blocks.. +- **New serialization formats**: lighthouse is working alongside EF researchers + to develop "simpleserialize" a purpose-built serialization format for sending +information across the network. Check out our [SSZ implementation](https://github.com/sigp/lighthouse/tree/master/beacon_chain/utils/ssz) and our [research](https://github.com/sigp/serialization_sandbox/blob/report/report/serialization_report.md) @@ -71,14 +72,14 @@ on serialization formats. - **Casper FFG fork-choice**: the [Casper FFG](https://arxiv.org/abs/1710.09437) fork-choice rules allow the chain to select a canonical chain in the case of a fork. -- **Efficient state transition logic**: "state transition" logic deals with - updating the validator set as valiators log in/out, penalising/rewarding -validators, rotating validators across shards, and many other core tasks. -- **Fuzzing and testing environments**: we preparing to implement lab - environments with CI work-flows to provide automated security analysis. +- **Efficient state transition logic**: "state transition" logic governs + updates to the validator set as validators log in/out, penalises/rewards +validators, rotates validators across shards, and implements other core tasks. +- **Fuzzing and testing environments**: we are preparing to implement lab +environments with CI work-flows to provide automated security analysis.. -On top of these components we're also working on database schemas, -RPC frameworks, specification development, database optimizations (e.g., +In addition to these components we're also working on database schemas, RPC +frameworks, specification development, database optimizations (e.g., bloom-filters) and tons of other interesting stuff (at least we think so). ### Contributing @@ -97,8 +98,8 @@ possible; we are more than happy to up-skill contributors in exchange for their help on the project. Alternatively, if you an ETH/Rust veteran we'd love to have your input. We're -always looking for the best way to do things and will always consider any -respectfully presented criticism. +always looking for the best way to implement things and will consider any +respectful criticism. If you'd like to contribute, try having a look through the [open issues](https://github.com/sigp/lighthouse/issues) (tip: look for the [good @@ -113,10 +114,10 @@ your support! experimental and as such all cryptography should be assumed to be insecure.** The code-base is still under-development and does not provide any user-facing -functionality. However, there are a lot of tests and some benchmarks if that -sort of thing interests you. +functionality. For developers and researchers, there are tests and benchmarks +which could be of interest. -To run the tests, use +To run tests, use ``` $ cargo test --all @@ -128,7 +129,7 @@ To run benchmarks, use $ cargo bench --all ``` -Lighthouse presently runs on Rust `stable`, however benchmarks require the +Lighthouse presently runs on Rust `stable`, however, benchmarks require the `nightly` version. ### Engineering Ethos @@ -140,9 +141,9 @@ Generally, tests can be kept in the same file, as is typical in Rust. Integration tests should be placed in the `tests` directory in the crates root. Particularity large (line-count) tests should be separated into another file. -A function is not complete until it is tested. We produce tests to help -ourselves and others understand others code and to provide protection from -regression (breaking stuff accidentally). +A function is not complete until it is tested. We produce tests to protect +against regression (accidentally breaking things) and to help those who read +our code to understand how the function should (or shouldn't) be used. Each PR is to be reviewed by at-least one "core developer" (i.e., someone with write-access to the repository). This helps to detect bugs, improve consistency @@ -171,22 +172,21 @@ Ping @paulhauner or @AgeManning to get the quickest response. # What is Ethereum 2.0 -Ethereum 2.0 is the name that has been given to a new blockchain being -developed by the Ethereum Foundation and the Ethereum community. Ethereum 2.0 +Ethereum 2.0 refers to a new blockchain currently under development +by the Ethereum Foundation and the Ethereum community. The Ethereum 2.0 blockchain consists of 1,025 proof-of-stake blockchains; the "beacon chain" and 1,024 "shard chains". ## Beacon Chain -The Beacon Chain is a little different to more common blockchains like Bitcoin -and present-Ethereum in that it doesn't process "transactions", per say. -Instead, it maintains a set of bonded (staked) validators and co-ordinates them -to provide services to a static set of "sub-blockchains" (shards). These shards -then process the normal "5 ETH from A to B" transactions in _parallel_ whilst -deferring consensus to the Beacon Chain. +The Beacon Chain differs from existing blockchains such as Bitcoin and +Ethereum, in that it doesn't process "transactions", per say. Instead, it +maintains a set of bonded (staked) validators and co-ordinates these to provide +services to a static set of "sub-blockchains" (shards). These shards process +normal transactions, such as "5 ETH from A to B", in parallel whilst deferring +consensus to the Beacon Chain. -Here are some of the major services that the beacon chain provides to its -shards: +Major services provided by the beacon chain to its shards include the following: - A source of entropy, likely using a [RANDAO + VDF scheme](https://ethresear.ch/t/minimal-vdf-randomness-beacon/3566). @@ -198,48 +198,43 @@ shards: ## Shard Chains -Shards can be thought of like CPU cores, they're a lane where transactions can +Shards can be thought of like CPU cores - they're a lane where transactions can execute in series (one-after-another). Presently, Ethereum is single-core and can only _fully_ process one transaction at a time. Sharding allows multiple transactions to happen in parallel, greatly increasing the per-second transaction capacity of Ethereum. -Each shard is proof-of-stake and shares its validators (stakers) with the other +Each shard uses proof-of-stake and shares its validators (stakers) with the other shards as the beacon chain rotates validators pseudo-randomly across shards. Shards will likely be the basis of very interesting layer-2 transaction -processing schemes, however we won't get into that here. +processing schemes, however, we won't get into that here. ## The Proof-of-Work Chain -The proof-of-work chain will hold a contract to allow addresses to deposit 32 +The proof-of-work chain will hold a contract that allows accounts to deposit 32 ETH, a BLS public key and some [other parameters](https://github.com/ethereum/eth2.0-specs/blob/master/specs/casper_sharding_v2.1.md#pow-chain-changes) to allow them to become Beacon Chain validators. Each Beacon Chain will reference a PoW block hash allowing PoW clients to use the Beacon Chain as a -source of [Casper FFG finality](https://arxiv.org/abs/1710.09437), if they -desire. +source of [Casper FFG finality](https://arxiv.org/abs/1710.09437), if desired. ## Ethereum 2.0 Progress Ethereum 2.0 is not fully specified and there's no working implementation. Some -teams have demos available, however these demos indicate _progress_, not -completion. We look forward to providing user functionality once we are ready -to provide a minimum-viable user experience. +teams have demos available which indicate progress, but not a complete product. +We look forward to providing user functionality once we are ready to provide a +minimum-viable user experience. The work-in-progress specification lives [here](https://github.com/ethereum/eth2.0-specs/blob/master/specs/casper_sharding_v2.1.md) in the [ethereum/eth2.0-specs](https://github.com/ethereum/eth2.0-specs) -repository. It is still in a draft phase, however there are several teams -already implementing it. This spec is being developed by Ethereum Foundation -researchers, most notably Vitalik Buterin. There is active discussion about the -spec in the [ethereum/sharding](https://gitter.im/ethereum/sharding) gitter -channel. There is a proof-of-concept implementation in Python at +repository. The spec is still in a draft phase, however there are several teams +already implementing it whilst the Ethereum Foundation research team fill in +the gaps. There is active discussion about the spec in the +[ethereum/sharding](https://gitter.im/ethereum/sharding) gitter channel. A +proof-of-concept implementation in Python is available at [ethereum/beacon_chain](https://github.com/ethereum/beacon_chain). -Presently, the spec almost exclusively defines the Beacon Chain as it -is the focus of present development efforts. Progress on shard chain -specification will soon follow. - - - - +Presently, the spec almost exclusively defines the Beacon Chain, which is the +focus of present development efforts. Progress on shard chain specification +will soon follow. From 277503a559ef61fe4e22d1c2ea619c269f013748 Mon Sep 17 00:00:00 2001 From: Paul Hauner Date: Thu, 4 Oct 2018 10:18:21 +1000 Subject: [PATCH 4/5] Fix missed merge conflict (Doh!) --- README.md | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/README.md b/README.md index 02f98e933..5a2637dd5 100644 --- a/README.md +++ b/README.md @@ -54,13 +54,8 @@ reject invalid blocks even quicker. See the [issue](https://github.com/ethereum/beacon_chain/issues/103) on [ethereum/beacon_chain](https://github.com/ethereum/beacon_chain) . -<<<<<<< HEAD - **P2P networking**: Eth 2.0 will likely use the [libp2p framework](https://libp2p.io/). Lighthouse aims to work alongside -======= -- **P2P networking**: Eth 2.0 is likely to use the [libp2p - framework](https://libp2p.io/), lighthouse hopes to work alongside ->>>>>>> f765f4e08d84346a936e77859b2cb91110a9c007 [Parity](https://www.parity.io/) to get [libp2p-rust](https://github.com/libp2p/rust-libp2p) fit-for-purpose. - **Validator duties** : the project involves the development of "validator" @@ -77,7 +72,6 @@ on serialization formats. - **Casper FFG fork-choice**: the [Casper FFG](https://arxiv.org/abs/1710.09437) fork-choice rules allow the chain to select a canonical chain in the case of a fork. -<<<<<<< HEAD - **Efficient state transition logic**: "state transition" logic governs updates to the validator set as validators log in/out, penalises/rewards validators, rotates validators across shards, and implements other core tasks. @@ -86,16 +80,6 @@ environments with CI work-flows to provide automated security analysis.. In addition to these components we're also working on database schemas, RPC frameworks, specification development, database optimizations (e.g., -======= -- **Efficient state transition logic**: "state transition" logic deals with - updating the validator set as validators log in/out, penalising/rewarding -validators, rotating validators across shards, and many other core tasks. -- **Fuzzing and testing environments**: we are preparing to implement lab - environments with CI work-flows to provide automated security analysis. - -On top of these components we're also working on database schemas, -RPC frameworks, specification development, database optimizations (e.g., ->>>>>>> f765f4e08d84346a936e77859b2cb91110a9c007 bloom-filters) and tons of other interesting stuff (at least we think so). ### Contributing From 1d0d6a1b0c2226a5f25ae51abc8e5d1a474b8aa8 Mon Sep 17 00:00:00 2001 From: Paul Hauner Date: Thu, 4 Oct 2018 10:49:28 +1000 Subject: [PATCH 5/5] Implement MZ's comments --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5a2637dd5..a3d11b19b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,10 @@ Lighthouse is an open-source Ethereum 2.0 client, in development. Designed as an Ethereum 2.0-only client, Lighthouse will not re-implement the existing proof-of-work protocol. Maintaining a forward-focus on Ethereum 2.0 ensures that Lighthouse will avoid reproducing the high-quality work already undertaken -by existing clients. +by existing clients. For present-Ethereum functionality, Lighthouse will +connect to existing clients like +[Geth](https://github.com/ethereum/go-ethereum) or +[Parity-Ethereum](https://github.com/paritytech/parity-ethereum) via RPC. This readme is split into two major sections: @@ -20,7 +23,8 @@ This readme is split into two major sections: - [What is Ethereum 2.0](#what-is-ethereum-20): an introduction to Ethereum 2.0. If you'd like some background on Sigma Prime, please see the [Lighthouse Update -\#00](https://lighthouse.sigmaprime.io/update-00.html) blog post. +\#00](https://lighthouse.sigmaprime.io/update-00.html) blog post or our +[website](https://sigmaprime.io). ## Lighthouse Client @@ -88,8 +92,8 @@ bloom-filters) and tons of other interesting stuff (at least we think so). Layer-1 infrastructure is a critical component of the ecosystem and relies heavily on community contribution. Building Ethereum 2.0 is a huge task and we -refuse to "do an ICO" or charge licensing fees. Instead, we fund development -through grants and support from Sigma Prime. +refuse to conduct an inappropriate ICO or charge licensing fees. Instead, we +fund development through grants and support from Sigma Prime. If you would like to learn more about Ethereum 2.0 and/or [Rust](https://www.rust-lang.org/), we would be more than happy to on-board you @@ -218,6 +222,10 @@ to allow them to become Beacon Chain validators. Each Beacon Chain will reference a PoW block hash allowing PoW clients to use the Beacon Chain as a source of [Casper FFG finality](https://arxiv.org/abs/1710.09437), if desired. +It is a requirement that ETH can move freely between shard chains and between +Eth 2.0 and present-Ethereum. The exact mechanics of these transfers are still +a topic of research and their details are yet to be confirmed. + ## Ethereum 2.0 Progress Ethereum 2.0 is not fully specified and there's no working implementation. Some