netsync/consensusmgr/consensus_msg.go

   1 package consensusmgr
   2
   3 import (
   4         "bytes"
   5         "encoding/hex"
   6         "errors"
   7         "fmt"
   8
   9         "github.com/tendermint/go-wire"
  10
  11         "github.com/vapor/netsync/peers"
  12         "github.com/vapor/protocol/bc"
  13         "github.com/vapor/protocol/bc/types"
  14 )
  15
  16 const (
  17         blockSignatureByte = byte(0x10)
  18         blockProposeByte   = byte(0x11)
  19 )
  20
  21 //ConsensusMessage is a generic message for consensus reactor.
  22 type ConsensusMessage interface {
  23         String() string
  24         BroadcastMarkSendRecord(ps *peers.PeerSet, peers []string)
  25         BroadcastFilterTargetPeers(ps *peers.PeerSet) []string
  26 }
  27
  28 var _ = wire.RegisterInterface(
  29         struct{ ConsensusMessage }{},
  30         wire.ConcreteType{O: &BlockSignatureMsg{}, Byte: blockSignatureByte},
  31         wire.ConcreteType{O: &BlockProposeMsg{}, Byte: blockProposeByte},
  32 )
  33
  34 //decodeMessage decode msg
  35 func decodeMessage(bz []byte) (msgType byte, msg ConsensusMessage, err error) {
  36         msgType = bz[0]
  37         n := int(0)
  38         r := bytes.NewReader(bz)
  39         msg = wire.ReadBinary(struct{ ConsensusMessage }{}, r, maxBlockchainResponseSize, &n, &err).(struct{ ConsensusMessage }).ConsensusMessage
  40         if err != nil && n != len(bz) {
  41                 err = errors.New("DecodeMessage() had bytes left over")
  42         }
  43         return
  44 }
  45
  46 // BlockSignatureMsg block signature message transferred between nodes.
  47 type BlockSignatureMsg struct {
  48         BlockHash [32]byte
  49         Signature []byte
  50         PubKey    []byte
  51 }
  52
  53 //NewBlockSignatureMsg create new block signature msg.
  54 func NewBlockSignatureMsg(blockHash bc.Hash, signature, pubKey []byte) ConsensusMessage {
  55         hash := blockHash.Byte32()
  56         return &BlockSignatureMsg{BlockHash: hash, Signature: signature, PubKey: pubKey}
  57 }
  58
  59 func (bs *BlockSignatureMsg) String() string {
  60         return fmt.Sprintf("{block_hash: %s,signature:%s,pubkey:%s}", hex.EncodeToString(bs.BlockHash[:]), hex.EncodeToString(bs.Signature), hex.EncodeToString(bs.PubKey[:]))
  61 }
  62
  63 // BroadcastMarkSendRecord mark send message record to prevent messages from being sent repeatedly.
  64 func (bs *BlockSignatureMsg) BroadcastMarkSendRecord(ps *peers.PeerSet, peers []string) {
  65         for _, peer := range peers {
  66                 ps.MarkBlockSignature(peer, bs.Signature)
  67         }
  68 }
  69
  70 // BroadcastFilterTargetPeers filter target peers to filter the nodes that need to send messages.
  71 func (bs *BlockSignatureMsg) BroadcastFilterTargetPeers(ps *peers.PeerSet) []string {
  72         return ps.PeersWithoutSignature(bs.Signature)
  73 }
  74
  75 // BlockProposeMsg block propose message transferred between nodes.
  76 type BlockProposeMsg struct {
  77         RawBlock []byte
  78 }
  79
  80 //NewBlockProposeMsg create new block propose msg.
  81 func NewBlockProposeMsg(block *types.Block) (ConsensusMessage, error) {
  82         rawBlock, err := block.MarshalText()
  83         if err != nil {
  84                 return nil, err
  85         }
  86         return &BlockProposeMsg{RawBlock: rawBlock}, nil
  87 }
  88
  89 //GetProposeBlock get propose block from msg.
  90 func (bp *BlockProposeMsg) GetProposeBlock() (*types.Block, error) {
  91         block := &types.Block{}
  92         if err := block.UnmarshalText(bp.RawBlock); err != nil {
  93                 return nil, err
  94         }
  95         return block, nil
  96 }
  97
  98 func (bp *BlockProposeMsg) String() string {
  99         block, err := bp.GetProposeBlock()
 100         if err != nil {
 101                 return "{err: wrong message}"
 102         }
 103         blockHash := block.Hash()
 104         return fmt.Sprintf("{block_height: %d, block_hash: %s}", block.Height, blockHash.String())
 105 }
 106
 107 // BroadcastMarkSendRecord mark send message record to prevent messages from being sent repeatedly.
 108 func (bp *BlockProposeMsg) BroadcastMarkSendRecord(ps *peers.PeerSet, peers []string) {
 109         block, err := bp.GetProposeBlock()
 110         if err != nil {
 111                 return
 112         }
 113
 114         hash := block.Hash()
 115         height := block.Height
 116         for _, peer := range peers {
 117                 ps.MarkBlock(peer, &hash)
 118                 ps.MarkStatus(peer, height)
 119         }
 120 }
 121
 122 // BroadcastFilterTargetPeers filter target peers to filter the nodes that need to send messages.
 123 func (bp *BlockProposeMsg) BroadcastFilterTargetPeers(ps *peers.PeerSet) []string {
 124         block, err := bp.GetProposeBlock()
 125         if err != nil {
 126                 return nil
 127         }
 128
 129         return ps.PeersWithoutBlock(block.Hash())
 130 }