@imtbl/sdk 0.35.7 → 0.36.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.
package/dist/index.d.ts CHANGED
@@ -135,6 +135,41 @@ declare class Configuration$1 {
135
135
  isJsonMime(mime: string): boolean;
136
136
  }
137
137
 
138
+ /**
139
+ * Immutable zkEVM API
140
+ * Immutable Multi Rollup API
141
+ *
142
+ * The version of the OpenAPI document: 1.0.0
143
+ * Contact: support@immutable.com
144
+ *
145
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
146
+ * https://openapi-generator.tech
147
+ * Do not edit the class manually.
148
+ */
149
+ /**
150
+ *
151
+ * @export
152
+ * @interface APIError400AllOf
153
+ */
154
+ interface APIError400AllOf {
155
+ /**
156
+ * Error Code
157
+ * @type {string}
158
+ * @memberof APIError400AllOf
159
+ */
160
+ 'code': APIError400AllOfCodeEnum;
161
+ /**
162
+ * Additional details to help resolve the error
163
+ * @type {object}
164
+ * @memberof APIError400AllOf
165
+ */
166
+ 'details': object | null;
167
+ }
168
+ declare const APIError400AllOfCodeEnum: {
169
+ readonly ValidationError: "VALIDATION_ERROR";
170
+ };
171
+ type APIError400AllOfCodeEnum = typeof APIError400AllOfCodeEnum[keyof typeof APIError400AllOfCodeEnum];
172
+
138
173
  /**
139
174
  * Immutable zkEVM API
140
175
  * Immutable Multi Rollup API
@@ -188,7 +223,42 @@ interface BasicAPIError {
188
223
  * @type APIError400
189
224
  * @export
190
225
  */
191
- type APIError400 = BasicAPIError;
226
+ type APIError400 = APIError400AllOf & BasicAPIError;
227
+
228
+ /**
229
+ * Immutable zkEVM API
230
+ * Immutable Multi Rollup API
231
+ *
232
+ * The version of the OpenAPI document: 1.0.0
233
+ * Contact: support@immutable.com
234
+ *
235
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
236
+ * https://openapi-generator.tech
237
+ * Do not edit the class manually.
238
+ */
239
+ /**
240
+ *
241
+ * @export
242
+ * @interface APIError401AllOf
243
+ */
244
+ interface APIError401AllOf {
245
+ /**
246
+ * Error Code
247
+ * @type {string}
248
+ * @memberof APIError401AllOf
249
+ */
250
+ 'code': APIError401AllOfCodeEnum;
251
+ /**
252
+ * Additional details to help resolve the error
253
+ * @type {object}
254
+ * @memberof APIError401AllOf
255
+ */
256
+ 'details': object | null;
257
+ }
258
+ declare const APIError401AllOfCodeEnum: {
259
+ readonly UnauthorisedRequest: "UNAUTHORISED_REQUEST";
260
+ };
261
+ type APIError401AllOfCodeEnum = typeof APIError401AllOfCodeEnum[keyof typeof APIError401AllOfCodeEnum];
192
262
 
193
263
  /**
194
264
  * Immutable zkEVM API
@@ -206,7 +276,42 @@ type APIError400 = BasicAPIError;
206
276
  * @type APIError401
207
277
  * @export
208
278
  */
209
- type APIError401 = BasicAPIError;
279
+ type APIError401 = APIError401AllOf & BasicAPIError;
280
+
281
+ /**
282
+ * Immutable zkEVM API
283
+ * Immutable Multi Rollup API
284
+ *
285
+ * The version of the OpenAPI document: 1.0.0
286
+ * Contact: support@immutable.com
287
+ *
288
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
289
+ * https://openapi-generator.tech
290
+ * Do not edit the class manually.
291
+ */
292
+ /**
293
+ *
294
+ * @export
295
+ * @interface APIError403AllOf
296
+ */
297
+ interface APIError403AllOf {
298
+ /**
299
+ * Error Code
300
+ * @type {string}
301
+ * @memberof APIError403AllOf
302
+ */
303
+ 'code': APIError403AllOfCodeEnum;
304
+ /**
305
+ * Additional details to help resolve the error
306
+ * @type {object}
307
+ * @memberof APIError403AllOf
308
+ */
309
+ 'details': object | null;
310
+ }
311
+ declare const APIError403AllOfCodeEnum: {
312
+ readonly AuthenticationError: "AUTHENTICATION_ERROR";
313
+ };
314
+ type APIError403AllOfCodeEnum = typeof APIError403AllOfCodeEnum[keyof typeof APIError403AllOfCodeEnum];
210
315
 
211
316
  /**
212
317
  * Immutable zkEVM API
@@ -224,7 +329,42 @@ type APIError401 = BasicAPIError;
224
329
  * @type APIError403
225
330
  * @export
226
331
  */
227
- type APIError403 = BasicAPIError;
332
+ type APIError403 = APIError403AllOf & BasicAPIError;
333
+
334
+ /**
335
+ * Immutable zkEVM API
336
+ * Immutable Multi Rollup API
337
+ *
338
+ * The version of the OpenAPI document: 1.0.0
339
+ * Contact: support@immutable.com
340
+ *
341
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
342
+ * https://openapi-generator.tech
343
+ * Do not edit the class manually.
344
+ */
345
+ /**
346
+ *
347
+ * @export
348
+ * @interface APIError404AllOf
349
+ */
350
+ interface APIError404AllOf {
351
+ /**
352
+ * Error Code
353
+ * @type {string}
354
+ * @memberof APIError404AllOf
355
+ */
356
+ 'code': APIError404AllOfCodeEnum;
357
+ /**
358
+ * Additional details to help resolve the error
359
+ * @type {object}
360
+ * @memberof APIError404AllOf
361
+ */
362
+ 'details': object | null;
363
+ }
364
+ declare const APIError404AllOfCodeEnum: {
365
+ readonly ResourceNotFound: "RESOURCE_NOT_FOUND";
366
+ };
367
+ type APIError404AllOfCodeEnum = typeof APIError404AllOfCodeEnum[keyof typeof APIError404AllOfCodeEnum];
228
368
 
229
369
  /**
230
370
  * Immutable zkEVM API
@@ -242,7 +382,42 @@ type APIError403 = BasicAPIError;
242
382
  * @type APIError404
243
383
  * @export
244
384
  */
245
- type APIError404 = BasicAPIError;
385
+ type APIError404 = APIError404AllOf & BasicAPIError;
386
+
387
+ /**
388
+ * Immutable zkEVM API
389
+ * Immutable Multi Rollup API
390
+ *
391
+ * The version of the OpenAPI document: 1.0.0
392
+ * Contact: support@immutable.com
393
+ *
394
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
395
+ * https://openapi-generator.tech
396
+ * Do not edit the class manually.
397
+ */
398
+ /**
399
+ *
400
+ * @export
401
+ * @interface APIError429AllOf
402
+ */
403
+ interface APIError429AllOf {
404
+ /**
405
+ * Error Code
406
+ * @type {string}
407
+ * @memberof APIError429AllOf
408
+ */
409
+ 'code': APIError429AllOfCodeEnum;
410
+ /**
411
+ * Additional details to help resolve the error
412
+ * @type {object}
413
+ * @memberof APIError429AllOf
414
+ */
415
+ 'details': object | null;
416
+ }
417
+ declare const APIError429AllOfCodeEnum: {
418
+ readonly TooManyRequestsError: "TOO_MANY_REQUESTS_ERROR";
419
+ };
420
+ type APIError429AllOfCodeEnum = typeof APIError429AllOfCodeEnum[keyof typeof APIError429AllOfCodeEnum];
246
421
 
247
422
  /**
248
423
  * Immutable zkEVM API
@@ -260,7 +435,42 @@ type APIError404 = BasicAPIError;
260
435
  * @type APIError429
261
436
  * @export
262
437
  */
263
- type APIError429 = BasicAPIError;
438
+ type APIError429 = APIError429AllOf & BasicAPIError;
439
+
440
+ /**
441
+ * Immutable zkEVM API
442
+ * Immutable Multi Rollup API
443
+ *
444
+ * The version of the OpenAPI document: 1.0.0
445
+ * Contact: support@immutable.com
446
+ *
447
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
448
+ * https://openapi-generator.tech
449
+ * Do not edit the class manually.
450
+ */
451
+ /**
452
+ *
453
+ * @export
454
+ * @interface APIError500AllOf
455
+ */
456
+ interface APIError500AllOf {
457
+ /**
458
+ * Error Code
459
+ * @type {string}
460
+ * @memberof APIError500AllOf
461
+ */
462
+ 'code': APIError500AllOfCodeEnum;
463
+ /**
464
+ * Additional details to help resolve the error
465
+ * @type {object}
466
+ * @memberof APIError500AllOf
467
+ */
468
+ 'details': object | null;
469
+ }
470
+ declare const APIError500AllOfCodeEnum: {
471
+ readonly InternalServerError: "INTERNAL_SERVER_ERROR";
472
+ };
473
+ type APIError500AllOfCodeEnum = typeof APIError500AllOfCodeEnum[keyof typeof APIError500AllOfCodeEnum];
264
474
 
265
475
  /**
266
476
  * Immutable zkEVM API
@@ -278,7 +488,7 @@ type APIError429 = BasicAPIError;
278
488
  * @type APIError500
279
489
  * @export
280
490
  */
281
- type APIError500 = BasicAPIError;
491
+ type APIError500 = APIError500AllOf & BasicAPIError;
282
492
 
283
493
  /**
284
494
  * Immutable zkEVM API
@@ -947,6 +1157,12 @@ interface Activity {
947
1157
  * @memberof Activity
948
1158
  */
949
1159
  'details': ActivityDetails;
1160
+ /**
1161
+ * The time activity was updated at
1162
+ * @type {string}
1163
+ * @memberof Activity
1164
+ */
1165
+ 'updated_at': string;
950
1166
  /**
951
1167
  * The time activity was indexed
952
1168
  * @type {string}
@@ -961,6 +1177,31 @@ interface Activity {
961
1177
  'blockchain_metadata': BlockchainMetadata | null;
962
1178
  }
963
1179
 
1180
+ /**
1181
+ * Immutable zkEVM API
1182
+ * Immutable Multi Rollup API
1183
+ *
1184
+ * The version of the OpenAPI document: 1.0.0
1185
+ * Contact: support@immutable.com
1186
+ *
1187
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1188
+ * https://openapi-generator.tech
1189
+ * Do not edit the class manually.
1190
+ */
1191
+ /**
1192
+ *
1193
+ * @export
1194
+ * @interface ChainWithDetailsAllOf
1195
+ */
1196
+ interface ChainWithDetailsAllOf {
1197
+ /**
1198
+ * URL for RPC node
1199
+ * @type {string}
1200
+ * @memberof ChainWithDetailsAllOf
1201
+ */
1202
+ 'rpc_url': string | null;
1203
+ }
1204
+
964
1205
  /**
965
1206
  * Immutable zkEVM API
966
1207
  * Immutable Multi Rollup API
@@ -977,7 +1218,7 @@ interface Activity {
977
1218
  * @type ChainWithDetails
978
1219
  * @export
979
1220
  */
980
- type ChainWithDetails = Chain$1;
1221
+ type ChainWithDetails = Chain$1 & ChainWithDetailsAllOf;
981
1222
 
982
1223
  /**
983
1224
  * Immutable zkEVM API
@@ -997,6 +1238,7 @@ type ChainWithDetails = Chain$1;
997
1238
  */
998
1239
  declare const CollectionContractType: {
999
1240
  readonly Erc721: "ERC721";
1241
+ readonly Erc1155: "ERC1155";
1000
1242
  };
1001
1243
  type CollectionContractType = typeof CollectionContractType[keyof typeof CollectionContractType];
1002
1244
 
@@ -1475,12 +1717,6 @@ interface NFT {
1475
1717
  * @memberof NFT
1476
1718
  */
1477
1719
  'youtube_url': string | null;
1478
- /**
1479
- * The id of mint activity of this NFT
1480
- * @type {string}
1481
- * @memberof NFT
1482
- */
1483
- 'mint_activity_id': string | null;
1484
1720
  }
1485
1721
 
1486
1722
  /**
@@ -1983,6 +2219,148 @@ interface ListNFTOwnersResult {
1983
2219
  'page': Page$2;
1984
2220
  }
1985
2221
 
2222
+ /**
2223
+ * Immutable zkEVM API
2224
+ * Immutable Multi Rollup API
2225
+ *
2226
+ * The version of the OpenAPI document: 1.0.0
2227
+ * Contact: support@immutable.com
2228
+ *
2229
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2230
+ * https://openapi-generator.tech
2231
+ * Do not edit the class manually.
2232
+ */
2233
+
2234
+ /**
2235
+ *
2236
+ * @export
2237
+ * @interface NFTWithBalance
2238
+ */
2239
+ interface NFTWithBalance {
2240
+ /**
2241
+ *
2242
+ * @type {Chain}
2243
+ * @memberof NFTWithBalance
2244
+ */
2245
+ 'chain': Chain$1;
2246
+ /**
2247
+ * An `uint256` token id as string
2248
+ * @type {string}
2249
+ * @memberof NFTWithBalance
2250
+ */
2251
+ 'token_id': string;
2252
+ /**
2253
+ * The contract address of the NFT
2254
+ * @type {string}
2255
+ * @memberof NFTWithBalance
2256
+ */
2257
+ 'contract_address': string;
2258
+ /**
2259
+ * The contract type of the NFT
2260
+ * @type {string}
2261
+ * @memberof NFTWithBalance
2262
+ */
2263
+ 'contract_type': string;
2264
+ /**
2265
+ * When the NFT was first indexed
2266
+ * @type {string}
2267
+ * @memberof NFTWithBalance
2268
+ */
2269
+ 'indexed_at': string;
2270
+ /**
2271
+ * When the NFT owner was last updated
2272
+ * @type {string}
2273
+ * @memberof NFTWithBalance
2274
+ */
2275
+ 'updated_at': string;
2276
+ /**
2277
+ * When NFT metadata was last synced
2278
+ * @type {string}
2279
+ * @memberof NFTWithBalance
2280
+ */
2281
+ 'metadata_synced_at': string | null;
2282
+ /**
2283
+ * The id of the metadata of this NFT
2284
+ * @type {string}
2285
+ * @memberof NFTWithBalance
2286
+ */
2287
+ 'metadata_id'?: string | null;
2288
+ /**
2289
+ * The name of the NFT
2290
+ * @type {string}
2291
+ * @memberof NFTWithBalance
2292
+ */
2293
+ 'name': string | null;
2294
+ /**
2295
+ * The description of the NFT
2296
+ * @type {string}
2297
+ * @memberof NFTWithBalance
2298
+ */
2299
+ 'description': string | null;
2300
+ /**
2301
+ * The image url of the NFT
2302
+ * @type {string}
2303
+ * @memberof NFTWithBalance
2304
+ */
2305
+ 'image': string | null;
2306
+ /**
2307
+ * The external website link of NFT
2308
+ * @type {string}
2309
+ * @memberof NFTWithBalance
2310
+ */
2311
+ 'external_link': string | null;
2312
+ /**
2313
+ * The animation url of the NFT
2314
+ * @type {string}
2315
+ * @memberof NFTWithBalance
2316
+ */
2317
+ 'animation_url': string | null;
2318
+ /**
2319
+ * The youtube URL of NFT
2320
+ * @type {string}
2321
+ * @memberof NFTWithBalance
2322
+ */
2323
+ 'youtube_url': string | null;
2324
+ /**
2325
+ * The balance of NFT in the account
2326
+ * @type {string}
2327
+ * @memberof NFTWithBalance
2328
+ */
2329
+ 'balance': string;
2330
+ }
2331
+
2332
+ /**
2333
+ * Immutable zkEVM API
2334
+ * Immutable Multi Rollup API
2335
+ *
2336
+ * The version of the OpenAPI document: 1.0.0
2337
+ * Contact: support@immutable.com
2338
+ *
2339
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2340
+ * https://openapi-generator.tech
2341
+ * Do not edit the class manually.
2342
+ */
2343
+
2344
+ /**
2345
+ *
2346
+ * @export
2347
+ * @interface ListNFTsByOwnerResult
2348
+ */
2349
+ interface ListNFTsByOwnerResult {
2350
+ /**
2351
+ * List of nfts by owner
2352
+ * @type {Array<NFTWithBalance>}
2353
+ * @memberof ListNFTsByOwnerResult
2354
+ */
2355
+ 'result': Array<NFTWithBalance>;
2356
+ /**
2357
+ *
2358
+ * @type {Page}
2359
+ * @memberof ListNFTsByOwnerResult
2360
+ */
2361
+ 'page': Page$2;
2362
+ }
2363
+
1986
2364
  /**
1987
2365
  * Immutable zkEVM API
1988
2366
  * Immutable Multi Rollup API
@@ -2090,6 +2468,68 @@ interface MetadataRefreshRateLimitResult {
2090
2468
  'retry_after': string;
2091
2469
  }
2092
2470
 
2471
+ /**
2472
+ * Immutable zkEVM API
2473
+ * Immutable Multi Rollup API
2474
+ *
2475
+ * The version of the OpenAPI document: 1.0.0
2476
+ * Contact: support@immutable.com
2477
+ *
2478
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2479
+ * https://openapi-generator.tech
2480
+ * Do not edit the class manually.
2481
+ */
2482
+
2483
+ /**
2484
+ *
2485
+ * @export
2486
+ * @interface RefreshableNFTAttributes
2487
+ */
2488
+ interface RefreshableNFTAttributes {
2489
+ /**
2490
+ * The name of the NFT
2491
+ * @type {string}
2492
+ * @memberof RefreshableNFTAttributes
2493
+ */
2494
+ 'name': string | null;
2495
+ /**
2496
+ * The description of the NFT
2497
+ * @type {string}
2498
+ * @memberof RefreshableNFTAttributes
2499
+ */
2500
+ 'description': string | null;
2501
+ /**
2502
+ * The image url of the NFT
2503
+ * @type {string}
2504
+ * @memberof RefreshableNFTAttributes
2505
+ */
2506
+ 'image': string | null;
2507
+ /**
2508
+ * The external link of the NFT
2509
+ * @type {string}
2510
+ * @memberof RefreshableNFTAttributes
2511
+ */
2512
+ 'external_url': string | null;
2513
+ /**
2514
+ * The animation url of the NFT
2515
+ * @type {string}
2516
+ * @memberof RefreshableNFTAttributes
2517
+ */
2518
+ 'animation_url': string | null;
2519
+ /**
2520
+ * The youtube link of the NFT
2521
+ * @type {string}
2522
+ * @memberof RefreshableNFTAttributes
2523
+ */
2524
+ 'youtube_url': string | null;
2525
+ /**
2526
+ * List of Metadata attributes
2527
+ * @type {Array<NFTMetadataAttribute>}
2528
+ * @memberof RefreshableNFTAttributes
2529
+ */
2530
+ 'attributes': Array<NFTMetadataAttribute> | null;
2531
+ }
2532
+
2093
2533
  /**
2094
2534
  * Immutable zkEVM API
2095
2535
  * Immutable Multi Rollup API
@@ -2165,55 +2605,18 @@ interface RefreshCollectionMetadataResult {
2165
2605
  * https://openapi-generator.tech
2166
2606
  * Do not edit the class manually.
2167
2607
  */
2168
-
2169
2608
  /**
2170
2609
  *
2171
2610
  * @export
2172
- * @interface RefreshableNFTAttributes
2611
+ * @interface RefreshMetadataByIDAllOf
2173
2612
  */
2174
- interface RefreshableNFTAttributes {
2175
- /**
2176
- * The name of the NFT
2177
- * @type {string}
2178
- * @memberof RefreshableNFTAttributes
2179
- */
2180
- 'name': string | null;
2181
- /**
2182
- * The description of the NFT
2183
- * @type {string}
2184
- * @memberof RefreshableNFTAttributes
2185
- */
2186
- 'description': string | null;
2613
+ interface RefreshMetadataByIDAllOf {
2187
2614
  /**
2188
- * The image url of the NFT
2189
- * @type {string}
2190
- * @memberof RefreshableNFTAttributes
2191
- */
2192
- 'image': string | null;
2193
- /**
2194
- * The external link of the NFT
2195
- * @type {string}
2196
- * @memberof RefreshableNFTAttributes
2197
- */
2198
- 'external_url': string | null;
2199
- /**
2200
- * The animation url of the NFT
2201
- * @type {string}
2202
- * @memberof RefreshableNFTAttributes
2203
- */
2204
- 'animation_url': string | null;
2205
- /**
2206
- * The youtube link of the NFT
2615
+ * Metadata ID in UUIDv4 format
2207
2616
  * @type {string}
2208
- * @memberof RefreshableNFTAttributes
2209
- */
2210
- 'youtube_url': string | null;
2211
- /**
2212
- * List of Metadata attributes
2213
- * @type {Array<NFTMetadataAttribute>}
2214
- * @memberof RefreshableNFTAttributes
2617
+ * @memberof RefreshMetadataByIDAllOf
2215
2618
  */
2216
- 'attributes': Array<NFTMetadataAttribute> | null;
2619
+ 'metadata_id': string;
2217
2620
  }
2218
2621
 
2219
2622
  /**
@@ -2232,7 +2635,7 @@ interface RefreshableNFTAttributes {
2232
2635
  * @type RefreshMetadataByID
2233
2636
  * @export
2234
2637
  */
2235
- type RefreshMetadataByID = RefreshableNFTAttributes;
2638
+ type RefreshMetadataByID = RefreshMetadataByIDAllOf & RefreshableNFTAttributes;
2236
2639
 
2237
2640
  /**
2238
2641
  * Immutable zkEVM API
@@ -2251,13 +2654,38 @@ type RefreshMetadataByID = RefreshableNFTAttributes;
2251
2654
  * @export
2252
2655
  * @interface RefreshMetadataByIDRequest
2253
2656
  */
2254
- interface RefreshMetadataByIDRequest {
2657
+ interface RefreshMetadataByIDRequest {
2658
+ /**
2659
+ *
2660
+ * @type {Array<RefreshMetadataByID>}
2661
+ * @memberof RefreshMetadataByIDRequest
2662
+ */
2663
+ 'metadata'?: Array<RefreshMetadataByID>;
2664
+ }
2665
+
2666
+ /**
2667
+ * Immutable zkEVM API
2668
+ * Immutable Multi Rollup API
2669
+ *
2670
+ * The version of the OpenAPI document: 1.0.0
2671
+ * Contact: support@immutable.com
2672
+ *
2673
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2674
+ * https://openapi-generator.tech
2675
+ * Do not edit the class manually.
2676
+ */
2677
+ /**
2678
+ *
2679
+ * @export
2680
+ * @interface RefreshMetadataByTokenIDAllOf
2681
+ */
2682
+ interface RefreshMetadataByTokenIDAllOf {
2255
2683
  /**
2256
- *
2257
- * @type {Array<RefreshMetadataByID>}
2258
- * @memberof RefreshMetadataByIDRequest
2684
+ * An `uint256` token id as string
2685
+ * @type {string}
2686
+ * @memberof RefreshMetadataByTokenIDAllOf
2259
2687
  */
2260
- 'metadata'?: Array<RefreshMetadataByID>;
2688
+ 'token_id': string;
2261
2689
  }
2262
2690
 
2263
2691
  /**
@@ -2276,7 +2704,7 @@ interface RefreshMetadataByIDRequest {
2276
2704
  * @type RefreshMetadataByTokenID
2277
2705
  * @export
2278
2706
  */
2279
- type RefreshMetadataByTokenID = RefreshableNFTAttributes;
2707
+ type RefreshMetadataByTokenID = RefreshMetadataByTokenIDAllOf & RefreshableNFTAttributes;
2280
2708
 
2281
2709
  /**
2282
2710
  * Immutable zkEVM API
@@ -2360,33 +2788,64 @@ interface ActivitiesApiListActivitiesRequest {
2360
2788
  */
2361
2789
  readonly activityType?: ActivityType$1;
2362
2790
  /**
2363
- * From indexed at including given date
2791
+ * The transaction hash of activity
2364
2792
  * @type {string}
2365
2793
  * @memberof ActivitiesApiListActivities
2366
2794
  */
2367
- readonly fromIndexedAt?: string;
2795
+ readonly transactionHash?: string;
2368
2796
  /**
2369
- * To indexed at including given date
2797
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2370
2798
  * @type {string}
2371
2799
  * @memberof ActivitiesApiListActivities
2372
2800
  */
2373
- readonly toIndexedAt?: string;
2801
+ readonly pageCursor?: string;
2374
2802
  /**
2375
- * The transaction hash of activity
2376
- * @type {string}
2803
+ * Maximum number of items to return
2804
+ * @type {number}
2377
2805
  * @memberof ActivitiesApiListActivities
2378
2806
  */
2379
- readonly transactionHash?: string;
2807
+ readonly pageSize?: number;
2808
+ }
2809
+ /**
2810
+ * Request parameters for listActivityHistory operation in ActivitiesApi.
2811
+ * @export
2812
+ * @interface ActivitiesApiListActivityHistoryRequest
2813
+ */
2814
+ interface ActivitiesApiListActivityHistoryRequest {
2815
+ /**
2816
+ * The name of chain
2817
+ * @type {string}
2818
+ * @memberof ActivitiesApiListActivityHistory
2819
+ */
2820
+ readonly chainName: string;
2821
+ /**
2822
+ * From indexed at including given date
2823
+ * @type {string}
2824
+ * @memberof ActivitiesApiListActivityHistory
2825
+ */
2826
+ readonly fromUpdatedAt: string;
2827
+ /**
2828
+ * To indexed at including given date
2829
+ * @type {string}
2830
+ * @memberof ActivitiesApiListActivityHistory
2831
+ */
2832
+ readonly toUpdatedAt?: string;
2833
+ /**
2834
+ * The contract address of the collection
2835
+ * @type {string}
2836
+ * @memberof ActivitiesApiListActivityHistory
2837
+ */
2838
+ readonly contractAddress?: string;
2380
2839
  /**
2381
2840
  * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2382
2841
  * @type {string}
2383
- * @memberof ActivitiesApiListActivities
2842
+ * @memberof ActivitiesApiListActivityHistory
2384
2843
  */
2385
2844
  readonly pageCursor?: string;
2386
2845
  /**
2387
2846
  * Maximum number of items to return
2388
2847
  * @type {number}
2389
- * @memberof ActivitiesApiListActivities
2848
+ * @memberof ActivitiesApiListActivityHistory
2390
2849
  */
2391
2850
  readonly pageSize?: number;
2392
2851
  }
@@ -2586,6 +3045,37 @@ interface MetadataApiListMetadataRequest {
2586
3045
  */
2587
3046
  readonly pageSize?: number;
2588
3047
  }
3048
+ /**
3049
+ * Request parameters for listMetadataForChain operation in MetadataApi.
3050
+ * @export
3051
+ * @interface MetadataApiListMetadataForChainRequest
3052
+ */
3053
+ interface MetadataApiListMetadataForChainRequest {
3054
+ /**
3055
+ * The name of chain
3056
+ * @type {string}
3057
+ * @memberof MetadataApiListMetadataForChain
3058
+ */
3059
+ readonly chainName: string;
3060
+ /**
3061
+ * Datetime to use as the oldest updated timestamp
3062
+ * @type {string}
3063
+ * @memberof MetadataApiListMetadataForChain
3064
+ */
3065
+ readonly fromUpdatedAt?: string;
3066
+ /**
3067
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3068
+ * @type {string}
3069
+ * @memberof MetadataApiListMetadataForChain
3070
+ */
3071
+ readonly pageCursor?: string;
3072
+ /**
3073
+ * Maximum number of items to return
3074
+ * @type {number}
3075
+ * @memberof MetadataApiListMetadataForChain
3076
+ */
3077
+ readonly pageSize?: number;
3078
+ }
2589
3079
  /**
2590
3080
  * Request parameters for refreshMetadataByID operation in MetadataApi.
2591
3081
  * @export
@@ -2737,37 +3227,6 @@ interface NftsApiGetNFTRequest {
2737
3227
  */
2738
3228
  readonly chainName: string;
2739
3229
  }
2740
- /**
2741
- * Request parameters for listAllNFTOwners operation in NftsApi.
2742
- * @export
2743
- * @interface NftsApiListAllNFTOwnersRequest
2744
- */
2745
- interface NftsApiListAllNFTOwnersRequest {
2746
- /**
2747
- * The name of chain
2748
- * @type {string}
2749
- * @memberof NftsApiListAllNFTOwners
2750
- */
2751
- readonly chainName: string;
2752
- /**
2753
- * Datetime to use as the oldest updated timestamp
2754
- * @type {string}
2755
- * @memberof NftsApiListAllNFTOwners
2756
- */
2757
- readonly fromUpdatedAt: string;
2758
- /**
2759
- * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2760
- * @type {string}
2761
- * @memberof NftsApiListAllNFTOwners
2762
- */
2763
- readonly pageCursor?: string;
2764
- /**
2765
- * Maximum number of items to return
2766
- * @type {number}
2767
- * @memberof NftsApiListAllNFTOwners
2768
- */
2769
- readonly pageSize?: number;
2770
- }
2771
3230
  /**
2772
3231
  * Request parameters for listAllNFTs operation in NftsApi.
2773
3232
  * @export
@@ -2993,33 +3452,64 @@ interface ListActivitiesRequest {
2993
3452
  */
2994
3453
  readonly activityType?: ActivityType$1;
2995
3454
  /**
2996
- * From indexed at including given date
3455
+ * The transaction hash of activity
2997
3456
  * @type {string}
2998
3457
  * @memberof ListActivities
2999
3458
  */
3000
- readonly fromIndexedAt?: string;
3459
+ readonly transactionHash?: string;
3001
3460
  /**
3002
- * To indexed at including given date
3461
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3003
3462
  * @type {string}
3004
3463
  * @memberof ListActivities
3005
3464
  */
3006
- readonly toIndexedAt?: string;
3465
+ readonly pageCursor?: string;
3007
3466
  /**
3008
- * The transaction hash of activity
3009
- * @type {string}
3467
+ * Maximum number of items to return
3468
+ * @type {number}
3010
3469
  * @memberof ListActivities
3011
3470
  */
3012
- readonly transactionHash?: string;
3471
+ readonly pageSize?: number;
3472
+ }
3473
+ /**
3474
+ * Request parameters for listActivityHistory operation in ActivitiesApi.
3475
+ * @export
3476
+ * @interface ListActivityHistoryRequest
3477
+ */
3478
+ interface ListActivityHistoryRequest {
3479
+ /**
3480
+ * The name of chain
3481
+ * @type {string}
3482
+ * @memberof ListActivityHistory
3483
+ */
3484
+ readonly chainName: string;
3485
+ /**
3486
+ * From indexed at including given date
3487
+ * @type {string}
3488
+ * @memberof ListActivityHistory
3489
+ */
3490
+ readonly fromUpdatedAt: string;
3491
+ /**
3492
+ * To indexed at including given date
3493
+ * @type {string}
3494
+ * @memberof ListActivityHistory
3495
+ */
3496
+ readonly toUpdatedAt?: string;
3497
+ /**
3498
+ * The contract address of the collection
3499
+ * @type {string}
3500
+ * @memberof ListActivityHistory
3501
+ */
3502
+ readonly contractAddress?: string;
3013
3503
  /**
3014
3504
  * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3015
3505
  * @type {string}
3016
- * @memberof ListActivities
3506
+ * @memberof ListActivityHistory
3017
3507
  */
3018
3508
  readonly pageCursor?: string;
3019
3509
  /**
3020
3510
  * Maximum number of items to return
3021
3511
  * @type {number}
3022
- * @memberof ListActivities
3512
+ * @memberof ListActivityHistory
3023
3513
  */
3024
3514
  readonly pageSize?: number;
3025
3515
  }
@@ -3031,6 +3521,7 @@ type activitiesApiTypes_d_GetActivityRequest = GetActivityRequest;
3031
3521
  type activitiesApiTypes_d_GetActivityResult = GetActivityResult;
3032
3522
  type activitiesApiTypes_d_ListActivitiesRequest = ListActivitiesRequest;
3033
3523
  type activitiesApiTypes_d_ListActivitiesResult = ListActivitiesResult;
3524
+ type activitiesApiTypes_d_ListActivityHistoryRequest = ListActivityHistoryRequest;
3034
3525
  declare namespace activitiesApiTypes_d {
3035
3526
  export {
3036
3527
  activitiesApiTypes_d_APIError400 as APIError400,
@@ -3041,6 +3532,7 @@ declare namespace activitiesApiTypes_d {
3041
3532
  activitiesApiTypes_d_GetActivityResult as GetActivityResult,
3042
3533
  activitiesApiTypes_d_ListActivitiesRequest as ListActivitiesRequest,
3043
3534
  activitiesApiTypes_d_ListActivitiesResult as ListActivitiesResult,
3535
+ activitiesApiTypes_d_ListActivityHistoryRequest as ListActivityHistoryRequest,
3044
3536
  };
3045
3537
  }
3046
3538
 
@@ -3294,6 +3786,37 @@ interface ListMetadataRequest {
3294
3786
  */
3295
3787
  readonly pageSize?: number;
3296
3788
  }
3789
+ /**
3790
+ * Request parameters for listMetadataForChain operation in MetadataApi.
3791
+ * @export
3792
+ * @interface ListMetadataForChainRequest
3793
+ */
3794
+ interface ListMetadataForChainRequest {
3795
+ /**
3796
+ * The name of chain
3797
+ * @type {string}
3798
+ * @memberof ListMetadataForChain
3799
+ */
3800
+ readonly chainName: string;
3801
+ /**
3802
+ * Datetime to use as the oldest updated timestamp
3803
+ * @type {string}
3804
+ * @memberof ListMetadataForChain
3805
+ */
3806
+ readonly fromUpdatedAt?: string;
3807
+ /**
3808
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3809
+ * @type {string}
3810
+ * @memberof ListMetadataForChain
3811
+ */
3812
+ readonly pageCursor?: string;
3813
+ /**
3814
+ * Maximum number of items to return
3815
+ * @type {number}
3816
+ * @memberof ListMetadataForChain
3817
+ */
3818
+ readonly pageSize?: number;
3819
+ }
3297
3820
 
3298
3821
  type metadataApiTypes_d_APIError400 = APIError400;
3299
3822
  type metadataApiTypes_d_APIError401 = APIError401;
@@ -3303,6 +3826,7 @@ type metadataApiTypes_d_APIError429 = APIError429;
3303
3826
  type metadataApiTypes_d_APIError500 = APIError500;
3304
3827
  type metadataApiTypes_d_GetMetadataRequest = GetMetadataRequest;
3305
3828
  type metadataApiTypes_d_GetMetadataResult = GetMetadataResult;
3829
+ type metadataApiTypes_d_ListMetadataForChainRequest = ListMetadataForChainRequest;
3306
3830
  type metadataApiTypes_d_ListMetadataRequest = ListMetadataRequest;
3307
3831
  type metadataApiTypes_d_ListMetadataResult = ListMetadataResult;
3308
3832
  type metadataApiTypes_d_MetadataRefreshRateLimitResult = MetadataRefreshRateLimitResult;
@@ -3318,6 +3842,7 @@ declare namespace metadataApiTypes_d {
3318
3842
  metadataApiTypes_d_APIError500 as APIError500,
3319
3843
  metadataApiTypes_d_GetMetadataRequest as GetMetadataRequest,
3320
3844
  metadataApiTypes_d_GetMetadataResult as GetMetadataResult,
3845
+ metadataApiTypes_d_ListMetadataForChainRequest as ListMetadataForChainRequest,
3321
3846
  metadataApiTypes_d_ListMetadataRequest as ListMetadataRequest,
3322
3847
  metadataApiTypes_d_ListMetadataResult as ListMetadataResult,
3323
3848
  metadataApiTypes_d_MetadataRefreshRateLimitResult as MetadataRefreshRateLimitResult,
@@ -3338,6 +3863,37 @@ declare namespace metadataApiTypes_d {
3338
3863
  * Do not edit the class manually.
3339
3864
  */
3340
3865
 
3866
+ /**
3867
+ * Request parameters for listAllNFTOwners operation in NftOwnersApi.
3868
+ * @export
3869
+ * @interface ListAllNFTOwnersRequest
3870
+ */
3871
+ interface ListAllNFTOwnersRequest {
3872
+ /**
3873
+ * The name of chain
3874
+ * @type {string}
3875
+ * @memberof ListAllNFTOwners
3876
+ */
3877
+ readonly chainName: string;
3878
+ /**
3879
+ * Datetime to use as the oldest updated timestamp
3880
+ * @type {string}
3881
+ * @memberof ListAllNFTOwners
3882
+ */
3883
+ readonly fromUpdatedAt?: string;
3884
+ /**
3885
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3886
+ * @type {string}
3887
+ * @memberof ListAllNFTOwners
3888
+ */
3889
+ readonly pageCursor?: string;
3890
+ /**
3891
+ * Maximum number of items to return
3892
+ * @type {number}
3893
+ * @memberof ListAllNFTOwners
3894
+ */
3895
+ readonly pageSize?: number;
3896
+ }
3341
3897
  /**
3342
3898
  * Request parameters for listNFTOwners operation in NftOwnersApi.
3343
3899
  * @export
@@ -3416,6 +3972,7 @@ interface ListOwnersByContractAddressRequest {
3416
3972
  type nftOwnersApiTypes_d_APIError400 = APIError400;
3417
3973
  type nftOwnersApiTypes_d_APIError404 = APIError404;
3418
3974
  type nftOwnersApiTypes_d_APIError500 = APIError500;
3975
+ type nftOwnersApiTypes_d_ListAllNFTOwnersRequest = ListAllNFTOwnersRequest;
3419
3976
  type nftOwnersApiTypes_d_ListCollectionOwnersResult = ListCollectionOwnersResult;
3420
3977
  type nftOwnersApiTypes_d_ListNFTOwnersRequest = ListNFTOwnersRequest;
3421
3978
  type nftOwnersApiTypes_d_ListNFTOwnersResult = ListNFTOwnersResult;
@@ -3425,6 +3982,7 @@ declare namespace nftOwnersApiTypes_d {
3425
3982
  nftOwnersApiTypes_d_APIError400 as APIError400,
3426
3983
  nftOwnersApiTypes_d_APIError404 as APIError404,
3427
3984
  nftOwnersApiTypes_d_APIError500 as APIError500,
3985
+ nftOwnersApiTypes_d_ListAllNFTOwnersRequest as ListAllNFTOwnersRequest,
3428
3986
  nftOwnersApiTypes_d_ListCollectionOwnersResult as ListCollectionOwnersResult,
3429
3987
  nftOwnersApiTypes_d_ListNFTOwnersRequest as ListNFTOwnersRequest,
3430
3988
  nftOwnersApiTypes_d_ListNFTOwnersResult as ListNFTOwnersResult,
@@ -3469,37 +4027,6 @@ interface GetNFTRequest {
3469
4027
  */
3470
4028
  readonly chainName: string;
3471
4029
  }
3472
- /**
3473
- * Request parameters for listAllNFTOwners operation in NftsApi.
3474
- * @export
3475
- * @interface ListAllNFTOwnersRequest
3476
- */
3477
- interface ListAllNFTOwnersRequest {
3478
- /**
3479
- * The name of chain
3480
- * @type {string}
3481
- * @memberof ListAllNFTOwners
3482
- */
3483
- readonly chainName: string;
3484
- /**
3485
- * Datetime to use as the oldest updated timestamp
3486
- * @type {string}
3487
- * @memberof ListAllNFTOwners
3488
- */
3489
- readonly fromUpdatedAt: string;
3490
- /**
3491
- * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3492
- * @type {string}
3493
- * @memberof ListAllNFTOwners
3494
- */
3495
- readonly pageCursor?: string;
3496
- /**
3497
- * Maximum number of items to return
3498
- * @type {number}
3499
- * @memberof ListAllNFTOwners
3500
- */
3501
- readonly pageSize?: number;
3502
- }
3503
4030
  /**
3504
4031
  * Request parameters for listAllNFTs operation in NftsApi.
3505
4032
  * @export
@@ -3611,10 +4138,9 @@ type nftsApiTypes_d_APIError404 = APIError404;
3611
4138
  type nftsApiTypes_d_APIError500 = APIError500;
3612
4139
  type nftsApiTypes_d_GetNFTRequest = GetNFTRequest;
3613
4140
  type nftsApiTypes_d_GetNFTResult = GetNFTResult;
3614
- type nftsApiTypes_d_ListAllNFTOwnersRequest = ListAllNFTOwnersRequest;
3615
4141
  type nftsApiTypes_d_ListAllNFTsRequest = ListAllNFTsRequest;
3616
- type nftsApiTypes_d_ListNFTOwnersResult = ListNFTOwnersResult;
3617
4142
  type nftsApiTypes_d_ListNFTsByAccountAddressRequest = ListNFTsByAccountAddressRequest;
4143
+ type nftsApiTypes_d_ListNFTsByOwnerResult = ListNFTsByOwnerResult;
3618
4144
  type nftsApiTypes_d_ListNFTsRequest = ListNFTsRequest;
3619
4145
  type nftsApiTypes_d_ListNFTsResult = ListNFTsResult;
3620
4146
  declare namespace nftsApiTypes_d {
@@ -3624,10 +4150,9 @@ declare namespace nftsApiTypes_d {
3624
4150
  nftsApiTypes_d_APIError500 as APIError500,
3625
4151
  nftsApiTypes_d_GetNFTRequest as GetNFTRequest,
3626
4152
  nftsApiTypes_d_GetNFTResult as GetNFTResult,
3627
- nftsApiTypes_d_ListAllNFTOwnersRequest as ListAllNFTOwnersRequest,
3628
4153
  nftsApiTypes_d_ListAllNFTsRequest as ListAllNFTsRequest,
3629
- nftsApiTypes_d_ListNFTOwnersResult as ListNFTOwnersResult,
3630
4154
  nftsApiTypes_d_ListNFTsByAccountAddressRequest as ListNFTsByAccountAddressRequest,
4155
+ nftsApiTypes_d_ListNFTsByOwnerResult as ListNFTsByOwnerResult,
3631
4156
  nftsApiTypes_d_ListNFTsRequest as ListNFTsRequest,
3632
4157
  nftsApiTypes_d_ListNFTsResult as ListNFTsResult,
3633
4158
  };
@@ -3764,6 +4289,13 @@ declare class BlockchainData {
3764
4289
  * @throws {@link index.APIError}
3765
4290
  */
3766
4291
  listActivities(request: ActivitiesApiListActivitiesRequest): Promise<ListActivitiesResult>;
4292
+ /**
4293
+ * List activities sorted by updated_at timestamp ascending, useful for time based data replication
4294
+ * @param request - the request object containing the parameters to be provided in the API request
4295
+ * @returns a promise that resolves with a list of activities
4296
+ * @throws {@link index.APIError}
4297
+ */
4298
+ listActivityHistory(request: ActivitiesApiListActivityHistoryRequest): Promise<ListActivitiesResult>;
3767
4299
  /**
3768
4300
  * Get a single activity by ID
3769
4301
  * @param request - the request object containing the parameters to be provided in the API request
@@ -3793,7 +4325,7 @@ declare class BlockchainData {
3793
4325
  */
3794
4326
  listCollectionsByNFTOwner(request: CollectionsApiListCollectionsByNFTOwnerRequest): Promise<ListCollectionsResult>;
3795
4327
  /**
3796
- * Get collection by contract address
4328
+ * Get a collection by contract address
3797
4329
  * @param request - the request object containing the parameters to be provided in the API request
3798
4330
  * @returns a promise that resolves with a single collection
3799
4331
  * @throws {@link index.APIError}
@@ -3847,7 +4379,7 @@ declare class BlockchainData {
3847
4379
  * @returns a promise that resolves with a list of NFT owners
3848
4380
  * @throws {@link index.APIError}
3849
4381
  */
3850
- listAllNFTOwners(request: NftsApiListAllNFTOwnersRequest): Promise<ListNFTOwnersResult>;
4382
+ listAllNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
3851
4383
  /**
3852
4384
  * List ERC20 Token contracts
3853
4385
  * @param request - the request object containing the parameters to be provided in the API request
@@ -3876,6 +4408,13 @@ declare class BlockchainData {
3876
4408
  * @throws {@link index.APIError}
3877
4409
  */
3878
4410
  listNFTMetadataByContractAddress(request: MetadataApiListMetadataRequest): Promise<ListMetadataResult>;
4411
+ /**
4412
+ * List NFT Metadata by chain
4413
+ * @param request - the request object containing the parameters to be provided in the API request
4414
+ * @returns a promise that resolves with a list of Metadata
4415
+ * @throws {@link index.APIError}
4416
+ */
4417
+ listNFTMetadataByChain(request: MetadataApiListMetadataForChainRequest): Promise<ListMetadataResult>;
3879
4418
  /**
3880
4419
  * Refresh collection metadata
3881
4420
  * @param request - the request object containing the parameters to be provided in the API request
@@ -16978,6 +17517,26 @@ interface CheckConnectionResult {
16978
17517
  walletAddress: string;
16979
17518
  }
16980
17519
 
17520
+ /**
17521
+ * @typedef {Object} BridgeFeeResponse
17522
+ * @property {ethers.BigNumber} sourceChainGas - Gas cost to send tokens to the bridge contract on the source chain.
17523
+ * - priced in the source chain's native token.
17524
+ * @property {ethers.BigNumber} bridgeFee - destinationChainGas + validatorFee.
17525
+ * This will be added to the tx.value of the bridge transaction and forwarded to the Axelar Gas Service contract.
17526
+ * - priced in the source chain's native token.
17527
+ * @property {ethers.BigNumber} imtblFee - The fee charged by Immutable to facilitate the bridge.
17528
+ * - priced in the source chain's native token.
17529
+ * @property {ethers.BigNumber} totalFees - The total fees the user will be charged which is;
17530
+ * sourceChainGas + bridgeFee + imtblFee.
17531
+ * - priced in the source chain's native token.
17532
+ */
17533
+ interface BridgeFeeResponse {
17534
+ sourceChainGas: BigNumber;
17535
+ bridgeFee: BigNumber;
17536
+ imtblFee: BigNumber;
17537
+ totalFees: BigNumber;
17538
+ }
17539
+
16981
17540
  /**
16982
17541
  * An enum representing the type of gas estimate.
16983
17542
  * @enum {string}
@@ -16997,11 +17556,9 @@ type GasEstimateParams = GasEstimateBridgeToL2Params | GasEstimateSwapParams;
16997
17556
  /**
16998
17557
  * An interface representing the parameters for estimating gas for a bridge to L2 transaction {@link Checkout.gasEstimate}.
16999
17558
  * @param {GasEstimateType.BRIDGE_TO_L2} gasEstimateType - The type of gas estimate.
17000
- * @param {boolean} isSpendingCapApprovalRequired - Whether or not spending cap approval is required.
17001
17559
  */
17002
17560
  interface GasEstimateBridgeToL2Params {
17003
17561
  gasEstimateType: GasEstimateType.BRIDGE_TO_L2;
17004
- isSpendingCapApprovalRequired: boolean;
17005
17562
  }
17006
17563
  /**
17007
17564
  * An interface representing the parameters for a gas estimate swap {@link Checkout.gasEstimate}.
@@ -17015,28 +17572,31 @@ interface GasEstimateSwapParams {
17015
17572
  * An interface representing the result of a gas estimate for a swap transaction {@link Checkout.gasEstimate}.
17016
17573
  * @interface GasEstimateSwapResult
17017
17574
  * @property {GasEstimateType.SWAP} gasEstimateType - The type of gas estimate, which is always "SWAP".
17018
- * @property {TokenAmountEstimate} gasFee - The estimated gas fee for the swap transaction.
17575
+ * @property {TokenAmountEstimate} fees - The estimated gas fee for the swap transaction.
17019
17576
  */
17020
17577
  interface GasEstimateSwapResult {
17021
17578
  gasEstimateType: GasEstimateType.SWAP;
17022
- gasFee: TokenAmountEstimate;
17579
+ fees: TokenAmountEstimate;
17023
17580
  }
17024
17581
  /**
17025
17582
  * An interface representing the result of a gas estimate for a bridge to L2 transaction {@link Checkout.gasEstimate}.
17026
17583
  * @interface GasEstimateBridgeToL2Result
17027
17584
  * @property {GasEstimateType.BRIDGE_TO_L2} gasEstimateType - The type of gas estimate.
17028
- * @property {TokenAmountEstimate} gasFee - The estimated gas fee for the transaction.
17029
- * @property {TokenAmountEstimate} bridgeFee - The estimated bridge fee for the transaction.
17030
- * @property {boolean} bridgeable - A boolean indicating whether the transaction is bridgeable.
17585
+ * @property {BridgeFeeResponse} fees - The estimated fees for the transaction.
17586
+ * @property {TokenInfo | undefined} token - The gas token information.
17031
17587
  */
17032
17588
  interface GasEstimateBridgeToL2Result {
17033
17589
  gasEstimateType: GasEstimateType.BRIDGE_TO_L2;
17034
- gasFee: TokenAmountEstimate;
17035
- bridgeFee: TokenAmountEstimate;
17036
- bridgeable: boolean;
17590
+ fees: BridgeFeeResponse;
17591
+ token?: TokenInfo;
17037
17592
  }
17593
+ /**
17594
+ * An interface representing the estimated fees.
17595
+ * @property {BigNumber | undefined} totalFees - The estimated fees for the transaction.
17596
+ * @property {TokenInfo | undefined} token - The gas token information.
17597
+ */
17038
17598
  interface TokenAmountEstimate {
17039
- estimatedAmount?: BigNumber;
17599
+ totalFees?: BigNumber;
17040
17600
  token?: TokenInfo;
17041
17601
  }
17042
17602
 
@@ -17520,14 +18080,14 @@ type SaleTransactionSuccess = {
17520
18080
  */
17521
18081
  declare enum BridgeEventType {
17522
18082
  CLOSE_WIDGET = "close-widget",
17523
- SUCCESS = "success",
17524
- FAILURE = "failure"
18083
+ FAILURE = "failure",
18084
+ TRANSACTION_SENT = "transaction-sent"
17525
18085
  }
17526
18086
  /**
17527
18087
  * Represents a successful bridge transaction.
17528
18088
  * @property {string} transactionHash
17529
18089
  */
17530
- type BridgeSuccess = {
18090
+ type BridgeTransactionSent = {
17531
18091
  /** The hash of the successful transaction. */
17532
18092
  transactionHash: string;
17533
18093
  };
@@ -17643,13 +18203,13 @@ type ConnectWidgetParams = {};
17643
18203
 
17644
18204
  /**
17645
18205
  * Bridge Widget parameters
17646
- * @property {string | undefined} fromContractAddress
18206
+ * @property {string | undefined} contractAddress
17647
18207
  * @property {string | undefined} amount
17648
18208
  * @property {WalletProviderName | undefined} walletProviderName
17649
18209
  */
17650
18210
  type BridgeWidgetParams = {
17651
18211
  /** The contract address of the token to bridge from, used to populate the bridge form token field */
17652
- fromContractAddress?: string;
18212
+ contractAddress?: string;
17653
18213
  /** The formatted amount to bridge, used to populate the bridge form amount field */
17654
18214
  amount?: string;
17655
18215
  /** The wallet provider name to use for the bridge widget */
@@ -17845,7 +18405,7 @@ type WidgetEventData = {
17845
18405
  [SwapEventType.CLOSE_WIDGET]: {};
17846
18406
  } & OrchestrationMapping & ProviderEventMapping;
17847
18407
  [WidgetType.BRIDGE]: {
17848
- [BridgeEventType.SUCCESS]: BridgeSuccess;
18408
+ [BridgeEventType.TRANSACTION_SENT]: BridgeTransactionSent;
17849
18409
  [BridgeEventType.FAILURE]: BridgeFailed;
17850
18410
  [BridgeEventType.CLOSE_WIDGET]: {};
17851
18411
  } & OrchestrationMapping & ProviderEventMapping;
@@ -18202,6 +18762,18 @@ declare global {
18202
18762
  }
18203
18763
  }
18204
18764
 
18765
+ /**
18766
+ * Base URL for the Immutable API based on the environment.
18767
+ * @property {string} DEVELOPMENT - The base URL for the development environment.
18768
+ * @property {string} SANDBOX - The base URL for the sandbox environment.
18769
+ * @property {string} PRODUCTION - The base URL for the production environment.
18770
+ */
18771
+ declare const IMMUTABLE_API_BASE_URL: {
18772
+ [x: string]: string;
18773
+ sandbox: string;
18774
+ production: string;
18775
+ };
18776
+
18205
18777
  /**
18206
18778
  * Enum representing different types of errors that can occur during the checkout process.
18207
18779
  */
@@ -18261,18 +18833,6 @@ type ErrorType = {
18261
18833
  };
18262
18834
  };
18263
18835
 
18264
- /**
18265
- * Base URL for the checkout API based on the environment.
18266
- * @property {string} DEVELOPMENT - The base URL for the development environment.
18267
- * @property {string} SANDBOX - The base URL for the sandbox environment.
18268
- * @property {string} PRODUCTION - The base URL for the production environment.
18269
- */
18270
- declare const CHECKOUT_API_BASE_URL: {
18271
- [x: string]: string;
18272
- sandbox: string;
18273
- production: string;
18274
- };
18275
-
18276
18836
  type checkout_d_AllowedNetworkConfig = AllowedNetworkConfig;
18277
18837
  type checkout_d_AvailableRoutingOptions = AvailableRoutingOptions;
18278
18838
  type checkout_d_BalanceDelta = BalanceDelta;
@@ -18280,7 +18840,7 @@ type checkout_d_BridgeEventType = BridgeEventType;
18280
18840
  declare const checkout_d_BridgeEventType: typeof BridgeEventType;
18281
18841
  type checkout_d_BridgeFailed = BridgeFailed;
18282
18842
  type checkout_d_BridgeFundingStep = BridgeFundingStep;
18283
- type checkout_d_BridgeSuccess = BridgeSuccess;
18843
+ type checkout_d_BridgeTransactionSent = BridgeTransactionSent;
18284
18844
  type checkout_d_BridgeWidgetConfiguration = BridgeWidgetConfiguration;
18285
18845
  type checkout_d_BridgeWidgetParams = BridgeWidgetParams;
18286
18846
  type checkout_d_BuyOrder = BuyOrder;
@@ -18290,7 +18850,6 @@ type checkout_d_BuyResultFailed = BuyResultFailed;
18290
18850
  type checkout_d_BuyResultInsufficientFunds = BuyResultInsufficientFunds;
18291
18851
  type checkout_d_BuyResultSuccess = BuyResultSuccess;
18292
18852
  type checkout_d_BuyToken = BuyToken;
18293
- declare const checkout_d_CHECKOUT_API_BASE_URL: typeof CHECKOUT_API_BASE_URL;
18294
18853
  type checkout_d_CancelParams = CancelParams;
18295
18854
  type checkout_d_CancelResult = CancelResult;
18296
18855
  type checkout_d_CancelResultFailed = CancelResultFailed;
@@ -18364,6 +18923,7 @@ type checkout_d_GetTokenAllowListParams = GetTokenAllowListParams;
18364
18923
  type checkout_d_GetTokenAllowListResult = GetTokenAllowListResult;
18365
18924
  type checkout_d_GetWalletAllowListParams = GetWalletAllowListParams;
18366
18925
  type checkout_d_GetWalletAllowListResult = GetWalletAllowListResult;
18926
+ declare const checkout_d_IMMUTABLE_API_BASE_URL: typeof IMMUTABLE_API_BASE_URL;
18367
18927
  type checkout_d_IMTBLWidgetEvents = IMTBLWidgetEvents;
18368
18928
  declare const checkout_d_IMTBLWidgetEvents: typeof IMTBLWidgetEvents;
18369
18929
  type checkout_d_IWidgetsFactory = IWidgetsFactory;
@@ -18478,7 +19038,7 @@ declare namespace checkout_d {
18478
19038
  checkout_d_BridgeEventType as BridgeEventType,
18479
19039
  checkout_d_BridgeFailed as BridgeFailed,
18480
19040
  checkout_d_BridgeFundingStep as BridgeFundingStep,
18481
- checkout_d_BridgeSuccess as BridgeSuccess,
19041
+ checkout_d_BridgeTransactionSent as BridgeTransactionSent,
18482
19042
  checkout_d_BridgeWidgetConfiguration as BridgeWidgetConfiguration,
18483
19043
  checkout_d_BridgeWidgetParams as BridgeWidgetParams,
18484
19044
  checkout_d_BuyOrder as BuyOrder,
@@ -18488,7 +19048,6 @@ declare namespace checkout_d {
18488
19048
  checkout_d_BuyResultInsufficientFunds as BuyResultInsufficientFunds,
18489
19049
  checkout_d_BuyResultSuccess as BuyResultSuccess,
18490
19050
  checkout_d_BuyToken as BuyToken,
18491
- checkout_d_CHECKOUT_API_BASE_URL as CHECKOUT_API_BASE_URL,
18492
19051
  checkout_d_CancelParams as CancelParams,
18493
19052
  checkout_d_CancelResult as CancelResult,
18494
19053
  checkout_d_CancelResultFailed as CancelResultFailed,
@@ -18550,6 +19109,7 @@ declare namespace checkout_d {
18550
19109
  checkout_d_GetTokenAllowListResult as GetTokenAllowListResult,
18551
19110
  checkout_d_GetWalletAllowListParams as GetWalletAllowListParams,
18552
19111
  checkout_d_GetWalletAllowListResult as GetWalletAllowListResult,
19112
+ checkout_d_IMMUTABLE_API_BASE_URL as IMMUTABLE_API_BASE_URL,
18553
19113
  checkout_d_IMTBLWidgetEvents as IMTBLWidgetEvents,
18554
19114
  checkout_d_IWidgetsFactory as IWidgetsFactory,
18555
19115
  checkout_d_ItemBalance as ItemBalance,