Version: v2.2.26+incompatible Latest Latest

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

Go to latest
Published: Jan 22, 2019 License: GPL-3.0 Imports: 17 Imported by: 112



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



This section is empty.


View Source
var MaxTrieCacheGen = uint16(120)

Trie cache generation limit after which to evict trie nodes from memory.


func NewStateSync

func NewStateSync(root common.Hash, database trie.DatabaseReader) *trie.Sync

NewStateSync create a new state trie download scheduler.


type Account

type Account struct {
	Nonce    uint64
	Balance  *big.Int
	Root     common.Hash // merkle root of the storage trie
	CodeHash common.Hash

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

func (*Account) EncodeRLP

func (a *Account) EncodeRLP(w io.Writer) error

EncodeRLP implements rlp.Encoder.

func (*Account) MarshalRLP

func (a *Account) MarshalRLP() (_ []byte, err error)

MarshalRLP returns an RLP encoded byte slice.

func (*Account) RLPSize

func (a *Account) RLPSize() int

type Code

type Code []byte

func (Code) String

func (self 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

	// 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 common.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 NewDatabaseWithCache

func NewDatabaseWithCache(db common.Database, cache int) Database

NewDatabase creates a backing store for state. The returned database is safe for concurrent use and retains both a few recent expanded trie nodes in memory, as well as a lot of collapsed RLP trie nodes in a large memory cache.

type Dump

type Dump struct {
	Root     string                 `json:"root"`
	Accounts map[string]DumpAccount `json:"accounts"`

type DumpAccount

type DumpAccount struct {
	Balance  string            `json:"balance"`
	Nonce    uint64            `json:"nonce"`
	Root     string            `json:"root"`
	CodeHash string            `json:"codeHash"`
	Code     string            `json:"code"`
	Storage  map[string]string `json:"storage"`

type ManagedState

type ManagedState struct {
	// contains filtered or unexported fields

func ManageState

func ManageState(ctx context.Context, 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 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 New

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

Create a new state from a given trie.

func (*StateDB) AddBalance

func (db *StateDB) AddBalance(addr common.Address, amount *big.Int)

AddBalance adds amount to the account associated with addr

func (*StateDB) AddLog

func (db *StateDB) AddLog(log *types.Log)

func (*StateDB) AddPreimage

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

AddPreimage records a SHA3 preimage seen by the VM.

func (*StateDB) AddRefund

func (db *StateDB) AddRefund(gas uint64)

AddRefund adds gas to the refund counter.

func (*StateDB) Commit

func (db *StateDB) Commit(deleteEmptyObjects bool) (root common.Hash, err error)

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

func (*StateDB) Copy

func (db *StateDB) Copy(ctx context.Context) *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 (db *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 (db *StateDB) Database() Database

Database retrieves the low level database supporting the lower level trie ops.

func (*StateDB) Dump

func (db *StateDB) Dump() []byte

func (*StateDB) Empty

func (db *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) Exist

func (db *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 (db *StateDB) Finalise(deleteEmptyObjects bool)

Finalise finalises the state by removing the self destructed objects and clears the journal as well as the refunds.

func (*StateDB) ForEachStorage

func (db *StateDB) ForEachStorage(addr common.Address, cb func(key, value common.Hash) bool)

func (*StateDB) GetBalance

func (db *StateDB) GetBalance(addr common.Address) *big.Int

Retrieve the balance from the given address or 0 if object not found.

func (*StateDB) GetBalanceErr

func (db *StateDB) GetBalanceErr(addr common.Address) (*big.Int, error)

Retrieve the balance from the given address or an error.

func (*StateDB) GetCode

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

func (*StateDB) GetCodeErr

func (db *StateDB) GetCodeErr(addr common.Address) ([]byte, error)

func (*StateDB) GetCodeHash

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

func (*StateDB) GetCodeSize

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

func (*StateDB) GetCommittedState

func (db *StateDB) GetCommittedState(addr common.Address, hash common.Hash) common.Hash

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

func (*StateDB) GetLogs

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

func (*StateDB) GetNonce

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

func (*StateDB) GetNonceErr

func (db *StateDB) GetNonceErr(addr common.Address) (uint64, error)

func (*StateDB) GetOrNewStateObject

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

Retrieve a state object or create a new state object if nil

func (*StateDB) GetProof

func (self *StateDB) GetProof(a common.Address) ([][]byte, error)

GetProof returns the MerkleProof for a given Account

func (*StateDB) GetRefund

func (db *StateDB) GetRefund() uint64

GetRefund returns the current value of the refund counter.

func (*StateDB) GetState

func (db *StateDB) GetState(a common.Address, b common.Hash) common.Hash

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

func (*StateDB) GetStateErr

func (db *StateDB) GetStateErr(addr common.Address, hash common.Hash) (common.Hash, error)

func (*StateDB) GetStorageProof

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

GetProof returns the StorageProof for given key

func (*StateDB) HasSuicided

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

func (*StateDB) IntermediateRoot

func (db *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) Logs

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

func (*StateDB) Preimages

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

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

func (*StateDB) Prepare

func (db *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) RawDump

func (db *StateDB) RawDump() Dump

func (*StateDB) Reset

func (db *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 (db *StateDB) RevertToSnapshot(revid int)

RevertToSnapshot reverts all state changes made since the given revision.

func (*StateDB) SetBalance

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

func (*StateDB) SetCode

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

func (*StateDB) SetNonce

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

func (*StateDB) SetState

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

func (*StateDB) Snapshot

func (db *StateDB) Snapshot() int

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

func (*StateDB) StorageTrie

func (db *StateDB) StorageTrie(a 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 (db *StateDB) SubBalance(addr common.Address, amount *big.Int)

SubBalance subtracts amount from the account associated with addr

func (*StateDB) SubRefund

func (db *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 (db *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.

type Storage

type Storage map[common.Hash]common.Hash

func (Storage) Copy

func (self Storage) Copy() Storage

func (Storage) String

func (self Storage) String() (str string)

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 common.Putter) error

Trie is a Ethereum Merkle Trie.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL