go-ethereum/core/state/journal.go

// Copyright 2016 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 <http://www.gnu.org/licenses/>.

package state

import (
	"fmt"
	"maps"
	"slices"
	"sort"

	"github.com/ethereum/go-ethereum/common"
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/holiman/uint256"
)

// frameRange is a half-open interval [start, end) of journal entry indices,
// used to record the slice of entries occupied by a closed child call frame.
type frameRange struct {
	start, end int
}

type revision struct {
	id           int
	journalIndex int
	// closedChildren holds the [start, end) ranges of child call frames that
	// have been closed under this revision via closeSnapshot. Together with
	// journalIndex (this frame's own start) and the current journal length
	// (this frame's tentative end) they describe the slice of entries that
	// belong directly to this frame, with descendant frames' entries excluded.
	//
	// Invariant: ranges are appended in increasing order, are non-overlapping,
	// and lie entirely within [journalIndex, len(entries)).
	closedChildren []frameRange
}

// journalEntry is a modification entry in the state change journal that can be
// reverted on demand.
type journalEntry interface {
	// revert undoes the changes introduced by this journal entry.
	revert(*StateDB)

	// dirtied returns the Ethereum address modified by this journal entry.
	// indicates false if no address was changed.
	dirtied() (common.Address, bool)

	// copy returns a deep-copied journal entry.
	copy() journalEntry
}

// journal contains the list of state modifications applied since the last state
// commit. These are tracked to be able to be reverted in the case of an execution
// exception or request for reversal.
type journal struct {
	entries []journalEntry         // Current changes tracked by the journal
	dirties map[common.Address]int // Dirty accounts and the number of changes

	validRevisions []revision
	nextRevisionId int

	// stateBytesCharged caches the state bytes result per snapshot ID.
	// When a call boundary computes its state bytes and charges gas,
	// the result is stored here. The parent frame subtracts the sum
	// of its subcalls' cached results to avoid double-counting.
	stateBytesCharged map[int]int64
}

// newJournal creates a new initialized journal.
func newJournal() *journal {
	return &journal{
		dirties:           make(map[common.Address]int),
		stateBytesCharged: make(map[int]int64),
	}
}

// reset clears the journal, after this operation the journal can be used anew.
// It is semantically similar to calling 'newJournal', but the underlying slices
// can be reused.
func (j *journal) reset() {
	j.entries = j.entries[:0]
	j.validRevisions = j.validRevisions[:0]
	clear(j.dirties)
	clear(j.stateBytesCharged)
	j.nextRevisionId = 0
}

// snapshot returns an identifier for the current revision of the state.
func (j *journal) snapshot() int {
	id := j.nextRevisionId
	j.nextRevisionId++
	j.validRevisions = append(j.validRevisions, revision{id: id, journalIndex: j.length()})
	return id
}

// revertToSnapshot reverts all state changes made since the given revision.
func (j *journal) revertToSnapshot(revid int, s *StateDB) {
	// Find the snapshot in the stack of valid snapshots.
	idx := sort.Search(len(j.validRevisions), func(i int) bool {
		return j.validRevisions[i].id >= revid
	})
	if idx == len(j.validRevisions) || j.validRevisions[idx].id != revid {
		panic(fmt.Errorf("revision id %v cannot be reverted", revid))
	}
	snapshot := j.validRevisions[idx].journalIndex

	// Replay the journal to undo changes and remove invalidated snapshots
	j.revert(s, snapshot)
	j.validRevisions = j.validRevisions[:idx]
}

// closeSnapshot marks the end of the call frame identified by revid without
// reverting any state. The frame's entry range [snapshot_index, current_length)
// is recorded on its parent revision so callers can later iterate the parent's
// own entries while skipping over closed children (and, transitively, their
// descendants — descendant ranges are absorbed into the closing child's range
// when the descendant itself was closed earlier under that child).
//
// closeSnapshot must be invoked in LIFO order: revid must identify the topmost
// snapshot. It panics otherwise. The corresponding revision is popped, so a
// subsequent revertToSnapshot on the same id is no longer valid.
func (j *journal) closeSnapshot(revid int) {
	if len(j.validRevisions) == 0 {
		panic(fmt.Errorf("revision id %v cannot be closed: no open snapshot", revid))
	}
	top := len(j.validRevisions) - 1
	if j.validRevisions[top].id != revid {
		panic(fmt.Errorf("revision id %v cannot be closed: top is %v",
			revid, j.validRevisions[top].id))
	}
	closed := frameRange{
		start: j.validRevisions[top].journalIndex,
		end:   len(j.entries),
	}
	// Only propagate non-empty ranges, and only if there is a parent frame to
	// receive them. The outermost frame has nothing to bubble up to.
	if closed.start < closed.end && top > 0 {
		parent := &j.validRevisions[top-1]
		parent.closedChildren = append(parent.closedChildren, closed)
	}
	// Drop this revision's bookkeeping. The slice is reused by the parent so
	// avoid pinning it via the popped tail.
	j.validRevisions[top].closedChildren = nil
	j.validRevisions = j.validRevisions[:top]
}

// frameEntries invokes visit for each entry that belongs directly to the
// current (topmost) call frame, skipping entries that lie within any closed
// child frame's range. Entries are visited in append order. If no frame is
// open, frameEntries is a no-op.
//
// nolint:unused
func (j *journal) frameEntries(visit func(entry journalEntry)) {
	if len(j.validRevisions) == 0 {
		return
	}
	rev := j.validRevisions[len(j.validRevisions)-1]
	idx := rev.journalIndex
	for _, child := range rev.closedChildren {
		for ; idx < child.start; idx++ {
			visit(j.entries[idx])
		}
		idx = child.end
	}
	for ; idx < len(j.entries); idx++ {
		visit(j.entries[idx])
	}
}

// append inserts a new modification entry to the end of the change journal.
func (j *journal) append(entry journalEntry) {
	j.entries = append(j.entries, entry)
	if addr, dirty := entry.dirtied(); dirty {
		j.dirties[addr]++
	}
}

// revert undoes a batch of journalled modifications along with any reverted
// dirty handling too.
func (j *journal) revert(statedb *StateDB, snapshot int) {
	for i := len(j.entries) - 1; i >= snapshot; i-- {
		// Undo the changes made by the operation
		j.entries[i].revert(statedb)

		// Drop any dirty tracking induced by the change
		if addr, dirty := j.entries[i].dirtied(); dirty {
			if j.dirties[addr]--; j.dirties[addr] == 0 {
				delete(j.dirties, addr)
			}
		}
	}
	j.entries = j.entries[:snapshot]
}

// dirty explicitly sets an address to dirty, even if the change entries would
// otherwise suggest it as clean. This method is an ugly hack to handle the RIPEMD
// precompile consensus exception.
func (j *journal) dirty(addr common.Address) {
	j.dirties[addr]++
}

// length returns the current number of entries in the journal.
func (j *journal) length() int {
	return len(j.entries)
}

// stateChangedBytes computes the state bytes created by the call frame
// identified by snapshotId. Since subcalls always compute their results
// before the parent (innermost-first), this only scans journal entries
// between this snapshot and the next one — the frame's own entries.
// Subcall results are summed from the cache and subtracted.
//
// The result is cached in stateBytesCharged[snapshotId] so the parent
// frame can look it up instead of re-scanning.
func (j *journal) stateChangedBytes(snapshotId int, stateObjects map[common.Address]*stateObject) int64 {
	// TODO (MariusVanDerWijden): this is a bit slop-py needs to be cleaned up
	// Resolve snapshot index.
	idx := sort.Search(len(j.validRevisions), func(i int) bool {
		return j.validRevisions[i].id >= snapshotId
	})
	if idx == len(j.validRevisions) || j.validRevisions[idx].id != snapshotId {
		panic(fmt.Errorf("snapshot id %v not found for stateChangedBytes", snapshotId))
	}
	start := j.validRevisions[idx].journalIndex

	// Our range is [start, end) where end is the next revision's start,
	// or the end of the journal if we're the last revision.
	end := len(j.entries)
	if idx+1 < len(j.validRevisions) {
		end = j.validRevisions[idx+1].journalIndex
	}

	// Walk only our own entries.
	type slotKey struct {
		addr common.Address
		key  common.Hash
	}
	type slotInfo struct {
		prev common.Hash // value before first write in this frame
		orig common.Hash // committed/original value from trie
	}
	slots := make(map[slotKey]*slotInfo)
	created := make(map[common.Address]bool)
	codeChanged := make(map[common.Address]bool)

	for i := start; i < end; i++ {
		switch e := j.entries[i].(type) {
		case createContractChange:
			created[e.account] = true
		case codeChange:
			codeChanged[e.account] = true
		case storageChange:
			sk := slotKey{e.account, e.key}
			if _, seen := slots[sk]; !seen {
				slots[sk] = &slotInfo{prev: e.prevvalue, orig: e.origvalue}
			}
		}
	}

	var totalBytes int64
	for range created {
		totalBytes += CostPerAccount
	}
	for sk, si := range slots {
		obj := stateObjects[sk.addr]
		if obj == nil {
			continue
		}
		cur := obj.dirtyStorage[sk.key]
		prevZero := si.prev == (common.Hash{})
		curZero := cur == (common.Hash{})
		origZero := si.orig == (common.Hash{})

		if prevZero && !curZero && origZero {
			// Frame-entry zero, frame-exit non-zero, tx-entry zero:
			// this frame created a new slot, charge.
			totalBytes += CostPerSlot
		} else if !prevZero && curZero && origZero {
			// Only refund slots created and freed in this transaction
			totalBytes -= CostPerSlot
		}
		// All other transitions are free:
		// - prevZero && !curZero && !origZero: pre-existing slot was
		//   cleared in earlier frame, re-set here — no charge.
		// - X → Y (non-zero to non-zero): no charge.
		// - zero → zero: no change.
		// - !prevZero && curZero && !origZero: pre-exising slot was
		// cleared now, don't refund to not enable gas tokens.
	}
	for addr := range codeChanged {
		obj := stateObjects[addr]
		if obj != nil {
			totalBytes += int64(len(obj.code))
		}
	}

	// Cache our result so the parent can look it up.
	j.stateBytesCharged[snapshotId] = totalBytes
	return totalBytes
}

// copy returns a deep-copied journal.
func (j *journal) copy() *journal {
	entries := make([]journalEntry, 0, j.length())
	for i := 0; i < j.length(); i++ {
		entries = append(entries, j.entries[i].copy())
	}
	revisions := make([]revision, len(j.validRevisions))
	for i, r := range j.validRevisions {
		revisions[i] = revision{
			id:             r.id,
			journalIndex:   r.journalIndex,
			closedChildren: slices.Clone(r.closedChildren),
		}
	}
	return &journal{
		entries:           entries,
		dirties:           maps.Clone(j.dirties),
		validRevisions:    revisions,
		nextRevisionId:    j.nextRevisionId,
		stateBytesCharged: maps.Clone(j.stateBytesCharged),
	}
}

func (j *journal) logChange(txHash common.Hash) {
	j.append(addLogChange{txhash: txHash})
}

func (j *journal) createObject(addr common.Address) {
	j.append(createObjectChange{account: addr})
}

func (j *journal) createContract(addr common.Address) {
	j.append(createContractChange{account: addr})
}

func (j *journal) destruct(addr common.Address) {
	j.append(selfDestructChange{account: addr})
}

func (j *journal) storageChange(addr common.Address, key, prev, origin common.Hash) {
	j.append(storageChange{
		account:   addr,
		key:       key,
		prevvalue: prev,
		origvalue: origin,
	})
}

func (j *journal) transientStateChange(addr common.Address, key, prev common.Hash) {
	j.append(transientStorageChange{
		account:  addr,
		key:      key,
		prevalue: prev,
	})
}

func (j *journal) refundChange(previous uint64) {
	j.append(refundChange{prev: previous})
}

func (j *journal) balanceChange(addr common.Address, previous *uint256.Int) {
	j.append(balanceChange{
		account: addr,
		prev:    previous.Clone(),
	})
}

func (j *journal) setCode(address common.Address, prevCode []byte) {
	j.append(codeChange{
		account:  address,
		prevCode: prevCode,
	})
}

func (j *journal) nonceChange(address common.Address, prev uint64) {
	j.append(nonceChange{
		account: address,
		prev:    prev,
	})
}

func (j *journal) touchChange(address common.Address) {
	j.append(touchChange{
		account: address,
	})
	if address == ripemd {
		// Explicitly put it in the dirty-cache, which is otherwise generated from
		// flattened journals.
		j.dirty(address)
	}
}

func (j *journal) accessListAddAccount(addr common.Address) {
	j.append(accessListAddAccountChange{addr})
}

func (j *journal) accessListAddSlot(addr common.Address, slot common.Hash) {
	j.append(accessListAddSlotChange{
		address: addr,
		slot:    slot,
	})
}

type (
	// Changes to the account trie.
	createObjectChange struct {
		account common.Address
	}
	// createContractChange represents an account becoming a contract-account.
	// This event happens prior to executing initcode. The journal-event simply
	// manages the created-flag, in order to allow same-tx destruction.
	createContractChange struct {
		account common.Address
	}
	selfDestructChange struct {
		account common.Address
	}

	// Changes to individual accounts.
	balanceChange struct {
		account common.Address
		prev    *uint256.Int
	}
	nonceChange struct {
		account common.Address
		prev    uint64
	}
	storageChange struct {
		account   common.Address
		key       common.Hash
		prevvalue common.Hash
		origvalue common.Hash
	}
	codeChange struct {
		account  common.Address
		prevCode []byte
	}

	// Changes to other state values.
	refundChange struct {
		prev uint64
	}
	addLogChange struct {
		txhash common.Hash
	}
	touchChange struct {
		account common.Address
	}

	// Changes to the access list
	accessListAddAccountChange struct {
		address common.Address
	}
	accessListAddSlotChange struct {
		address common.Address
		slot    common.Hash
	}

	// Changes to transient storage
	transientStorageChange struct {
		account       common.Address
		key, prevalue common.Hash
	}
)

func (ch createObjectChange) revert(s *StateDB) {
	delete(s.stateObjects, ch.account)
}

func (ch createObjectChange) dirtied() (common.Address, bool) {
	return ch.account, true
}

func (ch createObjectChange) copy() journalEntry {
	return createObjectChange{
		account: ch.account,
	}
}

func (ch createContractChange) revert(s *StateDB) {
	s.getStateObject(ch.account).newContract = false
}

func (ch createContractChange) dirtied() (common.Address, bool) {
	return common.Address{}, false
}

func (ch createContractChange) copy() journalEntry {
	return createContractChange{
		account: ch.account,
	}
}

func (ch selfDestructChange) revert(s *StateDB) {
	obj := s.getStateObject(ch.account)
	if obj != nil {
		obj.selfDestructed = false
	}
}

func (ch selfDestructChange) dirtied() (common.Address, bool) {
	return ch.account, true
}

func (ch selfDestructChange) copy() journalEntry {
	return selfDestructChange{
		account: ch.account,
	}
}

var ripemd = common.HexToAddress("0000000000000000000000000000000000000003")

func (ch touchChange) revert(s *StateDB) {
}

func (ch touchChange) dirtied() (common.Address, bool) {
	return ch.account, true
}

func (ch touchChange) copy() journalEntry {
	return touchChange{
		account: ch.account,
	}
}

func (ch balanceChange) revert(s *StateDB) {
	s.getStateObject(ch.account).setBalance(ch.prev)
}

func (ch balanceChange) dirtied() (common.Address, bool) {
	return ch.account, true
}

func (ch balanceChange) copy() journalEntry {
	return balanceChange{
		account: ch.account,
		prev:    new(uint256.Int).Set(ch.prev),
	}
}

func (ch nonceChange) revert(s *StateDB) {
	s.getStateObject(ch.account).setNonce(ch.prev)
}

func (ch nonceChange) dirtied() (common.Address, bool) {
	return ch.account, true
}

func (ch nonceChange) copy() journalEntry {
	return nonceChange{
		account: ch.account,
		prev:    ch.prev,
	}
}

func (ch codeChange) revert(s *StateDB) {
	s.getStateObject(ch.account).setCode(crypto.Keccak256Hash(ch.prevCode), ch.prevCode)
}

func (ch codeChange) dirtied() (common.Address, bool) {
	return ch.account, true
}

func (ch codeChange) copy() journalEntry {
	return codeChange{
		account:  ch.account,
		prevCode: ch.prevCode,
	}
}

func (ch storageChange) revert(s *StateDB) {
	s.getStateObject(ch.account).setState(ch.key, ch.prevvalue, ch.origvalue)
}

func (ch storageChange) dirtied() (common.Address, bool) {
	return ch.account, true
}

func (ch storageChange) copy() journalEntry {
	return storageChange{
		account:   ch.account,
		key:       ch.key,
		prevvalue: ch.prevvalue,
		origvalue: ch.origvalue,
	}
}

func (ch transientStorageChange) revert(s *StateDB) {
	s.setTransientState(ch.account, ch.key, ch.prevalue)
}

func (ch transientStorageChange) dirtied() (common.Address, bool) {
	return common.Address{}, false
}

func (ch transientStorageChange) copy() journalEntry {
	return transientStorageChange{
		account:  ch.account,
		key:      ch.key,
		prevalue: ch.prevalue,
	}
}

func (ch refundChange) revert(s *StateDB) {
	s.refund = ch.prev
}

func (ch refundChange) dirtied() (common.Address, bool) {
	return common.Address{}, false
}

func (ch refundChange) copy() journalEntry {
	return refundChange{
		prev: ch.prev,
	}
}

func (ch addLogChange) revert(s *StateDB) {
	logs := s.logs[ch.txhash]
	if len(logs) == 1 {
		delete(s.logs, ch.txhash)
	} else {
		s.logs[ch.txhash] = logs[:len(logs)-1]
	}
	s.logSize--
}

func (ch addLogChange) dirtied() (common.Address, bool) {
	return common.Address{}, false
}

func (ch addLogChange) copy() journalEntry {
	return addLogChange{
		txhash: ch.txhash,
	}
}

func (ch accessListAddAccountChange) revert(s *StateDB) {
	/*
		One important invariant here, is that whenever a (addr, slot) is added, if the
		addr is not already present, the add causes two journal entries:
		- one for the address,
		- one for the (address,slot)
		Therefore, when unrolling the change, we can always blindly delete the
		(addr) at this point, since no storage adds can remain when come upon
		a single (addr) change.
	*/
	s.accessList.DeleteAddress(ch.address)
}

func (ch accessListAddAccountChange) dirtied() (common.Address, bool) {
	return common.Address{}, false
}

func (ch accessListAddAccountChange) copy() journalEntry {
	return accessListAddAccountChange{
		address: ch.address,
	}
}

func (ch accessListAddSlotChange) revert(s *StateDB) {
	s.accessList.DeleteSlot(ch.address, ch.slot)
}

func (ch accessListAddSlotChange) dirtied() (common.Address, bool) {
	return common.Address{}, false
}

func (ch accessListAddSlotChange) copy() journalEntry {
	return accessListAddSlotChange{
		address: ch.address,
		slot:    ch.slot,
	}
}