aboutsummaryrefslogtreecommitdiffstats
path: root/integration_test/validator.go
blob: bfe517f1d6daa2208abb3600b203aadc06ffd887 (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
// 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 integration

import (
    "fmt"
    "sort"
    "time"

    "github.com/dexon-foundation/dexon-consensus-core/blockdb"
    "github.com/dexon-foundation/dexon-consensus-core/common"
    "github.com/dexon-foundation/dexon-consensus-core/core"
    "github.com/dexon-foundation/dexon-consensus-core/core/test"
    "github.com/dexon-foundation/dexon-consensus-core/core/types"
    "github.com/dexon-foundation/dexon-consensus-core/crypto"
    "github.com/dexon-foundation/dexon-consensus-core/crypto/eth"
)

type consensusEventType int

const (
    evtProposeBlock consensusEventType = iota
    evtReceiveBlock
)

type consensusEventPayload struct {
    Type      consensusEventType
    PiggyBack interface{}
}

// NewProposeBlockEvent constructs an test.Event that would trigger
// block proposing.
func NewProposeBlockEvent(vID types.ValidatorID, when time.Time) *test.Event {
    return test.NewEvent(vID, when, &consensusEventPayload{
        Type: evtProposeBlock,
    })
}

// NewReceiveBlockEvent constructs an test.Event that would trigger
// block received.
func NewReceiveBlockEvent(
    vID types.ValidatorID, when time.Time, block *types.Block) *test.Event {

    return test.NewEvent(vID, when, &consensusEventPayload{
        Type:      evtReceiveBlock,
        PiggyBack: block,
    })
}

// Validator is designed to work with test.Scheduler.
type Validator struct {
    ID               types.ValidatorID
    chainID          uint32
    cons             *core.Consensus
    gov              core.Governance
    networkLatency   LatencyModel
    proposingLatency LatencyModel
}

// NewValidator constructs an instance of Validator.
func NewValidator(
    app core.Application,
    gov core.Governance,
    db blockdb.BlockDatabase,
    privateKey crypto.PrivateKey,
    vID types.ValidatorID,
    networkLatency LatencyModel,
    proposingLatency LatencyModel) *Validator {

    hashes := make(common.Hashes, 0)
    for vID := range gov.GetValidatorSet() {
        hashes = append(hashes, vID.Hash)
    }
    sort.Sort(hashes)
    chainID := uint32(0)
    for i, hash := range hashes {
        if hash == vID.Hash {
            chainID = uint32(i)
            break
        }
    }

    return &Validator{
        ID:               vID,
        chainID:          chainID,
        gov:              gov,
        networkLatency:   networkLatency,
        proposingLatency: proposingLatency,
        cons: core.NewConsensus(
            app, gov,
            db, &Network{}, time.NewTicker(1), privateKey, eth.SigToPub),
    }
}

// Handle implements test.EventHandler interface.
func (v *Validator) Handle(e *test.Event) (events []*test.Event) {
    payload := e.Payload.(*consensusEventPayload)
    switch payload.Type {
    case evtProposeBlock:
        events, e.ExecError = v.handleProposeBlock(e.Time, payload.PiggyBack)
    case evtReceiveBlock:
        events, e.ExecError = v.handleReceiveBlock(payload.PiggyBack)
    default:
        panic(fmt.Errorf("unknown consensus event type: %v", payload.Type))
    }
    return
}

func (v *Validator) handleProposeBlock(when time.Time, piggyback interface{}) (
    events []*test.Event, err error) {

    b := &types.Block{
        ProposerID: v.ID,
        Position: types.Position{
            ChainID: v.chainID,
        },
    }
    defer types.RecycleBlock(b)
    if err = v.cons.PrepareBlock(b, when); err != nil {
        return
    }
    if err = v.cons.ProcessBlock(b); err != nil {
        return
    }
    // Create 'block received' event for each other validators.
    for vID := range v.gov.GetValidatorSet() {
        if vID == v.ID {
            continue
        }
        events = append(events, NewReceiveBlockEvent(
            vID, when.Add(v.networkLatency.Delay()), b.Clone()))
    }
    // Create next 'block proposing' event for this validators.
    events = append(events, NewProposeBlockEvent(
        v.ID, when.Add(v.proposingLatency.Delay())))
    return
}

func (v *Validator) handleReceiveBlock(piggyback interface{}) (
    events []*test.Event, err error) {

    err = v.cons.ProcessBlock(piggyback.(*types.Block))
    if err != nil {
        panic(err)
    }
    return
}