@0xsequence/hooks 6.0.0-beta.4 → 6.0.0

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

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useGetExchangeRate = void 0;
-const react_query_1 = require("@tanstack/react-query");
-const constants_js_1 = require("../../constants.js");
-const useAPIClient_js_1 = require("./useAPIClient.js");
-/**
- * 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-sdk/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 false)
- *   - 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`)
- * ```
- */
-const useGetExchangeRate = (toCurrency, options) => {
-    const apiClient = (0, useAPIClient_js_1.useAPIClient)();
-    return (0, react_query_1.useQuery)({
-        queryKey: [constants_js_1.QUERY_KEYS.useGetExchangeRate, toCurrency, options],
-        queryFn: async () => {
-            if (toCurrency === 'USD') {
-                return 1;
-            }
-            const res = await apiClient.getExchangeRate({ toCurrency });
-            return res.exchangeRate.value;
-        },
-        retry: options?.retry ?? false,
-        staleTime: constants_js_1.time.oneMinute * 10,
-        enabled: !!toCurrency && !options?.disabled
-    });
-};
-exports.useGetExchangeRate = useGetExchangeRate;
-//# sourceMappingURL=useGetExchangeRate.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useGetExchangeRate.js","sourceRoot":"","sources":["../../../../src/hooks/API/useGetExchangeRate.ts"],"names":[],"mappings":";;;AAAA,uDAAgD;AAEhD,qDAAqD;AAGrD,uDAAgD;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACI,MAAM,kBAAkB,GAAG,CAAC,UAAkB,EAAE,OAAsB,EAAE,EAAE;IAC/E,MAAM,SAAS,GAAG,IAAA,8BAAY,GAAE,CAAA;IAEhC,OAAO,IAAA,sBAAQ,EAAC;QACd,QAAQ,EAAE,CAAC,yBAAU,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,KAAK;QAC9B,SAAS,EAAE,mBAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,UAAU,IAAI,CAAC,OAAO,EAAE,QAAQ;KAC5C,CAAC,CAAA;AACJ,CAAC,CAAA;AAlBY,QAAA,kBAAkB,sBAkB9B"}

package/dist/cjs/hooks/API/useGetWaasStatus.d.ts

@@ -1,48 +0,0 @@
-import { type UseQueryResult } from '@tanstack/react-query';
-export type WaasErrorStatusResponse = {
-    status: number;
-    error: number;
-    code: string;
-    msg: string;
-};
-export type WaasSuccessStatusResponse = {
-    healthOK: boolean;
-    pcr0: string;
-    startTime: string;
-    uptime: string;
-    ver: string;
-};
-export type WaasStatusResponse = {
-    successResponse: WaasSuccessStatusResponse | undefined;
-    errorResponse: WaasErrorStatusResponse | undefined;
-};
-/**
- * React hook to fetch the current WAAS (Wallet as a Service) status from the backend API.
- *
- * @returns {UseQueryResult<WaasStatusResponse, Error>} The react-query result object containing:
- *   - data: The WAAS status response
- *     - successResponse: The WAAS status response if the request is successful
- *     - errorResponse: The WAAS status response if the request is not successful
- *   - error: Any error encountered during fetch
- *   - isLoading: Boolean indicating if the request is in progress
- *   - isSuccess, isError, refetch, etc.
- *
- * An error will be thrown only if the endpoint is not reachable or has an unhandled error.
- *
- * @example
- * ```tsx
- * import { useGetWaasStatus } from '@0xsequence/hooks'
- *
- * const MyComponent = () => {
- *   const { data, isLoading, error } = useGetWaasStatus()
- *
- *   if (isLoading) return <div>Loading...</div>
- *   if (error) return <div>Error: {error.message}</div>
- *   if (!data) return <div>No status available</div>
- *
- *   return <div>Status: {data.successResponse?.healthOK ? 'OK' : data.errorResponse?.msg}</div>
- * }
- * ```
- */
-export declare const useGetWaasStatus: () => UseQueryResult<WaasStatusResponse, Error>;
-//# sourceMappingURL=useGetWaasStatus.d.ts.map

package/dist/cjs/hooks/API/useGetWaasStatus.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useGetWaasStatus.d.ts","sourceRoot":"","sources":["../../../../src/hooks/API/useGetWaasStatus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAIrE,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,OAAO,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,eAAe,EAAE,yBAAyB,GAAG,SAAS,CAAA;IACtD,aAAa,EAAE,uBAAuB,GAAG,SAAS,CAAA;CACnD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,gBAAgB,QAAO,cAAc,CAAC,kBAAkB,EAAE,KAAK,CAa3E,CAAA"}

package/dist/cjs/hooks/API/useGetWaasStatus.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useGetWaasStatus = void 0;
-const react_query_1 = require("@tanstack/react-query");
-const constants_js_1 = require("../../constants.js");
-/**
- * React hook to fetch the current WAAS (Wallet as a Service) status from the backend API.
- *
- * @returns {UseQueryResult<WaasStatusResponse, Error>} The react-query result object containing:
- *   - data: The WAAS status response
- *     - successResponse: The WAAS status response if the request is successful
- *     - errorResponse: The WAAS status response if the request is not successful
- *   - error: Any error encountered during fetch
- *   - isLoading: Boolean indicating if the request is in progress
- *   - isSuccess, isError, refetch, etc.
- *
- * An error will be thrown only if the endpoint is not reachable or has an unhandled error.
- *
- * @example
- * ```tsx
- * import { useGetWaasStatus } from '@0xsequence/hooks'
- *
- * const MyComponent = () => {
- *   const { data, isLoading, error } = useGetWaasStatus()
- *
- *   if (isLoading) return <div>Loading...</div>
- *   if (error) return <div>Error: {error.message}</div>
- *   if (!data) return <div>No status available</div>
- *
- *   return <div>Status: {data.successResponse?.healthOK ? 'OK' : data.errorResponse?.msg}</div>
- * }
- * ```
- */
-const useGetWaasStatus = () => {
-    return (0, react_query_1.useQuery)({
-        queryKey: ['waasStatus'],
-        queryFn: async () => {
-            const res = await fetch(constants_js_1.WAAS_STATUS_URL);
-            const data = await res.json();
-            return {
-                successResponse: data.healthOK ? data : undefined,
-                errorResponse: data.error ? data : undefined
-            };
-        },
-        retry: false
-    });
-};
-exports.useGetWaasStatus = useGetWaasStatus;
-//# sourceMappingURL=useGetWaasStatus.js.map

package/dist/cjs/hooks/API/useGetWaasStatus.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useGetWaasStatus.js","sourceRoot":"","sources":["../../../../src/hooks/API/useGetWaasStatus.ts"],"names":[],"mappings":";;;AAAA,uDAAqE;AAErE,qDAAoD;AAsBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,MAAM,gBAAgB,GAAG,GAA8C,EAAE;IAC9E,OAAO,IAAA,sBAAQ,EAAC;QACd,QAAQ,EAAE,CAAC,YAAY,CAAC;QACxB,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,8BAAe,CAAC,CAAA;YACxC,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;YAC7B,OAAO;gBACL,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAE,IAAkC,CAAC,CAAC,CAAC,SAAS;gBAChF,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,IAAgC,CAAC,CAAC,CAAC,SAAS;aAC1E,CAAA;QACH,CAAC;QACD,KAAK,EAAE,KAAK;KACb,CAAC,CAAA;AACJ,CAAC,CAAA;AAbY,QAAA,gBAAgB,oBAa5B"}

package/dist/cjs/hooks/Builder/useDetectContractVersion.d.ts

@@ -1,30 +0,0 @@
-import type { HooksOptions } from '../../types/hooks.js';
-/**
- * Hook to fetch the version of a contract.
- *
- * This hook uses React Query to fetch and cache the version of a contract.
- *
- *
- * @param args - The arguments for the hook:
- *   - address: The address of the contract
- *   - chainId: The chain id of the contract
- *
- * @param options - Optional configuration options:
- *   - retry: Whether to retry failed requests (defaults to false)
- *   - disabled: Whether to disable the query
- *
- * @returns React Query result object containing:
- *   - data: The version of the contract
- *   - isLoading: Whether the initial request is in progress
- *   - error: Any error that occurred
- *   - isError: Whether an error occurred
- *   - isSuccess: Whether the request was successful
- *
- */
-interface DetectContractVersionArgs {
-    contractAddress: string;
-    chainId: number;
-}
-export declare const useDetectContractVersion: (args: DetectContractVersionArgs, options?: HooksOptions) => import("@tanstack/react-query").UseQueryResult<any, Error>;
-export {};
-//# sourceMappingURL=useDetectContractVersion.d.ts.map

package/dist/cjs/hooks/Builder/useDetectContractVersion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useDetectContractVersion.d.ts","sourceRoot":"","sources":["../../../../src/hooks/Builder/useDetectContractVersion.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAGxD;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,UAAU,yBAAyB;IACjC,eAAe,EAAE,MAAM,CAAA;IACvB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,eAAO,MAAM,wBAAwB,GAAI,MAAM,yBAAyB,EAAE,UAAU,YAAY,+DAkB/F,CAAA"}

package/dist/cjs/hooks/Builder/useDetectContractVersion.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useDetectContractVersion = void 0;
-const react_query_1 = require("@tanstack/react-query");
-const constants_js_1 = require("../../constants.js");
-const useConfig_js_1 = require("../useConfig.js");
-const useDetectContractVersion = (args, options) => {
-    const { projectAccessKey, env } = (0, useConfig_js_1.useConfig)();
-    return (0, react_query_1.useQuery)({
-        queryKey: [constants_js_1.QUERY_KEYS.useDetectContractVersion, args.contractAddress, args.chainId, options],
-        queryFn: async () => {
-            const res = await fetch(`${env.builderUrl}/rpc/ContractLibrary/DetectContractVersion`, {
-                method: 'POST',
-                headers: { 'Content-Type': 'application/json', 'X-Access-Key': projectAccessKey },
-                body: JSON.stringify({ address: args.contractAddress, chainId: args.chainId })
-            });
-            const data = await res.json();
-            return data;
-        },
-        retry: options?.retry ?? false,
-        staleTime: constants_js_1.time.oneMinute * 60,
-        enabled: !!args.contractAddress && !!args.chainId && !options?.disabled
-    });
-};
-exports.useDetectContractVersion = useDetectContractVersion;
-//# sourceMappingURL=useDetectContractVersion.js.map

package/dist/cjs/hooks/Builder/useDetectContractVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useDetectContractVersion.js","sourceRoot":"","sources":["../../../../src/hooks/Builder/useDetectContractVersion.ts"],"names":[],"mappings":";;;AAAA,uDAAgD;AAEhD,qDAAqD;AAErD,kDAA2C;AA8BpC,MAAM,wBAAwB,GAAG,CAAC,IAA+B,EAAE,OAAsB,EAAE,EAAE;IAClG,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,GAAG,IAAA,wBAAS,GAAE,CAAA;IAE7C,OAAO,IAAA,sBAAQ,EAAC;QACd,QAAQ,EAAE,CAAC,yBAAU,CAAC,wBAAwB,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;QAC5F,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,GAAG,CAAC,UAAU,4CAA4C,EAAE;gBACrF,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,gBAAgB,EAAE;gBACjF,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;aAC/E,CAAC,CAAA;YACF,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;YAC7B,OAAO,IAAI,CAAA;QACb,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,KAAK;QAC9B,SAAS,EAAE,mBAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE,QAAQ;KACxE,CAAC,CAAA;AACJ,CAAC,CAAA;AAlBY,QAAA,wBAAwB,4BAkBpC"}

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

@@ -1,97 +0,0 @@
-import type { GetLifiSwapQuoteRequest } from '@0xsequence/api';
-import type { HooksOptions } from '../../types/hooks.js';
-/**
- * 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-sdk/hooks/useGetSwapQuote} for more detailed documentation.
- *
- * @param getSwapQuoteArgs - Configuration object for the swap quote query:
- * - params: The parameters for the swap quote query
- *   - walletAddress: The address of the user's wallet
- *   - fromTokenAddress: The address of the currency to sell
- *   - toTokenAddress: The address of the currency to buy
- *   - fromTokenAmount?: The amount of currency to sell (optional)
- *   - toTokenAmount?: The amount of currency to buy (optional)
- *   - includeApprove: Whether to include approval data for ERC20 tokens
- *   - slippageBps: The slippage percentage for the swap
- *
- * @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:
- *   - quote: 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)
- *     - amount: The amount of currency to buy
- *     - amountMin: The minimum amount of currency to buy
- * - 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({
- *     params: {
- *       walletAddress: '0x123...',
- *       fromTokenAddress: '0x456...',
- *       toTokenAddress: '0x789...',
- *       fromTokenAmount: '1000000000000000000', // 1 token in base units
- *       includeApprove: true,
- *       slippageBps: 150,
- *       chainId: 1
- *     }
- *   })
- *
- *   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: GetLifiSwapQuoteRequest, options?: HooksOptions) => import("@tanstack/react-query").UseQueryResult<{
-    currencyAddress: string;
-    currencyBalance: string;
-    price: string;
-    maxPrice: string;
-    to: string;
-    transactionData: string;
-    transactionValue: string;
-    approveData: string;
-    amount: string;
-    amountMin: string;
-}, Error>;
-//# sourceMappingURL=useGetSwapQuote.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useGetSwapQuote.d.ts","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapQuote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAA;AAI9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAIxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiFG;AACH,eAAO,MAAM,eAAe,GAAI,kBAAkB,uBAAuB,EAAE,UAAU,YAAY;;;;;;;;;;;SAkChG,CAAA"}

package/dist/cjs/hooks/Combination/useGetSwapQuote.js

@@ -1,123 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useGetSwapQuote = void 0;
-const react_query_1 = require("@tanstack/react-query");
-const constants_js_1 = require("../../constants.js");
-const helpers_js_1 = require("../../utils/helpers.js");
-const useAPIClient_js_1 = require("../API/useAPIClient.js");
-/**
- * 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-sdk/hooks/useGetSwapQuote} for more detailed documentation.
- *
- * @param getSwapQuoteArgs - Configuration object for the swap quote query:
- * - params: The parameters for the swap quote query
- *   - walletAddress: The address of the user's wallet
- *   - fromTokenAddress: The address of the currency to sell
- *   - toTokenAddress: The address of the currency to buy
- *   - fromTokenAmount?: The amount of currency to sell (optional)
- *   - toTokenAmount?: The amount of currency to buy (optional)
- *   - includeApprove: Whether to include approval data for ERC20 tokens
- *   - slippageBps: The slippage percentage for the swap
- *
- * @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:
- *   - quote: 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)
- *     - amount: The amount of currency to buy
- *     - amountMin: The minimum amount of currency to buy
- * - 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({
- *     params: {
- *       walletAddress: '0x123...',
- *       fromTokenAddress: '0x456...',
- *       toTokenAddress: '0x789...',
- *       fromTokenAmount: '1000000000000000000', // 1 token in base units
- *       includeApprove: true,
- *       slippageBps: 150,
- *       chainId: 1
- *     }
- *   })
- *
- *   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>
- *   )
- * }
- * ```
- */
-const useGetSwapQuote = (getSwapQuoteArgs, options) => {
-    const apiClient = (0, useAPIClient_js_1.useAPIClient)();
-    return (0, react_query_1.useQuery)({
-        queryKey: [constants_js_1.QUERY_KEYS.useGetSwapQuote, getSwapQuoteArgs, options],
-        queryFn: async () => {
-            const res = await apiClient.getLifiSwapQuote({
-                params: {
-                    ...getSwapQuoteArgs.params,
-                    toTokenAddress: (0, helpers_js_1.compareAddress)(getSwapQuoteArgs.params.toTokenAddress, constants_js_1.ZERO_ADDRESS)
-                        ? constants_js_1.ZERO_ADDRESS
-                        : getSwapQuoteArgs.params.toTokenAddress,
-                    fromTokenAddress: (0, helpers_js_1.compareAddress)(getSwapQuoteArgs.params.fromTokenAddress, constants_js_1.ZERO_ADDRESS)
-                        ? constants_js_1.ZERO_ADDRESS
-                        : getSwapQuoteArgs.params.fromTokenAddress
-                }
-            });
-            return {
-                ...res.quote,
-                currencyAddress: (0, helpers_js_1.compareAddress)(res.quote.currencyAddress, constants_js_1.ZERO_ADDRESS) ? constants_js_1.ZERO_ADDRESS : res.quote.currencyAddress
-            };
-        },
-        retry: options?.retry ?? false,
-        staleTime: constants_js_1.time.oneMinute * 1,
-        enabled: !options?.disabled &&
-            !!getSwapQuoteArgs.params.walletAddress &&
-            !!getSwapQuoteArgs.params.fromTokenAddress &&
-            !!getSwapQuoteArgs.params.toTokenAddress &&
-            getSwapQuoteArgs.params.fromTokenAmount !== '0' &&
-            !!getSwapQuoteArgs.params.chainId &&
-            !!getSwapQuoteArgs.params.includeApprove
-    });
-};
-exports.useGetSwapQuote = useGetSwapQuote;
-//# sourceMappingURL=useGetSwapQuote.js.map

package/dist/cjs/hooks/Combination/useGetSwapQuote.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useGetSwapQuote.js","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapQuote.ts"],"names":[],"mappings":";;;AACA,uDAAgD;AAEhD,qDAAmE;AAEnE,uDAAuD;AACvD,4DAAqD;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiFG;AACI,MAAM,eAAe,GAAG,CAAC,gBAAyC,EAAE,OAAsB,EAAE,EAAE;IACnG,MAAM,SAAS,GAAG,IAAA,8BAAY,GAAE,CAAA;IAEhC,OAAO,IAAA,sBAAQ,EAAC;QACd,QAAQ,EAAE,CAAC,yBAAU,CAAC,eAAe,EAAE,gBAAgB,EAAE,OAAO,CAAC;QACjE,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,gBAAgB,CAAC;gBAC3C,MAAM,EAAE;oBACN,GAAG,gBAAgB,CAAC,MAAM;oBAC1B,cAAc,EAAE,IAAA,2BAAc,EAAC,gBAAgB,CAAC,MAAM,CAAC,cAAc,EAAE,2BAAY,CAAC;wBAClF,CAAC,CAAC,2BAAY;wBACd,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,cAAc;oBAC1C,gBAAgB,EAAE,IAAA,2BAAc,EAAC,gBAAgB,CAAC,MAAM,CAAC,gBAAgB,EAAE,2BAAY,CAAC;wBACtF,CAAC,CAAC,2BAAY;wBACd,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,gBAAgB;iBAC7C;aACF,CAAC,CAAA;YAEF,OAAO;gBACL,GAAG,GAAG,CAAC,KAAK;gBACZ,eAAe,EAAE,IAAA,2BAAc,EAAC,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,2BAAY,CAAC,CAAC,CAAC,CAAC,2BAAY,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe;aACpH,CAAA;QACH,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,KAAK;QAC9B,SAAS,EAAE,mBAAI,CAAC,SAAS,GAAG,CAAC;QAC7B,OAAO,EACL,CAAC,OAAO,EAAE,QAAQ;YAClB,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,aAAa;YACvC,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,gBAAgB;YAC1C,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,cAAc;YACxC,gBAAgB,CAAC,MAAM,CAAC,eAAe,KAAK,GAAG;YAC/C,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO;YACjC,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,cAAc;KAC3C,CAAC,CAAA;AACJ,CAAC,CAAA;AAlCY,QAAA,eAAe,mBAkC3B"}

package/dist/cjs/hooks/Combination/useGetSwapRoutes.d.ts

@@ -1,61 +0,0 @@
-import { type LifiSwapRoute } from '@0xsequence/api';
-import type { HooksOptions } from '../../types/hooks.js';
-/**
- * Arguments for the useGetSwapRoutes hook
- *
- * @property walletAddress - The address of the user's wallet
- * @property toTokenAddress - The address of the currency to buy
- * @property chainId - The chain ID where the swap will occur
- * @property toTokenAmount - The amount of the currency to buy
- */
-export interface UseGetSwapRoutesArgs {
-    walletAddress: string;
-    toTokenAddress: string;
-    chainId: number;
-    toTokenAmount: string;
-}
-/**
- * Hook to fetch available swap routes for a given token.
- *
- * This hook uses React Query to fetch and cache swap routes from the Sequence API.
- * Stale time is set to one hour by default
- *
- * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetSwapRoutes} for more detailed documentation.
- *
- * @param args - Arguments for fetching swap routes:
- *   - walletAddress: The address of the user's wallet
- *   - toTokenAddress: The address of the token to buy
- *   - chainId: The chain ID where the swap will occur
- *   - toTokenAmount: The amount of the token to buy
- *
- * @param options - Optional configuration options:
- *   - retry: Whether to retry failed requests (defaults to false)
- *   - disabled: Whether to disable the query
- *
- * @returns React Query result object containing:
- *   - data: Array of available swap routes 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: routes, isLoading, error } = useGetSwapRoutes({
- *   walletAddress: '0x123...',
- *   toTokenAddress: '0x456...',
- *   chainId: 1,
- *   toTokenAmount: '1000000000000000000' // 1 ETH in wei
- * })
- *
- * if (isLoading) {
- *   return <div>Loading swap routes...</div>
- * }
- *
- * if (routes?.length) {
- *   console.log('Best route:', routes[0])
- * }
- * ```
- */
-export declare const useGetSwapRoutes: (args: UseGetSwapRoutesArgs, options?: HooksOptions) => import("@tanstack/react-query").UseQueryResult<LifiSwapRoute[], Error>;
-//# sourceMappingURL=useGetSwapRoutes.d.ts.map

package/dist/cjs/hooks/Combination/useGetSwapRoutes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useGetSwapRoutes.d.ts","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapRoutes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgD,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAIlG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAGxD;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;CACtB;AA+BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,oBAAoB,EAAE,UAAU,YAAY,2EAclF,CAAA"}

package/dist/cjs/hooks/Combination/useGetSwapRoutes.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useGetSwapRoutes = void 0;
-const api_1 = require("@0xsequence/api");
-const react_query_1 = require("@tanstack/react-query");
-const constants_js_1 = require("../../constants.js");
-const useAPIClient_js_1 = require("../API/useAPIClient.js");
-const getSwapRoutes = async (apiClient, args) => {
-    if (!args.chainId || !args.toTokenAddress) {
-        return [];
-    }
-    const res = await apiClient.getLifiSwapRoutes({
-        params: {
-            direction: api_1.GetLifiSwapRouteDirection.to,
-            chainId: args.chainId,
-            walletAddress: args.walletAddress,
-            tokenAddress: args.toTokenAddress,
-            tokenAmount: args.toTokenAmount
-        }
-    });
-    if (res.routes.length === 0) {
-        return [];
-    }
-    return res.routes;
-};
-/**
- * Hook to fetch available swap routes for a given token.
- *
- * This hook uses React Query to fetch and cache swap routes from the Sequence API.
- * Stale time is set to one hour by default
- *
- * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetSwapRoutes} for more detailed documentation.
- *
- * @param args - Arguments for fetching swap routes:
- *   - walletAddress: The address of the user's wallet
- *   - toTokenAddress: The address of the token to buy
- *   - chainId: The chain ID where the swap will occur
- *   - toTokenAmount: The amount of the token to buy
- *
- * @param options - Optional configuration options:
- *   - retry: Whether to retry failed requests (defaults to false)
- *   - disabled: Whether to disable the query
- *
- * @returns React Query result object containing:
- *   - data: Array of available swap routes 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: routes, isLoading, error } = useGetSwapRoutes({
- *   walletAddress: '0x123...',
- *   toTokenAddress: '0x456...',
- *   chainId: 1,
- *   toTokenAmount: '1000000000000000000' // 1 ETH in wei
- * })
- *
- * if (isLoading) {
- *   return <div>Loading swap routes...</div>
- * }
- *
- * if (routes?.length) {
- *   console.log('Best route:', routes[0])
- * }
- * ```
- */
-const useGetSwapRoutes = (args, options) => {
-    const apiClient = (0, useAPIClient_js_1.useAPIClient)();
-    const enabled = !!args.chainId && !!args.toTokenAddress && !options?.disabled;
-    return (0, react_query_1.useQuery)({
-        queryKey: [constants_js_1.QUERY_KEYS.useGetSwapRoutes, args, options],
-        queryFn: () => getSwapRoutes(apiClient, args),
-        retry: options?.retry ?? false,
-        // We must keep a long staletime to avoid the list of quotes being refreshed while the user is doing the transactions
-        // Instead, we will invalidate the query manually
-        staleTime: constants_js_1.time.oneHour,
-        enabled
-    });
-};
-exports.useGetSwapRoutes = useGetSwapRoutes;
-//# sourceMappingURL=useGetSwapRoutes.js.map

package/dist/cjs/hooks/Combination/useGetSwapRoutes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useGetSwapRoutes.js","sourceRoot":"","sources":["../../../../src/hooks/Combination/useGetSwapRoutes.ts"],"names":[],"mappings":";;;AAAA,yCAAkG;AAClG,uDAAgD;AAEhD,qDAAqD;AAErD,4DAAqD;AAwBrD,MAAM,aAAa,GAAG,KAAK,EAAE,SAA4B,EAAE,IAAuB,EAA4B,EAAE;IAC9G,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,iBAAiB,CAAC;QAC5C,MAAM,EAAE;YACN,SAAS,EAAE,+BAAyB,CAAC,EAAE;YACvC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,YAAY,EAAE,IAAI,CAAC,cAAc;YACjC,WAAW,EAAE,IAAI,CAAC,aAAa;SAChC;KACF,CAAC,CAAA;IAEF,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,OAAO,GAAG,CAAC,MAAM,CAAA;AACnB,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACI,MAAM,gBAAgB,GAAG,CAAC,IAA0B,EAAE,OAAsB,EAAE,EAAE;IACrF,MAAM,SAAS,GAAG,IAAA,8BAAY,GAAE,CAAA;IAEhC,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAA;IAE7E,OAAO,IAAA,sBAAQ,EAAC;QACd,QAAQ,EAAE,CAAC,yBAAU,CAAC,gBAAgB,EAAE,IAAI,EAAE,OAAO,CAAC;QACtD,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC;QAC7C,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,KAAK;QAC9B,qHAAqH;QACrH,iDAAiD;QACjD,SAAS,EAAE,mBAAI,CAAC,OAAO;QACvB,OAAO;KACR,CAAC,CAAA;AACJ,CAAC,CAAA;AAdY,QAAA,gBAAgB,oBAc5B"}