@imtbl/sdk 0.1.8-alpha.1 → 0.1.8

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