go-ethereum: github.com/ethereum/go-ethereum/core/state Index | Files | Directories

package state

import "github.com/ethereum/go-ethereum/core/state"

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


Package Files

access_list.go database.go dump.go iterator.go journal.go state_object.go statedb.go sync.go trie_prefetcher.go

func NewStateSync Uses

func NewStateSync(root common.Hash, database ethdb.KeyValueReader, bloom *trie.SyncBloom) *trie.Sync

NewStateSync create a new state trie download scheduler.

type Account Uses

type Account struct {
    Nonce    uint64
    Balance  *big.Int
    Root     common.Hash // merkle root of the storage trie
    CodeHash []byte

Account is the Ethereum consensus representation of accounts. These objects are stored in the main account trie.

type Code Uses

type Code []byte

func (Code) String Uses

func (c Code) String() string

type Database Uses

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

    // OpenStorageTrie opens the storage trie of an account.
    OpenStorageTrie(addrHash, 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(addrHash, codeHash common.Hash) ([]byte, error)

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

    // TrieDB retrieves the low level trie database used for data storage.
    TrieDB() *trie.Database

Database wraps access to tries and contract code.

func NewDatabase Uses

func NewDatabase(db ethdb.Database) Database

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 Uses

func NewDatabaseWithConfig(db ethdb.Database, config *trie.Config) Database

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 Uses

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.

func (*Dump) OnAccount Uses

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

OnAccount implements DumpCollector interface

func (*Dump) OnRoot Uses

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

OnRoot implements DumpCollector interface

type DumpAccount Uses

type DumpAccount struct {
    Balance   string                 `json:"balance"`
    Nonce     uint64                 `json:"nonce"`
    Root      string                 `json:"root"`
    CodeHash  string                 `json:"codeHash"`
    Code      string                 `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 Uses

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

DumpCollector interface which the state trie calls during iteration

type IteratorDump Uses

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 Uses

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

OnAccount implements DumpCollector interface

func (*IteratorDump) OnRoot Uses

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

OnRoot implements DumpCollector interface

type NodeIterator Uses

type NodeIterator struct {
    Hash   common.Hash // Hash of the current entry being iterated (nil if not standalone)
    Parent common.Hash // Hash of the first full ancestor node (nil if current is the root)

    Error error // Failure set in case of an internal error in the iterator
    // contains filtered or unexported fields

NodeIterator is an iterator to traverse the entire state trie post-order, including all of the contract code and contract state tries.

func NewNodeIterator Uses

func NewNodeIterator(state *StateDB) *NodeIterator

NewNodeIterator creates an post-order state node iterator.

func (*NodeIterator) Next Uses

func (it *NodeIterator) Next() bool

Next moves the iterator to the next node, returning whether there are any further nodes. In case of an internal error this method returns false and sets the Error field to the encountered failure.

type StateDB Uses

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
    // 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

func New Uses

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

New creates a new state from a given trie.

func (*StateDB) AddAddressToAccessList Uses

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

AddAddressToAccessList adds the given address to the access list

func (*StateDB) AddBalance Uses

func (s *StateDB) AddBalance(addr common.Address, amount *big.Int)

AddBalance adds amount to the account associated with addr.

func (*StateDB) AddLog Uses

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

func (*StateDB) AddPreimage Uses

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

AddPreimage records a SHA3 preimage seen by the VM.

func (*StateDB) AddRefund Uses

func (s *StateDB) AddRefund(gas uint64)

AddRefund adds gas to the refund counter

func (*StateDB) AddSlotToAccessList Uses

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

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

func (*StateDB) AddressInAccessList Uses

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

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

func (*StateDB) BlockHash Uses

func (s *StateDB) BlockHash() common.Hash

BlockHash returns the current block hash set by Prepare.

func (*StateDB) Commit Uses

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

Commit writes the state to the underlying in-memory trie database.

func (*StateDB) Copy Uses

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 Uses

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

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:

1. sends funds to sha(account ++ (nonce + 1))
2. 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 Uses

func (s *StateDB) Database() Database

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

func (*StateDB) Dump Uses

func (s *StateDB) Dump(excludeCode, excludeStorage, excludeMissingPreimages bool) []byte

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

func (*StateDB) DumpToCollector Uses

func (s *StateDB) DumpToCollector(c DumpCollector, excludeCode, excludeStorage, excludeMissingPreimages bool, start []byte, maxResults int) (nextKey []byte)

func (*StateDB) Empty Uses

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 Uses

func (s *StateDB) Error() error

func (*StateDB) Exist Uses

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 suicided accounts.

func (*StateDB) Finalise Uses

func (s *StateDB) Finalise(deleteEmptyObjects bool)

Finalise finalises the state by removing the s 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 Uses

func (db *StateDB) ForEachStorage(addr common.Address, cb func(key, value common.Hash) bool) error

func (*StateDB) GetBalance Uses

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

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

func (*StateDB) GetCode Uses

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

func (*StateDB) GetCodeHash Uses

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

func (*StateDB) GetCodeSize Uses

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

func (*StateDB) GetCommittedState Uses

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

GetCommittedState retrieves a value from the given account's committed storage trie.

func (*StateDB) GetLogs Uses

func (s *StateDB) GetLogs(hash common.Hash) []*types.Log

func (*StateDB) GetNonce Uses

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

func (*StateDB) GetOrNewStateObject Uses

func (s *StateDB) GetOrNewStateObject(addr common.Address) *stateObject

GetOrNewStateObject retrieves a state object or create a new state object if nil.

func (*StateDB) GetProof Uses

func (s *StateDB) GetProof(addr common.Address) ([][]byte, error)

GetProof returns the Merkle proof for a given account.

func (*StateDB) GetProofByHash Uses

func (s *StateDB) GetProofByHash(addrHash common.Hash) ([][]byte, error)

GetProofByHash returns the Merkle proof for a given account.

func (*StateDB) GetRefund Uses

func (s *StateDB) GetRefund() uint64

GetRefund returns the current value of the refund counter.

func (*StateDB) GetState Uses

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

GetState retrieves a value from the given account's storage trie.

func (*StateDB) GetStorageProof Uses

func (s *StateDB) GetStorageProof(a common.Address, key common.Hash) ([][]byte, error)

GetStorageProof returns the Merkle proof for given storage slot.

func (*StateDB) GetStorageProofByHash Uses

func (s *StateDB) GetStorageProofByHash(a common.Address, key common.Hash) ([][]byte, error)

GetStorageProofByHash returns the Merkle proof for given storage slot.

func (*StateDB) HasSuicided Uses

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

func (*StateDB) IntermediateRoot Uses

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 Uses

func (s *StateDB) IterativeDump(excludeCode, excludeStorage, excludeMissingPreimages bool, output *json.Encoder)

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

func (*StateDB) IteratorDump Uses

func (s *StateDB) IteratorDump(excludeCode, excludeStorage, excludeMissingPreimages bool, start []byte, maxResults int) IteratorDump

IteratorDump dumps out a batch of accounts starts with the given start key

func (*StateDB) Logs Uses

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

func (*StateDB) Preimages Uses

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

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

func (*StateDB) Prepare Uses

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

Prepare sets the current transaction hash and index and block hash which is used when the EVM emits new state logs.

func (*StateDB) RawDump Uses

func (s *StateDB) RawDump(excludeCode, excludeStorage, excludeMissingPreimages bool) Dump

RawDump returns the entire state an a single large object

func (*StateDB) RevertToSnapshot Uses

func (s *StateDB) RevertToSnapshot(revid int)

RevertToSnapshot reverts all state changes made since the given revision.

func (*StateDB) SetBalance Uses

func (s *StateDB) SetBalance(addr common.Address, amount *big.Int)

func (*StateDB) SetCode Uses

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

func (*StateDB) SetNonce Uses

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

func (*StateDB) SetState Uses

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

func (*StateDB) SetStorage Uses

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.

func (*StateDB) SlotInAccessList Uses

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 Uses

func (s *StateDB) Snapshot() int

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

func (*StateDB) StartPrefetcher Uses

func (s *StateDB) StartPrefetcher(namespace string)

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 Uses

func (s *StateDB) StopPrefetcher()

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

func (*StateDB) StorageTrie Uses

func (s *StateDB) StorageTrie(addr common.Address) Trie

StorageTrie returns the storage trie of an account. The return value is a copy and is nil for non-existent accounts.

func (*StateDB) SubBalance Uses

func (s *StateDB) SubBalance(addr common.Address, amount *big.Int)

SubBalance subtracts amount from the account associated with addr.

func (*StateDB) SubRefund Uses

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) Suicide Uses

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

Suicide marks the given account as suicided. 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 Suicide.

func (*StateDB) TxIndex Uses

func (s *StateDB) TxIndex() int

TxIndex returns the current transaction index set by Prepare.

type Storage Uses

type Storage map[common.Hash]common.Hash

func (Storage) Copy Uses

func (s Storage) Copy() Storage

func (Storage) String Uses

func (s Storage) String() (str string)

type Trie Uses

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 SecureTrie is removed
    GetKey([]byte) []byte

    // TryGet 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.
    TryGet(key []byte) ([]byte, error)

    // TryUpdate 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.
    TryUpdate(key, value []byte) error

    // TryDelete removes any existing value for key from the trie. If a node was not
    // found in the database, a trie.MissingNodeError is returned.
    TryDelete(key []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 writes all nodes to the trie's memory database, tracking the internal
    // and external (for account tries) references.
    Commit(onleaf trie.LeafCallback) (common.Hash, error)

    // NodeIterator returns an iterator that returns nodes of the trie. Iteration
    // starts at the key after the given start key.
    NodeIterator(startKey []byte) trie.NodeIterator

    // 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, fromLevel uint, proofDb ethdb.KeyValueWriter) error

Trie is a Ethereum Merkle Patricia trie.


snapshotPackage snapshot implements a journalled, dynamic state dump.

Package state imports 22 packages (graph) and is imported by 2524 packages. Updated 2021-01-26. Refresh now. Tools for package owners.