aboutsummaryrefslogtreecommitdiffstats
path: root/dex/app.go
blob: 6c6d8da5306475abb97bc26217cc8911f8aa5571 (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
// Copyright 2018 The dexon-consensus-core Authors
// This file is part of the dexon-consensus-core library.
//
// The dexon-consensus-core 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-core 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-core library. If not, see
// <http://www.gnu.org/licenses/>.

package dex

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

    coreCommon "github.com/dexon-foundation/dexon-consensus-core/common"
    coreTypes "github.com/dexon-foundation/dexon-consensus-core/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"
)

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

    notifyChan map[uint64]*notify
    notifyMu   sync.Mutex

    chainLatestRootMu sync.RWMutex
    chainLatestRoot   map[uint32]*common.Hash

    insertMu sync.Mutex

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

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,
        notifyChan:      make(map[uint64]*notify),
        chainLocks:      make(map[uint32]*sync.RWMutex),
        chainLatestRoot: make(map[uint32]*common.Hash),
    }
}

func (d *DexconApp) addNotify(height uint64) <-chan uint64 {
    d.notifyMu.Lock()
    defer d.notifyMu.Unlock()
    result := make(chan uint64)
    if n, exist := d.notifyChan[height]; exist {
        n.results = append(n.results, result)
    } else {
        d.notifyChan[height] = &notify{}
        d.notifyChan[height].results = append(d.notifyChan[height].results, result)
    }
    return result
}

func (d *DexconApp) notify(height uint64) {
    d.notifyMu.Lock()
    defer d.notifyMu.Unlock()
    for h, n := range d.notifyChan {
        if height >= h {
            for _, ch := range n.results {
                ch <- height
            }
            delete(d.notifyChan, h)
        }
    }
}

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

// 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 sequential
        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")
        }
    }

    root := d.getChainLatestRoot(position.ChainID)
    if root == nil {
        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 {
        // every address's transactions will appear in fixed chain
        if !d.checkChain(address, chainNums, chainID) {
            continue
        }

        var expectNonce uint64
        // get last nonce from confirmed blocks
        lastConfirmedNonce, exist := d.blockchain.GetLastNonceInConfirmedBlocks(address)
        if !exist {
            // get expect nonce from latest state when confirmed block is empty
            expectNonce = latestState.GetNonce(address)
        } else {
            expectNonce = lastConfirmedNonce + 1
        }

        if expectNonce != txs[0].Nonce() {
            log.Debug("Nonce check error", "expect", expectNonce, "nonce", txs[0].Nonce())
            continue
        }

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

        for _, tx := range txs {
            maxGasUsed := new(big.Int).Mul(new(big.Int).SetUint64(tx.Gas()), tx.GasPrice())
            intrinsicGas, err := core.IntrinsicGas(tx.Data(), tx.To() == nil, true)
            if err != nil {
                log.Error("Calculate intrinsic gas fail", "err", err)
                return nil, fmt.Errorf("calculate intrinsic gas error: %v", err)
            }
            if big.NewInt(int64(intrinsicGas)).Cmp(maxGasUsed) > 0 {
                log.Warn("Intrinsic gas is larger than (gas limit * gas price)", "intrinsic", intrinsicGas, "maxGasUsed", maxGasUsed)
                break
            }

            balance = new(big.Int).Sub(balance, tx.Cost())
            if balance.Cmp(big.NewInt(0)) < 0 {
                log.Error("Tx fail", "reason", "not enough balance")
                break
            }

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

            allTxs = append(allTxs, tx)
        }
    }
    payload, err = rlp.EncodeToBytes(&allTxs)
    if err != nil {
        return
    }

    return
}

// 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.GetLastPendingHeight()
    if lastPendingHeight == 0 && consensusHeight == 0 {
        witnessBlock = d.blockchain.CurrentBlock()
    } else if lastPendingHeight >= consensusHeight {
        witnessBlock = d.blockchain.GetLastPendingBlock()
    } else if h := <-d.addNotify(consensusHeight); h >= consensusHeight {
        witnessBlock = d.blockchain.GetLastPendingBlock()
    } 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.Decode(bytes.NewReader(block.Witness.Data), &witnessData)
    if err != nil {
        log.Error("Witness rlp decode", "error", err)
        return coreTypes.VerifyInvalidBlock
    }

    for i := 0; i < 6 && err != nil; i++ {
        // check witness root exist
        err = nil
        _, err = d.blockchain.StateAt(witnessData.Root)
        if err != nil {
            log.Debug("Sleep 0.5 seconds and try again", "error", err)
            time.Sleep(500 * time.Millisecond)
        }
    }
    if err != nil {
        log.Error("Expect 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 chain block height is sequential
        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
        }
    }

    root := d.getChainLatestRoot(block.Position.ChainID)
    if root == nil {
        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 coreTypes.VerifyInvalidBlock
    }

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

    // check if nonce is sequential and return first nonce of every address
    addresses, err := d.validateNonce(transactions)
    if err != nil {
        log.Error("Get address nonce", "error", err)
        return coreTypes.VerifyInvalidBlock
    }

    // check all address nonce
    chainID := big.NewInt(int64(block.Position.ChainID))
    chainNums := new(big.Int).SetUint64(uint64(d.gov.GetNumChains(block.Position.Round)))
    for address, firstNonce := range addresses {
        if !d.checkChain(address, chainNums, chainID) {
            log.Error("check chain fail", "address", address)
            return coreTypes.VerifyInvalidBlock
        }

        var expectNonce uint64
        // get last nonce from confirmed blocks
        lastConfirmedNonce, exist := d.blockchain.GetLastNonceInConfirmedBlocks(address)
        if !exist {
            // get expect nonce from latest state when confirmed block is empty
            expectNonce = latestState.GetNonce(address)
        } else {
            expectNonce = lastConfirmedNonce + 1
        }

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

    // get balance from state
    addressesBalance := map[common.Address]*big.Int{}
    for address := range addresses {
        // replay confirmed block tx to correct balance
        cost, exist := d.blockchain.GetCostInConfirmedBlocks(address)
        if exist {
            addressesBalance[address] = new(big.Int).Sub(latestState.GetBalance(address), cost)
        } else {
            addressesBalance[address] = latestState.GetBalance(address)
        }
    }

    // validate tx to check available balance
    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("Tx to message", "error", err)
            return coreTypes.VerifyInvalidBlock
        }
        balance, _ := addressesBalance[msg.From()]
        maxGasUsed := new(big.Int).Mul(new(big.Int).SetUint64(msg.Gas()), msg.GasPrice())
        intrinsicGas, err := core.IntrinsicGas(msg.Data(), msg.To() == nil, true)
        if err != nil {
            log.Error("Calculate intrinsic gas fail", "err", err)
            return coreTypes.VerifyInvalidBlock
        }
        if big.NewInt(int64(intrinsicGas)).Cmp(maxGasUsed) > 0 {
            log.Error("Intrinsic gas is larger than (gas limit * gas price)", "intrinsic", intrinsicGas, "maxGasUsed", maxGasUsed)
            return coreTypes.VerifyInvalidBlock
        }

        balance = new(big.Int).Sub(balance, tx.Cost())
        if balance.Cmp(big.NewInt(0)) < 0 {
            log.Error("Tx fail", "reason", "not enough balance")
            return coreTypes.VerifyInvalidBlock
        }

        blockGasUsed = new(big.Int).Add(blockGasUsed, new(big.Int).SetUint64(tx.Gas()))
        if blockGasLimit.Cmp(blockGasUsed) < 0 {
            log.Error("Reach block gas limit", "limit", blockGasLimit)
            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, result coreTypes.FinalizationResult) {
    d.insertMu.Lock()
    defer d.insertMu.Unlock()

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

    d.chainLock(block.Position.ChainID)
    defer d.chainUnlock(block.Position.ChainID)

    var transactions types.Transactions
    err := rlp.Decode(bytes.NewReader(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.Unix()),
        Coinbase: common.BytesToAddress(block.ProposerID.Bytes()),
        // TODO(bojie): fix it
        GasLimit:   8000000,
        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("Insert chain", "error", err)
        panic(err)
    }
    d.setChainLatestRoot(block.Position.ChainID, root)

    log.Info("Insert pending block success", "height", result.Height)
    d.blockchain.RemoveConfirmedBlock(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)
}

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()
            continue
        } else {
            addressNonce[msg.From()] = msg.Nonce()
            addressFirstNonce[msg.From()] = msg.Nonce()
        }
    }

    return addressFirstNonce, nil
}

func (d *DexconApp) getChainLatestRoot(chainID uint32) *common.Hash {
    d.chainLatestRootMu.RLock()
    defer d.chainLatestRootMu.RUnlock()

    return d.chainLatestRoot[chainID]
}

func (d *DexconApp) setChainLatestRoot(chainID uint32, root *common.Hash) {
    d.chainLatestRootMu.Lock()
    defer d.chainLatestRootMu.Unlock()

    d.chainLatestRoot[chainID] = root
}

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