mining/mining.go

   1 // Copyright (c) 2014-2016 The btcsuite developers
   2 // Use of this source code is governed by an ISC
   3 // license that can be found in the LICENSE file.
   4
   5 package mining
   6
   7 import (
   8         "sort"
   9         "time"
  10
  11         log "github.com/sirupsen/logrus"
  12
  13         "github.com/bytom/blockchain/account"
  14         "github.com/bytom/blockchain/txbuilder"
  15         "github.com/bytom/consensus"
  16         "github.com/bytom/consensus/difficulty"
  17         "github.com/bytom/errors"
  18         "github.com/bytom/protocol"
  19         "github.com/bytom/protocol/bc"
  20         "github.com/bytom/protocol/bc/legacy"
  21         "github.com/bytom/protocol/state"
  22         "github.com/bytom/protocol/validation"
  23         "github.com/bytom/protocol/vm/vmutil"
  24 )
  25
  26 // createCoinbaseTx returns a coinbase transaction paying an appropriate subsidy
  27 // based on the passed block height to the provided address.  When the address
  28 // is nil, the coinbase transaction will instead be redeemable by anyone.
  29 func createCoinbaseTx(accountManager *account.Manager, amount uint64, blockHeight uint64) (tx *legacy.Tx, err error) {
  30         amount += consensus.BlockSubsidy(blockHeight)
  31
  32         var script []byte
  33         if accountManager == nil {
  34                 script, err = vmutil.DefaultCoinbaseProgram()
  35         } else {
  36                 script, err = accountManager.GetCoinbaseControlProgram()
  37         }
  38         if err != nil {
  39                 return
  40         }
  41
  42         builder := txbuilder.NewBuilder(time.Now())
  43         if err = builder.AddInput(legacy.NewCoinbaseInput([]byte(string(blockHeight))), &txbuilder.SigningInstruction{}); err != nil {
  44                 return
  45         }
  46         if err = builder.AddOutput(legacy.NewTxOutput(*consensus.BTMAssetID, amount, script)); err != nil {
  47                 return
  48         }
  49         _, txData, err := builder.Build()
  50         if err != nil {
  51                 return
  52         }
  53
  54         tx = &legacy.Tx{
  55                 TxData: *txData,
  56                 Tx:     legacy.MapTx(txData),
  57         }
  58         return
  59 }
  60
  61 // NewBlockTemplate returns a new block template that is ready to be solved
  62 func NewBlockTemplate(c *protocol.Chain, txPool *protocol.TxPool, accountManager *account.Manager) (b *legacy.Block, err error) {
  63         view := state.NewUtxoViewpoint()
  64         txStatus := bc.NewTransactionStatus()
  65         txEntries := []*bc.Tx{nil}
  66         gasUsed := uint64(0)
  67         txFee := uint64(0)
  68
  69         // get preblock info for generate next block
  70         preBlock := c.BestBlock()
  71         preBcBlock := legacy.MapBlock(preBlock)
  72         nextBlockHeight := preBlock.BlockHeader.Height + 1
  73
  74         var compareDiffBH *legacy.BlockHeader
  75         if compareDiffBlock, err := c.GetBlockByHeight(nextBlockHeight - consensus.BlocksPerRetarget); err == nil {
  76                 compareDiffBH = &compareDiffBlock.BlockHeader
  77         }
  78
  79         b = &legacy.Block{
  80                 BlockHeader: legacy.BlockHeader{
  81                         Version:           1,
  82                         Height:            nextBlockHeight,
  83                         PreviousBlockHash: preBlock.Hash(),
  84                         Timestamp:         uint64(time.Now().Unix()),
  85                         BlockCommitment:   legacy.BlockCommitment{},
  86                         Bits:              difficulty.CalcNextRequiredDifficulty(&preBlock.BlockHeader, compareDiffBH),
  87                 },
  88                 Transactions: []*legacy.Tx{nil},
  89         }
  90         bcBlock := &bc.Block{BlockHeader: &bc.BlockHeader{Height: nextBlockHeight}}
  91
  92         txs := txPool.GetTransactions()
  93         sort.Sort(ByTime(txs))
  94         for _, txDesc := range txs {
  95                 tx := txDesc.Tx.Tx
  96                 gasOnlyTx := false
  97
  98                 if err := c.GetTransactionsUtxo(view, []*bc.Tx{tx}); err != nil {
  99                         log.WithField("error", err).Error("mining block generate skip tx due to")
 100                         txPool.RemoveTransaction(&tx.ID)
 101                         continue
 102                 }
 103
 104                 gasStatus, err := validation.ValidateTx(tx, preBcBlock)
 105                 if err != nil {
 106                         if !gasStatus.GasVaild {
 107                                 log.WithField("error", err).Error("mining block generate skip tx due to")
 108                                 txPool.RemoveTransaction(&tx.ID)
 109                                 continue
 110                         }
 111                         gasOnlyTx = true
 112                 }
 113
 114                 if gasUsed+uint64(gasStatus.GasUsed) > consensus.MaxBlockGas {
 115                         break
 116                 }
 117
 118                 if err := view.ApplyTransaction(bcBlock, tx, gasOnlyTx); err != nil {
 119                         log.WithField("error", err).Error("mining block generate skip tx due to")
 120                         txPool.RemoveTransaction(&tx.ID)
 121                         continue
 122                 }
 123
 124                 txStatus.SetStatus(len(b.Transactions), gasOnlyTx)
 125                 b.Transactions = append(b.Transactions, txDesc.Tx)
 126                 txEntries = append(txEntries, tx)
 127                 gasUsed += uint64(gasStatus.GasUsed)
 128                 txFee += txDesc.Fee
 129
 130                 if gasUsed == consensus.MaxBlockGas {
 131                         break
 132                 }
 133         }
 134
 135         // creater coinbase transaction
 136         b.Transactions[0], err = createCoinbaseTx(accountManager, txFee, nextBlockHeight)
 137         if err != nil {
 138                 return nil, errors.Wrap(err, "fail on createCoinbaseTx")
 139         }
 140         txEntries[0] = b.Transactions[0].Tx
 141
 142         b.BlockHeader.BlockCommitment.TransactionsMerkleRoot, err = bc.MerkleRoot(txEntries)
 143         b.BlockHeader.BlockCommitment.TransactionStatusHash = bc.EntryID(txStatus)
 144         return b, err
 145 }