statedb

package module
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Jul 9, 2019 License: GPL-3.0, Apache-2.0 Imports: 17 Imported by: 4

README

statedb-NG

A stateDB implementation.

Build Status codecov

Getting started

Running it then should be as simple as:

$ make all
Testing
$ make test

Documentation

Overview

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

Index

Constants

View Source 
const (
	UnknownCode = CodeType(iota)
	SolidityCode
	WasmCode
)

Variables

This section is empty.

Functions

func NewStateSync 

func NewStateSync(root types.Hash, database ethdb.Reader) *trie.Sync

NewStateSync create a new state trie download scheduler.

Types

type Account 

type Account struct {
	Nonce    uint64
	Balance  *big.Int
	Root     types.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 Code 

type Code []byte

func (Code) String 

func (self Code) String() string

type CodeType added in v1.1.0 

type CodeType int

CodeType use to identify the contract code type(solidity or wasm)

type Database 

type Database interface {
	// OpenTrie opens the main account trie.
	OpenTrie(root types.Hash) (Trie, error)

	// OpenStorageTrie opens the storage trie of an account.
	OpenStorageTrie(addrHash, root types.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 types.Hash) ([]byte, error)

	// ContractCodeSize retrieves a particular contracts code's size.
	ContractCodeSize(addrHash, codeHash types.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 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 NewDatabaseWithCache constructor.

func NewDatabaseWithCache added in v1.0.0 

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

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

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 {
	*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 types.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 types.Address) bool

HasAccount returns whether the given address is managed or not

func (*ManagedState) NewNonce 

func (ms *ManagedState) NewNonce(addr types.Address) uint64

NewNonce returns the new canonical nonce for the managed account

func (*ManagedState) RemoveNonce 

func (ms *ManagedState) RemoveNonce(addr types.Address, n uint64)

RemoveNonce removed the nonce from the managed state and all future pending nonces

func (*ManagedState) SetNonce 

func (ms *ManagedState) SetNonce(addr types.Address, nonce uint64)

SetNonce sets the new canonical nonce for the managed state

func (*ManagedState) SetState 

func (ms *ManagedState) SetState(statedb *StateDB)

SetHashTypeState sets the backing layer of the managed state

type NodeIterator 

type NodeIterator struct {
	Hash   types.Hash // Hash of the current entry being iterated (nil if not standalone)
	Parent types.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 types.Hash, db Database) (*StateDB, error)

Create a new state from a given trie.

func (*StateDB) AddBalance 

func (self *StateDB) AddBalance(addr types.Address, amount *big.Int)

AddBalance adds amount to the account associated with addr.

func (*StateDB) AddLog 

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

func (*StateDB) AddPreimage 

func (self *StateDB) AddPreimage(hash types.Hash, preimage []byte)

AddPreimage records a SHA3 preimage seen by the VM.

func (*StateDB) AddRefund 

func (self *StateDB) AddRefund(gas uint64)

AddRefund adds gas to the refund counter

func (*StateDB) Commit 

func (s *StateDB) Commit(deleteEmptyObjects bool) (root types.Hash, err error)

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

func (*StateDB) Copy 

func (self *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 (self *StateDB) CreateAccount(addr types.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 (self *StateDB) Database() Database

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

func (*StateDB) Dump 

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

func (*StateDB) Empty 

func (self *StateDB) Empty(addr types.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 (self *StateDB) Error() error

func (*StateDB) Exist 

func (self *StateDB) Exist(addr types.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 (s *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 types.Address, cb func(key, value types.Hash) bool)

func (*StateDB) GetBalance 

func (self *StateDB) GetBalance(addr types.Address) *big.Int

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

func (*StateDB) GetCode 

func (self *StateDB) GetCode(addr types.Address) []byte

func (*StateDB) GetCodeHash 

func (self *StateDB) GetCodeHash(addr types.Address) types.Hash

func (*StateDB) GetCodeSize 

func (self *StateDB) GetCodeSize(addr types.Address) int

func (*StateDB) GetCodeType added in v1.1.0 

func (self *StateDB) GetCodeType(addr types.Address) CodeType

func (*StateDB) GetCommittedHashTypeState added in v1.1.0 

func (self *StateDB) GetCommittedHashTypeState(addr types.Address, hash types.Hash) types.Hash

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

func (*StateDB) GetCommittedState added in v1.0.0 

func (self *StateDB) GetCommittedState(addr types.Address, hash types.Hash) []byte

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

func (*StateDB) GetHashTypeState added in v1.1.0 

func (self *StateDB) GetHashTypeState(addr types.Address, hash types.Hash) types.Hash

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

func (*StateDB) GetLogs 

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

func (*StateDB) GetNonce 

func (self *StateDB) GetNonce(addr types.Address) uint64

func (*StateDB) GetOrNewStateObject 

func (self *StateDB) GetOrNewStateObject(addr types.Address) *stateObject

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

func (*StateDB) GetProof added in v1.0.0 

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

GetProof returns the MerkleProof for a given Account

func (*StateDB) GetRefund 

func (self *StateDB) GetRefund() uint64

GetRefund returns the current value of the refund counter.

func (*StateDB) GetState 

func (self *StateDB) GetState(addr types.Address, hash types.Hash) []byte

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

func (*StateDB) GetStorageProof added in v1.0.0 

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

GetProof returns the StorageProof for given key

func (*StateDB) HasSuicided 

func (self *StateDB) HasSuicided(addr types.Address) bool

func (*StateDB) IntermediateRoot 

func (s *StateDB) IntermediateRoot(deleteEmptyObjects bool) types.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 (self *StateDB) Logs() []*types.Log

func (*StateDB) Preimages 

func (self *StateDB) Preimages() map[types.Hash][]byte

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

func (*StateDB) Prepare 

func (self *StateDB) Prepare(thash, bhash types.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 (self *StateDB) RawDump() Dump

func (*StateDB) Reset 

func (self *StateDB) Reset(root types.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 (self *StateDB) RevertToSnapshot(revid int)

RevertToSnapshot reverts all state changes made since the given revision.

func (*StateDB) SetBalance 

func (self *StateDB) SetBalance(addr types.Address, amount *big.Int)

func (*StateDB) SetCode 

func (self *StateDB) SetCode(addr types.Address, code []byte)

func (*StateDB) SetHashTypeState added in v1.1.0 

func (self *StateDB) SetHashTypeState(addr types.Address, key, value types.Hash)

func (*StateDB) SetNonce 

func (self *StateDB) SetNonce(addr types.Address, nonce uint64)

func (*StateDB) SetState 

func (self *StateDB) SetState(addr types.Address, key types.Hash, value []byte)

func (*StateDB) Snapshot 

func (self *StateDB) Snapshot() int

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

func (*StateDB) StorageTrie 

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

SubBalance subtracts amount from the account associated with addr.

func (*StateDB) SubRefund added in v1.0.0 

func (self *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 (self *StateDB) Suicide(addr types.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[types.Hash][]byte

func (Storage) Copy 

func (self Storage) Copy() Storage

func (Storage) String 

func (self 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 SecureTrie is removed
	GetKey([]byte) []byte

	// TryGet 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.
	TryGet(key []byte) ([]byte, error)

	// TryUpdate 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.
	TryUpdate(key, value []byte) error

	// TryDelete removes any existing value for key from the trie. If a node was not
	// found in the database, a trie.MissingNodeError is returned.
	TryDelete(key []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() types.Hash

	// Commit writes all nodes to the trie's memory database, tracking the internal
	// and external (for account tries) references.
	Commit(onleaf trie.LeafCallback) (types.Hash, error)

	// NodeIterator returns an iterator that returns nodes of the trie. Iteration
	// starts at the key after the given start key.
	NodeIterator(startKey []byte) trie.NodeIterator

	// 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, fromLevel uint, proofDb ethdb.Writer) error
}

Trie is a Ethereum Merkle Patricia trie.

Source Files

View all Source files

Directories

Path Synopsis
Package common contains various helper functions.
 Package common contains various helper functions.
hexutil
Package hexutil implements hex encoding with 0x prefix.
 Package hexutil implements hex encoding with 0x prefix.
log
Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
 Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
math
Package math provides integer math utilities.
 Package math provides integer math utilities.
prque
rlp
Package rlp implements the RLP serialization format.
 Package rlp implements the RLP serialization format.
types
leveldb
Package leveldb implements the key-value database layer based on LevelDB.
 Package leveldb implements the key-value database layer based on LevelDB.
memorydb
Package memorydb implements the key-value database layer based on memory maps.
 Package memorydb implements the key-value database layer based on memory maps.
Go port of Coda Hale's Metrics library <https://github.com/rcrowley/go-metrics> Coda Hale's original work: <https://github.com/codahale/metrics>
 Go port of Coda Hale's Metrics library <https://github.com/rcrowley/go-metrics> Coda Hale's original work: <https://github.com/codahale/metrics>
Package trie implements Merkle Patricia Tries.
 Package trie implements Merkle Patricia Tries.

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.