state

package
v0.13.9-rc.3-acp118-no... Latest Latest
Warning

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

 Go to latest Published: Dec 18, 2024 License: GPL-3.0, LGPL-3.0 Imports: 33 Imported by: 35

Documentation

Overview

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

(c) 2023, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewTestStateDB added in v0.12.10 

func NewTestStateDB(t testing.TB) contract.StateDB

func NormalizeCoinID 

func NormalizeCoinID(coinID *common.Hash)

NormalizeCoinID ORs the 0th bit of the first byte in [coinID], which ensures this bit will be 1 and all other bits are left the same. This partitions multicoin storage from normal state storage.

func NormalizeStateKey 

func NormalizeStateKey(key *common.Hash)

NormalizeStateKey ANDs the 0th bit of the first byte in [key], which ensures this bit will be 0 and all other bits are left the same. This partitions normal state storage from multicoin storage.

Types

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(stateRoot common.Hash, address common.Address, root common.Hash, trie Trie) (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 returns the underlying trie database for managing trie nodes.
	TrieDB() *triedb.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, but does not retain any recent trie nodes in memory. To keep some historical state in memory, use the NewDatabaseWithConfig constructor.

func NewDatabaseWithConfig added in v0.5.0 

func NewDatabaseWithConfig(db ethdb.Database, config *triedb.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.

func NewDatabaseWithNodeDB added in v0.12.3 

func NewDatabaseWithNodeDB(db ethdb.Database, triedb *triedb.Database) Database

NewDatabaseWithNodeDB creates a state database with an already initialized node database.

type Dump 

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 v0.3.1 

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

OnAccount implements DumpCollector interface

func (*Dump) OnRoot added in v0.3.1 

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"`
	IsMultiCoin bool                   `json:"isMultiCoin"`
	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 v0.3.1 

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 v0.6.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 state will be iterated and collected.

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 New 

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

New creates a new state from a given trie.

func NewWithSnapshot added in v0.5.6 

func NewWithSnapshot(root common.Hash, db Database, snap snapshot.Snapshot) (*StateDB, error)

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 added in v0.5.0 

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)

AddBalance adds amount to the account associated with addr.

func (*StateDB) AddBalanceMultiCoin 

func (s *StateDB) AddBalanceMultiCoin(addr common.Address, coinID common.Hash, amount *big.Int)

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 

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

AddPreimage records a SHA3 preimage seen by the VM.

func (*StateDB) AddRefund 

func (s *StateDB) AddRefund(gas uint64)

AddRefund adds gas to the refund counter

func (*StateDB) AddSlotToAccessList added in v0.5.0 

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 v0.5.0 

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

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

func (*StateDB) Commit 

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

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

func (*StateDB) CommitWithSnap added in v0.5.6 

func (s *StateDB) CommitWithSnap(block uint64, deleteEmptyObjects bool, snaps *snapshot.Tree, blockHash, parentHash common.Hash) (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 

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 v0.3.1 

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

Error returns the memorized database failure occurred earlier.

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 self-destructed accounts.

func (*StateDB) Finalise 

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

func (s *StateDB) GetBalanceMultiCoin(addr common.Address, coinID common.Hash) *big.Int

Retrieve 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 

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, hash common.Hash) common.Hash

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

func (*StateDB) GetCommittedStateAP1 added in v0.4.0 

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

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

func (*StateDB) GetLogData added in v0.12.10 

func (s *StateDB) GetLogData() ([][]common.Hash, [][]byte)

GetLogData returns the underlying topics and data from each log included in the StateDB Test helper function.

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) GetPredicateStorageSlots added in v0.12.10 

func (s *StateDB) GetPredicateStorageSlots(address common.Address, index int) ([]byte, bool)

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) 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, hash common.Hash) common.Hash

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

func (*StateDB) GetStorageRoot added in v0.13.3 

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 v0.12.3 

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

GetTransientState gets transient storage for a given account.

func (*StateDB) GetTxHash added in v0.12.10 

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

GetTxHash returns the current tx hash on the StateDB set by SetTxContext.

func (*StateDB) HasSelfDestructed added in v0.13.2 

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

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 

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) 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(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 (aka ApricotPhase2): - 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/ApricotPhase2) - 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 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 

func (s *StateDB) RevertToSnapshot(revid int)

RevertToSnapshot reverts all state changes made since the given revision.

func (*StateDB) SelfDestruct added in v0.13.2 

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 v0.13.2 

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

func (*StateDB) SetBalance 

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

func (*StateDB) SetBalanceMultiCoin 

func (s *StateDB) SetBalanceMultiCoin(addr common.Address, coinID common.Hash, amount *big.Int)

func (*StateDB) SetCode 

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

func (*StateDB) SetNonce 

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

func (*StateDB) SetPredicateStorageSlots added in v0.12.10 

func (s *StateDB) SetPredicateStorageSlots(address common.Address, predicates [][]byte)

SetPredicateStorageSlots sets the predicate storage slots for the given address

func (*StateDB) SetState 

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

func (*StateDB) SetStorage 

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 v0.12.3 

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 v0.12.3 

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 v0.5.0 

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) StartPrefetcher added in v0.5.0 

func (s *StateDB) StartPrefetcher(namespace string, maxConcurrency int)

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 v0.5.0 

func (s *StateDB) StopPrefetcher()

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

func (*StateDB) SubBalance 

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

SubBalance subtracts amount from the account associated with addr.

func (*StateDB) SubBalanceMultiCoin 

func (s *StateDB) SubBalanceMultiCoin(addr common.Address, coinID common.Hash, 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 set the refund counter to 0 if the gas is greater than the current refund.

func (*StateDB) TxIndex 

func (s *StateDB) TxIndex() int

TxIndex returns the current transaction index set by Prepare.

type Storage 

type Storage map[common.Hash]common.Hash

func (Storage) Copy 

func (s Storage) Copy() Storage

func (Storage) String 

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

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

	// 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) 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, 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.

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.