consensus

package
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Jun 17, 2019 License: GPL-3.0 Imports: 16 Imported by: 0

Documentation

Overview

Package consensus implements different Ethereum consensus engines.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrUnknownAncestor is returned when validating a block requires an ancestor
	// that is unknown.
	ErrUnknownAncestor = errors.New("unknown ancestor")

	// ErrPrunedAncestor is returned when validating a block requires an ancestor
	// that is known, but the state of which is not available.
	ErrPrunedAncestor = errors.New("pruned ancestor")

	// ErrFutureBlock is returned when a block's timestamp is in the future according
	// to the current node.
	ErrFutureBlock = errors.New("block in the future")

	// ErrInvalidNumber is returned if a block's number doesn't equal it's parent's
	// plus one.
	ErrInvalidNumber = errors.New("invalid block number")
)
View Source 
var (
	ExtraSeal = 65 // Fixed number of extra-data suffix bytes reserved for signer seal
	// ErrMissingSignature is returned if a block's extra-data section doesn't seem
	// to contain a 65 byte secp256k1 signature.
	ErrMissingSignature = errors.New("extra-data 65 byte signature suffix missing")
)

Functions

func Ecrecover added in v0.7.0 

func Ecrecover(header *types.Header, sigcache *lru.ARCCache) (common.Address, error)

Ecrecover extracts the Ethereum account address from a signed header.

func SigHash added in v0.7.0 

func SigHash(header *types.Header) (hash common.Hash)

SigHash returns the hash which is used as input for the proof-of-authority signing. It is the hash of the entire header apart from the 65 byte signature contained at the end of the extra data.

Note, the method requires the extra data to be at least 65 bytes, otherwise it panics. This is done to avoid accidentally using both forms (signature present or not), which could be abused to produce different hashes for the same header.

Types

type Bft added in v0.7.0 

type Bft interface {
	Engine

	// Returns the current consensus node address list.
	ConsensusNodes() ([]discover.NodeID, error)

	// Returns whether the current node is out of the block
	ShouldSeal(curTime int64) (bool, error)

	CalcBlockDeadline(timePoint int64) (time.Time, error)
	CalcNextBlockTime(timePoint int64) (time.Time, error)

	// Process the BFT signatures
	OnPong(nodeID discover.NodeID, netLatency int64) error

	CheckConsensusNode(address common.Address) bool

	IsConsensusNode() bool

	// At present, the highest reasonable block, when the node is out of the block, it needs to generate the block based on the highest reasonable block.
	HighestLogicalBlock() *types.Block

	HighestConfirmedBlock() *types.Block

	GetBlock(hash common.Hash, number uint64) *types.Block

	GetBlockWithoutLock(hash common.Hash, number uint64) *types.Block

	SetPrivateKey(privateKey *ecdsa.PrivateKey)

	IsSignedBySelf(sealHash common.Hash, signature []byte) bool

	Evidences() string

	CommitBlockBP(block *types.Block, txs int, gasUsed uint64, elapse time.Duration)
}

type BftMock added in v0.7.0 

type BftMock struct {
}

func (*BftMock) APIs added in v0.7.0 

func (bm *BftMock) APIs(chain ChainReader) []rpc.API

APIs returns the RPC APIs this consensus engine provides.

func (*BftMock) Author added in v0.7.0 

func (bm *BftMock) Author(header *types.Header) (common.Address, error)

Author retrieves the Ethereum address of the account that minted the given block, which may be different from the header's coinbase if a consensus engine is based on signatures.

func (*BftMock) CalcDifficulty added in v0.7.0 

func (bm *BftMock) CalcDifficulty(chain ChainReader, time uint64, parent *types.Header) *big.Int

CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty that a new block should have.

func (*BftMock) CheckConsensusNode added in v0.7.0 

func (bm *BftMock) CheckConsensusNode(nodeID discover.NodeID) (bool, error)

func (*BftMock) Close added in v0.7.0 

func (bm *BftMock) Close() error

Close terminates any background threads maintained by the consensus engine.

func (*BftMock) ConsensusNodes added in v0.7.0 

func (bm *BftMock) ConsensusNodes() ([]discover.NodeID, error)

Returns the current consensus node address list.

func (*BftMock) CurrentBlock added in v0.7.0 

func (bm *BftMock) CurrentBlock() *types.Block

func (*BftMock) FastSyncCommitHead added in v0.7.0 

func (bm *BftMock) FastSyncCommitHead() <-chan error

func (*BftMock) Finalize added in v0.7.0 

func (bm *BftMock) Finalize(chain ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction,
	receipts []*types.Receipt) (*types.Block, error)

Finalize runs any post-transaction state modifications (e.g. block rewards) and assembles the final block. Note: The block header and state database might be updated to reflect any consensus rules that happen at finalization (e.g. block rewards).

func (*BftMock) GetBlock added in v0.7.0 

func (bm *BftMock) GetBlock(hash common.Hash, number uint64) *types.Block

func (*BftMock) GetBlockByHash added in v0.7.0 

func (bm *BftMock) GetBlockByHash(hash common.Hash) *types.Block

func (*BftMock) HasBlock added in v0.7.0 

func (bm *BftMock) HasBlock(hash common.Hash, number uint64) bool

func (*BftMock) HighestConfirmedBlock added in v0.7.0 

func (bm *BftMock) HighestConfirmedBlock() *types.Block

func (*BftMock) HighestLogicalBlock added in v0.7.0 

func (bm *BftMock) HighestLogicalBlock() *types.Block

At present, the highest reasonable block, when the node is out of the block, it needs to generate the block based on the highest reasonable block.

func (*BftMock) InsertChain added in v0.7.0 

func (bm *BftMock) InsertChain(block *types.Block, errCh chan error)

func (*BftMock) IsConsensusNode added in v0.7.0 

func (bm *BftMock) IsConsensusNode() (bool, error)

func (*BftMock) NextBaseBlock added in v0.7.0 

func (bm *BftMock) NextBaseBlock() *types.Block

func (*BftMock) OnBlockSignature added in v0.7.0 

func (bm *BftMock) OnBlockSignature(chain ChainReader, nodeID discover.NodeID, sig *cbfttypes.BlockSignature) error

Received a new block signature Need to verify if the signature is signed by nodeID

func (*BftMock) OnBlockSynced added in v0.7.0 

func (bm *BftMock) OnBlockSynced()

Send a signal if a block synced from other peer.

func (*BftMock) OnNewBlock added in v0.7.0 

func (bm *BftMock) OnNewBlock(chain ChainReader, block *types.Block) error

Process the BFT signatures

func (*BftMock) OnPong added in v0.7.0 

func (bm *BftMock) OnPong(nodeID discover.NodeID, netLatency int64) error

Process the BFT signatures

func (*BftMock) Prepare added in v0.7.0 

func (bm *BftMock) Prepare(chain ChainReader, header *types.Header) error

Prepare initializes the consensus fields of a block header according to the rules of a particular engine. The changes are executed inline.

func (*BftMock) Protocols added in v0.7.0 

func (bm *BftMock) Protocols() []p2p.Protocol

func (*BftMock) Seal added in v0.7.0 

func (bm *BftMock) Seal(chain ChainReader, block *types.Block, results chan<- *types.Block, stop <-chan struct{}) error

Seal generates a new sealing request for the given input block and pushes the result into the given channel.

Note, the method returns immediately and will send the result async. More than one result may also be returned depending on the consensus algorithm.

func (*BftMock) SealHash added in v0.7.0 

func (bm *BftMock) SealHash(header *types.Header) common.Hash

SealHash returns the hash of a block prior to it being sealed.

func (*BftMock) SetPrivateKey added in v0.7.0 

func (bm *BftMock) SetPrivateKey(privateKey *ecdsa.PrivateKey)

func (*BftMock) ShouldSeal added in v0.7.0 

func (bm *BftMock) ShouldSeal(curTime int64) (bool, error)

Returns whether the current node is out of the block

func (*BftMock) Status added in v0.7.0 

func (bm *BftMock) Status() string

func (*BftMock) VerifyHeader added in v0.7.0 

func (bm *BftMock) VerifyHeader(chain ChainReader, header *types.Header, seal bool) error

VerifyHeader checks whether a header conforms to the consensus rules of a given engine. Verifying the seal may be done optionally here, or explicitly via the VerifySeal method.

func (*BftMock) VerifyHeaders added in v0.7.0 

func (bm *BftMock) VerifyHeaders(chain ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)

VerifyHeaders is similar to VerifyHeader, but verifies a batch of headers concurrently. The method returns a quit channel to abort the operations and a results channel to retrieve the async verifications (the order is that of the input slice).

func (*BftMock) VerifySeal added in v0.7.0 

func (bm *BftMock) VerifySeal(chain ChainReader, header *types.Header) error

VerifySeal checks whether the crypto seal on a header is valid according to the consensus rules of the given engine.

func (*BftMock) VerifyUncles added in v0.7.0 

func (bm *BftMock) VerifyUncles(chain ChainReader, block *types.Block) error

VerifyUncles verifies that the given block's uncles conform to the consensus rules of a given engine.

type ChainReader 

type ChainReader interface {
	// Config retrieves the blockchain's chain configuration.
	Config() *params.ChainConfig

	// CurrentHeader retrieves the current header from the local chain.
	CurrentHeader() *types.Header

	// GetHeader retrieves a block header from the database by hash and number.
	GetHeader(hash common.Hash, number uint64) *types.Header

	// GetHeaderByNumber retrieves a block header from the database by number.
	GetHeaderByNumber(number uint64) *types.Header

	// GetHeaderByHash retrieves a block header from the database by its hash.
	GetHeaderByHash(hash common.Hash) *types.Header

	// GetBlock retrieves a block from the database by hash and number.
	GetBlock(hash common.Hash, number uint64) *types.Block
}

ChainReader defines a small collection of methods needed to access the local blockchain during header verification.

type Engine 

type Engine interface {
	// Author retrieves the Ethereum address of the account that minted the given
	// block, which may be different from the header's coinbase if a consensus
	// engine is based on signatures.
	Author(header *types.Header) (common.Address, error)

	// VerifyHeader checks whether a header conforms to the consensus rules of a
	// given engine. Verifying the seal may be done optionally here, or explicitly
	// via the VerifySeal method.
	VerifyHeader(chain ChainReader, header *types.Header, seal bool) error

	// VerifyHeaders is similar to VerifyHeader, but verifies a batch of headers
	// concurrently. The method returns a quit channel to abort the operations and
	// a results channel to retrieve the async verifications (the order is that of
	// the input slice).
	VerifyHeaders(chain ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)

	// VerifySeal checks whether the crypto seal on a header is valid according to
	// the consensus rules of the given engine.
	VerifySeal(chain ChainReader, header *types.Header) error

	// Prepare initializes the consensus fields of a block header according to the
	// rules of a particular engine. The changes are executed inline.
	Prepare(chain ChainReader, header *types.Header) error

	// Finalize runs any post-transaction state modifications (e.g. block rewards)
	// and assembles the final block.
	// Note: The block header and state database might be updated to reflect any
	// consensus rules that happen at finalization (e.g. block rewards).
	Finalize(chain ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction,
		receipts []*types.Receipt) (*types.Block, error)

	// Seal generates a new sealing request for the given input block and pushes
	// the result into the given channel.
	//
	// Note, the method returns immediately and will send the result async. More
	// than one result may also be returned depending on the consensus algorithm.
	Seal(chain ChainReader, block *types.Block, results chan<- *types.Block, stop <-chan struct{}) error

	// SealHash returns the hash of a block prior to it being sealed.
	SealHash(header *types.Header) common.Hash

	// APIs returns the RPC APIs this consensus engine provides.
	APIs(chain ChainReader) []rpc.API

	Protocols() []p2p.Protocol

	NextBaseBlock() *types.Block

	InsertChain(block *types.Block, errCh chan error)

	HasBlock(hash common.Hash, number uint64) bool

	Status() string
	GetBlockByHash(hash common.Hash) *types.Block

	CurrentBlock() *types.Block

	FastSyncCommitHead() <-chan error

	// Close terminates any background threads maintained by the consensus engine.
	Close() error
}

Engine is an algorithm agnostic consensus engine.

type PoW 

type PoW interface {
	Engine

	// Hashrate returns the current mining hashrate of a PoW consensus engine.
	Hashrate() float64
}

PoW is a consensus engine based on proof-of-work.

Source Files

View all Source files

Directories

Path Synopsis
Package bft implements the BFT consensus engine.
 Package bft implements the BFT consensus engine.
prepare

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.