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