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
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
|
// 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 (
"context"
"encoding/hex"
"fmt"
"sync"
"time"
"github.com/tangerine-network/tangerine-consensus/common"
"github.com/tangerine-network/tangerine-consensus/core/crypto"
cryptoDKG "github.com/tangerine-network/tangerine-consensus/core/crypto/dkg"
"github.com/tangerine-network/tangerine-consensus/core/db"
"github.com/tangerine-network/tangerine-consensus/core/types"
typesDKG "github.com/tangerine-network/tangerine-consensus/core/types/dkg"
"github.com/tangerine-network/tangerine-consensus/core/utils"
)
// Errors for consensus core.
var (
ErrProposerNotInNodeSet = fmt.Errorf(
"proposer is not in node set")
ErrIncorrectHash = fmt.Errorf(
"hash of block is incorrect")
ErrIncorrectSignature = fmt.Errorf(
"signature of block is incorrect")
ErrUnknownBlockProposed = fmt.Errorf(
"unknown block is proposed")
ErrIncorrectAgreementResultPosition = fmt.Errorf(
"incorrect agreement result position")
ErrNotEnoughVotes = fmt.Errorf(
"not enought votes")
ErrCRSNotReady = fmt.Errorf(
"CRS not ready")
ErrConfigurationNotReady = fmt.Errorf(
"Configuration not ready")
ErrIncorrectBlockRandomness = fmt.Errorf(
"randomness of block is incorrect")
ErrCannotVerifyBlockRandomness = fmt.Errorf(
"cannot verify block randomness")
)
type selfAgreementResult types.AgreementResult
// consensusBAReceiver implements agreementReceiver.
type consensusBAReceiver struct {
consensus *Consensus
agreementModule *agreement
emptyBlockHashMap *sync.Map
isNotary bool
restartNotary chan types.Position
npks *typesDKG.NodePublicKeys
psigSigner *dkgShareSecret
}
func (recv *consensusBAReceiver) emptyBlockHash(pos types.Position) (
common.Hash, error) {
hashVal, ok := recv.emptyBlockHashMap.Load(pos)
if ok {
return hashVal.(common.Hash), nil
}
emptyBlock, err := recv.consensus.bcModule.prepareBlock(
pos, time.Time{}, true)
if err != nil {
return common.Hash{}, err
}
hash, err := utils.HashBlock(emptyBlock)
if err != nil {
return common.Hash{}, err
}
recv.emptyBlockHashMap.Store(pos, hash)
return hash, nil
}
func (recv *consensusBAReceiver) VerifyPartialSignature(vote *types.Vote) (
bool, bool) {
if vote.Position.Round >= DKGDelayRound && vote.BlockHash != types.SkipBlockHash {
if vote.Type == types.VoteCom || vote.Type == types.VoteFastCom {
if recv.npks == nil {
recv.consensus.logger.Debug(
"Unable to verify psig, npks is nil",
"vote", vote)
return false, false
}
if vote.Position.Round != recv.npks.Round {
recv.consensus.logger.Debug(
"Unable to verify psig, round of npks mismatch",
"vote", vote,
"npksRound", recv.npks.Round)
return false, false
}
pubKey, exist := recv.npks.PublicKeys[vote.ProposerID]
if !exist {
recv.consensus.logger.Debug(
"Unable to verify psig, proposer is not qualified",
"vote", vote)
return false, true
}
blockHash := vote.BlockHash
if blockHash == types.NullBlockHash {
var err error
blockHash, err = recv.emptyBlockHash(vote.Position)
if err != nil {
recv.consensus.logger.Error(
"Failed to verify vote for empty block",
"position", vote.Position,
"error", err)
return false, true
}
}
return pubKey.VerifySignature(
blockHash, crypto.Signature(vote.PartialSignature)), true
}
}
return len(vote.PartialSignature.Signature) == 0, true
}
func (recv *consensusBAReceiver) ProposeVote(vote *types.Vote) {
if !recv.isNotary {
return
}
if recv.psigSigner != nil &&
vote.BlockHash != types.SkipBlockHash {
if vote.Type == types.VoteCom || vote.Type == types.VoteFastCom {
if vote.BlockHash == types.NullBlockHash {
hash, err := recv.emptyBlockHash(vote.Position)
if err != nil {
recv.consensus.logger.Error(
"Failed to propose vote for empty block",
"position", vote.Position,
"error", err)
return
}
vote.PartialSignature = recv.psigSigner.sign(hash)
} else {
vote.PartialSignature = recv.psigSigner.sign(vote.BlockHash)
}
}
}
if err := recv.agreementModule.prepareVote(vote); err != nil {
recv.consensus.logger.Error("Failed to prepare vote", "error", err)
return
}
go func() {
if err := recv.agreementModule.processVote(vote); err != nil {
recv.consensus.logger.Error("Failed to process self vote",
"error", err,
"vote", vote)
return
}
recv.consensus.logger.Debug("Calling Network.BroadcastVote",
"vote", vote)
recv.consensus.network.BroadcastVote(vote)
}()
}
func (recv *consensusBAReceiver) ProposeBlock() common.Hash {
if !recv.isNotary {
return common.Hash{}
}
block, err := recv.consensus.proposeBlock(recv.agreementModule.agreementID())
if err != nil || block == nil {
recv.consensus.logger.Error("Unable to propose block", "error", err)
return types.NullBlockHash
}
go func() {
if err := recv.consensus.preProcessBlock(block); err != nil {
recv.consensus.logger.Error("Failed to pre-process block", "error", err)
return
}
recv.consensus.logger.Debug("Calling Network.BroadcastBlock",
"block", block)
recv.consensus.network.BroadcastBlock(block)
}()
return block.Hash
}
func (recv *consensusBAReceiver) ConfirmBlock(
hash common.Hash, votes map[types.NodeID]*types.Vote) {
var (
block *types.Block
aID = recv.agreementModule.agreementID()
)
isEmptyBlockConfirmed := hash == common.Hash{}
if isEmptyBlockConfirmed {
recv.consensus.logger.Info("Empty block is confirmed", "position", aID)
var err error
block, err = recv.consensus.bcModule.addEmptyBlock(aID)
if err != nil {
recv.consensus.logger.Error("Add position for empty failed",
"error", err)
return
}
if block == nil {
// The empty block's parent is not found locally, thus we can't
// propose it at this moment.
//
// We can only rely on block pulling upon receiving
// types.AgreementResult from the next position.
recv.consensus.logger.Warn(
"An empty block is confirmed without its parent",
"position", aID)
return
}
} else {
var exist bool
block, exist = recv.agreementModule.findBlockNoLock(hash)
if !exist {
recv.consensus.logger.Debug("Unknown block confirmed",
"hash", hash.String()[:6])
ch := make(chan *types.Block)
func() {
recv.consensus.lock.Lock()
defer recv.consensus.lock.Unlock()
recv.consensus.baConfirmedBlock[hash] = ch
}()
go func() {
hashes := common.Hashes{hash}
PullBlockLoop:
for {
recv.consensus.logger.Debug("Calling Network.PullBlock for BA block",
"hash", hash)
recv.consensus.network.PullBlocks(hashes)
select {
case block = <-ch:
break PullBlockLoop
case <-time.After(1 * time.Second):
}
}
recv.consensus.logger.Debug("Receive unknown block",
"hash", hash.String()[:6],
"position", block.Position)
recv.agreementModule.addCandidateBlock(block)
recv.agreementModule.lock.Lock()
defer recv.agreementModule.lock.Unlock()
recv.ConfirmBlock(block.Hash, votes)
}()
return
}
}
if len(votes) == 0 && len(block.Randomness) == 0 {
recv.consensus.logger.Error("No votes to recover randomness",
"block", block)
} else if votes != nil {
voteList := make([]types.Vote, 0, len(votes))
IDs := make(cryptoDKG.IDs, 0, len(votes))
psigs := make([]cryptoDKG.PartialSignature, 0, len(votes))
for _, vote := range votes {
if vote.BlockHash != hash {
continue
}
if block.Position.Round >= DKGDelayRound {
ID, exist := recv.npks.IDMap[vote.ProposerID]
if !exist {
continue
}
IDs = append(IDs, ID)
psigs = append(psigs, vote.PartialSignature)
} else {
voteList = append(voteList, *vote)
}
}
if block.Position.Round >= DKGDelayRound {
rand, err := cryptoDKG.RecoverSignature(psigs, IDs)
if err != nil {
recv.consensus.logger.Warn("Unable to recover randomness",
"block", block,
"error", err)
} else {
block.Randomness = rand.Signature[:]
}
} else {
block.Randomness = NoRand
}
if recv.isNotary {
result := &types.AgreementResult{
BlockHash: block.Hash,
Position: block.Position,
Votes: voteList,
IsEmptyBlock: isEmptyBlockConfirmed,
Randomness: block.Randomness,
}
// touchAgreementResult does not support concurrent access.
go func() {
recv.consensus.priorityMsgChan <- (*selfAgreementResult)(result)
}()
recv.consensus.logger.Debug("Broadcast AgreementResult",
"result", result)
recv.consensus.network.BroadcastAgreementResult(result)
if block.IsEmpty() {
recv.consensus.bcModule.addBlockRandomness(
block.Position, block.Randomness)
}
if block.Position.Round >= DKGDelayRound {
recv.consensus.logger.Debug(
"Broadcast finalized block",
"block", block)
recv.consensus.network.BroadcastBlock(block)
}
}
}
if !block.IsGenesis() &&
!recv.consensus.bcModule.confirmed(block.Position.Height-1) {
go func(hash common.Hash) {
parentHash := hash
for {
recv.consensus.logger.Warn("Parent block not confirmed",
"parent-hash", parentHash.String()[:6],
"cur-position", block.Position)
ch := make(chan *types.Block)
if !func() bool {
recv.consensus.lock.Lock()
defer recv.consensus.lock.Unlock()
if _, exist := recv.consensus.baConfirmedBlock[parentHash]; exist {
return false
}
recv.consensus.baConfirmedBlock[parentHash] = ch
return true
}() {
return
}
var block *types.Block
PullBlockLoop:
for {
recv.consensus.logger.Debug("Calling Network.PullBlock for parent",
"hash", parentHash)
recv.consensus.network.PullBlocks(common.Hashes{parentHash})
select {
case block = <-ch:
break PullBlockLoop
case <-time.After(1 * time.Second):
}
}
recv.consensus.logger.Info("Receive parent block",
"parent-hash", block.ParentHash.String()[:6],
"cur-position", block.Position)
if !block.IsFinalized() {
// TODO(jimmy): use a seperate message to pull finalized
// block. Here, we pull it again as workaround.
continue
}
recv.consensus.processBlockChan <- block
parentHash = block.ParentHash
if block.IsGenesis() || recv.consensus.bcModule.confirmed(
block.Position.Height-1) {
return
}
}
}(block.ParentHash)
}
if !block.IsEmpty() {
recv.consensus.processBlockChan <- block
}
// Clean the restartNotary channel so BA will not stuck by deadlock.
CleanChannelLoop:
for {
select {
case <-recv.restartNotary:
default:
break CleanChannelLoop
}
}
recv.restartNotary <- block.Position
}
func (recv *consensusBAReceiver) PullBlocks(hashes common.Hashes) {
if !recv.isNotary {
return
}
recv.consensus.logger.Debug("Calling Network.PullBlocks", "hashes", hashes)
recv.consensus.network.PullBlocks(hashes)
}
func (recv *consensusBAReceiver) ReportForkVote(v1, v2 *types.Vote) {
recv.consensus.gov.ReportForkVote(v1, v2)
}
func (recv *consensusBAReceiver) ReportForkBlock(b1, b2 *types.Block) {
b1Clone := b1.Clone()
b2Clone := b2.Clone()
b1Clone.Payload = []byte{}
b2Clone.Payload = []byte{}
recv.consensus.gov.ReportForkBlock(b1Clone, b2Clone)
}
// consensusDKGReceiver implements dkgReceiver.
type consensusDKGReceiver struct {
ID types.NodeID
gov Governance
signer *utils.Signer
nodeSetCache *utils.NodeSetCache
cfgModule *configurationChain
network Network
logger common.Logger
}
// ProposeDKGComplaint proposes a DKGComplaint.
func (recv *consensusDKGReceiver) ProposeDKGComplaint(
complaint *typesDKG.Complaint) {
if err := recv.signer.SignDKGComplaint(complaint); err != nil {
recv.logger.Error("Failed to sign DKG complaint", "error", err)
return
}
recv.logger.Debug("Calling Governace.AddDKGComplaint",
"complaint", complaint)
recv.gov.AddDKGComplaint(complaint)
}
// ProposeDKGMasterPublicKey propose a DKGMasterPublicKey.
func (recv *consensusDKGReceiver) ProposeDKGMasterPublicKey(
mpk *typesDKG.MasterPublicKey) {
if err := recv.signer.SignDKGMasterPublicKey(mpk); err != nil {
recv.logger.Error("Failed to sign DKG master public key", "error", err)
return
}
recv.logger.Debug("Calling Governance.AddDKGMasterPublicKey", "key", mpk)
recv.gov.AddDKGMasterPublicKey(mpk)
}
// ProposeDKGPrivateShare propose a DKGPrivateShare.
func (recv *consensusDKGReceiver) ProposeDKGPrivateShare(
prv *typesDKG.PrivateShare) {
if err := recv.signer.SignDKGPrivateShare(prv); err != nil {
recv.logger.Error("Failed to sign DKG private share", "error", err)
return
}
receiverPubKey, exists := recv.nodeSetCache.GetPublicKey(prv.ReceiverID)
if !exists {
recv.logger.Error("Public key for receiver not found",
"receiver", prv.ReceiverID.String()[:6])
return
}
if prv.ReceiverID == recv.ID {
go func() {
if err := recv.cfgModule.processPrivateShare(prv); err != nil {
recv.logger.Error("Failed to process self private share", "prvShare", prv)
}
}()
} else {
recv.logger.Debug("Calling Network.SendDKGPrivateShare",
"receiver", hex.EncodeToString(receiverPubKey.Bytes()))
recv.network.SendDKGPrivateShare(receiverPubKey, prv)
}
}
// ProposeDKGAntiNackComplaint propose a DKGPrivateShare as an anti complaint.
func (recv *consensusDKGReceiver) ProposeDKGAntiNackComplaint(
prv *typesDKG.PrivateShare) {
if prv.ProposerID == recv.ID {
if err := recv.signer.SignDKGPrivateShare(prv); err != nil {
recv.logger.Error("Failed sign DKG private share", "error", err)
return
}
}
recv.logger.Debug("Calling Network.BroadcastDKGPrivateShare", "share", prv)
recv.network.BroadcastDKGPrivateShare(prv)
}
// ProposeDKGMPKReady propose a DKGMPKReady message.
func (recv *consensusDKGReceiver) ProposeDKGMPKReady(ready *typesDKG.MPKReady) {
if err := recv.signer.SignDKGMPKReady(ready); err != nil {
recv.logger.Error("Failed to sign DKG ready", "error", err)
return
}
recv.logger.Debug("Calling Governance.AddDKGMPKReady", "ready", ready)
recv.gov.AddDKGMPKReady(ready)
}
// ProposeDKGFinalize propose a DKGFinalize message.
func (recv *consensusDKGReceiver) ProposeDKGFinalize(final *typesDKG.Finalize) {
if err := recv.signer.SignDKGFinalize(final); err != nil {
recv.logger.Error("Failed to sign DKG finalize", "error", err)
return
}
recv.logger.Debug("Calling Governance.AddDKGFinalize", "final", final)
recv.gov.AddDKGFinalize(final)
}
// ProposeDKGSuccess propose a DKGSuccess message.
func (recv *consensusDKGReceiver) ProposeDKGSuccess(success *typesDKG.Success) {
if err := recv.signer.SignDKGSuccess(success); err != nil {
recv.logger.Error("Failed to sign DKG successize", "error", err)
return
}
recv.logger.Debug("Calling Governance.AddDKGSuccess", "success", success)
recv.gov.AddDKGSuccess(success)
}
// Consensus implements DEXON Consensus algorithm.
type Consensus struct {
// Node Info.
ID types.NodeID
signer *utils.Signer
// BA.
baMgr *agreementMgr
baConfirmedBlock map[common.Hash]chan<- *types.Block
// DKG.
dkgRunning int32
dkgReady *sync.Cond
cfgModule *configurationChain
// Interfaces.
db db.Database
app Application
debugApp Debug
gov Governance
network Network
// Misc.
bcModule *blockChain
dMoment time.Time
nodeSetCache *utils.NodeSetCache
tsigVerifierCache *TSigVerifierCache
lock sync.RWMutex
ctx context.Context
ctxCancel context.CancelFunc
event *common.Event
roundEvent *utils.RoundEvent
logger common.Logger
resetDeliveryGuardTicker chan struct{}
msgChan chan types.Msg
priorityMsgChan chan interface{}
waitGroup sync.WaitGroup
processBlockChan chan *types.Block
// Context of Dummy receiver during switching from syncer.
dummyCancel context.CancelFunc
dummyFinished <-chan struct{}
dummyMsgBuffer []types.Msg
}
// NewConsensus construct an Consensus instance.
func NewConsensus(
dMoment time.Time,
app Application,
gov Governance,
db db.Database,
network Network,
prv crypto.PrivateKey,
logger common.Logger) *Consensus {
return newConsensusForRound(
nil, dMoment, app, gov, db, network, prv, logger, true)
}
// NewConsensusForSimulation creates an instance of Consensus for simulation,
// the only difference with NewConsensus is nonblocking of app.
func NewConsensusForSimulation(
dMoment time.Time,
app Application,
gov Governance,
db db.Database,
network Network,
prv crypto.PrivateKey,
logger common.Logger) *Consensus {
return newConsensusForRound(
nil, dMoment, app, gov, db, network, prv, logger, false)
}
// NewConsensusFromSyncer constructs an Consensus instance from information
// provided from syncer.
//
// You need to provide the initial block for this newly created Consensus
// instance to bootstrap with. A proper choice is the last finalized block you
// delivered to syncer.
//
// NOTE: those confirmed blocks should be organized by chainID and sorted by
// their positions, in ascending order.
func NewConsensusFromSyncer(
initBlock *types.Block,
startWithEmpty bool,
dMoment time.Time,
app Application,
gov Governance,
db db.Database,
networkModule Network,
prv crypto.PrivateKey,
confirmedBlocks []*types.Block,
cachedMessages []types.Msg,
logger common.Logger) (*Consensus, error) {
// Setup Consensus instance.
con := newConsensusForRound(initBlock, dMoment, app, gov, db,
networkModule, prv, logger, true)
// Launch a dummy receiver before we start receiving from network module.
con.dummyMsgBuffer = cachedMessages
con.dummyCancel, con.dummyFinished = utils.LaunchDummyReceiver(
con.ctx, networkModule.ReceiveChan(), func(msg types.Msg) {
con.dummyMsgBuffer = append(con.dummyMsgBuffer, msg)
})
// Dump all BA-confirmed blocks to the consensus instance, make sure these
// added blocks forming a DAG.
refBlock := initBlock
for _, b := range confirmedBlocks {
// Only when its parent block is already added to lattice, we can
// then add this block. If not, our pulling mechanism would stop at
// the block we added, and lost its parent block forever.
if b.Position.Height != refBlock.Position.Height+1 {
break
}
if err := con.processBlock(b); err != nil {
return nil, err
}
refBlock = b
}
if startWithEmpty {
emptyPos := types.Position{
Round: con.bcModule.tipRound(),
Height: initBlock.Position.Height + 1,
}
_, err := con.bcModule.addEmptyBlock(emptyPos)
if err != nil {
panic(err)
}
}
return con, nil
}
// newConsensusForRound creates a Consensus instance.
func newConsensusForRound(
initBlock *types.Block,
dMoment time.Time,
app Application,
gov Governance,
db db.Database,
network Network,
prv crypto.PrivateKey,
logger common.Logger,
usingNonBlocking bool) *Consensus {
// TODO(w): load latest blockHeight from DB, and use config at that height.
nodeSetCache := utils.NewNodeSetCache(gov)
// Setup signer module.
signer := utils.NewSigner(prv)
// Check if the application implement Debug interface.
var debugApp Debug
if a, ok := app.(Debug); ok {
debugApp = a
}
// Get configuration for bootstrap round.
initPos := types.Position{
Round: 0,
Height: types.GenesisHeight,
}
if initBlock != nil {
initPos = initBlock.Position
}
// Init configuration chain.
ID := types.NewNodeID(prv.PublicKey())
recv := &consensusDKGReceiver{
ID: ID,
gov: gov,
signer: signer,
nodeSetCache: nodeSetCache,
network: network,
logger: logger,
}
cfgModule := newConfigurationChain(ID, recv, gov, nodeSetCache, db, logger)
recv.cfgModule = cfgModule
signer.SetBLSSigner(
func(round uint64, hash common.Hash) (crypto.Signature, error) {
_, signer, err := cfgModule.getDKGInfo(round, false)
if err != nil {
return crypto.Signature{}, err
}
return crypto.Signature(signer.sign(hash)), nil
})
appModule := app
if usingNonBlocking {
appModule = newNonBlocking(app, debugApp)
}
tsigVerifierCache := NewTSigVerifierCache(gov, 7)
bcModule := newBlockChain(ID, dMoment, initBlock, appModule,
tsigVerifierCache, signer, logger)
// Construct Consensus instance.
con := &Consensus{
ID: ID,
app: appModule,
debugApp: debugApp,
gov: gov,
db: db,
network: network,
baConfirmedBlock: make(map[common.Hash]chan<- *types.Block),
dkgReady: sync.NewCond(&sync.Mutex{}),
cfgModule: cfgModule,
bcModule: bcModule,
dMoment: dMoment,
nodeSetCache: nodeSetCache,
tsigVerifierCache: tsigVerifierCache,
signer: signer,
event: common.NewEvent(),
logger: logger,
resetDeliveryGuardTicker: make(chan struct{}),
msgChan: make(chan types.Msg, 1024),
priorityMsgChan: make(chan interface{}, 1024),
processBlockChan: make(chan *types.Block, 1024),
}
con.ctx, con.ctxCancel = context.WithCancel(context.Background())
var err error
con.roundEvent, err = utils.NewRoundEvent(con.ctx, gov, logger, initPos,
ConfigRoundShift)
if err != nil {
panic(err)
}
if con.baMgr, err = newAgreementMgr(con); err != nil {
panic(err)
}
if err = con.prepare(initBlock); err != nil {
panic(err)
}
return con
}
// prepare the Consensus instance to be ready for blocks after 'initBlock'.
// 'initBlock' could be either:
// - nil
// - the last finalized block
func (con *Consensus) prepare(initBlock *types.Block) (err error) {
// Trigger the round validation method for the next round of the first
// round.
// The block past from full node should be delivered already or known by
// full node. We don't have to notify it.
initRound := uint64(0)
if initBlock != nil {
initRound = initBlock.Position.Round
}
if initRound == 0 {
if DKGDelayRound == 0 {
panic("not implemented yet")
}
}
// Measure time elapse for each handler of round events.
elapse := func(what string, lastE utils.RoundEventParam) func() {
start := time.Now()
con.logger.Info("Handle round event",
"what", what,
"event", lastE)
return func() {
con.logger.Info("Finish round event",
"what", what,
"event", lastE,
"elapse", time.Since(start))
}
}
// Register round event handler to purge cached node set. To make sure each
// modules see the up-to-date node set, we need to make sure this action
// should be taken as the first one.
con.roundEvent.Register(func(evts []utils.RoundEventParam) {
defer elapse("purge-cache", evts[len(evts)-1])()
for _, e := range evts {
if e.Reset == 0 {
continue
}
con.nodeSetCache.Purge(e.Round + 1)
con.tsigVerifierCache.Purge(e.Round + 1)
}
})
// Register round event handler to abort previous running DKG if any.
con.roundEvent.Register(func(evts []utils.RoundEventParam) {
e := evts[len(evts)-1]
go func() {
defer elapse("abort-DKG", e)()
if e.Reset > 0 {
aborted := con.cfgModule.abortDKG(con.ctx, e.Round+1, e.Reset-1)
con.logger.Info("DKG aborting result",
"round", e.Round+1,
"reset", e.Reset-1,
"aborted", aborted)
}
}()
})
// Register round event handler to update BA and BC modules.
con.roundEvent.Register(func(evts []utils.RoundEventParam) {
defer elapse("append-config", evts[len(evts)-1])()
// Always updates newer configs to the later modules first in the data
// flow.
if err := con.bcModule.notifyRoundEvents(evts); err != nil {
panic(err)
}
if err := con.baMgr.notifyRoundEvents(evts); err != nil {
panic(err)
}
})
// Register round event handler to reset DKG if the DKG set for next round
// failed to setup.
con.roundEvent.Register(func(evts []utils.RoundEventParam) {
e := evts[len(evts)-1]
defer elapse("reset-DKG", e)()
nextRound := e.Round + 1
if nextRound < DKGDelayRound {
return
}
curNotarySet, err := con.nodeSetCache.GetNotarySet(e.Round)
if err != nil {
con.logger.Error("Error getting notary set when proposing CRS",
"round", e.Round,
"error", err)
return
}
if _, exist := curNotarySet[con.ID]; !exist {
return
}
con.event.RegisterHeight(e.NextDKGResetHeight(), func(uint64) {
if ok, _ := utils.IsDKGValid(
con.gov, con.logger, nextRound, e.Reset); ok {
return
}
// Aborting all previous running DKG protocol instance if any.
go con.runCRS(e.Round, utils.Rehash(e.CRS, uint(e.Reset+1)), true)
})
})
// Register round event handler to propose new CRS.
con.roundEvent.Register(func(evts []utils.RoundEventParam) {
// We don't have to propose new CRS during DKG reset, the reset of DKG
// would be done by the notary set in previous round.
e := evts[len(evts)-1]
defer elapse("propose-CRS", e)()
if e.Reset != 0 || e.Round < DKGDelayRound {
return
}
if curNotarySet, err := con.nodeSetCache.GetNotarySet(e.Round); err != nil {
con.logger.Error("Error getting notary set when proposing CRS",
"round", e.Round,
"error", err)
} else {
if _, exist := curNotarySet[con.ID]; !exist {
return
}
con.event.RegisterHeight(e.NextCRSProposingHeight(), func(uint64) {
con.logger.Debug(
"Calling Governance.CRS to check if already proposed",
"round", e.Round+1)
if (con.gov.CRS(e.Round+1) != common.Hash{}) {
con.logger.Debug("CRS already proposed", "round", e.Round+1)
return
}
go con.runCRS(e.Round, e.CRS, false)
})
}
})
// Touch nodeSetCache for next round.
con.roundEvent.Register(func(evts []utils.RoundEventParam) {
e := evts[len(evts)-1]
defer elapse("touch-NodeSetCache", e)()
con.event.RegisterHeight(e.NextTouchNodeSetCacheHeight(), func(uint64) {
if e.Reset == 0 {
return
}
go func() {
nextRound := e.Round + 1
if err := con.nodeSetCache.Touch(nextRound); err != nil {
con.logger.Warn("Failed to update nodeSetCache",
"round", nextRound,
"error", err)
}
}()
})
})
con.roundEvent.Register(func(evts []utils.RoundEventParam) {
e := evts[len(evts)-1]
if e.Reset != 0 {
return
}
defer elapse("touch-DKGCache", e)()
go func() {
if _, err :=
con.tsigVerifierCache.Update(e.Round); err != nil {
con.logger.Warn("Failed to update tsig cache",
"round", e.Round,
"error", err)
}
}()
go func() {
threshold := utils.GetDKGThreshold(
utils.GetConfigWithPanic(con.gov, e.Round, con.logger))
// Restore group public key.
con.logger.Debug(
"Calling Governance.DKGMasterPublicKeys for recoverDKGInfo",
"round", e.Round)
con.logger.Debug(
"Calling Governance.DKGComplaints for recoverDKGInfo",
"round", e.Round)
_, qualifies, err := typesDKG.CalcQualifyNodes(
con.gov.DKGMasterPublicKeys(e.Round),
con.gov.DKGComplaints(e.Round),
threshold)
if err != nil {
con.logger.Warn("Failed to calculate dkg set",
"round", e.Round,
"error", err)
return
}
if _, exist := qualifies[con.ID]; !exist {
return
}
if _, _, err :=
con.cfgModule.getDKGInfo(e.Round, true); err != nil {
con.logger.Warn("Failed to recover DKG info",
"round", e.Round,
"error", err)
}
}()
})
// checkCRS is a generator of checker to check if CRS for that round is
// ready or not.
checkCRS := func(round uint64) func() bool {
return func() bool {
nextCRS := con.gov.CRS(round)
if (nextCRS != common.Hash{}) {
return true
}
con.logger.Debug("CRS is not ready yet. Try again later...",
"nodeID", con.ID,
"round", round)
return false
}
}
// Trigger round validation method for next period.
con.roundEvent.Register(func(evts []utils.RoundEventParam) {
e := evts[len(evts)-1]
defer elapse("next-round", e)()
// Register a routine to trigger round events.
con.event.RegisterHeight(e.NextRoundValidationHeight(),
utils.RoundEventRetryHandlerGenerator(con.roundEvent, con.event))
// Register a routine to register next DKG.
con.event.RegisterHeight(e.NextDKGRegisterHeight(), func(uint64) {
nextRound := e.Round + 1
if nextRound < DKGDelayRound {
con.logger.Info("Skip runDKG for round",
"round", nextRound,
"reset", e.Reset)
return
}
go func() {
// Normally, gov.CRS would return non-nil. Use this for in case
// of unexpected network fluctuation and ensure the robustness.
if !checkWithCancel(
con.ctx, 500*time.Millisecond, checkCRS(nextRound)) {
con.logger.Debug("unable to prepare CRS for notary set",
"round", nextRound,
"reset", e.Reset)
return
}
nextNotarySet, err := con.nodeSetCache.GetNotarySet(nextRound)
if err != nil {
con.logger.Error("Error getting notary set for next round",
"round", nextRound,
"reset", e.Reset,
"error", err)
return
}
if _, exist := nextNotarySet[con.ID]; !exist {
con.logger.Info("Not selected as notary set",
"round", nextRound,
"reset", e.Reset)
return
}
con.logger.Info("Selected as notary set",
"round", nextRound,
"reset", e.Reset)
nextConfig := utils.GetConfigWithPanic(con.gov, nextRound,
con.logger)
con.cfgModule.registerDKG(con.ctx, nextRound, e.Reset,
utils.GetDKGThreshold(nextConfig))
con.event.RegisterHeight(e.NextDKGPreparationHeight(),
func(h uint64) {
func() {
con.dkgReady.L.Lock()
defer con.dkgReady.L.Unlock()
con.dkgRunning = 0
}()
// We want to skip some of the DKG phases when started.
dkgCurrentHeight := h - e.NextDKGPreparationHeight()
con.runDKG(
nextRound, e.Reset,
e.NextDKGPreparationHeight(), dkgCurrentHeight)
})
}()
})
})
con.roundEvent.TriggerInitEvent()
if initBlock != nil {
con.event.NotifyHeight(initBlock.Position.Height)
}
con.baMgr.prepare()
return
}
// Run starts running DEXON Consensus.
func (con *Consensus) Run(stopChan chan<- struct{}) {
// There may have emptys block in blockchain added by force sync.
blocksWithoutRandomness := con.bcModule.pendingBlocksWithoutRandomness()
// Launch BA routines.
con.baMgr.run()
// Launch network handler.
con.logger.Debug("Calling Network.ReceiveChan")
con.waitGroup.Add(1)
go con.deliverNetworkMsg()
con.waitGroup.Add(1)
go con.processMsg()
go con.processBlockLoop()
// Stop dummy receiver if launched.
if con.dummyCancel != nil {
con.logger.Trace("Stop dummy receiver")
con.dummyCancel()
<-con.dummyFinished
// Replay those cached messages.
con.logger.Trace("Dummy receiver stoped, start dumping cached messages",
"count", len(con.dummyMsgBuffer))
for _, msg := range con.dummyMsgBuffer {
loop:
for {
select {
case con.msgChan <- msg:
break loop
case <-time.After(50 * time.Millisecond):
con.logger.Debug(
"internal message channel is full when syncing")
}
}
}
con.logger.Trace("Finish dumping cached messages")
}
con.generateBlockRandomness(blocksWithoutRandomness)
// Sleep until dMoment come.
time.Sleep(con.dMoment.Sub(time.Now().UTC()))
// Take some time to bootstrap.
time.Sleep(3 * time.Second)
con.waitGroup.Add(1)
go con.deliveryGuard(stopChan)
// Block until done.
select {
case <-con.ctx.Done():
}
}
func (con *Consensus) generateBlockRandomness(blocks []*types.Block) {
con.logger.Debug("Start generating block randomness", "blocks", blocks)
isNotarySet := make(map[uint64]bool)
for _, block := range blocks {
if block.Position.Round < DKGDelayRound {
continue
}
doRun, exist := isNotarySet[block.Position.Round]
if !exist {
curNotarySet, err := con.nodeSetCache.GetNotarySet(block.Position.Round)
if err != nil {
con.logger.Error("Error getting notary set when generate block tsig",
"round", block.Position.Round,
"error", err)
continue
}
_, exist := curNotarySet[con.ID]
isNotarySet[block.Position.Round] = exist
doRun = exist
}
if !doRun {
continue
}
go func(block *types.Block) {
psig, err := con.cfgModule.preparePartialSignature(
block.Position.Round, block.Hash)
if err != nil {
con.logger.Error("Failed to prepare partial signature",
"block", block,
"error", err)
} else if err = con.signer.SignDKGPartialSignature(psig); err != nil {
con.logger.Error("Failed to sign DKG partial signature",
"block", block,
"error", err)
} else if err = con.cfgModule.processPartialSignature(psig); err != nil {
con.logger.Error("Failed to process partial signature",
"block", block,
"error", err)
} else {
con.logger.Debug("Calling Network.BroadcastDKGPartialSignature",
"proposer", psig.ProposerID,
"block", block)
con.network.BroadcastDKGPartialSignature(psig)
sig, err := con.cfgModule.runTSig(
block.Position.Round,
block.Hash,
60*time.Minute,
)
if err != nil {
con.logger.Error("Failed to run Block Tsig",
"block", block,
"error", err)
return
}
result := &types.AgreementResult{
BlockHash: block.Hash,
Position: block.Position,
Randomness: sig.Signature[:],
}
con.bcModule.addBlockRandomness(block.Position, sig.Signature[:])
con.logger.Debug("Broadcast BlockRandomness",
"block", block,
"result", result)
con.network.BroadcastAgreementResult(result)
if err := con.deliverFinalizedBlocks(); err != nil {
con.logger.Error("Failed to deliver finalized block",
"error", err)
}
}
}(block)
}
}
// runDKG starts running DKG protocol.
func (con *Consensus) runDKG(
round, reset, dkgBeginHeight, dkgHeight uint64) {
con.dkgReady.L.Lock()
defer con.dkgReady.L.Unlock()
if con.dkgRunning != 0 {
return
}
con.dkgRunning = 1
go func() {
defer func() {
con.dkgReady.L.Lock()
defer con.dkgReady.L.Unlock()
con.dkgReady.Broadcast()
con.dkgRunning = 2
}()
if err :=
con.cfgModule.runDKG(
round, reset,
con.event, dkgBeginHeight, dkgHeight); err != nil {
con.logger.Error("Failed to runDKG", "error", err)
}
}()
}
func (con *Consensus) runCRS(round uint64, hash common.Hash, reset bool) {
// Start running next round CRS.
psig, err := con.cfgModule.preparePartialSignature(round, hash)
if err != nil {
con.logger.Error("Failed to prepare partial signature", "error", err)
} else if err = con.signer.SignDKGPartialSignature(psig); err != nil {
con.logger.Error("Failed to sign DKG partial signature", "error", err)
} else if err = con.cfgModule.processPartialSignature(psig); err != nil {
con.logger.Error("Failed to process partial signature", "error", err)
} else {
con.logger.Debug("Calling Network.BroadcastDKGPartialSignature",
"proposer", psig.ProposerID,
"round", psig.Round,
"hash", psig.Hash)
con.network.BroadcastDKGPartialSignature(psig)
con.logger.Debug("Calling Governance.CRS", "round", round)
crs, err := con.cfgModule.runCRSTSig(round, hash)
if err != nil {
con.logger.Error("Failed to run CRS Tsig", "error", err)
} else {
if reset {
con.logger.Debug("Calling Governance.ResetDKG",
"round", round+1,
"crs", hex.EncodeToString(crs))
con.gov.ResetDKG(crs)
} else {
con.logger.Debug("Calling Governance.ProposeCRS",
"round", round+1,
"crs", hex.EncodeToString(crs))
con.gov.ProposeCRS(round+1, crs)
}
}
}
}
// Stop the Consensus core.
func (con *Consensus) Stop() {
con.ctxCancel()
con.baMgr.stop()
con.event.Reset()
con.waitGroup.Wait()
if nbApp, ok := con.app.(*nonBlocking); ok {
nbApp.wait()
}
}
func (con *Consensus) deliverNetworkMsg() {
defer con.waitGroup.Done()
recv := con.network.ReceiveChan()
for {
select {
case <-con.ctx.Done():
return
default:
}
select {
case msg := <-recv:
innerLoop:
for {
select {
case con.msgChan <- msg:
break innerLoop
case <-time.After(500 * time.Millisecond):
con.logger.Debug("internal message channel is full",
"pending", msg)
}
}
case <-con.ctx.Done():
return
}
}
}
func (con *Consensus) processMsg() {
defer con.waitGroup.Done()
MessageLoop:
for {
select {
case <-con.ctx.Done():
return
default:
}
var msg, peer interface{}
select {
case msg = <-con.priorityMsgChan:
default:
}
if msg == nil {
select {
case message := <-con.msgChan:
msg, peer = message.Payload, message.PeerID
case msg = <-con.priorityMsgChan:
case <-con.ctx.Done():
return
}
}
switch val := msg.(type) {
case *selfAgreementResult:
con.baMgr.touchAgreementResult((*types.AgreementResult)(val))
case *types.Block:
if ch, exist := func() (chan<- *types.Block, bool) {
con.lock.RLock()
defer con.lock.RUnlock()
ch, e := con.baConfirmedBlock[val.Hash]
return ch, e
}(); exist {
if val.IsEmpty() {
hash, err := utils.HashBlock(val)
if err != nil {
con.logger.Error("Error verifying empty block hash",
"block", val,
"error, err")
con.network.ReportBadPeerChan() <- peer
continue MessageLoop
}
if hash != val.Hash {
con.logger.Error("Incorrect confirmed empty block hash",
"block", val,
"hash", hash)
con.network.ReportBadPeerChan() <- peer
continue MessageLoop
}
if _, err := con.bcModule.proposeBlock(
val.Position, time.Time{}, true); err != nil {
con.logger.Error("Error adding empty block",
"block", val,
"error", err)
con.network.ReportBadPeerChan() <- peer
continue MessageLoop
}
} else {
if !val.IsFinalized() {
con.logger.Warn("Ignore not finalized block",
"block", val)
continue MessageLoop
}
ok, err := con.bcModule.verifyRandomness(
val.Hash, val.Position.Round, val.Randomness)
if err != nil {
con.logger.Error("Error verifying confirmed block randomness",
"block", val,
"error", err)
con.network.ReportBadPeerChan() <- peer
continue MessageLoop
}
if !ok {
con.logger.Error("Incorrect confirmed block randomness",
"block", val)
con.network.ReportBadPeerChan() <- peer
continue MessageLoop
}
if err := utils.VerifyBlockSignature(val); err != nil {
con.logger.Error("VerifyBlockSignature failed",
"block", val,
"error", err)
con.network.ReportBadPeerChan() <- peer
continue MessageLoop
}
}
func() {
con.lock.Lock()
defer con.lock.Unlock()
// In case of multiple delivered block.
if _, exist := con.baConfirmedBlock[val.Hash]; !exist {
return
}
delete(con.baConfirmedBlock, val.Hash)
ch <- val
}()
} else if val.IsFinalized() {
if err := con.processFinalizedBlock(val); err != nil {
con.logger.Error("Failed to process finalized block",
"block", val,
"error", err)
con.network.ReportBadPeerChan() <- peer
}
} else {
if err := con.preProcessBlock(val); err != nil {
con.logger.Error("Failed to pre process block",
"block", val,
"error", err)
con.network.ReportBadPeerChan() <- peer
}
}
case *types.Vote:
if err := con.ProcessVote(val); err != nil {
con.logger.Error("Failed to process vote",
"vote", val,
"error", err)
con.network.ReportBadPeerChan() <- peer
}
case *types.AgreementResult:
if err := con.ProcessAgreementResult(val); err != nil {
con.logger.Error("Failed to process agreement result",
"result", val,
"error", err)
con.network.ReportBadPeerChan() <- peer
}
case *typesDKG.PrivateShare:
if err := con.cfgModule.processPrivateShare(val); err != nil {
con.logger.Error("Failed to process private share",
"error", err)
con.network.ReportBadPeerChan() <- peer
}
case *typesDKG.PartialSignature:
if err := con.cfgModule.processPartialSignature(val); err != nil {
con.logger.Error("Failed to process partial signature",
"error", err)
con.network.ReportBadPeerChan() <- peer
}
}
}
}
// ProcessVote is the entry point to submit ont vote to a Consensus instance.
func (con *Consensus) ProcessVote(vote *types.Vote) (err error) {
err = con.baMgr.processVote(vote)
return
}
// ProcessAgreementResult processes the randomness request.
func (con *Consensus) ProcessAgreementResult(
rand *types.AgreementResult) error {
if !con.baMgr.touchAgreementResult(rand) {
return nil
}
// Sanity Check.
if err := VerifyAgreementResult(rand, con.nodeSetCache); err != nil {
con.baMgr.untouchAgreementResult(rand)
return err
}
if err := con.bcModule.processAgreementResult(rand); err != nil {
con.baMgr.untouchAgreementResult(rand)
if err == ErrSkipButNoError {
return nil
}
return err
}
// Syncing BA Module.
if err := con.baMgr.processAgreementResult(rand); err != nil {
con.baMgr.untouchAgreementResult(rand)
return err
}
con.logger.Debug("Rebroadcast AgreementResult",
"result", rand)
con.network.BroadcastAgreementResult(rand)
return con.deliverFinalizedBlocks()
}
// preProcessBlock performs Byzantine Agreement on the block.
func (con *Consensus) preProcessBlock(b *types.Block) (err error) {
err = con.baMgr.processBlock(b)
if err == nil && con.debugApp != nil {
con.debugApp.BlockReceived(b.Hash)
}
return
}
func (con *Consensus) processFinalizedBlock(b *types.Block) (err error) {
if b.Position.Round < DKGDelayRound {
return
}
if err = utils.VerifyBlockSignature(b); err != nil {
return
}
verifier, ok, err := con.tsigVerifierCache.UpdateAndGet(b.Position.Round)
if err != nil {
return
}
if !ok {
err = ErrCannotVerifyBlockRandomness
return
}
if !verifier.VerifySignature(b.Hash, crypto.Signature{
Type: "bls",
Signature: b.Randomness,
}) {
err = ErrIncorrectBlockRandomness
return
}
err = con.baMgr.processFinalizedBlock(b)
if err == nil && con.debugApp != nil {
con.debugApp.BlockReceived(b.Hash)
}
return
}
func (con *Consensus) deliveryGuard(stopChan chan<- struct{}) {
defer con.waitGroup.Done()
select {
case <-con.ctx.Done():
case <-time.After(con.dMoment.Sub(time.Now())):
}
// Node takes time to start.
select {
case <-con.ctx.Done():
case <-time.After(60 * time.Second):
}
for {
select {
case <-con.ctx.Done():
return
default:
}
select {
case <-con.ctx.Done():
return
case <-con.resetDeliveryGuardTicker:
case <-time.After(60 * time.Second):
con.logger.Error("No blocks delivered for too long", "ID", con.ID)
stopChan <- struct{}{}
con.ctxCancel()
return
}
}
}
// deliverBlock deliver a block to application layer.
func (con *Consensus) deliverBlock(b *types.Block) {
select {
case con.resetDeliveryGuardTicker <- struct{}{}:
default:
}
if err := con.db.PutBlock(*b); err != nil {
panic(err)
}
if err := con.db.PutCompactionChainTipInfo(b.Hash,
b.Position.Height); err != nil {
panic(err)
}
con.logger.Debug("Calling Application.BlockDelivered", "block", b)
con.app.BlockDelivered(b.Hash, b.Position, common.CopyBytes(b.Randomness))
if con.debugApp != nil {
con.debugApp.BlockReady(b.Hash)
}
}
// deliverFinalizedBlocks extracts and delivers finalized blocks to application
// layer.
func (con *Consensus) deliverFinalizedBlocks() error {
con.lock.Lock()
defer con.lock.Unlock()
return con.deliverFinalizedBlocksWithoutLock()
}
func (con *Consensus) deliverFinalizedBlocksWithoutLock() (err error) {
deliveredBlocks := con.bcModule.extractBlocks()
con.logger.Debug("Last blocks in compaction chain",
"delivered", con.bcModule.lastDeliveredBlock(),
"pending", con.bcModule.lastPendingBlock())
for _, b := range deliveredBlocks {
con.deliverBlock(b)
con.event.NotifyHeight(b.Position.Height)
}
return
}
func (con *Consensus) processBlockLoop() {
for {
select {
case <-con.ctx.Done():
return
default:
}
select {
case <-con.ctx.Done():
return
case block := <-con.processBlockChan:
if err := con.processBlock(block); err != nil {
con.logger.Error("Error processing block",
"block", block,
"error", err)
}
}
}
}
// processBlock is the entry point to submit one block to a Consensus instance.
func (con *Consensus) processBlock(block *types.Block) (err error) {
// Block processed by blockChain can be out-of-order. But the output from
// blockChain (deliveredBlocks) cannot, thus we need to protect the part
// below with writer lock.
con.lock.Lock()
defer con.lock.Unlock()
if err = con.bcModule.addBlock(block); err != nil {
return
}
if err = con.deliverFinalizedBlocksWithoutLock(); err != nil {
return
}
return
}
// PrepareBlock would setup header fields of block based on its ProposerID.
func (con *Consensus) proposeBlock(position types.Position) (
*types.Block, error) {
b, err := con.bcModule.proposeBlock(position, time.Now().UTC(), false)
if err != nil {
return nil, err
}
con.logger.Debug("Calling Governance.CRS", "round", b.Position.Round)
crs := con.gov.CRS(b.Position.Round)
if crs.Equal(common.Hash{}) {
con.logger.Error("CRS for round is not ready, unable to prepare block",
"position", &b.Position)
return nil, ErrCRSNotReady
}
if err = con.signer.SignCRS(b, crs); err != nil {
return nil, err
}
return b, nil
}
|