@opensea/sdk 12.14.0 → 13.0.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 (50) hide show
  1. package/lib/abi/abis.d.ts +0 -30
  2. package/lib/abi/abis.js +1 -29
  3. package/lib/abi/abis.js.map +1 -1
  4. package/lib/api/api.d.ts +12 -5
  5. package/lib/api/api.js +16 -8
  6. package/lib/api/api.js.map +1 -1
  7. package/lib/api/apiPaths.d.ts +2 -0
  8. package/lib/api/apiPaths.js +9 -1
  9. package/lib/api/apiPaths.js.map +1 -1
  10. package/lib/api/listings.d.ts +2 -1
  11. package/lib/api/listings.js +3 -1
  12. package/lib/api/listings.js.map +1 -1
  13. package/lib/api/nfts.d.ts +1 -1
  14. package/lib/api/nfts.js +2 -2
  15. package/lib/api/nfts.js.map +1 -1
  16. package/lib/api/offers.d.ts +8 -4
  17. package/lib/api/offers.js +21 -4
  18. package/lib/api/offers.js.map +1 -1
  19. package/lib/api/signals.d.ts +21 -0
  20. package/lib/api/signals.js +31 -0
  21. package/lib/api/signals.js.map +1 -0
  22. package/lib/api/types.d.ts +28 -1
  23. package/lib/api/types.js.map +1 -1
  24. package/lib/api/walletAuth.d.ts +274 -259
  25. package/lib/api/walletAuth.js +26 -10
  26. package/lib/api/walletAuth.js.map +1 -1
  27. package/lib/auth/oauth.d.ts +3 -1
  28. package/lib/auth/oauth.js +47 -30
  29. package/lib/auth/oauth.js.map +1 -1
  30. package/lib/auth/siwx.d.ts +1 -4
  31. package/lib/sdk/assets.d.ts +6 -5
  32. package/lib/sdk/assets.js +24 -36
  33. package/lib/sdk/assets.js.map +1 -1
  34. package/lib/sdk/base.d.ts +8 -8
  35. package/lib/utils/rateLimit.js +3 -3
  36. package/lib/utils/rateLimit.js.map +1 -1
  37. package/package.json +2 -2
  38. package/src/abi/abis.ts +0 -29
  39. package/src/api/api.ts +25 -4
  40. package/src/api/apiPaths.ts +8 -0
  41. package/src/api/listings.ts +3 -0
  42. package/src/api/nfts.ts +2 -1
  43. package/src/api/offers.ts +33 -13
  44. package/src/api/signals.ts +33 -0
  45. package/src/api/types.ts +36 -0
  46. package/src/api/walletAuth.ts +39 -18
  47. package/src/auth/oauth.ts +86 -53
  48. package/src/auth/siwx.ts +1 -1
  49. package/src/sdk/assets.ts +30 -54
  50. package/src/utils/rateLimit.ts +3 -3
@@ -11,89 +11,89 @@ export declare class WalletAuthAPI {
11
11
  constructor(fetcher: WalletAuthFetcher);
12
12
  getDropEligibility(slug: string): Promise<{
13
13
  stages: {
14
- stageUuid: string;
15
14
  isEligible: boolean;
16
- price?: string | null | undefined;
17
15
  maxTotalMintableByWallet?: string | null | undefined;
18
16
  maxTotalMintableByWalletPerToken?: string | null | undefined;
17
+ price?: string | null | undefined;
18
+ stageUuid: string;
19
19
  }[];
20
20
  }>;
21
21
  getFavorites(address: string, query?: WalletAuthQuery<"get_profile_favorites">): Promise<{
22
+ next?: string | null | undefined;
22
23
  nfts: {
23
- identifier: string;
24
24
  collection: string;
25
25
  contract: string;
26
- tokenStandard: string;
27
- name?: string | null | undefined;
26
+ decimals?: number | null | undefined;
28
27
  description?: string | null | undefined;
29
- imageUrl?: string | null | undefined;
30
- displayImageUrl?: string | null | undefined;
31
28
  displayAnimationUrl?: string | null | undefined;
32
- metadataUrl?: string | null | undefined;
33
- openseaUrl: string;
34
- updatedAt: string;
29
+ displayImageUrl?: string | null | undefined;
30
+ estimatedValueUsd?: number | null | undefined;
31
+ identifier: string;
32
+ imageUrl?: string | null | undefined;
35
33
  isDisabled: boolean;
36
34
  isNsfw: boolean;
37
- originalImageUrl?: string | null | undefined;
35
+ metadataUrl?: string | null | undefined;
36
+ name?: string | null | undefined;
37
+ openseaUrl: string;
38
38
  originalAnimationUrl?: string | null | undefined;
39
+ originalImageUrl?: string | null | undefined;
40
+ tokenStandard: string;
39
41
  traits: {
40
- traitType: string;
41
42
  displayType?: string | null | undefined;
42
43
  maxValue?: string | null | undefined;
44
+ traitType: string;
43
45
  value: unknown;
44
46
  }[];
45
- estimatedValueUsd?: number | null | undefined;
46
- decimals?: number | null | undefined;
47
+ updatedAt: string;
47
48
  }[];
48
- next?: string | null | undefined;
49
49
  }>;
50
50
  getTokenWatchlist(address: string): Promise<{
51
+ next?: string | null | undefined;
51
52
  tokens: {
52
53
  address: string;
53
54
  chain: string;
55
+ createdAt?: number | null | undefined;
56
+ decimals: number;
57
+ genesisDate?: number | null | undefined;
58
+ holdersCount?: number | null | undefined;
59
+ imageUrl?: string | null | undefined;
60
+ isVerified: boolean;
61
+ marketCapUsd?: number | null | undefined;
54
62
  name: string;
63
+ openseaUrl: string;
64
+ priceChange24h?: number | null | undefined;
55
65
  symbol: string;
56
- imageUrl?: string | null | undefined;
57
66
  usdPrice: string;
58
- decimals: number;
59
- openseaUrl: string;
60
- marketCapUsd?: number | null | undefined;
61
67
  volume24h?: number | null | undefined;
62
- priceChange24h?: number | null | undefined;
63
- holdersCount?: number | null | undefined;
64
- isVerified: boolean;
65
- createdAt?: number | null | undefined;
66
- genesisDate?: number | null | undefined;
67
68
  }[];
68
- next?: string | null | undefined;
69
69
  }>;
70
70
  getPerpetualWatchlist(address: string): Promise<{
71
+ next?: string | null | undefined;
71
72
  perpetuals: {
72
- id: string;
73
- name: string;
74
- symbol: string;
75
- imageUrl?: string | null | undefined;
76
- description?: string | null | undefined;
77
- createdAt?: number | null | undefined;
73
+ assetId: string;
74
+ categories: string[];
78
75
  chain: string;
79
76
  contractAddress: string;
80
- maxLeverage: number;
77
+ createdAt?: number | null | undefined;
81
78
  decimals: number;
82
- assetId: string;
83
- version: number;
84
- categories: string[];
79
+ description?: string | null | undefined;
80
+ id: string;
81
+ imageUrl?: string | null | undefined;
85
82
  market?: string | null | undefined;
83
+ maxLeverage: number;
84
+ name: string;
86
85
  stats?: {
87
- priceUsd?: number | null | undefined;
88
- priceChange24h?: number | null | undefined;
89
- volume24h?: number | null | undefined;
90
- markPrice?: number | null | undefined;
91
- oraclePrice?: number | null | undefined;
92
86
  fundingRate?: number | null | undefined;
87
+ markPrice?: number | null | undefined;
93
88
  openInterest?: number | null | undefined;
89
+ oraclePrice?: number | null | undefined;
90
+ priceChange24h?: number | null | undefined;
91
+ priceUsd?: number | null | undefined;
92
+ volume24h?: number | null | undefined;
94
93
  } | null | undefined;
94
+ symbol: string;
95
+ version: number;
95
96
  }[];
96
- next?: string | null | undefined;
97
97
  }>;
98
98
  addWatchlistEntry(body: WalletAuthRequest<"add_watchlist_entry">): Promise<{
99
99
  success: boolean;
@@ -106,46 +106,46 @@ export declare class WalletAuthAPI {
106
106
  isWatching: boolean;
107
107
  }>;
108
108
  getAccountFollowing(addressOrUsername: string, query?: WalletAuthQuery<"get_account_following">): Promise<{
109
+ next?: string | null | undefined;
109
110
  profiles: {
110
111
  address: string;
111
- username?: string | null | undefined;
112
112
  displayName?: string | null | undefined;
113
- profileImageUrl?: string | null | undefined;
114
- isVerified: boolean;
115
113
  followerCount: number;
114
+ isFollowing: boolean;
115
+ isVerified: boolean;
116
+ isWatching: boolean;
116
117
  nftPfp?: {
117
- contractAddress: string;
118
- tokenId: string;
119
118
  chain: string;
120
119
  collectionSlug?: string | null | undefined;
120
+ contractAddress: string;
121
121
  imageUrl: string;
122
122
  isVerified: boolean;
123
+ tokenId: string;
123
124
  } | null | undefined;
124
- isFollowing: boolean;
125
- isWatching: boolean;
125
+ profileImageUrl?: string | null | undefined;
126
+ username?: string | null | undefined;
126
127
  }[];
127
- next?: string | null | undefined;
128
128
  }>;
129
129
  getAccountFollowers(addressOrUsername: string, query?: WalletAuthQuery<"get_account_followers">): Promise<{
130
+ next?: string | null | undefined;
130
131
  profiles: {
131
132
  address: string;
132
- username?: string | null | undefined;
133
133
  displayName?: string | null | undefined;
134
- profileImageUrl?: string | null | undefined;
135
- isVerified: boolean;
136
134
  followerCount: number;
135
+ isFollowing: boolean;
136
+ isVerified: boolean;
137
+ isWatching: boolean;
137
138
  nftPfp?: {
138
- contractAddress: string;
139
- tokenId: string;
140
139
  chain: string;
141
140
  collectionSlug?: string | null | undefined;
141
+ contractAddress: string;
142
142
  imageUrl: string;
143
143
  isVerified: boolean;
144
+ tokenId: string;
144
145
  } | null | undefined;
145
- isFollowing: boolean;
146
- isWatching: boolean;
146
+ profileImageUrl?: string | null | undefined;
147
+ username?: string | null | undefined;
147
148
  }[];
148
- next?: string | null | undefined;
149
149
  }>;
150
150
  followAccount(addressOrUsername: string): Promise<{
151
151
  status: string;
@@ -160,23 +160,37 @@ export declare class WalletAuthAPI {
160
160
  status: string;
161
161
  }>;
162
162
  listSavedTools(query?: WalletAuthQuery<"list_saved_tools">): Promise<{
163
+ next?: string | null | undefined;
163
164
  tools: {
164
165
  id: string;
165
- toolId: string;
166
- registryChain: string;
167
166
  registryAddr: string;
167
+ registryChain: string;
168
+ toolId: string;
168
169
  }[];
169
- next?: string | null | undefined;
170
170
  }>;
171
171
  saveTool(body: WalletAuthRequest<"save_tool">): Promise<{
172
172
  id: string;
173
- toolId: string;
174
- registryChain: string;
175
173
  registryAddr: string;
174
+ registryChain: string;
175
+ toolId: string;
176
176
  }>;
177
177
  removeSavedTool(query: WalletAuthQuery<"unsave_tool">): Promise<{
178
178
  removed: boolean;
179
179
  }>;
180
+ /**
181
+ * Create a signal as the token's account. Needs the `write:posts` scope. Pick the subject as
182
+ * `listSignals` does; `authorAddress` defaults to the wallet the token signed in with. Not
183
+ * idempotent: a retry after an unknown outcome can post twice once the per-subject cooldown,
184
+ * which returns 422, has passed.
185
+ */
186
+ createSignal(body: WalletAuthRequest<"create_signal">): Promise<{
187
+ signalId: string;
188
+ }>;
189
+ /**
190
+ * Delete a signal the token's account owns. Needs the `write:posts` scope. A signal that is
191
+ * missing, already deleted or owned by another account returns 404.
192
+ */
193
+ deleteSignal(signalId: string): Promise<void>;
180
194
  /**
181
195
  * `CancelRequest` carries `offererSignature`, which is camelCase on the wire.
182
196
  * It is optional, so snake-casing it didn't fail the request — it just dropped
@@ -189,11 +203,11 @@ export declare class WalletAuthAPI {
189
203
  success: boolean;
190
204
  }>;
191
205
  savePrerevealDropItem(slug: string, body: WalletAuthRequest<"save_prereveal_drop_item">): Promise<{
192
- name: string;
193
206
  description?: string | null | undefined;
194
207
  imageUrl: string;
195
208
  mediaToken: string;
196
209
  mediaType?: string | null | undefined;
210
+ name: string;
197
211
  }>;
198
212
  /**
199
213
  * The drop's saved items, including a draft's, one page at a time. Only the
@@ -201,54 +215,54 @@ export declare class WalletAuthAPI {
201
215
  */
202
216
  listDropItems(slug: string, query?: WalletAuthQuery<"list_drop_items">): Promise<{
203
217
  items: {
204
- tokenId: string;
205
- name?: string | null | undefined;
206
- description?: string | null | undefined;
207
- imageUrl: string;
218
+ animationUrl?: string | null | undefined;
208
219
  attributes: {
209
220
  traitType: string;
210
221
  value: string;
211
222
  }[];
212
- mediaToken: string;
213
- contractStandard: string;
214
- externalUrl?: string | null | undefined;
215
- animationUrl?: string | null | undefined;
216
223
  chain: string;
217
224
  contractAddress: string;
225
+ contractStandard: string;
226
+ description?: string | null | undefined;
227
+ externalUrl?: string | null | undefined;
228
+ imageUrl: string;
229
+ mediaToken: string;
230
+ name?: string | null | undefined;
231
+ tokenId: string;
218
232
  }[];
219
233
  next?: string | null | undefined;
220
234
  }>;
221
235
  saveSelfMintDropItem(slug: string, body: WalletAuthRequest<"save_self_mint_drop_item">): Promise<{
222
- to: string;
223
- from: string;
224
- data: string;
225
- value: string;
226
236
  chain: string;
237
+ data: string;
238
+ from: string;
239
+ to: string;
227
240
  tokenId: string;
241
+ value: string;
228
242
  }>;
229
243
  updateSelfMintDropItem(slug: string, tokenId: string | number, body: WalletAuthRequest<"update_self_mint_drop_item">): Promise<{
230
- to: string;
231
- from: string;
232
- data: string;
233
- value: string;
234
244
  chain: string;
245
+ data: string;
246
+ from: string;
247
+ to: string;
235
248
  tokenId: string;
249
+ value: string;
236
250
  }>;
237
251
  updateDropItem(slug: string, tokenId: string | number, body: WalletAuthRequest<"update_drop_item">): Promise<{
238
- tokenId: string;
239
- name?: string | null | undefined;
240
- description?: string | null | undefined;
241
- imageUrl: string;
252
+ animationUrl?: string | null | undefined;
242
253
  attributes: {
243
254
  traitType: string;
244
255
  value: string;
245
256
  }[];
246
- mediaToken: string;
247
- contractStandard: string;
248
- externalUrl?: string | null | undefined;
249
- animationUrl?: string | null | undefined;
250
257
  chain: string;
251
258
  contractAddress: string;
259
+ contractStandard: string;
260
+ description?: string | null | undefined;
261
+ externalUrl?: string | null | undefined;
262
+ imageUrl: string;
263
+ mediaToken: string;
264
+ name?: string | null | undefined;
265
+ tokenId: string;
252
266
  }>;
253
267
  /**
254
268
  * `UploadContext.fields` is an opaque signed multipart field map that the
@@ -261,21 +275,13 @@ export declare class WalletAuthAPI {
261
275
  * save them by filename with `saveDropItemMediaBatch`.
262
276
  */
263
277
  createDropItemMediaUpload(slug: string, body: WalletAuthRequest<"upload_drop_item_media">): Promise<{
264
- url: string;
265
- method: "POST" | "PUT";
266
278
  fields: {
267
279
  [key: string]: string;
268
280
  };
281
+ method: "POST" | "PUT";
269
282
  token: string;
283
+ url: string;
270
284
  }[]>;
271
- /**
272
- * @deprecated Use `saveDropItemMediaBatch`, which saves the same items by
273
- * `uploadBatchId` and filename. This save sends every media token back and
274
- * the API checks each file separately, so it slows down with drop size.
275
- */
276
- saveDropItemMedia(slug: string, body: WalletAuthRequest<"save_drop_item_media">): Promise<{
277
- success: boolean;
278
- }>;
279
285
  /**
280
286
  * Save the drop's items from files uploaded with one `uploadBatchId` through
281
287
  * `createDropItemMediaUpload`, naming them by filename (up to 15,000). Each
@@ -293,12 +299,12 @@ export declare class WalletAuthAPI {
293
299
  * `successActionStatus` and the form no longer matches the signed policy.
294
300
  */
295
301
  createDropAllowlistUpload(slug: string): Promise<{
296
- url: string;
297
- method: "POST" | "PUT";
298
302
  fields: {
299
303
  [key: string]: string;
300
304
  };
305
+ method: "POST" | "PUT";
301
306
  token: string;
307
+ url: string;
302
308
  }>;
303
309
  validateDropAllowlist(slug: string, body: WalletAuthRequest<"validate_drop_allowlist">): Promise<{
304
310
  token: string;
@@ -307,16 +313,15 @@ export declare class WalletAuthAPI {
307
313
  * `UploadContext.fields` is an opaque signed multipart field map that the
308
314
  * caller must submit unchanged, so the response is not camelized. Unlike the
309
315
  * other upload contexts, the returned token is not passed to a later call:
310
- * the next `saveDropItemMediaBatch` (or deprecated `saveDropItemMedia`)
311
- * reads the stored manifest.
316
+ * the next `saveDropItemMediaBatch` reads the stored manifest.
312
317
  */
313
318
  createDropCollectionManifestUpload(slug: string): Promise<{
314
- url: string;
315
- method: "POST" | "PUT";
316
319
  fields: {
317
320
  [key: string]: string;
318
321
  };
322
+ method: "POST" | "PUT";
319
323
  token: string;
324
+ url: string;
320
325
  }>;
321
326
  /**
322
327
  * Build the transaction that publishes the drop's saved draft onchain. It
@@ -324,19 +329,19 @@ export declare class WalletAuthAPI {
324
329
  * from any other address it reverts.
325
330
  */
326
331
  buildDropPublishTransaction(slug: string): Promise<{
327
- to: string;
328
- from: string;
332
+ chain: string;
329
333
  data: string;
334
+ from: string;
335
+ to: string;
330
336
  value: string;
331
- chain: string;
332
337
  }>;
333
338
  /** Same sender rule as `buildDropPublishTransaction`. */
334
339
  buildDropUnpublishTransaction(slug: string): Promise<{
335
- to: string;
336
- from: string;
340
+ chain: string;
337
341
  data: string;
342
+ from: string;
343
+ to: string;
338
344
  value: string;
339
- chain: string;
340
345
  }>;
341
346
  /**
342
347
  * Start uploading the drop's item media and metadata to IPFS. Follow it with
@@ -346,10 +351,10 @@ export declare class WalletAuthAPI {
346
351
  workflowExecutionId: string;
347
352
  }>;
348
353
  getDropMetadataIpfsProgress(slug: string, workflowExecutionId: string): Promise<{
349
- status: "failed" | "not_found" | "running" | "completed";
354
+ failureReason?: string | null | undefined;
350
355
  mediaUploadProgress?: number | null | undefined;
351
356
  metadataUploadProgress?: number | null | undefined;
352
- failureReason?: string | null | undefined;
357
+ status: "failed" | "not_found" | "running" | "completed";
353
358
  }>;
354
359
  modifyCollection(slug: string, body: WalletAuthRequest<"modify_collection">): Promise<{
355
360
  success: boolean;
@@ -367,12 +372,12 @@ export declare class WalletAuthAPI {
367
372
  * `successActionStatus` and the form no longer matches the signed policy.
368
373
  */
369
374
  createCollectionImageUpload(slug: string, imageType: string, contentType: WalletAuthQuery<"upload_collection_image">["contentType"]): Promise<{
370
- url: string;
371
- method: "POST" | "PUT";
372
375
  fields: {
373
376
  [key: string]: string;
374
377
  };
378
+ method: "POST" | "PUT";
375
379
  token: string;
380
+ url: string;
376
381
  }>;
377
382
  /**
378
383
  * `placement` is one of hero_desktop, hero_mobile, about_preview,
@@ -381,195 +386,195 @@ export declare class WalletAuthAPI {
381
386
  * `createCollectionImageUpload`.
382
387
  */
383
388
  createCollectionPageMediaUpload(slug: string, placement: string, contentType: WalletAuthQuery<"upload_collection_page_media">["contentType"]): Promise<{
384
- url: string;
385
- method: "POST" | "PUT";
386
389
  fields: {
387
390
  [key: string]: string;
388
391
  };
392
+ method: "POST" | "PUT";
389
393
  token: string;
394
+ url: string;
390
395
  }>;
391
396
  getCollectionMetadata(slug: string): Promise<{
392
- hero?: {
393
- desktopHeroMedia?: {
397
+ about?: {
398
+ previewMedia: {
394
399
  image?: {
395
400
  url: string;
396
401
  } | null | undefined;
397
- video?: {
398
- url: string;
399
- thumbnailUrl?: string | null | undefined;
400
- } | null | undefined;
401
402
  muxVideo?: {
402
403
  playbackId: string;
403
404
  thumbnailUrl?: string | null | undefined;
404
405
  } | null | undefined;
405
- } | null | undefined;
406
- mobileHeroMedia?: {
407
- image?: {
408
- url: string;
409
- } | null | undefined;
410
406
  video?: {
411
- url: string;
412
- thumbnailUrl?: string | null | undefined;
413
- } | null | undefined;
414
- muxVideo?: {
415
- playbackId: string;
416
407
  thumbnailUrl?: string | null | undefined;
417
- } | null | undefined;
418
- } | null | undefined;
419
- } | null | undefined;
420
- about?: {
421
- previewMedia: {
422
- image?: {
423
- url: string;
424
- } | null | undefined;
425
- video?: {
426
408
  url: string;
427
- thumbnailUrl?: string | null | undefined;
428
- } | null | undefined;
429
- muxVideo?: {
430
- playbackId: string;
431
- thumbnailUrl?: string | null | undefined;
432
409
  } | null | undefined;
433
410
  }[];
434
411
  sections: {
435
- id?: string | null | undefined;
436
- title?: string | null | undefined;
437
412
  description?: string | null | undefined;
413
+ id?: string | null | undefined;
438
414
  media: {
439
415
  image?: {
440
416
  url: string;
441
417
  } | null | undefined;
442
- video?: {
443
- url: string;
444
- thumbnailUrl?: string | null | undefined;
445
- } | null | undefined;
446
418
  muxVideo?: {
447
419
  playbackId: string;
448
420
  thumbnailUrl?: string | null | undefined;
449
421
  } | null | undefined;
422
+ video?: {
423
+ thumbnailUrl?: string | null | undefined;
424
+ url: string;
425
+ } | null | undefined;
450
426
  }[];
427
+ title?: string | null | undefined;
451
428
  }[];
452
429
  } | null | undefined;
430
+ hero?: {
431
+ desktopHeroMedia?: {
432
+ image?: {
433
+ url: string;
434
+ } | null | undefined;
435
+ muxVideo?: {
436
+ playbackId: string;
437
+ thumbnailUrl?: string | null | undefined;
438
+ } | null | undefined;
439
+ video?: {
440
+ thumbnailUrl?: string | null | undefined;
441
+ url: string;
442
+ } | null | undefined;
443
+ } | null | undefined;
444
+ mobileHeroMedia?: {
445
+ image?: {
446
+ url: string;
447
+ } | null | undefined;
448
+ muxVideo?: {
449
+ playbackId: string;
450
+ thumbnailUrl?: string | null | undefined;
451
+ } | null | undefined;
452
+ video?: {
453
+ thumbnailUrl?: string | null | undefined;
454
+ url: string;
455
+ } | null | undefined;
456
+ } | null | undefined;
457
+ } | null | undefined;
453
458
  overview?: {
454
459
  modules: {
455
- narrative: {
460
+ contentBlock: {
461
+ description?: string | null | undefined;
456
462
  id?: string | null | undefined;
457
463
  index: number;
464
+ sections: {
465
+ collectionSlug?: string | null | undefined;
466
+ date?: string | null | undefined;
467
+ description?: string | null | undefined;
468
+ externalLink?: {
469
+ href?: string | null | undefined;
470
+ label?: string | null | undefined;
471
+ } | null | undefined;
472
+ id?: string | null | undefined;
473
+ media?: {
474
+ image?: {
475
+ url: string;
476
+ } | null | undefined;
477
+ muxVideo?: {
478
+ playbackId: string;
479
+ thumbnailUrl?: string | null | undefined;
480
+ } | null | undefined;
481
+ video?: {
482
+ thumbnailUrl?: string | null | undefined;
483
+ url: string;
484
+ } | null | undefined;
485
+ } | null | undefined;
486
+ moduleType: string;
487
+ title?: string | null | undefined;
488
+ tokenId?: string | null | undefined;
489
+ }[];
490
+ title?: string | null | undefined;
491
+ }[];
492
+ faq: {
493
+ description?: string | null | undefined;
494
+ hidden?: boolean | null | undefined;
495
+ index: number;
496
+ sections: {
497
+ answer?: string | null | undefined;
498
+ id?: string | null | undefined;
499
+ question?: string | null | undefined;
500
+ }[];
458
501
  title?: string | null | undefined;
502
+ }[];
503
+ narrative: {
459
504
  description?: string | null | undefined;
460
- media: {
505
+ desktopBackgroundMedia?: {
461
506
  image?: {
462
507
  url: string;
463
508
  } | null | undefined;
464
- video?: {
465
- url: string;
466
- thumbnailUrl?: string | null | undefined;
467
- } | null | undefined;
468
509
  muxVideo?: {
469
510
  playbackId: string;
470
511
  thumbnailUrl?: string | null | undefined;
471
512
  } | null | undefined;
472
- }[];
473
- horizontalTextPosition?: string | null | undefined;
474
- verticalTextPosition?: string | null | undefined;
475
- desktopBackgroundMedia?: {
476
- image?: {
513
+ video?: {
514
+ thumbnailUrl?: string | null | undefined;
477
515
  url: string;
478
516
  } | null | undefined;
479
- video?: {
517
+ } | null | undefined;
518
+ horizontalTextPosition?: string | null | undefined;
519
+ id?: string | null | undefined;
520
+ index: number;
521
+ media: {
522
+ image?: {
480
523
  url: string;
481
- thumbnailUrl?: string | null | undefined;
482
524
  } | null | undefined;
483
525
  muxVideo?: {
484
526
  playbackId: string;
485
527
  thumbnailUrl?: string | null | undefined;
486
528
  } | null | undefined;
487
- } | null | undefined;
488
- mobileBackgroundMedia?: {
489
- image?: {
529
+ video?: {
530
+ thumbnailUrl?: string | null | undefined;
490
531
  url: string;
491
532
  } | null | undefined;
492
- video?: {
533
+ }[];
534
+ mobileBackgroundMedia?: {
535
+ image?: {
493
536
  url: string;
494
- thumbnailUrl?: string | null | undefined;
495
537
  } | null | undefined;
496
538
  muxVideo?: {
497
539
  playbackId: string;
498
540
  thumbnailUrl?: string | null | undefined;
499
541
  } | null | undefined;
542
+ video?: {
543
+ thumbnailUrl?: string | null | undefined;
544
+ url: string;
545
+ } | null | undefined;
500
546
  } | null | undefined;
501
- variant?: string | null | undefined;
502
- }[];
503
- contentBlock: {
504
- id?: string | null | undefined;
505
- index: number;
506
547
  title?: string | null | undefined;
507
- description?: string | null | undefined;
508
- sections: {
509
- id?: string | null | undefined;
510
- moduleType: string;
511
- title?: string | null | undefined;
512
- description?: string | null | undefined;
513
- date?: string | null | undefined;
514
- externalLink?: {
515
- href?: string | null | undefined;
516
- label?: string | null | undefined;
517
- } | null | undefined;
518
- media?: {
519
- image?: {
520
- url: string;
521
- } | null | undefined;
522
- video?: {
523
- url: string;
524
- thumbnailUrl?: string | null | undefined;
525
- } | null | undefined;
526
- muxVideo?: {
527
- playbackId: string;
528
- thumbnailUrl?: string | null | undefined;
529
- } | null | undefined;
530
- } | null | undefined;
531
- collectionSlug?: string | null | undefined;
532
- tokenId?: string | null | undefined;
533
- }[];
548
+ variant?: string | null | undefined;
549
+ verticalTextPosition?: string | null | undefined;
534
550
  }[];
535
551
  team: {
536
- index: number;
537
- hidden?: boolean | null | undefined;
538
- title?: string | null | undefined;
539
552
  description?: string | null | undefined;
553
+ hidden?: boolean | null | undefined;
554
+ index: number;
540
555
  sections: {
541
- id?: string | null | undefined;
542
- name?: string | null | undefined;
543
- title?: string | null | undefined;
544
556
  bio?: string | null | undefined;
545
- websiteUrl?: string | null | undefined;
546
- twitterUrl?: string | null | undefined;
557
+ id?: string | null | undefined;
547
558
  instagramUrl?: string | null | undefined;
548
559
  media: {
549
560
  image?: {
550
561
  url: string;
551
562
  } | null | undefined;
552
- video?: {
553
- url: string;
554
- thumbnailUrl?: string | null | undefined;
555
- } | null | undefined;
556
563
  muxVideo?: {
557
564
  playbackId: string;
558
565
  thumbnailUrl?: string | null | undefined;
559
566
  } | null | undefined;
567
+ video?: {
568
+ thumbnailUrl?: string | null | undefined;
569
+ url: string;
570
+ } | null | undefined;
560
571
  }[];
572
+ name?: string | null | undefined;
573
+ title?: string | null | undefined;
574
+ twitterUrl?: string | null | undefined;
575
+ websiteUrl?: string | null | undefined;
561
576
  }[];
562
- }[];
563
- faq: {
564
- index: number;
565
- hidden?: boolean | null | undefined;
566
577
  title?: string | null | undefined;
567
- description?: string | null | undefined;
568
- sections: {
569
- id?: string | null | undefined;
570
- question?: string | null | undefined;
571
- answer?: string | null | undefined;
572
- }[];
573
578
  }[];
574
579
  };
575
580
  } | null | undefined;
@@ -585,11 +590,11 @@ export declare class WalletAuthAPI {
585
590
  */
586
591
  buildCreatorFeeEnforcementTransactions(slug: string, body: WalletAuthRequest<"build_creator_fee_enforcement_transactions">): Promise<{
587
592
  transactions: {
588
- to: string;
589
- from: string;
593
+ chain: string;
590
594
  data: string;
595
+ from: string;
596
+ to: string;
591
597
  value: string;
592
- chain: string;
593
598
  }[];
594
599
  }>;
595
600
  refreshCollectionMetadata(slug: string): Promise<{
@@ -603,8 +608,8 @@ export declare class WalletAuthAPI {
603
608
  * so the loss is invisible to the caller.
604
609
  */
605
610
  updateProfileSettings(body: WalletAuthRequest<"update_profile_settings">): Promise<{
606
- displayName?: string | null | undefined;
607
611
  bio?: string | null | undefined;
612
+ displayName?: string | null | undefined;
608
613
  externalUrl?: string | null | undefined;
609
614
  }>;
610
615
  claimProfileUsername(body: WalletAuthRequest<"claim_profile_username">): Promise<{
@@ -617,12 +622,12 @@ export declare class WalletAuthAPI {
617
622
  * camelized either, for the `UploadContext.fields` reason above.
618
623
  */
619
624
  createProfileImageUpload(body: WalletAuthRequest<"upload_profile_image">): Promise<{
620
- url: string;
621
- method: "POST" | "PUT";
622
625
  fields: {
623
626
  [key: string]: string;
624
627
  };
628
+ method: "POST" | "PUT";
625
629
  token: string;
630
+ url: string;
626
631
  }>;
627
632
  /**
628
633
  * `SetNftPfpRequest` is camelCase on the wire (`contractAddress`, `tokenId`,
@@ -630,12 +635,12 @@ export declare class WalletAuthAPI {
630
635
  * made this call fail validation every time. Sent verbatim.
631
636
  */
632
637
  setProfileNftPfp(body: WalletAuthRequest<"set_profile_nft_pfp">): Promise<{
633
- contractAddress: string;
634
- tokenId: string;
635
638
  chain: string;
636
639
  collectionSlug?: string | null | undefined;
640
+ contractAddress: string;
637
641
  imageUrl: string;
638
642
  isVerified: boolean;
643
+ tokenId: string;
639
644
  }>;
640
645
  clearProfileNftPfp(): Promise<{
641
646
  success: boolean;
@@ -645,71 +650,81 @@ export declare class WalletAuthAPI {
645
650
  * when one is configured.
646
651
  */
647
652
  getProfileShelves(address: string): Promise<{
648
- id: string;
649
653
  accountAddress?: string | null | undefined;
650
- title: string;
651
654
  description?: string | null | undefined;
652
655
  displayOrder: number;
656
+ icon?: string | null | undefined;
657
+ id: string;
653
658
  items: {
654
659
  chain: string;
655
660
  contractAddress: string;
656
661
  tokenId: string;
657
662
  }[];
658
- icon?: string | null | undefined;
659
- view?: string | null | undefined;
660
- singleItemShelfSide?: string | null | undefined;
661
663
  shelfItemMetadata: {
662
664
  [x: string]: {
663
665
  description?: string | null | undefined;
664
666
  };
665
667
  };
668
+ singleItemShelfSide?: string | null | undefined;
669
+ title: string;
670
+ view?: string | null | undefined;
666
671
  }[]>;
667
672
  createProfileShelf(body: WalletAuthRequest<"create_profile_shelf">): Promise<{
668
- id: string;
669
673
  accountAddress?: string | null | undefined;
670
- title: string;
671
674
  description?: string | null | undefined;
672
675
  displayOrder: number;
676
+ icon?: string | null | undefined;
677
+ id: string;
673
678
  items: {
674
679
  chain: string;
675
680
  contractAddress: string;
676
681
  tokenId: string;
677
682
  }[];
678
- icon?: string | null | undefined;
679
- view?: string | null | undefined;
680
- singleItemShelfSide?: string | null | undefined;
681
683
  shelfItemMetadata: {
682
684
  [x: string]: {
683
685
  description?: string | null | undefined;
684
686
  };
685
687
  };
688
+ singleItemShelfSide?: string | null | undefined;
689
+ title: string;
690
+ view?: string | null | undefined;
686
691
  }>;
687
692
  reorderProfileShelves(body: WalletAuthRequest<"reorder_profile_shelves">): Promise<{
688
693
  success: boolean;
689
694
  }>;
690
695
  updateProfileShelf(shelfId: string, body: WalletAuthRequest<"update_profile_shelf">): Promise<{
691
- id: string;
692
696
  accountAddress?: string | null | undefined;
693
- title: string;
694
697
  description?: string | null | undefined;
695
698
  displayOrder: number;
699
+ icon?: string | null | undefined;
700
+ id: string;
696
701
  items: {
697
702
  chain: string;
698
703
  contractAddress: string;
699
704
  tokenId: string;
700
705
  }[];
701
- icon?: string | null | undefined;
702
- view?: string | null | undefined;
703
- singleItemShelfSide?: string | null | undefined;
704
706
  shelfItemMetadata: {
705
707
  [x: string]: {
706
708
  description?: string | null | undefined;
707
709
  };
708
710
  };
711
+ singleItemShelfSide?: string | null | undefined;
712
+ title: string;
713
+ view?: string | null | undefined;
709
714
  }>;
710
715
  deleteProfileShelf(shelfId: string): Promise<{
711
716
  success: boolean;
712
717
  }>;
718
+ /**
719
+ * Issue a single-use nonce for linking a wallet to the authenticated account,
720
+ * with the statement to sign. Build the SIWX message with both verbatim and
721
+ * submit it to `linkWallet` within 10 minutes; the nonce only works for this
722
+ * account.
723
+ */
724
+ getWalletLinkNonce(): Promise<{
725
+ nonce: string;
726
+ statement: string;
727
+ }>;
713
728
  /**
714
729
  * `LinkWalletSiwxRequest` is camelCase on the wire. `chainArch` is required, so
715
730
  * snake-casing it made every call fail validation, and the nested SIWX `message`
@@ -739,16 +754,16 @@ export declare class WalletAuthAPI {
739
754
  * distinguishable from a real change.
740
755
  */
741
756
  declareAgentAccount(): Promise<{
742
- isAgent: boolean;
743
757
  changed: boolean;
758
+ isAgent: boolean;
744
759
  }>;
745
760
  /**
746
761
  * Withdraw the authenticated account's agent declaration. Requires
747
762
  * `write:wallets`.
748
763
  */
749
764
  withdrawAgentAccountDeclaration(): Promise<{
750
- isAgent: boolean;
751
765
  changed: boolean;
766
+ isAgent: boolean;
752
767
  }>;
753
768
  /**
754
769
  * Propose an agent ownership relationship. Requires `write:wallets`.
@@ -761,30 +776,30 @@ export declare class WalletAuthAPI {
761
776
  * client that cannot tell who moved first can just propose.
762
777
  */
763
778
  proposeAgentRelationship(body: WalletAuthRequest<"propose_agent_relationship">): Promise<{
779
+ created: boolean;
764
780
  relation: {
765
781
  agentAccountId: string;
766
- ownerAccountId: string;
767
- status: string;
768
782
  awaitingConfirmationFrom?: string | null | undefined;
769
- createdAt: number;
770
783
  confirmedAt?: number | null | undefined;
784
+ createdAt: number;
785
+ ownerAccountId: string;
786
+ status: string;
771
787
  };
772
- created: boolean;
773
788
  }>;
774
789
  /**
775
790
  * Confirm a relationship proposed to the authenticated account. Requires
776
791
  * `write:wallets`. An agent ends up with at most one confirmed owner.
777
792
  */
778
793
  confirmAgentRelationship(body: WalletAuthRequest<"confirm_agent_relationship">): Promise<{
794
+ created: boolean;
779
795
  relation: {
780
796
  agentAccountId: string;
781
- ownerAccountId: string;
782
- status: string;
783
797
  awaitingConfirmationFrom?: string | null | undefined;
784
- createdAt: number;
785
798
  confirmedAt?: number | null | undefined;
799
+ createdAt: number;
800
+ ownerAccountId: string;
801
+ status: string;
786
802
  };
787
- created: boolean;
788
803
  }>;
789
804
  /**
790
805
  * Withdraw a proposal or revoke a confirmed relationship. Requires
@@ -810,11 +825,11 @@ export declare class WalletAuthAPI {
810
825
  listOwnAgentRelationships(): Promise<{
811
826
  relationships: {
812
827
  agentAccountId: string;
813
- ownerAccountId: string;
814
- status: string;
815
828
  awaitingConfirmationFrom?: string | null | undefined;
816
- createdAt: number;
817
829
  confirmedAt?: number | null | undefined;
830
+ createdAt: number;
831
+ ownerAccountId: string;
832
+ status: string;
818
833
  }[];
819
834
  }>;
820
835
  }