github.com/bloxroute-labs/bor@v0.1.4/consensus/ethash/consensus.go (about)

     1  // Copyright 2017 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package ethash
    18  
    19  import (
    20  	"bytes"
    21  	"errors"
    22  	"fmt"
    23  	"math/big"
    24  	"runtime"
    25  	"time"
    26  
    27  	mapset "github.com/deckarep/golang-set"
    28  	"github.com/maticnetwork/bor/common"
    29  	"github.com/maticnetwork/bor/common/math"
    30  	"github.com/maticnetwork/bor/consensus"
    31  	"github.com/maticnetwork/bor/consensus/misc"
    32  	"github.com/maticnetwork/bor/core/state"
    33  	"github.com/maticnetwork/bor/core/types"
    34  	"github.com/maticnetwork/bor/params"
    35  	"github.com/maticnetwork/bor/rlp"
    36  	"golang.org/x/crypto/sha3"
    37  )
    38  
    39  // Ethash proof-of-work protocol constants.
    40  var (
    41  	FrontierBlockReward       = big.NewInt(5e+18) // Block reward in wei for successfully mining a block
    42  	ByzantiumBlockReward      = big.NewInt(3e+18) // Block reward in wei for successfully mining a block upward from Byzantium
    43  	ConstantinopleBlockReward = big.NewInt(2e+18) // Block reward in wei for successfully mining a block upward from Constantinople
    44  	maxUncles                 = 2                 // Maximum number of uncles allowed in a single block
    45  	allowedFutureBlockTime    = 15 * time.Second  // Max time from current time allowed for blocks, before they're considered future blocks
    46  
    47  	// calcDifficultyConstantinople is the difficulty adjustment algorithm for Constantinople.
    48  	// It returns the difficulty that a new block should have when created at time given the
    49  	// parent block's time and difficulty. The calculation uses the Byzantium rules, but with
    50  	// bomb offset 5M.
    51  	// Specification EIP-1234: https://eips.ethereum.org/EIPS/eip-1234
    52  	calcDifficultyConstantinople = makeDifficultyCalculator(big.NewInt(5000000))
    53  
    54  	// calcDifficultyByzantium is the difficulty adjustment algorithm. It returns
    55  	// the difficulty that a new block should have when created at time given the
    56  	// parent block's time and difficulty. The calculation uses the Byzantium rules.
    57  	// Specification EIP-649: https://eips.ethereum.org/EIPS/eip-649
    58  	calcDifficultyByzantium = makeDifficultyCalculator(big.NewInt(3000000))
    59  )
    60  
    61  // Various error messages to mark blocks invalid. These should be private to
    62  // prevent engine specific errors from being referenced in the remainder of the
    63  // codebase, inherently breaking if the engine is swapped out. Please put common
    64  // error types into the consensus package.
    65  var (
    66  	errZeroBlockTime     = errors.New("timestamp equals parent's")
    67  	errTooManyUncles     = errors.New("too many uncles")
    68  	errDuplicateUncle    = errors.New("duplicate uncle")
    69  	errUncleIsAncestor   = errors.New("uncle is ancestor")
    70  	errDanglingUncle     = errors.New("uncle's parent is not ancestor")
    71  	errInvalidDifficulty = errors.New("non-positive difficulty")
    72  	errInvalidMixDigest  = errors.New("invalid mix digest")
    73  	errInvalidPoW        = errors.New("invalid proof-of-work")
    74  )
    75  
    76  // Author implements consensus.Engine, returning the header's coinbase as the
    77  // proof-of-work verified author of the block.
    78  func (ethash *Ethash) Author(header *types.Header) (common.Address, error) {
    79  	return header.Coinbase, nil
    80  }
    81  
    82  // VerifyHeader checks whether a header conforms to the consensus rules of the
    83  // stock Ethereum ethash engine.
    84  func (ethash *Ethash) VerifyHeader(chain consensus.ChainReader, header *types.Header, seal bool) error {
    85  	// If we're running a full engine faking, accept any input as valid
    86  	if ethash.config.PowMode == ModeFullFake {
    87  		return nil
    88  	}
    89  	// Short circuit if the header is known, or it's parent not
    90  	number := header.Number.Uint64()
    91  	if chain.GetHeader(header.Hash(), number) != nil {
    92  		return nil
    93  	}
    94  	parent := chain.GetHeader(header.ParentHash, number-1)
    95  	if parent == nil {
    96  		return consensus.ErrUnknownAncestor
    97  	}
    98  	// Sanity checks passed, do a proper verification
    99  	return ethash.verifyHeader(chain, header, parent, false, seal)
   100  }
   101  
   102  // VerifyHeaders is similar to VerifyHeader, but verifies a batch of headers
   103  // concurrently. The method returns a quit channel to abort the operations and
   104  // a results channel to retrieve the async verifications.
   105  func (ethash *Ethash) VerifyHeaders(chain consensus.ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error) {
   106  	// If we're running a full engine faking, accept any input as valid
   107  	if ethash.config.PowMode == ModeFullFake || len(headers) == 0 {
   108  		abort, results := make(chan struct{}), make(chan error, len(headers))
   109  		for i := 0; i < len(headers); i++ {
   110  			results <- nil
   111  		}
   112  		return abort, results
   113  	}
   114  
   115  	// Spawn as many workers as allowed threads
   116  	workers := runtime.GOMAXPROCS(0)
   117  	if len(headers) < workers {
   118  		workers = len(headers)
   119  	}
   120  
   121  	// Create a task channel and spawn the verifiers
   122  	var (
   123  		inputs = make(chan int)
   124  		done   = make(chan int, workers)
   125  		errors = make([]error, len(headers))
   126  		abort  = make(chan struct{})
   127  	)
   128  	for i := 0; i < workers; i++ {
   129  		go func() {
   130  			for index := range inputs {
   131  				errors[index] = ethash.verifyHeaderWorker(chain, headers, seals, index)
   132  				done <- index
   133  			}
   134  		}()
   135  	}
   136  
   137  	errorsOut := make(chan error, len(headers))
   138  	go func() {
   139  		defer close(inputs)
   140  		var (
   141  			in, out = 0, 0
   142  			checked = make([]bool, len(headers))
   143  			inputs  = inputs
   144  		)
   145  		for {
   146  			select {
   147  			case inputs <- in:
   148  				if in++; in == len(headers) {
   149  					// Reached end of headers. Stop sending to workers.
   150  					inputs = nil
   151  				}
   152  			case index := <-done:
   153  				for checked[index] = true; checked[out]; out++ {
   154  					errorsOut <- errors[out]
   155  					if out == len(headers)-1 {
   156  						return
   157  					}
   158  				}
   159  			case <-abort:
   160  				return
   161  			}
   162  		}
   163  	}()
   164  	return abort, errorsOut
   165  }
   166  
   167  func (ethash *Ethash) verifyHeaderWorker(chain consensus.ChainReader, headers []*types.Header, seals []bool, index int) error {
   168  	var parent *types.Header
   169  	if index == 0 {
   170  		parent = chain.GetHeader(headers[0].ParentHash, headers[0].Number.Uint64()-1)
   171  	} else if headers[index-1].Hash() == headers[index].ParentHash {
   172  		parent = headers[index-1]
   173  	}
   174  	if parent == nil {
   175  		return consensus.ErrUnknownAncestor
   176  	}
   177  	if chain.GetHeader(headers[index].Hash(), headers[index].Number.Uint64()) != nil {
   178  		return nil // known block
   179  	}
   180  	return ethash.verifyHeader(chain, headers[index], parent, false, seals[index])
   181  }
   182  
   183  // VerifyUncles verifies that the given block's uncles conform to the consensus
   184  // rules of the stock Ethereum ethash engine.
   185  func (ethash *Ethash) VerifyUncles(chain consensus.ChainReader, block *types.Block) error {
   186  	// If we're running a full engine faking, accept any input as valid
   187  	if ethash.config.PowMode == ModeFullFake {
   188  		return nil
   189  	}
   190  	// Verify that there are at most 2 uncles included in this block
   191  	if len(block.Uncles()) > maxUncles {
   192  		return errTooManyUncles
   193  	}
   194  	if len(block.Uncles()) == 0 {
   195  		return nil
   196  	}
   197  	// Gather the set of past uncles and ancestors
   198  	uncles, ancestors := mapset.NewSet(), make(map[common.Hash]*types.Header)
   199  
   200  	number, parent := block.NumberU64()-1, block.ParentHash()
   201  	for i := 0; i < 7; i++ {
   202  		ancestor := chain.GetBlock(parent, number)
   203  		if ancestor == nil {
   204  			break
   205  		}
   206  		ancestors[ancestor.Hash()] = ancestor.Header()
   207  		for _, uncle := range ancestor.Uncles() {
   208  			uncles.Add(uncle.Hash())
   209  		}
   210  		parent, number = ancestor.ParentHash(), number-1
   211  	}
   212  	ancestors[block.Hash()] = block.Header()
   213  	uncles.Add(block.Hash())
   214  
   215  	// Verify each of the uncles that it's recent, but not an ancestor
   216  	for _, uncle := range block.Uncles() {
   217  		// Make sure every uncle is rewarded only once
   218  		hash := uncle.Hash()
   219  		if uncles.Contains(hash) {
   220  			return errDuplicateUncle
   221  		}
   222  		uncles.Add(hash)
   223  
   224  		// Make sure the uncle has a valid ancestry
   225  		if ancestors[hash] != nil {
   226  			return errUncleIsAncestor
   227  		}
   228  		if ancestors[uncle.ParentHash] == nil || uncle.ParentHash == block.ParentHash() {
   229  			return errDanglingUncle
   230  		}
   231  		if err := ethash.verifyHeader(chain, uncle, ancestors[uncle.ParentHash], true, true); err != nil {
   232  			return err
   233  		}
   234  	}
   235  	return nil
   236  }
   237  
   238  // verifyHeader checks whether a header conforms to the consensus rules of the
   239  // stock Ethereum ethash engine.
   240  // See YP section 4.3.4. "Block Header Validity"
   241  func (ethash *Ethash) verifyHeader(chain consensus.ChainReader, header, parent *types.Header, uncle bool, seal bool) error {
   242  	// Ensure that the header's extra-data section is of a reasonable size
   243  	if uint64(len(header.Extra)) > params.MaximumExtraDataSize {
   244  		return fmt.Errorf("extra-data too long: %d > %d", len(header.Extra), params.MaximumExtraDataSize)
   245  	}
   246  	// Verify the header's timestamp
   247  	if !uncle {
   248  		if header.Time > uint64(time.Now().Add(allowedFutureBlockTime).Unix()) {
   249  			return consensus.ErrFutureBlock
   250  		}
   251  	}
   252  	if header.Time <= parent.Time {
   253  		return errZeroBlockTime
   254  	}
   255  	// Verify the block's difficulty based in it's timestamp and parent's difficulty
   256  	expected := ethash.CalcDifficulty(chain, header.Time, parent)
   257  
   258  	if expected.Cmp(header.Difficulty) != 0 {
   259  		return fmt.Errorf("invalid difficulty: have %v, want %v", header.Difficulty, expected)
   260  	}
   261  	// Verify that the gas limit is <= 2^63-1
   262  	cap := uint64(0x7fffffffffffffff)
   263  	if header.GasLimit > cap {
   264  		return fmt.Errorf("invalid gasLimit: have %v, max %v", header.GasLimit, cap)
   265  	}
   266  	// Verify that the gasUsed is <= gasLimit
   267  	if header.GasUsed > header.GasLimit {
   268  		return fmt.Errorf("invalid gasUsed: have %d, gasLimit %d", header.GasUsed, header.GasLimit)
   269  	}
   270  
   271  	// Verify that the gas limit remains within allowed bounds
   272  	diff := int64(parent.GasLimit) - int64(header.GasLimit)
   273  	if diff < 0 {
   274  		diff *= -1
   275  	}
   276  	limit := parent.GasLimit / params.GasLimitBoundDivisor
   277  
   278  	if uint64(diff) >= limit || header.GasLimit < params.MinGasLimit {
   279  		return fmt.Errorf("invalid gas limit: have %d, want %d += %d", header.GasLimit, parent.GasLimit, limit)
   280  	}
   281  	// Verify that the block number is parent's +1
   282  	if diff := new(big.Int).Sub(header.Number, parent.Number); diff.Cmp(big.NewInt(1)) != 0 {
   283  		return consensus.ErrInvalidNumber
   284  	}
   285  	// Verify the engine specific seal securing the block
   286  	if seal {
   287  		if err := ethash.VerifySeal(chain, header); err != nil {
   288  			return err
   289  		}
   290  	}
   291  	// If all checks passed, validate any special fields for hard forks
   292  	if err := misc.VerifyDAOHeaderExtraData(chain.Config(), header); err != nil {
   293  		return err
   294  	}
   295  	if err := misc.VerifyForkHashes(chain.Config(), header, uncle); err != nil {
   296  		return err
   297  	}
   298  	return nil
   299  }
   300  
   301  // CalcDifficulty is the difficulty adjustment algorithm. It returns
   302  // the difficulty that a new block should have when created at time
   303  // given the parent block's time and difficulty.
   304  func (ethash *Ethash) CalcDifficulty(chain consensus.ChainReader, time uint64, parent *types.Header) *big.Int {
   305  	return CalcDifficulty(chain.Config(), time, parent)
   306  }
   307  
   308  // CalcDifficulty is the difficulty adjustment algorithm. It returns
   309  // the difficulty that a new block should have when created at time
   310  // given the parent block's time and difficulty.
   311  func CalcDifficulty(config *params.ChainConfig, time uint64, parent *types.Header) *big.Int {
   312  	next := new(big.Int).Add(parent.Number, big1)
   313  	switch {
   314  	case config.IsConstantinople(next):
   315  		return calcDifficultyConstantinople(time, parent)
   316  	case config.IsByzantium(next):
   317  		return calcDifficultyByzantium(time, parent)
   318  	case config.IsHomestead(next):
   319  		return calcDifficultyHomestead(time, parent)
   320  	default:
   321  		return calcDifficultyFrontier(time, parent)
   322  	}
   323  }
   324  
   325  // Some weird constants to avoid constant memory allocs for them.
   326  var (
   327  	expDiffPeriod = big.NewInt(100000)
   328  	big1          = big.NewInt(1)
   329  	big2          = big.NewInt(2)
   330  	big9          = big.NewInt(9)
   331  	big10         = big.NewInt(10)
   332  	bigMinus99    = big.NewInt(-99)
   333  )
   334  
   335  // makeDifficultyCalculator creates a difficultyCalculator with the given bomb-delay.
   336  // the difficulty is calculated with Byzantium rules, which differs from Homestead in
   337  // how uncles affect the calculation
   338  func makeDifficultyCalculator(bombDelay *big.Int) func(time uint64, parent *types.Header) *big.Int {
   339  	// Note, the calculations below looks at the parent number, which is 1 below
   340  	// the block number. Thus we remove one from the delay given
   341  	bombDelayFromParent := new(big.Int).Sub(bombDelay, big1)
   342  	return func(time uint64, parent *types.Header) *big.Int {
   343  		// https://github.com/ethereum/EIPs/issues/100.
   344  		// algorithm:
   345  		// diff = (parent_diff +
   346  		//         (parent_diff / 2048 * max((2 if len(parent.uncles) else 1) - ((timestamp - parent.timestamp) // 9), -99))
   347  		//        ) + 2^(periodCount - 2)
   348  
   349  		bigTime := new(big.Int).SetUint64(time)
   350  		bigParentTime := new(big.Int).SetUint64(parent.Time)
   351  
   352  		// holds intermediate values to make the algo easier to read & audit
   353  		x := new(big.Int)
   354  		y := new(big.Int)
   355  
   356  		// (2 if len(parent_uncles) else 1) - (block_timestamp - parent_timestamp) // 9
   357  		x.Sub(bigTime, bigParentTime)
   358  		x.Div(x, big9)
   359  		if parent.UncleHash == types.EmptyUncleHash {
   360  			x.Sub(big1, x)
   361  		} else {
   362  			x.Sub(big2, x)
   363  		}
   364  		// max((2 if len(parent_uncles) else 1) - (block_timestamp - parent_timestamp) // 9, -99)
   365  		if x.Cmp(bigMinus99) < 0 {
   366  			x.Set(bigMinus99)
   367  		}
   368  		// parent_diff + (parent_diff / 2048 * max((2 if len(parent.uncles) else 1) - ((timestamp - parent.timestamp) // 9), -99))
   369  		y.Div(parent.Difficulty, params.DifficultyBoundDivisor)
   370  		x.Mul(y, x)
   371  		x.Add(parent.Difficulty, x)
   372  
   373  		// minimum difficulty can ever be (before exponential factor)
   374  		if x.Cmp(params.MinimumDifficulty) < 0 {
   375  			x.Set(params.MinimumDifficulty)
   376  		}
   377  		// calculate a fake block number for the ice-age delay
   378  		// Specification: https://eips.ethereum.org/EIPS/eip-1234
   379  		fakeBlockNumber := new(big.Int)
   380  		if parent.Number.Cmp(bombDelayFromParent) >= 0 {
   381  			fakeBlockNumber = fakeBlockNumber.Sub(parent.Number, bombDelayFromParent)
   382  		}
   383  		// for the exponential factor
   384  		periodCount := fakeBlockNumber
   385  		periodCount.Div(periodCount, expDiffPeriod)
   386  
   387  		// the exponential factor, commonly referred to as "the bomb"
   388  		// diff = diff + 2^(periodCount - 2)
   389  		if periodCount.Cmp(big1) > 0 {
   390  			y.Sub(periodCount, big2)
   391  			y.Exp(big2, y, nil)
   392  			x.Add(x, y)
   393  		}
   394  		return x
   395  	}
   396  }
   397  
   398  // calcDifficultyHomestead is the difficulty adjustment algorithm. It returns
   399  // the difficulty that a new block should have when created at time given the
   400  // parent block's time and difficulty. The calculation uses the Homestead rules.
   401  func calcDifficultyHomestead(time uint64, parent *types.Header) *big.Int {
   402  	// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2.md
   403  	// algorithm:
   404  	// diff = (parent_diff +
   405  	//         (parent_diff / 2048 * max(1 - (block_timestamp - parent_timestamp) // 10, -99))
   406  	//        ) + 2^(periodCount - 2)
   407  
   408  	bigTime := new(big.Int).SetUint64(time)
   409  	bigParentTime := new(big.Int).SetUint64(parent.Time)
   410  
   411  	// holds intermediate values to make the algo easier to read & audit
   412  	x := new(big.Int)
   413  	y := new(big.Int)
   414  
   415  	// 1 - (block_timestamp - parent_timestamp) // 10
   416  	x.Sub(bigTime, bigParentTime)
   417  	x.Div(x, big10)
   418  	x.Sub(big1, x)
   419  
   420  	// max(1 - (block_timestamp - parent_timestamp) // 10, -99)
   421  	if x.Cmp(bigMinus99) < 0 {
   422  		x.Set(bigMinus99)
   423  	}
   424  	// (parent_diff + parent_diff // 2048 * max(1 - (block_timestamp - parent_timestamp) // 10, -99))
   425  	y.Div(parent.Difficulty, params.DifficultyBoundDivisor)
   426  	x.Mul(y, x)
   427  	x.Add(parent.Difficulty, x)
   428  
   429  	// minimum difficulty can ever be (before exponential factor)
   430  	if x.Cmp(params.MinimumDifficulty) < 0 {
   431  		x.Set(params.MinimumDifficulty)
   432  	}
   433  	// for the exponential factor
   434  	periodCount := new(big.Int).Add(parent.Number, big1)
   435  	periodCount.Div(periodCount, expDiffPeriod)
   436  
   437  	// the exponential factor, commonly referred to as "the bomb"
   438  	// diff = diff + 2^(periodCount - 2)
   439  	if periodCount.Cmp(big1) > 0 {
   440  		y.Sub(periodCount, big2)
   441  		y.Exp(big2, y, nil)
   442  		x.Add(x, y)
   443  	}
   444  	return x
   445  }
   446  
   447  // calcDifficultyFrontier is the difficulty adjustment algorithm. It returns the
   448  // difficulty that a new block should have when created at time given the parent
   449  // block's time and difficulty. The calculation uses the Frontier rules.
   450  func calcDifficultyFrontier(time uint64, parent *types.Header) *big.Int {
   451  	diff := new(big.Int)
   452  	adjust := new(big.Int).Div(parent.Difficulty, params.DifficultyBoundDivisor)
   453  	bigTime := new(big.Int)
   454  	bigParentTime := new(big.Int)
   455  
   456  	bigTime.SetUint64(time)
   457  	bigParentTime.SetUint64(parent.Time)
   458  
   459  	if bigTime.Sub(bigTime, bigParentTime).Cmp(params.DurationLimit) < 0 {
   460  		diff.Add(parent.Difficulty, adjust)
   461  	} else {
   462  		diff.Sub(parent.Difficulty, adjust)
   463  	}
   464  	if diff.Cmp(params.MinimumDifficulty) < 0 {
   465  		diff.Set(params.MinimumDifficulty)
   466  	}
   467  
   468  	periodCount := new(big.Int).Add(parent.Number, big1)
   469  	periodCount.Div(periodCount, expDiffPeriod)
   470  	if periodCount.Cmp(big1) > 0 {
   471  		// diff = diff + 2^(periodCount - 2)
   472  		expDiff := periodCount.Sub(periodCount, big2)
   473  		expDiff.Exp(big2, expDiff, nil)
   474  		diff.Add(diff, expDiff)
   475  		diff = math.BigMax(diff, params.MinimumDifficulty)
   476  	}
   477  	return diff
   478  }
   479  
   480  // VerifySeal implements consensus.Engine, checking whether the given block satisfies
   481  // the PoW difficulty requirements.
   482  func (ethash *Ethash) VerifySeal(chain consensus.ChainReader, header *types.Header) error {
   483  	return ethash.verifySeal(chain, header, false)
   484  }
   485  
   486  // verifySeal checks whether a block satisfies the PoW difficulty requirements,
   487  // either using the usual ethash cache for it, or alternatively using a full DAG
   488  // to make remote mining fast.
   489  func (ethash *Ethash) verifySeal(chain consensus.ChainReader, header *types.Header, fulldag bool) error {
   490  	// If we're running a fake PoW, accept any seal as valid
   491  	if ethash.config.PowMode == ModeFake || ethash.config.PowMode == ModeFullFake {
   492  		time.Sleep(ethash.fakeDelay)
   493  		if ethash.fakeFail == header.Number.Uint64() {
   494  			return errInvalidPoW
   495  		}
   496  		return nil
   497  	}
   498  	// If we're running a shared PoW, delegate verification to it
   499  	if ethash.shared != nil {
   500  		return ethash.shared.verifySeal(chain, header, fulldag)
   501  	}
   502  	// Ensure that we have a valid difficulty for the block
   503  	if header.Difficulty.Sign() <= 0 {
   504  		return errInvalidDifficulty
   505  	}
   506  	// Recompute the digest and PoW values
   507  	number := header.Number.Uint64()
   508  
   509  	var (
   510  		digest []byte
   511  		result []byte
   512  	)
   513  	// If fast-but-heavy PoW verification was requested, use an ethash dataset
   514  	if fulldag {
   515  		dataset := ethash.dataset(number, true)
   516  		if dataset.generated() {
   517  			digest, result = hashimotoFull(dataset.dataset, ethash.SealHash(header).Bytes(), header.Nonce.Uint64())
   518  
   519  			// Datasets are unmapped in a finalizer. Ensure that the dataset stays alive
   520  			// until after the call to hashimotoFull so it's not unmapped while being used.
   521  			runtime.KeepAlive(dataset)
   522  		} else {
   523  			// Dataset not yet generated, don't hang, use a cache instead
   524  			fulldag = false
   525  		}
   526  	}
   527  	// If slow-but-light PoW verification was requested (or DAG not yet ready), use an ethash cache
   528  	if !fulldag {
   529  		cache := ethash.cache(number)
   530  
   531  		size := datasetSize(number)
   532  		if ethash.config.PowMode == ModeTest {
   533  			size = 32 * 1024
   534  		}
   535  		digest, result = hashimotoLight(size, cache.cache, ethash.SealHash(header).Bytes(), header.Nonce.Uint64())
   536  
   537  		// Caches are unmapped in a finalizer. Ensure that the cache stays alive
   538  		// until after the call to hashimotoLight so it's not unmapped while being used.
   539  		runtime.KeepAlive(cache)
   540  	}
   541  	// Verify the calculated values against the ones provided in the header
   542  	if !bytes.Equal(header.MixDigest[:], digest) {
   543  		return errInvalidMixDigest
   544  	}
   545  	target := new(big.Int).Div(two256, header.Difficulty)
   546  	if new(big.Int).SetBytes(result).Cmp(target) > 0 {
   547  		return errInvalidPoW
   548  	}
   549  	return nil
   550  }
   551  
   552  // Prepare implements consensus.Engine, initializing the difficulty field of a
   553  // header to conform to the ethash protocol. The changes are done inline.
   554  func (ethash *Ethash) Prepare(chain consensus.ChainReader, header *types.Header) error {
   555  	parent := chain.GetHeader(header.ParentHash, header.Number.Uint64()-1)
   556  	if parent == nil {
   557  		return consensus.ErrUnknownAncestor
   558  	}
   559  	header.Difficulty = ethash.CalcDifficulty(chain, header.Time, parent)
   560  	return nil
   561  }
   562  
   563  // Finalize implements consensus.Engine, accumulating the block and uncle rewards,
   564  // setting the final state on the header
   565  func (ethash *Ethash) Finalize(chain consensus.ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header) {
   566  	// Accumulate any block and uncle rewards and commit the final state root
   567  	accumulateRewards(chain.Config(), state, header, uncles)
   568  	header.Root = state.IntermediateRoot(chain.Config().IsEIP158(header.Number))
   569  }
   570  
   571  // FinalizeAndAssemble implements consensus.Engine, accumulating the block and
   572  // uncle rewards, setting the final state and assembling the block.
   573  func (ethash *Ethash) FinalizeAndAssemble(chain consensus.ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error) {
   574  	// Accumulate any block and uncle rewards and commit the final state root
   575  	accumulateRewards(chain.Config(), state, header, uncles)
   576  	header.Root = state.IntermediateRoot(chain.Config().IsEIP158(header.Number))
   577  
   578  	// Header seems complete, assemble into a block and return
   579  	return types.NewBlock(header, txs, uncles, receipts), nil
   580  }
   581  
   582  // SealHash returns the hash of a block prior to it being sealed.
   583  func (ethash *Ethash) SealHash(header *types.Header) (hash common.Hash) {
   584  	hasher := sha3.NewLegacyKeccak256()
   585  
   586  	rlp.Encode(hasher, []interface{}{
   587  		header.ParentHash,
   588  		header.UncleHash,
   589  		header.Coinbase,
   590  		header.Root,
   591  		header.TxHash,
   592  		header.ReceiptHash,
   593  		header.Bloom,
   594  		header.Difficulty,
   595  		header.Number,
   596  		header.GasLimit,
   597  		header.GasUsed,
   598  		header.Time,
   599  		header.Extra,
   600  	})
   601  	hasher.Sum(hash[:0])
   602  	return hash
   603  }
   604  
   605  // Some weird constants to avoid constant memory allocs for them.
   606  var (
   607  	big8  = big.NewInt(8)
   608  	big32 = big.NewInt(32)
   609  )
   610  
   611  // AccumulateRewards credits the coinbase of the given block with the mining
   612  // reward. The total reward consists of the static block reward and rewards for
   613  // included uncles. The coinbase of each uncle block is also rewarded.
   614  func accumulateRewards(config *params.ChainConfig, state *state.StateDB, header *types.Header, uncles []*types.Header) {
   615  	// Select the correct block reward based on chain progression
   616  	blockReward := FrontierBlockReward
   617  	if config.IsByzantium(header.Number) {
   618  		blockReward = ByzantiumBlockReward
   619  	}
   620  	if config.IsConstantinople(header.Number) {
   621  		blockReward = ConstantinopleBlockReward
   622  	}
   623  	// Accumulate the rewards for the miner and any included uncles
   624  	reward := new(big.Int).Set(blockReward)
   625  	r := new(big.Int)
   626  	for _, uncle := range uncles {
   627  		r.Add(uncle.Number, big8)
   628  		r.Sub(r, header.Number)
   629  		r.Mul(r, blockReward)
   630  		r.Div(r, big8)
   631  		state.AddBalance(uncle.Coinbase, r)
   632  
   633  		r.Div(blockReward, big32)
   634  		reward.Add(reward, r)
   635  	}
   636  	state.AddBalance(header.Coinbase, reward)
   637  }