Skip to content

Commit 121cbfb

Browse files
Update documentation links in various hooks to point to the new SDK structure (#531)
1 parent 7832eb3 commit 121cbfb

20 files changed

+20
-23
lines changed

packages/hooks/src/hooks/API/useAPIClient.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import { useConfig } from '../useConfig.js'
1919
* The client instance is memoized based on the project access key, meaning a new
2020
* instance is only created when the access key changes.
2121
*
22-
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useAPIClient} for more detailed documentation.
2322
*
2423
* @returns {SequenceAPIClient} A configured instance of the Sequence API client
2524
*

packages/hooks/src/hooks/API/useGetCoinPrices.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const getCoinPrices = async (apiClient: SequenceAPIClient, tokens: Token[]) => {
3030
* This hook uses React Query to fetch and cache token prices from the Sequence API.
3131
* Prices are automatically refreshed every minute to ensure they stay current.
3232
*
33-
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetCoinPrices} for more detailed documentation.
33+
* @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetCoinPrices} for more detailed documentation.
3434
*
3535
* @param tokens - Array of tokens to get prices for. Each token must include:
3636
* - chainId: The chain ID where the token exists

packages/hooks/src/hooks/API/useGetCollectiblePrices.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ const getCollectiblePrices = async (apiClient: SequenceAPIClient, tokens: Token[
3232
* Used in various UI components to display NFT valuations, particularly in collection views
3333
* and transaction details.
3434
*
35-
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetCollectiblePrices} for more detailed documentation.
35+
* @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetCollectiblePrices} for more detailed documentation.
3636
*
3737
* @param tokens - Array of tokens to get prices for. Each token must include:
3838
* - chainId: The chain ID where the NFT exists

packages/hooks/src/hooks/API/useGetExchangeRate.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { useAPIClient } from './useAPIClient.js'
1313
* Used throughout the wallet widget and checkout components to display fiat values
1414
* for tokens and NFTs.
1515
*
16-
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetExchangeRate} for more detailed documentation.
16+
* @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetExchangeRate} for more detailed documentation.
1717
*
1818
* @param toCurrency - The target currency code (e.g., 'EUR', 'GBP', 'JPY').
1919
* If 'USD' is provided, returns 1 as the conversion rate.

packages/hooks/src/hooks/Builder/useFindVersion.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import { useConfig } from '../useConfig.js'
99
*
1010
* This hook uses React Query to fetch and cache the version of a contract.
1111
*
12-
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useFindVersion} for more detailed documentation.
1312
*
1413
* @param args - The arguments for the hook:
1514
* - uid: The UID of the contract

packages/hooks/src/hooks/Combination/useGetSwapQuote.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { useAPIClient } from '../API/useAPIClient.js'
2020
* - Transaction data generation for the swap
2121
* - Error handling for failed API calls
2222
*
23-
* Go to {@link https://docs.sequence.xyz/sdk/web/hooks/useGetSwapQuote} for more detailed documentation.
23+
* Go to {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetSwapQuote} for more detailed documentation.
2424
*
2525
* @param getSwapQuoteArgs - Configuration object for the swap quote query:
2626
* - params: The parameters for the swap quote query

packages/hooks/src/hooks/Combination/useGetSwapRoutes.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const getSwapRoutes = async (
4848
* This hook uses React Query to fetch and cache swap routes from the Sequence API.
4949
* Stale time is set to one hour by default
5050
*
51-
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetSwapRoutes} for more detailed documentation.
51+
* @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetSwapRoutes} for more detailed documentation.
5252
*
5353
* @param args - Arguments for fetching swap routes:
5454
* - walletAddress: The address of the user's wallet

packages/hooks/src/hooks/Indexer/useGetTransactionHistory.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ const getTransactionHistory = async (
7676
* It can filter transactions by contract address and token ID, making it useful for both
7777
* general account history and specific asset history views.
7878
*
79-
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTransactionHistory} for more detailed documentation.
79+
* @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetTransactionHistory} for more detailed documentation.
8080
*
8181
* @param args - Configuration object for the transaction history query {@link GetTransactionHistoryArgs}
8282
*

packages/hooks/src/hooks/Indexer/useGetTransactionHistorySummary.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ const getTransactionHistorySummary = async (
7373
* - metaTxnID: Optional meta transaction ID
7474
* - Other standard React Query properties (isLoading, isError, etc.)
7575
*
76-
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTransactionHistorySummary} for more detailed documentation.
76+
* @see {@link https://docs.sequence.xyz/sdk/web/hooks-sdk/hooks/useGetTransactionHistorySummary} for more detailed documentation.
7777
*
7878
* @example
7979
* ```tsx

packages/hooks/src/hooks/Indexer/useIndexerClient.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ export const useIndexerClient = (chainId: ChainId) => {
9797
*
9898
* @throws Error if an indexer client cannot be created for any of the specified chain IDs
9999
*
100-
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useIndexerClients} for more detailed documentation.
101100
*
102101
* @example
103102
* ```typescript

0 commit comments

Comments
 (0)