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
|
// 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 simulation
import (
"encoding/json"
"fmt"
"time"
"gitlab.com/byzantine-lab/tangerine-consensus/common"
"gitlab.com/byzantine-lab/tangerine-consensus/core"
"gitlab.com/byzantine-lab/tangerine-consensus/core/crypto"
"gitlab.com/byzantine-lab/tangerine-consensus/core/db"
"gitlab.com/byzantine-lab/tangerine-consensus/core/test"
"gitlab.com/byzantine-lab/tangerine-consensus/core/types"
"gitlab.com/byzantine-lab/tangerine-consensus/simulation/config"
)
type serverNotification string
const (
ntfShutdown serverNotification = "shutdown"
ntfSelectedAsMaster serverNotification = "as_master"
ntfReady serverNotification = "ready"
)
type messageType string
const (
setupOK messageType = "setupOK"
shutdownAck messageType = "shutdownAck"
blockTimestamp messageType = "blockTimestamps"
)
// message is a struct for peer sending message to server.
type message struct {
Type messageType `json:"type"`
Payload json.RawMessage `json:"payload"`
}
// node represents a node in DexCon.
type node struct {
app core.Application
db db.Database
gov *test.Governance
netModule *test.Network
ID types.NodeID
prvKey crypto.PrivateKey
logger common.Logger
consensus *core.Consensus
cfg *config.Config
}
// newNode returns a new empty node.
func newNode(prvKey crypto.PrivateKey, logger common.Logger,
cfg config.Config) *node {
pubKey := prvKey.PublicKey()
netModule := test.NewNetwork(pubKey, test.NetworkConfig{
Type: cfg.Networking.Type,
PeerServer: cfg.Networking.PeerServer,
PeerPort: peerPort,
DirectLatency: &test.NormalLatencyModel{
Mean: cfg.Networking.Direct.Mean,
Sigma: cfg.Networking.Direct.Sigma,
},
GossipLatency: &test.NormalLatencyModel{
Mean: cfg.Networking.Gossip.Mean,
Sigma: cfg.Networking.Gossip.Sigma,
},
Marshaller: test.NewDefaultMarshaller(&jsonMarshaller{})})
id := types.NewNodeID(pubKey)
dbInst, err := db.NewMemBackedDB(id.String() + ".db")
if err != nil {
panic(err)
}
// Sync config to state in governance.
gov, err := test.NewGovernance(
test.NewState(core.DKGDelayRound,
[]crypto.PublicKey{pubKey}, time.Millisecond, logger, true),
core.ConfigRoundShift)
if err != nil {
panic(err)
}
return &node{
ID: id,
prvKey: prvKey,
logger: logger,
app: newSimApp(id, netModule, gov.State()),
gov: gov,
db: dbInst,
netModule: netModule,
cfg: &cfg,
}
}
// GetID returns the ID of node.
func (n *node) GetID() types.NodeID {
return n.ID
}
// run starts the node.
func (n *node) run(
serverEndpoint interface{}) {
// Run network.
if err := n.netModule.Setup(serverEndpoint); err != nil {
panic(err)
}
msgChannel := n.netModule.ReceiveChanForNode()
peers := n.netModule.Peers()
dMoment := n.netModule.DMoment()
n.logger.Info("Simulation DMoment", "dMoment", dMoment)
go n.netModule.Run()
// Run consensus.
hashes := make(common.Hashes, 0, len(peers))
for _, pubKey := range peers {
nID := types.NewNodeID(pubKey)
if err :=
n.gov.State().RequestChange(test.StateAddNode, pubKey); err != nil {
panic(err)
}
hashes = append(hashes, nID.Hash)
}
n.prepareConfigs()
if err := n.netModule.Report(&message{Type: setupOK}); err != nil {
panic(err)
}
// Wait for a "ready" server notification.
readyLoop:
for {
msg := <-msgChannel
ntf := msg.(serverNotification)
switch ntf {
case ntfReady:
break readyLoop
case ntfSelectedAsMaster:
n.logger.Info(
"Receive 'selected-as-master' notification from server")
for _, c := range n.cfg.Node.Changes {
if c.Round <= core.ConfigRoundShift+1 {
continue
}
n.logger.Info("Register config change", "change", c)
if err := c.RegisterChange(n.gov); err != nil {
panic(err)
}
}
default:
panic(fmt.Errorf("receive unexpected server notification: %v", ntf))
}
}
// Setup Consensus.
n.consensus = core.NewConsensusForSimulation(
dMoment,
n.app,
n.gov,
n.db,
n.netModule,
n.prvKey,
n.logger)
go n.consensus.Run(make(chan struct{}))
// Blocks forever.
MainLoop:
for {
msg := <-msgChannel
switch val := msg.(type) {
case serverNotification:
if val == ntfShutdown {
n.logger.Info("Receive shutdown notification from server")
break MainLoop
}
default:
panic(fmt.Errorf("Unexpected message from server: %v", val))
}
}
// Cleanup.
n.consensus.Stop()
if err := n.db.Close(); err != nil {
fmt.Println(err)
}
if err := n.netModule.Report(&message{Type: shutdownAck}); err != nil {
panic(err)
}
// TODO(mission): once we have a way to know if consensus is stopped, stop
// the network module.
return
}
func (n *node) prepareConfigs() {
// Prepare configurations.
cConfig := n.cfg.Node.Consensus
n.gov.State().RequestChange(
test.StateChangeNotarySetSize, cConfig.NotarySetSize) // #nosec G104
n.gov.State().RequestChange(test.StateChangeLambdaBA, time.Duration(
cConfig.LambdaBA)*time.Millisecond) // #nosec G104
n.gov.State().RequestChange(test.StateChangeLambdaDKG, time.Duration(
cConfig.LambdaDKG)*time.Millisecond) // #nosec G104
n.gov.State().RequestChange(test.StateChangeRoundLength, cConfig.RoundLength) // #nosec G104
n.gov.State().RequestChange(test.StateChangeMinBlockInterval, time.Duration(
cConfig.MinBlockInterval)*time.Millisecond) // #nosec G104
n.gov.State().ProposeCRS(0, crypto.Keccak256Hash([]byte(cConfig.GenesisCRS))) // #nosec G104
// These rounds are not safe to be registered as pending state change
// requests.
for i := uint64(0); i <= core.ConfigRoundShift+1; i++ {
n.logger.Info("Prepare config", "round", i)
prepareConfigs(i, n.cfg.Node.Changes, n.gov)
}
// This notification is implictly called in full node.
n.gov.NotifyRound(0, 0)
// Setup of configuration is ready, can be switched to remote mode.
n.gov.SwitchToRemoteMode(n.netModule)
}
|