@zoralabs/protocol-sdk 0.3.4 → 0.4.0

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.
Files changed (44) hide show
  1. package/.turbo/turbo-build.log +6 -6
  2. package/CHANGELOG.md +34 -0
  3. package/README.md +30 -58
  4. package/dist/anvil.d.ts +4 -2
  5. package/dist/anvil.d.ts.map +1 -1
  6. package/dist/constants.d.ts +32 -0
  7. package/dist/constants.d.ts.map +1 -1
  8. package/dist/index.cjs +819 -518
  9. package/dist/index.cjs.map +1 -1
  10. package/dist/index.d.ts +1 -0
  11. package/dist/index.d.ts.map +1 -1
  12. package/dist/index.js +788 -493
  13. package/dist/index.js.map +1 -1
  14. package/dist/mint/mint-api-client.d.ts +16 -216
  15. package/dist/mint/mint-api-client.d.ts.map +1 -1
  16. package/dist/mint/mint-client.d.ts +7 -227
  17. package/dist/mint/mint-client.d.ts.map +1 -1
  18. package/dist/premint/contract-types.d.ts +125 -0
  19. package/dist/premint/contract-types.d.ts.map +1 -0
  20. package/dist/premint/premint-api-client.d.ts +14 -7
  21. package/dist/premint/premint-api-client.d.ts.map +1 -1
  22. package/dist/premint/premint-client.d.ts +45 -115
  23. package/dist/premint/premint-client.d.ts.map +1 -1
  24. package/dist/premint/preminter.d.ts +102 -21
  25. package/dist/premint/preminter.d.ts.map +1 -1
  26. package/dist/types.d.ts +2 -0
  27. package/dist/types.d.ts.map +1 -0
  28. package/package.json +1 -1
  29. package/src/anvil.ts +7 -4
  30. package/src/constants.ts +7 -0
  31. package/src/index.ts +2 -0
  32. package/src/mint/mint-api-client.ts +72 -68
  33. package/src/mint/mint-client.test.ts +9 -11
  34. package/src/mint/mint-client.ts +51 -221
  35. package/src/premint/contract-types.ts +109 -0
  36. package/src/premint/premint-api-client.ts +162 -22
  37. package/src/premint/premint-client.test.ts +186 -84
  38. package/src/premint/premint-client.ts +357 -289
  39. package/src/premint/preminter.test.ts +209 -130
  40. package/src/premint/preminter.ts +377 -54
  41. package/src/types.ts +1 -0
  42. package/dist/apis/generated/discover-api-types.d.ts +0 -2131
  43. package/dist/apis/generated/discover-api-types.d.ts.map +0 -1
  44. package/src/apis/generated/discover-api-types.ts +0 -2180
@@ -1,2180 +0,0 @@
1
- /**
2
- * This file was auto-generated by openapi-typescript.
3
- * Do not make direct changes to the file.
4
- */
5
-
6
- export interface paths {
7
- "/": {
8
- /** Root */
9
- get: operations["root__get"];
10
- };
11
- "/feed": {
12
- /** Get Feed */
13
- get: operations["get_feed_feed_get"];
14
- };
15
- "/relevant_mintables/{chain_name}/{collection_address}/{token_id}": {
16
- /** Gen Relevant Mintables */
17
- get: operations["gen_relevant_mintables_relevant_mintables__chain_name___collection_address___token_id__get"];
18
- };
19
- "/relevant_mintables/{chain_name}/{collection_address}": {
20
- /** Gen Relevant Mintables */
21
- get: operations["gen_relevant_mintables_relevant_mintables__chain_name___collection_address__get"];
22
- };
23
- "/feed_item_check/{chain_name}/{collection_address}/{token_id}": {
24
- /** Gen Feed Item Check */
25
- get: operations["gen_feed_item_check_feed_item_check__chain_name___collection_address___token_id__get"];
26
- };
27
- "/feed_item_check/{chain_name}/{collection_address}": {
28
- /** Gen Feed Item Check */
29
- get: operations["gen_feed_item_check_feed_item_check__chain_name___collection_address__get"];
30
- };
31
- "/mintables/{chain_name}/{collection_address}/{token_id}": {
32
- /** Gen Mintable */
33
- get: operations["gen_mintable_mintables__chain_name___collection_address___token_id__get"];
34
- };
35
- "/mintables/{chain_name}/{collection_address}": {
36
- /** Gen Mintable */
37
- get: operations["gen_mintable_mintables__chain_name___collection_address__get"];
38
- };
39
- "/premints/{chain_name}": {
40
- /** Gen All Mintables */
41
- get: operations["gen_all_mintables_premints__chain_name__get"];
42
- };
43
- "/mintables_v2/{chain_name}/{collection_address}": {
44
- /** Gen Mintable V2 */
45
- get: operations["gen_mintable_v2_mintables_v2__chain_name___collection_address__get"];
46
- };
47
- "/contract/backfill": {
48
- /** Gen Backfill Contract */
49
- post: operations["gen_backfill_contract_contract_backfill_post"];
50
- };
51
- "/contract/{chain_name}/{collection_address}": {
52
- /** Get Contract */
53
- get: operations["get_contract_contract__chain_name___collection_address__get"];
54
- };
55
- "/contract_summaries": {
56
- /** Gen Contract Summaries */
57
- post: operations["gen_contract_summaries_contract_summaries_post"];
58
- };
59
- "/mint_counts": {
60
- /**
61
- * Gen Mint Counts
62
- * @deprecated
63
- * @description Use /contract_summaries instead
64
- */
65
- post: operations["gen_mint_counts_mint_counts_post"];
66
- };
67
- "/contracts": {
68
- /** Gen Contracts */
69
- post: operations["gen_contracts_contracts_post"];
70
- };
71
- "/tokens/{chain_name}/{collection_address}": {
72
- /** Gen Contract Tokens */
73
- get: operations["gen_contract_tokens_tokens__chain_name___collection_address__get"];
74
- };
75
- "/user/{wallet}": {
76
- /** Get User */
77
- get: operations["get_user_user__wallet__get"];
78
- };
79
- "/user/{wallet_address}/tokens": {
80
- /** Gen User Tokens */
81
- get: operations["gen_user_tokens_user__wallet_address__tokens_get"];
82
- };
83
- "/user/{wallet_address}/contracts": {
84
- /** Gen User Contracts */
85
- get: operations["gen_user_contracts_user__wallet_address__contracts_get"];
86
- };
87
- "/trending": {
88
- /** Gen Trending */
89
- get: operations["gen_trending_trending_get"];
90
- };
91
- "/trending_feed": {
92
- /** Gen Trending Feed */
93
- get: operations["gen_trending_feed_trending_feed_get"];
94
- };
95
- "/search": {
96
- /** Gen Search */
97
- get: operations["gen_search_search_get"];
98
- };
99
- "/stream/token_mint/{chain_name}/{collection_address}": {
100
- /** Stream Token Mint */
101
- get: operations["stream_token_mint_stream_token_mint__chain_name___collection_address__get"];
102
- };
103
- "/token_mints/{chain_name}/{collection_address}": {
104
- /** Gen Token Mints */
105
- get: operations["gen_token_mints_token_mints__chain_name___collection_address__get"];
106
- };
107
- "/stream/mint_comment/{chain_name}/{collection_address}": {
108
- /** Stream Mint Comment */
109
- get: operations["stream_mint_comment_stream_mint_comment__chain_name___collection_address__get"];
110
- };
111
- "/mint_comments/{chain_name}/{collection_address}": {
112
- /** Gen Mint Comments */
113
- get: operations["gen_mint_comments_mint_comments__chain_name___collection_address__get"];
114
- };
115
- "/notifications": {
116
- /** Gen Notifications */
117
- get: operations["gen_notifications_notifications_get"];
118
- };
119
- "/stream/notifications": {
120
- /** Stream Notification */
121
- get: operations["stream_notification_stream_notifications_get"];
122
- };
123
- "/refresh-blocklist": {
124
- /** Refresh Blocklist */
125
- get: operations["refresh_blocklist_refresh_blocklist_get"];
126
- };
127
- "/schema": {
128
- /** Schema */
129
- get: operations["schema_schema_get"];
130
- };
131
- }
132
-
133
- export type webhooks = Record<string, never>;
134
-
135
- export interface components {
136
- schemas: {
137
- /** BaseModel */
138
- BaseModel: Record<string, never>;
139
- /**
140
- * Chain
141
- * @description An enumeration.
142
- * @enum {string}
143
- */
144
- Chain: "ETHEREUM" | "ZORA";
145
- /**
146
- * ChainName
147
- * @description An enumeration.
148
- * @enum {string}
149
- */
150
- ChainName:
151
- | "ETHEREUM-MAINNET"
152
- | "ETHEREUM-ROPSTEN"
153
- | "ETHEREUM-RINKEBY"
154
- | "ETHEREUM-GOERLI"
155
- | "ETHEREUM-SEPOLIA"
156
- | "OPTIMISM-MAINNET"
157
- | "OPTIMISM-GOERLI"
158
- | "ZORA-GOERLI"
159
- | "ZORA-MAINNET"
160
- | "BASE-MAINNET"
161
- | "BASE-GOERLI"
162
- | "PGN-MAINNET";
163
- /** Collection */
164
- Collection: {
165
- /** Address */
166
- address: string;
167
- /** Name */
168
- name?: string;
169
- /** Symbol */
170
- symbol?: string;
171
- token_standard?: components["schemas"]["TokenStandard"];
172
- /** Description */
173
- description?: string;
174
- /** Image */
175
- image?: string;
176
- };
177
- /**
178
- * CollectionCreationConfig
179
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
180
- * (store_as, override_name), as well as provides other convinience methods.
181
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
182
- * complex type we include on a stored entity.
183
- *
184
- * Example::
185
- * >>> class Foo(ObjectBase):
186
- * ...: found_at_height: int = field(override_name="address", store_as=str)
187
- * ...: other: str = "default"
188
- */
189
- CollectionCreationConfig: {
190
- /** Contractadmin */
191
- contractAdmin: string;
192
- /** Contracturi */
193
- contractURI: string;
194
- /** Contractname */
195
- contractName: string;
196
- };
197
- /** CollectionTokenId */
198
- CollectionTokenId: {
199
- chain_name: components["schemas"]["ChainName"];
200
- /** Collection Address */
201
- collection_address: string;
202
- /** Token Id */
203
- token_id?: number | string;
204
- };
205
- /** Collector */
206
- Collector: {
207
- /** Address */
208
- address: string;
209
- /** Ens Name */
210
- ens_name?: string;
211
- };
212
- /** CollectorSummary */
213
- CollectorSummary: {
214
- /** Num Unique Collectors */
215
- num_unique_collectors: number;
216
- /** Collector Previews */
217
- collector_previews: components["schemas"]["Collector"][];
218
- };
219
- /** ContractBackfillResponse */
220
- ContractBackfillResponse: {
221
- /** Success */
222
- success: boolean;
223
- /** Message */
224
- message: string;
225
- };
226
- /** ContractQueryPayload */
227
- ContractQueryPayload: {
228
- chain_name: components["schemas"]["ChainName"];
229
- /** Collection Address */
230
- collection_address: string;
231
- /** Token Id */
232
- token_id?: string;
233
- };
234
- /** ContractQueryResponse */
235
- ContractQueryResponse: {
236
- chain_name: components["schemas"]["ChainName"];
237
- /** Collection Address */
238
- collection_address: string;
239
- /** Token Id */
240
- token_id?: string;
241
- contract_result?: components["schemas"]["ContractResult"];
242
- /**
243
- * Err Code
244
- * @default 0
245
- */
246
- err_code?: number;
247
- /**
248
- * Err Msg
249
- * @default
250
- */
251
- err_msg?: string;
252
- };
253
- /** ContractResult */
254
- ContractResult: {
255
- /** Chain Name */
256
- chain_name: string;
257
- /** Collection Address */
258
- collection_address: string;
259
- /** Token Id */
260
- token_id?: string;
261
- collection: components["schemas"]["Collection"];
262
- contract_type: components["schemas"]["MintableType"];
263
- /** Creator Address */
264
- creator_address?: string;
265
- mintable?: components["schemas"]["Mintable"];
266
- media?: components["schemas"]["Media"];
267
- metadata?: components["schemas"]["zora__collect__contract__models__metadata__Metadata"];
268
- /** Owner */
269
- owner?: string;
270
- /** Total Minted */
271
- total_minted?: number;
272
- };
273
- /** ContractSummary */
274
- ContractSummary: {
275
- chain_name: components["schemas"]["ChainName"];
276
- /** Collection Address */
277
- collection_address: string;
278
- /** Token Id */
279
- token_id?: string;
280
- /** Mint Count */
281
- mint_count: number;
282
- /** Comment Count */
283
- comment_count: number;
284
- /** Unique Collector Count */
285
- unique_collector_count: number;
286
- };
287
- /** ContractSummaryResponse */
288
- ContractSummaryResponse: {
289
- /** Contract Summary List */
290
- contract_summary_list: components["schemas"]["ContractSummary"][];
291
- };
292
- /** ContractsQueryOutput */
293
- ContractsQueryOutput: {
294
- /** Contract Results */
295
- contract_results: components["schemas"]["ContractQueryResponse"][];
296
- };
297
- /** ContractsResponse */
298
- ContractsResponse: {
299
- /** Results */
300
- results: components["schemas"]["ContractResult"][];
301
- /** Limit */
302
- limit: number;
303
- /** Offset */
304
- offset: number;
305
- /** Has Next Page */
306
- has_next_page: boolean;
307
- /**
308
- * Api Version
309
- * @default 1
310
- */
311
- api_version?: number;
312
- };
313
- /**
314
- * Cursor
315
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
316
- * (store_as, override_name), as well as provides other convinience methods.
317
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
318
- * complex type we include on a stored entity.
319
- *
320
- * Example::
321
- * >>> class Foo(ObjectBase):
322
- * ...: found_at_height: int = field(override_name="address", store_as=str)
323
- * ...: other: str = "default"
324
- */
325
- Cursor: {
326
- /** First */
327
- first?: string;
328
- /** Last */
329
- last?: string;
330
- };
331
- /** ENSRecord */
332
- ENSRecord: {
333
- /** Address */
334
- address: string;
335
- /** Ens Name */
336
- ens_name: string;
337
- text_records: components["schemas"]["ENSTextRecords"];
338
- };
339
- /** ENSTextRecords */
340
- ENSTextRecords: {
341
- /** Avatar */
342
- avatar?: string;
343
- /** Url */
344
- url?: string;
345
- /** Description */
346
- description?: string;
347
- /** Github */
348
- github?: string;
349
- /** Twitter */
350
- twitter?: string;
351
- /** Instagram */
352
- instagram?: string;
353
- /** Discord */
354
- discord?: string;
355
- /** Tiktok */
356
- tiktok?: string;
357
- };
358
- /**
359
- * EntityType
360
- * @description An enumeration.
361
- * @enum {string}
362
- */
363
- EntityType: "Collection" | "Token";
364
- /** FeedItemCheck */
365
- FeedItemCheck: {
366
- feed_item?: components["schemas"]["FeedResult"];
367
- /**
368
- * Err Msgs
369
- * @default []
370
- */
371
- err_msgs?: string[];
372
- };
373
- /**
374
- * FeedItemType
375
- * @description An enumeration.
376
- * @enum {string}
377
- */
378
- FeedItemType: "MINTABLE";
379
- /** FeedResponse */
380
- FeedResponse: {
381
- /** Results */
382
- results: components["schemas"]["FeedResult"][];
383
- /** Limit */
384
- limit: number;
385
- /** Offset */
386
- offset: number;
387
- /** Has Next Page */
388
- has_next_page: boolean;
389
- /**
390
- * Api Version
391
- * @default 1
392
- */
393
- api_version?: number;
394
- feed_type?: components["schemas"]["FeedType"];
395
- };
396
- /** FeedResult */
397
- FeedResult: {
398
- feed_item_type: components["schemas"]["FeedItemType"];
399
- /** Uuid */
400
- uuid?: string;
401
- feed_item: components["schemas"]["Mintable"];
402
- media?: components["schemas"]["Media"];
403
- };
404
- /**
405
- * FeedType
406
- * @description An enumeration.
407
- * @enum {string}
408
- */
409
- FeedType:
410
- | "curated"
411
- | "most_recent"
412
- | "heuristic"
413
- | "trending"
414
- | "recommendations";
415
- /**
416
- * FixedPrice
417
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
418
- * (store_as, override_name), as well as provides other convinience methods.
419
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
420
- * complex type we include on a stored entity.
421
- *
422
- * Example::
423
- * >>> class Foo(ObjectBase):
424
- * ...: found_at_height: int = field(override_name="address", store_as=str)
425
- * ...: other: str = "default"
426
- */
427
- FixedPrice: {
428
- /** Token Id */
429
- token_id?: number;
430
- /** Sale Start */
431
- sale_start?: string;
432
- /** Sale End */
433
- sale_end?: string;
434
- /** Max Tokens Per Address */
435
- max_tokens_per_address?: string;
436
- /** Price Per Token */
437
- price_per_token?: string;
438
- /** Funds Recipient */
439
- funds_recipient?: string;
440
- };
441
- /** FoundationMintContext */
442
- FoundationMintContext: {
443
- /**
444
- * Mint Context Type
445
- * @default foundation
446
- * @enum {string}
447
- */
448
- mint_context_type?: "foundation";
449
- };
450
- /** HTTPValidationError */
451
- HTTPValidationError: {
452
- /** Detail */
453
- detail?: components["schemas"]["ValidationError"][];
454
- };
455
- /**
456
- * InferredMintContext
457
- * @description Mint context passed to feed via mintables
458
- *
459
- * Corresponds to the following TypeScript type:
460
- * interface InferredMintContext {
461
- * price_per_token: string
462
- * function_abi: any
463
- * function_name: string
464
- * contract_address: string
465
- * default_eth_value: string
466
- * default_args: (string | number)[]
467
- * quantity_arg_index: number | null
468
- * use_proxy_contract: boolean
469
- * }
470
- */
471
- InferredMintContext: {
472
- /** Reference Tx */
473
- reference_tx?: string;
474
- /** Price Per Token */
475
- price_per_token: string;
476
- /** Function Abi */
477
- function_abi: Record<string, never>;
478
- /** Function Name */
479
- function_name: string;
480
- /** Contract Address */
481
- contract_address: string;
482
- /** Default Eth Value */
483
- default_eth_value: string;
484
- /** Default Args */
485
- default_args: (string | number)[];
486
- /** Expected Tokens Returned */
487
- expected_tokens_returned: number;
488
- /** User Address Arg Index */
489
- user_address_arg_index?: number;
490
- /** Quantity Arg Index */
491
- quantity_arg_index?: number;
492
- /**
493
- * Use Proxy Contract
494
- * @default false
495
- */
496
- use_proxy_contract?: boolean;
497
- /**
498
- * Mint Context Type
499
- * @default inferred
500
- * @enum {string}
501
- */
502
- mint_context_type?: "inferred";
503
- };
504
- /**
505
- * InfinitePageWithTotal[MintComment]
506
- * @description This is a generic model for pagination in an infitite scrolling context.
507
- */
508
- InfinitePageWithTotal_MintComment_: {
509
- /** Data */
510
- data: components["schemas"]["MintComment"][];
511
- /** Limit */
512
- limit: number;
513
- /** Has More */
514
- has_more: boolean;
515
- cursor: components["schemas"]["Cursor"];
516
- /** Total */
517
- total: number;
518
- };
519
- /**
520
- * InfinitePageWithTotal[TokenMint]
521
- * @description This is a generic model for pagination in an infitite scrolling context.
522
- */
523
- InfinitePageWithTotal_TokenMint_: {
524
- /** Data */
525
- data: components["schemas"]["TokenMint"][];
526
- /** Limit */
527
- limit: number;
528
- /** Has More */
529
- has_more: boolean;
530
- cursor: components["schemas"]["Cursor"];
531
- /** Total */
532
- total: number;
533
- };
534
- /**
535
- * InfinitePage[Mintable]
536
- * @description This is a generic model for pagination in an infitite scrolling context.
537
- */
538
- InfinitePage_Mintable_: {
539
- /** Data */
540
- data: components["schemas"]["Mintable"][];
541
- /** Limit */
542
- limit: number;
543
- /** Has More */
544
- has_more: boolean;
545
- cursor: components["schemas"]["Cursor"];
546
- };
547
- /** ManifoldMintContext */
548
- ManifoldMintContext: {
549
- /**
550
- * Mint Context Type
551
- * @default manifold
552
- * @enum {string}
553
- */
554
- mint_context_type?: "manifold";
555
- /** Creator Contract Address */
556
- creator_contract_address: string;
557
- /** Claim Index */
558
- claim_index: number;
559
- /** Mint Index */
560
- mint_index: number;
561
- /**
562
- * Merkle Proof
563
- * Format: binary
564
- */
565
- merkle_proof: string;
566
- };
567
- /** Media */
568
- Media: {
569
- image_preview?: components["schemas"]["zora__media_encoding__media__MediaURI"];
570
- /** Image Carousel */
571
- image_carousel?: components["schemas"]["zora__media_encoding__media__MediaURI"][];
572
- content_preview?: components["schemas"]["zora__media_encoding__media__MediaURI"];
573
- /** Content Carousel */
574
- content_carousel?: components["schemas"]["zora__media_encoding__media__MediaURI"][];
575
- /** Mime Type */
576
- mime_type?: string;
577
- };
578
- /** MediaAttribute */
579
- MediaAttribute: {
580
- /** Trait Type */
581
- trait_type?: string;
582
- /** Value */
583
- value?: string;
584
- /** Display Type */
585
- display_type?: string;
586
- };
587
- /** Mint */
588
- Mint: {
589
- image_preview: components["schemas"]["zora__collect__trending__models__models__MediaURI"];
590
- content_preview?: components["schemas"]["zora__collect__trending__models__models__MediaURI"];
591
- /** Collection Name */
592
- collection_name: string;
593
- /** Token Name */
594
- token_name?: string;
595
- /** Token Id */
596
- token_id: string;
597
- minter: components["schemas"]["Wallet"];
598
- /**
599
- * Mint Time
600
- * Format: date-time
601
- */
602
- mint_time: string;
603
- /** Chain Name */
604
- chain_name: string;
605
- };
606
- /** MintComment */
607
- MintComment: {
608
- chain_name: components["schemas"]["ChainName"];
609
- /** Collection Address */
610
- collection_address: string;
611
- /** Token Id */
612
- token_id?: string;
613
- token_standard?: components["schemas"]["TokenStandard"];
614
- /** From Address */
615
- from_address: string;
616
- /** Comment */
617
- comment: string;
618
- /** Quantity */
619
- quantity: number;
620
- transaction_info: components["schemas"]["TransactionInfo"];
621
- };
622
- /** MintCommentNotification */
623
- MintCommentNotification: {
624
- chain_name: components["schemas"]["ChainName"];
625
- /** Collection Address */
626
- collection_address: string;
627
- /** Token Id */
628
- token_id?: string;
629
- token_standard?: components["schemas"]["TokenStandard"];
630
- /**
631
- * Notification Type
632
- * @default MINT_COMMENT
633
- * @enum {string}
634
- */
635
- notification_type?: "MINT_COMMENT";
636
- /**
637
- * Timestamp
638
- * Format: date-time
639
- */
640
- timestamp: string;
641
- /** Read */
642
- read: boolean;
643
- /** Minter Address */
644
- minter_address: string;
645
- /** Comment */
646
- comment: string;
647
- metadata?: components["schemas"]["zora__ethereum__models__metadata__Metadata"];
648
- media?: components["schemas"]["zora__media_encoding__media__MediaURI"];
649
- };
650
- /** MintCountResponse */
651
- MintCountResponse: {
652
- chain_name: components["schemas"]["ChainName"];
653
- /** Collection Address */
654
- collection_address: string;
655
- /** Token Id */
656
- token_id?: string;
657
- /** Mint Count */
658
- mint_count: number;
659
- };
660
- /** MintCountsOutput */
661
- MintCountsOutput: {
662
- /** Mint Count Results */
663
- mint_count_results: components["schemas"]["MintCountResponse"][];
664
- };
665
- /** MintNotification */
666
- MintNotification: {
667
- chain_name: components["schemas"]["ChainName"];
668
- /** Collection Address */
669
- collection_address: string;
670
- /** Token Id */
671
- token_id?: string;
672
- token_standard?: components["schemas"]["TokenStandard"];
673
- /**
674
- * Notification Type
675
- * @default MINT
676
- * @enum {string}
677
- */
678
- notification_type?: "MINT";
679
- /**
680
- * Timestamp
681
- * Format: date-time
682
- */
683
- timestamp: string;
684
- /** Read */
685
- read: boolean;
686
- /** Minter Address */
687
- minter_address: string;
688
- /** Value */
689
- value: number;
690
- metadata?: components["schemas"]["zora__ethereum__models__metadata__Metadata"];
691
- media?: components["schemas"]["zora__media_encoding__media__MediaURI"];
692
- };
693
- /** Mintable */
694
- Mintable: {
695
- chain_name: components["schemas"]["ChainName"];
696
- mintable_type: components["schemas"]["MintableType"];
697
- token_standard: components["schemas"]["TokenStandard"];
698
- /** Contract Address */
699
- contract_address: string;
700
- /** Creator Address */
701
- creator_address?: string;
702
- /** Token Creator */
703
- token_creator?: string;
704
- collection: components["schemas"]["Collection"];
705
- /** Token Id */
706
- token_id?: string;
707
- /** Token Name */
708
- token_name?: string;
709
- /** Mint Context */
710
- mint_context?:
711
- | components["schemas"]["ManifoldMintContext"]
712
- | components["schemas"]["ZoraCreateMintContext"]
713
- | components["schemas"]["FoundationMintContext"]
714
- | components["schemas"]["ZoraCreate1155MintContext"]
715
- | components["schemas"]["ZoraCreatePremintContext"]
716
- | components["schemas"]["InferredMintContext"];
717
- /** Is Active */
718
- is_active: boolean;
719
- cost: components["schemas"]["zora__collect__feed__models__price_at_time__PriceAtTime"];
720
- total_mint_volume: components["schemas"]["zora__collect__feed__models__price_at_time__PriceAtTime"];
721
- /** Total Supply */
722
- total_supply?: number;
723
- /** Total Minted */
724
- total_minted: number;
725
- /** Wallet Max */
726
- wallet_max?: number;
727
- /**
728
- * Start Datetime
729
- * Format: date-time
730
- */
731
- start_datetime?: string;
732
- /**
733
- * End Datetime
734
- * Format: date-time
735
- */
736
- end_datetime?: string;
737
- collector_summary: components["schemas"]["CollectorSummary"];
738
- metadata?: components["schemas"]["zora__collect__contract__models__metadata__Metadata"];
739
- status?: components["schemas"]["MintableStatus"];
740
- /** Uuid */
741
- uuid?: string;
742
- };
743
- /**
744
- * MintableSortKey
745
- * @description An enumeration.
746
- * @enum {string}
747
- */
748
- MintableSortKey: "CREATED" | "MINTED";
749
- /**
750
- * MintableStatus
751
- * @description An enumeration.
752
- * @enum {string}
753
- */
754
- MintableStatus:
755
- | "ACTIVE"
756
- | "BLOCKED"
757
- | "EXPIRED"
758
- | "INVALID_MEDIA"
759
- | "MINTED_OUT"
760
- | "DELETED";
761
- /**
762
- * MintableType
763
- * @description An enumeration.
764
- * @enum {string}
765
- */
766
- MintableType:
767
- | "FOUNDATION_DROP_COLLECTION"
768
- | "FOUNDATION_TIMED_EDITION"
769
- | "MANIFOLD_ERC1155"
770
- | "MANIFOLD_ERC721"
771
- | "ZORA_CREATE"
772
- | "ZORA_CREATE_1155"
773
- | "ZORA_CREATE_1155_B2R_REDEEM_TOKEN"
774
- | "ZORA_CREATE_1155_PREMINT_TOKEN"
775
- | "ZORA_EDITION"
776
- | "ZORA_DROP"
777
- | "INFERRED";
778
- /**
779
- * Network
780
- * @description An enumeration.
781
- * @enum {string}
782
- */
783
- Network: "MAINNET" | "GOERLI";
784
- /** Notification */
785
- Notification:
786
- | components["schemas"]["MintNotification"]
787
- | components["schemas"]["MintCommentNotification"];
788
- /**
789
- * NotificationsResponse
790
- * @description This is a generic model for pagination in an infitite scrolling context.
791
- */
792
- NotificationsResponse: {
793
- /** Data */
794
- data: components["schemas"]["Notification"][];
795
- /** Limit */
796
- limit: number;
797
- /** Has More */
798
- has_more: boolean;
799
- cursor: components["schemas"]["Cursor"];
800
- /** Total Unread */
801
- total_unread: number;
802
- };
803
- /**
804
- * Platform
805
- * @description An enumeration.
806
- * @enum {string}
807
- */
808
- Platform: "FOUNDATION" | "ZORA" | "MANIFOLD" | "INFERRED";
809
- /**
810
- * PremintConfig
811
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
812
- * (store_as, override_name), as well as provides other convinience methods.
813
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
814
- * complex type we include on a stored entity.
815
- *
816
- * Example::
817
- * >>> class Foo(ObjectBase):
818
- * ...: found_at_height: int = field(override_name="address", store_as=str)
819
- * ...: other: str = "default"
820
- */
821
- PremintConfig: {
822
- tokenConfig: components["schemas"]["TokenCreationConfig"];
823
- /** Uid */
824
- uid: number;
825
- /** Version */
826
- version: number;
827
- /** Deleted */
828
- deleted: boolean;
829
- };
830
- /**
831
- * Presale
832
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
833
- * (store_as, override_name), as well as provides other convinience methods.
834
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
835
- * complex type we include on a stored entity.
836
- *
837
- * Example::
838
- * >>> class Foo(ObjectBase):
839
- * ...: found_at_height: int = field(override_name="address", store_as=str)
840
- * ...: other: str = "default"
841
- */
842
- Presale: {
843
- /** Token Id */
844
- token_id?: number;
845
- /** Presale Start */
846
- presale_start?: string;
847
- /** Presale End */
848
- presale_end?: string;
849
- /** Merkle Root */
850
- merkle_root?: string;
851
- /** Funds Recipient */
852
- funds_recipient?: string;
853
- };
854
- /** Price */
855
- Price: {
856
- /** Value */
857
- value: string;
858
- };
859
- /**
860
- * Royalties
861
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
862
- * (store_as, override_name), as well as provides other convinience methods.
863
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
864
- * complex type we include on a stored entity.
865
- *
866
- * Example::
867
- * >>> class Foo(ObjectBase):
868
- * ...: found_at_height: int = field(override_name="address", store_as=str)
869
- * ...: other: str = "default"
870
- */
871
- Royalties: {
872
- /** Token Id */
873
- token_id?: number;
874
- /** User */
875
- user?: string;
876
- /** Royalty Bps */
877
- royalty_bps?: string;
878
- /** Royaltyrecipient */
879
- royaltyRecipient?: string;
880
- /** Royalty Mint Schedule */
881
- royalty_mint_schedule?: number;
882
- };
883
- /**
884
- * SaleStrategies
885
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
886
- * (store_as, override_name), as well as provides other convinience methods.
887
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
888
- * complex type we include on a stored entity.
889
- *
890
- * Example::
891
- * >>> class Foo(ObjectBase):
892
- * ...: found_at_height: int = field(override_name="address", store_as=str)
893
- * ...: other: str = "default"
894
- */
895
- SaleStrategies: {
896
- /** Sale Strategies Type */
897
- sale_strategies_type?: string;
898
- fixed_price?: components["schemas"]["FixedPrice"];
899
- presale?: components["schemas"]["Presale"];
900
- /** Redeem Minter */
901
- redeem_minter?: boolean;
902
- };
903
- /** SearchCollection */
904
- SearchCollection: {
905
- /**
906
- * Entity Type
907
- * @default Collection
908
- * @enum {string}
909
- */
910
- entity_type?: "Collection";
911
- chain_name: components["schemas"]["ChainName"];
912
- /** Collection Address */
913
- collection_address: string;
914
- /** Token Id */
915
- token_id?: string;
916
- /** Name */
917
- name?: string;
918
- /** Description */
919
- description?: string;
920
- /** Creator Address */
921
- creator_address?: string;
922
- /** Total Minted */
923
- total_minted?: number;
924
- };
925
- /** SearchResponse */
926
- SearchResponse: {
927
- /** Results */
928
- results: components["schemas"]["SearchResult"][];
929
- /** Total Results */
930
- total_results: number;
931
- /** Blocked Results */
932
- blocked_results: number;
933
- /** Limit */
934
- limit: number;
935
- /** Offset */
936
- offset: number;
937
- /** Has Next Page */
938
- has_next_page: boolean;
939
- /**
940
- * Api Version
941
- * @default 1
942
- */
943
- api_version?: number;
944
- /** Search Id */
945
- search_id: string;
946
- };
947
- /** SearchResult */
948
- SearchResult: {
949
- /** Name */
950
- name?: string;
951
- /** Description */
952
- description?: string;
953
- entity_type: components["schemas"]["EntityType"];
954
- /** Entity */
955
- entity:
956
- | components["schemas"]["SearchCollection"]
957
- | components["schemas"]["SearchToken"];
958
- media?: components["schemas"]["Media"];
959
- /**
960
- * Rank
961
- * @default 0
962
- */
963
- rank?: number;
964
- };
965
- /**
966
- * SearchSortKey
967
- * @description An enumeration.
968
- * @enum {string}
969
- */
970
- SearchSortKey: "CREATED" | "POPULARITY";
971
- /** SearchToken */
972
- SearchToken: {
973
- /**
974
- * Entity Type
975
- * @default Token
976
- * @enum {string}
977
- */
978
- entity_type?: "Token";
979
- chain_name: components["schemas"]["ChainName"];
980
- /** Collection Address */
981
- collection_address: string;
982
- /** Token Id */
983
- token_id: string;
984
- /** Name */
985
- name?: string;
986
- /** Description */
987
- description?: string;
988
- /** Owner */
989
- owner?: string;
990
- };
991
- /**
992
- * SimpleResponse
993
- * @description A simple wrapper for data
994
- */
995
- SimpleResponse: {
996
- data: components["schemas"]["BaseModel"];
997
- };
998
- /**
999
- * SortDirection
1000
- * @description An enumeration.
1001
- * @enum {string}
1002
- */
1003
- SortDirection: "ASC" | "DESC";
1004
- /**
1005
- * TokenCreationConfig
1006
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
1007
- * (store_as, override_name), as well as provides other convinience methods.
1008
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
1009
- * complex type we include on a stored entity.
1010
- *
1011
- * Example::
1012
- * >>> class Foo(ObjectBase):
1013
- * ...: found_at_height: int = field(override_name="address", store_as=str)
1014
- * ...: other: str = "default"
1015
- */
1016
- TokenCreationConfig: {
1017
- /** Tokenuri */
1018
- tokenURI: string;
1019
- /** Maxsupply */
1020
- maxSupply: string;
1021
- /** Maxtokensperaddress */
1022
- maxTokensPerAddress: string;
1023
- /** Pricepertoken */
1024
- pricePerToken: string;
1025
- /** Mintstart */
1026
- mintStart: string;
1027
- /** Mintduration */
1028
- mintDuration: string;
1029
- /** Royaltymintschedule */
1030
- royaltyMintSchedule: number;
1031
- /** Royaltybps */
1032
- royaltyBPS: number;
1033
- /** Royaltyrecipient */
1034
- royaltyRecipient: string;
1035
- /** Fixedpriceminter */
1036
- fixedPriceMinter: string;
1037
- };
1038
- /** TokenMint */
1039
- TokenMint: {
1040
- chain_name: components["schemas"]["ChainName"];
1041
- /** Collection Address */
1042
- collection_address: string;
1043
- /** Token Id */
1044
- token_id?: string;
1045
- token_standard?: components["schemas"]["TokenStandard"];
1046
- /** Originator Address */
1047
- originator_address?: string;
1048
- /** To Address */
1049
- to_address: string;
1050
- fee: components["schemas"]["Price"];
1051
- /** Value */
1052
- value?: number;
1053
- transaction_info: components["schemas"]["TransactionInfo"];
1054
- };
1055
- /** TokenResult */
1056
- TokenResult: {
1057
- chain_name: components["schemas"]["ChainName"];
1058
- /** Collection Address */
1059
- collection_address: string;
1060
- /** Token Id */
1061
- token_id: string;
1062
- token_standard?: components["schemas"]["TokenStandard"];
1063
- /** Owner */
1064
- owner?: string;
1065
- metadata?: components["schemas"]["zora__collect__contract__models__metadata__Metadata"];
1066
- mintable?: components["schemas"]["Mintable"];
1067
- media?: components["schemas"]["Media"];
1068
- };
1069
- /**
1070
- * TokenStandard
1071
- * @description An enumeration.
1072
- * @enum {string}
1073
- */
1074
- TokenStandard: "ERC721" | "ERC1155";
1075
- /** TokensResponse */
1076
- TokensResponse: {
1077
- /** Results */
1078
- results: components["schemas"]["TokenResult"][];
1079
- /** Limit */
1080
- limit: number;
1081
- /** Offset */
1082
- offset: number;
1083
- /** Has Next Page */
1084
- has_next_page: boolean;
1085
- /**
1086
- * Api Version
1087
- * @default 1
1088
- */
1089
- api_version?: number;
1090
- };
1091
- /** Transaction */
1092
- Transaction: {
1093
- /** Chain Name */
1094
- chain_name: string;
1095
- /** Transaction Hash */
1096
- transaction_hash: string;
1097
- /** Block Number */
1098
- block_number: number;
1099
- /** Block Timestamp */
1100
- block_timestamp: string;
1101
- };
1102
- /** TransactionInfo */
1103
- TransactionInfo: {
1104
- /** Block Number */
1105
- block_number: number;
1106
- /**
1107
- * Block Timestamp
1108
- * Format: date-time
1109
- */
1110
- block_timestamp: string;
1111
- /** Transaction Hash */
1112
- transaction_hash: string;
1113
- };
1114
- /** TrendingItem */
1115
- TrendingItem: {
1116
- /** Uuid */
1117
- uuid: string;
1118
- platform: components["schemas"]["Platform"];
1119
- /** Collection Address */
1120
- collection_address: string;
1121
- /** Token Id */
1122
- token_id?: string;
1123
- /** Name */
1124
- name: string;
1125
- /** Token Name */
1126
- token_name?: string;
1127
- /** Num Mints Last Hour */
1128
- num_mints_last_hour: number;
1129
- /**
1130
- * End Datetime
1131
- * Format: date-time
1132
- */
1133
- end_datetime?: string;
1134
- creator: components["schemas"]["Wallet"];
1135
- /** Num Mints */
1136
- num_mints: number;
1137
- /**
1138
- * Num Unique Minters In Window
1139
- * @default 0
1140
- */
1141
- num_unique_minters_in_window?: number;
1142
- /** Total Supply */
1143
- total_supply?: number;
1144
- /** Total Num Unique Collectors */
1145
- total_num_unique_collectors: number;
1146
- cost: components["schemas"]["zora__collect__trending__models__price_at_time__PriceAtTime"];
1147
- /** Latest Mints */
1148
- latest_mints: components["schemas"]["Mint"][];
1149
- /** Rank */
1150
- rank: number;
1151
- /** Trending Duration */
1152
- trending_duration: number;
1153
- chain_name?: components["schemas"]["ChainName"];
1154
- };
1155
- /** TrendingResponse */
1156
- TrendingResponse: {
1157
- /** Trending Items */
1158
- trending_items: components["schemas"]["TrendingItem"][];
1159
- };
1160
- /**
1161
- * TrendingWindow
1162
- * @description An enumeration.
1163
- * @enum {string}
1164
- */
1165
- TrendingWindow: "now" | "1h" | "1d" | "7d";
1166
- /** User */
1167
- User: {
1168
- /** Address */
1169
- address: string;
1170
- /** Total Minted */
1171
- total_minted: number;
1172
- /** Total Created */
1173
- total_created: number;
1174
- /** Total Owned */
1175
- total_owned: number;
1176
- first_transaction?: components["schemas"]["Transaction"];
1177
- ens_record?: components["schemas"]["ENSRecord"];
1178
- };
1179
- /** UserOwnedToken */
1180
- UserOwnedToken: {
1181
- /** Balance */
1182
- balance: number;
1183
- token: components["schemas"]["TokenResult"];
1184
- };
1185
- /** UserTokensResponse */
1186
- UserTokensResponse: {
1187
- /** Results */
1188
- results: components["schemas"]["UserOwnedToken"][];
1189
- /** Limit */
1190
- limit: number;
1191
- /** Offset */
1192
- offset: number;
1193
- /** Has Next Page */
1194
- has_next_page: boolean;
1195
- /**
1196
- * Api Version
1197
- * @default 1
1198
- */
1199
- api_version?: number;
1200
- };
1201
- /** ValidationError */
1202
- ValidationError: {
1203
- /** Location */
1204
- loc: (string | number)[];
1205
- /** Message */
1206
- msg: string;
1207
- /** Error Type */
1208
- type: string;
1209
- };
1210
- /** Wallet */
1211
- Wallet: {
1212
- /** Address */
1213
- address: string;
1214
- /** Ens */
1215
- ens?: string;
1216
- };
1217
- /** ZoraCreate1155MintContext */
1218
- ZoraCreate1155MintContext: {
1219
- /**
1220
- * Mint Context Type
1221
- * @default zora_create_1155
1222
- * @enum {string}
1223
- */
1224
- mint_context_type?: "zora_create_1155";
1225
- /** Renderer Contract */
1226
- renderer_contract?: string;
1227
- /** Permissions */
1228
- permissions: components["schemas"]["ZoraCreatePermissions"][];
1229
- /** Sale Strategies */
1230
- sale_strategies: components["schemas"]["SaleStrategies"][];
1231
- /** Royalties */
1232
- royalties: components["schemas"]["Royalties"][];
1233
- /** Contract Version */
1234
- contract_version: string;
1235
- /** Created At Block */
1236
- created_at_block: number;
1237
- /** Uri */
1238
- uri?: string;
1239
- /** B2R Redeemable */
1240
- b2r_redeemable?: boolean;
1241
- };
1242
- /** ZoraCreateMintContext */
1243
- ZoraCreateMintContext: {
1244
- /**
1245
- * Mint Context Type
1246
- * @default zora_create
1247
- * @enum {string}
1248
- */
1249
- mint_context_type?: "zora_create";
1250
- /** Purchase */
1251
- purchase: string;
1252
- /** Price Per Token */
1253
- price_per_token?: string;
1254
- /** Purchase Presale */
1255
- purchase_presale?: number;
1256
- /** Presale Merkle Root */
1257
- presale_merkle_root?: string;
1258
- /** Max Sale Purchase Per Address */
1259
- max_sale_purchase_per_address?: string;
1260
- /** Contract Version */
1261
- contract_version?: string;
1262
- };
1263
- /**
1264
- * ZoraCreatePermissions
1265
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
1266
- * (store_as, override_name), as well as provides other convinience methods.
1267
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
1268
- * complex type we include on a stored entity.
1269
- *
1270
- * Example::
1271
- * >>> class Foo(ObjectBase):
1272
- * ...: found_at_height: int = field(override_name="address", store_as=str)
1273
- * ...: other: str = "default"
1274
- */
1275
- ZoraCreatePermissions: {
1276
- /** User */
1277
- user?: string;
1278
- /** Token Id */
1279
- token_id?: number;
1280
- /** Is Admin */
1281
- is_admin?: boolean;
1282
- /** Is Minter */
1283
- is_minter?: boolean;
1284
- /** Is Sales Manager */
1285
- is_sales_manager?: boolean;
1286
- /** Is Metadata Manager */
1287
- is_metadata_manager?: boolean;
1288
- /** Is Funds Manager */
1289
- is_funds_manager?: boolean;
1290
- };
1291
- /**
1292
- * ZoraCreatePremintContext
1293
- * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
1294
- * (store_as, override_name), as well as provides other convinience methods.
1295
- * ObjectBase allows for validation and type enforcement, and should be used inheritedfor any
1296
- * complex type we include on a stored entity.
1297
- *
1298
- * Example::
1299
- * >>> class Foo(ObjectBase):
1300
- * ...: found_at_height: int = field(override_name="address", store_as=str)
1301
- * ...: other: str = "default"
1302
- */
1303
- ZoraCreatePremintContext: {
1304
- /**
1305
- * Mint Context Type
1306
- * @default zora_create_premint
1307
- * @enum {string}
1308
- */
1309
- mint_context_type?: "zora_create_premint";
1310
- collection: components["schemas"]["CollectionCreationConfig"];
1311
- premint: components["schemas"]["PremintConfig"];
1312
- chain_name: components["schemas"]["ChainName"];
1313
- /** Signature */
1314
- signature: string;
1315
- };
1316
- /** Metadata */
1317
- zora__collect__contract__models__metadata__Metadata: {
1318
- /** Name */
1319
- name?: string;
1320
- /** Description */
1321
- description?: string;
1322
- /** Attributes */
1323
- attributes: components["schemas"]["MediaAttribute"][];
1324
- };
1325
- /** Currency */
1326
- zora__collect__feed__models__price_at_time__Currency: {
1327
- /** Name */
1328
- name?: string;
1329
- /** Address */
1330
- address: string;
1331
- /**
1332
- * Decimals
1333
- * @default 18
1334
- */
1335
- decimals?: number;
1336
- };
1337
- /** CurrencyAmount */
1338
- zora__collect__feed__models__price_at_time__CurrencyAmount: {
1339
- currency: components["schemas"]["zora__collect__feed__models__price_at_time__Currency"];
1340
- /** Raw */
1341
- raw: string;
1342
- /** Decimal */
1343
- decimal: number;
1344
- };
1345
- /** PriceAtTime */
1346
- zora__collect__feed__models__price_at_time__PriceAtTime: {
1347
- native_price: components["schemas"]["zora__collect__feed__models__price_at_time__CurrencyAmount"];
1348
- /** Block Number */
1349
- block_number: number;
1350
- eth_price?: components["schemas"]["zora__collect__feed__models__price_at_time__CurrencyAmount"];
1351
- usdc_price?: components["schemas"]["zora__collect__feed__models__price_at_time__CurrencyAmount"];
1352
- };
1353
- /** MediaURI */
1354
- zora__collect__trending__models__models__MediaURI: {
1355
- /** Raw */
1356
- raw: string;
1357
- /** Mime Type */
1358
- mime_type?: string;
1359
- /** Encoded Large */
1360
- encoded_large?: string;
1361
- /** Encoded Preview */
1362
- encoded_preview?: string;
1363
- };
1364
- /** Currency */
1365
- zora__collect__trending__models__price_at_time__Currency: {
1366
- /** Name */
1367
- name?: string;
1368
- /** Address */
1369
- address: string;
1370
- /**
1371
- * Decimals
1372
- * @default 18
1373
- */
1374
- decimals?: number;
1375
- };
1376
- /** CurrencyAmount */
1377
- zora__collect__trending__models__price_at_time__CurrencyAmount: {
1378
- currency: components["schemas"]["zora__collect__trending__models__price_at_time__Currency"];
1379
- /** Raw */
1380
- raw: string;
1381
- /** Decimal */
1382
- decimal: number;
1383
- };
1384
- /** PriceAtTime */
1385
- zora__collect__trending__models__price_at_time__PriceAtTime: {
1386
- native_price: components["schemas"]["zora__collect__trending__models__price_at_time__CurrencyAmount"];
1387
- /** Block Number */
1388
- block_number: number;
1389
- eth_price?: components["schemas"]["zora__collect__trending__models__price_at_time__CurrencyAmount"];
1390
- usdc_price?: components["schemas"]["zora__collect__trending__models__price_at_time__CurrencyAmount"];
1391
- };
1392
- /** Metadata */
1393
- zora__ethereum__models__metadata__Metadata: {
1394
- /** Name */
1395
- name: string;
1396
- };
1397
- /** MediaURI */
1398
- zora__media_encoding__media__MediaURI: {
1399
- /** Raw */
1400
- raw: string;
1401
- /** Mime Type */
1402
- mime_type?: string;
1403
- /** Encoded Large */
1404
- encoded_large?: string;
1405
- /** Encoded Preview */
1406
- encoded_preview?: string;
1407
- /** Encoded Thumbnail */
1408
- encoded_thumbnail?: string;
1409
- };
1410
- };
1411
- responses: never;
1412
- parameters: never;
1413
- requestBodies: never;
1414
- headers: never;
1415
- pathItems: never;
1416
- }
1417
-
1418
- export type $defs = Record<string, never>;
1419
-
1420
- export type external = Record<string, never>;
1421
-
1422
- export interface operations {
1423
- /** Root */
1424
- root__get: {
1425
- responses: {
1426
- /** @description Successful Response */
1427
- 200: {
1428
- content: {
1429
- "application/json": unknown;
1430
- };
1431
- };
1432
- };
1433
- };
1434
- /** Get Feed */
1435
- get_feed_feed_get: {
1436
- parameters: {
1437
- query?: {
1438
- offset?: number;
1439
- limit?: number;
1440
- mintable_types?: components["schemas"]["MintableType"][];
1441
- feed_type?: components["schemas"]["FeedType"];
1442
- allow_expired?: boolean;
1443
- chain?: components["schemas"]["Chain"];
1444
- network?: components["schemas"]["Network"];
1445
- };
1446
- cookie?: {
1447
- device_id?: string;
1448
- session_id?: string;
1449
- wallet_address?: string;
1450
- };
1451
- };
1452
- responses: {
1453
- /** @description Successful Response */
1454
- 200: {
1455
- content: {
1456
- "application/json": components["schemas"]["FeedResponse"];
1457
- };
1458
- };
1459
- /** @description Validation Error */
1460
- 422: {
1461
- content: {
1462
- "application/json": components["schemas"]["HTTPValidationError"];
1463
- };
1464
- };
1465
- };
1466
- };
1467
- /** Gen Relevant Mintables */
1468
- gen_relevant_mintables_relevant_mintables__chain_name___collection_address___token_id__get: {
1469
- parameters: {
1470
- path: {
1471
- chain_name: components["schemas"]["ChainName"];
1472
- collection_address: string;
1473
- token_id: string;
1474
- };
1475
- };
1476
- responses: {
1477
- /** @description Successful Response */
1478
- 200: {
1479
- content: {
1480
- "application/json": components["schemas"]["FeedResponse"];
1481
- };
1482
- };
1483
- /** @description Validation Error */
1484
- 422: {
1485
- content: {
1486
- "application/json": components["schemas"]["HTTPValidationError"];
1487
- };
1488
- };
1489
- };
1490
- };
1491
- /** Gen Relevant Mintables */
1492
- gen_relevant_mintables_relevant_mintables__chain_name___collection_address__get: {
1493
- parameters: {
1494
- query?: {
1495
- token_id?: string;
1496
- };
1497
- path: {
1498
- chain_name: components["schemas"]["ChainName"];
1499
- collection_address: string;
1500
- };
1501
- };
1502
- responses: {
1503
- /** @description Successful Response */
1504
- 200: {
1505
- content: {
1506
- "application/json": components["schemas"]["FeedResponse"];
1507
- };
1508
- };
1509
- /** @description Validation Error */
1510
- 422: {
1511
- content: {
1512
- "application/json": components["schemas"]["HTTPValidationError"];
1513
- };
1514
- };
1515
- };
1516
- };
1517
- /** Gen Feed Item Check */
1518
- gen_feed_item_check_feed_item_check__chain_name___collection_address___token_id__get: {
1519
- parameters: {
1520
- path: {
1521
- chain_name: components["schemas"]["ChainName"];
1522
- collection_address: string;
1523
- token_id: string;
1524
- };
1525
- };
1526
- responses: {
1527
- /** @description Successful Response */
1528
- 200: {
1529
- content: {
1530
- "application/json": components["schemas"]["FeedItemCheck"];
1531
- };
1532
- };
1533
- /** @description Validation Error */
1534
- 422: {
1535
- content: {
1536
- "application/json": components["schemas"]["HTTPValidationError"];
1537
- };
1538
- };
1539
- };
1540
- };
1541
- /** Gen Feed Item Check */
1542
- gen_feed_item_check_feed_item_check__chain_name___collection_address__get: {
1543
- parameters: {
1544
- query?: {
1545
- token_id?: string;
1546
- };
1547
- path: {
1548
- chain_name: components["schemas"]["ChainName"];
1549
- collection_address: string;
1550
- };
1551
- };
1552
- responses: {
1553
- /** @description Successful Response */
1554
- 200: {
1555
- content: {
1556
- "application/json": components["schemas"]["FeedItemCheck"];
1557
- };
1558
- };
1559
- /** @description Validation Error */
1560
- 422: {
1561
- content: {
1562
- "application/json": components["schemas"]["HTTPValidationError"];
1563
- };
1564
- };
1565
- };
1566
- };
1567
- /** Gen Mintable */
1568
- gen_mintable_mintables__chain_name___collection_address___token_id__get: {
1569
- parameters: {
1570
- query?: {
1571
- mintable_type?: string;
1572
- };
1573
- path: {
1574
- chain_name: components["schemas"]["ChainName"];
1575
- collection_address: string;
1576
- token_id: string;
1577
- };
1578
- cookie?: {
1579
- device_id?: string;
1580
- session_id?: string;
1581
- wallet_address?: string;
1582
- };
1583
- };
1584
- responses: {
1585
- /** @description Successful Response */
1586
- 200: {
1587
- content: {
1588
- "application/json": components["schemas"]["Mintable"];
1589
- };
1590
- };
1591
- /** @description Validation Error */
1592
- 422: {
1593
- content: {
1594
- "application/json": components["schemas"]["HTTPValidationError"];
1595
- };
1596
- };
1597
- };
1598
- };
1599
- /** Gen Mintable */
1600
- gen_mintable_mintables__chain_name___collection_address__get: {
1601
- parameters: {
1602
- query?: {
1603
- token_id?: string;
1604
- mintable_type?: string;
1605
- };
1606
- path: {
1607
- chain_name: components["schemas"]["ChainName"];
1608
- collection_address: string;
1609
- };
1610
- cookie?: {
1611
- device_id?: string;
1612
- session_id?: string;
1613
- wallet_address?: string;
1614
- };
1615
- };
1616
- responses: {
1617
- /** @description Successful Response */
1618
- 200: {
1619
- content: {
1620
- "application/json": components["schemas"]["Mintable"];
1621
- };
1622
- };
1623
- /** @description Validation Error */
1624
- 422: {
1625
- content: {
1626
- "application/json": components["schemas"]["HTTPValidationError"];
1627
- };
1628
- };
1629
- };
1630
- };
1631
- /** Gen All Mintables */
1632
- gen_all_mintables_premints__chain_name__get: {
1633
- parameters: {
1634
- query?: {
1635
- limit?: number;
1636
- sort_direction?: components["schemas"]["SortDirection"];
1637
- signer?: string;
1638
- cursor?: string;
1639
- };
1640
- path: {
1641
- chain_name: components["schemas"]["ChainName"];
1642
- };
1643
- };
1644
- responses: {
1645
- /** @description Successful Response */
1646
- 200: {
1647
- content: {
1648
- "application/json": components["schemas"]["InfinitePage_Mintable_"];
1649
- };
1650
- };
1651
- /** @description Validation Error */
1652
- 422: {
1653
- content: {
1654
- "application/json": components["schemas"]["HTTPValidationError"];
1655
- };
1656
- };
1657
- };
1658
- };
1659
- /** Gen Mintable V2 */
1660
- gen_mintable_v2_mintables_v2__chain_name___collection_address__get: {
1661
- parameters: {
1662
- query?: {
1663
- token_id?: string;
1664
- };
1665
- path: {
1666
- chain_name: components["schemas"]["ChainName"];
1667
- collection_address: string;
1668
- };
1669
- };
1670
- responses: {
1671
- /** @description Successful Response */
1672
- 200: {
1673
- content: {
1674
- "application/json": components["schemas"]["FeedResult"];
1675
- };
1676
- };
1677
- /** @description Validation Error */
1678
- 422: {
1679
- content: {
1680
- "application/json": components["schemas"]["HTTPValidationError"];
1681
- };
1682
- };
1683
- };
1684
- };
1685
- /** Gen Backfill Contract */
1686
- gen_backfill_contract_contract_backfill_post: {
1687
- parameters: {
1688
- query: {
1689
- chain_name: components["schemas"]["ChainName"];
1690
- collection_address: string;
1691
- };
1692
- };
1693
- responses: {
1694
- /** @description Successful Response */
1695
- 200: {
1696
- content: {
1697
- "application/json": components["schemas"]["ContractBackfillResponse"];
1698
- };
1699
- };
1700
- /** @description Validation Error */
1701
- 422: {
1702
- content: {
1703
- "application/json": components["schemas"]["HTTPValidationError"];
1704
- };
1705
- };
1706
- };
1707
- };
1708
- /** Get Contract */
1709
- get_contract_contract__chain_name___collection_address__get: {
1710
- parameters: {
1711
- query?: {
1712
- token_id?: string;
1713
- };
1714
- path: {
1715
- chain_name: components["schemas"]["ChainName"];
1716
- collection_address: string;
1717
- };
1718
- };
1719
- responses: {
1720
- /** @description Successful Response */
1721
- 200: {
1722
- content: {
1723
- "application/json": components["schemas"]["ContractResult"];
1724
- };
1725
- };
1726
- /** @description Validation Error */
1727
- 422: {
1728
- content: {
1729
- "application/json": components["schemas"]["HTTPValidationError"];
1730
- };
1731
- };
1732
- };
1733
- };
1734
- /** Gen Contract Summaries */
1735
- gen_contract_summaries_contract_summaries_post: {
1736
- requestBody: {
1737
- content: {
1738
- "application/json": components["schemas"]["CollectionTokenId"][];
1739
- };
1740
- };
1741
- responses: {
1742
- /** @description Successful Response */
1743
- 200: {
1744
- content: {
1745
- "application/json": components["schemas"]["ContractSummaryResponse"];
1746
- };
1747
- };
1748
- /** @description Validation Error */
1749
- 422: {
1750
- content: {
1751
- "application/json": components["schemas"]["HTTPValidationError"];
1752
- };
1753
- };
1754
- };
1755
- };
1756
- /**
1757
- * Gen Mint Counts
1758
- * @deprecated
1759
- * @description Use /contract_summaries instead
1760
- */
1761
- gen_mint_counts_mint_counts_post: {
1762
- requestBody: {
1763
- content: {
1764
- "application/json": components["schemas"]["ContractQueryPayload"][];
1765
- };
1766
- };
1767
- responses: {
1768
- /** @description Successful Response */
1769
- 200: {
1770
- content: {
1771
- "application/json": components["schemas"]["MintCountsOutput"];
1772
- };
1773
- };
1774
- /** @description Validation Error */
1775
- 422: {
1776
- content: {
1777
- "application/json": components["schemas"]["HTTPValidationError"];
1778
- };
1779
- };
1780
- };
1781
- };
1782
- /** Gen Contracts */
1783
- gen_contracts_contracts_post: {
1784
- requestBody: {
1785
- content: {
1786
- "application/json": components["schemas"]["ContractQueryPayload"][];
1787
- };
1788
- };
1789
- responses: {
1790
- /** @description Successful Response */
1791
- 200: {
1792
- content: {
1793
- "application/json": components["schemas"]["ContractsQueryOutput"];
1794
- };
1795
- };
1796
- /** @description Validation Error */
1797
- 422: {
1798
- content: {
1799
- "application/json": components["schemas"]["HTTPValidationError"];
1800
- };
1801
- };
1802
- };
1803
- };
1804
- /** Gen Contract Tokens */
1805
- gen_contract_tokens_tokens__chain_name___collection_address__get: {
1806
- parameters: {
1807
- query?: {
1808
- offset?: number;
1809
- limit?: number;
1810
- sort_key?: components["schemas"]["MintableSortKey"];
1811
- sort_direction?: components["schemas"]["SortDirection"];
1812
- };
1813
- path: {
1814
- chain_name: components["schemas"]["ChainName"];
1815
- collection_address: string;
1816
- };
1817
- };
1818
- responses: {
1819
- /** @description Successful Response */
1820
- 200: {
1821
- content: {
1822
- "application/json": components["schemas"]["TokensResponse"];
1823
- };
1824
- };
1825
- /** @description Validation Error */
1826
- 422: {
1827
- content: {
1828
- "application/json": components["schemas"]["HTTPValidationError"];
1829
- };
1830
- };
1831
- };
1832
- };
1833
- /** Get User */
1834
- get_user_user__wallet__get: {
1835
- parameters: {
1836
- query?: {
1837
- chain_names?: components["schemas"]["ChainName"][];
1838
- ens_chain_name?: components["schemas"]["ChainName"];
1839
- chain_name?: components["schemas"]["ChainName"];
1840
- };
1841
- path: {
1842
- wallet: string;
1843
- };
1844
- };
1845
- responses: {
1846
- /** @description Successful Response */
1847
- 200: {
1848
- content: {
1849
- "application/json": components["schemas"]["User"];
1850
- };
1851
- };
1852
- /** @description Validation Error */
1853
- 422: {
1854
- content: {
1855
- "application/json": components["schemas"]["HTTPValidationError"];
1856
- };
1857
- };
1858
- };
1859
- };
1860
- /** Gen User Tokens */
1861
- gen_user_tokens_user__wallet_address__tokens_get: {
1862
- parameters: {
1863
- query?: {
1864
- chain_names?: components["schemas"]["ChainName"][];
1865
- offset?: number;
1866
- limit?: number;
1867
- sort_direction?: components["schemas"]["SortDirection"];
1868
- };
1869
- path: {
1870
- wallet_address: string;
1871
- };
1872
- };
1873
- responses: {
1874
- /** @description Successful Response */
1875
- 200: {
1876
- content: {
1877
- "application/json": components["schemas"]["UserTokensResponse"];
1878
- };
1879
- };
1880
- /** @description Validation Error */
1881
- 422: {
1882
- content: {
1883
- "application/json": components["schemas"]["HTTPValidationError"];
1884
- };
1885
- };
1886
- };
1887
- };
1888
- /** Gen User Contracts */
1889
- gen_user_contracts_user__wallet_address__contracts_get: {
1890
- parameters: {
1891
- query?: {
1892
- chain_names?: components["schemas"]["ChainName"][];
1893
- offset?: number;
1894
- limit?: number;
1895
- sort_direction?: components["schemas"]["SortDirection"];
1896
- };
1897
- path: {
1898
- wallet_address: string;
1899
- };
1900
- };
1901
- responses: {
1902
- /** @description Successful Response */
1903
- 200: {
1904
- content: {
1905
- "application/json": components["schemas"]["ContractsResponse"];
1906
- };
1907
- };
1908
- /** @description Validation Error */
1909
- 422: {
1910
- content: {
1911
- "application/json": components["schemas"]["HTTPValidationError"];
1912
- };
1913
- };
1914
- };
1915
- };
1916
- /** Gen Trending */
1917
- gen_trending_trending_get: {
1918
- parameters: {
1919
- query?: {
1920
- trending_window?: components["schemas"]["TrendingWindow"];
1921
- chain_names?: unknown;
1922
- multichain?: unknown;
1923
- };
1924
- cookie?: {
1925
- wallet_address?: string;
1926
- };
1927
- };
1928
- responses: {
1929
- /** @description Successful Response */
1930
- 200: {
1931
- content: {
1932
- "application/json": components["schemas"]["TrendingResponse"];
1933
- };
1934
- };
1935
- /** @description Validation Error */
1936
- 422: {
1937
- content: {
1938
- "application/json": components["schemas"]["HTTPValidationError"];
1939
- };
1940
- };
1941
- };
1942
- };
1943
- /** Gen Trending Feed */
1944
- gen_trending_feed_trending_feed_get: {
1945
- parameters: {
1946
- query?: {
1947
- trending_window?: components["schemas"]["TrendingWindow"];
1948
- chain_names?: unknown;
1949
- multichain?: unknown;
1950
- };
1951
- };
1952
- responses: {
1953
- /** @description Successful Response */
1954
- 200: {
1955
- content: {
1956
- "application/json": components["schemas"]["FeedResponse"];
1957
- };
1958
- };
1959
- /** @description Validation Error */
1960
- 422: {
1961
- content: {
1962
- "application/json": components["schemas"]["HTTPValidationError"];
1963
- };
1964
- };
1965
- };
1966
- };
1967
- /** Gen Search */
1968
- gen_search_search_get: {
1969
- parameters: {
1970
- query: {
1971
- text: string;
1972
- chain_names?: components["schemas"]["ChainName"][];
1973
- offset?: number;
1974
- limit?: number;
1975
- sort_key?: components["schemas"]["SearchSortKey"];
1976
- };
1977
- cookie?: {
1978
- device_id?: string;
1979
- session_id?: string;
1980
- wallet_address?: string;
1981
- };
1982
- };
1983
- responses: {
1984
- /** @description Successful Response */
1985
- 200: {
1986
- content: {
1987
- "application/json": components["schemas"]["SearchResponse"];
1988
- };
1989
- };
1990
- /** @description Validation Error */
1991
- 422: {
1992
- content: {
1993
- "application/json": components["schemas"]["HTTPValidationError"];
1994
- };
1995
- };
1996
- };
1997
- };
1998
- /** Stream Token Mint */
1999
- stream_token_mint_stream_token_mint__chain_name___collection_address__get: {
2000
- parameters: {
2001
- query?: {
2002
- token_id?: string;
2003
- timeout?: number;
2004
- };
2005
- path: {
2006
- chain_name: components["schemas"]["ChainName"];
2007
- collection_address: string;
2008
- };
2009
- };
2010
- responses: {
2011
- /** @description Successful Response */
2012
- 200: {
2013
- content: {
2014
- "application/json": components["schemas"]["SimpleResponse"];
2015
- };
2016
- };
2017
- /** @description Validation Error */
2018
- 422: {
2019
- content: {
2020
- "application/json": components["schemas"]["HTTPValidationError"];
2021
- };
2022
- };
2023
- };
2024
- };
2025
- /** Gen Token Mints */
2026
- gen_token_mints_token_mints__chain_name___collection_address__get: {
2027
- parameters: {
2028
- query?: {
2029
- token_id?: string;
2030
- limit?: number;
2031
- sort_direction?: components["schemas"]["SortDirection"];
2032
- cursor?: string;
2033
- };
2034
- path: {
2035
- chain_name: components["schemas"]["ChainName"];
2036
- collection_address: string;
2037
- };
2038
- };
2039
- responses: {
2040
- /** @description Successful Response */
2041
- 200: {
2042
- content: {
2043
- "application/json": components["schemas"]["InfinitePageWithTotal_TokenMint_"];
2044
- };
2045
- };
2046
- /** @description Validation Error */
2047
- 422: {
2048
- content: {
2049
- "application/json": components["schemas"]["HTTPValidationError"];
2050
- };
2051
- };
2052
- };
2053
- };
2054
- /** Stream Mint Comment */
2055
- stream_mint_comment_stream_mint_comment__chain_name___collection_address__get: {
2056
- parameters: {
2057
- query?: {
2058
- token_id?: string;
2059
- timeout?: number;
2060
- };
2061
- path: {
2062
- chain_name: components["schemas"]["ChainName"];
2063
- collection_address: string;
2064
- };
2065
- };
2066
- responses: {
2067
- /** @description Successful Response */
2068
- 200: {
2069
- content: {
2070
- "application/json": components["schemas"]["SimpleResponse"];
2071
- };
2072
- };
2073
- /** @description Validation Error */
2074
- 422: {
2075
- content: {
2076
- "application/json": components["schemas"]["HTTPValidationError"];
2077
- };
2078
- };
2079
- };
2080
- };
2081
- /** Gen Mint Comments */
2082
- gen_mint_comments_mint_comments__chain_name___collection_address__get: {
2083
- parameters: {
2084
- query?: {
2085
- token_id?: string;
2086
- limit?: number;
2087
- sort_direction?: components["schemas"]["SortDirection"];
2088
- cursor?: string;
2089
- };
2090
- path: {
2091
- chain_name: components["schemas"]["ChainName"];
2092
- collection_address: string;
2093
- };
2094
- };
2095
- responses: {
2096
- /** @description Successful Response */
2097
- 200: {
2098
- content: {
2099
- "application/json": components["schemas"]["InfinitePageWithTotal_MintComment_"];
2100
- };
2101
- };
2102
- /** @description Validation Error */
2103
- 422: {
2104
- content: {
2105
- "application/json": components["schemas"]["HTTPValidationError"];
2106
- };
2107
- };
2108
- };
2109
- };
2110
- /** Gen Notifications */
2111
- gen_notifications_notifications_get: {
2112
- parameters: {
2113
- query?: {
2114
- chain_names?: components["schemas"]["ChainName"][];
2115
- limit?: number;
2116
- sort_direction?: components["schemas"]["SortDirection"];
2117
- cursor?: string;
2118
- };
2119
- };
2120
- responses: {
2121
- /** @description Successful Response */
2122
- 200: {
2123
- content: {
2124
- "application/json": components["schemas"]["NotificationsResponse"];
2125
- };
2126
- };
2127
- /** @description Validation Error */
2128
- 422: {
2129
- content: {
2130
- "application/json": components["schemas"]["HTTPValidationError"];
2131
- };
2132
- };
2133
- };
2134
- };
2135
- /** Stream Notification */
2136
- stream_notification_stream_notifications_get: {
2137
- parameters: {
2138
- query?: {
2139
- chain_names?: components["schemas"]["ChainName"][];
2140
- timeout?: number;
2141
- };
2142
- };
2143
- responses: {
2144
- /** @description Successful Response */
2145
- 200: {
2146
- content: {
2147
- "application/json": components["schemas"]["SimpleResponse"];
2148
- };
2149
- };
2150
- /** @description Validation Error */
2151
- 422: {
2152
- content: {
2153
- "application/json": components["schemas"]["HTTPValidationError"];
2154
- };
2155
- };
2156
- };
2157
- };
2158
- /** Refresh Blocklist */
2159
- refresh_blocklist_refresh_blocklist_get: {
2160
- responses: {
2161
- /** @description Successful Response */
2162
- 200: {
2163
- content: {
2164
- "application/json": unknown;
2165
- };
2166
- };
2167
- };
2168
- };
2169
- /** Schema */
2170
- schema_schema_get: {
2171
- responses: {
2172
- /** @description Successful Response */
2173
- 200: {
2174
- content: {
2175
- "application/json": unknown;
2176
- };
2177
- };
2178
- };
2179
- };
2180
- }