@0xsequence/hooks 5.0.9 → 5.1.0

package/dist/esm/hooks/API/useGetCoinPrices.js

@@ -1,6 +1,14 @@
 import { useQuery } from '@tanstack/react-query';
 import { QUERY_KEYS, time } from '../../constants';
 import { useAPIClient } from './useAPIClient';
+/**
+ * Helper function to fetch coin prices from the Sequence API.
+ *
+ * @param apiClient - The Sequence API client instance
+ * @param tokens - Array of tokens to get prices for, each containing chainId and contractAddress
+ * @returns Array of token prices, or empty array if no tokens provided
+ * @internal
+ */
 const getCoinPrices = async (apiClient, tokens) => {
     if (tokens.length === 0) {
         return [];
@@ -9,7 +17,49 @@ const getCoinPrices = async (apiClient, tokens) => {
     return res?.tokenPrices || [];
 };
 /**
- * @description Gets the prices of a list of tokens
+ * Hook to fetch current prices for a list of tokens.
+ *
+ * This hook uses React Query to fetch and cache token prices from the Sequence API.
+ * Prices are automatically refreshed every minute to ensure they stay current.
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetCoinPrices} for more detailed documentation.
+ *
+ * @param tokens - Array of tokens to get prices for. Each token must include:
+ *   - chainId: The chain ID where the token exists
+ *   - contractAddress: The token's contract address (use ZERO_ADDRESS for native tokens)
+ *
+ * @param options - Optional configuration options:
+ *   - retry: Whether to retry failed requests (defaults to true)
+ *   - disabled: Whether to disable the query
+ *
+ * @returns React Query result object containing:
+ *   - data: Array of token prices when available
+ *   - isLoading: Whether the initial request is in progress
+ *   - error: Any error that occurred
+ *   - isError: Whether an error occurred
+ *   - isSuccess: Whether the request was successful
+ *
+ * @example
+ * ```tsx
+ * const { data: prices, isLoading, error } = useGetCoinPrices([
+ *   {
+ *     chainId: 1,
+ *     contractAddress: ZERO_ADDRESS // ETH
+ *   },
+ *   {
+ *     chainId: 137,
+ *     contractAddress: '0x...' // USDC on Polygon
+ *   }
+ * ])
+ *
+ * if (isLoading) {
+ *   return <div>Loading prices...</div>
+ * }
+ *
+ * if (prices) {
+ *   console.log('ETH price:', prices[0].price.value)
+ * }
+ * ```
  */
 export const useGetCoinPrices = (tokens, options) => {
     const apiClient = useAPIClient();

package/dist/esm/hooks/API/useGetCoinPrices.js.map

@@ -1 +1 @@
-{"version":3,"file":"useGetCoinPrices.js","sourceRoot":"","sources":["../../../../src/hooks/API/useGetCoinPrices.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,MAAM,aAAa,GAAG,KAAK,EAAE,SAA4B,EAAE,MAAe,EAAE,EAAE;IAC5E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAErD,OAAO,GAAG,EAAE,WAAW,IAAI,EAAE,CAAA;AAC/B,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAe,EAAE,OAAsB,EAAE,EAAE;IAC1E,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAEhC,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC;QACxD,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC;QAC/C,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KACjD,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"useGetCoinPrices.js","sourceRoot":"","sources":["../../../../src/hooks/API/useGetCoinPrices.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C;;;;;;;GAOG;AACH,MAAM,aAAa,GAAG,KAAK,EAAE,SAA4B,EAAE,MAAe,EAAE,EAAE;IAC5E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAErD,OAAO,GAAG,EAAE,WAAW,IAAI,EAAE,CAAA;AAC/B,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAe,EAAE,OAAsB,EAAE,EAAE;IAC1E,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAEhC,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC;QACxD,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC;QAC/C,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KACjD,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/esm/hooks/API/useGetCollectiblePrices.d.ts

@@ -1,7 +1,54 @@
 import { Token } from '@0xsequence/api';
 import { HooksOptions } from '../../types';
 /**
- * @description Gets the prices of a list of collectibles
+ * Hook to fetch current market prices for NFTs/collectibles.
+ *
+ * This hook uses React Query to fetch and cache collectible prices from the Sequence API.
+ * Prices are automatically refreshed every minute to ensure they stay current.
+ * Used in various UI components to display NFT valuations, particularly in collection views
+ * and transaction details.
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetCollectiblePrices} for more detailed documentation.
+ *
+ * @param tokens - Array of tokens to get prices for. Each token must include:
+ *   - chainId: The chain ID where the NFT exists
+ *   - contractAddress: The NFT collection's contract address
+ *   - tokenId: The specific token ID within the collection
+ *
+ * @param options - Optional configuration options:
+ *   - retry: Whether to retry failed requests (defaults to true)
+ *   - disabled: Whether to disable the query
+ *
+ * @returns React Query result object containing:
+ *   - data: Array of token prices when available, each containing:
+ *     - price: The price for the collection
+ *     - price24hChange: The price change for the collection in the last 24 hours (if available)
+ *     - floorPrice: The floor price for the collection (if available)
+ *     - buyPrice: Current market buy price (if available)
+ *     - sellPrice: Current market sell price (if available)
+ *   - isLoading: Whether the initial request is in progress
+ *   - error: Any error that occurred
+ *   - isError: Whether an error occurred
+ *   - isSuccess: Whether the request was successful
+ *
+ * @example
+ * ```tsx
+ * const { data: prices, isLoading } = useGetCollectiblePrices([
+ *   {
+ *     chainId: 1,
+ *     contractAddress: '0x...',  // NFT collection address
+ *     tokenId: '123'            // Specific NFT ID
+ *   }
+ * ])
+ *
+ * if (isLoading) {
+ *   return <div>Loading prices...</div>
+ * }
+ *
+ * if (prices?.[0]) {
+ *   console.log('Price:', prices[0].price.value)
+ * }
+ * ```
  */
 export declare const useGetCollectiblePrices: (tokens: Token[], options?: HooksOptions) => import("@tanstack/react-query").UseQueryResult<import("@0xsequence/api").TokenPrice[], Error>;
 //# sourceMappingURL=useGetCollectiblePrices.d.ts.map

package/dist/esm/hooks/API/useGetCollectiblePrices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useGetCollectiblePrices.d.ts","sourceRoot":"","sources":["../../../../src/hooks/API/useGetCollectiblePrices.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAI1D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAc1C;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAAI,QAAQ,KAAK,EAAE,EAAE,UAAU,YAAY,kGAU9E,CAAA"}
+{"version":3,"file":"useGetCollectiblePrices.d.ts","sourceRoot":"","sources":["../../../../src/hooks/API/useGetCollectiblePrices.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAI1D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAsB1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,eAAO,MAAM,uBAAuB,GAAI,QAAQ,KAAK,EAAE,EAAE,UAAU,YAAY,kGAU9E,CAAA"}

package/dist/esm/hooks/API/useGetCollectiblePrices.js

@@ -1,6 +1,14 @@
 import { useQuery } from '@tanstack/react-query';
 import { QUERY_KEYS, time } from '../../constants';
 import { useAPIClient } from './useAPIClient';
+/**
+ * Helper function to fetch collectible prices from the Sequence API.
+ *
+ * @param apiClient - The Sequence API client instance
+ * @param tokens - Array of tokens to get prices for. Each token should include chainId, contractAddress, and tokenId
+ * @returns Array of token prices with floor, buy, and sell prices, or empty array if no tokens provided
+ * @internal
+ */
 const getCollectiblePrices = async (apiClient, tokens) => {
     if (tokens.length === 0) {
         return [];
@@ -9,7 +17,54 @@ const getCollectiblePrices = async (apiClient, tokens) => {
     return res?.tokenPrices || [];
 };
 /**
- * @description Gets the prices of a list of collectibles
+ * Hook to fetch current market prices for NFTs/collectibles.
+ *
+ * This hook uses React Query to fetch and cache collectible prices from the Sequence API.
+ * Prices are automatically refreshed every minute to ensure they stay current.
+ * Used in various UI components to display NFT valuations, particularly in collection views
+ * and transaction details.
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetCollectiblePrices} for more detailed documentation.
+ *
+ * @param tokens - Array of tokens to get prices for. Each token must include:
+ *   - chainId: The chain ID where the NFT exists
+ *   - contractAddress: The NFT collection's contract address
+ *   - tokenId: The specific token ID within the collection
+ *
+ * @param options - Optional configuration options:
+ *   - retry: Whether to retry failed requests (defaults to true)
+ *   - disabled: Whether to disable the query
+ *
+ * @returns React Query result object containing:
+ *   - data: Array of token prices when available, each containing:
+ *     - price: The price for the collection
+ *     - price24hChange: The price change for the collection in the last 24 hours (if available)
+ *     - floorPrice: The floor price for the collection (if available)
+ *     - buyPrice: Current market buy price (if available)
+ *     - sellPrice: Current market sell price (if available)
+ *   - isLoading: Whether the initial request is in progress
+ *   - error: Any error that occurred
+ *   - isError: Whether an error occurred
+ *   - isSuccess: Whether the request was successful
+ *
+ * @example
+ * ```tsx
+ * const { data: prices, isLoading } = useGetCollectiblePrices([
+ *   {
+ *     chainId: 1,
+ *     contractAddress: '0x...',  // NFT collection address
+ *     tokenId: '123'            // Specific NFT ID
+ *   }
+ * ])
+ *
+ * if (isLoading) {
+ *   return <div>Loading prices...</div>
+ * }
+ *
+ * if (prices?.[0]) {
+ *   console.log('Price:', prices[0].price.value)
+ * }
+ * ```
  */
 export const useGetCollectiblePrices = (tokens, options) => {
     const apiClient = useAPIClient();

package/dist/esm/hooks/API/useGetCollectiblePrices.js.map

@@ -1 +1 @@
-{"version":3,"file":"useGetCollectiblePrices.js","sourceRoot":"","sources":["../../../../src/hooks/API/useGetCollectiblePrices.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,MAAM,oBAAoB,GAAG,KAAK,EAAE,SAA4B,EAAE,MAAe,EAAE,EAAE;IACnF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAE5D,OAAO,GAAG,EAAE,WAAW,IAAI,EAAE,CAAA;AAC/B,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAe,EAAE,OAAsB,EAAE,EAAE;IACjF,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAEhC,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,EAAE,OAAO,CAAC;QAC/D,OAAO,EAAE,GAAG,EAAE,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM,CAAC;QACtD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KACjD,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"useGetCollectiblePrices.js","sourceRoot":"","sources":["../../../../src/hooks/API/useGetCollectiblePrices.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAAG,KAAK,EAAE,SAA4B,EAAE,MAAe,EAAE,EAAE;IACnF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAE5D,OAAO,GAAG,EAAE,WAAW,IAAI,EAAE,CAAA;AAC/B,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAe,EAAE,OAAsB,EAAE,EAAE;IACjF,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAEhC,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,EAAE,OAAO,CAAC;QAC/D,OAAO,EAAE,GAAG,EAAE,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM,CAAC;QACtD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KACjD,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/esm/hooks/API/useGetExchangeRate.d.ts

@@ -1,6 +1,42 @@
 import { HooksOptions } from '../../types';
 /**
- * @description Gets the exchange rate from USD to another currency
+ * Hook to fetch current exchange rates from USD to other currencies.
+ *
+ * This hook uses React Query to fetch and cache exchange rates from the Sequence API.
+ * Rates are automatically refreshed every 10 minutes to ensure they stay current.
+ * Used throughout the wallet widget and checkout components to display fiat values
+ * for tokens and NFTs.
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetExchangeRate} for more detailed documentation.
+ *
+ * @param toCurrency - The target currency code (e.g., 'EUR', 'GBP', 'JPY').
+ *                     If 'USD' is provided, returns 1 as the conversion rate.
+ *
+ * @param options - Optional configuration options:
+ *   - retry: Whether to retry failed requests (defaults to true)
+ *   - disabled: Whether to disable the query
+ *
+ * @returns React Query result object containing:
+ *   - data: The exchange rate value from USD to the target currency
+ *   - isLoading: Whether the initial request is in progress
+ *   - error: Any error that occurred
+ *   - isError: Whether an error occurred
+ *   - isSuccess: Whether the request was successful
+ *
+ * @example
+ * ```tsx
+ * const { data: rate = 1, isLoading } = useGetExchangeRate('EUR')
+ *
+ * // Convert USD amount to EUR
+ * const usdAmount = 100
+ * const eurAmount = usdAmount * rate
+ *
+ * if (isLoading) {
+ *   return <div>Loading rates...</div>
+ * }
+ *
+ * console.log(`${usdAmount} USD = ${eurAmount} EUR`)
+ * ```
  */
 export declare const useGetExchangeRate: (toCurrency: string, options?: HooksOptions) => import("@tanstack/react-query").UseQueryResult<number, Error>;
 //# sourceMappingURL=useGetExchangeRate.d.ts.map

package/dist/esm/hooks/API/useGetExchangeRate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useGetExchangeRate.d.ts","sourceRoot":"","sources":["../../../../src/hooks/API/useGetExchangeRate.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI1C;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAAI,YAAY,MAAM,EAAE,UAAU,YAAY,kEAkB5E,CAAA"}
+{"version":3,"file":"useGetExchangeRate.d.ts","sourceRoot":"","sources":["../../../../src/hooks/API/useGetExchangeRate.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,eAAO,MAAM,kBAAkB,GAAI,YAAY,MAAM,EAAE,UAAU,YAAY,kEAkB5E,CAAA"}

package/dist/esm/hooks/API/useGetExchangeRate.js

@@ -2,7 +2,43 @@ import { useQuery } from '@tanstack/react-query';
 import { QUERY_KEYS, time } from '../../constants';
 import { useAPIClient } from './useAPIClient';
 /**
- * @description Gets the exchange rate from USD to another currency
+ * Hook to fetch current exchange rates from USD to other currencies.
+ *
+ * This hook uses React Query to fetch and cache exchange rates from the Sequence API.
+ * Rates are automatically refreshed every 10 minutes to ensure they stay current.
+ * Used throughout the wallet widget and checkout components to display fiat values
+ * for tokens and NFTs.
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetExchangeRate} for more detailed documentation.
+ *
+ * @param toCurrency - The target currency code (e.g., 'EUR', 'GBP', 'JPY').
+ *                     If 'USD' is provided, returns 1 as the conversion rate.
+ *
+ * @param options - Optional configuration options:
+ *   - retry: Whether to retry failed requests (defaults to true)
+ *   - disabled: Whether to disable the query
+ *
+ * @returns React Query result object containing:
+ *   - data: The exchange rate value from USD to the target currency
+ *   - isLoading: Whether the initial request is in progress
+ *   - error: Any error that occurred
+ *   - isError: Whether an error occurred
+ *   - isSuccess: Whether the request was successful
+ *
+ * @example
+ * ```tsx
+ * const { data: rate = 1, isLoading } = useGetExchangeRate('EUR')
+ *
+ * // Convert USD amount to EUR
+ * const usdAmount = 100
+ * const eurAmount = usdAmount * rate
+ *
+ * if (isLoading) {
+ *   return <div>Loading rates...</div>
+ * }
+ *
+ * console.log(`${usdAmount} USD = ${eurAmount} EUR`)
+ * ```
  */
 export const useGetExchangeRate = (toCurrency, options) => {
     const apiClient = useAPIClient();

package/dist/esm/hooks/API/useGetExchangeRate.js.map

@@ -1 +1 @@
-{"version":3,"file":"useGetExchangeRate.js","sourceRoot":"","sources":["../../../../src/hooks/API/useGetExchangeRate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,UAAkB,EAAE,OAAsB,EAAE,EAAE;IAC/E,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAEhC,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,kBAAkB,EAAE,UAAU,EAAE,OAAO,CAAC;QAC9D,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;gBACzB,OAAO,CAAC,CAAA;YACV,CAAC;YAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC,EAAE,UAAU,EAAE,CAAC,CAAA;YAE3D,OAAO,GAAG,CAAC,YAAY,CAAC,KAAK,CAAA;QAC/B,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,UAAU,IAAI,CAAC,OAAO,EAAE,QAAQ;KAC5C,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"useGetExchangeRate.js","sourceRoot":"","sources":["../../../../src/hooks/API/useGetExchangeRate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,UAAkB,EAAE,OAAsB,EAAE,EAAE;IAC/E,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAEhC,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,kBAAkB,EAAE,UAAU,EAAE,OAAO,CAAC;QAC9D,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;gBACzB,OAAO,CAAC,CAAA;YACV,CAAC;YAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC,EAAE,UAAU,EAAE,CAAC,CAAA;YAE3D,OAAO,GAAG,CAAC,YAAY,CAAC,KAAK,CAAA;QAC/B,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,UAAU,IAAI,CAAC,OAAO,EAAE,QAAQ;KAC5C,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/esm/hooks/Combination/useGetSwapPrices.d.ts

@@ -4,11 +4,27 @@ import { HooksOptions } from '../../types';
 interface Balance {
     balance: string;
 }
+/**
+ * Type representing a swap price with additional currency information
+ *
+ * @property price - The swap price information from the API
+ * @property info - Contract information for the currency, including name, symbol, decimals, etc.
+ * @property balance - The user's balance of this currency
+ */
 export type SwapPricesWithCurrencyInfo = {
     price: SwapPrice;
     info: ContractInfo | undefined;
     balance: Balance;
 };
+/**
+ * Arguments for the useGetSwapPrices hook
+ *
+ * @property userAddress - The address of the user's wallet
+ * @property buyCurrencyAddress - The address of the currency to buy
+ * @property buyAmount - The amount of currency to buy (in base units)
+ * @property chainId - The chain ID where the swap will occur
+ * @property withContractInfo - Whether to fetch additional contract info for each currency
+ */
 export interface UseGetSwapPricesArgs {
     userAddress: string;
     buyCurrencyAddress: string;
@@ -17,7 +33,59 @@ export interface UseGetSwapPricesArgs {
     withContractInfo?: boolean;
 }
 /**
- * @description Gets the Swap Prices for a given currency
+ * Hook to fetch available swap prices for a given currency pair.
+ *
+ * This hook provides functionality to:
+ * - Get swap prices for a specified currency and amount
+ * - Fetch token information and balances for available swap options
+ * - Support both native tokens and ERC20 tokens
+ * - Handle currency conversions and price formatting
+ *
+ * The hook automatically handles:
+ * - Native token address normalization (between 0x0 and 0xEEE...)
+ * - Contract information fetching (name, symbol, decimals, etc.)
+ * - Error handling for failed API calls or balance fetches
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetSwapPrices} for more detailed documentation.
+ *
+ * @param args - Configuration object for the swap prices query {@link UseGetSwapPricesArgs}
+ * @param options - Optional configuration for the hook behavior {@link HooksOptions}
+ *
+ * @returns A React Query result object containing:
+ * - data: Array of {@link SwapPricesWithCurrencyInfo} objects
+ * - isLoading: Whether the query is in progress
+ * - isError: Whether an error occurred
+ * - error: Any error that occurred
+ * - Other standard React Query properties
+ *
+ * @example
+ * ```tsx
+ * import { useGetSwapPrices } from '@0xsequence/hooks'
+ *
+ * function SwapComponent() {
+ *   const { data: swapPrices, isLoading } = useGetSwapPrices({
+ *     userAddress: '0x123...',
+ *     buyCurrencyAddress: '0x456...',
+ *     buyAmount: '1000000000000000000', // 1 token in base units
+ *     chainId: 1,
+ *     withContractInfo: true
+ *   })
+ *
+ *   if (isLoading) return <div>Loading...</div>
+ *
+ *   return (
+ *     <div>
+ *       {swapPrices?.map(swap => (
+ *         <div key={swap.info?.address}>
+ *           Token: {swap.info?.symbol}
+ *           Price: {swap.price.price}
+ *           Balance: {swap.balance.balance}
+ *         </div>
+ *       ))}
+ *     </div>
+ *   )
+ * }
+ * ```
  */
 export declare const useGetSwapPrices: (args: UseGetSwapPricesArgs, options?: HooksOptions) => import("@tanstack/react-query").UseQueryResult<SwapPricesWithCurrencyInfo[], Error>;
 export {};

package/dist/esm/hooks/Combination/useGetSwapPrices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useGetSwapPrices.d.ts","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapPrices.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE9D,OAAO,EAAE,YAAY,EAAoB,MAAM,sBAAsB,CAAA;AAKrE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAM1C,UAAU,OAAO;IACf,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,SAAS,CAAA;IAChB,IAAI,EAAE,YAAY,GAAG,SAAS,CAAA;IAC9B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AA8GD;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,oBAAoB,EAAE,UAAU,YAAY,wFAsBlF,CAAA"}
+{"version":3,"file":"useGetSwapPrices.d.ts","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapPrices.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE9D,OAAO,EAAE,YAAY,EAAoB,MAAM,sBAAsB,CAAA;AAKrE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAM1C,UAAU,OAAO;IACf,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,SAAS,CAAA;IAChB,IAAI,EAAE,YAAY,GAAG,SAAS,CAAA;IAC9B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AA8GD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,oBAAoB,EAAE,UAAU,YAAY,wFAsBlF,CAAA"}

package/dist/esm/hooks/Combination/useGetSwapPrices.js

@@ -92,7 +92,59 @@ const getSwapPrices = async (apiClient, metadataClient, indexerGatewayClient, ar
     }) || []);
 };
 /**
- * @description Gets the Swap Prices for a given currency
+ * Hook to fetch available swap prices for a given currency pair.
+ *
+ * This hook provides functionality to:
+ * - Get swap prices for a specified currency and amount
+ * - Fetch token information and balances for available swap options
+ * - Support both native tokens and ERC20 tokens
+ * - Handle currency conversions and price formatting
+ *
+ * The hook automatically handles:
+ * - Native token address normalization (between 0x0 and 0xEEE...)
+ * - Contract information fetching (name, symbol, decimals, etc.)
+ * - Error handling for failed API calls or balance fetches
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetSwapPrices} for more detailed documentation.
+ *
+ * @param args - Configuration object for the swap prices query {@link UseGetSwapPricesArgs}
+ * @param options - Optional configuration for the hook behavior {@link HooksOptions}
+ *
+ * @returns A React Query result object containing:
+ * - data: Array of {@link SwapPricesWithCurrencyInfo} objects
+ * - isLoading: Whether the query is in progress
+ * - isError: Whether an error occurred
+ * - error: Any error that occurred
+ * - Other standard React Query properties
+ *
+ * @example
+ * ```tsx
+ * import { useGetSwapPrices } from '@0xsequence/hooks'
+ *
+ * function SwapComponent() {
+ *   const { data: swapPrices, isLoading } = useGetSwapPrices({
+ *     userAddress: '0x123...',
+ *     buyCurrencyAddress: '0x456...',
+ *     buyAmount: '1000000000000000000', // 1 token in base units
+ *     chainId: 1,
+ *     withContractInfo: true
+ *   })
+ *
+ *   if (isLoading) return <div>Loading...</div>
+ *
+ *   return (
+ *     <div>
+ *       {swapPrices?.map(swap => (
+ *         <div key={swap.info?.address}>
+ *           Token: {swap.info?.symbol}
+ *           Price: {swap.price.price}
+ *           Balance: {swap.balance.balance}
+ *         </div>
+ *       ))}
+ *     </div>
+ *   )
+ * }
+ * ```
  */
 export const useGetSwapPrices = (args, options) => {
     const apiClient = useAPIClient();

package/dist/esm/hooks/Combination/useGetSwapPrices.js.map

@@ -1 +1 @@
-{"version":3,"file":"useGetSwapPrices.js","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapPrices.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,4BAA4B,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAE9F,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAA;AACnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AAoBjE,MAAM,aAAa,GAAG,KAAK,EACzB,SAA4B,EAC5B,cAAgC,EAChC,oBAA4C,EAC5C,IAA0B,EACa,EAAE;IACzC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,GAAG,EAAE,CAAC;QAChH,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAElD,MAAM,EAAE,gBAAgB,EAAE,GAAG,cAAc,EAAE,GAAG,IAAI,CAAA;IAEpD,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;IAEzD,IAAI,GAAG,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,GAAG,EAA6C,CAAA;IAC5E,IAAI,gBAAgB,EAAE,CAAC;QACrB,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC9B,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAA;YACrD,MAAM,eAAe,GAAG,cAAc,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAA;YAC5H,MAAM,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;YACnE,IAAI,eAAe,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;gBAC7D,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAC9B,IAAI,OAAO,CAAe,OAAO,CAAC,EAAE;oBAClC,OAAO,CAAC;wBACN,GAAG,OAAO,EAAE,WAAW;wBACvB,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,EAAE;wBAC/B,OAAO,EAAE,YAAY;qBACN,CAAC,CAAA;gBACpB,CAAC,CAAC,CAAA;gBAEJ,eAAe,CAAC,GAAG,CACjB,eAAe,EACf,aAAa;oBACX,CAAC,CAAC,kBAAkB,EAAE;oBACtB,CAAC,CAAC,cAAc;yBACX,eAAe,CAAC;wBACf,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;wBAC7B,eAAe,EAAE,eAAe;qBACjC,CAAC;yBACD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;yBACxC,KAAK,CAAC,KAAK,CAAC,EAAE;wBACb,OAAO,CAAC,KAAK,CAAC,qCAAqC,eAAe,GAAG,EAAE,KAAK,CAAC,CAAA;wBAC7E,OAAO,SAAS,CAAA;oBAClB,CAAC,CAAC,CACT,CAAA;YACH,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAA4B,CAAA;IAClE,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAC9B,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAA;QACrD,MAAM,eAAe,GAAG,cAAc,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAA;QAC5H,MAAM,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;QAEnE,IAAI,eAAe,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YACpE,MAAM,YAAY,GAAG,oBAAoB;iBACtC,uBAAuB,CAAC;gBACvB,QAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE;oBACN,gBAAgB,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC;oBACpC,iBAAiB,EAAE,CAAC,eAAe,CAAC;oBACpC,kBAAkB,EAAE,KAAK;iBAC1B;aACF,CAAC;iBACD,IAAI,CAAC,GAAG,CAAC,EAAE;gBACV,IAAI,aAAa,EAAE,CAAC;oBAClB,OAAO;wBACL,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;qBAClD,CAAA;gBACH,CAAC;qBAAM,CAAC;oBACN,OAAO;wBACL,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;qBAC5C,CAAA;gBACH,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,KAAK,CAAC,EAAE;gBACb,OAAO,CAAC,KAAK,CAAC,+BAA+B,eAAe,GAAG,EAAE,KAAK,CAAC,CAAA;gBACvE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAA;YACzB,CAAC,CAAC,CAAA;YAEJ,sBAAsB,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;QAC3D,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,GAAG,CAChB,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;QAChC,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAA;QACrD,MAAM,eAAe,GAAG,cAAc,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAA;QAE5H,OAAO;YACL,KAAK,EAAE;gBACL,GAAG,KAAK;gBACR,eAAe;aAChB;YACD,IAAI,EAAE,MAAM,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC;YAChD,OAAO,EAAE,CAAC,MAAM,sBAAsB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE;SACjF,CAAA;IACH,CAAC,CAAC,IAAI,EAAE,CACT,CAAA;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAA0B,EAAE,OAAsB,EAAE,EAAE;IACrF,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAChC,MAAM,cAAc,GAAG,iBAAiB,EAAE,CAAA;IAC1C,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,MAAM,OAAO,GACX,CAAC,CAAC,IAAI,CAAC,OAAO;QACd,CAAC,CAAC,IAAI,CAAC,WAAW;QAClB,CAAC,CAAC,IAAI,CAAC,kBAAkB;QACzB,CAAC,CAAC,IAAI,CAAC,SAAS;QAChB,IAAI,CAAC,SAAS,KAAK,GAAG;QACtB,CAAC,OAAO,EAAE,QAAQ,CAAA;IAEpB,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,IAAI,EAAE,OAAO,CAAC;QACtD,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,cAAc,EAAE,oBAAoB,EAAE,IAAI,CAAC;QACnF,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,qHAAqH;QACrH,iDAAiD;QACjD,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,OAAO;KACR,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"useGetSwapPrices.js","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapPrices.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,4BAA4B,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAE9F,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAA;AACnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AAoCjE,MAAM,aAAa,GAAG,KAAK,EACzB,SAA4B,EAC5B,cAAgC,EAChC,oBAA4C,EAC5C,IAA0B,EACa,EAAE;IACzC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,GAAG,EAAE,CAAC;QAChH,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAElD,MAAM,EAAE,gBAAgB,EAAE,GAAG,cAAc,EAAE,GAAG,IAAI,CAAA;IAEpD,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;IAEzD,IAAI,GAAG,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,GAAG,EAA6C,CAAA;IAC5E,IAAI,gBAAgB,EAAE,CAAC;QACrB,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC9B,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAA;YACrD,MAAM,eAAe,GAAG,cAAc,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAA;YAC5H,MAAM,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;YACnE,IAAI,eAAe,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;gBAC7D,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAC9B,IAAI,OAAO,CAAe,OAAO,CAAC,EAAE;oBAClC,OAAO,CAAC;wBACN,GAAG,OAAO,EAAE,WAAW;wBACvB,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,EAAE;wBAC/B,OAAO,EAAE,YAAY;qBACN,CAAC,CAAA;gBACpB,CAAC,CAAC,CAAA;gBAEJ,eAAe,CAAC,GAAG,CACjB,eAAe,EACf,aAAa;oBACX,CAAC,CAAC,kBAAkB,EAAE;oBACtB,CAAC,CAAC,cAAc;yBACX,eAAe,CAAC;wBACf,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;wBAC7B,eAAe,EAAE,eAAe;qBACjC,CAAC;yBACD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;yBACxC,KAAK,CAAC,KAAK,CAAC,EAAE;wBACb,OAAO,CAAC,KAAK,CAAC,qCAAqC,eAAe,GAAG,EAAE,KAAK,CAAC,CAAA;wBAC7E,OAAO,SAAS,CAAA;oBAClB,CAAC,CAAC,CACT,CAAA;YACH,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAA4B,CAAA;IAClE,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAC9B,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAA;QACrD,MAAM,eAAe,GAAG,cAAc,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAA;QAC5H,MAAM,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;QAEnE,IAAI,eAAe,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YACpE,MAAM,YAAY,GAAG,oBAAoB;iBACtC,uBAAuB,CAAC;gBACvB,QAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE;oBACN,gBAAgB,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC;oBACpC,iBAAiB,EAAE,CAAC,eAAe,CAAC;oBACpC,kBAAkB,EAAE,KAAK;iBAC1B;aACF,CAAC;iBACD,IAAI,CAAC,GAAG,CAAC,EAAE;gBACV,IAAI,aAAa,EAAE,CAAC;oBAClB,OAAO;wBACL,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;qBAClD,CAAA;gBACH,CAAC;qBAAM,CAAC;oBACN,OAAO;wBACL,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;qBAC5C,CAAA;gBACH,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,KAAK,CAAC,EAAE;gBACb,OAAO,CAAC,KAAK,CAAC,+BAA+B,eAAe,GAAG,EAAE,KAAK,CAAC,CAAA;gBACvE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAA;YACzB,CAAC,CAAC,CAAA;YAEJ,sBAAsB,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;QAC3D,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,GAAG,CAChB,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;QAChC,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAA;QACrD,MAAM,eAAe,GAAG,cAAc,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAA;QAE5H,OAAO;YACL,KAAK,EAAE;gBACL,GAAG,KAAK;gBACR,eAAe;aAChB;YACD,IAAI,EAAE,MAAM,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC;YAChD,OAAO,EAAE,CAAC,MAAM,sBAAsB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE;SACjF,CAAA;IACH,CAAC,CAAC,IAAI,EAAE,CACT,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAA0B,EAAE,OAAsB,EAAE,EAAE;IACrF,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAChC,MAAM,cAAc,GAAG,iBAAiB,EAAE,CAAA;IAC1C,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,MAAM,OAAO,GACX,CAAC,CAAC,IAAI,CAAC,OAAO;QACd,CAAC,CAAC,IAAI,CAAC,WAAW;QAClB,CAAC,CAAC,IAAI,CAAC,kBAAkB;QACzB,CAAC,CAAC,IAAI,CAAC,SAAS;QAChB,IAAI,CAAC,SAAS,KAAK,GAAG;QACtB,CAAC,OAAO,EAAE,QAAQ,CAAA;IAEpB,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,IAAI,EAAE,OAAO,CAAC;QACtD,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,cAAc,EAAE,oBAAoB,EAAE,IAAI,CAAC;QACnF,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,qHAAqH;QACrH,iDAAiD;QACjD,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,OAAO;KACR,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/esm/hooks/Combination/useGetSwapQuote.d.ts

@@ -1,9 +1,80 @@
-import { GetSwapQuoteArgs } from '@0xsequence/api';
+import { GetSwapQuoteV2Args } from '@0xsequence/api';
 import { HooksOptions } from '../../types';
 /**
- * @description Gets the swap quote for a given currency pair
+ * Hook to fetch a swap quote for exchanging between two currencies.
+ *
+ * This hook provides functionality to:
+ * - Get a quote for swapping between two currencies (native or ERC20)
+ * - Fetch necessary approval data for ERC20 tokens
+ * - Generate transaction data for executing the swap
+ *
+ * The hook automatically handles:
+ * - Native token address normalization (between 0x0 and 0xEEE...)
+ * - Approval data generation for ERC20 tokens when needed
+ * - Transaction data generation for the swap
+ * - Error handling for failed API calls
+ *
+ * Go to {@link https://docs.sequence.xyz/sdk/web/hooks/useGetSwapQuote} for more detailed documentation.
+ *
+ * @param getSwapQuoteArgs - Configuration object for the swap quote query:
+ * - userAddress: The address of the user's wallet
+ * - buyCurrencyAddress: The address of the currency to buy
+ * - sellCurrencyAddress: The address of the currency to sell
+ * - buyAmount: The amount of currency to buy (in base units)
+ * - chainId: The chain ID where the swap will occur
+ * - includeApprove: Whether to include approval data for ERC20 tokens
+ *
+ * @param options - Optional configuration for the hook behavior:
+ * - disabled: Whether to disable the query
+ * - retry: Whether to retry failed queries
+ * - Other standard React Query options
+ *
+ * @returns A React Query result object containing:
+ * - data: The swap quote data including:
+ *   - currencyAddress: The address of the currency being swapped
+ *   - currencyBalance: The user's balance of the currency
+ *   - price: The price for the swap
+ *   - maxPrice: The maximum price (including slippage)
+ *   - to: The target contract address for the swap
+ *   - transactionData: The calldata for the swap transaction
+ *   - transactionValue: The value to send with the transaction (for native tokens)
+ *   - approveData: The approval transaction data (if needed)
+ * - isLoading: Whether the query is in progress
+ * - isError: Whether an error occurred
+ * - error: Any error that occurred
+ * - Other standard React Query properties
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetSwapQuote} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useGetSwapQuote } from '@0xsequence/hooks'
+ *
+ * function SwapComponent() {
+ *   const { data: swapQuote, isLoading } = useGetSwapQuote({
+ *     userAddress: '0x123...',
+ *     buyCurrencyAddress: '0x456...',
+ *     sellCurrencyAddress: '0x789...',
+ *     buyAmount: '1000000000000000000', // 1 token in base units
+ *     chainId: 1,
+ *     includeApprove: true
+ *   })
+ *
+ *   if (isLoading) return <div>Loading...</div>
+ *
+ *   return (
+ *     <div>
+ *       <div>Price: {swapQuote?.price}</div>
+ *       <div>Max Price: {swapQuote?.maxPrice}</div>
+ *       <button onClick={() => executeSwap(swapQuote)}>
+ *         Swap Tokens
+ *       </button>
+ *     </div>
+ *   )
+ * }
+ * ```
  */
-export declare const useGetSwapQuote: (getSwapQuoteArgs: GetSwapQuoteArgs, options?: HooksOptions) => import("@tanstack/react-query").UseQueryResult<{
+export declare const useGetSwapQuote: (getSwapQuoteArgs: GetSwapQuoteV2Args, options?: HooksOptions) => import("@tanstack/react-query").UseQueryResult<{
     currencyAddress: string;
     currencyBalance: string;
     price: string;

package/dist/esm/hooks/Combination/useGetSwapQuote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useGetSwapQuote.d.ts","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapQuote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAIlD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI1C;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,kBAAkB,gBAAgB,EAAE,UAAU,YAAY;;;;;;;;;SA4BzF,CAAA"}
+{"version":3,"file":"useGetSwapQuote.d.ts","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapQuote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAIpD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,eAAO,MAAM,eAAe,GAAI,kBAAkB,kBAAkB,EAAE,UAAU,YAAY;;;;;;;;;SA4B3F,CAAA"}