blockchain

package
v1.0.0-alpha.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 1, 2020 License: GPL-3.0 Imports: 47 Imported by: 90

Documentation

Overview

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.

Index

Constants

This section is empty.

Variables

View Source 
var ErrTargetRootNotInDB = errors.New("target root does not exist in db")

ErrTargetRootNotInDB returns when the target block root of an attestation cannot be found in the beacon database.

Functions

This section is empty.

Types

type AttestationReceiver 

type AttestationReceiver interface {
	ReceiveAttestationNoPubsub(ctx context.Context, att *ethpb.Attestation) error
	IsValidAttestation(ctx context.Context, att *ethpb.Attestation) bool
}

AttestationReceiver interface defines the methods of chain service receive and processing new attestations.

type BlockReceiver 

type BlockReceiver interface {
	ReceiveBlock(ctx context.Context, block *ethpb.SignedBeaconBlock) error
	ReceiveBlockNoPubsub(ctx context.Context, block *ethpb.SignedBeaconBlock) error
	ReceiveBlockNoPubsubForkchoice(ctx context.Context, block *ethpb.SignedBeaconBlock) error
	ReceiveBlockNoVerify(ctx context.Context, block *ethpb.SignedBeaconBlock) error
	HasInitSyncBlock(root [32]byte) bool
}

BlockReceiver interface defines the methods of chain service receive and processing new blocks.

type ChainInfoFetcher 

type ChainInfoFetcher interface {
	HeadFetcher
	FinalizationFetcher
	GenesisFetcher
}

ChainInfoFetcher defines a common interface for methods in blockchain service which directly retrieves chain info related data.

type Config 

type Config struct {
	BeaconBlockBuf    int
	ChainStartFetcher powchain.ChainStartFetcher
	BeaconDB          db.HeadAccessDatabase
	DepositCache      *depositcache.DepositCache
	AttPool           attestations.Pool
	ExitPool          *voluntaryexits.Pool
	SlashingPool      *slashings.Pool
	P2p               p2p.Broadcaster
	MaxRoutines       int64
	StateNotifier     statefeed.Notifier
	ForkChoiceStore   f.ForkChoicer
	OpsService        *attestations.Service
	StateGen          *stategen.State
}

Config options for the service.

type FinalizationFetcher 

type FinalizationFetcher interface {
	FinalizedCheckpt() *ethpb.Checkpoint
	CurrentJustifiedCheckpt() *ethpb.Checkpoint
	PreviousJustifiedCheckpt() *ethpb.Checkpoint
}

FinalizationFetcher defines a common interface for methods in blockchain service which directly retrieves finalization and justification related data.

type ForkFetcher 

type ForkFetcher interface {
	CurrentFork() *pb.Fork
}

ForkFetcher retrieves the current fork information of the Ethereum beacon chain.

type GenesisFetcher added in v1.0.0 

type GenesisFetcher interface {
	GenesisValidatorRoot() [32]byte
}

GenesisFetcher retrieves the eth2 data related to its genesis.

type HeadFetcher 

type HeadFetcher interface {
	HeadSlot() uint64
	HeadRoot(ctx context.Context) ([]byte, error)
	HeadBlock(ctx context.Context) (*ethpb.SignedBeaconBlock, error)
	HeadState(ctx context.Context) (*state.BeaconState, error)
	HeadValidatorsIndices(epoch uint64) ([]uint64, error)
	HeadSeed(epoch uint64) ([32]byte, error)
	HeadGenesisValidatorRoot() [32]byte
}

HeadFetcher defines a common interface for methods in blockchain service which directly retrieves head related data.

type ParticipationFetcher added in v0.3.0 

type ParticipationFetcher interface {
	Participation(epoch uint64) *precompute.Balance
}

ParticipationFetcher defines a common interface for methods in blockchain service which directly retrieves validator participation related data.

type Service 

type Service struct {
	// contains filtered or unexported fields
}

Service represents a service that handles the internal logic of managing the full PoS beacon chain.

func NewService 

func NewService(ctx context.Context, cfg *Config) (*Service, error)

NewService instantiates a new block service instance that will be registered into a running beacon node.

func (*Service) ClearCachedStates added in v0.3.2 

func (s *Service) ClearCachedStates()

ClearCachedStates removes all stored caches states. This is done after the node is synced.

func (*Service) CurrentFork 

func (s *Service) CurrentFork() *pb.Fork

CurrentFork retrieves the latest fork information of the beacon chain.

func (*Service) CurrentJustifiedCheckpt added in v0.3.0 

func (s *Service) CurrentJustifiedCheckpt() *ethpb.Checkpoint

CurrentJustifiedCheckpt returns the current justified checkpoint from head state.

func (*Service) CurrentSlot added in v0.3.2 

func (s *Service) CurrentSlot() uint64

CurrentSlot returns the current slot based on time.

func (*Service) FinalizedCheckpt 

func (s *Service) FinalizedCheckpt() *ethpb.Checkpoint

FinalizedCheckpt returns the latest finalized checkpoint from head state.

func (*Service) GenesisTime 

func (s *Service) GenesisTime() time.Time

GenesisTime returns the genesis time of beacon chain.

func (*Service) GenesisValidatorRoot added in v1.0.0 

func (s *Service) GenesisValidatorRoot() [32]byte

GenesisValidatorRoot returns the genesis validator root of the chain.

func (*Service) HasInitSyncBlock added in v0.3.9 

func (s *Service) HasInitSyncBlock(root [32]byte) bool

HasInitSyncBlock returns true if the block of the input root exists in initial sync blocks cache.

func (*Service) HeadBlock 

func (s *Service) HeadBlock(ctx context.Context) (*ethpb.SignedBeaconBlock, error)

HeadBlock returns the head block of the chain. If the head state is nil from service struct, it will attempt to get the head block from DB.

func (*Service) HeadGenesisValidatorRoot added in v1.0.0 

func (s *Service) HeadGenesisValidatorRoot() [32]byte

HeadGenesisValidatorRoot returns genesis validator root of the head state.

func (*Service) HeadRoot 

func (s *Service) HeadRoot(ctx context.Context) ([]byte, error)

HeadRoot returns the root of the head of the chain.

func (*Service) HeadSeed added in v0.3.0 

func (s *Service) HeadSeed(epoch uint64) ([32]byte, error)

HeadSeed returns the seed from the head view of a given epoch.

func (*Service) HeadSlot 

func (s *Service) HeadSlot() uint64

HeadSlot returns the slot of the head of the chain.

func (*Service) HeadState 

func (s *Service) HeadState(ctx context.Context) (*state.BeaconState, error)

HeadState returns the head state of the chain. If the head state is nil from service struct, it will attempt to get the head state from DB.

func (*Service) HeadValidatorsIndices added in v0.3.0 

func (s *Service) HeadValidatorsIndices(epoch uint64) ([]uint64, error)

HeadValidatorsIndices returns a list of active validator indices from the head view of a given epoch.

func (*Service) IsValidAttestation added in v0.3.2 

func (s *Service) IsValidAttestation(ctx context.Context, att *ethpb.Attestation) bool

IsValidAttestation returns true if the attestation can be verified against its pre-state.

func (*Service) Participation added in v0.3.0 

func (s *Service) Participation(epoch uint64) *precompute.Balance

Participation returns the participation stats of a given epoch.

func (*Service) PreviousJustifiedCheckpt added in v0.3.0 

func (s *Service) PreviousJustifiedCheckpt() *ethpb.Checkpoint

PreviousJustifiedCheckpt returns the previous justified checkpoint from head state.

func (*Service) ReceiveAttestationNoPubsub 

func (s *Service) ReceiveAttestationNoPubsub(ctx context.Context, att *ethpb.Attestation) error

ReceiveAttestationNoPubsub is a function that defines the operations that are preformed on attestation that is received from regular sync. The operations consist of:

  1. Validate attestation, update validator's latest vote
  2. Apply fork choice to the processed attestation
  3. Save latest head info

func (*Service) ReceiveBlock 

func (s *Service) ReceiveBlock(ctx context.Context, block *ethpb.SignedBeaconBlock) error

ReceiveBlock is a function that defines the operations that are preformed on blocks that is received from rpc service. The operations consists of:

  1. Gossip block to other peers
  2. Validate block, apply state transition and update check points
  3. Apply fork choice to the processed block
  4. Save latest head info

func (*Service) ReceiveBlockNoPubsub 

func (s *Service) ReceiveBlockNoPubsub(ctx context.Context, block *ethpb.SignedBeaconBlock) error

ReceiveBlockNoPubsub is a function that defines the the operations (minus pubsub) that are preformed on blocks that is received from regular sync service. The operations consists of:

  1. Validate block, apply state transition and update check points
  2. Apply fork choice to the processed block
  3. Save latest head info

func (*Service) ReceiveBlockNoPubsubForkchoice 

func (s *Service) ReceiveBlockNoPubsubForkchoice(ctx context.Context, block *ethpb.SignedBeaconBlock) error

ReceiveBlockNoPubsubForkchoice is a function that defines the all operations (minus pubsub and forkchoice) that are preformed blocks that is received from initial sync service. The operations consists of:

  1. Validate block, apply state transition and update check points
  2. Save latest head info

func (*Service) ReceiveBlockNoVerify 

func (s *Service) ReceiveBlockNoVerify(ctx context.Context, block *ethpb.SignedBeaconBlock) error

ReceiveBlockNoVerify runs state transition on a input block without verifying the block's BLS contents. Depends on the security model, this is the "minimal" work a node can do to sync the chain. It simulates light client behavior and assumes 100% trust with the syncing peer.

func (*Service) Start 

func (s *Service) Start()

Start a blockchain service's main event loop.

func (*Service) Status 

func (s *Service) Status() error

Status always returns nil unless there is an error condition that causes this service to be unhealthy.

func (*Service) Stop 

func (s *Service) Stop() error

Stop the blockchain service's main event loop and associated goroutines.

func (*Service) TreeHandler added in v0.3.2 

func (s *Service) TreeHandler(w http.ResponseWriter, _ *http.Request)

TreeHandler is a handler to serve /tree page in metrics.

type TimeFetcher added in v0.3.2 

type TimeFetcher interface {
	GenesisTime() time.Time
	CurrentSlot() uint64
}

TimeFetcher retrieves the Eth2 data that's related to time.

Source Files

View all Source files

Directories

Path Synopsis
Package testing includes useful mocks for writing unit tests which depend on logic from the blockchain package.
 Package testing includes useful mocks for writing unit tests which depend on logic from the blockchain package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.