plugeth/ethchain/state_manager.go

392 lines
11 KiB
Go
Raw Normal View History

2014-02-14 22:56:09 +00:00
package ethchain
import (
"bytes"
"fmt"
"github.com/ethereum/eth-go/ethutil"
"github.com/ethereum/eth-go/ethwire"
2014-02-14 22:56:09 +00:00
"math/big"
"sync"
"time"
)
type BlockProcessor interface {
ProcessBlock(block *Block)
}
type EthManager interface {
2014-03-05 09:57:32 +00:00
StateManager() *StateManager
BlockChain() *BlockChain
TxPool() *TxPool
Broadcast(msgType ethwire.MsgType, data []interface{})
2014-03-10 10:53:02 +00:00
Reactor() *ethutil.ReactorEngine
PeerCount() int
IsMining() bool
IsListening() bool
}
2014-03-05 09:57:32 +00:00
type StateManager struct {
2014-02-14 22:56:09 +00:00
// Mutex for locking the block processor. Blocks can only be handled one at a time
mutex sync.Mutex
// Canonical block chain
2014-02-14 22:56:09 +00:00
bc *BlockChain
// Stack for processing contracts
stack *Stack
// non-persistent key/value memory storage
mem map[string]*big.Int
// Proof of work used for validating
2014-02-14 22:56:09 +00:00
Pow PoW
// The ethereum manager interface
Ethereum EthManager
// The managed states
// Transiently state. The trans state isn't ever saved, validated and
// it could be used for setting account nonces without effecting
// the main states.
transState *State
// Mining state. The mining state is used purely and solely by the mining
// operation.
miningState *State
2014-02-14 22:56:09 +00:00
}
2014-03-05 09:57:32 +00:00
func NewStateManager(ethereum EthManager) *StateManager {
sm := &StateManager{
stack: NewStack(),
mem: make(map[string]*big.Int),
Pow: &EasyPow{},
Ethereum: ethereum,
bc: ethereum.BlockChain(),
2014-02-14 22:56:09 +00:00
}
sm.transState = ethereum.BlockChain().CurrentBlock.State().Copy()
sm.miningState = ethereum.BlockChain().CurrentBlock.State().Copy()
2014-03-05 09:57:32 +00:00
return sm
2014-02-14 22:56:09 +00:00
}
func (sm *StateManager) CurrentState() *State {
return sm.Ethereum.BlockChain().CurrentBlock.State()
}
func (sm *StateManager) TransState() *State {
return sm.transState
}
func (sm *StateManager) MiningState() *State {
return sm.miningState
}
func (sm *StateManager) NewMiningState() *State {
sm.miningState = sm.Ethereum.BlockChain().CurrentBlock.State().Copy()
return sm.miningState
}
2014-03-05 09:57:32 +00:00
func (sm *StateManager) BlockChain() *BlockChain {
return sm.bc
2014-02-14 22:56:09 +00:00
}
2014-05-22 16:24:04 +00:00
func (sm *StateManager) MakeStateObject(state *State, tx *Transaction) *StateObject {
contract := MakeContract(tx, state)
if contract != nil {
state.states[string(tx.CreationAddress())] = contract.state
return contract
}
return nil
}
2014-03-30 10:58:37 +00:00
// Apply transactions uses the transaction passed to it and applies them onto
// the current processing state.
func (sm *StateManager) ApplyTransactions(state *State, block *Block, txs []*Transaction) ([]*Receipt, []*Transaction) {
// Process each transaction/contract
var receipts []*Receipt
var validTxs []*Transaction
totalUsedGas := big.NewInt(0)
for _, tx := range txs {
usedGas, err := sm.ApplyTransaction(state, block, tx)
if err != nil {
ethutil.Config.Log.Infoln(err)
continue
}
accumelative := new(big.Int).Set(totalUsedGas.Add(totalUsedGas, usedGas))
receipt := &Receipt{tx, ethutil.CopyBytes(state.Root().([]byte)), accumelative}
receipts = append(receipts, receipt)
validTxs = append(validTxs, tx)
}
return receipts, txs
}
func (sm *StateManager) ApplyTransaction(state *State, block *Block, tx *Transaction) (*big.Int, error) {
/*
Applies transactions to the given state and creates new
state objects where needed.
If said objects needs to be created
run the initialization script provided by the transaction and
assume there's a return value. The return value will be set to
the script section of the state object.
*/
totalGasUsed := big.NewInt(0)
// Apply the transaction to the current state
err := sm.Ethereum.TxPool().ProcessTransaction(tx, state, false)
if tx.CreatesContract() {
if err == nil {
// Create a new state object and the transaction
// as it's data provider.
2014-05-22 16:24:04 +00:00
contract := sm.MakeStateObject(state, tx)
if contract != nil {
// Evaluate the initialization script
// and use the return value as the
// script section for the state object.
2014-05-22 16:24:04 +00:00
script, err := sm.EvalScript(state, contract.Init(), contract, tx, block)
if err != nil {
return nil, fmt.Errorf("[STATE] Error during init script run %v", err)
}
contract.script = script
state.UpdateStateObject(contract)
} else {
return nil, fmt.Errorf("[STATE] Unable to create contract")
}
} else {
2014-05-22 16:24:04 +00:00
return nil, fmt.Errorf("[STATE] contract creation tx:", err)
}
} else {
// Find the state object at the "recipient" address. If
// there's an object attempt to run the script.
stateObject := state.GetStateObject(tx.Recipient)
if err == nil && stateObject != nil && len(stateObject.Script()) > 0 {
sm.EvalScript(state, stateObject.Script(), stateObject, tx, block)
} else if err != nil {
return nil, fmt.Errorf("[STATE] process:", err)
}
}
return totalGasUsed, nil
2014-02-14 22:56:09 +00:00
}
2014-05-21 09:42:20 +00:00
func (sm *StateManager) Process(block *Block, dontReact bool) error {
if !sm.bc.HasBlock(block.PrevHash) {
return ParentError(block.PrevHash)
}
parent := sm.bc.GetBlock(block.PrevHash)
return sm.ProcessBlock(parent.State(), parent, block, dontReact)
}
2014-02-14 22:56:09 +00:00
// Block processing and validating with a given (temporarily) state
2014-05-21 09:42:20 +00:00
func (sm *StateManager) ProcessBlock(state *State, parent, block *Block, dontReact bool) error {
2014-02-14 22:56:09 +00:00
// Processing a blocks may never happen simultaneously
2014-03-05 09:57:32 +00:00
sm.mutex.Lock()
defer sm.mutex.Unlock()
2014-02-14 22:56:09 +00:00
hash := block.Hash()
2014-03-05 09:57:32 +00:00
if sm.bc.HasBlock(hash) {
2014-04-30 15:13:32 +00:00
//fmt.Println("[STATE] We already have this block, ignoring")
2014-02-14 22:56:09 +00:00
return nil
}
2014-04-29 10:36:27 +00:00
// Defer the Undo on the Trie. If the block processing happened
// we don't want to undo but since undo only happens on dirty
// nodes this won't happen because Commit would have been called
// before that.
defer state.Reset()
2014-04-29 10:36:27 +00:00
2014-02-14 22:56:09 +00:00
// Check if we have the parent hash, if it isn't known we discard it
// Reasons might be catching up or simply an invalid block
2014-03-05 09:57:32 +00:00
if !sm.bc.HasBlock(block.PrevHash) && sm.bc.CurrentBlock != nil {
2014-02-14 22:56:09 +00:00
return ParentError(block.PrevHash)
}
// Process the transactions on to current block
2014-05-21 10:39:07 +00:00
sm.ApplyTransactions(state, parent, block.Transactions())
2014-02-14 22:56:09 +00:00
// Block validation
2014-03-05 09:57:32 +00:00
if err := sm.ValidateBlock(block); err != nil {
2014-03-24 14:04:29 +00:00
fmt.Println("[SM] Error validating block:", err)
2014-02-14 22:56:09 +00:00
return err
}
// I'm not sure, but I don't know if there should be thrown
// any errors at this time.
if err := sm.AccumelateRewards(state, block); err != nil {
2014-03-24 14:04:29 +00:00
fmt.Println("[SM] Error accumulating reward", err)
2014-02-14 22:56:09 +00:00
return err
}
//if !sm.compState.Cmp(state) {
if !block.State().Cmp(state) {
return fmt.Errorf("Invalid merkle root.\nrec: %x\nis: %x", block.State().trie.Root, state.trie.Root)
2014-02-14 22:56:09 +00:00
}
// Calculate the new total difficulty and sync back to the db
2014-03-05 09:57:32 +00:00
if sm.CalculateTD(block) {
2014-02-18 00:33:26 +00:00
// Sync the current block's state to the database and cancelling out the deferred Undo
state.Sync()
2014-02-14 22:56:09 +00:00
// Add the block to the chain
2014-03-05 09:57:32 +00:00
sm.bc.Add(block)
sm.notifyChanges(state)
2014-05-21 09:42:20 +00:00
ethutil.Config.Log.Infof("[STATE] Added block #%d (%x)\n", block.Number, block.Hash())
2014-03-20 10:20:29 +00:00
if dontReact == false {
sm.Ethereum.Reactor().Post("newBlock", block)
state.manifest.Reset()
2014-03-20 10:20:29 +00:00
}
2014-05-13 15:51:33 +00:00
sm.Ethereum.Broadcast(ethwire.MsgBlockTy, []interface{}{block.Value().Val})
sm.Ethereum.TxPool().RemoveInvalid(state)
2014-02-14 22:56:09 +00:00
} else {
fmt.Println("total diff failed")
}
return nil
}
2014-03-05 09:57:32 +00:00
func (sm *StateManager) CalculateTD(block *Block) bool {
2014-02-14 22:56:09 +00:00
uncleDiff := new(big.Int)
for _, uncle := range block.Uncles {
uncleDiff = uncleDiff.Add(uncleDiff, uncle.Difficulty)
}
// TD(genesis_block) = 0 and TD(B) = TD(B.parent) + sum(u.difficulty for u in B.uncles) + B.difficulty
td := new(big.Int)
2014-03-05 09:57:32 +00:00
td = td.Add(sm.bc.TD, uncleDiff)
2014-02-14 22:56:09 +00:00
td = td.Add(td, block.Difficulty)
// The new TD will only be accepted if the new difficulty is
// is greater than the previous.
2014-03-05 09:57:32 +00:00
if td.Cmp(sm.bc.TD) > 0 {
2014-02-14 22:56:09 +00:00
// Set the new total difficulty back to the block chain
2014-03-05 09:57:32 +00:00
sm.bc.SetTotalDifficulty(td)
2014-02-14 22:56:09 +00:00
return true
}
return false
}
// Validates the current block. Returns an error if the block was invalid,
// an uncle or anything that isn't on the current block chain.
// Validation validates easy over difficult (dagger takes longer time = difficult)
2014-03-05 09:57:32 +00:00
func (sm *StateManager) ValidateBlock(block *Block) error {
2014-02-14 22:56:09 +00:00
// TODO
// 2. Check if the difficulty is correct
// Check each uncle's previous hash. In order for it to be valid
// is if it has the same block hash as the current
2014-03-05 09:57:32 +00:00
previousBlock := sm.bc.GetBlock(block.PrevHash)
2014-02-14 22:56:09 +00:00
for _, uncle := range block.Uncles {
if bytes.Compare(uncle.PrevHash, previousBlock.PrevHash) != 0 {
return ValidationError("Mismatch uncle's previous hash. Expected %x, got %x", previousBlock.PrevHash, uncle.PrevHash)
}
}
2014-03-05 09:57:32 +00:00
diff := block.Time - sm.bc.CurrentBlock.Time
2014-02-14 22:56:09 +00:00
if diff < 0 {
return ValidationError("Block timestamp less then prev block %v", diff)
}
// New blocks must be within the 15 minute range of the last block.
if diff > int64(15*time.Minute) {
return ValidationError("Block is too far in the future of last block (> 15 minutes)")
}
// Verify the nonce of the block. Return an error if it's not valid
2014-03-05 09:57:32 +00:00
if !sm.Pow.Verify(block.HashNoNonce(), block.Difficulty, block.Nonce) {
2014-03-17 10:13:35 +00:00
return ValidationError("Block's nonce is invalid (= %v)", ethutil.Hex(block.Nonce))
2014-02-14 22:56:09 +00:00
}
return nil
}
2014-02-18 00:33:26 +00:00
func CalculateBlockReward(block *Block, uncleLength int) *big.Int {
base := new(big.Int)
for i := 0; i < uncleLength; i++ {
base.Add(base, UncleInclusionReward)
}
lastCumulGasUsed := big.NewInt(0)
for _, r := range block.Receipts() {
usedGas := new(big.Int).Sub(r.CumulativeGasUsed, lastCumulGasUsed)
usedGas.Add(usedGas, r.Tx.GasPrice)
base.Add(base, usedGas)
}
2014-02-18 00:33:26 +00:00
return base.Add(base, BlockReward)
}
func CalculateUncleReward(block *Block) *big.Int {
return UncleReward
}
func (sm *StateManager) AccumelateRewards(state *State, block *Block) error {
// Get the account associated with the coinbase
account := state.GetAccount(block.Coinbase)
2014-02-14 22:56:09 +00:00
// Reward amount of ether to the coinbase address
account.AddAmount(CalculateBlockReward(block, len(block.Uncles)))
2014-02-14 22:56:09 +00:00
2014-04-09 14:04:36 +00:00
addr := make([]byte, len(block.Coinbase))
copy(addr, block.Coinbase)
state.UpdateStateObject(account)
2014-02-14 22:56:09 +00:00
2014-02-18 00:33:26 +00:00
for _, uncle := range block.Uncles {
uncleAccount := state.GetAccount(uncle.Coinbase)
uncleAccount.AddAmount(CalculateUncleReward(uncle))
2014-02-18 00:33:26 +00:00
state.UpdateStateObject(uncleAccount)
2014-02-18 00:33:26 +00:00
}
2014-02-14 22:56:09 +00:00
return nil
}
2014-03-05 09:57:32 +00:00
func (sm *StateManager) Stop() {
sm.bc.Stop()
2014-02-14 22:56:09 +00:00
}
2014-05-22 16:24:04 +00:00
func (sm *StateManager) EvalScript(state *State, script []byte, object *StateObject, tx *Transaction, block *Block) (ret []byte, err error) {
account := state.GetAccount(tx.Sender())
2014-04-26 00:11:00 +00:00
2014-05-22 16:24:04 +00:00
err = account.ConvertGas(tx.Gas, tx.GasPrice)
2014-04-26 00:11:00 +00:00
if err != nil {
ethutil.Config.Log.Debugln(err)
return
}
closure := NewClosure(account, object, script, state, tx.Gas, tx.GasPrice)
vm := NewVm(state, sm, RuntimeVars{
2014-04-26 00:11:00 +00:00
Origin: account.Address(),
2014-04-11 17:29:57 +00:00
BlockNumber: block.BlockInfo().Number,
PrevHash: block.PrevHash,
Coinbase: block.Coinbase,
Time: block.Time,
Diff: block.Difficulty,
2014-05-07 09:05:49 +00:00
Value: tx.Value,
2014-04-18 11:41:07 +00:00
//Price: tx.GasPrice,
2014-02-14 22:56:09 +00:00
})
2014-05-22 16:24:04 +00:00
ret, err = closure.Call(vm, tx.Data, nil)
2014-04-01 08:41:30 +00:00
// Update the account (refunds)
state.UpdateStateObject(account)
state.UpdateStateObject(object)
2014-05-22 16:24:04 +00:00
return
2014-04-25 23:47:55 +00:00
}
func (sm *StateManager) notifyChanges(state *State) {
for addr, stateObject := range state.manifest.objectChanges {
sm.Ethereum.Reactor().Post("object:"+addr, stateObject)
2014-04-25 23:47:55 +00:00
}
for stateObjectAddr, mappedObjects := range state.manifest.storageChanges {
for addr, value := range mappedObjects {
sm.Ethereum.Reactor().Post("storage:"+stateObjectAddr+":"+addr, &StorageState{[]byte(stateObjectAddr), []byte(addr), value})
}
}
}