all: use unified emptyRootHash and emptyCodeHash (#26718)

The EmptyRootHash and EmptyCodeHash are defined everywhere in the codebase, this PR replaces all of them with unified one defined in core/types package, and also defines constants for TxRoot, WithdrawalsRoot and UncleRoot

cmd/devp2p/internal/ethtest/snap.go

@@ -23,6 +23,7 @@ import (
  "math/rand"
 
  "github.com/ethereum/go-ethereum/common"
+ "github.com/ethereum/go-ethereum/core/types"
  "github.com/ethereum/go-ethereum/crypto"
  "github.com/ethereum/go-ethereum/eth/protocols/snap"
  "github.com/ethereum/go-ethereum/internal/utesting"
@@ -210,13 +211,6 @@ type byteCodesTest struct {
  expHashes int
 }
 
-var (
- // emptyRoot is the known root hash of an empty trie.
- emptyRoot = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
- // emptyCode is the known hash of the empty EVM bytecode.
- emptyCode = common.HexToHash("c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470")
-)
-
 // TestSnapGetByteCodes various forms of GetByteCodes requests.
 func (s *Suite) TestSnapGetByteCodes(t *utesting.T) {
  // The halfchain import should yield these bytecodes
@@ -263,15 +257,15 @@ func (s *Suite) TestSnapGetByteCodes(t *utesting.T) {
  },
  // Empties
  {
- nBytes: 10000, hashes: []common.Hash{emptyRoot},
+ nBytes: 10000, hashes: []common.Hash{types.EmptyRootHash},
  expHashes: 0,
  },
  {
- nBytes: 10000, hashes: []common.Hash{emptyCode},
+ nBytes: 10000, hashes: []common.Hash{types.EmptyCodeHash},
  expHashes: 1,
  },
  {
- nBytes: 10000, hashes: []common.Hash{emptyCode, emptyCode, emptyCode},
+ nBytes: 10000, hashes: []common.Hash{types.EmptyCodeHash, types.EmptyCodeHash, types.EmptyCodeHash},
  expHashes: 3,
  },
  // The existing bytecodes
@@ -363,7 +357,7 @@ func (s *Suite) TestSnapTrieNodes(t *utesting.T) {
  for i := 1; i <= 65; i++ {
  accPaths = append(accPaths, pathTo(i))
  }
- empty := emptyCode
+ empty := types.EmptyCodeHash
  for i, tc := range []trieNodesTest{
  {
  root: s.chain.RootAt(999),

cmd/evm/internal/t8ntool/block.go

@@ -120,8 +120,8 @@ func (i *bbInput) ToBlock() *types.Block {
  UncleHash: types.EmptyUncleHash,
  Coinbase: common.Address{},
  Root: i.Header.Root,
- TxHash: types.EmptyRootHash,
- ReceiptHash: types.EmptyRootHash,
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  Bloom: i.Header.Bloom,
  Difficulty: common.Big0,
  Number: i.Header.Number,

cmd/geth/snapshot.go

@@ -38,14 +38,6 @@ import (
  cli "github.com/urfave/cli/v2"
 )
 
-var (
- // emptyRoot is the known root hash of an empty trie.
- emptyRoot = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
-
- // emptyCode is the known hash of the empty EVM bytecode.
- emptyCode = crypto.Keccak256(nil)
-)
-
 var (
  snapshotCommand = &cli.Command{
  Name: "snapshot",
@@ -308,7 +300,7 @@ func traverseState(ctx *cli.Context) error {
  log.Error("Invalid account encountered during traversal", "err", err)
  return err
  }
- if acc.Root != emptyRoot {
+ if acc.Root != types.EmptyRootHash {
  id := trie.StorageTrieID(root, common.BytesToHash(accIter.Key), acc.Root)
  storageTrie, err := trie.NewStateTrie(id, triedb)
  if err != nil {
@@ -324,7 +316,7 @@ func traverseState(ctx *cli.Context) error {
  return storageIter.Err
  }
  }
- if !bytes.Equal(acc.CodeHash, emptyCode) {
+ if !bytes.Equal(acc.CodeHash, types.EmptyCodeHash.Bytes()) {
  if !rawdb.HasCode(chaindb, common.BytesToHash(acc.CodeHash)) {
  log.Error("Code is missing", "hash", common.BytesToHash(acc.CodeHash))
  return errors.New("missing code")
@@ -423,7 +415,7 @@ func traverseRawState(ctx *cli.Context) error {
  log.Error("Invalid account encountered during traversal", "err", err)
  return errors.New("invalid account")
  }
- if acc.Root != emptyRoot {
+ if acc.Root != types.EmptyRootHash {
  id := trie.StorageTrieID(root, common.BytesToHash(accIter.LeafKey()), acc.Root)
  storageTrie, err := trie.NewStateTrie(id, triedb)
  if err != nil {
@@ -461,7 +453,7 @@ func traverseRawState(ctx *cli.Context) error {
  return storageIter.Error()
  }
  }
- if !bytes.Equal(acc.CodeHash, emptyCode) {
+ if !bytes.Equal(acc.CodeHash, types.EmptyCodeHash.Bytes()) {
  if !rawdb.HasCode(chaindb, common.BytesToHash(acc.CodeHash)) {
  log.Error("Code is missing", "account", common.BytesToHash(accIter.LeafKey()))
  return errors.New("missing code")
@@ -536,7 +528,7 @@ func dumpState(ctx *cli.Context) error {
  CodeHash: account.CodeHash,
  SecureKey: accIt.Hash().Bytes(),
  }
- if !conf.SkipCode && !bytes.Equal(account.CodeHash, emptyCode) {
+ if !conf.SkipCode && !bytes.Equal(account.CodeHash, types.EmptyCodeHash.Bytes()) {
  da.Code = rawdb.ReadCode(db, common.BytesToHash(account.CodeHash))
  }
  if !conf.SkipStorage {

consensus/ethash/algorithm_test.go

@@ -709,11 +709,11 @@ func TestConcurrentDiskCacheGeneration(t *testing.T) {
  block := types.NewBlockWithHeader(&types.Header{
  Number: big.NewInt(3311058),
  ParentHash: common.HexToHash("0xd783efa4d392943503f28438ad5830b2d5964696ffc285f338585e9fe0a37a05"),
- UncleHash: common.HexToHash("0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"),
+ UncleHash: types.EmptyUncleHash,
  Coinbase: common.HexToAddress("0xc0ea08a2d404d3172d2add29a45be56da40e2949"),
  Root: common.HexToHash("0x77d14e10470b5850332524f8cd6f69ad21f070ce92dca33ab2858300242ef2f1"),
- TxHash: common.HexToHash("0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"),
- ReceiptHash: common.HexToHash("0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"),
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  Difficulty: big.NewInt(167925187834220),
  GasLimit: 4015682,
  GasUsed: 0,

core/bench_test.go

@@ -252,8 +252,8 @@ func makeChainForBench(db ethdb.Database, full bool, count uint64) {
  ParentHash: hash,
  Difficulty: big.NewInt(1),
  UncleHash: types.EmptyUncleHash,
- TxHash: types.EmptyRootHash,
- ReceiptHash: types.EmptyRootHash,
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  }
  hash = header.Hash()
 

core/genesis.go

@@ -467,7 +467,7 @@ func (g *Genesis) ToBlock() *types.Block {
  }
  var withdrawals []*types.Withdrawal
  if g.Config != nil && g.Config.IsShanghai(g.Timestamp) {
- head.WithdrawalsHash = &types.EmptyRootHash
+ head.WithdrawalsHash = &types.EmptyWithdrawalsHash
  withdrawals = make([]*types.Withdrawal, 0)
  }
  return types.NewBlock(head, nil, nil, nil, trie.NewStackTrie(nil)).WithWithdrawals(withdrawals)

core/rawdb/accessors_chain_test.go

@@ -113,8 +113,8 @@ func TestBlockStorage(t *testing.T) {
  block := types.NewBlockWithHeader(&types.Header{
  Extra: []byte("test block"),
  UncleHash: types.EmptyUncleHash,
- TxHash: types.EmptyRootHash,
- ReceiptHash: types.EmptyRootHash,
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  })
  if entry := ReadBlock(db, block.Hash(), block.NumberU64()); entry != nil {
  t.Fatalf("Non existent block returned: %v", entry)
@@ -161,8 +161,8 @@ func TestPartialBlockStorage(t *testing.T) {
  block := types.NewBlockWithHeader(&types.Header{
  Extra: []byte("test block"),
  UncleHash: types.EmptyUncleHash,
- TxHash: types.EmptyRootHash,
- ReceiptHash: types.EmptyRootHash,
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  })
  // Store a header and check that it's not recognized as a block
  WriteHeader(db, block.Header())
@@ -198,8 +198,8 @@ func TestBadBlockStorage(t *testing.T) {
  Number: big.NewInt(1),
  Extra: []byte("bad block"),
  UncleHash: types.EmptyUncleHash,
- TxHash: types.EmptyRootHash,
- ReceiptHash: types.EmptyRootHash,
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  })
  if entry := ReadBadBlock(db, block.Hash()); entry != nil {
  t.Fatalf("Non existent block returned: %v", entry)
@@ -216,8 +216,8 @@ func TestBadBlockStorage(t *testing.T) {
  Number: big.NewInt(2),
  Extra: []byte("bad block two"),
  UncleHash: types.EmptyUncleHash,
- TxHash: types.EmptyRootHash,
- ReceiptHash: types.EmptyRootHash,
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  })
  WriteBadBlock(db, blockTwo)
 
@@ -235,8 +235,8 @@ func TestBadBlockStorage(t *testing.T) {
  Number: big.NewInt(int64(n)),
  Extra: []byte("bad block"),
  UncleHash: types.EmptyUncleHash,
- TxHash: types.EmptyRootHash,
- ReceiptHash: types.EmptyRootHash,
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  })
  WriteBadBlock(db, block)
  }
@@ -446,8 +446,8 @@ func TestAncientStorage(t *testing.T) {
  Number: big.NewInt(0),
  Extra: []byte("test block"),
  UncleHash: types.EmptyUncleHash,
- TxHash: types.EmptyRootHash,
- ReceiptHash: types.EmptyRootHash,
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  })
  // Ensure nothing non-existent will be read
  hash, number := block.Hash(), block.NumberU64()
@@ -889,8 +889,8 @@ func TestHeadersRLPStorage(t *testing.T) {
  Number: big.NewInt(int64(i)),
  Extra: []byte("test block"),
  UncleHash: types.EmptyUncleHash,
- TxHash: types.EmptyRootHash,
- ReceiptHash: types.EmptyRootHash,
+ TxHash: types.EmptyTxsHash,
+ ReceiptHash: types.EmptyReceiptsHash,
  ParentHash: pHash,
  })
  chain = append(chain, block)

core/state/iterator.go

@@ -117,7 +117,7 @@ func (it *NodeIterator) step() error {
  if !it.dataIt.Next(true) {
  it.dataIt = nil
  }
- if !bytes.Equal(account.CodeHash, emptyCodeHash) {
+ if !bytes.Equal(account.CodeHash, types.EmptyCodeHash.Bytes()) {
  it.codeHash = common.BytesToHash(account.CodeHash)
  addrHash := common.BytesToHash(it.stateIt.LeafKey())
  it.code, err = it.state.db.ContractCode(addrHash, common.BytesToHash(account.CodeHash))

core/state/pruner/pruner.go

@@ -31,7 +31,6 @@ import (
  "github.com/ethereum/go-ethereum/core/rawdb"
  "github.com/ethereum/go-ethereum/core/state/snapshot"
  "github.com/ethereum/go-ethereum/core/types"
- "github.com/ethereum/go-ethereum/crypto"
  "github.com/ethereum/go-ethereum/ethdb"
  "github.com/ethereum/go-ethereum/log"
  "github.com/ethereum/go-ethereum/rlp"
@@ -55,14 +54,6 @@ const (
  rangeCompactionThreshold = 100000
 )
 
-var (
- // emptyRoot is the known root hash of an empty trie.
- emptyRoot = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
-
- // emptyCode is the known hash of the empty EVM bytecode.
- emptyCode = crypto.Keccak256(nil)
-)
-
 // Config includes all the configurations for pruning.
 type Config struct {
  Datadir string // The directory of the state database
@@ -446,7 +437,7 @@ func extractGenesis(db ethdb.Database, stateBloom *stateBloom) error {
  if err := rlp.DecodeBytes(accIter.LeafBlob(), &acc); err != nil {
  return err
  }
- if acc.Root != emptyRoot {
+ if acc.Root != types.EmptyRootHash {
  id := trie.StorageTrieID(genesis.Root(), common.BytesToHash(accIter.LeafKey()), acc.Root)
  storageTrie, err := trie.NewStateTrie(id, trie.NewDatabase(db))
  if err != nil {
@@ -463,7 +454,7 @@ func extractGenesis(db ethdb.Database, stateBloom *stateBloom) error {
  return storageIter.Error()
  }
  }
- if !bytes.Equal(acc.CodeHash, emptyCode) {
+ if !bytes.Equal(acc.CodeHash, types.EmptyCodeHash.Bytes()) {
  stateBloom.Put(acc.CodeHash, nil)
  }
  }

core/state/snapshot/account.go

@@ -21,6 +21,7 @@ import (
  "math/big"
 
  "github.com/ethereum/go-ethereum/common"
+ "github.com/ethereum/go-ethereum/core/types"
  "github.com/ethereum/go-ethereum/rlp"
 )
 
@@ -41,10 +42,10 @@ func SlimAccount(nonce uint64, balance *big.Int, root common.Hash, codehash []by
  Nonce: nonce,
  Balance: balance,
  }
- if root != emptyRoot {
+ if root != types.EmptyRootHash {
  slim.Root = root[:]
  }
- if !bytes.Equal(codehash, emptyCode[:]) {
+ if !bytes.Equal(codehash, types.EmptyCodeHash[:]) {
  slim.CodeHash = codehash
  }
  return slim
@@ -68,10 +69,10 @@ func FullAccount(data []byte) (Account, error) {
  return Account{}, err
  }
  if len(account.Root) == 0 {
- account.Root = emptyRoot[:]
+ account.Root = types.EmptyRootHash[:]
  }
  if len(account.CodeHash) == 0 {
- account.CodeHash = emptyCode[:]
+ account.CodeHash = types.EmptyCodeHash[:]
  }
  return account, nil
 }

core/state/snapshot/conversion.go

@@ -28,6 +28,7 @@ import (
 
  "github.com/ethereum/go-ethereum/common"
  "github.com/ethereum/go-ethereum/core/rawdb"
+ "github.com/ethereum/go-ethereum/core/types"
  "github.com/ethereum/go-ethereum/ethdb"
  "github.com/ethereum/go-ethereum/log"
  "github.com/ethereum/go-ethereum/rlp"
@@ -74,7 +75,7 @@ func GenerateTrie(snaptree *Tree, root common.Hash, src ethdb.Database, dst ethd
  scheme := snaptree.triedb.Scheme()
  got, err := generateTrieRoot(dst, scheme, acctIt, common.Hash{}, stackTrieGenerate, func(dst ethdb.KeyValueWriter, accountHash, codeHash common.Hash, stat *generateStats) (common.Hash, error) {
  // Migrate the code first, commit the contract code into the tmp db.
- if codeHash != emptyCode {
+ if codeHash != types.EmptyCodeHash {
  code := rawdb.ReadCode(src, codeHash)
  if len(code) == 0 {
  return common.Hash{}, errors.New("failed to read contract code")

core/state/snapshot/generate.go

@@ -27,20 +27,14 @@ import (
  "github.com/ethereum/go-ethereum/common"
  "github.com/ethereum/go-ethereum/common/hexutil"
  "github.com/ethereum/go-ethereum/core/rawdb"
- "github.com/ethereum/go-ethereum/crypto"
+ "github.com/ethereum/go-ethereum/core/types"
  "github.com/ethereum/go-ethereum/ethdb"
  "github.com/ethereum/go-ethereum/log"
  "github.com/ethereum/go-ethereum/rlp"
  "github.com/ethereum/go-ethereum/trie"
 )
 
 var (
- // emptyRoot is the known root hash of an empty trie.
- emptyRoot = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
-
- // emptyCode is the known hash of the empty EVM bytecode.
- emptyCode = crypto.Keccak256Hash(nil)
-
  // accountCheckRange is the upper limit of the number of accounts involved in
  // each range check. This is a value estimated based on experience. If this
  // range is too large, the failure rate of range proof will increase. Otherwise,
@@ -591,10 +585,10 @@ func generateAccounts(ctx *generatorContext, dl *diskLayer, accMarker []byte) er
  if accMarker == nil || !bytes.Equal(account[:], accMarker) {
  dataLen := len(val) // Approximate size, saves us a round of RLP-encoding
  if !write {
- if bytes.Equal(acc.CodeHash, emptyCode[:]) {
+ if bytes.Equal(acc.CodeHash, types.EmptyCodeHash[:]) {
  dataLen -= 32
  }
- if acc.Root == emptyRoot {
+ if acc.Root == types.EmptyRootHash {
  dataLen -= 32
  }
  snapRecoveredAccountMeter.Mark(1)
@@ -621,7 +615,7 @@ func generateAccounts(ctx *generatorContext, dl *diskLayer, accMarker []byte) er
 
  // If the iterated account is the contract, create a further loop to
  // verify or regenerate the contract storage.
- if acc.Root == emptyRoot {
+ if acc.Root == types.EmptyRootHash {
  ctx.removeStorageAt(account)
  } else {
  var storeMarker []byte