8 log "github.com/sirupsen/logrus"
10 "github.com/bytom/vapor/account"
11 "github.com/bytom/vapor/blockchain/txbuilder"
12 "github.com/bytom/vapor/consensus"
13 "github.com/bytom/vapor/errors"
14 "github.com/bytom/vapor/protocol"
15 "github.com/bytom/vapor/protocol/bc"
16 "github.com/bytom/vapor/protocol/bc/types"
17 "github.com/bytom/vapor/protocol/state"
18 "github.com/bytom/vapor/protocol/validation"
19 "github.com/bytom/vapor/protocol/vm/vmutil"
31 // NewBlockTemplate returns a new block template that is ready to be solved
32 func NewBlockTemplate(chain *protocol.Chain, accountManager *account.Manager, timestamp uint64, warnDuration, criticalDuration time.Duration) (*types.Block, error) {
33 builder := newBlockBuilder(chain, accountManager, timestamp, warnDuration, criticalDuration)
34 return builder.build()
37 type blockBuilder struct {
39 accountManager *account.Manager
42 txStatus *bc.TransactionStatus
43 utxoView *state.UtxoViewpoint
45 warnTimeoutCh <-chan time.Time
46 criticalTimeoutCh <-chan time.Time
51 func newBlockBuilder(chain *protocol.Chain, accountManager *account.Manager, timestamp uint64, warnDuration, criticalDuration time.Duration) *blockBuilder {
52 preBlockHeader := chain.BestBlockHeader()
53 block := &types.Block{
54 BlockHeader: types.BlockHeader{
56 Height: preBlockHeader.Height + 1,
57 PreviousBlockHash: preBlockHeader.Hash(),
59 BlockCommitment: types.BlockCommitment{},
60 BlockWitness: types.BlockWitness{Witness: make([][]byte, consensus.ActiveNetParams.NumOfConsensusNode)},
64 builder := &blockBuilder{
66 accountManager: accountManager,
68 txStatus: bc.NewTransactionStatus(),
69 utxoView: state.NewUtxoViewpoint(),
70 warnTimeoutCh: time.After(warnDuration),
71 criticalTimeoutCh: time.After(criticalDuration),
72 gasLeft: int64(consensus.ActiveNetParams.MaxBlockGas),
73 timeoutStatus: timeoutOk,
78 func (b *blockBuilder) applyCoinbaseTransaction() error {
79 coinbaseTx, err := b.createCoinbaseTx()
81 return errors.Wrap(err, "fail on create coinbase tx")
84 gasState, err := validation.ValidateTx(coinbaseTx.Tx, &bc.Block{BlockHeader: &bc.BlockHeader{Height: b.block.Height}, Transactions: []*bc.Tx{coinbaseTx.Tx}})
89 b.block.Transactions = append(b.block.Transactions, coinbaseTx)
90 if err := b.txStatus.SetStatus(0, false); err != nil {
94 b.gasLeft -= gasState.GasUsed
98 func (b *blockBuilder) applyTransactions(txs []*types.Tx, timeoutStatus uint8) error {
99 tempTxs := []*types.Tx{}
100 for i := 0; i < len(txs); i++ {
101 if tempTxs = append(tempTxs, txs[i]); len(tempTxs) < batchApplyNum && i != len(txs)-1 {
105 results, gasLeft := b.preValidateTxs(tempTxs, b.chain, b.utxoView, b.gasLeft)
106 for _, result := range results {
107 if result.err != nil && !result.gasOnly {
108 log.WithFields(log.Fields{"module": logModule, "error": result.err}).Error("mining block generation: skip tx due to")
109 b.chain.GetTxPool().RemoveTransaction(&result.tx.ID)
113 if err := b.txStatus.SetStatus(len(b.block.Transactions), result.gasOnly); err != nil {
117 b.block.Transactions = append(b.block.Transactions, result.tx)
121 tempTxs = []*types.Tx{}
122 if b.getTimeoutStatus() >= timeoutStatus {
129 func (b *blockBuilder) applyTransactionFromPool() error {
130 txDescList := b.chain.GetTxPool().GetTransactions()
131 sort.Sort(byTime(txDescList))
133 poolTxs := make([]*types.Tx, len(txDescList))
134 for i, txDesc := range txDescList {
135 poolTxs[i] = txDesc.Tx
138 return b.applyTransactions(poolTxs, timeoutWarn)
141 func (b *blockBuilder) applyTransactionFromSubProtocol() error {
142 isTimeout := func() bool {
143 return b.getTimeoutStatus() > timeoutOk
146 for i, p := range b.chain.SubProtocols() {
147 if b.gasLeft <= 0 || isTimeout() {
151 subTxs, err := p.BeforeProposalBlock(b.block, b.gasLeft, isTimeout)
153 log.WithFields(log.Fields{"module": logModule, "index": i, "error": err}).Error("failed on sub protocol txs package")
157 if err := b.applyTransactions(subTxs, timeoutCritical); err != nil {
164 func (b *blockBuilder) build() (*types.Block, error) {
165 if err := b.applyCoinbaseTransaction(); err != nil {
169 if err := b.applyTransactionFromPool(); err != nil {
173 if err := b.applyTransactionFromSubProtocol(); err != nil {
177 if err := b.calcBlockCommitment(); err != nil {
181 if err := b.chain.SignBlockHeader(&b.block.BlockHeader); err != nil {
188 func (b *blockBuilder) calcBlockCommitment() (err error) {
189 var txEntries []*bc.Tx
190 for _, tx := range b.block.Transactions {
191 txEntries = append(txEntries, tx.Tx)
194 b.block.BlockHeader.BlockCommitment.TransactionsMerkleRoot, err = types.TxMerkleRoot(txEntries)
199 b.block.BlockHeader.BlockCommitment.TransactionStatusHash, err = types.TxStatusMerkleRoot(b.txStatus.VerifyStatus)
203 // createCoinbaseTx returns a coinbase transaction paying an appropriate subsidy
204 // based on the passed block height to the provided address. When the address
205 // is nil, the coinbase transaction will instead be redeemable by anyone.
206 func (b *blockBuilder) createCoinbaseTx() (*types.Tx, error) {
207 consensusResult, err := b.chain.GetConsensusResultByHash(&b.block.PreviousBlockHash)
212 rewards, err := consensusResult.GetCoinbaseRewards(b.block.Height - 1)
217 return createCoinbaseTxByReward(b.accountManager, b.block.Height, rewards)
220 func (b *blockBuilder) getTimeoutStatus() uint8 {
221 if b.timeoutStatus == timeoutCritical {
222 return b.timeoutStatus
226 case <-b.criticalTimeoutCh:
227 b.timeoutStatus = timeoutCritical
228 case <-b.warnTimeoutCh:
229 b.timeoutStatus = timeoutWarn
233 return b.timeoutStatus
236 func createCoinbaseTxByReward(accountManager *account.Manager, blockHeight uint64, rewards []state.CoinbaseReward) (tx *types.Tx, err error) {
237 arbitrary := append([]byte{0x00}, []byte(strconv.FormatUint(blockHeight, 10))...)
239 if accountManager == nil {
240 script, err = vmutil.DefaultCoinbaseProgram()
242 script, err = accountManager.GetCoinbaseControlProgram()
243 arbitrary = append(arbitrary, accountManager.GetCoinbaseArbitrary()...)
249 if len(arbitrary) > consensus.ActiveNetParams.CoinbaseArbitrarySizeLimit {
250 return nil, validation.ErrCoinbaseArbitraryOversize
253 builder := txbuilder.NewBuilder(time.Now())
254 if err = builder.AddInput(types.NewCoinbaseInput(arbitrary), &txbuilder.SigningInstruction{}); err != nil {
258 if err = builder.AddOutput(types.NewIntraChainOutput(*consensus.BTMAssetID, 0, script)); err != nil {
262 for _, r := range rewards {
263 if err = builder.AddOutput(types.NewIntraChainOutput(*consensus.BTMAssetID, r.Amount, r.ControlProgram)); err != nil {
268 _, txData, err := builder.Build()
273 byteData, err := txData.MarshalText()
278 txData.SerializedSize = uint64(len(byteData))
281 Tx: types.MapTx(txData),
286 type validateTxResult struct {
292 func (b *blockBuilder) preValidateTxs(txs []*types.Tx, chain *protocol.Chain, view *state.UtxoViewpoint, gasLeft int64) ([]*validateTxResult, int64) {
293 var results []*validateTxResult
294 bcBlock := &bc.Block{BlockHeader: &bc.BlockHeader{Height: chain.BestBlockHeight() + 1}}
295 bcTxs := make([]*bc.Tx, len(txs))
296 for i, tx := range txs {
300 validateResults := validation.ValidateTxs(bcTxs, bcBlock)
301 for i := 0; i < len(validateResults) && gasLeft > 0; i++ {
303 gasStatus := validateResults[i].GetGasState()
304 if err := validateResults[i].GetError(); err != nil {
305 if !gasStatus.GasValid {
306 results = append(results, &validateTxResult{tx: txs[i], err: err})
312 if err := chain.GetTransactionsUtxo(view, []*bc.Tx{bcTxs[i]}); err != nil {
313 results = append(results, &validateTxResult{tx: txs[i], err: err})
317 if gasLeft-gasStatus.GasUsed < 0 {
321 if err := view.ApplyTransaction(bcBlock, bcTxs[i], gasOnlyTx); err != nil {
322 results = append(results, &validateTxResult{tx: txs[i], err: err})
326 if err := b.validateBySubProtocols(txs[i], validateResults[i].GetError() != nil, chain.SubProtocols()); err != nil {
327 results = append(results, &validateTxResult{tx: txs[i], err: err})
331 results = append(results, &validateTxResult{tx: txs[i], gasOnly: gasOnlyTx, err: validateResults[i].GetError()})
332 gasLeft -= gasStatus.GasUsed
334 return results, gasLeft
337 func (b *blockBuilder) validateBySubProtocols(tx *types.Tx, statusFail bool, subProtocols []protocol.SubProtocol) error {
338 for _, subProtocol := range subProtocols {
339 verifyResult := &bc.TxVerifyResult{StatusFail: statusFail}
340 if err := subProtocol.ValidateTx(tx, verifyResult, b.block.Height); err != nil {