@imtbl/sdk 0.23.0-alpha → 0.23.2-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -996,6 +996,67 @@ interface Collection$1 {
996
996
  'last_metadata_synced_at': string | null;
997
997
  }
998
998
 
999
+ /**
1000
+ * Immutable zkEVM API
1001
+ * Immutable Multi Rollup API
1002
+ *
1003
+ * The version of the OpenAPI document: 1.0.0
1004
+ * Contact: support@immutable.com
1005
+ *
1006
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1007
+ * https://openapi-generator.tech
1008
+ * Do not edit the class manually.
1009
+ */
1010
+ /**
1011
+ *
1012
+ * @export
1013
+ * @interface CollectionMetadata
1014
+ */
1015
+ interface CollectionMetadata {
1016
+ /**
1017
+ * The name of the collection
1018
+ * @type {string}
1019
+ * @memberof CollectionMetadata
1020
+ */
1021
+ 'name': string | null;
1022
+ /**
1023
+ * The symbol of contract
1024
+ * @type {string}
1025
+ * @memberof CollectionMetadata
1026
+ */
1027
+ 'symbol': string | null;
1028
+ /**
1029
+ * The description of collection
1030
+ * @type {string}
1031
+ * @memberof CollectionMetadata
1032
+ */
1033
+ 'description': string | null;
1034
+ /**
1035
+ * The url of the collection image
1036
+ * @type {string}
1037
+ * @memberof CollectionMetadata
1038
+ */
1039
+ 'image': string | null;
1040
+ /**
1041
+ * The url of external link
1042
+ * @type {string}
1043
+ * @memberof CollectionMetadata
1044
+ */
1045
+ 'external_link': string | null;
1046
+ /**
1047
+ * The uri for the metadata of the collection
1048
+ * @type {string}
1049
+ * @memberof CollectionMetadata
1050
+ */
1051
+ 'contract_uri': string | null;
1052
+ /**
1053
+ * The metadata uri for nft
1054
+ * @type {string}
1055
+ * @memberof CollectionMetadata
1056
+ */
1057
+ 'base_uri': string | null;
1058
+ }
1059
+
999
1060
  /**
1000
1061
  * Immutable zkEVM API
1001
1062
  * Immutable Multi Rollup API
@@ -1628,6 +1689,313 @@ interface ListTokensResult {
1628
1689
  'page': Page$2;
1629
1690
  }
1630
1691
 
1692
+ /**
1693
+ * Immutable zkEVM API
1694
+ * Immutable Multi Rollup API
1695
+ *
1696
+ * The version of the OpenAPI document: 1.0.0
1697
+ * Contact: support@immutable.com
1698
+ *
1699
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1700
+ * https://openapi-generator.tech
1701
+ * Do not edit the class manually.
1702
+ */
1703
+ /**
1704
+ *
1705
+ * @export
1706
+ * @interface MetadataRefreshRateLimitResult
1707
+ */
1708
+ interface MetadataRefreshRateLimitResult {
1709
+ /**
1710
+ *
1711
+ * @type {string}
1712
+ * @memberof MetadataRefreshRateLimitResult
1713
+ */
1714
+ 'imx_refreshes_limit': string;
1715
+ /**
1716
+ *
1717
+ * @type {string}
1718
+ * @memberof MetadataRefreshRateLimitResult
1719
+ */
1720
+ 'imx_refresh_limit_reset': string;
1721
+ /**
1722
+ *
1723
+ * @type {string}
1724
+ * @memberof MetadataRefreshRateLimitResult
1725
+ */
1726
+ 'imx_remaining_refreshes': string;
1727
+ /**
1728
+ *
1729
+ * @type {string}
1730
+ * @memberof MetadataRefreshRateLimitResult
1731
+ */
1732
+ 'retry_after': string;
1733
+ }
1734
+
1735
+ /**
1736
+ * Immutable zkEVM API
1737
+ * Immutable Multi Rollup API
1738
+ *
1739
+ * The version of the OpenAPI document: 1.0.0
1740
+ * Contact: support@immutable.com
1741
+ *
1742
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1743
+ * https://openapi-generator.tech
1744
+ * Do not edit the class manually.
1745
+ */
1746
+
1747
+ /**
1748
+ *
1749
+ * @export
1750
+ * @interface RefreshCollectionMetadataRequest
1751
+ */
1752
+ interface RefreshCollectionMetadataRequest {
1753
+ /**
1754
+ *
1755
+ * @type {CollectionMetadata}
1756
+ * @memberof RefreshCollectionMetadataRequest
1757
+ */
1758
+ 'collection_metadata': CollectionMetadata;
1759
+ }
1760
+
1761
+ /**
1762
+ * Immutable zkEVM API
1763
+ * Immutable Multi Rollup API
1764
+ *
1765
+ * The version of the OpenAPI document: 1.0.0
1766
+ * Contact: support@immutable.com
1767
+ *
1768
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1769
+ * https://openapi-generator.tech
1770
+ * Do not edit the class manually.
1771
+ */
1772
+
1773
+ /**
1774
+ *
1775
+ * @export
1776
+ * @interface RefreshCollectionMetadataResult
1777
+ */
1778
+ interface RefreshCollectionMetadataResult {
1779
+ /**
1780
+ *
1781
+ * @type {string}
1782
+ * @memberof RefreshCollectionMetadataResult
1783
+ */
1784
+ 'contract_address': string;
1785
+ /**
1786
+ *
1787
+ * @type {Chain}
1788
+ * @memberof RefreshCollectionMetadataResult
1789
+ */
1790
+ 'chain': Chain$1;
1791
+ /**
1792
+ *
1793
+ * @type {CollectionMetadata}
1794
+ * @memberof RefreshCollectionMetadataResult
1795
+ */
1796
+ 'collection_metadata': CollectionMetadata;
1797
+ }
1798
+
1799
+ /**
1800
+ * Immutable zkEVM API
1801
+ * Immutable Multi Rollup API
1802
+ *
1803
+ * The version of the OpenAPI document: 1.0.0
1804
+ * Contact: support@immutable.com
1805
+ *
1806
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1807
+ * https://openapi-generator.tech
1808
+ * Do not edit the class manually.
1809
+ */
1810
+ /**
1811
+ *
1812
+ * @export
1813
+ * @interface RefreshMetadataByIDAllOf
1814
+ */
1815
+ interface RefreshMetadataByIDAllOf {
1816
+ /**
1817
+ * Metadata ID in UUIDv4 format
1818
+ * @type {string}
1819
+ * @memberof RefreshMetadataByIDAllOf
1820
+ */
1821
+ 'metadata_id': string;
1822
+ }
1823
+
1824
+ /**
1825
+ * Immutable zkEVM API
1826
+ * Immutable Multi Rollup API
1827
+ *
1828
+ * The version of the OpenAPI document: 1.0.0
1829
+ * Contact: support@immutable.com
1830
+ *
1831
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1832
+ * https://openapi-generator.tech
1833
+ * Do not edit the class manually.
1834
+ */
1835
+
1836
+ /**
1837
+ *
1838
+ * @export
1839
+ * @interface RefreshableNFTAttributes
1840
+ */
1841
+ interface RefreshableNFTAttributes {
1842
+ /**
1843
+ * The name of the NFT
1844
+ * @type {string}
1845
+ * @memberof RefreshableNFTAttributes
1846
+ */
1847
+ 'name': string | null;
1848
+ /**
1849
+ * The description of the NFT
1850
+ * @type {string}
1851
+ * @memberof RefreshableNFTAttributes
1852
+ */
1853
+ 'description': string | null;
1854
+ /**
1855
+ * The image url of the NFT
1856
+ * @type {string}
1857
+ * @memberof RefreshableNFTAttributes
1858
+ */
1859
+ 'image': string | null;
1860
+ /**
1861
+ * The external link of the NFT
1862
+ * @type {string}
1863
+ * @memberof RefreshableNFTAttributes
1864
+ */
1865
+ 'external_url': string | null;
1866
+ /**
1867
+ * The animation url of the NFT
1868
+ * @type {string}
1869
+ * @memberof RefreshableNFTAttributes
1870
+ */
1871
+ 'animation_url': string | null;
1872
+ /**
1873
+ * The youtube link of the NFT
1874
+ * @type {string}
1875
+ * @memberof RefreshableNFTAttributes
1876
+ */
1877
+ 'youtube_url': string | null;
1878
+ /**
1879
+ * List of Metadata attributes
1880
+ * @type {Array<NFTMetadataAttribute>}
1881
+ * @memberof RefreshableNFTAttributes
1882
+ */
1883
+ 'attributes': Array<NFTMetadataAttribute> | null;
1884
+ }
1885
+
1886
+ /**
1887
+ * Immutable zkEVM API
1888
+ * Immutable Multi Rollup API
1889
+ *
1890
+ * The version of the OpenAPI document: 1.0.0
1891
+ * Contact: support@immutable.com
1892
+ *
1893
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1894
+ * https://openapi-generator.tech
1895
+ * Do not edit the class manually.
1896
+ */
1897
+
1898
+ /**
1899
+ * @type RefreshMetadataByID
1900
+ * @export
1901
+ */
1902
+ type RefreshMetadataByID = RefreshMetadataByIDAllOf & RefreshableNFTAttributes;
1903
+
1904
+ /**
1905
+ * Immutable zkEVM API
1906
+ * Immutable Multi Rollup API
1907
+ *
1908
+ * The version of the OpenAPI document: 1.0.0
1909
+ * Contact: support@immutable.com
1910
+ *
1911
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1912
+ * https://openapi-generator.tech
1913
+ * Do not edit the class manually.
1914
+ */
1915
+
1916
+ /**
1917
+ * Request body for refreshing metadata by id
1918
+ * @export
1919
+ * @interface RefreshMetadataByIDRequest
1920
+ */
1921
+ interface RefreshMetadataByIDRequest {
1922
+ /**
1923
+ *
1924
+ * @type {Array<RefreshMetadataByID>}
1925
+ * @memberof RefreshMetadataByIDRequest
1926
+ */
1927
+ 'metadata'?: Array<RefreshMetadataByID>;
1928
+ }
1929
+
1930
+ /**
1931
+ * Immutable zkEVM API
1932
+ * Immutable Multi Rollup API
1933
+ *
1934
+ * The version of the OpenAPI document: 1.0.0
1935
+ * Contact: support@immutable.com
1936
+ *
1937
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1938
+ * https://openapi-generator.tech
1939
+ * Do not edit the class manually.
1940
+ */
1941
+ /**
1942
+ *
1943
+ * @export
1944
+ * @interface RefreshMetadataByTokenIDAllOf
1945
+ */
1946
+ interface RefreshMetadataByTokenIDAllOf {
1947
+ /**
1948
+ * An `uint256` token id as string
1949
+ * @type {string}
1950
+ * @memberof RefreshMetadataByTokenIDAllOf
1951
+ */
1952
+ 'token_id': string;
1953
+ }
1954
+
1955
+ /**
1956
+ * Immutable zkEVM API
1957
+ * Immutable Multi Rollup API
1958
+ *
1959
+ * The version of the OpenAPI document: 1.0.0
1960
+ * Contact: support@immutable.com
1961
+ *
1962
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1963
+ * https://openapi-generator.tech
1964
+ * Do not edit the class manually.
1965
+ */
1966
+
1967
+ /**
1968
+ * @type RefreshMetadataByTokenID
1969
+ * @export
1970
+ */
1971
+ type RefreshMetadataByTokenID = RefreshMetadataByTokenIDAllOf & RefreshableNFTAttributes;
1972
+
1973
+ /**
1974
+ * Immutable zkEVM API
1975
+ * Immutable Multi Rollup API
1976
+ *
1977
+ * The version of the OpenAPI document: 1.0.0
1978
+ * Contact: support@immutable.com
1979
+ *
1980
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1981
+ * https://openapi-generator.tech
1982
+ * Do not edit the class manually.
1983
+ */
1984
+
1985
+ /**
1986
+ *
1987
+ * @export
1988
+ * @interface RefreshNFTMetadataByTokenIDRequest
1989
+ */
1990
+ interface RefreshNFTMetadataByTokenIDRequest {
1991
+ /**
1992
+ * List of nft metadata to be refreshed
1993
+ * @type {Array<RefreshMetadataByTokenID>}
1994
+ * @memberof RefreshNFTMetadataByTokenIDRequest
1995
+ */
1996
+ 'nft_metadata': Array<RefreshMetadataByTokenID>;
1997
+ }
1998
+
1631
1999
  /**
1632
2000
  * Request parameters for getActivity operation in ActivitiesApi.
1633
2001
  * @export
@@ -1810,6 +2178,82 @@ interface CollectionsApiListCollectionsByNFTOwnerRequest {
1810
2178
  */
1811
2179
  readonly pageSize?: number;
1812
2180
  }
2181
+ /**
2182
+ * Request parameters for refreshCollectionMetadata operation in CollectionsApi.
2183
+ * @export
2184
+ * @interface CollectionsApiRefreshCollectionMetadataRequest
2185
+ */
2186
+ interface CollectionsApiRefreshCollectionMetadataRequest {
2187
+ /**
2188
+ * The address contract
2189
+ * @type {string}
2190
+ * @memberof CollectionsApiRefreshCollectionMetadata
2191
+ */
2192
+ readonly contractAddress: string;
2193
+ /**
2194
+ * The name of chain
2195
+ * @type {string}
2196
+ * @memberof CollectionsApiRefreshCollectionMetadata
2197
+ */
2198
+ readonly chainName: string;
2199
+ /**
2200
+ * The request body
2201
+ * @type {RefreshCollectionMetadataRequest}
2202
+ * @memberof CollectionsApiRefreshCollectionMetadata
2203
+ */
2204
+ readonly refreshCollectionMetadataRequest: RefreshCollectionMetadataRequest;
2205
+ }
2206
+
2207
+ /**
2208
+ * Request parameters for refreshMetadataByID operation in MetadataApi.
2209
+ * @export
2210
+ * @interface MetadataApiRefreshMetadataByIDRequest
2211
+ */
2212
+ interface MetadataApiRefreshMetadataByIDRequest {
2213
+ /**
2214
+ * The name of chain
2215
+ * @type {string}
2216
+ * @memberof MetadataApiRefreshMetadataByID
2217
+ */
2218
+ readonly chainName: string;
2219
+ /**
2220
+ * Contract address
2221
+ * @type {string}
2222
+ * @memberof MetadataApiRefreshMetadataByID
2223
+ */
2224
+ readonly contractAddress: string;
2225
+ /**
2226
+ * NFT Metadata Refresh Request
2227
+ * @type {RefreshMetadataByIDRequest}
2228
+ * @memberof MetadataApiRefreshMetadataByID
2229
+ */
2230
+ readonly refreshMetadataByIDRequest: RefreshMetadataByIDRequest;
2231
+ }
2232
+ /**
2233
+ * Request parameters for refreshNFTMetadataByTokenID operation in MetadataApi.
2234
+ * @export
2235
+ * @interface MetadataApiRefreshNFTMetadataByTokenIDRequest
2236
+ */
2237
+ interface MetadataApiRefreshNFTMetadataByTokenIDRequest {
2238
+ /**
2239
+ * The address of contract
2240
+ * @type {string}
2241
+ * @memberof MetadataApiRefreshNFTMetadataByTokenID
2242
+ */
2243
+ readonly contractAddress: string;
2244
+ /**
2245
+ * The name of chain
2246
+ * @type {string}
2247
+ * @memberof MetadataApiRefreshNFTMetadataByTokenID
2248
+ */
2249
+ readonly chainName: string;
2250
+ /**
2251
+ * the request body
2252
+ * @type {RefreshNFTMetadataByTokenIDRequest}
2253
+ * @memberof MetadataApiRefreshNFTMetadataByTokenID
2254
+ */
2255
+ readonly refreshNFTMetadataByTokenIDRequest: RefreshNFTMetadataByTokenIDRequest;
2256
+ }
1813
2257
 
1814
2258
  /**
1815
2259
  * Request parameters for listNFTOwners operation in NftOwnersApi.
@@ -2010,6 +2454,7 @@ declare class APIError$1 extends Error {
2010
2454
  interface APIConfigurationParams {
2011
2455
  basePath: string;
2012
2456
  headers?: Record<string, string>;
2457
+ baseConfig?: ImmutableConfiguration;
2013
2458
  }
2014
2459
  interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
2015
2460
  }
@@ -2027,6 +2472,7 @@ declare class BlockchainData {
2027
2472
  private readonly nfts;
2028
2473
  private readonly nftOwners;
2029
2474
  private readonly tokens;
2475
+ private readonly metadata;
2030
2476
  constructor(moduleConfig: BlockchainDataModuleConfiguration);
2031
2477
  /**
2032
2478
  * List all activities
@@ -2112,6 +2558,27 @@ declare class BlockchainData {
2112
2558
  * @throws {@link index.APIError}
2113
2559
  */
2114
2560
  getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
2561
+ /**
2562
+ * Refresh collection metadata
2563
+ * @param request - the request object containing the parameters to be provided in the API request
2564
+ * @returns a promise that resolves with the updated collection
2565
+ * @throws {@link index.APIError}
2566
+ */
2567
+ refreshCollectionMetadata(request: CollectionsApiRefreshCollectionMetadataRequest): Promise<RefreshCollectionMetadataResult>;
2568
+ /**
2569
+ * Refresh metadata for specific NFTs
2570
+ * @param request - the request object containing the parameters to be provided in the API request
2571
+ * @returns a promise that resolves with the remaining rate limits
2572
+ * @throws {@link index.APIError}
2573
+ */
2574
+ refreshNFTMetadata(request: MetadataApiRefreshNFTMetadataByTokenIDRequest): Promise<MetadataRefreshRateLimitResult>;
2575
+ /**
2576
+ * Refresh metadata by ID. This will refresh metadata for all NFTs that reference the given metadata ID.
2577
+ * @param request - the request object containing the parameters to be provided in the API request
2578
+ * @returns a promise that resolves with the remaining rate limits
2579
+ * @throws {@link index.APIError}
2580
+ */
2581
+ refreshStackedMetadata(request: MetadataApiRefreshMetadataByIDRequest): Promise<MetadataRefreshRateLimitResult>;
2115
2582
  }
2116
2583
 
2117
2584
  type ActivityType = ActivityType$1;
@@ -13414,7 +13881,7 @@ declare namespace Fee$2 {
13414
13881
  }
13415
13882
  }
13416
13883
 
13417
- type ERC20Item$2 = {
13884
+ type ERC20Item$1 = {
13418
13885
  /**
13419
13886
  * Token type user is offering, which in this case is ERC20
13420
13887
  */
@@ -13429,7 +13896,7 @@ type ERC20Item$2 = {
13429
13896
  start_amount: string;
13430
13897
  };
13431
13898
 
13432
- type ERC721Item$2 = {
13899
+ type ERC721Item$1 = {
13433
13900
  /**
13434
13901
  * Token type user is offering, which in this case is ERC721
13435
13902
  */
@@ -13444,7 +13911,7 @@ type ERC721Item$2 = {
13444
13911
  token_id: string;
13445
13912
  };
13446
13913
 
13447
- type NativeItem$2 = {
13914
+ type NativeItem$1 = {
13448
13915
  /**
13449
13916
  * Token type user is offering, which in this case is the native IMX token
13450
13917
  */
@@ -13455,7 +13922,7 @@ type NativeItem$2 = {
13455
13922
  start_amount: string;
13456
13923
  };
13457
13924
 
13458
- type Item = (NativeItem$2 | ERC20Item$2 | ERC721Item$2);
13925
+ type Item = (NativeItem$1 | ERC20Item$1 | ERC721Item$1);
13459
13926
 
13460
13927
  type ProtocolData = {
13461
13928
  /**
@@ -13815,17 +14282,17 @@ declare class OrdersService {
13815
14282
  }): CancelablePromise<TradeResult$1>;
13816
14283
  }
13817
14284
 
13818
- interface ERC721Item$1 {
14285
+ interface ERC721Item {
13819
14286
  type: 'ERC721';
13820
14287
  contractAddress: string;
13821
14288
  tokenId: string;
13822
14289
  }
13823
- interface ERC20Item$1 {
14290
+ interface ERC20Item {
13824
14291
  type: 'ERC20';
13825
14292
  contractAddress: string;
13826
14293
  amount: string;
13827
14294
  }
13828
- interface NativeItem$1 {
14295
+ interface NativeItem {
13829
14296
  type: 'NATIVE';
13830
14297
  amount: string;
13831
14298
  }
@@ -13835,8 +14302,8 @@ interface RoyaltyInfo {
13835
14302
  }
13836
14303
  interface PrepareListingParams {
13837
14304
  makerAddress: string;
13838
- sell: ERC721Item$1;
13839
- buy: ERC20Item$1 | NativeItem$1;
14305
+ sell: ERC721Item;
14306
+ buy: ERC20Item | NativeItem;
13840
14307
  orderExpiry?: Date;
13841
14308
  }
13842
14309
  interface PrepareListingResponse {
@@ -13907,8 +14374,8 @@ interface CancelOrderResponse {
13907
14374
  interface Order {
13908
14375
  id: string;
13909
14376
  accountAddress: string;
13910
- buy: (ERC20Item$1 | NativeItem$1)[];
13911
- sell: ERC721Item$1[];
14377
+ buy: (ERC20Item | NativeItem)[];
14378
+ sell: ERC721Item[];
13912
14379
  fees: Fee$1[];
13913
14380
  chain: {
13914
14381
  id: string;
@@ -13959,8 +14426,8 @@ interface Trade {
13959
14426
  id: string;
13960
14427
  name: string;
13961
14428
  };
13962
- buy: (ERC20Item$1 | NativeItem$1)[];
13963
- sell: ERC721Item$1[];
14429
+ buy: (ERC20Item | NativeItem)[];
14430
+ sell: ERC721Item[];
13964
14431
  buyerFees: Fee$1[];
13965
14432
  sellerAddress: string;
13966
14433
  buyerAddress: string;
@@ -14081,6 +14548,8 @@ type orderbook_d_ActionType = ActionType;
14081
14548
  declare const orderbook_d_ActionType: typeof ActionType;
14082
14549
  type orderbook_d_CancelOrderResponse = CancelOrderResponse;
14083
14550
  type orderbook_d_CreateListingParams = CreateListingParams;
14551
+ type orderbook_d_ERC20Item = ERC20Item;
14552
+ type orderbook_d_ERC721Item = ERC721Item;
14084
14553
  type orderbook_d_FeeType = FeeType;
14085
14554
  declare const orderbook_d_FeeType: typeof FeeType;
14086
14555
  type orderbook_d_FeeValue = FeeValue;
@@ -14090,6 +14559,7 @@ type orderbook_d_ListListingsResult = ListListingsResult;
14090
14559
  type orderbook_d_ListTradesParams = ListTradesParams;
14091
14560
  type orderbook_d_ListTradesResult = ListTradesResult;
14092
14561
  type orderbook_d_ListingResult = ListingResult;
14562
+ type orderbook_d_NativeItem = NativeItem;
14093
14563
  type orderbook_d_Order = Order;
14094
14564
  type orderbook_d_OrderStatus = OrderStatus;
14095
14565
  declare const orderbook_d_OrderStatus: typeof OrderStatus;
@@ -14115,8 +14585,8 @@ declare namespace orderbook_d {
14115
14585
  orderbook_d_ActionType as ActionType,
14116
14586
  orderbook_d_CancelOrderResponse as CancelOrderResponse,
14117
14587
  orderbook_d_CreateListingParams as CreateListingParams,
14118
- ERC20Item$1 as ERC20Item,
14119
- ERC721Item$1 as ERC721Item,
14588
+ orderbook_d_ERC20Item as ERC20Item,
14589
+ orderbook_d_ERC721Item as ERC721Item,
14120
14590
  Fee$1 as Fee,
14121
14591
  orderbook_d_FeeType as FeeType,
14122
14592
  orderbook_d_FeeValue as FeeValue,
@@ -14126,7 +14596,7 @@ declare namespace orderbook_d {
14126
14596
  orderbook_d_ListTradesParams as ListTradesParams,
14127
14597
  orderbook_d_ListTradesResult as ListTradesResult,
14128
14598
  orderbook_d_ListingResult as ListingResult,
14129
- NativeItem$1 as NativeItem,
14599
+ orderbook_d_NativeItem as NativeItem,
14130
14600
  orderbook_d_Order as Order,
14131
14601
  orderbook_d_OrderStatus as OrderStatus,
14132
14602
  orderbook_d_Orderbook as Orderbook,
@@ -14486,11 +14956,6 @@ type ERC721ItemRequirement = {
14486
14956
  id: string;
14487
14957
  spenderAddress: string;
14488
14958
  };
14489
- /**
14490
- * Represents the item requirements for a transaction.
14491
- * NativeItem, ERC20Item or ERC721Item {@link Checkout.smartCheckout}.
14492
- */
14493
- type ItemRequirement = NativeItem | ERC20Item | ERC721Item;
14494
14959
  /**
14495
14960
  * An enum representing the item types
14496
14961
  * @enum {string}
@@ -14503,41 +14968,6 @@ declare enum ItemType {
14503
14968
  ERC20 = "ERC20",
14504
14969
  ERC721 = "ERC721"
14505
14970
  }
14506
- /**
14507
- * Represents a native item.
14508
- * @property {ItemType} type - The type indicate this is a native item.
14509
- * @property {BigNumber} amount - The amount of the item.
14510
- */
14511
- type NativeItem = {
14512
- type: ItemType.NATIVE;
14513
- amount: BigNumber;
14514
- };
14515
- /**
14516
- * Represents an ERC20 item.
14517
- * @property {ItemType} type - The type to indicate this is an ERC20 item.
14518
- * @property {string} contractAddress - The contract address of the ERC20.
14519
- * @property {BigNumber} amount - The amount of the item.
14520
- * @property {string} spenderAddress - The contract address of the approver.
14521
- */
14522
- type ERC20Item = {
14523
- type: ItemType.ERC20;
14524
- contractAddress: string;
14525
- amount: BigNumber;
14526
- spenderAddress: string;
14527
- };
14528
- /**
14529
- * Represents an ERC721 item.
14530
- * @property {ItemType} type - The type to indicate this is an ERC721 item.
14531
- * @property {string} contractAddress - The contract address of the ERC721 collection.
14532
- * @property {string} id - The ID of this ERC721 in the collection.
14533
- * @property {string} spenderAddress - The contract address of the approver.
14534
- */
14535
- type ERC721Item = {
14536
- type: ItemType.ERC721;
14537
- contractAddress: string;
14538
- id: string;
14539
- spenderAddress: string;
14540
- };
14541
14971
  /**
14542
14972
  * An enum representing transaction or gas types
14543
14973
  * @enum {string}
@@ -14682,32 +15112,21 @@ type NoRouteOptions = {
14682
15112
  * Represents a funding route
14683
15113
  * @property {number} priority - The priority of the route
14684
15114
  * @property {FundingStep[]} steps - The steps associated with this funding route
14685
- * @property {TotalFees | undefined} totalFees - The total fees for this route
14686
15115
  */
14687
15116
  type FundingRoute = {
14688
15117
  priority: number;
14689
15118
  steps: FundingStep[];
14690
- totalFees?: TotalFees;
14691
- };
14692
- /**
14693
- * Represents the total fees for a route
14694
- * @property {Fee} gas - The total gas fees for this funding step
14695
- * @property {Fee} other - The total of all other fees associated with this funding step
14696
- * @property {Fee} total - The total combined gas and other fees for this funding step
14697
- */
14698
- type TotalFees = {
14699
- gas: Fee;
14700
- other: Fee;
14701
- total: Fee;
14702
15119
  };
14703
15120
  /**
14704
15121
  * Represents a fee
14705
15122
  * @property {BigNumber} amount - The amount of the fee
14706
15123
  * @property {string} formatted - The formatted amount of the fee
15124
+ * @property {TokenInfo | undefined} token - The token info for the fee
14707
15125
  */
14708
15126
  type Fee = {
14709
15127
  amount: BigNumber;
14710
15128
  formattedAmount: string;
15129
+ token?: TokenInfo;
14711
15130
  };
14712
15131
  type FundingStep = BridgeFundingStep | SwapFundingStep | OnRampFundingStep;
14713
15132
  /**
@@ -14874,6 +15293,24 @@ type AvailableRoutingOptions = {
14874
15293
  swap?: boolean;
14875
15294
  bridge?: boolean;
14876
15295
  };
15296
+ type FundingRouteFeeEstimate = SwapRouteFeeEstimate | BridgeRouteFeeEstimate;
15297
+ type SwapRouteFeeEstimate = {
15298
+ type: FundingStepType.SWAP;
15299
+ estimatedAmount: BigNumber;
15300
+ token: TokenInfo;
15301
+ };
15302
+ type BridgeRouteFeeEstimate = {
15303
+ type: FundingStepType.BRIDGE;
15304
+ gasFee: {
15305
+ estimatedAmount: BigNumber;
15306
+ token?: TokenInfo;
15307
+ };
15308
+ bridgeFee: {
15309
+ estimatedAmount: BigNumber;
15310
+ token?: TokenInfo;
15311
+ };
15312
+ totalFees: BigNumber;
15313
+ };
14877
15314
  /**
14878
15315
  * Interface representing the parameters for {@link Checkout.buy}
14879
15316
  * @property {Web3Provider} provider - The provider to use for the buy.
@@ -15565,6 +16002,8 @@ declare class Checkout {
15565
16002
  }
15566
16003
 
15567
16004
  type checkout_sdk_d_AllowedNetworkConfig = AllowedNetworkConfig;
16005
+ type checkout_sdk_d_AvailableRoutingOptions = AvailableRoutingOptions;
16006
+ type checkout_sdk_d_BalanceDelta = BalanceDelta;
15568
16007
  type checkout_sdk_d_BuyOrder = BuyOrder;
15569
16008
  type checkout_sdk_d_BuyParams = BuyParams;
15570
16009
  type checkout_sdk_d_BuyResult = BuyResult;
@@ -15597,6 +16036,12 @@ type checkout_sdk_d_FeePercentage = FeePercentage;
15597
16036
  type checkout_sdk_d_FeeToken = FeeToken;
15598
16037
  type checkout_sdk_d_FiatRampParams = FiatRampParams;
15599
16038
  type checkout_sdk_d_FulfillmentTransaction = FulfillmentTransaction;
16039
+ type checkout_sdk_d_FundingItem = FundingItem;
16040
+ type checkout_sdk_d_FundingRoute = FundingRoute;
16041
+ type checkout_sdk_d_FundingRouteFeeEstimate = FundingRouteFeeEstimate;
16042
+ type checkout_sdk_d_FundingStep = FundingStep;
16043
+ type checkout_sdk_d_FundingStepType = FundingStepType;
16044
+ declare const checkout_sdk_d_FundingStepType: typeof FundingStepType;
15600
16045
  type checkout_sdk_d_GasAmount = GasAmount;
15601
16046
  type checkout_sdk_d_GasEstimateBridgeToL2Result = GasEstimateBridgeToL2Result;
15602
16047
  type checkout_sdk_d_GasEstimateParams = GasEstimateParams;
@@ -15618,7 +16063,7 @@ type checkout_sdk_d_GetTokenAllowListParams = GetTokenAllowListParams;
15618
16063
  type checkout_sdk_d_GetTokenAllowListResult = GetTokenAllowListResult;
15619
16064
  type checkout_sdk_d_GetWalletAllowListParams = GetWalletAllowListParams;
15620
16065
  type checkout_sdk_d_GetWalletAllowListResult = GetWalletAllowListResult;
15621
- type checkout_sdk_d_ItemRequirement = ItemRequirement;
16066
+ type checkout_sdk_d_ItemBalance = ItemBalance;
15622
16067
  type checkout_sdk_d_ItemType = ItemType;
15623
16068
  declare const checkout_sdk_d_ItemType: typeof ItemType;
15624
16069
  type checkout_sdk_d_NativeItemRequirement = NativeItemRequirement;
@@ -15628,6 +16073,9 @@ declare const checkout_sdk_d_NetworkFilterTypes: typeof NetworkFilterTypes;
15628
16073
  type checkout_sdk_d_NetworkInfo = NetworkInfo;
15629
16074
  type checkout_sdk_d_OrderFee = OrderFee;
15630
16075
  type checkout_sdk_d_RemoteConfiguration = RemoteConfiguration;
16076
+ type checkout_sdk_d_RoutingOutcome = RoutingOutcome;
16077
+ type checkout_sdk_d_RoutingOutcomeType = RoutingOutcomeType;
16078
+ declare const checkout_sdk_d_RoutingOutcomeType: typeof RoutingOutcomeType;
15631
16079
  type checkout_sdk_d_SellOrder = SellOrder;
15632
16080
  type checkout_sdk_d_SellParams = SellParams;
15633
16081
  type checkout_sdk_d_SellResult = SellResult;
@@ -15635,6 +16083,8 @@ type checkout_sdk_d_SellToken = SellToken;
15635
16083
  type checkout_sdk_d_SendTransactionParams = SendTransactionParams;
15636
16084
  type checkout_sdk_d_SendTransactionResult = SendTransactionResult;
15637
16085
  type checkout_sdk_d_SmartCheckoutParams = SmartCheckoutParams;
16086
+ type checkout_sdk_d_SmartCheckoutResult = SmartCheckoutResult;
16087
+ type checkout_sdk_d_SmartCheckoutRouter = SmartCheckoutRouter;
15638
16088
  type checkout_sdk_d_SwitchNetworkParams = SwitchNetworkParams;
15639
16089
  type checkout_sdk_d_SwitchNetworkResult = SwitchNetworkResult;
15640
16090
  type checkout_sdk_d_TokenFilter = TokenFilter;
@@ -15643,6 +16093,7 @@ declare const checkout_sdk_d_TokenFilterTypes: typeof TokenFilterTypes;
15643
16093
  type checkout_sdk_d_TokenInfo = TokenInfo;
15644
16094
  type checkout_sdk_d_TransactionOrGasType = TransactionOrGasType;
15645
16095
  declare const checkout_sdk_d_TransactionOrGasType: typeof TransactionOrGasType;
16096
+ type checkout_sdk_d_TransactionRequirement = TransactionRequirement;
15646
16097
  type checkout_sdk_d_WalletFilter = WalletFilter;
15647
16098
  type checkout_sdk_d_WalletFilterTypes = WalletFilterTypes;
15648
16099
  declare const checkout_sdk_d_WalletFilterTypes: typeof WalletFilterTypes;
@@ -15652,6 +16103,8 @@ declare const checkout_sdk_d_WalletProviderName: typeof WalletProviderName;
15652
16103
  declare namespace checkout_sdk_d {
15653
16104
  export {
15654
16105
  checkout_sdk_d_AllowedNetworkConfig as AllowedNetworkConfig,
16106
+ checkout_sdk_d_AvailableRoutingOptions as AvailableRoutingOptions,
16107
+ checkout_sdk_d_BalanceDelta as BalanceDelta,
15655
16108
  checkout_sdk_d_BuyOrder as BuyOrder,
15656
16109
  checkout_sdk_d_BuyParams as BuyParams,
15657
16110
  checkout_sdk_d_BuyResult as BuyResult,
@@ -15678,6 +16131,11 @@ declare namespace checkout_sdk_d {
15678
16131
  checkout_sdk_d_FeeToken as FeeToken,
15679
16132
  checkout_sdk_d_FiatRampParams as FiatRampParams,
15680
16133
  checkout_sdk_d_FulfillmentTransaction as FulfillmentTransaction,
16134
+ checkout_sdk_d_FundingItem as FundingItem,
16135
+ checkout_sdk_d_FundingRoute as FundingRoute,
16136
+ checkout_sdk_d_FundingRouteFeeEstimate as FundingRouteFeeEstimate,
16137
+ checkout_sdk_d_FundingStep as FundingStep,
16138
+ checkout_sdk_d_FundingStepType as FundingStepType,
15681
16139
  checkout_sdk_d_GasAmount as GasAmount,
15682
16140
  checkout_sdk_d_GasEstimateBridgeToL2Result as GasEstimateBridgeToL2Result,
15683
16141
  checkout_sdk_d_GasEstimateParams as GasEstimateParams,
@@ -15697,7 +16155,7 @@ declare namespace checkout_sdk_d {
15697
16155
  checkout_sdk_d_GetTokenAllowListResult as GetTokenAllowListResult,
15698
16156
  checkout_sdk_d_GetWalletAllowListParams as GetWalletAllowListParams,
15699
16157
  checkout_sdk_d_GetWalletAllowListResult as GetWalletAllowListResult,
15700
- checkout_sdk_d_ItemRequirement as ItemRequirement,
16158
+ checkout_sdk_d_ItemBalance as ItemBalance,
15701
16159
  checkout_sdk_d_ItemType as ItemType,
15702
16160
  checkout_sdk_d_NativeItemRequirement as NativeItemRequirement,
15703
16161
  checkout_sdk_d_NetworkFilter as NetworkFilter,
@@ -15705,6 +16163,8 @@ declare namespace checkout_sdk_d {
15705
16163
  checkout_sdk_d_NetworkInfo as NetworkInfo,
15706
16164
  checkout_sdk_d_OrderFee as OrderFee,
15707
16165
  checkout_sdk_d_RemoteConfiguration as RemoteConfiguration,
16166
+ checkout_sdk_d_RoutingOutcome as RoutingOutcome,
16167
+ checkout_sdk_d_RoutingOutcomeType as RoutingOutcomeType,
15708
16168
  checkout_sdk_d_SellOrder as SellOrder,
15709
16169
  checkout_sdk_d_SellParams as SellParams,
15710
16170
  checkout_sdk_d_SellResult as SellResult,
@@ -15712,12 +16172,15 @@ declare namespace checkout_sdk_d {
15712
16172
  checkout_sdk_d_SendTransactionParams as SendTransactionParams,
15713
16173
  checkout_sdk_d_SendTransactionResult as SendTransactionResult,
15714
16174
  checkout_sdk_d_SmartCheckoutParams as SmartCheckoutParams,
16175
+ checkout_sdk_d_SmartCheckoutResult as SmartCheckoutResult,
16176
+ checkout_sdk_d_SmartCheckoutRouter as SmartCheckoutRouter,
15715
16177
  checkout_sdk_d_SwitchNetworkParams as SwitchNetworkParams,
15716
16178
  checkout_sdk_d_SwitchNetworkResult as SwitchNetworkResult,
15717
16179
  checkout_sdk_d_TokenFilter as TokenFilter,
15718
16180
  checkout_sdk_d_TokenFilterTypes as TokenFilterTypes,
15719
16181
  checkout_sdk_d_TokenInfo as TokenInfo,
15720
16182
  checkout_sdk_d_TransactionOrGasType as TransactionOrGasType,
16183
+ checkout_sdk_d_TransactionRequirement as TransactionRequirement,
15721
16184
  checkout_sdk_d_WalletFilter as WalletFilter,
15722
16185
  checkout_sdk_d_WalletFilterTypes as WalletFilterTypes,
15723
16186
  checkout_sdk_d_WalletInfo as WalletInfo,