From de9f7b8ef49926378fbbb94527d6c4796a5e9848 Mon Sep 17 00:00:00 2001 From: Mithat Akbulut Date: Fri, 10 Oct 2025 17:11:55 +0300 Subject: [PATCH] Update documentation links in various hooks to point to the new SDK structure --- packages/hooks/src/hooks/API/useAPIClient.ts | 1 - packages/hooks/src/hooks/API/useGetCoinPrices.ts | 2 +- packages/hooks/src/hooks/API/useGetCollectiblePrices.ts | 2 +- packages/hooks/src/hooks/API/useGetExchangeRate.ts | 2 +- packages/hooks/src/hooks/Builder/useFindVersion.ts | 1 - packages/hooks/src/hooks/Combination/useGetSwapQuote.ts | 2 +- packages/hooks/src/hooks/Combination/useGetSwapRoutes.ts | 2 +- .../hooks/src/hooks/Indexer/useGetTransactionHistory.ts | 2 +- .../src/hooks/Indexer/useGetTransactionHistorySummary.ts | 2 +- packages/hooks/src/hooks/Indexer/useIndexerClient.ts | 1 - .../src/hooks/IndexerGateway/useGetNativeTokenBalance.ts | 2 +- .../src/hooks/IndexerGateway/useGetSingleTokenBalance.ts | 8 ++++---- .../hooks/IndexerGateway/useGetTokenBalancesByContract.ts | 2 +- .../hooks/IndexerGateway/useGetTokenBalancesDetails.ts | 2 +- .../hooks/IndexerGateway/useGetTokenBalancesSummary.ts | 2 +- .../src/hooks/IndexerGateway/useIndexerGatewayClient.ts | 2 +- packages/hooks/src/hooks/Metadata/useGetContractInfo.ts | 2 +- .../src/hooks/Metadata/useGetMultipleContractsInfo.ts | 2 +- packages/hooks/src/hooks/Metadata/useGetTokenMetadata.ts | 2 +- packages/hooks/src/hooks/Metadata/useMetadataClient.ts | 2 +- 20 files changed, 20 insertions(+), 23 deletions(-) diff --git a/packages/hooks/src/hooks/API/useAPIClient.ts b/packages/hooks/src/hooks/API/useAPIClient.ts index 636d26b72..309ac8796 100644 --- a/packages/hooks/src/hooks/API/useAPIClient.ts +++ b/packages/hooks/src/hooks/API/useAPIClient.ts @@ -19,7 +19,6 @@ import { useConfig } from '../useConfig.js' * The client instance is memoized based on the project access key, meaning a new * instance is only created when the access key changes. * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useAPIClient} for more detailed documentation. * * @returns {SequenceAPIClient} A configured instance of the Sequence API client * diff --git a/packages/hooks/src/hooks/API/useGetCoinPrices.ts b/packages/hooks/src/hooks/API/useGetCoinPrices.ts index 418410246..4d6bd2567 100644 --- a/packages/hooks/src/hooks/API/useGetCoinPrices.ts +++ b/packages/hooks/src/hooks/API/useGetCoinPrices.ts @@ -30,7 +30,7 @@ const getCoinPrices = async (apiClient: SequenceAPIClient, tokens: Token[]) => { * 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. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/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 diff --git a/packages/hooks/src/hooks/API/useGetCollectiblePrices.ts b/packages/hooks/src/hooks/API/useGetCollectiblePrices.ts index 9d3fb7176..abf3f2f82 100644 --- a/packages/hooks/src/hooks/API/useGetCollectiblePrices.ts +++ b/packages/hooks/src/hooks/API/useGetCollectiblePrices.ts @@ -32,7 +32,7 @@ const getCollectiblePrices = async (apiClient: SequenceAPIClient, tokens: Token[ * 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. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/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 diff --git a/packages/hooks/src/hooks/API/useGetExchangeRate.ts b/packages/hooks/src/hooks/API/useGetExchangeRate.ts index ccf7305df..0fc42ea72 100644 --- a/packages/hooks/src/hooks/API/useGetExchangeRate.ts +++ b/packages/hooks/src/hooks/API/useGetExchangeRate.ts @@ -13,7 +13,7 @@ import { useAPIClient } from './useAPIClient.js' * 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. + * @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. diff --git a/packages/hooks/src/hooks/Builder/useFindVersion.ts b/packages/hooks/src/hooks/Builder/useFindVersion.ts index f4aa773df..f64f2a771 100644 --- a/packages/hooks/src/hooks/Builder/useFindVersion.ts +++ b/packages/hooks/src/hooks/Builder/useFindVersion.ts @@ -9,7 +9,6 @@ import { useConfig } from '../useConfig.js' * * This hook uses React Query to fetch and cache the version of a contract. * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useFindVersion} for more detailed documentation. * * @param args - The arguments for the hook: * - uid: The UID of the contract diff --git a/packages/hooks/src/hooks/Combination/useGetSwapQuote.ts b/packages/hooks/src/hooks/Combination/useGetSwapQuote.ts index d79963fc7..a5d2a24d5 100644 --- a/packages/hooks/src/hooks/Combination/useGetSwapQuote.ts +++ b/packages/hooks/src/hooks/Combination/useGetSwapQuote.ts @@ -20,7 +20,7 @@ import { useAPIClient } from '../API/useAPIClient.js' * - 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. + * 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 diff --git a/packages/hooks/src/hooks/Combination/useGetSwapRoutes.ts b/packages/hooks/src/hooks/Combination/useGetSwapRoutes.ts index fc7ec5f12..1b3037d8d 100644 --- a/packages/hooks/src/hooks/Combination/useGetSwapRoutes.ts +++ b/packages/hooks/src/hooks/Combination/useGetSwapRoutes.ts @@ -48,7 +48,7 @@ const getSwapRoutes = async ( * 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/useGetSwapRoutes} for more detailed documentation. + * @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 diff --git a/packages/hooks/src/hooks/Indexer/useGetTransactionHistory.ts b/packages/hooks/src/hooks/Indexer/useGetTransactionHistory.ts index ac9661571..bebf9ce7e 100644 --- a/packages/hooks/src/hooks/Indexer/useGetTransactionHistory.ts +++ b/packages/hooks/src/hooks/Indexer/useGetTransactionHistory.ts @@ -76,7 +76,7 @@ const getTransactionHistory = async ( * It can filter transactions by contract address and token ID, making it useful for both * general account history and specific asset history views. * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTransactionHistory} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetTransactionHistory} for more detailed documentation. * * @param args - Configuration object for the transaction history query {@link GetTransactionHistoryArgs} * diff --git a/packages/hooks/src/hooks/Indexer/useGetTransactionHistorySummary.ts b/packages/hooks/src/hooks/Indexer/useGetTransactionHistorySummary.ts index 0ff012006..5ce1dda79 100644 --- a/packages/hooks/src/hooks/Indexer/useGetTransactionHistorySummary.ts +++ b/packages/hooks/src/hooks/Indexer/useGetTransactionHistorySummary.ts @@ -73,7 +73,7 @@ const getTransactionHistorySummary = async ( * - metaTxnID: Optional meta transaction ID * - Other standard React Query properties (isLoading, isError, etc.) * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTransactionHistorySummary} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetTransactionHistorySummary} for more detailed documentation. * * @example * ```tsx diff --git a/packages/hooks/src/hooks/Indexer/useIndexerClient.ts b/packages/hooks/src/hooks/Indexer/useIndexerClient.ts index af55f89c3..2e2608e7e 100644 --- a/packages/hooks/src/hooks/Indexer/useIndexerClient.ts +++ b/packages/hooks/src/hooks/Indexer/useIndexerClient.ts @@ -97,7 +97,6 @@ export const useIndexerClient = (chainId: ChainId) => { * * @throws Error if an indexer client cannot be created for any of the specified chain IDs * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useIndexerClients} for more detailed documentation. * * @example * ```typescript diff --git a/packages/hooks/src/hooks/IndexerGateway/useGetNativeTokenBalance.ts b/packages/hooks/src/hooks/IndexerGateway/useGetNativeTokenBalance.ts index a10dcd23f..bb6851235 100644 --- a/packages/hooks/src/hooks/IndexerGateway/useGetNativeTokenBalance.ts +++ b/packages/hooks/src/hooks/IndexerGateway/useGetNativeTokenBalance.ts @@ -31,7 +31,7 @@ const getNativeTokenBalance = async ( * * @returns Query result containing an array of TokenBalance objects * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetNativeTokenBalance} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetNativeTokenBalance} for more detailed documentation. * * @example * ```tsx diff --git a/packages/hooks/src/hooks/IndexerGateway/useGetSingleTokenBalance.ts b/packages/hooks/src/hooks/IndexerGateway/useGetSingleTokenBalance.ts index c8db20cc3..485931374 100644 --- a/packages/hooks/src/hooks/IndexerGateway/useGetSingleTokenBalance.ts +++ b/packages/hooks/src/hooks/IndexerGateway/useGetSingleTokenBalance.ts @@ -50,15 +50,15 @@ const getSingleTokenBalance = async (args: GetSingleTokenBalanceArgs, indexerGat * * @returns Query result containing the token balance * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetSingleTokenBalanceSummary} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetSingleTokenBalance} for more detailed documentation. * * @example * ```tsx - * import { useGetSingleTokenBalanceSummary, ZERO_ADDRESS } from '@0xsequence/hooks' + * import { useGetSingleTokenBalance, ZERO_ADDRESS } from '@0xsequence/hooks' * * // Fetch native ETH balance * function NativeBalance() { - * const { data: ethBalance } = useGetSingleTokenBalanceSummary({ + * const { data: ethBalance } = useGetSingleTokenBalance({ * chainId: 1, * accountAddress: '0x123...', * contractAddress: ZERO_ADDRESS @@ -68,7 +68,7 @@ const getSingleTokenBalance = async (args: GetSingleTokenBalanceArgs, indexerGat * * // Fetch USDC balance * function TokenBalance() { - * const { data: usdcBalance } = useGetSingleTokenBalanceSummary({ + * const { data: usdcBalance } = useGetSingleTokenBalance({ * chainId: 1, * accountAddress: '0x123...', * contractAddress: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' // USDC diff --git a/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesByContract.ts b/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesByContract.ts index 0c4b47661..9796856d8 100644 --- a/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesByContract.ts +++ b/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesByContract.ts @@ -48,7 +48,7 @@ const getTokenBalancesByContract = async ( * - `decimals`: Number of decimals (for ERC20) * - `logoURI`: URL of the token logo * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTokenBalancesByContract} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetTokenBalancesByContract} for more detailed documentation. * * @example * ```tsx diff --git a/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesDetails.ts b/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesDetails.ts index 32b38c3a1..9392372ca 100644 --- a/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesDetails.ts +++ b/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesDetails.ts @@ -87,7 +87,7 @@ const getTokenBalancesDetails = async ( * - `image`: Token image URL * - `attributes`: Array of token attributes * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTokenBalancesDetails} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetTokenBalancesDetails} for more detailed documentation. * * @example * ```tsx diff --git a/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesSummary.ts b/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesSummary.ts index 415438774..3eeacbced 100644 --- a/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesSummary.ts +++ b/packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesSummary.ts @@ -73,7 +73,7 @@ const getTokenBalancesSummary = async ( * - `decimals`: Number of decimals * - `logoURI`: URL of the token logo * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTokenBalancesSummary} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetTokenBalancesSummary} for more detailed documentation. * * @example * ```tsx diff --git a/packages/hooks/src/hooks/IndexerGateway/useIndexerGatewayClient.ts b/packages/hooks/src/hooks/IndexerGateway/useIndexerGatewayClient.ts index 61b119bb4..055ff054f 100644 --- a/packages/hooks/src/hooks/IndexerGateway/useIndexerGatewayClient.ts +++ b/packages/hooks/src/hooks/IndexerGateway/useIndexerGatewayClient.ts @@ -10,7 +10,7 @@ import { useConfig } from '../useConfig.js' * * @returns A SequenceIndexerGateway instance * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useIndexerGatewayClient} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useIndexerGatewayClient} for more detailed documentation. * * @example * ```tsx diff --git a/packages/hooks/src/hooks/Metadata/useGetContractInfo.ts b/packages/hooks/src/hooks/Metadata/useGetContractInfo.ts index 37c1e0496..178524875 100644 --- a/packages/hooks/src/hooks/Metadata/useGetContractInfo.ts +++ b/packages/hooks/src/hooks/Metadata/useGetContractInfo.ts @@ -15,7 +15,7 @@ import { useMetadataClient } from './useMetadataClient.js' * For native tokens (like ETH, POL), it enriches the response with network-specific * information like the native token symbol and network logo. * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetContractInfo} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetContractInfo} for more detailed documentation. * * @param getContractInfoArgs - Arguments for fetching contract info * @param getContractInfoArgs.chainID - Chain ID as string (e.g., "1" for Ethereum mainnet) diff --git a/packages/hooks/src/hooks/Metadata/useGetMultipleContractsInfo.ts b/packages/hooks/src/hooks/Metadata/useGetMultipleContractsInfo.ts index 51ecd1bff..af84c7678 100644 --- a/packages/hooks/src/hooks/Metadata/useGetMultipleContractsInfo.ts +++ b/packages/hooks/src/hooks/Metadata/useGetMultipleContractsInfo.ts @@ -28,7 +28,7 @@ const getMultipleContractsInfo = async ( * for cross-chain applications. Can fetch any combination of NFTs (ERC721/ERC1155) and * tokens (ERC20) across different chains simultaneously. * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetMultipleContractsInfo} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetMultipleContractsInfo} for more detailed documentation. * * @param useGetMultipleContractsInfoArgs - Array of contract info arguments * @param useGetMultipleContractsInfoArgs[].chainID - Chain ID as string (e.g., "1" for Ethereum mainnet) diff --git a/packages/hooks/src/hooks/Metadata/useGetTokenMetadata.ts b/packages/hooks/src/hooks/Metadata/useGetTokenMetadata.ts index 20f24c488..3309d6975 100644 --- a/packages/hooks/src/hooks/Metadata/useGetTokenMetadata.ts +++ b/packages/hooks/src/hooks/Metadata/useGetTokenMetadata.ts @@ -44,7 +44,7 @@ const getTokenMetadata = async (metadataClient: SequenceMetadata, args: GetToken * Optimized for batch fetching with automatic chunking of token IDs to respect * rate limits (50 tokens per request). * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTokenMetadata} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetTokenMetadata} for more detailed documentation. * * @param getTokenMetadataArgs - Arguments for fetching token metadata * @param getTokenMetadataArgs.chainID - Chain ID as string (e.g., "1" for Ethereum mainnet) diff --git a/packages/hooks/src/hooks/Metadata/useMetadataClient.ts b/packages/hooks/src/hooks/Metadata/useMetadataClient.ts index bd45ed2e2..f68b33f19 100644 --- a/packages/hooks/src/hooks/Metadata/useMetadataClient.ts +++ b/packages/hooks/src/hooks/Metadata/useMetadataClient.ts @@ -18,7 +18,7 @@ import { useConfig } from '../useConfig.js' * - {@link useGetContractInfo} for fetching contract information * - {@link useGetMultipleContractsInfo} for batch fetching contract information * - * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useMetadataClient} for more detailed documentation. + * @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useMetadataClient} for more detailed documentation. * * @returns A configured instance of SequenceMetadata client *