-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbloXroute_apis.patch
More file actions
1996 lines (1843 loc) · 71.4 KB
/
Copy pathbloXroute_apis.patch
File metadata and controls
1996 lines (1843 loc) · 71.4 KB
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
From f8c054707e1eed4d32949f2c74bab15a37c8c091 Mon Sep 17 00:00:00 2001
From: Kevin Chen <kevin@bloxroute.com>
Date: Thu, 3 Feb 2022 15:50:52 -0600
Subject: [PATCH 1/7] Add config parameters for blxr_tx API/auth endpoints
---
cmd/geth/main.go | 2 ++
cmd/utils/flags.go | 28 ++++++++++++++++++++++++++++
eth/api_backend.go | 8 ++++++++
eth/ethconfig/config.go | 8 ++++++++
internal/ethapi/backend.go | 2 ++
les/api_backend.go | 8 ++++++++
6 files changed, 56 insertions(+)
diff --git a/cmd/geth/main.go b/cmd/geth/main.go
index a6f7b2d504be..62ada14d457b 100644
--- a/cmd/geth/main.go
+++ b/cmd/geth/main.go
@@ -184,6 +184,8 @@ var (
utils.RPCGlobalEVMTimeoutFlag,
utils.RPCGlobalTxFeeCapFlag,
utils.AllowUnprotectedTxs,
+ utils.BxAPIEndpointsFlag,
+ utils.BxAPIAuthHeaderFlag,
}
metricsFlags = []cli.Flag{
diff --git a/cmd/utils/flags.go b/cmd/utils/flags.go
index 57d9b87958ce..dd0319b2d4a0 100644
--- a/cmd/utils/flags.go
+++ b/cmd/utils/flags.go
@@ -794,6 +794,18 @@ var (
Name: "catalyst",
Usage: "Catalyst mode (eth2 integration testing)",
}
+
+ // bloXroute flags
+ BxAPIEndpointsFlag = cli.StringFlag{
+ Name: "bx.api.endpoints",
+ Usage: "Comma separated list of bloXroute RPC endpoints to send transactions to",
+ Value: "https://api.blxrbdn.com",
+ }
+
+ BxAPIAuthHeaderFlag = cli.StringFlag{
+ Name: "bx.api.auth",
+ Usage: "bloXroute account authorization header (see https://docs.bloxroute.com/apis/authorization-headers)",
+ }
)
// MakeDataDir retrieves the currently requested data directory, terminating
@@ -1059,6 +1071,21 @@ func setLes(ctx *cli.Context, cfg *ethconfig.Config) {
}
}
+func setBx(ctx *cli.Context, cfg *ethconfig.Config) {
+ if ctx.GlobalIsSet(BxAPIAuthHeaderFlag.Name) {
+ cfg.BxAPIAuthHeader = ctx.GlobalString(BxAPIAuthHeaderFlag.Name)
+
+ endpoints := SplitAndTrim(ctx.GlobalString(BxAPIEndpointsFlag.Name))
+ for _, endpoint := range endpoints {
+ if strings.HasPrefix(endpoint, "http") {
+ cfg.BxAPIEndpoints = append(cfg.BxAPIEndpoints, endpoint)
+ } else {
+ log.Error("Invalid bloXroute API endpoint, skipping", "endpoint", endpoint)
+ }
+ }
+ }
+}
+
// MakeDatabaseHandles raises out the number of allowed file handles per process
// for Geth and returns half of the allowance to assign to the database.
func MakeDatabaseHandles() int {
@@ -1496,6 +1523,7 @@ func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *ethconfig.Config) {
setMiner(ctx, &cfg.Miner)
setWhitelist(ctx, cfg)
setLes(ctx, cfg)
+ setBx(ctx, cfg)
// Cap the cache allowance and tune the garbage collector
mem, err := gopsutil.VirtualMemory()
diff --git a/eth/api_backend.go b/eth/api_backend.go
index 6577ac1e1af4..87b6e7b28d05 100644
--- a/eth/api_backend.go
+++ b/eth/api_backend.go
@@ -325,6 +325,14 @@ func (b *EthAPIBackend) RPCTxFeeCap() float64 {
return b.eth.config.RPCTxFeeCap
}
+func (b *EthAPIBackend) BxAPIEndpoints() []string {
+ return b.eth.config.BxAPIEndpoints
+}
+
+func (b *EthAPIBackend) BxAPIAuthHeader() string {
+ return b.eth.config.BxAPIAuthHeader
+}
+
func (b *EthAPIBackend) BloomStatus() (uint64, uint64) {
sections, _, _ := b.eth.bloomIndexer.Sections()
return params.BloomBitsBlocks, sections
diff --git a/eth/ethconfig/config.go b/eth/ethconfig/config.go
index 1dbd5a7f1fd8..29be1f5cf229 100644
--- a/eth/ethconfig/config.go
+++ b/eth/ethconfig/config.go
@@ -197,6 +197,14 @@ type Config struct {
// send-transction variants. The unit is ether.
RPCTxFeeCap float64
+ // BxAPIEndpoints is a list of blxr_tx RPC endpoints that should be forwarded to.
+ // This supports http/https endpoints.
+ BxAPIEndpoints []string
+
+ // BxAPIAuthHeader is the authentication header for submitting requests to blxr_tx.
+ // This field must be set (even "" for local gateways) for any forwarding.
+ BxAPIAuthHeader string
+
// Checkpoint is a hardcoded checkpoint which can be nil.
Checkpoint *params.TrustedCheckpoint `toml:",omitempty"`
diff --git a/internal/ethapi/backend.go b/internal/ethapi/backend.go
index bc60fb2a64f6..7ae10f964595 100644
--- a/internal/ethapi/backend.go
+++ b/internal/ethapi/backend.go
@@ -52,6 +52,8 @@ type Backend interface {
RPCEVMTimeout() time.Duration // global timeout for eth_call over rpc: DoS protection
RPCTxFeeCap() float64 // global tx fee cap for all transaction related APIs
UnprotectedAllowed() bool // allows only for EIP155 transactions.
+ BxAPIAuthHeader() string
+ BxAPIEndpoints() []string
// Blockchain API
SetHead(number uint64)
diff --git a/les/api_backend.go b/les/api_backend.go
index 11a9ca128aab..c3656e42f7fc 100644
--- a/les/api_backend.go
+++ b/les/api_backend.go
@@ -302,6 +302,14 @@ func (b *LesApiBackend) RPCTxFeeCap() float64 {
return b.eth.config.RPCTxFeeCap
}
+func (b *LesApiBackend) BxAPIEndpoints() []string {
+ return []string{}
+}
+
+func (b *LesApiBackend) BxAPIAuthHeader() string {
+ return ""
+}
+
func (b *LesApiBackend) BloomStatus() (uint64, uint64) {
if b.eth.bloomIndexer == nil {
return 0, 0
From a7225056f3b45efd66be4f860632ba2b23feca0f Mon Sep 17 00:00:00 2001
From: Kevin Chen <kevin@bloxroute.com>
Date: Thu, 3 Feb 2022 16:26:54 -0600
Subject: [PATCH 2/7] setup RPC clients to work with blxr RPC
---
cmd/bxrpc/main.go | 0
cmd/utils/flags.go | 20 ++++++++++--
eth/api_backend.go | 51 ++++++++++++++++++++++++++-----
eth/backend.go | 2 +-
eth/ethconfig/config.go | 3 +-
internal/ethapi/backend.go | 2 --
les/api_backend.go | 8 -----
rpc/client.go | 62 ++++++++++++++++++++++++--------------
rpc/client_test.go | 2 +-
rpc/handler.go | 22 +++++++-------
rpc/http.go | 26 ++++++++++------
rpc/json.go | 42 +++++++++++++-------------
rpc/subscription.go | 2 +-
rpc/subscription_test.go | 2 +-
rpc/types.go | 2 +-
rpc/websocket.go | 27 ++++++++++++-----
16 files changed, 173 insertions(+), 100 deletions(-)
create mode 100644 cmd/bxrpc/main.go
diff --git a/cmd/bxrpc/main.go b/cmd/bxrpc/main.go
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/cmd/utils/flags.go b/cmd/utils/flags.go
index dd0319b2d4a0..d3809329a3dc 100644
--- a/cmd/utils/flags.go
+++ b/cmd/utils/flags.go
@@ -19,11 +19,13 @@ package utils
import (
"crypto/ecdsa"
+ "errors"
"fmt"
"io"
"io/ioutil"
"math"
"math/big"
+ "net/url"
"os"
"path/filepath"
godebug "runtime/debug"
@@ -1077,10 +1079,22 @@ func setBx(ctx *cli.Context, cfg *ethconfig.Config) {
endpoints := SplitAndTrim(ctx.GlobalString(BxAPIEndpointsFlag.Name))
for _, endpoint := range endpoints {
- if strings.HasPrefix(endpoint, "http") {
- cfg.BxAPIEndpoints = append(cfg.BxAPIEndpoints, endpoint)
+ u, err := url.Parse(endpoint)
+
+ if err == nil {
+ switch u.Scheme {
+ case "http", "https", "ws", "wss":
+ default:
+ err = errors.New("invalid endpoint scheme (http/s, and ws/s only)")
+ cfg.BxAPIEndpoints = append(cfg.BxAPIEndpoints, u)
+ }
+ }
+
+ if err != nil {
+ log.Error("Invalid bloXroute API endpoint, skipping", "endpoint", endpoint, "err", err)
+ continue
} else {
- log.Error("Invalid bloXroute API endpoint, skipping", "endpoint", endpoint)
+ cfg.BxAPIEndpoints = append(cfg.BxAPIEndpoints, u)
}
}
}
diff --git a/eth/api_backend.go b/eth/api_backend.go
index 87b6e7b28d05..3069a91eb8bc 100644
--- a/eth/api_backend.go
+++ b/eth/api_backend.go
@@ -18,8 +18,10 @@ package eth
import (
"context"
+ "encoding/json"
"errors"
"math/big"
+ "net/http"
"time"
"github.com/ethereum/go-ethereum"
@@ -46,6 +48,19 @@ type EthAPIBackend struct {
allowUnprotectedTxs bool
eth *Ethereum
gpo *gasprice.Oracle
+ bxClients []*rpc.Client
+ bxAPIHeaders http.Header
+}
+
+func NewEthAPIBackend(extRPCEnabled bool, allowUnprotectedTxs bool, eth *Ethereum, gpo *gasprice.Oracle) *EthAPIBackend {
+ contentType := "application/json"
+ headers := make(http.Header, 3)
+ headers.Set("accept", contentType)
+ headers.Set("content-type", contentType)
+ headers.Set("authorization", eth.config.BxAPIAuthHeader)
+
+ b := &EthAPIBackend{extRPCEnabled: extRPCEnabled, allowUnprotectedTxs: allowUnprotectedTxs, eth: eth, gpo: gpo, bxAPIHeaders: headers}
+ return b
}
// ChainConfig returns the active chain configuration.
@@ -236,9 +251,37 @@ func (b *EthAPIBackend) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscri
}
func (b *EthAPIBackend) SendTx(ctx context.Context, signedTx *types.Transaction) error {
+ // TODO: send to blxr
+
return b.eth.txPool.AddLocal(signedTx)
}
+func (b *EthAPIBackend) sendTxToBxAPIs(ctx context.Context, signedTx *types.Transaction) error {
+
+ for _, endpoint := range b.eth.config.BxAPIEndpoints {
+ client, err := rpc.DialHTTPWithClientHeaders(endpoint, new(http.Client), b.bxAPIHeaders)
+ if err != nil {
+ return err
+ }
+
+ result := map[string]interface{}{}
+ request := map[string]interface{}{}
+ request["transaction"] = ""
+
+ serializedRequest, err := json.Marshal(request)
+ if err != nil {
+ return err
+ }
+
+ msg := client.NewMessageWithParams("blxr_tx", serializedRequest)
+ err = client.CallContextWithMessage(ctx, &result, msg)
+ if err != nil {
+ return err
+ }
+ }
+ return nil
+}
+
func (b *EthAPIBackend) GetPoolTransactions() (types.Transactions, error) {
pending := b.eth.txPool.Pending(false)
var txs types.Transactions
@@ -325,14 +368,6 @@ func (b *EthAPIBackend) RPCTxFeeCap() float64 {
return b.eth.config.RPCTxFeeCap
}
-func (b *EthAPIBackend) BxAPIEndpoints() []string {
- return b.eth.config.BxAPIEndpoints
-}
-
-func (b *EthAPIBackend) BxAPIAuthHeader() string {
- return b.eth.config.BxAPIAuthHeader
-}
-
func (b *EthAPIBackend) BloomStatus() (uint64, uint64) {
sections, _, _ := b.eth.bloomIndexer.Sections()
return params.BloomBitsBlocks, sections
diff --git a/eth/backend.go b/eth/backend.go
index 22535e0e2289..492777f50130 100644
--- a/eth/backend.go
+++ b/eth/backend.go
@@ -237,7 +237,7 @@ func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error) {
eth.miner = miner.New(eth, &config.Miner, chainConfig, eth.EventMux(), eth.engine, eth.isLocalBlock)
eth.miner.SetExtra(makeExtraData(config.Miner.ExtraData))
- eth.APIBackend = &EthAPIBackend{stack.Config().ExtRPCEnabled(), stack.Config().AllowUnprotectedTxs, eth, nil}
+ eth.APIBackend = NewEthAPIBackend(stack.Config().ExtRPCEnabled(), stack.Config().AllowUnprotectedTxs, eth, nil)
if eth.APIBackend.allowUnprotectedTxs {
log.Info("Unprotected transactions allowed")
}
diff --git a/eth/ethconfig/config.go b/eth/ethconfig/config.go
index 29be1f5cf229..1a52bbde131d 100644
--- a/eth/ethconfig/config.go
+++ b/eth/ethconfig/config.go
@@ -19,6 +19,7 @@ package ethconfig
import (
"math/big"
+ "net/url"
"os"
"os/user"
"path/filepath"
@@ -199,7 +200,7 @@ type Config struct {
// BxAPIEndpoints is a list of blxr_tx RPC endpoints that should be forwarded to.
// This supports http/https endpoints.
- BxAPIEndpoints []string
+ BxAPIEndpoints []*url.URL
// BxAPIAuthHeader is the authentication header for submitting requests to blxr_tx.
// This field must be set (even "" for local gateways) for any forwarding.
diff --git a/internal/ethapi/backend.go b/internal/ethapi/backend.go
index 7ae10f964595..bc60fb2a64f6 100644
--- a/internal/ethapi/backend.go
+++ b/internal/ethapi/backend.go
@@ -52,8 +52,6 @@ type Backend interface {
RPCEVMTimeout() time.Duration // global timeout for eth_call over rpc: DoS protection
RPCTxFeeCap() float64 // global tx fee cap for all transaction related APIs
UnprotectedAllowed() bool // allows only for EIP155 transactions.
- BxAPIAuthHeader() string
- BxAPIEndpoints() []string
// Blockchain API
SetHead(number uint64)
diff --git a/les/api_backend.go b/les/api_backend.go
index c3656e42f7fc..11a9ca128aab 100644
--- a/les/api_backend.go
+++ b/les/api_backend.go
@@ -302,14 +302,6 @@ func (b *LesApiBackend) RPCTxFeeCap() float64 {
return b.eth.config.RPCTxFeeCap
}
-func (b *LesApiBackend) BxAPIEndpoints() []string {
- return []string{}
-}
-
-func (b *LesApiBackend) BxAPIAuthHeader() string {
- return ""
-}
-
func (b *LesApiBackend) BloomStatus() (uint64, uint64) {
if b.eth.bloomIndexer == nil {
return 0, 0
diff --git a/rpc/client.go b/rpc/client.go
index d55af75545cd..422c6cd6f34a 100644
--- a/rpc/client.go
+++ b/rpc/client.go
@@ -122,18 +122,18 @@ func (cc *clientConn) close(err error, inflightReq *requestOp) {
}
type readOp struct {
- msgs []*jsonrpcMessage
+ msgs []*JSONRPCMessage
batch bool
}
type requestOp struct {
ids []json.RawMessage
err error
- resp chan *jsonrpcMessage // receives up to len(ids) responses
+ resp chan *JSONRPCMessage // receives up to len(ids) responses
sub *ClientSubscription // only set for EthSubscribe requests
}
-func (op *requestOp) wait(ctx context.Context, c *Client) (*jsonrpcMessage, error) {
+func (op *requestOp) wait(ctx context.Context, c *Client) (*JSONRPCMessage, error) {
select {
case <-ctx.Done():
// Send the timeout to dispatch so it can remove the request IDs.
@@ -290,14 +290,20 @@ func (c *Client) Call(result interface{}, method string, args ...interface{}) er
// The result must be a pointer so that package json can unmarshal into it. You
// can also pass nil, in which case the result is ignored.
func (c *Client) CallContext(ctx context.Context, result interface{}, method string, args ...interface{}) error {
- if result != nil && reflect.TypeOf(result).Kind() != reflect.Ptr {
- return fmt.Errorf("call result parameter must be pointer or nil interface: %v", result)
- }
- msg, err := c.newMessage(method, args...)
+ msg, err := c.NewMessage(method, args...)
if err != nil {
return err
}
- op := &requestOp{ids: []json.RawMessage{msg.ID}, resp: make(chan *jsonrpcMessage, 1)}
+ return c.CallContextWithMessage(ctx, result, msg)
+}
+
+// TODO:
+func (c *Client) CallContextWithMessage(ctx context.Context, result interface{}, msg *JSONRPCMessage) error {
+ if result != nil && reflect.TypeOf(result).Kind() != reflect.Ptr {
+ return fmt.Errorf("call result parameter must be pointer or nil interface: %v", result)
+ }
+ var err error
+ op := &requestOp{ids: []json.RawMessage{msg.ID}, resp: make(chan *JSONRPCMessage, 1)}
if c.isHTTP {
err = c.sendHTTP(ctx, op, msg)
@@ -344,15 +350,15 @@ func (c *Client) BatchCall(b []BatchElem) error {
// Note that batch calls may not be executed atomically on the server side.
func (c *Client) BatchCallContext(ctx context.Context, b []BatchElem) error {
var (
- msgs = make([]*jsonrpcMessage, len(b))
+ msgs = make([]*JSONRPCMessage, len(b))
byID = make(map[string]int, len(b))
)
op := &requestOp{
ids: make([]json.RawMessage, len(b)),
- resp: make(chan *jsonrpcMessage, len(b)),
+ resp: make(chan *JSONRPCMessage, len(b)),
}
for i, elem := range b {
- msg, err := c.newMessage(elem.Method, elem.Args...)
+ msg, err := c.NewMessage(elem.Method, elem.Args...)
if err != nil {
return err
}
@@ -370,7 +376,7 @@ func (c *Client) BatchCallContext(ctx context.Context, b []BatchElem) error {
// Wait for all responses to come back.
for n := 0; n < len(b) && err == nil; n++ {
- var resp *jsonrpcMessage
+ var resp *JSONRPCMessage
resp, err = op.wait(ctx, c)
if err != nil {
break
@@ -395,7 +401,7 @@ func (c *Client) BatchCallContext(ctx context.Context, b []BatchElem) error {
// Notify sends a notification, i.e. a method call that doesn't expect a response.
func (c *Client) Notify(ctx context.Context, method string, args ...interface{}) error {
op := new(requestOp)
- msg, err := c.newMessage(method, args...)
+ msg, err := c.NewMessage(method, args...)
if err != nil {
return err
}
@@ -443,13 +449,13 @@ func (c *Client) Subscribe(ctx context.Context, namespace string, channel interf
return nil, ErrNotificationsUnsupported
}
- msg, err := c.newMessage(namespace+subscribeMethodSuffix, args...)
+ msg, err := c.NewMessage(namespace+subscribeMethodSuffix, args...)
if err != nil {
return nil, err
}
op := &requestOp{
ids: []json.RawMessage{msg.ID},
- resp: make(chan *jsonrpcMessage),
+ resp: make(chan *JSONRPCMessage),
sub: newClientSubscription(c, namespace, chanVal),
}
@@ -464,15 +470,25 @@ func (c *Client) Subscribe(ctx context.Context, namespace string, channel interf
return op.sub, nil
}
-func (c *Client) newMessage(method string, paramsIn ...interface{}) (*jsonrpcMessage, error) {
- msg := &jsonrpcMessage{Version: vsn, ID: c.nextID(), Method: method}
- if paramsIn != nil { // prevent sending "params":null
- var err error
- if msg.Params, err = json.Marshal(paramsIn); err != nil {
- return nil, err
- }
+func (c *Client) NewMessage(method string, paramsIn ...interface{}) (*JSONRPCMessage, error) {
+ var (
+ params json.RawMessage
+ err error
+ )
+
+ if params, err = json.Marshal(paramsIn); err != nil {
+ return nil, err
+ }
+
+ return c.NewMessageWithParams(method, params), nil
+}
+
+func (c *Client) NewMessageWithParams(method string, params json.RawMessage) *JSONRPCMessage {
+ msg := &JSONRPCMessage{Version: vsn, ID: c.nextID(), Method: method}
+ if params != nil { // prevent sending "params":null
+ msg.Params = params
}
- return msg, nil
+ return msg
}
// send registers op with the dispatch loop, then sends msg on the connection.
diff --git a/rpc/client_test.go b/rpc/client_test.go
index fa6010bb199c..2c3012392f5a 100644
--- a/rpc/client_test.go
+++ b/rpc/client_test.go
@@ -383,7 +383,7 @@ type unsubscribeRecorder struct {
unsubscribes map[string]bool
}
-func (r *unsubscribeRecorder) readBatch() ([]*jsonrpcMessage, bool, error) {
+func (r *unsubscribeRecorder) readBatch() ([]*JSONRPCMessage, bool, error) {
if r.unsubscribes == nil {
r.unsubscribes = make(map[string]bool)
}
diff --git a/rpc/handler.go b/rpc/handler.go
index 488a29300a10..e04b378f5287 100644
--- a/rpc/handler.go
+++ b/rpc/handler.go
@@ -93,7 +93,7 @@ func newHandler(connCtx context.Context, conn jsonWriter, idgen func() ID, reg *
}
// handleBatch executes all messages in a batch and returns the responses.
-func (h *handler) handleBatch(msgs []*jsonrpcMessage) {
+func (h *handler) handleBatch(msgs []*JSONRPCMessage) {
// Emit error response for empty batches:
if len(msgs) == 0 {
h.startCallProc(func(cp *callProc) {
@@ -103,7 +103,7 @@ func (h *handler) handleBatch(msgs []*jsonrpcMessage) {
}
// Handle non-call messages first:
- calls := make([]*jsonrpcMessage, 0, len(msgs))
+ calls := make([]*JSONRPCMessage, 0, len(msgs))
for _, msg := range msgs {
if handled := h.handleImmediate(msg); !handled {
calls = append(calls, msg)
@@ -114,7 +114,7 @@ func (h *handler) handleBatch(msgs []*jsonrpcMessage) {
}
// Process calls on a goroutine because they may block indefinitely:
h.startCallProc(func(cp *callProc) {
- answers := make([]*jsonrpcMessage, 0, len(msgs))
+ answers := make([]*JSONRPCMessage, 0, len(msgs))
for _, msg := range calls {
if answer := h.handleCallMsg(cp, msg); answer != nil {
answers = append(answers, answer)
@@ -131,7 +131,7 @@ func (h *handler) handleBatch(msgs []*jsonrpcMessage) {
}
// handleMsg handles a single message.
-func (h *handler) handleMsg(msg *jsonrpcMessage) {
+func (h *handler) handleMsg(msg *JSONRPCMessage) {
if ok := h.handleImmediate(msg); ok {
return
}
@@ -229,7 +229,7 @@ func (h *handler) startCallProc(fn func(*callProc)) {
// handleImmediate executes non-call messages. It returns false if the message is a
// call or requires a reply.
-func (h *handler) handleImmediate(msg *jsonrpcMessage) bool {
+func (h *handler) handleImmediate(msg *JSONRPCMessage) bool {
start := time.Now()
switch {
case msg.isNotification():
@@ -248,7 +248,7 @@ func (h *handler) handleImmediate(msg *jsonrpcMessage) bool {
}
// handleSubscriptionResult processes subscription notifications.
-func (h *handler) handleSubscriptionResult(msg *jsonrpcMessage) {
+func (h *handler) handleSubscriptionResult(msg *JSONRPCMessage) {
var result subscriptionResult
if err := json.Unmarshal(msg.Params, &result); err != nil {
h.log.Debug("Dropping invalid subscription message")
@@ -260,7 +260,7 @@ func (h *handler) handleSubscriptionResult(msg *jsonrpcMessage) {
}
// handleResponse processes method call responses.
-func (h *handler) handleResponse(msg *jsonrpcMessage) {
+func (h *handler) handleResponse(msg *JSONRPCMessage) {
op := h.respWait[string(msg.ID)]
if op == nil {
h.log.Debug("Unsolicited RPC response", "reqid", idForLog{msg.ID})
@@ -287,7 +287,7 @@ func (h *handler) handleResponse(msg *jsonrpcMessage) {
}
// handleCallMsg executes a call message and returns the answer.
-func (h *handler) handleCallMsg(ctx *callProc, msg *jsonrpcMessage) *jsonrpcMessage {
+func (h *handler) handleCallMsg(ctx *callProc, msg *JSONRPCMessage) *JSONRPCMessage {
start := time.Now()
switch {
case msg.isNotification():
@@ -316,7 +316,7 @@ func (h *handler) handleCallMsg(ctx *callProc, msg *jsonrpcMessage) *jsonrpcMess
}
// handleCall processes method calls.
-func (h *handler) handleCall(cp *callProc, msg *jsonrpcMessage) *jsonrpcMessage {
+func (h *handler) handleCall(cp *callProc, msg *JSONRPCMessage) *JSONRPCMessage {
if msg.isSubscribe() {
return h.handleSubscribe(cp, msg)
}
@@ -352,7 +352,7 @@ func (h *handler) handleCall(cp *callProc, msg *jsonrpcMessage) *jsonrpcMessage
}
// handleSubscribe processes *_subscribe method calls.
-func (h *handler) handleSubscribe(cp *callProc, msg *jsonrpcMessage) *jsonrpcMessage {
+func (h *handler) handleSubscribe(cp *callProc, msg *JSONRPCMessage) *JSONRPCMessage {
if !h.allowSubscribe {
return msg.errorResponse(ErrNotificationsUnsupported)
}
@@ -385,7 +385,7 @@ func (h *handler) handleSubscribe(cp *callProc, msg *jsonrpcMessage) *jsonrpcMes
}
// runMethod runs the Go callback for an RPC method.
-func (h *handler) runMethod(ctx context.Context, msg *jsonrpcMessage, callb *callback, args []reflect.Value) *jsonrpcMessage {
+func (h *handler) runMethod(ctx context.Context, msg *JSONRPCMessage, callb *callback, args []reflect.Value) *JSONRPCMessage {
result, err := callb.call(ctx, msg.Method, args)
if err != nil {
return msg.errorResponse(err)
diff --git a/rpc/http.go b/rpc/http.go
index 18404c060a86..3de41acf7126 100644
--- a/rpc/http.go
+++ b/rpc/http.go
@@ -64,7 +64,7 @@ func (hc *httpConn) remoteAddr() string {
return hc.url
}
-func (hc *httpConn) readBatch() ([]*jsonrpcMessage, bool, error) {
+func (hc *httpConn) readBatch() ([]*JSONRPCMessage, bool, error) {
<-hc.closeCh
return nil, false, io.EOF
}
@@ -109,9 +109,9 @@ var DefaultHTTPTimeouts = HTTPTimeouts{
IdleTimeout: 120 * time.Second,
}
-// DialHTTPWithClient creates a new RPC client that connects to an RPC server over HTTP
-// using the provided HTTP Client.
-func DialHTTPWithClient(endpoint string, client *http.Client) (*Client, error) {
+// DialHTTPWithClientHeaders create a new RPC client that connects to an RPC server over HTTP
+// using the provided HTTP Client and Headers.
+func DialHTTPWithClientHeaders(endpoint string, client *http.Client, headers http.Header) (*Client, error) {
// Sanity check URL so we don't end up with a client that will fail every request.
_, err := url.Parse(endpoint)
if err != nil {
@@ -119,9 +119,6 @@ func DialHTTPWithClient(endpoint string, client *http.Client) (*Client, error) {
}
initctx := context.Background()
- headers := make(http.Header, 2)
- headers.Set("accept", contentType)
- headers.Set("content-type", contentType)
return newClient(initctx, func(context.Context) (ServerCodec, error) {
hc := &httpConn{
client: client,
@@ -133,6 +130,15 @@ func DialHTTPWithClient(endpoint string, client *http.Client) (*Client, error) {
})
}
+// DialHTTPWithClient creates a new RPC client that connects to an RPC server over HTTP
+// using the provided HTTP Client.
+func DialHTTPWithClient(endpoint string, client *http.Client) (*Client, error) {
+ headers := make(http.Header, 2)
+ headers.Set("accept", contentType)
+ headers.Set("content-type", contentType)
+ return DialHTTPWithClientHeaders(endpoint, client, headers)
+}
+
// DialHTTP creates a new RPC client that connects to an RPC server over HTTP.
func DialHTTP(endpoint string) (*Client, error) {
return DialHTTPWithClient(endpoint, new(http.Client))
@@ -146,7 +152,7 @@ func (c *Client) sendHTTP(ctx context.Context, op *requestOp, msg interface{}) e
}
defer respBody.Close()
- var respmsg jsonrpcMessage
+ var respmsg JSONRPCMessage
if err := json.NewDecoder(respBody).Decode(&respmsg); err != nil {
return err
}
@@ -154,14 +160,14 @@ func (c *Client) sendHTTP(ctx context.Context, op *requestOp, msg interface{}) e
return nil
}
-func (c *Client) sendBatchHTTP(ctx context.Context, op *requestOp, msgs []*jsonrpcMessage) error {
+func (c *Client) sendBatchHTTP(ctx context.Context, op *requestOp, msgs []*JSONRPCMessage) error {
hc := c.writeConn.(*httpConn)
respBody, err := hc.doRequest(ctx, msgs)
if err != nil {
return err
}
defer respBody.Close()
- var respmsgs []jsonrpcMessage
+ var respmsgs []JSONRPCMessage
if err := json.NewDecoder(respBody).Decode(&respmsgs); err != nil {
return err
}
diff --git a/rpc/json.go b/rpc/json.go
index 6024f1e7dc9b..ad4d63ad7ab2 100644
--- a/rpc/json.go
+++ b/rpc/json.go
@@ -48,7 +48,7 @@ type subscriptionResult struct {
// A value of this type can a JSON-RPC request, notification, successful response or
// error response. Which one it is depends on the fields.
-type jsonrpcMessage struct {
+type JSONRPCMessage struct {
Version string `json:"jsonrpc,omitempty"`
ID json.RawMessage `json:"id,omitempty"`
Method string `json:"method,omitempty"`
@@ -57,57 +57,57 @@ type jsonrpcMessage struct {
Result json.RawMessage `json:"result,omitempty"`
}
-func (msg *jsonrpcMessage) isNotification() bool {
+func (msg *JSONRPCMessage) isNotification() bool {
return msg.ID == nil && msg.Method != ""
}
-func (msg *jsonrpcMessage) isCall() bool {
+func (msg *JSONRPCMessage) isCall() bool {
return msg.hasValidID() && msg.Method != ""
}
-func (msg *jsonrpcMessage) isResponse() bool {
+func (msg *JSONRPCMessage) isResponse() bool {
return msg.hasValidID() && msg.Method == "" && msg.Params == nil && (msg.Result != nil || msg.Error != nil)
}
-func (msg *jsonrpcMessage) hasValidID() bool {
+func (msg *JSONRPCMessage) hasValidID() bool {
return len(msg.ID) > 0 && msg.ID[0] != '{' && msg.ID[0] != '['
}
-func (msg *jsonrpcMessage) isSubscribe() bool {
+func (msg *JSONRPCMessage) isSubscribe() bool {
return strings.HasSuffix(msg.Method, subscribeMethodSuffix)
}
-func (msg *jsonrpcMessage) isUnsubscribe() bool {
+func (msg *JSONRPCMessage) isUnsubscribe() bool {
return strings.HasSuffix(msg.Method, unsubscribeMethodSuffix)
}
-func (msg *jsonrpcMessage) namespace() string {
+func (msg *JSONRPCMessage) namespace() string {
elem := strings.SplitN(msg.Method, serviceMethodSeparator, 2)
return elem[0]
}
-func (msg *jsonrpcMessage) String() string {
+func (msg *JSONRPCMessage) String() string {
b, _ := json.Marshal(msg)
return string(b)
}
-func (msg *jsonrpcMessage) errorResponse(err error) *jsonrpcMessage {
+func (msg *JSONRPCMessage) errorResponse(err error) *JSONRPCMessage {
resp := errorMessage(err)
resp.ID = msg.ID
return resp
}
-func (msg *jsonrpcMessage) response(result interface{}) *jsonrpcMessage {
+func (msg *JSONRPCMessage) response(result interface{}) *JSONRPCMessage {
enc, err := json.Marshal(result)
if err != nil {
// TODO: wrap with 'internal server error'
return msg.errorResponse(err)
}
- return &jsonrpcMessage{Version: vsn, ID: msg.ID, Result: enc}
+ return &JSONRPCMessage{Version: vsn, ID: msg.ID, Result: enc}
}
-func errorMessage(err error) *jsonrpcMessage {
- msg := &jsonrpcMessage{Version: vsn, ID: null, Error: &jsonError{
+func errorMessage(err error) *JSONRPCMessage {
+ msg := &JSONRPCMessage{Version: vsn, ID: null, Error: &jsonError{
Code: defaultErrorCode,
Message: err.Error(),
}}
@@ -207,7 +207,7 @@ func (c *jsonCodec) remoteAddr() string {
return c.remote
}
-func (c *jsonCodec) readBatch() (messages []*jsonrpcMessage, batch bool, err error) {
+func (c *jsonCodec) readBatch() (messages []*JSONRPCMessage, batch bool, err error) {
// Decode the next JSON object in the input stream.
// This verifies basic syntax, etc.
var rawmsg json.RawMessage
@@ -219,7 +219,7 @@ func (c *jsonCodec) readBatch() (messages []*jsonrpcMessage, batch bool, err err
if msg == nil {
// Message is JSON 'null'. Replace with zero value so it
// will be treated like any other invalid message.
- messages[i] = new(jsonrpcMessage)
+ messages[i] = new(JSONRPCMessage)
}
}
return messages, batch, nil
@@ -252,18 +252,18 @@ func (c *jsonCodec) closed() <-chan interface{} {
// parseMessage parses raw bytes as a (batch of) JSON-RPC message(s). There are no error
// checks in this function because the raw message has already been syntax-checked when it
// is called. Any non-JSON-RPC messages in the input return the zero value of
-// jsonrpcMessage.
-func parseMessage(raw json.RawMessage) ([]*jsonrpcMessage, bool) {
+// JSONRPCMessage.
+func parseMessage(raw json.RawMessage) ([]*JSONRPCMessage, bool) {
if !isBatch(raw) {
- msgs := []*jsonrpcMessage{{}}
+ msgs := []*JSONRPCMessage{{}}
json.Unmarshal(raw, &msgs[0])
return msgs, false
}
dec := json.NewDecoder(bytes.NewReader(raw))
dec.Token() // skip '['
- var msgs []*jsonrpcMessage
+ var msgs []*JSONRPCMessage
for dec.More() {
- msgs = append(msgs, new(jsonrpcMessage))
+ msgs = append(msgs, new(JSONRPCMessage))
dec.Decode(&msgs[len(msgs)-1])
}
return msgs, true
diff --git a/rpc/subscription.go b/rpc/subscription.go
index 942e764e5d6c..c6e8424b9df4 100644
--- a/rpc/subscription.go
+++ b/rpc/subscription.go
@@ -175,7 +175,7 @@ func (n *Notifier) activate() error {
func (n *Notifier) send(sub *Subscription, data json.RawMessage) error {
params, _ := json.Marshal(&subscriptionResult{ID: string(sub.ID), Result: data})
ctx := context.Background()
- return n.h.conn.writeJSON(ctx, &jsonrpcMessage{
+ return n.h.conn.writeJSON(ctx, &JSONRPCMessage{
Version: vsn,
Method: n.namespace + notificationMethodSuffix,
Params: params,
diff --git a/rpc/subscription_test.go b/rpc/subscription_test.go
index 54a053dba805..264556cfe8c0 100644
--- a/rpc/subscription_test.go
+++ b/rpc/subscription_test.go
@@ -193,7 +193,7 @@ func waitForMessages(in *json.Decoder, successes chan subConfirmation, notificat
}
func readAndValidateMessage(in *json.Decoder) (*subConfirmation, *subscriptionResult, error) {
- var msg jsonrpcMessage
+ var msg JSONRPCMessage
if err := in.Decode(&msg); err != nil {
return nil, nil, fmt.Errorf("decode error: %v", err)
}
diff --git a/rpc/types.go b/rpc/types.go
index 959e383723bd..43de6069c083 100644
--- a/rpc/types.go
+++ b/rpc/types.go
@@ -41,7 +41,7 @@ type API struct {
// multiple go-routines concurrently.
type ServerCodec interface {
peerInfo() PeerInfo
- readBatch() (msgs []*jsonrpcMessage, isBatch bool, err error)
+ readBatch() (msgs []*JSONRPCMessage, isBatch bool, err error)
close()
jsonWriter
diff --git a/rpc/websocket.go b/rpc/websocket.go
index 28380d8aa4ae..2004e4504d5f 100644
--- a/rpc/websocket.go
+++ b/rpc/websocket.go
@@ -181,15 +181,13 @@ func parseOriginURL(origin string) (string, string, string, error) {
return scheme, hostname, port, nil
}
-// DialWebsocketWithDialer creates a new RPC client that communicates with a JSON-RPC server
-// that is listening on the given endpoint using the provided dialer.
-func DialWebsocketWithDialer(ctx context.Context, endpoint, origin string, dialer websocket.Dialer) (*Client, error) {
- endpoint, header, err := wsClientHeaders(endpoint, origin)
+func DialWebsocketWithDialerHeaders(ctx context.Context, endpoint, origin string, dialer websocket.Dialer, headers http.Header) (*Client, error) {
+ endpoint, _, err := wsClientHeaders(endpoint, origin)
if err != nil {
return nil, err
}
return newClient(ctx, func(ctx context.Context) (ServerCodec, error) {
- conn, resp, err := dialer.DialContext(ctx, endpoint, header)
+ conn, resp, err := dialer.DialContext(ctx, endpoint, headers)
if err != nil {
hErr := wsHandshakeError{err: err}
if resp != nil {
@@ -197,22 +195,35 @@ func DialWebsocketWithDialer(ctx context.Context, endpoint, origin string, diale
}
return nil, hErr
}
- return newWebsocketCodec(conn, endpoint, header), nil
+ return newWebsocketCodec(conn, endpoint, headers), nil
})
}
+// DialWebsocketWithDialer creates a new RPC client that communicates with a JSON-RPC server
+// that is listening on the given endpoint using the provided dialer.
+func DialWebsocketWithDialer(ctx context.Context, endpoint, origin string, dialer websocket.Dialer) (*Client, error) {
+ endpoint, header, err := wsClientHeaders(endpoint, origin)
+ if err != nil {
+ return nil, err
+ }
+ return DialWebsocketWithDialerHeaders(ctx, endpoint, origin, dialer, header)
+}
+
// DialWebsocket creates a new RPC client that communicates with a JSON-RPC server
// that is listening on the given endpoint.
//
// The context is used for the initial connection establishment. It does not
// affect subsequent interactions with the client.
func DialWebsocket(ctx context.Context, endpoint, origin string) (*Client, error) {
- dialer := websocket.Dialer{
+ return DialWebsocketWithDialer(ctx, endpoint, origin, WebsocketDialer())
+}
+
+func WebsocketDialer() websocket.Dialer {
+ return websocket.Dialer{
ReadBufferSize: wsReadBuffer,
WriteBufferSize: wsWriteBuffer,
WriteBufferPool: wsBufferPool,
}
- return DialWebsocketWithDialer(ctx, endpoint, origin, dialer)
}
func wsClientHeaders(endpoint, origin string) (string, http.Header, error) {
From 694888e5c0132fde5bb8b1cfa9b2a34c736d8777 Mon Sep 17 00:00:00 2001
From: Kevin Chen <kevin@bloxroute.com>
Date: Fri, 4 Feb 2022 14:53:47 -0600
Subject: [PATCH 3/7] send tx to bloxroute APIs as well
---
eth/api_backend.go | 69 ++++++++++++++++++++++++++++++++--------------
1 file changed, 48 insertions(+), 21 deletions(-)
diff --git a/eth/api_backend.go b/eth/api_backend.go
index 3069a91eb8bc..9efe244179c9 100644
--- a/eth/api_backend.go
+++ b/eth/api_backend.go
@@ -20,6 +20,8 @@ import (
"context"
"encoding/json"
"errors"
+ "github.com/ethereum/go-ethereum/common/hexutil"
+ "github.com/ethereum/go-ethereum/log"
"math/big"
"net/http"
"time"
@@ -49,17 +51,41 @@ type EthAPIBackend struct {
eth *Ethereum
gpo *gasprice.Oracle
bxClients []*rpc.Client
- bxAPIHeaders http.Header
}
func NewEthAPIBackend(extRPCEnabled bool, allowUnprotectedTxs bool, eth *Ethereum, gpo *gasprice.Oracle) *EthAPIBackend {
- contentType := "application/json"
- headers := make(http.Header, 3)
- headers.Set("accept", contentType)
- headers.Set("content-type", contentType)
- headers.Set("authorization", eth.config.BxAPIAuthHeader)
-
- b := &EthAPIBackend{extRPCEnabled: extRPCEnabled, allowUnprotectedTxs: allowUnprotectedTxs, eth: eth, gpo: gpo, bxAPIHeaders: headers}
+ b := &EthAPIBackend{extRPCEnabled: extRPCEnabled, allowUnprotectedTxs: allowUnprotectedTxs, eth: eth, gpo: gpo}
+
+ if eth.config.BxAPIAuthHeader != "" {
+ contentType := "application/json"
+ httpHeaders := make(http.Header, 3)
+ httpHeaders.Set("accept", contentType)
+ httpHeaders.Set("content-type", contentType)
+ httpHeaders.Set("authorization", eth.config.BxAPIAuthHeader)
+
+ wsHeaders := make(http.Header, 1)
+ wsHeaders.Set("authorization", eth.config.BxAPIAuthHeader)
+
+ for _, url := range eth.config.BxAPIEndpoints {
+ var (
+ client *rpc.Client
+ err error
+ )
+ switch url.Scheme {
+ case "http", "https":
+ client, err = rpc.DialHTTPWithClientHeaders(url.String(), new(http.Client), httpHeaders)
+ case "ws", "wss":
+ client, err = rpc.DialWebsocketWithDialerHeaders(context.Background(), url.String(), "", rpc.WebsocketDialer(), wsHeaders)
+ default:
+ err = errors.New("unknown URL scheme")
+ }