@imtbl/sdk 0.1.7-alpha.2 → 0.1.7-alpha.3

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,1518 @@
1
+ import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration } from 'config';
2
+
3
+ /**
4
+ * Immutable X 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
+ * The activity type
16
+ * @export
17
+ * @enum {string}
18
+ */
19
+ declare const ActivityType: {
20
+ readonly Mint: "mint";
21
+ readonly Burn: "burn";
22
+ readonly Transfer: "transfer";
23
+ readonly Sale: "sale";
24
+ };
25
+ type ActivityType = typeof ActivityType[keyof typeof ActivityType];
26
+
27
+ /**
28
+ * Immutable X API
29
+ * Immutable Multi Rollup API
30
+ *
31
+ * The version of the OpenAPI document: 1.0.0
32
+ * Contact: support@immutable.com
33
+ *
34
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
35
+ * https://openapi-generator.tech
36
+ * Do not edit the class manually.
37
+ */
38
+ /**
39
+ * The contract type
40
+ * @export
41
+ * @enum {string}
42
+ */
43
+ declare const ContractType: {
44
+ readonly Erc721: "ERC721";
45
+ readonly Erc20: "ERC20";
46
+ };
47
+ type ContractType = typeof ContractType[keyof typeof ContractType];
48
+
49
+ /**
50
+ * Immutable X API
51
+ * Immutable Multi Rollup API
52
+ *
53
+ * The version of the OpenAPI document: 1.0.0
54
+ * Contact: support@immutable.com
55
+ *
56
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
57
+ * https://openapi-generator.tech
58
+ * Do not edit the class manually.
59
+ */
60
+
61
+ /**
62
+ *
63
+ * @export
64
+ * @interface ERC20
65
+ */
66
+ interface ERC20 {
67
+ /**
68
+ *
69
+ * @type {ContractType}
70
+ * @memberof ERC20
71
+ */
72
+ 'contract_type': ContractType;
73
+ /**
74
+ * The token contract address
75
+ * @type {string}
76
+ * @memberof ERC20
77
+ */
78
+ 'contract_address': string;
79
+ /**
80
+ * The symbol of the token
81
+ * @type {string}
82
+ * @memberof ERC20
83
+ */
84
+ 'symbol': string | null;
85
+ /**
86
+ * The decimal places of a token
87
+ * @type {number}
88
+ * @memberof ERC20
89
+ */
90
+ 'decimals': number | null;
91
+ }
92
+
93
+ /**
94
+ * Immutable X API
95
+ * Immutable Multi Rollup API
96
+ *
97
+ * The version of the OpenAPI document: 1.0.0
98
+ * Contact: support@immutable.com
99
+ *
100
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
101
+ * https://openapi-generator.tech
102
+ * Do not edit the class manually.
103
+ */
104
+
105
+ /**
106
+ *
107
+ * @export
108
+ * @interface ERC721Token
109
+ */
110
+ interface ERC721Token {
111
+ /**
112
+ *
113
+ * @type {ContractType}
114
+ * @memberof ERC721Token
115
+ */
116
+ 'contract_type': ContractType;
117
+ /**
118
+ * The token contract address
119
+ * @type {string}
120
+ * @memberof ERC721Token
121
+ */
122
+ 'contract_address': string;
123
+ /**
124
+ * An `uint256` token id as string
125
+ * @type {string}
126
+ * @memberof ERC721Token
127
+ */
128
+ 'token_id': string;
129
+ }
130
+
131
+ /**
132
+ * Immutable X API
133
+ * Immutable Multi Rollup API
134
+ *
135
+ * The version of the OpenAPI document: 1.0.0
136
+ * Contact: support@immutable.com
137
+ *
138
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
139
+ * https://openapi-generator.tech
140
+ * Do not edit the class manually.
141
+ */
142
+
143
+ /**
144
+ * @type Token
145
+ * The token details
146
+ * @export
147
+ */
148
+ type Token = ERC20 | ERC721Token;
149
+
150
+ /**
151
+ * Immutable X API
152
+ * Immutable Multi Rollup API
153
+ *
154
+ * The version of the OpenAPI document: 1.0.0
155
+ * Contact: support@immutable.com
156
+ *
157
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
158
+ * https://openapi-generator.tech
159
+ * Do not edit the class manually.
160
+ */
161
+
162
+ /**
163
+ * The burn activity details
164
+ * @export
165
+ * @interface Burn
166
+ */
167
+ interface Burn {
168
+ /**
169
+ *
170
+ * @type {ActivityType}
171
+ * @memberof Burn
172
+ */
173
+ 'activity_type': ActivityType;
174
+ /**
175
+ * The account address the token was transferred from
176
+ * @type {string}
177
+ * @memberof Burn
178
+ */
179
+ 'from': string;
180
+ /**
181
+ * The amount of tokens burnt
182
+ * @type {string}
183
+ * @memberof Burn
184
+ */
185
+ 'amount': string;
186
+ /**
187
+ *
188
+ * @type {Token}
189
+ * @memberof Burn
190
+ */
191
+ 'token': Token;
192
+ }
193
+
194
+ /**
195
+ * Immutable X API
196
+ * Immutable Multi Rollup API
197
+ *
198
+ * The version of the OpenAPI document: 1.0.0
199
+ * Contact: support@immutable.com
200
+ *
201
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
202
+ * https://openapi-generator.tech
203
+ * Do not edit the class manually.
204
+ */
205
+
206
+ /**
207
+ * The mint activity details
208
+ * @export
209
+ * @interface Mint
210
+ */
211
+ interface Mint {
212
+ /**
213
+ *
214
+ * @type {ActivityType}
215
+ * @memberof Mint
216
+ */
217
+ 'activity_type': ActivityType;
218
+ /**
219
+ * The account address token minted to
220
+ * @type {string}
221
+ * @memberof Mint
222
+ */
223
+ 'to': string;
224
+ /**
225
+ * The minted token amount
226
+ * @type {string}
227
+ * @memberof Mint
228
+ */
229
+ 'amount': string;
230
+ /**
231
+ *
232
+ * @type {Token}
233
+ * @memberof Mint
234
+ */
235
+ 'token': Token;
236
+ }
237
+
238
+ /**
239
+ * Immutable X API
240
+ * Immutable Multi Rollup API
241
+ *
242
+ * The version of the OpenAPI document: 1.0.0
243
+ * Contact: support@immutable.com
244
+ *
245
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
246
+ * https://openapi-generator.tech
247
+ * Do not edit the class manually.
248
+ */
249
+ /**
250
+ *
251
+ * @export
252
+ * @interface NativeToken
253
+ */
254
+ interface NativeToken {
255
+ /**
256
+ * The token symbol
257
+ * @type {string}
258
+ * @memberof NativeToken
259
+ */
260
+ 'symbol': string;
261
+ }
262
+
263
+ /**
264
+ * Immutable X API
265
+ * Immutable Multi Rollup API
266
+ *
267
+ * The version of the OpenAPI document: 1.0.0
268
+ * Contact: support@immutable.com
269
+ *
270
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
271
+ * https://openapi-generator.tech
272
+ * Do not edit the class manually.
273
+ */
274
+
275
+ /**
276
+ * @type NFTSalePaymentToken
277
+ * The type of payment token
278
+ * @export
279
+ */
280
+ type NFTSalePaymentToken = ERC20 | NativeToken;
281
+
282
+ /**
283
+ * Immutable X API
284
+ * Immutable Multi Rollup API
285
+ *
286
+ * The version of the OpenAPI document: 1.0.0
287
+ * Contact: support@immutable.com
288
+ *
289
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
290
+ * https://openapi-generator.tech
291
+ * Do not edit the class manually.
292
+ */
293
+
294
+ /**
295
+ * The NFT Sale activity details
296
+ * @export
297
+ * @interface NFTSale
298
+ */
299
+ interface NFTSale {
300
+ /**
301
+ *
302
+ * @type {ActivityType}
303
+ * @memberof NFTSale
304
+ */
305
+ 'activity_type': ActivityType;
306
+ /**
307
+ * The id of order
308
+ * @type {string}
309
+ * @memberof NFTSale
310
+ */
311
+ 'order_id': string;
312
+ /**
313
+ * The account address of buyer
314
+ * @type {string}
315
+ * @memberof NFTSale
316
+ */
317
+ 'buyer_address': string;
318
+ /**
319
+ * The account address of seller
320
+ * @type {string}
321
+ * @memberof NFTSale
322
+ */
323
+ 'seller_address': string;
324
+ /**
325
+ * The quantity of tokens sold
326
+ * @type {number}
327
+ * @memberof NFTSale
328
+ */
329
+ 'quantity': number;
330
+ /**
331
+ *
332
+ * @type {ERC721Token}
333
+ * @memberof NFTSale
334
+ */
335
+ 'token': ERC721Token;
336
+ /**
337
+ * The amount of payment
338
+ * @type {string}
339
+ * @memberof NFTSale
340
+ */
341
+ 'payment_amount': string;
342
+ /**
343
+ *
344
+ * @type {NFTSalePaymentToken}
345
+ * @memberof NFTSale
346
+ */
347
+ 'payment_token': NFTSalePaymentToken;
348
+ }
349
+
350
+ /**
351
+ * Immutable X API
352
+ * Immutable Multi Rollup API
353
+ *
354
+ * The version of the OpenAPI document: 1.0.0
355
+ * Contact: support@immutable.com
356
+ *
357
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
358
+ * https://openapi-generator.tech
359
+ * Do not edit the class manually.
360
+ */
361
+
362
+ /**
363
+ * The transfer activity details
364
+ * @export
365
+ * @interface Transfer
366
+ */
367
+ interface Transfer {
368
+ /**
369
+ *
370
+ * @type {ActivityType}
371
+ * @memberof Transfer
372
+ */
373
+ 'activity_type': ActivityType;
374
+ /**
375
+ * The account address the token was transferred from
376
+ * @type {string}
377
+ * @memberof Transfer
378
+ */
379
+ 'from': string;
380
+ /**
381
+ * The account address the token was transferred to
382
+ * @type {string}
383
+ * @memberof Transfer
384
+ */
385
+ 'to': string;
386
+ /**
387
+ * The amount of tokens transferred
388
+ * @type {string}
389
+ * @memberof Transfer
390
+ */
391
+ 'amount': string;
392
+ /**
393
+ *
394
+ * @type {Token}
395
+ * @memberof Transfer
396
+ */
397
+ 'token': Token;
398
+ }
399
+
400
+ /**
401
+ * Immutable X API
402
+ * Immutable Multi Rollup API
403
+ *
404
+ * The version of the OpenAPI document: 1.0.0
405
+ * Contact: support@immutable.com
406
+ *
407
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
408
+ * https://openapi-generator.tech
409
+ * Do not edit the class manually.
410
+ */
411
+
412
+ /**
413
+ * @type ActivityDetails
414
+ * The activity details
415
+ * @export
416
+ */
417
+ type ActivityDetails = Burn | Mint | NFTSale | Transfer;
418
+
419
+ /**
420
+ * Immutable X API
421
+ * Immutable Multi Rollup API
422
+ *
423
+ * The version of the OpenAPI document: 1.0.0
424
+ * Contact: support@immutable.com
425
+ *
426
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
427
+ * https://openapi-generator.tech
428
+ * Do not edit the class manually.
429
+ */
430
+ /**
431
+ * The metadata related to blockchain transaction
432
+ * @export
433
+ * @interface BlockchainMetadata
434
+ */
435
+ interface BlockchainMetadata {
436
+ /**
437
+ * The transaction hash of the activity
438
+ * @type {string}
439
+ * @memberof BlockchainMetadata
440
+ */
441
+ 'transaction_hash': string;
442
+ /**
443
+ * EVM block number (uint64 as string)
444
+ * @type {string}
445
+ * @memberof BlockchainMetadata
446
+ */
447
+ 'block_number': string;
448
+ /**
449
+ * Transaction index in a block (uint32 as string)
450
+ * @type {string}
451
+ * @memberof BlockchainMetadata
452
+ */
453
+ 'transaction_index': string;
454
+ /**
455
+ * The log index of activity in a block (uint32 as string)
456
+ * @type {string}
457
+ * @memberof BlockchainMetadata
458
+ */
459
+ 'log_index': string | null;
460
+ }
461
+
462
+ /**
463
+ * Immutable X API
464
+ * Immutable Multi Rollup API
465
+ *
466
+ * The version of the OpenAPI document: 1.0.0
467
+ * Contact: support@immutable.com
468
+ *
469
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
470
+ * https://openapi-generator.tech
471
+ * Do not edit the class manually.
472
+ */
473
+ /**
474
+ * The chain details
475
+ * @export
476
+ * @interface Chain
477
+ */
478
+ interface Chain {
479
+ /**
480
+ * The id of chain
481
+ * @type {string}
482
+ * @memberof Chain
483
+ */
484
+ 'id': string;
485
+ /**
486
+ * The name of chain
487
+ * @type {string}
488
+ * @memberof Chain
489
+ */
490
+ 'name': string;
491
+ }
492
+
493
+ /**
494
+ * Immutable X API
495
+ * Immutable Multi Rollup API
496
+ *
497
+ * The version of the OpenAPI document: 1.0.0
498
+ * Contact: support@immutable.com
499
+ *
500
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
501
+ * https://openapi-generator.tech
502
+ * Do not edit the class manually.
503
+ */
504
+
505
+ /**
506
+ *
507
+ * @export
508
+ * @interface Activity
509
+ */
510
+ interface Activity {
511
+ /**
512
+ * Activity ID in UUIDv4 format
513
+ * @type {string}
514
+ * @memberof Activity
515
+ */
516
+ 'id': string;
517
+ /**
518
+ *
519
+ * @type {Chain}
520
+ * @memberof Activity
521
+ */
522
+ 'chain': Chain;
523
+ /**
524
+ *
525
+ * @type {ActivityType}
526
+ * @memberof Activity
527
+ */
528
+ 'type': ActivityType;
529
+ /**
530
+ *
531
+ * @type {ActivityDetails}
532
+ * @memberof Activity
533
+ */
534
+ 'details': ActivityDetails;
535
+ /**
536
+ * The time activity was indexed
537
+ * @type {string}
538
+ * @memberof Activity
539
+ */
540
+ 'indexed_at': string;
541
+ /**
542
+ *
543
+ * @type {BlockchainMetadata}
544
+ * @memberof Activity
545
+ */
546
+ 'blockchain_metadata': BlockchainMetadata | null;
547
+ }
548
+
549
+ /**
550
+ * Immutable X API
551
+ * Immutable Multi Rollup API
552
+ *
553
+ * The version of the OpenAPI document: 1.0.0
554
+ * Contact: support@immutable.com
555
+ *
556
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
557
+ * https://openapi-generator.tech
558
+ * Do not edit the class manually.
559
+ */
560
+ /**
561
+ * The collection contract type
562
+ * @export
563
+ * @enum {string}
564
+ */
565
+ declare const CollectionContractType: {
566
+ readonly Erc721: "ERC721";
567
+ };
568
+ type CollectionContractType = typeof CollectionContractType[keyof typeof CollectionContractType];
569
+
570
+ /**
571
+ * Immutable X API
572
+ * Immutable Multi Rollup API
573
+ *
574
+ * The version of the OpenAPI document: 1.0.0
575
+ * Contact: support@immutable.com
576
+ *
577
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
578
+ * https://openapi-generator.tech
579
+ * Do not edit the class manually.
580
+ */
581
+
582
+ /**
583
+ *
584
+ * @export
585
+ * @interface Collection
586
+ */
587
+ interface Collection {
588
+ /**
589
+ *
590
+ * @type {Chain}
591
+ * @memberof Collection
592
+ */
593
+ 'chain': Chain;
594
+ /**
595
+ * The name of the collection
596
+ * @type {string}
597
+ * @memberof Collection
598
+ */
599
+ 'name': string | null;
600
+ /**
601
+ * The symbol of contract
602
+ * @type {string}
603
+ * @memberof Collection
604
+ */
605
+ 'symbol': string | null;
606
+ /**
607
+ *
608
+ * @type {CollectionContractType}
609
+ * @memberof Collection
610
+ */
611
+ 'contract_type': CollectionContractType;
612
+ /**
613
+ * The address of the contract
614
+ * @type {string}
615
+ * @memberof Collection
616
+ */
617
+ 'contract_address': string;
618
+ /**
619
+ * The description of collection
620
+ * @type {string}
621
+ * @memberof Collection
622
+ */
623
+ 'description': string | null;
624
+ /**
625
+ * The url of the collection image
626
+ * @type {string}
627
+ * @memberof Collection
628
+ */
629
+ 'image': string | null;
630
+ /**
631
+ * The url of external link
632
+ * @type {string}
633
+ * @memberof Collection
634
+ */
635
+ 'external_link': string | null;
636
+ /**
637
+ * The uri for the metadata of the collection
638
+ * @type {string}
639
+ * @memberof Collection
640
+ */
641
+ 'contract_uri'?: string | null;
642
+ /**
643
+ * The metadata uri for nft
644
+ * @type {string}
645
+ * @memberof Collection
646
+ */
647
+ 'base_uri': string | null;
648
+ /**
649
+ * When the collection was first indexed
650
+ * @type {string}
651
+ * @memberof Collection
652
+ */
653
+ 'indexed_at': string;
654
+ /**
655
+ * When the collection was last updated
656
+ * @type {string}
657
+ * @memberof Collection
658
+ */
659
+ 'updated_at': string;
660
+ /**
661
+ * When the collection metadata was last synced
662
+ * @type {string}
663
+ * @memberof Collection
664
+ */
665
+ 'last_metadata_synced_at': string | null;
666
+ }
667
+
668
+ /**
669
+ * Immutable X API
670
+ * Immutable Multi Rollup API
671
+ *
672
+ * The version of the OpenAPI document: 1.0.0
673
+ * Contact: support@immutable.com
674
+ *
675
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
676
+ * https://openapi-generator.tech
677
+ * Do not edit the class manually.
678
+ */
679
+
680
+ /**
681
+ * Single activity
682
+ * @export
683
+ * @interface GetActivityResult
684
+ */
685
+ interface GetActivityResult {
686
+ /**
687
+ *
688
+ * @type {Activity}
689
+ * @memberof GetActivityResult
690
+ */
691
+ 'result': Activity;
692
+ }
693
+
694
+ /**
695
+ * Immutable X API
696
+ * Immutable Multi Rollup API
697
+ *
698
+ * The version of the OpenAPI document: 1.0.0
699
+ * Contact: support@immutable.com
700
+ *
701
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
702
+ * https://openapi-generator.tech
703
+ * Do not edit the class manually.
704
+ */
705
+
706
+ /**
707
+ * Single Collection
708
+ * @export
709
+ * @interface GetCollectionResult
710
+ */
711
+ interface GetCollectionResult {
712
+ /**
713
+ *
714
+ * @type {Collection}
715
+ * @memberof GetCollectionResult
716
+ */
717
+ 'result': Collection;
718
+ }
719
+
720
+ /**
721
+ * Immutable X API
722
+ * Immutable Multi Rollup API
723
+ *
724
+ * The version of the OpenAPI document: 1.0.0
725
+ * Contact: support@immutable.com
726
+ *
727
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
728
+ * https://openapi-generator.tech
729
+ * Do not edit the class manually.
730
+ */
731
+
732
+ /**
733
+ *
734
+ * @export
735
+ * @interface NFT
736
+ */
737
+ interface NFT {
738
+ /**
739
+ *
740
+ * @type {Chain}
741
+ * @memberof NFT
742
+ */
743
+ 'chain': Chain;
744
+ /**
745
+ * An `uint256` token id as string
746
+ * @type {string}
747
+ * @memberof NFT
748
+ */
749
+ 'token_id': string;
750
+ /**
751
+ * The contract address of the NFT
752
+ * @type {string}
753
+ * @memberof NFT
754
+ */
755
+ 'contract_address': string;
756
+ /**
757
+ * When the NFT was first indexed
758
+ * @type {string}
759
+ * @memberof NFT
760
+ */
761
+ 'indexed_at': string;
762
+ /**
763
+ * When NFT metadata was last synced
764
+ * @type {string}
765
+ * @memberof NFT
766
+ */
767
+ 'metadata_synced_at': string | null;
768
+ /**
769
+ * The name of the NFT
770
+ * @type {string}
771
+ * @memberof NFT
772
+ */
773
+ 'name': string | null;
774
+ /**
775
+ * The description of the NFT
776
+ * @type {string}
777
+ * @memberof NFT
778
+ */
779
+ 'description': string | null;
780
+ /**
781
+ * The image url of the NFT
782
+ * @type {string}
783
+ * @memberof NFT
784
+ */
785
+ 'image': string | null;
786
+ /**
787
+ * The external website link of NFT
788
+ * @type {string}
789
+ * @memberof NFT
790
+ */
791
+ 'external_link': string | null;
792
+ /**
793
+ * The animation url of the NFT
794
+ * @type {string}
795
+ * @memberof NFT
796
+ */
797
+ 'animation_url': string | null;
798
+ /**
799
+ * The youtube URL of NFT
800
+ * @type {string}
801
+ * @memberof NFT
802
+ */
803
+ 'youtube_url': string | null;
804
+ /**
805
+ * The id of mint activity of this NFT
806
+ * @type {string}
807
+ * @memberof NFT
808
+ */
809
+ 'mint_activity_id': string | null;
810
+ }
811
+
812
+ /**
813
+ * Immutable X API
814
+ * Immutable Multi Rollup API
815
+ *
816
+ * The version of the OpenAPI document: 1.0.0
817
+ * Contact: support@immutable.com
818
+ *
819
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
820
+ * https://openapi-generator.tech
821
+ * Do not edit the class manually.
822
+ */
823
+ /**
824
+ *
825
+ * @export
826
+ * @interface NFTMetadataAttribute
827
+ */
828
+ interface NFTMetadataAttribute {
829
+ /**
830
+ * The metadata trait type
831
+ * @type {string}
832
+ * @memberof NFTMetadataAttribute
833
+ */
834
+ 'trait_type': string;
835
+ /**
836
+ * The metadata trait value
837
+ * @type {string}
838
+ * @memberof NFTMetadataAttribute
839
+ */
840
+ 'value': string;
841
+ /**
842
+ * The metadata trait display type
843
+ * @type {string}
844
+ * @memberof NFTMetadataAttribute
845
+ */
846
+ 'display_type': string;
847
+ }
848
+
849
+ /**
850
+ * Immutable X API
851
+ * Immutable Multi Rollup API
852
+ *
853
+ * The version of the OpenAPI document: 1.0.0
854
+ * Contact: support@immutable.com
855
+ *
856
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
857
+ * https://openapi-generator.tech
858
+ * Do not edit the class manually.
859
+ */
860
+
861
+ /**
862
+ * List of normalized NFT metadata attributes
863
+ * @export
864
+ * @interface NFTMetadataAttributes
865
+ */
866
+ interface NFTMetadataAttributes {
867
+ /**
868
+ * List of NFT Metadata attributes
869
+ * @type {Array<NFTMetadataAttribute>}
870
+ * @memberof NFTMetadataAttributes
871
+ */
872
+ 'attributes': Array<NFTMetadataAttribute>;
873
+ }
874
+
875
+ /**
876
+ * Immutable X API
877
+ * Immutable Multi Rollup API
878
+ *
879
+ * The version of the OpenAPI document: 1.0.0
880
+ * Contact: support@immutable.com
881
+ *
882
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
883
+ * https://openapi-generator.tech
884
+ * Do not edit the class manually.
885
+ */
886
+
887
+ /**
888
+ * @type NFTWithMetadataAttributes
889
+ * A single NFT with metadata attributes
890
+ * @export
891
+ */
892
+ type NFTWithMetadataAttributes = NFT & NFTMetadataAttributes;
893
+
894
+ /**
895
+ * Immutable X API
896
+ * Immutable Multi Rollup API
897
+ *
898
+ * The version of the OpenAPI document: 1.0.0
899
+ * Contact: support@immutable.com
900
+ *
901
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
902
+ * https://openapi-generator.tech
903
+ * Do not edit the class manually.
904
+ */
905
+
906
+ /**
907
+ * Single NFT
908
+ * @export
909
+ * @interface GetNFTResult
910
+ */
911
+ interface GetNFTResult {
912
+ /**
913
+ *
914
+ * @type {NFTWithMetadataAttributes}
915
+ * @memberof GetNFTResult
916
+ */
917
+ 'result': NFTWithMetadataAttributes;
918
+ }
919
+
920
+ /**
921
+ * Immutable X API
922
+ * Immutable Multi Rollup API
923
+ *
924
+ * The version of the OpenAPI document: 1.0.0
925
+ * Contact: support@immutable.com
926
+ *
927
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
928
+ * https://openapi-generator.tech
929
+ * Do not edit the class manually.
930
+ */
931
+ /**
932
+ * Pagination properties
933
+ * @export
934
+ * @interface Page
935
+ */
936
+ interface Page {
937
+ /**
938
+ * First item as base64 encoded string
939
+ * @type {string}
940
+ * @memberof Page
941
+ */
942
+ 'previous_cursor': string;
943
+ /**
944
+ * Last item as base64 encoded string
945
+ * @type {string}
946
+ * @memberof Page
947
+ */
948
+ 'next_cursor': string;
949
+ }
950
+
951
+ /**
952
+ * Immutable X API
953
+ * Immutable Multi Rollup API
954
+ *
955
+ * The version of the OpenAPI document: 1.0.0
956
+ * Contact: support@immutable.com
957
+ *
958
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
959
+ * https://openapi-generator.tech
960
+ * Do not edit the class manually.
961
+ */
962
+
963
+ /**
964
+ * List activities response
965
+ * @export
966
+ * @interface ListActivitiesResult
967
+ */
968
+ interface ListActivitiesResult {
969
+ /**
970
+ * List of activities
971
+ * @type {Array<Activity>}
972
+ * @memberof ListActivitiesResult
973
+ */
974
+ 'result': Array<Activity>;
975
+ /**
976
+ *
977
+ * @type {Page}
978
+ * @memberof ListActivitiesResult
979
+ */
980
+ 'page': Page;
981
+ }
982
+
983
+ /**
984
+ * Immutable X API
985
+ * Immutable Multi Rollup API
986
+ *
987
+ * The version of the OpenAPI document: 1.0.0
988
+ * Contact: support@immutable.com
989
+ *
990
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
991
+ * https://openapi-generator.tech
992
+ * Do not edit the class manually.
993
+ */
994
+
995
+ /**
996
+ *
997
+ * @export
998
+ * @interface ListChainsResult
999
+ */
1000
+ interface ListChainsResult {
1001
+ /**
1002
+ * List of chains
1003
+ * @type {Array<Chain>}
1004
+ * @memberof ListChainsResult
1005
+ */
1006
+ 'result': Array<Chain>;
1007
+ /**
1008
+ *
1009
+ * @type {Page}
1010
+ * @memberof ListChainsResult
1011
+ */
1012
+ 'page': Page;
1013
+ }
1014
+
1015
+ /**
1016
+ * Immutable X API
1017
+ * Immutable Multi Rollup API
1018
+ *
1019
+ * The version of the OpenAPI document: 1.0.0
1020
+ * Contact: support@immutable.com
1021
+ *
1022
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1023
+ * https://openapi-generator.tech
1024
+ * Do not edit the class manually.
1025
+ */
1026
+
1027
+ /**
1028
+ *
1029
+ * @export
1030
+ * @interface ListCollectionsResult
1031
+ */
1032
+ interface ListCollectionsResult {
1033
+ /**
1034
+ * List of collections
1035
+ * @type {Array<Collection>}
1036
+ * @memberof ListCollectionsResult
1037
+ */
1038
+ 'result': Array<Collection>;
1039
+ /**
1040
+ *
1041
+ * @type {Page}
1042
+ * @memberof ListCollectionsResult
1043
+ */
1044
+ 'page': Page;
1045
+ }
1046
+
1047
+ /**
1048
+ * Immutable X API
1049
+ * Immutable Multi Rollup API
1050
+ *
1051
+ * The version of the OpenAPI document: 1.0.0
1052
+ * Contact: support@immutable.com
1053
+ *
1054
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1055
+ * https://openapi-generator.tech
1056
+ * Do not edit the class manually.
1057
+ */
1058
+
1059
+ /**
1060
+ *
1061
+ * @export
1062
+ * @interface NFTOwner
1063
+ */
1064
+ interface NFTOwner {
1065
+ /**
1066
+ *
1067
+ * @type {Chain}
1068
+ * @memberof NFTOwner
1069
+ */
1070
+ 'chain': Chain;
1071
+ /**
1072
+ * The address of NFT contract
1073
+ * @type {string}
1074
+ * @memberof NFTOwner
1075
+ */
1076
+ 'contract_address': string;
1077
+ /**
1078
+ * An `uint256` token id as string
1079
+ * @type {string}
1080
+ * @memberof NFTOwner
1081
+ */
1082
+ 'token_id': string;
1083
+ /**
1084
+ * The account address of the owner of the NFT
1085
+ * @type {string}
1086
+ * @memberof NFTOwner
1087
+ */
1088
+ 'account_address': string;
1089
+ /**
1090
+ * The quantity of owned tokens (uint256 as string)
1091
+ * @type {string}
1092
+ * @memberof NFTOwner
1093
+ */
1094
+ 'quantity': string;
1095
+ }
1096
+
1097
+ /**
1098
+ * Immutable X API
1099
+ * Immutable Multi Rollup API
1100
+ *
1101
+ * The version of the OpenAPI document: 1.0.0
1102
+ * Contact: support@immutable.com
1103
+ *
1104
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1105
+ * https://openapi-generator.tech
1106
+ * Do not edit the class manually.
1107
+ */
1108
+
1109
+ /**
1110
+ *
1111
+ * @export
1112
+ * @interface ListNFTOwnersResult
1113
+ */
1114
+ interface ListNFTOwnersResult {
1115
+ /**
1116
+ * List of nft owners
1117
+ * @type {Array<NFTOwner>}
1118
+ * @memberof ListNFTOwnersResult
1119
+ */
1120
+ 'result': Array<NFTOwner>;
1121
+ /**
1122
+ *
1123
+ * @type {Page}
1124
+ * @memberof ListNFTOwnersResult
1125
+ */
1126
+ 'page': Page;
1127
+ }
1128
+
1129
+ /**
1130
+ * Immutable X API
1131
+ * Immutable Multi Rollup API
1132
+ *
1133
+ * The version of the OpenAPI document: 1.0.0
1134
+ * Contact: support@immutable.com
1135
+ *
1136
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1137
+ * https://openapi-generator.tech
1138
+ * Do not edit the class manually.
1139
+ */
1140
+
1141
+ /**
1142
+ *
1143
+ * @export
1144
+ * @interface ListNFTsResult
1145
+ */
1146
+ interface ListNFTsResult {
1147
+ /**
1148
+ * List of nfts
1149
+ * @type {Array<NFT>}
1150
+ * @memberof ListNFTsResult
1151
+ */
1152
+ 'result': Array<NFT>;
1153
+ /**
1154
+ *
1155
+ * @type {Page}
1156
+ * @memberof ListNFTsResult
1157
+ */
1158
+ 'page': Page;
1159
+ }
1160
+
1161
+ /**
1162
+ * Request parameters for getActivity operation in ActivitiesApi.
1163
+ * @export
1164
+ * @interface ActivitiesApiGetActivityRequest
1165
+ */
1166
+ interface ActivitiesApiGetActivityRequest {
1167
+ /**
1168
+ * The name of chain
1169
+ * @type {string}
1170
+ * @memberof ActivitiesApiGetActivity
1171
+ */
1172
+ readonly chainName: string;
1173
+ /**
1174
+ * The id of activity
1175
+ * @type {string}
1176
+ * @memberof ActivitiesApiGetActivity
1177
+ */
1178
+ readonly activityId: string;
1179
+ }
1180
+ /**
1181
+ * Request parameters for listActivities operation in ActivitiesApi.
1182
+ * @export
1183
+ * @interface ActivitiesApiListActivitiesRequest
1184
+ */
1185
+ interface ActivitiesApiListActivitiesRequest {
1186
+ /**
1187
+ * The name of chain
1188
+ * @type {string}
1189
+ * @memberof ActivitiesApiListActivities
1190
+ */
1191
+ readonly chainName: string;
1192
+ /**
1193
+ * The contract address of NFT or ERC20 Token
1194
+ * @type {string}
1195
+ * @memberof ActivitiesApiListActivities
1196
+ */
1197
+ readonly contractAddress?: string;
1198
+ /**
1199
+ * An &#x60;uint256&#x60; token id as string
1200
+ * @type {string}
1201
+ * @memberof ActivitiesApiListActivities
1202
+ */
1203
+ readonly tokenId?: string;
1204
+ /**
1205
+ * The account address activity contains
1206
+ * @type {string}
1207
+ * @memberof ActivitiesApiListActivities
1208
+ */
1209
+ readonly accountAddress?: string;
1210
+ /**
1211
+ * The activity type
1212
+ * @type {ActivityType}
1213
+ * @memberof ActivitiesApiListActivities
1214
+ */
1215
+ readonly activityType?: ActivityType;
1216
+ /**
1217
+ * From indexed at including given date
1218
+ * @type {string}
1219
+ * @memberof ActivitiesApiListActivities
1220
+ */
1221
+ readonly fromIndexedAt?: string;
1222
+ /**
1223
+ * To indexed at including given date
1224
+ * @type {string}
1225
+ * @memberof ActivitiesApiListActivities
1226
+ */
1227
+ readonly toIndexedAt?: string;
1228
+ /**
1229
+ * The transaction hash of activity
1230
+ * @type {string}
1231
+ * @memberof ActivitiesApiListActivities
1232
+ */
1233
+ readonly transactionHash?: string;
1234
+ /**
1235
+ * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1236
+ * @type {string}
1237
+ * @memberof ActivitiesApiListActivities
1238
+ */
1239
+ readonly pageCursor?: string;
1240
+ /**
1241
+ * Maximum number of items to return
1242
+ * @type {number}
1243
+ * @memberof ActivitiesApiListActivities
1244
+ */
1245
+ readonly pageSize?: number;
1246
+ }
1247
+
1248
+ /**
1249
+ * Request parameters for listChains operation in ChainsApi.
1250
+ * @export
1251
+ * @interface ChainsApiListChainsRequest
1252
+ */
1253
+ interface ChainsApiListChainsRequest {
1254
+ /**
1255
+ * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1256
+ * @type {string}
1257
+ * @memberof ChainsApiListChains
1258
+ */
1259
+ readonly pageCursor?: string;
1260
+ /**
1261
+ * Maximum number of items to return
1262
+ * @type {number}
1263
+ * @memberof ChainsApiListChains
1264
+ */
1265
+ readonly pageSize?: number;
1266
+ }
1267
+
1268
+ /**
1269
+ * Request parameters for getCollection operation in CollectionsApi.
1270
+ * @export
1271
+ * @interface CollectionsApiGetCollectionRequest
1272
+ */
1273
+ interface CollectionsApiGetCollectionRequest {
1274
+ /**
1275
+ * The address contract
1276
+ * @type {string}
1277
+ * @memberof CollectionsApiGetCollection
1278
+ */
1279
+ readonly contractAddress: string;
1280
+ /**
1281
+ * The name of chain
1282
+ * @type {string}
1283
+ * @memberof CollectionsApiGetCollection
1284
+ */
1285
+ readonly chainName: string;
1286
+ }
1287
+ /**
1288
+ * Request parameters for listCollections operation in CollectionsApi.
1289
+ * @export
1290
+ * @interface CollectionsApiListCollectionsRequest
1291
+ */
1292
+ interface CollectionsApiListCollectionsRequest {
1293
+ /**
1294
+ * The name of chain
1295
+ * @type {string}
1296
+ * @memberof CollectionsApiListCollections
1297
+ */
1298
+ readonly chainName: string;
1299
+ /**
1300
+ * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1301
+ * @type {string}
1302
+ * @memberof CollectionsApiListCollections
1303
+ */
1304
+ readonly pageCursor?: string;
1305
+ /**
1306
+ * Maximum number of items to return
1307
+ * @type {number}
1308
+ * @memberof CollectionsApiListCollections
1309
+ */
1310
+ readonly pageSize?: number;
1311
+ }
1312
+
1313
+ /**
1314
+ * Request parameters for listNFTOwners operation in NftOwnersApi.
1315
+ * @export
1316
+ * @interface NftOwnersApiListNFTOwnersRequest
1317
+ */
1318
+ interface NftOwnersApiListNFTOwnersRequest {
1319
+ /**
1320
+ * The address of contract
1321
+ * @type {string}
1322
+ * @memberof NftOwnersApiListNFTOwners
1323
+ */
1324
+ readonly contractAddress: string;
1325
+ /**
1326
+ * An &#x60;uint256&#x60; token id as string
1327
+ * @type {string}
1328
+ * @memberof NftOwnersApiListNFTOwners
1329
+ */
1330
+ readonly tokenId: string;
1331
+ /**
1332
+ * The name of chain
1333
+ * @type {string}
1334
+ * @memberof NftOwnersApiListNFTOwners
1335
+ */
1336
+ readonly chainName: string;
1337
+ /**
1338
+ * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1339
+ * @type {string}
1340
+ * @memberof NftOwnersApiListNFTOwners
1341
+ */
1342
+ readonly pageCursor?: string;
1343
+ /**
1344
+ * Maximum number of items to return
1345
+ * @type {number}
1346
+ * @memberof NftOwnersApiListNFTOwners
1347
+ */
1348
+ readonly pageSize?: number;
1349
+ }
1350
+
1351
+ /**
1352
+ * Request parameters for getNFT operation in NftsApi.
1353
+ * @export
1354
+ * @interface NftsApiGetNFTRequest
1355
+ */
1356
+ interface NftsApiGetNFTRequest {
1357
+ /**
1358
+ * The address of NFT contract
1359
+ * @type {string}
1360
+ * @memberof NftsApiGetNFT
1361
+ */
1362
+ readonly contractAddress: string;
1363
+ /**
1364
+ * An &#x60;uint256&#x60; token id as string
1365
+ * @type {string}
1366
+ * @memberof NftsApiGetNFT
1367
+ */
1368
+ readonly tokenId: string;
1369
+ /**
1370
+ * The name of chain
1371
+ * @type {string}
1372
+ * @memberof NftsApiGetNFT
1373
+ */
1374
+ readonly chainName: string;
1375
+ }
1376
+ /**
1377
+ * Request parameters for listNFTs operation in NftsApi.
1378
+ * @export
1379
+ * @interface NftsApiListNFTsRequest
1380
+ */
1381
+ interface NftsApiListNFTsRequest {
1382
+ /**
1383
+ * Contract address
1384
+ * @type {string}
1385
+ * @memberof NftsApiListNFTs
1386
+ */
1387
+ readonly contractAddress: string;
1388
+ /**
1389
+ * The name of chain
1390
+ * @type {string}
1391
+ * @memberof NftsApiListNFTs
1392
+ */
1393
+ readonly chainName: string;
1394
+ /**
1395
+ * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1396
+ * @type {string}
1397
+ * @memberof NftsApiListNFTs
1398
+ */
1399
+ readonly pageCursor?: string;
1400
+ /**
1401
+ * Maximum number of items to return
1402
+ * @type {number}
1403
+ * @memberof NftsApiListNFTs
1404
+ */
1405
+ readonly pageSize?: number;
1406
+ }
1407
+ /**
1408
+ * Request parameters for listNFTsByAccountAddress operation in NftsApi.
1409
+ * @export
1410
+ * @interface NftsApiListNFTsByAccountAddressRequest
1411
+ */
1412
+ interface NftsApiListNFTsByAccountAddressRequest {
1413
+ /**
1414
+ * Account address
1415
+ * @type {string}
1416
+ * @memberof NftsApiListNFTsByAccountAddress
1417
+ */
1418
+ readonly accountAddress: string;
1419
+ /**
1420
+ * The name of chain
1421
+ * @type {string}
1422
+ * @memberof NftsApiListNFTsByAccountAddress
1423
+ */
1424
+ readonly chainName: string;
1425
+ /**
1426
+ * The address of contract
1427
+ * @type {string}
1428
+ * @memberof NftsApiListNFTsByAccountAddress
1429
+ */
1430
+ readonly contractAddress?: string;
1431
+ /**
1432
+ * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1433
+ * @type {string}
1434
+ * @memberof NftsApiListNFTsByAccountAddress
1435
+ */
1436
+ readonly pageCursor?: string;
1437
+ /**
1438
+ * Maximum number of items to return
1439
+ * @type {number}
1440
+ * @memberof NftsApiListNFTsByAccountAddress
1441
+ */
1442
+ readonly pageSize?: number;
1443
+ }
1444
+
1445
+ declare class BlockchainData {
1446
+ readonly config: BlockchainDataConfiguration;
1447
+ private readonly activities;
1448
+ private readonly chains;
1449
+ private readonly collections;
1450
+ private readonly nfts;
1451
+ private readonly nftOwners;
1452
+ constructor(moduleConfig: BlockchainDataModuleConfiguration);
1453
+ /**
1454
+ * List all activities
1455
+ * @param request - the request object containing the parameters to be provided in the API request
1456
+ * @returns a promise that resolves with a list of activities
1457
+ * @throws {@link index.APIError}
1458
+ */
1459
+ listActivities(request: ActivitiesApiListActivitiesRequest): Promise<ListActivitiesResult>;
1460
+ /**
1461
+ * Get a single activity by ID
1462
+ * @param request - the request object containing the parameters to be provided in the API request
1463
+ * @returns a promise that resolves with a single activity
1464
+ * @throws {@link index.APIError}
1465
+ */
1466
+ getActivity(request: ActivitiesApiGetActivityRequest): Promise<GetActivityResult>;
1467
+ /**
1468
+ * List supported chains
1469
+ * @param request - the request object containing the parameters to be provided in the API request
1470
+ * @returns a promise that resolves with a list of supported chains
1471
+ * @throws {@link index.APIError}
1472
+ */
1473
+ listChains(request: ChainsApiListChainsRequest): Promise<ListChainsResult>;
1474
+ /**
1475
+ * List all collections
1476
+ * @param request - the request object containing the parameters to be provided in the API request
1477
+ * @returns a promise that resolves with a list of collections
1478
+ * @throws {@link index.APIError}
1479
+ */
1480
+ listCollections(request: CollectionsApiListCollectionsRequest): Promise<ListCollectionsResult>;
1481
+ /**
1482
+ * Get collection by contract address
1483
+ * @param request - the request object containing the parameters to be provided in the API request
1484
+ * @returns a promise that resolves with a single collection
1485
+ * @throws {@link index.APIError}
1486
+ */
1487
+ getCollection(request: CollectionsApiGetCollectionRequest): Promise<GetCollectionResult>;
1488
+ /**
1489
+ * Get NFT by token ID
1490
+ * @param request - the request object containing the parameters to be provided in the API request
1491
+ * @returns a promise that resolves with a single NFT
1492
+ * @throws {@link index.APIError}
1493
+ */
1494
+ getNFT(request: NftsApiGetNFTRequest): Promise<GetNFTResult>;
1495
+ /**
1496
+ * List NFTs by contract address
1497
+ * @param request - the request object containing the parameters to be provided in the API request
1498
+ * @returns a promise that resolves with a list of NFTs
1499
+ * @throws {@link index.APIError}
1500
+ */
1501
+ listNFTs(request: NftsApiListNFTsRequest): Promise<ListNFTsResult>;
1502
+ /**
1503
+ * List NFTs by account address
1504
+ * @param request - the request object containing the parameters to be provided in the API request
1505
+ * @returns a promise that resolves with a list of NFTs
1506
+ * @throws {@link index.APIError}
1507
+ */
1508
+ listNFTsByAccountAddress(request: NftsApiListNFTsByAccountAddressRequest): Promise<ListNFTsResult>;
1509
+ /**
1510
+ * List NFT owners by token ID
1511
+ * @param request - the request object containing the parameters to be provided in the API request
1512
+ * @returns a promise that resolves with a list of NFT owners
1513
+ * @throws {@link index.APIError}
1514
+ */
1515
+ listNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
1516
+ }
1517
+
1518
+ export { BlockchainData };