/
service.go
2051 lines (1753 loc) · 71.9 KB
/
service.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 server
import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"math/big"
"math/rand"
"net/http"
"net/url"
"sort"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
capellaBuilderAPI "github.com/attestantio/go-builder-client/api/capella"
v1 "github.com/attestantio/go-builder-client/api/v1"
capellaapi "github.com/attestantio/go-eth2-client/api/v1/capella"
"github.com/attestantio/go-eth2-client/spec/capella"
"github.com/attestantio/go-eth2-client/spec/phase0"
"github.com/bloXroute-Labs/gateway/v2/sdnmessage"
"github.com/bloXroute-Labs/gateway/v2/utils/syncmap"
"github.com/cenkalti/backoff/v4"
"github.com/flashbots/go-boost-utils/types"
"github.com/gorilla/mux"
"github.com/justinas/alice"
"github.com/patrickmn/go-cache"
"github.com/redis/go-redis/v9"
uuid "github.com/satori/go.uuid"
"github.com/sirupsen/logrus"
blst "github.com/supranational/blst/bindings/go"
"go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
uberatomic "go.uber.org/atomic"
"github.com/bloXroute-Labs/gateway/v2/services/statistics"
"github.com/bloXroute-Labs/mev-relay/beaconclient"
"github.com/bloXroute-Labs/mev-relay/common"
"github.com/bloXroute-Labs/mev-relay/database"
"github.com/bloXroute-Labs/mev-relay/datastore"
"go.opentelemetry.io/otel/codes"
)
const (
defaultDatabaseRequestTimeout = 12 * time.Second
slotsPerEpoch = 32
emptyWalletAddressZero = "0x0000000000000000000000000000000000000000"
emptyWalletAddressOne = "0x0000000000000000000000000000000000000001"
coinbaseExchangeWalletAddress = "0x4675c7e5baafbffbca748158becba61ef3b0a263"
disableGetHeaderResponseSlotInterval = 10
bestBlockLoggingTimerInterval = 11 * time.Second // slot time - 1 sec
blockSimulationTimeout = 3 * time.Second
builderBidsReceivedKey = "builderBidsReceived"
clientAllowedGetHeaderReqPerMin = 5
bloxrouteExtraData = "0x506f776572656420627920626c6f58726f757465"
saveDeliveredPayloadMaxElapsedTime = 20 * time.Second
saveDeliveredPayloadMaxInterval = 5 * time.Second
getValidatorRegistrationsMaxElapsedTime = 2 * time.Second
blockSubmissionChannel = "blockSubmission"
redisPubsubChannelSize = 1000
AuthHeaderPrefix = "bearer "
)
// RPCRequestType represents the JSON-RPC methods that are callable
type RPCRequestType string
// RPCRequestType enumeration
const (
RPCMEVBlock RPCRequestType = "mev_block"
RPCProposerSlot RPCRequestType = "proposer_slot"
)
// RelayType represents the type of relay
type RelayType string
// RelayType enumeration
const (
RelayMaxProfit RelayType = "max-profit"
RelayRegulated RelayType = "regulated"
RelayEthical RelayType = "ethical"
RelayUnknown RelayType = ""
)
var (
errInvalidSlot = errors.New("invalid slot")
errInvalidHash = errors.New("invalid hash")
errInvalidPubkey = errors.New("invalid pubkey")
errNoSuccessfulRelayResponse = errors.New("no successful relay response")
errServerAlreadyRunning = errors.New("server already running")
errSimulationTimeout = errors.New("timeout while waiting for successful simulation response")
nilHash = types.Hash{}
nilResponse = struct{}{}
defaultBuilderPubkeySkipSimulationThreshold = big.NewInt(500000000000000000) // 0.5 ETH
defaultBuilderAccountIDSkipSimulationThreshold = new(big.Int).Mul(big.NewInt(20), big.NewInt(1000000000000000000)) // 20 ETH
)
type httpErrorResp struct {
Code int `json:"code"`
Message string `json:"message"`
}
type blockValuePayloadParams struct {
RelayType RelayType `json:"relay_type"`
SlotNumber uint64 `json:"slot_number"`
BlockNumber uint64 `json:"block_number"`
BlockHash string `json:"block_hash"`
BlockValue *big.Int `json:"block_value"`
ProposerFeeRecipient string `json:"proposer_fee_recipient"`
GasUsed uint64 `json:"gas_used"`
BuilderPubkey string `json:"builder_pubkey"`
ParentHash string `json:"parent_hash"`
TimestampMs int64 `json:"timestamp_ms"`
}
type slotProposerPayloadParams struct {
SlotNumber uint64 `json:"slot_number"`
ProposerIndex uint64 `json:"proposer_index"`
ProposerPublicKey string `json:"proposer_public_key"`
}
type blockValuePayload struct {
Method string `json:"method"`
Params blockValuePayloadParams `json:"params"`
}
type slotProposerPayload struct {
Method string `json:"method"`
Params slotProposerPayloadParams `json:"params"`
}
type payloadLog struct {
BlockNumber uint64 `json:"block_number"`
Hash string `json:"hash"`
Slot uint64 `json:"slot"`
Proposer uint64 `json:"proposer"`
IsBloxrouteBlock bool `json:"is_bloxroute_block"`
ExtraData string `json:"extra_data"`
}
type bidSavedLog struct {
Duration int64 `json:"duration"`
ValidatorIsActive bool `json:"validator_is_active"`
BlockHash string `json:"block_hash"`
BuilderPubKey string `json:"builder_pub_key"`
Slot uint64 `json:"slot"`
}
// BoostServiceOpts provides all available options for use with NewBoostService
type BoostServiceOpts struct {
Log *logrus.Entry
ListenAddr string
Relays []RelayEntry
GenesisForkVersionHex string
BellatrixForkVersionHex string
CapellaForkVersionHex string
GenesisValidatorRootHex string
RelayRequestTimeout time.Duration
RelayCheck bool
MaxHeaderBytes int
IsRelay bool
SecretKey *blst.SecretKey
PubKey types.PublicKey
BeaconNode string
ExecutionNode url.URL
BeaconChain url.URL
Etherscan url.URL
KnownValidators string
CheckKnownValidators bool
BuilderIPs string
HighPriorityBuilderPubkeys *syncmap.SyncMap[string, bool]
HighPerfSimBuilderPubkeys *syncmap.SyncMap[string, bool]
DB database.IDatabaseService
RedisURI string
RedisPrefix string
SDNURL string
CertificatesPath string
SimulationNodes string
SimulationNodeHighPerf string
CloudServicesEndpoint string
CloudServicesAuthHeader string
SendSlotProposerDuties bool
RelayType RelayType
RedisPoolSize int
TopBlockLimit int
ExternalRelaysForComparison []string
GetPayloadRequestCutoffMs int
GetHeaderRequestCutoffMs int
CapellaForkEpoch int64
EnableBidSaveCancellation bool
Tracer trace.Tracer
TrustedValidatorBearerTokens *syncmap.SyncMap[string, struct{}]
}
type ProvidedHeaders struct {
Headers []*common.GetHeaderResponse
ProposerPublicKey string
}
type randaoHelper struct {
slot uint64
prevRandao string
}
type saveBlockData struct {
getHeaderResponse common.GetHeaderResponse
submission common.WrappedCapellaBuilderSubmitBlockRequest
signedBidTrace *v1.BidTrace
receivedAt time.Time
clientIPAddress string
reqRemoteAddress string
simulationTime string
tier sdnmessage.AccountTier
}
type builderContextData struct {
Ctx context.Context
Cancel context.CancelFunc
BidReceivedTime time.Time
BidValue *big.Int
BlockHash string
}
// BoostService TODO
type BoostService struct {
listenAddr string
relays []RelayEntry
log *logrus.Entry
srv *http.Server
relayCheck bool
db database.IDatabaseService
datastore *datastore.Datastore
bidTraceWithTimestampJSONCache *cache.Cache
isRelay bool
secretKey *blst.SecretKey
pubKey types.PublicKey
beaconClient beaconclient.MultiBeaconClient
beaconNode,
executionNode,
beaconChain,
etherscan url.URL
knownValidators string
checkKnownValidators bool
validators *syncmap.SyncMap[string, Validator]
validatorsByIndex *syncmap.SyncMap[string, string]
validatorsLock sync.RWMutex
relayRankings *syncmap.SyncMap[string, relayRanking]
validatorActivity *syncmap.SyncMap[string, validatorActivity]
genesisForkVersion string
bellatrixForkVersion string
proposerSigningDomain types.Domain
genesisValidatorRootHex string
recentBlocks []blockStat
recentBlocksLock sync.RWMutex
stats statistics.FluentdStats
builderIPs string
highPriorityBuilderDataLock sync.RWMutex
highPriorityBuilderPubkeys *syncmap.SyncMap[string, bool]
highPriorityBuilderAccountIDs *syncmap.SyncMap[string, bool]
highPriorityBuilderPubkeysToSkipSimulationThreshold *syncmap.SyncMap[string, *big.Int]
highPriorityBuilderAccountIDsToSkipSimulationThreshold *syncmap.SyncMap[string, *big.Int]
ultraBuilderAccountIDs *syncmap.SyncMap[string, bool]
noRateLimitUltraBuilderAccIDs *syncmap.SyncMap[string, bool]
highPerfSimBuilderPubkeys *syncmap.SyncMap[string, bool]
certificatesPath string
sdnURL string
simulationNodes []string
simulationNodeHighPerf string
expectedBlockNumber uint64
expectedPrevRandao randaoHelper
expectedPayloadDataLock sync.RWMutex
externalRelaysForComparison []string
demotedBuilderLock sync.RWMutex
demotedBuilders *syncmap.SyncMap[string, string]
providedHeaders *syncmap.SyncMap[int64, ProvidedHeaders]
providedPayload *syncmap.SyncMap[int64, bool]
maxHeaderBytes int
builderSigningDomain types.Domain
httpClient http.Client
cloudServicesHttpClient http.Client
genesisInfo GetGenesisResponse
topBlockMap *syncmap.SyncMap[uint64, *syncmap.SyncMap[string, int]]
getPayloadRequestCutoffMs int
getHeaderRequestCutoffMs int
performanceStats PerformanceStats
proposerDutiesLock sync.RWMutex
proposerDutiesResponse []types.BuilderGetValidatorsResponseEntry
proposerDutiesSlot uint64
proposerDutiesMap *syncmap.SyncMap[uint64, *types.RegisterValidatorRequestMessage]
isUpdatingProposerDuties *uberatomic.Bool
latestFetchedSlotNumber uint64
cloudServicesEndpoint string
cloudServicesAuthHeader string
sendSlotProposerDuties bool
relayType RelayType
allProposerDuties *syncmap.SyncMap[uint64, beaconclient.ProposerDutiesResponseData]
allProposerDutiesLock sync.Mutex
latestSlotBlockReceived *uberatomic.Uint64
getHeaderLatestDisabledSlot *uberatomic.Uint64
slotStartTimes *syncmap.SyncMap[uint64, time.Time]
getPayloadRequests *syncmap.SyncMap[uint64, requestInfo]
getHeaderRequests *syncmap.SyncMap[uint64, []getHeaderRequestInfo]
bestBlockBidForSlot *syncmap.SyncMap[uint64, v1.BidTrace]
bestBlockLoggingTimer *time.Timer
bestBloxrouteBlockBidForSlot *syncmap.SyncMap[uint64, v1.BidTrace]
nextSlotWithdrawalsRoot phase0.Root
nextSlotWithdrawals []*capella.Withdrawal
nextSlotWithdrawalsLock sync.RWMutex
// TODO: remove this and flag??
capellaForkEpoch int64
newBlockChannel chan *saveBlockData
newPayloadAttributesSlotChannel chan uint64
redisBlockSubChannel chan *redis.Message
builderContextsForSlot *syncmap.SyncMap[uint64, *syncmap.SyncMap[string, *builderContextData]]
nodeUUID uuid.UUID
enableBidSaveCancellation bool
slotKeysToExpire *syncmap.SyncMap[uint64, *syncmap.SyncMap[string, bool]]
keysToExpireChan chan *syncmap.SyncMap[uint64, []string]
trustedValidatorBearerTokens *syncmap.SyncMap[string, struct{}]
tracer trace.Tracer
auth Auth
}
type deliveredPayloadsResult struct {
res []*database.BuilderBlockSubmissionEntry
err error
}
// NewBoostService created a new BoostService
func NewBoostService(opts BoostServiceOpts) (*BoostService, error) {
if len(opts.Relays) == 0 {
return nil, errors.New("no relays")
}
builderSigningDomain, err := ComputeDomain(types.DomainTypeAppBuilder, opts.GenesisForkVersionHex, types.Root{}.String())
if err != nil {
return nil, err
}
proposerSigningDomain, err := ComputeDomain(types.DomainTypeBeaconProposer, opts.CapellaForkVersionHex, opts.GenesisValidatorRootHex)
if err != nil {
return nil, err
}
opts.Log.Info("Setting up datastore...")
datastoreInstance, err := datastore.NewDatastore(opts.RedisURI, opts.RedisPrefix, opts.RedisPoolSize, opts.Log)
if err != nil {
opts.Log.WithError(err).Fatalf("Failed setting up prod datastore")
}
opts.Log.Infof("Using beacon endpoints: %s", opts.BeaconNode)
var beaconInstances []beaconclient.IBeaconInstance
for _, uri := range strings.Split(opts.BeaconNode, ",") {
beaconInstances = append(beaconInstances, beaconclient.NewProdBeaconInstance(opts.Log, uri))
}
beaconNodeURL, err := url.Parse(strings.Split(opts.BeaconNode, ",")[0])
if err != nil {
opts.Log.WithError(err).Error("could not process first beacon node")
}
boostService := &BoostService{
listenAddr: opts.ListenAddr,
relays: opts.Relays,
log: opts.Log.WithField("module", "service"),
relayCheck: opts.RelayCheck,
db: opts.DB,
datastore: datastoreInstance,
maxHeaderBytes: opts.MaxHeaderBytes,
isRelay: opts.IsRelay,
secretKey: opts.SecretKey,
pubKey: opts.PubKey,
executionNode: opts.ExecutionNode,
beaconChain: opts.BeaconChain,
etherscan: opts.Etherscan,
builderSigningDomain: builderSigningDomain,
knownValidators: opts.KnownValidators,
checkKnownValidators: opts.CheckKnownValidators,
certificatesPath: opts.CertificatesPath,
sdnURL: opts.SDNURL,
validators: syncmap.NewStringMapOf[Validator](),
validatorsByIndex: syncmap.NewStringMapOf[string](),
validatorsLock: sync.RWMutex{},
validatorActivity: syncmap.NewStringMapOf[validatorActivity](),
relayRankings: syncmap.NewStringMapOf[relayRanking](),
genesisForkVersion: opts.GenesisForkVersionHex,
bellatrixForkVersion: opts.BellatrixForkVersionHex,
proposerSigningDomain: proposerSigningDomain,
genesisValidatorRootHex: opts.GenesisValidatorRootHex,
recentBlocks: []blockStat{},
simulationNodes: strings.Split(opts.SimulationNodes, ","),
simulationNodeHighPerf: opts.SimulationNodeHighPerf,
beaconNode: *beaconNodeURL,
nextSlotWithdrawalsRoot: phase0.Root{},
nextSlotWithdrawals: []*capella.Withdrawal{},
nextSlotWithdrawalsLock: sync.RWMutex{},
expectedBlockNumber: 0,
expectedPrevRandao: randaoHelper{},
expectedPayloadDataLock: sync.RWMutex{},
demotedBuilderLock: sync.RWMutex{},
demotedBuilders: syncmap.NewStringMapOf[string](),
topBlockMap: syncmap.NewIntegerMapOf[uint64, *syncmap.SyncMap[string, int]](),
getPayloadRequestCutoffMs: opts.GetPayloadRequestCutoffMs,
getHeaderRequestCutoffMs: opts.GetHeaderRequestCutoffMs,
externalRelaysForComparison: opts.ExternalRelaysForComparison,
beaconClient: *beaconclient.NewMultiBeaconClient(opts.Log, beaconInstances),
bidTraceWithTimestampJSONCache: cache.New(time.Minute*30, time.Minute*30),
// TODO: possibly change providedHeaders back to hashmap.New[int64, []*types.GetHeaderResponse] after builder 'getValidators' implemented
providedHeaders: syncmap.NewIntegerMapOf[int64, ProvidedHeaders](),
providedPayload: syncmap.NewIntegerMapOf[int64, bool](),
builderIPs: opts.BuilderIPs,
highPriorityBuilderDataLock: sync.RWMutex{},
highPriorityBuilderPubkeys: opts.HighPriorityBuilderPubkeys,
highPerfSimBuilderPubkeys: opts.HighPerfSimBuilderPubkeys,
highPriorityBuilderAccountIDs: syncmap.NewStringMapOf[bool](),
highPriorityBuilderPubkeysToSkipSimulationThreshold: syncmap.NewStringMapOf[*big.Int](),
highPriorityBuilderAccountIDsToSkipSimulationThreshold: syncmap.NewStringMapOf[*big.Int](),
ultraBuilderAccountIDs: syncmap.NewStringMapOf[bool](),
noRateLimitUltraBuilderAccIDs: syncmap.NewStringMapOf[bool](),
httpClient: http.Client{
Timeout: opts.RelayRequestTimeout,
CheckRedirect: func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
},
},
cloudServicesHttpClient: http.Client{
Transport: &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
},
Timeout: opts.RelayRequestTimeout,
},
performanceStats: NewPerformanceStats(),
proposerDutiesLock: sync.RWMutex{}, // sync.RWMutex
proposerDutiesResponse: make([]types.BuilderGetValidatorsResponseEntry, 0),
proposerDutiesSlot: 0, // uint64
proposerDutiesMap: syncmap.NewIntegerMapOf[uint64, *types.RegisterValidatorRequestMessage](),
isUpdatingProposerDuties: uberatomic.NewBool(false), // uberatomic.Bool
latestFetchedSlotNumber: 0,
cloudServicesEndpoint: opts.CloudServicesEndpoint,
cloudServicesAuthHeader: opts.CloudServicesAuthHeader,
sendSlotProposerDuties: opts.SendSlotProposerDuties,
relayType: opts.RelayType,
allProposerDuties: syncmap.NewIntegerMapOf[uint64, beaconclient.ProposerDutiesResponseData](),
allProposerDutiesLock: sync.Mutex{},
latestSlotBlockReceived: uberatomic.NewUint64(0),
getHeaderLatestDisabledSlot: uberatomic.NewUint64(0),
slotStartTimes: syncmap.NewIntegerMapOf[uint64, time.Time](),
getPayloadRequests: syncmap.NewIntegerMapOf[uint64, requestInfo](),
getHeaderRequests: syncmap.NewIntegerMapOf[uint64, []getHeaderRequestInfo](),
bestBlockBidForSlot: syncmap.NewIntegerMapOf[uint64, v1.BidTrace](),
bestBloxrouteBlockBidForSlot: syncmap.NewIntegerMapOf[uint64, v1.BidTrace](),
capellaForkEpoch: opts.CapellaForkEpoch,
newBlockChannel: make(chan *saveBlockData, redisPubsubChannelSize),
newPayloadAttributesSlotChannel: make(chan uint64, redisPubsubChannelSize),
redisBlockSubChannel: make(chan *redis.Message, redisPubsubChannelSize),
builderContextsForSlot: syncmap.NewIntegerMapOf[uint64, *syncmap.SyncMap[string, *builderContextData]](),
enableBidSaveCancellation: opts.EnableBidSaveCancellation,
slotKeysToExpire: syncmap.NewIntegerMapOf[uint64, *syncmap.SyncMap[string, bool]](),
keysToExpireChan: make(chan *syncmap.SyncMap[uint64, []string]),
trustedValidatorBearerTokens: opts.TrustedValidatorBearerTokens,
tracer: opts.Tracer,
}
boostService.nodeUUID, err = uuid.NewV4()
if err != nil {
boostService.nodeUUID = uuid.UUID{}
boostService.log.Error("could not create UUID for this relay node, setting to empty", "error", err)
}
getGenesisResponse, err := boostService.GetGenesis()
if err != nil {
boostService.log.Error("could not fetch genesis", "error", err)
}
boostService.genesisInfo = *getGenesisResponse
go func() {
for {
keysToExpire := <-boostService.keysToExpireChan
keysToExpire.Range(func(slot uint64, keys []string) bool {
slotKeyMap, ok := boostService.slotKeysToExpire.Load(slot)
if !ok {
slotKeyMap = syncmap.NewStringMapOf[bool]()
}
for _, key := range keys {
slotKeyMap.Store(key, true)
}
boostService.slotKeysToExpire.Store(slot, slotKeyMap)
return true
})
}
}()
return boostService, nil
}
func (m *BoostService) respondErrorWithLog(w http.ResponseWriter, code int, message string, log *logrus.Entry, logMessage string) {
log = log.WithFields(logrus.Fields{"resp_message": message, "resp_code": code})
// write either specific error message or use one for the response
if logMessage != "" {
log.Error(logMessage)
} else {
log.Error(message)
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(code)
resp := httpErrorResp{Code: code, Message: message}
if err := json.NewEncoder(w).Encode(resp); err != nil {
log.WithError(err).Error("couldn't write error response")
http.Error(w, "", http.StatusInternalServerError)
}
}
func (m *BoostService) respondError(w http.ResponseWriter, code int, message string) {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(code)
resp := httpErrorResp{Code: code, Message: message}
if err := json.NewEncoder(w).Encode(resp); err != nil {
m.log.WithError(err).Error("couldn't write error response")
http.Error(w, "", http.StatusInternalServerError)
}
}
func (m *BoostService) respondOK(w http.ResponseWriter, response any) {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
if err := json.NewEncoder(w).Encode(response); err != nil {
m.log.WithField("response", response).WithError(err).Error("Couldn't write OK response")
http.Error(w, "", http.StatusInternalServerError)
}
}
func (m *BoostService) respondEncodedJSON(w http.ResponseWriter, response []byte) {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write(response)
}
func (m *BoostService) getRouter() http.Handler {
auth := NewAuth(m.log, m.certificatesPath, m.sdnURL, m.builderIPs)
m.auth = auth
r := mux.NewRouter()
r.HandleFunc("/", m.handleIndex)
r.PathPrefix("/static/").Handler(
func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Cache-Control", "max-age=18000, public, must-revalidate, proxy-revalidate")
next.ServeHTTP(w, r)
})
}(http.StripPrefix("/static/", http.FileServer(http.Dir("./static")))))
r.HandleFunc(pathStatus, m.handleStatus).Methods(http.MethodGet)
r.HandleFunc(pathRegisterValidator, m.handleRegisterValidator).Methods(http.MethodPost)
r.Handle(pathGetHeader, alice.New(rateLimitMiddleware(m.log, newRateLimiter(time.Minute, clientAllowedGetHeaderReqPerMin), getHeaderCaller)).
ThenFunc(m.handleGetHeader)).Methods(http.MethodGet)
r.HandleFunc(pathGetPayload, m.handleGetPayload).Methods(http.MethodPost)
r.HandleFunc(pathPutRelay, m.authMiddleware(m.handlePutRelay)).Methods(http.MethodPut)
r.Handle(pathSubmitNewBlock, alice.New(auth.whitelistIPMiddleware, auth.authMiddleware,
m.tierRateLimitMiddleware(newTierRateLimiters())).
ThenFunc(m.handlePostBlock)).Methods(http.MethodPost)
r.HandleFunc(pathBuilderGetValidators, m.handleBuilderGetValidators).Methods(http.MethodGet)
r.HandleFunc(pathDataProposerPayloadDelivered, m.handleDataProposerPayloadDelivered).Methods(http.MethodGet)
r.HandleFunc(pathDataBuilderBidsReceived, m.handleDataBuilderBidsReceived).Methods(http.MethodGet)
r.HandleFunc(pathDataValidatorRegistration, m.handleDataValidatorRegistration).Methods(http.MethodGet)
r.Handle(pathBuilderDeleteBlocks, alice.New(auth.whitelistIPMiddleware).ThenFunc(m.handleBuilderDeleteBlocks)).Methods(http.MethodPost)
r.Handle(pathBuilderDisableGetHeaderResponse, alice.New(auth.whitelistIPMiddleware).ThenFunc(m.handleBuilderDisableGetHeaderResponse)).Methods(http.MethodPost)
r.HandleFunc(pathGetActiveValidators, m.handleActiveValidators).Methods(http.MethodGet)
r.Handle(pathWebsocket, alice.New(auth.whitelistIPMiddleware, auth.authMiddleware).ThenFunc(m.HandleSocketConnection)).Methods(http.MethodGet)
r.Use(otelmux.Middleware("http-server"))
r.Use(mux.CORSMethodMiddleware(r))
r.Use(LogRequestID(m))
r.Use(CheckKnownValidator(m))
return recoveryMiddlewareWithLogs(m.log, r)
}
// StartHTTPServer starts the HTTP server for this boost service instance
func (m *BoostService) StartHTTPServer() error {
if m.srv != nil {
return errServerAlreadyRunning
}
m.srv = &http.Server{
Addr: m.listenAddr,
Handler: otelhttp.NewHandler(m.getRouter(), "otel-http-handler"),
ReadTimeout: 0,
ReadHeaderTimeout: 0,
WriteTimeout: 0,
IdleTimeout: 10 * time.Second,
MaxHeaderBytes: m.maxHeaderBytes,
}
err := m.srv.ListenAndServe()
if err == http.ErrServerClosed {
return nil
}
return err
}
//lint:ignore U1000 keep for future merging
func (m *BoostService) handleRoot(w http.ResponseWriter, _ *http.Request) {
m.respondOK(w, nilResponse)
}
// handleStatus sends calls to the status endpoint of every relay.
// It returns OK if at least one returned OK, and returns error otherwise.
func (m *BoostService) handleStatus(w http.ResponseWriter, req *http.Request) {
start := time.Now()
success := false
defer func() {
m.performanceStats.SetEndpointStats(pathStatus, uint64(time.Since(start).Microseconds()), success)
}()
if !m.relayCheck {
success = true
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write([]byte("{}"))
return
}
// If relayCheck is enabled, make sure at least 1 relay returns success
var wg sync.WaitGroup
var numSuccessRequestsToRelay uint32
ua := UserAgent(req.Header.Get("User-Agent"))
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
log := m.log.WithFields(logrus.Fields{
"method": "status",
})
for _, r := range m.relays {
wg.Add(1)
go func(relay RelayEntry, log logrus.Entry) {
defer wg.Done()
uri := relay.GetURI(pathStatus)
logR := log.WithField("uri", uri)
logR.Trace("checking relay status")
_, err := SendHTTPRequest(ctx, m.httpClient, http.MethodGet, uri, ua, nil, nil)
if err != nil && ctx.Err() != context.Canceled {
logR.WithError(err).Error("failed to retrieve relay status")
return
}
// Success: increase counter and cancel all pending requests to other relays
atomic.AddUint32(&numSuccessRequestsToRelay, 1)
cancel()
}(r, *log)
}
// At the end, wait for every routine and return status according to relay's ones.
wg.Wait()
if numSuccessRequestsToRelay > 0 {
success = true
m.respondOK(w, nilResponse)
} else {
m.respondErrorWithLog(w, http.StatusServiceUnavailable, "all relays are unavailable", log, "")
}
}
// RegisterValidatorV1 - returns 200 if at least one relay returns 200
func (m *BoostService) handlePutRelay(w http.ResponseWriter, req *http.Request) {
start := time.Now()
success := false
defer func() {
m.performanceStats.SetEndpointStats(pathPutRelay, uint64(time.Since(start).Microseconds()), success)
}()
log := m.log.WithFields(logrus.Fields{
"method": "putRelay",
"requester-ip": req.RemoteAddr,
})
var payload PutRelayPayload
if err := decodeJSON(req.Body, &payload); err != nil {
m.respondErrorWithLog(w, http.StatusBadRequest, err.Error(), log.WithError(err), "failed to decode request payload")
return
}
urls := m.parseRelayURLs(payload.URL)
for _, relay := range m.relays {
if urls[0].URL.String() == relay.URL.String() {
m.respondErrorWithLog(w, http.StatusBadRequest, "relay already known", log, "")
return
}
}
m.relays = append(m.relays, urls...)
success = true
m.respondOK(w, nilResponse)
}
// RegisterValidatorV1 - returns 200 if at least one relay returns 200
func (m *BoostService) handleRegisterValidator(w http.ResponseWriter, req *http.Request) {
start := time.Now()
success := false
defer func() {
m.performanceStats.SetEndpointStats(pathRegisterValidator, uint64(time.Since(start).Microseconds()), success)
}()
span := trace.SpanFromContext(req.Context())
log := m.log.WithFields(logrus.Fields{
"method": "registerValidator",
})
var (
isTrustedValidator bool
)
authHeader := strings.ToLower(req.Header.Get("authorization"))
if strings.HasPrefix(authHeader, AuthHeaderPrefix) {
token := strings.TrimPrefix(authHeader, AuthHeaderPrefix)
isTrustedValidator = m.trustedValidatorBearerTokens.Has(token)
}
var registrations []types.SignedValidatorRegistration
if err := decodeJSONAndClose(req.Body, ®istrations); err != nil {
m.respondErrorWithLog(w, http.StatusBadRequest, err.Error(), log.WithError(err), "failed to decode request registrations")
return
}
log = log.WithFields(logrus.Fields{
"numRegistrations": len(registrations),
"isTrustedValidator": isTrustedValidator,
})
span.SetAttributes(
attribute.String("method", "registerValidator"),
attribute.Int("numRegistrations", len(registrations)),
attribute.Bool("isTrustedValidator", isTrustedValidator),
)
spanContext := trace.ContextWithSpan(req.Context(), span)
var registrationsPubKeys []string
for i := range registrations {
if registrations[i].Message == nil {
log.Debug("registration message is nil")
continue
}
registrationsPubKeys = append(registrationsPubKeys, registrations[i].Message.Pubkey.PubkeyHex().String())
}
storedValidatorRegistrations, err := m.datastore.GetValidatorRegistrations(spanContext, registrationsPubKeys)
if err != nil {
// even in case of error here, all the validators will be re-registered
log.WithError(err).Error("failed to get validator registrations")
}
storedRegistrations := make(map[string]types.SignedValidatorRegistration)
for i := range storedValidatorRegistrations {
storedRegistrations[storedValidatorRegistrations[i].Message.Pubkey.PubkeyHex().String()] = storedValidatorRegistrations[i]
}
validators := make(map[string]interface{})
activeValidators := make(map[string]interface{})
var validRegistrations []types.SignedValidatorRegistration
for i := range registrations {
if registrations[i].Message == nil {
log.Debug("registration message is nil")
continue
}
// check for a previous registration fee recipient
storedValidatorRegistration, ok := storedRegistrations[registrations[i].Message.Pubkey.PubkeyHex().String()]
// skip signature verification if the fee recipient is the same
if ok && storedValidatorRegistration.Message.FeeRecipient.String() == registrations[i].Message.FeeRecipient.String() {
log.Tracef("validator public key %s and fee recipient %s validated from the cache",
storedValidatorRegistration.Message.Pubkey.String(), registrations[i].Message.FeeRecipient.String())
validRegistrations = append(validRegistrations, registrations[i])
activeValidators[registrations[i].Message.Pubkey.PubkeyHex().String()] = &datastore.ValidatorLatency{
Registration: registrations[i],
LastRegistered: time.Now().UnixNano(),
IsTrusted: isTrustedValidator,
}
continue
}
ok, err := types.VerifySignature(registrations[i].Message, m.builderSigningDomain,
registrations[i].Message.Pubkey[:], registrations[i].Signature[:])
if !ok || err != nil {
if err != nil {
log = log.WithError(err)
}
m.respondErrorWithLog(w, http.StatusBadRequest, "invalid signature", log, "")
return
} else {
validRegistrations = append(validRegistrations, registrations[i])
activeValidators[registrations[i].Message.Pubkey.PubkeyHex().String()] = &datastore.ValidatorLatency{
Registration: registrations[i],
LastRegistered: time.Now().UnixNano(),
IsTrusted: isTrustedValidator,
}
}
}
if len(activeValidators) > 0 {
go func() {
err := m.datastore.SetValidatorRegistrationMap(spanContext, activeValidators)
if err != nil {
log.WithError(err).Error("failed to set validator registration")
} else {
log.WithField("validator-count", len(validators)).Info("saved registration")
}
}()
}
go func() {
for _, registration := range validRegistrations {
go func(reg types.SignedValidatorRegistration) {
ctx, cancel := context.WithTimeout(spanContext, defaultDatabaseRequestTimeout)
defer cancel()
if err := m.db.SaveValidatorRegistration(ctx, reg); err != nil {
log.WithError(err).WithField("pubkey", reg.Message.Pubkey.String()).Error("could not save registration for validator")
}
}(registration)
}
}()
log.WithField("timeNeededSec", time.Since(start).Seconds()).Info("register validator")
success = true
m.respondOK(w, nilResponse)
}
// GetHeaderV1 TODO
func (m *BoostService) handleGetHeader(w http.ResponseWriter, req *http.Request) {
start := time.Now().UTC()
success := false
defer func() {
m.performanceStats.SetEndpointStats(pathGetHeaderPrefix, uint64(time.Since(start).Microseconds()), success)
}()
vars := mux.Vars(req)
parentHashHex := vars["parent_hash"]
pubkey := vars["pubkey"]
log := m.log.WithFields(logrus.Fields{
"method": "getHeader",
"slot": vars["slot"],
"parentHash": parentHashHex,
"pubkey": pubkey,
})
span := trace.SpanFromContext(req.Context())
span.SetAttributes(
attribute.String("method", "getHeader"),
attribute.String("slot", vars["slot"]),
attribute.String("parentHash", parentHashHex),
attribute.String("pubkey", pubkey),
)
spanContext := trace.ContextWithSpan(req.Context(), span)
slot, err := strconv.ParseUint(vars["slot"], 10, 64)
if err != nil {
m.respondErrorWithLog(w, http.StatusBadRequest, errInvalidSlot.Error(), log.WithError(err), "")
return
}
slotStartTimestamp := m.genesisInfo.Data.GenesisTime + (slot * 12)
msIntoSlot := start.UnixMilli() - int64(slotStartTimestamp*1000)
if m.getHeaderRequestCutoffMs > 0 && msIntoSlot > int64(m.getHeaderRequestCutoffMs) {
log.Info("too late into slot")
w.WriteHeader(http.StatusNoContent)
return
}
if len(pubkey) != 98 {
m.respondErrorWithLog(w, http.StatusBadRequest, errInvalidPubkey.Error(), log, fmt.Sprintf("pub key should be %d long", 98))
return
}
if len(parentHashHex) != 66 {
m.respondErrorWithLog(w, http.StatusBadRequest, errInvalidHash.Error(), log, fmt.Sprintf("parent hash hex should be %d long", 66))
return
}
if slot <= m.getHeaderLatestDisabledSlot.Load() {
log.Errorf("no header available, 'getHeader' requests disabled through slot %v, requested slot is %v", m.getHeaderLatestDisabledSlot.Load(), slot)
w.WriteHeader(http.StatusNoContent)
return
}
highestRankedRelay := new(string)
fetchGetHeaderStartTime := time.Now().UTC()
slotBestHeaderRaw, slotBestHeader, dataSource, err := m.datastore.GetGetHeaderResponse(spanContext, slot, parentHashHex, pubkey)
if slotBestHeader == nil || err != nil {
log.Errorf("no header available in datastore for slot: %v, parent hash: %v, proposer public key: %v, error: %v", slot, parentHashHex, pubkey, err)
w.WriteHeader(http.StatusNoContent)
return
}
if slotBestHeader.Capella == nil || slotBestHeader.Capella.Capella == nil || slotBestHeader.Capella.Capella.Message == nil || slotBestHeader.Capella.Capella.Message.Header == nil || slotBestHeader.Capella.Capella.Message.Header.BlockHash.String() == nilHash.String() {
log.Error("no bids received from relay")
w.WriteHeader(http.StatusNoContent)
return
}
fetchGetHeaderDurationMS := time.Since(fetchGetHeaderStartTime).Milliseconds()
log = log.WithFields(logrus.Fields{
"bid-header-withdrawalroot": slotBestHeader.Capella.Capella.Message.Header.WithdrawalsRoot.String(),
"bid-header-parenthash": slotBestHeader.Capella.Capella.Message.Header.ParentHash.String(),
"bid-header-blockhash": slotBestHeader.Capella.Capella.Message.Header.BlockHash.String(),
"bid-value": common.WeiToEth(slotBestHeader.Capella.Capella.Message.Value.ToBig().String()),
"bid-pubkey": slotBestHeader.Capella.Capella.Message.Pubkey.String(),
})
go func() {
ranking, ok := m.relayRankings.Load(*highestRankedRelay)
if !ok {
ranking = relayRanking{
HeaderRequests: 0,
HighestValueCount: 0,
}
}
ranking.HighestValueCount = ranking.HighestValueCount + 1
m.relayRankings.Store(*highestRankedRelay, ranking)
}()
go func() {
if m.stats.NodeID == "" {
return
}
mostProfitableBloxrouteBid, ok := m.bestBloxrouteBlockBidForSlot.Load(slot)
if !ok {
record := bestHeaderStatsRecord{
Data: slotBestHeader.Capella.Capella,
Slot: strconv.FormatUint(slot, 10),
ProposerPublicKey: pubkey,
IsBloxrouteBlock: m.isBloxrouteBlock(slotBestHeader.Capella.Capella.Message.Header.ExtraData),
BestBloxrouteValue: "0",
BestBloxrouteValueDiff: big.NewInt(0).Sub(big.NewInt(0), slotBestHeader.Capella.Capella.Message.Value.ToBig()).String(),