OSDN Git Service

versoin1.1.9 (#594)
[bytom/vapor.git] / protocol / protocol.go
index d7ea944..90c531f 100644 (file)
@@ -5,28 +5,52 @@ import (
 
        log "github.com/sirupsen/logrus"
 
-       "github.com/vapor/common"
-       "github.com/vapor/config"
-       "github.com/vapor/event"
-       "github.com/vapor/protocol/bc"
-       "github.com/vapor/protocol/bc/types"
-       "github.com/vapor/protocol/state"
+       "github.com/bytom/vapor/common"
+       "github.com/bytom/vapor/config"
+       "github.com/bytom/vapor/consensus"
+       "github.com/bytom/vapor/errors"
+       "github.com/bytom/vapor/event"
+       "github.com/bytom/vapor/protocol/bc"
+       "github.com/bytom/vapor/protocol/bc/types"
+       "github.com/bytom/vapor/protocol/state"
 )
 
 const (
-       maxProcessBlockChSize = 1024
-       maxKnownTxs           = 32768 // Maximum transactions hashes to keep in the known list (prevent DOS)
+       maxProcessBlockChSize              = 1024
+       maxKnownTxs                        = 32768 // Maximum transactions hashes to keep in the known list (prevent DOS)
+       maxPrevRoundVoteBlockHashCacheSize = 32768
 )
 
+// ErrNotInitSubProtocolChainStatus represent the node state of sub protocol has not been initialized
+var ErrNotInitSubProtocolChainStatus = errors.New("node state of sub protocol has not been initialized")
+
+// SubProtocol is interface for layer 2 consensus protocol
+type SubProtocol interface {
+       Name() string
+       StartHeight() uint64
+       BeforeProposalBlock(block *types.Block, gasLeft int64, isTimeout func() bool) ([]*types.Tx, error)
+
+       // ChainStatus return the the current block height and block hash of sub protocol.
+       // it will return ErrNotInitSubProtocolChainStatus if not initialized.
+       ChainStatus() (uint64, *bc.Hash, error)
+       InitChainStatus(*bc.Hash) error
+       ValidateBlock(block *types.Block, verifyResults []*bc.TxVerifyResult) error
+       ValidateTx(tx *types.Tx, verifyResult *bc.TxVerifyResult, blockHeight uint64) error
+       ApplyBlock(block *types.Block) error
+       DetachBlock(block *types.Block) error
+}
+
 // Chain provides functions for working with the Bytom block chain.
 type Chain struct {
        orphanManage   *OrphanManage
        txPool         *TxPool
        store          Store
        processBlockCh chan *processBlockMsg
+       subProtocols   []SubProtocol
 
-       signatureCache  *common.Cache
-       eventDispatcher *event.Dispatcher
+       signatureCache              *common.Cache
+       prevRoundVoteBlockHashCache *common.Cache
+       eventDispatcher             *event.Dispatcher
 
        cond               sync.Cond
        bestBlockHeader    *types.BlockHeader // the last block on current main chain
@@ -36,16 +60,18 @@ type Chain struct {
 }
 
 // NewChain returns a new Chain using store as the underlying storage.
-func NewChain(store Store, txPool *TxPool, eventDispatcher *event.Dispatcher) (*Chain, error) {
+func NewChain(store Store, txPool *TxPool, subProtocols []SubProtocol, eventDispatcher *event.Dispatcher) (*Chain, error) {
        knownTxs, _ := common.NewOrderedSet(maxKnownTxs)
        c := &Chain{
-               orphanManage:    NewOrphanManage(),
-               txPool:          txPool,
-               store:           store,
-               signatureCache:  common.NewCache(maxSignatureCacheSize),
-               eventDispatcher: eventDispatcher,
-               processBlockCh:  make(chan *processBlockMsg, maxProcessBlockChSize),
-               knownTxs:        knownTxs,
+               orphanManage:                NewOrphanManage(),
+               txPool:                      txPool,
+               store:                       store,
+               subProtocols:                subProtocols,
+               signatureCache:              common.NewCache(maxSignatureCacheSize),
+               prevRoundVoteBlockHashCache: common.NewCache(maxPrevRoundVoteBlockHashCacheSize),
+               eventDispatcher:             eventDispatcher,
+               processBlockCh:              make(chan *processBlockMsg, maxProcessBlockChSize),
+               knownTxs:                    knownTxs,
        }
        c.cond.L = new(sync.Mutex)
 
@@ -67,6 +93,13 @@ func NewChain(store Store, txPool *TxPool, eventDispatcher *event.Dispatcher) (*
        if err != nil {
                return nil, err
        }
+
+       for _, p := range c.subProtocols {
+               if err := c.syncProtocolStatus(p); err != nil {
+                       return nil, errors.Wrap(err, p.Name(), "sync sub protocol status")
+               }
+       }
+
        go c.blockProcesser()
        return c, nil
 }
@@ -90,7 +123,13 @@ func (c *Chain) initChainStatus() error {
                return err
        }
 
-       consensusResults := []*state.ConsensusResult{&state.ConsensusResult{
+       for _, subProtocol := range c.subProtocols {
+               if err := subProtocol.ApplyBlock(genesisBlock); err != nil {
+                       return err
+               }
+       }
+
+       consensusResults := []*state.ConsensusResult{{
                Seq:            0,
                NumOfVote:      make(map[string]uint64),
                CoinbaseReward: make(map[string]uint64),
@@ -102,6 +141,39 @@ func (c *Chain) initChainStatus() error {
        return c.store.SaveChainStatus(genesisBlockHeader, genesisBlockHeader, []*types.BlockHeader{genesisBlockHeader}, utxoView, consensusResults)
 }
 
+// getPrevRoundVoteBlockHash return the previous round block hash by the given block header
+func (c *Chain) getPrevRoundVoteBlockHash(hash *bc.Hash) (*bc.Hash, error) {
+       if data, ok := c.prevRoundVoteBlockHashCache.Get(*hash); ok {
+               return data.(*bc.Hash), nil
+       }
+
+       header, err := c.store.GetBlockHeader(hash)
+       if err != nil {
+               return nil, errNotFoundBlockNode
+       }
+
+       if header.Height%consensus.ActiveNetParams.RoundVoteBlockNums == 0 {
+               c.prevRoundVoteBlockHashCache.Add(*hash, hash)
+               return hash, nil
+       }
+
+       if data, ok := c.prevRoundVoteBlockHashCache.Get(header.PreviousBlockHash); ok {
+               c.prevRoundVoteBlockHashCache.Add(*hash, data.(*bc.Hash))
+               return data.(*bc.Hash), nil
+       }
+
+       // loop find the prev round vote block hash
+       for header.Height%consensus.ActiveNetParams.RoundVoteBlockNums != 0 {
+               header, err = c.store.GetBlockHeader(&header.PreviousBlockHash)
+               if err != nil {
+                       return nil, err
+               }
+       }
+       preRoundVoteBlockHash := header.Hash()
+       c.prevRoundVoteBlockHashCache.Add(*hash, &preRoundVoteBlockHash)
+       return &preRoundVoteBlockHash, nil
+}
+
 // BestBlockHeight returns the current height of the blockchain.
 func (c *Chain) BestBlockHeight() uint64 {
        c.cond.L.Lock()
@@ -146,6 +218,11 @@ func (c *Chain) InMainChain(hash bc.Hash) bool {
        return *blockHash == hash
 }
 
+// SubProtocols return list of layer 2 consensus protocol
+func (c *Chain) SubProtocols() []SubProtocol {
+       return c.subProtocols
+}
+
 // trace back to the tail of the chain from the given block header
 func (c *Chain) traceLongestChainTail(blockHeader *types.BlockHeader) (*types.BlockHeader, error) {
        longestTail, workQueue := blockHeader, []*types.BlockHeader{blockHeader}
@@ -182,6 +259,61 @@ func (c *Chain) markTransactions(txs ...*types.Tx) {
        }
 }
 
+func (c *Chain) syncProtocolStatus(subProtocol SubProtocol) error {
+       if c.bestBlockHeader.Height < subProtocol.StartHeight() {
+               return nil
+       }
+
+       protocolHeight, protocolHash, err := subProtocol.ChainStatus()
+       if err == ErrNotInitSubProtocolChainStatus {
+               startHash, err := c.store.GetMainChainHash(subProtocol.StartHeight())
+               if err != nil {
+                       return errors.Wrap(err, subProtocol.Name(), "can't get block hash by height")
+               }
+
+               if err := subProtocol.InitChainStatus(startHash); err != nil {
+                       return errors.Wrap(err, subProtocol.Name(), "fail init chain status")
+               }
+
+               protocolHeight, protocolHash = subProtocol.StartHeight(), startHash
+       } else if err != nil {
+               return errors.Wrap(err, subProtocol.Name(), "can't get chain status")
+       }
+
+       if *protocolHash == c.bestBlockHeader.Hash() {
+               return nil
+       }
+
+       for !c.InMainChain(*protocolHash) {
+               block, err := c.GetBlockByHash(protocolHash)
+               if err != nil {
+                       return errors.Wrap(err, subProtocol.Name(), "can't get block by hash in chain")
+               }
+
+               if err := subProtocol.DetachBlock(block); err != nil {
+                       return errors.Wrap(err, subProtocol.Name(), "sub protocol detach block err")
+               }
+
+               protocolHeight, protocolHash = block.Height-1, &block.PreviousBlockHash
+       }
+
+       for height := protocolHeight + 1; height <= c.bestBlockHeader.Height; height++ {
+               block, err := c.GetBlockByHeight(height)
+               if err != nil {
+                       return errors.Wrap(err, subProtocol.Name(), "can't get block by height in chain")
+               }
+
+               if err := subProtocol.ApplyBlock(block); err != nil {
+                       return errors.Wrap(err, subProtocol.Name(), "sub protocol apply block err")
+               }
+
+               blockHash := block.Hash()
+               protocolHeight, protocolHash = block.Height, &blockHash
+       }
+
+       return nil
+}
+
 // This function must be called with mu lock in above level
 func (c *Chain) setState(blockHeader, irrBlockHeader *types.BlockHeader, mainBlockHeaders []*types.BlockHeader, view *state.UtxoViewpoint, consensusResults []*state.ConsensusResult) error {
        if err := c.store.SaveChainStatus(blockHeader, irrBlockHeader, mainBlockHeaders, view, consensusResults); err != nil {