Documentation ¶
Overview ¶
Package state provides a caching layer atop the Ethereum state trie.
Index ¶
- Variables
- type Account
- type Code
- 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 StateDB
- func (self *StateDB) AddBalance(addr common.Address, amount *big.Int)
- func (self *StateDB) AddLog(log *vm.Log)
- func (self *StateDB) AddRefund(gas *big.Int)
- func (s *StateDB) Commit() (root common.Hash, err error)
- func (s *StateDB) CommitBatch() (root common.Hash, batch ethdb.Batch)
- func (self *StateDB) Copy() *StateDB
- func (self *StateDB) CreateAccount(addr common.Address) vm.Account
- func (self *StateDB) CreateStateObject(addr common.Address) *StateObject
- func (self *StateDB) Delete(addr common.Address) bool
- func (self *StateDB) DeleteStateObject(stateObject *StateObject)
- func (s *StateDB) DeleteSuicides()
- func (self *StateDB) Dump() []byte
- func (self *StateDB) Exist(addr common.Address) bool
- func (self *StateDB) GetAccount(addr common.Address) vm.Account
- func (self *StateDB) GetBalance(addr common.Address) *big.Int
- 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) GetLogs(hash common.Hash) vm.Logs
- func (self *StateDB) GetNonce(addr common.Address) uint64
- func (self *StateDB) GetOrNewStateObject(addr common.Address) *StateObject
- func (self *StateDB) GetRefund() *big.Int
- func (self *StateDB) GetState(a common.Address, b common.Hash) common.Hash
- func (self *StateDB) GetStateObject(addr common.Address) (stateObject *StateObject)
- func (self *StateDB) HasAccount(addr common.Address) bool
- func (s *StateDB) IntermediateRoot() common.Hash
- func (self *StateDB) IsDeleted(addr common.Address) bool
- func (self *StateDB) Logs() vm.Logs
- func (self *StateDB) MarkStateObjectDirty(addr common.Address)
- func (self *StateDB) New(root common.Hash) (*StateDB, error)
- func (self *StateDB) RawDump() Dump
- func (self *StateDB) Refunds() *big.Int
- func (self *StateDB) Reset(root common.Hash) error
- func (self *StateDB) Set(state *StateDB)
- func (self *StateDB) SetCode(addr common.Address, code []byte)
- func (self *StateDB) SetNonce(addr common.Address, nonce uint64)
- func (self *StateDB) SetState(addr common.Address, key common.Hash, value common.Hash)
- func (self *StateDB) SetStateObject(object *StateObject)
- func (self *StateDB) StartRecord(thash, bhash common.Hash, ti int)
- func (self *StateDB) UpdateStateObject(stateObject *StateObject)
- type StateObject
- func (c *StateObject) AddBalance(amount *big.Int)
- func (c *StateObject) Address() common.Address
- func (self *StateObject) Balance() *big.Int
- func (self *StateObject) Code(db trie.Database) []byte
- func (self *StateObject) CodeHash() []byte
- func (self *StateObject) CommitTrie(db trie.Database, dbw trie.DatabaseWriter) error
- func (self *StateObject) Copy(db trie.Database, onDirty func(addr common.Address)) *StateObject
- func (c *StateObject) EncodeRLP(w io.Writer) error
- func (self *StateObject) ForEachStorage(cb func(key, value common.Hash) bool)
- func (self *StateObject) GetState(db trie.Database, key common.Hash) common.Hash
- func (self *StateObject) MarkForDeletion()
- func (self *StateObject) Nonce() uint64
- func (c *StateObject) ReturnGas(gas, price *big.Int)
- func (self *StateObject) SetBalance(amount *big.Int)
- func (self *StateObject) SetCode(codeHash common.Hash, code []byte)
- func (self *StateObject) SetNonce(nonce uint64)
- func (self *StateObject) SetState(key, value common.Hash)
- func (c *StateObject) SubBalance(amount *big.Int)
- func (self *StateObject) UpdateRoot(db trie.Database)
- func (self *StateObject) Value() *big.Int
- type StateSync
- type Storage
Constants ¶
This section is empty.
Variables ¶
var StartingNonce uint64
The starting nonce determines the default nonce when new accounts are being created.
Functions ¶
This section is empty.
Types ¶
type Account ¶
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 Dump ¶ added in v1.4.13
type Dump struct { Root string `json:"root"` Accounts map[string]DumpAccount `json:"accounts"` }
type DumpAccount ¶ added in v1.4.13
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
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 ¶ added in v1.4.0
type NodeIterator struct { Hash common.Hash // Hash of the current entry being iterated (nil if not standalone) Entry interface{} // Current state entry being iterated (internal representation) 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 ¶ added in v1.4.0
func NewNodeIterator(state *StateDB) *NodeIterator
NewNodeIterator creates an post-order state node iterator.
func (*NodeIterator) Next ¶ added in v1.4.0
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 ¶
type StateDB struct {
// 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) CommitBatch ¶ added in v1.3.1
CommitBatch commits all state changes to a write batch but does not execute the batch. It is used to validate state changes against the root hash stored in a block.
func (*StateDB) CreateStateObject ¶ added in v1.3.1
func (self *StateDB) CreateStateObject(addr common.Address) *StateObject
Creates creates a new state object and takes ownership.
func (*StateDB) DeleteStateObject ¶
func (self *StateDB) DeleteStateObject(stateObject *StateObject)
Delete the given state object and delete it from the state trie
func (*StateDB) DeleteSuicides ¶ added in v1.4.7
func (s *StateDB) DeleteSuicides()
DeleteSuicides flags the suicided objects for deletion so that it won't be referenced again when called / queried up on.
DeleteSuicides should not be used for consensus related updates under any circumstances.
func (*StateDB) GetAccount ¶ added in v1.3.1
func (*StateDB) GetBalance ¶
Retrieve the balance from the given address or 0 if object not found
func (*StateDB) GetCodeHash ¶ added in v1.4.8
func (*StateDB) GetCodeSize ¶ added in v1.4.13
func (*StateDB) GetOrNewStateObject ¶
func (self *StateDB) GetOrNewStateObject(addr common.Address) *StateObject
Retrieve a state object or create a new state object if nil
func (*StateDB) GetStateObject ¶
func (self *StateDB) GetStateObject(addr common.Address) (stateObject *StateObject)
Retrieve a state object given my the address. Returns nil if not found.
func (*StateDB) IntermediateRoot ¶ added in v1.3.1
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) MarkStateObjectDirty ¶ added in v1.4.13
MarkStateObjectDirty adds the specified object to the dirty map to avoid costly state object cache iteration to find a handful of modified ones.
func (*StateDB) New ¶ added in v1.4.14
New creates a new statedb by reusing any journalled tries to avoid costly disk io.
func (*StateDB) Reset ¶
Reset clears out all emphemeral state objects from the state db, but keeps the underlying state trie to avoid reloading data for the next operations.
func (*StateDB) SetStateObject ¶
func (self *StateDB) SetStateObject(object *StateObject)
func (*StateDB) UpdateStateObject ¶
func (self *StateDB) UpdateStateObject(stateObject *StateObject)
Update the given state object and apply it to state trie
type StateObject ¶
type StateObject struct {
// contains filtered or unexported fields
}
StateObject represents an Ethereum account which is being modified.
The usage pattern is as follows: First you need to obtain a state object. Account values can be accessed and modified through the object. Finally, call CommitTrie to write the modified storage trie into a database.
func NewObject ¶ added in v1.4.13
func NewObject(address common.Address, data Account, onDirty func(addr common.Address)) *StateObject
NewObject creates a state object.
func (*StateObject) AddBalance ¶
func (c *StateObject) AddBalance(amount *big.Int)
func (*StateObject) Address ¶
func (c *StateObject) Address() common.Address
Returns the address of the contract/account
func (*StateObject) Balance ¶
func (self *StateObject) Balance() *big.Int
func (*StateObject) Code ¶
func (self *StateObject) Code(db trie.Database) []byte
Code returns the contract code associated with this object, if any.
func (*StateObject) CodeHash ¶
func (self *StateObject) CodeHash() []byte
func (*StateObject) CommitTrie ¶ added in v1.4.13
func (self *StateObject) CommitTrie(db trie.Database, dbw trie.DatabaseWriter) error
CommitTrie the storage trie of the object to dwb. This updates the trie root.
func (*StateObject) Copy ¶
func (self *StateObject) Copy(db trie.Database, onDirty func(addr common.Address)) *StateObject
func (*StateObject) EncodeRLP ¶ added in v1.4.0
func (c *StateObject) EncodeRLP(w io.Writer) error
EncodeRLP implements rlp.Encoder.
func (*StateObject) ForEachStorage ¶ added in v1.4.0
func (self *StateObject) ForEachStorage(cb func(key, value common.Hash) bool)
func (*StateObject) MarkForDeletion ¶
func (self *StateObject) MarkForDeletion()
func (*StateObject) Nonce ¶
func (self *StateObject) Nonce() uint64
func (*StateObject) ReturnGas ¶
func (c *StateObject) ReturnGas(gas, price *big.Int)
Return the gas back to the origin. Used by the Virtual machine or Closures
func (*StateObject) SetBalance ¶
func (self *StateObject) SetBalance(amount *big.Int)
func (*StateObject) SetNonce ¶
func (self *StateObject) SetNonce(nonce uint64)
func (*StateObject) SetState ¶
func (self *StateObject) SetState(key, value common.Hash)
SetState updates a value in account storage.
func (*StateObject) SubBalance ¶
func (c *StateObject) SubBalance(amount *big.Int)
func (*StateObject) UpdateRoot ¶ added in v1.4.13
func (self *StateObject) UpdateRoot(db trie.Database)
UpdateRoot sets the trie root to the current root hash of
func (*StateObject) Value ¶ added in v1.3.4
func (self *StateObject) Value() *big.Int
Never called, but must be present to allow StateObject to be used as a vm.Account interface that also satisfies the vm.ContractRef interface. Interfaces are awesome.
type StateSync ¶ added in v1.3.1
StateSync is the main state synchronisation scheduler, which provides yet the unknown state hashes to retrieve, accepts node data associated with said hashes and reconstructs the state database step by step until all is done.
func NewStateSync ¶ added in v1.3.1
NewStateSync create a new state trie download scheduler.
func (*StateSync) Missing ¶ added in v1.3.1
Missing retrieves the known missing nodes from the state trie for retrieval.