@0xsequence/hooks 5.2.1 → 5.2.3

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

@@ -1,173 +0,0 @@
-import { findSupportedNetwork } from '@0xsequence/network';
-import { useQuery } from '@tanstack/react-query';
-import { NATIVE_TOKEN_ADDRESS_0X_SWAP, QUERY_KEYS, time, ZERO_ADDRESS } from '../../constants';
-import { compareAddress } from '../../utils/helpers';
-import { useAPIClient } from '../API/useAPIClient';
-import { useIndexerGatewayClient } from '../IndexerGateway/useIndexerGatewayClient';
-import { useMetadataClient } from '../Metadata/useMetadataClient';
-const getSwapPrices = async (apiClient, metadataClient, indexerGatewayClient, args) => {
-    if (!args.chainId || !args.userAddress || !args.buyCurrencyAddress || !args.buyAmount || args.buyAmount === '0') {
-        return [];
-    }
-    const network = findSupportedNetwork(args.chainId);
-    const { withContractInfo, ...swapPricesArgs } = args;
-    const isNativeTokenInArgs = compareAddress(args.buyCurrencyAddress, NATIVE_TOKEN_ADDRESS_0X_SWAP) || compareAddress(args.buyCurrencyAddress, ZERO_ADDRESS);
-    const res = await apiClient.getSwapPermit2Prices({
-        ...swapPricesArgs,
-        buyCurrencyAddress: isNativeTokenInArgs ? NATIVE_TOKEN_ADDRESS_0X_SWAP : args.buyCurrencyAddress
-    });
-    if (res.swapPermit2Prices === null) {
-        return [];
-    }
-    const currencyInfoMap = new Map();
-    if (withContractInfo) {
-        res?.swapPermit2Prices.forEach(price => {
-            const { currencyAddress } = price;
-            const isNativeToken = compareAddress(currencyAddress, NATIVE_TOKEN_ADDRESS_0X_SWAP || ZERO_ADDRESS);
-            if (currencyAddress && !currencyInfoMap.has(currencyAddress)) {
-                const getNativeTokenInfo = () => new Promise(resolve => {
-                    resolve({
-                        ...network?.nativeToken,
-                        logoURI: network?.logoURI || '',
-                        address: NATIVE_TOKEN_ADDRESS_0X_SWAP
-                    });
-                });
-                currencyInfoMap.set(currencyAddress, isNativeToken
-                    ? getNativeTokenInfo()
-                    : metadataClient
-                        .getContractInfo({
-                        chainID: String(args.chainId),
-                        contractAddress: currencyAddress
-                    })
-                        .then(data => ({ ...data.contractInfo }))
-                        .catch(error => {
-                        console.error(`Failed to fetch contract info for ${currencyAddress}:`, error);
-                        return undefined;
-                    }));
-            }
-        });
-    }
-    const currencyBalanceInfoMap = new Map();
-    res?.swapPermit2Prices.forEach(price => {
-        const { currencyAddress } = price;
-        const isNativeToken = compareAddress(currencyAddress, NATIVE_TOKEN_ADDRESS_0X_SWAP || ZERO_ADDRESS);
-        if (currencyAddress && !currencyBalanceInfoMap.has(currencyAddress)) {
-            const tokenBalance = indexerGatewayClient
-                .getTokenBalancesSummary({
-                chainIds: [args.chainId],
-                filter: {
-                    accountAddresses: [args.userAddress],
-                    contractWhitelist: [currencyAddress],
-                    omitNativeBalances: false
-                }
-            })
-                .then(res => {
-                if (isNativeToken) {
-                    return {
-                        balance: res.nativeBalances[0].results[0].balance
-                    };
-                }
-                else {
-                    return {
-                        balance: res.balances[0].results[0].balance
-                    };
-                }
-            })
-                .catch(error => {
-                console.error(`Failed to fetch balance for ${currencyAddress}:`, error);
-                return { balance: '0' };
-            });
-            currencyBalanceInfoMap.set(currencyAddress, tokenBalance);
-        }
-    });
-    return Promise.all(res?.swapPermit2Prices.map(async (price) => {
-        const { currencyAddress: rawCurrencyAddress } = price;
-        const currencyAddress = compareAddress(rawCurrencyAddress, NATIVE_TOKEN_ADDRESS_0X_SWAP)
-            ? NATIVE_TOKEN_ADDRESS_0X_SWAP
-            : rawCurrencyAddress;
-        return {
-            price: {
-                ...price,
-                currencyAddress
-            },
-            info: await currencyInfoMap.get(currencyAddress),
-            balance: (await currencyBalanceInfoMap.get(currencyAddress)) || { balance: '0' }
-        };
-    }) || []);
-};
-/**
- * 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();
-    const metadataClient = useMetadataClient();
-    const indexerGatewayClient = useIndexerGatewayClient();
-    const enabled = !!args.chainId &&
-        !!args.userAddress &&
-        !!args.buyCurrencyAddress &&
-        !!args.buyAmount &&
-        args.buyAmount !== '0' &&
-        !options?.disabled;
-    return useQuery({
-        queryKey: [QUERY_KEYS.useGetSwapPrices, args, options],
-        queryFn: () => getSwapPrices(apiClient, metadataClient, indexerGatewayClient, args),
-        retry: options?.retry ?? true,
-        // 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: time.oneHour,
-        enabled
-    });
-};
-//# sourceMappingURL=useGetSwapPrices.js.map

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

@@ -1 +0,0 @@
-{"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,IAAI,EAAE,YAAY,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,mBAAmB,GACvB,cAAc,CAAC,IAAI,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAA;IAChI,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,oBAAoB,CAAC;QAC/C,GAAG,cAAc;QACjB,kBAAkB,EAAE,mBAAmB,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB;KACjG,CAAC,CAAA;IAEF,IAAI,GAAG,CAAC,iBAAiB,KAAK,IAAI,EAAE,CAAC;QACnC,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,GAAG,EAA6C,CAAA;IAC5E,IAAI,gBAAgB,EAAE,CAAC;QACrB,GAAG,EAAE,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAA;YACjC,MAAM,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,4BAA4B,IAAI,YAAY,CAAC,CAAA;YACnG,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,4BAA4B;qBACtB,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,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACrC,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAA;QACjC,MAAM,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,4BAA4B,IAAI,YAAY,CAAC,CAAA;QAEnG,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,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;QACvC,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAA;QACrD,MAAM,eAAe,GAAG,cAAc,CAAC,kBAAkB,EAAE,4BAA4B,CAAC;YACtF,CAAC,CAAC,4BAA4B;YAC9B,CAAC,CAAC,kBAAkB,CAAA;QAEtB,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/tests/Combination/useGetSwapPrices.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=useGetSwapPrices.test.d.ts.map

package/dist/esm/tests/Combination/useGetSwapPrices.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useGetSwapPrices.test.d.ts","sourceRoot":"","sources":["../../../../src/tests/Combination/useGetSwapPrices.test.ts"],"names":[],"mappings":""}

package/dist/esm/tests/Combination/useGetSwapPrices.test.js

@@ -1,35 +0,0 @@
-import { renderHook, waitFor } from '@testing-library/react';
-import { HttpResponse, http } from 'msw';
-import { describe, expect, it } from 'vitest';
-import { ACCOUNT_ADDRESS, NATIVE_TOKEN_ADDRESS_0X_SWAP } from '../../constants';
-import { useGetSwapPrices } from '../../hooks/Combination/useGetSwapPrices';
-import { createWrapper } from '../createWrapper';
-import { server } from '../setup';
-const getSwapPricesArgs = {
-    userAddress: ACCOUNT_ADDRESS,
-    buyCurrencyAddress: NATIVE_TOKEN_ADDRESS_0X_SWAP,
-    chainId: 1,
-    buyAmount: '20000',
-    withContractInfo: true
-};
-describe('useGetSwapPrices', () => {
-    it('should return data with a balance', async () => {
-        const { result } = renderHook(() => useGetSwapPrices(getSwapPricesArgs), {
-            wrapper: createWrapper()
-        });
-        await waitFor(() => expect(result.current.isSuccess).toBe(true));
-        expect(result.current.data).toBeDefined();
-        const value = BigInt(result.current.data[0].balance.balance || 0);
-        expect(value).toBeGreaterThan(0);
-    });
-    it('should return error when fetching data fails', async () => {
-        server.use(http.post('*', () => {
-            return HttpResponse.error();
-        }));
-        const { result } = renderHook(() => useGetSwapPrices(getSwapPricesArgs, { retry: false }), {
-            wrapper: createWrapper()
-        });
-        await waitFor(() => expect(result.current.isError).toBe(true));
-    });
-});
-//# sourceMappingURL=useGetSwapPrices.test.js.map

package/dist/esm/tests/Combination/useGetSwapPrices.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useGetSwapPrices.test.js","sourceRoot":"","sources":["../../../../src/tests/Combination/useGetSwapPrices.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,KAAK,CAAA;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAE7C,OAAO,EAAE,eAAe,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAA;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,MAAM,iBAAiB,GAAG;IACxB,WAAW,EAAE,eAAe;IAC5B,kBAAkB,EAAE,4BAA4B;IAChD,OAAO,EAAE,CAAC;IACV,SAAS,EAAE,OAAO;IAClB,gBAAgB,EAAE,IAAI;CACvB,CAAA;AAED,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE;YACvE,OAAO,EAAE,aAAa,EAAE;SACzB,CAAC,CAAA;QAEF,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QAEhE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAA;QAEzC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC,CAAA;QAElE,MAAM,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,CAAC,GAAG,CACR,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE;YAClB,OAAO,YAAY,CAAC,KAAK,EAAE,CAAA;QAC7B,CAAC,CAAC,CACH,CAAA;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE;YACzF,OAAO,EAAE,aAAa,EAAE;SACzB,CAAC,CAAA;QAEF,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAChE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}