state

package
v1.14.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 27, 2024 License: GPL-3.0 Imports: 34 Imported by: 5,148

Documentation

Overview

Package state provides a caching layer atop the Ethereum state trie.

Index

Constants

View Source 
const (
	AccessWitnessReadFlag  = mode(1)
	AccessWitnessWriteFlag = mode(2)
)
View Source 
const TriesInMemory = 128

TriesInMemory represents the number of layers that are kept in RAM.

Variables

This section is empty.

Functions

func NewStateSync added in v1.3.1 

func NewStateSync(root common.Hash, database ethdb.KeyValueReader, onLeaf func(keys [][]byte, leaf []byte) error, scheme string) *trie.Sync

NewStateSync creates a new state trie download scheduler.

Types

type AccessEvents added in v1.14.4 

type AccessEvents struct {
	// contains filtered or unexported fields
}

AccessEvents lists the locations of the state that are being accessed during the production of a block.

func NewAccessEvents added in v1.14.4 

func NewAccessEvents(pointCache *utils.PointCache) *AccessEvents

func (*AccessEvents) AddAccount added in v1.14.4 

func (ae *AccessEvents) AddAccount(addr common.Address, isWrite bool) uint64

AddAccount returns the gas to be charged for each of the currently cold member fields of an account.

func (*AccessEvents) AddTxDestination added in v1.14.4 

func (ae *AccessEvents) AddTxDestination(addr common.Address, sendsValue bool)

AddTxDestination adds the member fields of the sender account to the access event list, so that cold accesses are not charged, since they are covered by the 21000 gas.

func (*AccessEvents) AddTxOrigin added in v1.14.4 

func (ae *AccessEvents) AddTxOrigin(originAddr common.Address)

AddTxOrigin adds the member fields of the sender account to the access event list, so that cold accesses are not charged, since they are covered by the 21000 gas.

func (*AccessEvents) BasicDataGas added in v1.14.9 

func (ae *AccessEvents) BasicDataGas(addr common.Address, isWrite bool) uint64

BasicDataGas adds the account's basic data to the accessed data, and returns the amount of gas that it costs. Note that an access in write mode implies an access in read mode, whereas an access in read mode does not imply an access in write mode.

func (*AccessEvents) CodeChunksRangeGas added in v1.14.4 

func (ae *AccessEvents) CodeChunksRangeGas(contractAddr common.Address, startPC, size uint64, codeLen uint64, isWrite bool) uint64

CodeChunksRangeGas is a helper function to touch every chunk in a code range and charge witness gas costs

func (*AccessEvents) CodeHashGas added in v1.14.4 

func (ae *AccessEvents) CodeHashGas(addr common.Address, isWrite bool) uint64

CodeHashGas adds the account's code hash to the accessed data, and returns the amount of gas that it costs. in write mode. If false, the charged gas corresponds to an access in read mode. Note that an access in write mode implies an access in read mode, whereas an access in read mode does not imply an access in write mode.

func (*AccessEvents) ContractCreateInitGas added in v1.14.4 

func (ae *AccessEvents) ContractCreateInitGas(addr common.Address) uint64

ContractCreateInitGas returns the access gas costs for the initialization of a contract creation.

func (*AccessEvents) ContractCreatePreCheckGas added in v1.14.9 

func (ae *AccessEvents) ContractCreatePreCheckGas(addr common.Address) uint64

ContractCreateCPreheck charges access costs before a contract creation is initiated. It is just reads, because the address collision is done before the transfer, and so no write are guaranteed to happen at this point.

func (*AccessEvents) Copy added in v1.14.4 

func (ae *AccessEvents) Copy() *AccessEvents

func (*AccessEvents) Keys added in v1.14.4 

func (ae *AccessEvents) Keys() [][]byte

Keys returns, predictably, the list of keys that were touched during the buildup of the access witness.

func (*AccessEvents) Merge added in v1.14.4 

func (ae *AccessEvents) Merge(other *AccessEvents)

Merge is used to merge the access events that were generated during the execution of a tx, with the accumulation of all access events that were generated during the execution of all txs preceding this one in a block.

func (*AccessEvents) MessageCallGas added in v1.14.4 

func (ae *AccessEvents) MessageCallGas(destination common.Address) uint64

MessageCallGas returns the gas to be charged for each of the currently cold member fields of an account, that need to be touched when making a message call to that account.

func (*AccessEvents) SlotGas added in v1.14.4 

func (ae *AccessEvents) SlotGas(addr common.Address, slot common.Hash, isWrite bool) uint64

SlotGas returns the amount of gas to be charged for a cold storage access.

func (*AccessEvents) ValueTransferGas added in v1.14.4 

func (ae *AccessEvents) ValueTransferGas(callerAddr, targetAddr common.Address) uint64

ValueTransferGas returns the gas to be charged for each of the currently cold balance member fields of the caller and the callee accounts.

type CachingDB added in v1.14.9 

type CachingDB struct {
	// contains filtered or unexported fields
}

CachingDB is an implementation of Database interface. It leverages both trie and state snapshot to provide functionalities for state access. It's meant to be a long-live object and has a few caches inside for sharing between blocks.

func NewDatabase added in v1.6.7 

func NewDatabase(triedb *triedb.Database, snap *snapshot.Tree) *CachingDB

NewDatabase creates a state database with the provided data sources.

func NewDatabaseForTesting added in v1.14.9 

func NewDatabaseForTesting() *CachingDB

NewDatabaseForTesting is similar to NewDatabase, but it initializes the caching db by using an ephemeral memory db with default config for testing.

func (*CachingDB) ContractCode added in v1.14.9 

func (db *CachingDB) ContractCode(address common.Address, codeHash common.Hash) ([]byte, error)

ContractCode retrieves a particular contract's code.

func (*CachingDB) ContractCodeSize added in v1.14.9 

func (db *CachingDB) ContractCodeSize(addr common.Address, codeHash common.Hash) (int, error)

ContractCodeSize retrieves a particular contracts code's size.

func (*CachingDB) ContractCodeWithPrefix added in v1.14.9 

func (db *CachingDB) ContractCodeWithPrefix(address common.Address, codeHash common.Hash) ([]byte, error)

ContractCodeWithPrefix retrieves a particular contract's code. If the code can't be found in the cache, then check the existence with **new** db scheme.

func (*CachingDB) OpenStorageTrie added in v1.14.9 

func (db *CachingDB) OpenStorageTrie(stateRoot common.Hash, address common.Address, root common.Hash, self Trie) (Trie, error)

OpenStorageTrie opens the storage trie of an account.

func (*CachingDB) OpenTrie added in v1.14.9 

func (db *CachingDB) OpenTrie(root common.Hash) (Trie, error)

OpenTrie opens the main account trie at a specific root hash.

func (*CachingDB) PointCache added in v1.14.9 

func (db *CachingDB) PointCache() *utils.PointCache

PointCache returns the cache of evaluated curve points.

func (*CachingDB) Reader added in v1.14.9 

func (db *CachingDB) Reader(stateRoot common.Hash) (Reader, error)

Reader returns a state reader associated with the specified state root.

func (*CachingDB) Snapshot added in v1.14.9 

func (db *CachingDB) Snapshot() *snapshot.Tree

Snapshot returns the underlying state snapshot.

func (*CachingDB) TrieDB added in v1.14.9 

func (db *CachingDB) TrieDB() *triedb.Database

TrieDB retrieves any intermediate trie-node caching layer.

type Database added in v1.6.7 

type Database interface {
	// Reader returns a state reader associated with the specified state root.
	Reader(root common.Hash) (Reader, error)

	// OpenTrie opens the main account trie.
	OpenTrie(root common.Hash) (Trie, error)

	// OpenStorageTrie opens the storage trie of an account.
	OpenStorageTrie(stateRoot common.Hash, address common.Address, root common.Hash, trie Trie) (Trie, error)

	// ContractCode retrieves a particular contract's code.
	ContractCode(addr common.Address, codeHash common.Hash) ([]byte, error)

	// ContractCodeSize retrieves a particular contracts code's size.
	ContractCodeSize(addr common.Address, codeHash common.Hash) (int, error)

	// PointCache returns the cache holding points used in verkle tree key computation
	PointCache() *utils.PointCache

	// TrieDB returns the underlying trie database for managing trie nodes.
	TrieDB() *triedb.Database

	// Snapshot returns the underlying state snapshot.
	Snapshot() *snapshot.Tree
}

Database wraps access to tries and contract code.

type Dump added in v1.4.13 

type Dump struct {
	Root     string                 `json:"root"`
	Accounts map[string]DumpAccount `json:"accounts"`
	// Next can be set to represent that this dump is only partial, and Next
	// is where an iterator should be positioned in order to continue the dump.
	Next []byte `json:"next,omitempty"` // nil if no more accounts
}

Dump represents the full dump in a collected format, as one large map.

func (*Dump) OnAccount added in v1.9.16 

func (d *Dump) OnAccount(addr *common.Address, account DumpAccount)

OnAccount implements DumpCollector interface

func (*Dump) OnRoot added in v1.9.16 

func (d *Dump) OnRoot(root common.Hash)

OnRoot implements DumpCollector interface

type DumpAccount added in v1.4.13 

type DumpAccount struct {
	Balance     string                 `json:"balance"`
	Nonce       uint64                 `json:"nonce"`
	Root        hexutil.Bytes          `json:"root"`
	CodeHash    hexutil.Bytes          `json:"codeHash"`
	Code        hexutil.Bytes          `json:"code,omitempty"`
	Storage     map[common.Hash]string `json:"storage,omitempty"`
	Address     *common.Address        `json:"address,omitempty"` // Address only present in iterative (line-by-line) mode
	AddressHash hexutil.Bytes          `json:"key,omitempty"`     // If we don't have address, we can output the key
}

DumpAccount represents an account in the state.

type DumpCollector added in v1.9.16 

type DumpCollector interface {
	// OnRoot is called with the state root
	OnRoot(common.Hash)
	// OnAccount is called once for each account in the trie
	OnAccount(*common.Address, DumpAccount)
}

DumpCollector interface which the state trie calls during iteration

type DumpConfig added in v1.10.4 

type DumpConfig struct {
	SkipCode          bool
	SkipStorage       bool
	OnlyWithAddresses bool
	Start             []byte
	Max               uint64
}

DumpConfig is a set of options to control what portions of the state will be iterated and collected.

type Reader added in v1.14.9 

type Reader interface {
	// Account retrieves the account associated with a particular address.
	//
	// - Returns a nil account if it does not exist
	// - Returns an error only if an unexpected issue occurs
	// - The returned account is safe to modify after the call
	Account(addr common.Address) (*types.StateAccount, error)

	// Storage retrieves the storage slot associated with a particular account
	// address and slot key.
	//
	// - Returns an empty slot if it does not exist
	// - Returns an error only if an unexpected issue occurs
	// - The returned storage slot is safe to modify after the call
	Storage(addr common.Address, slot common.Hash) (common.Hash, error)

	// Copy returns a deep-copied state reader.
	Copy() Reader
}

Reader defines the interface for accessing accounts and storage slots associated with a specific state.

type StateDB 

type StateDB struct {

	// Measurements gathered during execution for debugging purposes
	AccountReads    time.Duration
	AccountHashes   time.Duration
	AccountUpdates  time.Duration
	AccountCommits  time.Duration
	StorageReads    time.Duration
	StorageUpdates  time.Duration
	StorageCommits  time.Duration
	SnapshotCommits time.Duration
	TrieDBCommits   time.Duration

	AccountLoaded  int          // Number of accounts retrieved from the database during the state transition
	AccountUpdated int          // Number of accounts updated during the state transition
	AccountDeleted int          // Number of accounts deleted during the state transition
	StorageLoaded  int          // Number of storage slots retrieved from the database during the state transition
	StorageUpdated atomic.Int64 // Number of storage slots updated during the state transition
	StorageDeleted atomic.Int64 // Number of storage slots deleted during the state transition
	// contains filtered or unexported fields
}

StateDB structs within the ethereum protocol are used to store anything within the merkle trie. StateDBs take care of caching and storing nested states. It's the general query interface to retrieve:

* Contracts * Accounts

Once the state is committed, tries cached in stateDB (including account trie, storage tries) will no longer be functional. A new state instance must be created with new root and updated database for accessing post- commit states.

func New 

func New(root common.Hash, db Database) (*StateDB, error)

New creates a new state from a given trie.

func (*StateDB) AccessEvents added in v1.14.9 

func (s *StateDB) AccessEvents() *AccessEvents

func (*StateDB) AddAddressToAccessList added in v1.9.24 

func (s *StateDB) AddAddressToAccessList(addr common.Address)

AddAddressToAccessList adds the given address to the access list

func (*StateDB) AddBalance 

func (s *StateDB) AddBalance(addr common.Address, amount *uint256.Int, reason tracing.BalanceChangeReason)

AddBalance adds amount to the account associated with addr.

func (*StateDB) AddLog 

func (s *StateDB) AddLog(log *types.Log)

func (*StateDB) AddPreimage added in v1.5.8 

func (s *StateDB) AddPreimage(hash common.Hash, preimage []byte)

AddPreimage records a SHA3 preimage seen by the VM.

func (*StateDB) AddRefund added in v1.3.1 

func (s *StateDB) AddRefund(gas uint64)

AddRefund adds gas to the refund counter

func (*StateDB) AddSlotToAccessList added in v1.9.24 

func (s *StateDB) AddSlotToAccessList(addr common.Address, slot common.Hash)

AddSlotToAccessList adds the given (address, slot)-tuple to the access list

func (*StateDB) AddressInAccessList added in v1.9.24 

func (s *StateDB) AddressInAccessList(addr common.Address) bool

AddressInAccessList returns true if the given address is in the access list.

func (*StateDB) Commit added in v1.3.1 

func (s *StateDB) Commit(block uint64, deleteEmptyObjects bool) (common.Hash, error)

Commit writes the state mutations into the configured data stores.

Once the state is committed, tries cached in stateDB (including account trie, storage tries) will no longer be functional. A new state instance must be created with new root and updated database for accessing post- commit states.

The associated block number of the state transition is also provided for more chain context.

func (*StateDB) Copy 

func (s *StateDB) Copy() *StateDB

Copy creates a deep, independent copy of the state. Snapshots of the copied state cannot be applied to the copy.

func (*StateDB) CreateAccount 

func (s *StateDB) CreateAccount(addr common.Address)

CreateAccount explicitly creates a new state object, assuming that the account did not previously exist in the state. If the account already exists, this function will silently overwrite it which might lead to a consensus bug eventually.

func (*StateDB) CreateContract added in v1.14.2 

func (s *StateDB) CreateContract(addr common.Address)

CreateContract is used whenever a contract is created. This may be preceded by CreateAccount, but that is not required if it already existed in the state due to funds sent beforehand. This operation sets the 'newContract'-flag, which is required in order to correctly handle EIP-6780 'delete-in-same-transaction' logic.

func (*StateDB) Database added in v1.8.0 

func (s *StateDB) Database() Database

Database retrieves the low level database supporting the lower level trie ops.

func (*StateDB) Dump 

func (s *StateDB) Dump(opts *DumpConfig) []byte

Dump returns a JSON string representing the entire state as a single json-object

func (*StateDB) DumpToCollector added in v1.9.16 

func (s *StateDB) DumpToCollector(c DumpCollector, conf *DumpConfig) (nextKey []byte)

DumpToCollector iterates the state according to the given options and inserts the items into a collector for aggregation or serialization.

func (*StateDB) Empty 

func (s *StateDB) Empty(addr common.Address) bool

Empty returns whether the state object is either non-existent or empty according to the EIP161 specification (balance = nonce = code = 0)

func (*StateDB) Error added in v1.6.7 

func (s *StateDB) Error() error

Error returns the memorized database failure occurred earlier.

func (*StateDB) Exist added in v1.3.1 

func (s *StateDB) Exist(addr common.Address) bool

Exist reports whether the given account address exists in the state. Notably this also returns true for self-destructed accounts.

func (*StateDB) Finalise added in v1.6.2 

func (s *StateDB) Finalise(deleteEmptyObjects bool)

Finalise finalises the state by removing the destructed objects and clears the journal as well as the refunds. Finalise, however, will not push any updates into the tries just yet. Only IntermediateRoot or Commit will do that.

func (*StateDB) GetBalance 

func (s *StateDB) GetBalance(addr common.Address) *uint256.Int

GetBalance retrieves the balance from the given address or 0 if object not found

func (*StateDB) GetCode 

func (s *StateDB) GetCode(addr common.Address) []byte

func (*StateDB) GetCodeHash added in v1.4.8 

func (s *StateDB) GetCodeHash(addr common.Address) common.Hash

func (*StateDB) GetCodeSize added in v1.4.13 

func (s *StateDB) GetCodeSize(addr common.Address) int

func (*StateDB) GetCommittedState added in v1.8.16 

func (s *StateDB) GetCommittedState(addr common.Address, hash common.Hash) common.Hash

GetCommittedState retrieves the value associated with the specific key without any mutations caused in the current execution.

func (*StateDB) GetLogs 

func (s *StateDB) GetLogs(hash common.Hash, blockNumber uint64, blockHash common.Hash) []*types.Log

GetLogs returns the logs matching the specified transaction hash, and annotates them with the given blockNumber and blockHash.

func (*StateDB) GetNonce 

func (s *StateDB) GetNonce(addr common.Address) uint64

GetNonce retrieves the nonce from the given address or 0 if object not found

func (*StateDB) GetRefund added in v1.3.1 

func (s *StateDB) GetRefund() uint64

GetRefund returns the current value of the refund counter.

func (*StateDB) GetState 

func (s *StateDB) GetState(addr common.Address, hash common.Hash) common.Hash

GetState retrieves the value associated with the specific key.

func (*StateDB) GetStorageRoot added in v1.13.0 

func (s *StateDB) GetStorageRoot(addr common.Address) common.Hash

GetStorageRoot retrieves the storage root from the given address or empty if object not found.

func (*StateDB) GetTransientState added in v1.11.0 

func (s *StateDB) GetTransientState(addr common.Address, key common.Hash) common.Hash

GetTransientState gets transient storage for a given account.

func (*StateDB) GetTrie added in v1.14.0 

func (s *StateDB) GetTrie() Trie

GetTrie returns the account trie.

func (*StateDB) HasSelfDestructed added in v1.12.1 

func (s *StateDB) HasSelfDestructed(addr common.Address) bool

func (*StateDB) IntermediateRoot added in v1.3.1 

func (s *StateDB) IntermediateRoot(deleteEmptyObjects bool) common.Hash

IntermediateRoot computes the current root hash of the state trie. It is called in between transactions to get the root hash that goes into transaction receipts.

func (*StateDB) IterativeDump added in v1.9.0 

func (s *StateDB) IterativeDump(opts *DumpConfig, output *json.Encoder)

IterativeDump dumps out accounts as json-objects, delimited by linebreaks on stdout

func (*StateDB) Logs 

func (s *StateDB) Logs() []*types.Log

func (*StateDB) PointCache added in v1.14.4 

func (s *StateDB) PointCache() *utils.PointCache

PointCache returns the point cache used by verkle tree.

func (*StateDB) Preimages added in v1.5.8 

func (s *StateDB) Preimages() map[common.Hash][]byte

Preimages returns a list of SHA3 preimages that have been submitted.

func (*StateDB) Prepare added in v1.6.2 

func (s *StateDB) Prepare(rules params.Rules, sender, coinbase common.Address, dst *common.Address, precompiles []common.Address, list types.AccessList)

Prepare handles the preparatory steps for executing a state transition with. This method must be invoked before state transition.

Berlin fork: - Add sender to access list (2929) - Add destination to access list (2929) - Add precompiles to access list (2929) - Add the contents of the optional tx access list (2930)

Potential EIPs: - Reset access list (Berlin) - Add coinbase to access list (EIP-3651) - Reset transient storage (EIP-1153)

func (*StateDB) RawDump 

func (s *StateDB) RawDump(opts *DumpConfig) Dump

RawDump returns the state. If the processing is aborted e.g. due to options reaching Max, the `Next` key is set on the returned Dump.

func (*StateDB) RevertToSnapshot added in v1.4.16 

func (s *StateDB) RevertToSnapshot(revid int)

RevertToSnapshot reverts all state changes made since the given revision.

func (*StateDB) SelfDestruct added in v1.12.1 

func (s *StateDB) SelfDestruct(addr common.Address)

SelfDestruct marks the given account as selfdestructed. This clears the account balance.

The account's state object is still available until the state is committed, getStateObject will return a non-nil account after SelfDestruct.

func (*StateDB) Selfdestruct6780 added in v1.12.1 

func (s *StateDB) Selfdestruct6780(addr common.Address)

func (*StateDB) SetBalance added in v1.4.16 

func (s *StateDB) SetBalance(addr common.Address, amount *uint256.Int, reason tracing.BalanceChangeReason)

func (*StateDB) SetCode 

func (s *StateDB) SetCode(addr common.Address, code []byte)

func (*StateDB) SetLogger added in v1.14.0 

func (s *StateDB) SetLogger(l *tracing.Hooks)

SetLogger sets the logger for account update hooks.

func (*StateDB) SetNonce 

func (s *StateDB) SetNonce(addr common.Address, nonce uint64)

func (*StateDB) SetState 

func (s *StateDB) SetState(addr common.Address, key, value common.Hash)

func (*StateDB) SetStorage added in v1.9.2 

func (s *StateDB) SetStorage(addr common.Address, storage map[common.Hash]common.Hash)

SetStorage replaces the entire storage for the specified account with given storage. This function should only be used for debugging and the mutations must be discarded afterwards.

func (*StateDB) SetTransientState added in v1.11.0 

func (s *StateDB) SetTransientState(addr common.Address, key, value common.Hash)

SetTransientState sets transient storage for a given account. It adds the change to the journal so that it can be rolled back to its previous value if there is a revert.

func (*StateDB) SetTxContext added in v1.11.0 

func (s *StateDB) SetTxContext(thash common.Hash, ti int)

SetTxContext sets the current transaction hash and index which are used when the EVM emits new state logs. It should be invoked before transaction execution.

func (*StateDB) SlotInAccessList added in v1.9.24 

func (s *StateDB) SlotInAccessList(addr common.Address, slot common.Hash) (addressPresent bool, slotPresent bool)

SlotInAccessList returns true if the given (address, slot)-tuple is in the access list.

func (*StateDB) Snapshot added in v1.4.16 

func (s *StateDB) Snapshot() int

Snapshot returns an identifier for the current revision of the state.

func (*StateDB) StartPrefetcher added in v1.10.0 

func (s *StateDB) StartPrefetcher(namespace string, witness *stateless.Witness)

StartPrefetcher initializes a new trie prefetcher to pull in nodes from the state trie concurrently while the state is mutated so that when we reach the commit phase, most of the needed data is already hot.

func (*StateDB) StopPrefetcher added in v1.10.0 

func (s *StateDB) StopPrefetcher()

StopPrefetcher terminates a running prefetcher and reports any leftover stats from the gathered metrics.

func (*StateDB) SubBalance added in v1.5.5 

func (s *StateDB) SubBalance(addr common.Address, amount *uint256.Int, reason tracing.BalanceChangeReason)

SubBalance subtracts amount from the account associated with addr.

func (*StateDB) SubRefund added in v1.8.16 

func (s *StateDB) SubRefund(gas uint64)

SubRefund removes gas from the refund counter. This method will panic if the refund counter goes below zero

func (*StateDB) TxIndex added in v1.9.0 

func (s *StateDB) TxIndex() int

TxIndex returns the current transaction index set by SetTxContext.

func (*StateDB) Witness added in v1.14.6 

func (s *StateDB) Witness() *stateless.Witness

Witness retrieves the current state witness being collected.

type Storage 

type Storage map[common.Hash]common.Hash

func (Storage) Copy 

func (s Storage) Copy() Storage

type Trie added in v1.6.7 

type Trie interface {
	// GetKey returns the sha3 preimage of a hashed key that was previously used
	// to store a value.
	//
	// TODO(fjl): remove this when StateTrie is removed
	GetKey([]byte) []byte

	// GetAccount abstracts an account read from the trie. It retrieves the
	// account blob from the trie with provided account address and decodes it
	// with associated decoding algorithm. If the specified account is not in
	// the trie, nil will be returned. If the trie is corrupted(e.g. some nodes
	// are missing or the account blob is incorrect for decoding), an error will
	// be returned.
	GetAccount(address common.Address) (*types.StateAccount, error)

	// GetStorage returns the value for key stored in the trie. The value bytes
	// must not be modified by the caller. If a node was not found in the database,
	// a trie.MissingNodeError is returned.
	GetStorage(addr common.Address, key []byte) ([]byte, error)

	// UpdateAccount abstracts an account write to the trie. It encodes the
	// provided account object with associated algorithm and then updates it
	// in the trie with provided address.
	UpdateAccount(address common.Address, account *types.StateAccount, codeLen int) error

	// UpdateStorage associates key with value in the trie. If value has length zero,
	// any existing value is deleted from the trie. The value bytes must not be modified
	// by the caller while they are stored in the trie. If a node was not found in the
	// database, a trie.MissingNodeError is returned.
	UpdateStorage(addr common.Address, key, value []byte) error

	// DeleteAccount abstracts an account deletion from the trie.
	DeleteAccount(address common.Address) error

	// DeleteStorage removes any existing value for key from the trie. If a node
	// was not found in the database, a trie.MissingNodeError is returned.
	DeleteStorage(addr common.Address, key []byte) error

	// UpdateContractCode abstracts code write to the trie. It is expected
	// to be moved to the stateWriter interface when the latter is ready.
	UpdateContractCode(address common.Address, codeHash common.Hash, code []byte) error

	// Hash returns the root hash of the trie. It does not write to the database and
	// can be used even if the trie doesn't have one.
	Hash() common.Hash

	// Commit collects all dirty nodes in the trie and replace them with the
	// corresponding node hash. All collected nodes(including dirty leaves if
	// collectLeaf is true) will be encapsulated into a nodeset for return.
	// The returned nodeset can be nil if the trie is clean(nothing to commit).
	// Once the trie is committed, it's not usable anymore. A new trie must
	// be created with new root and updated trie database for following usage
	Commit(collectLeaf bool) (common.Hash, *trienode.NodeSet)

	// Witness returns a set containing all trie nodes that have been accessed.
	// The returned map could be nil if the witness is empty.
	Witness() map[string]struct{}

	// NodeIterator returns an iterator that returns nodes of the trie. Iteration
	// starts at the key after the given start key. And error will be returned
	// if fails to create node iterator.
	NodeIterator(startKey []byte) (trie.NodeIterator, error)

	// Prove constructs a Merkle proof for key. The result contains all encoded nodes
	// on the path to the value at key. The value itself is also included in the last
	// node and can be retrieved by verifying the proof.
	//
	// If the trie does not contain a value for key, the returned proof contains all
	// nodes of the longest existing prefix of the key (at least the root), ending
	// with the node that proves the absence of the key.
	Prove(key []byte, proofDb ethdb.KeyValueWriter) error

	// IsVerkle returns true if the trie is verkle-tree based
	IsVerkle() bool
}

Trie is a Ethereum Merkle Patricia trie.

Source Files

View all Source files

Directories

Path Synopsis
Package snapshot implements a journalled, dynamic state dump.
 Package snapshot implements a journalled, dynamic state dump.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.