4 log "github.com/sirupsen/logrus"
6 "github.com/vapor/errors"
7 "github.com/vapor/event"
8 "github.com/vapor/protocol/bc"
9 "github.com/vapor/protocol/bc/types"
10 "github.com/vapor/protocol/state"
11 "github.com/vapor/protocol/validation"
15 // ErrBadBlock is returned when a block is invalid.
16 ErrBadBlock = errors.New("invalid block")
17 // ErrBadStateRoot is returned when the computed assets merkle root
18 // disagrees with the one declared in a block header.
19 ErrBadStateRoot = errors.New("invalid state merkle root")
22 // BlockExist check is a block in chain or orphan
23 func (c *Chain) BlockExist(hash *bc.Hash) bool {
24 return c.index.BlockExist(hash) || c.orphanManage.BlockExist(hash)
27 // GetBlockByHash return a block by given hash
28 func (c *Chain) GetBlockByHash(hash *bc.Hash) (*types.Block, error) {
29 return c.store.GetBlock(hash)
32 // GetBlockByHeight return a block header by given height
33 func (c *Chain) GetBlockByHeight(height uint64) (*types.Block, error) {
34 node := c.index.NodeByHeight(height)
36 return nil, errors.New("can't find block in given height")
38 return c.store.GetBlock(&node.Hash)
41 // GetHeaderByHash return a block header by given hash
42 func (c *Chain) GetHeaderByHash(hash *bc.Hash) (*types.BlockHeader, error) {
43 node := c.index.GetNode(hash)
45 return nil, errors.New("can't find block header in given hash")
47 return node.BlockHeader(), nil
50 // GetHeaderByHeight return a block header by given height
51 func (c *Chain) GetHeaderByHeight(height uint64) (*types.BlockHeader, error) {
52 node := c.index.NodeByHeight(height)
54 return nil, errors.New("can't find block header in given height")
56 return node.BlockHeader(), nil
59 func (c *Chain) calcReorganizeNodes(node *state.BlockNode) ([]*state.BlockNode, []*state.BlockNode) {
60 var attachNodes []*state.BlockNode
61 var detachNodes []*state.BlockNode
64 for c.index.NodeByHeight(attachNode.Height) != attachNode {
65 attachNodes = append([]*state.BlockNode{attachNode}, attachNodes...)
66 attachNode = attachNode.Parent
69 detachNode := c.bestNode
70 for detachNode != attachNode {
71 detachNodes = append(detachNodes, detachNode)
72 detachNode = detachNode.Parent
74 return attachNodes, detachNodes
77 func (c *Chain) connectBlock(block *types.Block) (err error) {
78 irreversibleNode := c.bestIrreversibleNode
79 bcBlock := types.MapBlock(block)
80 if bcBlock.TransactionStatus, err = c.store.GetTransactionStatus(&bcBlock.ID); err != nil {
84 utxoView := state.NewUtxoViewpoint()
85 if err := c.store.GetTransactionsUtxo(utxoView, bcBlock.Transactions); err != nil {
88 if err := utxoView.ApplyBlock(bcBlock, bcBlock.TransactionStatus); err != nil {
92 voteResultMap := make(map[uint64]*state.VoteResult)
93 if err := c.bbft.ApplyBlock(voteResultMap, block); err != nil {
97 node := c.index.GetNode(&bcBlock.ID)
98 if c.bbft.isIrreversible(block) && block.Height > irreversibleNode.Height {
99 irreversibleNode = node
102 if err := c.setState(node, irreversibleNode, utxoView, voteResultMap); err != nil {
106 for _, tx := range block.Transactions {
107 c.txPool.RemoveTransaction(&tx.Tx.ID)
112 func (c *Chain) reorganizeChain(node *state.BlockNode) error {
113 attachNodes, detachNodes := c.calcReorganizeNodes(node)
114 utxoView := state.NewUtxoViewpoint()
115 voteResultMap := make(map[uint64]*state.VoteResult)
116 irreversibleNode := c.bestIrreversibleNode
118 for _, detachNode := range detachNodes {
119 b, err := c.store.GetBlock(&detachNode.Hash)
124 if b.Height <= irreversibleNode.Height {
125 return errors.New("the height of rollback block below the height of irreversible block")
128 detachBlock := types.MapBlock(b)
129 if err := c.store.GetTransactionsUtxo(utxoView, detachBlock.Transactions); err != nil {
132 txStatus, err := c.GetTransactionStatus(&detachBlock.ID)
136 if err := utxoView.DetachBlock(detachBlock, txStatus); err != nil {
140 if err := c.bbft.DetachBlock(voteResultMap, b); err != nil {
144 log.WithFields(log.Fields{"module": logModule, "height": node.Height, "hash": node.Hash.String()}).Debug("detach from mainchain")
147 for _, attachNode := range attachNodes {
148 b, err := c.store.GetBlock(&attachNode.Hash)
153 attachBlock := types.MapBlock(b)
154 if err := c.store.GetTransactionsUtxo(utxoView, attachBlock.Transactions); err != nil {
157 txStatus, err := c.GetTransactionStatus(&attachBlock.ID)
161 if err := utxoView.ApplyBlock(attachBlock, txStatus); err != nil {
165 if err := c.bbft.ApplyBlock(voteResultMap, b); err != nil {
169 if c.bbft.isIrreversible(b) && b.Height > irreversibleNode.Height {
170 irreversibleNode = attachNode
173 log.WithFields(log.Fields{"module": logModule, "height": node.Height, "hash": node.Hash.String()}).Debug("attach from mainchain")
176 return c.setState(node, irreversibleNode, utxoView, voteResultMap)
179 // SaveBlock will validate and save block into storage
180 func (c *Chain) saveBlock(block *types.Block) error {
181 if err := c.bbft.ValidateBlock(block); err != nil {
182 return errors.Sub(ErrBadBlock, err)
185 parent := c.index.GetNode(&block.PreviousBlockHash)
186 if err := validation.ValidateBlock(types.MapBlock(block), parent); err != nil {
187 return errors.Sub(ErrBadBlock, err)
190 signature, err := c.bbft.SignBlock(block)
192 return errors.Sub(ErrBadBlock, err)
195 if len(signature) != 0 {
196 if err := c.txPool.eventDispatcher.Post(event.BlockSignatureEvent{BlockHash: block.Hash(), Signature: signature}); err != nil {
201 bcBlock := types.MapBlock(block)
202 if err := c.store.SaveBlock(block, bcBlock.TransactionStatus); err != nil {
206 c.orphanManage.Delete(&bcBlock.ID)
207 node, err := state.NewBlockNode(&block.BlockHeader, parent)
212 c.index.AddNode(node)
216 func (c *Chain) saveSubBlock(block *types.Block) *types.Block {
217 blockHash := block.Hash()
218 prevOrphans, ok := c.orphanManage.GetPrevOrphans(&blockHash)
224 for _, prevOrphan := range prevOrphans {
225 orphanBlock, ok := c.orphanManage.Get(prevOrphan)
227 log.WithFields(log.Fields{"module": logModule, "hash": prevOrphan.String()}).Warning("saveSubBlock fail to get block from orphanManage")
230 if err := c.saveBlock(orphanBlock); err != nil {
231 log.WithFields(log.Fields{"module": logModule, "hash": prevOrphan.String(), "height": orphanBlock.Height}).Warning("saveSubBlock fail to save block")
235 if subBestBlock := c.saveSubBlock(orphanBlock); subBestBlock.Height > bestBlock.Height {
236 bestBlock = subBestBlock
242 type processBlockResponse struct {
247 type processBlockMsg struct {
249 reply chan processBlockResponse
252 // ProcessBlock is the entry for chain update
253 func (c *Chain) ProcessBlock(block *types.Block) (bool, error) {
254 reply := make(chan processBlockResponse, 1)
255 c.processBlockCh <- &processBlockMsg{block: block, reply: reply}
257 return response.isOrphan, response.err
260 func (c *Chain) blockProcesser() {
261 for msg := range c.processBlockCh {
262 isOrphan, err := c.processBlock(msg.block)
263 msg.reply <- processBlockResponse{isOrphan: isOrphan, err: err}
267 // ProcessBlock is the entry for handle block insert
268 func (c *Chain) processBlock(block *types.Block) (bool, error) {
269 if block.Height <= c.bestIrreversibleNode.Height {
270 return false, errors.New("the height of block below the height of irreversible block")
273 blockHash := block.Hash()
274 if c.BlockExist(&blockHash) {
275 log.WithFields(log.Fields{"module": logModule, "hash": blockHash.String(), "height": block.Height}).Info("block has been processed")
276 return c.orphanManage.BlockExist(&blockHash), nil
279 parent := c.index.GetNode(&block.PreviousBlockHash)
281 c.orphanManage.Add(block)
285 if err := c.saveBlock(block); err != nil {
289 bestBlock := c.saveSubBlock(block)
290 bestBlockHash := bestBlock.Hash()
291 bestNode := c.index.GetNode(&bestBlockHash)
293 if bestNode.Parent == c.bestNode {
294 log.WithFields(log.Fields{"module": logModule}).Debug("append block to the end of mainchain")
295 return false, c.connectBlock(bestBlock)
298 if bestNode.Height > c.bestNode.Height {
299 log.WithFields(log.Fields{"module": logModule}).Debug("start to reorganize chain")
300 return false, c.reorganizeChain(bestNode)
305 func (c *Chain) processBlockSignature(signature, pubkey []byte, blockHeight uint64, blockHash *bc.Hash) error {
306 isBestIrreversible, err := c.bbft.ProcessBlockSignature(signature, pubkey, blockHeight, blockHash)
311 if isBestIrreversible {
312 bestIrreversibleNode := c.index.GetNode(blockHash)
313 if err := c.store.SaveChainNodeStatus(c.bestNode, bestIrreversibleNode); err != nil {
317 c.bestIrreversibleNode = bestIrreversibleNode