7 log "github.com/sirupsen/logrus"
9 cfg "github.com/vapor/config"
10 "github.com/vapor/consensus"
11 "github.com/vapor/event"
12 "github.com/vapor/p2p"
13 core "github.com/vapor/protocol"
14 "github.com/vapor/protocol/bc"
15 "github.com/vapor/protocol/bc/types"
21 maxFilterAddressSize = 50
22 maxFilterAddressCount = 1000
26 errVaultModeDialPeer = errors.New("can't dial peer in vault mode")
29 // Chain is the interface for Bytom core
30 type Chain interface {
31 BestBlockHeader() *types.BlockHeader
32 BestBlockHeight() uint64
33 GetBlockByHash(*bc.Hash) (*types.Block, error)
34 GetBlockByHeight(uint64) (*types.Block, error)
35 GetHeaderByHash(*bc.Hash) (*types.BlockHeader, error)
36 GetHeaderByHeight(uint64) (*types.BlockHeader, error)
37 GetTransactionStatus(*bc.Hash) (*bc.TransactionStatus, error)
38 InMainChain(bc.Hash) bool
39 ProcessBlock(*types.Block) (bool, error)
40 ValidateTx(*types.Tx) (bool, error)
43 type Switch interface {
44 AddReactor(name string, reactor p2p.Reactor) p2p.Reactor
45 AddBannedPeer(string) error
46 StopPeerGracefully(string)
47 NodeInfo() *p2p.NodeInfo
51 DialPeerWithAddress(addr *p2p.NetAddress) error
55 //SyncManager Sync Manager is responsible for the business layer information synchronization
56 type SyncManager struct {
61 blockFetcher *blockFetcher
62 blockKeeper *blockKeeper
65 txSyncCh chan *txSyncMsg
66 quitSync chan struct{}
69 eventDispatcher *event.Dispatcher
70 minedBlockSub *event.Subscription
71 txMsgSub *event.Subscription
74 // CreateSyncManager create sync manager and set switch.
75 func NewSyncManager(config *cfg.Config, chain Chain, txPool *core.TxPool, dispatcher *event.Dispatcher) (*SyncManager, error) {
76 sw, err := p2p.NewSwitch(config)
81 return newSyncManager(config, sw, chain, txPool, dispatcher)
84 //NewSyncManager create a sync manager
85 func newSyncManager(config *cfg.Config, sw Switch, chain Chain, txPool *core.TxPool, dispatcher *event.Dispatcher) (*SyncManager, error) {
86 genesisHeader, err := chain.GetHeaderByHeight(0)
90 peers := newPeerSet(sw)
91 manager := &SyncManager{
93 genesisHash: genesisHeader.Hash(),
96 blockFetcher: newBlockFetcher(chain, peers),
97 blockKeeper: newBlockKeeper(chain, peers),
99 txSyncCh: make(chan *txSyncMsg),
100 quitSync: make(chan struct{}),
102 eventDispatcher: dispatcher,
105 if !config.VaultMode {
106 protocolReactor := NewProtocolReactor(manager, peers)
107 manager.sw.AddReactor("PROTOCOL", protocolReactor)
112 func (sm *SyncManager) AddPeer(peer BasePeer) {
113 sm.peers.addPeer(peer)
116 //BestPeer return the highest p2p peerInfo
117 func (sm *SyncManager) BestPeer() *PeerInfo {
118 bestPeer := sm.peers.bestPeer(consensus.SFFullNode)
120 return bestPeer.getPeerInfo()
125 func (sm *SyncManager) DialPeerWithAddress(addr *p2p.NetAddress) error {
126 if sm.config.VaultMode {
127 return errVaultModeDialPeer
130 return sm.sw.DialPeerWithAddress(addr)
133 func (sm *SyncManager) GetNetwork() string {
134 return sm.config.ChainID
137 //GetPeerInfos return peer info of all peers
138 func (sm *SyncManager) GetPeerInfos() []*PeerInfo {
139 return sm.peers.getPeerInfos()
142 //IsCaughtUp check wheather the peer finish the sync
143 func (sm *SyncManager) IsCaughtUp() bool {
144 peer := sm.peers.bestPeer(consensus.SFFullNode)
145 return peer == nil || peer.Height() <= sm.chain.BestBlockHeight()
148 //StopPeer try to stop peer by given ID
149 func (sm *SyncManager) StopPeer(peerID string) error {
150 if peer := sm.peers.getPeer(peerID); peer == nil {
151 return errors.New("peerId not exist")
153 sm.peers.removePeer(peerID)
157 func (sm *SyncManager) handleBlockMsg(peer *peer, msg *BlockMessage) {
158 block, err := msg.GetBlock()
162 sm.blockKeeper.processBlock(peer.ID(), block)
165 func (sm *SyncManager) handleBlocksMsg(peer *peer, msg *BlocksMessage) {
166 blocks, err := msg.GetBlocks()
168 log.WithFields(log.Fields{"module": logModule, "err": err}).Debug("fail on handleBlocksMsg GetBlocks")
172 sm.blockKeeper.processBlocks(peer.ID(), blocks)
175 func (sm *SyncManager) handleFilterAddMsg(peer *peer, msg *FilterAddMessage) {
176 peer.addFilterAddress(msg.Address)
179 func (sm *SyncManager) handleFilterClearMsg(peer *peer) {
180 peer.filterAdds.Clear()
183 func (sm *SyncManager) handleFilterLoadMsg(peer *peer, msg *FilterLoadMessage) {
184 peer.addFilterAddresses(msg.Addresses)
187 func (sm *SyncManager) handleGetBlockMsg(peer *peer, msg *GetBlockMessage) {
188 var block *types.Block
191 block, err = sm.chain.GetBlockByHeight(msg.Height)
193 block, err = sm.chain.GetBlockByHash(msg.GetHash())
196 log.WithFields(log.Fields{"module": logModule, "err": err}).Warning("fail on handleGetBlockMsg get block from chain")
200 ok, err := peer.sendBlock(block)
202 sm.peers.removePeer(peer.ID())
205 log.WithFields(log.Fields{"module": logModule, "err": err}).Error("fail on handleGetBlockMsg sentBlock")
209 func (sm *SyncManager) handleGetBlocksMsg(peer *peer, msg *GetBlocksMessage) {
210 blocks, err := sm.blockKeeper.locateBlocks(msg.GetBlockLocator(), msg.GetStopHash())
211 if err != nil || len(blocks) == 0 {
216 sendBlocks := []*types.Block{}
217 for _, block := range blocks {
218 rawData, err := block.MarshalText()
220 log.WithFields(log.Fields{"module": logModule, "err": err}).Error("fail on handleGetBlocksMsg marshal block")
224 if totalSize+len(rawData) > maxBlockchainResponseSize/2 {
227 totalSize += len(rawData)
228 sendBlocks = append(sendBlocks, block)
231 ok, err := peer.sendBlocks(sendBlocks)
233 sm.peers.removePeer(peer.ID())
236 log.WithFields(log.Fields{"module": logModule, "err": err}).Error("fail on handleGetBlocksMsg sentBlock")
240 func (sm *SyncManager) handleGetHeadersMsg(peer *peer, msg *GetHeadersMessage) {
241 headers, err := sm.blockKeeper.locateHeaders(msg.GetBlockLocator(), msg.GetStopHash())
242 if err != nil || len(headers) == 0 {
243 log.WithFields(log.Fields{"module": logModule, "err": err}).Debug("fail on handleGetHeadersMsg locateHeaders")
247 ok, err := peer.sendHeaders(headers)
249 sm.peers.removePeer(peer.ID())
252 log.WithFields(log.Fields{"module": logModule, "err": err}).Error("fail on handleGetHeadersMsg sentBlock")
256 func (sm *SyncManager) handleGetMerkleBlockMsg(peer *peer, msg *GetMerkleBlockMessage) {
258 var block *types.Block
260 block, err = sm.chain.GetBlockByHeight(msg.Height)
262 block, err = sm.chain.GetBlockByHash(msg.GetHash())
265 log.WithFields(log.Fields{"module": logModule, "err": err}).Warning("fail on handleGetMerkleBlockMsg get block from chain")
269 blockHash := block.Hash()
270 txStatus, err := sm.chain.GetTransactionStatus(&blockHash)
272 log.WithFields(log.Fields{"module": logModule, "err": err}).Warning("fail on handleGetMerkleBlockMsg get transaction status")
276 ok, err := peer.sendMerkleBlock(block, txStatus)
278 log.WithFields(log.Fields{"module": logModule, "err": err}).Error("fail on handleGetMerkleBlockMsg sentMerkleBlock")
283 sm.peers.removePeer(peer.ID())
287 func (sm *SyncManager) handleHeadersMsg(peer *peer, msg *HeadersMessage) {
288 headers, err := msg.GetHeaders()
290 log.WithFields(log.Fields{"module": logModule, "err": err}).Debug("fail on handleHeadersMsg GetHeaders")
294 sm.blockKeeper.processHeaders(peer.ID(), headers)
297 func (sm *SyncManager) handleMineBlockMsg(peer *peer, msg *MineBlockMessage) {
298 block, err := msg.GetMineBlock()
300 log.WithFields(log.Fields{"module": logModule, "err": err}).Warning("fail on handleMineBlockMsg GetMineBlock")
305 peer.markBlock(&hash)
306 sm.blockFetcher.processNewBlock(&blockMsg{peerID: peer.ID(), block: block})
307 peer.setStatus(block.Height, &hash)
310 func (sm *SyncManager) handleStatusMsg(basePeer BasePeer, msg *StatusMessage) {
311 if peer := sm.peers.getPeer(basePeer.ID()); peer != nil {
312 peer.setStatus(msg.Height, msg.GetHash())
317 func (sm *SyncManager) handleTransactionMsg(peer *peer, msg *TransactionMessage) {
318 tx, err := msg.GetTransaction()
320 sm.peers.addBanScore(peer.ID(), 0, 10, "fail on get tx from message")
324 if isOrphan, err := sm.chain.ValidateTx(tx); err != nil && err != core.ErrDustTx && !isOrphan {
325 sm.peers.addBanScore(peer.ID(), 10, 0, "fail on validate tx transaction")
329 func (sm *SyncManager) IsListening() bool {
330 if sm.config.VaultMode {
333 return sm.sw.IsListening()
336 func (sm *SyncManager) NodeInfo() *p2p.NodeInfo {
337 return sm.sw.NodeInfo()
340 func (sm *SyncManager) PeerCount() int {
341 if sm.config.VaultMode {
344 return len(sm.sw.Peers().List())
347 func (sm *SyncManager) processMsg(basePeer BasePeer, msgType byte, msg BlockchainMessage) {
348 peer := sm.peers.getPeer(basePeer.ID())
353 log.WithFields(log.Fields{
355 "peer": basePeer.Addr(),
356 "type": reflect.TypeOf(msg),
357 "message": msg.String(),
358 }).Info("receive message from peer")
360 switch msg := msg.(type) {
361 case *GetBlockMessage:
362 sm.handleGetBlockMsg(peer, msg)
365 sm.handleBlockMsg(peer, msg)
368 sm.handleStatusMsg(basePeer, msg)
370 case *TransactionMessage:
371 sm.handleTransactionMsg(peer, msg)
373 case *MineBlockMessage:
374 sm.handleMineBlockMsg(peer, msg)
376 case *GetHeadersMessage:
377 sm.handleGetHeadersMsg(peer, msg)
379 case *HeadersMessage:
380 sm.handleHeadersMsg(peer, msg)
382 case *GetBlocksMessage:
383 sm.handleGetBlocksMsg(peer, msg)
386 sm.handleBlocksMsg(peer, msg)
388 case *FilterLoadMessage:
389 sm.handleFilterLoadMsg(peer, msg)
391 case *FilterAddMessage:
392 sm.handleFilterAddMsg(peer, msg)
394 case *FilterClearMessage:
395 sm.handleFilterClearMsg(peer)
397 case *GetMerkleBlockMessage:
398 sm.handleGetMerkleBlockMsg(peer, msg)
401 log.WithFields(log.Fields{
403 "peer": basePeer.Addr(),
404 "message_type": reflect.TypeOf(msg),
405 }).Error("unhandled message type")
409 func (sm *SyncManager) SendStatus(peer BasePeer) error {
410 p := sm.peers.getPeer(peer.ID())
412 return errors.New("invalid peer")
415 if err := p.sendStatus(sm.chain.BestBlockHeader()); err != nil {
416 sm.peers.removePeer(p.ID())
422 func (sm *SyncManager) Start() error {
424 if _, err = sm.sw.Start(); err != nil {
425 log.Error("switch start err")
429 sm.minedBlockSub, err = sm.eventDispatcher.Subscribe(event.NewMinedBlockEvent{})
434 sm.txMsgSub, err = sm.eventDispatcher.Subscribe(core.TxMsgEvent{})
439 // broadcast transactions
440 go sm.txBroadcastLoop()
441 go sm.minedBroadcastLoop()
447 //Stop stop sync manager
448 func (sm *SyncManager) Stop() {
450 sm.minedBlockSub.Unsubscribe()
451 if !sm.config.VaultMode {
456 func (sm *SyncManager) minedBroadcastLoop() {
459 case obj, ok := <-sm.minedBlockSub.Chan():
461 log.WithFields(log.Fields{"module": logModule}).Warning("mined block subscription channel closed")
465 ev, ok := obj.Data.(event.NewMinedBlockEvent)
467 log.WithFields(log.Fields{"module": logModule}).Error("event type error")
471 if err := sm.peers.broadcastMinedBlock(&ev.Block); err != nil {
472 log.WithFields(log.Fields{"module": logModule, "err": err}).Error("fail on broadcast mine block")