protocol/block.go

   1 package protocol
   2
   3 import (
   4         log "github.com/sirupsen/logrus"
   5
   6         "github.com/vapor/config"
   7         "github.com/vapor/errors"
   8         "github.com/vapor/event"
   9         "github.com/vapor/protocol/bc"
  10         "github.com/vapor/protocol/bc/types"
  11         "github.com/vapor/protocol/state"
  12         "github.com/vapor/protocol/validation"
  13 )
  14
  15 var (
  16         // ErrBadBlock is returned when a block is invalid.
  17         ErrBadBlock = errors.New("invalid block")
  18         // ErrBadStateRoot is returned when the computed assets merkle root
  19         // disagrees with the one declared in a block header.
  20         ErrBadStateRoot = errors.New("invalid state merkle root")
  21 )
  22
  23 // BlockExist check is a block in chain or orphan
  24 func (c *Chain) BlockExist(hash *bc.Hash) bool {
  25         if _, err := c.store.GetBlockHeader(hash); err == nil {
  26                 return true
  27         }
  28         return c.orphanManage.BlockExist(hash)
  29 }
  30
  31 // GetBlockByHash return a block by given hash
  32 func (c *Chain) GetBlockByHash(hash *bc.Hash) (*types.Block, error) {
  33         return c.store.GetBlock(hash)
  34 }
  35
  36 // GetBlockByHeight return a block by given height
  37 func (c *Chain) GetBlockByHeight(height uint64) (*types.Block, error) {
  38         hash, err := c.store.GetMainChainHash(height)
  39         if err != nil {
  40                 return nil, errors.Wrap(err, "can't find block in given height")
  41         }
  42         return c.store.GetBlock(hash)
  43 }
  44
  45 // GetHeaderByHash return a block header by given hash
  46 func (c *Chain) GetHeaderByHash(hash *bc.Hash) (*types.BlockHeader, error) {
  47         return c.store.GetBlockHeader(hash)
  48 }
  49
  50 // GetHeaderByHeight return a block header by given height
  51 func (c *Chain) GetHeaderByHeight(height uint64) (*types.BlockHeader, error) {
  52         hash, err := c.store.GetMainChainHash(height)
  53         if err != nil {
  54                 return nil, errors.Wrap(err, "can't find block header in given height")
  55         }
  56         return c.store.GetBlockHeader(hash)
  57 }
  58
  59 func (c *Chain) calcReorganizeChain(beginAttach *types.BlockHeader, beginDetach *types.BlockHeader) ([]*types.BlockHeader, []*types.BlockHeader, error) {
  60         var err error
  61         var attachBlockHeaders []*types.BlockHeader
  62         var detachBlockHeaders []*types.BlockHeader
  63
  64         for attachBlockHeader, detachBlockHeader := beginAttach, beginDetach; detachBlockHeader.Hash() != attachBlockHeader.Hash(); {
  65                 var attachRollback, detachRollBack bool
  66                 if attachRollback = attachBlockHeader.Height >= detachBlockHeader.Height; attachRollback {
  67                         attachBlockHeaders = append([]*types.BlockHeader{attachBlockHeader}, attachBlockHeaders...)
  68                 }
  69
  70                 if detachRollBack = attachBlockHeader.Height <= detachBlockHeader.Height; detachRollBack {
  71                         detachBlockHeaders = append(detachBlockHeaders, detachBlockHeader)
  72                 }
  73
  74                 if attachRollback {
  75                         attachBlockHeader, err = c.store.GetBlockHeader(&attachBlockHeader.PreviousBlockHash)
  76                         if err != nil {
  77                                 return nil, nil, err
  78                         }
  79                 }
  80
  81                 if detachRollBack {
  82                         detachBlockHeader, err = c.store.GetBlockHeader(&detachBlockHeader.PreviousBlockHash)
  83                         if err != nil {
  84                                 return nil, nil, err
  85                         }
  86                 }
  87         }
  88         return attachBlockHeaders, detachBlockHeaders, nil
  89 }
  90
  91 func (c *Chain) connectBlock(block *types.Block) (err error) {
  92         bcBlock := types.MapBlock(block)
  93         if bcBlock.TransactionStatus, err = c.store.GetTransactionStatus(&bcBlock.ID); err != nil {
  94                 return err
  95         }
  96
  97         utxoView := state.NewUtxoViewpoint()
  98         if err := c.store.GetTransactionsUtxo(utxoView, bcBlock.Transactions); err != nil {
  99                 return err
 100         }
 101         if err := utxoView.ApplyBlock(bcBlock, bcBlock.TransactionStatus); err != nil {
 102                 return err
 103         }
 104
 105         consensusResult, err := c.getBestConsensusResult()
 106         if err != nil {
 107                 return err
 108         }
 109         if err := consensusResult.ApplyBlock(block); err != nil {
 110                 return err
 111         }
 112
 113         irrBlockHeader := c.lastIrrBlockHeader
 114         if c.isIrreversible(&block.BlockHeader) && block.Height > irrBlockHeader.Height {
 115                 irrBlockHeader = &block.BlockHeader
 116         }
 117
 118         if err := c.setState(&block.BlockHeader, irrBlockHeader, []*types.BlockHeader{&block.BlockHeader}, utxoView, []*state.ConsensusResult{consensusResult}); err != nil {
 119                 return err
 120         }
 121
 122         for _, tx := range block.Transactions {
 123                 c.txPool.RemoveTransaction(&tx.Tx.ID)
 124         }
 125         return nil
 126 }
 127
 128 func (c *Chain) reorganizeChain(blockHeader *types.BlockHeader) error {
 129         attachBlockHeaders, detachBlockHeaders, err := c.calcReorganizeChain(blockHeader, c.bestBlockHeader)
 130         if err != nil {
 131                 return err
 132         }
 133
 134         utxoView := state.NewUtxoViewpoint()
 135         consensusResults := []*state.ConsensusResult{}
 136         consensusResult, err := c.getBestConsensusResult()
 137         if err != nil {
 138                 return err
 139         }
 140
 141         txsToRestore := map[bc.Hash]*types.Tx{}
 142         for _, detachBlockHeader := range detachBlockHeaders {
 143                 detachHash := detachBlockHeader.Hash()
 144                 b, err := c.store.GetBlock(&detachHash)
 145                 if err != nil {
 146                         return err
 147                 }
 148
 149                 detachBlock := types.MapBlock(b)
 150                 if err := c.store.GetTransactionsUtxo(utxoView, detachBlock.Transactions); err != nil {
 151                         return err
 152                 }
 153
 154                 txStatus, err := c.GetTransactionStatus(&detachBlock.ID)
 155                 if err != nil {
 156                         return err
 157                 }
 158
 159                 if err := utxoView.DetachBlock(detachBlock, txStatus); err != nil {
 160                         return err
 161                 }
 162
 163                 if err := consensusResult.DetachBlock(b); err != nil {
 164                         return err
 165                 }
 166
 167                 for _, tx := range b.Transactions {
 168                         txsToRestore[tx.ID] = tx
 169                 }
 170
 171                 blockHash := blockHeader.Hash()
 172                 log.WithFields(log.Fields{"module": logModule, "height": blockHeader.Height, "hash": blockHash.String()}).Debug("detach from mainchain")
 173         }
 174
 175         txsToRemove := map[bc.Hash]*types.Tx{}
 176         irrBlockHeader := c.lastIrrBlockHeader
 177         for _, attachBlockHeader := range attachBlockHeaders {
 178                 attachHash := attachBlockHeader.Hash()
 179                 b, err := c.store.GetBlock(&attachHash)
 180                 if err != nil {
 181                         return err
 182                 }
 183
 184                 attachBlock := types.MapBlock(b)
 185                 if err := c.store.GetTransactionsUtxo(utxoView, attachBlock.Transactions); err != nil {
 186                         return err
 187                 }
 188
 189                 txStatus, err := c.GetTransactionStatus(&attachBlock.ID)
 190                 if err != nil {
 191                         return err
 192                 }
 193
 194                 if err := utxoView.ApplyBlock(attachBlock, txStatus); err != nil {
 195                         return err
 196                 }
 197
 198                 if err := consensusResult.ApplyBlock(b); err != nil {
 199                         return err
 200                 }
 201
 202                 if consensusResult.IsFinalize() {
 203                         consensusResults = append(consensusResults, consensusResult.Fork())
 204                 }
 205
 206                 if c.isIrreversible(attachBlockHeader) && attachBlockHeader.Height > irrBlockHeader.Height {
 207                         irrBlockHeader = attachBlockHeader
 208                 }
 209
 210                 for _, tx := range b.Transactions {
 211                         if _, ok := txsToRestore[tx.ID]; !ok {
 212                                 txsToRemove[tx.ID] = tx
 213                         } else {
 214                                 delete(txsToRestore, tx.ID)
 215                         }
 216                 }
 217
 218                 blockHash := blockHeader.Hash()
 219                 log.WithFields(log.Fields{"module": logModule, "height": blockHeader.Height, "hash": blockHash.String()}).Debug("attach from mainchain")
 220         }
 221
 222         if len(detachBlockHeaders) > 0 &&
 223                 detachBlockHeaders[len(detachBlockHeaders)-1].Height <= c.lastIrrBlockHeader.Height &&
 224                 irrBlockHeader.Height <= c.lastIrrBlockHeader.Height {
 225                 return errors.New("rollback block below the height of irreversible block")
 226         }
 227
 228         consensusResults = append(consensusResults, consensusResult.Fork())
 229         if err := c.setState(blockHeader, irrBlockHeader, attachBlockHeaders, utxoView, consensusResults); err != nil {
 230                 return err
 231         }
 232
 233         for txHash := range txsToRemove {
 234                 c.txPool.RemoveTransaction(&txHash)
 235         }
 236
 237         for _, tx := range txsToRestore {
 238                 // the number of restored Tx should be very small or most of time ZERO
 239                 // Error returned from validation is ignored, tx could still be lost if validation fails.
 240                 // TODO: adjust tx timestamp so that it won't starve in pool.
 241                 if _, err := c.ValidateTx(tx); err != nil {
 242                         log.WithFields(log.Fields{"module": logModule, "tx_id": tx.Tx.ID.String(), "error": err}).Info("restore tx fail")
 243                 }
 244         }
 245
 246         if len(txsToRestore) > 0 {
 247                 log.WithFields(log.Fields{"module": logModule, "num": len(txsToRestore)}).Debug("restore txs back to pool")
 248         }
 249         return nil
 250 }
 251
 252 // SaveBlock will validate and save block into storage
 253 func (c *Chain) saveBlock(block *types.Block) error {
 254         if err := c.validateSign(block); err != nil {
 255                 return errors.Sub(ErrBadBlock, err)
 256         }
 257
 258         parent, err := c.store.GetBlockHeader(&block.PreviousBlockHash)
 259         if err != nil {
 260                 return err
 261         }
 262
 263         consensusResult, err := c.GetConsensusResultByHash(&block.PreviousBlockHash)
 264         if err != nil {
 265                 return err
 266         }
 267
 268         if err := consensusResult.AttachCoinbaseReward(block); err != nil {
 269                 return err
 270         }
 271
 272         rewards, err := consensusResult.GetCoinbaseRewards(block.Height)
 273         if err != nil {
 274                 return err
 275         }
 276
 277         bcBlock := types.MapBlock(block)
 278         if err := validation.ValidateBlock(bcBlock, parent, rewards); err != nil {
 279                 return errors.Sub(ErrBadBlock, err)
 280         }
 281
 282         signature, err := c.SignBlock(block)
 283         if err != nil {
 284                 return errors.Sub(ErrBadBlock, err)
 285         }
 286
 287         if err := c.store.SaveBlock(block, bcBlock.TransactionStatus); err != nil {
 288                 return err
 289         }
 290         c.orphanManage.Delete(&bcBlock.ID)
 291
 292         if len(signature) != 0 {
 293                 xPub := config.CommonConfig.PrivateKey().XPub()
 294                 if err := c.eventDispatcher.Post(event.BlockSignatureEvent{BlockHash: block.Hash(), Signature: signature, XPub: xPub[:]}); err != nil {
 295                         return err
 296                 }
 297         }
 298         return nil
 299 }
 300
 301 func (c *Chain) saveSubBlock(block *types.Block) *types.Block {
 302         blockHash := block.Hash()
 303         prevOrphans, ok := c.orphanManage.GetPrevOrphans(&blockHash)
 304         if !ok {
 305                 return block
 306         }
 307
 308         bestBlock := block
 309         for _, prevOrphan := range prevOrphans {
 310                 orphanBlock, ok := c.orphanManage.Get(prevOrphan)
 311                 if !ok {
 312                         log.WithFields(log.Fields{"module": logModule, "hash": prevOrphan.String()}).Warning("saveSubBlock fail to get block from orphanManage")
 313                         continue
 314                 }
 315                 if err := c.saveBlock(orphanBlock); err != nil {
 316                         log.WithFields(log.Fields{"module": logModule, "hash": prevOrphan.String(), "height": orphanBlock.Height}).Warning("saveSubBlock fail to save block")
 317                         continue
 318                 }
 319
 320                 if subBestBlock := c.saveSubBlock(orphanBlock); subBestBlock.Height > bestBlock.Height {
 321                         bestBlock = subBestBlock
 322                 }
 323         }
 324         return bestBlock
 325 }
 326
 327 type processBlockResponse struct {
 328         isOrphan bool
 329         err      error
 330 }
 331
 332 type processBlockMsg struct {
 333         block *types.Block
 334         reply chan processBlockResponse
 335 }
 336
 337 // ProcessBlock is the entry for chain update
 338 func (c *Chain) ProcessBlock(block *types.Block) (bool, error) {
 339         reply := make(chan processBlockResponse, 1)
 340         c.processBlockCh <- &processBlockMsg{block: block, reply: reply}
 341         response := <-reply
 342         return response.isOrphan, response.err
 343 }
 344
 345 func (c *Chain) blockProcesser() {
 346         for msg := range c.processBlockCh {
 347                 isOrphan, err := c.processBlock(msg.block)
 348                 msg.reply <- processBlockResponse{isOrphan: isOrphan, err: err}
 349         }
 350 }
 351
 352 // ProcessBlock is the entry for handle block insert
 353 func (c *Chain) processBlock(block *types.Block) (bool, error) {
 354         blockHash := block.Hash()
 355         if c.BlockExist(&blockHash) {
 356                 log.WithFields(log.Fields{"module": logModule, "hash": blockHash.String(), "height": block.Height}).Info("block has been processed")
 357                 return c.orphanManage.BlockExist(&blockHash), nil
 358         }
 359
 360         if _, err := c.store.GetBlockHeader(&block.PreviousBlockHash); err != nil {
 361                 c.orphanManage.Add(block)
 362                 return true, nil
 363         }
 364
 365         if err := c.saveBlock(block); err != nil {
 366                 return false, err
 367         }
 368
 369         bestBlock := c.saveSubBlock(block)
 370         bestBlockHeader := &bestBlock.BlockHeader
 371
 372         c.cond.L.Lock()
 373         defer c.cond.L.Unlock()
 374         if bestBlockHeader.PreviousBlockHash == c.bestBlockHeader.Hash() {
 375                 log.WithFields(log.Fields{"module": logModule}).Debug("append block to the end of mainchain")
 376                 return false, c.connectBlock(bestBlock)
 377         }
 378
 379         if bestBlockHeader.Height > c.bestBlockHeader.Height {
 380                 log.WithFields(log.Fields{"module": logModule}).Debug("start to reorganize chain")
 381                 return false, c.reorganizeChain(bestBlockHeader)
 382         }
 383         return false, nil
 384 }