aboutsummaryrefslogtreecommitdiffstats
path: root/dex/app.go
blob: 7d9c9e13a10a97d07966bd23ab6020c81b8029f7 (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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus library is free software: you can redistribute it
// and/or modify 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 dexon-consensus library is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
// General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.

package dex

import (
    "fmt"
    "math/big"
    "sync"
    "time"

    coreCommon "github.com/dexon-foundation/dexon-consensus/common"
    coreTypes "github.com/dexon-foundation/dexon-consensus/core/types"

    "github.com/dexon-foundation/dexon/common"
    "github.com/dexon-foundation/dexon/core"
    "github.com/dexon-foundation/dexon/core/types"
    "github.com/dexon-foundation/dexon/core/vm"
    "github.com/dexon-foundation/dexon/ethdb"
    "github.com/dexon-foundation/dexon/log"
    "github.com/dexon-foundation/dexon/rlp"
)

const (
    verifyBlockMaxRetries = 4
)

// DexconApp implementes the DEXON consensus core application interface.
type DexconApp struct {
    txPool     *core.TxPool
    blockchain *core.BlockChain
    gov        *DexconGovernance
    chainDB    ethdb.Database
    config     *Config
    vmConfig   vm.Config

    chainLocksInitMu sync.Mutex
    chainLocks       map[uint32]*sync.RWMutex

    notifyMu        sync.Mutex
    notifyChan      sync.Map
    chainLatestRoot sync.Map
}

type notify struct {
    results []chan uint64
}

type witnessData struct {
    Root        common.Hash
    TxHash      common.Hash
    ReceiptHash common.Hash
}

func NewDexconApp(txPool *core.TxPool, blockchain *core.BlockChain, gov *DexconGovernance,
    chainDB ethdb.Database, config *Config, vmConfig vm.Config) *DexconApp {
    return &DexconApp{
        txPool:     txPool,
        blockchain: blockchain,
        gov:        gov,
        chainDB:    chainDB,
        config:     config,
        vmConfig:   vmConfig,
        chainLocks: make(map[uint32]*sync.RWMutex),
    }
}

func (d *DexconApp) addNotify(height uint64) <-chan uint64 {
    d.notifyMu.Lock()
    defer d.notifyMu.Unlock()

    result := make(chan uint64)
    v, ok := d.notifyChan.Load(height)
    if ok {
        n := v.(*notify)
        n.results = append(n.results, result)
    } else {
        n := &notify{results: []chan uint64{result}}
        d.notifyChan.Store(height, n)
    }
    return result
}

func (d *DexconApp) notify(height uint64) {
    d.notifyMu.Lock()
    defer d.notifyMu.Unlock()

    d.notifyChan.Range(func(key, value interface{}) bool {
        h := key.(uint64)
        n := value.(*notify)

        if height >= h {
            for _, ch := range n.results {
                ch <- height
            }
            d.notifyChan.Delete(key)
        }
        return true
    })
}

func (d *DexconApp) addrBelongsToChain(address common.Address, chainSize, chainID *big.Int) bool {
    return new(big.Int).Mod(address.Big(), chainSize).Cmp(chainID) == 0
}

func (d *DexconApp) chainLockInit(chainID uint32) {
    d.chainLocksInitMu.Lock()
    defer d.chainLocksInitMu.Unlock()

    _, exist := d.chainLocks[chainID]
    if !exist {
        d.chainLocks[chainID] = &sync.RWMutex{}
    }
}

func (d *DexconApp) chainLock(chainID uint32) {
    d.chainLockInit(chainID)
    d.chainLocks[chainID].Lock()
}

func (d *DexconApp) chainUnlock(chainID uint32) {
    d.chainLocks[chainID].Unlock()
}

func (d *DexconApp) chainRLock(chainID uint32) {
    d.chainLockInit(chainID)
    d.chainLocks[chainID].RLock()
}

func (d *DexconApp) chainRUnlock(chainID uint32) {
    d.chainLocks[chainID].RUnlock()
}

// validateNonce check if nonce is in order and return first nonce of every address.
func (d *DexconApp) validateNonce(txs types.Transactions) (map[common.Address]uint64, error) {
    addressFirstNonce := map[common.Address]uint64{}
    addressNonce := map[common.Address]uint64{}

    for _, tx := range txs {
        msg, err := tx.AsMessage(types.MakeSigner(d.blockchain.Config(), new(big.Int)))
        if err != nil {
            return nil, err
        }

        if _, exist := addressFirstNonce[msg.From()]; exist {
            if addressNonce[msg.From()]+1 != msg.Nonce() {
                return nil, fmt.Errorf("address nonce check error: expect %v actual %v",
                    addressNonce[msg.From()]+1, msg.Nonce())
            }
            addressNonce[msg.From()] = msg.Nonce()
        } else {
            addressNonce[msg.From()] = msg.Nonce()
            addressFirstNonce[msg.From()] = msg.Nonce()
        }
    }
    return addressFirstNonce, nil
}

// PreparePayload is called when consensus core is preparing payload for block.
func (d *DexconApp) PreparePayload(position coreTypes.Position) (payload []byte, err error) {
    d.chainRLock(position.ChainID)
    defer d.chainRUnlock(position.ChainID)

    if position.Height != 0 {
        // Check if chain block height is strictly increamental.
        chainLastHeight := d.blockchain.GetChainLastConfirmedHeight(position.ChainID)
        if chainLastHeight != position.Height-1 {
            log.Error("Check confirmed block height fail",
                "chain", position.ChainID, "height", position.Height-1, "cache height", chainLastHeight)
            return nil, fmt.Errorf("check confirmed block height fail")
        }
    }

    var root *common.Hash
    value, ok := d.chainLatestRoot.Load(position.ChainID)
    if ok {
        root = value.(*common.Hash)
    } else {
        currentRoot := d.blockchain.CurrentBlock().Root()
        root = &currentRoot
    }

    // Set state to the chain latest height.
    latestState, err := d.blockchain.StateAt(*root)
    if err != nil {
        log.Error("Get pending state", "error", err)
        return nil, fmt.Errorf("get pending state error: %v", err)
    }

    txsMap, err := d.txPool.Pending()
    if err != nil {
        return
    }

    chainID := new(big.Int).SetUint64(uint64(position.ChainID))
    chainNums := new(big.Int).SetUint64(uint64(d.gov.GetNumChains(position.Round)))
    blockGasLimit := new(big.Int).SetUint64(core.CalcGasLimit(d.blockchain.CurrentBlock(),
        d.config.GasFloor, d.config.GasCeil))
    blockGasUsed := new(big.Int)
    var allTxs types.Transactions

addressMap:
    for address, txs := range txsMap {
        // TX hash need to be slot to the given chain in order to be included in the block.
        if !d.addrBelongsToChain(address, chainNums, chainID) {
            continue
        }

        balance := latestState.GetBalance(address)
        cost, exist := d.blockchain.GetCostInConfirmedBlocks(position.ChainID, address)
        if exist {
            balance = new(big.Int).Sub(balance, cost)
        }

        var expectNonce uint64
        lastConfirmedNonce, exist := d.blockchain.GetLastNonceInConfirmedBlocks(position.ChainID, address)
        if !exist {
            expectNonce = latestState.GetNonce(address)
        } else {
            expectNonce = lastConfirmedNonce + 1
        }

        for _, tx := range txs {
            if expectNonce == tx.Nonce() {
                expectNonce++
            } else if expectNonce < tx.Nonce() {
                break
            } else if expectNonce > tx.Nonce() {
                log.Debug("Skipping tx with smaller nonce then expected", "expected", expectNonce, "nonce", tx.Nonce())
                continue
            }

            intrGas, err := core.IntrinsicGas(tx.Data(), tx.To() == nil, true)
            if err != nil {
                log.Error("Failed to calculate intrinsic gas", "error", err)
                return nil, fmt.Errorf("calculate intrinsic gas error: %v", err)
            }
            if tx.Gas() < intrGas {
                log.Error("Intrinsic gas too low", "txHash", tx.Hash().String())
                break
            }

            balance = new(big.Int).Sub(balance, tx.Cost())
            if balance.Cmp(big.NewInt(0)) < 0 {
                log.Warn("Insufficient funds for gas * price + value", "txHash", tx.Hash().String())
                break
            }

            blockGasUsed = new(big.Int).Add(blockGasUsed, big.NewInt(int64(tx.Gas())))
            if blockGasUsed.Cmp(blockGasLimit) > 0 {
                break addressMap
            }

            allTxs = append(allTxs, tx)
        }
    }

    return rlp.EncodeToBytes(&allTxs)
}

// PrepareWitness will return the witness data no lower than consensusHeight.
func (d *DexconApp) PrepareWitness(consensusHeight uint64) (witness coreTypes.Witness, err error) {
    var witnessBlock *types.Block
    lastPendingHeight := d.blockchain.GetPendingHeight()
    if lastPendingHeight == 0 && consensusHeight == 0 {
        witnessBlock = d.blockchain.CurrentBlock()
    } else if lastPendingHeight >= consensusHeight {
        witnessBlock = d.blockchain.GetPendingBlock()
    } else if h := <-d.addNotify(consensusHeight); h >= consensusHeight {
        witnessBlock = d.blockchain.GetPendingBlock()
    } else {
        log.Error("need pending block")
        return witness, fmt.Errorf("need pending block")
    }

    witnessData, err := rlp.EncodeToBytes(&witnessData{
        Root:        witnessBlock.Root(),
        TxHash:      witnessBlock.TxHash(),
        ReceiptHash: witnessBlock.ReceiptHash(),
    })
    if err != nil {
        return
    }

    return coreTypes.Witness{
        Height: witnessBlock.NumberU64(),
        Data:   witnessData,
    }, nil
}

// VerifyBlock verifies if the payloads are valid.
func (d *DexconApp) VerifyBlock(block *coreTypes.Block) coreTypes.BlockVerifyStatus {
    var witnessData witnessData
    err := rlp.DecodeBytes(block.Witness.Data, &witnessData)
    if err != nil {
        log.Error("failed to RLP decode witness data", "error", err)
        return coreTypes.VerifyInvalidBlock
    }

    // Wait until the witnessed root is seen on our local chain.
    for i := 0; i < verifyBlockMaxRetries && err != nil; i++ {
        _, err = d.blockchain.StateAt(witnessData.Root)
        if err != nil {
            log.Debug("Witness root not found, retry in 500ms", "error", err)
            time.Sleep(500 * time.Millisecond)
        }
    }

    if err != nil {
        log.Error("Expected witness root not in stateDB", "err", err)
        return coreTypes.VerifyRetryLater
    }

    d.chainRLock(block.Position.ChainID)
    defer d.chainRUnlock(block.Position.ChainID)

    if block.Position.Height != 0 {
        // Check if target block is the next height to be verified, we can only
        // verify the next block in a given chain.
        chainLastHeight := d.blockchain.GetChainLastConfirmedHeight(block.Position.ChainID)
        if chainLastHeight != block.Position.Height-1 {
            log.Error("Check confirmed block height fail", "chain", block.Position.ChainID,
                "height", block.Position.Height-1, "cache height", chainLastHeight)
            return coreTypes.VerifyRetryLater
        }
    }

    // Find the latest state for the given block height.
    var root *common.Hash
    value, ok := d.chainLatestRoot.Load(block.Position.ChainID)
    if ok {
        root = value.(*common.Hash)
    } else {
        currentRoot := d.blockchain.CurrentBlock().Root()
        root = &currentRoot
    }

    latestState, err := d.blockchain.StateAt(*root)
    if err != nil {
        log.Error("Failed to get pending state", "error", err)
        return coreTypes.VerifyInvalidBlock
    }

    var transactions types.Transactions
    err = rlp.DecodeBytes(block.Payload, &transactions)
    if err != nil {
        log.Error("Payload rlp decode", "error", err)
        return coreTypes.VerifyInvalidBlock
    }

    _, err := transactions.TouchSenders(types.MakeSigner(d.blockchain.Config(), new(big.Int)))
    if err != nil {
        log.Error("Failed to calculate sender", "error", err)
        return coreTypes.VerifyInvalidBlock
    }

    addressNonce, err := d.validateNonce(transactions)
    if err != nil {
        log.Error("Validate nonce failed", "error", err)
        return coreTypes.VerifyInvalidBlock
    }

    // Check if nonce is strictly increasing for every address.
    chainID := big.NewInt(int64(block.Position.ChainID))
    chainNums := big.NewInt(int64(d.gov.GetNumChains(block.Position.Round)))

    for address, firstNonce := range addressNonce {
        if !d.addrBelongsToChain(address, chainNums, chainID) {
            log.Error("Address does not belong to given chain ID", "address", address, "chainD", chainID)
            return coreTypes.VerifyInvalidBlock
        }

        var expectNonce uint64
        lastConfirmedNonce, exist := d.blockchain.GetLastNonceInConfirmedBlocks(block.Position.ChainID, address)
        if exist {
            expectNonce = lastConfirmedNonce + 1
        } else {
            expectNonce = latestState.GetNonce(address)
        }

        if expectNonce != firstNonce {
            log.Error("Nonce check error", "expect", expectNonce, "firstNonce", firstNonce)
            return coreTypes.VerifyInvalidBlock
        }
    }

    // Calculate balance in last state (including pending state).
    addressesBalance := map[common.Address]*big.Int{}
    for address := range addressNonce {
        cost, exist := d.blockchain.GetCostInConfirmedBlocks(block.Position.ChainID, address)
        if exist {
            addressesBalance[address] = new(big.Int).Sub(latestState.GetBalance(address), cost)
        } else {
            addressesBalance[address] = latestState.GetBalance(address)
        }
    }

    // Validate if balance is enough for TXs in this block.
    blockGasLimit := new(big.Int).SetUint64(core.CalcGasLimit(
        d.blockchain.CurrentBlock(), d.config.GasFloor, d.config.GasCeil))
    blockGasUsed := new(big.Int)

    for _, tx := range transactions {
        msg, err := tx.AsMessage(types.MakeSigner(d.blockchain.Config(), new(big.Int)))
        if err != nil {
            log.Error("Failed to convert tx to message", "error", err)
            return coreTypes.VerifyInvalidBlock
        }
        balance, _ := addressesBalance[msg.From()]
        intrGas, err := core.IntrinsicGas(msg.Data(), msg.To() == nil, true)
        if err != nil {
            log.Error("Failed to calculate intrinsic gas", "err", err)
            return coreTypes.VerifyInvalidBlock
        }
        if tx.Gas() < intrGas {
            log.Error("Intrinsic gas too low", "txHash", tx.Hash().String(), "intrinsic", intrGas, "gas", tx.Gas())
            return coreTypes.VerifyInvalidBlock
        }

        balance = new(big.Int).Sub(balance, tx.Cost())
        if balance.Cmp(big.NewInt(0)) < 0 {
            log.Error("Insufficient funds for gas * price + value", "txHash", tx.Hash().String())
            return coreTypes.VerifyInvalidBlock
        }

        blockGasUsed = new(big.Int).Add(blockGasUsed, new(big.Int).SetUint64(tx.Gas()))
        if blockGasUsed.Cmp(blockGasLimit) > 0 {
            log.Error("Reach block gas limit", "gasUsed", blockGasUsed)
            return coreTypes.VerifyInvalidBlock
        }
        addressesBalance[msg.From()] = balance
    }

    return coreTypes.VerifyOK
}

// BlockDelivered is called when a block is add to the compaction chain.
func (d *DexconApp) BlockDelivered(
    blockHash coreCommon.Hash,
    blockPosition coreTypes.Position,
    result coreTypes.FinalizationResult) {

    chainID := blockPosition.ChainID
    d.chainLock(chainID)
    defer d.chainUnlock(chainID)

    block := d.blockchain.GetConfirmedBlockByHash(chainID, blockHash)
    if block == nil {
        panic("Can not get confirmed block")
    }

    var transactions types.Transactions
    err := rlp.DecodeBytes(block.Payload, &transactions)
    if err != nil {
        log.Error("Payload rlp decode failed", "error", err)
        panic(err)
    }

    block.Payload = nil
    dexconMeta, err := rlp.EncodeToBytes(block)
    if err != nil {
        panic(err)
    }

    newBlock := types.NewBlock(&types.Header{
        Number:     new(big.Int).SetUint64(result.Height),
        Time:       big.NewInt(result.Timestamp.UnixNano() / 1000000),
        Coinbase:   common.BytesToAddress(block.ProposerID.Bytes()),
        GasLimit:   d.gov.DexconConfiguration(block.Position.Round).BlockGasLimit,
        Difficulty: big.NewInt(1),
        Round:      block.Position.Round,
        DexconMeta: dexconMeta,
        Randomness: result.Randomness,
    }, transactions, nil, nil)

    root, err := d.blockchain.ProcessPendingBlock(newBlock, &block.Witness)
    if err != nil {
        log.Error("Failed to process pending block", "error", err)
        panic(err)
    }
    d.chainLatestRoot.Store(block.Position.ChainID, root)

    log.Info("Insert pending block success", "height", result.Height)
    d.blockchain.RemoveConfirmedBlock(chainID, blockHash)
    d.notify(result.Height)
}

// BlockConfirmed is called when a block is confirmed and added to lattice.
func (d *DexconApp) BlockConfirmed(block coreTypes.Block) {
    d.chainLock(block.Position.ChainID)
    defer d.chainUnlock(block.Position.ChainID)

    d.blockchain.AddConfirmedBlock(&block)
}