@imtbl/sdk 0.1.9-alpha.4 → 0.1.9

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