-
Notifications
You must be signed in to change notification settings - Fork 175
/
observer_builder.go
1060 lines (919 loc) · 41.2 KB
/
observer_builder.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 node_builder
import (
"context"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
"strings"
"time"
badger "github.com/ipfs/go-ds-badger2"
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/rs/zerolog"
"github.com/spf13/pflag"
"github.com/onflow/flow-go/cmd"
"github.com/onflow/flow-go/consensus"
"github.com/onflow/flow-go/consensus/hotstuff"
"github.com/onflow/flow-go/consensus/hotstuff/committees"
"github.com/onflow/flow-go/consensus/hotstuff/notifications/pubsub"
hotsignature "github.com/onflow/flow-go/consensus/hotstuff/signature"
"github.com/onflow/flow-go/consensus/hotstuff/verification"
recovery "github.com/onflow/flow-go/consensus/recovery/protocol"
"github.com/onflow/flow-go/crypto"
"github.com/onflow/flow-go/engine/access/apiproxy"
"github.com/onflow/flow-go/engine/access/rpc"
"github.com/onflow/flow-go/engine/access/rpc/backend"
"github.com/onflow/flow-go/engine/common/follower"
followereng "github.com/onflow/flow-go/engine/common/follower"
synceng "github.com/onflow/flow-go/engine/common/synchronization"
"github.com/onflow/flow-go/engine/protocol"
"github.com/onflow/flow-go/model/encodable"
"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/buffer"
"github.com/onflow/flow-go/module/chainsync"
"github.com/onflow/flow-go/module/compliance"
"github.com/onflow/flow-go/module/executiondatasync/execution_data"
finalizer "github.com/onflow/flow-go/module/finalizer/consensus"
"github.com/onflow/flow-go/module/id"
"github.com/onflow/flow-go/module/local"
"github.com/onflow/flow-go/module/metrics"
"github.com/onflow/flow-go/module/state_synchronization"
edrequester "github.com/onflow/flow-go/module/state_synchronization/requester"
consensus_follower "github.com/onflow/flow-go/module/upstream"
"github.com/onflow/flow-go/network"
netcache "github.com/onflow/flow-go/network/cache"
"github.com/onflow/flow-go/network/channels"
cborcodec "github.com/onflow/flow-go/network/codec/cbor"
"github.com/onflow/flow-go/network/converter"
"github.com/onflow/flow-go/network/p2p"
"github.com/onflow/flow-go/network/p2p/cache"
p2pdht "github.com/onflow/flow-go/network/p2p/dht"
"github.com/onflow/flow-go/network/p2p/keyutils"
"github.com/onflow/flow-go/network/p2p/middleware"
"github.com/onflow/flow-go/network/p2p/p2pbuilder"
"github.com/onflow/flow-go/network/p2p/p2pnode"
"github.com/onflow/flow-go/network/p2p/subscription"
"github.com/onflow/flow-go/network/p2p/translator"
"github.com/onflow/flow-go/network/p2p/unicast"
"github.com/onflow/flow-go/network/p2p/utils"
"github.com/onflow/flow-go/network/slashing"
"github.com/onflow/flow-go/network/validator"
stateprotocol "github.com/onflow/flow-go/state/protocol"
badgerState "github.com/onflow/flow-go/state/protocol/badger"
"github.com/onflow/flow-go/state/protocol/blocktimer"
"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/utils/io"
)
// ObserverBuilder extends cmd.NodeBuilder and declares additional functions needed to bootstrap an Access node
// These functions are shared by observer builders.
// The Staked network allows the access nodes to communicate among themselves, while the public network allows the
// observers and an Access node to communicate.
//
// public network private network
// +------------------------+
// | observer 1 |<--------------------------|
// +------------------------+ v
// +------------------------+ +----------------------+ +------------------------+
// | observer 2 |<----------------------->| Access Node (staked) |<------------>| All other staked Nodes |
// +------------------------+ +----------------------+ +------------------------+
// +------------------------+ ^
// | observer 3 |<--------------------------|
// +------------------------+
// ObserverServiceConfig defines all the user defined parameters required to bootstrap an access node
// For a node running as a standalone process, the config fields will be populated from the command line params,
// while for a node running as a library, the config fields are expected to be initialized by the caller.
type ObserverServiceConfig struct {
bootstrapNodeAddresses []string
bootstrapNodePublicKeys []string
observerNetworkingKeyPath string
bootstrapIdentities flow.IdentityList // the identity list of bootstrap peers the node uses to discover other nodes
apiRatelimits map[string]int
apiBurstlimits map[string]int
rpcConf rpc.Config
rpcMetricsEnabled bool
executionDataSyncEnabled bool
executionDataDir string
executionDataStartHeight uint64
executionDataConfig edrequester.ExecutionDataConfig
apiTimeout time.Duration
upstreamNodeAddresses []string
upstreamNodePublicKeys []string
upstreamIdentities flow.IdentityList // the identity list of upstream peers the node uses to forward API requests to
}
// DefaultObserverServiceConfig defines all the default values for the ObserverServiceConfig
func DefaultObserverServiceConfig() *ObserverServiceConfig {
homedir, _ := os.UserHomeDir()
return &ObserverServiceConfig{
rpcConf: rpc.Config{
UnsecureGRPCListenAddr: "0.0.0.0:9000",
SecureGRPCListenAddr: "0.0.0.0:9001",
HTTPListenAddr: "0.0.0.0:8000",
RESTListenAddr: "",
CollectionAddr: "",
HistoricalAccessAddrs: "",
CollectionClientTimeout: 3 * time.Second,
ExecutionClientTimeout: 3 * time.Second,
MaxHeightRange: backend.DefaultMaxHeightRange,
PreferredExecutionNodeIDs: nil,
FixedExecutionNodeIDs: nil,
},
rpcMetricsEnabled: false,
apiRatelimits: nil,
apiBurstlimits: nil,
bootstrapNodeAddresses: []string{},
bootstrapNodePublicKeys: []string{},
observerNetworkingKeyPath: cmd.NotSet,
executionDataSyncEnabled: false,
executionDataDir: filepath.Join(homedir, ".flow", "execution_data"),
executionDataStartHeight: 0,
executionDataConfig: edrequester.ExecutionDataConfig{
InitialBlockHeight: 0,
MaxSearchAhead: edrequester.DefaultMaxSearchAhead,
FetchTimeout: edrequester.DefaultFetchTimeout,
RetryDelay: edrequester.DefaultRetryDelay,
MaxRetryDelay: edrequester.DefaultMaxRetryDelay,
},
apiTimeout: 3 * time.Second,
upstreamNodeAddresses: []string{},
upstreamNodePublicKeys: []string{},
}
}
// ObserverServiceBuilder provides the common functionality needed to bootstrap a Flow observer service
// It is composed of the FlowNodeBuilder, the ObserverServiceConfig and contains all the components and modules needed for the observers
type ObserverServiceBuilder struct {
*cmd.FlowNodeBuilder
*ObserverServiceConfig
// components
LibP2PNode *p2pnode.Node
FollowerState stateprotocol.MutableState
SyncCore *chainsync.Core
RpcEng *rpc.Engine
FinalizationDistributor *pubsub.FinalizationDistributor
FinalizedHeader *synceng.FinalizedHeaderCache
Committee hotstuff.Committee
Finalized *flow.Header
Pending []*flow.Header
FollowerCore module.HotStuffFollower
ExecutionDataDownloader execution_data.Downloader
ExecutionDataRequester state_synchronization.ExecutionDataRequester // for the observer, the sync engine participants provider is the libp2p peer store which is not
// available until after the network has started. Hence, a factory function that needs to be called just before
// creating the sync engine
SyncEngineParticipantsProviderFactory func() module.IdentifierProvider
// engines
FollowerEng *followereng.Engine
SyncEng *synceng.Engine
// Public network
peerID peer.ID
}
// deriveBootstrapPeerIdentities derives the Flow Identity of the bootstrap peers from the parameters.
// These are the identities of the observers also acting as the DHT bootstrap server
func (builder *ObserverServiceBuilder) deriveBootstrapPeerIdentities() error {
// if bootstrap identities already provided (as part of alternate initialization as a library the skip reading command
// line params)
if builder.bootstrapIdentities != nil {
return nil
}
ids, err := BootstrapIdentities(builder.bootstrapNodeAddresses, builder.bootstrapNodePublicKeys)
if err != nil {
return fmt.Errorf("failed to derive bootstrap peer identities: %w", err)
}
builder.bootstrapIdentities = ids
return nil
}
// deriveBootstrapPeerIdentities derives the Flow Identity of the bootstrap peers from the parameters.
// These are the identities of the observers also acting as the DHT bootstrap server
func (builder *ObserverServiceBuilder) deriveUpstreamIdentities() error {
// if bootstrap identities already provided (as part of alternate initialization as a library the skip reading command
// line params)
if builder.upstreamIdentities != nil {
return nil
}
// BootstrapIdentities converts the bootstrap node addresses and keys to a Flow Identity list where
// each Flow Identity is initialized with the passed address, the networking key
// and the Node ID set to ZeroID, role set to Access, 0 stake and no staking key.
addresses := builder.upstreamNodeAddresses
keys := builder.upstreamNodePublicKeys
if len(addresses) != len(keys) {
return fmt.Errorf("number of addresses and keys provided for the boostrap nodes don't match")
}
ids := make([]*flow.Identity, len(addresses))
for i, address := range addresses {
key := keys[i]
// json unmarshaller needs a quotes before and after the string
// the pflags.StringSliceVar does not retain quotes for the command line arg even if escaped with \"
// hence this additional check to ensure the key is indeed quoted
if !strings.HasPrefix(key, "\"") {
key = fmt.Sprintf("\"%s\"", key)
}
// create the identity of the peer by setting only the relevant fields
ids[i] = &flow.Identity{
NodeID: flow.ZeroID, // the NodeID is the hash of the staking key and for the public network it does not apply
Address: address,
Role: flow.RoleAccess, // the upstream node has to be an access node
NetworkPubKey: nil,
}
// networking public key
var networkKey encodable.NetworkPubKey
err := json.Unmarshal([]byte(key), &networkKey)
if err == nil {
ids[i].NetworkPubKey = networkKey
}
}
builder.upstreamIdentities = ids
return nil
}
func (builder *ObserverServiceBuilder) buildFollowerState() *ObserverServiceBuilder {
builder.Module("mutable follower state", func(node *cmd.NodeConfig) error {
// For now, we only support state implementations from package badger.
// If we ever support different implementations, the following can be replaced by a type-aware factory
state, ok := node.State.(*badgerState.State)
if !ok {
return fmt.Errorf("only implementations of type badger.State are currently supported but read-only state has type %T", node.State)
}
followerState, err := badgerState.NewFollowerState(
state,
node.Storage.Index,
node.Storage.Payloads,
node.Tracer,
node.ProtocolEvents,
blocktimer.DefaultBlockTimer,
)
builder.FollowerState = followerState
return err
})
return builder
}
func (builder *ObserverServiceBuilder) buildSyncCore() *ObserverServiceBuilder {
builder.Module("sync core", func(node *cmd.NodeConfig) error {
syncCore, err := chainsync.New(node.Logger, node.SyncCoreConfig, metrics.NewChainSyncCollector())
builder.SyncCore = syncCore
return err
})
return builder
}
func (builder *ObserverServiceBuilder) buildCommittee() *ObserverServiceBuilder {
builder.Module("committee", func(node *cmd.NodeConfig) error {
// initialize consensus committee's membership state
// This committee state is for the HotStuff follower, which follows the MAIN CONSENSUS Committee
// Note: node.Me.NodeID() is not part of the consensus committee
committee, err := committees.NewConsensusCommittee(node.State, node.Me.NodeID())
builder.Committee = committee
return err
})
return builder
}
func (builder *ObserverServiceBuilder) buildLatestHeader() *ObserverServiceBuilder {
builder.Module("latest header", func(node *cmd.NodeConfig) error {
finalized, pending, err := recovery.FindLatest(node.State, node.Storage.Headers)
builder.Finalized, builder.Pending = finalized, pending
return err
})
return builder
}
func (builder *ObserverServiceBuilder) buildFollowerCore() *ObserverServiceBuilder {
builder.Component("follower core", func(node *cmd.NodeConfig) (module.ReadyDoneAware, error) {
// create a finalizer that will handle updating the protocol
// state when the follower detects newly finalized blocks
final := finalizer.NewFinalizer(node.DB, node.Storage.Headers, builder.FollowerState, node.Tracer)
packer := hotsignature.NewConsensusSigDataPacker(builder.Committee)
// initialize the verifier for the protocol consensus
verifier := verification.NewCombinedVerifier(builder.Committee, packer)
followerCore, err := consensus.NewFollower(
node.Logger,
builder.Committee,
node.Storage.Headers,
final,
verifier,
builder.FinalizationDistributor,
node.RootBlock.Header,
node.RootQC,
builder.Finalized,
builder.Pending,
)
if err != nil {
return nil, fmt.Errorf("could not initialize follower core: %w", err)
}
builder.FollowerCore = followerCore
return builder.FollowerCore, nil
})
return builder
}
func (builder *ObserverServiceBuilder) buildFollowerEngine() *ObserverServiceBuilder {
builder.Component("follower engine", func(node *cmd.NodeConfig) (module.ReadyDoneAware, error) {
// initialize cleaner for DB
cleaner := bstorage.NewCleaner(node.Logger, node.DB, builder.Metrics.CleanCollector, flow.DefaultValueLogGCFrequency)
conCache := buffer.NewPendingBlocks()
followerEng, err := follower.New(
node.Logger,
node.Network,
node.Me,
node.Metrics.Engine,
node.Metrics.Mempool,
cleaner,
node.Storage.Headers,
node.Storage.Payloads,
builder.FollowerState,
conCache,
builder.FollowerCore,
builder.SyncCore,
node.Tracer,
follower.WithComplianceOptions(compliance.WithSkipNewProposalsThreshold(builder.ComplianceConfig.SkipNewProposalsThreshold)),
follower.WithChannel(channels.PublicReceiveBlocks),
)
if err != nil {
return nil, fmt.Errorf("could not create follower engine: %w", err)
}
builder.FollowerEng = followerEng
return builder.FollowerEng, nil
})
return builder
}
func (builder *ObserverServiceBuilder) buildFinalizedHeader() *ObserverServiceBuilder {
builder.Component("finalized snapshot", func(node *cmd.NodeConfig) (module.ReadyDoneAware, error) {
finalizedHeader, err := synceng.NewFinalizedHeaderCache(node.Logger, node.State, builder.FinalizationDistributor)
if err != nil {
return nil, fmt.Errorf("could not create finalized snapshot cache: %w", err)
}
builder.FinalizedHeader = finalizedHeader
return builder.FinalizedHeader, nil
})
return builder
}
func (builder *ObserverServiceBuilder) buildSyncEngine() *ObserverServiceBuilder {
builder.Component("sync engine", func(node *cmd.NodeConfig) (module.ReadyDoneAware, error) {
sync, err := synceng.New(
node.Logger,
node.Metrics.Engine,
node.Network,
node.Me,
node.Storage.Blocks,
builder.FollowerEng,
builder.SyncCore,
builder.FinalizedHeader,
builder.SyncEngineParticipantsProviderFactory(),
)
if err != nil {
return nil, fmt.Errorf("could not create synchronization engine: %w", err)
}
builder.SyncEng = sync
return builder.SyncEng, nil
})
return builder
}
func (builder *ObserverServiceBuilder) BuildConsensusFollower() cmd.NodeBuilder {
builder.
buildFollowerState().
buildSyncCore().
buildCommittee().
buildLatestHeader().
buildFollowerCore().
buildFollowerEngine().
buildFinalizedHeader().
buildSyncEngine()
return builder
}
func (builder *ObserverServiceBuilder) BuildExecutionDataRequester() *ObserverServiceBuilder {
var ds *badger.Datastore
var bs network.BlobService
var processedBlockHeight storage.ConsumerProgress
var processedNotifications storage.ConsumerProgress
builder.
Module("execution data datastore and blobstore", func(node *cmd.NodeConfig) error {
err := os.MkdirAll(builder.executionDataDir, 0700)
if err != nil {
return err
}
ds, err = badger.NewDatastore(builder.executionDataDir, &badger.DefaultOptions)
if err != nil {
return err
}
builder.ShutdownFunc(func() error {
if err := ds.Close(); err != nil {
return fmt.Errorf("could not close execution data datastore: %w", err)
}
return nil
})
return nil
}).
Module("processed block height consumer progress", func(node *cmd.NodeConfig) error {
// uses the datastore's DB
processedBlockHeight = bstorage.NewConsumerProgress(ds.DB, module.ConsumeProgressExecutionDataRequesterBlockHeight)
return nil
}).
Module("processed notifications consumer progress", func(node *cmd.NodeConfig) error {
// uses the datastore's DB
processedNotifications = bstorage.NewConsumerProgress(ds.DB, module.ConsumeProgressExecutionDataRequesterNotification)
return nil
}).
Component("execution data service", func(node *cmd.NodeConfig) (module.ReadyDoneAware, error) {
var err error
bs, err = node.Network.RegisterBlobService(channels.ExecutionDataService, ds)
if err != nil {
return nil, fmt.Errorf("could not register blob service: %w", err)
}
builder.ExecutionDataDownloader = execution_data.NewDownloader(bs)
return builder.ExecutionDataDownloader, nil
}).
Component("execution data requester", func(node *cmd.NodeConfig) (module.ReadyDoneAware, error) {
// Validation of the start block height needs to be done after loading state
if builder.executionDataStartHeight > 0 {
if builder.executionDataStartHeight <= builder.RootBlock.Header.Height {
return nil, fmt.Errorf(
"execution data start block height (%d) must be greater than the root block height (%d)",
builder.executionDataStartHeight, builder.RootBlock.Header.Height)
}
latestSeal, err := builder.State.Sealed().Head()
if err != nil {
return nil, fmt.Errorf("failed to get latest sealed height")
}
// Note: since the root block of a spork is also sealed in the root protocol state, the
// latest sealed height is always equal to the root block height. That means that at the
// very beginning of a spork, this check will always fail. Operators should not specify
// an InitialBlockHeight when starting from the beginning of a spork.
if builder.executionDataStartHeight > latestSeal.Height {
return nil, fmt.Errorf(
"execution data start block height (%d) must be less than or equal to the latest sealed block height (%d)",
builder.executionDataStartHeight, latestSeal.Height)
}
// executionDataStartHeight is provided as the first block to sync, but the
// requester expects the initial last processed height, which is the first height - 1
builder.executionDataConfig.InitialBlockHeight = builder.executionDataStartHeight - 1
} else {
builder.executionDataConfig.InitialBlockHeight = builder.RootBlock.Header.Height
}
builder.ExecutionDataRequester = edrequester.New(
builder.Logger,
metrics.NewExecutionDataRequesterCollector(),
builder.ExecutionDataDownloader,
processedBlockHeight,
processedNotifications,
builder.State,
builder.Storage.Headers,
builder.Storage.Results,
builder.Storage.Seals,
builder.executionDataConfig,
)
builder.FinalizationDistributor.AddOnBlockFinalizedConsumer(builder.ExecutionDataRequester.OnBlockFinalized)
return builder.ExecutionDataRequester, nil
})
return builder
}
type Option func(*ObserverServiceConfig)
func NewFlowObserverServiceBuilder(opts ...Option) *ObserverServiceBuilder {
config := DefaultObserverServiceConfig()
for _, opt := range opts {
opt(config)
}
anb := &ObserverServiceBuilder{
ObserverServiceConfig: config,
FlowNodeBuilder: cmd.FlowNode(flow.RoleAccess.String()),
FinalizationDistributor: pubsub.NewFinalizationDistributor(),
}
// the observer gets a version of the root snapshot file that does not contain any node addresses
// hence skip all the root snapshot validations that involved an identity address
anb.FlowNodeBuilder.SkipNwAddressBasedValidations = true
return anb
}
func (builder *ObserverServiceBuilder) ParseFlags() error {
builder.BaseFlags()
builder.extraFlags()
return builder.ParseAndPrintFlags()
}
func (builder *ObserverServiceBuilder) extraFlags() {
builder.ExtraFlags(func(flags *pflag.FlagSet) {
defaultConfig := DefaultObserverServiceConfig()
flags.StringVarP(&builder.rpcConf.UnsecureGRPCListenAddr, "rpc-addr", "r", defaultConfig.rpcConf.UnsecureGRPCListenAddr, "the address the unsecured gRPC server listens on")
flags.StringVar(&builder.rpcConf.SecureGRPCListenAddr, "secure-rpc-addr", defaultConfig.rpcConf.SecureGRPCListenAddr, "the address the secure gRPC server listens on")
flags.StringVarP(&builder.rpcConf.HTTPListenAddr, "http-addr", "h", defaultConfig.rpcConf.HTTPListenAddr, "the address the http proxy server listens on")
flags.StringVar(&builder.rpcConf.RESTListenAddr, "rest-addr", defaultConfig.rpcConf.RESTListenAddr, "the address the REST server listens on (if empty the REST server will not be started)")
flags.UintVar(&builder.rpcConf.MaxHeightRange, "rpc-max-height-range", defaultConfig.rpcConf.MaxHeightRange, "maximum size for height range requests")
flags.StringToIntVar(&builder.apiRatelimits, "api-rate-limits", defaultConfig.apiRatelimits, "per second rate limits for Access API methods e.g. Ping=300,GetTransaction=500 etc.")
flags.StringToIntVar(&builder.apiBurstlimits, "api-burst-limits", defaultConfig.apiBurstlimits, "burst limits for Access API methods e.g. Ping=100,GetTransaction=100 etc.")
flags.StringVar(&builder.observerNetworkingKeyPath, "observer-networking-key-path", defaultConfig.observerNetworkingKeyPath, "path to the networking key for observer")
flags.StringSliceVar(&builder.bootstrapNodeAddresses, "bootstrap-node-addresses", defaultConfig.bootstrapNodeAddresses, "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")
flags.StringSliceVar(&builder.bootstrapNodePublicKeys, "bootstrap-node-public-keys", defaultConfig.bootstrapNodePublicKeys, "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....\"")
flags.DurationVar(&builder.apiTimeout, "upstream-api-timeout", defaultConfig.apiTimeout, "tcp timeout for Flow API gRPC sockets to upstrem nodes")
flags.StringSliceVar(&builder.upstreamNodeAddresses, "upstream-node-addresses", defaultConfig.upstreamNodeAddresses, "the gRPC network addresses of the upstream access node. e.g. access-001.mainnet.flow.org:9000,access-002.mainnet.flow.org:9000")
flags.StringSliceVar(&builder.upstreamNodePublicKeys, "upstream-node-public-keys", defaultConfig.upstreamNodePublicKeys, "the networking public key of the upstream access node (in the same order as the upstream node addresses) e.g. \"d57a5e9c5.....\",\"44ded42d....\"")
flags.BoolVar(&builder.rpcMetricsEnabled, "rpc-metrics-enabled", defaultConfig.rpcMetricsEnabled, "whether to enable the rpc metrics")
// ExecutionDataRequester config
flags.BoolVar(&builder.executionDataSyncEnabled, "execution-data-sync-enabled", defaultConfig.executionDataSyncEnabled, "whether to enable the execution data sync protocol")
flags.StringVar(&builder.executionDataDir, "execution-data-dir", defaultConfig.executionDataDir, "directory to use for Execution Data database")
flags.Uint64Var(&builder.executionDataStartHeight, "execution-data-start-height", defaultConfig.executionDataStartHeight, "height of first block to sync execution data from when starting with an empty Execution Data database")
flags.Uint64Var(&builder.executionDataConfig.MaxSearchAhead, "execution-data-max-search-ahead", defaultConfig.executionDataConfig.MaxSearchAhead, "max number of heights to search ahead of the lowest outstanding execution data height")
flags.DurationVar(&builder.executionDataConfig.FetchTimeout, "execution-data-fetch-timeout", defaultConfig.executionDataConfig.FetchTimeout, "timeout to use when fetching execution data from the network e.g. 300s")
flags.DurationVar(&builder.executionDataConfig.RetryDelay, "execution-data-retry-delay", defaultConfig.executionDataConfig.RetryDelay, "initial delay for exponential backoff when fetching execution data fails e.g. 10s")
flags.DurationVar(&builder.executionDataConfig.MaxRetryDelay, "execution-data-max-retry-delay", defaultConfig.executionDataConfig.MaxRetryDelay, "maximum delay for exponential backoff when fetching execution data fails e.g. 5m")
}).ValidateFlags(func() error {
if builder.executionDataSyncEnabled {
if builder.executionDataConfig.FetchTimeout <= 0 {
return errors.New("execution-data-fetch-timeout must be greater than 0")
}
if builder.executionDataConfig.RetryDelay <= 0 {
return errors.New("execution-data-retry-delay must be greater than 0")
}
if builder.executionDataConfig.MaxRetryDelay < builder.executionDataConfig.RetryDelay {
return errors.New("execution-data-max-retry-delay must be greater than or equal to execution-data-retry-delay")
}
if builder.executionDataConfig.MaxSearchAhead == 0 {
return errors.New("execution-data-max-search-ahead must be greater than 0")
}
}
return nil
})
}
// initNetwork creates the network.Network implementation with the given metrics, middleware, initial list of network
// participants and topology used to choose peers from the list of participants. The list of participants can later be
// updated by calling network.SetIDs.
func (builder *ObserverServiceBuilder) initNetwork(nodeID module.Local,
networkMetrics module.NetworkMetrics,
middleware network.Middleware,
topology network.Topology,
receiveCache *netcache.ReceiveCache,
) (*p2p.Network, error) {
// creates network instance
net, err := p2p.NewNetwork(&p2p.NetworkParameters{
Logger: builder.Logger,
Codec: cborcodec.NewCodec(),
Me: nodeID,
MiddlewareFactory: func() (network.Middleware, error) { return builder.Middleware, nil },
Topology: topology,
SubscriptionManager: subscription.NewChannelSubscriptionManager(middleware),
Metrics: networkMetrics,
IdentityProvider: builder.IdentityProvider,
ReceiveCache: receiveCache,
})
if err != nil {
return nil, fmt.Errorf("could not initialize network: %w", err)
}
return net, nil
}
func publicNetworkMsgValidators(log zerolog.Logger, idProvider module.IdentityProvider, selfID flow.Identifier) []network.MessageValidator {
return []network.MessageValidator{
// filter out messages sent by this node itself
validator.ValidateNotSender(selfID),
validator.NewAnyValidator(
// message should be either from a valid staked node
validator.NewOriginValidator(
id.NewIdentityFilterIdentifierProvider(filter.IsValidCurrentEpochParticipant, idProvider),
),
// or the message should be specifically targeted for this node
validator.ValidateTarget(log, selfID),
),
}
}
// BootstrapIdentities converts the bootstrap node addresses and keys to a Flow Identity list where
// each Flow Identity is initialized with the passed address, the networking key
// and the Node ID set to ZeroID, role set to Access, 0 stake and no staking key.
func BootstrapIdentities(addresses []string, keys []string) (flow.IdentityList, error) {
if len(addresses) != len(keys) {
return nil, fmt.Errorf("number of addresses and keys provided for the boostrap nodes don't match")
}
ids := make([]*flow.Identity, len(addresses))
for i, address := range addresses {
bytes, err := hex.DecodeString(keys[i])
if err != nil {
return nil, fmt.Errorf("failed to decode secured GRPC server public key hex %w", err)
}
publicFlowNetworkingKey, err := crypto.DecodePublicKey(crypto.ECDSAP256, bytes)
if err != nil {
return nil, fmt.Errorf("failed to get public flow networking key could not decode public key bytes %w", err)
}
// create the identity of the peer by setting only the relevant fields
ids[i] = &flow.Identity{
NodeID: flow.ZeroID, // the NodeID is the hash of the staking key and for the public network it does not apply
Address: address,
Role: flow.RoleAccess, // the upstream node has to be an access node
NetworkPubKey: publicFlowNetworkingKey,
}
}
return ids, nil
}
func (builder *ObserverServiceBuilder) initNodeInfo() error {
// use the networking key that was loaded from the configured file
networkingKey, err := loadNetworkingKey(builder.observerNetworkingKeyPath)
if err != nil {
return fmt.Errorf("could not load networking private key: %w", err)
}
pubKey, err := keyutils.LibP2PPublicKeyFromFlow(networkingKey.PublicKey())
if err != nil {
return fmt.Errorf("could not load networking public key: %w", err)
}
builder.peerID, err = peer.IDFromPublicKey(pubKey)
if err != nil {
return fmt.Errorf("could not get peer ID from public key: %w", err)
}
builder.NodeID, err = translator.NewPublicNetworkIDTranslator().GetFlowID(builder.peerID)
if err != nil {
return fmt.Errorf("could not get flow node ID: %w", err)
}
builder.NodeConfig.NetworkKey = networkingKey // copy the key to NodeConfig
builder.NodeConfig.StakingKey = nil // no staking key for the observer
return nil
}
func (builder *ObserverServiceBuilder) InitIDProviders() {
builder.Module("id providers", func(node *cmd.NodeConfig) error {
idCache, err := cache.NewProtocolStateIDCache(node.Logger, node.State, builder.ProtocolEvents)
if err != nil {
return fmt.Errorf("could not initialize ProtocolStateIDCache: %w", err)
}
builder.IDTranslator = translator.NewHierarchicalIDTranslator(idCache, translator.NewPublicNetworkIDTranslator())
// The following wrapper allows to black-list byzantine nodes via an admin command:
// the wrapper overrides the 'Ejected' flag of blocked nodes to true
builder.IdentityProvider, err = cache.NewNodeBlocklistWrapper(idCache, node.DB)
if err != nil {
return fmt.Errorf("could not initialize NodeBlocklistWrapper: %w", err)
}
// use the default identifier provider
builder.SyncEngineParticipantsProviderFactory = func() module.IdentifierProvider {
return id.NewCustomIdentifierProvider(func() flow.IdentifierList {
pids := builder.LibP2PNode.GetPeersForProtocol(unicast.FlowProtocolID(builder.SporkID))
result := make(flow.IdentifierList, 0, len(pids))
for _, pid := range pids {
// exclude own Identifier
if pid == builder.peerID {
continue
}
if flowID, err := builder.IDTranslator.GetFlowID(pid); err != nil {
// TODO: this is an instance of "log error and continue with best effort" anti-pattern
builder.Logger.Err(err).Str("peer", pid.String()).Msg("failed to translate to Flow ID")
} else {
result = append(result, flowID)
}
}
return result
})
}
return nil
})
}
func (builder *ObserverServiceBuilder) Initialize() error {
if err := builder.deriveBootstrapPeerIdentities(); err != nil {
return err
}
if err := builder.deriveUpstreamIdentities(); err != nil {
return err
}
if err := builder.validateParams(); err != nil {
return err
}
if err := builder.initNodeInfo(); err != nil {
return err
}
builder.InitIDProviders()
builder.enqueuePublicNetworkInit()
builder.enqueueConnectWithStakedAN()
builder.enqueueRPCServer()
if builder.BaseConfig.MetricsEnabled {
builder.EnqueueMetricsServerInit()
if err := builder.RegisterBadgerMetrics(); err != nil {
return err
}
}
builder.PreInit(builder.initObserverLocal())
return nil
}
func (builder *ObserverServiceBuilder) validateParams() error {
if builder.BaseConfig.BindAddr == cmd.NotSet || builder.BaseConfig.BindAddr == "" {
return errors.New("bind address not specified")
}
if builder.ObserverServiceConfig.observerNetworkingKeyPath == cmd.NotSet {
return errors.New("networking key not provided")
}
if len(builder.bootstrapIdentities) > 0 {
return nil
}
if len(builder.bootstrapNodeAddresses) == 0 {
return errors.New("no bootstrap node address provided")
}
if len(builder.bootstrapNodeAddresses) != len(builder.bootstrapNodePublicKeys) {
return errors.New("number of bootstrap node addresses and public keys should match")
}
if len(builder.upstreamNodePublicKeys) > 0 && len(builder.upstreamNodeAddresses) != len(builder.upstreamNodePublicKeys) {
return errors.New("number of upstream node addresses and public keys must match if public keys given")
}
return nil
}
// initLibP2PFactory creates the LibP2P factory function for the given node ID and network key for the observer.
// 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
func (builder *ObserverServiceBuilder) initLibP2PFactory(networkKey crypto.PrivateKey) p2pbuilder.LibP2PFactoryFunc {
return func() (*p2pnode.Node, error) {
var pis []peer.AddrInfo
for _, b := range builder.bootstrapIdentities {
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)
}
node, err := p2pbuilder.NewNodeBuilder(builder.Logger, builder.BaseConfig.BindAddr, networkKey, builder.SporkID).
SetSubscriptionFilter(
subscription.NewRoleBasedFilter(
subscription.UnstakedRole, builder.IdentityProvider,
),
).
SetRoutingSystem(func(ctx context.Context, h host.Host) (routing.Routing, error) {
return p2pdht.NewDHT(ctx, h, unicast.FlowPublicDHTProtocolID(builder.SporkID),
builder.Logger,
builder.Metrics.Network,
p2pdht.AsClient(),
dht.BootstrapPeers(pis...),
)
}).
Build()
if err != nil {
return nil, err
}
builder.LibP2PNode = node
return builder.LibP2PNode, nil
}
}
// initObserverLocal initializes the observer's ID, network key and network address
// Currently, it reads a node-info.priv.json like any other node.
// TODO: read the node ID from the special bootstrap files
func (builder *ObserverServiceBuilder) initObserverLocal() func(node *cmd.NodeConfig) error {
return func(node *cmd.NodeConfig) error {
// for an observer, set the identity here explicitly since it will not be found in the protocol state
self := &flow.Identity{
NodeID: node.NodeID,
NetworkPubKey: node.NetworkKey.PublicKey(),
StakingPubKey: nil, // no staking key needed for the observer
Role: flow.RoleAccess, // observer can only run as an access node
Address: builder.BindAddr,
}
var err error
node.Me, err = local.NewNoKey(self)
if err != nil {
return fmt.Errorf("could not initialize local: %w", err)
}
return nil
}
}
// Build enqueues the sync engine and the follower engine for the observer.
// Currently, the observer only runs the follower engine.
func (builder *ObserverServiceBuilder) Build() (cmd.Node, error) {
builder.BuildConsensusFollower()
if builder.executionDataSyncEnabled {
builder.BuildExecutionDataRequester()
}
return builder.FlowNodeBuilder.Build()
}
// enqueuePublicNetworkInit enqueues the observer network component initialized for the observer
func (builder *ObserverServiceBuilder) enqueuePublicNetworkInit() {
var libp2pNode *p2pnode.Node
builder.
Component("public libp2p node", func(node *cmd.NodeConfig) (module.ReadyDoneAware, error) {
libP2PFactory := builder.initLibP2PFactory(node.NetworkKey)
var err error
libp2pNode, err = libP2PFactory()
if err != nil {
return nil, fmt.Errorf("could not create public libp2p node: %w", err)
}
return libp2pNode, nil
}).
Component("public network", func(node *cmd.NodeConfig) (module.ReadyDoneAware, error) {
var heroCacheCollector module.HeroCacheMetrics = metrics.NewNoopCollector()
if builder.HeroCacheMetricsEnable {
heroCacheCollector = metrics.NetworkReceiveCacheMetricsFactory(builder.MetricsRegisterer)
}
receiveCache := netcache.NewHeroReceiveCache(builder.NetworkReceivedMessageCacheSize,
builder.Logger,
heroCacheCollector)
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)
}
msgValidators := publicNetworkMsgValidators(node.Logger, node.IdentityProvider, node.NodeID)
builder.initMiddleware(node.NodeID, node.Metrics.Network, libp2pNode, msgValidators...)
// topology is nil since it is automatically managed by libp2p
net, err := builder.initNetwork(builder.Me, builder.Metrics.Network, builder.Middleware, nil, receiveCache)
if err != nil {
return nil, err
}
builder.Network = converter.NewNetwork(net, channels.SyncCommittee, channels.PublicSyncCommittee)
builder.Logger.Info().Msgf("network will run on address: %s", builder.BindAddr)
idEvents := gadgets.NewIdentityDeltas(builder.Middleware.UpdateNodeAddresses)
builder.ProtocolEvents.AddConsumer(idEvents)
return builder.Network, nil
})
}
// enqueueConnectWithStakedAN enqueues the upstream connector component which connects the libp2p host of the observer
// service with the AN.
// Currently, there is an issue with LibP2P stopping advertisements of subscribed topics if no peers are connected
// (https://github.com/libp2p/go-libp2p-pubsub/issues/442). This means that an observer could end up not being
// discovered by other observers if it subscribes to a topic before connecting to the AN. Hence, the need
// of an explicit connect to the AN before the node attempts to subscribe to topics.
func (builder *ObserverServiceBuilder) enqueueConnectWithStakedAN() {
builder.Component("upstream connector", func(_ *cmd.NodeConfig) (module.ReadyDoneAware, error) {
return consensus_follower.NewUpstreamConnector(builder.bootstrapIdentities, builder.LibP2PNode, builder.Logger), nil
})
}
func (builder *ObserverServiceBuilder) enqueueRPCServer() {
builder.Component("RPC engine", func(node *cmd.NodeConfig) (module.ReadyDoneAware, error) {
engineBuilder, err := rpc.NewBuilder(
node.Logger,
node.State,
builder.rpcConf,
nil,
nil,
node.Storage.Blocks,
node.Storage.Headers,
node.Storage.Collections,
node.Storage.Transactions,
node.Storage.Receipts,
node.Storage.Results,
node.RootChainID,
nil,
nil,
0,
0,
false,
builder.rpcMetricsEnabled,
builder.apiRatelimits,
builder.apiBurstlimits,
)
if err != nil {
return nil, err
}
// upstream access node forwarder
forwarder, err := apiproxy.NewFlowAccessAPIForwarder(builder.upstreamIdentities, builder.apiTimeout)
if err != nil {
return nil, err
}
proxy := &apiproxy.FlowAccessAPIRouter{
Logger: builder.Logger,
Metrics: metrics.NewObserverCollector(),
Upstream: forwarder,
Observer: protocol.NewHandler(protocol.New(
node.State,
node.Storage.Blocks,