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
|
// 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 test
import (
"encoding/hex"
"errors"
"fmt"
"reflect"
"sort"
"sync"
"time"
"github.com/dexon-foundation/dexon-consensus/common"
"github.com/dexon-foundation/dexon-consensus/core/crypto"
"github.com/dexon-foundation/dexon-consensus/core/crypto/ecdsa"
"github.com/dexon-foundation/dexon-consensus/core/types"
typesDKG "github.com/dexon-foundation/dexon-consensus/core/types/dkg"
)
// Governance is an implementation of Goverance for testing purpose.
type Governance struct {
configs []*types.Config
nodeSets [][]crypto.PublicKey
state *State
pendingConfigChanges map[uint64]map[StateChangeType]interface{}
lock sync.RWMutex
}
// NewGovernance constructs a Governance instance.
func NewGovernance(genesisNodes []crypto.PublicKey,
lambda time.Duration) (g *Governance, err error) {
// Setup a State instance.
// TODO(mission): it's not a good idea to embed initialization of one
// public class in another, I did this to make the range of
// modification smaller.
g = &Governance{
pendingConfigChanges: make(map[uint64]map[StateChangeType]interface{}),
state: NewState(genesisNodes, lambda, true),
}
return
}
// NodeSet implements Governance interface to return current
// notary set.
func (g *Governance) NodeSet(round uint64) []crypto.PublicKey {
if round == 0 || round == 1 {
// Round 0, 1 are genesis round, their configs should be created
// by default.
g.CatchUpWithRound(round)
}
g.lock.RLock()
defer g.lock.RUnlock()
if round >= uint64(len(g.nodeSets)) {
return nil
}
return g.nodeSets[round]
}
// Configuration returns the configuration at a given block height.
func (g *Governance) Configuration(round uint64) *types.Config {
if round == 0 || round == 1 {
// Round 0, 1 are genesis round, their configs should be created
// by default.
g.CatchUpWithRound(round)
}
g.lock.RLock()
defer g.lock.RUnlock()
if round >= uint64(len(g.configs)) {
return nil
}
return g.configs[round]
}
// CRS returns the CRS for a given round.
func (g *Governance) CRS(round uint64) common.Hash {
return g.state.CRS(round)
}
// NotifyRoundHeight notifies governace contract to snapshot config.
func (g *Governance) NotifyRoundHeight(round, height uint64) {
g.CatchUpWithRound(round)
// Apply change request for next round.
func() {
g.lock.Lock()
defer g.lock.Unlock()
for t, v := range g.pendingConfigChanges[round+1] {
if err := g.state.RequestChange(t, v); err != nil {
panic(err)
}
}
delete(g.pendingConfigChanges, round+1)
}()
}
// ProposeCRS propose a CRS.
func (g *Governance) ProposeCRS(round uint64, signedCRS []byte) {
g.lock.Lock()
defer g.lock.Unlock()
crs := crypto.Keccak256Hash(signedCRS)
if err := g.state.ProposeCRS(round, crs); err != nil {
// CRS can be proposed multiple times, other errors are not
// accepted.
if err != ErrDuplicatedChange {
panic(err)
}
}
}
// AddDKGComplaint add a DKGComplaint.
func (g *Governance) AddDKGComplaint(
round uint64, complaint *typesDKG.Complaint) {
if round != complaint.Round {
return
}
if g.IsDKGFinal(complaint.Round) {
return
}
g.state.RequestChange(StateAddDKGComplaint, complaint)
}
// DKGComplaints returns the DKGComplaints of round.
func (g *Governance) DKGComplaints(round uint64) []*typesDKG.Complaint {
return g.state.DKGComplaints(round)
}
// AddDKGMasterPublicKey adds a DKGMasterPublicKey.
func (g *Governance) AddDKGMasterPublicKey(
round uint64, masterPublicKey *typesDKG.MasterPublicKey) {
if round != masterPublicKey.Round {
return
}
g.state.RequestChange(StateAddDKGMasterPublicKey, masterPublicKey)
}
// DKGMasterPublicKeys returns the DKGMasterPublicKeys of round.
func (g *Governance) DKGMasterPublicKeys(
round uint64) []*typesDKG.MasterPublicKey {
return g.state.DKGMasterPublicKeys(round)
}
// AddDKGFinalize adds a DKG finalize message.
func (g *Governance) AddDKGFinalize(round uint64, final *typesDKG.Finalize) {
if round != final.Round {
return
}
g.state.RequestChange(StateAddDKGFinal, final)
}
// IsDKGFinal checks if DKG is final.
func (g *Governance) IsDKGFinal(round uint64) bool {
if round == 0 || round == 1 {
// Round 0, 1 are genesis round, their configs should be created
// by default.
g.CatchUpWithRound(round)
}
g.lock.RLock()
defer g.lock.RUnlock()
if round >= uint64(len(g.configs)) {
return false
}
return g.state.IsDKGFinal(round, int(g.configs[round].DKGSetSize)/3*2)
}
//
// Test Utilities
//
// State allows to access embed State instance.
func (g *Governance) State() *State {
return g.state
}
// CatchUpWithRound attempts to perform state snapshot to
// provide configuration/nodeSet for round R.
func (g *Governance) CatchUpWithRound(round uint64) {
if func() bool {
g.lock.RLock()
defer g.lock.RUnlock()
return uint64(len(g.configs)) > round
}() {
return
}
g.lock.Lock()
defer g.lock.Unlock()
for uint64(len(g.configs)) <= round {
config, nodeSet := g.state.Snapshot()
g.configs = append(g.configs, config)
g.nodeSets = append(g.nodeSets, nodeSet)
}
}
// Clone a governance instance with replicate internal state.
func (g *Governance) Clone() *Governance {
g.lock.RLock()
defer g.lock.RUnlock()
// Clone state.
copiedState := g.state.Clone()
// Clone configs.
copiedConfigs := []*types.Config{}
for _, c := range g.configs {
copiedConfigs = append(copiedConfigs, c.Clone())
}
// Clone node sets.
copiedPendingChanges := make(map[uint64]map[StateChangeType]interface{})
for round, forRound := range g.pendingConfigChanges {
copiedForRound := make(map[StateChangeType]interface{})
for k, v := range forRound {
copiedForRound[k] = v
}
copiedPendingChanges[round] = copiedForRound
}
// NOTE: here I assume the key is from ecdsa.
copiedNodeSets := [][]crypto.PublicKey{}
for _, nodeSetForRound := range g.nodeSets {
copiedNodeSet := []crypto.PublicKey{}
for _, node := range nodeSetForRound {
pubKey, err := ecdsa.NewPublicKeyFromByteSlice(node.Bytes())
if err != nil {
panic(err)
}
copiedNodeSet = append(copiedNodeSet, pubKey)
}
copiedNodeSets = append(copiedNodeSets, copiedNodeSet)
}
// Clone pending changes.
return &Governance{
configs: copiedConfigs,
state: copiedState,
nodeSets: copiedNodeSets,
pendingConfigChanges: copiedPendingChanges,
}
}
// Equal checks equality between two Governance instances.
func (g *Governance) Equal(other *Governance, checkState bool) bool {
// Check configs.
if !reflect.DeepEqual(g.configs, other.configs) {
return false
}
// Check node sets.
if len(g.nodeSets) != len(other.nodeSets) {
return false
}
// Check pending changes.
if !reflect.DeepEqual(g.pendingConfigChanges, other.pendingConfigChanges) {
return false
}
getSortedKeys := func(keys []crypto.PublicKey) (encoded []string) {
for _, key := range keys {
encoded = append(encoded, hex.EncodeToString(key.Bytes()))
}
sort.Strings(encoded)
return
}
for round, nodeSetsForRound := range g.nodeSets {
otherNodeSetsForRound := other.nodeSets[round]
if len(nodeSetsForRound) != len(otherNodeSetsForRound) {
return false
}
if !reflect.DeepEqual(
getSortedKeys(nodeSetsForRound),
getSortedKeys(otherNodeSetsForRound)) {
return false
}
}
// Check state if needed.
//
// While testing, it's expected that two governance instances contain
// different state, only the snapshots (configs and node sets) are
// essentially equal.
if checkState {
return g.state.Equal(other.state) == nil
}
return true
}
// RegisterConfigChange tells this governance instance to request some
// configuration change at some round.
// NOTE: you can't request config change for round 0, 1, they are genesis
// rounds.
// NOTE: this function should be called before running.
func (g *Governance) RegisterConfigChange(
round uint64, t StateChangeType, v interface{}) (err error) {
if t < StateChangeNumChains || t > StateChangeDKGSetSize {
return fmt.Errorf("state changes to register is not supported: %v", t)
}
if round < 2 {
return errors.New(
"attempt to register state change for genesis rounds")
}
g.lock.Lock()
defer g.lock.Unlock()
if round <= uint64(len(g.configs)) {
return errors.New(
"attempt to register state change for prepared rounds")
}
pendingChangesForRound, exists := g.pendingConfigChanges[round]
if !exists {
pendingChangesForRound = make(map[StateChangeType]interface{})
g.pendingConfigChanges[round] = pendingChangesForRound
}
pendingChangesForRound[t] = v
return nil
}
|