diff --git a/README.md b/README.md index f18937c1b..391edaef0 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Prysmatic Labs Ethereum 2.0 Implementation +# Prysmatic Labs Ethereum Serenity Implementation [![Build status](https://badge.buildkite.com/b555891daf3614bae4284dcf365b2340cefc0089839526f096.svg)](https://buildkite.com/prysmatic-labs/prysm) -This is the main repository for the beacon chain and sharding implementation for Ethereum 2.0 [Prysmatic Labs](https://prysmaticlabs.com). +This is the main repository for the beacon chain and sharding implementation for Ethereum Serenity [Prysmatic Labs](https://prysmaticlabs.com). Before you begin, check out our [Contribution Guidelines](#contributing) and join our active chat room on Discord or Gitter below: diff --git a/beacon-chain/README.md b/beacon-chain/README.md index 4bcc9f5b0..8db8e1ba0 100644 --- a/beacon-chain/README.md +++ b/beacon-chain/README.md @@ -1,6 +1,6 @@ # Prysmatic Labs Beacon Chain Implementation -This is the main project folder for the beacon chain implementation of Ethereum 2.0 in Golang by [Prysmatic Labs](https://prysmaticlabs.com). Before you begin, check out our [Contribution Guidelines](https://github.com/prysmaticlabs/prysm/blob/master/CONTRIBUTING.md) and join our active chat room on Discord or Gitter below: +This is the main project folder for the beacon chain implementation of Ethereum Serenity in Golang by [Prysmatic Labs](https://prysmaticlabs.com). Before you begin, check out our [Contribution Guidelines](https://github.com/prysmaticlabs/prysm/blob/master/CONTRIBUTING.md) and join our active chat room on Discord or Gitter below: [![Discord](https://user-images.githubusercontent.com/7288322/34471967-1df7808a-efbb-11e7-9088-ed0b04151291.png)](https://discord.gg/KSA7rPr) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/prysmaticlabs/prysm?badge&utm_medium=badge&utm_campaign=pr-badge) diff --git a/beacon-chain/params/config.go b/beacon-chain/params/config.go index 4a945aaa6..13b4964b6 100644 --- a/beacon-chain/params/config.go +++ b/beacon-chain/params/config.go @@ -18,7 +18,7 @@ type ValidatorSetDeltaFlags int // Config contains configs for node to participate in beacon chain. type Config struct { - ShardCount uint64 // ShardCount is the fixed number of shards in Ethereum 2.0. + ShardCount uint64 // ShardCount is the fixed number of shards in Ethereum Serenity. DepositSize uint64 // DepositSize is how much a validator has deposited in Gwei. BootstrappedValidatorsCount uint64 // BootstrappedValidatorsCount is the number of validators we seed the first crystallized state. ModuloBias uint64 // ModuloBias is the upper bound of validator shuffle function. Can shuffle validator lists up to that size. diff --git a/contracts/README.md b/contracts/README.md index d7f5bd0a6..dc3b8a0b9 100644 --- a/contracts/README.md +++ b/contracts/README.md @@ -1,6 +1,6 @@ # Prysmatic Labs Contract Page -This page serves as a main reference for Prysmatic Labs' smart contracts implementation for ethereum 2.0. +This page serves as a main reference for Prysmatic Labs' smart contracts implementation for Ethereum Serenity. ## Table of Contents diff --git a/docs/DEMO_INFORMATION.md b/docs/DEMO_INFORMATION.md index 8df78c5c8..da79292c4 100644 --- a/docs/DEMO_INFORMATION.md +++ b/docs/DEMO_INFORMATION.md @@ -1,14 +1,14 @@ -# Ethereum 2.0 Prysm Demo +# Ethereum Serenity Prysm Demo ## Overview & Research Background -At Prysmatic Labs, we started working on Ethereum 2.0 all the way back since Vitalik first had a Sharding FAQ as the only reference for the system at the start of 2018. A lot has happened, with the specification evolving from a series of ETHResearch blog posts into a minimal viable blueprint for how to design a scalable, secure Ethereum blockchain using Casper Proof of Stake and Sharding at its core. +At Prysmatic Labs, we started working on Ethereum Serenity all the way back since Vitalik first had a Sharding FAQ as the only reference for the system at the start of 2018. A lot has happened, with the specification evolving from a series of ETHResearch blog posts into a minimal viable blueprint for how to design a scalable, secure Ethereum blockchain using Casper Proof of Stake and Sharding at its core. Now, the plan is to deploy ETH2.0 as a sidechain of Ethereum known as a beacon chain, where validators can stake their Ether and participate in consensus to vote on occurrences on shards known as cross-links. ## Version 0.0.0: Beacon Chain+Validator Demo -We call our Ethereum 2.0 Shasper project Prysm, which will serve as the scaffold for a production-oriented release fully written in Go. We have been working hard to ensure we have a robust implementation of the Ethereum 2.0 specification as created by the Ethereum Research Team along with industry standard approaches to building large scale applications. +We call our Ethereum Serenity project Prysm, which will serve as the scaffold for a production-oriented release fully written in Go. We have been working hard to ensure we have a robust implementation of the Ethereum Serenity specification as created by the Ethereum Research Team along with industry standard approaches to building large scale applications. We are proud to announce our very first release of Prysm, v0.0.0, which will serve as the building block for all future releases as we get to production. We want to show the community we have a project we have put a lot of work into through careful thought and design decisions that we hope will set a standard for future ETH2.0 developments. @@ -47,10 +47,10 @@ Curious to see the system working and running a validator client locally? We hav [Running Instructions](https://github.com/prysmaticlabs/prysm/blob/master/README.md#instructions) -You’ll be able to spin up a beacon node, connect a validator client, and start getting assigned to shards where you will then create beacon blocks or vote on beacon blocks through structures called “attestations”. If you are not quite as familiar with the Ethereum 2.0 Roadmap and Spec, check out the following links: +You’ll be able to spin up a beacon node, connect a validator client, and start getting assigned to shards where you will then create beacon blocks or vote on beacon blocks through structures called “attestations”. If you are not quite as familiar with the Ethereum Serenity Roadmap and Spec, check out the following links: -- [Ethereum 2.0 Devs Handbook](https://notes.ethereum.org/s/BkSZAJNwX#) -- [Ethereum 2.0 Casper+Sharding Specification](https://github.com/ethereum/eth2.0-specs/blob/master/specs/casper_sharding_v2.1.md) +- [Ethereum Serenity Devs Handbook](https://notes.ethereum.org/s/BkSZAJNwX#) +- [Ethereum Serenity Casper+Sharding Specification](https://github.com/ethereum/eth2.0-specs/blob/master/specs/casper_sharding_v2.1.md) -Even though canonical blocks are created in the demo due to your activity as a validator, you’ll quickly see not much can be done with these blocks until real, state execution comes into play. However, this beacon chain is a critical piece of consensus and coordination for all actors participating in Ethereum 2.0 and will as the foundation for a full-fledged, sharding system. +Even though canonical blocks are created in the demo due to your activity as a validator, you’ll quickly see not much can be done with these blocks until real, state execution comes into play. However, this beacon chain is a critical piece of consensus and coordination for all actors participating in Ethereum Serenity and will as the foundation for a full-fledged, sharding system. diff --git a/docs/MAINCHAIN.md b/docs/MAINCHAIN.md index bc0aa1966..198e12eaf 100644 --- a/docs/MAINCHAIN.md +++ b/docs/MAINCHAIN.md @@ -1,6 +1,6 @@ -# Connecting Ethereum 2.0 to a Mainchain, Go-Ethereum Node +# Connecting Ethereum Serenity to a Mainchain, Go-Ethereum Node -In order to test out validator registration and synchronize the Ethereum 2.0 beacon chain with a proof-of-work, mainchain node, you'll need to initialize your own private Ethereum blockchain as follows: +In order to test out validator registration and synchronize the Ethereum Serenity beacon chain with a proof-of-work, mainchain node, you'll need to initialize your own private Ethereum blockchain as follows: ## Running a Local Geth Node diff --git a/docs/READINGS.md b/docs/READINGS.md index 006e3deaa..b757e026c 100644 --- a/docs/READINGS.md +++ b/docs/READINGS.md @@ -102,7 +102,7 @@ With respect to knowing enough about sharding, we will cover the requirements fo After reading the Sharding FAQ, it is important to understand the minimal implementation notes and the research that went into writing it up. -**Shasper Concepts and Notes** +**Serenity Concepts and Notes** - [Sharding Concepts Mental Map](https://www.mindomo.com/zh/mindmap/sharding-d7cf8b6dee714d01a77388cb5d9d2a01) - [Taiwan Sharding Workshop Notes](https://hackmd.io/s/HJ_BbgCFz#%E2%9F%A0-General-Introduction) @@ -111,7 +111,7 @@ After reading the Sharding FAQ, it is important to understand the minimal implem - [General Theory of Sharding](https://ethresear.ch/t/a-general-theory-of-what-quadratically-sharded-validation-is/1730/10) - [Sharding Design Compendium](https://ethresear.ch/t/sharding-designs-compendium/1888/25) -**Shasper Research Posts in Order** +**Serenity Research Posts in Order** - [Sharding v2.1 Spec](https://notes.ethereum.org/SCIg8AH5SA-O4C1G1LYZHQ) - [Casper/Sharding/Beacon Chain FAQs](https://notes.ethereum.org/9MMuzWeFTTSg-3Tz_YeiBA?view) @@ -128,7 +128,7 @@ After reading the Sharding FAQ, it is important to understand the minimal implem - [Safe Notary Pool Size](https://ethresear.ch/t/safe-notary-pool-size/1728/3) - [Cross Links Between Main and Shard Chains](https://ethresear.ch/t/cross-links-between-main-chain-and-shards/1860/2) -**Shasper Talk from Conferences & Meet Ups in Order** +**Serenity Talk from Conferences & Meet Ups in Order** - [Sharding Presentation by Vitalik from IC3-ETH Bootcamp](https://vod.video.cornell.edu/media/Sharding+-+Vitalik+Buterin/1_1xezsfb4/97851101) - [Latest Research and Sharding by Justin Drake from Tech Crunch](https://www.youtube.com/watch?v=J6xO7DH20Js) - [Beacon Casper Chain by Vitalik and Justin Drake](https://www.youtube.com/watch?v=GAywmwGToUI) diff --git a/docs/VALIDATOR_REGISTRATION.md b/docs/VALIDATOR_REGISTRATION.md index 5d9b851f2..ef19923d1 100644 --- a/docs/VALIDATOR_REGISTRATION.md +++ b/docs/VALIDATOR_REGISTRATION.md @@ -36,7 +36,7 @@ as long as pub key matches the one you used to launch beacon chain node. (ex: aa ### Step 4: Wait for Deposit Tx Block to be Mined -After the deposit transaction gets mined, beacon chain node will report account holder has been registered. Congrats! Now, you are contributing to the security of Ethereum 2.0 : ) +After the deposit transaction gets mined, beacon chain node will report account holder has been registered. Congrats! Now, you are contributing to the security of Ethereum Serenity ``` INFO[0000] Starting beacon node INFO[0000] Starting web3 PoW chain service at ws://127.0.0.1:8546 diff --git a/k8s/README.md b/k8s/README.md index 0b246e41e..e17468073 100644 --- a/k8s/README.md +++ b/k8s/README.md @@ -1,4 +1,4 @@ -# Kubernetes Configuration for Ethereum 2.0 +# Kubernetes Configuration for Ethereum Serenity ## Requirements diff --git a/proto/README.md b/proto/README.md index 2b5ba0e4e..553dd0e68 100644 --- a/proto/README.md +++ b/proto/README.md @@ -1,6 +1,6 @@ -# Ethereum 2.0 Protocol Buffers +# Ethereum Serenity Protocol Buffers -This package defines common protobuf messages and services used by Ethereum 2.0 clients. Following the structure of: +This package defines common protobuf messages and services used by Ethereum Serenity clients. Following the structure of: ``` proto/ diff --git a/shared/bls/bls.go b/shared/bls/bls.go index 65cd50c00..4cab3c02a 100644 --- a/shared/bls/bls.go +++ b/shared/bls/bls.go @@ -1,6 +1,6 @@ // Package bls implements a go-wrapper around a C BLS library leveraging // the BLS12-381 curve. This package exposes a public API for verifying and -// aggregating BLS signatures used by Ethereum 2.0. +// aggregating BLS signatures used by Ethereum Serenity. package bls import "fmt" diff --git a/shared/legacyutil/convert_transaction.go b/shared/legacyutil/convert_transaction.go index ae1e51b5b..116331597 100644 --- a/shared/legacyutil/convert_transaction.go +++ b/shared/legacyutil/convert_transaction.go @@ -1,4 +1,4 @@ -// Package legacyutil exists to convert Ethererum 2.0 types to go-ethereum or +// Package legacyutil exists to convert Ethereum Serenity types to go-ethereum or // Ethereum 1.0 types. package legacyutil diff --git a/shared/p2p/p2p.go b/shared/p2p/p2p.go index c8333a6e1..fd5207ac0 100644 --- a/shared/p2p/p2p.go +++ b/shared/p2p/p2p.go @@ -1,4 +1,4 @@ -// Package p2p handles peer-to-peer networking for Ethereum 2.0 clients. +// Package p2p handles peer-to-peer networking for Ethereum Serenity clients. // // There are three types of p2p communications. // diff --git a/validator/README.md b/validator/README.md index a76659186..75813a735 100644 --- a/validator/README.md +++ b/validator/README.md @@ -1,6 +1,6 @@ # Prysmatic Labs Validator Client Implementation -This is the main project folder for a validator client implementation of Ethereum 2.0 in Golang by [Prysmatic Labs](https://prysmaticlabs.com). A validator client attaches to a running beacon node in order to perform proposer/attester responsibilities and manage the lifecycle of a particular shard upon being assigned to one. +This is the main project folder for a validator client implementation of Ethereum Serenity in Golang by [Prysmatic Labs](https://prysmaticlabs.com). A validator client attaches to a running beacon node in order to perform proposer/attester responsibilities and manage the lifecycle of a particular shard upon being assigned to one. Before you begin, check out our main [README](https://github.com/prysmaticlabs/prysm/blob/master/README.md) and join our active chat room on Discord or Gitter below: diff --git a/validator/attester/service.go b/validator/attester/service.go index f4e817a4c..5cef02d64 100644 --- a/validator/attester/service.go +++ b/validator/attester/service.go @@ -1,5 +1,5 @@ // Package attester defines all relevant functionality for a Attester actor -// within Ethereum 2.0. +// within Ethereum Serenity. package attester import ( @@ -26,7 +26,7 @@ type beaconClientService interface { } // Attester holds functionality required to run a block attester -// in Ethereum 2.0. +// in Ethereum Serenity. type Attester struct { ctx context.Context cancel context.CancelFunc diff --git a/validator/main.go b/validator/main.go index 76e370b73..48227e192 100644 --- a/validator/main.go +++ b/validator/main.go @@ -58,7 +58,7 @@ VERSION: app := cli.NewApp() app.Name = "validator" - app.Usage = `launches an Ethereum 2.0 validator client that interacts with a beacon chain, starts proposer services, shardp2p connections, and more + app.Usage = `launches an Ethereum Serenity validator client that interacts with a beacon chain, starts proposer services, shardp2p connections, and more ` app.Action = startNode app.Flags = []cli.Flag{ diff --git a/validator/node/node.go b/validator/node/node.go index 8ec00092f..d3162a114 100644 --- a/validator/node/node.go +++ b/validator/node/node.go @@ -1,5 +1,5 @@ // Package node defines a validator client which connects to a -// full beacon node as part of the Ethereum 2.0 specification. +// full beacon node as part of the Ethereum Serenity specification. package node import ( @@ -32,7 +32,7 @@ const shardChainDBName = "shardchaindata" // ValidatorClient defines an instance of a sharding validator that manages // the entire lifecycle of services attached to it participating in -// Ethereum 2.0. +// Ethereum Serenity. type ValidatorClient struct { ctx *cli.Context services *shared.ServiceRegistry // Lifecycle and service store. @@ -49,7 +49,7 @@ func GeneratePubKey() ([]byte, error) { return pubkey, err } -// NewValidatorClient creates a new, Ethereum 2.0 validator client. +// NewValidatorClient creates a new, Ethereum Serenity validator client. func NewValidatorClient(ctx *cli.Context) (*ValidatorClient, error) { registry := shared.NewServiceRegistry() ValidatorClient := &ValidatorClient{ diff --git a/validator/proposer/service.go b/validator/proposer/service.go index 64689528c..7dd817bc0 100644 --- a/validator/proposer/service.go +++ b/validator/proposer/service.go @@ -1,5 +1,5 @@ // Package proposer defines all relevant functionality for a Proposer actor -// within Ethereum 2.0. +// within Ethereum Serenity. package proposer import ( @@ -31,7 +31,7 @@ type rpcAttestationService interface { } // Proposer holds functionality required to run a block proposer -// in Ethereum 2.0. Must satisfy the Service interface defined in +// in Ethereum Serenity. Must satisfy the Service interface defined in // sharding/service.go. type Proposer struct { ctx context.Context