aboutsummaryrefslogtreecommitdiffstats
path: root/dex/app.go
blob: 8caa84837f0475a5251eeebf6fafd25b48e97117 (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
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
// 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 (
    "bytes"
    "context"
    "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/ethdb"
    "github.com/dexon-foundation/dexon/event"
    "github.com/dexon-foundation/dexon/log"
    "github.com/dexon-foundation/dexon/rlp"
)

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

    finalizedBlockFeed event.Feed
    scope              event.SubscriptionScope

    appMu sync.RWMutex

    confirmedBlocks map[coreCommon.Hash]*blockInfo
    addressNonce    map[common.Address]uint64
    addressCost     map[common.Address]*big.Int
    addressCounter  map[common.Address]uint64
    undeliveredNum  uint64
    deliveredHeight uint64
}

func NewDexconApp(txPool *core.TxPool, blockchain *core.BlockChain, gov *DexconGovernance,
    chainDB ethdb.Database, config *Config) *DexconApp {
    return &DexconApp{
        txPool:          txPool,
        blockchain:      blockchain,
        gov:             gov,
        chainDB:         chainDB,
        config:          config,
        confirmedBlocks: map[coreCommon.Hash]*blockInfo{},
        addressNonce:    map[common.Address]uint64{},
        addressCost:     map[common.Address]*big.Int{},
        addressCounter:  map[common.Address]uint64{},
    }
}

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

// validateGasPrice checks if no gas price is lower than minGasPrice defined in
// governance contract.
func (d *DexconApp) validateGasPrice(txs types.Transactions, round uint64) bool {
    minGasPrice := d.gov.MinGasPrice(round)
    for _, tx := range txs {
        if minGasPrice.Cmp(tx.GasPrice()) > 0 {
            return false
        }
    }
    return true
}

// PreparePayload is called when consensus core is preparing payload for block.
func (d *DexconApp) PreparePayload(position coreTypes.Position) (payload []byte, err error) {
    // softLimit limits the runtime of inner call to preparePayload.
    // hardLimit limits the runtime of outer PreparePayload.
    // If hardLimit is hit, it is possible that no payload is prepared.
    softLimit := 100 * time.Millisecond
    hardLimit := 150 * time.Millisecond
    ctx, cancel := context.WithTimeout(context.Background(), hardLimit)
    defer cancel()
    payloadCh := make(chan []byte, 1)
    errCh := make(chan error, 1)
    doneCh := make(chan struct{}, 1)
    go func() {
        ctx, cancel := context.WithTimeout(context.Background(), softLimit)
        defer cancel()
        payload, err := d.preparePayload(ctx, position)
        if err != nil {
            errCh <- err
        }
        payloadCh <- payload
        doneCh <- struct{}{}
    }()
    select {
    case <-ctx.Done():
    case <-doneCh:
    }
    select {
    case err = <-errCh:
        if err != nil {
            return
        }
    default:
    }
    select {
    case payload = <-payloadCh:
    default:
    }
    return
}

func (d *DexconApp) preparePayload(ctx context.Context, position coreTypes.Position) (
    payload []byte, err error) {
    d.appMu.RLock()
    defer d.appMu.RUnlock()
    select {
    // This case will hit if previous RLock took too much time.
    case <-ctx.Done():
        return
    default:
    }

    // deliver height = position height + 1
    if d.deliveredHeight+d.undeliveredNum != position.Height {
        return nil, fmt.Errorf("expected height %d but get %d", d.deliveredHeight+d.undeliveredNum, position.Height)
    }

    deliveredBlock := d.blockchain.GetBlockByNumber(d.deliveredHeight)
    state, err := d.blockchain.StateAt(deliveredBlock.Root())
    if err != nil {
        return nil, fmt.Errorf("get state by root %v error: %v", deliveredBlock.Root(), err)
    }

    log.Debug("Prepare payload", "height", position.Height)

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

    blockGasLimit := new(big.Int).SetUint64(d.gov.DexconConfiguration(position.Round).BlockGasLimit)
    blockGasUsed := new(big.Int)
    allTxs := make([]*types.Transaction, 0, 10000)

addressMap:
    for address, txs := range txsMap {
        select {
        case <-ctx.Done():
            break addressMap
        default:
        }

        balance := state.GetBalance(address)
        cost, exist := d.addressCost[address]
        if exist {
            balance = new(big.Int).Sub(balance, cost)
        }

        var expectNonce uint64
        lastConfirmedNonce, exist := d.addressNonce[address]
        if !exist {
            expectNonce = state.GetNonce(address)
        } else {
            expectNonce = lastConfirmedNonce + 1
        }

        if len(txs) == 0 {
            continue
        }

        firstNonce := txs[0].Nonce()
        startIndex := int(expectNonce - firstNonce)

        // Warning: the pending tx will also affect by syncing, so startIndex maybe negative
        for i := startIndex; i >= 0 && i < len(txs); i++ {
            tx := txs[i]
            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
    if d.blockchain.CurrentBlock().NumberU64() >= consensusHeight {
        witnessBlock = d.blockchain.CurrentBlock()
    } else {
        log.Error("Current height too low", "lastPendingHeight", d.blockchain.CurrentBlock().NumberU64(),
            "consensusHeight", consensusHeight)
        return witness, fmt.Errorf("current height < consensus height")
    }

    witnessData, err := rlp.EncodeToBytes(witnessBlock.Hash())
    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 witnessBlockHash common.Hash
    err := rlp.DecodeBytes(block.Witness.Data, &witnessBlockHash)
    if err != nil {
        log.Error("Failed to RLP decode witness data", "error", err)
        return coreTypes.VerifyInvalidBlock
    }

    // Validate witness height.
    if d.blockchain.CurrentBlock().NumberU64() < block.Witness.Height {
        log.Debug("Current height < witness height")
        return coreTypes.VerifyRetryLater
    }

    b := d.blockchain.GetBlockByNumber(block.Witness.Height)
    if b == nil {
        log.Error("Can not get block by height", "height", block.Witness.Height)
        return coreTypes.VerifyInvalidBlock
    }

    if b.Hash() != witnessBlockHash {
        log.Error("Witness block hash not match",
            "expect", b.Hash().String(), "got", witnessBlockHash.String())
        return coreTypes.VerifyInvalidBlock
    }

    _, err = d.blockchain.StateAt(b.Root())
    if err != nil {
        log.Error("Get state by root %v error: %v", b.Root(), err)
        return coreTypes.VerifyInvalidBlock
    }

    d.appMu.RLock()
    defer d.appMu.RUnlock()

    // deliver height = position height + 1
    if d.deliveredHeight+d.undeliveredNum != block.Position.Height {
        return coreTypes.VerifyRetryLater
    }

    var transactions types.Transactions
    if len(block.Payload) == 0 {
        return coreTypes.VerifyOK
    }

    deliveredBlock := d.blockchain.GetBlockByNumber(d.deliveredHeight)
    state, err := d.blockchain.StateAt(deliveredBlock.Root())
    if err != nil {
        return coreTypes.VerifyInvalidBlock
    }

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

    _, err = types.GlobalSigCache.Add(types.NewEIP155Signer(d.blockchain.Config().ChainID), transactions)
    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
    }
    if !d.validateGasPrice(transactions, block.Position.Round) {
        log.Error("Validate gas price failed")
        return coreTypes.VerifyInvalidBlock
    }

    for address, firstNonce := range addressNonce {
        var expectNonce uint64
        nonce, exist := d.addressNonce[address]
        if exist {
            expectNonce = nonce + 1
        } else {
            expectNonce = state.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.addressCost[address]
        if exist {
            addressesBalance[address] = new(big.Int).Sub(state.GetBalance(address), cost)
        } else {
            addressesBalance[address] = state.GetBalance(address)
        }
    }

    // Validate if balance is enough for TXs in this block.
    blockGasLimit := new(big.Int).SetUint64(d.gov.DexconConfiguration(block.Position.Round).BlockGasLimit)
    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) {

    log.Debug("DexconApp block deliver", "height", result.Height, "hash", blockHash, "position", blockPosition.String())
    defer log.Debug("DexconApp block delivered", "height", result.Height, "hash", blockHash, "position", blockPosition.String())

    d.appMu.Lock()
    defer d.appMu.Unlock()

    block, txs := d.getConfirmedBlockByHash(blockHash)
    if block == nil {
        panic("Can not get confirmed block")
    }

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

    var owner common.Address
    if !block.IsEmpty() {
        gs := d.gov.GetStateForConfigAtRound(block.Position.Round)
        node, err := gs.GetNodeByID(block.ProposerID)
        if err != nil {
            panic(err)
        }
        owner = node.Owner
    }

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

    if block.IsEmpty() {
        _, err = d.blockchain.ProcessEmptyBlock(newBlock)
        if err != nil {
            log.Error("Failed to process empty block", "error", err)
            panic(err)
        }
    } else {
        _, err = d.blockchain.ProcessBlock(newBlock, &block.Witness)
        if err != nil {
            log.Error("Failed to process pending block", "error", err)
            panic(err)
        }
    }

    d.removeConfirmedBlock(blockHash)
    d.deliveredHeight = result.Height

    // New blocks are finalized, notify other components.
    go d.finalizedBlockFeed.Send(core.NewFinalizedBlockEvent{Block: d.blockchain.CurrentBlock()})
}

// BlockConfirmed is called when a block is confirmed and added to lattice.
func (d *DexconApp) BlockConfirmed(block coreTypes.Block) {
    d.appMu.Lock()
    defer d.appMu.Unlock()

    log.Debug("DexconApp block confirmed", "block", block.String())
    if err := d.addConfirmedBlock(&block); err != nil {
        panic(err)
    }
}

type addressInfo struct {
    cost *big.Int
}

type blockInfo struct {
    addresses map[common.Address]*addressInfo
    block     *coreTypes.Block
    txs       types.Transactions
}

func (d *DexconApp) addConfirmedBlock(block *coreTypes.Block) error {
    var transactions types.Transactions
    if len(block.Payload) != 0 {
        err := rlp.Decode(bytes.NewReader(block.Payload), &transactions)
        if err != nil {
            return err
        }
        _, err = types.GlobalSigCache.Add(types.NewEIP155Signer(d.blockchain.Config().ChainID), transactions)
        if err != nil {
            return err
        }
    }

    addressMap := map[common.Address]*addressInfo{}
    for _, tx := range transactions {
        msg, err := tx.AsMessage(types.MakeSigner(d.blockchain.Config(), new(big.Int)))
        if err != nil {
            return err
        }

        if addrInfo, exist := addressMap[msg.From()]; !exist {
            addressMap[msg.From()] = &addressInfo{cost: tx.Cost()}
        } else {
            addrInfo.cost = new(big.Int).Add(addrInfo.cost, tx.Cost())
        }

        // get latest nonce in block
        if nonce, exist := d.addressNonce[msg.From()]; !exist || nonce < msg.Nonce() {
            d.addressNonce[msg.From()] = msg.Nonce()
        } else {
            return fmt.Errorf("address %v nonce incorrect cached(%d) >= tx(%d)", msg.From(), nonce, msg.Nonce())
        }

        // calculate max cost in confirmed blocks
        if d.addressCost[msg.From()] == nil {
            d.addressCost[msg.From()] = big.NewInt(0)
        }
        d.addressCost[msg.From()] = new(big.Int).Add(d.addressCost[msg.From()], tx.Cost())
    }

    for addr := range addressMap {
        d.addressCounter[addr]++
    }

    d.confirmedBlocks[block.Hash] = &blockInfo{
        addresses: addressMap,
        block:     block,
        txs:       transactions,
    }

    d.undeliveredNum++
    return nil
}

func (d *DexconApp) removeConfirmedBlock(hash coreCommon.Hash) {
    blockInfo := d.confirmedBlocks[hash]
    for addr, info := range blockInfo.addresses {
        d.addressCounter[addr]--
        d.addressCost[addr] = new(big.Int).Sub(d.addressCost[addr], info.cost)
        if d.addressCounter[addr] == 0 {
            delete(d.addressCounter, addr)
            delete(d.addressCost, addr)
            delete(d.addressNonce, addr)
        }
    }

    delete(d.confirmedBlocks, hash)
    d.undeliveredNum--
}

func (d *DexconApp) getConfirmedBlockByHash(hash coreCommon.Hash) (*coreTypes.Block, types.Transactions) {
    info, exist := d.confirmedBlocks[hash]
    if !exist {
        return nil, nil
    }

    return info.block, info.txs
}

func (d *DexconApp) SubscribeNewFinalizedBlockEvent(
    ch chan<- core.NewFinalizedBlockEvent) event.Subscription {
    return d.scope.Track(d.finalizedBlockFeed.Subscribe(ch))
}

func (d *DexconApp) Stop() {
    d.scope.Close()
}