Documentation ¶
Overview ¶
Package state provides a caching layer atop the Matrix state trie.
Index ¶
- Variables
- func NewStateSync(root common.Hash, database trie.DatabaseReader) *trie.TrieSync
- type Account
- type BtreeDietyStruct
- type Code
- type CodeData
- type Database
- type Dump
- type DumpAccount
- type DumpDB
- type DumpValue
- 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 MapAccountArr
- type NodeIterator
- type StateDB
- func (self *StateDB) AddBalance(accountType uint32, addr common.Address, amount *big.Int)
- func (self *StateDB) AddLog(log *types.Log)
- func (self *StateDB) AddPreimage(hash common.Hash, preimage []byte)
- func (self *StateDB) AddRefund(gas uint64)
- func (s *StateDB) Commit(deleteEmptyObjects bool) (root common.Hash, err error)
- func (self *StateDB) CommitSaveTx()
- func (self *StateDB) Copy() *StateDB
- func (self *StateDB) CreateAccount(addr common.Address)
- func (self *StateDB) Database() Database
- func (self *StateDB) DeleteMxData(hash common.Hash, val []byte)
- func (self *StateDB) Dump() []byte
- func (self *StateDB) Empty(addr common.Address) bool
- func (self *StateDB) Error() error
- func (self *StateDB) Exist(addr common.Address) bool
- func (s *StateDB) Finalise(deleteEmptyObjects bool)
- func (db *StateDB) ForEachStorage(addr common.Address, cb func(key, value common.Hash) bool)
- func (self *StateDB) GetAllEntrustGasFrom(authFrom common.Address) []common.Address
- func (self *StateDB) GetAllEntrustList(authFrom common.Address) []common.EntrustType
- func (self *StateDB) GetAllEntrustSignFrom(authFrom common.Address) []common.Address
- func (self *StateDB) GetAuthFrom(entrustFrom common.Address, height uint64) common.Address
- func (self *StateDB) GetAuthStateByteArray(addr common.Address) []byte
- func (self *StateDB) GetBalance(addr common.Address) common.BalanceType
- func (self *StateDB) GetBalanceByType(addr common.Address, accType uint32) *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) GetEntrustFrom(authFrom common.Address, height uint64) []common.Address
- func (self *StateDB) GetEntrustFromByTime(authFrom common.Address, time uint64) []common.Address
- func (self *StateDB) GetEntrustStateByteArray(addr common.Address) []byte
- func (self *StateDB) GetGasAuthFrom(entrustFrom common.Address, height uint64) common.Address
- func (self *StateDB) GetGasAuthFromByTime(entrustFrom common.Address, time uint64) common.Address
- func (self *StateDB) GetIsEntrustByTime(entrustFrom common.Address, time uint64) bool
- func (self *StateDB) GetLogs(hash common.Hash) []*types.Log
- func (self *StateDB) GetMatrixData(hash common.Hash) (val []byte)
- func (self *StateDB) GetNonce(addr common.Address) uint64
- func (self *StateDB) GetOrNewStateObject(addr common.Address) *stateObject
- func (self *StateDB) GetRefund() uint64
- func (self *StateDB) GetSaveTx(typ byte, key uint32, hashlist []common.Hash, isdel bool)
- func (self *StateDB) GetState(addr common.Address, bhash common.Hash) common.Hash
- func (self *StateDB) GetStateByteArray(a common.Address, b common.Hash) []byte
- 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) MissTrieDebug()
- func (self *StateDB) NewBTrie(typ byte)
- func (self *StateDB) Preimages() map[common.Hash][]byte
- func (self *StateDB) Prepare(thash, bhash common.Hash, ti int)
- func (self *StateDB) RawAccount(account common.Address) *DumpAccount
- func (self *StateDB) RawDump() Dump
- func (self *StateDB) RawDump1(dbDump *DumpDB) Dump
- func (self *StateDB) RawDumpDB() DumpDB
- func (self *StateDB) Reset(root common.Hash) error
- func (self *StateDB) RevertToSnapshot(revid int)
- func (self *StateDB) SaveTx(typ byte, key uint32, data map[common.Hash][]byte)
- func (self *StateDB) SetAuthStateByteArray(addr common.Address, value []byte)
- func (self *StateDB) SetBalance(accountType uint32, addr common.Address, amount *big.Int)
- func (self *StateDB) SetCode(addr common.Address, code []byte)
- func (self *StateDB) SetEntrustStateByteArray(addr common.Address, value []byte)
- func (self *StateDB) SetMatrixData(hash common.Hash, val []byte)
- func (self *StateDB) SetNonce(addr common.Address, nonce uint64)
- func (self *StateDB) SetState(addr common.Address, key, value common.Hash)
- func (self *StateDB) SetStateByteArray(addr common.Address, key common.Hash, value []byte)
- func (self *StateDB) Snapshot() int
- func (self *StateDB) StorageTrie(addr common.Address) Trie
- func (self *StateDB) SubBalance(accountType uint32, addr common.Address, amount *big.Int)
- func (self *StateDB) Suicide(addr common.Address) bool
- func (self *StateDB) UpdateTxForBtree(key uint32)
- func (self *StateDB) UpdateTxForBtreeBytime(key uint32)
- type Storage
- type StorageByteArray
- type Trie
Constants ¶
This section is empty.
Variables ¶
var MaxTrieCacheGen = uint16(120)
Trie cache generation limit after which to evict trie nodes from memory.
Functions ¶
func NewStateSync ¶
NewStateSync create a new state trie download scheduler.
Types ¶
type Account ¶
type Account struct { Nonce uint64 Balance common.BalanceType Root common.Hash // merkle root of the storage trie CodeHash []byte }
Account is the Matrix consensus representation of accounts. These objects are stored in the main account trie.
type BtreeDietyStruct ¶
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 ¶
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.
type Dump ¶
type Dump struct { Root string `json:"root"` Accounts map[string]DumpAccount `json:"accounts"` MatrixData map[string]string `json:"matrixData"` }
type DumpAccount ¶
type DumpDB ¶
type DumpDB struct { Root common.Hash Account []DumpValue Matrix []DumpValue // MapAccount map[common.Address][]DumpValue MapAccount []MapAccountArr CodeDatas []CodeData }
Root [Account ...] [Matrix...] Account -> Root -> []DumpValue
func (*DumpDB) PrintAccountMsg ¶
func (dbDump *DumpDB) PrintAccountMsg()
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 MapAccountArr ¶
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 matrix 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) AddPreimage ¶
AddPreimage records a SHA3 preimage seen by the VM.
func (*StateDB) CommitSaveTx ¶
func (self *StateDB) CommitSaveTx()
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 Maner doesn't disappear.
func (*StateDB) Database ¶
Database retrieves the low level database supporting the lower level trie ops.
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) Finalise ¶
Finalise finalises the state by removing the self destructed objects and clears the journal as well as the refunds.
func (*StateDB) ForEachStorage ¶
func (*StateDB) GetAllEntrustGasFrom ¶
根据授权人获取所有委托gas列表,(该方法用于取消委托时调用)
func (*StateDB) GetAllEntrustList ¶
func (self *StateDB) GetAllEntrustList(authFrom common.Address) []common.EntrustType
钱包调用显示
func (*StateDB) GetAllEntrustSignFrom ¶
根据授权人获取所有委托签名列表,(该方法用于取消委托时调用)
func (*StateDB) GetAuthFrom ¶
根据委托人from和高度获取授权人的from,返回授权人地址(算法组调用,仅适用委托签名) A1
func (*StateDB) GetAuthStateByteArray ¶
func (*StateDB) GetBalance ¶
func (self *StateDB) GetBalance(addr common.Address) common.BalanceType
Retrieve the balance from the given address or 0 if object not found
func (*StateDB) GetBalanceByType ¶
Retrieve the balance from the given address or 0 if object not found
func (*StateDB) GetEntrustFrom ¶
根据授权人from和高度获取委托人的from列表,返回委托人地址列表(算法组调用,仅适用委托签名) A2 s
func (*StateDB) GetEntrustFromByTime ¶
func (*StateDB) GetEntrustStateByteArray ¶
func (*StateDB) GetGasAuthFrom ¶
根据委托人from和高度获取授权人的from,返回授权人地址(内部调用,仅适用委托gas)
func (*StateDB) GetGasAuthFromByTime ¶
根据委托人from和时间获取授权人的from,返回授权人地址(内部调用,仅适用委托gas)
func (*StateDB) GetIsEntrustByTime ¶
判断根据时间委托是否满足条件,用于执行按时间委托的交易(跑交易),此处time应该为header里的时间戳
func (*StateDB) GetOrNewStateObject ¶
Retrieve a state object or create a new state object if nil.
func (*StateDB) GetStateByteArray ¶
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) MissTrieDebug ¶
func (self *StateDB) MissTrieDebug()
func (*StateDB) Prepare ¶
Prepare sets the current transaction hash and index and block hash which is used when the EVM emits new state logs.
func (*StateDB) RawAccount ¶
func (self *StateDB) RawAccount(account common.Address) *DumpAccount
func (*StateDB) Reset ¶
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 ¶
RevertToSnapshot reverts all state changes made since the given revision.
func (*StateDB) SetAuthStateByteArray ¶
func (*StateDB) SetBalance ¶
func (*StateDB) SetEntrustStateByteArray ¶
func (*StateDB) SetStateByteArray ¶
func (*StateDB) StorageTrie ¶
StorageTrie returns the storage trie of an account. The return value is a copy and is nil for non-existent accounts.
func (*StateDB) SubBalance ¶
SubBalance subtracts amount from the account associated with addr.
func (*StateDB) Suicide ¶
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.
func (*StateDB) UpdateTxForBtree ¶
func (*StateDB) UpdateTxForBtreeBytime ¶
type StorageByteArray ¶
func (StorageByteArray) Copy ¶
func (self StorageByteArray) Copy() StorageByteArray
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 mandb.Putter) error }
Trie is a Matrix Merkle Trie.