-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
simulated_backend_client.go
899 lines (782 loc) · 27.4 KB
/
simulated_backend_client.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
package client
import (
"bytes"
"context"
"errors"
"fmt"
"math/big"
"strings"
"testing"
"time"
"github.com/ethereum/go-ethereum"
"github.com/ethereum/go-ethereum/accounts/abi"
"github.com/ethereum/go-ethereum/accounts/abi/bind/backends"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/common/hexutil"
"github.com/ethereum/go-ethereum/core/types"
"github.com/ethereum/go-ethereum/rpc"
"github.com/smartcontractkit/chainlink-common/pkg/utils/hex"
"github.com/smartcontractkit/chainlink-common/pkg/assets"
"github.com/smartcontractkit/chainlink-common/pkg/logger"
commonclient "github.com/smartcontractkit/chainlink/v2/common/client"
evmtypes "github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"
ubig "github.com/smartcontractkit/chainlink/v2/core/chains/evm/utils/big"
)
func init() {
var err error
balanceOfABI, err = abi.JSON(strings.NewReader(balanceOfABIString))
if err != nil {
panic(fmt.Errorf("%w: while parsing erc20ABI", err))
}
}
var (
balanceOfABIString = `[
{
"constant": true,
"inputs": [
{
"name": "_owner",
"type": "address"
}
],
"name": "balanceOf",
"outputs": [
{
"name": "balance",
"type": "uint256"
}
],
"payable": false,
"stateMutability": "view",
"type": "function"
}
]`
balanceOfABI abi.ABI
)
// SimulatedBackendClient is an Client implementation using a simulated
// blockchain backend. Note that not all RPC methods are implemented here.
type SimulatedBackendClient struct {
b *backends.SimulatedBackend
t testing.TB
chainId *big.Int
}
// NewSimulatedBackendClient creates an eth client backed by a simulated backend.
func NewSimulatedBackendClient(t testing.TB, b *backends.SimulatedBackend, chainId *big.Int) *SimulatedBackendClient {
return &SimulatedBackendClient{
b: b,
t: t,
chainId: chainId,
}
}
// Dial noop for the sim.
func (c *SimulatedBackendClient) Dial(context.Context) error {
return nil
}
// Close does nothing. We ought not close the underlying backend here since
// other simulated clients might still be using it
func (c *SimulatedBackendClient) Close() {}
// CallContext mocks the ethereum client RPC calls used by chainlink, copying the
// return value into result.
// The simulated client avoids the old block error from the simulated backend by
// passing `nil` to `CallContract` when calling `CallContext` or `BatchCallContext`
// and will not return an error when an old block is used.
func (c *SimulatedBackendClient) CallContext(ctx context.Context, result interface{}, method string, args ...interface{}) error {
switch method {
case "eth_getTransactionReceipt":
return c.ethGetTransactionReceipt(ctx, result, args...)
case "eth_getBlockByNumber":
return c.ethGetBlockByNumber(ctx, result, args...)
case "eth_call":
return c.ethCall(ctx, result, args...)
case "eth_getHeaderByNumber":
return c.ethGetHeaderByNumber(ctx, result, args...)
case "eth_estimateGas":
return c.ethEstimateGas(ctx, result, args...)
default:
return fmt.Errorf("second arg to SimulatedBackendClient.Call is an RPC API method which has not yet been implemented: %s. Add processing for it here", method)
}
}
// FilterLogs returns all logs that respect the passed filter query.
func (c *SimulatedBackendClient) FilterLogs(ctx context.Context, q ethereum.FilterQuery) (logs []types.Log, err error) {
return c.b.FilterLogs(ctx, q)
}
// SubscribeFilterLogs registers a subscription for push notifications of logs
// from a given address.
func (c *SimulatedBackendClient) SubscribeFilterLogs(ctx context.Context, q ethereum.FilterQuery, channel chan<- types.Log) (ethereum.Subscription, error) {
return c.b.SubscribeFilterLogs(ctx, q, channel)
}
// currentBlockNumber returns index of *pending* block in simulated blockchain
func (c *SimulatedBackendClient) currentBlockNumber() *big.Int {
return c.b.Blockchain().CurrentBlock().Number
}
func (c *SimulatedBackendClient) finalizedBlockNumber() *big.Int {
return c.b.Blockchain().CurrentFinalBlock().Number
}
func (c *SimulatedBackendClient) TokenBalance(ctx context.Context, address common.Address, contractAddress common.Address) (balance *big.Int, err error) {
callData, err := balanceOfABI.Pack("balanceOf", address)
if err != nil {
return nil, fmt.Errorf("%w: while seeking the ERC20 balance of %s on %s", err,
address, contractAddress)
}
b, err := c.b.CallContract(ctx, ethereum.CallMsg{
To: &contractAddress, Data: callData},
c.currentBlockNumber())
if err != nil {
return nil, fmt.Errorf("%w: while calling ERC20 balanceOf method on %s "+
"for balance of %s", err, contractAddress, address)
}
err = balanceOfABI.UnpackIntoInterface(balance, "balanceOf", b)
if err != nil {
return nil, fmt.Errorf("unable to unpack balance")
}
return balance, nil
}
// GetLINKBalance get link balance.
func (c *SimulatedBackendClient) LINKBalance(ctx context.Context, address common.Address, linkAddress common.Address) (*assets.Link, error) {
panic("not implemented")
}
// TransactionReceipt returns the transaction receipt for the given transaction hash.
func (c *SimulatedBackendClient) TransactionReceipt(ctx context.Context, receipt common.Hash) (*types.Receipt, error) {
return c.b.TransactionReceipt(ctx, receipt)
}
func (c *SimulatedBackendClient) TransactionByHash(ctx context.Context, txHash common.Hash) (tx *types.Transaction, err error) {
tx, _, err = c.b.TransactionByHash(ctx, txHash)
return
}
func (c *SimulatedBackendClient) blockNumber(number interface{}) (blockNumber *big.Int, err error) {
switch n := number.(type) {
case string:
switch n {
case "latest":
return c.currentBlockNumber(), nil
case "earliest":
return big.NewInt(0), nil
case "pending":
panic("pending block not supported by simulated backend client") // I don't understand the semantics of this.
// return big.NewInt(0).Add(c.currentBlockNumber(), big.NewInt(1)), nil
case "finalized":
return c.finalizedBlockNumber(), nil
default:
blockNumber, err := hexutil.DecodeBig(n)
if err != nil {
return nil, fmt.Errorf("%w: while parsing '%s' as hex-encoded block number", err, n)
}
return blockNumber, nil
}
case *big.Int:
if n == nil {
return nil, nil
}
if n.Sign() < 0 {
return nil, fmt.Errorf("block number must be non-negative")
}
return n, nil
default:
return nil, fmt.Errorf("invalid type %T for block number, must be string or *big.Int", n)
}
}
// HeadByNumber returns our own header type.
func (c *SimulatedBackendClient) HeadByNumber(ctx context.Context, n *big.Int) (*evmtypes.Head, error) {
if n == nil {
n = c.currentBlockNumber()
}
header, err := c.b.HeaderByNumber(ctx, n)
if err != nil {
return nil, err
} else if header == nil {
return nil, ethereum.NotFound
}
return &evmtypes.Head{
EVMChainID: ubig.NewI(c.chainId.Int64()),
Hash: header.Hash(),
Number: header.Number.Int64(),
ParentHash: header.ParentHash,
Timestamp: time.Unix(int64(header.Time), 0),
}, nil
}
// HeadByHash returns our own header type.
func (c *SimulatedBackendClient) HeadByHash(ctx context.Context, h common.Hash) (*evmtypes.Head, error) {
header, err := c.b.HeaderByHash(ctx, h)
if err != nil {
return nil, err
} else if header == nil {
return nil, ethereum.NotFound
}
return &evmtypes.Head{
EVMChainID: ubig.NewI(c.chainId.Int64()),
Hash: header.Hash(),
Number: header.Number.Int64(),
ParentHash: header.ParentHash,
Timestamp: time.Unix(int64(header.Time), 0),
}, nil
}
// BlockByNumber returns a geth block type.
func (c *SimulatedBackendClient) BlockByNumber(ctx context.Context, n *big.Int) (*types.Block, error) {
return c.b.BlockByNumber(ctx, n)
}
// BlockByNumber returns a geth block type.
func (c *SimulatedBackendClient) BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) {
return c.b.BlockByHash(ctx, hash)
}
func (c *SimulatedBackendClient) LatestBlockHeight(ctx context.Context) (*big.Int, error) {
header, err := c.b.HeaderByNumber(ctx, nil)
return header.Number, err
}
// ChainID returns the ethereum ChainID.
func (c *SimulatedBackendClient) ConfiguredChainID() *big.Int {
return c.chainId
}
// ChainID RPC call
func (c *SimulatedBackendClient) ChainID() (*big.Int, error) {
panic("not implemented")
}
// PendingNonceAt gets pending nonce i.e. mempool nonce.
func (c *SimulatedBackendClient) PendingNonceAt(ctx context.Context, account common.Address) (uint64, error) {
return c.b.PendingNonceAt(ctx, account)
}
// NonceAt gets nonce as of a specified block.
func (c *SimulatedBackendClient) SequenceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (evmtypes.Nonce, error) {
nonce, err := c.b.NonceAt(ctx, account, blockNumber)
return evmtypes.Nonce(nonce), err
}
// BalanceAt gets balance as of a specified block.
func (c *SimulatedBackendClient) BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error) {
return c.b.BalanceAt(ctx, account, blockNumber)
}
type headSubscription struct {
unSub chan chan struct{}
subscription ethereum.Subscription
}
var _ ethereum.Subscription = (*headSubscription)(nil)
func (h *headSubscription) Unsubscribe() {
done := make(chan struct{})
h.unSub <- done
<-done
}
// Err returns err channel
func (h *headSubscription) Err() <-chan error { return h.subscription.Err() }
// SubscribeNewHead registers a subscription for push notifications of new blocks.
// Note the sim's API only accepts types.Head so we have this goroutine
// to convert those into evmtypes.Head.
func (c *SimulatedBackendClient) SubscribeNewHead(
ctx context.Context,
channel chan<- *evmtypes.Head,
) (ethereum.Subscription, error) {
subscription := &headSubscription{unSub: make(chan chan struct{})}
ch := make(chan *types.Header)
var err error
subscription.subscription, err = c.b.SubscribeNewHead(ctx, ch)
if err != nil {
return nil, fmt.Errorf("%w: could not subscribe to new heads on "+
"simulated backend", err)
}
go func() {
var lastHead *evmtypes.Head
for {
select {
case h := <-ch:
var head *evmtypes.Head
if h != nil {
head = &evmtypes.Head{Difficulty: h.Difficulty, Timestamp: time.Unix(int64(h.Time), 0), Number: h.Number.Int64(), Hash: h.Hash(), ParentHash: h.ParentHash, Parent: lastHead, EVMChainID: ubig.New(c.chainId)}
lastHead = head
}
select {
case channel <- head:
case done := <-subscription.unSub:
subscription.subscription.Unsubscribe()
close(done)
return
}
case done := <-subscription.unSub:
subscription.subscription.Unsubscribe()
close(done)
return
}
}
}()
return subscription, err
}
// HeaderByNumber returns the geth header type.
func (c *SimulatedBackendClient) HeaderByNumber(ctx context.Context, n *big.Int) (*types.Header, error) {
return c.b.HeaderByNumber(ctx, n)
}
func (c *SimulatedBackendClient) HeaderByHash(ctx context.Context, h common.Hash) (*types.Header, error) {
return c.b.HeaderByHash(ctx, h)
}
func (c *SimulatedBackendClient) SendTransactionReturnCode(ctx context.Context, tx *types.Transaction, fromAddress common.Address) (commonclient.SendTxReturnCode, error) {
err := c.SendTransaction(ctx, tx)
if err == nil {
return commonclient.Successful, nil
}
if strings.Contains(err.Error(), "could not fetch parent") || strings.Contains(err.Error(), "invalid transaction") {
return commonclient.Fatal, err
}
// All remaining error messages returned from SendTransaction are considered Unknown.
return commonclient.Unknown, err
}
// SendTransaction sends a transaction.
func (c *SimulatedBackendClient) SendTransaction(ctx context.Context, tx *types.Transaction) error {
sender, err := types.Sender(types.NewLondonSigner(c.chainId), tx)
if err != nil {
logger.Test(c.t).Panic(fmt.Errorf("invalid transaction: %v (tx: %#v)", err, tx))
}
pendingNonce, err := c.b.PendingNonceAt(ctx, sender)
if err != nil {
panic(fmt.Errorf("unable to determine nonce for account %s: %v", sender.Hex(), err))
}
// the simulated backend does not gracefully handle tx rebroadcasts (gas bumping) so just
// ignore the situation where nonces are reused
// github.com/ethereum/go-ethereum/blob/fb2c79df1995b4e8dfe79f9c75464d29d23aaaf4/accounts/abi/bind/backends/simulated.go#L556
if tx.Nonce() < pendingNonce {
return nil
}
err = c.b.SendTransaction(ctx, tx)
return err
}
type revertError struct {
error
reason string
}
func (e *revertError) ErrorCode() int {
return 3
}
// ErrorData returns the hex encoded revert reason.
func (e *revertError) ErrorData() interface{} {
return e.reason
}
var _ rpc.DataError = &revertError{}
// CallContract calls a contract.
func (c *SimulatedBackendClient) CallContract(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error) {
// Expected error is
// type JsonError struct {
// Code int `json:"code"`
// Message string `json:"message"`
// Data interface{} `json:"data,omitempty"`
//}
res, err := c.b.CallContract(ctx, msg, blockNumber)
if err != nil {
dataErr := revertError{}
if errors.Is(err, &dataErr) {
return nil, &JsonError{Data: dataErr.ErrorData(), Message: dataErr.Error(), Code: 3}
}
// Generic revert, no data
return nil, &JsonError{Data: []byte{}, Message: err.Error(), Code: 3}
}
return res, nil
}
func (c *SimulatedBackendClient) PendingCallContract(ctx context.Context, msg ethereum.CallMsg) ([]byte, error) {
// Expected error is
// type JsonError struct {
// Code int `json:"code"`
// Message string `json:"message"`
// Data interface{} `json:"data,omitempty"`
//}
res, err := c.b.PendingCallContract(ctx, msg)
if err != nil {
dataErr := revertError{}
if errors.Is(err, &dataErr) {
return nil, &JsonError{Data: dataErr.ErrorData(), Message: dataErr.Error(), Code: 3}
}
// Generic revert, no data
return nil, &JsonError{Data: []byte{}, Message: err.Error(), Code: 3}
}
return res, nil
}
// CodeAt gets the code associated with an account as of a specified block.
func (c *SimulatedBackendClient) CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error) {
return c.b.CodeAt(ctx, account, blockNumber)
}
// PendingCodeAt gets the latest code.
func (c *SimulatedBackendClient) PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error) {
return c.b.PendingCodeAt(ctx, account)
}
// EstimateGas estimates gas for a msg.
func (c *SimulatedBackendClient) EstimateGas(ctx context.Context, call ethereum.CallMsg) (gas uint64, err error) {
return c.b.EstimateGas(ctx, call)
}
// SuggestGasPrice recommends a gas price.
func (c *SimulatedBackendClient) SuggestGasPrice(ctx context.Context) (*big.Int, error) {
panic("unimplemented")
}
// BatchCallContext makes a batch rpc call.
// The simulated client avoids the old block error from the simulated backend by
// passing `nil` to `CallContract` when calling `CallContext` or `BatchCallContext`
// and will not return an error when an old block is used.
func (c *SimulatedBackendClient) BatchCallContext(ctx context.Context, b []rpc.BatchElem) error {
select {
case <-ctx.Done():
return errors.New("context canceled")
default:
//do nothing
}
for i, elem := range b {
var method func(context.Context, interface{}, ...interface{}) error
switch elem.Method {
case "eth_getTransactionReceipt":
method = c.ethGetTransactionReceipt
case "eth_getBlockByNumber":
method = c.ethGetBlockByNumber
case "eth_call":
method = c.ethCall
case "eth_getHeaderByNumber":
method = c.ethGetHeaderByNumber
case "eth_estimateGas":
method = c.ethEstimateGas
case "eth_getLogs":
method = c.ethGetLogs
default:
return fmt.Errorf("SimulatedBackendClient got unsupported method %s", elem.Method)
}
b[i].Error = method(ctx, b[i].Result, b[i].Args...)
}
return nil
}
// BatchCallContextAll makes a batch rpc call.
func (c *SimulatedBackendClient) BatchCallContextAll(ctx context.Context, b []rpc.BatchElem) error {
return c.BatchCallContext(ctx, b)
}
// SuggestGasTipCap suggests a gas tip cap.
func (c *SimulatedBackendClient) SuggestGasTipCap(ctx context.Context) (tipCap *big.Int, err error) {
return c.b.SuggestGasTipCap(ctx)
}
func (c *SimulatedBackendClient) Backend() *backends.SimulatedBackend {
return c.b
}
// NodeStates implements evmclient.Client
func (c *SimulatedBackendClient) NodeStates() map[string]string { return nil }
// Commit imports all the pending transactions as a single block and starts a
// fresh new state.
func (c *SimulatedBackendClient) Commit() common.Hash {
return c.b.Commit()
}
func (c *SimulatedBackendClient) IsL2() bool {
return false
}
func (c *SimulatedBackendClient) fetchHeader(ctx context.Context, blockNumOrTag string) (*types.Header, error) {
switch blockNumOrTag {
case rpc.SafeBlockNumber.String():
return c.b.Blockchain().CurrentSafeBlock(), nil
case rpc.LatestBlockNumber.String():
return c.b.Blockchain().CurrentHeader(), nil
case rpc.FinalizedBlockNumber.String():
return c.b.Blockchain().CurrentFinalBlock(), nil
default:
blockNum, ok := new(big.Int).SetString(blockNumOrTag, 0)
if !ok {
return nil, fmt.Errorf("error while converting block number string: %s to big.Int ", blockNumOrTag)
}
return c.b.HeaderByNumber(ctx, blockNum)
}
}
func (c *SimulatedBackendClient) ethGetTransactionReceipt(ctx context.Context, result interface{}, args ...interface{}) error {
if len(args) != 1 {
return fmt.Errorf("SimulatedBackendClient expected 1 arg, got %d for eth_getTransactionReceipt", len(args))
}
hash, is := args[0].(common.Hash)
if !is {
return fmt.Errorf("SimulatedBackendClient expected arg to be a hash, got: %T", args[0])
}
receipt, err := c.b.TransactionReceipt(ctx, hash)
if err != nil {
return err
}
// strongly typing the result here has the consequence of not being flexible in
// custom types where a real-world RPC client would allow for custom types with
// custom marshalling.
switch typed := result.(type) {
case *types.Receipt:
*typed = *receipt
case *evmtypes.Receipt:
*typed = *evmtypes.FromGethReceipt(receipt)
default:
return fmt.Errorf("SimulatedBackendClient expected return type of *evmtypes.Receipt for eth_getTransactionReceipt, got type %T", result)
}
return nil
}
func (c *SimulatedBackendClient) ethGetBlockByNumber(ctx context.Context, result interface{}, args ...interface{}) error {
if len(args) != 2 {
return fmt.Errorf("SimulatedBackendClient expected 2 args, got %d for eth_getBlockByNumber", len(args))
}
blockNumOrTag, is := args[0].(string)
if !is {
return fmt.Errorf("SimulatedBackendClient expected first arg to be a string for eth_getBlockByNumber, got: %T", args[0])
}
_, is = args[1].(bool)
if !is {
return fmt.Errorf("SimulatedBackendClient expected second arg to be a boolean for eth_getBlockByNumber, got: %T", args[1])
}
header, err := c.fetchHeader(ctx, blockNumOrTag)
if err != nil {
return err
}
switch res := result.(type) {
case *evmtypes.Head:
res.Number = header.Number.Int64()
res.Hash = header.Hash()
res.ParentHash = header.ParentHash
res.Timestamp = time.Unix(int64(header.Time), 0).UTC()
case *evmtypes.Block:
res.Number = header.Number.Int64()
res.Hash = header.Hash()
res.ParentHash = header.ParentHash
res.Timestamp = time.Unix(int64(header.Time), 0).UTC()
default:
return fmt.Errorf("SimulatedBackendClient Unexpected Type %T", res)
}
return nil
}
func (c *SimulatedBackendClient) ethEstimateGas(ctx context.Context, result interface{}, args ...interface{}) error {
if len(args) != 2 {
return fmt.Errorf("SimulatedBackendClient expected 2 args, got %d for eth_estimateGas", len(args))
}
params, ok := args[0].(map[string]interface{})
if !ok {
return fmt.Errorf("SimulatedBackendClient expected first arg to be map[string]interface{} for eth_call, got: %T", args[0])
}
_, err := c.blockNumber(args[1])
if err != nil {
return fmt.Errorf("SimulatedBackendClient expected second arg to be the string 'latest' or a *big.Int for eth_call, got: %T", args[1])
}
resp, err := c.b.EstimateGas(ctx, toCallMsg(params))
if err != nil {
return err
}
switch typedResult := result.(type) {
case *uint64:
*typedResult = resp
case *hexutil.Uint64:
*typedResult = hexutil.Uint64(resp)
default:
return fmt.Errorf("SimulatedBackendClient unexpected type %T", result)
}
return nil
}
func (c *SimulatedBackendClient) ethCall(ctx context.Context, result interface{}, args ...interface{}) error {
if len(args) != 2 {
return fmt.Errorf("SimulatedBackendClient expected 2 args, got %d for eth_call", len(args))
}
params, ok := args[0].(map[string]interface{})
if !ok {
return fmt.Errorf("SimulatedBackendClient expected first arg to be map[string]interface{} for eth_call, got: %T", args[0])
}
if _, err := c.blockNumber(args[1]); err != nil {
return fmt.Errorf("SimulatedBackendClient expected second arg to be the string 'latest' or a *big.Int for eth_call, got: %T", args[1])
}
resp, err := c.b.CallContract(ctx, toCallMsg(params), nil /* always latest block on simulated backend */)
if err != nil {
return err
}
switch typedResult := result.(type) {
case *hexutil.Bytes:
*typedResult = append(*typedResult, resp...)
if !bytes.Equal(*typedResult, resp) {
return fmt.Errorf("SimulatedBackendClient was passed a non-empty array, or failed to copy answer. Expected %x = %x", *typedResult, resp)
}
case *string:
*typedResult = hexutil.Encode(resp)
default:
return fmt.Errorf("SimulatedBackendClient unexpected type %T", result)
}
return nil
}
func (c *SimulatedBackendClient) ethGetHeaderByNumber(ctx context.Context, result interface{}, args ...interface{}) error {
if len(args) != 1 {
return fmt.Errorf("SimulatedBackendClient expected 1 arg, got %d for eth_getHeaderByNumber", len(args))
}
blockNumber, err := c.blockNumber(args[0])
if err != nil {
return fmt.Errorf("SimulatedBackendClient expected first arg to be a string for eth_getHeaderByNumber: %w", err)
}
header, err := c.b.HeaderByNumber(ctx, blockNumber)
if err != nil {
return err
}
switch typedResult := result.(type) {
case *types.Header:
*typedResult = *header
default:
return fmt.Errorf("SimulatedBackendClient unexpected Type %T", typedResult)
}
return nil
}
func (c *SimulatedBackendClient) LatestFinalizedBlock(ctx context.Context) (*evmtypes.Head, error) {
block := c.b.Blockchain().CurrentFinalBlock()
return &evmtypes.Head{
EVMChainID: ubig.NewI(c.chainId.Int64()),
Hash: block.Hash(),
Number: block.Number.Int64(),
ParentHash: block.ParentHash,
Timestamp: time.Unix(int64(block.Time), 0),
}, nil
}
func (c *SimulatedBackendClient) ethGetLogs(ctx context.Context, result interface{}, args ...interface{}) error {
var from, to *big.Int
var hash *common.Hash
var err error
var addresses []common.Address
var topics [][]common.Hash
params := args[0].(map[string]interface{})
if blockHash, ok := params["blockHash"]; ok {
hash, err = interfaceToHash(blockHash)
if err != nil {
return fmt.Errorf("SimultaedBackendClient received unexpected 'blockhash' param: %w", err)
}
}
if fromBlock, ok := params["fromBlock"]; ok {
from, err = c.blockNumber(fromBlock)
if err != nil {
return fmt.Errorf("SimulatedBackendClient expected 'fromBlock' to be a string: %w", err)
}
}
if toBlock, ok := params["toBlock"]; ok {
to, err = c.blockNumber(toBlock)
if err != nil {
return fmt.Errorf("SimulatedBackendClient expected 'toBlock' to be a string: %w", err)
}
}
if a, ok := params["addresses"]; ok {
addresses = a.([]common.Address)
}
if t, ok := params["topics"]; ok {
tt := t.([][]common.Hash)
lastTopic := len(tt) - 1
for lastTopic >= 0 {
if tt[lastTopic] != nil {
break
}
lastTopic--
}
// lastTopic is the topic index of the last non-nil topic slice
// We have to drop any nil values in the topics slice after that due to a quirk in FilterLogs(),
// which will only use nil as a wildcard if there are non-nil values after it in the slice
for i := 0; i < lastTopic; i++ {
topics = append(topics, tt[i])
}
}
query := ethereum.FilterQuery{
BlockHash: hash,
FromBlock: from,
ToBlock: to,
Addresses: addresses,
Topics: topics,
}
logs, err := c.b.FilterLogs(ctx, query)
if err != nil {
return err
}
switch r := result.(type) {
case *[]types.Log:
*r = logs
return nil
default:
return fmt.Errorf("SimulatedBackendClient unexpected Type %T", r)
}
}
func (c *SimulatedBackendClient) CheckTxValidity(ctx context.Context, from common.Address, to common.Address, data []byte) *SendError {
return nil
}
func toCallMsg(params map[string]interface{}) ethereum.CallMsg {
var callMsg ethereum.CallMsg
toAddr, err := interfaceToAddress(params["to"])
if err != nil {
panic(fmt.Errorf("unexpected 'to' parameter: %s", err))
}
callMsg.To = &toAddr
// from is optional in the standard client; default to 0x when missing
if value, ok := params["from"]; ok {
addr, err := interfaceToAddress(value)
if err != nil {
panic(fmt.Errorf("unexpected 'from' parameter: %s", err))
}
callMsg.From = addr
} else {
callMsg.From = common.HexToAddress("0x")
}
if params["data"] != nil && params["input"] != nil {
panic("cannot have both 'data' and 'input' parameters")
}
switch data := params["data"].(type) {
case nil:
// This parameter is not required so nil is acceptable
case hexutil.Bytes:
callMsg.Data = data
case []byte:
callMsg.Data = data
default:
panic("unexpected type of 'data' parameter; try hexutil.Bytes, []byte, or nil")
}
switch input := params["input"].(type) {
case nil:
// This parameter is not required so nil is acceptable
case hexutil.Bytes:
callMsg.Data = input
case []byte:
callMsg.Data = input
default:
panic("unexpected type of 'input' parameter; try hexutil.Bytes, []byte, or nil")
}
if value, ok := params["value"].(*big.Int); ok {
callMsg.Value = value
}
switch gas := params["gas"].(type) {
case nil:
// This parameter is not required so nil is acceptable
case uint64:
callMsg.Gas = gas
case hexutil.Uint64:
callMsg.Gas = uint64(gas)
default:
panic("unexpected type of 'gas' parameter; try hexutil.Uint64, or uint64")
}
switch gasPrice := params["gasPrice"].(type) {
case nil:
// This parameter is not required so nil is acceptable
case *big.Int:
callMsg.GasPrice = gasPrice
case *hexutil.Big:
callMsg.GasPrice = gasPrice.ToInt()
default:
panic("unexpected type of 'gasPrice' parameter; try *big.Int, or *hexutil.Big")
}
return callMsg
}
func interfaceToAddress(value interface{}) (common.Address, error) {
switch v := value.(type) {
case common.Address:
return v, nil
case *common.Address:
if v == nil {
return common.Address{}, nil
}
return *v, nil
case string:
if ok := common.IsHexAddress(v); !ok {
return common.Address{}, fmt.Errorf("string not formatted as a hex encoded evm address")
}
return common.HexToAddress(v), nil
case *big.Int:
if v.Uint64() > 0 || len(v.Bytes()) > 20 {
return common.Address{}, fmt.Errorf("invalid *big.Int; value must be larger than 0 with a byte length <= 20")
}
return common.BigToAddress(v), nil
default:
return common.Address{}, fmt.Errorf("unrecognized value type: %T for converting value to common.Address; use hex encoded string, *big.Int, or common.Address", v)
}
}
func interfaceToHash(value interface{}) (*common.Hash, error) {
switch v := value.(type) {
case common.Hash:
return &v, nil
case *common.Hash:
return v, nil
case string:
b, err := hex.DecodeString(v)
if err != nil || len(b) != 32 {
return nil, fmt.Errorf("string does not represent a 32-byte hexadecimal number")
}
h := common.Hash(b)
return &h, nil
default:
return nil, fmt.Errorf("unrecognized value type: %T for converting value to common.Hash; use hex encoded string or common.Hash", v)
}
}