Add RPC to force round timeout (#804)

consensus/istanbul/backend/api.go

@@ -150,9 +150,21 @@ func (api *API) GetValEnodeTable() (map[string]*vet.ValEnodeEntryInfo, error) {
 
 // GetCurrentRoundState retrieves the current IBFT RoundState
 func (api *API) GetCurrentRoundState() (*core.RoundStateSummary, error) {
+	if !api.istanbul.coreStarted {
+		return nil, istanbul.ErrStoppedEngine
+	}
 	return api.istanbul.core.CurrentRoundState().Summary(), nil
 }
 
+// GetCurrentRoundState retrieves the current IBFT RoundState
+func (api *API) ForceRoundChange() (bool, error) {
+	if !api.istanbul.coreStarted {
+		return false, istanbul.ErrStoppedEngine
+	}
+	api.istanbul.core.ForceRoundChange()
+	return true, nil
+}
+
 // TODO(kevjue) - implement this
 // ProxyInfo retrieves all the information we know about each individual proxy node
 /* func (api *PublicAdminAPI) ProxyInfo() ([]*p2p.PeerInfo, error) {

consensus/istanbul/core/core.go

@@ -130,6 +130,12 @@ func (c *core) ParentCommits() MessageSet {
 	return c.current.ParentCommits()
 }
 
+func (c *core) ForceRoundChange() {
+	// timeout current DesiredView
+	view := &istanbul.View{Sequence: c.current.Sequence(), Round: c.current.DesiredRound()}
+	c.sendEvent(timeoutAndMoveToNextRoundEvent{view})
+}
+
 // PrepareCommittedSeal returns a committed seal for the given hash and round number.
 func PrepareCommittedSeal(hash common.Hash, round *big.Int) []byte {
 	var buf bytes.Buffer

consensus/istanbul/core/handler.go

@@ -211,17 +211,17 @@ func (c *core) handleCheckedMsg(msg *istanbul.Message, src istanbul.Validator) e
 	return errInvalidMessage
 }
 
-func (c *core) handleTimeoutAndMoveToNextRound(desiredView *istanbul.View) error {
-	logger := c.newLogger("func", "handleTimeoutAndMoveToNextRound", "set_at_seq", desiredView.Sequence, "set_at_desiredRound", desiredView.Round)
+func (c *core) handleTimeoutAndMoveToNextRound(timedOutView *istanbul.View) error {
+	logger := c.newLogger("func", "handleTimeoutAndMoveToNextRound", "timed_out_seq", timedOutView.Sequence, "timed_out_round", timedOutView.Round)
 
 	// Avoid races where message is enqueued then a later event advances sequence or desired round.
-	if c.current.Sequence().Cmp(desiredView.Sequence) != 0 || c.current.DesiredRound().Cmp(desiredView.Round) != 0 {
+	if c.current.Sequence().Cmp(timedOutView.Sequence) != 0 || c.current.DesiredRound().Cmp(timedOutView.Round) != 0 {
 		logger.Trace("Timed out but now on a different view")
 		return nil
 	}
 
 	logger.Debug("Timed out, trying to wait for next round")
-	nextRound := new(big.Int).Add(desiredView.Round, common.Big1)
+	nextRound := new(big.Int).Add(timedOutView.Round, common.Big1)
 	return c.waitForDesiredRound(nextRound)
 }
 

consensus/istanbul/core/types.go

@@ -25,11 +25,15 @@ import (
 type Engine interface {
 	Start() error
 	Stop() error
+	// CurrentView returns the current view or nil if none
 	CurrentView() *istanbul.View
+	// CurrentRoundState returns the current roundState or nil if none
 	CurrentRoundState() RoundState
 	SetAddress(common.Address)
 	// Validator -> CommittedSeal from Parent Block
 	ParentCommits() MessageSet
+	// ForceRoundChange will force round change to the current desiredRound + 1
+	ForceRoundChange()
 }
 
 // State represents the IBFT state