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 *types.Log)
- func (self *StateDB) AddRefund(gas *big.Int)
- func (s *StateDB) Commit(deleteEmptyObjects bool) (root common.Hash, err error)
- func (s *StateDB) CommitBatch(deleteEmptyObjects bool) (root common.Hash, batch ethdb.Batch)
- func (self *StateDB) Copy() *StateDB
- func (self *StateDB) CreateAccount(addr common.Address) vm.Account
- func (s *StateDB) DeleteSuicides()
- func (self *StateDB) Dump() []byte
- func (self *StateDB) Empty(addr common.Address) bool
- 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) []*types.Log
- 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) HasSuicided(addr common.Address) bool
- func (s *StateDB) IntermediateRoot(deleteEmptyObjects bool) common.Hash
- func (self *StateDB) Logs() []*types.Log
- func (self *StateDB) MarkStateObjectDirty(addr common.Address)
- func (self *StateDB) New(root common.Hash) (*StateDB, error)
- func (self *StateDB) RawDump() Dump
- func (self *StateDB) Reset(root common.Hash) error
- func (self *StateDB) RevertToSnapshot(revid int)
- func (self *StateDB) SetBalance(addr common.Address, amount *big.Int)
- 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) Snapshot() int
- func (self *StateDB) StartRecord(thash, bhash common.Hash, ti int)
- func (self *StateDB) SubBalance(addr common.Address, amount *big.Int)
- func (self *StateDB) Suicide(addr common.Address) bool
- 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 (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) Nonce() uint64
- func (c *StateObject) ReturnGas(gas *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(db trie.Database, key, value common.Hash)
- func (c *StateObject) SubBalance(amount *big.Int)
- func (self *StateObject) Value() *big.Int
- type StateSync
- type Storage
Constants ¶
This section is empty.
Variables ¶
var MaxTrieCacheGen = uint16(120)
Trie cache generation limit after which to evic trie nodes from memory.
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 ¶
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
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) 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 ¶
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 StateDB ¶
type StateDB struct {
// contains filtered or unexported fields
}
StateDBs within the ubiq 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) CommitBatch ¶
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) 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) DeleteSuicides ¶
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) 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) GetBalance ¶
Retrieve the balance from the given address or 0 if object not found
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) GetRefund ¶
GetRefund returns the current value of the refund counter. The return value must not be modified by the caller and will become invalid at the next call to AddRefund.
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 ¶
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 ¶
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 ¶
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) RevertToSnapshot ¶
RevertToSnapshot reverts all state changes made since the given revision.
func (*StateDB) SubBalance ¶
SubBalance subtracts amount from the account associated with addr
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 (*StateObject) AddBalance ¶
func (c *StateObject) AddBalance(amount *big.Int)
AddBalance removes amount from c's balance. It is used to add funds to the destination account of a transfer.
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 ¶
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) EncodeRLP ¶
func (c *StateObject) EncodeRLP(w io.Writer) error
EncodeRLP implements rlp.Encoder.
func (*StateObject) ForEachStorage ¶
func (self *StateObject) ForEachStorage(cb func(key, value common.Hash) bool)
func (*StateObject) Nonce ¶
func (self *StateObject) Nonce() uint64
func (*StateObject) ReturnGas ¶
func (c *StateObject) ReturnGas(gas *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(db trie.Database, key, value common.Hash)
SetState updates a value in account storage.
func (*StateObject) SubBalance ¶
func (c *StateObject) SubBalance(amount *big.Int)
SubBalance removes amount from c's balance. It is used to remove funds from the origin account of a transfer.
func (*StateObject) Value ¶
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 ¶
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 ¶
func NewStateSync(root common.Hash, database trie.DatabaseReader) *StateSync
NewStateSync create a new state trie download scheduler.
func (*StateSync) Missing ¶
Missing retrieves the known missing nodes from the state trie for retrieval.
func (*StateSync) Pending ¶
Pending returns the number of state entries currently pending for download.
func (*StateSync) Process ¶
func (s *StateSync) Process(list []trie.SyncResult, dbw trie.DatabaseWriter) (bool, int, error)
Process injects a batch of retrieved trie nodes data, returning if something was committed to the database and also the index of an entry if processing of it failed.