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
|
// 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 core
import (
"math/rand"
"testing"
"time"
"github.com/dexon-foundation/dexon-consensus/common"
"github.com/dexon-foundation/dexon-consensus/core/crypto/ecdsa"
"github.com/dexon-foundation/dexon-consensus/core/db"
"github.com/dexon-foundation/dexon-consensus/core/test"
"github.com/dexon-foundation/dexon-consensus/core/types"
"github.com/dexon-foundation/dexon-consensus/core/utils"
"github.com/stretchr/testify/suite"
)
// testLatticeMgr wraps compaction chain and lattice.
type testLatticeMgr struct {
lattice *Lattice
ccModule *compactionChain
app *test.App
db db.Database
}
func (mgr *testLatticeMgr) prepareBlock(
chainID uint32) (b *types.Block, err error) {
b = &types.Block{
Position: types.Position{
ChainID: chainID,
}}
err = mgr.lattice.PrepareBlock(b, time.Now().UTC())
return
}
// Process describes the usage of Lattice.ProcessBlock.
func (mgr *testLatticeMgr) processBlock(b *types.Block) (err error) {
var (
delivered []*types.Block
)
if err = mgr.lattice.SanityCheck(b); err != nil {
if err == ErrRetrySanityCheckLater {
err = nil
} else {
return
}
}
if err = mgr.db.PutBlock(*b); err != nil {
if err != db.ErrBlockExists {
return
}
err = nil
}
if delivered, err = mgr.lattice.ProcessBlock(b); err != nil {
return
}
// Deliver blocks.
for _, b = range delivered {
if err = mgr.ccModule.processBlock(b); err != nil {
return
}
}
for _, b = range mgr.ccModule.extractBlocks() {
if err = mgr.db.UpdateBlock(*b); err != nil {
return
}
mgr.app.BlockDelivered(b.Hash, b.Position, b.Finalization)
}
if err = mgr.lattice.PurgeBlocks(delivered); err != nil {
return
}
return
}
type LatticeTestSuite struct {
suite.Suite
}
func (s *LatticeTestSuite) newTestLatticeMgr(
cfg *types.Config, dMoment time.Time) *testLatticeMgr {
var req = s.Require()
// Setup private key.
prvKey, err := ecdsa.NewPrivateKey()
req.NoError(err)
// Setup db.
dbInst, err := db.NewMemBackedDB()
req.NoError(err)
// Setup governance.
logger := &common.NullLogger{}
_, pubKeys, err := test.NewKeys(int(cfg.NotarySetSize))
req.NoError(err)
gov, err := test.NewGovernance(test.NewState(
pubKeys, cfg.LambdaBA, logger, true), ConfigRoundShift)
req.NoError(err)
// Setup application.
app := test.NewApp(gov.State())
// Setup compaction chain.
cc := newCompactionChain(gov)
cc.init(&types.Block{})
mock := newMockTSigVerifier(true)
for i := 0; i < cc.tsigVerifier.cacheSize; i++ {
cc.tsigVerifier.verifier[uint64(i)] = mock
}
// Setup lattice.
return &testLatticeMgr{
ccModule: cc,
app: app,
db: dbInst,
lattice: NewLattice(
dMoment,
0,
cfg,
utils.NewSigner(prvKey),
app,
app,
dbInst,
logger)}
}
func (s *LatticeTestSuite) TestBasicUsage() {
// One Lattice prepare blocks on chains randomly selected each time
// and process it. Those generated blocks and kept into a buffer, and
// process by other Lattice instances with random order.
var (
blockNum = 100
chainNum = uint32(19)
otherLatticeNum = 20
req = s.Require()
err error
cfg = types.Config{
NumChains: chainNum,
NotarySetSize: chainNum,
PhiRatio: float32(2) / float32(3),
K: 0,
MinBlockInterval: 0,
RoundInterval: time.Hour,
}
dMoment = time.Now().UTC()
master = s.newTestLatticeMgr(&cfg, dMoment)
apps = []*test.App{master.app}
revealSeq = map[string]struct{}{}
)
// Master-lattice generates blocks.
for i := uint32(0); i < chainNum; i++ {
// Produced genesis blocks should be delivered before all other blocks,
// or the consensus time would be wrong.
b, err := master.prepareBlock(i)
req.NotNil(b)
req.NoError(err)
// Ignore error "acking blocks don't exist".
req.NoError(master.processBlock(b))
}
for i := 0; i < (blockNum - int(chainNum)); i++ {
b, err := master.prepareBlock(uint32(rand.Intn(int(chainNum))))
req.NotNil(b)
req.NoError(err)
// Ignore error "acking blocks don't exist".
req.NoError(master.processBlock(b))
}
// Now we have some blocks, replay them on different lattices.
iter, err := master.db.GetAllBlocks()
req.NoError(err)
revealer, err := test.NewRandomBlockRevealer(iter)
req.NoError(err)
for i := 0; i < otherLatticeNum; i++ {
revealer.Reset()
revealed := ""
other := s.newTestLatticeMgr(&cfg, dMoment)
for {
b, err := revealer.NextBlock()
if err != nil {
if err == db.ErrIterationFinished {
err = nil
break
}
}
req.NoError(err)
req.NoError(other.processBlock(&b))
revealed += b.Hash.String() + ","
}
revealSeq[revealed] = struct{}{}
apps = append(apps, other.app)
}
// Make sure not only one revealing sequence.
req.True(len(revealSeq) > 1)
// Make sure nothing goes wrong.
for i, app := range apps {
err := app.Verify()
req.NoError(err)
for j, otherApp := range apps {
if i >= j {
continue
}
err := app.Compare(otherApp)
s.NoError(err)
}
}
}
func (s *LatticeTestSuite) TestSanityCheck() {
// This sanity check focuses on hash/signature part.
var (
chainNum = uint32(19)
cfg = types.Config{
NumChains: chainNum,
PhiRatio: float32(2) / float32(3),
K: 0,
MinBlockInterval: 0,
}
lattice = s.newTestLatticeMgr(&cfg, time.Now().UTC()).lattice
signer = lattice.signer // Steal signer module from lattice, :(
req = s.Require()
err error
)
// A block properly signed should pass sanity check.
b := &types.Block{
Position: types.Position{ChainID: 0},
Timestamp: time.Now().UTC(),
}
req.NoError(signer.SignBlock(b))
req.NoError(lattice.SanityCheck(b))
// A block with incorrect signature should not pass sanity check.
otherPrvKey, err := ecdsa.NewPrivateKey()
req.NoError(err)
b.Signature, err = otherPrvKey.Sign(common.NewRandomHash())
req.Equal(lattice.SanityCheck(b), ErrIncorrectSignature)
// A block with un-sorted acks should not pass sanity check.
b.Acks = common.NewSortedHashes(common.Hashes{
common.NewRandomHash(),
common.NewRandomHash(),
common.NewRandomHash(),
common.NewRandomHash(),
common.NewRandomHash(),
})
b.Acks[0], b.Acks[1] = b.Acks[1], b.Acks[0]
req.NoError(signer.SignBlock(b))
req.Equal(lattice.SanityCheck(b), ErrAcksNotSorted)
// A block with incorrect hash should not pass sanity check.
b.Hash = common.NewRandomHash()
req.Equal(lattice.SanityCheck(b), ErrIncorrectHash)
}
func TestLattice(t *testing.T) {
suite.Run(t, new(LatticeTestSuite))
}
|
