Documentation ¶
Overview ¶
Package state provides a caching layer atop the Ethereum state trie.
Index ¶
- func NewTestStateDB(t testing.TB) contract.StateDB
- type Code
- type Database
- type Dump
- type DumpAccount
- type DumpCollector
- type DumpConfig
- type IteratorDump
- type StateDB
- func (s *StateDB) AddAddressToAccessList(addr common.Address)
- func (s *StateDB) AddBalance(addr common.Address, amount *big.Int)
- func (s *StateDB) AddLog(addr common.Address, topics []common.Hash, data []byte, blockNumber uint64)
- func (s *StateDB) AddPreimage(hash common.Hash, preimage []byte)
- func (s *StateDB) AddRefund(gas uint64)
- func (s *StateDB) AddSlotToAccessList(addr common.Address, slot common.Hash)
- func (s *StateDB) AddressInAccessList(addr common.Address) bool
- func (s *StateDB) Commit(block uint64, deleteEmptyObjects bool, referenceRoot bool) (common.Hash, error)
- func (s *StateDB) CommitWithSnap(block uint64, deleteEmptyObjects bool, snaps *snapshot.Tree, ...) (common.Hash, error)
- func (s *StateDB) Copy() *StateDB
- func (s *StateDB) CreateAccount(addr common.Address)
- func (s *StateDB) Database() Database
- func (s *StateDB) Dump(opts *DumpConfig) []byte
- func (s *StateDB) DumpToCollector(c DumpCollector, conf *DumpConfig) (nextKey []byte)
- func (s *StateDB) Empty(addr common.Address) bool
- func (s *StateDB) Error() error
- func (s *StateDB) Exist(addr common.Address) bool
- func (s *StateDB) Finalise(deleteEmptyObjects bool)
- func (s *StateDB) ForEachStorage(addr common.Address, cb func(key, value common.Hash) bool) error
- func (s *StateDB) GetBalance(addr common.Address) *big.Int
- func (s *StateDB) GetCode(addr common.Address) []byte
- func (s *StateDB) GetCodeHash(addr common.Address) common.Hash
- func (s *StateDB) GetCodeSize(addr common.Address) int
- func (s *StateDB) GetCommittedState(addr common.Address, hash common.Hash) common.Hash
- func (s *StateDB) GetLogData() ([][]common.Hash, [][]byte)
- func (s *StateDB) GetLogs(hash common.Hash, blockNumber uint64, blockHash common.Hash) []*types.Log
- func (s *StateDB) GetNonce(addr common.Address) uint64
- func (s *StateDB) GetOrNewStateObject(addr common.Address) *stateObject
- func (s *StateDB) GetPredicateStorageSlots(address common.Address, index int) ([]byte, bool)
- func (s *StateDB) GetProof(addr common.Address) ([][]byte, error)
- func (s *StateDB) GetProofByHash(addrHash common.Hash) ([][]byte, error)
- func (s *StateDB) GetRefund() uint64
- func (s *StateDB) GetState(addr common.Address, hash common.Hash) common.Hash
- func (s *StateDB) GetStorageProof(a common.Address, key common.Hash) ([][]byte, error)
- func (s *StateDB) GetTransientState(addr common.Address, key common.Hash) common.Hash
- func (s *StateDB) GetTxHash() common.Hash
- func (s *StateDB) HasSelfDestructed(addr common.Address) bool
- func (s *StateDB) IntermediateRoot(deleteEmptyObjects bool) common.Hash
- func (s *StateDB) IterativeDump(opts *DumpConfig, output *json.Encoder)
- func (s *StateDB) IteratorDump(opts *DumpConfig) IteratorDump
- func (s *StateDB) Logs() []*types.Log
- func (s *StateDB) Preimages() map[common.Hash][]byte
- func (s *StateDB) Prepare(rules params.Rules, sender, coinbase common.Address, dst *common.Address, ...)
- func (s *StateDB) RawDump(opts *DumpConfig) Dump
- func (s *StateDB) RevertToSnapshot(revid int)
- func (s *StateDB) SelfDestruct(addr common.Address)
- func (s *StateDB) Selfdestruct6780(addr common.Address)
- func (s *StateDB) SetBalance(addr common.Address, amount *big.Int)
- func (s *StateDB) SetCode(addr common.Address, code []byte)
- func (s *StateDB) SetNonce(addr common.Address, nonce uint64)
- func (s *StateDB) SetPredicateStorageSlots(address common.Address, predicates [][]byte)
- func (s *StateDB) SetState(addr common.Address, key, value common.Hash)
- func (s *StateDB) SetStorage(addr common.Address, storage map[common.Hash]common.Hash)
- func (s *StateDB) SetTransientState(addr common.Address, key, value common.Hash)
- func (s *StateDB) SetTxContext(thash common.Hash, ti int)
- func (s *StateDB) SlotInAccessList(addr common.Address, slot common.Hash) (addressPresent bool, slotPresent bool)
- func (s *StateDB) Snapshot() int
- func (s *StateDB) StartPrefetcher(namespace string, maxConcurrency int)
- func (s *StateDB) StopPrefetcher()
- func (s *StateDB) StorageTrie(addr common.Address) (Trie, error)
- func (s *StateDB) SubBalance(addr common.Address, amount *big.Int)
- func (s *StateDB) SubRefund(gas uint64)
- func (s *StateDB) TxIndex() int
- type Storage
- type Trie
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Database ¶
type Database interface { // 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, error) // CopyTrie returns an independent copy of the given trie. CopyTrie(Trie) Trie // 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) // DiskDB returns the underlying key-value disk database. DiskDB() ethdb.KeyValueStore // TrieDB retrieves the low level trie database used for data storage. TrieDB() *trie.Database }
Database wraps access to tries and contract code.
func NewDatabase ¶
NewDatabase creates a backing store for state. The returned database is safe for concurrent use, but does not retain any recent trie nodes in memory. To keep some historical state in memory, use the NewDatabaseWithConfig constructor.
func NewDatabaseWithConfig ¶
NewDatabaseWithConfig creates a backing store for state. The returned database is safe for concurrent use and retains a lot of collapsed RLP trie nodes in a large memory cache.
type Dump ¶
type Dump struct { Root string `json:"root"` Accounts map[common.Address]DumpAccount `json:"accounts"` }
Dump represents the full dump in a collected format, as one large map.
type DumpAccount ¶
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 SecureKey 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 ¶
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 ¶
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 IteratorDump ¶
type IteratorDump struct { Root string `json:"root"` Accounts map[common.Address]DumpAccount `json:"accounts"` Next []byte `json:"next,omitempty"` // nil if no more accounts }
IteratorDump is an implementation for iterating over data.
func (*IteratorDump) OnAccount ¶
func (d *IteratorDump) OnAccount(addr *common.Address, account DumpAccount)
OnAccount implements DumpCollector interface
func (*IteratorDump) OnRoot ¶
func (d *IteratorDump) OnRoot(root common.Hash)
OnRoot implements DumpCollector interface
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 StorageHashes time.Duration StorageUpdates time.Duration StorageCommits time.Duration SnapshotAccountReads time.Duration SnapshotStorageReads time.Duration SnapshotCommits time.Duration TrieDBCommits time.Duration AccountUpdated int StorageUpdated int AccountDeleted int StorageDeleted int // 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 NewWithSnapshot ¶
NewWithSnapshot creates a new state from a given trie with the specified [snap] If [snap] doesn't have the same root as [root], then NewWithSnapshot will return an error. If snap is nil, then no snapshot will be used and CommitWithSnapshot cannot be called on the returned StateDB.
func (*StateDB) AddAddressToAccessList ¶
AddAddressToAccessList adds the given address to the access list
func (*StateDB) AddBalance ¶
AddBalance adds amount to the account associated with addr.
func (*StateDB) AddLog ¶
func (s *StateDB) AddLog(addr common.Address, topics []common.Hash, data []byte, blockNumber uint64)
AddLog adds a log with the specified parameters to the statedb Note: blockNumber is a required argument because StateDB does not know the current block number.
func (*StateDB) AddPreimage ¶
AddPreimage records a SHA3 preimage seen by the VM.
func (*StateDB) AddSlotToAccessList ¶
AddSlotToAccessList adds the given (address, slot)-tuple to the access list
func (*StateDB) AddressInAccessList ¶
AddressInAccessList returns true if the given address is in the access list.
func (*StateDB) Commit ¶
func (s *StateDB) Commit(block uint64, deleteEmptyObjects bool, referenceRoot bool) (common.Hash, error)
Commit writes the state to the underlying in-memory trie database.
func (*StateDB) CommitWithSnap ¶
func (s *StateDB) CommitWithSnap(block uint64, deleteEmptyObjects bool, snaps *snapshot.Tree, blockHash, parentHash common.Hash, referenceRoot bool) (common.Hash, error)
CommitWithSnap writes the state to the underlying in-memory trie database and generates a snapshot layer for the newly committed state.
func (*StateDB) Copy ¶
Copy creates a deep, independent copy of the state. Snapshots of the copied state cannot be applied to the copy.
func (*StateDB) CreateAccount ¶
CreateAccount explicitly creates a state object. If a state object with the address already exists the balance is carried over to the new account.
CreateAccount is called during the EVM CREATE operation. The situation might arise that a contract does the following:
- sends funds to sha(account ++ (nonce + 1))
- tx_create(sha(account ++ nonce)) (note that this gets the address of 1)
Carrying over the balance ensures that Ether doesn't disappear.
func (*StateDB) 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 ¶
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 ¶
Empty returns whether the state object is either non-existent or empty according to the EIP161 specification (balance = nonce = code = 0)
func (*StateDB) Exist ¶
Exist reports whether the given account address exists in the state. Notably this also returns true for self-destructed accounts.
func (*StateDB) Finalise ¶
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) ForEachStorage ¶
func (*StateDB) GetBalance ¶
GetBalance retrieves the balance from the given address or 0 if object not found
func (*StateDB) GetCommittedState ¶
GetCommittedState retrieves a value from the given account's committed storage trie.
func (*StateDB) GetLogData ¶
GetLogData returns the underlying topics and data from each log included in the StateDB Test helper function.
func (*StateDB) GetLogs ¶
GetLogs returns the logs matching the specified transaction hash, and annotates them with the given blockNumber and blockHash.
func (*StateDB) GetOrNewStateObject ¶
GetOrNewStateObject retrieves a state object or create a new state object if nil.
func (*StateDB) GetPredicateStorageSlots ¶
GetPredicateStorageSlots returns the storage slots associated with the address, index pair. A list of access tuples can be included within transaction types post EIP-2930. The address is declared directly on the access tuple and the index is the i'th occurrence of an access tuple with the specified address.
Ex. AccessList[[AddrA, Predicate1], [AddrB, Predicate2], [AddrA, Predicate3]] In this case, the caller could retrieve predicates 1-3 with the following calls: GetPredicateStorageSlots(AddrA, 0) -> Predicate1 GetPredicateStorageSlots(AddrB, 0) -> Predicate2 GetPredicateStorageSlots(AddrA, 1) -> Predicate3
func (*StateDB) GetProofByHash ¶
GetProofByHash returns the Merkle proof for a given account.
func (*StateDB) GetStorageProof ¶
GetStorageProof returns the Merkle proof for given storage slot.
func (*StateDB) GetTransientState ¶
GetTransientState gets transient storage for a given account.
func (*StateDB) GetTxHash ¶
GetTxHash returns the current tx hash on the StateDB set by SetTxContext.
func (*StateDB) IntermediateRoot ¶
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 ¶
func (s *StateDB) IterativeDump(opts *DumpConfig, output *json.Encoder)
IterativeDump dumps out accounts as json-objects, delimited by linebreaks on stdout
func (*StateDB) IteratorDump ¶
func (s *StateDB) IteratorDump(opts *DumpConfig) IteratorDump
IteratorDump dumps out a batch of accounts starts with the given start key
func (*StateDB) Prepare ¶
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/Durango) - Reset transient storage (EIP-1153)
func (*StateDB) RawDump ¶
func (s *StateDB) RawDump(opts *DumpConfig) Dump
RawDump returns the entire state an a single large object
func (*StateDB) RevertToSnapshot ¶
RevertToSnapshot reverts all state changes made since the given revision.
func (*StateDB) SelfDestruct ¶
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 ¶
func (*StateDB) SetPredicateStorageSlots ¶
SetPredicateStorageSlots sets the predicate storage slots for the given address
func (*StateDB) SetStorage ¶
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 ¶
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 ¶
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 ¶
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) StartPrefetcher ¶
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 ¶
func (s *StateDB) StopPrefetcher()
StopPrefetcher terminates a running prefetcher and reports any leftover stats from the gathered metrics.
func (*StateDB) StorageTrie ¶
StorageTrie returns the storage trie of an account. The return value is a copy and is nil for non-existent accounts. An error will be returned if storage trie is existent but can't be loaded correctly.
func (*StateDB) SubBalance ¶
SubBalance subtracts amount from the account associated with addr.
type Trie ¶
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 // 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) // 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) // 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 // 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) 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 // 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 // DeleteAccount abstracts an account deletion from the trie. DeleteAccount(address common.Address) 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, error) // 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 }
Trie is a Ethereum Merkle Patricia trie.