Documentation ¶
Overview ¶
Package state provides a caching layer atop the Ethereum state trie.
Index ¶
- Variables
- func GetBalanceWithFund(statedb *StateDB, addr common.Address) *big.Int
- func GetTotalFund(statedb *StateDB, addr common.Address) *big.Int
- func GetTotalReceived(statedb *StateDB, id common.Address) *big.Int
- func MakeStartLifespanCoinbase(start uint64, lifespan uint32, coinbase common.Address) (data common.Hash)
- func NewStateSync(root common.Hash, database trie.DatabaseReader) *trie.Sync
- type Account
- type Code
- type Database
- 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 MinerContract
- func (minerdb *MinerContract) Get(stateDb *StateDB, height uint64, miner common.Address) (uint64, uint32, common.Address, [32]byte, [32]byte)
- func (minerdb *MinerContract) IsMinerOf(stateDb *StateDB, height uint64, miner common.Address) bool
- func (minerdb *MinerContract) MakeMinerInfoKey(height uint64, miner common.Address) common.Hash
- func (minerdb *MinerContract) MakeNewMinersKey(height uint64) common.Hash
- func (minerdb *MinerContract) NewAddedMiners(stateDb *StateDB, height uint64) []common.Address
- type MinerTracker
- type NodeIterator
- type StateDB
- func (self *StateDB) AddBalance(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) Copy() *StateDB
- func (self *StateDB) CreateAccount(addr common.Address)
- func (self *StateDB) Database() Database
- func (self *StateDB) Dump() []byte
- func (self *StateDB) Empty(addr common.Address) bool
- func (self *StateDB) EnableMinerTracker(config *params.AlgorandConfig, height uint64, totalBalanceOfMiners *big.Int)
- 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) 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) GetCommittedState(addr common.Address, hash common.Hash) common.Hash
- 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) GetProof(a common.Address) ([][]byte, error)
- func (self *StateDB) GetRefund() uint64
- func (self *StateDB) GetState(addr common.Address, hash common.Hash) common.Hash
- func (self *StateDB) GetStateObjectRoot(addr common.Address) common.Hash
- func (self *StateDB) GetStorageProof(a common.Address, key common.Hash) ([][]byte, error)
- func (self *StateDB) HasCode(addr common.Address) bool
- 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) Preimages() map[common.Hash][]byte
- func (self *StateDB) Prepare(thash, bhash common.Hash, ti int)
- func (self *StateDB) Prove(a common.Address, fromLevel uint, proofDb ethdb.Putter) 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, value common.Hash)
- func (self *StateDB) Snapshot() int
- func (self *StateDB) StorageProve(a common.Address, key common.Hash, fromLevel uint, proofDb ethdb.Putter) error
- func (self *StateDB) StorageTrie(addr common.Address) Trie
- func (self *StateDB) SubBalance(addr common.Address, amount *big.Int)
- func (self *StateDB) SubRefund(gas uint64)
- func (self *StateDB) Suicide(addr common.Address) bool
- func (self *StateDB) TotalBalanceOfMiners() *big.Int
- type Storage
- 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 GetBalanceWithFund ¶
GetBalanceWithFund returns a value summed by balance and fund
func GetTotalFund ¶
GetTotalFund 取地址已抵押的总数量
func GetTotalReceived ¶
GetTotalReceived 取抵押给id的总数量
func NewStateSync ¶
NewStateSync create a new state trie download scheduler.
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 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 a few recent expanded trie nodes in memory. To keep more historical state in memory, use the NewDatabaseWithCache constructor.
func NewDatabaseWithCache ¶
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 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 MinerContract ¶
type MinerContract struct {
// contains filtered or unexported fields
}
func NewMinerContract ¶
func NewMinerContract(config *params.AlgorandConfig) *MinerContract
func (*MinerContract) IsMinerOf ¶
IsMinerOf returns if the miner participates mining of the block height
func (*MinerContract) MakeMinerInfoKey ¶
func (*MinerContract) MakeNewMinersKey ¶
func (minerdb *MinerContract) MakeNewMinersKey(height uint64) common.Hash
func (*MinerContract) NewAddedMiners ¶
func (minerdb *MinerContract) NewAddedMiners(stateDb *StateDB, height uint64) []common.Address
type MinerTracker ¶
type MinerTracker struct {
// contains filtered or unexported fields
}
MinerTracker is a tracker for balance change Note: we only need track miners before current block, miners of current block do NOT track!
func NewMinerTracker ¶
func NewMinerTracker(config *params.AlgorandConfig, initialState *StateDB, height uint64, totalBalanceOfMiners *big.Int) *MinerTracker
func (*MinerTracker) Copy ¶
func (tracker *MinerTracker) Copy() *MinerTracker
func (*MinerTracker) SetDirty ¶
func (tracker *MinerTracker) SetDirty(addr common.Address)
func (*MinerTracker) TotalBalance ¶
func (tracker *MinerTracker) TotalBalance(finalState *StateDB) *big.Int
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 (*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) 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) 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) EnableMinerTracker ¶
func (self *StateDB) EnableMinerTracker(config *params.AlgorandConfig, height uint64, totalBalanceOfMiners *big.Int)
EnableMinerTracker enables the tracker of miners' balance
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) GetBalance ¶
Retrieve the balance from the given address or 0 if object not found
func (*StateDB) GetCommittedState ¶
GetCommittedState retrieves a value from the given account's committed storage trie.
func (*StateDB) GetOrNewStateObject ¶
Retrieve a state object or create a new state object if nil.
func (*StateDB) GetStateObjectRoot ¶
func (*StateDB) GetStorageProof ¶
GetProof returns the StorageProof for given key
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) Prepare ¶
Prepare sets the current transaction hash and index and block hash which is used when the EVM emits new state logs.
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) StorageProve ¶
func (self *StateDB) StorageProve(a common.Address, key common.Hash, fromLevel uint, proofDb ethdb.Putter) error
StorageProve constructs the StorageProof for given key of a given Account
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) SubRefund ¶
SubRefund removes gas from the refund counter. This method will panic if the refund counter goes below zero
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) TotalBalanceOfMiners ¶
TotalBalanceOfMiners returns tracking result
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.