Merge pull request #1209 from jbhurat/qibft

QBFT Consensus Implementation

Author: nmvalera

cmd/utils/flags.go

@@ -2220,8 +2220,9 @@ func MakeChain(ctx *cli.Context, stack *node.Node, readOnly bool, useExist bool)
 		if config.Istanbul.Epoch != 0 {
 			istanbulConfig.Epoch = config.Istanbul.Epoch
 		}
-		istanbulConfig.ProposerPolicy = istanbul.ProposerPolicy(config.Istanbul.ProposerPolicy)
+		istanbulConfig.ProposerPolicy = istanbul.NewProposerPolicy(istanbul.ProposerPolicyId(config.Istanbul.ProposerPolicy))
 		istanbulConfig.Ceil2Nby3Block = config.Istanbul.Ceil2Nby3Block
+		istanbulConfig.TestQBFTBlock = config.Istanbul.TestQBFTBlock
 		engine = istanbulBackend.New(istanbulConfig, stack.GetNodeKey(), chainDb)
 	} else if config.IsQuorum {
 		// for Raft

consensus/istanbul/backend.go

@@ -36,14 +36,14 @@ type Backend interface {
 	EventMux() *event.TypeMux
 
 	// Broadcast sends a message to all validators (include self)
-	Broadcast(valSet ValidatorSet, payload []byte) error
+	Broadcast(valSet ValidatorSet, code uint64, payload []byte) error
 
 	// Gossip sends a message to all validators (exclude self)
-	Gossip(valSet ValidatorSet, payload []byte) error
+	Gossip(valSet ValidatorSet, code uint64, payload []byte) error
 
 	// Commit delivers an approved proposal to backend.
 	// The delivered proposal will be put into blockchain.
-	Commit(proposal Proposal, seals [][]byte) error
+	Commit(proposal Proposal, seals [][]byte, round *big.Int) error
 
 	// Verify verifies the proposal. If a consensus.ErrFutureBlock error is returned,
 	// the time difference of the proposal and current time is also returned.
@@ -52,6 +52,9 @@ type Backend interface {
 	// Sign signs input data with the backend's private key
 	Sign([]byte) ([]byte, error)
 
+	// SignWithoutHashing sign input data with the backend's private key without hashing the input data
+	SignWithoutHashing([]byte) ([]byte, error)
+
 	// CheckSignature verifies the signature by checking if it's signed by
 	// the given validator
 	CheckSignature(data []byte, addr common.Address, sig []byte) error
@@ -68,8 +71,14 @@ type Backend interface {
 	// ParentValidators returns the validator set of the given proposal's parent block
 	ParentValidators(proposal Proposal) ValidatorSet
 
-	// HasBadBlock returns whether the block with the hash is a bad block
+	// HasBadProposal returns whether the block with the hash is a bad block
 	HasBadProposal(hash common.Hash) bool
 
 	Close() error
+
+	// IsQBFTConsensus checks qbftBlock fork block and returns if it should be enabled
+	IsQBFTConsensusAt(*big.Int) bool
+
+	// StartQBFTConsensus stops existing legacy ibft consensus and starts the new qbft consensus
+	StartQBFTConsensus() error
 }

consensus/istanbul/backend/api.go

@@ -21,14 +21,15 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/consensus"
+	istanbulcommon "github.com/ethereum/go-ethereum/consensus/istanbul/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/rpc"
 )
 
 // API is a user facing RPC API to dump Istanbul state
 type API struct {
-	chain    consensus.ChainHeaderReader
-	istanbul *backend
+	chain   consensus.ChainHeaderReader
+	backend *Backend
 }
 
 // BlockSigners is contains who created and who signed a particular block, denoted by its number and hash
@@ -46,7 +47,7 @@ type Status struct {
 
 // NodeAddress returns the public address that is used to sign block headers in IBFT
 func (api *API) NodeAddress() common.Address {
-	return api.istanbul.Address()
+	return api.backend.Address()
 }
 
 // GetSignersFromBlock returns the signers and minter for a given block number, or the
@@ -61,7 +62,7 @@ func (api *API) GetSignersFromBlock(number *rpc.BlockNumber) (*BlockSigners, err
 	}
 
 	if header == nil {
-		return nil, errUnknownBlock
+		return nil, istanbulcommon.ErrUnknownBlock
 	}
 
 	return api.signers(header)
@@ -71,19 +72,19 @@ func (api *API) GetSignersFromBlock(number *rpc.BlockNumber) (*BlockSigners, err
 func (api *API) GetSignersFromBlockByHash(hash common.Hash) (*BlockSigners, error) {
 	header := api.chain.GetHeaderByHash(hash)
 	if header == nil {
-		return nil, errUnknownBlock
+		return nil, istanbulcommon.ErrUnknownBlock
 	}
 
 	return api.signers(header)
 }
 
 func (api *API) signers(header *types.Header) (*BlockSigners, error) {
-	author, err := api.istanbul.Author(header)
+	author, err := api.backend.Author(header)
 	if err != nil {
 		return nil, err
 	}
 
-	committers, err := api.istanbul.Signers(header)
+	committers, err := api.backend.Signers(header)
 	if err != nil {
 		return nil, err
 	}
@@ -107,18 +108,18 @@ func (api *API) GetSnapshot(number *rpc.BlockNumber) (*Snapshot, error) {
 	}
 	// Ensure we have an actually valid block and return its snapshot
 	if header == nil {
-		return nil, errUnknownBlock
+		return nil, istanbulcommon.ErrUnknownBlock
 	}
-	return api.istanbul.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
+	return api.backend.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
 }
 
 // GetSnapshotAtHash retrieves the state snapshot at a given block.
 func (api *API) GetSnapshotAtHash(hash common.Hash) (*Snapshot, error) {
 	header := api.chain.GetHeaderByHash(hash)
 	if header == nil {
-		return nil, errUnknownBlock
+		return nil, istanbulcommon.ErrUnknownBlock
 	}
-	return api.istanbul.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
+	return api.backend.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
 }
 
 // GetValidators retrieves the list of authorized validators at the specified block.
@@ -132,9 +133,9 @@ func (api *API) GetValidators(number *rpc.BlockNumber) ([]common.Address, error)
 	}
 	// Ensure we have an actually valid block and return the validators from its snapshot
 	if header == nil {
-		return nil, errUnknownBlock
+		return nil, istanbulcommon.ErrUnknownBlock
 	}
-	snap, err := api.istanbul.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
+	snap, err := api.backend.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -145,9 +146,9 @@ func (api *API) GetValidators(number *rpc.BlockNumber) ([]common.Address, error)
 func (api *API) GetValidatorsAtHash(hash common.Hash) ([]common.Address, error) {
 	header := api.chain.GetHeaderByHash(hash)
 	if header == nil {
-		return nil, errUnknownBlock
+		return nil, istanbulcommon.ErrUnknownBlock
 	}
-	snap, err := api.istanbul.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
+	snap, err := api.backend.snapshot(api.chain, header.Number.Uint64(), header.Hash(), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -156,11 +157,11 @@ func (api *API) GetValidatorsAtHash(hash common.Hash) ([]common.Address, error)
 
 // Candidates returns the current candidates the node tries to uphold and vote on.
 func (api *API) Candidates() map[common.Address]bool {
-	api.istanbul.candidatesLock.RLock()
-	defer api.istanbul.candidatesLock.RUnlock()
+	api.backend.candidatesLock.RLock()
+	defer api.backend.candidatesLock.RUnlock()
 
 	proposals := make(map[common.Address]bool)
-	for address, auth := range api.istanbul.candidates {
+	for address, auth := range api.backend.candidates {
 		proposals[address] = auth
 	}
 	return proposals
@@ -169,19 +170,19 @@ func (api *API) Candidates() map[common.Address]bool {
 // Propose injects a new authorization candidate that the validator will attempt to
 // push through.
 func (api *API) Propose(address common.Address, auth bool) {
-	api.istanbul.candidatesLock.Lock()
-	defer api.istanbul.candidatesLock.Unlock()
+	api.backend.candidatesLock.Lock()
+	defer api.backend.candidatesLock.Unlock()
 
-	api.istanbul.candidates[address] = auth
+	api.backend.candidates[address] = auth
 }
 
 // Discard drops a currently running candidate, stopping the validator from casting
 // further votes (either for or against).
 func (api *API) Discard(address common.Address) {
-	api.istanbul.candidatesLock.Lock()
-	defer api.istanbul.candidatesLock.Unlock()
+	api.backend.candidatesLock.Lock()
+	defer api.backend.candidatesLock.Unlock()
 
-	delete(api.istanbul.candidates, address)
+	delete(api.backend.candidates, address)
 }
 
 func (api *API) Status(startBlockNum *rpc.BlockNumber, endBlockNum *rpc.BlockNumber) (*Status, error) {
@@ -264,7 +265,7 @@ func (api *API) IsValidator(blockNum *rpc.BlockNumber) (bool, error) {
 	s, _ := api.GetValidators(&blockNumber)
 
 	for _, v := range s {
-		if v == api.istanbul.address {
+		if v == api.backend.address {
 			return true, nil
 		}
 	}