Documentation ¶
Overview ¶
Package state provides a caching layer atop the Ethereum state trie.
Index ¶
- func NewStateSync(root common.Hash, database ethdb.KeyValueReader, bloom *trie.SyncBloom) *trie.Sync
- type Account
- type Code
- type Database
- type Dump
- type DumpAccount
- type ManagedState
- func (ms *ManagedState) GetNonce(addr common.Address) uint64
- func (ms *ManagedState) HasAccount(addr common.Address) bool
- func (ms *ManagedState) NewNonce(addr common.Address) uint64
- func (ms *ManagedState) RemoveNonce(addr common.Address, n uint64)
- func (ms *ManagedState) SetNonce(addr common.Address, nonce uint64)
- func (ms *ManagedState) SetState(statedb *StateDB)
- type NodeIterator
- type ParallelStateObject
- func (parallelObject *ParallelStateObject) AddBalance(amount *big.Int)
- func (parallelObject *ParallelStateObject) GetBalance() *big.Int
- func (parallelObject *ParallelStateObject) GetNonce() uint64
- func (parallelObject *ParallelStateObject) SetNonce(nonce uint64)
- func (parallelObject *ParallelStateObject) SubBalance(amount *big.Int)
- func (parallelObject *ParallelStateObject) UpdateRoot()
- type StateDB
- func (self *StateDB) AddBalance(addr common.Address, amount *big.Int)
- func (self *StateDB) AddLog(logInfo *types.Log)
- func (s *StateDB) AddMinerEarnings(addr common.Address, amount *big.Int)
- func (self *StateDB) AddPreimage(hash common.Hash, preimage []byte)
- func (self *StateDB) AddReferenceFunc(fn func()) int
- func (self *StateDB) AddRefund(gas uint64)
- func (self *StateDB) BlockHash() common.Hash
- func (self *StateDB) ClearIndexReference(index int)
- func (self *StateDB) ClearParentReference()
- func (self *StateDB) ClearReference()
- func (s *StateDB) Commit(deleteEmptyObjects bool) (root common.Hash, err error)
- func (self *StateDB) Copy() *StateDB
- func (self *StateDB) CreateAccount(addr common.Address)
- func (self *StateDB) Database() Database
- func (self *StateDB) Dump() []byte
- func (self *StateDB) Empty(addr common.Address) bool
- func (self *StateDB) Error() error
- func (self *StateDB) Exist(addr common.Address) bool
- func (s *StateDB) Finalise(deleteEmptyObjects bool)
- func (db *StateDB) ForEachStorage(addr common.Address, cb func(key, value []byte) bool)
- func (self *StateDB) GetBalance(addr common.Address) *big.Int
- func (self *StateDB) GetByte(addr common.Address, key []byte) byte
- func (self *StateDB) GetCode(addr common.Address) []byte
- func (self *StateDB) GetCodeHash(addr common.Address) common.Hash
- func (self *StateDB) GetCodeSize(addr common.Address) int
- func (self *StateDB) GetCommittedState(addr common.Address, key []byte) []byte
- func (self *StateDB) GetCurrentActiveVersion() uint32
- func (self *StateDB) GetFloat32(addr common.Address, key []byte) float32
- func (self *StateDB) GetFloat64(addr common.Address, key []byte) float64
- func (self *StateDB) GetInt32(addr common.Address, key []byte) int32
- func (self *StateDB) GetInt64(addr common.Address, key []byte) int64
- func (self *StateDB) GetLogs(hash common.Hash) []*types.Log
- func (self *StateDB) GetNonce(addr common.Address) uint64
- func (self *StateDB) GetOrNewParallelStateObject(addr common.Address) *ParallelStateObject
- func (self *StateDB) GetOrNewStateObject(addr common.Address) *stateObject
- func (s *StateDB) GetProof(a common.Address) ([][]byte, error)
- func (self *StateDB) GetRefund() uint64
- func (self *StateDB) GetState(addr common.Address, key []byte) []byte
- func (s *StateDB) GetStorageProof(a common.Address, key common.Hash) ([][]byte, error)
- func (self *StateDB) GetString(addr common.Address, key []byte) string
- func (self *StateDB) HadParent() bool
- func (self *StateDB) HasSuicided(addr common.Address) bool
- func (self *StateDB) IncreaseTxIdx()
- func (s *StateDB) IntermediateRoot(deleteEmptyObjects bool) common.Hash
- func (self *StateDB) ListActiveVersion() ([]gov.ActiveVersionValue, error)
- func (self *StateDB) Logs() []*types.Log
- func (s *StateDB) Merge(idx int, from, to *ParallelStateObject, deleteEmptyObjects bool)
- func (db *StateDB) MigrateStorage(from, to common.Address)
- func (self *StateDB) NewStateDB() *StateDB
- func (self *StateDB) Preimages() map[common.Hash][]byte
- func (self *StateDB) Prepare(thash, bhash common.Hash, ti int)
- func (self *StateDB) RawDump() Dump
- func (self *StateDB) Reset(root common.Hash) error
- func (self *StateDB) RevertToSnapshot(revid int)
- func (s *StateDB) Root() common.Hash
- func (self *StateDB) SetBalance(addr common.Address, amount *big.Int)
- func (self *StateDB) SetByte(addr common.Address, key []byte, value byte)
- func (self *StateDB) SetCode(addr common.Address, code []byte)
- func (self *StateDB) SetFloat32(addr common.Address, key []byte, value float32)
- func (self *StateDB) SetFloat64(addr common.Address, key []byte, value float64)
- func (self *StateDB) SetInt32(addr common.Address, key []byte, value int32)
- func (self *StateDB) SetInt64(addr common.Address, key []byte, value int64)
- func (self *StateDB) SetNonce(addr common.Address, nonce uint64)
- func (self *StateDB) SetState(address common.Address, key, value []byte)
- func (self *StateDB) SetStorage(addr common.Address, storage map[common.Hash]common.Hash)
- func (self *StateDB) SetString(addr common.Address, key []byte, value string)
- func (self *StateDB) Snapshot() int
- func (self *StateDB) StorageTrie(addr common.Address) Trie
- func (self *StateDB) SubBalance(addr common.Address, amount *big.Int)
- func (self *StateDB) SubRefund(gas uint64)
- func (self *StateDB) Suicide(addr common.Address) bool
- func (self *StateDB) TxHash() common.Hash
- func (self *StateDB) TxIdx() uint32
- func (self *StateDB) TxIndex() int
- type Trie
- type ValueStorage
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewStateSync ¶
func NewStateSync(root common.Hash, database ethdb.KeyValueReader, bloom *trie.SyncBloom) *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 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 ¶
NewDatabase creates a backing store for state. The returned database is safe for concurrent use and retains cached trie nodes in memory. The pool is an optional intermediate trie-node memory pool between the low level storage layer and the high level trie abstraction.
type Dump ¶
type Dump struct { Root string `json:"root"` Accounts map[string]DumpAccount `json:"accounts"` }
type DumpAccount ¶
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 // contains filtered or unexported fields }
StateDBs 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 (*StateDB) AddBalance ¶
AddBalance adds amount to the account associated with addr.
func (*StateDB) AddMinerEarnings ¶ added in v1.0.0
func (*StateDB) AddPreimage ¶
AddPreimage records a SHA3 preimage seen by the VM.
func (*StateDB) AddReferenceFunc ¶ added in v0.7.3
Add childrent statedb reference
func (*StateDB) BlockHash ¶ added in v1.0.0
BlockHash returns the current block hash set by Prepare.
func (*StateDB) ClearIndexReference ¶ added in v1.0.0
Clear reference by index
func (*StateDB) ClearParentReference ¶ added in v1.0.0
func (self *StateDB) ClearParentReference()
Clear Parent reference
func (*StateDB) ClearReference ¶ added in v0.7.3
func (self *StateDB) ClearReference()
Clear reference when StateDB is committed
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) 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 suicided accounts.
func (*StateDB) Finalise ¶
Finalise finalises the state by removing the self destructed objects and clears the journal as well as the refunds.
func (*StateDB) ForEachStorage ¶
func (*StateDB) GetBalance ¶
Retrieve 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) GetCurrentActiveVersion ¶ added in v1.1.0
func (*StateDB) GetFloat32 ¶ added in v0.7.0
func (*StateDB) GetFloat64 ¶ added in v0.7.0
func (*StateDB) GetOrNewParallelStateObject ¶ added in v1.0.0
func (self *StateDB) GetOrNewParallelStateObject(addr common.Address) *ParallelStateObject
func (*StateDB) GetOrNewStateObject ¶
Retrieve a state object or create a new state object if nil.
func (*StateDB) GetStorageProof ¶ added in v1.0.0
GetProof returns the StorageProof for given key
func (*StateDB) IncreaseTxIdx ¶ added in v1.0.0
func (self *StateDB) IncreaseTxIdx()
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) ListActiveVersion ¶ added in v1.1.0
func (self *StateDB) ListActiveVersion() ([]gov.ActiveVersionValue, error)
Obtain version information maintained by governance
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 (*StateDB) NewStateDB ¶ added in v0.7.3
New StateDB based on the parent StateDB
func (*StateDB) Prepare ¶
Prepare sets the current transaction hash and index and block hash which is used when the EVM emits new state logs.
func (*StateDB) Reset ¶
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 ¶
RevertToSnapshot reverts all state changes made since the given revision.
func (*StateDB) SetFloat32 ¶ added in v0.7.0
func (*StateDB) SetFloat64 ¶ added in v0.7.0
func (*StateDB) SetStorage ¶ added in v1.1.3
SetStorage replaces the entire storage for the specified account with given storage. This function should only be used for debugging.
func (*StateDB) StorageTrie ¶
StorageTrie returns the storage trie of an account. The return value is a copy and is nil for non-existent accounts.
func (*StateDB) SubBalance ¶
SubBalance subtracts amount from the account associated with addr.
func (*StateDB) SubRefund ¶
SubRefund removes gas from the refund counter. This method will panic if the refund counter goes below zero
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) ParallelCommit(onleaf trie.LeafCallback) (common.Hash, error) Hash() common.Hash ParallelHash() 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
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)