Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/checkout/src/hooks/useAddFundsModal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type UseAddFundsModalReturnType = {
* The modal integration is powered by Transak, allowing users to purchase crypto directly within
* your application.
*
* Go to {@link https://docs.sequence.xyz/sdk/web/hooks/useAddFundsModal} for more detailed documentation.
* Go to {@link https://docs.sequence.xyz/sdk/web/checkout-sdk/hooks/useAddFundsModal} for more detailed documentation.
*
* @returns An object containing functions and settings for the On-ramp modal {@link UseAddFundsModalReturnType}
*
Expand Down
2 changes: 1 addition & 1 deletion packages/checkout/src/hooks/useCheckoutModal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type UseCheckoutModalReturnType = {
* This hook provides methods to open and close the checkout modal, and access its current settings.
* Checkout supports credit card payments and crypto payments for purchasing digital assets.
*
* Go to {@link https://docs.sequence.xyz/sdk/web/hooks/useCheckoutModal} for more detailed documentation.
* Go to {@link https://docs.sequence.xyz/sdk/web/checkout-sdk/hooks/useCheckoutModal} for more detailed documentation.
*
* @returns An object containing functions and settings for the Checkout modal {@link UseCheckoutModalReturnType}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ export const getERC1155SaleContractConfig = ({
* - Generating the proper transaction data
* - Opening and managing the checkout modal
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useERC1155SaleContractCheckout} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/checkout-sdk/hooks/useERC1155SaleContractCheckout} for more detailed documentation.
*
* @param {object} params - Configuration options for the ERC-1155 sale contract checkout
* @param {number} params.chain - Chain ID where the sale contract is deployed
Expand Down
2 changes: 1 addition & 1 deletion packages/checkout/src/hooks/useSelectPaymentModal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ type UseSelectPaymentModalReturnType = {
* - Pay with credit/debit card
* - Receive funds from another wallet
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useSelectPaymentModal} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/checkout-sdk/hooks/useSelectPaymentModal} for more detailed documentation.
*
* @returns An object containing functions to control the Payment Selection modal and its state {@link UseSelectPaymentModalReturnType}
*
Expand Down
2 changes: 1 addition & 1 deletion packages/checkout/src/hooks/useSwapModal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type UseSwapModalReturnType = {
* The Swap modal allows users to select tokens from their wallet to swap to a specified target token,
* with the option to execute additional transactions after the swap completes.
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useSwapModal} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/checkout-sdk/hooks/useSwapModal} for more detailed documentation.
*
* @returns An object containing functions to control the Swap modal and its state {@link UseSwapModalReturnType}
*
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/src/hooks/useChain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import type { Chain } from 'wagmi/chains'
* The hook is commonly used in conjunction with other Sequence hooks to access chain-specific
* information when working with transactions, indexer clients, or network-specific features.
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useChain} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/wallet-sdk/ecosystem/hooks/useChain} for more detailed documentation.
*
* @param chainId - Optional chain ID to get configuration for a specific chain. If not provided, returns the current chain's configuration.
* @returns Chain configuration object for the specified or current chain, or undefined if not found
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/src/hooks/useCheckWaasFeeOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { useConnections } from 'wagmi'
* for unsponsored transactions. It's particularly useful in
* wallet interfaces and transaction confirmation flows.
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useCheckWaasFeeOptions} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/wallet-sdk/embedded/hooks/useCheckWaasFeeOptions} for more detailed documentation.
*
* @returns A function that accepts transaction details and returns fee information
* @returns.feeQuote - The fee quote for the transaction if available
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/src/hooks/useOpenConnectModal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ type UseOpenConnectModalReturnType = {
* This hook provides a method to open and close the connect modal, and access its current open state.
* The Connect modal provides various wallet connection options including Sequence wallet and external wallets.
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useOpenConnectModal} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/wallet-sdk/ecosystem/hooks/useOpenConnectModal} for more detailed documentation.
*
* @returns An object containing function to control the Connect modal and its state {@link UseOpenConnectModalReturnType}
*
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/src/hooks/useProjectAccessKey.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { useConnectConfigContext } from '../contexts/ConnectConfig.js'
* identify your application with Sequence services. It is used across various SDK features
* including marketplace integration and wallet connections.
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useProjectAccessKey} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/wallet-sdk/ecosystem/hooks/useProjectAccessKey} for more detailed documentation.
*
* @returns {string} The project access key configured for the application
*
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/src/hooks/useSignInEmail.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { LocalStorageKey } from '../constants/localStorage.js'
* is connected. It works with both WaaS (Wallet-as-a-Service) and universal wallet types.
* The email is cleared when the wallet is disconnected.
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useSignInEmail} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/wallet-sdk/ecosystem/hooks/useSignInEmail} for more detailed documentation.
*
* @returns {string | null} The email address of the connected wallet user, or null if not connected
* or no email is associated
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/src/hooks/useStorage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import type { StorageItem } from '../types.js'
* It is commonly used for operations that require access to the storage layer,
* such as generating authentication proofs.
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useStorage} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/wallet-sdk/ecosystem/hooks/useStorage} for more detailed documentation.
*
* @returns The Storage instance if available, or null if not configured {@link Storage} or null
*
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/src/hooks/useTheme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { useThemeContext } from '../contexts/Theme.js'
* along with functions to update these values. The modal position can be set to various
* predefined positions on the screen.
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useTheme} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/wallet-sdk/ecosystem/hooks/useTheme} for more detailed documentation.
*
* @returns {Object} An object containing:
* - `theme` - The current theme setting
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/src/hooks/useWalletSettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { useWalletConfigContext } from '../contexts/WalletConfig.js'
* - See if external wallets are visible on the Connect Modal
* - See if linked wallets are visible on the Connect Modal
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useWalletSettings} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/wallet-sdk/ecosystem/hooks/useWalletSettings} for more detailed documentation.
*
* @returns An object containing:
* - `displayedAssets` - Array of assets to display, each with a contract address and chain ID
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/src/hooks/useWallets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ export interface UseWalletsReturnType {
* For embedded wallets, it also provides access to linked wallets - additional
* wallets that have been linked to the primary embedded wallet.
*
* @see {@link https://docs.sequence.xyz/sdk/web/hooks/useWallets} for more detailed documentation.
* @see {@link https://docs.sequence.xyz/sdk/web/wallet-sdk/ecosystem/hooks/useWallets} for more detailed documentation.
*
* @returns An object containing wallet information and management functions {@link UseWalletsReturnType}
*
Expand Down
1 change: 0 additions & 1 deletion packages/hooks/src/hooks/API/useAPIClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/src/hooks/API/useGetCoinPrices.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/src/hooks/API/useGetCollectiblePrices.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/src/hooks/API/useGetExchangeRate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion packages/hooks/src/hooks/Builder/useFindVersion.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/src/hooks/Combination/useGetSwapQuote.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/src/hooks/Combination/useGetSwapRoutes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion packages/hooks/src/hooks/Indexer/useIndexerClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/src/hooks/Metadata/useGetContractInfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/src/hooks/Metadata/useGetTokenMetadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/src/hooks/Metadata/useMetadataClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down