package protocol
import (
- "time"
+ log "github.com/sirupsen/logrus"
"github.com/bytom/errors"
"github.com/bytom/protocol/bc"
- "github.com/bytom/protocol/bc/legacy"
+ "github.com/bytom/protocol/bc/types"
"github.com/bytom/protocol/state"
"github.com/bytom/protocol/validation"
)
-// maxBlockTxs limits the number of transactions
-// included in each block.
-const maxBlockTxs = 10000
-
-// saveSnapshotFrequency stores how often to save a state
-// snapshot to the Store.
-const saveSnapshotFrequency = time.Hour
-
var (
// ErrBadBlock is returned when a block is invalid.
ErrBadBlock = errors.New("invalid block")
-
- // ErrStaleState is returned when the Chain does not have a current
- // blockchain state.
- ErrStaleState = errors.New("stale blockchain state")
-
// ErrBadStateRoot is returned when the computed assets merkle root
// disagrees with the one declared in a block header.
ErrBadStateRoot = errors.New("invalid state merkle root")
)
-// GetBlock returns the block at the given height, if there is one,
-// otherwise it returns an error.
-func (c *Chain) GetBlock(hash *bc.Hash) (*legacy.Block, error) {
+// BlockExist check is a block in chain or orphan
+func (c *Chain) BlockExist(hash *bc.Hash) bool {
+ return c.index.BlockExist(hash) || c.orphanManage.BlockExist(hash)
+}
+
+// GetBlockByHash return a block by given hash
+func (c *Chain) GetBlockByHash(hash *bc.Hash) (*types.Block, error) {
return c.store.GetBlock(hash)
}
-func (c *Chain) GetBlockByHeight(height uint64) (*legacy.Block, error) {
- hash, ok := c.state.mainChain[height]
- if !ok {
- return nil, nil
+// GetBlockByHeight return a block header by given height
+func (c *Chain) GetBlockByHeight(height uint64) (*types.Block, error) {
+ node := c.index.NodeByHeight(height)
+ if node == nil {
+ return nil, errors.New("can't find block in given height")
}
- return c.GetBlock(hash)
+ return c.store.GetBlock(&node.Hash)
}
-// ValidateBlock validates an incoming block in advance of applying it
-// to a snapshot (with ApplyValidBlock) and committing it to the
-// blockchain (with CommitAppliedBlock).
-func (c *Chain) ValidateBlock(block, prev *legacy.Block) error {
- blockEnts := legacy.MapBlock(block)
- prevEnts := legacy.MapBlock(prev)
- err := validation.ValidateBlock(blockEnts, prevEnts)
- if err != nil {
- return errors.Sub(ErrBadBlock, err)
+// GetHeaderByHash return a block header by given hash
+func (c *Chain) GetHeaderByHash(hash *bc.Hash) (*types.BlockHeader, error) {
+ node := c.index.GetNode(hash)
+ if node == nil {
+ return nil, errors.New("can't find block header in given hash")
}
- return errors.Sub(ErrBadBlock, err)
+ return node.BlockHeader(), nil
}
-// ApplyValidBlock creates an updated snapshot without validating the
-// block.
-func (c *Chain) ConnectBlock(block *legacy.Block) error {
- newSnapshot := state.Copy(c.state.snapshot)
- if err := newSnapshot.ApplyBlock(legacy.MapBlock(block)); err != nil {
- return err
+// GetHeaderByHeight return a block header by given height
+func (c *Chain) GetHeaderByHeight(height uint64) (*types.BlockHeader, error) {
+ node := c.index.NodeByHeight(height)
+ if node == nil {
+ return nil, errors.New("can't find block header in given height")
}
- if block.AssetsMerkleRoot != newSnapshot.Tree.RootHash() {
- return ErrBadStateRoot
+ return node.BlockHeader(), nil
+}
+
+func (c *Chain) calcReorganizeNodes(node *state.BlockNode) ([]*state.BlockNode, []*state.BlockNode) {
+ var attachNodes []*state.BlockNode
+ var detachNodes []*state.BlockNode
+
+ attachNode := node
+ for c.index.NodeByHeight(attachNode.Height) != attachNode {
+ attachNodes = append([]*state.BlockNode{attachNode}, attachNodes...)
+ attachNode = attachNode.Parent
}
- blockHash := block.Hash()
- if err := c.store.SaveSnapshot(newSnapshot, &blockHash); err != nil {
+ detachNode := c.bestNode
+ for detachNode != attachNode {
+ detachNodes = append(detachNodes, detachNode)
+ detachNode = detachNode.Parent
+ }
+ return attachNodes, detachNodes
+}
+
+func (c *Chain) connectBlock(block *types.Block) (err error) {
+ bcBlock := types.MapBlock(block)
+ if bcBlock.TransactionStatus, err = c.store.GetTransactionStatus(&bcBlock.ID); err != nil {
return err
}
- c.state.mainChain[block.Height] = &blockHash
- if err := c.store.SaveMainchain(c.state.mainChain, &blockHash); err != nil {
- delete(c.state.mainChain, block.Height)
+
+ utxoView := state.NewUtxoViewpoint()
+ if err := c.store.GetTransactionsUtxo(utxoView, bcBlock.Transactions); err != nil {
+ return err
+ }
+ if err := utxoView.ApplyBlock(bcBlock, bcBlock.TransactionStatus); err != nil {
+ return err
+ }
+
+ node := c.index.GetNode(&bcBlock.ID)
+ if err := c.setState(node, utxoView); err != nil {
return err
}
- c.state.snapshot = newSnapshot
- c.store.SaveStoreStatus(block.Height, &blockHash)
for _, tx := range block.Transactions {
c.txPool.RemoveTransaction(&tx.Tx.ID)
return nil
}
-func (c *Chain) getReorganizeBlocks(block *legacy.Block) ([]*legacy.Block, []*legacy.Block) {
- attachBlocks := []*legacy.Block{}
- detachBlocks := []*legacy.Block{}
+func (c *Chain) reorganizeChain(node *state.BlockNode) error {
+ attachNodes, detachNodes := c.calcReorganizeNodes(node)
+ utxoView := state.NewUtxoViewpoint()
- ancestor := block
- for ancestor, ok := c.orphanManage.Get(&ancestor.PreviousBlockHash); ok; {
- if c.InMainchain(ancestor) {
- break
+ for _, detachNode := range detachNodes {
+ b, err := c.store.GetBlock(&detachNode.Hash)
+ if err != nil {
+ return err
}
- attachBlocks = append([]*legacy.Block{ancestor}, attachBlocks...)
- }
- for n := c.state.block; n != nil; n, _ = c.GetBlock(&n.PreviousBlockHash) {
- if n.Hash() == ancestor.Hash() {
- break
+ detachBlock := types.MapBlock(b)
+ if err := c.store.GetTransactionsUtxo(utxoView, detachBlock.Transactions); err != nil {
+ return err
+ }
+ txStatus, err := c.GetTransactionStatus(&detachBlock.ID)
+ if err != nil {
+ return err
+ }
+ if err := utxoView.DetachBlock(detachBlock, txStatus); err != nil {
+ return err
}
- detachBlocks = append(detachBlocks, n)
- }
-
- return attachBlocks, detachBlocks
-}
-func (c *Chain) AddOrphan(block *legacy.Block) error {
- attachBlocks, detachBlocks := c.getReorganizeBlocks(block)
- newSnapshot := state.Copy(c.state.snapshot)
+ log.WithFields(log.Fields{"height": node.Height, "hash": node.Hash.String()}).Debug("detach from mainchain")
+ }
- for _, detachBlock := range detachBlocks {
- if err := newSnapshot.DetachBlock(legacy.MapBlock(detachBlock)); err != nil {
+ for _, attachNode := range attachNodes {
+ b, err := c.store.GetBlock(&attachNode.Hash)
+ if err != nil {
return err
}
- }
- for _, attachBlock := range attachBlocks {
- if err := newSnapshot.ApplyBlock(legacy.MapBlock(attachBlock)); err != nil {
+ attachBlock := types.MapBlock(b)
+ if err := c.store.GetTransactionsUtxo(utxoView, attachBlock.Transactions); err != nil {
+ return err
+ }
+ txStatus, err := c.GetTransactionStatus(&attachBlock.ID)
+ if err != nil {
return err
}
+ if err := utxoView.ApplyBlock(attachBlock, txStatus); err != nil {
+ return err
+ }
+
+ log.WithFields(log.Fields{"height": node.Height, "hash": node.Hash.String()}).Debug("attach from mainchain")
}
- blockHash := block.Hash()
- if err := c.store.SaveSnapshot(newSnapshot, &blockHash); err != nil {
- return err
+ return c.setState(node, utxoView)
+}
+
+// SaveBlock will validate and save block into storage
+func (c *Chain) saveBlock(block *types.Block) error {
+ bcBlock := types.MapBlock(block)
+ parent := c.index.GetNode(&block.PreviousBlockHash)
+
+ if err := validation.ValidateBlock(bcBlock, parent); err != nil {
+ return errors.Sub(ErrBadBlock, err)
}
- for _, attachBlock := range attachBlocks {
- attachBlockHash := attachBlock.Hash()
- c.state.mainChain[attachBlock.Height] = &attachBlockHash
- c.orphanManage.Delete(&attachBlockHash)
+ if err := c.store.SaveBlock(block, bcBlock.TransactionStatus); err != nil {
+ return err
}
- c.state.mainChain[block.Height] = &blockHash
- if err := c.store.SaveMainchain(c.state.mainChain, &blockHash); err != nil {
- delete(c.state.mainChain, block.Height)
+
+ c.orphanManage.Delete(&bcBlock.ID)
+ node, err := state.NewBlockNode(&block.BlockHeader, parent)
+ if err != nil {
return err
}
- c.state.snapshot = newSnapshot
- c.store.SaveStoreStatus(block.Height, &blockHash)
+
+ c.index.AddNode(node)
return nil
}
-func (c *Chain) AddBlock(block *legacy.Block) (bool, error) {
+func (c *Chain) saveSubBlock(block *types.Block) *types.Block {
blockHash := block.Hash()
- if c.orphanManage.BlockExist(&blockHash) || c.store.BlockExist(&blockHash) {
- return c.InMainchain(block), nil
+ prevOrphans, ok := c.orphanManage.GetPrevOrphans(&blockHash)
+ if !ok {
+ return block
}
- if !c.store.BlockExist(&block.PreviousBlockHash) {
- c.orphanManage.Add(block)
- return true, nil
+ bestBlock := block
+ for _, prevOrphan := range prevOrphans {
+ orphanBlock, ok := c.orphanManage.Get(prevOrphan)
+ if !ok {
+ log.WithFields(log.Fields{"hash": prevOrphan.String()}).Warning("saveSubBlock fail to get block from orphanManage")
+ continue
+ }
+ if err := c.saveBlock(orphanBlock); err != nil {
+ log.WithFields(log.Fields{"hash": prevOrphan.String(), "height": orphanBlock.Height}).Warning("saveSubBlock fail to save block")
+ continue
+ }
+
+ if subBestBlock := c.saveSubBlock(orphanBlock); subBestBlock.Height > bestBlock.Height {
+ bestBlock = subBestBlock
+ }
}
+ return bestBlock
+}
- preBlock, err := c.GetBlock(&block.PreviousBlockHash)
- if err != nil {
- return false, err
+type processBlockResponse struct {
+ isOrphan bool
+ err error
+}
+
+type processBlockMsg struct {
+ block *types.Block
+ reply chan processBlockResponse
+}
+
+// ProcessBlock is the entry for chain update
+func (c *Chain) ProcessBlock(block *types.Block) (bool, error) {
+ reply := make(chan processBlockResponse, 1)
+ c.processBlockCh <- &processBlockMsg{block: block, reply: reply}
+ response := <-reply
+ return response.isOrphan, response.err
+}
+
+func (c *Chain) blockProcesser() {
+ for msg := range c.processBlockCh {
+ isOrphan, err := c.processBlock(msg.block)
+ msg.reply <- processBlockResponse{isOrphan: isOrphan, err: err}
}
+}
- if err := c.ValidateBlock(block, preBlock); err != nil {
- return false, err
+// ProcessBlock is the entry for handle block insert
+func (c *Chain) processBlock(block *types.Block) (bool, error) {
+ blockHash := block.Hash()
+ if c.BlockExist(&blockHash) {
+ log.WithFields(log.Fields{"hash": blockHash.String(), "height": block.Height}).Info("block has been processed")
+ return c.orphanManage.BlockExist(&blockHash), nil
}
- c.store.SaveBlock(block)
- if *c.state.mainChain[preBlock.Height] == block.PreviousBlockHash {
- return false, c.ConnectBlock(block)
+ if parent := c.index.GetNode(&block.PreviousBlockHash); parent == nil {
+ c.orphanManage.Add(block)
+ return true, nil
}
- if block.Bits > c.state.block.Bits {
- return true, c.AddOrphan(block)
+ if err := c.saveBlock(block); err != nil {
+ return false, err
}
- return true, nil
-}
-func (c *Chain) setHeight(h uint64) {
- // We call setHeight from two places independently:
- // CommitBlock and the Postgres LISTEN goroutine.
- // This means we can get here twice for each block,
- // and any of them might be arbitrarily delayed,
- // which means h might be from the past.
- // Detect and discard these duplicate calls.
+ bestBlock := c.saveSubBlock(block)
+ bestBlockHash := bestBlock.Hash()
+ bestNode := c.index.GetNode(&bestBlockHash)
- c.state.cond.L.Lock()
- defer c.state.cond.L.Unlock()
+ if bestNode.Parent == c.bestNode {
+ log.Debug("append block to the end of mainchain")
+ return false, c.connectBlock(bestBlock)
+ }
- if h <= c.state.height {
- return
+ if bestNode.Height > c.bestNode.Height && bestNode.WorkSum.Cmp(c.bestNode.WorkSum) >= 0 {
+ log.Debug("start to reorganize chain")
+ return false, c.reorganizeChain(bestNode)
}
- c.state.height = h
- c.state.cond.Broadcast()
+ return false, nil
}