Merge pull request #59 from getamis/feature/rpc_api

consensus/pbft,internal: update rpc api and remove UpdateState()

Author: markya0616

consensus/pbft/backend.go

@@ -38,9 +38,6 @@ type Backend interface {
 	// Broadcast is to send pbft message to all peers
 	Broadcast(payload []byte) error
 
-	// UpdateState is to update the current pbft state to backend
-	UpdateState(*State) error
-
 	// Commit is to deliver a final result to write into blockchain
 	Commit(Proposal) error
 

consensus/pbft/backends/simple/api.go

@@ -1,6 +1,9 @@
 package simple
 
 import (
+	"fmt"
+	"strings"
+
 	"github.com/ethereum/go-ethereum/consensus"
 	"github.com/ethereum/go-ethereum/log"
 )
@@ -11,10 +14,23 @@ type API struct {
 	backend *simpleBackend
 }
 
-func (self *API) ConsensusState() {
-	log.Info("Dump PBFT state")
+// Snapshot returns current state and proposer
+func (api *API) Snapshot() {
+	state, snapshot := api.backend.core.Snapshot()
+	p := api.backend.valSet.GetProposer().Address()
+	log.Info("Snapshot", "sequence", snapshot.Sequence, "Round", snapshot.Round,
+		"state", state, "proposer", p.Hex(),
+		"hash", snapshot.Preprepare.Proposal.Hash().Hex(),
+		"prepares", snapshot.Prepares, "commits", snapshot.Commits,
+		"checkpoint", snapshot.Checkpoints)
 }
 
-func (self *API) ViewChange() {
-	log.Info("Force view change")
+// Backlog returns backlogs
+func (api *API) Backlog() {
+	backlog := api.backend.core.Backlog()
+	logs := make([]string, 0, len(backlog))
+	for address, q := range backlog {
+		logs = append(logs, fmt.Sprintf("{%v, %v}", address.Address().Hex(), q.Size()))
+	}
+	log.Info("Backlog", "logs", fmt.Sprintf("[%v]", strings.Join(logs, ", ")))
 }

consensus/pbft/backends/simple/backend.go

@@ -54,21 +54,20 @@ func New(config *pbft.Config, eventMux *event.TypeMux, privateKey *ecdsa.Private
 
 // ----------------------------------------------------------------------------
 type simpleBackend struct {
-	config         *pbft.Config
-	peerSet        *peerSet
-	valSet         pbft.ValidatorSet
-	eventMux       *event.TypeMux
-	pbftEventMux   *event.TypeMux
-	privateKey     *ecdsa.PrivateKey
-	address        common.Address
-	consensusState *pbft.State
-	core           pbftCore.Engine
-	logger         log.Logger
-	quitSync       chan struct{}
-	db             ethdb.Database
-	timeout        uint64
-	chain          consensus.ChainReader
-	inserter       func(block *types.Block) error
+	config       *pbft.Config
+	peerSet      *peerSet
+	valSet       pbft.ValidatorSet
+	eventMux     *event.TypeMux
+	pbftEventMux *event.TypeMux
+	privateKey   *ecdsa.PrivateKey
+	address      common.Address
+	core         pbftCore.Engine
+	logger       log.Logger
+	quitSync     chan struct{}
+	db           ethdb.Database
+	timeout      uint64
+	chain        consensus.ChainReader
+	inserter     func(block *types.Block) error
 
 	// the channels for pbft engine notifications
 	viewChange chan bool
@@ -236,12 +235,6 @@ func (sb *simpleBackend) getSignatureAddress(data []byte, sig []byte) (common.Ad
 	return crypto.PubkeyToAddress(*pubkey), nil
 }
 
-// UpdateState implements pbft.Backend.UpdateState
-func (sb *simpleBackend) UpdateState(state *pbft.State) error {
-	sb.consensusState = state
-	return nil
-}
-
 func (sb *simpleBackend) IsProposer() bool {
 	if sb.valSet == nil {
 		return false

consensus/pbft/core/core.go

@@ -59,6 +59,11 @@ func (s State) String() string {
 type Engine interface {
 	Start(lastSequence *big.Int, lastProposer common.Address) error
 	Stop() error
+
+	// get current state and snapshot
+	Snapshot() (State, *snapshot)
+	// get back log
+	Backlog() map[pbft.Validator]*prque.Prque
 }
 
 func New(backend pbft.Backend, config *pbft.Config) Engine {
@@ -201,3 +206,11 @@ func (c *core) setState(state State) {
 func (c *core) Address() common.Address {
 	return c.address
 }
+
+func (c *core) Snapshot() (State, *snapshot) {
+	return c.state, c.current
+}
+
+func (c *core) Backlog() map[pbft.Validator]*prque.Prque {
+	return c.backlogs
+}

consensus/pbft/core/message_set.go

@@ -17,8 +17,10 @@
 package core
 
 import (
+	"fmt"
 	"io"
 	"math/big"
+	"strings"
 	"sync"
 
 	"github.com/ethereum/go-ethereum/common"
@@ -169,3 +171,13 @@ func (ms *messageSet) addVerifiedMessage(msg *message) error {
 	ms.messages[hash(msg)] = msg
 	return nil
 }
+
+func (ms *messageSet) String() string {
+	ms.messagesMu.Lock()
+	defer ms.messagesMu.Unlock()
+	addresses := make([]string, 0, len(ms.messages))
+	for _, v := range ms.messages {
+		addresses = append(addresses, v.Address.Hex())
+	}
+	return fmt.Sprintf("[%v]", strings.Join(addresses, ", "))
+}

consensus/pbft/core/testbackend_test.go

@@ -81,11 +81,6 @@ func (self *testSystemBackend) Broadcast(message []byte) error {
 	return nil
 }
 
-func (self *testSystemBackend) UpdateState(state *pbft.State) error {
-	testLogger.Warn("nothing to happen")
-	return nil
-}
-
 func (self *testSystemBackend) ViewChanged(needNewProposal bool) error {
 	testLogger.Warn("nothing to happen")
 	return nil

internal/web3ext/web3ext.go

@@ -589,13 +589,13 @@ web3._extend({
   	methods:
   	[
 		new web3._extend.Method({
-			name: 'consensusState',
-			call: 'pbft_consensusState',
+			name: 'snapshot',
+			call: 'pbft_snapshot',
 			params: 0
 		}),
 		new web3._extend.Method({
-			name: 'viewChange',
-			call: 'pbft_viewChange',
+			name: 'backlog',
+			call: 'pbft_backlog',
 			params: 0
 		}),
   	],