-
Notifications
You must be signed in to change notification settings - Fork 4
/
v1.yaml
2069 lines (1982 loc) · 67 KB
/
v1.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
# yaml-language-server: $schema=https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.1/schema.json
openapi: 3.0.3
info:
title: Oasis Indexer API V1
description: An API for accessing indexed data from the Oasis Network.
version: 0.1.0
servers:
- url: http://index.oasislabs.com/v1
description: Mainnet index endpoint.
- url: http://index.testnet.oasislabs.com/v1
description: Testnet index endpoint.
x-query-params:
- &offset
in: query
name: offset
schema:
type: integer
format: uint64
default: 0
description: |
The number of items to skip before starting to collect the result set.
- &limit
in: query
name: limit
schema:
type: integer
format: uint64
default: 100
minimum: 1
maximum: 1000
description: |
The maximum numbers of items to return.
- &height
in: query
name: height
schema:
type: integer
format: int64
description: |
The block height from which to query state. The Oasis Indexer does not
make any guarantees about availability of historical state data.
- &runtime
in: path
name: runtime
required: true
schema:
$ref: '#/components/schemas/Runtime'
description: |
The runtime which to query.
- &bucket_size_seconds
in: query
name: bucket_size_seconds
schema:
type: integer
format: uint32
default: 86400
description: |
The size of buckets into which the statistic is grouped, in seconds.
The backend supports a limited number of bucket sizes: 300 (5 minutes) and
86400 (1 day). Requests with other values may be rejected.
x-examples:
chain-id:
- &chain_id_1 'oasis-3'
block-height:
- &block_height_1 8048956
- &block_height_2 8049555
block-hash:
- &block_hash_1 '0a29ac21fa69bb9e43e5cb25d10826ff3946f1ce977e82f99a2614206a50765c'
tx-hash:
- &tx_hash_1 '0d0531d6b8a468c07440182b1cdda517f5a076d69fb2199126a83082ecfc0f41'
tx-body:
- &tx_body_1 '{"amount":"1000000000","account":"oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p"}'
epoch:
- &epoch_1 8048956
- &epoch_2 8048966
event-type:
- &event_type_1 'staking.escrow.take'
entity-id:
- &entity_id_1 'gb8SHLeDc69Elk7OTfqhtVgE2sqxrBCDQI84xKR+Bjg='
node-id:
- &node_id_1 'lbxs4hlud9XNloIOdhJPaCahd7HtiY8QATCgGnFfCM0='
staking-address:
- &staking_address_1 'oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p'
- &staking_address_2 'oasis1qprtzrg97jk0wxnqkhxwyzy5qys47r7alvfl3fcg'
proposal-id:
- &proposal_id_1 1
proposal-state:
- &proposal_state_1 'active'
runtime-block-round:
- &runtime_block_round_1 3283246
runtime-block-hash:
- &runtime_block_hash_1 '21c243cd34bedfc234f1b45615d10a868f0655f59578f063a7d2fc8c6e5b4009'
runtime-event-type:
- &runtime_event_type_1 'consensus_accounts.deposit'
iso-timestamp:
- &iso_timestamp_1 '2022-03-01T00:00:00Z'
- &iso_timestamp_2 '2019-04-01T00:00:00Z'
- &iso_timestamp_3 '2022-10-15T00:05:34Z'
x-err-responses:
common-errors: &common_error_responses
'400':
$ref: '#/components/responses/HumanReadableError'
description: Invalid request.
'404':
$ref: '#/components/responses/NotFoundError'
description: The requested resource was not found.
'500':
$ref: '#/components/responses/HumanReadableError'
description: A server error occurred.
x-type-annotations:
big-int: &BigIntType
type: string
pattern: '^-?[0-9]+$'
format: bigint # Not used by the indexer; might be helpful to client generators to recognize this type.
example: "1234567890123456789012"
x-go-type: common.BigInt
x-go-type-import: { name: common, path: "github.com/oasisprotocol/oasis-indexer/common" }
staking-address: &StakingAddressType
type: string
pattern: '^oasis1[a-z0-9]{40}$'
example: "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p"
x-go-type: staking.Address
x-go-type-import: { name: staking, path: "github.com/oasisprotocol/oasis-core/go/staking/api" }
description: An oasis-style (bech32) address.
pubkey: &Ed25519PubKeyType
type: string
format: byte # means base64-encoded raw bytes
example: "lbxs4hlud9XNloIOdhJPaCahd7HtiY8QATCgGnFfCM0="
x-go-type: signature.PublicKey
x-go-type-import: { name: signature, path: "github.com/oasisprotocol/oasis-core/go/common/crypto/signature" }
description: A base64-encoded ed25519 public key.
paths:
/:
get:
operationId: getStatus
summary: Returns the indexer status.
responses:
'200':
description: A JSON object containing status metadata.
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
<<: *common_error_responses
/consensus/blocks:
get:
summary: Returns a list of consensus blocks, sorted from most to least recent.
parameters:
- *limit
- *offset
- in: query
name: from
schema:
type: integer
format: int64
description: A filter on minimum block height, inclusive.
example: *block_height_1
- in: query
name: to
schema:
type: integer
format: int64
description: A filter on maximum block height, inclusive.
example: *block_height_2
- in: query
name: after
schema:
type: string
format: date-time
description: A filter on minimum block time, inclusive.
example: *iso_timestamp_1
- in: query
name: before
schema:
type: string
format: date-time
description: A filter on maximum block time, inclusive.
example: *iso_timestamp_2
responses:
'200':
description: A JSON object containing a list of consensus blocks.
content:
application/json:
schema:
$ref: '#/components/schemas/BlockList'
<<: *common_error_responses
/consensus/blocks/{height}:
get:
summary: Returns a consensus block.
parameters:
- in: path
name: height
required: true
schema:
type: integer
format: int64
description: The block height of the block to return.
example: *block_height_1
responses:
'200':
description: A JSON object containing a consensus block.
content:
application/json:
schema:
$ref: '#/components/schemas/Block'
<<: *common_error_responses
/consensus/transactions:
get:
summary: Returns a list of consensus transactions.
parameters:
- *limit
- *offset
- in: query
name: block
schema:
type: integer
format: int64
description: A filter on block height.
example: *block_height_1
- in: query
name: method
schema:
$ref: '#/components/schemas/ConsensusTxMethod'
description: A filter on transaction method.
- in: query
name: sender
schema:
<<: *StakingAddressType
description: A filter on transaction sender.
- in: query
name: rel
schema:
type: string
description: A filter on related accounts.
example: *staking_address_1
- in: query
name: minFee
schema:
<<: *BigIntType
description: A filter on minimum transaction fee, inclusive.
example: "1000"
- in: query
name: maxFee
schema:
<<: *BigIntType
description: A filter on maximum transaction fee, inclusive.
example: "100000000000000000000000"
- in: query
name: code
schema:
type: integer
description: A filter on transaction status code.
responses:
'200':
description: |
A JSON object containing a list of consensus transactions.
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionList'
<<: *common_error_responses
/consensus/transactions/{tx_hash}:
get:
summary: Returns a consensus transaction.
parameters:
- in: path
name: tx_hash
required: true
schema:
type: string
description: The transaction hash of the transaction to return.
example: *tx_hash_1
responses:
'200':
description: A JSON object containing a consensus transaction.
content:
application/json:
schema:
$ref: '#/components/schemas/Transaction'
<<: *common_error_responses
/consensus/events:
get:
summary: Returns a list of consensus events.
parameters:
- *limit
- *offset
- in: query
name: block
schema:
type: integer
format: int64
description: A filter on block height.
example: *block_height_1
- in: query
name: tx_index
schema:
type: integer
format: int32
description: |
A filter on transaction index. The returned events all need to originate
from a transaction that appeared in `tx_index`-th position in the block.
It is invalid to specify this filter without also specifying a `block`.
Specifying `tx_index` and `block` is an alternative to specifying `tx_hash`;
either works to fetch events from a specific transaction.
example: 3
- in: query
name: tx_hash
schema:
type: string
description: |
A filter on the hash of the transaction that originated the events.
Specifying `tx_index` and `block` is an alternative to specifying `tx_hash`;
either works to fetch events from a specific transaction.
example: *tx_hash_1
- in: query
name: rel
schema:
<<: *StakingAddressType
description: |
A filter on related accounts. Every returned event will refer to
this account. For example, for a `Transfer` event, this will be the
the sender or the recipient of tokens.
- in: query
name: type
schema:
$ref: '#/components/schemas/ConsensusEventType'
description: A filter on the event type.
example: *event_type_1
responses:
'200':
description: |
Consensus events matching the filters, sorted by most recent first.
content:
application/json:
schema:
$ref: '#/components/schemas/ConsensusEventList'
<<: *common_error_responses
/consensus/entities:
get:
summary: Returns a list of entities registered at the consensus layer.
parameters:
- *limit
- *offset
responses:
'200':
description: |
A JSON object containing a list of entities registered
at the consensus layer.
content:
application/json:
schema:
$ref: '#/components/schemas/EntityList'
<<: *common_error_responses
/consensus/entities/{entity_id}:
get:
summary: Returns an entity registered at the consensus layer.
parameters:
- in: path
name: entity_id
required: true
schema:
<<: *Ed25519PubKeyType
description: The entity ID of the entity to return.
responses:
'200':
description: |
A JSON object containing an entity registered
at the consensus layer.
content:
application/json:
schema:
$ref: '#/components/schemas/Entity'
<<: *common_error_responses
/consensus/entities/{entity_id}/nodes:
get:
summary: Returns a list of nodes registered at the consensus layer.
parameters:
- *limit
- *offset
- in: path
name: entity_id
required: true
schema:
<<: *Ed25519PubKeyType
description: |
The entity ID of the controlling entity of the nodes to return.
responses:
'200':
description: |
A JSON object containing a list of nodes registered at the consensus layer.
content:
application/json:
schema:
$ref: '#/components/schemas/NodeList'
<<: *common_error_responses
/consensus/entities/{entity_id}/nodes/{node_id}:
get:
summary: Returns a node registered at the consensus layer.
parameters:
- in: path
name: entity_id
required: true
schema:
<<: *Ed25519PubKeyType
description: |
The entity ID of the entity controlling the node to return.
example: *entity_id_1
- in: path
name: node_id
required: true
schema:
<<: *Ed25519PubKeyType
description: The node ID of the node to return.
responses:
'200':
description: |
A JSON object containing a node registered at the consensus layer.
content:
application/json:
schema:
$ref: '#/components/schemas/Node'
<<: *common_error_responses
/consensus/validators:
get:
summary: Returns a list of validators registered at the consensus layer.
parameters:
- *limit
- *offset
responses:
'200':
description: |
A JSON object containing a list of validators registered
at the consensus layer.
content:
application/json:
schema:
$ref: '#/components/schemas/ValidatorList'
<<: *common_error_responses
/consensus/validators/{entity_id}:
get:
summary: Returns a validator registered at the consensus layer.
parameters:
- in: path
name: entity_id
required: true
schema:
<<: *Ed25519PubKeyType
description: The entity ID of the entity to return.
responses:
'200':
description: |
A JSON object containing a validator registered at the
consensus layer.
content:
application/json:
schema:
$ref: '#/components/schemas/Validator'
<<: *common_error_responses
/consensus/accounts:
get:
summary: Returns a list of consensus layer accounts.
parameters:
- *limit
- *offset
- in: query
name: minAvailable
schema:
<<: *BigIntType
description: A filter on the minimum available account balance.
- in: query
name: maxAvailable
schema:
<<: *BigIntType
description: A filter on the maximum available account balance.
- in: query
name: minEscrow
schema:
<<: *BigIntType
description: A filter on the minimum active escrow account balance.
- in: query
name: maxEscrow
schema:
<<: *BigIntType
description: A filter on the maximum active escrow account balance.
- in: query
name: minDebonding
schema:
<<: *BigIntType
description: A filter on the minimum debonding account balance.
- in: query
name: maxDebonding
schema:
<<: *BigIntType
description: A filter on the maximum debonding account balance.
- in: query
name: minTotalBalance
schema:
<<: *BigIntType
description: A filter on the minimum total account balance.
- in: query
name: maxTotalBalance
schema:
<<: *BigIntType
description: A filter on the maximum total account balance.
responses:
'200':
description: |
A JSON object containing a list of consensus layer accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountList'
<<: *common_error_responses
/consensus/accounts/{address}:
get:
summary: Returns a consensus layer account.
parameters:
- in: path
name: address
required: true
schema:
<<: *StakingAddressType
description: The staking address of the account to return.
responses:
'200':
description: A JSON object containing a consensus layer account.
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
<<: *common_error_responses
/consensus/accounts/{address}/delegations:
get:
summary: Returns an account's delegations.
parameters:
- *limit
- *offset
- in: path
name: address
required: true
schema:
<<: *StakingAddressType
description: The staking address of the account that delegated.
responses:
'200':
description: A JSON object containing a list of delegations.
content:
application/json:
schema:
$ref: '#/components/schemas/DelegationList'
<<: *common_error_responses
/consensus/accounts/{address}/debonding_delegations:
get:
summary: Returns an account's debonding delegations.
parameters:
- *limit
- *offset
- in: path
name: address
required: true
schema:
<<: *StakingAddressType
description: The staking address of the account that delegated.
responses:
'200':
description: A JSON object containing a list of debonding delegations.
content:
application/json:
schema:
$ref: '#/components/schemas/DebondingDelegationList'
<<: *common_error_responses
/consensus/epochs:
get:
summary: Returns a list of consensus epochs.
parameters:
- *limit
- *offset
responses:
'200':
description: A JSON object containing a list of consensus epochs.
content:
application/json:
schema:
$ref: '#/components/schemas/EpochList'
<<: *common_error_responses
/consensus/epochs/{epoch}:
get:
summary: Returns a consensus epoch.
parameters:
- in: path
name: epoch
required: true
schema:
type: integer
format: int64
description: The epoch number of the epoch to return.
example: *epoch_1
responses:
'200':
description: A JSON object containing a consensus epoch.
content:
application/json:
schema:
$ref: '#/components/schemas/Epoch'
<<: *common_error_responses
/consensus/proposals:
get:
summary: Returns a list of governance proposals.
parameters:
- *limit
- *offset
- in: query
name: submitter
schema:
<<: *StakingAddressType
description: The submitter of the proposal.
- in: query
name: state
schema:
type: string
description: The state of the proposal.
example: *proposal_state_1
responses:
'200':
description: A JSON object containing a list of governance proposals.
content:
application/json:
schema:
$ref: '#/components/schemas/ProposalList'
<<: *common_error_responses
/consensus/proposals/{proposal_id}:
get:
summary: Returns a governance proposal.
parameters:
- in: path
name: proposal_id
required: true
schema:
type: integer
format: uint64
description: The unique identifier of the proposal to return.
example: *proposal_id_1
responses:
'200':
description: A JSON object containing a governance proposal.
content:
application/json:
schema:
$ref: '#/components/schemas/Proposal'
<<: *common_error_responses
/consensus/proposals/{proposal_id}/votes:
get:
summary: Returns a list of votes for a governance proposal.
parameters:
- *limit
- *offset
- in: path
name: proposal_id
required: true
schema:
type: integer
format: uint64
description: |
The unique identifier of the proposal for which votes are returned.
example: *proposal_id_1
responses:
'200':
description: |
A JSON object containing a list of votes for a governance proposal.
content:
application/json:
schema:
$ref: '#/components/schemas/ProposalVotes'
<<: *common_error_responses
/{runtime}/blocks:
get:
summary: Returns a list of Emerald blocks.
parameters:
- *limit
- *offset
- *runtime
- in: query
name: from
schema:
type: integer
format: int64
description: A filter on minimum block height, inclusive.
example: *block_height_1
- in: query
name: to
schema:
type: integer
format: int64
description: A filter on maximum block height, inclusive.
example: *block_height_2
- in: query
name: after
schema:
type: string
format: date-time
description: A filter on minimum block time, inclusive.
example: *iso_timestamp_1
- in: query
name: before
schema:
type: string
format: date-time
description: A filter on maximum block time, inclusive.
example: *iso_timestamp_2
responses:
'200':
description: A JSON object containing a list of Emerald blocks.
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeBlockList'
<<: *common_error_responses
/{runtime}/transactions:
get:
summary: Returns a list of Emerald transactions.
parameters:
- *limit
- *offset
- *runtime
- in: query
name: block
schema:
type: integer
format: int64
description: A filter on block round.
example: *runtime_block_round_1
- in: query
name: rel
schema:
<<: *StakingAddressType
# TODO: Implement autodetection of Eth addresses, get rid of last sentence.
description: |
A filter on related accounts. Every returned transaction will refer to
this account in a way. For example, for an `accounts.Transfer` tx, this will be
the sender or the recipient of tokens.
The indexer detects related accounts inside EVM transactions and events on a
best-effort basis. For example, it inspects ERC20 methods inside `evm.Call` txs.
However, you must provide the oasis-style derived address here, not the Eth address.
See `AddressPreimage` for more info on oasis-style vs Eth addresses.
responses:
'200':
description: |
A JSON object containing a list of Emerald transactions.
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeTransactionList'
<<: *common_error_responses
/{runtime}/events:
get:
summary: Returns a list of Emerald events.
parameters:
- *limit
- *offset
- *runtime
- in: query
name: block
schema:
type: integer
format: int64
description: A filter on block round.
example: *runtime_block_round_1
- in: query
name: tx_index
schema:
type: integer
format: int32
description: |
A filter on transaction index. The returned events all need to originate
from a transaction that appeared in `tx_index`-th position in the block.
It is invalid to specify this filter without also specifying a `block`.
Specifying `tx_index` and `round` is an alternative to specifying `tx_hash`;
either works to fetch events from a specific transaction.
example: 3
- in: query
name: tx_hash
schema:
type: string
description: |
A filter on the hash of the transaction that originated the events.
Specifying `tx_index` and `round` is an alternative to specifying `tx_hash`;
either works to fetch events from a specific transaction.
example: *tx_hash_1
- in: query
name: type
schema:
$ref: '#/components/schemas/RuntimeEventType'
description: A filter on the event type.
- in: query
name: rel
schema:
type: string
description: |
A filter on related accounts. Every returned event will refer to
this account. For example, for a `accounts.Transfer` event, this will be
the sender or the recipient of tokens.
example: *staking_address_1
- in: query
name: evm_log_signature
schema:
type: string
description: |
A filter on the first of `topics` in the EVM log structure, which typically contains the
event _signature_, i.e. the keccak256 hash of the event name and parameter types.
Note: The filter will match on `topics[0]` even in the rare case of anonymous events
when that field does not actually contain the signature.
example: '0x27f12abfe35860a9a927b465bb3d4a9c23c8428174b83f278fe45ed7b4da2662'
responses:
'200':
description: |
Runtime events matching the filters, sorted by most recent first.
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeEventList'
<<: *common_error_responses
/{runtime}/transactions/{tx_hash}:
get:
summary: Returns an Emerald transaction with the given transaction hash.
parameters:
- *runtime
- in: path
name: tx_hash
required: true
schema:
type: string
description: The transaction hash of the transaction to return.
example: *tx_hash_1
responses:
'200':
description: The requested Emerald transactions.
content:
application/json:
schema:
$ref: '#/components/schemas/RuntimeTransaction'
<<: *common_error_responses
/{runtime}/evm_tokens:
get:
summary: Returns a list of EVM (ERC-20, ...) tokens on Emerald.
parameters:
- *limit
- *offset
- *runtime
responses:
'200':
description: The requested tokens.
content:
application/json:
schema:
$ref: '#/components/schemas/EvmTokenList'
<<: *common_error_responses
/{layer}/stats/tx_volume:
get:
summary: |
Returns a timeline of the transaction volume at the chosen granularity,
for either consensus or one of the paratimes.
parameters:
- *limit
- *offset
- *bucket_size_seconds
- in: path
name: layer
required: true
schema:
$ref: '#/components/schemas/Layer'
description: |
The layer for which to return the transaction volume timeline.
responses:
'200':
description: |
A JSON object containing a list of TPS values for each interval.
content:
application/json:
schema:
$ref: '#/components/schemas/TxVolumeList'
<<: *common_error_responses
components:
schemas:
Layer:
type: string
enum: [emerald, sapphire, cipher, consensus]
Runtime:
type: string
enum: [emerald, sapphire, cipher]
Status:
type: object
required: [latest_chain_id, latest_block, latest_update]
properties:
latest_chain_id:
x-go-name: LatestChainID # oapi-codegen generates LatestChainId (with a lowercase d) by default.
type: string
description: The most recently indexed chain ID.
example: *chain_id_1
latest_block:
type: integer
format: int64
description: The height of the most recent indexed block. Query a synced Oasis node for the latest block produced.
example: *block_height_1
latest_update:
type: string
format: date-time
description: The RFC 3339 formatted time when the Indexer processed the latest block. Compare with current time for approximate indexing progress with the Oasis Network.
example: *iso_timestamp_1
BlockList:
type: object
required: [blocks]
properties:
blocks:
type: array
items:
$ref: '#/components/schemas/Block'
description: |
A list of consensus blocks.
Block:
type: object
required: [height, hash, timestamp, num_transactions] # TODO: size, gas_used
properties:
height:
type: integer
format: int64
description: The block height.
example: *block_height_1
hash:
type: string
description: The block header hash.
example: *block_hash_1
timestamp:
type: string
format: date-time
description: The second-granular consensus time.
example: *iso_timestamp_1
num_transactions:
type: integer
format: int32
description: Number of transactions in the block.
example: 17
# TODO: Not available on backend
# size:
# type: integer
# format: int64
# description: Size of the block, in bytes. TODO: Be more exact. Should this include results? By far the easiest is to give the total bytesize of txs here.
# example: 123456
# gas_used:
# type: integer
# format: int64
# description: Total gas used by the transactions in the block.
# example: 123456
description: |
A consensus block.
Delegation:
type: object
required: [amount, shares, validator_address]
properties:
amount:
<<: *BigIntType
description: The amount of tokens delegated in base units.