plugeth/core/state/statedb.go

394 lines
10 KiB
Go
Raw Normal View History

2015-07-07 00:54:22 +00:00
// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
2015-07-07 00:54:22 +00:00
//
// The go-ethereum library is free software: you can redistribute it and/or modify
2015-07-07 00:54:22 +00:00
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
2015-07-07 00:54:22 +00:00
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2015-07-07 00:54:22 +00:00
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
2015-07-07 00:54:22 +00:00
2015-07-07 03:08:16 +00:00
// Package state provides a caching layer atop the Ethereum state trie.
2014-10-31 13:43:14 +00:00
package state
import (
"math/big"
2015-03-16 10:27:38 +00:00
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/vm"
"github.com/ethereum/go-ethereum/ethdb"
2014-10-31 11:56:05 +00:00
"github.com/ethereum/go-ethereum/logger"
2015-04-04 10:40:11 +00:00
"github.com/ethereum/go-ethereum/logger/glog"
2015-01-08 10:47:04 +00:00
"github.com/ethereum/go-ethereum/trie"
)
2014-12-04 10:40:20 +00:00
// 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
2014-12-04 10:40:20 +00:00
type StateDB struct {
db ethdb.Database
2015-03-03 11:25:44 +00:00
trie *trie.SecureTrie
stateObjects map[string]*StateObject
2015-06-17 08:20:33 +00:00
refund *big.Int
thash, bhash common.Hash
txIndex int
logs map[common.Hash]vm.Logs
logSize uint
}
// Create a new state from a given trie
func New(root common.Hash, db ethdb.Database) *StateDB {
2015-07-05 23:19:48 +00:00
tr, err := trie.NewSecure(root, db)
if err != nil {
// TODO: bubble this up
tr, _ = trie.NewSecure(common.Hash{}, db)
glog.Errorf("can't create state trie with root %x: %v", root[:], err)
}
return &StateDB{
db: db,
trie: tr,
stateObjects: make(map[string]*StateObject),
refund: new(big.Int),
logs: make(map[common.Hash]vm.Logs),
2015-07-05 23:19:48 +00:00
}
2015-03-19 09:57:02 +00:00
}
func (self *StateDB) StartRecord(thash, bhash common.Hash, ti int) {
self.thash = thash
self.bhash = bhash
self.txIndex = ti
}
func (self *StateDB) AddLog(log *vm.Log) {
log.TxHash = self.thash
log.BlockHash = self.bhash
log.TxIndex = uint(self.txIndex)
log.Index = self.logSize
self.logs[self.thash] = append(self.logs[self.thash], log)
self.logSize++
}
func (self *StateDB) GetLogs(hash common.Hash) vm.Logs {
return self.logs[hash]
}
func (self *StateDB) Logs() vm.Logs {
var logs vm.Logs
for _, lgs := range self.logs {
logs = append(logs, lgs...)
}
return logs
}
func (self *StateDB) AddRefund(gas *big.Int) {
2015-06-17 08:20:33 +00:00
self.refund.Add(self.refund, gas)
}
func (self *StateDB) HasAccount(addr common.Address) bool {
return self.GetStateObject(addr) != nil
}
func (self *StateDB) Exist(addr common.Address) bool {
return self.GetStateObject(addr) != nil
}
func (self *StateDB) GetAccount(addr common.Address) vm.Account {
return self.GetStateObject(addr)
}
// Retrieve the balance from the given address or 0 if object not found
2015-03-16 10:59:52 +00:00
func (self *StateDB) GetBalance(addr common.Address) *big.Int {
2015-03-12 18:41:56 +00:00
stateObject := self.GetStateObject(addr)
if stateObject != nil {
2014-10-22 13:22:21 +00:00
return stateObject.balance
}
2015-03-16 10:27:38 +00:00
return common.Big0
}
2015-03-16 10:59:52 +00:00
func (self *StateDB) GetNonce(addr common.Address) uint64 {
2015-03-12 18:41:56 +00:00
stateObject := self.GetStateObject(addr)
if stateObject != nil {
return stateObject.nonce
}
return 0
}
2015-03-16 10:59:52 +00:00
func (self *StateDB) GetCode(addr common.Address) []byte {
2015-03-12 18:41:56 +00:00
stateObject := self.GetStateObject(addr)
if stateObject != nil {
return stateObject.code
}
return nil
}
func (self *StateDB) GetState(a common.Address, b common.Hash) common.Hash {
2015-03-12 18:41:56 +00:00
stateObject := self.GetStateObject(a)
2014-09-07 22:50:04 +00:00
if stateObject != nil {
return stateObject.GetState(b)
2014-09-07 22:50:04 +00:00
}
return common.Hash{}
2014-09-07 22:50:04 +00:00
}
func (self *StateDB) IsDeleted(addr common.Address) bool {
2015-03-12 18:41:56 +00:00
stateObject := self.GetStateObject(addr)
if stateObject != nil {
return stateObject.remove
}
return false
}
/*
* SETTERS
*/
func (self *StateDB) AddBalance(addr common.Address, amount *big.Int) {
stateObject := self.GetOrNewStateObject(addr)
if stateObject != nil {
stateObject.AddBalance(amount)
}
}
func (self *StateDB) SetNonce(addr common.Address, nonce uint64) {
stateObject := self.GetOrNewStateObject(addr)
if stateObject != nil {
stateObject.SetNonce(nonce)
}
}
2015-03-16 10:59:52 +00:00
func (self *StateDB) SetCode(addr common.Address, code []byte) {
stateObject := self.GetOrNewStateObject(addr)
2014-10-15 15:12:26 +00:00
if stateObject != nil {
stateObject.SetCode(code)
2014-10-15 15:12:26 +00:00
}
}
func (self *StateDB) SetState(addr common.Address, key common.Hash, value common.Hash) {
stateObject := self.GetOrNewStateObject(addr)
if stateObject != nil {
stateObject.SetState(key, value)
}
}
2015-03-16 10:59:52 +00:00
func (self *StateDB) Delete(addr common.Address) bool {
2015-03-12 18:41:56 +00:00
stateObject := self.GetStateObject(addr)
if stateObject != nil {
stateObject.MarkForDeletion()
2015-03-09 10:28:35 +00:00
stateObject.balance = new(big.Int)
return true
}
return false
}
//
// Setting, updating & deleting state object methods
//
// Update the given state object and apply it to state trie
2014-12-04 10:40:20 +00:00
func (self *StateDB) UpdateStateObject(stateObject *StateObject) {
2015-03-16 10:59:52 +00:00
//addr := stateObject.Address()
2014-09-15 13:42:12 +00:00
if len(stateObject.CodeHash()) > 0 {
self.db.Put(stateObject.CodeHash(), stateObject.code)
2014-09-15 13:42:12 +00:00
}
2015-03-16 16:09:08 +00:00
addr := stateObject.Address()
self.trie.Update(addr[:], stateObject.RlpEncode())
}
// Delete the given state object and delete it from the state trie
2014-12-04 10:40:20 +00:00
func (self *StateDB) DeleteStateObject(stateObject *StateObject) {
2015-08-20 16:22:50 +00:00
stateObject.deleted = true
2015-03-16 16:09:08 +00:00
addr := stateObject.Address()
self.trie.Delete(addr[:])
//delete(self.stateObjects, addr.Str())
}
// Retrieve a state object given my the address. Nil if not found
2015-08-20 16:22:50 +00:00
func (self *StateDB) GetStateObject(addr common.Address) (stateObject *StateObject) {
stateObject = self.stateObjects[addr.Str()]
if stateObject != nil {
2015-08-20 16:22:50 +00:00
if stateObject.deleted {
stateObject = nil
}
return stateObject
}
2015-03-16 16:09:08 +00:00
data := self.trie.Get(addr[:])
if len(data) == 0 {
return nil
}
2015-01-07 12:17:48 +00:00
stateObject = NewStateObjectFromBytes(addr, []byte(data), self.db)
self.SetStateObject(stateObject)
return stateObject
}
2014-12-04 10:40:20 +00:00
func (self *StateDB) SetStateObject(object *StateObject) {
2015-03-16 10:59:52 +00:00
self.stateObjects[object.Address().Str()] = object
}
// Retrieve a state object or create a new state object if nil
2015-03-16 10:59:52 +00:00
func (self *StateDB) GetOrNewStateObject(addr common.Address) *StateObject {
stateObject := self.GetStateObject(addr)
2015-08-20 16:22:50 +00:00
if stateObject == nil || stateObject.deleted {
stateObject = self.CreateStateObject(addr)
}
return stateObject
}
// NewStateObject create a state object whether it exist in the trie or not
func (self *StateDB) newStateObject(addr common.Address) *StateObject {
2015-04-04 11:24:01 +00:00
if glog.V(logger.Core) {
2015-04-03 15:09:01 +00:00
glog.Infof("(+) %x\n", addr)
}
2015-01-07 12:17:48 +00:00
stateObject := NewStateObject(addr, self.db)
2015-03-16 16:09:08 +00:00
self.stateObjects[addr.Str()] = stateObject
return stateObject
}
// Creates creates a new state object and takes ownership. This is different from "NewStateObject"
func (self *StateDB) CreateStateObject(addr common.Address) *StateObject {
// Get previous (if any)
so := self.GetStateObject(addr)
// Create a new one
newSo := self.newStateObject(addr)
// If it existed set the balance to the new account
if so != nil {
newSo.balance = so.balance
}
return newSo
}
func (self *StateDB) CreateAccount(addr common.Address) vm.Account {
return self.CreateStateObject(addr)
}
//
// Setting, copying of the state methods
//
2014-12-04 10:40:20 +00:00
func (self *StateDB) Copy() *StateDB {
2015-03-16 22:48:18 +00:00
state := New(common.Hash{}, self.db)
2015-06-17 11:39:19 +00:00
state.trie = self.trie
for k, stateObject := range self.stateObjects {
state.stateObjects[k] = stateObject.Copy()
}
2015-06-17 08:20:33 +00:00
state.refund.Set(self.refund)
for hash, logs := range self.logs {
state.logs[hash] = make(vm.Logs, len(logs))
copy(state.logs[hash], logs)
}
state.logSize = self.logSize
return state
}
2014-12-04 10:40:20 +00:00
func (self *StateDB) Set(state *StateDB) {
2014-12-23 17:35:36 +00:00
self.trie = state.trie
self.stateObjects = state.stateObjects
2014-10-28 12:22:04 +00:00
self.refund = state.refund
self.logs = state.logs
self.logSize = state.logSize
}
func (self *StateDB) GetRefund() *big.Int {
return self.refund
}
// 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 (s *StateDB) IntermediateRoot() common.Hash {
s.refund = new(big.Int)
for _, stateObject := range s.stateObjects {
if stateObject.dirty {
if stateObject.remove {
s.DeleteStateObject(stateObject)
} else {
stateObject.Update()
s.UpdateStateObject(stateObject)
}
stateObject.dirty = false
}
}
return s.trie.Hash()
}
// Commit commits all state changes to the database.
func (s *StateDB) Commit() (root common.Hash, err error) {
return s.commit(s.db)
}
// CommitBatch commits all state changes to a write batch but does not
// execute the batch. It is used to validate state changes against
// the root hash stored in a block.
func (s *StateDB) CommitBatch() (root common.Hash, batch ethdb.Batch) {
batch = s.db.NewBatch()
root, _ = s.commit(batch)
return root, batch
}
func (s *StateDB) commit(db trie.DatabaseWriter) (common.Hash, error) {
s.refund = new(big.Int)
for _, stateObject := range s.stateObjects {
if stateObject.remove {
// If the object has been removed, don't bother syncing it
// and just mark it for deletion in the trie.
s.DeleteStateObject(stateObject)
} else {
// Write any storage changes in the state object to its trie.
stateObject.Update()
// Commit the trie of the object to the batch.
// This updates the trie root internally, so
// getting the root hash of the storage trie
// through UpdateStateObject is fast.
if _, err := stateObject.trie.CommitTo(db); err != nil {
return common.Hash{}, err
}
// Update the object in the account trie.
s.UpdateStateObject(stateObject)
}
stateObject.dirty = false
}
return s.trie.CommitTo(db)
}
func (self *StateDB) Refunds() *big.Int {
return self.refund
}
2014-08-11 14:23:38 +00:00
// Debug stuff
2014-12-04 10:40:20 +00:00
func (self *StateDB) CreateOutputForDiff() {
2014-08-11 14:23:38 +00:00
for _, stateObject := range self.stateObjects {
stateObject.CreateOutputForDiff()
}
}