// Copyright 2026 The go-ethereum Authors // This file is part of the go-ethereum library. // // The go-ethereum library is free software: you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // The go-ethereum library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public License // along with the go-ethereum library. If not, see . package state import ( "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/core/stateless" "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/crypto" "github.com/ethereum/go-ethereum/ethdb" "github.com/ethereum/go-ethereum/trie/bintrie" "github.com/ethereum/go-ethereum/trie/trienode" "github.com/ethereum/go-ethereum/triedb" ) // warpBinTrie pairs a BinaryTrie with an optional background prefetcher that // preloads trie nodes ahead of mutation. type warpBinTrie struct { *bintrie.BinaryTrie prefetcher *prefetcher } // newWrapBinTrie creates a binary trie with the optional prefetcher enabled. func newWrapBinTrie(root common.Hash, db *triedb.Database, prefetch bool, prefetchRead bool) (*warpBinTrie, error) { t, err := bintrie.NewBinaryTrie(root, db) if err != nil { return nil, err } var p *prefetcher if prefetch { p = newPrefetcher(t, prefetchRead) } return &warpBinTrie{BinaryTrie: t, prefetcher: p}, nil } // term synchronously terminates the prefetcher (no-op if nil or already done). // After termination the prefetcher reference is nilled so subsequent calls are // a cheap pointer check. func (tr *warpBinTrie) term() { if tr.prefetcher == nil { return } tr.prefetcher.terminate() tr.prefetcher = nil } // The methods below shadow the embedded bintrie.BinaryTrie so that any direct trie // access auto-terminates the prefetcher first. This makes data-race freedom // structural: callers never need to remember to call term() manually. func (tr *warpBinTrie) UpdateAccount(address common.Address, acc *types.StateAccount, codeLen int) error { tr.term() return tr.BinaryTrie.UpdateAccount(address, acc, codeLen) } func (tr *warpBinTrie) DeleteAccount(address common.Address) error { tr.term() return tr.BinaryTrie.DeleteAccount(address) } func (tr *warpBinTrie) UpdateStorage(address common.Address, key, value []byte) error { tr.term() return tr.BinaryTrie.UpdateStorage(address, key, value) } func (tr *warpBinTrie) DeleteStorage(address common.Address, key []byte) error { tr.term() return tr.BinaryTrie.DeleteStorage(address, key) } func (tr *warpBinTrie) Hash() common.Hash { tr.term() return tr.BinaryTrie.Hash() } func (tr *warpBinTrie) Commit(collectLeaf bool) (common.Hash, *trienode.NodeSet) { tr.term() return tr.BinaryTrie.Commit(collectLeaf) } func (tr *warpBinTrie) Prove(key []byte, proofDb ethdb.KeyValueWriter) error { tr.term() return tr.BinaryTrie.Prove(key, proofDb) } func (tr *warpBinTrie) Witness() map[string][]byte { tr.term() return tr.BinaryTrie.Witness() } func (tr *warpBinTrie) prefetchAccounts(addresses []common.Address, read bool) { if tr.prefetcher == nil { return } tr.prefetcher.scheduleAccounts(addresses, read) } func (tr *warpBinTrie) prefetchStorage(addr common.Address, keys []common.Hash, read bool) { if tr.prefetcher == nil { return } tr.prefetcher.scheduleSlots(addr, keys, read) } // copy returns a deep-copied state trie. Notably the prefetcher is deliberately // not copied, as it only belongs to the original one. func (tr *warpBinTrie) copy() *warpBinTrie { tr.term() return &warpBinTrie{BinaryTrie: tr.BinaryTrie.Copy()} } // binaryHasher is a Hasher implementation backed by a unified single-layer // binary trie. Accounts, storage slots, and contract code all reside in one // trie, keyed according to the EIP-7864 address space layout. type binaryHasher struct { db *triedb.Database root common.Hash prefetch bool trie *warpBinTrie } func newBinaryHasher(root common.Hash, db *triedb.Database, prefetch bool, prefetchRead bool) (*binaryHasher, error) { tr, err := newWrapBinTrie(root, db, prefetch, prefetchRead) if err != nil { return nil, err } return &binaryHasher{ db: db, root: root, prefetch: prefetch, trie: tr, }, nil } // deleteAccount removes the account specified by the address from the state. func (h *binaryHasher) deleteAccount(addr common.Address) error { return h.trie.DeleteAccount(addr) } // update writes the account specified by the address into the state. func (h *binaryHasher) updateAccount(addr common.Address, account AccountMut) error { // Determine code size: use the new code length if provided, // otherwise fall back to the cached or trie-stored value. // // TODO(rjl493456442) the contract code length is not assigned // if it's not modified, fix it. codeLen := 0 if account.Code != nil { codeLen = len(account.Code.Code) } data := &types.StateAccount{ Nonce: account.Account.Nonce, Balance: account.Account.Balance, CodeHash: account.Account.CodeHash, } if err := h.trie.UpdateAccount(addr, data, codeLen); err != nil { return err } // Write chunked code into the trie when dirty. if account.Code != nil && len(account.Code.Code) > 0 { codeHash := common.BytesToHash(account.Account.CodeHash) if err := h.trie.UpdateContractCode(addr, codeHash, account.Code.Code); err != nil { return err } } return nil } // UpdateAccount implements Hasher, writing a list of account mutations // into the state. The assumption is held all the storage changes have // already been written beforehand. func (h *binaryHasher) UpdateAccount(addresses []common.Address, accounts []AccountMut) error { var err error for i, addr := range addresses { if accounts[i].Account == nil { err = h.deleteAccount(addr) } else { err = h.updateAccount(addr, accounts[i]) } if err != nil { return err } } return nil } // UpdateStorage implements Hasher, writing a list of storage slot mutations // into the state. This function must be invoked first before writing the // associated account metadata into the state. func (h *binaryHasher) UpdateStorage(address common.Address, keys []common.Hash, values []common.Hash) error { var err error for i, key := range keys { if values[i] == (common.Hash{}) { err = h.trie.DeleteStorage(address, key[:]) } else { err = h.trie.UpdateStorage(address, key[:], values[i][:]) } if err != nil { return err } } return nil } // Hash implements Hasher, computing the state root hash without committing. func (h *binaryHasher) Hash() common.Hash { return h.trie.Hash() } // Commit implements Hasher, finalizing all pending changes and returning // the resulting state root hash, along with the set of dirty trie nodes // generated by the updates. func (h *binaryHasher) Commit() (common.Hash, *trienode.MergedNodeSet, map[common.Address]Hashes, error) { nodes := trienode.NewMergedNodeSet() root, set := h.trie.Commit(false) if set != nil { if err := nodes.Merge(set); err != nil { return common.Hash{}, nil, nil, err } } // The binary trie is a single unified structure with no per-account // storage sub-tries, so there are no secondary hashes to report. return root, nodes, nil, nil } // Close terminates all prefetcher goroutines. Safe to call multiple times. func (h *binaryHasher) Close() { h.trie.term() } // Copy implements Hasher, returning a deep-copied hasher instance. func (h *binaryHasher) Copy() Hasher { return &binaryHasher{ db: h.db, root: h.root, prefetch: false, trie: h.trie.copy(), } } // ProveAccount implements Prover, constructing a proof for the given account. func (h *binaryHasher) ProveAccount(addr common.Address, proofDb ethdb.KeyValueWriter) error { return h.trie.Prove(crypto.Keccak256(addr.Bytes()), proofDb) } // ProveStorage implements Prover, constructing a proof for the given storage // slot of the specified account. func (h *binaryHasher) ProveStorage(addr common.Address, key common.Hash, proofDb ethdb.KeyValueWriter) error { return h.trie.Prove(crypto.Keccak256(key.Bytes()), proofDb) } // CollectWitness implements WitnessCollector. It aggregates all trie nodes // accessed (both read and write) across the account trie, all active storage // tries and deleted storage tries into a single state witness. func (h *binaryHasher) CollectWitness(witness *stateless.Witness) { witness.AddState(h.trie.Witness(), common.Hash{}) } // PrefetchAccount implements Prefetcher, preloading the nodes of specific accounts. func (h *binaryHasher) PrefetchAccount(addresses []common.Address, read bool) { if !h.prefetch { return } h.trie.prefetchAccounts(addresses, read) } // PrefetchStorage implements Prefetcher. The storage trie is opened eagerly // so the prefetcher can begin loading nodes in the background. func (h *binaryHasher) PrefetchStorage(addr common.Address, keys []common.Hash, read bool) { if !h.prefetch { return } h.trie.prefetchStorage(addr, keys, read) }