state

package
v0.0.0-...-ac8b7ce Latest Latest
Warning

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

 Go to latest Published: Jan 27, 2021 License: GPL-3.0 Imports: 15 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

View Source 
var MaxTrieCacheGen = uint16(120)

Trie cache generation limit after which to evict trie nodes from memory. ·Trie· 缓存生成限制，之后将 对应的 trie nodes 从内存中逐出

Functions

func NewStateSync 

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

NewStateSync create a new state trie download scheduler.

Types

type Account 

type Account struct {
	// 账户的 nonce， 标识下一次发tx时需要用到的值
	Nonce uint64
	// 账户的余额
	Balance *big.Int

	// 账户的 k-v storage trie 的root
	Root common.Hash // merkle root of the storage trie

	// 只有合约账户才会有的， 合约账户的codeHash
	CodeHash []byte
}

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

* 账户是以太坊账户的共识表示。 这些对象存储在主帐户trie中。

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 ethdb.Database) Database

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. * 对 db 的封装

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

todo State中的db是cachingDB

todo State中的 trie是 cachedTrie todo Storage中的 trie是 SecureTrie

func New 

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

Create a new state from a given trie.

func (*StateDB) AddBalance 

func (self *StateDB) AddBalance(addr common.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 common.Hash, preimage []byte)

AddPreimage records a SHA3 preimage seen by the VM.

AddPreimage: 记录VM看到的SHA3预映像。

func (*StateDB) AddRefund 

func (self *StateDB) AddRefund(gas uint64)

func (*StateDB) Commit 

func (s *StateDB) Commit(deleteEmptyObjects bool) (root common.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 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 (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 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) Error 

func (self *StateDB) Error() error

func (*StateDB) Exist 

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

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

* Finalize: 通过删除 suicided对象来最终确定State，并清除 日记帐<journal> 以及 refunds计数器。

func (*StateDB) ForEachStorage 

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

func (*StateDB) GetBalance 

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

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

func (*StateDB) GetCode 

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

func (*StateDB) GetCodeHash 

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

func (*StateDB) GetCodeSize 

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

func (*StateDB) GetLogs 

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

func (*StateDB) GetNonce 

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

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 

func (self *StateDB) GetRefund() uint64

GetRefund returns the current value of the refund counter.

func (*StateDB) GetState 

func (self *StateDB) GetState(addr common.Address, bhash common.Hash) common.Hash

func (*StateDB) HasSuicided 

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

func (*StateDB) IntermediateRoot 

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

* IntermediateRoot: 

计算State Trie的当前 root Hash。 在tx之间调用它以获取进入交易 receipt的 root哈希。
说白了，每个tx都需要调用，是因为每个tx都产生receipt，而state的root 是生成receipt的重要一部分
todo 当然这都发生在 拜占庭分叉之前， 在此之后receipt 就不需要实时的root了

func (*StateDB) Logs 

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

func (*StateDB) Preimages 

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

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

Preimages: 返回已提交的SHA3原像的列表。

func (*StateDB) Prepare 

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

* Prepare: 设置当前 txHash以及 txIndex和 blockHash，当EVM发出新的状态log时将使用它们。 

只在 tx 被执行之前调用

func (*StateDB) RawDump 

func (self *StateDB) RawDump() Dump

func (*StateDB) Reset 

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

Reset: 

从state db中清除所有 临时 state对象，但保留基础 state Trie，以避免为下一个操作重新加载数据。

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 common.Address, amount *big.Int)

func (*StateDB) SetCode 

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

func (*StateDB) SetNonce 

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

func (*StateDB) SetState 

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

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

SubBalance subtracts amount from the account associated with addr.

func (*StateDB) Suicide 

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

todo 账户自杀

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

Trie is a Ethereum Merkle Trie.

Source Files

View all Source files

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.