aboutsummaryrefslogtreecommitdiffstats
path: root/chain/block_manager.go
blob: eda8a5a0c63ff4a94b13f7514b04d903acc53fdc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
package chain

import (
    "bytes"
    "container/list"
    "errors"
    "fmt"
    "math/big"
    "sync"
    "time"

    "github.com/ethereum/go-ethereum/chain/types"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/ethutil"
    "github.com/ethereum/go-ethereum/event"
    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/state"
    "github.com/ethereum/go-ethereum/wire"
)

var statelogger = logger.NewLogger("BLOCK")

type Peer interface {
    Inbound() bool
    LastSend() time.Time
    LastPong() int64
    Host() []byte
    Port() uint16
    Version() string
    PingTime() string
    Connected() *int32
    Caps() *ethutil.Value
}

type EthManager interface {
    BlockManager() *BlockManager
    ChainManager() *ChainManager
    TxPool() *TxPool
    Broadcast(msgType wire.MsgType, data []interface{})
    PeerCount() int
    IsMining() bool
    IsListening() bool
    Peers() *list.List
    KeyManager() *crypto.KeyManager
    ClientIdentity() wire.ClientIdentity
    Db() ethutil.Database
    EventMux() *event.TypeMux
}

type BlockManager struct {
    // Mutex for locking the block processor. Blocks can only be handled one at a time
    mutex sync.Mutex
    // Canonical block chain
    bc *ChainManager
    // non-persistent key/value memory storage
    mem map[string]*big.Int
    // Proof of work used for validating
    Pow PoW
    // The ethereum manager interface
    eth 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.State
    // Mining state. The mining state is used purely and solely by the mining
    // operation.
    miningState *state.State

    // The last attempted block is mainly used for debugging purposes
    // This does not have to be a valid block and will be set during
    // 'Process' & canonical validation.
    lastAttemptedBlock *types.Block

    events event.Subscription
}

func NewBlockManager(ethereum EthManager) *BlockManager {
    sm := &BlockManager{
        mem: make(map[string]*big.Int),
        Pow: &EasyPow{},
        eth: ethereum,
        bc:  ethereum.ChainManager(),
    }
    sm.transState = ethereum.ChainManager().CurrentBlock.State().Copy()
    sm.miningState = ethereum.ChainManager().CurrentBlock.State().Copy()

    return sm
}

func (self *BlockManager) Start() {
    statelogger.Debugln("Starting block manager")
}

func (self *BlockManager) Stop() {
    statelogger.Debugln("Stopping state manager")
}

func (sm *BlockManager) CurrentState() *state.State {
    return sm.eth.ChainManager().CurrentBlock.State()
}

func (sm *BlockManager) TransState() *state.State {
    return sm.transState
}

func (sm *BlockManager) MiningState() *state.State {
    return sm.miningState
}

func (sm *BlockManager) NewMiningState() *state.State {
    sm.miningState = sm.eth.ChainManager().CurrentBlock.State().Copy()

    return sm.miningState
}

func (sm *BlockManager) ChainManager() *ChainManager {
    return sm.bc
}

func (sm *BlockManager) TransitionState(statedb *state.State, parent, block *types.Block) (receipts types.Receipts, err error) {
    coinbase := statedb.GetOrNewStateObject(block.Coinbase)
    coinbase.SetGasPool(block.CalcGasLimit(parent))

    // Process the transactions on to current block
    receipts, _, _, _, err = sm.ProcessTransactions(coinbase, statedb, block, parent, block.Transactions())
    if err != nil {
        return nil, err
    }

    return receipts, nil
}

func (self *BlockManager) ProcessTransactions(coinbase *state.StateObject, state *state.State, block, parent *types.Block, txs types.Transactions) (types.Receipts, types.Transactions, types.Transactions, types.Transactions, error) {
    var (
        receipts           types.Receipts
        handled, unhandled types.Transactions
        erroneous          types.Transactions
        totalUsedGas       = big.NewInt(0)
        err                error
        cumulativeSum      = new(big.Int)
    )

done:
    for i, tx := range txs {
        // If we are mining this block and validating we want to set the logs back to 0
        state.EmptyLogs()

        txGas := new(big.Int).Set(tx.Gas)

        cb := state.GetStateObject(coinbase.Address())
        st := NewStateTransition(cb, tx, state, block)
        err = st.TransitionState()
        if err != nil {
            statelogger.Infoln(err)
            switch {
            case IsNonceErr(err):
                err = nil // ignore error
                continue
            case IsGasLimitErr(err):
                unhandled = txs[i:]

                break done
            default:
                statelogger.Infoln(err)
                erroneous = append(erroneous, tx)
                err = nil
                continue
            }
        }

        txGas.Sub(txGas, st.gas)
        cumulativeSum.Add(cumulativeSum, new(big.Int).Mul(txGas, tx.GasPrice))

        // Update the state with pending changes
        state.Update(txGas)

        cumulative := new(big.Int).Set(totalUsedGas.Add(totalUsedGas, txGas))
        receipt := types.NewReceipt(state.Root(), cumulative)
        receipt.SetLogs(state.Logs())
        receipt.Bloom = types.CreateBloom(types.Receipts{receipt})

        // Notify all subscribers
        go self.eth.EventMux().Post(TxPostEvent{tx})

        receipts = append(receipts, receipt)
        handled = append(handled, tx)

        if ethutil.Config.Diff && ethutil.Config.DiffType == "all" {
            state.CreateOutputForDiff()
        }
    }

    block.Reward = cumulativeSum
    block.GasUsed = totalUsedGas

    return receipts, handled, unhandled, erroneous, err
}

func (sm *BlockManager) Process(block *types.Block) (td *big.Int, msgs state.Messages, err error) {
    // Processing a blocks may never happen simultaneously
    sm.mutex.Lock()
    defer sm.mutex.Unlock()

    if sm.bc.HasBlock(block.Hash()) {
        return nil, nil, &KnownBlockError{block.Number, block.Hash()}
    }

    if !sm.bc.HasBlock(block.PrevHash) {
        return nil, nil, ParentError(block.PrevHash)
    }
    parent := sm.bc.GetBlock(block.PrevHash)

    return sm.ProcessWithParent(block, parent)
}

func (sm *BlockManager) ProcessWithParent(block, parent *types.Block) (td *big.Int, messages state.Messages, err error) {
    sm.lastAttemptedBlock = block

    state := parent.State().Copy()

    // 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()

    if ethutil.Config.Diff && ethutil.Config.DiffType == "all" {
        fmt.Printf("## %x %x ##\n", block.Hash(), block.Number)
    }

    _, err = sm.TransitionState(state, parent, block)
    if err != nil {
        return
    }

    txSha := types.DeriveSha(block.Transactions())
    if bytes.Compare(txSha, block.TxSha) != 0 {
        err = fmt.Errorf("validating transaction root. received=%x got=%x", block.TxSha, txSha)
        return
    }

    /*
        receiptSha := types.DeriveSha(receipts)
        if bytes.Compare(receiptSha, block.ReceiptSha) != 0 {
            err = fmt.Errorf("validating receipt root. received=%x got=%x", block.ReceiptSha, receiptSha)
            return
        }
    */

    // Block validation
    if err = sm.ValidateBlock(block, parent); err != nil {
        return
    }

    if err = sm.AccumelateRewards(state, block, parent); err != nil {
        return
    }

    /*
        //block.receipts = receipts // although this isn't necessary it be in the future
        rbloom := types.CreateBloom(receipts)
        if bytes.Compare(rbloom, block.LogsBloom) != 0 {
            err = fmt.Errorf("unable to replicate block's bloom=%x", rbloom)
            return
        }
    */

    state.Update(ethutil.Big0)

    if !block.State().Cmp(state) {
        err = fmt.Errorf("invalid merkle root. received=%x got=%x", block.Root(), state.Root())
        return
    }

    // Calculate the new total difficulty and sync back to the db
    if td, ok := sm.CalculateTD(block); ok {
        // Sync the current block's state to the database and cancelling out the deferred Undo
        state.Sync()

        messages := state.Manifest().Messages
        state.Manifest().Reset()

        chainlogger.Infof("Processed block #%d (%x...)\n", block.Number, block.Hash()[0:4])

        sm.transState = state.Copy()

        sm.eth.TxPool().RemoveSet(block.Transactions())

        return td, messages, nil
    } else {
        return nil, nil, errors.New("total diff failed")
    }
}

func (sm *BlockManager) CalculateTD(block *types.Block) (*big.Int, bool) {
    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)
    td = td.Add(sm.bc.TD, uncleDiff)
    td = td.Add(td, block.Difficulty)

    // The new TD will only be accepted if the new difficulty is
    // is greater than the previous.
    if td.Cmp(sm.bc.TD) > 0 {
        return td, true
    }

    return nil, 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)
func (sm *BlockManager) ValidateBlock(block, parent *types.Block) error {
    expd := CalcDifficulty(block, parent)
    if expd.Cmp(block.Difficulty) < 0 {
        return fmt.Errorf("Difficulty check failed for block %v, %v", block.Difficulty, expd)
    }

    diff := block.Time - parent.Time
    if diff < 0 {
        return ValidationError("Block timestamp less then prev block %v (%v - %v)", diff, block.Time, sm.bc.CurrentBlock.Time)
    }

    /* XXX
    // 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
    if !sm.Pow.Verify(block.HashNoNonce(), block.Difficulty, block.Nonce) {
        return ValidationError("Block's nonce is invalid (= %v)", ethutil.Bytes2Hex(block.Nonce))
    }

    return nil
}

func (sm *BlockManager) AccumelateRewards(statedb *state.State, block, parent *types.Block) error {
    reward := new(big.Int).Set(BlockReward)

    knownUncles := ethutil.Set(parent.Uncles)
    nonces := ethutil.NewSet(block.Nonce)
    for _, uncle := range block.Uncles {
        if nonces.Include(uncle.Nonce) {
            // Error not unique
            return UncleError("Uncle not unique")
        }

        uncleParent := sm.bc.GetBlock(uncle.PrevHash)
        if uncleParent == nil {
            return UncleError(fmt.Sprintf("Uncle's parent unknown (%x)", uncle.PrevHash[0:4]))
        }

        if uncleParent.Number.Cmp(new(big.Int).Sub(parent.Number, big.NewInt(6))) < 0 {
            return UncleError("Uncle too old")
        }

        if knownUncles.Include(uncle.Hash()) {
            return UncleError("Uncle in chain")
        }

        nonces.Insert(uncle.Nonce)

        r := new(big.Int)
        r.Mul(BlockReward, big.NewInt(15)).Div(r, big.NewInt(16))

        uncleAccount := statedb.GetAccount(uncle.Coinbase)
        uncleAccount.AddAmount(r)

        reward.Add(reward, new(big.Int).Div(BlockReward, big.NewInt(32)))
    }

    // Get the account associated with the coinbase
    account := statedb.GetAccount(block.Coinbase)
    // Reward amount of ether to the coinbase address
    account.AddAmount(reward)

    statedb.Manifest().AddMessage(&state.Message{
        To: block.Coinbase, From: block.Coinbase,
        Input:  nil,
        Origin: nil,
        Block:  block.Hash(), Timestamp: block.Time, Coinbase: block.Coinbase, Number: block.Number,
        Value: new(big.Int).Add(reward, block.Reward),
    })

    return nil
}

func (sm *BlockManager) GetMessages(block *types.Block) (messages []*state.Message, err error) {
    if !sm.bc.HasBlock(block.PrevHash) {
        return nil, ParentError(block.PrevHash)
    }

    sm.lastAttemptedBlock = block

    var (
        parent = sm.bc.GetBlock(block.PrevHash)
        state  = parent.State().Copy()
    )

    defer state.Reset()

    sm.TransitionState(state, parent, block)
    sm.AccumelateRewards(state, block, parent)

    return state.Manifest().Messages, nil
}