@imtbl/sdk 0.9.0 → 0.12.0-alpha

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.
@@ -0,0 +1,1971 @@
1
+ import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration as BlockchainDataModuleConfiguration$1 } from 'config';
2
+
3
+ /**
4
+ * Immutable zkEVM API
5
+ * Immutable Multi Rollup API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@immutable.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface BasicAPIError
18
+ */
19
+ interface BasicAPIError {
20
+ /**
21
+ * Error Message
22
+ * @type {string}
23
+ * @memberof BasicAPIError
24
+ */
25
+ 'message': string;
26
+ /**
27
+ * Link to IMX documentation that can help resolve this error
28
+ * @type {string}
29
+ * @memberof BasicAPIError
30
+ */
31
+ 'link': string;
32
+ /**
33
+ * Trace ID of the initial request
34
+ * @type {string}
35
+ * @memberof BasicAPIError
36
+ */
37
+ 'trace_id': string;
38
+ }
39
+
40
+ /**
41
+ * Immutable zkEVM API
42
+ * Immutable Multi Rollup API
43
+ *
44
+ * The version of the OpenAPI document: 1.0.0
45
+ * Contact: support@immutable.com
46
+ *
47
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
48
+ * https://openapi-generator.tech
49
+ * Do not edit the class manually.
50
+ */
51
+ /**
52
+ * The contract type for an NFT
53
+ * @export
54
+ * @enum {string}
55
+ */
56
+ declare const NFTContractType: {
57
+ readonly Erc721: "ERC721";
58
+ };
59
+ type NFTContractType = typeof NFTContractType[keyof typeof NFTContractType];
60
+
61
+ /**
62
+ * Immutable zkEVM API
63
+ * Immutable Multi Rollup API
64
+ *
65
+ * The version of the OpenAPI document: 1.0.0
66
+ * Contact: support@immutable.com
67
+ *
68
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
69
+ * https://openapi-generator.tech
70
+ * Do not edit the class manually.
71
+ */
72
+
73
+ /**
74
+ *
75
+ * @export
76
+ * @interface ActivityNFT
77
+ */
78
+ interface ActivityNFT {
79
+ /**
80
+ *
81
+ * @type {NFTContractType}
82
+ * @memberof ActivityNFT
83
+ */
84
+ 'contract_type': NFTContractType;
85
+ /**
86
+ * The token contract address
87
+ * @type {string}
88
+ * @memberof ActivityNFT
89
+ */
90
+ 'contract_address': string;
91
+ /**
92
+ * An `uint256` token id as string
93
+ * @type {string}
94
+ * @memberof ActivityNFT
95
+ */
96
+ 'token_id': string;
97
+ }
98
+
99
+ /**
100
+ * Immutable zkEVM API
101
+ * Immutable Multi Rollup API
102
+ *
103
+ * The version of the OpenAPI document: 1.0.0
104
+ * Contact: support@immutable.com
105
+ *
106
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
107
+ * https://openapi-generator.tech
108
+ * Do not edit the class manually.
109
+ */
110
+ /**
111
+ * The contract type for a token
112
+ * @export
113
+ * @enum {string}
114
+ */
115
+ declare const TokenContractType: {
116
+ readonly Erc20: "ERC20";
117
+ };
118
+ type TokenContractType = typeof TokenContractType[keyof typeof TokenContractType];
119
+
120
+ /**
121
+ * Immutable zkEVM API
122
+ * Immutable Multi Rollup API
123
+ *
124
+ * The version of the OpenAPI document: 1.0.0
125
+ * Contact: support@immutable.com
126
+ *
127
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
128
+ * https://openapi-generator.tech
129
+ * Do not edit the class manually.
130
+ */
131
+
132
+ /**
133
+ *
134
+ * @export
135
+ * @interface ActivityToken
136
+ */
137
+ interface ActivityToken {
138
+ /**
139
+ *
140
+ * @type {TokenContractType}
141
+ * @memberof ActivityToken
142
+ */
143
+ 'contract_type': TokenContractType;
144
+ /**
145
+ * The contract address
146
+ * @type {string}
147
+ * @memberof ActivityToken
148
+ */
149
+ 'contract_address': string;
150
+ }
151
+
152
+ /**
153
+ * Immutable zkEVM API
154
+ * Immutable Multi Rollup API
155
+ *
156
+ * The version of the OpenAPI document: 1.0.0
157
+ * Contact: support@immutable.com
158
+ *
159
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
160
+ * https://openapi-generator.tech
161
+ * Do not edit the class manually.
162
+ */
163
+
164
+ /**
165
+ * @type ActivityAsset
166
+ * The contract and asset details for this activity
167
+ * @export
168
+ */
169
+ type ActivityAsset = ActivityNFT | ActivityToken;
170
+
171
+ /**
172
+ * Immutable zkEVM API
173
+ * Immutable Multi Rollup API
174
+ *
175
+ * The version of the OpenAPI document: 1.0.0
176
+ * Contact: support@immutable.com
177
+ *
178
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
179
+ * https://openapi-generator.tech
180
+ * Do not edit the class manually.
181
+ */
182
+
183
+ /**
184
+ * The burn activity details
185
+ * @export
186
+ * @interface Burn
187
+ */
188
+ interface Burn {
189
+ /**
190
+ * The account address the asset was transferred from
191
+ * @type {string}
192
+ * @memberof Burn
193
+ */
194
+ 'from': string;
195
+ /**
196
+ * The amount of assets burnt
197
+ * @type {string}
198
+ * @memberof Burn
199
+ */
200
+ 'amount': string;
201
+ /**
202
+ *
203
+ * @type {ActivityAsset}
204
+ * @memberof Burn
205
+ */
206
+ 'asset': ActivityAsset;
207
+ }
208
+
209
+ /**
210
+ * Immutable zkEVM API
211
+ * Immutable Multi Rollup API
212
+ *
213
+ * The version of the OpenAPI document: 1.0.0
214
+ * Contact: support@immutable.com
215
+ *
216
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
217
+ * https://openapi-generator.tech
218
+ * Do not edit the class manually.
219
+ */
220
+
221
+ /**
222
+ * The deposit activity details
223
+ * @export
224
+ * @interface Deposit
225
+ */
226
+ interface Deposit {
227
+ /**
228
+ * The account address the asset was deposited to
229
+ * @type {string}
230
+ * @memberof Deposit
231
+ */
232
+ 'to': string;
233
+ /**
234
+ * The deposited amount
235
+ * @type {string}
236
+ * @memberof Deposit
237
+ */
238
+ 'amount': string;
239
+ /**
240
+ *
241
+ * @type {ActivityAsset}
242
+ * @memberof Deposit
243
+ */
244
+ 'asset': ActivityAsset;
245
+ }
246
+
247
+ /**
248
+ * Immutable zkEVM API
249
+ * Immutable Multi Rollup API
250
+ *
251
+ * The version of the OpenAPI document: 1.0.0
252
+ * Contact: support@immutable.com
253
+ *
254
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
255
+ * https://openapi-generator.tech
256
+ * Do not edit the class manually.
257
+ */
258
+
259
+ /**
260
+ * The mint activity details
261
+ * @export
262
+ * @interface Mint
263
+ */
264
+ interface Mint {
265
+ /**
266
+ * The account address the asset was minted to
267
+ * @type {string}
268
+ * @memberof Mint
269
+ */
270
+ 'to': string;
271
+ /**
272
+ * The minted amount
273
+ * @type {string}
274
+ * @memberof Mint
275
+ */
276
+ 'amount': string;
277
+ /**
278
+ *
279
+ * @type {ActivityAsset}
280
+ * @memberof Mint
281
+ */
282
+ 'asset': ActivityAsset;
283
+ }
284
+
285
+ /**
286
+ * Immutable zkEVM API
287
+ * Immutable Multi Rollup API
288
+ *
289
+ * The version of the OpenAPI document: 1.0.0
290
+ * Contact: support@immutable.com
291
+ *
292
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
293
+ * https://openapi-generator.tech
294
+ * Do not edit the class manually.
295
+ */
296
+ /**
297
+ *
298
+ * @export
299
+ * @interface SaleFee
300
+ */
301
+ interface SaleFee {
302
+ /**
303
+ * Fee payable to recipient upon settlement
304
+ * @type {string}
305
+ * @memberof SaleFee
306
+ */
307
+ 'amount'?: string;
308
+ /**
309
+ * Fee type
310
+ * @type {string}
311
+ * @memberof SaleFee
312
+ */
313
+ 'type'?: SaleFeeTypeEnum;
314
+ /**
315
+ * Wallet address of fee recipient
316
+ * @type {string}
317
+ * @memberof SaleFee
318
+ */
319
+ 'recipient'?: string;
320
+ }
321
+ declare const SaleFeeTypeEnum: {
322
+ readonly Royalty: "ROYALTY";
323
+ };
324
+ type SaleFeeTypeEnum = typeof SaleFeeTypeEnum[keyof typeof SaleFeeTypeEnum];
325
+
326
+ /**
327
+ * Immutable zkEVM API
328
+ * Immutable Multi Rollup API
329
+ *
330
+ * The version of the OpenAPI document: 1.0.0
331
+ * Contact: support@immutable.com
332
+ *
333
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
334
+ * https://openapi-generator.tech
335
+ * Do not edit the class manually.
336
+ */
337
+ /**
338
+ *
339
+ * @export
340
+ * @interface ActivityNativeToken
341
+ */
342
+ interface ActivityNativeToken {
343
+ /**
344
+ * The token symbol
345
+ * @type {string}
346
+ * @memberof ActivityNativeToken
347
+ */
348
+ 'symbol': string;
349
+ }
350
+
351
+ /**
352
+ * Immutable zkEVM API
353
+ * Immutable Multi Rollup API
354
+ *
355
+ * The version of the OpenAPI document: 1.0.0
356
+ * Contact: support@immutable.com
357
+ *
358
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
359
+ * https://openapi-generator.tech
360
+ * Do not edit the class manually.
361
+ */
362
+
363
+ /**
364
+ * @type SalePaymentToken
365
+ * The type of payment token
366
+ * @export
367
+ */
368
+ type SalePaymentToken = ActivityNativeToken | ActivityToken;
369
+
370
+ /**
371
+ * Immutable zkEVM API
372
+ * Immutable Multi Rollup API
373
+ *
374
+ * The version of the OpenAPI document: 1.0.0
375
+ * Contact: support@immutable.com
376
+ *
377
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
378
+ * https://openapi-generator.tech
379
+ * Do not edit the class manually.
380
+ */
381
+
382
+ /**
383
+ *
384
+ * @export
385
+ * @interface SalePayment
386
+ */
387
+ interface SalePayment {
388
+ /**
389
+ *
390
+ * @type {SalePaymentToken}
391
+ * @memberof SalePayment
392
+ */
393
+ 'token': SalePaymentToken;
394
+ /**
395
+ * The base price of the sale not including any fees
396
+ * @type {string}
397
+ * @memberof SalePayment
398
+ */
399
+ 'price_excluding_fees': string;
400
+ /**
401
+ * The total price of the sale. Includes the sum of all fees
402
+ * @type {string}
403
+ * @memberof SalePayment
404
+ */
405
+ 'price_including_fees': string;
406
+ /**
407
+ * The fees associated with this sale
408
+ * @type {Array<SaleFee>}
409
+ * @memberof SalePayment
410
+ */
411
+ 'fees': Array<SaleFee>;
412
+ }
413
+
414
+ /**
415
+ * Immutable zkEVM API
416
+ * Immutable Multi Rollup API
417
+ *
418
+ * The version of the OpenAPI document: 1.0.0
419
+ * Contact: support@immutable.com
420
+ *
421
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
422
+ * https://openapi-generator.tech
423
+ * Do not edit the class manually.
424
+ */
425
+
426
+ /**
427
+ * The NFT Sale activity details
428
+ * @export
429
+ * @interface NFTSale
430
+ */
431
+ interface NFTSale {
432
+ /**
433
+ * The id of order
434
+ * @type {string}
435
+ * @memberof NFTSale
436
+ */
437
+ 'order_id': string;
438
+ /**
439
+ * The account address of buyer
440
+ * @type {string}
441
+ * @memberof NFTSale
442
+ */
443
+ 'to': string;
444
+ /**
445
+ * The account address of seller
446
+ * @type {string}
447
+ * @memberof NFTSale
448
+ */
449
+ 'from': string;
450
+ /**
451
+ *
452
+ * @type {Array<ActivityNFT>}
453
+ * @memberof NFTSale
454
+ */
455
+ 'asset': Array<ActivityNFT>;
456
+ /**
457
+ *
458
+ * @type {SalePayment}
459
+ * @memberof NFTSale
460
+ */
461
+ 'payment': SalePayment;
462
+ }
463
+
464
+ /**
465
+ * Immutable zkEVM API
466
+ * Immutable Multi Rollup API
467
+ *
468
+ * The version of the OpenAPI document: 1.0.0
469
+ * Contact: support@immutable.com
470
+ *
471
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
472
+ * https://openapi-generator.tech
473
+ * Do not edit the class manually.
474
+ */
475
+
476
+ /**
477
+ * The transfer activity details
478
+ * @export
479
+ * @interface Transfer
480
+ */
481
+ interface Transfer {
482
+ /**
483
+ * The account address the asset was transferred from
484
+ * @type {string}
485
+ * @memberof Transfer
486
+ */
487
+ 'from': string;
488
+ /**
489
+ * The account address the asset was transferred to
490
+ * @type {string}
491
+ * @memberof Transfer
492
+ */
493
+ 'to': string;
494
+ /**
495
+ * The amount of assets transferred
496
+ * @type {string}
497
+ * @memberof Transfer
498
+ */
499
+ 'amount': string;
500
+ /**
501
+ *
502
+ * @type {ActivityAsset}
503
+ * @memberof Transfer
504
+ */
505
+ 'asset': ActivityAsset;
506
+ }
507
+
508
+ /**
509
+ * Immutable zkEVM API
510
+ * Immutable Multi Rollup API
511
+ *
512
+ * The version of the OpenAPI document: 1.0.0
513
+ * Contact: support@immutable.com
514
+ *
515
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
516
+ * https://openapi-generator.tech
517
+ * Do not edit the class manually.
518
+ */
519
+
520
+ /**
521
+ * The withdrawal activity details
522
+ * @export
523
+ * @interface Withdrawal
524
+ */
525
+ interface Withdrawal {
526
+ /**
527
+ * The account address the asset was withdrawn from
528
+ * @type {string}
529
+ * @memberof Withdrawal
530
+ */
531
+ 'from': string;
532
+ /**
533
+ * The amount of assets withdrawn
534
+ * @type {string}
535
+ * @memberof Withdrawal
536
+ */
537
+ 'amount': string;
538
+ /**
539
+ *
540
+ * @type {ActivityAsset}
541
+ * @memberof Withdrawal
542
+ */
543
+ 'asset': ActivityAsset;
544
+ }
545
+
546
+ /**
547
+ * Immutable zkEVM API
548
+ * Immutable Multi Rollup API
549
+ *
550
+ * The version of the OpenAPI document: 1.0.0
551
+ * Contact: support@immutable.com
552
+ *
553
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
554
+ * https://openapi-generator.tech
555
+ * Do not edit the class manually.
556
+ */
557
+
558
+ /**
559
+ * @type ActivityDetails
560
+ * The activity details
561
+ * @export
562
+ */
563
+ type ActivityDetails = Burn | Deposit | Mint | NFTSale | Transfer | Withdrawal;
564
+
565
+ /**
566
+ * Immutable zkEVM API
567
+ * Immutable Multi Rollup API
568
+ *
569
+ * The version of the OpenAPI document: 1.0.0
570
+ * Contact: support@immutable.com
571
+ *
572
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
573
+ * https://openapi-generator.tech
574
+ * Do not edit the class manually.
575
+ */
576
+ /**
577
+ * The activity type
578
+ * @export
579
+ * @enum {string}
580
+ */
581
+ declare const ActivityType$1: {
582
+ readonly Mint: "mint";
583
+ readonly Burn: "burn";
584
+ readonly Transfer: "transfer";
585
+ readonly Sale: "sale";
586
+ readonly Deposit: "deposit";
587
+ readonly Withdrawal: "withdrawal";
588
+ };
589
+ type ActivityType$1 = typeof ActivityType$1[keyof typeof ActivityType$1];
590
+
591
+ /**
592
+ * Immutable zkEVM API
593
+ * Immutable Multi Rollup API
594
+ *
595
+ * The version of the OpenAPI document: 1.0.0
596
+ * Contact: support@immutable.com
597
+ *
598
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
599
+ * https://openapi-generator.tech
600
+ * Do not edit the class manually.
601
+ */
602
+ /**
603
+ * The metadata related to blockchain transaction
604
+ * @export
605
+ * @interface BlockchainMetadata
606
+ */
607
+ interface BlockchainMetadata {
608
+ /**
609
+ * The transaction hash of the activity
610
+ * @type {string}
611
+ * @memberof BlockchainMetadata
612
+ */
613
+ 'transaction_hash': string;
614
+ /**
615
+ * EVM block number (uint64 as string)
616
+ * @type {string}
617
+ * @memberof BlockchainMetadata
618
+ */
619
+ 'block_number': string;
620
+ /**
621
+ * Transaction index in a block (uint32 as string)
622
+ * @type {string}
623
+ * @memberof BlockchainMetadata
624
+ */
625
+ 'transaction_index': string;
626
+ /**
627
+ * The log index of activity in a block (uint32 as string)
628
+ * @type {string}
629
+ * @memberof BlockchainMetadata
630
+ */
631
+ 'log_index': string | null;
632
+ }
633
+
634
+ /**
635
+ * Immutable zkEVM API
636
+ * Immutable Multi Rollup API
637
+ *
638
+ * The version of the OpenAPI document: 1.0.0
639
+ * Contact: support@immutable.com
640
+ *
641
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
642
+ * https://openapi-generator.tech
643
+ * Do not edit the class manually.
644
+ */
645
+ /**
646
+ * The chain details
647
+ * @export
648
+ * @interface Chain
649
+ */
650
+ interface Chain {
651
+ /**
652
+ * The id of chain
653
+ * @type {string}
654
+ * @memberof Chain
655
+ */
656
+ 'id': string;
657
+ /**
658
+ * The name of chain
659
+ * @type {string}
660
+ * @memberof Chain
661
+ */
662
+ 'name': string;
663
+ }
664
+
665
+ /**
666
+ * Immutable zkEVM API
667
+ * Immutable Multi Rollup API
668
+ *
669
+ * The version of the OpenAPI document: 1.0.0
670
+ * Contact: support@immutable.com
671
+ *
672
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
673
+ * https://openapi-generator.tech
674
+ * Do not edit the class manually.
675
+ */
676
+
677
+ /**
678
+ *
679
+ * @export
680
+ * @interface Activity
681
+ */
682
+ interface Activity {
683
+ /**
684
+ * Activity ID in UUIDv4 format
685
+ * @type {string}
686
+ * @memberof Activity
687
+ */
688
+ 'id': string;
689
+ /**
690
+ *
691
+ * @type {Chain}
692
+ * @memberof Activity
693
+ */
694
+ 'chain': Chain;
695
+ /**
696
+ *
697
+ * @type {ActivityType}
698
+ * @memberof Activity
699
+ */
700
+ 'type': ActivityType$1;
701
+ /**
702
+ *
703
+ * @type {ActivityDetails}
704
+ * @memberof Activity
705
+ */
706
+ 'details': ActivityDetails;
707
+ /**
708
+ * The time activity was indexed
709
+ * @type {string}
710
+ * @memberof Activity
711
+ */
712
+ 'indexed_at': string;
713
+ /**
714
+ *
715
+ * @type {BlockchainMetadata}
716
+ * @memberof Activity
717
+ */
718
+ 'blockchain_metadata': BlockchainMetadata | null;
719
+ }
720
+
721
+ /**
722
+ * Immutable zkEVM API
723
+ * Immutable Multi Rollup API
724
+ *
725
+ * The version of the OpenAPI document: 1.0.0
726
+ * Contact: support@immutable.com
727
+ *
728
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
729
+ * https://openapi-generator.tech
730
+ * Do not edit the class manually.
731
+ */
732
+ /**
733
+ *
734
+ * @export
735
+ * @interface ChainWithDetailsAllOf
736
+ */
737
+ interface ChainWithDetailsAllOf {
738
+ /**
739
+ * URL for RPC node
740
+ * @type {string}
741
+ * @memberof ChainWithDetailsAllOf
742
+ */
743
+ 'rpc_url': string | null;
744
+ }
745
+
746
+ /**
747
+ * Immutable zkEVM API
748
+ * Immutable Multi Rollup API
749
+ *
750
+ * The version of the OpenAPI document: 1.0.0
751
+ * Contact: support@immutable.com
752
+ *
753
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
754
+ * https://openapi-generator.tech
755
+ * Do not edit the class manually.
756
+ */
757
+
758
+ /**
759
+ * @type ChainWithDetails
760
+ * @export
761
+ */
762
+ type ChainWithDetails = Chain & ChainWithDetailsAllOf;
763
+
764
+ /**
765
+ * Immutable zkEVM API
766
+ * Immutable Multi Rollup API
767
+ *
768
+ * The version of the OpenAPI document: 1.0.0
769
+ * Contact: support@immutable.com
770
+ *
771
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
772
+ * https://openapi-generator.tech
773
+ * Do not edit the class manually.
774
+ */
775
+ /**
776
+ * The collection contract type
777
+ * @export
778
+ * @enum {string}
779
+ */
780
+ declare const CollectionContractType: {
781
+ readonly Erc721: "ERC721";
782
+ };
783
+ type CollectionContractType = typeof CollectionContractType[keyof typeof CollectionContractType];
784
+
785
+ /**
786
+ * Immutable zkEVM API
787
+ * Immutable Multi Rollup API
788
+ *
789
+ * The version of the OpenAPI document: 1.0.0
790
+ * Contact: support@immutable.com
791
+ *
792
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
793
+ * https://openapi-generator.tech
794
+ * Do not edit the class manually.
795
+ */
796
+
797
+ /**
798
+ *
799
+ * @export
800
+ * @interface Collection
801
+ */
802
+ interface Collection {
803
+ /**
804
+ *
805
+ * @type {Chain}
806
+ * @memberof Collection
807
+ */
808
+ 'chain': Chain;
809
+ /**
810
+ * The name of the collection
811
+ * @type {string}
812
+ * @memberof Collection
813
+ */
814
+ 'name': string | null;
815
+ /**
816
+ * The symbol of contract
817
+ * @type {string}
818
+ * @memberof Collection
819
+ */
820
+ 'symbol': string | null;
821
+ /**
822
+ *
823
+ * @type {CollectionContractType}
824
+ * @memberof Collection
825
+ */
826
+ 'contract_type': CollectionContractType;
827
+ /**
828
+ * The address of the contract
829
+ * @type {string}
830
+ * @memberof Collection
831
+ */
832
+ 'contract_address': string;
833
+ /**
834
+ * The description of collection
835
+ * @type {string}
836
+ * @memberof Collection
837
+ */
838
+ 'description': string | null;
839
+ /**
840
+ * The url of the collection image
841
+ * @type {string}
842
+ * @memberof Collection
843
+ */
844
+ 'image': string | null;
845
+ /**
846
+ * The url of external link
847
+ * @type {string}
848
+ * @memberof Collection
849
+ */
850
+ 'external_link': string | null;
851
+ /**
852
+ * The uri for the metadata of the collection
853
+ * @type {string}
854
+ * @memberof Collection
855
+ */
856
+ 'contract_uri'?: string | null;
857
+ /**
858
+ * The metadata uri for nft
859
+ * @type {string}
860
+ * @memberof Collection
861
+ */
862
+ 'base_uri': string | null;
863
+ /**
864
+ * When the collection was first indexed
865
+ * @type {string}
866
+ * @memberof Collection
867
+ */
868
+ 'indexed_at': string;
869
+ /**
870
+ * When the collection was last updated
871
+ * @type {string}
872
+ * @memberof Collection
873
+ */
874
+ 'updated_at': string;
875
+ /**
876
+ * When the collection metadata was last synced
877
+ * @type {string}
878
+ * @memberof Collection
879
+ */
880
+ 'last_metadata_synced_at': string | null;
881
+ }
882
+
883
+ /**
884
+ * Immutable zkEVM API
885
+ * Immutable Multi Rollup API
886
+ *
887
+ * The version of the OpenAPI document: 1.0.0
888
+ * Contact: support@immutable.com
889
+ *
890
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
891
+ * https://openapi-generator.tech
892
+ * Do not edit the class manually.
893
+ */
894
+
895
+ /**
896
+ * Single activity
897
+ * @export
898
+ * @interface GetActivityResult
899
+ */
900
+ interface GetActivityResult {
901
+ /**
902
+ *
903
+ * @type {Activity}
904
+ * @memberof GetActivityResult
905
+ */
906
+ 'result': Activity;
907
+ }
908
+
909
+ /**
910
+ * Immutable zkEVM API
911
+ * Immutable Multi Rollup API
912
+ *
913
+ * The version of the OpenAPI document: 1.0.0
914
+ * Contact: support@immutable.com
915
+ *
916
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
917
+ * https://openapi-generator.tech
918
+ * Do not edit the class manually.
919
+ */
920
+
921
+ /**
922
+ * Single Collection
923
+ * @export
924
+ * @interface GetCollectionResult
925
+ */
926
+ interface GetCollectionResult {
927
+ /**
928
+ *
929
+ * @type {Collection}
930
+ * @memberof GetCollectionResult
931
+ */
932
+ 'result': Collection;
933
+ }
934
+
935
+ /**
936
+ * Immutable zkEVM API
937
+ * Immutable Multi Rollup API
938
+ *
939
+ * The version of the OpenAPI document: 1.0.0
940
+ * Contact: support@immutable.com
941
+ *
942
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
943
+ * https://openapi-generator.tech
944
+ * Do not edit the class manually.
945
+ */
946
+
947
+ /**
948
+ *
949
+ * @export
950
+ * @interface NFT
951
+ */
952
+ interface NFT {
953
+ /**
954
+ *
955
+ * @type {Chain}
956
+ * @memberof NFT
957
+ */
958
+ 'chain': Chain;
959
+ /**
960
+ * An `uint256` token id as string
961
+ * @type {string}
962
+ * @memberof NFT
963
+ */
964
+ 'token_id': string;
965
+ /**
966
+ * The contract address of the NFT
967
+ * @type {string}
968
+ * @memberof NFT
969
+ */
970
+ 'contract_address': string;
971
+ /**
972
+ * When the NFT was first indexed
973
+ * @type {string}
974
+ * @memberof NFT
975
+ */
976
+ 'indexed_at': string;
977
+ /**
978
+ * When NFT metadata was last synced
979
+ * @type {string}
980
+ * @memberof NFT
981
+ */
982
+ 'metadata_synced_at': string | null;
983
+ /**
984
+ * The name of the NFT
985
+ * @type {string}
986
+ * @memberof NFT
987
+ */
988
+ 'name': string | null;
989
+ /**
990
+ * The description of the NFT
991
+ * @type {string}
992
+ * @memberof NFT
993
+ */
994
+ 'description': string | null;
995
+ /**
996
+ * The image url of the NFT
997
+ * @type {string}
998
+ * @memberof NFT
999
+ */
1000
+ 'image': string | null;
1001
+ /**
1002
+ * The external website link of NFT
1003
+ * @type {string}
1004
+ * @memberof NFT
1005
+ */
1006
+ 'external_link': string | null;
1007
+ /**
1008
+ * The animation url of the NFT
1009
+ * @type {string}
1010
+ * @memberof NFT
1011
+ */
1012
+ 'animation_url': string | null;
1013
+ /**
1014
+ * The youtube URL of NFT
1015
+ * @type {string}
1016
+ * @memberof NFT
1017
+ */
1018
+ 'youtube_url': string | null;
1019
+ /**
1020
+ * The id of mint activity of this NFT
1021
+ * @type {string}
1022
+ * @memberof NFT
1023
+ */
1024
+ 'mint_activity_id': string | null;
1025
+ }
1026
+
1027
+ /**
1028
+ * Immutable zkEVM API
1029
+ * Immutable Multi Rollup API
1030
+ *
1031
+ * The version of the OpenAPI document: 1.0.0
1032
+ * Contact: support@immutable.com
1033
+ *
1034
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1035
+ * https://openapi-generator.tech
1036
+ * Do not edit the class manually.
1037
+ */
1038
+ /**
1039
+ * @type NFTMetadataAttributeValue
1040
+ * The metadata trait value
1041
+ * @export
1042
+ */
1043
+ type NFTMetadataAttributeValue = boolean | number | string;
1044
+
1045
+ /**
1046
+ * Immutable zkEVM API
1047
+ * Immutable Multi Rollup API
1048
+ *
1049
+ * The version of the OpenAPI document: 1.0.0
1050
+ * Contact: support@immutable.com
1051
+ *
1052
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1053
+ * https://openapi-generator.tech
1054
+ * Do not edit the class manually.
1055
+ */
1056
+
1057
+ /**
1058
+ *
1059
+ * @export
1060
+ * @interface NFTMetadataAttribute
1061
+ */
1062
+ interface NFTMetadataAttribute {
1063
+ /**
1064
+ * The metadata trait type
1065
+ * @type {string}
1066
+ * @memberof NFTMetadataAttribute
1067
+ */
1068
+ 'trait_type': string;
1069
+ /**
1070
+ *
1071
+ * @type {NFTMetadataAttributeValue}
1072
+ * @memberof NFTMetadataAttribute
1073
+ */
1074
+ 'value': NFTMetadataAttributeValue;
1075
+ }
1076
+
1077
+ /**
1078
+ * Immutable zkEVM API
1079
+ * Immutable Multi Rollup API
1080
+ *
1081
+ * The version of the OpenAPI document: 1.0.0
1082
+ * Contact: support@immutable.com
1083
+ *
1084
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1085
+ * https://openapi-generator.tech
1086
+ * Do not edit the class manually.
1087
+ */
1088
+
1089
+ /**
1090
+ * List of normalized NFT metadata attributes
1091
+ * @export
1092
+ * @interface NFTMetadataAttributes
1093
+ */
1094
+ interface NFTMetadataAttributes {
1095
+ /**
1096
+ * List of NFT Metadata attributes
1097
+ * @type {Array<NFTMetadataAttribute>}
1098
+ * @memberof NFTMetadataAttributes
1099
+ */
1100
+ 'attributes': Array<NFTMetadataAttribute>;
1101
+ }
1102
+
1103
+ /**
1104
+ * Immutable zkEVM API
1105
+ * Immutable Multi Rollup API
1106
+ *
1107
+ * The version of the OpenAPI document: 1.0.0
1108
+ * Contact: support@immutable.com
1109
+ *
1110
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1111
+ * https://openapi-generator.tech
1112
+ * Do not edit the class manually.
1113
+ */
1114
+
1115
+ /**
1116
+ * @type NFTWithMetadataAttributes
1117
+ * A single NFT with metadata attributes
1118
+ * @export
1119
+ */
1120
+ type NFTWithMetadataAttributes = NFT & NFTMetadataAttributes;
1121
+
1122
+ /**
1123
+ * Immutable zkEVM API
1124
+ * Immutable Multi Rollup API
1125
+ *
1126
+ * The version of the OpenAPI document: 1.0.0
1127
+ * Contact: support@immutable.com
1128
+ *
1129
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1130
+ * https://openapi-generator.tech
1131
+ * Do not edit the class manually.
1132
+ */
1133
+
1134
+ /**
1135
+ * Single NFT
1136
+ * @export
1137
+ * @interface GetNFTResult
1138
+ */
1139
+ interface GetNFTResult {
1140
+ /**
1141
+ *
1142
+ * @type {NFTWithMetadataAttributes}
1143
+ * @memberof GetNFTResult
1144
+ */
1145
+ 'result': NFTWithMetadataAttributes;
1146
+ }
1147
+
1148
+ /**
1149
+ * Immutable zkEVM API
1150
+ * Immutable Multi Rollup API
1151
+ *
1152
+ * The version of the OpenAPI document: 1.0.0
1153
+ * Contact: support@immutable.com
1154
+ *
1155
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1156
+ * https://openapi-generator.tech
1157
+ * Do not edit the class manually.
1158
+ */
1159
+
1160
+ /**
1161
+ *
1162
+ * @export
1163
+ * @interface Token
1164
+ */
1165
+ interface Token {
1166
+ /**
1167
+ *
1168
+ * @type {Chain}
1169
+ * @memberof Token
1170
+ */
1171
+ 'chain': Chain;
1172
+ /**
1173
+ * The address of token contract
1174
+ * @type {string}
1175
+ * @memberof Token
1176
+ */
1177
+ 'contract_address': string;
1178
+ /**
1179
+ * The address of root token contract
1180
+ * @type {string}
1181
+ * @memberof Token
1182
+ */
1183
+ 'root_contract_address': string | null;
1184
+ /**
1185
+ * The symbol of token
1186
+ * @type {string}
1187
+ * @memberof Token
1188
+ */
1189
+ 'symbol': string | null;
1190
+ /**
1191
+ * The decimals of token
1192
+ * @type {number}
1193
+ * @memberof Token
1194
+ */
1195
+ 'decimals': number | null;
1196
+ /**
1197
+ * The image url of token
1198
+ * @type {string}
1199
+ * @memberof Token
1200
+ */
1201
+ 'image_url': string | null;
1202
+ /**
1203
+ * The name of token
1204
+ * @type {string}
1205
+ * @memberof Token
1206
+ */
1207
+ 'name': string | null;
1208
+ }
1209
+
1210
+ /**
1211
+ * Immutable zkEVM API
1212
+ * Immutable Multi Rollup API
1213
+ *
1214
+ * The version of the OpenAPI document: 1.0.0
1215
+ * Contact: support@immutable.com
1216
+ *
1217
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1218
+ * https://openapi-generator.tech
1219
+ * Do not edit the class manually.
1220
+ */
1221
+
1222
+ /**
1223
+ * Single Token
1224
+ * @export
1225
+ * @interface GetTokenResult
1226
+ */
1227
+ interface GetTokenResult {
1228
+ /**
1229
+ *
1230
+ * @type {Token}
1231
+ * @memberof GetTokenResult
1232
+ */
1233
+ 'result': Token;
1234
+ }
1235
+
1236
+ /**
1237
+ * Immutable zkEVM API
1238
+ * Immutable Multi Rollup API
1239
+ *
1240
+ * The version of the OpenAPI document: 1.0.0
1241
+ * Contact: support@immutable.com
1242
+ *
1243
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1244
+ * https://openapi-generator.tech
1245
+ * Do not edit the class manually.
1246
+ */
1247
+ /**
1248
+ * Pagination properties
1249
+ * @export
1250
+ * @interface Page
1251
+ */
1252
+ interface Page {
1253
+ /**
1254
+ * First item as an encoded string
1255
+ * @type {string}
1256
+ * @memberof Page
1257
+ */
1258
+ 'previous_cursor': string | null;
1259
+ /**
1260
+ * Last item as an encoded string
1261
+ * @type {string}
1262
+ * @memberof Page
1263
+ */
1264
+ 'next_cursor': string | null;
1265
+ }
1266
+
1267
+ /**
1268
+ * Immutable zkEVM API
1269
+ * Immutable Multi Rollup API
1270
+ *
1271
+ * The version of the OpenAPI document: 1.0.0
1272
+ * Contact: support@immutable.com
1273
+ *
1274
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1275
+ * https://openapi-generator.tech
1276
+ * Do not edit the class manually.
1277
+ */
1278
+
1279
+ /**
1280
+ * List activities response
1281
+ * @export
1282
+ * @interface ListActivitiesResult
1283
+ */
1284
+ interface ListActivitiesResult {
1285
+ /**
1286
+ * List of activities
1287
+ * @type {Array<Activity>}
1288
+ * @memberof ListActivitiesResult
1289
+ */
1290
+ 'result': Array<Activity>;
1291
+ /**
1292
+ *
1293
+ * @type {Page}
1294
+ * @memberof ListActivitiesResult
1295
+ */
1296
+ 'page': Page;
1297
+ }
1298
+
1299
+ /**
1300
+ * Immutable zkEVM API
1301
+ * Immutable Multi Rollup API
1302
+ *
1303
+ * The version of the OpenAPI document: 1.0.0
1304
+ * Contact: support@immutable.com
1305
+ *
1306
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1307
+ * https://openapi-generator.tech
1308
+ * Do not edit the class manually.
1309
+ */
1310
+
1311
+ /**
1312
+ *
1313
+ * @export
1314
+ * @interface ListChainsResult
1315
+ */
1316
+ interface ListChainsResult {
1317
+ /**
1318
+ * List of chains
1319
+ * @type {Array<ChainWithDetails>}
1320
+ * @memberof ListChainsResult
1321
+ */
1322
+ 'result': Array<ChainWithDetails>;
1323
+ /**
1324
+ *
1325
+ * @type {Page}
1326
+ * @memberof ListChainsResult
1327
+ */
1328
+ 'page': Page;
1329
+ }
1330
+
1331
+ /**
1332
+ * Immutable zkEVM API
1333
+ * Immutable Multi Rollup API
1334
+ *
1335
+ * The version of the OpenAPI document: 1.0.0
1336
+ * Contact: support@immutable.com
1337
+ *
1338
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1339
+ * https://openapi-generator.tech
1340
+ * Do not edit the class manually.
1341
+ */
1342
+
1343
+ /**
1344
+ *
1345
+ * @export
1346
+ * @interface ListCollectionsResult
1347
+ */
1348
+ interface ListCollectionsResult {
1349
+ /**
1350
+ * List of collections
1351
+ * @type {Array<Collection>}
1352
+ * @memberof ListCollectionsResult
1353
+ */
1354
+ 'result': Array<Collection>;
1355
+ /**
1356
+ *
1357
+ * @type {Page}
1358
+ * @memberof ListCollectionsResult
1359
+ */
1360
+ 'page': Page;
1361
+ }
1362
+
1363
+ /**
1364
+ * Immutable zkEVM API
1365
+ * Immutable Multi Rollup API
1366
+ *
1367
+ * The version of the OpenAPI document: 1.0.0
1368
+ * Contact: support@immutable.com
1369
+ *
1370
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1371
+ * https://openapi-generator.tech
1372
+ * Do not edit the class manually.
1373
+ */
1374
+
1375
+ /**
1376
+ *
1377
+ * @export
1378
+ * @interface NFTOwner
1379
+ */
1380
+ interface NFTOwner {
1381
+ /**
1382
+ *
1383
+ * @type {Chain}
1384
+ * @memberof NFTOwner
1385
+ */
1386
+ 'chain': Chain;
1387
+ /**
1388
+ * The address of NFT contract
1389
+ * @type {string}
1390
+ * @memberof NFTOwner
1391
+ */
1392
+ 'contract_address': string;
1393
+ /**
1394
+ * An `uint256` token id as string
1395
+ * @type {string}
1396
+ * @memberof NFTOwner
1397
+ */
1398
+ 'token_id': string;
1399
+ /**
1400
+ * The account address of the owner of the NFT
1401
+ * @type {string}
1402
+ * @memberof NFTOwner
1403
+ */
1404
+ 'account_address': string;
1405
+ /**
1406
+ * The quantity of owned tokens (uint256 as string)
1407
+ * @type {string}
1408
+ * @memberof NFTOwner
1409
+ */
1410
+ 'quantity': string;
1411
+ }
1412
+
1413
+ /**
1414
+ * Immutable zkEVM API
1415
+ * Immutable Multi Rollup API
1416
+ *
1417
+ * The version of the OpenAPI document: 1.0.0
1418
+ * Contact: support@immutable.com
1419
+ *
1420
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1421
+ * https://openapi-generator.tech
1422
+ * Do not edit the class manually.
1423
+ */
1424
+
1425
+ /**
1426
+ *
1427
+ * @export
1428
+ * @interface ListNFTOwnersResult
1429
+ */
1430
+ interface ListNFTOwnersResult {
1431
+ /**
1432
+ * List of nft owners
1433
+ * @type {Array<NFTOwner>}
1434
+ * @memberof ListNFTOwnersResult
1435
+ */
1436
+ 'result': Array<NFTOwner>;
1437
+ /**
1438
+ *
1439
+ * @type {Page}
1440
+ * @memberof ListNFTOwnersResult
1441
+ */
1442
+ 'page': Page;
1443
+ }
1444
+
1445
+ /**
1446
+ * Immutable zkEVM API
1447
+ * Immutable Multi Rollup API
1448
+ *
1449
+ * The version of the OpenAPI document: 1.0.0
1450
+ * Contact: support@immutable.com
1451
+ *
1452
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1453
+ * https://openapi-generator.tech
1454
+ * Do not edit the class manually.
1455
+ */
1456
+
1457
+ /**
1458
+ *
1459
+ * @export
1460
+ * @interface ListNFTsResult
1461
+ */
1462
+ interface ListNFTsResult {
1463
+ /**
1464
+ * List of nfts
1465
+ * @type {Array<NFT>}
1466
+ * @memberof ListNFTsResult
1467
+ */
1468
+ 'result': Array<NFT>;
1469
+ /**
1470
+ *
1471
+ * @type {Page}
1472
+ * @memberof ListNFTsResult
1473
+ */
1474
+ 'page': Page;
1475
+ }
1476
+
1477
+ /**
1478
+ * Immutable zkEVM API
1479
+ * Immutable Multi Rollup API
1480
+ *
1481
+ * The version of the OpenAPI document: 1.0.0
1482
+ * Contact: support@immutable.com
1483
+ *
1484
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1485
+ * https://openapi-generator.tech
1486
+ * Do not edit the class manually.
1487
+ */
1488
+
1489
+ /**
1490
+ *
1491
+ * @export
1492
+ * @interface ListTokensResult
1493
+ */
1494
+ interface ListTokensResult {
1495
+ /**
1496
+ * List of tokens
1497
+ * @type {Array<Token>}
1498
+ * @memberof ListTokensResult
1499
+ */
1500
+ 'result': Array<Token>;
1501
+ /**
1502
+ *
1503
+ * @type {Page}
1504
+ * @memberof ListTokensResult
1505
+ */
1506
+ 'page': Page;
1507
+ }
1508
+
1509
+ /**
1510
+ * Request parameters for getActivity operation in ActivitiesApi.
1511
+ * @export
1512
+ * @interface ActivitiesApiGetActivityRequest
1513
+ */
1514
+ interface ActivitiesApiGetActivityRequest {
1515
+ /**
1516
+ * The name of chain
1517
+ * @type {string}
1518
+ * @memberof ActivitiesApiGetActivity
1519
+ */
1520
+ readonly chainName: string;
1521
+ /**
1522
+ * The id of activity
1523
+ * @type {string}
1524
+ * @memberof ActivitiesApiGetActivity
1525
+ */
1526
+ readonly activityId: string;
1527
+ }
1528
+ /**
1529
+ * Request parameters for listActivities operation in ActivitiesApi.
1530
+ * @export
1531
+ * @interface ActivitiesApiListActivitiesRequest
1532
+ */
1533
+ interface ActivitiesApiListActivitiesRequest {
1534
+ /**
1535
+ * The name of chain
1536
+ * @type {string}
1537
+ * @memberof ActivitiesApiListActivities
1538
+ */
1539
+ readonly chainName: string;
1540
+ /**
1541
+ * The contract address of NFT or ERC20 Token
1542
+ * @type {string}
1543
+ * @memberof ActivitiesApiListActivities
1544
+ */
1545
+ readonly contractAddress?: string;
1546
+ /**
1547
+ * An &#x60;uint256&#x60; token id as string
1548
+ * @type {string}
1549
+ * @memberof ActivitiesApiListActivities
1550
+ */
1551
+ readonly tokenId?: string;
1552
+ /**
1553
+ * The account address activity contains
1554
+ * @type {string}
1555
+ * @memberof ActivitiesApiListActivities
1556
+ */
1557
+ readonly accountAddress?: string;
1558
+ /**
1559
+ * The activity type
1560
+ * @type {ActivityType}
1561
+ * @memberof ActivitiesApiListActivities
1562
+ */
1563
+ readonly activityType?: ActivityType$1;
1564
+ /**
1565
+ * From indexed at including given date
1566
+ * @type {string}
1567
+ * @memberof ActivitiesApiListActivities
1568
+ */
1569
+ readonly fromIndexedAt?: string;
1570
+ /**
1571
+ * To indexed at including given date
1572
+ * @type {string}
1573
+ * @memberof ActivitiesApiListActivities
1574
+ */
1575
+ readonly toIndexedAt?: string;
1576
+ /**
1577
+ * The transaction hash of activity
1578
+ * @type {string}
1579
+ * @memberof ActivitiesApiListActivities
1580
+ */
1581
+ readonly transactionHash?: string;
1582
+ /**
1583
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1584
+ * @type {string}
1585
+ * @memberof ActivitiesApiListActivities
1586
+ */
1587
+ readonly pageCursor?: string;
1588
+ /**
1589
+ * Maximum number of items to return
1590
+ * @type {number}
1591
+ * @memberof ActivitiesApiListActivities
1592
+ */
1593
+ readonly pageSize?: number;
1594
+ }
1595
+
1596
+ /**
1597
+ * Request parameters for listChains operation in ChainsApi.
1598
+ * @export
1599
+ * @interface ChainsApiListChainsRequest
1600
+ */
1601
+ interface ChainsApiListChainsRequest {
1602
+ /**
1603
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1604
+ * @type {string}
1605
+ * @memberof ChainsApiListChains
1606
+ */
1607
+ readonly pageCursor?: string;
1608
+ /**
1609
+ * Maximum number of items to return
1610
+ * @type {number}
1611
+ * @memberof ChainsApiListChains
1612
+ */
1613
+ readonly pageSize?: number;
1614
+ }
1615
+
1616
+ /**
1617
+ * Request parameters for getCollection operation in CollectionsApi.
1618
+ * @export
1619
+ * @interface CollectionsApiGetCollectionRequest
1620
+ */
1621
+ interface CollectionsApiGetCollectionRequest {
1622
+ /**
1623
+ * The address contract
1624
+ * @type {string}
1625
+ * @memberof CollectionsApiGetCollection
1626
+ */
1627
+ readonly contractAddress: string;
1628
+ /**
1629
+ * The name of chain
1630
+ * @type {string}
1631
+ * @memberof CollectionsApiGetCollection
1632
+ */
1633
+ readonly chainName: string;
1634
+ }
1635
+ /**
1636
+ * Request parameters for listCollections operation in CollectionsApi.
1637
+ * @export
1638
+ * @interface CollectionsApiListCollectionsRequest
1639
+ */
1640
+ interface CollectionsApiListCollectionsRequest {
1641
+ /**
1642
+ * The name of chain
1643
+ * @type {string}
1644
+ * @memberof CollectionsApiListCollections
1645
+ */
1646
+ readonly chainName: string;
1647
+ /**
1648
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1649
+ * @type {string}
1650
+ * @memberof CollectionsApiListCollections
1651
+ */
1652
+ readonly pageCursor?: string;
1653
+ /**
1654
+ * Maximum number of items to return
1655
+ * @type {number}
1656
+ * @memberof CollectionsApiListCollections
1657
+ */
1658
+ readonly pageSize?: number;
1659
+ }
1660
+
1661
+ /**
1662
+ * Request parameters for listNFTOwners operation in NftOwnersApi.
1663
+ * @export
1664
+ * @interface NftOwnersApiListNFTOwnersRequest
1665
+ */
1666
+ interface NftOwnersApiListNFTOwnersRequest {
1667
+ /**
1668
+ * The address of contract
1669
+ * @type {string}
1670
+ * @memberof NftOwnersApiListNFTOwners
1671
+ */
1672
+ readonly contractAddress: string;
1673
+ /**
1674
+ * An &#x60;uint256&#x60; token id as string
1675
+ * @type {string}
1676
+ * @memberof NftOwnersApiListNFTOwners
1677
+ */
1678
+ readonly tokenId: string;
1679
+ /**
1680
+ * The name of chain
1681
+ * @type {string}
1682
+ * @memberof NftOwnersApiListNFTOwners
1683
+ */
1684
+ readonly chainName: string;
1685
+ /**
1686
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1687
+ * @type {string}
1688
+ * @memberof NftOwnersApiListNFTOwners
1689
+ */
1690
+ readonly pageCursor?: string;
1691
+ /**
1692
+ * Maximum number of items to return
1693
+ * @type {number}
1694
+ * @memberof NftOwnersApiListNFTOwners
1695
+ */
1696
+ readonly pageSize?: number;
1697
+ }
1698
+
1699
+ /**
1700
+ * Request parameters for getNFT operation in NftsApi.
1701
+ * @export
1702
+ * @interface NftsApiGetNFTRequest
1703
+ */
1704
+ interface NftsApiGetNFTRequest {
1705
+ /**
1706
+ * The address of NFT contract
1707
+ * @type {string}
1708
+ * @memberof NftsApiGetNFT
1709
+ */
1710
+ readonly contractAddress: string;
1711
+ /**
1712
+ * An &#x60;uint256&#x60; token id as string
1713
+ * @type {string}
1714
+ * @memberof NftsApiGetNFT
1715
+ */
1716
+ readonly tokenId: string;
1717
+ /**
1718
+ * The name of chain
1719
+ * @type {string}
1720
+ * @memberof NftsApiGetNFT
1721
+ */
1722
+ readonly chainName: string;
1723
+ }
1724
+ /**
1725
+ * Request parameters for listNFTs operation in NftsApi.
1726
+ * @export
1727
+ * @interface NftsApiListNFTsRequest
1728
+ */
1729
+ interface NftsApiListNFTsRequest {
1730
+ /**
1731
+ * Contract address
1732
+ * @type {string}
1733
+ * @memberof NftsApiListNFTs
1734
+ */
1735
+ readonly contractAddress: string;
1736
+ /**
1737
+ * The name of chain
1738
+ * @type {string}
1739
+ * @memberof NftsApiListNFTs
1740
+ */
1741
+ readonly chainName: string;
1742
+ /**
1743
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1744
+ * @type {string}
1745
+ * @memberof NftsApiListNFTs
1746
+ */
1747
+ readonly pageCursor?: string;
1748
+ /**
1749
+ * Maximum number of items to return
1750
+ * @type {number}
1751
+ * @memberof NftsApiListNFTs
1752
+ */
1753
+ readonly pageSize?: number;
1754
+ }
1755
+ /**
1756
+ * Request parameters for listNFTsByAccountAddress operation in NftsApi.
1757
+ * @export
1758
+ * @interface NftsApiListNFTsByAccountAddressRequest
1759
+ */
1760
+ interface NftsApiListNFTsByAccountAddressRequest {
1761
+ /**
1762
+ * Account address
1763
+ * @type {string}
1764
+ * @memberof NftsApiListNFTsByAccountAddress
1765
+ */
1766
+ readonly accountAddress: string;
1767
+ /**
1768
+ * The name of chain
1769
+ * @type {string}
1770
+ * @memberof NftsApiListNFTsByAccountAddress
1771
+ */
1772
+ readonly chainName: string;
1773
+ /**
1774
+ * The address of contract
1775
+ * @type {string}
1776
+ * @memberof NftsApiListNFTsByAccountAddress
1777
+ */
1778
+ readonly contractAddress?: string;
1779
+ /**
1780
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1781
+ * @type {string}
1782
+ * @memberof NftsApiListNFTsByAccountAddress
1783
+ */
1784
+ readonly pageCursor?: string;
1785
+ /**
1786
+ * Maximum number of items to return
1787
+ * @type {number}
1788
+ * @memberof NftsApiListNFTsByAccountAddress
1789
+ */
1790
+ readonly pageSize?: number;
1791
+ }
1792
+
1793
+ /**
1794
+ * Request parameters for getERC20Token operation in TokensApi.
1795
+ * @export
1796
+ * @interface TokensApiGetERC20TokenRequest
1797
+ */
1798
+ interface TokensApiGetERC20TokenRequest {
1799
+ /**
1800
+ * The address of contract
1801
+ * @type {string}
1802
+ * @memberof TokensApiGetERC20Token
1803
+ */
1804
+ readonly contractAddress: string;
1805
+ /**
1806
+ * The name of chain
1807
+ * @type {string}
1808
+ * @memberof TokensApiGetERC20Token
1809
+ */
1810
+ readonly chainName: string;
1811
+ }
1812
+ /**
1813
+ * Request parameters for listERC20Tokens operation in TokensApi.
1814
+ * @export
1815
+ * @interface TokensApiListERC20TokensRequest
1816
+ */
1817
+ interface TokensApiListERC20TokensRequest {
1818
+ /**
1819
+ * The name of chain
1820
+ * @type {string}
1821
+ * @memberof TokensApiListERC20Tokens
1822
+ */
1823
+ readonly chainName: string;
1824
+ /**
1825
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1826
+ * @type {string}
1827
+ * @memberof TokensApiListERC20Tokens
1828
+ */
1829
+ readonly pageCursor?: string;
1830
+ /**
1831
+ * Maximum number of items to return
1832
+ * @type {number}
1833
+ * @memberof TokensApiListERC20Tokens
1834
+ */
1835
+ readonly pageSize?: number;
1836
+ }
1837
+
1838
+ interface OpenAPIError extends BasicAPIError {
1839
+ code: string;
1840
+ details: {
1841
+ [key: string]: any;
1842
+ } | null;
1843
+ }
1844
+ /**
1845
+ * Custom Error class that is returned from the API when a request fails
1846
+ */
1847
+ declare class APIError extends Error {
1848
+ readonly code: string;
1849
+ readonly details: {
1850
+ [key: string]: any;
1851
+ } | null;
1852
+ readonly link: string;
1853
+ readonly traceId: string;
1854
+ constructor({ message, code, details, link, trace_id: traceId, }: OpenAPIError);
1855
+ }
1856
+
1857
+ declare class BlockchainData {
1858
+ readonly config: BlockchainDataConfiguration;
1859
+ private readonly activities;
1860
+ private readonly chains;
1861
+ private readonly collections;
1862
+ private readonly nfts;
1863
+ private readonly nftOwners;
1864
+ private readonly tokens;
1865
+ constructor(moduleConfig: BlockchainDataModuleConfiguration$1);
1866
+ /**
1867
+ * List all activities
1868
+ * @param request - the request object containing the parameters to be provided in the API request
1869
+ * @returns a promise that resolves with a list of activities
1870
+ * @throws {@link index.APIError}
1871
+ */
1872
+ listActivities(request: ActivitiesApiListActivitiesRequest): Promise<ListActivitiesResult>;
1873
+ /**
1874
+ * Get a single activity by ID
1875
+ * @param request - the request object containing the parameters to be provided in the API request
1876
+ * @returns a promise that resolves with a single activity
1877
+ * @throws {@link index.APIError}
1878
+ */
1879
+ getActivity(request: ActivitiesApiGetActivityRequest): Promise<GetActivityResult>;
1880
+ /**
1881
+ * List supported chains
1882
+ * @param request - the request object containing the parameters to be provided in the API request
1883
+ * @returns a promise that resolves with a list of supported chains
1884
+ * @throws {@link index.APIError}
1885
+ */
1886
+ listChains(request: ChainsApiListChainsRequest): Promise<ListChainsResult>;
1887
+ /**
1888
+ * List all collections
1889
+ * @param request - the request object containing the parameters to be provided in the API request
1890
+ * @returns a promise that resolves with a list of collections
1891
+ * @throws {@link index.APIError}
1892
+ */
1893
+ listCollections(request: CollectionsApiListCollectionsRequest): Promise<ListCollectionsResult>;
1894
+ /**
1895
+ * Get collection by contract address
1896
+ * @param request - the request object containing the parameters to be provided in the API request
1897
+ * @returns a promise that resolves with a single collection
1898
+ * @throws {@link index.APIError}
1899
+ */
1900
+ getCollection(request: CollectionsApiGetCollectionRequest): Promise<GetCollectionResult>;
1901
+ /**
1902
+ * Get NFT by token ID
1903
+ * @param request - the request object containing the parameters to be provided in the API request
1904
+ * @returns a promise that resolves with a single NFT
1905
+ * @throws {@link index.APIError}
1906
+ */
1907
+ getNFT(request: NftsApiGetNFTRequest): Promise<GetNFTResult>;
1908
+ /**
1909
+ * List NFTs by contract address
1910
+ * @param request - the request object containing the parameters to be provided in the API request
1911
+ * @returns a promise that resolves with a list of NFTs
1912
+ * @throws {@link index.APIError}
1913
+ */
1914
+ listNFTs(request: NftsApiListNFTsRequest): Promise<ListNFTsResult>;
1915
+ /**
1916
+ * List NFTs by account address
1917
+ * @param request - the request object containing the parameters to be provided in the API request
1918
+ * @returns a promise that resolves with a list of NFTs
1919
+ * @throws {@link index.APIError}
1920
+ */
1921
+ listNFTsByAccountAddress(request: NftsApiListNFTsByAccountAddressRequest): Promise<ListNFTsResult>;
1922
+ /**
1923
+ * List NFT owners by token ID
1924
+ * @param request - the request object containing the parameters to be provided in the API request
1925
+ * @returns a promise that resolves with a list of NFT owners
1926
+ * @throws {@link index.APIError}
1927
+ */
1928
+ listNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
1929
+ /**
1930
+ * List ERC20 Token contracts
1931
+ * @param request - the request object containing the parameters to be provided in the API request
1932
+ * @returns a promise that resolves with a list of ERC20 Tokens
1933
+ * @throws {@link index.APIError}
1934
+ */
1935
+ listTokens(request: TokensApiListERC20TokensRequest): Promise<ListTokensResult>;
1936
+ /**
1937
+ * Get details for an ERC20 Token by contract address
1938
+ * @param request - the request object containing the parameters to be provided in the API request
1939
+ * @returns a promise that resolves with a list of ERC20 Tokens
1940
+ * @throws {@link index.APIError}
1941
+ */
1942
+ getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
1943
+ }
1944
+
1945
+ declare enum Environment {
1946
+ PRODUCTION = "production",
1947
+ SANDBOX = "sandbox"
1948
+ }
1949
+ declare class ImmutableConfiguration {
1950
+ readonly environment: Environment;
1951
+ readonly apiKey?: string;
1952
+ constructor(options: {
1953
+ environment: Environment;
1954
+ apiKey?: string;
1955
+ });
1956
+ }
1957
+ interface ModuleConfiguration<T> {
1958
+ baseConfig: ImmutableConfiguration;
1959
+ overrides?: T;
1960
+ }
1961
+
1962
+ interface APIConfigurationParams {
1963
+ basePath: string;
1964
+ headers?: Record<string, string>;
1965
+ }
1966
+ interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
1967
+ }
1968
+
1969
+ type ActivityType = ActivityType$1;
1970
+
1971
+ export { APIError, ActivityType, BlockchainData, BlockchainDataModuleConfiguration };