consensus

Documentation

Overview

Package consensus implements different Ethereum consensus engines.

Index

• Variables
• type ChainReader
• type ChainReaderCtt
• type Engine
• type EngineCtt
• type PoW
• type PoliceVerifiedHeader
  • func (h *PoliceVerifiedHeader) Hash() common.Hash

Variables

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")

	ErrInvalidHeader = errors.New("invalid header")
)

Types

type ChainReader

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

	// Config retrieves the blockchain's chain configuration.
	ElephantConfig() *params.ElephantChainConfig

	// 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

	// CurrEleSealersBlockNum retrieves the number of the nearest elephant sealer block from the Ethereum chain.
	CurrEleSealersBlockNum() rpc.BlockNumber

	// CurrEleSealersBlockHash retrieves the hash of the nearest elephant sealer block from the Ethereum chain.
	CurrEleSealersBlockHash() common.Hash

	// LastEleSealersBlockNum retrieves the number of the one before the nearest elephant sealer block from the Ethereum chain.
	LastEleSealersBlockNum() rpc.BlockNumber

	// LastEleSealersBlockHash retrieves the hash of the one before the nearest elephant sealer block from the Ethereum chain.
	LastEleSealersBlockHash() common.Hash
}

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

type ChainReaderCtt

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

	// Config retrieves the blockchain's chain configuration.
	ElephantConfig() *params.ElephantChainConfig

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

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

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

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

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

ChainReader defines a small collection of methods needed to access the local blockchain during header and/or uncle 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)

	// VerifyUncles verifies that the given block's uncles conform to the consensus
	// rules of a given engine.
	VerifyUncles(chain ChainReader, block *types.Block) 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_eth.StateDB, txs []*types.Transaction,
		uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error)

	// Seal generates a new block for the given input block with the local miner's
	// seal place on top.
	Seal(chain ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)

	// CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty
	// that a new block should have.
	CalcDifficulty(chain ChainReader, time uint64, parent *types.Header) *big.Int

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

Engine is an algorithm agnostic consensus engine.

type EngineCtt

type EngineCtt 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_elephant.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 ChainReaderCtt, header *types_elephant.Header) error

	// VerifyBFT verifies that the given block's BFT records conform to the consensus
	// rules of the engine.
	VerifyBFT(chain ChainReaderCtt, block *types_elephant.Block) 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 ChainReaderCtt, headers []*types_elephant.Header) (chan<- struct{}, <-chan 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 ChainReaderCtt, header *types_elephant.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 ChainReaderCtt, header *types_elephant.Header, state *state_elephant.StateDB, txs []*types_elephant.Transaction,
		inputTxs []*types_elephant.ShardingTxBatch,
		uncles []*types_elephant.Header, receipts []*types_elephant.Receipt, eBase *common.Address) (*types_elephant.Block, error)

	// Seal generates a new block for the given input block with the local miner's
	// seal place on top.
	Seal(chain ChainReaderCtt, block *types_elephant.Block, stop <-chan struct{}) (*types_elephant.Block, []*types_elephant.HBFTStageCompleted, error)

	// CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty
	// that a new block should have.
	CalcDifficulty(chain ChainReaderCtt, time uint64, parent *types_elephant.Header) *big.Int

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

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.

type PoliceVerifiedHeader

type PoliceVerifiedHeader struct {
	ShardingID uint16
	BlockNum   uint64
	LampBase   *common.Hash
	Header     *common.Hash
	Previous   []*common.Hash

	Sign string
	// contains filtered or unexported fields
}

PoliceVerifiedHeader is a result that contains the header verified by the police representing it's transactions are valid

func (*PoliceVerifiedHeader) Hash

func (h *PoliceVerifiedHeader) Hash() common.Hash