@valve-tech/trueblocks-sdk 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/LICENSE +21 -0
  3. package/README.md +140 -0
  4. package/dist/client.d.ts +25 -0
  5. package/dist/client.d.ts.map +1 -0
  6. package/dist/client.js +35 -0
  7. package/dist/client.js.map +1 -0
  8. package/dist/errors.d.ts +22 -0
  9. package/dist/errors.d.ts.map +1 -0
  10. package/dist/errors.js +26 -0
  11. package/dist/errors.js.map +1 -0
  12. package/dist/generated.d.ts +3686 -0
  13. package/dist/generated.d.ts.map +1 -0
  14. package/dist/generated.js +10 -0
  15. package/dist/generated.js.map +1 -0
  16. package/dist/index.d.ts +5 -0
  17. package/dist/index.d.ts.map +1 -0
  18. package/dist/index.js +4 -0
  19. package/dist/index.js.map +1 -0
  20. package/dist/variants/blocks.d.ts +65 -0
  21. package/dist/variants/blocks.d.ts.map +1 -0
  22. package/dist/variants/blocks.js +24 -0
  23. package/dist/variants/blocks.js.map +1 -0
  24. package/dist/variants/chunks.d.ts +47 -0
  25. package/dist/variants/chunks.d.ts.map +1 -0
  26. package/dist/variants/chunks.js +18 -0
  27. package/dist/variants/chunks.js.map +1 -0
  28. package/dist/variants/export.d.ts +51 -0
  29. package/dist/variants/export.d.ts.map +1 -0
  30. package/dist/variants/export.js +25 -0
  31. package/dist/variants/export.js.map +1 -0
  32. package/dist/variants/slurp.d.ts +21 -0
  33. package/dist/variants/slurp.d.ts.map +1 -0
  34. package/dist/variants/slurp.js +13 -0
  35. package/dist/variants/slurp.js.map +1 -0
  36. package/dist/variants/state.d.ts +27 -0
  37. package/dist/variants/state.d.ts.map +1 -0
  38. package/dist/variants/state.js +8 -0
  39. package/dist/variants/state.js.map +1 -0
  40. package/dist/variants/traces.d.ts +19 -0
  41. package/dist/variants/traces.d.ts.map +1 -0
  42. package/dist/variants/traces.js +8 -0
  43. package/dist/variants/traces.js.map +1 -0
  44. package/dist/variants/transactions.d.ts +24 -0
  45. package/dist/variants/transactions.d.ts.map +1 -0
  46. package/dist/variants/transactions.js +10 -0
  47. package/dist/variants/transactions.js.map +1 -0
  48. package/dist/verbs.d.ts +331 -0
  49. package/dist/verbs.d.ts.map +1 -0
  50. package/dist/verbs.js +141 -0
  51. package/dist/verbs.js.map +1 -0
  52. package/package.json +34 -0
@@ -0,0 +1,3686 @@
1
+ /**
2
+ * AUTO-GENERATED — DO NOT EDIT.
3
+ *
4
+ * Source: https://raw.githubusercontent.com/TrueBlocks/trueblocks-core/3205a003af599adf2229408f74afbe6952391883/docs/content/api/openapi.yaml
5
+ * Tool: openapi-typescript
6
+ *
7
+ * Re-run with `yarn codegen` from this package to refresh.
8
+ */
9
+ export interface paths {
10
+ "/list": {
11
+ parameters: {
12
+ query?: never;
13
+ header?: never;
14
+ path?: never;
15
+ cookie?: never;
16
+ };
17
+ /**
18
+ * List transactions
19
+ * @description List every appearance of an address anywhere on the chain. Corresponds to the <a href="/chifra/accounts/#chifra-list">chifra list</a> command line.
20
+ */
21
+ get: operations["accounts-list"];
22
+ put?: never;
23
+ post?: never;
24
+ delete?: never;
25
+ options?: never;
26
+ head?: never;
27
+ patch?: never;
28
+ trace?: never;
29
+ };
30
+ "/export": {
31
+ parameters: {
32
+ query?: never;
33
+ header?: never;
34
+ path?: never;
35
+ cookie?: never;
36
+ };
37
+ /**
38
+ * Export details
39
+ * @description Export full details of transactions for one or more addresses. Corresponds to the <a href="/chifra/accounts/#chifra-export">chifra export</a> command line.
40
+ */
41
+ get: operations["accounts-export"];
42
+ put?: never;
43
+ post?: never;
44
+ delete?: never;
45
+ options?: never;
46
+ head?: never;
47
+ patch?: never;
48
+ trace?: never;
49
+ };
50
+ "/monitors": {
51
+ parameters: {
52
+ query?: never;
53
+ header?: never;
54
+ path?: never;
55
+ cookie?: never;
56
+ };
57
+ /**
58
+ * Manage monitors
59
+ * @description Add, remove, clean, and list address monitors. Corresponds to the <a href="/chifra/accounts/#chifra-monitors">chifra monitors</a> command line.
60
+ */
61
+ get: operations["accounts-monitors"];
62
+ put?: never;
63
+ post?: never;
64
+ delete?: never;
65
+ options?: never;
66
+ head?: never;
67
+ patch?: never;
68
+ trace?: never;
69
+ };
70
+ "/names": {
71
+ parameters: {
72
+ query?: never;
73
+ header?: never;
74
+ path?: never;
75
+ cookie?: never;
76
+ };
77
+ /**
78
+ * Manage names
79
+ * @description Query addresses or names of well-known accounts. Corresponds to the <a href="/chifra/accounts/#chifra-names">chifra names</a> command line.
80
+ */
81
+ get: operations["accounts-names"];
82
+ put?: never;
83
+ post?: never;
84
+ delete?: never;
85
+ options?: never;
86
+ head?: never;
87
+ patch?: never;
88
+ trace?: never;
89
+ };
90
+ "/abis": {
91
+ parameters: {
92
+ query?: never;
93
+ header?: never;
94
+ path?: never;
95
+ cookie?: never;
96
+ };
97
+ /**
98
+ * Manage Abi files
99
+ * @description Fetches the ABI for a smart contract. Corresponds to the <a href="/chifra/accounts/#chifra-abis">chifra abis</a> command line.
100
+ */
101
+ get: operations["accounts-abis"];
102
+ put?: never;
103
+ post?: never;
104
+ delete?: never;
105
+ options?: never;
106
+ head?: never;
107
+ patch?: never;
108
+ trace?: never;
109
+ };
110
+ "/blocks": {
111
+ parameters: {
112
+ query?: never;
113
+ header?: never;
114
+ path?: never;
115
+ cookie?: never;
116
+ };
117
+ /**
118
+ * Get blocks
119
+ * @description Retrieve one or more blocks from the chain or local cache. Corresponds to the <a href="/chifra/chaindata/#chifra-blocks">chifra blocks</a> command line.
120
+ */
121
+ get: operations["chaindata-blocks"];
122
+ put?: never;
123
+ post?: never;
124
+ delete?: never;
125
+ options?: never;
126
+ head?: never;
127
+ patch?: never;
128
+ trace?: never;
129
+ };
130
+ "/transactions": {
131
+ parameters: {
132
+ query?: never;
133
+ header?: never;
134
+ path?: never;
135
+ cookie?: never;
136
+ };
137
+ /**
138
+ * Get transactions
139
+ * @description Retrieve one or more transactions from the chain or local cache. Corresponds to the <a href="/chifra/chaindata/#chifra-transactions">chifra transactions</a> command line.
140
+ */
141
+ get: operations["chaindata-transactions"];
142
+ put?: never;
143
+ post?: never;
144
+ delete?: never;
145
+ options?: never;
146
+ head?: never;
147
+ patch?: never;
148
+ trace?: never;
149
+ };
150
+ "/receipts": {
151
+ parameters: {
152
+ query?: never;
153
+ header?: never;
154
+ path?: never;
155
+ cookie?: never;
156
+ };
157
+ /**
158
+ * Get receipts
159
+ * @description Retrieve receipts for the given transaction(s). Corresponds to the <a href="/chifra/chaindata/#chifra-receipts">chifra receipts</a> command line.
160
+ */
161
+ get: operations["chaindata-receipts"];
162
+ put?: never;
163
+ post?: never;
164
+ delete?: never;
165
+ options?: never;
166
+ head?: never;
167
+ patch?: never;
168
+ trace?: never;
169
+ };
170
+ "/logs": {
171
+ parameters: {
172
+ query?: never;
173
+ header?: never;
174
+ path?: never;
175
+ cookie?: never;
176
+ };
177
+ /**
178
+ * Get logs
179
+ * @description Retrieve logs for the given transaction(s). Corresponds to the <a href="/chifra/chaindata/#chifra-logs">chifra logs</a> command line.
180
+ */
181
+ get: operations["chaindata-logs"];
182
+ put?: never;
183
+ post?: never;
184
+ delete?: never;
185
+ options?: never;
186
+ head?: never;
187
+ patch?: never;
188
+ trace?: never;
189
+ };
190
+ "/traces": {
191
+ parameters: {
192
+ query?: never;
193
+ header?: never;
194
+ path?: never;
195
+ cookie?: never;
196
+ };
197
+ /**
198
+ * Get traces
199
+ * @description Retrieve traces for the given transaction(s). Corresponds to the <a href="/chifra/chaindata/#chifra-traces">chifra traces</a> command line.
200
+ */
201
+ get: operations["chaindata-traces"];
202
+ put?: never;
203
+ post?: never;
204
+ delete?: never;
205
+ options?: never;
206
+ head?: never;
207
+ patch?: never;
208
+ trace?: never;
209
+ };
210
+ "/when": {
211
+ parameters: {
212
+ query?: never;
213
+ header?: never;
214
+ path?: never;
215
+ cookie?: never;
216
+ };
217
+ /**
218
+ * Get block dates
219
+ * @description Find block(s) based on date, blockNum, timestamp, or 'special'. Corresponds to the <a href="/chifra/chaindata/#chifra-when">chifra when</a> command line.
220
+ */
221
+ get: operations["chaindata-when"];
222
+ put?: never;
223
+ post?: never;
224
+ delete?: never;
225
+ options?: never;
226
+ head?: never;
227
+ patch?: never;
228
+ trace?: never;
229
+ };
230
+ "/state": {
231
+ parameters: {
232
+ query?: never;
233
+ header?: never;
234
+ path?: never;
235
+ cookie?: never;
236
+ };
237
+ /**
238
+ * Get balance(s)
239
+ * @description Retrieve account balance(s) for one or more addresses at given block(s). Corresponds to the <a href="/chifra/chainstate/#chifra-state">chifra state</a> command line.
240
+ */
241
+ get: operations["chainstate-state"];
242
+ put?: never;
243
+ post?: never;
244
+ delete?: never;
245
+ options?: never;
246
+ head?: never;
247
+ patch?: never;
248
+ trace?: never;
249
+ };
250
+ "/tokens": {
251
+ parameters: {
252
+ query?: never;
253
+ header?: never;
254
+ path?: never;
255
+ cookie?: never;
256
+ };
257
+ /**
258
+ * Get token balance(s)
259
+ * @description Retrieve token balance(s) for one or more addresses at given block(s). Corresponds to the <a href="/chifra/chainstate/#chifra-tokens">chifra tokens</a> command line.
260
+ */
261
+ get: operations["chainstate-tokens"];
262
+ put?: never;
263
+ post?: never;
264
+ delete?: never;
265
+ options?: never;
266
+ head?: never;
267
+ patch?: never;
268
+ trace?: never;
269
+ };
270
+ "/config": {
271
+ parameters: {
272
+ query?: never;
273
+ header?: never;
274
+ path?: never;
275
+ cookie?: never;
276
+ };
277
+ /**
278
+ * Manage config
279
+ * @description Report on and edit the configuration of the TrueBlocks system. Corresponds to the <a href="/chifra/admin/#chifra-config">chifra config</a> command line.
280
+ */
281
+ get: operations["admin-config"];
282
+ put?: never;
283
+ post?: never;
284
+ delete?: never;
285
+ options?: never;
286
+ head?: never;
287
+ patch?: never;
288
+ trace?: never;
289
+ };
290
+ "/status": {
291
+ parameters: {
292
+ query?: never;
293
+ header?: never;
294
+ path?: never;
295
+ cookie?: never;
296
+ };
297
+ /**
298
+ * Get status on caches
299
+ * @description Report on the state of the internal binary caches. Corresponds to the <a href="/chifra/admin/#chifra-status">chifra status</a> command line.
300
+ */
301
+ get: operations["admin-status"];
302
+ put?: never;
303
+ post?: never;
304
+ delete?: never;
305
+ options?: never;
306
+ head?: never;
307
+ patch?: never;
308
+ trace?: never;
309
+ };
310
+ "/chunks": {
311
+ parameters: {
312
+ query?: never;
313
+ header?: never;
314
+ path?: never;
315
+ cookie?: never;
316
+ };
317
+ /**
318
+ * Manage chunks
319
+ * @description Manage, investigate, and display the Unchained Index. Corresponds to the <a href="/chifra/admin/#chifra-chunks">chifra chunks</a> command line.
320
+ */
321
+ get: operations["admin-chunks"];
322
+ put?: never;
323
+ post?: never;
324
+ delete?: never;
325
+ options?: never;
326
+ head?: never;
327
+ patch?: never;
328
+ trace?: never;
329
+ };
330
+ "/init": {
331
+ parameters: {
332
+ query?: never;
333
+ header?: never;
334
+ path?: never;
335
+ cookie?: never;
336
+ };
337
+ /**
338
+ * Initialize index
339
+ * @description Initialize the TrueBlocks system by downloading the Unchained Index from IPFS. Corresponds to the <a href="/chifra/admin/#chifra-init">chifra init</a> command line.
340
+ */
341
+ get: operations["admin-init"];
342
+ put?: never;
343
+ post?: never;
344
+ delete?: never;
345
+ options?: never;
346
+ head?: never;
347
+ patch?: never;
348
+ trace?: never;
349
+ };
350
+ "/slurp": {
351
+ parameters: {
352
+ query?: never;
353
+ header?: never;
354
+ path?: never;
355
+ cookie?: never;
356
+ };
357
+ /**
358
+ * Slurp Api services
359
+ * @description Fetch data from Etherscan and other APIs for any address. Corresponds to the <a href="/chifra/other/#chifra-slurp">chifra slurp</a> command line.
360
+ */
361
+ get: operations["other-slurp"];
362
+ put?: never;
363
+ post?: never;
364
+ delete?: never;
365
+ options?: never;
366
+ head?: never;
367
+ patch?: never;
368
+ trace?: never;
369
+ };
370
+ }
371
+ export type webhooks = Record<string, never>;
372
+ export interface components {
373
+ schemas: {
374
+ /** @description an appearance (`<blockNumber,transactionIndex>`) of an address anywhere on the chain (note that in some cases, not all fields will appear depending on the command) */
375
+ appearance: {
376
+ /**
377
+ * Format: address
378
+ * @description the address of the appearance
379
+ */
380
+ address?: string;
381
+ /**
382
+ * Format: uint32
383
+ * @description the number of the block
384
+ */
385
+ blockNumber?: number;
386
+ /**
387
+ * Format: uint32
388
+ * @description the index of the transaction in the block
389
+ */
390
+ transactionIndex?: number;
391
+ /**
392
+ * Format: uint32
393
+ * @description the zero-based index of the trace in the transaction
394
+ */
395
+ traceIndex?: number;
396
+ /**
397
+ * Format: string
398
+ * @description the location in the data where the appearance was found
399
+ */
400
+ reason?: string;
401
+ /**
402
+ * Format: timestamp
403
+ * @description the timestamp for this appearance
404
+ */
405
+ timestamp?: number;
406
+ /**
407
+ * Format: datetime
408
+ * @description the timestamp as a date (calculated)
409
+ */
410
+ date?: string;
411
+ };
412
+ /** @description a local file indicating a user's interest in an address. Includes caches for reconicilations, transactions, and appearances as well as an optional association to named account */
413
+ monitor: {
414
+ /**
415
+ * Format: address
416
+ * @description the address of this monitor
417
+ */
418
+ address?: string;
419
+ /**
420
+ * Format: string
421
+ * @description the name of this monitor (if any)
422
+ */
423
+ name?: string;
424
+ /**
425
+ * Format: int64
426
+ * @description the number of appearances for this monitor
427
+ */
428
+ nRecords?: number;
429
+ /**
430
+ * Format: int64
431
+ * @description the size of this monitor on disc
432
+ */
433
+ fileSize?: number;
434
+ /**
435
+ * Format: uint32
436
+ * @description the last scanned block number
437
+ */
438
+ lastScanned?: number;
439
+ /**
440
+ * Format: boolean
441
+ * @description `true` if the monitor has no appearances, `false` otherwise
442
+ */
443
+ isEmpty?: boolean;
444
+ /**
445
+ * Format: boolean
446
+ * @description `true` if the monitor file in on the stage, `false` otherwise
447
+ */
448
+ isStaged?: boolean;
449
+ /**
450
+ * Format: boolean
451
+ * @description `true` if this monitor has been deleted, `false` otherwise
452
+ */
453
+ deleted?: boolean;
454
+ };
455
+ /** @description an association between a human-readable name and an address used throughout TrueBlocks */
456
+ name: {
457
+ /**
458
+ * Format: string
459
+ * @description colon separated list of tags
460
+ */
461
+ tags?: string;
462
+ /**
463
+ * Format: address
464
+ * @description the address associated with this name
465
+ */
466
+ address?: string;
467
+ /**
468
+ * Format: string
469
+ * @description the name associated with this address (retrieved from on-chain data if available)
470
+ */
471
+ name?: string;
472
+ /**
473
+ * Format: string
474
+ * @description the symbol for this address (retrieved from on-chain data if available)
475
+ */
476
+ symbol?: string;
477
+ /**
478
+ * Format: string
479
+ * @description user supplied source of where this name was found (or on-chain if name is on-chain)
480
+ */
481
+ source?: string;
482
+ /**
483
+ * Format: uint64
484
+ * @description number of decimals retrieved from an ERC20 smart contract, defaults to 18
485
+ */
486
+ decimals?: number;
487
+ /**
488
+ * Format: boolean
489
+ * @description `true` if deleted, `false` otherwise
490
+ */
491
+ deleted?: boolean;
492
+ /**
493
+ * Format: boolean
494
+ * @description `true` if the address is a custom address, `false` otherwise
495
+ */
496
+ isCustom?: boolean;
497
+ /**
498
+ * Format: boolean
499
+ * @description `true` if the address was one of the prefund addresses, `false` otherwise
500
+ */
501
+ isPrefund?: boolean;
502
+ /**
503
+ * Format: boolean
504
+ * @description `true` if the address is a smart contract, `false` otherwise
505
+ */
506
+ isContract?: boolean;
507
+ /**
508
+ * Format: boolean
509
+ * @description `true` if the address is an ERC20, `false` otherwise
510
+ */
511
+ isErc20?: boolean;
512
+ /**
513
+ * Format: boolean
514
+ * @description `true` if the address is an ERC720, `false` otherwise
515
+ */
516
+ isErc721?: boolean;
517
+ };
518
+ /** @description show first block and last block an address appears in along with timestamps and dates */
519
+ bounds: {
520
+ /**
521
+ * Format: uint64
522
+ * @description the number of appearances for this address
523
+ */
524
+ count?: number;
525
+ /** @description the block number and transaction id of the first appearance of this address */
526
+ firstApp?: Record<string, never>;
527
+ /**
528
+ * Format: timestamp
529
+ * @description the timestamp of the first appearance of this address
530
+ */
531
+ firstTs?: number;
532
+ /**
533
+ * Format: datetime
534
+ * @description the first appearance timestamp as a date (calculated)
535
+ */
536
+ firstDate?: string;
537
+ /** @description the block number and transaction id of the latest appearance of this address */
538
+ latestApp?: Record<string, never>;
539
+ /**
540
+ * Format: timestamp
541
+ * @description the timestamp of the latest appearance of this address
542
+ */
543
+ latestTs?: number;
544
+ /**
545
+ * Format: datetime
546
+ * @description the latest appearance timestamp as a date (calculated)
547
+ */
548
+ latestDate?: string;
549
+ };
550
+ /** @description a statement, including all inflows and outflows, for a single transfer of an asset (including ETH) to or from a given address */
551
+ statement: {
552
+ /**
553
+ * Format: blknum
554
+ * @description the number of the block
555
+ */
556
+ blockNumber?: number;
557
+ /**
558
+ * Format: txnum
559
+ * @description the zero-indexed position of the transaction in the block
560
+ */
561
+ transactionIndex?: number;
562
+ /**
563
+ * Format: lognum
564
+ * @description the zero-indexed position the log in the block, if applicable
565
+ */
566
+ logIndex?: number;
567
+ /**
568
+ * Format: hash
569
+ * @description the hash of the transaction that triggered this reconciliation
570
+ */
571
+ transactionHash?: string;
572
+ /**
573
+ * Format: timestamp
574
+ * @description the Unix timestamp of the object
575
+ */
576
+ timestamp?: number;
577
+ /**
578
+ * Format: datetime
579
+ * @description the timestamp as a date (calculated)
580
+ */
581
+ date?: string;
582
+ /**
583
+ * Format: address
584
+ * @description 0xeeee...eeee for ETH reconciliations, the token address otherwise
585
+ */
586
+ asset?: string;
587
+ /**
588
+ * Format: string
589
+ * @description either ETH, WEI, or the symbol of the asset being reconciled as extracted from the chain
590
+ */
591
+ symbol?: string;
592
+ /**
593
+ * Format: value
594
+ * @description the value of `decimals` from an ERC20 contract or, if ETH or WEI, then 18
595
+ */
596
+ decimals?: number;
597
+ /**
598
+ * Format: float
599
+ * @description the on-chain price in USD (or if a token in ETH, or zero) at the time of the transaction
600
+ */
601
+ spotPrice?: number;
602
+ /**
603
+ * Format: string
604
+ * @description the on-chain source from which the spot price was taken
605
+ */
606
+ priceSource?: string;
607
+ /**
608
+ * Format: address
609
+ * @description the address being accounted for in this reconciliation
610
+ */
611
+ accountedFor?: string;
612
+ /**
613
+ * Format: address
614
+ * @description the initiator of the transfer (the sender)
615
+ */
616
+ sender?: string;
617
+ /**
618
+ * Format: address
619
+ * @description the receiver of the transfer (the recipient)
620
+ */
621
+ recipient?: string;
622
+ /**
623
+ * Format: int256
624
+ * @description the on-chain or running beginning balance prior to the transaction (see notes about intra-block reconciliations)
625
+ */
626
+ begBal?: string;
627
+ /**
628
+ * Format: int256
629
+ * @description totalIn - totalOut (calculated)
630
+ */
631
+ amountNet?: string;
632
+ /**
633
+ * Format: int256
634
+ * @description the on-chain or running balance after the transaction (see notes about intra-block reconciliations)
635
+ */
636
+ endBal?: string;
637
+ /**
638
+ * Format: boolean
639
+ * @description true if `endBal === endBalCalc` and `begBal === prevBal`. `false` otherwise. (calculated)
640
+ */
641
+ reconciled?: boolean;
642
+ /**
643
+ * Format: int256
644
+ * @description the sum of the following `In` fields (calculated)
645
+ */
646
+ totalIn?: string;
647
+ /**
648
+ * Format: int256
649
+ * @description the top-level value of the incoming transfer for the accountedFor address
650
+ */
651
+ amountIn?: string;
652
+ /**
653
+ * Format: int256
654
+ * @description the internal value of the incoming transfer for the accountedFor address
655
+ */
656
+ internalIn?: string;
657
+ /**
658
+ * Format: int256
659
+ * @description the incoming value of a self-destruct if recipient is the accountedFor address
660
+ */
661
+ selfDestructIn?: string;
662
+ /**
663
+ * Format: int256
664
+ * @description the base fee reward if the miner is the accountedFor address
665
+ */
666
+ minerBaseRewardIn?: string;
667
+ /**
668
+ * Format: int256
669
+ * @description the nephew reward if the miner is the accountedFor address
670
+ */
671
+ minerNephewRewardIn?: string;
672
+ /**
673
+ * Format: int256
674
+ * @description the transaction fee reward if the miner is the accountedFor address
675
+ */
676
+ minerTxFeeIn?: string;
677
+ /**
678
+ * Format: int256
679
+ * @description the uncle reward if the miner who won the uncle block is the accountedFor address
680
+ */
681
+ minerUncleRewardIn?: string;
682
+ /**
683
+ * Format: int256
684
+ * @description for unreconciled transfers, increase in beginning balance need to match previous balance
685
+ */
686
+ correctBegBalIn?: string;
687
+ /**
688
+ * Format: int256
689
+ * @description for unreconciled transfers, increase in the amount of a transfer
690
+ */
691
+ correctAmountIn?: string;
692
+ /**
693
+ * Format: int256
694
+ * @description for unreconciled transfers, increase in ending balance need to match running balance or block balance
695
+ */
696
+ correctEndBalIn?: string;
697
+ /**
698
+ * Format: int256
699
+ * @description at block zero (0) only, the amount of genesis income for the accountedFor address
700
+ */
701
+ prefundIn?: string;
702
+ /**
703
+ * Format: int256
704
+ * @description the sum of the following `Out` fields (calculated)
705
+ */
706
+ totalOut?: string;
707
+ /**
708
+ * Format: int256
709
+ * @description the amount (in units of the asset) of regular outflow during this transaction
710
+ */
711
+ amountOut?: string;
712
+ /**
713
+ * Format: int256
714
+ * @description the value of any internal value transfers out of the accountedFor account
715
+ */
716
+ internalOut?: string;
717
+ /**
718
+ * Format: int256
719
+ * @description for unreconciled transfers, decrease in beginning balance need to match previous balance
720
+ */
721
+ correctBegBalOut?: string;
722
+ /**
723
+ * Format: int256
724
+ * @description for unreconciled transfers, decrease in the amount of a transfer
725
+ */
726
+ correctAmountOut?: string;
727
+ /**
728
+ * Format: int256
729
+ * @description for unreconciled transfers, decrease in ending balance need to match running balance or block balance
730
+ */
731
+ correctEndBalOut?: string;
732
+ /**
733
+ * Format: int256
734
+ * @description the value of the self-destructed value out if the accountedFor address was self-destructed
735
+ */
736
+ selfDestructOut?: string;
737
+ /**
738
+ * Format: int256
739
+ * @description if the transaction's original sender is the accountedFor address, the amount of gas expended
740
+ */
741
+ gasOut?: string;
742
+ /**
743
+ * Format: int256
744
+ * @description the account balance for the given asset for the previous reconciliation
745
+ */
746
+ prevBal?: string;
747
+ /**
748
+ * Format: int256
749
+ * @description difference between expected beginning balance and balance at last reconciliation, if non-zero, the reconciliation failed (calculated)
750
+ */
751
+ begBalDiff?: string;
752
+ /**
753
+ * Format: int256
754
+ * @description endBal - endBalCalc, if non-zero, the reconciliation failed (calculated)
755
+ */
756
+ endBalDiff?: string;
757
+ /**
758
+ * Format: int256
759
+ * @description begBal + amountNet (calculated)
760
+ */
761
+ endBalCalc?: string;
762
+ /**
763
+ * Format: string
764
+ * @description for unreconciled transfers, the reasons for the correcting entries, if any
765
+ */
766
+ correctingReasons?: string;
767
+ };
768
+ /** @description a movement of an asset from one address to another (derived from a transaction or a log) */
769
+ transfer: {
770
+ /**
771
+ * Format: blknum
772
+ * @description the number of the block
773
+ */
774
+ blockNumber?: number;
775
+ /**
776
+ * Format: txnum
777
+ * @description the zero-indexed position of the transaction in the block
778
+ */
779
+ transactionIndex?: number;
780
+ /**
781
+ * Format: lognum
782
+ * @description the zero-indexed position the log in the block, if applicable
783
+ */
784
+ logIndex?: number;
785
+ /**
786
+ * Format: address
787
+ * @description the address of the holder of the asset
788
+ */
789
+ holder?: string;
790
+ /**
791
+ * Format: address
792
+ * @description 0xeeee...eeee for ETH transfers, the token address otherwise
793
+ */
794
+ asset?: string;
795
+ /**
796
+ * Format: uint64
797
+ * @description the number of decimal places in the asset units
798
+ */
799
+ decimals?: number;
800
+ /**
801
+ * Format: address
802
+ * @description the initiator of the transfer (the sender)
803
+ */
804
+ sender?: string;
805
+ /**
806
+ * Format: address
807
+ * @description the receiver of the transfer (the recipient)
808
+ */
809
+ recipient?: string;
810
+ /**
811
+ * Format: int256
812
+ * @description the top-level value of the incoming transfer for the holder address
813
+ */
814
+ amountIn?: string;
815
+ /**
816
+ * Format: int256
817
+ * @description the internal value of the incoming transfer for the holder address
818
+ */
819
+ internalIn?: string;
820
+ /**
821
+ * Format: int256
822
+ * @description the base fee reward if the miner is the holder address
823
+ */
824
+ minerBaseRewardIn?: string;
825
+ /**
826
+ * Format: int256
827
+ * @description the nephew reward if the miner is the holder address
828
+ */
829
+ minerNephewRewardIn?: string;
830
+ /**
831
+ * Format: int256
832
+ * @description the transaction fee reward if the miner is the holder address
833
+ */
834
+ minerTxFeeIn?: string;
835
+ /**
836
+ * Format: int256
837
+ * @description the uncle reward if the miner who won the uncle block is the holder address
838
+ */
839
+ minerUncleRewardIn?: string;
840
+ /**
841
+ * Format: int256
842
+ * @description at block zero (0) only, the amount of genesis income for the holder address
843
+ */
844
+ prefundIn?: string;
845
+ /**
846
+ * Format: int256
847
+ * @description the incoming value of a self-destruct if recipient is the holder address
848
+ */
849
+ selfDestructIn?: string;
850
+ /**
851
+ * Format: int256
852
+ * @description the amount (in units of the asset) of regular outflow during this transaction
853
+ */
854
+ amountOut?: string;
855
+ /**
856
+ * Format: int256
857
+ * @description the value of any internal value transfers out of the holder account
858
+ */
859
+ internalOut?: string;
860
+ /**
861
+ * Format: int256
862
+ * @description if the transaction's original sender is the holder address, the amount of gas expended
863
+ */
864
+ gasOut?: string;
865
+ /**
866
+ * Format: int256
867
+ * @description the outgoing value of a self-destruct if sender is the holder address
868
+ */
869
+ selfDestructOut?: string;
870
+ /** @description the transaction that triggered the transfer (calculated) */
871
+ transaction?: Record<string, never>;
872
+ /** @description if a token transfer, the log that triggered the transfer (calculated) */
873
+ log?: Record<string, never>;
874
+ };
875
+ /** @description an ERC-20 token approval granting spending permission from owner to spender */
876
+ approval: {
877
+ /**
878
+ * Format: wei
879
+ * @description the amount of tokens approved for spending
880
+ */
881
+ allowance?: string;
882
+ /**
883
+ * Format: blknum
884
+ * @description the current block number when the report was generated
885
+ */
886
+ blockNumber?: number;
887
+ /**
888
+ * Format: timestamp
889
+ * @description the current timestamp when the report was generated
890
+ */
891
+ timestamp?: number;
892
+ /**
893
+ * Format: datetime
894
+ * @description the timestamp as a date (calculated)
895
+ */
896
+ date?: string;
897
+ /**
898
+ * Format: address
899
+ * @description the address of the owner of the token (the approver)
900
+ */
901
+ owner?: string;
902
+ /**
903
+ * Format: address
904
+ * @description the address being granted approval to spend tokens
905
+ */
906
+ spender?: string;
907
+ /**
908
+ * Format: address
909
+ * @description the address of the ERC-20 token being approved
910
+ */
911
+ token?: string;
912
+ /**
913
+ * Format: blknum
914
+ * @description the block number of the last approval event
915
+ */
916
+ lastAppBlock?: number;
917
+ /**
918
+ * Format: timestamp
919
+ * @description the timestamp of the last approval event
920
+ */
921
+ lastAppTs?: number;
922
+ /**
923
+ * Format: txnum
924
+ * @description the transaction index of the last approval event
925
+ */
926
+ lastAppTxID?: number;
927
+ /**
928
+ * Format: lognum
929
+ * @description the log index of the last approval event
930
+ */
931
+ lastAppLogID?: number;
932
+ };
933
+ /** @description an appearance table for an address */
934
+ appearanceTable: {
935
+ /** @description the address record for these appearances */
936
+ AddressRecord?: Record<string, never>;
937
+ /** @description all the appearances for this address */
938
+ Appearances?: components["schemas"]["appRecord"][];
939
+ };
940
+ /** @description block data as returned from the RPC (with slight enhancements) */
941
+ block: {
942
+ /**
943
+ * Format: gas
944
+ * @description the system-wide maximum amount of gas permitted in this block
945
+ */
946
+ gasLimit?: number;
947
+ /**
948
+ * Format: hash
949
+ * @description the hash of the current block
950
+ */
951
+ hash?: string;
952
+ /**
953
+ * Format: blknum
954
+ * @description the number of the block
955
+ */
956
+ blockNumber?: number;
957
+ /**
958
+ * Format: hash
959
+ * @description hash of previous block
960
+ */
961
+ parentHash?: string;
962
+ /**
963
+ * Format: address
964
+ * @description address of block's winning miner
965
+ */
966
+ miner?: string;
967
+ /**
968
+ * Format: value
969
+ * @description the computational difficulty at this block
970
+ */
971
+ difficulty?: number;
972
+ /**
973
+ * Format: timestamp
974
+ * @description the Unix timestamp of the object
975
+ */
976
+ timestamp?: number;
977
+ /**
978
+ * Format: datetime
979
+ * @description the timestamp as a date (calculated)
980
+ */
981
+ date?: string;
982
+ /** @description a possibly empty array of transactions */
983
+ transactions?: components["schemas"]["transaction"][];
984
+ /**
985
+ * Format: gas
986
+ * @description the base fee for this block
987
+ */
988
+ baseFeePerGas?: number;
989
+ /** @description a possibly empty array of uncle hashes */
990
+ uncles?: components["schemas"]["hash"][];
991
+ /** @description a possibly empty array of withdrawals (post Shanghai) */
992
+ withdrawals?: components["schemas"]["withdrawal"][];
993
+ };
994
+ /** @description transaction data as returned from the RPC (with slight enhancements) */
995
+ transaction: {
996
+ /**
997
+ * Format: hash
998
+ * @description the hash of the transaction
999
+ */
1000
+ hash?: string;
1001
+ /**
1002
+ * Format: hash
1003
+ * @description the hash of the block containing this transaction
1004
+ */
1005
+ blockHash?: string;
1006
+ /**
1007
+ * Format: blknum
1008
+ * @description the number of the block
1009
+ */
1010
+ blockNumber?: number;
1011
+ /**
1012
+ * Format: txnum
1013
+ * @description the zero-indexed position of the transaction in the block
1014
+ */
1015
+ transactionIndex?: number;
1016
+ /**
1017
+ * Format: value
1018
+ * @description sequence number of the transactions sent by the sender
1019
+ */
1020
+ nonce?: number;
1021
+ /**
1022
+ * Format: timestamp
1023
+ * @description the Unix timestamp of the object
1024
+ */
1025
+ timestamp?: number;
1026
+ /**
1027
+ * Format: datetime
1028
+ * @description the timestamp as a date (calculated)
1029
+ */
1030
+ date?: string;
1031
+ /**
1032
+ * Format: address
1033
+ * @description address from which the transaction was sent
1034
+ */
1035
+ from?: string;
1036
+ /**
1037
+ * Format: address
1038
+ * @description address to which the transaction was sent
1039
+ */
1040
+ to?: string;
1041
+ /**
1042
+ * Format: wei
1043
+ * @description the amount of wei sent with this transactions
1044
+ */
1045
+ value?: string;
1046
+ /**
1047
+ * Format: ether
1048
+ * @description if --ether is specified, the value in ether (calculated)
1049
+ */
1050
+ ether?: string;
1051
+ /**
1052
+ * Format: gas
1053
+ * @description the number of wei per unit of gas the sender is willing to spend
1054
+ */
1055
+ gasPrice?: number;
1056
+ /**
1057
+ * Format: gas
1058
+ * @description the maximum number of gas allowed for this transaction
1059
+ */
1060
+ gas?: number;
1061
+ /**
1062
+ * Format: bytes
1063
+ * @description byte data either containing a message or funcational data for a smart contracts. See the --articulate
1064
+ */
1065
+ input?: string;
1066
+ receipt?: Record<string, never>;
1067
+ /** @description array of reconciliation statements (calculated) */
1068
+ statements?: components["schemas"]["statement"][];
1069
+ articulatedTx?: Record<string, never>;
1070
+ /**
1071
+ * Format: boolean
1072
+ * @description `true` if the transaction is token related, `false` otherwise
1073
+ */
1074
+ hasToken?: boolean;
1075
+ /**
1076
+ * Format: boolean
1077
+ * @description `true` if the transaction ended in error, `false` otherwise
1078
+ */
1079
+ isError?: boolean;
1080
+ /**
1081
+ * Format: string
1082
+ * @description truncated, more readable version of the articulation (calculated)
1083
+ */
1084
+ compressedTx?: string;
1085
+ };
1086
+ /** @description withdrawal record for post-Shanghai withdrawals from the consensus layer */
1087
+ withdrawal: {
1088
+ /**
1089
+ * Format: address
1090
+ * @description the recipient for the withdrawn ether
1091
+ */
1092
+ address?: string;
1093
+ /**
1094
+ * Format: wei
1095
+ * @description a nonzero amount of ether given in gwei (1e9 wei)
1096
+ */
1097
+ amount?: string;
1098
+ /**
1099
+ * Format: ether
1100
+ * @description if --ether is specified, the amount in ether (calculated)
1101
+ */
1102
+ ether?: string;
1103
+ /**
1104
+ * Format: blknum
1105
+ * @description the number of this block
1106
+ */
1107
+ blockNumber?: number;
1108
+ /**
1109
+ * Format: value
1110
+ * @description a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal
1111
+ */
1112
+ index?: number;
1113
+ /**
1114
+ * Format: timestamp
1115
+ * @description the timestamp for this block
1116
+ */
1117
+ timestamp?: number;
1118
+ /**
1119
+ * Format: datetime
1120
+ * @description the timestamp as a date (calculated)
1121
+ */
1122
+ date?: string;
1123
+ /**
1124
+ * Format: value
1125
+ * @description the validator_index of the validator on the consensus layer the withdrawal corresponds to
1126
+ */
1127
+ validatorIndex?: number;
1128
+ };
1129
+ /** @description receipt data as returned from the RPC (with slight enhancements) */
1130
+ receipt: {
1131
+ /** Format: hash */
1132
+ blockHash?: string;
1133
+ /** Format: blknum */
1134
+ blockNumber?: number;
1135
+ /**
1136
+ * Format: address
1137
+ * @description the address of the newly created contract, if any
1138
+ */
1139
+ contractAddress?: string;
1140
+ /**
1141
+ * Format: gas
1142
+ * @description the amount of gas actually used by the transaction
1143
+ */
1144
+ gasUsed?: number;
1145
+ /** Format: boolean */
1146
+ isError?: boolean;
1147
+ /** @description a possibly empty array of logs */
1148
+ logs?: components["schemas"]["log"][];
1149
+ /**
1150
+ * Format: value
1151
+ * @description `1` on transaction suceess, `null` if tx precedes Byzantium, `0` otherwise
1152
+ */
1153
+ status?: number;
1154
+ /** Format: hash */
1155
+ transactionHash?: string;
1156
+ /** Format: txnum */
1157
+ transactionIndex?: number;
1158
+ };
1159
+ /** @description log data as returned from the RPC (with slight enhancements) */
1160
+ log: {
1161
+ /**
1162
+ * Format: blknum
1163
+ * @description the number of the block
1164
+ */
1165
+ blockNumber?: number;
1166
+ /**
1167
+ * Format: txnum
1168
+ * @description the zero-indexed position of the transaction in the block
1169
+ */
1170
+ transactionIndex?: number;
1171
+ /**
1172
+ * Format: lognum
1173
+ * @description the zero-indexed position of this log relative to the block
1174
+ */
1175
+ logIndex?: number;
1176
+ /**
1177
+ * Format: timestamp
1178
+ * @description the timestamp of the block this log appears in
1179
+ */
1180
+ timestamp?: number;
1181
+ /**
1182
+ * Format: datetime
1183
+ * @description the timestamp as a date (calculated)
1184
+ */
1185
+ date?: string;
1186
+ /**
1187
+ * Format: address
1188
+ * @description the smart contract that emitted this log
1189
+ */
1190
+ address?: string;
1191
+ /** @description first topic event signature up to 3 additional index parameters may appear */
1192
+ topics?: components["schemas"]["topic"][];
1193
+ /**
1194
+ * Format: bytes
1195
+ * @description any remaining un-indexed parameters to the event
1196
+ */
1197
+ data?: string;
1198
+ /**
1199
+ * Format: hash
1200
+ * @description the hash of the transction
1201
+ */
1202
+ transactionHash?: string;
1203
+ /**
1204
+ * Format: hash
1205
+ * @description the hash of the block
1206
+ */
1207
+ blockHash?: string;
1208
+ /** @description a human-readable version of the topic and data fields */
1209
+ articulatedLog?: Record<string, never>;
1210
+ /**
1211
+ * Format: string
1212
+ * @description a truncated, more readable version of the articulation (calculated)
1213
+ */
1214
+ compressedLog?: string;
1215
+ /**
1216
+ * Format: boolean
1217
+ * @description true if the log is an NFT transfer (calculated)
1218
+ */
1219
+ isNFT?: boolean;
1220
+ };
1221
+ /** @description trace data as returned from the RPC (with slight enhancements) */
1222
+ trace: {
1223
+ /**
1224
+ * Format: hash
1225
+ * @description the hash of the block containing this trace
1226
+ */
1227
+ blockHash?: string;
1228
+ /**
1229
+ * Format: blknum
1230
+ * @description the number of the block
1231
+ */
1232
+ blockNumber?: number;
1233
+ /**
1234
+ * Format: timestamp
1235
+ * @description the timestamp of the block
1236
+ */
1237
+ timestamp?: number;
1238
+ /**
1239
+ * Format: datetime
1240
+ * @description the timestamp as a date (calculated)
1241
+ */
1242
+ date?: string;
1243
+ /**
1244
+ * Format: hash
1245
+ * @description the transaction's hash containing this trace
1246
+ */
1247
+ transactionHash?: string;
1248
+ /**
1249
+ * Format: txnum
1250
+ * @description the zero-indexed position of the transaction in the block
1251
+ */
1252
+ transactionIndex?: number;
1253
+ /** @description a particular trace's address in the trace tree */
1254
+ traceAddress?: components["schemas"]["uint64"][];
1255
+ /**
1256
+ * Format: uint64
1257
+ * @description the number of children traces that the trace hash
1258
+ */
1259
+ subtraces?: number;
1260
+ /**
1261
+ * Format: string
1262
+ * @description the type of the trace
1263
+ */
1264
+ type?: string;
1265
+ /** @description the trace action for this trace */
1266
+ action?: Record<string, never>;
1267
+ /** @description the trace result of this trace */
1268
+ result?: Record<string, never>;
1269
+ /** @description human readable version of the trace action input data */
1270
+ articulatedTrace?: Record<string, never>;
1271
+ /**
1272
+ * Format: string
1273
+ * @description a compressed string version of the articulated trace (calculated)
1274
+ */
1275
+ compressedTrace?: string;
1276
+ };
1277
+ /** @description trace action data as returned from the RPC (with slight enhancements) */
1278
+ traceAction: {
1279
+ /**
1280
+ * Format: address
1281
+ * @description address from which the trace was sent
1282
+ */
1283
+ from?: string;
1284
+ /**
1285
+ * Format: address
1286
+ * @description address to which the trace was sent
1287
+ */
1288
+ to?: string;
1289
+ /**
1290
+ * Format: gas
1291
+ * @description the maximum number of gas allowed for this trace
1292
+ */
1293
+ gas?: number;
1294
+ /**
1295
+ * Format: bytes
1296
+ * @description an encoded version of the function call
1297
+ */
1298
+ input?: string;
1299
+ /**
1300
+ * Format: string
1301
+ * @description the type of call
1302
+ */
1303
+ callType?: string;
1304
+ /**
1305
+ * Format: address
1306
+ * @description if the call type is self-destruct, the address to which the refund is sent
1307
+ */
1308
+ refundAddress?: string;
1309
+ /**
1310
+ * Format: string
1311
+ * @description the type of reward
1312
+ */
1313
+ rewardType?: string;
1314
+ /**
1315
+ * Format: wei
1316
+ * @description the value (in wei) of this trace action
1317
+ */
1318
+ value?: string;
1319
+ /**
1320
+ * Format: ether
1321
+ * @description if --ether is specified, the value in ether (calculated)
1322
+ */
1323
+ ether?: string;
1324
+ /**
1325
+ * Format: address
1326
+ * @description `true` if the contract self-destructed, `false` otherwise
1327
+ */
1328
+ selfDestructed?: string;
1329
+ /**
1330
+ * Format: wei
1331
+ * @description if self-destructed, the balance of the contract at that time
1332
+ */
1333
+ balance?: string;
1334
+ /**
1335
+ * Format: ether
1336
+ * @description if --ether is specified, the balance in ether (calculated)
1337
+ */
1338
+ balanceEth?: string;
1339
+ };
1340
+ /** @description trace result data as returned from the RPC (with slight enhancements) */
1341
+ traceResult: {
1342
+ /**
1343
+ * Format: address
1344
+ * @description address of new contract, if any
1345
+ */
1346
+ address?: string;
1347
+ /**
1348
+ * Format: bytes
1349
+ * @description if this trace is creating a new smart contract, the byte code of that contract
1350
+ */
1351
+ code?: string;
1352
+ /**
1353
+ * Format: gas
1354
+ * @description the amount of gas used by this trace
1355
+ */
1356
+ gasUsed?: number;
1357
+ /**
1358
+ * Format: bytes
1359
+ * @description the result of the call of this trace
1360
+ */
1361
+ output?: string;
1362
+ };
1363
+ /** @description counts the number of traces in a transaction */
1364
+ traceCount: {
1365
+ /**
1366
+ * Format: blknum
1367
+ * @description the block number
1368
+ */
1369
+ blockNumber?: number;
1370
+ /**
1371
+ * Format: txnum
1372
+ * @description the transaction index
1373
+ */
1374
+ transactionIndex?: number;
1375
+ /**
1376
+ * Format: hash
1377
+ * @description the transaction's hash
1378
+ */
1379
+ transactionHash?: string;
1380
+ /**
1381
+ * Format: timestamp
1382
+ * @description the timestamp of the block
1383
+ */
1384
+ timestamp?: number;
1385
+ /**
1386
+ * Format: datetime
1387
+ * @description the timestamp as a date (calculated)
1388
+ */
1389
+ date?: string;
1390
+ /**
1391
+ * Format: uint64
1392
+ * @description the number of traces in the transaction
1393
+ */
1394
+ tracesCnt?: number;
1395
+ };
1396
+ /** @description used by chifra traces --filter option to query for traces */
1397
+ traceFilter: {
1398
+ /**
1399
+ * Format: blknum
1400
+ * @description the first block to include in the queried list of traces.
1401
+ */
1402
+ fromBlock?: number;
1403
+ /**
1404
+ * Format: blknum
1405
+ * @description the last block to include in the queried list of traces.
1406
+ */
1407
+ toBlock?: number;
1408
+ /**
1409
+ * Format: address
1410
+ * @description if included, only traces `from` this address will be included.
1411
+ */
1412
+ fromAddress?: string;
1413
+ /**
1414
+ * Format: address
1415
+ * @description if included, only traces `to` this address will be included.
1416
+ */
1417
+ toAddress?: string;
1418
+ /**
1419
+ * Format: uint64
1420
+ * @description only traces after this many traces are included.
1421
+ */
1422
+ after?: number;
1423
+ /**
1424
+ * Format: uint64
1425
+ * @description only this many traces are included.
1426
+ */
1427
+ count?: number;
1428
+ };
1429
+ /** @description counts of various parts of the block data such as tx_count, trace_count, etc. */
1430
+ blockCount: {
1431
+ /**
1432
+ * Format: blknum
1433
+ * @description the block's block number
1434
+ */
1435
+ blockNumber?: number;
1436
+ /**
1437
+ * Format: timestamp
1438
+ * @description the timestamp of the block
1439
+ */
1440
+ timestamp?: number;
1441
+ /**
1442
+ * Format: datetime
1443
+ * @description the timestamp as a date (calculated)
1444
+ */
1445
+ date?: string;
1446
+ /**
1447
+ * Format: uint64
1448
+ * @description the number transactions in the block
1449
+ */
1450
+ transactionsCnt?: number;
1451
+ /**
1452
+ * Format: uint64
1453
+ * @description the number of uncles in the block
1454
+ */
1455
+ unclesCnt?: number;
1456
+ /**
1457
+ * Format: uint64
1458
+ * @description the number of logs in the block
1459
+ */
1460
+ logsCnt?: number;
1461
+ /**
1462
+ * Format: uint64
1463
+ * @description the number of traces in the block
1464
+ */
1465
+ tracesCnt?: number;
1466
+ /**
1467
+ * Format: uint64
1468
+ * @description the number of withdrawals in the block
1469
+ */
1470
+ withdrawalsCnt?: number;
1471
+ /**
1472
+ * Format: uint64
1473
+ * @description the number of address appearances in the block
1474
+ */
1475
+ addressCnt?: number;
1476
+ };
1477
+ /** @description a block that has been given a particular name such as `first` or `latest` */
1478
+ namedBlock: {
1479
+ /**
1480
+ * Format: blknum
1481
+ * @description the number of the block
1482
+ */
1483
+ blockNumber?: number;
1484
+ /**
1485
+ * Format: timestamp
1486
+ * @description the Unix timestamp of the block
1487
+ */
1488
+ timestamp?: number;
1489
+ /**
1490
+ * Format: datetime
1491
+ * @description the timestamp as a date (calculated)
1492
+ */
1493
+ date?: string;
1494
+ /**
1495
+ * Format: string
1496
+ * @description an optional name for the block
1497
+ */
1498
+ name?: string;
1499
+ /**
1500
+ * Format: string
1501
+ * @description an optional description of the block
1502
+ */
1503
+ description?: string;
1504
+ };
1505
+ /** @description the timestamp, date and difference in timestamp of previous block produced by chifra when */
1506
+ timestamp: {
1507
+ /**
1508
+ * Format: blknum
1509
+ * @description the number of the block
1510
+ */
1511
+ blockNumber?: number;
1512
+ /**
1513
+ * Format: timestamp
1514
+ * @description the Unix timestamp of the block
1515
+ */
1516
+ timestamp?: number;
1517
+ /**
1518
+ * Format: datetime
1519
+ * @description the timestamp as a date (calculated)
1520
+ */
1521
+ date?: string;
1522
+ /**
1523
+ * Format: int64
1524
+ * @description the number of seconds since the last block
1525
+ */
1526
+ diff?: number;
1527
+ };
1528
+ /** @description a block containing only the hashes of the transactions */
1529
+ lightBlock: {
1530
+ /**
1531
+ * Format: gas
1532
+ * @description the system-wide maximum amount of gas permitted in this block
1533
+ */
1534
+ gasLimit?: number;
1535
+ /**
1536
+ * Format: hash
1537
+ * @description the hash of the current block
1538
+ */
1539
+ hash?: string;
1540
+ /**
1541
+ * Format: blknum
1542
+ * @description the number of the block
1543
+ */
1544
+ blockNumber?: number;
1545
+ /**
1546
+ * Format: hash
1547
+ * @description hash of previous block
1548
+ */
1549
+ parentHash?: string;
1550
+ /**
1551
+ * Format: address
1552
+ * @description address of block's winning miner
1553
+ */
1554
+ miner?: string;
1555
+ /**
1556
+ * Format: value
1557
+ * @description the computational difficulty at this block
1558
+ */
1559
+ difficulty?: number;
1560
+ /**
1561
+ * Format: timestamp
1562
+ * @description the Unix timestamp of the object
1563
+ */
1564
+ timestamp?: number;
1565
+ /**
1566
+ * Format: datetime
1567
+ * @description the timestamp as a date (calculated)
1568
+ */
1569
+ date?: string;
1570
+ /** @description a possibly empty array of transaction hashes */
1571
+ transactions?: components["schemas"]["string"][];
1572
+ /**
1573
+ * Format: gas
1574
+ * @description the base fee for this block
1575
+ */
1576
+ baseFeePerGas?: number;
1577
+ /** @description a possibly empty array of uncle hashes */
1578
+ uncles?: components["schemas"]["hash"][];
1579
+ /** @description a possibly empty array of withdrawals (post Shanghai) */
1580
+ withdrawals?: components["schemas"]["withdrawal"][];
1581
+ };
1582
+ /** @description the state of an Ethereum account (EOA or smart contract) on-chain */
1583
+ state: {
1584
+ /**
1585
+ * Format: blknum
1586
+ * @description the block number at which this call was made
1587
+ */
1588
+ blockNumber?: number;
1589
+ /**
1590
+ * Format: timestamp
1591
+ * @description the timestamp of the block for this call
1592
+ */
1593
+ timestamp?: number;
1594
+ /**
1595
+ * Format: datetime
1596
+ * @description the timestamp as a date (calculated)
1597
+ */
1598
+ date?: string;
1599
+ /**
1600
+ * Format: address
1601
+ * @description the address of contract being called
1602
+ */
1603
+ address?: string;
1604
+ /**
1605
+ * Format: string
1606
+ * @description the type of account at the given block
1607
+ */
1608
+ accountType?: string;
1609
+ /**
1610
+ * Format: wei
1611
+ * @description the balance of the account at the given block
1612
+ */
1613
+ balance?: string;
1614
+ /**
1615
+ * Format: ether
1616
+ * @description if --ether is specified, the balance in ether (calculated)
1617
+ */
1618
+ ether?: string;
1619
+ /**
1620
+ * Format: string
1621
+ * @description the code of the account
1622
+ */
1623
+ code?: string;
1624
+ /**
1625
+ * Format: blknum
1626
+ * @description for smart contracts only, the block number at which the contract was deployed
1627
+ */
1628
+ deployed?: number;
1629
+ /**
1630
+ * Format: value
1631
+ * @description the nonce of the account at the given block
1632
+ */
1633
+ nonce?: number;
1634
+ /**
1635
+ * Format: address
1636
+ * @description the proxy address of the account at the given block
1637
+ */
1638
+ proxy?: string;
1639
+ };
1640
+ /** @description on-chain token-related data such as totalSupply, symbol, decimals, and individual balances for a given address at a given block */
1641
+ token: {
1642
+ /**
1643
+ * Format: blknum
1644
+ * @description the block at which the report is made
1645
+ */
1646
+ blockNumber?: number;
1647
+ /**
1648
+ * Format: txnum
1649
+ * @description the transaction index (if applicable) at which the report is made
1650
+ */
1651
+ transactionIndex?: number;
1652
+ /**
1653
+ * Format: timestamp
1654
+ * @description the timestamp of the block
1655
+ */
1656
+ timestamp?: number;
1657
+ /**
1658
+ * Format: datetime
1659
+ * @description the timestamp as a date (calculated)
1660
+ */
1661
+ date?: string;
1662
+ /**
1663
+ * Format: int256
1664
+ * @description the total supply of the token contract
1665
+ */
1666
+ totalSupply?: string;
1667
+ /**
1668
+ * Format: address
1669
+ * @description the address of the token contract
1670
+ */
1671
+ address?: string;
1672
+ /**
1673
+ * Format: address
1674
+ * @description the holder address for which we are reporting
1675
+ */
1676
+ holder?: string;
1677
+ /**
1678
+ * Format: int256
1679
+ * @description the holder's asset balance at its prior appearance
1680
+ */
1681
+ priorBalance?: string;
1682
+ /**
1683
+ * Format: int256
1684
+ * @description the holder's asset balance at the given block height
1685
+ */
1686
+ balance?: string;
1687
+ /**
1688
+ * Format: float
1689
+ * @description the holder's asset balance (in Ether) at the given block height (calculated)
1690
+ */
1691
+ balanceDec?: number;
1692
+ /**
1693
+ * Format: int256
1694
+ * @description the difference, if any, between the prior and current balance (calculated)
1695
+ */
1696
+ diff?: string;
1697
+ /**
1698
+ * Format: string
1699
+ * @description the name of the token contract, if available
1700
+ */
1701
+ name?: string;
1702
+ /**
1703
+ * Format: string
1704
+ * @description the symbol of the token contract
1705
+ */
1706
+ symbol?: string;
1707
+ /**
1708
+ * Format: uint64
1709
+ * @description the number of decimals for the token contract
1710
+ */
1711
+ decimals?: number;
1712
+ /** @description the type of token (ERC20 or ERC721) or none */
1713
+ type?: Record<string, never>;
1714
+ };
1715
+ /** @description the result (articulated if possible, as bytes otherwise) of a call to a smart contract */
1716
+ result: {
1717
+ /**
1718
+ * Format: blknum
1719
+ * @description the block number at which this call was made
1720
+ */
1721
+ blockNumber?: number;
1722
+ /**
1723
+ * Format: timestamp
1724
+ * @description the timestamp of the block for this call
1725
+ */
1726
+ timestamp?: number;
1727
+ /**
1728
+ * Format: datetime
1729
+ * @description the timestamp as a date (calculated)
1730
+ */
1731
+ date?: string;
1732
+ /**
1733
+ * Format: address
1734
+ * @description the address of contract being called
1735
+ */
1736
+ address?: string;
1737
+ /**
1738
+ * Format: string
1739
+ * @description the name of the function call
1740
+ */
1741
+ name?: string;
1742
+ /**
1743
+ * Format: string
1744
+ * @description the encoding for the function call
1745
+ */
1746
+ encoding?: string;
1747
+ /**
1748
+ * Format: string
1749
+ * @description the canonical signature of the interface
1750
+ */
1751
+ signature?: string;
1752
+ /**
1753
+ * Format: string
1754
+ * @description the bytes data following the encoding of the call
1755
+ */
1756
+ encodedArguments?: string;
1757
+ /** @description the result of the call articulated as other models */
1758
+ articulatedOut?: Record<string, never>;
1759
+ };
1760
+ /** @description smart contract state and interaction data including read function results, write function forms, and event history */
1761
+ contract: {
1762
+ /**
1763
+ * Format: address
1764
+ * @description the address of this smart contract
1765
+ */
1766
+ address?: string;
1767
+ /**
1768
+ * Format: string
1769
+ * @description the name of this contract (if available)
1770
+ */
1771
+ name?: string;
1772
+ /** @description the ABI for this contract */
1773
+ abi?: Record<string, never>;
1774
+ /**
1775
+ * Format: timestamp
1776
+ * @description timestamp when this contract state was last updated
1777
+ */
1778
+ lastUpdated?: number;
1779
+ /**
1780
+ * Format: datetime
1781
+ * @description date when this contract state was last updated (calculated)
1782
+ */
1783
+ date?: string;
1784
+ /**
1785
+ * Format: int64
1786
+ * @description number of errors encountered when calling read functions
1787
+ */
1788
+ errorCount?: number;
1789
+ /**
1790
+ * Format: string
1791
+ * @description the most recent error message when calling functions
1792
+ */
1793
+ lastError?: string;
1794
+ };
1795
+ /** @description status-related data about the TrueBlocks system including the server and local binary caches */
1796
+ status: {
1797
+ /**
1798
+ * Format: string
1799
+ * @description the path to the local binary caches
1800
+ */
1801
+ cachePath?: string;
1802
+ /** @description a collection of information concerning the binary caches */
1803
+ caches?: components["schemas"]["cacheItem"][];
1804
+ /**
1805
+ * Format: string
1806
+ * @description the current chain
1807
+ */
1808
+ chain?: string;
1809
+ /**
1810
+ * Format: string
1811
+ * @description the path to the chain configuration folder
1812
+ */
1813
+ chainConfig?: string;
1814
+ /**
1815
+ * Format: string
1816
+ * @description the version string as reported by the rpcProvider
1817
+ */
1818
+ clientVersion?: string;
1819
+ /**
1820
+ * Format: string
1821
+ * @description the path to config files
1822
+ */
1823
+ chainId?: string;
1824
+ /**
1825
+ * Format: boolean
1826
+ * @description `true` if an Etherscan key is present
1827
+ */
1828
+ hasEsKey?: boolean;
1829
+ /**
1830
+ * Format: boolean
1831
+ * @description `true` if a Pinata API key is present
1832
+ */
1833
+ hasPinKey?: boolean;
1834
+ /**
1835
+ * Format: string
1836
+ * @description the path to the local binary indexes
1837
+ */
1838
+ indexPath?: string;
1839
+ /**
1840
+ * Format: boolean
1841
+ * @description `true` if the server is running in API mode
1842
+ */
1843
+ isApi?: boolean;
1844
+ /**
1845
+ * Format: boolean
1846
+ * @description `true` if the rpcProvider is an archive node
1847
+ */
1848
+ isArchive?: boolean;
1849
+ /**
1850
+ * Format: boolean
1851
+ * @description `true` if the server is running in test mode
1852
+ */
1853
+ isTesting?: boolean;
1854
+ /**
1855
+ * Format: boolean
1856
+ * @description `true` if the rpcProvider provides Parity traces
1857
+ */
1858
+ isTracing?: boolean;
1859
+ /**
1860
+ * Format: boolean
1861
+ * @description `true` if the scraper is running
1862
+ */
1863
+ isScraping?: boolean;
1864
+ /**
1865
+ * Format: string
1866
+ * @description the network id as reported by the rpcProvider
1867
+ */
1868
+ networkId?: string;
1869
+ /**
1870
+ * Format: string
1871
+ * @description the progress string of the system
1872
+ */
1873
+ progress?: string;
1874
+ /**
1875
+ * Format: string
1876
+ * @description the path to the root configuration folder
1877
+ */
1878
+ rootConfig?: string;
1879
+ /**
1880
+ * Format: string
1881
+ * @description the current rpcProvider
1882
+ */
1883
+ rpcProvider?: string;
1884
+ /**
1885
+ * Format: string
1886
+ * @description the TrueBlocks version string
1887
+ */
1888
+ version?: string;
1889
+ /** @description a list of available chains in the config file */
1890
+ chains?: components["schemas"]["chain"][];
1891
+ };
1892
+ /** @description a JSON object containing records for each bloom filter and index chunk in the Unchained Index */
1893
+ manifest: {
1894
+ /**
1895
+ * Format: string
1896
+ * @description the version string hashed into the chunk data
1897
+ */
1898
+ version?: string;
1899
+ /**
1900
+ * Format: string
1901
+ * @description the chain to which this manifest belongs
1902
+ */
1903
+ chain?: string;
1904
+ /**
1905
+ * Format: ipfshash
1906
+ * @description IPFS cid of the specification
1907
+ */
1908
+ specification?: string;
1909
+ /** @description a list of the IPFS hashes of all of the chunks in the unchained index */
1910
+ chunks?: components["schemas"]["chunkRecord"][];
1911
+ };
1912
+ /** @description a single record in the manifest detailing the IPFS hases and file sizes for each bloom filter and index chunk */
1913
+ chunkRecord: {
1914
+ /**
1915
+ * Format: blkrange
1916
+ * @description the block range (inclusive) covered by this chunk
1917
+ */
1918
+ range?: string;
1919
+ /**
1920
+ * Format: ipfshash
1921
+ * @description the IPFS hash of the bloom filter at that range
1922
+ */
1923
+ bloomHash?: string;
1924
+ /**
1925
+ * Format: ipfshash
1926
+ * @description the IPFS hash of the index chunk at that range
1927
+ */
1928
+ indexHash?: string;
1929
+ /**
1930
+ * Format: int64
1931
+ * @description the size of the bloom filter in bytes
1932
+ */
1933
+ bloomSize?: number;
1934
+ /**
1935
+ * Format: int64
1936
+ * @description the size of the index portion in bytes
1937
+ */
1938
+ indexSize?: number;
1939
+ /** @description if verbose, the block and timestamp bounds of the chunk (may be null) */
1940
+ rangeDates?: Record<string, never>;
1941
+ };
1942
+ /** @description internal-use only data model detailing a single index chunk file */
1943
+ chunkIndex: {
1944
+ /**
1945
+ * Format: blkrange
1946
+ * @description the block range (inclusive) covered by this chunk
1947
+ */
1948
+ range?: string;
1949
+ /**
1950
+ * Format: string
1951
+ * @description an internal use only magic number to indicate file format
1952
+ */
1953
+ magic?: string;
1954
+ /**
1955
+ * Format: hash
1956
+ * @description the hash of the specification under which this chunk was generated
1957
+ */
1958
+ hash?: string;
1959
+ /**
1960
+ * Format: uint64
1961
+ * @description the number of addresses in this chunk
1962
+ */
1963
+ nAddresses?: number;
1964
+ /**
1965
+ * Format: uint64
1966
+ * @description the number of appearances in this chunk
1967
+ */
1968
+ nAppearances?: number;
1969
+ /**
1970
+ * Format: uint64
1971
+ * @description the file size on disc in bytes of this bloom file
1972
+ */
1973
+ fileSize?: number;
1974
+ /** @description if verbose, the block and timestamp bounds of the chunk (may be null) */
1975
+ rangeDates?: Record<string, never>;
1976
+ };
1977
+ /** @description internal-use only data model detailing a single bloom filter file */
1978
+ chunkBloom: {
1979
+ /**
1980
+ * Format: blkrange
1981
+ * @description the block range (inclusive) covered by this chunk
1982
+ */
1983
+ range?: string;
1984
+ /**
1985
+ * Format: string
1986
+ * @description an internal use only magic number to indicate file format
1987
+ */
1988
+ magic?: string;
1989
+ /**
1990
+ * Format: hash
1991
+ * @description the hash of the specification under which this chunk was generated
1992
+ */
1993
+ hash?: string;
1994
+ /**
1995
+ * Format: uint64
1996
+ * @description the number of individual bloom filters in this bloom file
1997
+ */
1998
+ nBlooms?: number;
1999
+ /**
2000
+ * Format: uint64
2001
+ * @description the number of addresses inserted into the bloom file
2002
+ */
2003
+ nInserted?: number;
2004
+ /**
2005
+ * Format: uint64
2006
+ * @description the file size on disc in bytes of this bloom file
2007
+ */
2008
+ fileSize?: number;
2009
+ /**
2010
+ * Format: uint64
2011
+ * @description the width of the bloom filter
2012
+ */
2013
+ byteWidth?: number;
2014
+ /** @description if verbose, the block and timestamp bounds of the chunk (may be null) */
2015
+ rangeDates?: Record<string, never>;
2016
+ };
2017
+ /** @description internal-use only data model detailing a single address record in the address table of an index chunk */
2018
+ chunkAddress: {
2019
+ /**
2020
+ * Format: address
2021
+ * @description the address in this record
2022
+ */
2023
+ address?: string;
2024
+ /**
2025
+ * Format: blkrange
2026
+ * @description the block range of the chunk from which this address record was taken
2027
+ */
2028
+ range?: string;
2029
+ /**
2030
+ * Format: uint64
2031
+ * @description the offset into the appearance table of the first record for this address
2032
+ */
2033
+ offset?: number;
2034
+ /**
2035
+ * Format: uint64
2036
+ * @description the number of records in teh appearance table for this address
2037
+ */
2038
+ count?: number;
2039
+ /** @description if verbose, the block and timestamp bounds of the chunk (may be null) */
2040
+ rangeDates?: Record<string, never>;
2041
+ };
2042
+ /** @description internal-use only data model detailing a single remote or local ipfs pinned file */
2043
+ ipfsPin: {
2044
+ /**
2045
+ * Format: ipfshash
2046
+ * @description the CID of the file
2047
+ */
2048
+ cid?: string;
2049
+ /**
2050
+ * Format: string
2051
+ * @description the date the CID was first created
2052
+ */
2053
+ datePinned?: string;
2054
+ /**
2055
+ * Format: string
2056
+ * @description the status of the file (one of [all|pinned|unpinned|pending])
2057
+ */
2058
+ status?: string;
2059
+ /**
2060
+ * Format: int64
2061
+ * @description the size of the file in bytes
2062
+ */
2063
+ size?: number;
2064
+ /**
2065
+ * Format: string
2066
+ * @description the metadata name of the pinned file
2067
+ */
2068
+ fileName?: string;
2069
+ };
2070
+ /** @description summary statistics about an Unchained Index bloom filter and index chunk */
2071
+ chunkStats: {
2072
+ /**
2073
+ * Format: blkrange
2074
+ * @description the block range (inclusive) covered by this chunk
2075
+ */
2076
+ range?: string;
2077
+ /**
2078
+ * Format: uint64
2079
+ * @description the number of addresses in the chunk
2080
+ */
2081
+ nAddrs?: number;
2082
+ /**
2083
+ * Format: uint64
2084
+ * @description the number of appearances in the chunk
2085
+ */
2086
+ nApps?: number;
2087
+ /**
2088
+ * Format: uint64
2089
+ * @description the number of blocks in the chunk
2090
+ */
2091
+ nBlocks?: number;
2092
+ /**
2093
+ * Format: uint64
2094
+ * @description the number of bloom filters in the chunk's bloom
2095
+ */
2096
+ nBlooms?: number;
2097
+ /**
2098
+ * Format: uint64
2099
+ * @description the record width of a single bloom filter
2100
+ */
2101
+ recWid?: number;
2102
+ /**
2103
+ * Format: uint64
2104
+ * @description the size of the bloom filters on disc in bytes
2105
+ */
2106
+ bloomSz?: number;
2107
+ /**
2108
+ * Format: uint64
2109
+ * @description the size of the chunks on disc in bytes
2110
+ */
2111
+ chunkSz?: number;
2112
+ /**
2113
+ * Format: float64
2114
+ * @description the average number of addresses per block
2115
+ */
2116
+ addrsPerBlock?: number;
2117
+ /**
2118
+ * Format: float64
2119
+ * @description the average number of appearances per block
2120
+ */
2121
+ appsPerBlock?: number;
2122
+ /**
2123
+ * Format: float64
2124
+ * @description the average number of appearances per address
2125
+ */
2126
+ appsPerAddr?: number;
2127
+ /**
2128
+ * Format: float64
2129
+ * @description the ratio of appearances to addresses
2130
+ */
2131
+ ratio?: number;
2132
+ /** @description if verbose, the block and timestamp bounds of the chunk (may be null) */
2133
+ rangeDates?: Record<string, never>;
2134
+ };
2135
+ /** @description report on cleaning dups out of monitors */
2136
+ monitorClean: {
2137
+ /**
2138
+ * Format: address
2139
+ * @description the address being cleaned
2140
+ */
2141
+ address?: string;
2142
+ /**
2143
+ * Format: int64
2144
+ * @description the number of appearances in the monitor prior to cleaning
2145
+ */
2146
+ sizeThen?: number;
2147
+ /**
2148
+ * Format: int64
2149
+ * @description the number of appearances in the monitor after cleaning
2150
+ */
2151
+ sizeNow?: number;
2152
+ /**
2153
+ * Format: int64
2154
+ * @description the number of duplicates removed
2155
+ */
2156
+ dups?: number;
2157
+ /**
2158
+ * Format: boolean
2159
+ * @description `true` if the address is in the stage, `false` otherwise
2160
+ */
2161
+ staged?: boolean;
2162
+ /**
2163
+ * Format: boolean
2164
+ * @description `true` if the address was removed from the stage, `false` otherwise
2165
+ */
2166
+ removed?: boolean;
2167
+ };
2168
+ /** @description a single entry in the results of a status query when `--verbose` is enabled */
2169
+ cacheItem: {
2170
+ /**
2171
+ * Format: string
2172
+ * @description the type of the cache
2173
+ */
2174
+ type?: string;
2175
+ /** @description the individual items in the cache (if --verbose) */
2176
+ items?: components["schemas"]["any"][];
2177
+ /**
2178
+ * Format: string
2179
+ * @description the date of the most recent item added to the cache
2180
+ */
2181
+ lastCached?: string;
2182
+ /**
2183
+ * Format: uint64
2184
+ * @description the number of items in the cache
2185
+ */
2186
+ nFiles?: number;
2187
+ /**
2188
+ * Format: uint64
2189
+ * @description the number of folders holding that many items
2190
+ */
2191
+ nFolders?: number;
2192
+ /**
2193
+ * Format: string
2194
+ * @description the path to the top of the given cache
2195
+ */
2196
+ path?: string;
2197
+ /**
2198
+ * Format: int64
2199
+ * @description the size of the cache in bytes
2200
+ */
2201
+ sizeInBytes?: number;
2202
+ };
2203
+ /** @description report on checking contents of chunks */
2204
+ reportCheck: {
2205
+ /**
2206
+ * Format: string
2207
+ * @description the result of the check
2208
+ */
2209
+ result?: string;
2210
+ /**
2211
+ * Format: uint64
2212
+ * @description the number of visited items in the cache
2213
+ */
2214
+ visitedCnt?: number;
2215
+ /**
2216
+ * Format: uint64
2217
+ * @description the number of checks
2218
+ */
2219
+ checkedCnt?: number;
2220
+ /**
2221
+ * Format: uint64
2222
+ * @description the number of skipped checks
2223
+ */
2224
+ skippedCnt?: number;
2225
+ /**
2226
+ * Format: uint64
2227
+ * @description the number of passed checks
2228
+ */
2229
+ passedCnt?: number;
2230
+ /**
2231
+ * Format: uint64
2232
+ * @description the number of failed checks
2233
+ */
2234
+ failedCnt?: number;
2235
+ /** @description an array of messages explaining failed checks */
2236
+ msgStrings?: components["schemas"]["string"][];
2237
+ /**
2238
+ * Format: string
2239
+ * @description the reason for the test
2240
+ */
2241
+ reason?: string;
2242
+ };
2243
+ /** @description a JSON object containing the results of pinning the Unchained Index */
2244
+ chunkPin: {
2245
+ /**
2246
+ * Format: string
2247
+ * @description the version string hashed into the chunk data
2248
+ */
2249
+ version?: string;
2250
+ /**
2251
+ * Format: string
2252
+ * @description the chain to which this manifest belongs
2253
+ */
2254
+ chain?: string;
2255
+ /**
2256
+ * Format: ipfshash
2257
+ * @description IPFS cid of file containing timestamps
2258
+ */
2259
+ timestampHash?: string;
2260
+ /**
2261
+ * Format: ipfshash
2262
+ * @description IPFS cid of the specification
2263
+ */
2264
+ specHash?: string;
2265
+ /**
2266
+ * Format: ipfshash
2267
+ * @description IPFS cid of file containing CIDs for the various chunks
2268
+ */
2269
+ manifestHash?: string;
2270
+ };
2271
+ /** @description a configuration item carrying information about a single chain */
2272
+ chain: {
2273
+ /**
2274
+ * Format: string
2275
+ * @description the common name of the chain
2276
+ */
2277
+ chain?: string;
2278
+ /**
2279
+ * Format: uint64
2280
+ * @description the chain id as reported by the RPC
2281
+ */
2282
+ chainId?: number;
2283
+ /**
2284
+ * Format: string
2285
+ * @description the symbol of the base currency on the chain
2286
+ */
2287
+ symbol?: string;
2288
+ /**
2289
+ * Format: string
2290
+ * @description a valid RPC provider for the chain
2291
+ */
2292
+ rpcProvider?: string;
2293
+ /**
2294
+ * Format: string
2295
+ * @description a remote explorer for the chain such as Etherscan
2296
+ */
2297
+ remoteExplorer?: string;
2298
+ /**
2299
+ * Format: string
2300
+ * @description the local explorer for the chain (typically TrueBlocks Explorer)
2301
+ */
2302
+ localExplorer?: string;
2303
+ /**
2304
+ * Format: string
2305
+ * @description an IPFS gateway for pinning the index if enabled
2306
+ */
2307
+ ipfsGateway?: string;
2308
+ };
2309
+ /** @description shows first and last timestamps and dates for a given block range */
2310
+ rangeDates: {
2311
+ /**
2312
+ * Format: timestamp
2313
+ * @description the timestamp of the first block in this range
2314
+ */
2315
+ firstTs?: number;
2316
+ /**
2317
+ * Format: datetime
2318
+ * @description the first timestamp as a date
2319
+ */
2320
+ firstDate?: string;
2321
+ /**
2322
+ * Format: timestamp
2323
+ * @description the timestamp of the most recent block in this range
2324
+ */
2325
+ lastTs?: number;
2326
+ /**
2327
+ * Format: datetime
2328
+ * @description the last timestamp as a date
2329
+ */
2330
+ lastDate?: string;
2331
+ };
2332
+ /** @description a human-readable representation of a Solidity smart contract */
2333
+ abi: {
2334
+ /**
2335
+ * Format: address
2336
+ * @description the address for the ABI
2337
+ */
2338
+ address?: string;
2339
+ /**
2340
+ * Format: string
2341
+ * @description the filename of the ABI (likely the smart contract address)
2342
+ */
2343
+ name?: string;
2344
+ /**
2345
+ * Format: string
2346
+ * @description the folder holding the abi file
2347
+ */
2348
+ path?: string;
2349
+ /**
2350
+ * Format: int64
2351
+ * @description the size of this file on disc
2352
+ */
2353
+ fileSize?: number;
2354
+ /**
2355
+ * Format: string
2356
+ * @description the last update date of the file
2357
+ */
2358
+ lastModDate?: string;
2359
+ /**
2360
+ * Format: boolean
2361
+ * @description true if this is the ABI for a known smart contract or protocol
2362
+ */
2363
+ isKnown?: boolean;
2364
+ /**
2365
+ * Format: boolean
2366
+ * @description true if the ABI could not be found (and won't be looked for again)
2367
+ */
2368
+ isEmpty?: boolean;
2369
+ /**
2370
+ * Format: int64
2371
+ * @description if verbose, the number of functions in the ABI
2372
+ */
2373
+ nFunctions?: number;
2374
+ /**
2375
+ * Format: int64
2376
+ * @description if verbose, the number of events in the ABI
2377
+ */
2378
+ nEvents?: number;
2379
+ /**
2380
+ * Format: boolean
2381
+ * @description if verbose and the abi has a constructor, then `true`, else `false`
2382
+ */
2383
+ hasConstructor?: boolean;
2384
+ /**
2385
+ * Format: boolean
2386
+ * @description if verbose and the abi has a fallback, then `true`, else `false`
2387
+ */
2388
+ hasFallback?: boolean;
2389
+ /** @description the functions for this address */
2390
+ functions?: components["schemas"]["function"][];
2391
+ };
2392
+ /** @description a human-readable representation of a Solidity function call or event */
2393
+ function: {
2394
+ /**
2395
+ * Format: string
2396
+ * @description the name of the interface
2397
+ */
2398
+ name?: string;
2399
+ /**
2400
+ * Format: string
2401
+ * @description the type of the interface, either 'event' or 'function'
2402
+ */
2403
+ type?: string;
2404
+ /**
2405
+ * Format: string
2406
+ * @description the canonical signature of the interface
2407
+ */
2408
+ signature?: string;
2409
+ /**
2410
+ * Format: string
2411
+ * @description the signature encoded with keccak
2412
+ */
2413
+ encoding?: string;
2414
+ /** @description the input parameters to the function, if any */
2415
+ inputs?: components["schemas"]["parameter"][];
2416
+ /** @description the output parameters to the function, if any */
2417
+ outputs?: components["schemas"]["parameter"][];
2418
+ };
2419
+ /** @description an input or output parameter to a Solidity function or event */
2420
+ parameter: {
2421
+ /**
2422
+ * Format: string
2423
+ * @description the type of this parameter
2424
+ */
2425
+ type?: string;
2426
+ /**
2427
+ * Format: string
2428
+ * @description the name of this parameter
2429
+ */
2430
+ name?: string;
2431
+ /**
2432
+ * Format: string
2433
+ * @description the default value of this parameter, if any
2434
+ */
2435
+ strDefault?: string;
2436
+ /**
2437
+ * Format: boolean
2438
+ * @description `true` if this parameter is indexed
2439
+ */
2440
+ indexed?: boolean;
2441
+ /**
2442
+ * Format: string
2443
+ * @description for composite types, the internal type of the parameter
2444
+ */
2445
+ internalType?: string;
2446
+ /** @description for composite types, the parameters making up the composite */
2447
+ components?: components["schemas"]["parameter"][];
2448
+ };
2449
+ /** @description transaction data as returned from by remote APIs */
2450
+ slurp: {
2451
+ /**
2452
+ * Format: hash
2453
+ * @description the hash of the transaction
2454
+ */
2455
+ hash?: string;
2456
+ /**
2457
+ * Format: hash
2458
+ * @description the hash of the block containing this transaction
2459
+ */
2460
+ blockHash?: string;
2461
+ /**
2462
+ * Format: blknum
2463
+ * @description the number of the block
2464
+ */
2465
+ blockNumber?: number;
2466
+ /**
2467
+ * Format: txnum
2468
+ * @description the zero-indexed position of the transaction in the block
2469
+ */
2470
+ transactionIndex?: number;
2471
+ /**
2472
+ * Format: value
2473
+ * @description sequence number of the transactions sent by the sender
2474
+ */
2475
+ nonce?: number;
2476
+ /**
2477
+ * Format: timestamp
2478
+ * @description the Unix timestamp of the object
2479
+ */
2480
+ timestamp?: number;
2481
+ /**
2482
+ * Format: datetime
2483
+ * @description the timestamp as a date (calculated)
2484
+ */
2485
+ date?: string;
2486
+ /**
2487
+ * Format: address
2488
+ * @description address from which the transaction was sent
2489
+ */
2490
+ from?: string;
2491
+ /**
2492
+ * Format: address
2493
+ * @description address to which the transaction was sent
2494
+ */
2495
+ to?: string;
2496
+ /**
2497
+ * Format: wei
2498
+ * @description the amount of wei sent with this transactions
2499
+ */
2500
+ value?: string;
2501
+ /**
2502
+ * Format: ether
2503
+ * @description if --ether is specified, the value in ether (calculated)
2504
+ */
2505
+ ether?: string;
2506
+ /**
2507
+ * Format: gas
2508
+ * @description the maximum number of gas allowed for this transaction
2509
+ */
2510
+ gas?: number;
2511
+ /**
2512
+ * Format: gas
2513
+ * @description the number of wei per unit of gas the sender is willing to spend
2514
+ */
2515
+ gasPrice?: number;
2516
+ /**
2517
+ * Format: bytes
2518
+ * @description byte data either containing a message or funcational data for a smart contracts. See the --articulate
2519
+ */
2520
+ input?: string;
2521
+ /**
2522
+ * Format: boolean
2523
+ * @description `true` if the transaction is token related, `false` otherwise
2524
+ */
2525
+ hasToken?: boolean;
2526
+ /** @description if present, the function that was called in the transaction */
2527
+ articulatedTx?: Record<string, never>;
2528
+ /**
2529
+ * Format: string
2530
+ * @description truncated, more readable version of the articulation (calculated)
2531
+ */
2532
+ compressedTx?: string;
2533
+ /**
2534
+ * Format: boolean
2535
+ * @description `true` if the transaction ended in error, `false` otherwise
2536
+ */
2537
+ isError?: boolean;
2538
+ };
2539
+ /** @description used for various responses when no real data is generated */
2540
+ message: {
2541
+ /**
2542
+ * Format: string
2543
+ * @description the message
2544
+ */
2545
+ msg?: string;
2546
+ /**
2547
+ * Format: int64
2548
+ * @description a number if needed
2549
+ */
2550
+ num?: number;
2551
+ };
2552
+ /** @description the number of items in the given database */
2553
+ count: {
2554
+ /**
2555
+ * Format: uint64
2556
+ * @description the number of items in the given database
2557
+ */
2558
+ count?: number;
2559
+ };
2560
+ /** @description an enhanced url used by chifra explore */
2561
+ destination: {
2562
+ /**
2563
+ * Format: string
2564
+ * @description the term used to produce the url
2565
+ */
2566
+ term?: string;
2567
+ /** @description the type of the term */
2568
+ termType?: string;
2569
+ /**
2570
+ * Format: string
2571
+ * @description the url produced
2572
+ */
2573
+ url?: string;
2574
+ /**
2575
+ * Format: string
2576
+ * @description the option that produced the url
2577
+ */
2578
+ source?: string;
2579
+ };
2580
+ response: {
2581
+ data?: Record<string, never>;
2582
+ error?: string[];
2583
+ };
2584
+ /**
2585
+ * Format: hash
2586
+ * @description The 32-byte hash
2587
+ */
2588
+ hash: string;
2589
+ address: string;
2590
+ string: string;
2591
+ /** Format: uint64 */
2592
+ uint64: number;
2593
+ /**
2594
+ * Format: bytes
2595
+ * @description One of four 32-byte topics of a log
2596
+ */
2597
+ topic: string;
2598
+ /** @description an address record in the Unchained Index chunk */
2599
+ addrRecord: string;
2600
+ /** @description an appearance record in the Unchained Index chunk */
2601
+ appRecord: string;
2602
+ /** @description any cache item found in the binary cache */
2603
+ any: string;
2604
+ /** @description a string representing the token type */
2605
+ tokenType: string;
2606
+ };
2607
+ responses: never;
2608
+ parameters: never;
2609
+ requestBodies: never;
2610
+ headers: never;
2611
+ pathItems: never;
2612
+ }
2613
+ export type $defs = Record<string, never>;
2614
+ export interface operations {
2615
+ "accounts-list": {
2616
+ parameters: {
2617
+ query: {
2618
+ /** @description one or more addresses (0x...) to list */
2619
+ addrs: string[];
2620
+ /** @description display only the count of records for each monitor */
2621
+ count?: boolean;
2622
+ /** @description for the --count option only, suppress the display of zero appearance accounts */
2623
+ noZero?: boolean;
2624
+ /** @description report first and last block this address appears */
2625
+ bounds?: boolean;
2626
+ /** @description list transactions labeled unripe (i.e. less than 28 blocks old) */
2627
+ unripe?: boolean;
2628
+ /** @description freshen the monitor only (no reporting) */
2629
+ silent?: boolean;
2630
+ /** @description the first record to process */
2631
+ firstRecord?: number;
2632
+ /** @description the maximum number of records to process */
2633
+ maxRecords?: number;
2634
+ /** @description produce results in reverse chronological order */
2635
+ reversed?: boolean;
2636
+ /** @description first block to export (inclusive, ignored when freshening) */
2637
+ firstBlock?: number;
2638
+ /** @description last block to export (inclusive, ignored when freshening) */
2639
+ lastBlock?: number;
2640
+ /** @description the chain to use */
2641
+ chain?: string;
2642
+ /** @description suppress the header in the output */
2643
+ noHeader?: boolean;
2644
+ /** @description export format, one of [ txt | csv | json ] */
2645
+ fmt?: string;
2646
+ };
2647
+ header?: never;
2648
+ path?: never;
2649
+ cookie?: never;
2650
+ };
2651
+ requestBody?: never;
2652
+ responses: {
2653
+ /** @description returns the requested data */
2654
+ 200: {
2655
+ headers: {
2656
+ [name: string]: unknown;
2657
+ };
2658
+ content: {
2659
+ "application/json": {
2660
+ /** @description Produces <a href="/data-model/accounts/#appearance">Appearance</a>, <a href="/data-model/accounts/#bounds">Bounds</a> or <a href="/data-model/accounts/#monitor">Monitor</a> data. Corresponds to the <a href="/chifra/accounts/#chifra-list">chifra list</a> command line. */
2661
+ data?: (components["schemas"]["appearance"] | components["schemas"]["bounds"] | components["schemas"]["monitor"])[];
2662
+ };
2663
+ };
2664
+ };
2665
+ /** @description bad input parameter */
2666
+ 400: {
2667
+ headers: {
2668
+ [name: string]: unknown;
2669
+ };
2670
+ content?: never;
2671
+ };
2672
+ };
2673
+ };
2674
+ "accounts-export": {
2675
+ parameters: {
2676
+ query: {
2677
+ /** @description one or more addresses (0x...) to export */
2678
+ addrs: string[];
2679
+ /** @description filter by one or more log topics (only for --logs option) */
2680
+ topics?: string[];
2681
+ /** @description filter by one or more fourbytes (only for transactions and trace options) */
2682
+ fourbytes?: string[];
2683
+ /** @description export a list of appearances */
2684
+ appearances?: boolean;
2685
+ /** @description export receipts instead of transactional data */
2686
+ receipts?: boolean;
2687
+ /** @description export logs instead of transactional data */
2688
+ logs?: boolean;
2689
+ /** @description export all token approval transactions for the given address */
2690
+ approvals?: boolean;
2691
+ /** @description export traces instead of transactional data */
2692
+ traces?: boolean;
2693
+ /** @description export the neighbors of the given address */
2694
+ neighbors?: boolean;
2695
+ /** @description export only statements */
2696
+ statements?: boolean;
2697
+ /** @description export only eth or token transfers */
2698
+ transfers?: boolean;
2699
+ /** @description list all assets (with names) that appear in any transfer */
2700
+ assets?: boolean;
2701
+ /** @description traverse the transaction history and show each change in ETH balances */
2702
+ balances?: boolean;
2703
+ /** @description export withdrawals for the given address */
2704
+ withdrawals?: boolean;
2705
+ /** @description articulate transactions, traces, logs, and outputs */
2706
+ articulate?: boolean;
2707
+ /** @description force the transaction's traces into the cache */
2708
+ cacheTraces?: boolean;
2709
+ /** @description for --appearances mode only, display only the count of records */
2710
+ count?: boolean;
2711
+ /** @description the first record to process */
2712
+ firstRecord?: number;
2713
+ /** @description the maximum number of records to process */
2714
+ maxRecords?: number;
2715
+ /** @description for log and accounting export only, export only logs relevant to one of the given export addresses */
2716
+ relevant?: boolean;
2717
+ /** @description for the --logs option only, filter logs to show only those logs emitted by the given address(es) */
2718
+ emitter?: string[];
2719
+ /** @description for the --logs option only, filter logs to show only those with this topic(s) */
2720
+ topic?: string[];
2721
+ /** @description for the --logs option only, filter logs to show only nft transfers */
2722
+ nfts?: boolean;
2723
+ /** @description export only transactions that were reverted */
2724
+ reverted?: boolean;
2725
+ /** @description export transfers, balances, or statements only for this asset */
2726
+ asset?: string[];
2727
+ /** @description export transfers, balances, or statements with incoming, outgoing, or zero value */
2728
+ flow?: "in" | "out" | "zero";
2729
+ /** @description for --traces only, report addresses created by (or self-destructed by) the given address(es) */
2730
+ factory?: boolean;
2731
+ /** @description export transactions labeled unripe (i.e. less than 28 blocks old) */
2732
+ unripe?: boolean;
2733
+ /** @description produce results in reverse chronological order */
2734
+ reversed?: boolean;
2735
+ /** @description for the --count option only, suppress the display of zero appearance accounts */
2736
+ noZero?: boolean;
2737
+ /** @description first block to process (inclusive) */
2738
+ firstBlock?: number;
2739
+ /** @description last block to process (inclusive) */
2740
+ lastBlock?: number;
2741
+ /** @description deprecated option, you may simply remove it */
2742
+ accounting?: boolean;
2743
+ /** @description the chain to use */
2744
+ chain?: string;
2745
+ /** @description suppress the header in the output */
2746
+ noHeader?: boolean;
2747
+ /** @description force the results of the query into the cache */
2748
+ cache?: boolean;
2749
+ /** @description removes related items from the cache */
2750
+ decache?: boolean;
2751
+ /** @description export values in ether */
2752
+ ether?: boolean;
2753
+ /** @description export format, one of [ txt | csv | json ] */
2754
+ fmt?: string;
2755
+ };
2756
+ header?: never;
2757
+ path?: never;
2758
+ cookie?: never;
2759
+ };
2760
+ requestBody?: never;
2761
+ responses: {
2762
+ /** @description returns the requested data */
2763
+ 200: {
2764
+ headers: {
2765
+ [name: string]: unknown;
2766
+ };
2767
+ content: {
2768
+ "application/json": {
2769
+ /** @description Produces <a href="/data-model/accounts/#appearance">Appearance</a>, <a href="/data-model/other/#function">Function</a>, <a href="/data-model/chaindata/#log">Log</a>, <a href="/data-model/other/#message">Message</a>, <a href="/data-model/accounts/#monitor">Monitor</a>, <a href="/data-model/other/#parameter">Parameter</a>, <a href="/data-model/chaindata/#receipt">Receipt</a>, <a href="/data-model/accounts/#statement">Statement</a>, <a href="/data-model/chainstate/#token">Token</a>, <a href="/data-model/chaindata/#trace">Trace</a>, <a href="/data-model/chaindata/#traceaction">TraceAction</a>, <a href="/data-model/chaindata/#traceresult">TraceResult</a>, <a href="/data-model/chaindata/#transaction">Transaction</a>, <a href="/data-model/accounts/#transfer">Transfer</a> or <a href="/data-model/chaindata/#withdrawal">Withdrawal</a> data. Corresponds to the <a href="/chifra/accounts/#chifra-export">chifra export</a> command line. */
2770
+ data?: (components["schemas"]["appearance"] | components["schemas"]["function"] | components["schemas"]["log"] | components["schemas"]["message"] | components["schemas"]["monitor"] | components["schemas"]["parameter"] | components["schemas"]["receipt"] | components["schemas"]["statement"] | components["schemas"]["token"] | components["schemas"]["trace"] | components["schemas"]["traceAction"] | components["schemas"]["traceResult"] | components["schemas"]["transaction"] | components["schemas"]["transfer"] | components["schemas"]["withdrawal"])[];
2771
+ };
2772
+ };
2773
+ };
2774
+ /** @description bad input parameter */
2775
+ 400: {
2776
+ headers: {
2777
+ [name: string]: unknown;
2778
+ };
2779
+ content?: never;
2780
+ };
2781
+ };
2782
+ };
2783
+ "accounts-monitors": {
2784
+ parameters: {
2785
+ query?: {
2786
+ /** @description one or more addresses (0x...) to process */
2787
+ addrs?: string[];
2788
+ /** @description delete a monitor, but do not remove it */
2789
+ delete?: boolean;
2790
+ /** @description undelete a previously deleted monitor */
2791
+ undelete?: boolean;
2792
+ /** @description remove a previously deleted monitor */
2793
+ remove?: boolean;
2794
+ /** @description clean (i.e. remove duplicate appearances) from monitors, optionally clear stage */
2795
+ clean?: boolean;
2796
+ /** @description list monitors in the cache (--verbose for more detail) */
2797
+ list?: boolean;
2798
+ /** @description show the number of active monitors (included deleted but not removed monitors) */
2799
+ count?: boolean;
2800
+ /** @description for --clean, --list, and --count options only, include staged monitors */
2801
+ staged?: boolean;
2802
+ /** @description the chain to use */
2803
+ chain?: string;
2804
+ /** @description suppress the header in the output */
2805
+ noHeader?: boolean;
2806
+ /** @description force the results of the query into the cache */
2807
+ cache?: boolean;
2808
+ /** @description removes related items from the cache */
2809
+ decache?: boolean;
2810
+ /** @description export format, one of [ txt | csv | json ] */
2811
+ fmt?: string;
2812
+ };
2813
+ header?: never;
2814
+ path?: never;
2815
+ cookie?: never;
2816
+ };
2817
+ requestBody?: never;
2818
+ responses: {
2819
+ /** @description returns the requested data */
2820
+ 200: {
2821
+ headers: {
2822
+ [name: string]: unknown;
2823
+ };
2824
+ content: {
2825
+ "application/json": {
2826
+ /** @description Produces <a href="/data-model/other/#message">Message</a>, <a href="/data-model/accounts/#monitor">Monitor</a> or <a href="/data-model/admin/#monitorclean">MonitorClean</a> data. Corresponds to the <a href="/chifra/accounts/#chifra-monitors">chifra monitors</a> command line. */
2827
+ data?: (components["schemas"]["message"] | components["schemas"]["monitor"] | components["schemas"]["monitorClean"])[];
2828
+ };
2829
+ };
2830
+ };
2831
+ /** @description bad input parameter */
2832
+ 400: {
2833
+ headers: {
2834
+ [name: string]: unknown;
2835
+ };
2836
+ content?: never;
2837
+ };
2838
+ };
2839
+ };
2840
+ "accounts-names": {
2841
+ parameters: {
2842
+ query: {
2843
+ /** @description a space separated list of one or more search terms */
2844
+ terms: string[];
2845
+ /** @description expand search to include all fields (search name, address, and symbol otherwise) */
2846
+ expand?: boolean;
2847
+ /** @description do case-sensitive search */
2848
+ matchCase?: boolean;
2849
+ /** @description include all (including custom) names in the search */
2850
+ all?: boolean;
2851
+ /** @description include only custom named accounts in the search */
2852
+ custom?: boolean;
2853
+ /** @description include prefund accounts in the search */
2854
+ prefund?: boolean;
2855
+ /** @description display only addresses in the results (useful for scripting, assumes --no_header) */
2856
+ addr?: boolean;
2857
+ /** @description export the list of tags and subtags only */
2858
+ tags?: boolean;
2859
+ /** @description clean the data (addrs to lower case, sort by addr) */
2860
+ clean?: boolean;
2861
+ /** @description only available with --clean, cleans regular names database */
2862
+ regular?: boolean;
2863
+ /** @description return the number of names matching the search terms or other options */
2864
+ count?: boolean;
2865
+ /** @description only available with --clean or --autoname, outputs changes to stdout instead of updating databases */
2866
+ dryRun?: boolean;
2867
+ /** @description an address assumed to be a token, added automatically to names database if true */
2868
+ autoname?: string;
2869
+ /** @description create a new item */
2870
+ create?: string;
2871
+ /** @description update an existing item */
2872
+ update?: string;
2873
+ /** @description delete the item, but do not remove it */
2874
+ delete?: string;
2875
+ /** @description undelete a previously deleted item */
2876
+ undelete?: string;
2877
+ /** @description remove a previously deleted item */
2878
+ remove?: string;
2879
+ /** @description the chain to use */
2880
+ chain?: string;
2881
+ /** @description suppress the header in the output */
2882
+ noHeader?: boolean;
2883
+ /** @description export format, one of [ txt | csv | json ] */
2884
+ fmt?: string;
2885
+ };
2886
+ header?: never;
2887
+ path?: never;
2888
+ cookie?: never;
2889
+ };
2890
+ requestBody?: never;
2891
+ responses: {
2892
+ /** @description returns the requested data */
2893
+ 200: {
2894
+ headers: {
2895
+ [name: string]: unknown;
2896
+ };
2897
+ content: {
2898
+ "application/json": {
2899
+ /** @description Produces <a href="/data-model/other/#message">Message</a> or <a href="/data-model/accounts/#name">Name</a> data. Corresponds to the <a href="/chifra/accounts/#chifra-names">chifra names</a> command line. */
2900
+ data?: (components["schemas"]["message"] | components["schemas"]["name"])[];
2901
+ };
2902
+ };
2903
+ };
2904
+ /** @description bad input parameter */
2905
+ 400: {
2906
+ headers: {
2907
+ [name: string]: unknown;
2908
+ };
2909
+ content?: never;
2910
+ };
2911
+ };
2912
+ };
2913
+ "accounts-abis": {
2914
+ parameters: {
2915
+ query: {
2916
+ /** @description a list of one or more smart contracts whose ABIs to display */
2917
+ addrs: string[];
2918
+ /** @description load common 'known' ABIs from cache */
2919
+ known?: boolean;
2920
+ /** @description redirects the query to this implementation */
2921
+ proxyFor?: string;
2922
+ /** @description a list of downloaded abi files */
2923
+ list?: boolean;
2924
+ /** @description show the functions and events instead of summaries for all abi files */
2925
+ details?: boolean;
2926
+ /** @description show the number of abis downloaded */
2927
+ count?: boolean;
2928
+ /** @description search for function or event declarations given a four- or 32-byte code(s) */
2929
+ find?: string[];
2930
+ /** @description for the --find option only, provide hints to speed up the search */
2931
+ hint?: string[];
2932
+ /** @description generate the 32-byte encoding for a given canonical function or event signature */
2933
+ encode?: string;
2934
+ /** @description the chain to use */
2935
+ chain?: string;
2936
+ /** @description suppress the header in the output */
2937
+ noHeader?: boolean;
2938
+ /** @description force the results of the query into the cache */
2939
+ cache?: boolean;
2940
+ /** @description removes related items from the cache */
2941
+ decache?: boolean;
2942
+ /** @description export format, one of [ txt | csv | json ] */
2943
+ fmt?: string;
2944
+ };
2945
+ header?: never;
2946
+ path?: never;
2947
+ cookie?: never;
2948
+ };
2949
+ requestBody?: never;
2950
+ responses: {
2951
+ /** @description returns the requested data */
2952
+ 200: {
2953
+ headers: {
2954
+ [name: string]: unknown;
2955
+ };
2956
+ content: {
2957
+ "application/json": {
2958
+ /** @description Produces <a href="/data-model/other/#abi">Abi</a>, <a href="/data-model/other/#function">Function</a> or <a href="/data-model/other/#parameter">Parameter</a> data. Corresponds to the <a href="/chifra/accounts/#chifra-abis">chifra abis</a> command line. */
2959
+ data?: (components["schemas"]["abi"] | components["schemas"]["function"] | components["schemas"]["parameter"])[];
2960
+ };
2961
+ };
2962
+ };
2963
+ /** @description bad input parameter */
2964
+ 400: {
2965
+ headers: {
2966
+ [name: string]: unknown;
2967
+ };
2968
+ content?: never;
2969
+ };
2970
+ };
2971
+ };
2972
+ "chaindata-blocks": {
2973
+ parameters: {
2974
+ query: {
2975
+ /** @description a space-separated list of one or more block identifiers */
2976
+ blocks: string[];
2977
+ /** @description display only transaction hashes, default is to display full transaction detail */
2978
+ hashes?: boolean;
2979
+ /** @description display uncle blocks (if any) instead of the requested block */
2980
+ uncles?: boolean;
2981
+ /** @description export the traces from the block as opposed to the block data */
2982
+ traces?: boolean;
2983
+ /** @description display a list of uniq address appearances per transaction */
2984
+ uniq?: boolean;
2985
+ /** @description for the --uniq option only, export only from or to (including trace from or to) */
2986
+ flow?: "from" | "to" | "reward";
2987
+ /** @description display only the logs found in the block(s) */
2988
+ logs?: boolean;
2989
+ /** @description for the --logs option only, filter logs to show only those logs emitted by the given address(es) */
2990
+ emitter?: string[];
2991
+ /** @description for the --logs option only, filter logs to show only those with this topic(s) */
2992
+ topic?: string[];
2993
+ /** @description export the withdrawals from the block as opposed to the block data */
2994
+ withdrawals?: boolean;
2995
+ /** @description for the --logs option only, articulate the retrieved data if ABIs can be found */
2996
+ articulate?: boolean;
2997
+ /** @description display only the count of appearances for --addrs or --uniq */
2998
+ count?: boolean;
2999
+ /** @description force a write of the block's transactions to the cache (slow) */
3000
+ cacheTxs?: boolean;
3001
+ /** @description force a write of the block's traces to the cache (slower) */
3002
+ cacheTraces?: boolean;
3003
+ /** @description the chain to use */
3004
+ chain?: string;
3005
+ /** @description suppress the header in the output */
3006
+ noHeader?: boolean;
3007
+ /** @description force the results of the query into the cache */
3008
+ cache?: boolean;
3009
+ /** @description removes related items from the cache */
3010
+ decache?: boolean;
3011
+ /** @description export values in ether */
3012
+ ether?: boolean;
3013
+ /** @description export format, one of [ txt | csv | json ] */
3014
+ fmt?: string;
3015
+ };
3016
+ header?: never;
3017
+ path?: never;
3018
+ cookie?: never;
3019
+ };
3020
+ requestBody?: never;
3021
+ responses: {
3022
+ /** @description returns the requested data */
3023
+ 200: {
3024
+ headers: {
3025
+ [name: string]: unknown;
3026
+ };
3027
+ content: {
3028
+ "application/json": {
3029
+ /** @description Produces <a href="/data-model/accounts/#appearance">Appearance</a>, <a href="/data-model/chaindata/#block">Block</a>, <a href="/data-model/chaindata/#blockcount">BlockCount</a>, <a href="/data-model/chaindata/#lightblock">LightBlock</a>, <a href="/data-model/chaindata/#log">Log</a>, <a href="/data-model/other/#message">Message</a>, <a href="/data-model/chaindata/#trace">Trace</a>, <a href="/data-model/chaindata/#traceaction">TraceAction</a>, <a href="/data-model/chaindata/#traceresult">TraceResult</a> or <a href="/data-model/chaindata/#withdrawal">Withdrawal</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-blocks">chifra blocks</a> command line. */
3030
+ data?: (components["schemas"]["appearance"] | components["schemas"]["block"] | components["schemas"]["blockCount"] | components["schemas"]["lightBlock"] | components["schemas"]["log"] | components["schemas"]["message"] | components["schemas"]["trace"] | components["schemas"]["traceAction"] | components["schemas"]["traceResult"] | components["schemas"]["withdrawal"])[];
3031
+ };
3032
+ };
3033
+ };
3034
+ /** @description bad input parameter */
3035
+ 400: {
3036
+ headers: {
3037
+ [name: string]: unknown;
3038
+ };
3039
+ content?: never;
3040
+ };
3041
+ };
3042
+ };
3043
+ "chaindata-transactions": {
3044
+ parameters: {
3045
+ query: {
3046
+ /** @description a space-separated list of one or more transaction identifiers */
3047
+ transactions: string[];
3048
+ /** @description articulate the retrieved data if ABIs can be found */
3049
+ articulate?: boolean;
3050
+ /** @description include the transaction's traces in the results */
3051
+ traces?: boolean;
3052
+ /** @description display a list of uniq addresses found in the transaction */
3053
+ uniq?: boolean;
3054
+ /** @description for the uniq option only, export only from or to (including trace from or to) */
3055
+ flow?: "from" | "to";
3056
+ /** @description display only the logs found in the transaction(s) */
3057
+ logs?: boolean;
3058
+ /** @description for the --logs option only, filter logs to show only those logs emitted by the given address(es) */
3059
+ emitter?: string[];
3060
+ /** @description for the --logs option only, filter logs to show only those with this topic(s) */
3061
+ topic?: string[];
3062
+ /** @description force the transaction's traces into the cache */
3063
+ cacheTraces?: boolean;
3064
+ /** @description the chain to use */
3065
+ chain?: string;
3066
+ /** @description suppress the header in the output */
3067
+ noHeader?: boolean;
3068
+ /** @description force the results of the query into the cache */
3069
+ cache?: boolean;
3070
+ /** @description removes related items from the cache */
3071
+ decache?: boolean;
3072
+ /** @description export values in ether */
3073
+ ether?: boolean;
3074
+ /** @description export format, one of [ txt | csv | json ] */
3075
+ fmt?: string;
3076
+ };
3077
+ header?: never;
3078
+ path?: never;
3079
+ cookie?: never;
3080
+ };
3081
+ requestBody?: never;
3082
+ responses: {
3083
+ /** @description returns the requested data */
3084
+ 200: {
3085
+ headers: {
3086
+ [name: string]: unknown;
3087
+ };
3088
+ content: {
3089
+ "application/json": {
3090
+ /** @description Produces <a href="/data-model/accounts/#appearance">Appearance</a>, <a href="/data-model/other/#function">Function</a>, <a href="/data-model/chaindata/#log">Log</a>, <a href="/data-model/other/#message">Message</a>, <a href="/data-model/other/#parameter">Parameter</a> or <a href="/data-model/chaindata/#transaction">Transaction</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-transactions">chifra transactions</a> command line. */
3091
+ data?: (components["schemas"]["appearance"] | components["schemas"]["function"] | components["schemas"]["log"] | components["schemas"]["message"] | components["schemas"]["parameter"] | components["schemas"]["transaction"])[];
3092
+ };
3093
+ };
3094
+ };
3095
+ /** @description bad input parameter */
3096
+ 400: {
3097
+ headers: {
3098
+ [name: string]: unknown;
3099
+ };
3100
+ content?: never;
3101
+ };
3102
+ };
3103
+ };
3104
+ "chaindata-receipts": {
3105
+ parameters: {
3106
+ query: {
3107
+ /** @description a space-separated list of one or more transaction identifiers */
3108
+ transactions: string[];
3109
+ /** @description articulate the retrieved data if ABIs can be found */
3110
+ articulate?: boolean;
3111
+ /** @description the chain to use */
3112
+ chain?: string;
3113
+ /** @description suppress the header in the output */
3114
+ noHeader?: boolean;
3115
+ /** @description force the results of the query into the cache */
3116
+ cache?: boolean;
3117
+ /** @description removes related items from the cache */
3118
+ decache?: boolean;
3119
+ /** @description export format, one of [ txt | csv | json ] */
3120
+ fmt?: string;
3121
+ };
3122
+ header?: never;
3123
+ path?: never;
3124
+ cookie?: never;
3125
+ };
3126
+ requestBody?: never;
3127
+ responses: {
3128
+ /** @description returns the requested data */
3129
+ 200: {
3130
+ headers: {
3131
+ [name: string]: unknown;
3132
+ };
3133
+ content: {
3134
+ "application/json": {
3135
+ /** @description Produces <a href="/data-model/other/#function">Function</a>, <a href="/data-model/other/#parameter">Parameter</a> or <a href="/data-model/chaindata/#receipt">Receipt</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-receipts">chifra receipts</a> command line. */
3136
+ data?: (components["schemas"]["function"] | components["schemas"]["parameter"] | components["schemas"]["receipt"])[];
3137
+ };
3138
+ };
3139
+ };
3140
+ /** @description bad input parameter */
3141
+ 400: {
3142
+ headers: {
3143
+ [name: string]: unknown;
3144
+ };
3145
+ content?: never;
3146
+ };
3147
+ };
3148
+ };
3149
+ "chaindata-logs": {
3150
+ parameters: {
3151
+ query: {
3152
+ /** @description a space-separated list of one or more transaction identifiers */
3153
+ transactions: string[];
3154
+ /** @description filter logs to show only those logs emitted by the given address(es) */
3155
+ emitter?: string[];
3156
+ /** @description filter logs to show only those with this topic(s) */
3157
+ topic?: string[];
3158
+ /** @description articulate the retrieved data if ABIs can be found */
3159
+ articulate?: boolean;
3160
+ /** @description the chain to use */
3161
+ chain?: string;
3162
+ /** @description suppress the header in the output */
3163
+ noHeader?: boolean;
3164
+ /** @description force the results of the query into the cache */
3165
+ cache?: boolean;
3166
+ /** @description removes related items from the cache */
3167
+ decache?: boolean;
3168
+ /** @description export format, one of [ txt | csv | json ] */
3169
+ fmt?: string;
3170
+ };
3171
+ header?: never;
3172
+ path?: never;
3173
+ cookie?: never;
3174
+ };
3175
+ requestBody?: never;
3176
+ responses: {
3177
+ /** @description returns the requested data */
3178
+ 200: {
3179
+ headers: {
3180
+ [name: string]: unknown;
3181
+ };
3182
+ content: {
3183
+ "application/json": {
3184
+ /** @description Produces <a href="/data-model/other/#function">Function</a>, <a href="/data-model/chaindata/#log">Log</a>, <a href="/data-model/other/#message">Message</a> or <a href="/data-model/other/#parameter">Parameter</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-logs">chifra logs</a> command line. */
3185
+ data?: (components["schemas"]["function"] | components["schemas"]["log"] | components["schemas"]["message"] | components["schemas"]["parameter"])[];
3186
+ };
3187
+ };
3188
+ };
3189
+ /** @description bad input parameter */
3190
+ 400: {
3191
+ headers: {
3192
+ [name: string]: unknown;
3193
+ };
3194
+ content?: never;
3195
+ };
3196
+ };
3197
+ };
3198
+ "chaindata-traces": {
3199
+ parameters: {
3200
+ query: {
3201
+ /** @description a space-separated list of one or more transaction identifiers */
3202
+ transactions: string[];
3203
+ /** @description articulate the retrieved data if ABIs can be found */
3204
+ articulate?: boolean;
3205
+ /** @description call the node's trace_filter routine with bang-separated filter */
3206
+ filter?: string;
3207
+ /** @description display only the number of traces for the transaction (fast) */
3208
+ count?: boolean;
3209
+ /** @description the chain to use */
3210
+ chain?: string;
3211
+ /** @description suppress the header in the output */
3212
+ noHeader?: boolean;
3213
+ /** @description force the results of the query into the cache */
3214
+ cache?: boolean;
3215
+ /** @description removes related items from the cache */
3216
+ decache?: boolean;
3217
+ /** @description export values in ether */
3218
+ ether?: boolean;
3219
+ /** @description export format, one of [ txt | csv | json ] */
3220
+ fmt?: string;
3221
+ };
3222
+ header?: never;
3223
+ path?: never;
3224
+ cookie?: never;
3225
+ };
3226
+ requestBody?: never;
3227
+ responses: {
3228
+ /** @description returns the requested data */
3229
+ 200: {
3230
+ headers: {
3231
+ [name: string]: unknown;
3232
+ };
3233
+ content: {
3234
+ "application/json": {
3235
+ /** @description Produces <a href="/data-model/other/#function">Function</a>, <a href="/data-model/other/#message">Message</a>, <a href="/data-model/other/#parameter">Parameter</a>, <a href="/data-model/chaindata/#trace">Trace</a>, <a href="/data-model/chaindata/#traceaction">TraceAction</a>, <a href="/data-model/chaindata/#tracecount">TraceCount</a>, <a href="/data-model/chaindata/#tracefilter">TraceFilter</a> or <a href="/data-model/chaindata/#traceresult">TraceResult</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-traces">chifra traces</a> command line. */
3236
+ data?: (components["schemas"]["function"] | components["schemas"]["message"] | components["schemas"]["parameter"] | components["schemas"]["trace"] | components["schemas"]["traceAction"] | components["schemas"]["traceCount"] | components["schemas"]["traceFilter"] | components["schemas"]["traceResult"])[];
3237
+ };
3238
+ };
3239
+ };
3240
+ /** @description bad input parameter */
3241
+ 400: {
3242
+ headers: {
3243
+ [name: string]: unknown;
3244
+ };
3245
+ content?: never;
3246
+ };
3247
+ };
3248
+ };
3249
+ "chaindata-when": {
3250
+ parameters: {
3251
+ query?: {
3252
+ /** @description one or more dates, block numbers, hashes, or special named blocks (see notes) */
3253
+ blocks?: string[];
3254
+ /** @description export a list of the 'special' blocks */
3255
+ list?: boolean;
3256
+ /** @description display or process timestamps */
3257
+ timestamps?: boolean;
3258
+ /** @description with --timestamps only, returns the number of timestamps in the cache */
3259
+ count?: boolean;
3260
+ /** @description with --timestamps only, repairs block(s) in the block range by re-querying from the chain */
3261
+ repair?: boolean;
3262
+ /** @description with --timestamps only, checks the validity of the timestamp data */
3263
+ check?: boolean;
3264
+ /** @description with --timestamps only, bring the timestamp database forward to the latest block */
3265
+ update?: boolean;
3266
+ /** @description with --timestamps --check only, verifies every N timestamp directly from the chain (slow) */
3267
+ deep?: number;
3268
+ /** @description the chain to use */
3269
+ chain?: string;
3270
+ /** @description suppress the header in the output */
3271
+ noHeader?: boolean;
3272
+ /** @description force the results of the query into the cache */
3273
+ cache?: boolean;
3274
+ /** @description removes related items from the cache */
3275
+ decache?: boolean;
3276
+ /** @description export format, one of [ txt | csv | json ] */
3277
+ fmt?: string;
3278
+ };
3279
+ header?: never;
3280
+ path?: never;
3281
+ cookie?: never;
3282
+ };
3283
+ requestBody?: never;
3284
+ responses: {
3285
+ /** @description returns the requested data */
3286
+ 200: {
3287
+ headers: {
3288
+ [name: string]: unknown;
3289
+ };
3290
+ content: {
3291
+ "application/json": {
3292
+ /** @description Produces <a href="/data-model/other/#count">Count</a>, <a href="/data-model/other/#message">Message</a>, <a href="/data-model/chaindata/#namedblock">NamedBlock</a> or <a href="/data-model/chaindata/#timestamp">Timestamp</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-when">chifra when</a> command line. */
3293
+ data?: (components["schemas"]["count"] | components["schemas"]["message"] | components["schemas"]["namedBlock"] | components["schemas"]["timestamp"])[];
3294
+ };
3295
+ };
3296
+ };
3297
+ /** @description bad input parameter */
3298
+ 400: {
3299
+ headers: {
3300
+ [name: string]: unknown;
3301
+ };
3302
+ content?: never;
3303
+ };
3304
+ };
3305
+ };
3306
+ "chainstate-state": {
3307
+ parameters: {
3308
+ query: {
3309
+ /** @description one or more addresses (0x...) from which to retrieve balances */
3310
+ addrs: string[];
3311
+ /** @description an optional list of one or more blocks at which to report balances, defaults to 'latest' */
3312
+ blocks?: string[];
3313
+ /** @description control which state to export */
3314
+ parts?: ("balance" | "nonce" | "code" | "proxy" | "deployed" | "accttype" | "some" | "all")[];
3315
+ /** @description only report a balance when it changes from one block to the next */
3316
+ changes?: boolean;
3317
+ /** @description suppress the display of zero balance accounts */
3318
+ noZero?: boolean;
3319
+ /** @description write-only call (a query) to a smart contract */
3320
+ call?: boolean;
3321
+ /** @description for commands (--call or --send), provides the call data (in various forms) for the command (may be empty for --send) */
3322
+ calldata?: string;
3323
+ /** @description for commands only, articulate the retrieved data if ABIs can be found */
3324
+ articulate?: boolean;
3325
+ /** @description for commands only, redirects calls to this implementation */
3326
+ proxyFor?: string;
3327
+ /** @description the chain to use */
3328
+ chain?: string;
3329
+ /** @description suppress the header in the output */
3330
+ noHeader?: boolean;
3331
+ /** @description force the results of the query into the cache */
3332
+ cache?: boolean;
3333
+ /** @description removes related items from the cache */
3334
+ decache?: boolean;
3335
+ /** @description export values in ether */
3336
+ ether?: boolean;
3337
+ /** @description export format, one of [ txt | csv | json ] */
3338
+ fmt?: string;
3339
+ };
3340
+ header?: never;
3341
+ path?: never;
3342
+ cookie?: never;
3343
+ };
3344
+ requestBody?: never;
3345
+ responses: {
3346
+ /** @description returns the requested data */
3347
+ 200: {
3348
+ headers: {
3349
+ [name: string]: unknown;
3350
+ };
3351
+ content: {
3352
+ "application/json": {
3353
+ /** @description Produces <a href="/data-model/other/#function">Function</a>, <a href="/data-model/other/#message">Message</a>, <a href="/data-model/other/#parameter">Parameter</a>, <a href="/data-model/chainstate/#result">Result</a> or <a href="/data-model/chainstate/#state">State</a> data. Corresponds to the <a href="/chifra/chainstate/#chifra-state">chifra state</a> command line. */
3354
+ data?: (components["schemas"]["function"] | components["schemas"]["message"] | components["schemas"]["parameter"] | components["schemas"]["result"] | components["schemas"]["state"])[];
3355
+ };
3356
+ };
3357
+ };
3358
+ /** @description bad input parameter */
3359
+ 400: {
3360
+ headers: {
3361
+ [name: string]: unknown;
3362
+ };
3363
+ content?: never;
3364
+ };
3365
+ };
3366
+ };
3367
+ "chainstate-tokens": {
3368
+ parameters: {
3369
+ query: {
3370
+ /** @description two or more addresses (one for --approvals), the first is an ERC20 token, balances for the rest are reported */
3371
+ addrs: string[];
3372
+ /** @description an optional list of one or more blocks at which to report balances, defaults to 'latest' */
3373
+ blocks?: string[];
3374
+ /** @description returns all open approvals for the given address(es) */
3375
+ approvals?: boolean;
3376
+ /** @description which parts of the token information to retrieve */
3377
+ parts?: ("name" | "symbol" | "decimals" | "totalSupply" | "version" | "some" | "all")[];
3378
+ /** @description consider each address an ERC20 token except the last, whose balance is reported for each token */
3379
+ byAcct?: boolean;
3380
+ /** @description only report a balance when it changes from one block to the next */
3381
+ changes?: boolean;
3382
+ /** @description suppress the display of zero balance accounts */
3383
+ noZero?: boolean;
3384
+ /** @description the chain to use */
3385
+ chain?: string;
3386
+ /** @description suppress the header in the output */
3387
+ noHeader?: boolean;
3388
+ /** @description force the results of the query into the cache */
3389
+ cache?: boolean;
3390
+ /** @description removes related items from the cache */
3391
+ decache?: boolean;
3392
+ /** @description export format, one of [ txt | csv | json ] */
3393
+ fmt?: string;
3394
+ };
3395
+ header?: never;
3396
+ path?: never;
3397
+ cookie?: never;
3398
+ };
3399
+ requestBody?: never;
3400
+ responses: {
3401
+ /** @description returns the requested data */
3402
+ 200: {
3403
+ headers: {
3404
+ [name: string]: unknown;
3405
+ };
3406
+ content: {
3407
+ "application/json": {
3408
+ /** @description Produces <a href="/data-model/accounts/#approval">Approval</a> or <a href="/data-model/chainstate/#token">Token</a> data. Corresponds to the <a href="/chifra/chainstate/#chifra-tokens">chifra tokens</a> command line. */
3409
+ data?: (components["schemas"]["approval"] | components["schemas"]["token"])[];
3410
+ };
3411
+ };
3412
+ };
3413
+ /** @description bad input parameter */
3414
+ 400: {
3415
+ headers: {
3416
+ [name: string]: unknown;
3417
+ };
3418
+ content?: never;
3419
+ };
3420
+ };
3421
+ };
3422
+ "admin-config": {
3423
+ parameters: {
3424
+ query?: {
3425
+ /** @description either show or edit the configuration */
3426
+ mode?: "show" | "edit";
3427
+ /** @description show the configuration paths for the system */
3428
+ paths?: boolean;
3429
+ /** @description dump the configuration to stdout */
3430
+ dump?: boolean;
3431
+ /** @description the chain to use */
3432
+ chain?: string;
3433
+ /** @description suppress the header in the output */
3434
+ noHeader?: boolean;
3435
+ /** @description export format, one of [ txt | csv | json ] */
3436
+ fmt?: string;
3437
+ };
3438
+ header?: never;
3439
+ path?: never;
3440
+ cookie?: never;
3441
+ };
3442
+ requestBody?: never;
3443
+ responses: {
3444
+ /** @description returns the requested data */
3445
+ 200: {
3446
+ headers: {
3447
+ [name: string]: unknown;
3448
+ };
3449
+ content: {
3450
+ "application/json": {
3451
+ /** @description Produces <a href="/data-model/admin/#chain">Chain</a> data. Corresponds to the <a href="/chifra/admin/#chifra-config">chifra config</a> command line. */
3452
+ data?: components["schemas"]["chain"][];
3453
+ };
3454
+ };
3455
+ };
3456
+ /** @description bad input parameter */
3457
+ 400: {
3458
+ headers: {
3459
+ [name: string]: unknown;
3460
+ };
3461
+ content?: never;
3462
+ };
3463
+ };
3464
+ };
3465
+ "admin-status": {
3466
+ parameters: {
3467
+ query?: {
3468
+ /** @description the (optional) name of the binary cache to report on, terse otherwise */
3469
+ modes?: ("index" | "blooms" | "blocks" | "transactions" | "traces" | "logs" | "statements" | "results" | "state" | "tokens" | "monitors" | "names" | "abis" | "slurps" | "staging" | "unripe" | "maps" | "some" | "all")[];
3470
+ /** @description same as the default but with additional diagnostics */
3471
+ diagnose?: boolean;
3472
+ /** @description the first record to process */
3473
+ firstRecord?: number;
3474
+ /** @description the maximum number of records to process */
3475
+ maxRecords?: number;
3476
+ /** @description include a list of chain configurations in the output */
3477
+ chains?: boolean;
3478
+ /** @description include a list of cache items in the output */
3479
+ caches?: boolean;
3480
+ /** @description an alias for the diagnose endpoint */
3481
+ healthcheck?: boolean;
3482
+ /** @description the chain to use */
3483
+ chain?: string;
3484
+ /** @description suppress the header in the output */
3485
+ noHeader?: boolean;
3486
+ /** @description export format, one of [ txt | csv | json ] */
3487
+ fmt?: string;
3488
+ };
3489
+ header?: never;
3490
+ path?: never;
3491
+ cookie?: never;
3492
+ };
3493
+ requestBody?: never;
3494
+ responses: {
3495
+ /** @description returns the requested data */
3496
+ 200: {
3497
+ headers: {
3498
+ [name: string]: unknown;
3499
+ };
3500
+ content: {
3501
+ "application/json": {
3502
+ /** @description Produces <a href="/data-model/admin/#cacheitem">CacheItem</a>, <a href="/data-model/admin/#chain">Chain</a> or <a href="/data-model/admin/#status">Status</a> data. Corresponds to the <a href="/chifra/admin/#chifra-status">chifra status</a> command line. */
3503
+ data?: (components["schemas"]["cacheItem"] | components["schemas"]["chain"] | components["schemas"]["status"])[];
3504
+ };
3505
+ };
3506
+ };
3507
+ /** @description bad input parameter */
3508
+ 400: {
3509
+ headers: {
3510
+ [name: string]: unknown;
3511
+ };
3512
+ content?: never;
3513
+ };
3514
+ };
3515
+ };
3516
+ "admin-chunks": {
3517
+ parameters: {
3518
+ query: {
3519
+ /** @description the type of data to process */
3520
+ mode: "manifest" | "index" | "blooms" | "pins" | "addresses" | "appearances" | "stats";
3521
+ /** @description an optional list of blocks to intersect with chunk ranges */
3522
+ blocks?: string[];
3523
+ /** @description check the manifest, index, or blooms for internal consistency */
3524
+ check?: boolean;
3525
+ /** @description in index mode only, checks the address(es) for inclusion in the given index chunk */
3526
+ belongs?: string[];
3527
+ /** @description first block to process (inclusive) */
3528
+ firstBlock?: number;
3529
+ /** @description last block to process (inclusive) */
3530
+ lastBlock?: number;
3531
+ /** @description the max number of addresses to process in a given chunk */
3532
+ maxAddrs?: number;
3533
+ /** @description if true, dig more deeply during checking (manifest only) */
3534
+ deep?: boolean;
3535
+ /** @description for the --pin --deep mode only, writes the manifest back to the index folder (see notes) */
3536
+ rewrite?: boolean;
3537
+ /** @description for certain modes only, display the count of records */
3538
+ count?: boolean;
3539
+ /** @description for --pin only, pin only metadata files (ts.bin and manifest.json) */
3540
+ metadata?: boolean;
3541
+ /** @description for --remote pinning only, seconds to sleep between API calls */
3542
+ sleep?: number;
3543
+ /** @description the chain to use */
3544
+ chain?: string;
3545
+ /** @description suppress the header in the output */
3546
+ noHeader?: boolean;
3547
+ /** @description export format, one of [ txt | csv | json ] */
3548
+ fmt?: string;
3549
+ };
3550
+ header?: never;
3551
+ path?: never;
3552
+ cookie?: never;
3553
+ };
3554
+ requestBody?: never;
3555
+ responses: {
3556
+ /** @description returns the requested data */
3557
+ 200: {
3558
+ headers: {
3559
+ [name: string]: unknown;
3560
+ };
3561
+ content: {
3562
+ "application/json": {
3563
+ /** @description Produces <a href="/data-model/accounts/#appearance">Appearance</a>, <a href="/data-model/accounts/#appearancetable">AppearanceTable</a>, <a href="/data-model/admin/#chunkaddress">ChunkAddress</a>, <a href="/data-model/admin/#chunkbloom">ChunkBloom</a>, <a href="/data-model/admin/#chunkindex">ChunkIndex</a>, <a href="/data-model/admin/#chunkpin">ChunkPin</a>, <a href="/data-model/admin/#chunkrecord">ChunkRecord</a>, <a href="/data-model/admin/#chunkstats">ChunkStats</a>, <a href="/data-model/other/#count">Count</a>, <a href="/data-model/admin/#ipfspin">IpfsPin</a>, <a href="/data-model/admin/#manifest">Manifest</a>, <a href="/data-model/other/#message">Message</a>, <a href="/data-model/admin/#rangedates">RangeDates</a> or <a href="/data-model/admin/#reportcheck">ReportCheck</a> data. Corresponds to the <a href="/chifra/admin/#chifra-chunks">chifra chunks</a> command line. */
3564
+ data?: (components["schemas"]["appearance"] | components["schemas"]["appearanceTable"] | components["schemas"]["chunkAddress"] | components["schemas"]["chunkBloom"] | components["schemas"]["chunkIndex"] | components["schemas"]["chunkPin"] | components["schemas"]["chunkRecord"] | components["schemas"]["chunkStats"] | components["schemas"]["count"] | components["schemas"]["ipfsPin"] | components["schemas"]["manifest"] | components["schemas"]["message"] | components["schemas"]["rangeDates"] | components["schemas"]["reportCheck"])[];
3565
+ };
3566
+ };
3567
+ };
3568
+ /** @description bad input parameter */
3569
+ 400: {
3570
+ headers: {
3571
+ [name: string]: unknown;
3572
+ };
3573
+ content?: never;
3574
+ };
3575
+ };
3576
+ };
3577
+ "admin-init": {
3578
+ parameters: {
3579
+ query?: {
3580
+ /** @description in addition to Bloom filters, download full index chunks (recommended) */
3581
+ all?: boolean;
3582
+ /** @description create an example for the SDK with the given name */
3583
+ example?: string;
3584
+ /** @description display the results of the download without actually downloading */
3585
+ dryRun?: boolean;
3586
+ /** @description do not download any chunks earlier than this block */
3587
+ firstBlock?: number;
3588
+ /** @description seconds to sleep between downloads */
3589
+ sleep?: number;
3590
+ /** @description the chain to use */
3591
+ chain?: string;
3592
+ };
3593
+ header?: never;
3594
+ path?: never;
3595
+ cookie?: never;
3596
+ };
3597
+ requestBody?: never;
3598
+ responses: {
3599
+ /** @description returns the requested data */
3600
+ 200: {
3601
+ headers: {
3602
+ [name: string]: unknown;
3603
+ };
3604
+ content: {
3605
+ "application/json": {
3606
+ /** @description Produces <a href="/data-model/admin/#chunkrecord">ChunkRecord</a> or <a href="/data-model/admin/#manifest">Manifest</a> data. Corresponds to the <a href="/chifra/admin/#chifra-init">chifra init</a> command line. */
3607
+ data?: (components["schemas"]["chunkRecord"] | components["schemas"]["manifest"])[];
3608
+ };
3609
+ };
3610
+ };
3611
+ /** @description bad input parameter */
3612
+ 400: {
3613
+ headers: {
3614
+ [name: string]: unknown;
3615
+ };
3616
+ content?: never;
3617
+ };
3618
+ };
3619
+ };
3620
+ "other-slurp": {
3621
+ parameters: {
3622
+ query: {
3623
+ /** @description one or more addresses to slurp from Etherscan */
3624
+ addrs: string[];
3625
+ /** @description an optional range of blocks to slurp */
3626
+ blocks?: string[];
3627
+ /** @description which types of transactions to request */
3628
+ parts?: ("ext" | "int" | "token" | "nfts" | "1155" | "miner" | "uncles" | "withdrawals" | "some" | "all")[];
3629
+ /** @description show only the blocknumber.tx_id appearances of the exported transactions */
3630
+ appearances?: boolean;
3631
+ /** @description articulate the retrieved data if ABIs can be found */
3632
+ articulate?: boolean;
3633
+ /** @description the source of the slurped data */
3634
+ source?: "etherscan" | "covalent" | "alchemy";
3635
+ /** @description for --appearances mode only, display only the count of records */
3636
+ count?: boolean;
3637
+ /** @description the page to retrieve (page number) */
3638
+ page?: number;
3639
+ /** @description the page to retrieve (page ID) */
3640
+ pageId?: string;
3641
+ /** @description the number of records to request on each page */
3642
+ perPage?: number;
3643
+ /** @description seconds to sleep between requests */
3644
+ sleep?: number;
3645
+ /** @description the chain to use */
3646
+ chain?: string;
3647
+ /** @description suppress the header in the output */
3648
+ noHeader?: boolean;
3649
+ /** @description force the results of the query into the cache */
3650
+ cache?: boolean;
3651
+ /** @description removes related items from the cache */
3652
+ decache?: boolean;
3653
+ /** @description export values in ether */
3654
+ ether?: boolean;
3655
+ /** @description export format, one of [ txt | csv | json ] */
3656
+ fmt?: string;
3657
+ };
3658
+ header?: never;
3659
+ path?: never;
3660
+ cookie?: never;
3661
+ };
3662
+ requestBody?: never;
3663
+ responses: {
3664
+ /** @description returns the requested data */
3665
+ 200: {
3666
+ headers: {
3667
+ [name: string]: unknown;
3668
+ };
3669
+ content: {
3670
+ "application/json": {
3671
+ /** @description Produces <a href="/data-model/accounts/#appearance">Appearance</a>, <a href="/data-model/other/#function">Function</a>, <a href="/data-model/accounts/#monitor">Monitor</a>, <a href="/data-model/other/#parameter">Parameter</a> or <a href="/data-model/other/#slurp">Slurp</a> data. Corresponds to the <a href="/chifra/other/#chifra-slurp">chifra slurp</a> command line. */
3672
+ data?: (components["schemas"]["appearance"] | components["schemas"]["function"] | components["schemas"]["monitor"] | components["schemas"]["parameter"] | components["schemas"]["slurp"])[];
3673
+ };
3674
+ };
3675
+ };
3676
+ /** @description bad input parameter */
3677
+ 400: {
3678
+ headers: {
3679
+ [name: string]: unknown;
3680
+ };
3681
+ content?: never;
3682
+ };
3683
+ };
3684
+ };
3685
+ }
3686
+ //# sourceMappingURL=generated.d.ts.map