Skip to content

Commit

Permalink
Reduce Usage of Eth2 Terminology in Prysm (#9104)
Browse files Browse the repository at this point in the history
* remove all mentions

* more changes

* folder by folder

Co-authored-by: terence tsao <terence@prysmaticlabs.com>
Co-authored-by: prylabs-bulldozer[bot] <58059840+prylabs-bulldozer[bot]@users.noreply.github.com>
  • Loading branch information
3 people committed Jun 26, 2021
1 parent dd0ae1b commit a860648
Show file tree
Hide file tree
Showing 122 changed files with 183 additions and 188 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -175,7 +175,7 @@ We consider two types of contributions to our repo and categorize them as follow

### Part-Time Contributors

Anyone can become a part-time contributor and help out on implementing eth2. The responsibilities of a part-time contributor include:
Anyone can become a part-time contributor and help out on implementing Ethereum consensus. The responsibilities of a part-time contributor include:

- Engaging in Gitter conversations, asking the questions on how to begin contributing to the project
- Opening up github issues to express interest in code to implement
Expand Down
2 changes: 1 addition & 1 deletion INTEROP.md
@@ -1,6 +1,6 @@
# Prysm Client Interoperability Guide

This README details how to setup Prysm for interop testing for usage with other Ethereum 2.0 clients.
This README details how to setup Prysm for interop testing for usage with other Ethereum consensus clients.

## Installation & Setup

Expand Down
4 changes: 2 additions & 2 deletions README.md
@@ -1,11 +1,11 @@
# Prysm: An Ethereum 2.0 Implementation Written in Go
# Prysm: An Ethereum Consensus Implementation Written in Go

[![Build status](https://badge.buildkite.com/b555891daf3614bae4284dcf365b2340cefc0089839526f096.svg?branch=master)](https://buildkite.com/prysmatic-labs/prysm)
[![Go Report Card](https://goreportcard.com/badge/github.com/prysmaticlabs/prysm)](https://goreportcard.com/report/github.com/prysmaticlabs/prysm)
[![ETH2.0_Spec_Version 1.0.0](https://img.shields.io/badge/ETH2.0%20Spec%20Version-v1.0.0-blue.svg)](https://github.com/ethereum/eth2.0-specs/tree/v1.0.0)
[![Discord](https://user-images.githubusercontent.com/7288322/34471967-1df7808a-efbb-11e7-9088-ed0b04151291.png)](https://discord.gg/CTYGPUJ)

This is the core repository for Prysm, a [Golang](https://golang.org/) implementation of the [Ethereum 2.0](https://ethereum.org/en/eth2/) specification, developed by [Prysmatic Labs](https://prysmaticlabs.com). See the [Changelog](https://github.com/prysmaticlabs/prysm/releases) for details of the latest releases and upcoming breaking changes.
This is the core repository for Prysm, a [Golang](https://golang.org/) implementation of the [Ethereum Consensus](https://ethereum.org/en/eth2/) specification, developed by [Prysmatic Labs](https://prysmaticlabs.com). See the [Changelog](https://github.com/prysmaticlabs/prysm/releases) for details of the latest releases and upcoming breaking changes.

### Getting Started

Expand Down
4 changes: 2 additions & 2 deletions TERMS_OF_SERVICE.md
Expand Up @@ -5,15 +5,15 @@ Effective as of Oct 14, 2020
By downloading, accessing or using the Prysm implementation (“Prysm”), you (referenced herein as “you” or the “user”) certify that you have read and agreed to the terms and conditions below (the “Terms”) which form a binding contract between you and Prysmatic Labs (referenced herein as “we” or “us”). If you do not agree to the Terms, do not download or use Prysm.

### About Prysm
Prysm is a client implementation for Ethereum 2.0 Phase 0 protocol for a proof-of-stake blockchain. To participate in the network, a user must send ETH from the Eth1.0 chain into a validator deposit contract, which will queue in the user as a validator in the system. Validators participate in proposing and voting on blocks in the protocol, and the network applies rewards/penalties based on their behavior. A detailed set of installation and usage instructions as well as breakdowns of each individual component are available in the official documentation portal, however, we do not warrant the accuracy, completeness or usefulness of this documentation. Any reliance you place on such information is strictly at your own risk.
Prysm is a client implementation for Ethereum consensus protocol for a proof-of-stake blockchain. To participate in the network, a user must send ETH from the Eth1.0 chain into a validator deposit contract, which will queue in the user as a validator in the system. Validators participate in proposing and voting on blocks in the protocol, and the network applies rewards/penalties based on their behavior. A detailed set of installation and usage instructions as well as breakdowns of each individual component are available in the official documentation portal, however, we do not warrant the accuracy, completeness or usefulness of this documentation. Any reliance you place on such information is strictly at your own risk.

### Licensing Terms
Prysm is a fully open-source software program licensed pursuant to the GNU General Public License v3.0.

The Prysmatic Labs name, the term “Prysm” and all related names, logos, product and service names, designs and slogans are trademarks of Prysmatic Labs or its affiliates and/or licensors. You must not use such marks without our prior written permission.

### Risks of Operating Prysm
The use of Prysm and acting as a validator on the Ethereum 2.0 network can lead to loss of money. Ethereum is still an experimental system and ETH remains a risky investment. You alone are responsible for your actions on Prysm including the security of your ETH and meeting any applicable minimum system requirements.
The use of Prysm and acting as a validator on the Ethereum network can lead to loss of money. Ethereum is still an experimental system and ETH remains a risky investment. You alone are responsible for your actions on Prysm including the security of your ETH and meeting any applicable minimum system requirements.

Use of Prysm and the ability to receive rewards or penalties may be affected at any time by mistakes made by the user or other users, software problems such as bugs, errors, incorrectly constructed transactions, unsafe cryptographic libraries or malware affecting the network, technical failures in the hardware of a user, security problems experienced by a user and/or actions or inactions of third parties and/or events experienced by third parties, among other risks. We cannot and do not guarantee that any user of Prysm will make money, that the Prysm network will operate in accordance with the documentation or that transactions will be effective or secure.

Expand Down
2 changes: 1 addition & 1 deletion 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 eth2 written in Go by [Prysmatic Labs](https://prysmaticlabs.com).
This is the main project folder for the beacon chain implementation of Ethereum written in Go by [Prysmatic Labs](https://prysmaticlabs.com).

You can also read our main [README](https://github.com/prysmaticlabs/prysm/blob/master/README.md) and join our active chat room on Discord.

Expand Down
4 changes: 2 additions & 2 deletions beacon-chain/blockchain/chain_info.go
Expand Up @@ -26,13 +26,13 @@ type ChainInfoFetcher interface {
CanonicalFetcher
}

// TimeFetcher retrieves the Eth2 data that's related to time.
// TimeFetcher retrieves the Ethereum consensus data that's related to time.
type TimeFetcher interface {
GenesisTime() time.Time
CurrentSlot() types.Slot
}

// GenesisFetcher retrieves the eth2 data related to its genesis.
// GenesisFetcher retrieves the Ethereum consensus data related to its genesis.
type GenesisFetcher interface {
GenesisValidatorRoot() [32]byte
}
Expand Down
3 changes: 1 addition & 2 deletions beacon-chain/blockchain/service.go
@@ -1,6 +1,5 @@
// Package blockchain defines the life-cycle of the blockchain at the core of
// eth2, including processing of new blocks and attestations using casper
// proof of stake.
// Ethereum, including processing of new blocks and attestations using proof of stake.
package blockchain

import (
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/cache/doc.go
@@ -1,5 +1,5 @@
// Package cache includes all important caches for the runtime
// of an eth2 beacon node, ensuring the node does not spend
// of an Ethereum Beacon Node, ensuring the node does not spend
// resources computing duplicate operations such as committee
// calculations for validators during the same epoch, etc.
package cache
2 changes: 1 addition & 1 deletion beacon-chain/core/blocks/genesis.go
@@ -1,5 +1,5 @@
// Package blocks contains block processing libraries according to
// the eth2spec.
// the Ethereum beacon chain spec.
package blocks

import (
Expand Down
Expand Up @@ -127,7 +127,7 @@ func weighJustificationAndFinalization(state iface.BeaconState,
}
}

// Process finalization according to ETH2.0 specifications.
// Process finalization according to Ethereum Beacon Chain specification.
justification := state.JustificationBits().Bytes()[0]

// 2nd/3rd/4th (0b1110) most recent epochs are justified, the 2nd using the 4th as source.
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/core/helpers/committee.go
@@ -1,4 +1,4 @@
// Package helpers contains helper functions outlined in the eth2 beacon chain spec, such as
// Package helpers contains helper functions outlined in the Ethereum Beacon Chain spec, such as
// computing committees, randao, rewards/penalties, and more.
package helpers

Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/core/state/state.go
@@ -1,6 +1,6 @@
// Package state implements the whole state transition
// function which consists of per slot, per-epoch transitions, and
// bootstrapping the genesis state according to the eth2 spec.
// bootstrapping the genesis state according to the Ethereum Beacon chain spec.
package state

import (
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/core/state/transition.go
Expand Up @@ -46,7 +46,7 @@ var processExitFunc = func(ctx context.Context, s iface.BeaconState, blk interfa
return b.ProcessVoluntaryExits(ctx, s, blk.Block().Body().VoluntaryExits())
}

// This defines the processing block routine as outlined in eth2 spec:
// This defines the processing block routine as outlined in the Ethereum Beacon Chain spec:
// https://github.com/ethereum/eth2.0-specs/blob/dev/specs/phase0/beacon-chain.md#block-processing
var processingPipeline = []processFunc{
b.ProcessBlockHeader,
Expand Down
8 changes: 4 additions & 4 deletions beacon-chain/db/alias.go
Expand Up @@ -2,23 +2,23 @@ package db

import "github.com/prysmaticlabs/prysm/beacon-chain/db/iface"

// ReadOnlyDatabase exposes Prysm's eth2 data backend for read access only, no information about
// ReadOnlyDatabase exposes Prysm's Ethereum data backend for read access only, no information about
// head info. For head info, use github.com/prysmaticlabs/prysm/blockchain.HeadFetcher.
type ReadOnlyDatabase = iface.ReadOnlyDatabase

// NoHeadAccessDatabase exposes Prysm's eth2 data backend for read/write access, no information
// NoHeadAccessDatabase exposes Prysm's Ethereum data backend for read/write access, no information
// about head info. For head info, use github.com/prysmaticlabs/prysm/blockchain.HeadFetcher.
type NoHeadAccessDatabase = iface.NoHeadAccessDatabase

// HeadAccessDatabase exposes Prysm's eth2 backend for read/write access with information about
// HeadAccessDatabase exposes Prysm's Ethereum backend for read/write access with information about
// chain head information. This interface should be used sparingly as the HeadFetcher is the source
// of truth around chain head information while this interface serves as persistent storage for the
// head fetcher.
//
// See github.com/prysmaticlabs/prysm/blockchain.HeadFetcher
type HeadAccessDatabase = iface.HeadAccessDatabase

// Database defines the necessary methods for Prysm's eth2 backend which may be implemented by any
// Database defines the necessary methods for Prysm's Ethereum backend which may be implemented by any
// key-value or relational database in practice. This is the full database interface which should
// not be used often. Prefer a more restrictive interface in this package.
type Database = iface.Database
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/db/db.go
@@ -1,5 +1,5 @@
// Package db defines the ability to create a new database
// for an eth2 beacon node.
// for an Ethereum Beacon Node.
package db

import (
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/db/filters/filter.go
Expand Up @@ -52,7 +52,7 @@ type QueryFilter struct {
}

// NewFilter instantiates a new QueryFilter type used to build filters for
// certain eth2 data types by attribute.
// certain Ethereum data types by attribute.
func NewFilter() *QueryFilter {
return &QueryFilter{
queries: make(map[FilterType]interface{}),
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/db/iface/interface.go
Expand Up @@ -107,7 +107,7 @@ type HeadAccessDatabase interface {
EnsureEmbeddedGenesis(ctx context.Context) error
}

// SlasherDatabase interface for persisting data related to detecting slashable offenses on eth2.
// SlasherDatabase interface for persisting data related to detecting slashable offenses on Ethereum.
type SlasherDatabase interface {
io.Closer
SaveLastEpochWrittenForValidators(
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/db/kv/blocks.go
Expand Up @@ -42,7 +42,7 @@ func (s *Store) Block(ctx context.Context, blockRoot [32]byte) (interfaces.Signe
return interfaces.WrappedPhase0SignedBeaconBlock(block), err
}

// HeadBlock returns the latest canonical block in eth2.
// HeadBlock returns the latest canonical block in the Ethereum Beacon Chain.
func (s *Store) HeadBlock(ctx context.Context) (interfaces.SignedBeaconBlock, error) {
ctx, span := trace.StartSpan(ctx, "BeaconDB.HeadBlock")
defer span.End()
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/db/kv/kv.go
Expand Up @@ -54,7 +54,7 @@ type Config struct {
}

// Store defines an implementation of the Prysm Database interface
// using BoltDB as the underlying persistent kv-store for eth2.
// using BoltDB as the underlying persistent kv-store for Ethereum Beacon Nodes.
type Store struct {
db *bolt.DB
databasePath string
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/db/slasherkv/kv.go
Expand Up @@ -29,7 +29,7 @@ type Config struct {
}

// Store defines an implementation of the Prysm Database interface
// using BoltDB as the underlying persistent kv-store for eth2.
// using BoltDB as the underlying persistent kv-store for Ethereum consensus.
type Store struct {
db *bolt.DB
databasePath string
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/forkchoice/doc.go
@@ -1,5 +1,5 @@
/*
Package forkchoice implements the service to support fork choice for the eth2 beacon chain. This contains the
Package forkchoice implements the service to support fork choice for the Ethereum beacon chain. This contains the
necessary components to track latest validators votes, and balances. Then a store object to be used
to calculate head. High level fork choice summary:
https://notes.ethereum.org/@vbuterin/rkhCgQteN?type=view#LMD-GHOST-fork-choice-rule
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/node/registration/powchain.go
Expand Up @@ -18,7 +18,7 @@ func PowchainPreregistration(cliCtx *cli.Context) (depositContractAddress string

if cliCtx.String(flags.HTTPWeb3ProviderFlag.Name) == "" && len(cliCtx.StringSlice(flags.FallbackWeb3ProviderFlag.Name)) == 0 {
log.Error(
"No ETH1 node specified to run with the beacon node. Please consider running your own ETH1 node for better uptime, security, and decentralization of ETH2. Visit https://docs.prylabs.network/docs/prysm-usage/setup-eth1 for more information.",
"No ETH1 node specified to run with the beacon node. Please consider running your own Ethereum proof-of-work node for better uptime, security, and decentralization of Ethereum. Visit https://docs.prylabs.network/docs/prysm-usage/setup-eth1 for more information.",
)
log.Error(
"You will need to specify --http-web3provider and/or --fallback-web3provider to attach an eth1 node to the prysm node. Without an eth1 node block proposals for your validator will be affected and the beacon node will not be able to initialize the genesis state.",
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/p2p/doc.go
@@ -1,5 +1,5 @@
/*
Package p2p implements the Ethereum 2.0 networking specification.
Package p2p implements the Ethereum consensus networking specification.
Canonical spec reference: https://github.com/ethereum/eth2.0-specs/blob/dev/specs/phase0/p2p-interface.md
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/p2p/encoder/network_encoding.go
Expand Up @@ -4,7 +4,7 @@ import (
"io"
)

// NetworkEncoding represents an encoder compatible with Ethereum 2.0 p2p.
// NetworkEncoding represents an encoder compatible with Ethereum consensus p2p.
type NetworkEncoding interface {
// DecodeGossip to the provided gossip message. The interface must be a pointer to the decoding destination.
DecodeGossip([]byte, interface{}) error
Expand Down
6 changes: 3 additions & 3 deletions beacon-chain/p2p/fork.go
Expand Up @@ -16,7 +16,7 @@ import (
"github.com/sirupsen/logrus"
)

// ENR key used for eth2-related fork data.
// ENR key used for Ethereum consensus-related fork data.
var eth2ENRKey = params.BeaconNetworkConfig().ETH2Key

// ForkDigest returns the current fork digest of
Expand Down Expand Up @@ -78,7 +78,7 @@ func (s *Service) compareForkENR(record *enr.Record) error {
return nil
}

// Adds a fork entry as an ENR record under the eth2EnrKey for
// Adds a fork entry as an ENR record under the Ethereum consensus EnrKey for
// the local node. The fork entry is an ssz-encoded enrForkID type
// which takes into account the current fork version from the current
// epoch to create a fork digest, the next fork version,
Expand Down Expand Up @@ -123,7 +123,7 @@ func addForkEntry(
}

// Retrieves an enrForkID from an ENR record by key lookup
// under the eth2EnrKey.
// under the Ethereum consensus EnrKey
func forkEntry(record *enr.Record) (*pb.ENRForkID, error) {
sszEncodedForkEntry := make([]byte, 16)
entry := enr.WithEntry(eth2ENRKey, &sszEncodedForkEntry)
Expand Down
4 changes: 2 additions & 2 deletions beacon-chain/p2p/fork_test.go
Expand Up @@ -58,7 +58,7 @@ func TestStartDiscv5_DifferentForkDigests(t *testing.T) {

// We give every peer a different genesis validators root, which
// will cause each peer to have a different ForkDigest, preventing
// them from connecting according to our discovery rules for eth2.
// them from connecting according to our discovery rules for Ethereum consensus.
root := make([]byte, 32)
copy(root, strconv.Itoa(port))
s = &Service{
Expand Down Expand Up @@ -149,7 +149,7 @@ func TestStartDiscv5_SameForkDigests_DifferentNextForkData(t *testing.T) {

// We give every peer a different genesis validators root, which
// will cause each peer to have a different ForkDigest, preventing
// them from connecting according to our discovery rules for eth2.
// them from connecting according to our discovery rules for Ethereum consensus.
s = &Service{
cfg: cfg,
genesisTime: genesisTime,
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/p2p/peers/status.go
@@ -1,4 +1,4 @@
// Package peers provides information about peers at the eth2 protocol level.
// Package peers provides information about peers at the Ethereum consensus protocol level.
//
// "Protocol level" is the level above the network level, so this layer never sees or interacts with
// (for example) hosts that are uncontactable due to being down, firewalled, etc. Instead, this works
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/p2p/pubsub.go
Expand Up @@ -123,7 +123,7 @@ func (s *Service) peerInspector(peerMap map[peer.ID]*pubsub.PeerScoreSnapshot) {

// Content addressable ID function.
//
// ETH2 spec defines the message ID as:
// Ethereum Beacon Chain spec defines the message ID as:
// The `message-id` of a gossipsub message MUST be the following 20 byte value computed from the message data:
// If `message.data` has a valid snappy decompression, set `message-id` to the first 20 bytes of the `SHA256` hash of
// the concatenation of `MESSAGE_DOMAIN_VALID_SNAPPY` with the snappy decompressed message data,
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/p2p/service.go
@@ -1,4 +1,4 @@
// Package p2p defines the network protocol implementation for eth2
// Package p2p defines the network protocol implementation for Ethereum consensus
// used by beacon nodes, including peer discovery using discv5, gossip-sub
// using libp2p, and handing peer lifecycles + handshakes.
package p2p
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/package/BUILD.bazel
Expand Up @@ -40,7 +40,7 @@ pkg_deb(
"etc/prysm/beacon-chain.yaml",
],
data = ":debian-data",
description = "Prysm Beacon Chain - Ethereum 2.0 network communications",
description = "Prysm Beacon Chain - Ethereum consensus network communications",
homepage = "https://prysmaticlabs.com/",
maintainer = "Prysmatic Labs <contact@prysmaticlabs.com>",
package = "prysm-beacon-chain",
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/package/prysm-beacon-chain.service
@@ -1,5 +1,5 @@
[Unit]
Description=Prysm Eth2 Beacon Chain
Description=Prysm Ethereum Beacon Chain
Wants=network-online.target
After=network-online.target

Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/powchain/service.go
Expand Up @@ -85,7 +85,7 @@ type ChainStartFetcher interface {
ClearPreGenesisData()
}

// ChainInfoFetcher retrieves information about eth1 metadata at the eth2 genesis time.
// ChainInfoFetcher retrieves information about eth1 metadata at the Ethereum consensus genesis time.
type ChainInfoFetcher interface {
Eth2GenesisPowchainInfo() (uint64, *big.Int)
IsConnectedToETH1() bool
Expand Down
2 changes: 1 addition & 1 deletion beacon-chain/rpc/beacon/attestations.go
Expand Up @@ -383,7 +383,7 @@ func (bs *Server) collectReceivedAttestations(ctx context.Context) {
// yet processed. Pool attestations eventually expire as the slot
// advances, so an attestation missing from this request does not imply
// that it was included in a block. The attestation may have expired.
// Refer to the ethereum 2.0 specification for more details on how
// Refer to the ethereum consensus specification for more details on how
// attestations are processed and when they are no longer valid.
// https://github.com/ethereum/eth2.0-specs/blob/dev/specs/core/0_beacon-chain.md#attestations
func (bs *Server) AttestationPool(
Expand Down

0 comments on commit a860648

Please sign in to comment.