state

package
v1.4.2 Latest Latest
Warning

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

 Go to latest Published: Oct 18, 2023 License: GPL-3.0 Imports: 25 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewStateSync 

func NewStateSync(root common.Hash, database ethdb.KeyValueReader, bloom *trie.SyncBloom, onLeaf func(paths [][]byte, leaf []byte) error) *trie.Sync

NewStateSync create a new state trie download scheduler.

Types

type Account 

type Account struct {
	Nonce            uint64
	Balance          *big.Int
	Root             common.Hash // merkle root of the storage trie
	CodeHash         []byte
	StorageKeyPrefix []byte // A prefix added to the `key` to ensure that data between different accounts are not shared
}

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

type Code 

type Code []byte

func (Code) String 

func (c Code) String() string

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(addrHash, root common.Hash) (Trie, error)

	// CopyTrie returns an independent copy of the given trie.
	CopyTrie(Trie) Trie

	NewTrie(t 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 

func NewDatabase(db ethdb.Database) Database

NewDatabase creates a backing store for state. The returned database is safe for concurrent use and retains a few recent expanded trie nodes in memory. To keep more historical state in memory, use the NewDatabaseWithCache constructor.

func NewDatabaseWithConfig added in v1.3.2 

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

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.

func (*Dump) OnAccount added in v1.3.0 

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

OnAccount implements DumpCollector interface

func (*Dump) OnRoot added in v1.3.0 

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

OnRoot implements DumpCollector interface

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 added in v1.3.0 

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.3.0 

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 statewill be iterated and collected.

type IteratorDump added in v1.3.0 

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 added in v1.3.0 

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

OnAccount implements DumpCollector interface

func (*IteratorDump) OnRoot added in v1.3.0 

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

OnRoot implements DumpCollector interface

type ManagedState 

type ManagedState struct {
	*StateDB
	// contains filtered or unexported fields
}

func ManageState 

func ManageState(statedb *StateDB) *ManagedState

ManagedState returns a new managed state with the statedb as it's backing layer

func (*ManagedState) GetNonce 

func (ms *ManagedState) GetNonce(addr common.Address) uint64

GetNonce returns the canonical nonce for the managed or unmanaged account.

Because GetNonce mutates the DB, we must take a write lock.

func (*ManagedState) HasAccount 

func (ms *ManagedState) HasAccount(addr common.Address) bool

HasAccount returns whether the given address is managed or not

func (*ManagedState) NewNonce 

func (ms *ManagedState) NewNonce(addr common.Address) uint64

NewNonce returns the new canonical nonce for the managed account

func (*ManagedState) RemoveNonce 

func (ms *ManagedState) RemoveNonce(addr common.Address, n uint64)

RemoveNonce removed the nonce from the managed state and all future pending nonces

func (*ManagedState) SetNonce 

func (ms *ManagedState) SetNonce(addr common.Address, nonce uint64)

SetNonce sets the new canonical nonce for the managed state

func (*ManagedState) SetState 

func (ms *ManagedState) SetState(statedb *StateDB)

SetState sets the backing layer of the managed state

type NodeIterator 

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 

func NewNodeIterator(state *StateDB) *NodeIterator

NewNodeIterator creates an post-order state node iterator.

func (*NodeIterator) Next 

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 ParallelStateObject added in v1.0.0 

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

func NewParallelStateObject added in v1.0.0 

func NewParallelStateObject(stateObject *stateObject, createFlag bool) *ParallelStateObject

func (*ParallelStateObject) AddBalance added in v1.0.0 

func (parallelObject *ParallelStateObject) AddBalance(amount *big.Int)

func (*ParallelStateObject) GetBalance added in v1.0.0 

func (parallelObject *ParallelStateObject) GetBalance() *big.Int

func (*ParallelStateObject) GetNonce added in v1.0.0 

func (parallelObject *ParallelStateObject) GetNonce() uint64

func (*ParallelStateObject) SetNonce added in v1.0.0 

func (parallelObject *ParallelStateObject) SetNonce(nonce uint64)

func (*ParallelStateObject) SubBalance added in v1.0.0 

func (parallelObject *ParallelStateObject) SubBalance(amount *big.Int)

func (*ParallelStateObject) UpdateRoot added in v1.0.0 

func (parallelObject *ParallelStateObject) UpdateRoot()

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

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

New creates a new state from a given trie.

func (*StateDB) AddAddressToAccessList added in v1.3.2 

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 *big.Int)

AddBalance adds amount to the account associated with addr.

func (*StateDB) AddLog 

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

func (*StateDB) AddMinerEarnings added in v1.0.0 

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

func (*StateDB) AddPreimage 

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

AddPreimage records a SHA3 preimage seen by the VM.

func (*StateDB) AddReferenceFunc added in v0.7.3 

func (s *StateDB) AddReferenceFunc(fn func()) int

Add childrent statedb reference

func (*StateDB) AddRefund 

func (s *StateDB) AddRefund(gas uint64)

AddRefund adds gas to the refund counter

func (*StateDB) AddSlotToAccessList added in v1.3.2 

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.3.2 

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

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

func (*StateDB) BlockHash added in v1.0.0 

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

BlockHash returns the current block hash set by Prepare.

func (*StateDB) ClearIndexReference added in v1.0.0 

func (s *StateDB) ClearIndexReference(index int)

Clear reference by index

func (*StateDB) ClearParentReference added in v1.0.0 

func (s *StateDB) ClearParentReference()

Clear Parent reference

func (*StateDB) ClearReference added in v0.7.3 

func (s *StateDB) ClearReference()

Clear reference when StateDB is committed

func (*StateDB) Commit 

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

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

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

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.3.0 

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 

func (s *StateDB) Error() error

func (*StateDB) Exist 

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 

func (s *StateDB) Finalise(deleteEmptyObjects bool)

Finalise finalises the state by removing the self 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 (db *StateDB) ForEachStorage(addr common.Address, cb func(key, value []byte) bool)

func (*StateDB) GetBalance 

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) GetByte added in v0.7.0 

func (s *StateDB) GetByte(addr common.Address, key []byte) byte

func (*StateDB) GetCode 

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

func (*StateDB) GetCodeHash 

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

func (*StateDB) GetCodeSize 

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

func (*StateDB) GetCommittedState 

func (s *StateDB) GetCommittedState(addr common.Address, key []byte) []byte

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

func (*StateDB) GetCurrentActiveVersion added in v1.1.0 

func (s *StateDB) GetCurrentActiveVersion() uint32

func (*StateDB) GetFloat32 added in v0.7.0 

func (s *StateDB) GetFloat32(addr common.Address, key []byte) float32

func (*StateDB) GetFloat64 added in v0.7.0 

func (s *StateDB) GetFloat64(addr common.Address, key []byte) float64

func (*StateDB) GetInt32 added in v0.7.0 

func (s *StateDB) GetInt32(addr common.Address, key []byte) int32

func (*StateDB) GetInt64 added in v0.7.0 

func (s *StateDB) GetInt64(addr common.Address, key []byte) int64

func (*StateDB) GetLogs 

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

func (*StateDB) GetNonce 

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

func (*StateDB) GetOrNewParallelStateObject added in v1.0.0 

func (self *StateDB) GetOrNewParallelStateObject(addr common.Address) *ParallelStateObject

func (*StateDB) GetOrNewStateObject 

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

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

func (*StateDB) GetProof added in v1.0.0 

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

GetProof returns the Merkle proof for a given account.

func (*StateDB) GetProofByHash added in v1.4.1 

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

GetProofByHash returns the Merkle proof for a given account.

func (*StateDB) GetRefund 

func (s *StateDB) GetRefund() uint64

GetRefund returns the current value of the refund counter.

func (*StateDB) GetState 

func (s *StateDB) GetState(addr common.Address, key []byte) []byte

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

func (*StateDB) GetStorageProof added in v1.0.0 

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

GetStorageProof returns the Merkle proof for given storage slot.

func (*StateDB) GetStorageProofByHash added in v1.4.1 

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

GetStorageProofByHash returns the Merkle proof for given storage slot.

func (*StateDB) GetString added in v0.7.0 

func (s *StateDB) GetString(addr common.Address, key []byte) string

func (*StateDB) HadParent added in v0.7.3 

func (s *StateDB) HadParent() bool

func (*StateDB) HasSuicided 

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

func (*StateDB) IncreaseTxIdx added in v1.0.0 

func (s *StateDB) IncreaseTxIdx()

func (*StateDB) IntermediateRoot 

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.3.0 

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

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

func (*StateDB) IteratorDump added in v1.3.0 

func (s *StateDB) IteratorDump(opts *DumpConfig) IteratorDump

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

func (*StateDB) ListActiveVersion added in v1.1.0 

func (s *StateDB) ListActiveVersion() ([]gov.ActiveVersionValue, error)

Obtain version information maintained by governance

func (*StateDB) Logs 

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

func (*StateDB) Merge added in v1.0.0 

func (s *StateDB) Merge(idx int, from, to *ParallelStateObject, deleteEmptyObjects bool)

func (*StateDB) MigrateStorage added in v1.0.0 

func (db *StateDB) MigrateStorage(from, to common.Address)

func (*StateDB) NewStateDB added in v0.7.3 

func (s *StateDB) NewStateDB() *StateDB

New StateDB based on the parent StateDB

func (*StateDB) Preimages 

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

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

func (*StateDB) Prepare 

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) PrepareAccessList added in v1.4.1 

func (s *StateDB) PrepareAccessList(sender common.Address, dst *common.Address, precompiles []common.Address, list types.AccessList)

PrepareAccessList handles the preparatory steps for executing a state transition with regards to both EIP-2929 and EIP-2930:

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

This method should only be called if Yolov3/Berlin/2929+2930 is applicable at the current number.

func (*StateDB) RawDump 

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

RawDump returns the entire state an a single large object

func (*StateDB) Reset 

func (s *StateDB) Reset(root common.Hash) error

Reset clears out all ephemeral state objects from the state db, but keeps the underlying state trie to avoid reloading data for the next operations.

func (*StateDB) RevertToSnapshot 

func (s *StateDB) RevertToSnapshot(revid int)

RevertToSnapshot reverts all state changes made since the given revision.

func (*StateDB) Root added in v0.7.0 

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

func (*StateDB) SetBalance 

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

func (*StateDB) SetByte added in v0.7.0 

func (s *StateDB) SetByte(addr common.Address, key []byte, value byte)

func (*StateDB) SetCode 

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

func (*StateDB) SetFloat32 added in v0.7.0 

func (s *StateDB) SetFloat32(addr common.Address, key []byte, value float32)

func (*StateDB) SetFloat64 added in v0.7.0 

func (s *StateDB) SetFloat64(addr common.Address, key []byte, value float64)

func (*StateDB) SetInt32 added in v0.7.0 

func (s *StateDB) SetInt32(addr common.Address, key []byte, value int32)

func (*StateDB) SetInt64 added in v0.7.0 

func (s *StateDB) SetInt64(addr common.Address, key []byte, value int64)

func (*StateDB) SetNonce 

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

func (*StateDB) SetState 

func (s *StateDB) SetState(address common.Address, key, value []byte)

func (*StateDB) SetStorage added in v1.1.3 

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) SetString added in v0.7.0 

func (s *StateDB) SetString(addr common.Address, key []byte, value string)

func (*StateDB) SlotInAccessList added in v1.3.2 

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 

func (s *StateDB) Snapshot() int

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

func (*StateDB) StorageTrie 

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 

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

SubBalance subtracts amount from the account associated with addr.

func (*StateDB) SubRefund 

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 

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) TxHash added in v0.7.0 

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

func (*StateDB) TxIdx added in v0.7.0 

func (s *StateDB) TxIdx() uint32

func (*StateDB) TxIndex added in v1.0.0 

func (s *StateDB) TxIndex() int

TxIndex returns the current transaction index set by Prepare.

func (*StateDB) UpdateSnaps added in v1.4.1 

func (s *StateDB) UpdateSnaps() error

Since the execution and submission of the block are parallel the snapshot needs to be updated before the state is committed.

type Trie 

type Trie interface {
	TryGet(key []byte) ([]byte, error)
	TryUpdate(key, value []byte) error
	TryDelete(key []byte) error
	Commit(onleaf trie.LeafCallback) (common.Hash, error)
	Hash() common.Hash
	NodeIterator(startKey []byte) trie.NodeIterator
	GetKey([]byte) []byte // TODO(fjl): remove this when SecureTrie is removed
	Prove(key []byte, fromLevel uint, proofDb ethdb.KeyValueWriter) error
}

Trie is a Ethereum Merkle Trie.

type ValueStorage added in v0.7.0 

type ValueStorage map[string][]byte

func (ValueStorage) Copy added in v0.7.0 

func (self ValueStorage) Copy() ValueStorage

func (ValueStorage) String added in v1.0.0 

func (self ValueStorage) String() (str string)

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.