@imtbl/sdk 1.36.2 → 1.36.3-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3528 @@
1
+ import { Pool } from 'pg';
2
+
3
+ declare enum Environment {
4
+ PRODUCTION = "production",
5
+ SANDBOX = "sandbox"
6
+ }
7
+ declare class ImmutableConfiguration {
8
+ readonly environment: Environment;
9
+ readonly rateLimitingKey?: string;
10
+ readonly apiKey?: string;
11
+ readonly publishableKey?: string;
12
+ constructor(options: {
13
+ environment: Environment;
14
+ rateLimitingKey?: string;
15
+ apiKey?: string;
16
+ publishableKey?: string;
17
+ });
18
+ }
19
+ interface ModuleConfiguration<T> {
20
+ baseConfig: ImmutableConfiguration;
21
+ overrides?: T;
22
+ }
23
+
24
+ type CreateMintRequest = {
25
+ contract_address: string;
26
+ asset_id: string;
27
+ metadata: any;
28
+ owner_address: string;
29
+ };
30
+ type MintRequest = {
31
+ id: string;
32
+ contract_address: string;
33
+ wallet_address: string;
34
+ asset_id: string;
35
+ metadata: any;
36
+ owner_address: string;
37
+ tried_count: number;
38
+ };
39
+ type SubmittedMintRequest = {
40
+ tokenId: string | null;
41
+ status: string;
42
+ assetId: string;
43
+ contractAddress: string;
44
+ ownerAddress: string;
45
+ metadataId: string;
46
+ imtblZkevmMintRequestUpdatedId: string;
47
+ error: any | null;
48
+ };
49
+ interface MintingPersistence {
50
+ recordMint: (request: CreateMintRequest) => Promise<void>;
51
+ getNextBatchForSubmission: (limit: number) => Promise<MintRequest[]>;
52
+ updateMintingStatusToSubmitted: (ids: string[]) => Promise<void>;
53
+ updateMintingStatusToSubmissionFailed: (ids: string[]) => Promise<void>;
54
+ syncMintingStatus: (submittedMintRequest: SubmittedMintRequest) => Promise<void>;
55
+ markAsConflict: (assetIds: string[], contractAddress: string) => Promise<void>;
56
+ resetMintingStatus: (ids: string[]) => Promise<void>;
57
+ markForRetry: (ids: string[]) => Promise<void>;
58
+ getMintingRequest: (contractAddress: string, referenceId: string) => Promise<MintRequest | null>;
59
+ }
60
+
61
+ declare const mintingPersistence$1: (client: Pool) => MintingPersistence;
62
+
63
+ declare const mintingPersistence: (client: any) => MintingPersistence;
64
+
65
+ /**
66
+ * Immutable zkEVM API
67
+ * Immutable Multi Rollup API
68
+ *
69
+ * The version of the OpenAPI document: 1.0.0
70
+ * Contact: support@immutable.com
71
+ *
72
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
73
+ * https://openapi-generator.tech
74
+ * Do not edit the class manually.
75
+ */
76
+ interface ConfigurationParameters {
77
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
78
+ username?: string;
79
+ password?: string;
80
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
81
+ basePath?: string;
82
+ baseOptions?: any;
83
+ formDataCtor?: new () => any;
84
+ }
85
+ declare class Configuration {
86
+ /**
87
+ * parameter for apiKey security
88
+ * @param name security name
89
+ * @memberof Configuration
90
+ */
91
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
92
+ /**
93
+ * parameter for basic security
94
+ *
95
+ * @type {string}
96
+ * @memberof Configuration
97
+ */
98
+ username?: string;
99
+ /**
100
+ * parameter for basic security
101
+ *
102
+ * @type {string}
103
+ * @memberof Configuration
104
+ */
105
+ password?: string;
106
+ /**
107
+ * parameter for oauth2 security
108
+ * @param name security name
109
+ * @param scopes oauth2 scope
110
+ * @memberof Configuration
111
+ */
112
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
113
+ /**
114
+ * override base path
115
+ *
116
+ * @type {string}
117
+ * @memberof Configuration
118
+ */
119
+ basePath?: string;
120
+ /**
121
+ * base options for axios calls
122
+ *
123
+ * @type {any}
124
+ * @memberof Configuration
125
+ */
126
+ baseOptions?: any;
127
+ /**
128
+ * The FormData constructor that will be used to create multipart form data
129
+ * requests. You can inject this here so that execution environments that
130
+ * do not support the FormData class can still run the generated client.
131
+ *
132
+ * @type {new () => FormData}
133
+ */
134
+ formDataCtor?: new () => any;
135
+ constructor(param?: ConfigurationParameters);
136
+ /**
137
+ * Check if the given MIME is a JSON MIME.
138
+ * JSON MIME examples:
139
+ * application/json
140
+ * application/json; charset=UTF8
141
+ * APPLICATION/JSON
142
+ * application/vnd.company+json
143
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
144
+ * @return True if the given MIME is JSON, false otherwise.
145
+ */
146
+ isJsonMime(mime: string): boolean;
147
+ }
148
+
149
+ /**
150
+ * Immutable zkEVM API
151
+ * Immutable Multi Rollup API
152
+ *
153
+ * The version of the OpenAPI document: 1.0.0
154
+ * Contact: support@immutable.com
155
+ *
156
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
157
+ * https://openapi-generator.tech
158
+ * Do not edit the class manually.
159
+ */
160
+ /**
161
+ * The contract type for an NFT
162
+ * @export
163
+ * @enum {string}
164
+ */
165
+ declare const NFTContractType: {
166
+ readonly Erc721: "ERC721";
167
+ readonly Erc1155: "ERC1155";
168
+ };
169
+ type NFTContractType = typeof NFTContractType[keyof typeof NFTContractType];
170
+
171
+ /**
172
+ * Immutable zkEVM API
173
+ * Immutable Multi Rollup API
174
+ *
175
+ * The version of the OpenAPI document: 1.0.0
176
+ * Contact: support@immutable.com
177
+ *
178
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
179
+ * https://openapi-generator.tech
180
+ * Do not edit the class manually.
181
+ */
182
+
183
+ /**
184
+ *
185
+ * @export
186
+ * @interface ActivityNFT
187
+ */
188
+ interface ActivityNFT {
189
+ /**
190
+ *
191
+ * @type {NFTContractType}
192
+ * @memberof ActivityNFT
193
+ */
194
+ 'contract_type': NFTContractType;
195
+ /**
196
+ * The token contract address
197
+ * @type {string}
198
+ * @memberof ActivityNFT
199
+ */
200
+ 'contract_address': string;
201
+ /**
202
+ * An `uint256` token id as string
203
+ * @type {string}
204
+ * @memberof ActivityNFT
205
+ */
206
+ 'token_id': string;
207
+ /**
208
+ * The amount of tokens exchanged
209
+ * @type {string}
210
+ * @memberof ActivityNFT
211
+ */
212
+ 'amount': string;
213
+ }
214
+
215
+ /**
216
+ * Immutable zkEVM API
217
+ * Immutable Multi Rollup API
218
+ *
219
+ * The version of the OpenAPI document: 1.0.0
220
+ * Contact: support@immutable.com
221
+ *
222
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
223
+ * https://openapi-generator.tech
224
+ * Do not edit the class manually.
225
+ */
226
+ /**
227
+ * The contract type for a token
228
+ * @export
229
+ * @enum {string}
230
+ */
231
+ declare const TokenContractType: {
232
+ readonly Erc20: "ERC20";
233
+ };
234
+ type TokenContractType = typeof TokenContractType[keyof typeof TokenContractType];
235
+
236
+ /**
237
+ * Immutable zkEVM API
238
+ * Immutable Multi Rollup API
239
+ *
240
+ * The version of the OpenAPI document: 1.0.0
241
+ * Contact: support@immutable.com
242
+ *
243
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
244
+ * https://openapi-generator.tech
245
+ * Do not edit the class manually.
246
+ */
247
+
248
+ /**
249
+ *
250
+ * @export
251
+ * @interface ActivityToken
252
+ */
253
+ interface ActivityToken {
254
+ /**
255
+ *
256
+ * @type {TokenContractType}
257
+ * @memberof ActivityToken
258
+ */
259
+ 'contract_type': TokenContractType;
260
+ /**
261
+ * The contract address
262
+ * @type {string}
263
+ * @memberof ActivityToken
264
+ */
265
+ 'contract_address': string;
266
+ }
267
+
268
+ /**
269
+ * Immutable zkEVM API
270
+ * Immutable Multi Rollup API
271
+ *
272
+ * The version of the OpenAPI document: 1.0.0
273
+ * Contact: support@immutable.com
274
+ *
275
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
276
+ * https://openapi-generator.tech
277
+ * Do not edit the class manually.
278
+ */
279
+
280
+ /**
281
+ * @type ActivityAsset
282
+ * The contract and asset details for this activity
283
+ * @export
284
+ */
285
+ type ActivityAsset = ActivityNFT | ActivityToken;
286
+
287
+ /**
288
+ * Immutable zkEVM API
289
+ * Immutable Multi Rollup API
290
+ *
291
+ * The version of the OpenAPI document: 1.0.0
292
+ * Contact: support@immutable.com
293
+ *
294
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
295
+ * https://openapi-generator.tech
296
+ * Do not edit the class manually.
297
+ */
298
+
299
+ /**
300
+ * The burn activity details
301
+ * @export
302
+ * @interface Burn
303
+ */
304
+ interface Burn {
305
+ /**
306
+ * The account address the asset was transferred from
307
+ * @type {string}
308
+ * @memberof Burn
309
+ */
310
+ 'from': string;
311
+ /**
312
+ * The amount of assets burnt
313
+ * @type {string}
314
+ * @memberof Burn
315
+ */
316
+ 'amount': string;
317
+ /**
318
+ *
319
+ * @type {ActivityAsset}
320
+ * @memberof Burn
321
+ */
322
+ 'asset': ActivityAsset;
323
+ }
324
+
325
+ /**
326
+ * Immutable zkEVM API
327
+ * Immutable Multi Rollup API
328
+ *
329
+ * The version of the OpenAPI document: 1.0.0
330
+ * Contact: support@immutable.com
331
+ *
332
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
333
+ * https://openapi-generator.tech
334
+ * Do not edit the class manually.
335
+ */
336
+
337
+ /**
338
+ * The deposit activity details
339
+ * @export
340
+ * @interface Deposit
341
+ */
342
+ interface Deposit {
343
+ /**
344
+ * The account address the asset was deposited to
345
+ * @type {string}
346
+ * @memberof Deposit
347
+ */
348
+ 'to': string;
349
+ /**
350
+ * The deposited amount
351
+ * @type {string}
352
+ * @memberof Deposit
353
+ */
354
+ 'amount': string;
355
+ /**
356
+ *
357
+ * @type {ActivityAsset}
358
+ * @memberof Deposit
359
+ */
360
+ 'asset': ActivityAsset;
361
+ }
362
+
363
+ /**
364
+ * Immutable zkEVM API
365
+ * Immutable Multi Rollup API
366
+ *
367
+ * The version of the OpenAPI document: 1.0.0
368
+ * Contact: support@immutable.com
369
+ *
370
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
371
+ * https://openapi-generator.tech
372
+ * Do not edit the class manually.
373
+ */
374
+
375
+ /**
376
+ * The mint activity details
377
+ * @export
378
+ * @interface Mint
379
+ */
380
+ interface Mint {
381
+ /**
382
+ * The account address the asset was minted to
383
+ * @type {string}
384
+ * @memberof Mint
385
+ */
386
+ 'to': string;
387
+ /**
388
+ * The minted amount
389
+ * @type {string}
390
+ * @memberof Mint
391
+ */
392
+ 'amount': string;
393
+ /**
394
+ *
395
+ * @type {ActivityAsset}
396
+ * @memberof Mint
397
+ */
398
+ 'asset': ActivityAsset;
399
+ }
400
+
401
+ /**
402
+ * Immutable zkEVM API
403
+ * Immutable Multi Rollup API
404
+ *
405
+ * The version of the OpenAPI document: 1.0.0
406
+ * Contact: support@immutable.com
407
+ *
408
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
409
+ * https://openapi-generator.tech
410
+ * Do not edit the class manually.
411
+ */
412
+ /**
413
+ *
414
+ * @export
415
+ * @interface SaleFee
416
+ */
417
+ interface SaleFee {
418
+ /**
419
+ * Fee payable to recipient upon settlement
420
+ * @type {string}
421
+ * @memberof SaleFee
422
+ */
423
+ 'amount'?: string;
424
+ /**
425
+ * Fee type
426
+ * @type {string}
427
+ * @memberof SaleFee
428
+ */
429
+ 'type'?: SaleFeeTypeEnum;
430
+ /**
431
+ * Wallet address of fee recipient
432
+ * @type {string}
433
+ * @memberof SaleFee
434
+ */
435
+ 'recipient'?: string;
436
+ }
437
+ declare const SaleFeeTypeEnum: {
438
+ readonly Royalty: "ROYALTY";
439
+ };
440
+ type SaleFeeTypeEnum = typeof SaleFeeTypeEnum[keyof typeof SaleFeeTypeEnum];
441
+
442
+ /**
443
+ * Immutable zkEVM API
444
+ * Immutable Multi Rollup API
445
+ *
446
+ * The version of the OpenAPI document: 1.0.0
447
+ * Contact: support@immutable.com
448
+ *
449
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
450
+ * https://openapi-generator.tech
451
+ * Do not edit the class manually.
452
+ */
453
+ /**
454
+ *
455
+ * @export
456
+ * @interface ActivityNativeToken
457
+ */
458
+ interface ActivityNativeToken {
459
+ /**
460
+ * The token symbol
461
+ * @type {string}
462
+ * @memberof ActivityNativeToken
463
+ */
464
+ 'symbol': string;
465
+ }
466
+
467
+ /**
468
+ * Immutable zkEVM API
469
+ * Immutable Multi Rollup API
470
+ *
471
+ * The version of the OpenAPI document: 1.0.0
472
+ * Contact: support@immutable.com
473
+ *
474
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
475
+ * https://openapi-generator.tech
476
+ * Do not edit the class manually.
477
+ */
478
+
479
+ /**
480
+ * @type SalePaymentToken
481
+ * The type of payment token
482
+ * @export
483
+ */
484
+ type SalePaymentToken = ActivityNativeToken | ActivityToken;
485
+
486
+ /**
487
+ * Immutable zkEVM API
488
+ * Immutable Multi Rollup API
489
+ *
490
+ * The version of the OpenAPI document: 1.0.0
491
+ * Contact: support@immutable.com
492
+ *
493
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
494
+ * https://openapi-generator.tech
495
+ * Do not edit the class manually.
496
+ */
497
+
498
+ /**
499
+ *
500
+ * @export
501
+ * @interface SalePayment
502
+ */
503
+ interface SalePayment {
504
+ /**
505
+ *
506
+ * @type {SalePaymentToken}
507
+ * @memberof SalePayment
508
+ */
509
+ 'token': SalePaymentToken;
510
+ /**
511
+ * The base price of the sale not including any fees
512
+ * @type {string}
513
+ * @memberof SalePayment
514
+ */
515
+ 'price_excluding_fees': string;
516
+ /**
517
+ * The total price of the sale. Includes the sum of all fees
518
+ * @type {string}
519
+ * @memberof SalePayment
520
+ */
521
+ 'price_including_fees': string;
522
+ /**
523
+ * The fees associated with this sale
524
+ * @type {Array<SaleFee>}
525
+ * @memberof SalePayment
526
+ */
527
+ 'fees': Array<SaleFee>;
528
+ }
529
+
530
+ /**
531
+ * Immutable zkEVM 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
+ * The NFT Sale activity details
544
+ * @export
545
+ * @interface NFTSale
546
+ */
547
+ interface NFTSale {
548
+ /**
549
+ * The id of order
550
+ * @type {string}
551
+ * @memberof NFTSale
552
+ */
553
+ 'order_id': string;
554
+ /**
555
+ * The account address of buyer
556
+ * @type {string}
557
+ * @memberof NFTSale
558
+ */
559
+ 'to': string;
560
+ /**
561
+ * The account address of seller
562
+ * @type {string}
563
+ * @memberof NFTSale
564
+ */
565
+ 'from': string;
566
+ /**
567
+ *
568
+ * @type {Array<ActivityNFT>}
569
+ * @memberof NFTSale
570
+ */
571
+ 'asset': Array<ActivityNFT>;
572
+ /**
573
+ *
574
+ * @type {SalePayment}
575
+ * @memberof NFTSale
576
+ */
577
+ 'payment': SalePayment;
578
+ }
579
+
580
+ /**
581
+ * Immutable zkEVM API
582
+ * Immutable Multi Rollup API
583
+ *
584
+ * The version of the OpenAPI document: 1.0.0
585
+ * Contact: support@immutable.com
586
+ *
587
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
588
+ * https://openapi-generator.tech
589
+ * Do not edit the class manually.
590
+ */
591
+
592
+ /**
593
+ * The transfer activity details
594
+ * @export
595
+ * @interface Transfer
596
+ */
597
+ interface Transfer {
598
+ /**
599
+ * The account address the asset was transferred from
600
+ * @type {string}
601
+ * @memberof Transfer
602
+ */
603
+ 'from': string;
604
+ /**
605
+ * The account address the asset was transferred to
606
+ * @type {string}
607
+ * @memberof Transfer
608
+ */
609
+ 'to': string;
610
+ /**
611
+ * The amount of assets transferred
612
+ * @type {string}
613
+ * @memberof Transfer
614
+ */
615
+ 'amount': string;
616
+ /**
617
+ *
618
+ * @type {ActivityAsset}
619
+ * @memberof Transfer
620
+ */
621
+ 'asset': ActivityAsset;
622
+ }
623
+
624
+ /**
625
+ * Immutable zkEVM API
626
+ * Immutable Multi Rollup API
627
+ *
628
+ * The version of the OpenAPI document: 1.0.0
629
+ * Contact: support@immutable.com
630
+ *
631
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
632
+ * https://openapi-generator.tech
633
+ * Do not edit the class manually.
634
+ */
635
+
636
+ /**
637
+ * The withdrawal activity details
638
+ * @export
639
+ * @interface Withdrawal
640
+ */
641
+ interface Withdrawal {
642
+ /**
643
+ * The account address the asset was withdrawn from
644
+ * @type {string}
645
+ * @memberof Withdrawal
646
+ */
647
+ 'from': string;
648
+ /**
649
+ * The amount of assets withdrawn
650
+ * @type {string}
651
+ * @memberof Withdrawal
652
+ */
653
+ 'amount': string;
654
+ /**
655
+ *
656
+ * @type {ActivityAsset}
657
+ * @memberof Withdrawal
658
+ */
659
+ 'asset': ActivityAsset;
660
+ }
661
+
662
+ /**
663
+ * Immutable zkEVM API
664
+ * Immutable Multi Rollup API
665
+ *
666
+ * The version of the OpenAPI document: 1.0.0
667
+ * Contact: support@immutable.com
668
+ *
669
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
670
+ * https://openapi-generator.tech
671
+ * Do not edit the class manually.
672
+ */
673
+
674
+ /**
675
+ * @type ActivityDetails
676
+ * The activity details
677
+ * @export
678
+ */
679
+ type ActivityDetails = Burn | Deposit | Mint | NFTSale | Transfer | Withdrawal;
680
+
681
+ /**
682
+ * Immutable zkEVM API
683
+ * Immutable Multi Rollup API
684
+ *
685
+ * The version of the OpenAPI document: 1.0.0
686
+ * Contact: support@immutable.com
687
+ *
688
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
689
+ * https://openapi-generator.tech
690
+ * Do not edit the class manually.
691
+ */
692
+ /**
693
+ * The activity type
694
+ * @export
695
+ * @enum {string}
696
+ */
697
+ declare const ActivityType: {
698
+ readonly Mint: "mint";
699
+ readonly Burn: "burn";
700
+ readonly Transfer: "transfer";
701
+ readonly Sale: "sale";
702
+ readonly Deposit: "deposit";
703
+ readonly Withdrawal: "withdrawal";
704
+ };
705
+ type ActivityType = typeof ActivityType[keyof typeof ActivityType];
706
+
707
+ /**
708
+ * Immutable zkEVM 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
+ * The metadata related to blockchain transaction
720
+ * @export
721
+ * @interface BlockchainMetadata
722
+ */
723
+ interface BlockchainMetadata {
724
+ /**
725
+ * The transaction hash of the activity
726
+ * @type {string}
727
+ * @memberof BlockchainMetadata
728
+ */
729
+ 'transaction_hash': string;
730
+ /**
731
+ * EVM block number (uint64 as string)
732
+ * @type {string}
733
+ * @memberof BlockchainMetadata
734
+ */
735
+ 'block_number': string;
736
+ /**
737
+ * Transaction index in a block (uint32 as string)
738
+ * @type {string}
739
+ * @memberof BlockchainMetadata
740
+ */
741
+ 'transaction_index': string;
742
+ /**
743
+ * The log index of activity in a block (uint32 as string)
744
+ * @type {string}
745
+ * @memberof BlockchainMetadata
746
+ */
747
+ 'log_index': string | null;
748
+ }
749
+
750
+ /**
751
+ * Immutable zkEVM API
752
+ * Immutable Multi Rollup API
753
+ *
754
+ * The version of the OpenAPI document: 1.0.0
755
+ * Contact: support@immutable.com
756
+ *
757
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
758
+ * https://openapi-generator.tech
759
+ * Do not edit the class manually.
760
+ */
761
+ /**
762
+ * The chain details
763
+ * @export
764
+ * @interface Chain
765
+ */
766
+ interface Chain {
767
+ /**
768
+ * The id of chain
769
+ * @type {string}
770
+ * @memberof Chain
771
+ */
772
+ 'id': string;
773
+ /**
774
+ * The name of chain
775
+ * @type {string}
776
+ * @memberof Chain
777
+ */
778
+ 'name': string;
779
+ }
780
+
781
+ /**
782
+ * Immutable zkEVM API
783
+ * Immutable Multi Rollup API
784
+ *
785
+ * The version of the OpenAPI document: 1.0.0
786
+ * Contact: support@immutable.com
787
+ *
788
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
789
+ * https://openapi-generator.tech
790
+ * Do not edit the class manually.
791
+ */
792
+
793
+ /**
794
+ *
795
+ * @export
796
+ * @interface Activity
797
+ */
798
+ interface Activity {
799
+ /**
800
+ * Activity id in UUIDv4 format
801
+ * @type {string}
802
+ * @memberof Activity
803
+ */
804
+ 'id': string;
805
+ /**
806
+ *
807
+ * @type {Chain}
808
+ * @memberof Activity
809
+ */
810
+ 'chain': Chain;
811
+ /**
812
+ *
813
+ * @type {ActivityType}
814
+ * @memberof Activity
815
+ */
816
+ 'type': ActivityType;
817
+ /**
818
+ *
819
+ * @type {ActivityDetails}
820
+ * @memberof Activity
821
+ */
822
+ 'details': ActivityDetails;
823
+ /**
824
+ * The time activity was updated at
825
+ * @type {string}
826
+ * @memberof Activity
827
+ */
828
+ 'updated_at': string;
829
+ /**
830
+ * The time activity was indexed
831
+ * @type {string}
832
+ * @memberof Activity
833
+ */
834
+ 'indexed_at': string;
835
+ /**
836
+ *
837
+ * @type {BlockchainMetadata}
838
+ * @memberof Activity
839
+ */
840
+ 'blockchain_metadata': BlockchainMetadata | null;
841
+ }
842
+
843
+ /**
844
+ * Immutable zkEVM API
845
+ * Immutable Multi Rollup API
846
+ *
847
+ * The version of the OpenAPI document: 1.0.0
848
+ * Contact: support@immutable.com
849
+ *
850
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
851
+ * https://openapi-generator.tech
852
+ * Do not edit the class manually.
853
+ */
854
+ /**
855
+ * The verification status for a given contract
856
+ * @export
857
+ * @enum {string}
858
+ */
859
+ declare const AssetVerificationStatus: {
860
+ readonly Verified: "verified";
861
+ readonly Unverified: "unverified";
862
+ readonly Spam: "spam";
863
+ readonly Inactive: "inactive";
864
+ };
865
+ type AssetVerificationStatus = typeof AssetVerificationStatus[keyof typeof AssetVerificationStatus];
866
+
867
+ /**
868
+ * Immutable zkEVM API
869
+ * Immutable Multi Rollup API
870
+ *
871
+ * The version of the OpenAPI document: 1.0.0
872
+ * Contact: support@immutable.com
873
+ *
874
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
875
+ * https://openapi-generator.tech
876
+ * Do not edit the class manually.
877
+ */
878
+ /**
879
+ *
880
+ * @export
881
+ * @interface ChainWithDetailsAllOf
882
+ */
883
+ interface ChainWithDetailsAllOf {
884
+ /**
885
+ * URL for RPC node
886
+ * @type {string}
887
+ * @memberof ChainWithDetailsAllOf
888
+ */
889
+ 'rpc_url': string | null;
890
+ }
891
+
892
+ /**
893
+ * Immutable zkEVM API
894
+ * Immutable Multi Rollup API
895
+ *
896
+ * The version of the OpenAPI document: 1.0.0
897
+ * Contact: support@immutable.com
898
+ *
899
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
900
+ * https://openapi-generator.tech
901
+ * Do not edit the class manually.
902
+ */
903
+
904
+ /**
905
+ * @type ChainWithDetails
906
+ * @export
907
+ */
908
+ type ChainWithDetails = Chain & ChainWithDetailsAllOf;
909
+
910
+ /**
911
+ * Immutable zkEVM API
912
+ * Immutable Multi Rollup API
913
+ *
914
+ * The version of the OpenAPI document: 1.0.0
915
+ * Contact: support@immutable.com
916
+ *
917
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
918
+ * https://openapi-generator.tech
919
+ * Do not edit the class manually.
920
+ */
921
+ /**
922
+ * The collection contract type
923
+ * @export
924
+ * @enum {string}
925
+ */
926
+ declare const CollectionContractType: {
927
+ readonly Erc721: "ERC721";
928
+ readonly Erc1155: "ERC1155";
929
+ };
930
+ type CollectionContractType = typeof CollectionContractType[keyof typeof CollectionContractType];
931
+
932
+ /**
933
+ * Immutable zkEVM API
934
+ * Immutable Multi Rollup API
935
+ *
936
+ * The version of the OpenAPI document: 1.0.0
937
+ * Contact: support@immutable.com
938
+ *
939
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
940
+ * https://openapi-generator.tech
941
+ * Do not edit the class manually.
942
+ */
943
+
944
+ /**
945
+ *
946
+ * @export
947
+ * @interface Collection
948
+ */
949
+ interface Collection {
950
+ /**
951
+ *
952
+ * @type {Chain}
953
+ * @memberof Collection
954
+ */
955
+ 'chain': Chain;
956
+ /**
957
+ * The name of the collection
958
+ * @type {string}
959
+ * @memberof Collection
960
+ */
961
+ 'name': string | null;
962
+ /**
963
+ * The symbol of contract
964
+ * @type {string}
965
+ * @memberof Collection
966
+ */
967
+ 'symbol': string | null;
968
+ /**
969
+ *
970
+ * @type {CollectionContractType}
971
+ * @memberof Collection
972
+ */
973
+ 'contract_type': CollectionContractType;
974
+ /**
975
+ * The address of the contract
976
+ * @type {string}
977
+ * @memberof Collection
978
+ */
979
+ 'contract_address': string;
980
+ /**
981
+ * The description of collection
982
+ * @type {string}
983
+ * @memberof Collection
984
+ */
985
+ 'description': string | null;
986
+ /**
987
+ * The url of the collection image
988
+ * @type {string}
989
+ * @memberof Collection
990
+ */
991
+ 'image': string | null;
992
+ /**
993
+ * The url of external link
994
+ * @type {string}
995
+ * @memberof Collection
996
+ */
997
+ 'external_link': string | null;
998
+ /**
999
+ * The uri for the metadata of the collection
1000
+ * @type {string}
1001
+ * @memberof Collection
1002
+ */
1003
+ 'contract_uri'?: string | null;
1004
+ /**
1005
+ * The metadata uri for nft
1006
+ * @type {string}
1007
+ * @memberof Collection
1008
+ */
1009
+ 'base_uri': string | null;
1010
+ /**
1011
+ *
1012
+ * @type {AssetVerificationStatus}
1013
+ * @memberof Collection
1014
+ */
1015
+ 'verification_status': AssetVerificationStatus;
1016
+ /**
1017
+ * When the collection was first indexed
1018
+ * @type {string}
1019
+ * @memberof Collection
1020
+ */
1021
+ 'indexed_at': string;
1022
+ /**
1023
+ * When the collection was last updated
1024
+ * @type {string}
1025
+ * @memberof Collection
1026
+ */
1027
+ 'updated_at': string;
1028
+ /**
1029
+ * When the collection metadata was last synced
1030
+ * @type {string}
1031
+ * @memberof Collection
1032
+ */
1033
+ 'metadata_synced_at': string | null;
1034
+ }
1035
+
1036
+ /**
1037
+ * Immutable zkEVM API
1038
+ * Immutable Multi Rollup API
1039
+ *
1040
+ * The version of the OpenAPI document: 1.0.0
1041
+ * Contact: support@immutable.com
1042
+ *
1043
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1044
+ * https://openapi-generator.tech
1045
+ * Do not edit the class manually.
1046
+ */
1047
+ /**
1048
+ *
1049
+ * @export
1050
+ * @interface CollectionMetadata
1051
+ */
1052
+ interface CollectionMetadata {
1053
+ /**
1054
+ * The name of the collection
1055
+ * @type {string}
1056
+ * @memberof CollectionMetadata
1057
+ */
1058
+ 'name': string | null;
1059
+ /**
1060
+ * The symbol of contract
1061
+ * @type {string}
1062
+ * @memberof CollectionMetadata
1063
+ */
1064
+ 'symbol': string | null;
1065
+ /**
1066
+ * The description of collection
1067
+ * @type {string}
1068
+ * @memberof CollectionMetadata
1069
+ */
1070
+ 'description': string | null;
1071
+ /**
1072
+ * The url of the collection image
1073
+ * @type {string}
1074
+ * @memberof CollectionMetadata
1075
+ */
1076
+ 'image': string | null;
1077
+ /**
1078
+ * The url of external link
1079
+ * @type {string}
1080
+ * @memberof CollectionMetadata
1081
+ */
1082
+ 'external_link': string | null;
1083
+ /**
1084
+ * The uri for the metadata of the collection
1085
+ * @type {string}
1086
+ * @memberof CollectionMetadata
1087
+ */
1088
+ 'contract_uri': string | null;
1089
+ /**
1090
+ * The metadata uri for nft
1091
+ * @type {string}
1092
+ * @memberof CollectionMetadata
1093
+ */
1094
+ 'base_uri': string | null;
1095
+ }
1096
+
1097
+ /**
1098
+ * Immutable zkEVM API
1099
+ * Immutable Multi Rollup API
1100
+ *
1101
+ * The version of the OpenAPI document: 1.0.0
1102
+ * Contact: support@immutable.com
1103
+ *
1104
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1105
+ * https://openapi-generator.tech
1106
+ * Do not edit the class manually.
1107
+ */
1108
+ /**
1109
+ * @type NFTMetadataAttributeValue
1110
+ * The metadata trait value
1111
+ * @export
1112
+ */
1113
+ type NFTMetadataAttributeValue = boolean | number | string;
1114
+
1115
+ /**
1116
+ * Immutable zkEVM API
1117
+ * Immutable Multi Rollup API
1118
+ *
1119
+ * The version of the OpenAPI document: 1.0.0
1120
+ * Contact: support@immutable.com
1121
+ *
1122
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1123
+ * https://openapi-generator.tech
1124
+ * Do not edit the class manually.
1125
+ */
1126
+
1127
+ /**
1128
+ *
1129
+ * @export
1130
+ * @interface NFTMetadataAttribute
1131
+ */
1132
+ interface NFTMetadataAttribute {
1133
+ /**
1134
+ * The metadata trait type
1135
+ * @type {string}
1136
+ * @memberof NFTMetadataAttribute
1137
+ */
1138
+ 'trait_type': string;
1139
+ /**
1140
+ *
1141
+ * @type {NFTMetadataAttributeValue}
1142
+ * @memberof NFTMetadataAttribute
1143
+ */
1144
+ 'value': NFTMetadataAttributeValue;
1145
+ }
1146
+
1147
+ /**
1148
+ * Immutable zkEVM API
1149
+ * Immutable Multi Rollup API
1150
+ *
1151
+ * The version of the OpenAPI document: 1.0.0
1152
+ * Contact: support@immutable.com
1153
+ *
1154
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1155
+ * https://openapi-generator.tech
1156
+ * Do not edit the class manually.
1157
+ */
1158
+
1159
+ /**
1160
+ * The NFT metadata
1161
+ * @export
1162
+ * @interface NFTMetadataRequest
1163
+ */
1164
+ interface NFTMetadataRequest {
1165
+ /**
1166
+ * The name of the NFT
1167
+ * @type {string}
1168
+ * @memberof NFTMetadataRequest
1169
+ */
1170
+ 'name'?: string | null;
1171
+ /**
1172
+ * The description of the NFT
1173
+ * @type {string}
1174
+ * @memberof NFTMetadataRequest
1175
+ */
1176
+ 'description'?: string | null;
1177
+ /**
1178
+ * The image url of the NFT
1179
+ * @type {string}
1180
+ * @memberof NFTMetadataRequest
1181
+ */
1182
+ 'image'?: string | null;
1183
+ /**
1184
+ * The external link of the NFT
1185
+ * @type {string}
1186
+ * @memberof NFTMetadataRequest
1187
+ */
1188
+ 'external_url'?: string | null;
1189
+ /**
1190
+ * The animation url of the NFT
1191
+ * @type {string}
1192
+ * @memberof NFTMetadataRequest
1193
+ */
1194
+ 'animation_url'?: string | null;
1195
+ /**
1196
+ * The youtube link of the NFT
1197
+ * @type {string}
1198
+ * @memberof NFTMetadataRequest
1199
+ */
1200
+ 'youtube_url'?: string | null;
1201
+ /**
1202
+ * List of Metadata attributes
1203
+ * @type {Array<NFTMetadataAttribute>}
1204
+ * @memberof NFTMetadataRequest
1205
+ */
1206
+ 'attributes'?: Array<NFTMetadataAttribute> | null;
1207
+ }
1208
+
1209
+ /**
1210
+ * Immutable zkEVM API
1211
+ * Immutable Multi Rollup API
1212
+ *
1213
+ * The version of the OpenAPI document: 1.0.0
1214
+ * Contact: support@immutable.com
1215
+ *
1216
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1217
+ * https://openapi-generator.tech
1218
+ * Do not edit the class manually.
1219
+ */
1220
+
1221
+ /**
1222
+ *
1223
+ * @export
1224
+ * @interface MintAsset
1225
+ */
1226
+ interface MintAsset {
1227
+ /**
1228
+ * The id of this asset in the system that originates the mint request
1229
+ * @type {string}
1230
+ * @memberof MintAsset
1231
+ */
1232
+ 'reference_id': string;
1233
+ /**
1234
+ * The address of the receiver
1235
+ * @type {string}
1236
+ * @memberof MintAsset
1237
+ */
1238
+ 'owner_address': string;
1239
+ /**
1240
+ * An optional `uint256` token id as string. Required for ERC1155 collections.
1241
+ * @type {string}
1242
+ * @memberof MintAsset
1243
+ */
1244
+ 'token_id'?: string | null;
1245
+ /**
1246
+ * Optional mount of tokens to mint. Required for ERC1155 collections. ERC712 collections can omit this field or set it to 1
1247
+ * @type {string}
1248
+ * @memberof MintAsset
1249
+ */
1250
+ 'amount'?: string | null;
1251
+ /**
1252
+ *
1253
+ * @type {NFTMetadataRequest}
1254
+ * @memberof MintAsset
1255
+ */
1256
+ 'metadata'?: NFTMetadataRequest;
1257
+ }
1258
+
1259
+ /**
1260
+ * Immutable zkEVM API
1261
+ * Immutable Multi Rollup API
1262
+ *
1263
+ * The version of the OpenAPI document: 1.0.0
1264
+ * Contact: support@immutable.com
1265
+ *
1266
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1267
+ * https://openapi-generator.tech
1268
+ * Do not edit the class manually.
1269
+ */
1270
+
1271
+ /**
1272
+ *
1273
+ * @export
1274
+ * @interface CreateMintRequestRequest
1275
+ */
1276
+ interface CreateMintRequestRequest {
1277
+ /**
1278
+ * List of nft to be minted
1279
+ * @type {Array<MintAsset>}
1280
+ * @memberof CreateMintRequestRequest
1281
+ */
1282
+ 'assets': Array<MintAsset>;
1283
+ }
1284
+
1285
+ /**
1286
+ * Immutable zkEVM API
1287
+ * Immutable Multi Rollup API
1288
+ *
1289
+ * The version of the OpenAPI document: 1.0.0
1290
+ * Contact: support@immutable.com
1291
+ *
1292
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1293
+ * https://openapi-generator.tech
1294
+ * Do not edit the class manually.
1295
+ */
1296
+ /**
1297
+ *
1298
+ * @export
1299
+ * @interface CreateMintRequestResult
1300
+ */
1301
+ interface CreateMintRequestResult {
1302
+ /**
1303
+ *
1304
+ * @type {string}
1305
+ * @memberof CreateMintRequestResult
1306
+ */
1307
+ 'imx_mint_requests_limit': string;
1308
+ /**
1309
+ *
1310
+ * @type {string}
1311
+ * @memberof CreateMintRequestResult
1312
+ */
1313
+ 'imx_mint_requests_limit_reset': string;
1314
+ /**
1315
+ *
1316
+ * @type {string}
1317
+ * @memberof CreateMintRequestResult
1318
+ */
1319
+ 'imx_remaining_mint_requests': string;
1320
+ /**
1321
+ *
1322
+ * @type {string}
1323
+ * @memberof CreateMintRequestResult
1324
+ */
1325
+ 'imx_mint_requests_retry_after': string;
1326
+ }
1327
+
1328
+ /**
1329
+ * Immutable zkEVM API
1330
+ * Immutable Multi Rollup API
1331
+ *
1332
+ * The version of the OpenAPI document: 1.0.0
1333
+ * Contact: support@immutable.com
1334
+ *
1335
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1336
+ * https://openapi-generator.tech
1337
+ * Do not edit the class manually.
1338
+ */
1339
+
1340
+ /**
1341
+ * Single activity
1342
+ * @export
1343
+ * @interface GetActivityResult
1344
+ */
1345
+ interface GetActivityResult {
1346
+ /**
1347
+ *
1348
+ * @type {Activity}
1349
+ * @memberof GetActivityResult
1350
+ */
1351
+ 'result': Activity;
1352
+ }
1353
+
1354
+ /**
1355
+ * Immutable zkEVM API
1356
+ * Immutable Multi Rollup API
1357
+ *
1358
+ * The version of the OpenAPI document: 1.0.0
1359
+ * Contact: support@immutable.com
1360
+ *
1361
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1362
+ * https://openapi-generator.tech
1363
+ * Do not edit the class manually.
1364
+ */
1365
+
1366
+ /**
1367
+ * Single Collection
1368
+ * @export
1369
+ * @interface GetCollectionResult
1370
+ */
1371
+ interface GetCollectionResult {
1372
+ /**
1373
+ *
1374
+ * @type {Collection}
1375
+ * @memberof GetCollectionResult
1376
+ */
1377
+ 'result': Collection;
1378
+ }
1379
+
1380
+ /**
1381
+ * Immutable zkEVM API
1382
+ * Immutable Multi Rollup API
1383
+ *
1384
+ * The version of the OpenAPI document: 1.0.0
1385
+ * Contact: support@immutable.com
1386
+ *
1387
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1388
+ * https://openapi-generator.tech
1389
+ * Do not edit the class manually.
1390
+ */
1391
+
1392
+ /**
1393
+ *
1394
+ * @export
1395
+ * @interface Metadata
1396
+ */
1397
+ interface Metadata {
1398
+ /**
1399
+ * Metadata id in UUIDv4 format
1400
+ * @type {string}
1401
+ * @memberof Metadata
1402
+ */
1403
+ 'id': string;
1404
+ /**
1405
+ *
1406
+ * @type {Chain}
1407
+ * @memberof Metadata
1408
+ */
1409
+ 'chain': Chain;
1410
+ /**
1411
+ * The contract address of the metadata
1412
+ * @type {string}
1413
+ * @memberof Metadata
1414
+ */
1415
+ 'contract_address': string;
1416
+ /**
1417
+ * When the metadata was created
1418
+ * @type {string}
1419
+ * @memberof Metadata
1420
+ */
1421
+ 'created_at': string;
1422
+ /**
1423
+ * When the metadata was last updated
1424
+ * @type {string}
1425
+ * @memberof Metadata
1426
+ */
1427
+ 'updated_at': string | null;
1428
+ /**
1429
+ * The name of the NFT
1430
+ * @type {string}
1431
+ * @memberof Metadata
1432
+ */
1433
+ 'name': string | null;
1434
+ /**
1435
+ * The description of the NFT
1436
+ * @type {string}
1437
+ * @memberof Metadata
1438
+ */
1439
+ 'description': string | null;
1440
+ /**
1441
+ * The image url of the NFT
1442
+ * @type {string}
1443
+ * @memberof Metadata
1444
+ */
1445
+ 'image': string | null;
1446
+ /**
1447
+ * The external website link of NFT
1448
+ * @type {string}
1449
+ * @memberof Metadata
1450
+ */
1451
+ 'external_url'?: string | null;
1452
+ /**
1453
+ * The animation url of the NFT
1454
+ * @type {string}
1455
+ * @memberof Metadata
1456
+ */
1457
+ 'animation_url': string | null;
1458
+ /**
1459
+ * The youtube URL of NFT
1460
+ * @type {string}
1461
+ * @memberof Metadata
1462
+ */
1463
+ 'youtube_url': string | null;
1464
+ /**
1465
+ * List of Metadata attributes
1466
+ * @type {Array<NFTMetadataAttribute>}
1467
+ * @memberof Metadata
1468
+ */
1469
+ 'attributes': Array<NFTMetadataAttribute> | null;
1470
+ }
1471
+
1472
+ /**
1473
+ * Immutable zkEVM API
1474
+ * Immutable Multi Rollup API
1475
+ *
1476
+ * The version of the OpenAPI document: 1.0.0
1477
+ * Contact: support@immutable.com
1478
+ *
1479
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1480
+ * https://openapi-generator.tech
1481
+ * Do not edit the class manually.
1482
+ */
1483
+
1484
+ /**
1485
+ * Single metadata
1486
+ * @export
1487
+ * @interface GetMetadataResult
1488
+ */
1489
+ interface GetMetadataResult {
1490
+ /**
1491
+ *
1492
+ * @type {Metadata}
1493
+ * @memberof GetMetadataResult
1494
+ */
1495
+ 'result': Metadata;
1496
+ }
1497
+
1498
+ /**
1499
+ * Immutable zkEVM API
1500
+ * Immutable Multi Rollup API
1501
+ *
1502
+ * The version of the OpenAPI document: 1.0.0
1503
+ * Contact: support@immutable.com
1504
+ *
1505
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1506
+ * https://openapi-generator.tech
1507
+ * Do not edit the class manually.
1508
+ */
1509
+ /**
1510
+ * The error details in case the mint request fails
1511
+ * @export
1512
+ * @interface MintRequestErrorMessage
1513
+ */
1514
+ interface MintRequestErrorMessage {
1515
+ /**
1516
+ * An error message in case the mint request fails
1517
+ * @type {string}
1518
+ * @memberof MintRequestErrorMessage
1519
+ */
1520
+ 'message'?: string;
1521
+ }
1522
+
1523
+ /**
1524
+ * Immutable zkEVM API
1525
+ * Immutable Multi Rollup API
1526
+ *
1527
+ * The version of the OpenAPI document: 1.0.0
1528
+ * Contact: support@immutable.com
1529
+ *
1530
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1531
+ * https://openapi-generator.tech
1532
+ * Do not edit the class manually.
1533
+ */
1534
+ /**
1535
+ * The status of the mint request
1536
+ * @export
1537
+ * @enum {string}
1538
+ */
1539
+ declare const MintRequestStatus: {
1540
+ readonly Pending: "pending";
1541
+ readonly Succeeded: "succeeded";
1542
+ readonly Failed: "failed";
1543
+ };
1544
+ type MintRequestStatus = typeof MintRequestStatus[keyof typeof MintRequestStatus];
1545
+
1546
+ /**
1547
+ * Immutable zkEVM API
1548
+ * Immutable Multi Rollup API
1549
+ *
1550
+ * The version of the OpenAPI document: 1.0.0
1551
+ * Contact: support@immutable.com
1552
+ *
1553
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1554
+ * https://openapi-generator.tech
1555
+ * Do not edit the class manually.
1556
+ */
1557
+
1558
+ /**
1559
+ *
1560
+ * @export
1561
+ * @interface GetMintRequestResult
1562
+ */
1563
+ interface GetMintRequestResult {
1564
+ /**
1565
+ *
1566
+ * @type {Chain}
1567
+ * @memberof GetMintRequestResult
1568
+ */
1569
+ 'chain': Chain;
1570
+ /**
1571
+ * The address of the contract
1572
+ * @type {string}
1573
+ * @memberof GetMintRequestResult
1574
+ */
1575
+ 'collection_address': string;
1576
+ /**
1577
+ * The reference id of this mint request
1578
+ * @type {string}
1579
+ * @memberof GetMintRequestResult
1580
+ */
1581
+ 'reference_id': string;
1582
+ /**
1583
+ * The address of the owner of the NFT
1584
+ * @type {string}
1585
+ * @memberof GetMintRequestResult
1586
+ */
1587
+ 'owner_address': string;
1588
+ /**
1589
+ * An `uint256` token id as string. Only available when the mint request succeeds
1590
+ * @type {string}
1591
+ * @memberof GetMintRequestResult
1592
+ */
1593
+ 'token_id': string | null;
1594
+ /**
1595
+ * An `uint256` amount as string. Only relevant for mint requests on ERC1155 contracts
1596
+ * @type {string}
1597
+ * @memberof GetMintRequestResult
1598
+ */
1599
+ 'amount'?: string | null;
1600
+ /**
1601
+ * The id of the mint activity associated with this mint request
1602
+ * @type {string}
1603
+ * @memberof GetMintRequestResult
1604
+ */
1605
+ 'activity_id'?: string | null;
1606
+ /**
1607
+ * The transaction hash of the activity
1608
+ * @type {string}
1609
+ * @memberof GetMintRequestResult
1610
+ */
1611
+ 'transaction_hash': string | null;
1612
+ /**
1613
+ * When the mint request was created
1614
+ * @type {string}
1615
+ * @memberof GetMintRequestResult
1616
+ */
1617
+ 'created_at': string;
1618
+ /**
1619
+ * When the mint request was last updated
1620
+ * @type {string}
1621
+ * @memberof GetMintRequestResult
1622
+ */
1623
+ 'updated_at': string;
1624
+ /**
1625
+ *
1626
+ * @type {MintRequestErrorMessage}
1627
+ * @memberof GetMintRequestResult
1628
+ */
1629
+ 'error': MintRequestErrorMessage | null;
1630
+ /**
1631
+ *
1632
+ * @type {MintRequestStatus}
1633
+ * @memberof GetMintRequestResult
1634
+ */
1635
+ 'status': MintRequestStatus;
1636
+ }
1637
+
1638
+ /**
1639
+ * Immutable zkEVM API
1640
+ * Immutable Multi Rollup API
1641
+ *
1642
+ * The version of the OpenAPI document: 1.0.0
1643
+ * Contact: support@immutable.com
1644
+ *
1645
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1646
+ * https://openapi-generator.tech
1647
+ * Do not edit the class manually.
1648
+ */
1649
+
1650
+ /**
1651
+ *
1652
+ * @export
1653
+ * @interface NFT
1654
+ */
1655
+ interface NFT {
1656
+ /**
1657
+ *
1658
+ * @type {Chain}
1659
+ * @memberof NFT
1660
+ */
1661
+ 'chain': Chain;
1662
+ /**
1663
+ * An `uint256` token id as string
1664
+ * @type {string}
1665
+ * @memberof NFT
1666
+ */
1667
+ 'token_id': string;
1668
+ /**
1669
+ * The contract address of the NFT
1670
+ * @type {string}
1671
+ * @memberof NFT
1672
+ */
1673
+ 'contract_address': string;
1674
+ /**
1675
+ *
1676
+ * @type {NFTContractType}
1677
+ * @memberof NFT
1678
+ */
1679
+ 'contract_type': NFTContractType;
1680
+ /**
1681
+ * When the NFT was first indexed
1682
+ * @type {string}
1683
+ * @memberof NFT
1684
+ */
1685
+ 'indexed_at': string;
1686
+ /**
1687
+ * When the NFT owner was last updated
1688
+ * @type {string}
1689
+ * @memberof NFT
1690
+ */
1691
+ 'updated_at': string;
1692
+ /**
1693
+ * When NFT metadata was last synced
1694
+ * @type {string}
1695
+ * @memberof NFT
1696
+ */
1697
+ 'metadata_synced_at': string | null;
1698
+ /**
1699
+ * The id of the metadata of this NFT
1700
+ * @type {string}
1701
+ * @memberof NFT
1702
+ */
1703
+ 'metadata_id'?: string | null;
1704
+ /**
1705
+ * The name of the NFT
1706
+ * @type {string}
1707
+ * @memberof NFT
1708
+ */
1709
+ 'name': string | null;
1710
+ /**
1711
+ * The description of the NFT
1712
+ * @type {string}
1713
+ * @memberof NFT
1714
+ */
1715
+ 'description': string | null;
1716
+ /**
1717
+ * The image url of the NFT
1718
+ * @type {string}
1719
+ * @memberof NFT
1720
+ */
1721
+ 'image': string | null;
1722
+ /**
1723
+ * The external website link of NFT
1724
+ * @type {string}
1725
+ * @memberof NFT
1726
+ */
1727
+ 'external_link': string | null;
1728
+ /**
1729
+ * The animation url of the NFT
1730
+ * @type {string}
1731
+ * @memberof NFT
1732
+ */
1733
+ 'animation_url': string | null;
1734
+ /**
1735
+ * The youtube URL of NFT
1736
+ * @type {string}
1737
+ * @memberof NFT
1738
+ */
1739
+ 'youtube_url': string | null;
1740
+ /**
1741
+ * List of NFT Metadata attributes
1742
+ * @type {Array<NFTMetadataAttribute>}
1743
+ * @memberof NFT
1744
+ */
1745
+ 'attributes': Array<NFTMetadataAttribute>;
1746
+ /**
1747
+ * The total supply of NFT
1748
+ * @type {string}
1749
+ * @memberof NFT
1750
+ */
1751
+ 'total_supply'?: string | null;
1752
+ }
1753
+
1754
+ /**
1755
+ * Immutable zkEVM API
1756
+ * Immutable Multi Rollup API
1757
+ *
1758
+ * The version of the OpenAPI document: 1.0.0
1759
+ * Contact: support@immutable.com
1760
+ *
1761
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1762
+ * https://openapi-generator.tech
1763
+ * Do not edit the class manually.
1764
+ */
1765
+
1766
+ /**
1767
+ * Single NFT
1768
+ * @export
1769
+ * @interface GetNFTResult
1770
+ */
1771
+ interface GetNFTResult {
1772
+ /**
1773
+ *
1774
+ * @type {NFT}
1775
+ * @memberof GetNFTResult
1776
+ */
1777
+ 'result': NFT;
1778
+ }
1779
+
1780
+ /**
1781
+ * Immutable zkEVM API
1782
+ * Immutable Multi Rollup API
1783
+ *
1784
+ * The version of the OpenAPI document: 1.0.0
1785
+ * Contact: support@immutable.com
1786
+ *
1787
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1788
+ * https://openapi-generator.tech
1789
+ * Do not edit the class manually.
1790
+ */
1791
+
1792
+ /**
1793
+ *
1794
+ * @export
1795
+ * @interface Token
1796
+ */
1797
+ interface Token {
1798
+ /**
1799
+ *
1800
+ * @type {Chain}
1801
+ * @memberof Token
1802
+ */
1803
+ 'chain': Chain;
1804
+ /**
1805
+ * The address of token contract
1806
+ * @type {string}
1807
+ * @memberof Token
1808
+ */
1809
+ 'contract_address': string;
1810
+ /**
1811
+ * The address of root token contract
1812
+ * @type {string}
1813
+ * @memberof Token
1814
+ */
1815
+ 'root_contract_address': string | null;
1816
+ /**
1817
+ * The symbol of token
1818
+ * @type {string}
1819
+ * @memberof Token
1820
+ */
1821
+ 'symbol': string | null;
1822
+ /**
1823
+ * The decimals of token
1824
+ * @type {number}
1825
+ * @memberof Token
1826
+ */
1827
+ 'decimals': number | null;
1828
+ /**
1829
+ * The image url of token
1830
+ * @type {string}
1831
+ * @memberof Token
1832
+ */
1833
+ 'image_url': string | null;
1834
+ /**
1835
+ * The name of token
1836
+ * @type {string}
1837
+ * @memberof Token
1838
+ */
1839
+ 'name': string | null;
1840
+ /**
1841
+ *
1842
+ * @type {AssetVerificationStatus}
1843
+ * @memberof Token
1844
+ */
1845
+ 'verification_status': AssetVerificationStatus;
1846
+ /**
1847
+ * When the collection was last updated
1848
+ * @type {string}
1849
+ * @memberof Token
1850
+ */
1851
+ 'updated_at': string;
1852
+ }
1853
+
1854
+ /**
1855
+ * Immutable zkEVM API
1856
+ * Immutable Multi Rollup API
1857
+ *
1858
+ * The version of the OpenAPI document: 1.0.0
1859
+ * Contact: support@immutable.com
1860
+ *
1861
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1862
+ * https://openapi-generator.tech
1863
+ * Do not edit the class manually.
1864
+ */
1865
+
1866
+ /**
1867
+ * Single Token
1868
+ * @export
1869
+ * @interface GetTokenResult
1870
+ */
1871
+ interface GetTokenResult {
1872
+ /**
1873
+ *
1874
+ * @type {Token}
1875
+ * @memberof GetTokenResult
1876
+ */
1877
+ 'result': Token;
1878
+ }
1879
+
1880
+ /**
1881
+ * Immutable zkEVM API
1882
+ * Immutable Multi Rollup API
1883
+ *
1884
+ * The version of the OpenAPI document: 1.0.0
1885
+ * Contact: support@immutable.com
1886
+ *
1887
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1888
+ * https://openapi-generator.tech
1889
+ * Do not edit the class manually.
1890
+ */
1891
+ /**
1892
+ * Pagination properties
1893
+ * @export
1894
+ * @interface Page
1895
+ */
1896
+ interface Page {
1897
+ /**
1898
+ * First item as an encoded string
1899
+ * @type {string}
1900
+ * @memberof Page
1901
+ */
1902
+ 'previous_cursor': string | null;
1903
+ /**
1904
+ * Last item as an encoded string
1905
+ * @type {string}
1906
+ * @memberof Page
1907
+ */
1908
+ 'next_cursor': string | null;
1909
+ }
1910
+
1911
+ /**
1912
+ * Immutable zkEVM API
1913
+ * Immutable Multi Rollup API
1914
+ *
1915
+ * The version of the OpenAPI document: 1.0.0
1916
+ * Contact: support@immutable.com
1917
+ *
1918
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1919
+ * https://openapi-generator.tech
1920
+ * Do not edit the class manually.
1921
+ */
1922
+
1923
+ /**
1924
+ * List activities response
1925
+ * @export
1926
+ * @interface ListActivitiesResult
1927
+ */
1928
+ interface ListActivitiesResult {
1929
+ /**
1930
+ * List of activities
1931
+ * @type {Array<Activity>}
1932
+ * @memberof ListActivitiesResult
1933
+ */
1934
+ 'result': Array<Activity>;
1935
+ /**
1936
+ *
1937
+ * @type {Page}
1938
+ * @memberof ListActivitiesResult
1939
+ */
1940
+ 'page': Page;
1941
+ }
1942
+
1943
+ /**
1944
+ * Immutable zkEVM API
1945
+ * Immutable Multi Rollup API
1946
+ *
1947
+ * The version of the OpenAPI document: 1.0.0
1948
+ * Contact: support@immutable.com
1949
+ *
1950
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1951
+ * https://openapi-generator.tech
1952
+ * Do not edit the class manually.
1953
+ */
1954
+
1955
+ /**
1956
+ *
1957
+ * @export
1958
+ * @interface ListChainsResult
1959
+ */
1960
+ interface ListChainsResult {
1961
+ /**
1962
+ * List of chains
1963
+ * @type {Array<ChainWithDetails>}
1964
+ * @memberof ListChainsResult
1965
+ */
1966
+ 'result': Array<ChainWithDetails>;
1967
+ /**
1968
+ *
1969
+ * @type {Page}
1970
+ * @memberof ListChainsResult
1971
+ */
1972
+ 'page': Page;
1973
+ }
1974
+
1975
+ /**
1976
+ * Immutable zkEVM API
1977
+ * Immutable Multi Rollup API
1978
+ *
1979
+ * The version of the OpenAPI document: 1.0.0
1980
+ * Contact: support@immutable.com
1981
+ *
1982
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1983
+ * https://openapi-generator.tech
1984
+ * Do not edit the class manually.
1985
+ */
1986
+
1987
+ /**
1988
+ *
1989
+ * @export
1990
+ * @interface ListCollectionsResult
1991
+ */
1992
+ interface ListCollectionsResult {
1993
+ /**
1994
+ * List of collections
1995
+ * @type {Array<Collection>}
1996
+ * @memberof ListCollectionsResult
1997
+ */
1998
+ 'result': Array<Collection>;
1999
+ /**
2000
+ *
2001
+ * @type {Page}
2002
+ * @memberof ListCollectionsResult
2003
+ */
2004
+ 'page': Page;
2005
+ }
2006
+
2007
+ /**
2008
+ * Immutable zkEVM API
2009
+ * Immutable Multi Rollup API
2010
+ *
2011
+ * The version of the OpenAPI document: 1.0.0
2012
+ * Contact: support@immutable.com
2013
+ *
2014
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2015
+ * https://openapi-generator.tech
2016
+ * Do not edit the class manually.
2017
+ */
2018
+
2019
+ /**
2020
+ *
2021
+ * @export
2022
+ * @interface ListMetadataResult
2023
+ */
2024
+ interface ListMetadataResult {
2025
+ /**
2026
+ * List of metadata
2027
+ * @type {Array<Metadata>}
2028
+ * @memberof ListMetadataResult
2029
+ */
2030
+ 'result': Array<Metadata>;
2031
+ /**
2032
+ *
2033
+ * @type {Page}
2034
+ * @memberof ListMetadataResult
2035
+ */
2036
+ 'page': Page;
2037
+ }
2038
+
2039
+ /**
2040
+ * Immutable zkEVM API
2041
+ * Immutable Multi Rollup API
2042
+ *
2043
+ * The version of the OpenAPI document: 1.0.0
2044
+ * Contact: support@immutable.com
2045
+ *
2046
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2047
+ * https://openapi-generator.tech
2048
+ * Do not edit the class manually.
2049
+ */
2050
+
2051
+ /**
2052
+ * List mint requests
2053
+ * @export
2054
+ * @interface ListMintRequestsResult
2055
+ */
2056
+ interface ListMintRequestsResult {
2057
+ /**
2058
+ * List of mint requests
2059
+ * @type {Array<GetMintRequestResult>}
2060
+ * @memberof ListMintRequestsResult
2061
+ */
2062
+ 'result': Array<GetMintRequestResult>;
2063
+ /**
2064
+ *
2065
+ * @type {Page}
2066
+ * @memberof ListMintRequestsResult
2067
+ */
2068
+ 'page': Page;
2069
+ }
2070
+
2071
+ /**
2072
+ * Immutable zkEVM API
2073
+ * Immutable Multi Rollup API
2074
+ *
2075
+ * The version of the OpenAPI document: 1.0.0
2076
+ * Contact: support@immutable.com
2077
+ *
2078
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2079
+ * https://openapi-generator.tech
2080
+ * Do not edit the class manually.
2081
+ */
2082
+
2083
+ /**
2084
+ *
2085
+ * @export
2086
+ * @interface NFTOwner
2087
+ */
2088
+ interface NFTOwner {
2089
+ /**
2090
+ *
2091
+ * @type {Chain}
2092
+ * @memberof NFTOwner
2093
+ */
2094
+ 'chain': Chain;
2095
+ /**
2096
+ * The address of NFT contract
2097
+ * @type {string}
2098
+ * @memberof NFTOwner
2099
+ */
2100
+ 'contract_address': string;
2101
+ /**
2102
+ * An `uint256` token id as string
2103
+ * @type {string}
2104
+ * @memberof NFTOwner
2105
+ */
2106
+ 'token_id': string;
2107
+ /**
2108
+ * The account address of the owner of the NFT
2109
+ * @type {string}
2110
+ * @memberof NFTOwner
2111
+ */
2112
+ 'account_address': string;
2113
+ /**
2114
+ * (deprecated - use balance instead) The quantity of owned tokens (uint256 as string)
2115
+ * @type {string}
2116
+ * @memberof NFTOwner
2117
+ * @deprecated
2118
+ */
2119
+ 'quantity': string;
2120
+ /**
2121
+ * The amount of owned tokens (uint256 as string)
2122
+ * @type {string}
2123
+ * @memberof NFTOwner
2124
+ */
2125
+ 'balance': string;
2126
+ /**
2127
+ * When the NFT owner was last updated
2128
+ * @type {string}
2129
+ * @memberof NFTOwner
2130
+ */
2131
+ 'updated_at'?: string;
2132
+ }
2133
+
2134
+ /**
2135
+ * Immutable zkEVM API
2136
+ * Immutable Multi Rollup API
2137
+ *
2138
+ * The version of the OpenAPI document: 1.0.0
2139
+ * Contact: support@immutable.com
2140
+ *
2141
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2142
+ * https://openapi-generator.tech
2143
+ * Do not edit the class manually.
2144
+ */
2145
+
2146
+ /**
2147
+ *
2148
+ * @export
2149
+ * @interface ListNFTOwnersResult
2150
+ */
2151
+ interface ListNFTOwnersResult {
2152
+ /**
2153
+ * List of nft owners
2154
+ * @type {Array<NFTOwner>}
2155
+ * @memberof ListNFTOwnersResult
2156
+ */
2157
+ 'result': Array<NFTOwner>;
2158
+ /**
2159
+ *
2160
+ * @type {Page}
2161
+ * @memberof ListNFTOwnersResult
2162
+ */
2163
+ 'page': Page;
2164
+ }
2165
+
2166
+ /**
2167
+ * Immutable zkEVM API
2168
+ * Immutable Multi Rollup API
2169
+ *
2170
+ * The version of the OpenAPI document: 1.0.0
2171
+ * Contact: support@immutable.com
2172
+ *
2173
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2174
+ * https://openapi-generator.tech
2175
+ * Do not edit the class manually.
2176
+ */
2177
+
2178
+ /**
2179
+ *
2180
+ * @export
2181
+ * @interface ListNFTsResult
2182
+ */
2183
+ interface ListNFTsResult {
2184
+ /**
2185
+ * List of NFTs
2186
+ * @type {Array<NFT>}
2187
+ * @memberof ListNFTsResult
2188
+ */
2189
+ 'result': Array<NFT>;
2190
+ /**
2191
+ *
2192
+ * @type {Page}
2193
+ * @memberof ListNFTsResult
2194
+ */
2195
+ 'page': Page;
2196
+ }
2197
+
2198
+ /**
2199
+ * Immutable zkEVM API
2200
+ * Immutable Multi Rollup API
2201
+ *
2202
+ * The version of the OpenAPI document: 1.0.0
2203
+ * Contact: support@immutable.com
2204
+ *
2205
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2206
+ * https://openapi-generator.tech
2207
+ * Do not edit the class manually.
2208
+ */
2209
+
2210
+ /**
2211
+ *
2212
+ * @export
2213
+ * @interface ListTokensResult
2214
+ */
2215
+ interface ListTokensResult {
2216
+ /**
2217
+ * List of tokens
2218
+ * @type {Array<Token>}
2219
+ * @memberof ListTokensResult
2220
+ */
2221
+ 'result': Array<Token>;
2222
+ /**
2223
+ *
2224
+ * @type {Page}
2225
+ * @memberof ListTokensResult
2226
+ */
2227
+ 'page': Page;
2228
+ }
2229
+
2230
+ /**
2231
+ * Immutable zkEVM API
2232
+ * Immutable Multi Rollup API
2233
+ *
2234
+ * The version of the OpenAPI document: 1.0.0
2235
+ * Contact: support@immutable.com
2236
+ *
2237
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2238
+ * https://openapi-generator.tech
2239
+ * Do not edit the class manually.
2240
+ */
2241
+ /**
2242
+ *
2243
+ * @export
2244
+ * @interface MetadataRefreshRateLimitResult
2245
+ */
2246
+ interface MetadataRefreshRateLimitResult {
2247
+ /**
2248
+ *
2249
+ * @type {string}
2250
+ * @memberof MetadataRefreshRateLimitResult
2251
+ */
2252
+ 'imx_refreshes_limit': string;
2253
+ /**
2254
+ *
2255
+ * @type {string}
2256
+ * @memberof MetadataRefreshRateLimitResult
2257
+ */
2258
+ 'imx_refresh_limit_reset': string;
2259
+ /**
2260
+ *
2261
+ * @type {string}
2262
+ * @memberof MetadataRefreshRateLimitResult
2263
+ */
2264
+ 'imx_remaining_refreshes': string;
2265
+ /**
2266
+ *
2267
+ * @type {string}
2268
+ * @memberof MetadataRefreshRateLimitResult
2269
+ */
2270
+ 'retry_after': string;
2271
+ }
2272
+
2273
+ /**
2274
+ * Immutable zkEVM API
2275
+ * Immutable Multi Rollup API
2276
+ *
2277
+ * The version of the OpenAPI document: 1.0.0
2278
+ * Contact: support@immutable.com
2279
+ *
2280
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2281
+ * https://openapi-generator.tech
2282
+ * Do not edit the class manually.
2283
+ */
2284
+
2285
+ /**
2286
+ *
2287
+ * @export
2288
+ * @interface RefreshCollectionMetadataRequest
2289
+ */
2290
+ interface RefreshCollectionMetadataRequest {
2291
+ /**
2292
+ *
2293
+ * @type {CollectionMetadata}
2294
+ * @memberof RefreshCollectionMetadataRequest
2295
+ */
2296
+ 'collection_metadata': CollectionMetadata;
2297
+ }
2298
+
2299
+ /**
2300
+ * Immutable zkEVM API
2301
+ * Immutable Multi Rollup API
2302
+ *
2303
+ * The version of the OpenAPI document: 1.0.0
2304
+ * Contact: support@immutable.com
2305
+ *
2306
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2307
+ * https://openapi-generator.tech
2308
+ * Do not edit the class manually.
2309
+ */
2310
+
2311
+ /**
2312
+ *
2313
+ * @export
2314
+ * @interface RefreshCollectionMetadataResult
2315
+ */
2316
+ interface RefreshCollectionMetadataResult {
2317
+ /**
2318
+ *
2319
+ * @type {string}
2320
+ * @memberof RefreshCollectionMetadataResult
2321
+ */
2322
+ 'contract_address': string;
2323
+ /**
2324
+ *
2325
+ * @type {Chain}
2326
+ * @memberof RefreshCollectionMetadataResult
2327
+ */
2328
+ 'chain': Chain;
2329
+ /**
2330
+ *
2331
+ * @type {CollectionMetadata}
2332
+ * @memberof RefreshCollectionMetadataResult
2333
+ */
2334
+ 'collection_metadata': CollectionMetadata;
2335
+ }
2336
+
2337
+ /**
2338
+ * Immutable zkEVM API
2339
+ * Immutable Multi Rollup API
2340
+ *
2341
+ * The version of the OpenAPI document: 1.0.0
2342
+ * Contact: support@immutable.com
2343
+ *
2344
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2345
+ * https://openapi-generator.tech
2346
+ * Do not edit the class manually.
2347
+ */
2348
+ /**
2349
+ *
2350
+ * @export
2351
+ * @interface RefreshMetadataByIDAllOf
2352
+ */
2353
+ interface RefreshMetadataByIDAllOf {
2354
+ /**
2355
+ * Metadata id in UUIDv4 format
2356
+ * @type {string}
2357
+ * @memberof RefreshMetadataByIDAllOf
2358
+ */
2359
+ 'metadata_id': string;
2360
+ }
2361
+
2362
+ /**
2363
+ * Immutable zkEVM API
2364
+ * Immutable Multi Rollup API
2365
+ *
2366
+ * The version of the OpenAPI document: 1.0.0
2367
+ * Contact: support@immutable.com
2368
+ *
2369
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2370
+ * https://openapi-generator.tech
2371
+ * Do not edit the class manually.
2372
+ */
2373
+
2374
+ /**
2375
+ * @type RefreshableNFTAttributes
2376
+ * @export
2377
+ */
2378
+ type RefreshableNFTAttributes = NFTMetadataRequest;
2379
+
2380
+ /**
2381
+ * Immutable zkEVM API
2382
+ * Immutable Multi Rollup API
2383
+ *
2384
+ * The version of the OpenAPI document: 1.0.0
2385
+ * Contact: support@immutable.com
2386
+ *
2387
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2388
+ * https://openapi-generator.tech
2389
+ * Do not edit the class manually.
2390
+ */
2391
+
2392
+ /**
2393
+ * @type RefreshMetadataByID
2394
+ * @export
2395
+ */
2396
+ type RefreshMetadataByID = RefreshMetadataByIDAllOf & RefreshableNFTAttributes;
2397
+
2398
+ /**
2399
+ * Immutable zkEVM API
2400
+ * Immutable Multi Rollup API
2401
+ *
2402
+ * The version of the OpenAPI document: 1.0.0
2403
+ * Contact: support@immutable.com
2404
+ *
2405
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2406
+ * https://openapi-generator.tech
2407
+ * Do not edit the class manually.
2408
+ */
2409
+
2410
+ /**
2411
+ * Request body for refreshing metadata by id
2412
+ * @export
2413
+ * @interface RefreshMetadataByIDRequest
2414
+ */
2415
+ interface RefreshMetadataByIDRequest {
2416
+ /**
2417
+ *
2418
+ * @type {Array<RefreshMetadataByID>}
2419
+ * @memberof RefreshMetadataByIDRequest
2420
+ */
2421
+ 'metadata'?: Array<RefreshMetadataByID>;
2422
+ }
2423
+
2424
+ /**
2425
+ * Immutable zkEVM API
2426
+ * Immutable Multi Rollup API
2427
+ *
2428
+ * The version of the OpenAPI document: 1.0.0
2429
+ * Contact: support@immutable.com
2430
+ *
2431
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2432
+ * https://openapi-generator.tech
2433
+ * Do not edit the class manually.
2434
+ */
2435
+ /**
2436
+ *
2437
+ * @export
2438
+ * @interface RefreshMetadataByTokenIDAllOf
2439
+ */
2440
+ interface RefreshMetadataByTokenIDAllOf {
2441
+ /**
2442
+ * An `uint256` token id as string
2443
+ * @type {string}
2444
+ * @memberof RefreshMetadataByTokenIDAllOf
2445
+ */
2446
+ 'token_id': string;
2447
+ }
2448
+
2449
+ /**
2450
+ * Immutable zkEVM API
2451
+ * Immutable Multi Rollup API
2452
+ *
2453
+ * The version of the OpenAPI document: 1.0.0
2454
+ * Contact: support@immutable.com
2455
+ *
2456
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2457
+ * https://openapi-generator.tech
2458
+ * Do not edit the class manually.
2459
+ */
2460
+
2461
+ /**
2462
+ * @type RefreshMetadataByTokenID
2463
+ * @export
2464
+ */
2465
+ type RefreshMetadataByTokenID = RefreshMetadataByTokenIDAllOf & RefreshableNFTAttributes;
2466
+
2467
+ /**
2468
+ * Immutable zkEVM API
2469
+ * Immutable Multi Rollup API
2470
+ *
2471
+ * The version of the OpenAPI document: 1.0.0
2472
+ * Contact: support@immutable.com
2473
+ *
2474
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2475
+ * https://openapi-generator.tech
2476
+ * Do not edit the class manually.
2477
+ */
2478
+
2479
+ /**
2480
+ *
2481
+ * @export
2482
+ * @interface RefreshNFTMetadataByTokenIDRequest
2483
+ */
2484
+ interface RefreshNFTMetadataByTokenIDRequest {
2485
+ /**
2486
+ * List of nft metadata to be refreshed
2487
+ * @type {Array<RefreshMetadataByTokenID>}
2488
+ * @memberof RefreshNFTMetadataByTokenIDRequest
2489
+ */
2490
+ 'nft_metadata': Array<RefreshMetadataByTokenID>;
2491
+ }
2492
+
2493
+ /**
2494
+ * Request parameters for getActivity operation in ActivitiesApi.
2495
+ * @export
2496
+ * @interface ActivitiesApiGetActivityRequest
2497
+ */
2498
+ interface ActivitiesApiGetActivityRequest {
2499
+ /**
2500
+ * The name of chain
2501
+ * @type {string}
2502
+ * @memberof ActivitiesApiGetActivity
2503
+ */
2504
+ readonly chainName: string;
2505
+ /**
2506
+ * The id of activity
2507
+ * @type {string}
2508
+ * @memberof ActivitiesApiGetActivity
2509
+ */
2510
+ readonly activityId: string;
2511
+ }
2512
+ /**
2513
+ * Request parameters for listActivities operation in ActivitiesApi.
2514
+ * @export
2515
+ * @interface ActivitiesApiListActivitiesRequest
2516
+ */
2517
+ interface ActivitiesApiListActivitiesRequest {
2518
+ /**
2519
+ * The name of chain
2520
+ * @type {string}
2521
+ * @memberof ActivitiesApiListActivities
2522
+ */
2523
+ readonly chainName: string;
2524
+ /**
2525
+ * The contract address of NFT or ERC20 Token
2526
+ * @type {string}
2527
+ * @memberof ActivitiesApiListActivities
2528
+ */
2529
+ readonly contractAddress?: string;
2530
+ /**
2531
+ * An &#x60;uint256&#x60; token id as string
2532
+ * @type {string}
2533
+ * @memberof ActivitiesApiListActivities
2534
+ */
2535
+ readonly tokenId?: string;
2536
+ /**
2537
+ * The account address activity contains
2538
+ * @type {string}
2539
+ * @memberof ActivitiesApiListActivities
2540
+ */
2541
+ readonly accountAddress?: string;
2542
+ /**
2543
+ * The activity type
2544
+ * @type {ActivityType}
2545
+ * @memberof ActivitiesApiListActivities
2546
+ */
2547
+ readonly activityType?: ActivityType;
2548
+ /**
2549
+ * The transaction hash of activity
2550
+ * @type {string}
2551
+ * @memberof ActivitiesApiListActivities
2552
+ */
2553
+ readonly transactionHash?: string;
2554
+ /**
2555
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2556
+ * @type {string}
2557
+ * @memberof ActivitiesApiListActivities
2558
+ */
2559
+ readonly pageCursor?: string;
2560
+ /**
2561
+ * Maximum number of items to return
2562
+ * @type {number}
2563
+ * @memberof ActivitiesApiListActivities
2564
+ */
2565
+ readonly pageSize?: number;
2566
+ }
2567
+ /**
2568
+ * Request parameters for listActivityHistory operation in ActivitiesApi.
2569
+ * @export
2570
+ * @interface ActivitiesApiListActivityHistoryRequest
2571
+ */
2572
+ interface ActivitiesApiListActivityHistoryRequest {
2573
+ /**
2574
+ * The name of chain
2575
+ * @type {string}
2576
+ * @memberof ActivitiesApiListActivityHistory
2577
+ */
2578
+ readonly chainName: string;
2579
+ /**
2580
+ * From indexed at including given date
2581
+ * @type {string}
2582
+ * @memberof ActivitiesApiListActivityHistory
2583
+ */
2584
+ readonly fromUpdatedAt: string;
2585
+ /**
2586
+ * To indexed at including given date
2587
+ * @type {string}
2588
+ * @memberof ActivitiesApiListActivityHistory
2589
+ */
2590
+ readonly toUpdatedAt?: string;
2591
+ /**
2592
+ * The contract address of the collection
2593
+ * @type {string}
2594
+ * @memberof ActivitiesApiListActivityHistory
2595
+ */
2596
+ readonly contractAddress?: string;
2597
+ /**
2598
+ * The activity type
2599
+ * @type {ActivityType}
2600
+ * @memberof ActivitiesApiListActivityHistory
2601
+ */
2602
+ readonly activityType?: ActivityType;
2603
+ /**
2604
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2605
+ * @type {string}
2606
+ * @memberof ActivitiesApiListActivityHistory
2607
+ */
2608
+ readonly pageCursor?: string;
2609
+ /**
2610
+ * Maximum number of items to return
2611
+ * @type {number}
2612
+ * @memberof ActivitiesApiListActivityHistory
2613
+ */
2614
+ readonly pageSize?: number;
2615
+ }
2616
+
2617
+ /**
2618
+ * Request parameters for listChains operation in ChainsApi.
2619
+ * @export
2620
+ * @interface ChainsApiListChainsRequest
2621
+ */
2622
+ interface ChainsApiListChainsRequest {
2623
+ /**
2624
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2625
+ * @type {string}
2626
+ * @memberof ChainsApiListChains
2627
+ */
2628
+ readonly pageCursor?: string;
2629
+ /**
2630
+ * Maximum number of items to return
2631
+ * @type {number}
2632
+ * @memberof ChainsApiListChains
2633
+ */
2634
+ readonly pageSize?: number;
2635
+ }
2636
+
2637
+ /**
2638
+ * Request parameters for getCollection operation in CollectionsApi.
2639
+ * @export
2640
+ * @interface CollectionsApiGetCollectionRequest
2641
+ */
2642
+ interface CollectionsApiGetCollectionRequest {
2643
+ /**
2644
+ * The address contract
2645
+ * @type {string}
2646
+ * @memberof CollectionsApiGetCollection
2647
+ */
2648
+ readonly contractAddress: string;
2649
+ /**
2650
+ * The name of chain
2651
+ * @type {string}
2652
+ * @memberof CollectionsApiGetCollection
2653
+ */
2654
+ readonly chainName: string;
2655
+ }
2656
+ /**
2657
+ * Request parameters for listCollections operation in CollectionsApi.
2658
+ * @export
2659
+ * @interface CollectionsApiListCollectionsRequest
2660
+ */
2661
+ interface CollectionsApiListCollectionsRequest {
2662
+ /**
2663
+ * The name of chain
2664
+ * @type {string}
2665
+ * @memberof CollectionsApiListCollections
2666
+ */
2667
+ readonly chainName: string;
2668
+ /**
2669
+ * List of contract addresses to filter by
2670
+ * @type {Array<string>}
2671
+ * @memberof CollectionsApiListCollections
2672
+ */
2673
+ readonly contractAddress?: Array<string>;
2674
+ /**
2675
+ * List of verification status to filter by
2676
+ * @type {Array<AssetVerificationStatus>}
2677
+ * @memberof CollectionsApiListCollections
2678
+ */
2679
+ readonly verificationStatus?: Array<AssetVerificationStatus>;
2680
+ /**
2681
+ * Datetime to use as the oldest updated timestamp
2682
+ * @type {string}
2683
+ * @memberof CollectionsApiListCollections
2684
+ */
2685
+ readonly fromUpdatedAt?: string;
2686
+ /**
2687
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2688
+ * @type {string}
2689
+ * @memberof CollectionsApiListCollections
2690
+ */
2691
+ readonly pageCursor?: string;
2692
+ /**
2693
+ * Maximum number of items to return
2694
+ * @type {number}
2695
+ * @memberof CollectionsApiListCollections
2696
+ */
2697
+ readonly pageSize?: number;
2698
+ }
2699
+ /**
2700
+ * Request parameters for listCollectionsByNFTOwner operation in CollectionsApi.
2701
+ * @export
2702
+ * @interface CollectionsApiListCollectionsByNFTOwnerRequest
2703
+ */
2704
+ interface CollectionsApiListCollectionsByNFTOwnerRequest {
2705
+ /**
2706
+ * Account address
2707
+ * @type {string}
2708
+ * @memberof CollectionsApiListCollectionsByNFTOwner
2709
+ */
2710
+ readonly accountAddress: string;
2711
+ /**
2712
+ * The name of chain
2713
+ * @type {string}
2714
+ * @memberof CollectionsApiListCollectionsByNFTOwner
2715
+ */
2716
+ readonly chainName: string;
2717
+ /**
2718
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2719
+ * @type {string}
2720
+ * @memberof CollectionsApiListCollectionsByNFTOwner
2721
+ */
2722
+ readonly pageCursor?: string;
2723
+ /**
2724
+ * Maximum number of items to return
2725
+ * @type {number}
2726
+ * @memberof CollectionsApiListCollectionsByNFTOwner
2727
+ */
2728
+ readonly pageSize?: number;
2729
+ }
2730
+ /**
2731
+ * Request parameters for refreshCollectionMetadata operation in CollectionsApi.
2732
+ * @export
2733
+ * @interface CollectionsApiRefreshCollectionMetadataRequest
2734
+ */
2735
+ interface CollectionsApiRefreshCollectionMetadataRequest {
2736
+ /**
2737
+ * The address contract
2738
+ * @type {string}
2739
+ * @memberof CollectionsApiRefreshCollectionMetadata
2740
+ */
2741
+ readonly contractAddress: string;
2742
+ /**
2743
+ * The name of chain
2744
+ * @type {string}
2745
+ * @memberof CollectionsApiRefreshCollectionMetadata
2746
+ */
2747
+ readonly chainName: string;
2748
+ /**
2749
+ * The request body
2750
+ * @type {RefreshCollectionMetadataRequest}
2751
+ * @memberof CollectionsApiRefreshCollectionMetadata
2752
+ */
2753
+ readonly refreshCollectionMetadataRequest: RefreshCollectionMetadataRequest;
2754
+ }
2755
+
2756
+ /**
2757
+ * Request parameters for getMetadata operation in MetadataApi.
2758
+ * @export
2759
+ * @interface MetadataApiGetMetadataRequest
2760
+ */
2761
+ interface MetadataApiGetMetadataRequest {
2762
+ /**
2763
+ * The name of chain
2764
+ * @type {string}
2765
+ * @memberof MetadataApiGetMetadata
2766
+ */
2767
+ readonly chainName: string;
2768
+ /**
2769
+ * The address of metadata contract
2770
+ * @type {string}
2771
+ * @memberof MetadataApiGetMetadata
2772
+ */
2773
+ readonly contractAddress: string;
2774
+ /**
2775
+ * The id of the metadata
2776
+ * @type {string}
2777
+ * @memberof MetadataApiGetMetadata
2778
+ */
2779
+ readonly metadataId: string;
2780
+ }
2781
+ /**
2782
+ * Request parameters for listMetadata operation in MetadataApi.
2783
+ * @export
2784
+ * @interface MetadataApiListMetadataRequest
2785
+ */
2786
+ interface MetadataApiListMetadataRequest {
2787
+ /**
2788
+ * The name of chain
2789
+ * @type {string}
2790
+ * @memberof MetadataApiListMetadata
2791
+ */
2792
+ readonly chainName: string;
2793
+ /**
2794
+ * The address of metadata contract
2795
+ * @type {string}
2796
+ * @memberof MetadataApiListMetadata
2797
+ */
2798
+ readonly contractAddress: string;
2799
+ /**
2800
+ * Datetime to use as the oldest updated timestamp
2801
+ * @type {string}
2802
+ * @memberof MetadataApiListMetadata
2803
+ */
2804
+ readonly fromUpdatedAt?: string;
2805
+ /**
2806
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2807
+ * @type {string}
2808
+ * @memberof MetadataApiListMetadata
2809
+ */
2810
+ readonly pageCursor?: string;
2811
+ /**
2812
+ * Maximum number of items to return
2813
+ * @type {number}
2814
+ * @memberof MetadataApiListMetadata
2815
+ */
2816
+ readonly pageSize?: number;
2817
+ }
2818
+ /**
2819
+ * Request parameters for listMetadataForChain operation in MetadataApi.
2820
+ * @export
2821
+ * @interface MetadataApiListMetadataForChainRequest
2822
+ */
2823
+ interface MetadataApiListMetadataForChainRequest {
2824
+ /**
2825
+ * The name of chain
2826
+ * @type {string}
2827
+ * @memberof MetadataApiListMetadataForChain
2828
+ */
2829
+ readonly chainName: string;
2830
+ /**
2831
+ * Datetime to use as the oldest updated timestamp
2832
+ * @type {string}
2833
+ * @memberof MetadataApiListMetadataForChain
2834
+ */
2835
+ readonly fromUpdatedAt?: string;
2836
+ /**
2837
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2838
+ * @type {string}
2839
+ * @memberof MetadataApiListMetadataForChain
2840
+ */
2841
+ readonly pageCursor?: string;
2842
+ /**
2843
+ * Maximum number of items to return
2844
+ * @type {number}
2845
+ * @memberof MetadataApiListMetadataForChain
2846
+ */
2847
+ readonly pageSize?: number;
2848
+ }
2849
+ /**
2850
+ * Request parameters for refreshMetadataByID operation in MetadataApi.
2851
+ * @export
2852
+ * @interface MetadataApiRefreshMetadataByIDRequest
2853
+ */
2854
+ interface MetadataApiRefreshMetadataByIDRequest {
2855
+ /**
2856
+ * The name of chain
2857
+ * @type {string}
2858
+ * @memberof MetadataApiRefreshMetadataByID
2859
+ */
2860
+ readonly chainName: string;
2861
+ /**
2862
+ * Contract address
2863
+ * @type {string}
2864
+ * @memberof MetadataApiRefreshMetadataByID
2865
+ */
2866
+ readonly contractAddress: string;
2867
+ /**
2868
+ * NFT Metadata Refresh Request
2869
+ * @type {RefreshMetadataByIDRequest}
2870
+ * @memberof MetadataApiRefreshMetadataByID
2871
+ */
2872
+ readonly refreshMetadataByIDRequest: RefreshMetadataByIDRequest;
2873
+ }
2874
+ /**
2875
+ * Request parameters for refreshNFTMetadataByTokenID operation in MetadataApi.
2876
+ * @export
2877
+ * @interface MetadataApiRefreshNFTMetadataByTokenIDRequest
2878
+ */
2879
+ interface MetadataApiRefreshNFTMetadataByTokenIDRequest {
2880
+ /**
2881
+ * The address of contract
2882
+ * @type {string}
2883
+ * @memberof MetadataApiRefreshNFTMetadataByTokenID
2884
+ */
2885
+ readonly contractAddress: string;
2886
+ /**
2887
+ * The name of chain
2888
+ * @type {string}
2889
+ * @memberof MetadataApiRefreshNFTMetadataByTokenID
2890
+ */
2891
+ readonly chainName: string;
2892
+ /**
2893
+ * the request body
2894
+ * @type {RefreshNFTMetadataByTokenIDRequest}
2895
+ * @memberof MetadataApiRefreshNFTMetadataByTokenID
2896
+ */
2897
+ readonly refreshNFTMetadataByTokenIDRequest: RefreshNFTMetadataByTokenIDRequest;
2898
+ }
2899
+
2900
+ /**
2901
+ * Request parameters for listNFTOwners operation in NftOwnersApi.
2902
+ * @export
2903
+ * @interface NftOwnersApiListNFTOwnersRequest
2904
+ */
2905
+ interface NftOwnersApiListNFTOwnersRequest {
2906
+ /**
2907
+ * The address of contract
2908
+ * @type {string}
2909
+ * @memberof NftOwnersApiListNFTOwners
2910
+ */
2911
+ readonly contractAddress: string;
2912
+ /**
2913
+ * An &#x60;uint256&#x60; token id as string
2914
+ * @type {string}
2915
+ * @memberof NftOwnersApiListNFTOwners
2916
+ */
2917
+ readonly tokenId: string;
2918
+ /**
2919
+ * The name of chain
2920
+ * @type {string}
2921
+ * @memberof NftOwnersApiListNFTOwners
2922
+ */
2923
+ readonly chainName: string;
2924
+ /**
2925
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2926
+ * @type {string}
2927
+ * @memberof NftOwnersApiListNFTOwners
2928
+ */
2929
+ readonly pageCursor?: string;
2930
+ /**
2931
+ * Maximum number of items to return
2932
+ * @type {number}
2933
+ * @memberof NftOwnersApiListNFTOwners
2934
+ */
2935
+ readonly pageSize?: number;
2936
+ }
2937
+ /**
2938
+ * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
2939
+ * @export
2940
+ * @interface NftOwnersApiListOwnersByContractAddressRequest
2941
+ */
2942
+ interface NftOwnersApiListOwnersByContractAddressRequest {
2943
+ /**
2944
+ * The address of contract
2945
+ * @type {string}
2946
+ * @memberof NftOwnersApiListOwnersByContractAddress
2947
+ */
2948
+ readonly contractAddress: string;
2949
+ /**
2950
+ * The name of chain
2951
+ * @type {string}
2952
+ * @memberof NftOwnersApiListOwnersByContractAddress
2953
+ */
2954
+ readonly chainName: string;
2955
+ /**
2956
+ * List of account addresses to filter by
2957
+ * @type {Array<string>}
2958
+ * @memberof NftOwnersApiListOwnersByContractAddress
2959
+ */
2960
+ readonly accountAddress?: Array<string>;
2961
+ /**
2962
+ * Datetime to use as the oldest updated timestamp
2963
+ * @type {string}
2964
+ * @memberof NftOwnersApiListOwnersByContractAddress
2965
+ */
2966
+ readonly fromUpdatedAt?: string;
2967
+ /**
2968
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2969
+ * @type {string}
2970
+ * @memberof NftOwnersApiListOwnersByContractAddress
2971
+ */
2972
+ readonly pageCursor?: string;
2973
+ /**
2974
+ * Maximum number of items to return
2975
+ * @type {number}
2976
+ * @memberof NftOwnersApiListOwnersByContractAddress
2977
+ */
2978
+ readonly pageSize?: number;
2979
+ }
2980
+
2981
+ /**
2982
+ * Request parameters for createMintRequest operation in NftsApi.
2983
+ * @export
2984
+ * @interface NftsApiCreateMintRequestRequest
2985
+ */
2986
+ interface NftsApiCreateMintRequestRequest {
2987
+ /**
2988
+ * The address of contract
2989
+ * @type {string}
2990
+ * @memberof NftsApiCreateMintRequest
2991
+ */
2992
+ readonly contractAddress: string;
2993
+ /**
2994
+ * The name of chain
2995
+ * @type {string}
2996
+ * @memberof NftsApiCreateMintRequest
2997
+ */
2998
+ readonly chainName: string;
2999
+ /**
3000
+ * Create Mint Request Body
3001
+ * @type {CreateMintRequestRequest}
3002
+ * @memberof NftsApiCreateMintRequest
3003
+ */
3004
+ readonly createMintRequestRequest: CreateMintRequestRequest;
3005
+ }
3006
+ /**
3007
+ * Request parameters for getMintRequest operation in NftsApi.
3008
+ * @export
3009
+ * @interface NftsApiGetMintRequestRequest
3010
+ */
3011
+ interface NftsApiGetMintRequestRequest {
3012
+ /**
3013
+ * The address of contract
3014
+ * @type {string}
3015
+ * @memberof NftsApiGetMintRequest
3016
+ */
3017
+ readonly contractAddress: string;
3018
+ /**
3019
+ * The name of chain
3020
+ * @type {string}
3021
+ * @memberof NftsApiGetMintRequest
3022
+ */
3023
+ readonly chainName: string;
3024
+ /**
3025
+ * The id of the mint request
3026
+ * @type {string}
3027
+ * @memberof NftsApiGetMintRequest
3028
+ */
3029
+ readonly referenceId: string;
3030
+ }
3031
+ /**
3032
+ * Request parameters for getNFT operation in NftsApi.
3033
+ * @export
3034
+ * @interface NftsApiGetNFTRequest
3035
+ */
3036
+ interface NftsApiGetNFTRequest {
3037
+ /**
3038
+ * The address of NFT contract
3039
+ * @type {string}
3040
+ * @memberof NftsApiGetNFT
3041
+ */
3042
+ readonly contractAddress: string;
3043
+ /**
3044
+ * An &#x60;uint256&#x60; token id as string
3045
+ * @type {string}
3046
+ * @memberof NftsApiGetNFT
3047
+ */
3048
+ readonly tokenId: string;
3049
+ /**
3050
+ * The name of chain
3051
+ * @type {string}
3052
+ * @memberof NftsApiGetNFT
3053
+ */
3054
+ readonly chainName: string;
3055
+ }
3056
+ /**
3057
+ * Request parameters for listAllNFTs operation in NftsApi.
3058
+ * @export
3059
+ * @interface NftsApiListAllNFTsRequest
3060
+ */
3061
+ interface NftsApiListAllNFTsRequest {
3062
+ /**
3063
+ * The name of chain
3064
+ * @type {string}
3065
+ * @memberof NftsApiListAllNFTs
3066
+ */
3067
+ readonly chainName: string;
3068
+ /**
3069
+ * Datetime to use as the oldest updated timestamp
3070
+ * @type {string}
3071
+ * @memberof NftsApiListAllNFTs
3072
+ */
3073
+ readonly fromUpdatedAt?: string;
3074
+ /**
3075
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3076
+ * @type {string}
3077
+ * @memberof NftsApiListAllNFTs
3078
+ */
3079
+ readonly pageCursor?: string;
3080
+ /**
3081
+ * Maximum number of items to return
3082
+ * @type {number}
3083
+ * @memberof NftsApiListAllNFTs
3084
+ */
3085
+ readonly pageSize?: number;
3086
+ }
3087
+ /**
3088
+ * Request parameters for listMintRequests operation in NftsApi.
3089
+ * @export
3090
+ * @interface NftsApiListMintRequestsRequest
3091
+ */
3092
+ interface NftsApiListMintRequestsRequest {
3093
+ /**
3094
+ * The address of contract
3095
+ * @type {string}
3096
+ * @memberof NftsApiListMintRequests
3097
+ */
3098
+ readonly contractAddress: string;
3099
+ /**
3100
+ * The name of chain
3101
+ * @type {string}
3102
+ * @memberof NftsApiListMintRequests
3103
+ */
3104
+ readonly chainName: string;
3105
+ /**
3106
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3107
+ * @type {string}
3108
+ * @memberof NftsApiListMintRequests
3109
+ */
3110
+ readonly pageCursor?: string;
3111
+ /**
3112
+ * Maximum number of items to return
3113
+ * @type {number}
3114
+ * @memberof NftsApiListMintRequests
3115
+ */
3116
+ readonly pageSize?: number;
3117
+ /**
3118
+ * The status of the mint request
3119
+ * @type {MintRequestStatus}
3120
+ * @memberof NftsApiListMintRequests
3121
+ */
3122
+ readonly status?: MintRequestStatus;
3123
+ }
3124
+ /**
3125
+ * Request parameters for listNFTs operation in NftsApi.
3126
+ * @export
3127
+ * @interface NftsApiListNFTsRequest
3128
+ */
3129
+ interface NftsApiListNFTsRequest {
3130
+ /**
3131
+ * Contract address
3132
+ * @type {string}
3133
+ * @memberof NftsApiListNFTs
3134
+ */
3135
+ readonly contractAddress: string;
3136
+ /**
3137
+ * The name of chain
3138
+ * @type {string}
3139
+ * @memberof NftsApiListNFTs
3140
+ */
3141
+ readonly chainName: string;
3142
+ /**
3143
+ * List of token IDs to filter by
3144
+ * @type {Array<string>}
3145
+ * @memberof NftsApiListNFTs
3146
+ */
3147
+ readonly tokenId?: Array<string>;
3148
+ /**
3149
+ * Datetime to use as the oldest updated timestamp
3150
+ * @type {string}
3151
+ * @memberof NftsApiListNFTs
3152
+ */
3153
+ readonly fromUpdatedAt?: string;
3154
+ /**
3155
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3156
+ * @type {string}
3157
+ * @memberof NftsApiListNFTs
3158
+ */
3159
+ readonly pageCursor?: string;
3160
+ /**
3161
+ * Maximum number of items to return
3162
+ * @type {number}
3163
+ * @memberof NftsApiListNFTs
3164
+ */
3165
+ readonly pageSize?: number;
3166
+ }
3167
+ /**
3168
+ * Request parameters for listNFTsByAccountAddress operation in NftsApi.
3169
+ * @export
3170
+ * @interface NftsApiListNFTsByAccountAddressRequest
3171
+ */
3172
+ interface NftsApiListNFTsByAccountAddressRequest {
3173
+ /**
3174
+ * Account address
3175
+ * @type {string}
3176
+ * @memberof NftsApiListNFTsByAccountAddress
3177
+ */
3178
+ readonly accountAddress: string;
3179
+ /**
3180
+ * The name of chain
3181
+ * @type {string}
3182
+ * @memberof NftsApiListNFTsByAccountAddress
3183
+ */
3184
+ readonly chainName: string;
3185
+ /**
3186
+ * The address of contract
3187
+ * @type {string}
3188
+ * @memberof NftsApiListNFTsByAccountAddress
3189
+ */
3190
+ readonly contractAddress?: string;
3191
+ /**
3192
+ * Datetime to use as the oldest updated timestamp
3193
+ * @type {string}
3194
+ * @memberof NftsApiListNFTsByAccountAddress
3195
+ */
3196
+ readonly fromUpdatedAt?: string;
3197
+ /**
3198
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3199
+ * @type {string}
3200
+ * @memberof NftsApiListNFTsByAccountAddress
3201
+ */
3202
+ readonly pageCursor?: string;
3203
+ /**
3204
+ * Maximum number of items to return
3205
+ * @type {number}
3206
+ * @memberof NftsApiListNFTsByAccountAddress
3207
+ */
3208
+ readonly pageSize?: number;
3209
+ }
3210
+
3211
+ /**
3212
+ * Request parameters for getERC20Token operation in TokensApi.
3213
+ * @export
3214
+ * @interface TokensApiGetERC20TokenRequest
3215
+ */
3216
+ interface TokensApiGetERC20TokenRequest {
3217
+ /**
3218
+ * The address of contract
3219
+ * @type {string}
3220
+ * @memberof TokensApiGetERC20Token
3221
+ */
3222
+ readonly contractAddress: string;
3223
+ /**
3224
+ * The name of chain
3225
+ * @type {string}
3226
+ * @memberof TokensApiGetERC20Token
3227
+ */
3228
+ readonly chainName: string;
3229
+ }
3230
+ /**
3231
+ * Request parameters for listERC20Tokens operation in TokensApi.
3232
+ * @export
3233
+ * @interface TokensApiListERC20TokensRequest
3234
+ */
3235
+ interface TokensApiListERC20TokensRequest {
3236
+ /**
3237
+ * The name of chain
3238
+ * @type {string}
3239
+ * @memberof TokensApiListERC20Tokens
3240
+ */
3241
+ readonly chainName: string;
3242
+ /**
3243
+ * Datetime to use as the oldest updated timestamp
3244
+ * @type {string}
3245
+ * @memberof TokensApiListERC20Tokens
3246
+ */
3247
+ readonly fromUpdatedAt?: string;
3248
+ /**
3249
+ * List of verification status to filter by
3250
+ * @type {Array<AssetVerificationStatus>}
3251
+ * @memberof TokensApiListERC20Tokens
3252
+ */
3253
+ readonly verificationStatus?: Array<AssetVerificationStatus>;
3254
+ /**
3255
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3256
+ * @type {string}
3257
+ * @memberof TokensApiListERC20Tokens
3258
+ */
3259
+ readonly pageCursor?: string;
3260
+ /**
3261
+ * Maximum number of items to return
3262
+ * @type {number}
3263
+ * @memberof TokensApiListERC20Tokens
3264
+ */
3265
+ readonly pageSize?: number;
3266
+ }
3267
+
3268
+ interface APIConfigurationParams {
3269
+ basePath: string;
3270
+ headers?: Record<string, string>;
3271
+ baseConfig?: ImmutableConfiguration;
3272
+ }
3273
+ interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
3274
+ }
3275
+ declare class BlockchainDataConfiguration {
3276
+ readonly apiConfig: Configuration;
3277
+ readonly baseConfig: ImmutableConfiguration;
3278
+ constructor({ baseConfig, overrides }: BlockchainDataModuleConfiguration);
3279
+ }
3280
+
3281
+ declare class BlockchainData {
3282
+ readonly config: BlockchainDataConfiguration;
3283
+ private readonly activities;
3284
+ private readonly chains;
3285
+ private readonly collections;
3286
+ private readonly nfts;
3287
+ private readonly nftOwners;
3288
+ private readonly tokens;
3289
+ private readonly metadata;
3290
+ constructor(moduleConfig: BlockchainDataModuleConfiguration);
3291
+ /**
3292
+ * List all activities
3293
+ * @param request - the request object containing the parameters to be provided in the API request
3294
+ * @returns a promise that resolves with a list of activities
3295
+ * @throws {@link index.APIError}
3296
+ */
3297
+ listActivities(request: ActivitiesApiListActivitiesRequest): Promise<ListActivitiesResult>;
3298
+ /**
3299
+ * List activities sorted by updated_at timestamp ascending, useful for time based data replication
3300
+ * @param request - the request object containing the parameters to be provided in the API request
3301
+ * @returns a promise that resolves with a list of activities
3302
+ * @throws {@link index.APIError}
3303
+ */
3304
+ listActivityHistory(request: ActivitiesApiListActivityHistoryRequest): Promise<ListActivitiesResult>;
3305
+ /**
3306
+ * Get a single activity by ID
3307
+ * @param request - the request object containing the parameters to be provided in the API request
3308
+ * @returns a promise that resolves with a single activity
3309
+ * @throws {@link index.APIError}
3310
+ */
3311
+ getActivity(request: ActivitiesApiGetActivityRequest): Promise<GetActivityResult>;
3312
+ /**
3313
+ * List supported chains
3314
+ * @param request - the request object containing the parameters to be provided in the API request
3315
+ * @returns a promise that resolves with a list of supported chains
3316
+ * @throws {@link index.APIError}
3317
+ */
3318
+ listChains(request: ChainsApiListChainsRequest): Promise<ListChainsResult>;
3319
+ /**
3320
+ * List all collections
3321
+ * @param request - the request object containing the parameters to be provided in the API request
3322
+ * @returns a promise that resolves with a list of collections
3323
+ * @throws {@link index.APIError}
3324
+ */
3325
+ listCollections(request: CollectionsApiListCollectionsRequest): Promise<ListCollectionsResult>;
3326
+ /**
3327
+ * List collections by NFT owner
3328
+ * @param request - the request object containing the parameters to be provided in the API request
3329
+ * @returns a promise that resolves with a list of collections
3330
+ * @throws {@link index.APIError}
3331
+ */
3332
+ listCollectionsByNFTOwner(request: CollectionsApiListCollectionsByNFTOwnerRequest): Promise<ListCollectionsResult>;
3333
+ /**
3334
+ * Get a collection by contract address
3335
+ * @param request - the request object containing the parameters to be provided in the API request
3336
+ * @returns a promise that resolves with a single collection
3337
+ * @throws {@link index.APIError}
3338
+ */
3339
+ getCollection(request: CollectionsApiGetCollectionRequest): Promise<GetCollectionResult>;
3340
+ /**
3341
+ * Get NFT by token ID
3342
+ * @param request - the request object containing the parameters to be provided in the API request
3343
+ * @returns a promise that resolves with a single NFT
3344
+ * @throws {@link index.APIError}
3345
+ */
3346
+ getNFT(request: NftsApiGetNFTRequest): Promise<GetNFTResult>;
3347
+ /**
3348
+ * List NFTs by contract address
3349
+ * @param request - the request object containing the parameters to be provided in the API request
3350
+ * @returns a promise that resolves with a list of NFTs
3351
+ * @throws {@link index.APIError}
3352
+ */
3353
+ listNFTs(request: NftsApiListNFTsRequest): Promise<ListNFTsResult>;
3354
+ /**
3355
+ * List NFTs by account address
3356
+ * @param request - the request object containing the parameters to be provided in the API request
3357
+ * @returns a promise that resolves with a list of NFTs
3358
+ * @throws {@link index.APIError}
3359
+ */
3360
+ listNFTsByAccountAddress(request: NftsApiListNFTsByAccountAddressRequest): Promise<ListNFTsResult>;
3361
+ /**
3362
+ * List All NFTs on a chain
3363
+ * @param request - the request object containing the parameters to be provided in the API request
3364
+ * @returns a promise that resolves with a list of NFTs
3365
+ * @throws {@link index.APIError}
3366
+ */
3367
+ listAllNFTs(request: NftsApiListAllNFTsRequest): Promise<ListNFTsResult>;
3368
+ /**
3369
+ * Create a mint request to mint a set of NFTs for a given collection
3370
+ * @param request - the request object containing the parameters to be provided in the API request
3371
+ * @returns a promise that resolves with the remaining rate limits
3372
+ * @throws {@link index.APIError}
3373
+ */
3374
+ createMintRequest(request: NftsApiCreateMintRequestRequest): Promise<CreateMintRequestResult>;
3375
+ /**
3376
+ * List all mint requests for a given contract address
3377
+ * @param request - the request object containing the parameters to be provided in the API request
3378
+ * @returns a promise that resolves with a list of mint requests
3379
+ * @throws {@link index.APIError}
3380
+ */
3381
+ listMintRequests(request: NftsApiListMintRequestsRequest): Promise<ListMintRequestsResult>;
3382
+ /**
3383
+ * Retrieve the status of a single mint request identified by its reference ID
3384
+ * @param request - the request object containing the parameters to be provided in the API request
3385
+ * @returns a promise that resolves with a single mint request
3386
+ * @throws {@link index.APIError}
3387
+ */
3388
+ getMintRequest(request: NftsApiGetMintRequestRequest): Promise<ListMintRequestsResult>;
3389
+ /**
3390
+ * List NFT owners by token ID
3391
+ * @param request - the request object containing the parameters to be provided in the API request
3392
+ * @returns a promise that resolves with a list of NFT owners
3393
+ * @throws {@link index.APIError}
3394
+ */
3395
+ listNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
3396
+ /**
3397
+ * List NFT owners by contract address
3398
+ * @param request - the request object containing the parameters to be provided in the API request
3399
+ * @returns a promise that resolves with a list of NFT owners
3400
+ * @throws {@link index.APIError}
3401
+ */
3402
+ listNFTOwnersByContractAddress(request: NftOwnersApiListOwnersByContractAddressRequest): Promise<ListNFTOwnersResult>;
3403
+ /**
3404
+ * List All NFT owners on a chain
3405
+ * @param request - the request object containing the parameters to be provided in the API request
3406
+ * @returns a promise that resolves with a list of NFT owners
3407
+ * @throws {@link index.APIError}
3408
+ */
3409
+ listAllNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
3410
+ /**
3411
+ * List ERC20 Token contracts
3412
+ * @param request - the request object containing the parameters to be provided in the API request
3413
+ * @returns a promise that resolves with a list of ERC20 Tokens
3414
+ * @throws {@link index.APIError}
3415
+ */
3416
+ listTokens(request: TokensApiListERC20TokensRequest): Promise<ListTokensResult>;
3417
+ /**
3418
+ * Get details for an ERC20 Token by contract address
3419
+ * @param request - the request object containing the parameters to be provided in the API request
3420
+ * @returns a promise that resolves with a list of ERC20 Tokens
3421
+ * @throws {@link index.APIError}
3422
+ */
3423
+ getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
3424
+ /**
3425
+ * Get metadata by ID
3426
+ * @param request - the request object containing the parameters to be provided in the API request
3427
+ * @returns a promise that resolves with a single Metadata
3428
+ * @throws {@link index.APIError}
3429
+ */
3430
+ getMetadata(request: MetadataApiGetMetadataRequest): Promise<GetMetadataResult>;
3431
+ /**
3432
+ * List NFT Metadata by contract address
3433
+ * @param request - the request object containing the parameters to be provided in the API request
3434
+ * @returns a promise that resolves with a list of Metadata
3435
+ * @throws {@link index.APIError}
3436
+ */
3437
+ listNFTMetadataByContractAddress(request: MetadataApiListMetadataRequest): Promise<ListMetadataResult>;
3438
+ /**
3439
+ * List NFT Metadata by chain
3440
+ * @param request - the request object containing the parameters to be provided in the API request
3441
+ * @returns a promise that resolves with a list of Metadata
3442
+ * @throws {@link index.APIError}
3443
+ */
3444
+ listNFTMetadataByChain(request: MetadataApiListMetadataForChainRequest): Promise<ListMetadataResult>;
3445
+ /**
3446
+ * Refresh collection metadata
3447
+ * @param request - the request object containing the parameters to be provided in the API request
3448
+ * @returns a promise that resolves with the updated collection
3449
+ * @throws {@link index.APIError}
3450
+ */
3451
+ refreshCollectionMetadata(request: CollectionsApiRefreshCollectionMetadataRequest): Promise<RefreshCollectionMetadataResult>;
3452
+ /**
3453
+ * Refresh metadata for specific NFTs
3454
+ * @param request - the request object containing the parameters to be provided in the API request
3455
+ * @returns a promise that resolves with the remaining rate limits
3456
+ * @throws {@link index.APIError}
3457
+ */
3458
+ refreshNFTMetadata(request: MetadataApiRefreshNFTMetadataByTokenIDRequest): Promise<MetadataRefreshRateLimitResult>;
3459
+ /**
3460
+ * Refresh metadata by ID. This will refresh metadata for all NFTs that reference the given metadata ID.
3461
+ * @param request - the request object containing the parameters to be provided in the API request
3462
+ * @returns a promise that resolves with the remaining rate limits
3463
+ * @throws {@link index.APIError}
3464
+ */
3465
+ refreshStackedMetadata(request: MetadataApiRefreshMetadataByIDRequest): Promise<MetadataRefreshRateLimitResult>;
3466
+ }
3467
+
3468
+ interface Logger {
3469
+ info: (message: string) => void;
3470
+ error: (message: any) => void;
3471
+ }
3472
+
3473
+ declare const recordMint: (mintingPersistence: MintingPersistence, mintRequest: CreateMintRequest) => Promise<void>;
3474
+ declare const submitMintingRequests: (mintingPersistence: MintingPersistence, blockchainDataSDKClient: BlockchainData, { defaultBatchSize, chainName, maxNumberOfTries, }: {
3475
+ defaultBatchSize?: number | undefined;
3476
+ chainName?: string | undefined;
3477
+ maxNumberOfTries?: number | undefined;
3478
+ }, logger?: Logger) => Promise<never>;
3479
+ type MintRequestEvent = {
3480
+ event_name: string;
3481
+ chain: string;
3482
+ event_id: string;
3483
+ data: {
3484
+ chain: {
3485
+ id: string;
3486
+ name: string;
3487
+ };
3488
+ contract_address: string;
3489
+ owner_address: string;
3490
+ reference_id: string;
3491
+ metadata_id: string;
3492
+ token_id: string | null;
3493
+ status: string;
3494
+ transaction_hash: string | null;
3495
+ activity_id: string | null;
3496
+ error: {
3497
+ code: string;
3498
+ message: string;
3499
+ } | null;
3500
+ created_at: string;
3501
+ updated_at: string;
3502
+ };
3503
+ };
3504
+ declare const processMint: (mintingPersistence: MintingPersistence, event: MintRequestEvent, logger?: Logger) => Promise<void>;
3505
+
3506
+ interface MintingBackendModuleConfiguration extends ModuleConfiguration<undefined> {
3507
+ persistence: MintingPersistence;
3508
+ logger?: Logger;
3509
+ }
3510
+ declare class MintingBackendModule {
3511
+ private readonly baseConfig;
3512
+ private readonly persistence;
3513
+ private readonly blockchainDataClient;
3514
+ private readonly logger;
3515
+ constructor(config: MintingBackendModuleConfiguration);
3516
+ recordMint(mintRequest: CreateMintRequest): Promise<void>;
3517
+ submitMintingRequests(config: {
3518
+ defaultBatchSize?: number;
3519
+ chainName?: string;
3520
+ maxNumberOfTries?: number;
3521
+ }): Promise<void>;
3522
+ processMint(body: string | Record<string, unknown>, otherHandlers?: {
3523
+ zkevmMintRequestUpdated: (event: MintRequestEvent) => Promise<void>;
3524
+ others: (..._args: any) => Promise<void>;
3525
+ }): Promise<void>;
3526
+ }
3527
+
3528
+ export { MintingBackendModule, MintingBackendModuleConfiguration, mintingPersistence$1 as mintingPersistencePg, mintingPersistence as mintingPersistencePrismaSqlite, processMint, recordMint, submitMintingRequests };