forked from alchemyplatform/docs-openapi-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
evm_responses.yaml
2291 lines (2233 loc) · 93.8 KB
/
evm_responses.yaml
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
eth_getLogs:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: array
description: 'Array of log objects, or an empty array if nothing has changed since last poll.'
items:
$ref: '#/log_object'
example:
$ref: "#/components/eth_getLogs"
eth_blockNumber:
allOf:
- $ref: '#/common_response_fields'
- type: object
description: Integer of the current block number the client is on.
properties:
result:
type: string
description: Integer of the current block number the client is on.
example:
$ref: "#/components/eth_blockNumber"
eth_block:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
$ref: '#/block_object'
example:
$ref: "#/components/eth_block"
block_object_arb:
type: object
properties:
number:
type: string
description: The block number. null when its pending block.
hash:
type: string
description: 32 Bytes - hash of the block. null when its pending block.
parentHash:
type: string
description: 32 Bytes - hash of the parent block.
nonce:
type: string
description: 8 Bytes - hash of the generated proof-of-work. null when its pending block.
sha3Uncles:
type: string
description: 32 Bytes - SHA3 of the uncles data in the block.
logsBloom:
type: string
description: 256 Bytes - the bloom filter for the logs of the block. null when its pending block.
transactionsRoot:
type: string
description: 32 Bytes - the root of the transaction trie of the block.
stateRoot:
type: string
description: 32 Bytes - the root of the final state trie of the block.
receiptsRoot:
type: string
description: 32 Bytes - the root of the receipts trie of the block.
miner:
type: string
description: 20 Bytes - the address of the beneficiary to whom the mining rewards were given.
difficulty:
type: string
description: Fixed at `0x1`
example: '0x1'
totalDifficulty:
type: string
description: Integer of the total difficulty of the chain until this block.
size:
type: string
description: Integer the size of this block in bytes.
extraData:
type: string
description: The Merkle root of the Outbox tree state - same as `sendRoot`.
example: '0x1992458362ac0d6c8e5f33d32a83edc9e7c53723d3f13dc3f41f710e2c2c5091'
gasLimit:
type: string
description: Value is fixed at `0x4000000000000`, but it's important to note that Arbitrum currently has a 32M gas limit per block
example: '0x4000000000000'
gasUsed:
type: string
description: The total used gas by all transactions in this block.
timestamp:
type: string
description: The unix timestamp for when the block was collated.
transactions:
type: array
description: Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
items:
type: string
uncles:
type: array
description: Array of uncle hashes.
items:
type: string
l1BlockNumber:
type: string
description: An approximate L1 block number hex string that occurred before this L2 block.
example: '0x1000755'
sendCount:
type: string
description: The hex-number of L2-to-L1 messages since Nitro genesis.
example: '0xdd2d'
sendRoot:
type: string
description: The Merkle root of the Outbox tree state.
example: '0x1992458362ac0d6c8e5f33d32a83edc9e7c53723d3f13dc3f41f710e2c2c5091'
mixHash:
type: string
description: First 8 bytes is equivalent to `sendCount`, second 8 bytes is equivalent to `l1BlockNumber`
example: '0x000000000000df4f00000000010036d5000000000000000a0000000000000000'
arb_block:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
$ref: '#/block_object_arb'
example:
$ref: ./evm_examples.yaml#/arb_block
log_object:
type: object
properties:
blockHash:
type: string
description: 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log
blockNumber:
type: string
description: The block number where this log was in. null when its pending. null when its pending log.
transactionIndex:
type: string
description: Integer of the transactions index position log was created from. null when its pending log.
address:
type: string
description: 20 Bytes - address from which this log originated.
logIndex:
type: string
description: Integer of the log index position in the block. null when its pending log.
data:
type: string
description: Contains one or more 32 Bytes non-indexed arguments of the log.
removed:
type: boolean
description: 'true when the log was removed, due to a chain reorganization. false if its a valid log.'
topics:
type: array
items:
type: string
description: 'Array of zero to four 32 Bytes DATA of indexed log arguments. In solidity: The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except you declare the event with the anonymous specifier.'
transactionHash:
type: string
description: Hash of the transactions this log was created from. null when its pending log.
block_object:
allOf:
- $ref: '#/nonce_hash_block'
- type: object
description: 'A block object with the following fields, or null when no block was found.'
properties:
baseFeePerGas:
type: string
description: the base fee, in wei, that is charged for each unit of gas used, during the execution of the given block, encoded as a hexadecimal.
number:
type: string
description: the block number. null when its pending block.
parentHash:
type: string
description: 32 Bytes - hash of the parent block.
sha3Uncles:
type: string
description: 32 Bytes - SHA3 of the uncles data in the block.
logsBloom:
type: string
description: 256 Bytes - the bloom filter for the logs of the block. null when its pending block.
transactionsRoot:
type: string
description: 32 Bytes - the root of the transaction trie of the block.
stateRoot:
type: string
description: 32 Bytes - the root of the final state trie of the block.
receiptsRoot:
type: string
description: 32 Bytes - the root of the receipts trie of the block.
miner:
type: string
description: 20 Bytes - the address of the beneficiary to whom the mining rewards were given.
difficulty:
type: string
description: integer of the difficulty for this block.
totalDifficulty:
type: string
description: integer of the total difficulty of the chain until this block.
extraData:
type: string
description: the "extra data" field of this block.
size:
type: string
description: integer the size of this block in bytes.
gasLimit:
type: string
description: the maximum gas allowed in this block.
gasUsed:
type: string
description: the total used gas by all transactions in this block.
timestamp:
type: string
description: the unix timestamp for when the block was collated.
transactions:
type: array
items:
type: string
description: 'Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.'
uncles:
type: array
items:
type: string
description: Array of uncle hashes.
common_response_fields:
type: object
properties:
id:
type: integer
jsonrpc:
type: string
hash_number_transactionIndex:
type: object
properties:
blockHash:
type: string
description: 32 Bytes - The hash of the block where the given transaction was included.
blockNumber:
type: string
description: The number of the block where the given transaction was included.
transactionIndex:
type: string
description: The index of the transaction within the block.
nonce_hash_block:
type: object
properties:
nonce:
type: string
description: 8 Bytes - hash of the generated proof-of-work. null when its pending block.
hash:
type: string
description: 32 Bytes - hash of the block. null when its pending block.
nonce_hash_txn:
type: object
properties:
nonce:
type: string
description: The number of transactions made by the sender prior to this one.
hash:
type: string
description: 32 Bytes - hash of the transaction.
eth_getTransactionByHash:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
description: 'A transaction object, or null when no transaction was found'
$ref: '#/transaction_object'
example:
$ref: "#/components/eth_getTransactionByHash"
eth_getTransactionByHash_arb:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
description: 'A transaction object, or null when no transaction was found'
$ref: '#/transaction_object_arb'
example:
$ref: ./evm_examples.yaml#/eth_getTransactionByHash_arb
transaction_object_arb:
allOf:
- $ref: '#/hash_number_transactionIndex'
- $ref: '#/nonce_hash_txn'
- type: object
properties:
from:
type: string
description: For L1-to-L2 related transactions, will be the aliased version of the L1's `msg.sender`.
gas:
type: string
description: gas provided by the sender
gasPrice:
type: string
description: gas price provided by the sender in Wei
input:
type: string
description: the data send along with the transaction
r:
type: string
description: ECDSA signature r
s:
type: string
description: ECDSA signature s
to:
type: string
description: 20 Bytes - address of the receiver. null when it's a contract creation transaction
v:
type: string
description: ECDSA recovery id
value:
type: string
description: value transferred in Wei
type:
type: string
description: |
Can also be one of the following codes, in addition to the standard transaction types:
- `100` - ArbitrumDepositTxType: A deposit of ETH from L1 to L2 via the Arbitrum bridge.
- `101` - ArbitrumUnsignedTxType: An L1 user can use to call an L2 contract via the bridge.
- `102` - ArbitrumContractTxType: Allows an L1 contract to call an L2 contract method via the bridge.
- `105` - ArbitrumSubmitRetryableTxType: Retryable tickets are submitted via the L1 bridge and allow arbitrary L1 to L2 messages to be created and executed on L2.
- `104` - ArbitrumRetryTxType: Used to redeem a retryable ticket on L2, which finalizes a retryable that failed to execute automatically (usually due to low gas).
- `106` - ArbitrumInternalTxType: Internal transactions created by the ArbOS itself for certain state updates, like L1 base fee and block number.
Standard transaction types:
- `0` - LegacyTransaction: A legacy transaction.
- `1` - AccessListTransaction: An EIP-2930 transaction.
- `2` - FeeMarketEIP1559Transaction: An EIP-1559 transaction.
requestId:
type: string
description: Added to L1-to-L2 transactions to indicate position in the `Inbox` queue.
transaction_object:
allOf:
- $ref: '#/hash_number_transactionIndex'
- $ref: '#/nonce_hash_txn'
- type: object
properties:
from:
type: string
description: 20 Bytes - address of the sender
gas:
type: string
description: gas provided by the sender
gasPrice:
type: string
description: gas price provided by the sender in Wei
input:
type: string
description: the data send along with the transaction
r:
type: string
description: ECDSA signature r
s:
type: string
description: ECDSA signature s
to:
type: string
description: 20 Bytes - address of the receiver. null when it's a contract creation transaction
v:
type: string
description: ECDSA recovery id
value:
type: string
description: value transferred in Wei
transaction_receipt:
description: 'A transaction receipt object, or null when no receipt was found'
allOf:
- $ref: '#/hash_number_transactionIndex'
- type: object
properties:
transactionHash:
type: string
description: 32 Bytes - hash of the transaction
from:
type: string
description: 20 Bytes - address of the sender
to:
type: string
description: 20 Bytes - address of the receiver. null when its a contract creation transaction
cumulativeGasUsed:
type: string
description: The total amount of gas used when this transaction was executed in the block.
gasUsed:
type: string
description: The amount of gas used by this specific transaction alone
contractAddress:
type: string
description: '20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null'
logs:
type: array
description: 'Array of log objects, which this transaction generated'
items:
$ref: '#/log_object'
logsBloom:
type: string
description: 256 Bytes - Bloom filter for light clients to quickly retrieve related logs
root:
type: string
description: 32 bytes of post-transaction stateroot. (pre Byzantium hard fork at block 4,370,000)
status:
type: integer
description: Either 1 (success) or 0 (failure). (post Byzantium hard fork at block 4,370,000)
enum:
- 0
- 1
effectiveGasPrice:
type: string
type:
type: string
transaction_receipt_zkevm:
description: 'A transaction receipt object, or null when no receipt was found'
allOf:
- $ref: '#/hash_number_transactionIndex'
- type: object
properties:
transactionHash:
type: string
description: 32 Bytes - hash of the transaction
from:
type: string
description: 20 Bytes - address of the sender
to:
type: string
description: 20 Bytes - address of the receiver. null when its a contract creation transaction
cumulativeGasUsed:
type: string
description: The total amount of gas used when this transaction was executed in the block.
gasUsed:
type: string
description: The amount of gas used by this specific transaction alone
contractAddress:
type: string
description: '20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null'
logs:
type: array
description: 'Array of log objects, which this transaction generated'
items:
$ref: '#/log_object'
logsBloom:
type: string
description: 256 Bytes - Bloom filter for light clients to quickly retrieve related logs
root:
type: string
description: 32 bytes of post-transaction stateroot. (pre Byzantium hard fork at block 4,370,000)
status:
type: integer
description: Either 1 (success) or 0 (failure). (post Byzantium hard fork at block 4,370,000)
enum:
- 0
- 1
type:
type: string
eth_getTransactionReceipt:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
$ref: '#/transaction_receipt'
example:
$ref: "#/components/eth_getTransactionReceipt"
eth_getTransactionReceipt_zkevm:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
$ref: '#/transaction_receipt_zkevm'
example:
$ref: ./evm_examples.yaml#/eth_getTransactionReceipt_zkevm
eth_cancelPrivateTransaction:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: boolean
description: A boolean indicating if the operation was successful or not.
example:
$ref: "#/components/eth_cancelPrivateTransaction"
eth_getTransactionReceipt_arb:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
allOf:
- $ref: '#/transaction_receipt'
- type: object
properties:
l1BlockNumber:
type: string
description: The L1 block number that would be used for `block.number` calls.
gasUsedForL1:
type: string
description: Amount of gas spent on L1 calldata in units of L2 gas.
example:
$ref: ./evm_examples.yaml#/eth_getTransactionReceipt_arb
eth_getBlockReceipts:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: array
items:
$ref: '#/transaction_receipt'
example:
$ref: ./evm_examples.yaml#/eth_getBlockReceipts
eth_getProof:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: Object
description: An account object
properties:
balance:
type: string
description: the balance of the account
codeHash:
type: string
description: 32 Bytes - hash of the code of the account. For a simple Account without code it will return '0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470'
nonce:
type: string
description: nonce of the account.
storageHash:
type: string
description: 32 Bytes - SHA3 of the StorageRoot. All storage will deliver a MerkleProof starting with this rootHash.
accountProof:
type: array
items:
type: string
description: 'Array of rlp-serialized MerkleTree-Nodes, starting with the stateRoot-Node, following the path of the SHA3 (address) as key.'
storageProof:
type: array
items:
type: object
properties:
key:
type: string
description: the requested storage key
value:
type: string
description: the storage value
proof:
type: array
items:
type: string
description: 'Array of rlp-serialized MerkleTree-Nodes, starting with the storageHash-Node, following the path of the SHA3 (key) as path.'
example:
$ref: ./evm_examples.yaml#/eth_getProof
string_result_response:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: string
description: '32 Bytes String - The Transaction Hash.'
example:
$ref: "#/components/string_result_response"
eth_call:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: string
description: 'The result of the call'
example:
$ref: "#/components/string_result_response"
getTxn_result_response:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: object
properties:
jobStatus:
type: string
description: 'See below for the different response statuses'
enum:
- 'IN_PROGRESS'
- 'COMPLETE'
- 'ABANDONED'
- 'UNSPECIFIED'
transactionHashesAttempted:
type: array
description: 'An array of currently submitted transaction hashes'
items:
type: string
minedTransactionHash:
type: string
description: transaction hash for the mined transaction if it has been mined
transactionHashWithErrors:
type: array
description: An array of object errors that occurred with the transaction, omitted if no errors occurred.
items:
type: object
properties:
hash:
type: string
description: hash for the transaction that had the error
errors:
type: array
description: error objects
properties:
code:
type: integer
description: error code
message:
type: string
description: error message
example:
$ref: ./evm_examples.yaml#/getTxn_result_response
sendTxn_result_response:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: object
properties:
trackingId:
type: string
description: 'A transaction identifier that can be used in alchemy_getGasOptimizedTransactionStatus for querying its status'
transactionHashes:
type: array
description: 'An array of currently submitted transaction hashes'
items:
type: string
example:
$ref: ./evm_examples.yaml#/sendTxn_result_response
eth_feeHistory:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: object
required:
- OLDESTBLOCK
- BASEFEEPERGAS
- GASUSEDRATIO
properties:
OLDESTBLOCK:
type: integer
format: int64
description: Lowest number block of the returned range.
BASEFEEPERGAS:
type: array
description: 'An array of block base fees per gas. This includes the next block after the newest of the returned range, because this value can be derived from the newest block. Zeroes are returned for pre-EIP-1559 blocks.'
items:
type: string
GASUSEDRATIO:
type: array
items:
type: number
REWARD:
type: array
items:
type: array
items:
type: string
example:
$ref: ./evm_examples.yaml#/eth_feeHistory
net_version:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: string
description: 'The current network id. 1 - Ethereum Mainnet, 2 - Morden Testnet (deprecated), 3 - Ropsten Testnet, 4 - Rinkeby Testnet, 42 - Kovan Testnet,'
enum:
- '1'
- '2'
- '3'
- '4'
- '42'
example:
$ref: "#/components/net_version"
eth_subscribe:
type: object
properties:
jsonrpc:
default: '2.0'
type: string
enum:
- '2.0'
description: Always '2.0'.
method:
type: string
default: eth_subscription
enum:
- eth_subscription
description: Always 'eth_subscription'.
params:
type: object
properties:
subscription:
type: string
description: The subscription ID returned by the eth_subscription call which created this subscription.
result:
description: An object whose contents vary depending on the type of subscription.
oneOf:
- $ref: '#/transaction_object'
- type: string
- $ref: '#/block_object'
- $ref: '#/log_object'
- type: object
properties:
syncing:
type: boolean
status:
type: object
properties:
startingBlock:
type: integer
currentBlock:
type: integer
highestBlock:
type: integer
pulledStates:
type: integer
knownStates:
type: integer
example:
$ref: ./evm_examples.yaml#/eth_subscribe
alchemy_getTokenAllowance:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: string
description: The allowance amount.
example:
$ref: ./evm_examples.yaml#/alchemy_getTokenAllowance
alchemy_getTokenBalances:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: object
properties:
address:
type: string
description: 'DATA, 20 Bytes - The address for which token balances were checked.'
tokenBalances:
type: array
description: Array - returns an array of token balance objects. One of tokenBalance or error will be null.
items:
type: object
properties:
contractAddress:
type: string
tokenBalance:
type: string
error:
type: string
example:
$ref: ./evm_examples.yaml#/alchemy_getTokenBalances
alchemy_getTokenMetadata:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: object
properties:
name:
type: string
description: String - The token's name. null if not defined in the contract and not available from other sources.
symbol:
type: string
description: String - The token's symbol. null if not defined in the contract and not available from other sources.
decimals:
type: number
description: Number - The number of decimals of the token. null if not defined in the contract and not available from other sources.
logo:
type: string
description: String - URL of the token's logo image. null if not available.
example:
$ref: ./evm_examples.yaml#/alchemy_getTokenMetadata
trace_call:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
$ref: '#/trace_block'
example:
$ref: ./evm_examples.yaml#/trace_call
trace_block:
type: object
properties:
output:
type: string
stateDiff:
type: string
trace:
type: array
items:
type: object
properties:
action:
$ref: '#/action_object'
error:
type: string
subtraces:
type: string
traceAddress:
type: array
items:
type: string
type:
type: string
vmTrace:
type: string
example:
$ref: ./evm_examples.yaml#/trace_block
action_object:
type: object
properties:
callType:
type: string
from:
type: string
gas:
type: string
input:
type: string
to:
type: string
value:
type: string
trace_filter:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: array
items:
$ref: '#/trace_filter_object'
example:
$ref: ./evm_examples.yaml#/trace_filter
trace_filter_object:
type: object
properties:
action:
$ref: '#/action_object'
blockHash:
type: string
blockNumber:
type: string
result:
type: object
properties:
gasUsed:
type: string
output:
type: string
subtraces:
type: integer
traceAddress:
type: array
items:
type: string
transactionHash:
type: string
transactionPosition:
type: string
type:
type: string
trace_get_object:
type: object
properties:
action:
$ref: '#/action_object'
blockHash:
type: string
blockNumber:
type: string
result:
type: object
properties:
gasUsed:
type: string
output:
type: string
subtraces:
type: integer
traceAddress:
type: array
items:
type: string
transactionHash:
type: string
transactionPosition:
type: string
type:
type: string
trace_get:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
$ref: '#/trace_get_object'
example:
$ref: ./evm_examples.yaml#/trace_get
trace_transaction:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: array
items:
$ref: '#/trace_get_object'
example:
$ref: ./evm_examples.yaml#/trace_transaction
trace_replayBlockTransactions:
allOf:
- $ref: '#/common_response_fields'
- type: object
properties:
result:
type: array
items:
allOf:
- $ref: '#/trace_block'
- type: object
properties:
transactionHash:
type: string
example:
$ref: ./evm_examples.yaml#/trace_replayBlockTransactions
# ===== Debug API Responses ============
callTracer:
type: object
properties:
type:
type: string
description: CALL or CREATE
from:
type: string
description: 20 Bytes - address of the sender
to:
type: string
description: 20 Bytes - address of the receiver. null when its a contract creation transaction
value:
type: string
description: amount of value for transfer (in hex)
gas:
type: string
description: amount of gas provided for the call (in hex)
gasUsed:
type: string
description: amount of gsa used during the call (in hex)
input:
type: string
description: call data
output:
type: string
description: return data
error:
type: string
description: error, if any
revertReason:
type: string
description: solidity revert reason, if any
calls:
type: array
description: list of sub-calls