forked from erigontech/erigon
-
Notifications
You must be signed in to change notification settings - Fork 2
/
stage_headers.go
1182 lines (1065 loc) · 36.1 KB
/
stage_headers.go
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
package stagedsync
import (
"context"
"encoding/binary"
"errors"
"fmt"
"math/big"
"runtime"
"time"
"github.com/c2h5oh/datasize"
"github.com/holiman/uint256"
libcommon "github.com/ledgerwatch/erigon-lib/common"
"github.com/ledgerwatch/erigon-lib/common/dir"
"github.com/ledgerwatch/erigon-lib/etl"
proto_downloader "github.com/ledgerwatch/erigon-lib/gointerfaces/downloader"
"github.com/ledgerwatch/erigon-lib/gointerfaces/remote"
"github.com/ledgerwatch/erigon-lib/kv"
"github.com/ledgerwatch/erigon/cmd/downloader/downloadergrpc"
"github.com/ledgerwatch/erigon/cmd/rpcdaemon/interfaces"
"github.com/ledgerwatch/erigon/common"
"github.com/ledgerwatch/erigon/common/dbutils"
"github.com/ledgerwatch/erigon/core/rawdb"
"github.com/ledgerwatch/erigon/core/types"
"github.com/ledgerwatch/erigon/eth/stagedsync/stages"
"github.com/ledgerwatch/erigon/ethdb/privateapi"
"github.com/ledgerwatch/erigon/params"
"github.com/ledgerwatch/erigon/rlp"
"github.com/ledgerwatch/erigon/turbo/engineapi"
"github.com/ledgerwatch/erigon/turbo/snapshotsync"
"github.com/ledgerwatch/erigon/turbo/snapshotsync/snapshothashes"
"github.com/ledgerwatch/erigon/turbo/stages/bodydownload"
"github.com/ledgerwatch/erigon/turbo/stages/headerdownload"
"github.com/ledgerwatch/log/v3"
)
// The number of blocks we should be able to re-org sub-second on commodity hardware.
// See https://hackmd.io/TdJtNs0dS56q-In8h-ShSg
const ShortPoSReorgThresholdBlocks = 10
type HeadersCfg struct {
db kv.RwDB
hd *headerdownload.HeaderDownload
bodyDownload *bodydownload.BodyDownload
chainConfig params.ChainConfig
headerReqSend func(context.Context, *headerdownload.HeaderRequest) ([64]byte, bool)
announceNewHashes func(context.Context, []headerdownload.Announce)
penalize func(context.Context, []headerdownload.PenaltyItem)
batchSize datasize.ByteSize
noP2PDiscovery bool
tmpdir string
snapshotDir *dir.Rw
snapshots *snapshotsync.RoSnapshots
snapshotHashesCfg *snapshothashes.Config
snapshotDownloader proto_downloader.DownloaderClient
blockReader interfaces.FullBlockReader
}
func StageHeadersCfg(
db kv.RwDB,
headerDownload *headerdownload.HeaderDownload,
bodyDownload *bodydownload.BodyDownload,
chainConfig params.ChainConfig,
headerReqSend func(context.Context, *headerdownload.HeaderRequest) ([64]byte, bool),
announceNewHashes func(context.Context, []headerdownload.Announce),
penalize func(context.Context, []headerdownload.PenaltyItem),
batchSize datasize.ByteSize,
noP2PDiscovery bool,
snapshots *snapshotsync.RoSnapshots,
snapshotDownloader proto_downloader.DownloaderClient,
blockReader interfaces.FullBlockReader,
tmpdir string,
snapshotDir *dir.Rw,
) HeadersCfg {
return HeadersCfg{
db: db,
hd: headerDownload,
bodyDownload: bodyDownload,
chainConfig: chainConfig,
headerReqSend: headerReqSend,
announceNewHashes: announceNewHashes,
penalize: penalize,
batchSize: batchSize,
tmpdir: tmpdir,
noP2PDiscovery: noP2PDiscovery,
snapshots: snapshots,
snapshotDownloader: snapshotDownloader,
blockReader: blockReader,
snapshotHashesCfg: snapshothashes.KnownConfig(chainConfig.ChainName),
snapshotDir: snapshotDir,
}
}
func SpawnStageHeaders(
s *StageState,
u Unwinder,
ctx context.Context,
tx kv.RwTx,
cfg HeadersCfg,
initialCycle bool,
test bool, // Set to true in tests, allows the stage to fail rather than wait indefinitely
) error {
if err := DownloadAndIndexSnapshotsIfNeed(s, ctx, tx, cfg, initialCycle); err != nil {
return err
}
useExternalTx := tx != nil
if !useExternalTx {
var err error
tx, err = cfg.db.BeginRw(ctx)
if err != nil {
return err
}
defer tx.Rollback()
}
var blockNumber uint64
if s == nil {
blockNumber = 0
} else {
blockNumber = s.BlockNumber
}
unsettledForkChoice, headHeight := cfg.hd.GetUnsettledForkChoice()
if unsettledForkChoice != nil { // some work left to do after unwind
return finishHandlingForkChoice(unsettledForkChoice, headHeight, s, tx, cfg, useExternalTx)
}
isTrans, err := rawdb.Transitioned(tx, blockNumber, cfg.chainConfig.TerminalTotalDifficulty)
if err != nil {
return err
}
if isTrans {
return HeadersPOS(s, u, ctx, tx, cfg, useExternalTx)
} else {
return HeadersPOW(s, u, ctx, tx, cfg, initialCycle, test, useExternalTx)
}
}
func finishHandlingForkChoice(
forkChoice *engineapi.ForkChoiceMessage,
headHeight uint64,
s *StageState,
tx kv.RwTx,
cfg HeadersCfg,
useExternalTx bool,
) error {
log.Info(fmt.Sprintf("[%s] Unsettled forkchoice after unwind", s.LogPrefix()), "height", headHeight, "forkchoice", forkChoice)
logEvery := time.NewTicker(logInterval)
defer logEvery.Stop()
if err := fixCanonicalChain(s.LogPrefix(), logEvery, headHeight, forkChoice.HeadBlockHash, tx, cfg.blockReader); err != nil {
return err
}
if err := rawdb.WriteHeadHeaderHash(tx, forkChoice.HeadBlockHash); err != nil {
return err
}
rawdb.WriteForkchoiceHead(tx, forkChoice.HeadBlockHash)
sendErrResponse := cfg.hd.GetPendingPayloadStatus() != (common.Hash{})
safeIsCanonical, err := rawdb.IsCanonicalHash(tx, forkChoice.SafeBlockHash)
if err != nil {
return err
}
if safeIsCanonical {
rawdb.WriteForkchoiceSafe(tx, forkChoice.SafeBlockHash)
} else {
log.Warn(fmt.Sprintf("[%s] Non-canonical SafeBlockHash", s.LogPrefix()), "forkChoice", forkChoice)
if sendErrResponse {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{
CriticalError: errors.New("safe block is not an ancestor of head block"),
}
cfg.hd.ClearPendingPayloadStatus()
sendErrResponse = false
}
}
finalizedIsCanonical, err := rawdb.IsCanonicalHash(tx, forkChoice.FinalizedBlockHash)
if err != nil {
return err
}
if finalizedIsCanonical {
rawdb.WriteForkchoiceFinalized(tx, forkChoice.FinalizedBlockHash)
} else {
log.Warn(fmt.Sprintf("[%s] Non-canonical FinalizedBlockHash", s.LogPrefix()), "forkChoice", forkChoice)
if sendErrResponse {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{
CriticalError: errors.New("finalized block is not an ancestor of head block"),
}
cfg.hd.ClearPendingPayloadStatus()
}
}
if err := s.Update(tx, headHeight); err != nil {
return err
}
if !useExternalTx {
if err := tx.Commit(); err != nil {
return err
}
}
cfg.hd.ClearUnsettledForkChoice()
return nil
}
// HeadersPOS processes Proof-of-Stake requests (newPayload, forkchoiceUpdated)
func HeadersPOS(
s *StageState,
u Unwinder,
ctx context.Context,
tx kv.RwTx,
cfg HeadersCfg,
useExternalTx bool,
) error {
log.Info(fmt.Sprintf("[%s] Waiting for Beacon Chain...", s.LogPrefix()))
onlyNewRequests := cfg.hd.PosStatus() == headerdownload.Syncing
interrupt, requestId, requestWithStatus := cfg.hd.BeaconRequestList.WaitForRequest(onlyNewRequests)
cfg.hd.SetHeaderReader(&chainReader{config: &cfg.chainConfig, tx: tx, blockReader: cfg.blockReader})
headerInserter := headerdownload.NewHeaderInserter(s.LogPrefix(), nil, s.BlockNumber, cfg.blockReader)
if interrupt != engineapi.None {
if interrupt == engineapi.Stopping {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{CriticalError: errors.New("server is stopping")}
}
if interrupt == engineapi.Synced {
verifyAndSaveDownloadedPoSHeaders(tx, cfg, headerInserter)
}
if !useExternalTx {
return tx.Commit()
}
return nil
}
request := requestWithStatus.Message
status := requestWithStatus.Status
// Decide what kind of action we need to take place
var payloadMessage *engineapi.PayloadMessage
forkChoiceMessage, forkChoiceInsteadOfNewPayload := request.(*engineapi.ForkChoiceMessage)
if !forkChoiceInsteadOfNewPayload {
payloadMessage = request.(*engineapi.PayloadMessage)
}
cfg.hd.ClearPendingPayloadStatus()
if forkChoiceInsteadOfNewPayload {
startHandlingForkChoice(forkChoiceMessage, status, requestId, s, u, ctx, tx, cfg, headerInserter)
} else {
if err := handleNewPayload(payloadMessage, status, requestId, s, ctx, tx, cfg, headerInserter); err != nil {
return err
}
}
if !useExternalTx {
return tx.Commit()
}
return nil
}
func startHandlingForkChoice(
forkChoiceMessage *engineapi.ForkChoiceMessage,
requestStatus engineapi.RequestStatus,
requestId int,
s *StageState,
u Unwinder,
ctx context.Context,
tx kv.RwTx,
cfg HeadersCfg,
headerInserter *headerdownload.HeaderInserter,
) error {
headerHash := forkChoiceMessage.HeadBlockHash
log.Info(fmt.Sprintf("[%s] Handling fork choice", s.LogPrefix()), "headerHash", headerHash)
currentHeadHash := rawdb.ReadHeadHeaderHash(tx)
if currentHeadHash == headerHash { // no-op
log.Info(fmt.Sprintf("[%s] Fork choice no-op", s.LogPrefix()))
cfg.hd.BeaconRequestList.Remove(requestId)
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{
Status: remote.EngineStatus_VALID,
LatestValidHash: currentHeadHash,
}
}
return nil
}
header, err := rawdb.ReadHeaderByHash(tx, headerHash)
if err != nil {
log.Warn(fmt.Sprintf("[%s] Fork choice err", s.LogPrefix()), "err", err)
cfg.hd.BeaconRequestList.Remove(requestId)
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{CriticalError: err}
}
return err
}
if header == nil {
log.Info(fmt.Sprintf("[%s] Fork choice missing header", s.LogPrefix()))
hashToDownload := headerHash
heighToDownload := cfg.hd.TopSeenHeight() // approximate
schedulePoSDownload(requestStatus, requestId, hashToDownload, heighToDownload, s, cfg)
return nil
}
cfg.hd.BeaconRequestList.Remove(requestId)
headerNumber := header.Number.Uint64()
cfg.hd.UpdateTopSeenHeightPoS(headerNumber)
forkingPoint := uint64(0)
if headerNumber > 0 {
parent := rawdb.ReadHeader(tx, header.ParentHash, headerNumber-1)
forkingPoint, err = headerInserter.ForkingPoint(tx, header, parent)
if err != nil {
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{CriticalError: err}
}
return err
}
}
if requestStatus == engineapi.New {
if headerNumber-forkingPoint <= ShortPoSReorgThresholdBlocks {
log.Info(fmt.Sprintf("[%s] Short range re-org", s.LogPrefix()), "headerNumber", headerNumber, "forkingPoint", forkingPoint)
// TODO(yperbasis): what if some bodies are missing and we have to download them?
cfg.hd.SetPendingPayloadStatus(headerHash)
} else {
log.Info(fmt.Sprintf("[%s] Long range re-org", s.LogPrefix()), "headerNumber", headerNumber, "forkingPoint", forkingPoint)
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{Status: remote.EngineStatus_SYNCING}
}
}
log.Trace(fmt.Sprintf("[%s] Fork choice beginning unwind", s.LogPrefix()))
u.UnwindTo(forkingPoint, common.Hash{})
log.Trace(fmt.Sprintf("[%s] Fork choice unwind finished", s.LogPrefix()))
cfg.hd.SetUnsettledForkChoice(forkChoiceMessage, headerNumber)
return nil
}
func handleNewPayload(
payloadMessage *engineapi.PayloadMessage,
requestStatus engineapi.RequestStatus,
requestId int,
s *StageState,
ctx context.Context,
tx kv.RwTx,
cfg HeadersCfg,
headerInserter *headerdownload.HeaderInserter,
) error {
header := payloadMessage.Header
headerNumber := header.Number.Uint64()
headerHash := header.Hash()
log.Trace(fmt.Sprintf("[%s] Handling new payload", s.LogPrefix()), "height", headerNumber, "hash", headerHash)
cfg.hd.UpdateTopSeenHeightPoS(headerNumber)
existingCanonicalHash, err := rawdb.ReadCanonicalHash(tx, headerNumber)
if err != nil {
log.Warn(fmt.Sprintf("[%s] New payload err", s.LogPrefix()), "err", err)
cfg.hd.BeaconRequestList.Remove(requestId)
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{CriticalError: err}
}
return err
}
if existingCanonicalHash != (common.Hash{}) && headerHash == existingCanonicalHash {
log.Info(fmt.Sprintf("[%s] New payload: previously received valid header", s.LogPrefix()))
cfg.hd.BeaconRequestList.Remove(requestId)
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{
Status: remote.EngineStatus_VALID,
LatestValidHash: headerHash,
}
}
return nil
}
parent := rawdb.ReadHeader(tx, header.ParentHash, headerNumber-1)
if parent == nil {
log.Info(fmt.Sprintf("[%s] New payload missing parent", s.LogPrefix()))
hashToDownload := header.ParentHash
heightToDownload := headerNumber - 1
schedulePoSDownload(requestStatus, requestId, hashToDownload, heightToDownload, s, cfg)
return nil
}
cfg.hd.BeaconRequestList.Remove(requestId)
for _, tx := range payloadMessage.Body.Transactions {
if types.TypedTransactionMarshalledAsRlpString(tx) {
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{
Status: remote.EngineStatus_INVALID,
LatestValidHash: header.ParentHash,
ValidationError: errors.New("typed txn marshalled as RLP string"),
}
}
return nil
}
}
transactions, err := types.DecodeTransactions(payloadMessage.Body.Transactions)
if err != nil {
log.Warn("Error during Beacon transaction decoding", "err", err.Error())
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{
Status: remote.EngineStatus_INVALID,
LatestValidHash: header.ParentHash,
ValidationError: err,
}
}
return nil
}
log.Trace(fmt.Sprintf("[%s] New payload begin verification", s.LogPrefix()))
success, err := verifyAndSaveNewPoSHeader(requestStatus, s, tx, cfg, header, headerInserter)
log.Trace(fmt.Sprintf("[%s] New payload verification ended", s.LogPrefix()), "success", success, "err", err)
if err != nil || !success {
return err
}
if cfg.bodyDownload != nil {
block := types.NewBlockFromStorage(headerHash, header, transactions, nil)
cfg.bodyDownload.AddToPrefetch(block)
}
return nil
}
func verifyAndSaveNewPoSHeader(
requestStatus engineapi.RequestStatus,
s *StageState,
tx kv.RwTx,
cfg HeadersCfg,
header *types.Header,
headerInserter *headerdownload.HeaderInserter,
) (success bool, err error) {
headerNumber := header.Number.Uint64()
headerHash := header.Hash()
if verificationErr := cfg.hd.VerifyHeader(header); verificationErr != nil {
log.Warn("Verification failed for header", "hash", headerHash, "height", headerNumber, "err", verificationErr)
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{
Status: remote.EngineStatus_INVALID,
LatestValidHash: header.ParentHash,
ValidationError: verificationErr,
}
}
return
}
err = headerInserter.FeedHeaderPoS(tx, header, headerHash)
if err != nil {
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{CriticalError: err}
}
return
}
currentHeadHash := rawdb.ReadHeadHeaderHash(tx)
if currentHeadHash == header.ParentHash {
// OK, we're on the canonical chain
if requestStatus == engineapi.New {
cfg.hd.SetPendingPayloadStatus(headerHash)
}
logEvery := time.NewTicker(logInterval)
defer logEvery.Stop()
// Extend canonical chain by the new header
err = fixCanonicalChain(s.LogPrefix(), logEvery, headerInserter.GetHighest(), headerInserter.GetHighestHash(), tx, cfg.blockReader)
if err != nil {
return
}
err = rawdb.WriteHeadHeaderHash(tx, headerHash)
if err != nil {
return
}
err = s.Update(tx, headerNumber)
if err != nil {
return
}
} else {
// Side chain or something weird
// TODO(yperbasis): considered non-canonical because some missing headers were donloaded but not canonized
// Or it's not a problem because forkChoice is updated frequently?
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{Status: remote.EngineStatus_ACCEPTED}
}
// No canonization, HeadHeaderHash & StageProgress are not updated
}
success = true
return
}
func schedulePoSDownload(
requestStatus engineapi.RequestStatus,
requestId int,
hashToDownload common.Hash,
heightToDownload uint64,
s *StageState,
cfg HeadersCfg,
) {
if requestStatus == engineapi.New {
cfg.hd.PayloadStatusCh <- privateapi.PayloadStatus{Status: remote.EngineStatus_SYNCING}
}
cfg.hd.BeaconRequestList.SetStatus(requestId, engineapi.DataWasMissing)
if cfg.hd.PosStatus() != headerdownload.Idle {
log.Trace(fmt.Sprintf("[%s] Postponing PoS download since another one is in progress", s.LogPrefix()), "height", heightToDownload, "hash", hashToDownload)
return
}
log.Info(fmt.Sprintf("[%s] Downloading PoS headers...", s.LogPrefix()), "height", heightToDownload, "hash", hashToDownload, "requestId", requestId)
cfg.hd.SetPOSSync(true)
cfg.hd.SetRequestId(requestId)
cfg.hd.SetHeaderToDownloadPoS(hashToDownload, heightToDownload)
//nolint
headerCollector := etl.NewCollector(s.LogPrefix(), cfg.tmpdir, etl.NewSortableBuffer(etl.BufferOptimalSize))
// headerCollector is closed in verifyAndSaveDownloadedPoSHeaders, thus nolint
cfg.hd.SetHeadersCollector(headerCollector)
cfg.hd.SetPosStatus(headerdownload.Syncing)
}
func verifyAndSaveDownloadedPoSHeaders(tx kv.RwTx, cfg HeadersCfg, headerInserter *headerdownload.HeaderInserter) error {
headerLoadFunc := func(key, value []byte, _ etl.CurrentTableReader, _ etl.LoadNextFunc) error {
var h types.Header
if err := rlp.DecodeBytes(value, &h); err != nil {
return err
}
if err := cfg.hd.VerifyHeader(&h); err != nil {
log.Warn("Verification failed for header", "hash", h.Hash(), "height", h.Number.Uint64(), "err", err)
return err
}
return headerInserter.FeedHeaderPoS(tx, &h, h.Hash())
}
err := cfg.hd.HeadersCollector().Load(tx, kv.Headers, headerLoadFunc, etl.TransformArgs{
LogDetailsLoad: func(k, v []byte) (additionalLogArguments []interface{}) {
return []interface{}{"block", binary.BigEndian.Uint64(k)}
},
})
if err != nil {
log.Warn("Removing beacon request due to", "err", err, "requestId", cfg.hd.RequestId())
cfg.hd.BeaconRequestList.Remove(cfg.hd.RequestId())
} else {
log.Info("PoS headers verified and saved", "requestId", cfg.hd.RequestId())
}
cfg.hd.HeadersCollector().Close()
cfg.hd.SetHeadersCollector(nil)
cfg.hd.SetPosStatus(headerdownload.Idle)
return err
}
// HeadersPOW progresses Headers stage for Proof-of-Work headers
func HeadersPOW(
s *StageState,
u Unwinder,
ctx context.Context,
tx kv.RwTx,
cfg HeadersCfg,
initialCycle bool,
test bool, // Set to true in tests, allows the stage to fail rather than wait indefinitely
useExternalTx bool,
) error {
var headerProgress uint64
var err error
if err = cfg.hd.ReadProgressFromDb(tx); err != nil {
return err
}
cfg.hd.SetPOSSync(false)
cfg.hd.SetFetchingNew(true)
defer cfg.hd.SetFetchingNew(false)
headerProgress = cfg.hd.Progress()
logPrefix := s.LogPrefix()
// Check if this is called straight after the unwinds, which means we need to create new canonical markings
hash, err := rawdb.ReadCanonicalHash(tx, headerProgress)
if err != nil {
return err
}
logEvery := time.NewTicker(logInterval)
defer logEvery.Stop()
if hash == (common.Hash{}) {
headHash := rawdb.ReadHeadHeaderHash(tx)
if err = fixCanonicalChain(logPrefix, logEvery, headerProgress, headHash, tx, cfg.blockReader); err != nil {
return err
}
if !useExternalTx {
if err = tx.Commit(); err != nil {
return err
}
}
return nil
}
// Allow other stages to run 1 cycle if no network available
if initialCycle && cfg.noP2PDiscovery {
return nil
}
log.Info(fmt.Sprintf("[%s] Waiting for headers...", logPrefix), "from", headerProgress)
localTd, err := rawdb.ReadTd(tx, hash, headerProgress)
if err != nil {
return err
}
if localTd == nil {
return fmt.Errorf("localTD is nil: %d, %x", headerProgress, hash)
}
headerInserter := headerdownload.NewHeaderInserter(logPrefix, localTd, headerProgress, cfg.blockReader)
cfg.hd.SetHeaderReader(&chainReader{config: &cfg.chainConfig, tx: tx, blockReader: cfg.blockReader})
var sentToPeer bool
stopped := false
prevProgress := headerProgress
Loop:
for !stopped {
isTrans, err := rawdb.Transitioned(tx, headerProgress, cfg.chainConfig.TerminalTotalDifficulty)
if err != nil {
return err
}
if isTrans {
if err := s.Update(tx, headerProgress); err != nil {
return err
}
break
}
currentTime := uint64(time.Now().Unix())
req, penalties := cfg.hd.RequestMoreHeaders(currentTime)
if req != nil {
_, sentToPeer = cfg.headerReqSend(ctx, req)
if sentToPeer {
// If request was actually sent to a peer, we update retry time to be 5 seconds in the future
cfg.hd.UpdateRetryTime(req, currentTime, 5 /* timeout */)
log.Trace("Sent request", "height", req.Number)
}
}
if len(penalties) > 0 {
cfg.penalize(ctx, penalties)
}
maxRequests := 64 // Limit number of requests sent per round to let some headers to be inserted into the database
for req != nil && sentToPeer && maxRequests > 0 {
req, penalties = cfg.hd.RequestMoreHeaders(currentTime)
if req != nil {
_, sentToPeer = cfg.headerReqSend(ctx, req)
if sentToPeer {
// If request was actually sent to a peer, we update retry time to be 5 seconds in the future
cfg.hd.UpdateRetryTime(req, currentTime, 5 /*timeout */)
log.Trace("Sent request", "height", req.Number)
}
}
if len(penalties) > 0 {
cfg.penalize(ctx, penalties)
}
maxRequests--
}
// Send skeleton request if required
req = cfg.hd.RequestSkeleton()
if req != nil {
_, sentToPeer = cfg.headerReqSend(ctx, req)
if sentToPeer {
log.Trace("Sent skeleton request", "height", req.Number)
}
}
// Load headers into the database
var inSync bool
if inSync, err = cfg.hd.InsertHeaders(headerInserter.NewFeedHeaderFunc(tx, cfg.blockReader), cfg.chainConfig.TerminalTotalDifficulty, logPrefix, logEvery.C); err != nil {
return err
}
announces := cfg.hd.GrabAnnounces()
if len(announces) > 0 {
cfg.announceNewHashes(ctx, announces)
}
if headerInserter.BestHeaderChanged() { // We do not break unless there best header changed
if !initialCycle {
// if this is not an initial cycle, we need to react quickly when new headers are coming in
break
}
// if this is initial cycle, we want to make sure we insert all known headers (inSync)
if inSync {
break
}
}
if test {
break
}
timer := time.NewTimer(1 * time.Second)
select {
case <-ctx.Done():
stopped = true
case <-logEvery.C:
progress := cfg.hd.Progress()
logProgressHeaders(logPrefix, prevProgress, progress)
prevProgress = progress
case <-timer.C:
log.Trace("RequestQueueTime (header) ticked")
case <-cfg.hd.DeliveryNotify:
log.Trace("headerLoop woken up by the incoming request")
case <-cfg.hd.SkipCycleHack:
break Loop
}
timer.Stop()
}
if headerInserter.Unwind() {
u.UnwindTo(headerInserter.UnwindPoint(), common.Hash{})
}
if headerInserter.GetHighest() != 0 {
if !headerInserter.Unwind() {
if err := fixCanonicalChain(logPrefix, logEvery, headerInserter.GetHighest(), headerInserter.GetHighestHash(), tx, cfg.blockReader); err != nil {
return fmt.Errorf("fix canonical chain: %w", err)
}
}
if err = rawdb.WriteHeadHeaderHash(tx, headerInserter.GetHighestHash()); err != nil {
return fmt.Errorf("[%s] marking head header hash as %x: %w", logPrefix, headerInserter.GetHighestHash(), err)
}
if err = s.Update(tx, headerInserter.GetHighest()); err != nil {
return fmt.Errorf("[%s] saving Headers progress: %w", logPrefix, err)
}
}
if !useExternalTx {
if err := tx.Commit(); err != nil {
return err
}
}
if stopped {
return libcommon.ErrStopped
}
// We do not print the following line if the stage was interrupted
log.Info(fmt.Sprintf("[%s] Processed", logPrefix), "highest inserted", headerInserter.GetHighest(), "age", common.PrettyAge(time.Unix(int64(headerInserter.GetHighestTimestamp()), 0)))
return nil
}
func fixCanonicalChain(logPrefix string, logEvery *time.Ticker, height uint64, hash common.Hash, tx kv.StatelessRwTx, headerReader interfaces.FullBlockReader) error {
if height == 0 {
return nil
}
ancestorHash := hash
ancestorHeight := height
var ch common.Hash
var err error
for ch, err = headerReader.CanonicalHash(context.Background(), tx, ancestorHeight); err == nil && ch != ancestorHash; ch, err = headerReader.CanonicalHash(context.Background(), tx, ancestorHeight) {
if err = rawdb.WriteCanonicalHash(tx, ancestorHash, ancestorHeight); err != nil {
return fmt.Errorf("marking canonical header %d %x: %w", ancestorHeight, ancestorHash, err)
}
ancestor, err := headerReader.Header(context.Background(), tx, ancestorHash, ancestorHeight)
if err != nil {
return err
}
if ancestor == nil {
return fmt.Errorf("ancestor is nil. height %d, hash %x", ancestorHeight, ancestorHash)
}
select {
case <-logEvery.C:
log.Info(fmt.Sprintf("[%s] write canonical markers", logPrefix), "ancestor", ancestorHeight, "hash", ancestorHash)
default:
}
ancestorHash = ancestor.ParentHash
ancestorHeight--
}
if err != nil {
return fmt.Errorf("reading canonical hash for %d: %w", ancestorHeight, err)
}
return nil
}
func HeadersUnwind(u *UnwindState, s *StageState, tx kv.RwTx, cfg HeadersCfg, test bool) (err error) {
useExternalTx := tx != nil
if !useExternalTx {
tx, err = cfg.db.BeginRw(context.Background())
if err != nil {
return err
}
defer tx.Rollback()
}
// Delete canonical hashes that are being unwound
var headerProgress uint64
headerProgress, err = stages.GetStageProgress(tx, stages.Headers)
if err != nil {
return err
}
badBlock := u.BadBlock != (common.Hash{})
if badBlock {
cfg.hd.ReportBadHeader(u.BadBlock)
// Mark all descendants of bad block as bad too
headerCursor, cErr := tx.Cursor(kv.Headers)
if cErr != nil {
return cErr
}
defer headerCursor.Close()
var k, v []byte
for k, v, err = headerCursor.Seek(dbutils.EncodeBlockNumber(u.UnwindPoint + 1)); err == nil && k != nil; k, v, err = headerCursor.Next() {
var h types.Header
if err = rlp.DecodeBytes(v, &h); err != nil {
return err
}
if cfg.hd.IsBadHeader(h.ParentHash) {
cfg.hd.ReportBadHeader(h.Hash())
}
}
if err != nil {
return fmt.Errorf("iterate over headers to mark bad headers: %w", err)
}
}
for blockHeight := headerProgress; blockHeight > u.UnwindPoint; blockHeight-- {
if err = rawdb.DeleteCanonicalHash(tx, blockHeight); err != nil {
return err
}
}
if badBlock {
var maxTd big.Int
var maxHash common.Hash
var maxNum uint64 = 0
if test { // If we are not in the test, we can do searching for the heaviest chain in the next cycle
// Find header with biggest TD
tdCursor, cErr := tx.Cursor(kv.HeaderTD)
if cErr != nil {
return cErr
}
defer tdCursor.Close()
var k, v []byte
k, v, err = tdCursor.Last()
if err != nil {
return err
}
for ; err == nil && k != nil; k, v, err = tdCursor.Prev() {
if len(k) != 40 {
return fmt.Errorf("key in TD table has to be 40 bytes long: %x", k)
}
var hash common.Hash
copy(hash[:], k[8:])
if cfg.hd.IsBadHeader(hash) {
continue
}
var td big.Int
if err = rlp.DecodeBytes(v, &td); err != nil {
return err
}
if td.Cmp(&maxTd) > 0 {
maxTd.Set(&td)
copy(maxHash[:], k[8:])
maxNum = binary.BigEndian.Uint64(k[:8])
}
}
if err != nil {
return err
}
}
if maxNum == 0 {
maxNum = u.UnwindPoint
if maxHash, err = rawdb.ReadCanonicalHash(tx, maxNum); err != nil {
return err
}
}
if err = rawdb.WriteHeadHeaderHash(tx, maxHash); err != nil {
return err
}
if err = u.Done(tx); err != nil {
return err
}
if err = s.Update(tx, maxNum); err != nil {
return err
}
}
if !useExternalTx {
if err := tx.Commit(); err != nil {
return err
}
}
return nil
}
func logProgressHeaders(logPrefix string, prev, now uint64) uint64 {
speed := float64(now-prev) / float64(logInterval/time.Second)
var m runtime.MemStats
runtime.ReadMemStats(&m)
log.Info(fmt.Sprintf("[%s] Wrote block headers", logPrefix),
"number", now,
"blk/second", speed,
"alloc", common.StorageSize(m.Alloc),
"sys", common.StorageSize(m.Sys))
return now
}
type chainReader struct {
config *params.ChainConfig
tx kv.RwTx
blockReader interfaces.FullBlockReader
}
func (cr chainReader) Config() *params.ChainConfig { return cr.config }
func (cr chainReader) CurrentHeader() *types.Header { panic("") }
func (cr chainReader) GetHeader(hash common.Hash, number uint64) *types.Header {
if cr.blockReader != nil {
h, _ := cr.blockReader.Header(context.Background(), cr.tx, hash, number)
return h
}
return rawdb.ReadHeader(cr.tx, hash, number)
}
func (cr chainReader) GetHeaderByNumber(number uint64) *types.Header {
if cr.blockReader != nil {
h, _ := cr.blockReader.HeaderByNumber(context.Background(), cr.tx, number)
return h
}
return rawdb.ReadHeaderByNumber(cr.tx, number)
}
func (cr chainReader) GetHeaderByHash(hash common.Hash) *types.Header {
if cr.blockReader != nil {
number := rawdb.ReadHeaderNumber(cr.tx, hash)
if number == nil {
return nil
}
return cr.GetHeader(hash, *number)
}
h, _ := rawdb.ReadHeaderByHash(cr.tx, hash)
return h
}
func (cr chainReader) GetTd(hash common.Hash, number uint64) *big.Int {
td, err := rawdb.ReadTd(cr.tx, hash, number)
if err != nil {
log.Error("ReadTd failed", "err", err)
return nil
}
return td
}
type epochReader struct {
tx kv.RwTx
}
func (cr epochReader) GetEpoch(hash common.Hash, number uint64) ([]byte, error) {
return rawdb.ReadEpoch(cr.tx, number, hash)
}
func (cr epochReader) PutEpoch(hash common.Hash, number uint64, proof []byte) error {
return rawdb.WriteEpoch(cr.tx, number, hash, proof)
}
func (cr epochReader) GetPendingEpoch(hash common.Hash, number uint64) ([]byte, error) {
return rawdb.ReadPendingEpoch(cr.tx, number, hash)
}
func (cr epochReader) PutPendingEpoch(hash common.Hash, number uint64, proof []byte) error {
return rawdb.WritePendingEpoch(cr.tx, number, hash, proof)
}
func (cr epochReader) FindBeforeOrEqualNumber(number uint64) (blockNum uint64, blockHash common.Hash, transitionProof []byte, err error) {
return rawdb.FindEpochBeforeOrEqualNumber(cr.tx, number)
}
func HeadersPrune(p *PruneState, tx kv.RwTx, cfg HeadersCfg, ctx context.Context) (err error) {
useExternalTx := tx != nil
if !useExternalTx {
tx, err = cfg.db.BeginRw(ctx)
if err != nil {
return err
}
defer tx.Rollback()
}
if !useExternalTx {
if err = tx.Commit(); err != nil {
return err
}
}
return nil
}