-
Notifications
You must be signed in to change notification settings - Fork 4
/
coverageDetailsGo.html
11751 lines (10587 loc) · 600 KB
/
coverageDetailsGo.html
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
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>core: Go Coverage Report</title>
<style>
body {
background: black;
color: rgb(80, 80, 80);
}
body, pre, #legend span {
font-family: Menlo, monospace;
font-weight: bold;
}
#topbar {
background: black;
position: fixed;
top: 0; left: 0; right: 0;
height: 42px;
border-bottom: 1px solid rgb(80, 80, 80);
}
#content {
margin-top: 50px;
}
#nav, #legend {
float: left;
margin-left: 10px;
}
#legend {
margin-top: 12px;
}
#nav {
margin-top: 10px;
}
#legend span {
margin: 0 5px;
}
.cov0 { color: rgb(192, 0, 0) }
.cov1 { color: rgb(128, 128, 128) }
.cov2 { color: rgb(116, 140, 131) }
.cov3 { color: rgb(104, 152, 134) }
.cov4 { color: rgb(92, 164, 137) }
.cov5 { color: rgb(80, 176, 140) }
.cov6 { color: rgb(68, 188, 143) }
.cov7 { color: rgb(56, 200, 146) }
.cov8 { color: rgb(44, 212, 149) }
.cov9 { color: rgb(32, 224, 152) }
.cov10 { color: rgb(20, 236, 155) }
</style>
</head>
<body>
<div id="topbar">
<div id="nav">
<select id="files">
<option value="file0">github.com/harmony-one/harmony/core/blockchain.go (24.2%)</option>
<option value="file1">github.com/harmony-one/harmony/core/chain_makers.go (0.0%)</option>
<option value="file2">github.com/harmony-one/harmony/core/evm.go (65.8%)</option>
<option value="file3">github.com/harmony-one/harmony/core/offchain.go (29.8%)</option>
<option value="file4">github.com/harmony-one/harmony/core/staking_verifier.go (96.2%)</option>
<option value="file5">github.com/harmony-one/harmony/core/state_processor.go (49.6%)</option>
<option value="file6">github.com/harmony-one/harmony/core/state_transition.go (69.4%)</option>
<option value="file7">github.com/harmony-one/harmony/core/tx_pool.go (61.0%)</option>
<option value="file8">github.com/harmony-one/harmony/core/vm/contracts.go (77.6%)</option>
<option value="file9">github.com/harmony-one/harmony/core/vm/contracts_write.go (75.9%)</option>
<option value="file10">github.com/harmony-one/harmony/core/vm/evm.go (37.9%)</option>
<option value="file11">github.com/harmony-one/harmony/core/vm/gas.go (63.3%)</option>
<option value="file12">github.com/harmony-one/harmony/hmy/tracer.go (0.0%)</option>
<option value="file13">github.com/harmony-one/harmony/internal/params/config.go (60.7%)</option>
<option value="file14">github.com/harmony-one/harmony/node/worker/worker.go (42.5%)</option>
<option value="file15">github.com/harmony-one/harmony/rosetta/services/construction_check.go (23.4%)</option>
<option value="file16">github.com/harmony-one/harmony/staking/precompile.go (88.0%)</option>
<option value="file17">github.com/harmony-one/harmony/staking/types/messages.go (89.4%)</option>
</select>
</div>
<div id="legend">
<span>not tracked</span>
<span class="cov0">not covered</span>
<span class="cov8">covered</span>
</div>
</div>
<div id="content">
<pre class="file" id="file0" style="display: none">// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum 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 go-ethereum 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 go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
// Package core implements the Ethereum consensus protocol.
package core
import (
"bytes"
"encoding/json"
"fmt"
"io"
"math/big"
"os"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/common/mclock"
"github.com/ethereum/go-ethereum/common/prque"
"github.com/ethereum/go-ethereum/crypto"
"github.com/ethereum/go-ethereum/ethdb"
"github.com/ethereum/go-ethereum/event"
"github.com/ethereum/go-ethereum/metrics"
"github.com/ethereum/go-ethereum/rlp"
"github.com/harmony-one/harmony/block"
consensus_engine "github.com/harmony-one/harmony/consensus/engine"
"github.com/harmony-one/harmony/consensus/reward"
"github.com/harmony-one/harmony/consensus/votepower"
"github.com/harmony-one/harmony/core/rawdb"
"github.com/harmony-one/harmony/core/state"
"github.com/harmony-one/harmony/core/types"
"github.com/harmony-one/harmony/core/vm"
"github.com/harmony-one/harmony/internal/params"
"github.com/harmony-one/harmony/internal/utils"
"github.com/harmony-one/harmony/numeric"
"github.com/harmony-one/harmony/shard"
"github.com/harmony-one/harmony/shard/committee"
"github.com/harmony-one/harmony/staking/apr"
"github.com/harmony-one/harmony/staking/effective"
"github.com/harmony-one/harmony/staking/slash"
staking "github.com/harmony-one/harmony/staking/types"
lru "github.com/hashicorp/golang-lru"
"github.com/pkg/errors"
)
var (
// blockInsertTimer
blockInsertTimer = metrics.NewRegisteredTimer("chain/inserts", nil)
// ErrNoGenesis is the error when there is no genesis.
ErrNoGenesis = errors.New("Genesis not found in chain")
// errExceedMaxPendingSlashes ..
errExceedMaxPendingSlashes = errors.New("exceeed max pending slashes")
errNilEpoch = errors.New("nil epoch for voting power computation")
)
const (
bodyCacheLimit = 2048
blockCacheLimit = 2048
receiptsCacheLimit = 32
maxFutureBlocks = 256
maxTimeFutureBlocks = 30
badBlockLimit = 10
triesInMemory = 128
shardCacheLimit = 10
commitsCacheLimit = 10
epochCacheLimit = 10
randomnessCacheLimit = 10
validatorCacheLimit = 1024
validatorStatsCacheLimit = 1024
validatorListCacheLimit = 10
validatorListByDelegatorCacheLimit = 1024
pendingCrossLinksCacheLimit = 2
blockAccumulatorCacheLimit = 256
maxPendingSlashes = 512
// BlockChainVersion ensures that an incompatible database forces a resync from scratch.
BlockChainVersion = 3
pendingCLCacheKey = "pendingCLs"
)
// CacheConfig contains the configuration values for the trie caching/pruning
// that's resident in a blockchain.
type CacheConfig struct {
Disabled bool // Whether to disable trie write caching (archive node)
TrieNodeLimit int // Memory limit (MB) at which to flush the current in-memory trie to disk
TrieTimeLimit time.Duration // Time limit after which to flush the current in-memory trie to disk
}
// BlockChain represents the canonical chain given a database with a genesis
// block. The Blockchain manages chain imports, reverts, chain reorganisations.
//
// Importing blocks in to the block chain happens according to the set of rules
// defined by the two stage validator. Processing of blocks is done using the
// Processor which processes the included transaction. The validation of the state
// is done in the second part of the validator. Failing results in aborting of
// the import.
//
// The BlockChain also helps in returning blocks from **any** chain included
// in the database as well as blocks that represents the canonical chain. It's
// important to note that GetBlock can return any block and does not need to be
// included in the canonical one where as GetBlockByNumber always represents the
// canonical chain.
type BlockChain struct {
chainConfig *params.ChainConfig // Chain & network configuration
cacheConfig *CacheConfig // Cache configuration for pruning
db ethdb.Database // Low level persistent database to store final content in
triegc *prque.Prque // Priority queue mapping block numbers to tries to gc
gcproc time.Duration // Accumulates canonical block processing for trie dumping
hc *HeaderChain
rmLogsFeed event.Feed
chainFeed event.Feed
chainSideFeed event.Feed
chainHeadFeed event.Feed
logsFeed event.Feed
scope event.SubscriptionScope
genesisBlock *types.Block
mu sync.RWMutex // global mutex for locking chain operations
chainmu sync.RWMutex // blockchain insertion lock
procmu sync.RWMutex // block processor lock
pendingCrossLinksMutex sync.RWMutex // pending crosslinks lock
pendingSlashingCandidatesMU sync.RWMutex // pending slashing candidates
currentBlock atomic.Value // Current head of the block chain
currentFastBlock atomic.Value // Current head of the fast-sync chain (may be above the block chain!)
stateCache state.Database // State database to reuse between imports (contains state cache)
bodyCache *lru.Cache // Cache for the most recent block bodies
bodyRLPCache *lru.Cache // Cache for the most recent block bodies in RLP encoded format
receiptsCache *lru.Cache // Cache for the most recent receipts per block
blockCache *lru.Cache // Cache for the most recent entire blocks
futureBlocks *lru.Cache // future blocks are blocks added for later processing
shardStateCache *lru.Cache
lastCommitsCache *lru.Cache
epochCache *lru.Cache // Cache epoch number → first block number
randomnessCache *lru.Cache // Cache for vrf/vdf
validatorSnapshotCache *lru.Cache // Cache for validator snapshot
validatorStatsCache *lru.Cache // Cache for validator stats
validatorListCache *lru.Cache // Cache of validator list
validatorListByDelegatorCache *lru.Cache // Cache of validator list by delegator
pendingCrossLinksCache *lru.Cache // Cache of last pending crosslinks
blockAccumulatorCache *lru.Cache // Cache of block accumulators
quit chan struct{} // blockchain quit channel
running int32 // running must be called atomically
// procInterrupt must be atomically called
procInterrupt int32 // interrupt signaler for block processing
wg sync.WaitGroup // chain processing wait group for shutting down
engine consensus_engine.Engine
processor Processor // block processor interface
validator Validator // block and state validator interface
vmConfig vm.Config
badBlocks *lru.Cache // Bad block cache
shouldPreserve func(*types.Block) bool // Function used to determine whether should preserve the given block.
pendingSlashes slash.Records
maxGarbCollectedBlkNum int64
}
// NewBlockChain returns a fully initialised block chain using information
// available in the database. It initialises the default Ethereum validator and
// Processor.
func NewBlockChain(
db ethdb.Database, cacheConfig *CacheConfig, chainConfig *params.ChainConfig,
engine consensus_engine.Engine, vmConfig vm.Config,
shouldPreserve func(block *types.Block) bool,
) (*BlockChain, error) <span class="cov8" title="1">{
if cacheConfig == nil </span><span class="cov8" title="1">{
cacheConfig = &CacheConfig{
TrieNodeLimit: 256 * 1024 * 1024,
TrieTimeLimit: 2 * time.Minute,
}
}</span>
<span class="cov8" title="1">bodyCache, _ := lru.New(bodyCacheLimit)
bodyRLPCache, _ := lru.New(bodyCacheLimit)
receiptsCache, _ := lru.New(receiptsCacheLimit)
blockCache, _ := lru.New(blockCacheLimit)
futureBlocks, _ := lru.New(maxFutureBlocks)
badBlocks, _ := lru.New(badBlockLimit)
shardCache, _ := lru.New(shardCacheLimit)
commitsCache, _ := lru.New(commitsCacheLimit)
epochCache, _ := lru.New(epochCacheLimit)
randomnessCache, _ := lru.New(randomnessCacheLimit)
validatorCache, _ := lru.New(validatorCacheLimit)
validatorStatsCache, _ := lru.New(validatorStatsCacheLimit)
validatorListCache, _ := lru.New(validatorListCacheLimit)
validatorListByDelegatorCache, _ := lru.New(validatorListByDelegatorCacheLimit)
pendingCrossLinksCache, _ := lru.New(pendingCrossLinksCacheLimit)
blockAccumulatorCache, _ := lru.New(blockAccumulatorCacheLimit)
bc := &BlockChain{
chainConfig: chainConfig,
cacheConfig: cacheConfig,
db: db,
triegc: prque.New(nil),
stateCache: state.NewDatabase(db),
quit: make(chan struct{}),
shouldPreserve: shouldPreserve,
bodyCache: bodyCache,
bodyRLPCache: bodyRLPCache,
receiptsCache: receiptsCache,
blockCache: blockCache,
futureBlocks: futureBlocks,
shardStateCache: shardCache,
lastCommitsCache: commitsCache,
epochCache: epochCache,
randomnessCache: randomnessCache,
validatorSnapshotCache: validatorCache,
validatorStatsCache: validatorStatsCache,
validatorListCache: validatorListCache,
validatorListByDelegatorCache: validatorListByDelegatorCache,
pendingCrossLinksCache: pendingCrossLinksCache,
blockAccumulatorCache: blockAccumulatorCache,
engine: engine,
vmConfig: vmConfig,
badBlocks: badBlocks,
pendingSlashes: slash.Records{},
maxGarbCollectedBlkNum: -1,
}
bc.SetValidator(NewBlockValidator(chainConfig, bc, engine))
bc.SetProcessor(NewStateProcessor(chainConfig, bc, engine))
var err error
bc.hc, err = NewHeaderChain(db, chainConfig, engine, bc.getProcInterrupt)
if err != nil </span><span class="cov0" title="0">{
return nil, err
}</span>
<span class="cov8" title="1">bc.genesisBlock = bc.GetBlockByNumber(0)
if bc.genesisBlock == nil </span><span class="cov0" title="0">{
return nil, ErrNoGenesis
}</span>
<span class="cov8" title="1">var nilBlock *types.Block
bc.currentBlock.Store(nilBlock)
bc.currentFastBlock.Store(nilBlock)
if err := bc.loadLastState(); err != nil </span><span class="cov0" title="0">{
return nil, err
}</span>
// Take ownership of this particular state
<span class="cov8" title="1">go bc.update()
return bc, nil</span>
}
// ValidateNewBlock validates new block.
func (bc *BlockChain) ValidateNewBlock(block *types.Block) error <span class="cov8" title="1">{
state, err := state.New(bc.CurrentBlock().Root(), bc.stateCache)
if err != nil </span><span class="cov0" title="0">{
return err
}</span>
// NOTE Order of mutating state here matters.
// Process block using the parent state as reference point.
// Do not read cache from processor.
<span class="cov8" title="1">receipts, cxReceipts, _, _, usedGas, _, _, err := bc.processor.Process(
block, state, bc.vmConfig, false,
)
if err != nil </span><span class="cov0" title="0">{
bc.reportBlock(block, receipts, err)
return err
}</span>
// Verify all the hash roots (state, txns, receipts, cross-shard)
<span class="cov8" title="1">if err := bc.Validator().ValidateState(
block, state, receipts, cxReceipts, usedGas,
); err != nil </span><span class="cov0" title="0">{
bc.reportBlock(block, receipts, err)
return err
}</span>
<span class="cov8" title="1">return nil</span>
}
// IsEpochBlock returns whether this block is the first block of an epoch.
// by checking if the previous block is the last block of the previous epoch
func IsEpochBlock(block *types.Block) bool <span class="cov8" title="1">{
if block.NumberU64() == 0 </span><span class="cov8" title="1">{
// genesis block is the first epoch block
return true
}</span>
<span class="cov8" title="1">return shard.Schedule.IsLastBlock(block.NumberU64() - 1)</span>
}
func (bc *BlockChain) getProcInterrupt() bool <span class="cov0" title="0">{
return atomic.LoadInt32(&bc.procInterrupt) == 1
}</span>
// loadLastState loads the last known chain state from the database. This method
// assumes that the chain manager mutex is held.
func (bc *BlockChain) loadLastState() error <span class="cov8" title="1">{
// Restore the last known head block
head := rawdb.ReadHeadBlockHash(bc.db)
if head == (common.Hash{}) </span><span class="cov0" title="0">{
// Corrupt or empty database, init from scratch
utils.Logger().Warn().Msg("Empty database, resetting chain")
return bc.Reset()
}</span>
// Make sure the entire head block is available
<span class="cov8" title="1">currentBlock := bc.GetBlockByHash(head)
if currentBlock == nil </span><span class="cov0" title="0">{
// Corrupt or empty database, init from scratch
utils.Logger().Warn().Str("hash", head.Hex()).Msg("Head block missing, resetting chain")
return bc.Reset()
}</span>
// Make sure the state associated with the block is available
<span class="cov8" title="1">if _, err := state.New(currentBlock.Root(), bc.stateCache); err != nil </span><span class="cov0" title="0">{
// Dangling block without a state associated, init from scratch
utils.Logger().Warn().
Str("number", currentBlock.Number().String()).
Str("hash", currentBlock.Hash().Hex()).
Msg("Head state missing, repairing chain")
if err := bc.repair(&currentBlock); err != nil </span><span class="cov0" title="0">{
return err
}</span>
}
// Everything seems to be fine, set as the head block
<span class="cov8" title="1">bc.currentBlock.Store(currentBlock)
// We don't need the following as we want the current header and block to be consistent
// Restore the last known head header
//currentHeader := currentBlock.Header()
//if head := rawdb.ReadHeadHeaderHash(bc.db); head != (common.Hash{}) {
// if header := bc.GetHeaderByHash(head); header != nil {
// currentHeader = header
// }
//}
currentHeader := currentBlock.Header()
if err := bc.hc.SetCurrentHeader(currentHeader); err != nil </span><span class="cov0" title="0">{
return errors.Wrap(err, "headerChain SetCurrentHeader")
}</span>
// Restore the last known head fast block
<span class="cov8" title="1">bc.currentFastBlock.Store(currentBlock)
if head := rawdb.ReadHeadFastBlockHash(bc.db); head != (common.Hash{}) </span><span class="cov0" title="0">{
if block := bc.GetBlockByHash(head); block != nil </span><span class="cov0" title="0">{
bc.currentFastBlock.Store(block)
}</span>
}
// Issue a status log for the user
<span class="cov8" title="1">currentFastBlock := bc.CurrentFastBlock()
headerTd := bc.GetTd(currentHeader.Hash(), currentHeader.Number().Uint64())
blockTd := bc.GetTd(currentBlock.Hash(), currentBlock.NumberU64())
fastTd := bc.GetTd(currentFastBlock.Hash(), currentFastBlock.NumberU64())
utils.Logger().Info().
Str("number", currentHeader.Number().String()).
Str("hash", currentHeader.Hash().Hex()).
Str("td", headerTd.String()).
Str("age", common.PrettyAge(time.Unix(currentHeader.Time().Int64(), 0)).String()).
Msg("Loaded most recent local header")
utils.Logger().Info().
Str("number", currentBlock.Number().String()).
Str("hash", currentBlock.Hash().Hex()).
Str("td", blockTd.String()).
Str("age", common.PrettyAge(time.Unix(currentBlock.Time().Int64(), 0)).String()).
Msg("Loaded most recent local full block")
utils.Logger().Info().
Str("number", currentFastBlock.Number().String()).
Str("hash", currentFastBlock.Hash().Hex()).
Str("td", fastTd.String()).
Str("age", common.PrettyAge(time.Unix(currentFastBlock.Time().Int64(), 0)).String()).
Msg("Loaded most recent local fast block")
return nil</span>
}
// SetHead rewinds the local chain to a new head. In the case of headers, everything
// above the new head will be deleted and the new one set. In the case of blocks
// though, the head may be further rewound if block bodies are missing (non-archive
// nodes after a fast sync).
func (bc *BlockChain) SetHead(head uint64) error <span class="cov0" title="0">{
utils.Logger().Warn().Uint64("target", head).Msg("Rewinding blockchain")
bc.mu.Lock()
defer bc.mu.Unlock()
// Rewind the header chain, deleting all block bodies until then
delFn := func(db rawdb.DatabaseDeleter, hash common.Hash, num uint64) error </span><span class="cov0" title="0">{
return rawdb.DeleteBody(db, hash, num)
}</span>
<span class="cov0" title="0">if err := bc.hc.SetHead(head, delFn); err != nil </span><span class="cov0" title="0">{
return errors.Wrap(err, "headerChain SetHeader")
}</span>
<span class="cov0" title="0">currentHeader := bc.hc.CurrentHeader()
// Clear out any stale content from the caches
bc.bodyCache.Purge()
bc.bodyRLPCache.Purge()
bc.receiptsCache.Purge()
bc.blockCache.Purge()
bc.futureBlocks.Purge()
bc.shardStateCache.Purge()
// Rewind the block chain, ensuring we don't end up with a stateless head block
if currentBlock := bc.CurrentBlock(); currentBlock != nil && currentHeader.Number().Uint64() < currentBlock.NumberU64() </span><span class="cov0" title="0">{
bc.currentBlock.Store(bc.GetBlock(currentHeader.Hash(), currentHeader.Number().Uint64()))
}</span>
<span class="cov0" title="0">if currentBlock := bc.CurrentBlock(); currentBlock != nil </span><span class="cov0" title="0">{
if _, err := state.New(currentBlock.Root(), bc.stateCache); err != nil </span><span class="cov0" title="0">{
// Rewound state missing, rolled back to before pivot, reset to genesis
bc.currentBlock.Store(bc.genesisBlock)
}</span>
}
// Rewind the fast block in a simpleton way to the target head
<span class="cov0" title="0">if currentFastBlock := bc.CurrentFastBlock(); currentFastBlock != nil && currentHeader.Number().Uint64() < currentFastBlock.NumberU64() </span><span class="cov0" title="0">{
bc.currentFastBlock.Store(bc.GetBlock(currentHeader.Hash(), currentHeader.Number().Uint64()))
}</span>
// If either blocks reached nil, reset to the genesis state
<span class="cov0" title="0">if currentBlock := bc.CurrentBlock(); currentBlock == nil </span><span class="cov0" title="0">{
bc.currentBlock.Store(bc.genesisBlock)
}</span>
<span class="cov0" title="0">if currentFastBlock := bc.CurrentFastBlock(); currentFastBlock == nil </span><span class="cov0" title="0">{
bc.currentFastBlock.Store(bc.genesisBlock)
}</span>
<span class="cov0" title="0">currentBlock := bc.CurrentBlock()
currentFastBlock := bc.CurrentFastBlock()
if err := rawdb.WriteHeadBlockHash(bc.db, currentBlock.Hash()); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov0" title="0">if err := rawdb.WriteHeadFastBlockHash(bc.db, currentFastBlock.Hash()); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov0" title="0">return bc.loadLastState()</span>
}
// ShardID returns the shard Id of the blockchain.
// TODO: use a better solution before resharding shuffle nodes to different shards
func (bc *BlockChain) ShardID() uint32 <span class="cov8" title="1">{
return bc.CurrentBlock().ShardID()
}</span>
// GasLimit returns the gas limit of the current HEAD block.
func (bc *BlockChain) GasLimit() uint64 <span class="cov0" title="0">{
return bc.CurrentBlock().GasLimit()
}</span>
// CurrentBlock retrieves the current head block of the canonical chain. The
// block is retrieved from the blockchain's internal cache.
func (bc *BlockChain) CurrentBlock() *types.Block <span class="cov8" title="1">{
return bc.currentBlock.Load().(*types.Block)
}</span>
// CurrentFastBlock retrieves the current fast-sync head block of the canonical
// chain. The block is retrieved from the blockchain's internal cache.
func (bc *BlockChain) CurrentFastBlock() *types.Block <span class="cov8" title="1">{
return bc.currentFastBlock.Load().(*types.Block)
}</span>
// SetProcessor sets the processor required for making state modifications.
func (bc *BlockChain) SetProcessor(processor Processor) <span class="cov8" title="1">{
bc.procmu.Lock()
defer bc.procmu.Unlock()
bc.processor = processor
}</span>
// SetValidator sets the validator which is used to validate incoming blocks.
func (bc *BlockChain) SetValidator(validator Validator) <span class="cov8" title="1">{
bc.procmu.Lock()
defer bc.procmu.Unlock()
bc.validator = validator
}</span>
// Validator returns the current validator.
func (bc *BlockChain) Validator() Validator <span class="cov8" title="1">{
bc.procmu.RLock()
defer bc.procmu.RUnlock()
return bc.validator
}</span>
// Processor returns the current processor.
func (bc *BlockChain) Processor() Processor <span class="cov0" title="0">{
bc.procmu.RLock()
defer bc.procmu.RUnlock()
return bc.processor
}</span>
// State returns a new mutable state based on the current HEAD block.
func (bc *BlockChain) State() (*state.DB, error) <span class="cov0" title="0">{
return bc.StateAt(bc.CurrentBlock().Root())
}</span>
// StateAt returns a new mutable state based on a particular point in time.
func (bc *BlockChain) StateAt(root common.Hash) (*state.DB, error) <span class="cov8" title="1">{
return state.New(root, bc.stateCache)
}</span>
// Reset purges the entire blockchain, restoring it to its genesis state.
func (bc *BlockChain) Reset() error <span class="cov0" title="0">{
return bc.ResetWithGenesisBlock(bc.genesisBlock)
}</span>
// ResetWithGenesisBlock purges the entire blockchain, restoring it to the
// specified genesis state.
func (bc *BlockChain) ResetWithGenesisBlock(genesis *types.Block) error <span class="cov0" title="0">{
// Dump the entire block chain and purge the caches
if err := bc.SetHead(0); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov0" title="0">bc.mu.Lock()
defer bc.mu.Unlock()
// Prepare the genesis block and reinitialise the chain
if err := rawdb.WriteBlock(bc.db, genesis); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov0" title="0">bc.genesisBlock = genesis
if err := bc.insert(bc.genesisBlock); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov0" title="0">bc.hc.SetGenesis(bc.genesisBlock.Header())
if err := bc.hc.SetCurrentHeader(bc.genesisBlock.Header()); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov0" title="0">bc.currentBlock.Store(bc.genesisBlock)
bc.currentFastBlock.Store(bc.genesisBlock)
return nil</span>
}
// repair tries to repair the current blockchain by rolling back the current block
// until one with associated state is found. This is needed to fix incomplete db
// writes caused either by crashes/power outages, or simply non-committed tries.
//
// This method only rolls back the current block. The current header and current
// fast block are left intact.
func (bc *BlockChain) repair(head **types.Block) error <span class="cov0" title="0">{
valsToRemove := map[common.Address]struct{}{}
for </span><span class="cov0" title="0">{
// Abort if we've rewound to a head block that does have associated state
if _, err := state.New((*head).Root(), bc.stateCache); err == nil </span><span class="cov0" title="0">{
utils.Logger().Info().
Str("number", (*head).Number().String()).
Str("hash", (*head).Hash().Hex()).
Msg("Rewound blockchain to past state")
return bc.removeInValidatorList(valsToRemove)
}</span>
// Repair last commit sigs
<span class="cov0" title="0">lastSig := (*head).Header().LastCommitSignature()
sigAndBitMap := append(lastSig[:], (*head).Header().LastCommitBitmap()...)
bc.WriteCommitSig((*head).NumberU64()-1, sigAndBitMap)
// Otherwise rewind one block and recheck state availability there
for _, stkTxn := range (*head).StakingTransactions() </span><span class="cov0" title="0">{
if stkTxn.StakingType() == staking.DirectiveCreateValidator </span><span class="cov0" title="0">{
if addr, err := stkTxn.SenderAddress(); err == nil </span><span class="cov0" title="0">{
valsToRemove[addr] = struct{}{}
}</span> else<span class="cov0" title="0"> {
return err
}</span>
}
}
<span class="cov0" title="0">block := bc.GetBlock((*head).ParentHash(), (*head).NumberU64()-1)
if block == nil </span><span class="cov0" title="0">{
return fmt.Errorf("missing block %d [%x]", (*head).NumberU64()-1, (*head).ParentHash())
}</span>
<span class="cov0" title="0">*head = block</span>
}
}
// This func is used to remove the validator addresses from the validator list.
func (bc *BlockChain) removeInValidatorList(toRemove map[common.Address]struct{}) error <span class="cov0" title="0">{
if len(toRemove) == 0 </span><span class="cov0" title="0">{
return nil
}</span>
<span class="cov0" title="0">utils.Logger().Info().
Interface("validators", toRemove).
Msg("Removing validators from validator list")
existingVals, err := bc.ReadValidatorList()
if err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov0" title="0">newVals := []common.Address{}
for _, addr := range existingVals </span><span class="cov0" title="0">{
if _, ok := toRemove[addr]; !ok </span><span class="cov0" title="0">{
newVals = append(newVals, addr)
}</span>
}
<span class="cov0" title="0">return bc.WriteValidatorList(bc.db, newVals)</span>
}
// Export writes the active chain to the given writer.
func (bc *BlockChain) Export(w io.Writer) error <span class="cov0" title="0">{
return bc.ExportN(w, uint64(0), bc.CurrentBlock().NumberU64())
}</span>
// ExportN writes a subset of the active chain to the given writer.
func (bc *BlockChain) ExportN(w io.Writer, first uint64, last uint64) error <span class="cov0" title="0">{
bc.mu.RLock()
defer bc.mu.RUnlock()
if first > last </span><span class="cov0" title="0">{
return fmt.Errorf("export failed: first (%d) is greater than last (%d)", first, last)
}</span>
<span class="cov0" title="0">utils.Logger().Info().Uint64("count", last-first+1).Msg("Exporting batch of blocks")
start, reported := time.Now(), time.Now()
for nr := first; nr <= last; nr++ </span><span class="cov0" title="0">{
block := bc.GetBlockByNumber(nr)
if block == nil </span><span class="cov0" title="0">{
return fmt.Errorf("export failed on #%d: not found", nr)
}</span>
<span class="cov0" title="0">if err := block.EncodeRLP(w); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov0" title="0">if time.Since(reported) >= statsReportLimit </span><span class="cov0" title="0">{
utils.Logger().Info().
Uint64("exported", block.NumberU64()-first).
Str("elapsed", common.PrettyDuration(time.Since(start)).String()).
Msg("Exporting blocks")
reported = time.Now()
}</span>
}
<span class="cov0" title="0">return nil</span>
}
// writeHeadBlock writes a new head block
func (bc *BlockChain) writeHeadBlock(block *types.Block) error <span class="cov8" title="1">{
// If the block is on a side chain or an unknown one, force other heads onto it too
updateHeads := rawdb.ReadCanonicalHash(bc.db, block.NumberU64()) != block.Hash()
// Add the block to the canonical chain number scheme and mark as the head
batch := bc.ChainDb().NewBatch()
if err := rawdb.WriteCanonicalHash(batch, block.Hash(), block.NumberU64()); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov8" title="1">if err := rawdb.WriteHeadBlockHash(batch, block.Hash()); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov8" title="1">if err := batch.Write(); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov8" title="1">bc.currentBlock.Store(block)
// If the block is better than our head or is on a different chain, force update heads
if updateHeads </span><span class="cov8" title="1">{
if err := bc.hc.SetCurrentHeader(block.Header()); err != nil </span><span class="cov0" title="0">{
return errors.Wrap(err, "HeaderChain SetCurrentHeader")
}</span>
<span class="cov8" title="1">if err := rawdb.WriteHeadFastBlockHash(bc.db, block.Hash()); err != nil </span><span class="cov0" title="0">{
return err
}</span>
<span class="cov8" title="1">bc.currentFastBlock.Store(block)</span>
}
<span class="cov8" title="1">return nil</span>
}
// insert injects a new head block into the current block chain. This method
// assumes that the block is indeed a true head. It will also reset the head
// header and the head fast sync block to this very same block if they are older
// or if they are on a different side chain.
//
// Note, this function assumes that the `mu` mutex is held!
func (bc *BlockChain) insert(block *types.Block) error <span class="cov0" title="0">{
return bc.writeHeadBlock(block)
}</span>
// Genesis retrieves the chain's genesis block.
func (bc *BlockChain) Genesis() *types.Block <span class="cov0" title="0">{
return bc.genesisBlock
}</span>
// GetBody retrieves a block body (transactions and uncles) from the database by
// hash, caching it if found.
func (bc *BlockChain) GetBody(hash common.Hash) *types.Body <span class="cov0" title="0">{
// Short circuit if the body's already in the cache, retrieve otherwise
if cached, ok := bc.bodyCache.Get(hash); ok </span><span class="cov0" title="0">{
body := cached.(*types.Body)
return body
}</span>
<span class="cov0" title="0">number := bc.hc.GetBlockNumber(hash)
if number == nil </span><span class="cov0" title="0">{
return nil
}</span>
<span class="cov0" title="0">body := rawdb.ReadBody(bc.db, hash, *number)
if body == nil </span><span class="cov0" title="0">{
return nil
}</span>
// Cache the found body for next time and return
<span class="cov0" title="0">bc.bodyCache.Add(hash, body)
return body</span>
}
// GetBodyRLP retrieves a block body in RLP encoding from the database by hash,
// caching it if found.
func (bc *BlockChain) GetBodyRLP(hash common.Hash) rlp.RawValue <span class="cov0" title="0">{
// Short circuit if the body's already in the cache, retrieve otherwise
if cached, ok := bc.bodyRLPCache.Get(hash); ok </span><span class="cov0" title="0">{
return cached.(rlp.RawValue)
}</span>
<span class="cov0" title="0">number := bc.hc.GetBlockNumber(hash)
if number == nil </span><span class="cov0" title="0">{
return nil
}</span>
<span class="cov0" title="0">body := rawdb.ReadBodyRLP(bc.db, hash, *number)
if len(body) == 0 </span><span class="cov0" title="0">{
return nil
}</span>
// Cache the found body for next time and return
<span class="cov0" title="0">bc.bodyRLPCache.Add(hash, body)
return body</span>
}
// HasBlock checks if a block is fully present in the database or not.
func (bc *BlockChain) HasBlock(hash common.Hash, number uint64) bool <span class="cov0" title="0">{
if bc.blockCache.Contains(hash) </span><span class="cov0" title="0">{
return true
}</span>
<span class="cov0" title="0">return rawdb.HasBody(bc.db, hash, number)</span>
}
// HasState checks if state trie is fully present in the database or not.
func (bc *BlockChain) HasState(hash common.Hash) bool <span class="cov8" title="1">{
_, err := bc.stateCache.OpenTrie(hash)
return err == nil
}</span>
// HasBlockAndState checks if a block and associated state trie is fully present
// in the database or not, caching it if present.
func (bc *BlockChain) HasBlockAndState(hash common.Hash, number uint64) bool <span class="cov8" title="1">{
// Check first that the block itself is known
block := bc.GetBlock(hash, number)
if block == nil </span><span class="cov8" title="1">{
return false
}</span>
<span class="cov8" title="1">return bc.HasState(block.Root())</span>
}
// GetBlock retrieves a block from the database by hash and number,
// caching it if found.
func (bc *BlockChain) GetBlock(hash common.Hash, number uint64) *types.Block <span class="cov8" title="1">{
// Short circuit if the block's already in the cache, retrieve otherwise
if block, ok := bc.blockCache.Get(hash); ok </span><span class="cov8" title="1">{
return block.(*types.Block)
}</span>
<span class="cov8" title="1">block := rawdb.ReadBlock(bc.db, hash, number)
if block == nil </span><span class="cov8" title="1">{
return nil
}</span>
// Cache the found block for next time and return
<span class="cov8" title="1">bc.blockCache.Add(block.Hash(), block)
return block</span>
}
// GetBlockByHash retrieves a block from the database by hash, caching it if found.
func (bc *BlockChain) GetBlockByHash(hash common.Hash) *types.Block <span class="cov8" title="1">{
number := bc.hc.GetBlockNumber(hash)
if number == nil </span><span class="cov0" title="0">{
return nil
}</span>
<span class="cov8" title="1">return bc.GetBlock(hash, *number)</span>
}
// GetBlockByNumber retrieves a block from the database by number, caching it
// (associated with its hash) if found.
func (bc *BlockChain) GetBlockByNumber(number uint64) *types.Block <span class="cov8" title="1">{
hash := rawdb.ReadCanonicalHash(bc.db, number)
if hash == (common.Hash{}) </span><span class="cov0" title="0">{
return nil
}</span>
<span class="cov8" title="1">return bc.GetBlock(hash, number)</span>
}
// GetReceiptsByHash retrieves the receipts for all transactions in a given block.
func (bc *BlockChain) GetReceiptsByHash(hash common.Hash) types.Receipts <span class="cov0" title="0">{
if receipts, ok := bc.receiptsCache.Get(hash); ok </span><span class="cov0" title="0">{
return receipts.(types.Receipts)
}</span>
<span class="cov0" title="0">number := rawdb.ReadHeaderNumber(bc.db, hash)
if number == nil </span><span class="cov0" title="0">{
return nil
}</span>
<span class="cov0" title="0">receipts := rawdb.ReadReceipts(bc.db, hash, *number)
bc.receiptsCache.Add(hash, receipts)
return receipts</span>
}
// GetBlocksFromHash returns the block corresponding to hash and up to n-1 ancestors.
// [deprecated by eth/62]
func (bc *BlockChain) GetBlocksFromHash(hash common.Hash, n int) (blocks []*types.Block) <span class="cov0" title="0">{
number := bc.hc.GetBlockNumber(hash)
if number == nil </span><span class="cov0" title="0">{
return nil
}</span>
<span class="cov0" title="0">for i := 0; i < n; i++ </span><span class="cov0" title="0">{
block := bc.GetBlock(hash, *number)
if block == nil </span><span class="cov0" title="0">{
break</span>
}
<span class="cov0" title="0">blocks = append(blocks, block)
hash = block.ParentHash()
*number--</span>
}
<span class="cov0" title="0">return</span>
}
// GetUnclesInChain retrieves all the uncles from a given block backwards until
// a specific distance is reached.
func (bc *BlockChain) GetUnclesInChain(b *types.Block, length int) []*block.Header <span class="cov0" title="0">{
uncles := []*block.Header{}
for i := 0; b != nil && i < length; i++ </span><span class="cov0" title="0">{
uncles = append(uncles, b.Uncles()...)
b = bc.GetBlock(b.ParentHash(), b.NumberU64()-1)
}</span>
<span class="cov0" title="0">return uncles</span>
}
// TrieNode retrieves a blob of data associated with a trie node (or code hash)
// either from ephemeral in-memory cache, or from persistent storage.
func (bc *BlockChain) TrieNode(hash common.Hash) ([]byte, error) <span class="cov0" title="0">{
return bc.stateCache.TrieDB().Node(hash)
}</span>
// Stop stops the blockchain service. If any imports are currently in progress
// it will abort them using the procInterrupt.
func (bc *BlockChain) Stop() <span class="cov0" title="0">{
if !atomic.CompareAndSwapInt32(&bc.running, 0, 1) </span><span class="cov0" title="0">{
return
}</span>
<span class="cov0" title="0">if err := bc.SavePendingCrossLinks(); err != nil </span><span class="cov0" title="0">{
utils.Logger().Error().Err(err).Msg("Failed to save pending cross links")
}</span>
// Unsubscribe all subscriptions registered from blockchain
<span class="cov0" title="0">bc.scope.Close()
close(bc.quit)
atomic.StoreInt32(&bc.procInterrupt, 1)
bc.wg.Wait()
// Ensure the state of a recent block is also stored to disk before exiting.
// We're writing three different states to catch different restart scenarios:
// - HEAD: So we don't need to reprocess any blocks in the general case
// - HEAD-1: So we don't do large reorgs if our HEAD becomes an uncle
// - HEAD-127: So we have a hard limit on the number of blocks reexecuted
if !bc.cacheConfig.Disabled </span><span class="cov0" title="0">{
triedb := bc.stateCache.TrieDB()
for _, offset := range []uint64{0, 1, triesInMemory - 1} </span><span class="cov0" title="0">{
if number := bc.CurrentBlock().NumberU64(); number > offset </span><span class="cov0" title="0">{
recent := bc.GetHeaderByNumber(number - offset)
if recent != nil </span><span class="cov0" title="0">{
utils.Logger().Info().
Str("block", recent.Number().String()).
Str("hash", recent.Hash().Hex()).
Str("root", recent.Root().Hex()).
Msg("Writing cached state to disk")
if err := triedb.Commit(recent.Root(), true); err != nil </span><span class="cov0" title="0">{
utils.Logger().Error().Err(err).Msg("Failed to commit recent state trie")
}</span>
}
}
}
<span class="cov0" title="0">for !bc.triegc.Empty() </span><span class="cov0" title="0">{
triedb.Dereference(bc.triegc.PopItem().(common.Hash))
}</span>
<span class="cov0" title="0">if size, _ := triedb.Size(); size != 0 </span><span class="cov0" title="0">{
utils.Logger().Error().Msg("Dangling trie nodes after full cleanup")
}</span>
}
<span class="cov0" title="0">utils.Logger().Info().Msg("Blockchain manager stopped")</span>
}
func (bc *BlockChain) procFutureBlocks() <span class="cov8" title="1">{
blocks := make([]*types.Block, 0, bc.futureBlocks.Len())
for _, hash := range bc.futureBlocks.Keys() </span><span class="cov0" title="0">{
if block, exist := bc.futureBlocks.Peek(hash); exist </span><span class="cov0" title="0">{
blocks = append(blocks, block.(*types.Block))
}</span>
}
<span class="cov8" title="1">if len(blocks) > 0 </span><span class="cov0" title="0">{
types.BlockBy(types.Number).Sort(blocks)