-
Notifications
You must be signed in to change notification settings - Fork 175
/
scaffold.go
2180 lines (1867 loc) · 77.5 KB
/
scaffold.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 cmd
import (
"context"
"crypto/tls"
"crypto/x509"
"errors"
"fmt"
"os"
"runtime"
"strings"
"time"
gcemd "cloud.google.com/go/compute/metadata"
"github.com/dgraph-io/badger/v2"
"github.com/hashicorp/go-multierror"
dht "github.com/libp2p/go-libp2p-kad-dht"
"github.com/libp2p/go-libp2p/core/host"
"github.com/libp2p/go-libp2p/core/peer"
"github.com/libp2p/go-libp2p/core/routing"
"github.com/prometheus/client_golang/prometheus"
"github.com/rs/zerolog"
"github.com/spf13/pflag"
"golang.org/x/time/rate"
"google.golang.org/api/option"
"github.com/onflow/flow-go/crypto"
"github.com/onflow/flow-go/admin"
"github.com/onflow/flow-go/admin/commands"
"github.com/onflow/flow-go/admin/commands/common"
storageCommands "github.com/onflow/flow-go/admin/commands/storage"
"github.com/onflow/flow-go/cmd/build"
"github.com/onflow/flow-go/config"
"github.com/onflow/flow-go/consensus/hotstuff/persister"
"github.com/onflow/flow-go/fvm"
"github.com/onflow/flow-go/fvm/environment"
"github.com/onflow/flow-go/model/flow"
"github.com/onflow/flow-go/model/flow/filter"
"github.com/onflow/flow-go/module"
"github.com/onflow/flow-go/module/chainsync"
"github.com/onflow/flow-go/module/compliance"
"github.com/onflow/flow-go/module/component"
"github.com/onflow/flow-go/module/id"
"github.com/onflow/flow-go/module/irrecoverable"
"github.com/onflow/flow-go/module/local"
"github.com/onflow/flow-go/module/mempool/herocache"
"github.com/onflow/flow-go/module/metrics"
"github.com/onflow/flow-go/module/profiler"
"github.com/onflow/flow-go/module/trace"
"github.com/onflow/flow-go/module/updatable_configs"
"github.com/onflow/flow-go/module/util"
"github.com/onflow/flow-go/network"
alspmgr "github.com/onflow/flow-go/network/alsp/manager"
netcache "github.com/onflow/flow-go/network/cache"
"github.com/onflow/flow-go/network/channels"
"github.com/onflow/flow-go/network/converter"
"github.com/onflow/flow-go/network/p2p"
p2pbuilder "github.com/onflow/flow-go/network/p2p/builder"
p2pbuilderconfig "github.com/onflow/flow-go/network/p2p/builder/config"
"github.com/onflow/flow-go/network/p2p/cache"
"github.com/onflow/flow-go/network/p2p/conduit"
"github.com/onflow/flow-go/network/p2p/connection"
p2pdht "github.com/onflow/flow-go/network/p2p/dht"
"github.com/onflow/flow-go/network/p2p/dns"
"github.com/onflow/flow-go/network/p2p/keyutils"
"github.com/onflow/flow-go/network/p2p/ping"
"github.com/onflow/flow-go/network/p2p/subscription"
"github.com/onflow/flow-go/network/p2p/translator"
"github.com/onflow/flow-go/network/p2p/unicast/protocols"
"github.com/onflow/flow-go/network/p2p/unicast/ratelimit"
"github.com/onflow/flow-go/network/p2p/utils"
"github.com/onflow/flow-go/network/p2p/utils/ratelimiter"
"github.com/onflow/flow-go/network/slashing"
"github.com/onflow/flow-go/network/topology"
"github.com/onflow/flow-go/network/underlay"
"github.com/onflow/flow-go/state/protocol"
badgerState "github.com/onflow/flow-go/state/protocol/badger"
"github.com/onflow/flow-go/state/protocol/events"
"github.com/onflow/flow-go/state/protocol/events/gadgets"
"github.com/onflow/flow-go/storage"
bstorage "github.com/onflow/flow-go/storage/badger"
"github.com/onflow/flow-go/storage/badger/operation"
sutil "github.com/onflow/flow-go/storage/util"
"github.com/onflow/flow-go/utils/logging"
)
const (
NetworkComponent = "network"
ConduitFactoryComponent = "conduit-factory"
LibP2PNodeComponent = "libp2p-node"
)
type Metrics struct {
Network module.NetworkMetrics
Engine module.EngineMetrics
Compliance module.ComplianceMetrics
Cache module.CacheMetrics
Mempool module.MempoolMetrics
CleanCollector module.CleanerMetrics
Bitswap module.BitswapMetrics
}
type Storage = storage.All
type namedModuleFunc struct {
fn BuilderFunc
name string
}
type namedComponentFunc struct {
fn ReadyDoneFactory
name string
errorHandler component.OnError
dependencies *DependencyList
}
// FlowNodeBuilder is the default builder struct used for all flow nodes
// It runs a node process with following structure, in sequential order
// Base inits (network, storage, state, logger)
// PostInit handlers, if any
// Components handlers, if any, wait sequentially
// Run() <- main loop
// Components destructors, if any
// The initialization can be proceeded and succeeded with PreInit and PostInit functions that allow customization
// of the process in case of nodes such as the unstaked access node where the NodeInfo is not part of the genesis data
type FlowNodeBuilder struct {
*NodeConfig
flags *pflag.FlagSet
modules []namedModuleFunc
components []namedComponentFunc
postShutdownFns []func() error
preInitFns []BuilderFunc
postInitFns []BuilderFunc
extraRootSnapshotCheck func(protocol.Snapshot) error
extraFlagCheck func() error
adminCommandBootstrapper *admin.CommandRunnerBootstrapper
adminCommands map[string]func(config *NodeConfig) commands.AdminCommand
componentBuilder component.ComponentManagerBuilder
bootstrapNodeAddresses []string
bootstrapNodePublicKeys []string
}
var _ NodeBuilder = (*FlowNodeBuilder)(nil)
func (fnb *FlowNodeBuilder) BaseFlags() {
defaultFlowConfig, err := config.DefaultConfig()
if err != nil {
fnb.Logger.Fatal().Err(err).Msg("failed to initialize flow config")
}
// initialize pflag set for Flow node
config.InitializePFlagSet(fnb.flags, defaultFlowConfig)
defaultConfig := DefaultBaseConfig()
// bind configuration parameters
fnb.flags.StringVar(&fnb.BaseConfig.nodeIDHex, "nodeid", defaultConfig.nodeIDHex, "identity of our node")
fnb.flags.StringVar(&fnb.BaseConfig.BindAddr, "bind", defaultConfig.BindAddr, "address to bind on")
fnb.flags.StringVarP(&fnb.BaseConfig.BootstrapDir, "bootstrapdir", "b", defaultConfig.BootstrapDir, "path to the bootstrap directory")
fnb.flags.StringVarP(&fnb.BaseConfig.datadir, "datadir", "d", defaultConfig.datadir, "directory to store the public database (protocol state)")
fnb.flags.StringVar(&fnb.BaseConfig.secretsdir, "secretsdir", defaultConfig.secretsdir, "directory to store private database (secrets)")
fnb.flags.StringVarP(&fnb.BaseConfig.level, "loglevel", "l", defaultConfig.level, "level for logging output")
fnb.flags.Uint32Var(&fnb.BaseConfig.debugLogLimit, "debug-log-limit", defaultConfig.debugLogLimit, "max number of debug/trace log events per second")
fnb.flags.UintVarP(&fnb.BaseConfig.metricsPort, "metricport", "m", defaultConfig.metricsPort, "port for /metrics endpoint")
fnb.flags.BoolVar(&fnb.BaseConfig.profilerConfig.Enabled, "profiler-enabled", defaultConfig.profilerConfig.Enabled, "whether to enable the auto-profiler")
fnb.flags.BoolVar(&fnb.BaseConfig.profilerConfig.UploaderEnabled, "profile-uploader-enabled", defaultConfig.profilerConfig.UploaderEnabled,
"whether to enable automatic profile upload to Google Cloud Profiler. "+
"For autoupload to work forllowing should be true: "+
"1) both -profiler-enabled=true and -profile-uploader-enabled=true need to be set. "+
"2) node is running in GCE. "+
"3) server or user has https://www.googleapis.com/auth/monitoring.write scope. ")
fnb.flags.StringVar(&fnb.BaseConfig.profilerConfig.Dir, "profiler-dir", defaultConfig.profilerConfig.Dir, "directory to create auto-profiler profiles")
fnb.flags.DurationVar(&fnb.BaseConfig.profilerConfig.Interval, "profiler-interval", defaultConfig.profilerConfig.Interval,
"the interval between auto-profiler runs")
fnb.flags.DurationVar(&fnb.BaseConfig.profilerConfig.Duration, "profiler-duration", defaultConfig.profilerConfig.Duration,
"the duration to run the auto-profile for")
fnb.flags.BoolVar(&fnb.BaseConfig.tracerEnabled, "tracer-enabled", defaultConfig.tracerEnabled,
"whether to enable tracer")
fnb.flags.UintVar(&fnb.BaseConfig.tracerSensitivity, "tracer-sensitivity", defaultConfig.tracerSensitivity,
"adjusts the level of sampling when tracing is enabled. 0 means capture everything, higher value results in less samples")
fnb.flags.StringVar(&fnb.BaseConfig.AdminAddr, "admin-addr", defaultConfig.AdminAddr, "address to bind on for admin HTTP server")
fnb.flags.StringVar(&fnb.BaseConfig.AdminCert, "admin-cert", defaultConfig.AdminCert, "admin cert file (for TLS)")
fnb.flags.StringVar(&fnb.BaseConfig.AdminKey, "admin-key", defaultConfig.AdminKey, "admin key file (for TLS)")
fnb.flags.StringVar(&fnb.BaseConfig.AdminClientCAs, "admin-client-certs", defaultConfig.AdminClientCAs, "admin client certs (for mutual TLS)")
fnb.flags.UintVar(&fnb.BaseConfig.AdminMaxMsgSize, "admin-max-response-size", defaultConfig.AdminMaxMsgSize, "admin server max response size in bytes")
fnb.flags.UintVar(&fnb.BaseConfig.guaranteesCacheSize, "guarantees-cache-size", bstorage.DefaultCacheSize, "collection guarantees cache size")
fnb.flags.UintVar(&fnb.BaseConfig.receiptsCacheSize, "receipts-cache-size", bstorage.DefaultCacheSize, "receipts cache size")
fnb.flags.BoolVar(&fnb.BaseConfig.DhtSystemEnabled,
"dht-enabled",
defaultConfig.DhtSystemEnabled,
"[experimental] whether to enable dht system. This is an experimental feature. Use with caution.")
fnb.flags.BoolVar(&fnb.BaseConfig.BitswapReprovideEnabled,
"bitswap-reprovide-enabled",
defaultConfig.BitswapReprovideEnabled,
"[experimental] whether to enable bitswap reproviding. This is an experimental feature. Use with caution.")
// dynamic node startup flags
fnb.flags.StringVar(&fnb.BaseConfig.DynamicStartupANPubkey,
"dynamic-startup-access-publickey",
"",
"the public key of the trusted secure access node to connect to when using dynamic-startup, this access node must be staked")
fnb.flags.StringVar(&fnb.BaseConfig.DynamicStartupANAddress,
"dynamic-startup-access-address",
"",
"the access address of the trusted secure access node to connect to when using dynamic-startup, this access node must be staked")
fnb.flags.StringVar(&fnb.BaseConfig.DynamicStartupEpochPhase,
"dynamic-startup-epoch-phase",
"EpochPhaseSetup",
"the target epoch phase for dynamic startup <EpochPhaseStaking|EpochPhaseSetup|EpochPhaseCommitted")
fnb.flags.StringVar(&fnb.BaseConfig.DynamicStartupEpoch,
"dynamic-startup-epoch",
"current",
"the target epoch for dynamic-startup, use \"current\" to start node in the current epoch")
fnb.flags.DurationVar(&fnb.BaseConfig.DynamicStartupSleepInterval,
"dynamic-startup-sleep-interval",
time.Minute,
"the interval in which the node will check if it can start")
fnb.flags.BoolVar(&fnb.BaseConfig.InsecureSecretsDB, "insecure-secrets-db", false, "allow the node to start up without an secrets DB encryption key")
fnb.flags.BoolVar(&fnb.BaseConfig.HeroCacheMetricsEnable, "herocache-metrics-collector", false, "enables herocache metrics collection")
// sync core flags
fnb.flags.DurationVar(&fnb.BaseConfig.SyncCoreConfig.RetryInterval,
"sync-retry-interval",
defaultConfig.SyncCoreConfig.RetryInterval,
"the initial interval before we retry a sync request, uses exponential backoff")
fnb.flags.UintVar(&fnb.BaseConfig.SyncCoreConfig.Tolerance,
"sync-tolerance",
defaultConfig.SyncCoreConfig.Tolerance,
"determines how big of a difference in block heights we tolerate before actively syncing with range requests")
fnb.flags.UintVar(&fnb.BaseConfig.SyncCoreConfig.MaxAttempts,
"sync-max-attempts",
defaultConfig.SyncCoreConfig.MaxAttempts,
"the maximum number of attempts we make for each requested block/height before discarding")
fnb.flags.UintVar(&fnb.BaseConfig.SyncCoreConfig.MaxSize,
"sync-max-size",
defaultConfig.SyncCoreConfig.MaxSize,
"the maximum number of blocks we request in the same block request message")
fnb.flags.UintVar(&fnb.BaseConfig.SyncCoreConfig.MaxRequests,
"sync-max-requests",
defaultConfig.SyncCoreConfig.MaxRequests,
"the maximum number of requests we send during each scanning period")
fnb.flags.Uint64Var(&fnb.BaseConfig.ComplianceConfig.SkipNewProposalsThreshold,
"compliance-skip-proposals-threshold",
defaultConfig.ComplianceConfig.SkipNewProposalsThreshold,
"threshold at which new proposals are discarded rather than cached, if their height is this much above local finalized height")
// observer mode allows a unstaked execution node to fetch blocks from a public staked access node, and being able to execute blocks
fnb.flags.BoolVar(&fnb.BaseConfig.ObserverMode, "observer-mode", defaultConfig.ObserverMode, "whether the node is running in observer mode")
fnb.flags.StringSliceVar(&fnb.bootstrapNodePublicKeys,
"observer-mode-bootstrap-node-public-keys",
nil,
"the networking public key of the bootstrap access node if this is an observer (in the same order as the bootstrap node addresses) e.g. \"d57a5e9c5.....\",\"44ded42d....\"")
fnb.flags.StringSliceVar(&fnb.bootstrapNodeAddresses,
"observer-mode-bootstrap-node-addresses",
nil,
"the network addresses of the bootstrap access node if this is an observer e.g. access-001.mainnet.flow.org:9653,access-002.mainnet.flow.org:9653")
}
func (fnb *FlowNodeBuilder) EnqueuePingService() {
fnb.Component("ping service", func(node *NodeConfig) (module.ReadyDoneAware, error) {
pingLibP2PProtocolID := protocols.PingProtocolId(node.SporkID)
// setup the Ping provider to return the software version and the sealed block height
pingInfoProvider := &ping.InfoProvider{
SoftwareVersionFun: func() string {
return build.Version()
},
SealedBlockHeightFun: func() (uint64, error) {
head, err := node.State.Sealed().Head()
if err != nil {
return 0, err
}
return head.Height, nil
},
HotstuffViewFun: func() (uint64, error) {
return 0, fmt.Errorf("hotstuff view reporting disabled")
},
}
// only consensus roles will need to report hotstuff view
if fnb.BaseConfig.NodeRole == flow.RoleConsensus.String() {
// initialize the persister
persist := persister.New(node.DB, node.RootChainID)
pingInfoProvider.HotstuffViewFun = func() (uint64, error) {
livenessData, err := persist.GetLivenessData()
if err != nil {
return 0, err
}
return livenessData.CurrentView, nil
}
}
pingService, err := node.EngineRegistry.RegisterPingService(pingLibP2PProtocolID, pingInfoProvider)
node.PingService = pingService
return &module.NoopReadyDoneAware{}, err
})
}
func (fnb *FlowNodeBuilder) EnqueueResolver() {
fnb.Component("resolver", func(node *NodeConfig) (module.ReadyDoneAware, error) {
var dnsIpCacheMetricsCollector module.HeroCacheMetrics = metrics.NewNoopCollector()
var dnsTxtCacheMetricsCollector module.HeroCacheMetrics = metrics.NewNoopCollector()
if fnb.HeroCacheMetricsEnable {
dnsIpCacheMetricsCollector = metrics.NetworkDnsIpCacheMetricsFactory(fnb.MetricsRegisterer)
dnsTxtCacheMetricsCollector = metrics.NetworkDnsTxtCacheMetricsFactory(fnb.MetricsRegisterer)
}
cache := herocache.NewDNSCache(
dns.DefaultCacheSize,
node.Logger,
dnsIpCacheMetricsCollector,
dnsTxtCacheMetricsCollector,
)
resolver := dns.NewResolver(
node.Logger,
fnb.Metrics.Network,
cache,
dns.WithTTL(fnb.BaseConfig.FlowConfig.NetworkConfig.DNSCacheTTL))
fnb.Resolver = resolver
return resolver, nil
})
}
func (fnb *FlowNodeBuilder) EnqueueNetworkInit() {
connGaterPeerDialFilters := make([]p2p.PeerFilter, 0)
connGaterInterceptSecureFilters := make([]p2p.PeerFilter, 0)
peerManagerFilters := make([]p2p.PeerFilter, 0)
fnb.UnicastRateLimiterDistributor = ratelimit.NewUnicastRateLimiterDistributor()
fnb.UnicastRateLimiterDistributor.AddConsumer(fnb.Metrics.Network)
// setup default rate limiter options
unicastRateLimiterOpts := []ratelimit.RateLimitersOption{
ratelimit.WithDisabledRateLimiting(fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.DryRun),
ratelimit.WithNotifier(fnb.UnicastRateLimiterDistributor),
}
// override noop unicast message rate limiter
if fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.MessageRateLimit > 0 {
unicastMessageRateLimiter := ratelimiter.NewRateLimiter(
rate.Limit(fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.MessageRateLimit),
fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.MessageRateLimit,
fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.LockoutDuration,
)
unicastRateLimiterOpts = append(unicastRateLimiterOpts, ratelimit.WithMessageRateLimiter(unicastMessageRateLimiter))
// avoid connection gating and pruning during dry run
if !fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.DryRun {
f := rateLimiterPeerFilter(unicastMessageRateLimiter)
// add IsRateLimited peerFilters to conn gater intercept secure peer and peer manager filters list
// don't allow rate limited peers to establishing incoming connections
connGaterInterceptSecureFilters = append(connGaterInterceptSecureFilters, f)
// don't create outbound connections to rate limited peers
peerManagerFilters = append(peerManagerFilters, f)
}
}
// override noop unicast bandwidth rate limiter
if fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.BandwidthRateLimit > 0 && fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.BandwidthBurstLimit > 0 {
unicastBandwidthRateLimiter := ratelimit.NewBandWidthRateLimiter(
rate.Limit(fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.BandwidthRateLimit),
fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.BandwidthBurstLimit,
fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.LockoutDuration,
)
unicastRateLimiterOpts = append(unicastRateLimiterOpts, ratelimit.WithBandwidthRateLimiter(unicastBandwidthRateLimiter))
// avoid connection gating and pruning during dry run
if !fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast.RateLimiter.DryRun {
f := rateLimiterPeerFilter(unicastBandwidthRateLimiter)
// add IsRateLimited peerFilters to conn gater intercept secure peer and peer manager filters list
connGaterInterceptSecureFilters = append(connGaterInterceptSecureFilters, f)
peerManagerFilters = append(peerManagerFilters, f)
}
}
// setup unicast rate limiters
unicastRateLimiters := ratelimit.NewRateLimiters(unicastRateLimiterOpts...)
uniCfg := &p2pbuilderconfig.UnicastConfig{
Unicast: fnb.BaseConfig.FlowConfig.NetworkConfig.Unicast,
RateLimiterDistributor: fnb.UnicastRateLimiterDistributor,
}
connGaterCfg := &p2pbuilderconfig.ConnectionGaterConfig{
InterceptPeerDialFilters: connGaterPeerDialFilters,
InterceptSecuredFilters: connGaterInterceptSecureFilters,
}
peerManagerCfg := &p2pbuilderconfig.PeerManagerConfig{
ConnectionPruning: fnb.FlowConfig.NetworkConfig.NetworkConnectionPruning,
UpdateInterval: fnb.FlowConfig.NetworkConfig.PeerUpdateInterval,
ConnectorFactory: connection.DefaultLibp2pBackoffConnectorFactory(),
}
fnb.Component(LibP2PNodeComponent, func(node *NodeConfig) (module.ReadyDoneAware, error) {
myAddr := fnb.NodeConfig.Me.Address()
if fnb.BaseConfig.BindAddr != NotSet {
myAddr = fnb.BaseConfig.BindAddr
}
if fnb.ObserverMode {
// observer mode only init pulbic libp2p node
publicLibp2pNode, err := fnb.BuildPublicLibp2pNode(myAddr)
if err != nil {
return nil, fmt.Errorf("could not build public libp2p node: %w", err)
}
fnb.LibP2PNode = publicLibp2pNode
return publicLibp2pNode, nil
}
dhtActivationStatus, err := DhtSystemActivationStatus(fnb.NodeRole, fnb.DhtSystemEnabled)
if err != nil {
return nil, fmt.Errorf("could not determine dht activation status: %w", err)
}
builder, err := p2pbuilder.DefaultNodeBuilder(fnb.Logger,
myAddr,
network.PrivateNetwork,
fnb.NetworkKey,
fnb.SporkID,
fnb.IdentityProvider,
&p2pbuilderconfig.MetricsConfig{
Metrics: fnb.Metrics.Network,
HeroCacheFactory: fnb.HeroCacheMetricsFactory(),
},
fnb.Resolver,
fnb.BaseConfig.NodeRole,
connGaterCfg,
peerManagerCfg,
&fnb.FlowConfig.NetworkConfig.GossipSub,
&fnb.FlowConfig.NetworkConfig.ResourceManager,
uniCfg,
&fnb.FlowConfig.NetworkConfig.ConnectionManager,
&p2p.DisallowListCacheConfig{
MaxSize: fnb.FlowConfig.NetworkConfig.DisallowListNotificationCacheSize,
Metrics: metrics.DisallowListCacheMetricsFactory(fnb.HeroCacheMetricsFactory(), network.PrivateNetwork),
},
dhtActivationStatus)
if err != nil {
return nil, fmt.Errorf("could not create libp2p node builder: %w", err)
}
libp2pNode, err := builder.Build()
if err != nil {
return nil, fmt.Errorf("could not build libp2p node: %w", err)
}
fnb.LibP2PNode = libp2pNode
return libp2pNode, nil
})
fnb.Component(NetworkComponent, func(node *NodeConfig) (module.ReadyDoneAware, error) {
fnb.Logger.Info().Hex("node_id", logging.ID(fnb.NodeID)).Msg("default conduit factory initiated")
return fnb.InitFlowNetworkWithConduitFactory(
node,
conduit.NewDefaultConduitFactory(),
unicastRateLimiters,
peerManagerFilters)
})
fnb.Module("network underlay dependency", func(node *NodeConfig) error {
fnb.networkUnderlayDependable = module.NewProxiedReadyDoneAware()
fnb.PeerManagerDependencies.Add(fnb.networkUnderlayDependable)
return nil
})
// peer manager won't be created until all PeerManagerDependencies are ready.
if !fnb.ObserverMode {
fnb.DependableComponent("peer manager", func(node *NodeConfig) (module.ReadyDoneAware, error) {
return fnb.LibP2PNode.PeerManagerComponent(), nil
}, fnb.PeerManagerDependencies)
}
}
// HeroCacheMetricsFactory returns a HeroCacheMetricsFactory based on the MetricsEnabled flag.
// If MetricsEnabled is true, it returns a HeroCacheMetricsFactory that will register metrics with the provided MetricsRegisterer.
// If MetricsEnabled is false, it returns a no-op HeroCacheMetricsFactory that will not register any metrics.
func (fnb *FlowNodeBuilder) HeroCacheMetricsFactory() metrics.HeroCacheMetricsFactory {
if fnb.MetricsEnabled {
return metrics.NewHeroCacheMetricsFactory(fnb.MetricsRegisterer)
}
return metrics.NewNoopHeroCacheMetricsFactory()
}
// initPublicLibp2pNode creates a libp2p node for the observer service in the public (unstaked) network.
// The factory function is later passed into the initMiddleware function to eventually instantiate the p2p.LibP2PNode instance
// The LibP2P host is created with the following options:
// * DHT as client and seeded with the given bootstrap peers
// * The specified bind address as the listen address
// * The passed in private key as the libp2p key
// * No connection gater
// * No connection manager
// * No peer manager
// * Default libp2p pubsub options.
// Args:
// - networkKey: the private key to use for the libp2p node
// Returns:
// - p2p.LibP2PNode: the libp2p node
// - error: if any error occurs. Any error returned is considered irrecoverable.
func (fnb *FlowNodeBuilder) BuildPublicLibp2pNode(address string) (p2p.LibP2PNode, error) {
var pis []peer.AddrInfo
ids, err := BootstrapIdentities(fnb.bootstrapNodeAddresses, fnb.bootstrapNodePublicKeys)
if err != nil {
return nil, fmt.Errorf("could not create bootstrap identities: %w", err)
}
for _, b := range ids {
pi, err := utils.PeerAddressInfo(*b)
if err != nil {
return nil, fmt.Errorf("could not extract peer address info from bootstrap identity %v: %w", b, err)
}
pis = append(pis, pi)
fnb.Logger.Info().Msgf("bootstrap peer address info %v: %v", b, pi)
}
for _, b := range ids {
pi, err := utils.PeerAddressInfo(*b)
if err != nil {
return nil, fmt.Errorf("could not extract peer address info from bootstrap identity %v: %w", b, err)
}
pis = append(pis, pi)
}
if len(pis) == 0 {
return nil, errors.New("no bootstrap peers provided")
}
node, err := p2pbuilder.NewNodeBuilder(
fnb.Logger,
&fnb.FlowConfig.NetworkConfig.GossipSub,
&p2pbuilderconfig.MetricsConfig{
HeroCacheFactory: fnb.HeroCacheMetricsFactory(),
Metrics: fnb.Metrics.Network,
},
network.PublicNetwork,
address,
fnb.NetworkKey,
fnb.SporkID,
fnb.IdentityProvider,
&fnb.FlowConfig.NetworkConfig.ResourceManager,
p2pbuilderconfig.PeerManagerDisableConfig(), // disable peer manager for observer node.
&p2p.DisallowListCacheConfig{
MaxSize: fnb.FlowConfig.NetworkConfig.DisallowListNotificationCacheSize,
Metrics: metrics.DisallowListCacheMetricsFactory(fnb.HeroCacheMetricsFactory(), network.PublicNetwork),
},
&p2pbuilderconfig.UnicastConfig{
Unicast: fnb.FlowConfig.NetworkConfig.Unicast,
}).
SetSubscriptionFilter(
subscription.NewRoleBasedFilter(
subscription.UnstakedRole, fnb.IdentityProvider,
),
).
SetRoutingSystem(func(ctx context.Context, h host.Host) (routing.Routing, error) {
return p2pdht.NewDHT(ctx, h, protocols.FlowPublicDHTProtocolID(fnb.SporkID),
fnb.Logger,
fnb.Metrics.Network,
p2pdht.AsClient(),
dht.BootstrapPeers(pis...),
)
}).
Build()
if err != nil {
return nil, fmt.Errorf("could not initialize libp2p node for observer: %w", err)
}
return node, nil
}
func (fnb *FlowNodeBuilder) InitFlowNetworkWithConduitFactory(
node *NodeConfig,
cf network.ConduitFactory,
unicastRateLimiters *ratelimit.RateLimiters,
peerManagerFilters []p2p.PeerFilter) (network.EngineRegistry, error) {
var networkOptions []underlay.NetworkOption
if len(fnb.MsgValidators) > 0 {
networkOptions = append(networkOptions, underlay.WithMessageValidators(fnb.MsgValidators...))
}
// by default if no rate limiter configuration was provided in the CLI args the default
// noop rate limiter will be used.
networkOptions = append(networkOptions, underlay.WithUnicastRateLimiters(unicastRateLimiters))
networkOptions = append(networkOptions,
underlay.WithPreferredUnicastProtocols(protocols.ToProtocolNames(fnb.FlowConfig.NetworkConfig.PreferredUnicastProtocols)...),
)
// peerManagerFilters are used by the peerManager via the network to filter peers from the topology.
if len(peerManagerFilters) > 0 {
networkOptions = append(networkOptions, underlay.WithPeerManagerFilters(peerManagerFilters...))
}
receiveCache := netcache.NewHeroReceiveCache(fnb.FlowConfig.NetworkConfig.NetworkReceivedMessageCacheSize,
fnb.Logger,
metrics.NetworkReceiveCacheMetricsFactory(fnb.HeroCacheMetricsFactory(), network.PrivateNetwork))
err := node.Metrics.Mempool.Register(metrics.ResourceNetworkingReceiveCache, receiveCache.Size)
if err != nil {
return nil, fmt.Errorf("could not register networking receive cache metric: %w", err)
}
networkType := network.PrivateNetwork
if fnb.ObserverMode {
// observer mode uses public network
networkType = network.PublicNetwork
}
// creates network instance
net, err := underlay.NewNetwork(&underlay.NetworkConfig{
Logger: fnb.Logger,
Libp2pNode: fnb.LibP2PNode,
Codec: fnb.CodecFactory(),
Me: fnb.Me,
SporkId: fnb.SporkID,
Topology: topology.NewFullyConnectedTopology(),
Metrics: fnb.Metrics.Network,
BitSwapMetrics: fnb.Metrics.Bitswap,
IdentityProvider: fnb.IdentityProvider,
ReceiveCache: receiveCache,
ConduitFactory: cf,
UnicastMessageTimeout: fnb.FlowConfig.NetworkConfig.Unicast.MessageTimeout,
IdentityTranslator: fnb.IDTranslator,
AlspCfg: &alspmgr.MisbehaviorReportManagerConfig{
Logger: fnb.Logger,
SpamRecordCacheSize: fnb.FlowConfig.NetworkConfig.AlspConfig.SpamRecordCacheSize,
SpamReportQueueSize: fnb.FlowConfig.NetworkConfig.AlspConfig.SpamReportQueueSize,
DisablePenalty: fnb.FlowConfig.NetworkConfig.AlspConfig.DisablePenalty,
HeartBeatInterval: fnb.FlowConfig.NetworkConfig.AlspConfig.HearBeatInterval,
AlspMetrics: fnb.Metrics.Network,
HeroCacheMetricsFactory: fnb.HeroCacheMetricsFactory(),
NetworkType: networkType,
},
SlashingViolationConsumerFactory: func(adapter network.ConduitAdapter) network.ViolationsConsumer {
return slashing.NewSlashingViolationsConsumer(fnb.Logger, fnb.Metrics.Network, adapter)
},
}, networkOptions...)
if err != nil {
return nil, fmt.Errorf("could not initialize network: %w", err)
}
if node.ObserverMode {
fnb.EngineRegistry = converter.NewNetwork(net, channels.SyncCommittee, channels.PublicSyncCommittee)
} else {
fnb.EngineRegistry = net // setting network as the fnb.Network for the engine-level components
}
fnb.NetworkUnderlay = net // setting network as the fnb.Underlay for the lower-level components
// register network ReadyDoneAware interface so other components can depend on it for startup
if fnb.networkUnderlayDependable != nil {
fnb.networkUnderlayDependable.Init(fnb.NetworkUnderlay)
}
idEvents := gadgets.NewIdentityDeltas(net.UpdateNodeAddresses)
fnb.ProtocolEvents.AddConsumer(idEvents)
return net, nil
}
func (fnb *FlowNodeBuilder) EnqueueMetricsServerInit() {
fnb.Component("metrics server", func(node *NodeConfig) (module.ReadyDoneAware, error) {
server := metrics.NewServer(fnb.Logger, fnb.BaseConfig.metricsPort)
return server, nil
})
}
func (fnb *FlowNodeBuilder) EnqueueAdminServerInit() error {
if fnb.AdminAddr == NotSet {
return nil
}
if (fnb.AdminCert != NotSet || fnb.AdminKey != NotSet || fnb.AdminClientCAs != NotSet) &&
!(fnb.AdminCert != NotSet && fnb.AdminKey != NotSet && fnb.AdminClientCAs != NotSet) {
return fmt.Errorf("admin cert / key and client certs must all be provided to enable mutual TLS")
}
// create the updatable config manager
fnb.RegisterDefaultAdminCommands()
fnb.Component("admin server", func(node *NodeConfig) (module.ReadyDoneAware, error) {
// set up all admin commands
for commandName, commandFunc := range fnb.adminCommands {
command := commandFunc(fnb.NodeConfig)
fnb.adminCommandBootstrapper.RegisterHandler(commandName, command.Handler)
fnb.adminCommandBootstrapper.RegisterValidator(commandName, command.Validator)
}
opts := []admin.CommandRunnerOption{
admin.WithMaxMsgSize(int(fnb.AdminMaxMsgSize)),
}
if node.AdminCert != NotSet {
serverCert, err := tls.LoadX509KeyPair(node.AdminCert, node.AdminKey)
if err != nil {
return nil, err
}
clientCAs, err := os.ReadFile(node.AdminClientCAs)
if err != nil {
return nil, err
}
certPool := x509.NewCertPool()
certPool.AppendCertsFromPEM(clientCAs)
config := &tls.Config{
MinVersion: tls.VersionTLS13,
Certificates: []tls.Certificate{serverCert},
ClientAuth: tls.RequireAndVerifyClientCert,
ClientCAs: certPool,
}
opts = append(opts, admin.WithTLS(config))
}
runner := fnb.adminCommandBootstrapper.Bootstrap(fnb.Logger, fnb.AdminAddr, opts...)
return runner, nil
})
return nil
}
func (fnb *FlowNodeBuilder) RegisterBadgerMetrics() error {
return metrics.RegisterBadgerMetrics()
}
func (fnb *FlowNodeBuilder) EnqueueTracer() {
fnb.Component("tracer", func(node *NodeConfig) (module.ReadyDoneAware, error) {
return fnb.Tracer, nil
})
}
func (fnb *FlowNodeBuilder) ParseAndPrintFlags() error {
// parse configuration parameters
pflag.Parse()
configOverride, err := config.BindPFlags(&fnb.BaseConfig.FlowConfig, fnb.flags)
if err != nil {
return err
}
if configOverride {
fnb.Logger.Info().Str("config-file", fnb.FlowConfig.ConfigFile).Msg("configuration file updated")
}
if err = fnb.BaseConfig.FlowConfig.Validate(); err != nil {
fnb.Logger.Fatal().Err(err).Msg("flow configuration validation failed")
}
info := fnb.Logger.Error()
noPrint := config.LogConfig(info, fnb.flags)
fnb.flags.VisitAll(func(flag *pflag.Flag) {
if _, ok := noPrint[flag.Name]; !ok {
info.Str(flag.Name, fmt.Sprintf("%v", flag.Value))
}
})
info.Msg("configuration loaded (logged as error for visibility)")
return fnb.extraFlagsValidation()
}
func (fnb *FlowNodeBuilder) ValidateRootSnapshot(f func(protocol.Snapshot) error) NodeBuilder {
fnb.extraRootSnapshotCheck = f
return fnb
}
func (fnb *FlowNodeBuilder) ValidateFlags(f func() error) NodeBuilder {
fnb.extraFlagCheck = f
return fnb
}
func (fnb *FlowNodeBuilder) PrintBuildVersionDetails() {
fnb.Logger.Info().Str("version", build.Version()).Str("commit", build.Commit()).Msg("build details")
}
func (fnb *FlowNodeBuilder) initNodeInfo() error {
if fnb.BaseConfig.nodeIDHex == NotSet {
return fmt.Errorf("cannot start without node ID")
}
nodeID, err := flow.HexStringToIdentifier(fnb.BaseConfig.nodeIDHex)
if err != nil {
return fmt.Errorf("could not parse node ID from string (id: %v): %w", fnb.BaseConfig.nodeIDHex, err)
}
info, err := LoadPrivateNodeInfo(fnb.BaseConfig.BootstrapDir, nodeID)
if err != nil {
return fmt.Errorf("failed to load private node info: %w", err)
}
fnb.StakingKey = info.StakingPrivKey.PrivateKey
if fnb.ObserverMode {
// observer mode uses a network private key with different format than the staked node,
// so it has to load the network private key from a separate file
networkingPrivateKey, err := LoadNetworkPrivateKey(fnb.BaseConfig.BootstrapDir, nodeID)
if err != nil {
return fmt.Errorf("failed to load networking private key: %w", err)
}
peerID, err := peerIDFromNetworkKey(networkingPrivateKey)
if err != nil {
return fmt.Errorf("could not get peer ID from network key: %w", err)
}
// public node ID for observer is derived from peer ID which is derived from network key
pubNodeID, err := translator.NewPublicNetworkIDTranslator().GetFlowID(peerID)
if err != nil {
return fmt.Errorf("could not get flow node ID: %w", err)
}
fnb.NodeID = pubNodeID
fnb.NetworkKey = networkingPrivateKey
return nil
}
fnb.NodeID = nodeID
fnb.NetworkKey = info.NetworkPrivKey.PrivateKey
return nil
}
func peerIDFromNetworkKey(privateKey crypto.PrivateKey) (peer.ID, error) {
pubKey, err := keyutils.LibP2PPublicKeyFromFlow(privateKey.PublicKey())
if err != nil {
return "", fmt.Errorf("could not load libp2p public key: %w", err)
}
return peer.IDFromPublicKey(pubKey)
}
func (fnb *FlowNodeBuilder) initLogger() error {
// configure logger with standard level, node ID and UTC timestamp
zerolog.TimeFieldFormat = time.RFC3339Nano
zerolog.TimestampFunc = func() time.Time { return time.Now().UTC() }
// Drop all log events that exceed this rate limit
throttledSampler := logging.BurstSampler(fnb.BaseConfig.debugLogLimit, time.Second)
log := fnb.Logger.With().
Timestamp().
Str("node_role", fnb.BaseConfig.NodeRole).
Str("node_id", fnb.NodeID.String()).
Logger().
Sample(zerolog.LevelSampler{
TraceSampler: throttledSampler,
DebugSampler: throttledSampler,
})
log.Info().Msgf("flow %s node starting up", fnb.BaseConfig.NodeRole)
// parse config log level and apply to logger
lvl, err := zerolog.ParseLevel(strings.ToLower(fnb.BaseConfig.level))
if err != nil {
return fmt.Errorf("invalid log level: %w", err)
}
// Minimum log level is set to trace, then overridden by SetGlobalLevel.
// this allows admin commands to modify the level to any value during runtime
log = log.Level(zerolog.TraceLevel)
zerolog.SetGlobalLevel(lvl)
fnb.Logger = log
return nil
}
func (fnb *FlowNodeBuilder) initMetrics() error {
fnb.Tracer = trace.NewNoopTracer()
if fnb.BaseConfig.tracerEnabled {
nodeIdHex := fnb.NodeID.String()
if len(nodeIdHex) > 8 {
nodeIdHex = nodeIdHex[:8]
}
serviceName := fnb.BaseConfig.NodeRole + "-" + nodeIdHex
tracer, err := trace.NewTracer(
fnb.Logger,
serviceName,
fnb.RootChainID.String(),
fnb.tracerSensitivity,
)
if err != nil {
return fmt.Errorf("could not initialize tracer: %w", err)
}
fnb.Logger.Info().Msg("Tracer Started")
fnb.Tracer = tracer
}
fnb.Metrics = Metrics{
Network: metrics.NewNoopCollector(),
Engine: metrics.NewNoopCollector(),
Compliance: metrics.NewNoopCollector(),
Cache: metrics.NewNoopCollector(),
Mempool: metrics.NewNoopCollector(),
CleanCollector: metrics.NewNoopCollector(),
Bitswap: metrics.NewNoopCollector(),
}
if fnb.BaseConfig.MetricsEnabled {
fnb.MetricsRegisterer = prometheus.DefaultRegisterer
mempools := metrics.NewMempoolCollector(5 * time.Second)
fnb.Metrics = Metrics{
Network: metrics.NewNetworkCollector(fnb.Logger),
Engine: metrics.NewEngineCollector(),
Compliance: metrics.NewComplianceCollector(),
// CacheControl metrics has been causing memory abuse, disable for now
// Cache: metrics.NewCacheCollector(fnb.RootChainID),
Cache: metrics.NewNoopCollector(),
CleanCollector: metrics.NewCleanerCollector(),
Mempool: mempools,
Bitswap: metrics.NewBitswapCollector(),
}
// registers mempools as a Component so that its Ready method is invoked upon startup
fnb.Component("mempools metrics", func(node *NodeConfig) (module.ReadyDoneAware, error) {
return mempools, nil
})
// metrics enabled, report node info metrics as post init event
fnb.PostInit(func(nodeConfig *NodeConfig) error {
nodeInfoMetrics := metrics.NewNodeInfoCollector()
protocolVersion, err := fnb.RootSnapshot.Params().ProtocolVersion()
if err != nil {
return fmt.Errorf("could not query root snapshoot protocol version: %w", err)
}
nodeInfoMetrics.NodeInfo(build.Version(), build.Commit(), nodeConfig.SporkID.String(), protocolVersion)
return nil
})
}
return nil
}
func (fnb *FlowNodeBuilder) createGCEProfileUploader(client *gcemd.Client, opts ...option.ClientOption) (profiler.Uploader, error) {
projectID, err := client.ProjectID()
if err != nil {
return &profiler.NoopUploader{}, fmt.Errorf("failed to get project ID: %w", err)
}
instance, err := client.InstanceID()
if err != nil {
return &profiler.NoopUploader{}, fmt.Errorf("failed to get instance ID: %w", err)
}
chainID := fnb.RootChainID.String()
if chainID == "" {
fnb.Logger.Warn().Msg("RootChainID is not set, using default value")
chainID = "unknown"
}
params := profiler.Params{
ProjectID: projectID,
ChainID: chainID,
Role: fnb.NodeConfig.NodeRole,
Version: build.Version(),
Commit: build.Commit(),
Instance: instance,
}
fnb.Logger.Info().Msgf("creating pprof profile uploader with params: %+v", params)
return profiler.NewUploader(fnb.Logger, params, opts...)
}
func (fnb *FlowNodeBuilder) createProfileUploader() (profiler.Uploader, error) {
switch {
case fnb.BaseConfig.profilerConfig.UploaderEnabled && gcemd.OnGCE():
return fnb.createGCEProfileUploader(gcemd.NewClient(nil))
default:
fnb.Logger.Info().Msg("not running on GCE, setting pprof uploader to noop")
return &profiler.NoopUploader{}, nil
}
}
func (fnb *FlowNodeBuilder) initProfiler() error {
uploader, err := fnb.createProfileUploader()
if err != nil {
fnb.Logger.Warn().Err(err).Msg("failed to create pprof uploader, falling back to noop")
uploader = &profiler.NoopUploader{}
}
profiler, err := profiler.New(fnb.Logger, uploader, fnb.BaseConfig.profilerConfig)