Documentation ¶
Overview ¶
Package consensus implements different Ethereum consensus engines.
Index ¶
- Variables
- func Ecrecover(header *types.Header, sigcache *lru.ARCCache) (common.Address, error)
- func SigHash(header *types.Header) (hash common.Hash)
- type Agency
- type Bft
- type BftMock
- func (bm *BftMock) APIs(chain ChainReader) []rpc.API
- func (bm *BftMock) Author(header *types.Header) (common.Address, error)
- func (bm *BftMock) CalcBlockDeadline(timePoint time.Time) time.Time
- func (bm *BftMock) CalcDifficulty(chain ChainReader, time uint64, parent *types.Header) *big.Int
- func (bm *BftMock) CalcNextBlockTime(timePoint time.Time) time.Time
- func (bm *BftMock) CheckConsensusNode(nodeID discover.NodeID) (bool, error)
- func (bm *BftMock) Close() error
- func (bm *BftMock) ConsensusNodes() ([]discover.NodeID, error)
- func (bm *BftMock) CurrentBlock() *types.Block
- func (bm *BftMock) DecodeExtra(extra []byte) (common.Hash, uint64, error)
- func (bm *BftMock) Evidences() string
- func (bm *BftMock) FastSyncCommitHead(block *types.Block) error
- func (bm *BftMock) Finalize(chain ChainReader, header *types.Header, state *state.StateDB, ...) (*types.Block, error)
- func (bm *BftMock) GetBlock(hash common.Hash, number uint64) *types.Block
- func (bm *BftMock) GetBlockByHash(hash common.Hash) *types.Block
- func (bm *BftMock) GetBlockByHashAndNum(hash common.Hash, number uint64) *types.Block
- func (bm *BftMock) GetBlockWithoutLock(hash common.Hash, number uint64) *types.Block
- func (bm *BftMock) GetPrepareQC(number uint64) *ctypes.QuorumCert
- func (bm *BftMock) HasBlock(hash common.Hash, number uint64) bool
- func (bm *BftMock) HighestConfirmedBlock() *types.Block
- func (bm *BftMock) HighestLogicalBlock() *types.Block
- func (bm *BftMock) InsertChain(block *types.Block) error
- func (bm *BftMock) IsConsensusNode() bool
- func (bm *BftMock) IsSignedBySelf(sealHash common.Hash, header *types.Header) bool
- func (bm *BftMock) NextBaseBlock() *types.Block
- func (bm *BftMock) NodeID() discover.NodeID
- func (bm *BftMock) OnBlockSignature(chain ChainReader, nodeID discover.NodeID, sig *cbfttypes.BlockSignature) error
- func (bm *BftMock) OnBlockSynced()
- func (bm *BftMock) OnNewBlock(chain ChainReader, block *types.Block) error
- func (bm *BftMock) OnPong(nodeID discover.NodeID, netLatency int64) error
- func (bm *BftMock) Pause()
- func (bm *BftMock) Prepare(chain ChainReader, header *types.Header) error
- func (bm *BftMock) Protocols() []p2p.Protocol
- func (bm *BftMock) Resume()
- func (bm *BftMock) Seal(chain ChainReader, block *types.Block, results chan<- *types.Block, ...) error
- func (bm *BftMock) SealHash(header *types.Header) common.Hash
- func (bm *BftMock) ShouldSeal(curTime time.Time) (bool, error)
- func (bm *BftMock) Start(chain ChainReader, blockCacheWriter BlockCacheWriter, pool TxPoolReset, ...) error
- func (bm *BftMock) Status() string
- func (bm *BftMock) Stop() error
- func (bm *BftMock) Syncing() bool
- func (bm *BftMock) TracingSwitch(flag int8)
- func (bm *BftMock) UnmarshalEvidence(data []byte) (consensus.Evidences, error)
- func (bm *BftMock) VerifyHeader(chain ChainReader, header *types.Header, seal bool) error
- func (bm *BftMock) VerifyHeaders(chain ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
- func (bm *BftMock) VerifySeal(chain ChainReader, header *types.Header) error
- type BlockCacheWriter
- type ChainReader
- type Engine
- type PoW
- type TxPoolReset
Constants ¶
This section is empty.
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") )
var ( // ExtraSeal fixed number of extra-data suffix bytes reserved for signer seal ExtraSeal = 65 // 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 SigHash ¶
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 Agency ¶
type Agency interface { Sign(msg interface{}) error VerifySign(msg interface{}) error Flush(header *types.Header) error VerifyHeader(header *types.Header, stateDB *state.StateDB) error GetLastNumber(blockNumber uint64) uint64 GetValidator(blockNumber uint64) (*cbfttypes.Validators, error) IsCandidateNode(nodeID discover.NodeID) bool OnCommit(block *types.Block) error }
Agency defines the interface that the authentication mechanism must implement.
type Bft ¶
type Bft interface { Engine Start(chain ChainReader, blockCacheWriter BlockCacheWriter, pool TxPoolReset, agency Agency) error // Returns the current consensus node address list. ConsensusNodes() ([]discover.NodeID, error) // Returns whether the current node is out of the block ShouldSeal(curTime time.Time) (bool, error) CalcBlockDeadline(timePoint time.Time) time.Time CalcNextBlockTime(timePoint time.Time) time.Time IsConsensusNode() bool GetBlock(hash common.Hash, number uint64) *types.Block GetBlockWithoutLock(hash common.Hash, number uint64) *types.Block IsSignedBySelf(sealHash common.Hash, header *types.Header) bool Evidences() string TracingSwitch(flag int8) // NodeID is temporary. NodeID() discover.NodeID }
Bft defines the functions that BFT consensus must implement.
type BftMock ¶
type BftMock struct { EventMux *event.TypeMux Blocks []*types.Block Next uint32 Current *types.Block Base *types.Block // contains filtered or unexported fields }
BftMock represents a simulated consensus structure.
func NewFailFaker ¶
func NewFakerWithDataBase ¶
func (*BftMock) APIs ¶
func (bm *BftMock) APIs(chain ChainReader) []rpc.API
APIs returns the RPC APIs this consensus engine provides.
func (*BftMock) Author ¶
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) CalcBlockDeadline ¶
CalcBlockDeadline is a fake interface, no need to implement.
func (*BftMock) CalcDifficulty ¶
CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty that a new block should have.
func (*BftMock) CalcNextBlockTime ¶
CalcNextBlockTime is a fake interface, no need to implement.
func (*BftMock) CheckConsensusNode ¶
CheckConsensusNode is a fake interface, no need to implement.
func (*BftMock) ConsensusNodes ¶
ConsensusNodes returns the current consensus node address list.
func (*BftMock) CurrentBlock ¶
CurrentBlock is a fake interface, no need to implement.
func (*BftMock) DecodeExtra ¶
func (*BftMock) FastSyncCommitHead ¶
FastSyncCommitHead is a fake interface, no need to implement.
func (*BftMock) Finalize ¶
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) GetBlockByHash ¶
GetBlockByHash is a fake interface, no need to implement.
func (*BftMock) GetBlockByHashAndNum ¶
GetBlockByHash get the specified block by hash and number.
func (*BftMock) GetBlockWithoutLock ¶
GetBlockWithoutLock is a fake interface, no need to implement.
func (*BftMock) GetPrepareQC ¶
func (bm *BftMock) GetPrepareQC(number uint64) *ctypes.QuorumCert
func (*BftMock) HighestConfirmedBlock ¶
HighestConfirmedBlock is a fake interface, no need to implement.
func (*BftMock) HighestLogicalBlock ¶
HighestLogicalBlock is a fake interface, no need to implement.
func (*BftMock) InsertChain ¶
InsertChain is a fake interface, no need to implement.
func (*BftMock) IsConsensusNode ¶
IsConsensusNode is a fake interface, no need to implement.
func (*BftMock) IsSignedBySelf ¶
IsSignedBySelf is a fake interface, no need to implement.
func (*BftMock) NextBaseBlock ¶
NextBaseBlock is a fake interface, no need to implement.
func (*BftMock) OnBlockSignature ¶
func (bm *BftMock) OnBlockSignature(chain ChainReader, nodeID discover.NodeID, sig *cbfttypes.BlockSignature) error
OnBlockSignature received a new block signature Need to verify if the signature is signed by nodeID
func (*BftMock) OnBlockSynced ¶
func (bm *BftMock) OnBlockSynced()
OnBlockSynced sends a signal if a block synced from other peer.
func (*BftMock) OnNewBlock ¶
func (bm *BftMock) OnNewBlock(chain ChainReader, block *types.Block) error
OnNewBlock processes the BFT signatures
func (*BftMock) Prepare ¶
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) Seal ¶
func (bm *BftMock) Seal(chain ChainReader, block *types.Block, results chan<- *types.Block, stop <-chan struct{}, complete 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) ShouldSeal ¶
ShouldSeal returns whether the current node is out of the block
func (*BftMock) Start ¶
func (bm *BftMock) Start(chain ChainReader, blockCacheWriter BlockCacheWriter, pool TxPoolReset, agency Agency) error
Start is a fake interface, no need to implement.
func (*BftMock) TracingSwitch ¶
TracingSwitch is a fake interface, no need to implement.
func (*BftMock) UnmarshalEvidence ¶
UnmarshalEvidence is a fake interface, no need to implement.
func (*BftMock) VerifyHeader ¶
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 ¶
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 ¶
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.
type BlockCacheWriter ¶
type BlockCacheWriter interface { Execute(block *types.Block, parent *types.Block) error ClearCache(block *types.Block) WriteBlock(block *types.Block) error Stop() }
BlockCacheWriter executions block, you need to pass in the parent block to find the parent block state
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 // CurrentBlock retrieves the current head block of the canonical chain. CurrentBlock() *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{}, complete 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) error HasBlock(hash common.Hash, number uint64) bool GetBlockByHash(hash common.Hash) *types.Block GetBlockByHashAndNum(hash common.Hash, number uint64) *types.Block CurrentBlock() *types.Block FastSyncCommitHead(block *types.Block) error // Close terminates any background threads maintained by the consensus engine. Close() error Stop() error // Pause consensus Pause() // Resume consensus Resume() DecodeExtra(extra []byte) (common.Hash, uint64, error) Syncing() bool }
Engine is an algorithm agnostic consensus engine.
Directories ¶
Path | Synopsis |
---|---|
evidence
Package evidence implements recording duplicate blocks and votes for cbft consensus.
|
Package evidence implements recording duplicate blocks and votes for cbft consensus. |
network
Package network implements a concrete consensus engines.
|
Package network implements a concrete consensus engines. |
wal
Package wal implements the similar write-ahead logging for cbft consensus.
|
Package wal implements the similar write-ahead logging for cbft consensus. |