@0xsequence/hooks 5.1.1 → 5.2.0

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesByContract.d.ts

@@ -1,7 +1,58 @@
 import { IndexerGateway, TokenBalance } from '@0xsequence/indexer';
 import { BalanceHookOptions } from '../../types';
 /**
- * @description Gets the token balances for a given list of contractAddresses
+ * Hook to fetch token balances by contract address.
+ * Can be used to fetch multiple token balances in a single request.
+ *
+ * @param getTokenBalancesByContractArgs - Arguments for fetching token balances
+ * @param getTokenBalancesByContractArgs.chainIds - Array of chain IDs to fetch balances from
+ * @param getTokenBalancesByContractArgs.filter - Filter criteria for the query
+ * @param getTokenBalancesByContractArgs.filter.contractAddresses - List of token contract addresses to fetch balances for
+ * @param getTokenBalancesByContractArgs.filter.accountAddresses - Optional list of account addresses to fetch balances for
+ * @param getTokenBalancesByContractArgs.filter.contractStatus - Optional filter for contract verification status
+ * @param options - Optional configuration for the query behavior
+ * @param options.hideCollectibles - If true, filters out ERC721 and ERC1155 tokens from the results
+ * @param options.disabled - If true, disables the query from automatically running
+ * @param options.retry - If true, retries failed queries
+ *
+ * @returns Query result containing an array of TokenBalance objects with the following properties:
+ * - `contractType`: Type of the token contract (ERC20, ERC721, ERC1155)
+ * - `contractAddress`: Address of the token contract
+ * - `accountAddress`: Address of the account holding the tokens
+ * - `tokenID`: (for ERC721/ERC1155) ID of the token
+ * - `balance`: Token balance as a string
+ * - `blockHash`: Hash of the block where this balance was last updated
+ * - `blockNumber`: Block number where this balance was last updated
+ * - `chainId`: Chain ID where the token exists
+ * - `contractInfo`: (optional) Additional token contract information including:
+ *   - `name`: Token name
+ *   - `symbol`: Token symbol
+ *   - `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.
+ *
+ * @example
+ * ```tsx
+ * function TokenBalances() {
+ *   const { data: balances } = useGetTokenBalancesByContract({
+ *     chainIds: [1], // Ethereum mainnet
+ *     filter: {
+ *       contractAddresses: [
+ *         '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', // USDC
+ *         '0xdac17f958d2ee523a2206206994597c13d831ec7'  // USDT
+ *       ],
+ *       accountAddresses: ['0x123...']
+ *     }
+ *   })
+ *
+ *   return balances?.map(balance => (
+ *     <div key={balance.contractAddress}>
+ *       {balance.contractInfo?.symbol}: {balance.balance}
+ *     </div>
+ *   ))
+ * }
+ * ```
  */
 export declare const useGetTokenBalancesByContract: (getTokenBalancesByContractArgs: IndexerGateway.GetTokenBalancesByContractArgs, options?: BalanceHookOptions) => import("@tanstack/react-query").UseQueryResult<TokenBalance[], Error>;
 //# sourceMappingURL=useGetTokenBalancesByContract.d.ts.map

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesByContract.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useGetTokenBalancesByContract.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesByContract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAA0B,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAIxG,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAsBhD;;GAEG;AACH,eAAO,MAAM,6BAA6B,GACxC,gCAAgC,cAAc,CAAC,8BAA8B,EAC7E,UAAU,kBAAkB,0EAiB7B,CAAA"}
+{"version":3,"file":"useGetTokenBalancesByContract.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesByContract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAA0B,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAIxG,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAsBhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,eAAO,MAAM,6BAA6B,GACxC,gCAAgC,cAAc,CAAC,8BAA8B,EAC7E,UAAU,kBAAkB,0EAiB7B,CAAA"}

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesByContract.js

@@ -12,7 +12,58 @@ const getTokenBalancesByContract = async (indexerGatewayClient, getTokenBalances
     return res.balances.flatMap(balance => balance.results);
 };
 /**
- * @description Gets the token balances for a given list of contractAddresses
+ * Hook to fetch token balances by contract address.
+ * Can be used to fetch multiple token balances in a single request.
+ *
+ * @param getTokenBalancesByContractArgs - Arguments for fetching token balances
+ * @param getTokenBalancesByContractArgs.chainIds - Array of chain IDs to fetch balances from
+ * @param getTokenBalancesByContractArgs.filter - Filter criteria for the query
+ * @param getTokenBalancesByContractArgs.filter.contractAddresses - List of token contract addresses to fetch balances for
+ * @param getTokenBalancesByContractArgs.filter.accountAddresses - Optional list of account addresses to fetch balances for
+ * @param getTokenBalancesByContractArgs.filter.contractStatus - Optional filter for contract verification status
+ * @param options - Optional configuration for the query behavior
+ * @param options.hideCollectibles - If true, filters out ERC721 and ERC1155 tokens from the results
+ * @param options.disabled - If true, disables the query from automatically running
+ * @param options.retry - If true, retries failed queries
+ *
+ * @returns Query result containing an array of TokenBalance objects with the following properties:
+ * - `contractType`: Type of the token contract (ERC20, ERC721, ERC1155)
+ * - `contractAddress`: Address of the token contract
+ * - `accountAddress`: Address of the account holding the tokens
+ * - `tokenID`: (for ERC721/ERC1155) ID of the token
+ * - `balance`: Token balance as a string
+ * - `blockHash`: Hash of the block where this balance was last updated
+ * - `blockNumber`: Block number where this balance was last updated
+ * - `chainId`: Chain ID where the token exists
+ * - `contractInfo`: (optional) Additional token contract information including:
+ *   - `name`: Token name
+ *   - `symbol`: Token symbol
+ *   - `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.
+ *
+ * @example
+ * ```tsx
+ * function TokenBalances() {
+ *   const { data: balances } = useGetTokenBalancesByContract({
+ *     chainIds: [1], // Ethereum mainnet
+ *     filter: {
+ *       contractAddresses: [
+ *         '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', // USDC
+ *         '0xdac17f958d2ee523a2206206994597c13d831ec7'  // USDT
+ *       ],
+ *       accountAddresses: ['0x123...']
+ *     }
+ *   })
+ *
+ *   return balances?.map(balance => (
+ *     <div key={balance.contractAddress}>
+ *       {balance.contractInfo?.symbol}: {balance.balance}
+ *     </div>
+ *   ))
+ * }
+ * ```
  */
 export const useGetTokenBalancesByContract = (getTokenBalancesByContractArgs, options) => {
     const indexerGatewayClient = useIndexerGatewayClient();

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesByContract.js.map

@@ -1 +1 @@
-{"version":3,"file":"useGetTokenBalancesByContract.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesByContract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAwD,MAAM,qBAAqB,CAAA;AACxG,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAGlD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE,MAAM,0BAA0B,GAAG,KAAK,EACtC,oBAA4C,EAC5C,8BAA6E,EAC7E,gBAAyB,EACA,EAAE;IAC3B,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,0BAA0B,CAAC,8BAA8B,CAAC,CAAA;IAEjG,IAAI,gBAAgB,EAAE,CAAC;QACrB,KAAK,MAAM,YAAY,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;YACxC,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAChD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,OAAO,CACtG,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;AACzD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,8BAA6E,EAC7E,OAA4B,EAC5B,EAAE;IACF,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,6BAA6B,EAAE,8BAA8B,EAAE,OAAO,CAAC;QAC7F,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,MAAM,0BAA0B,CACrC,oBAAoB,EACpB,8BAA8B,EAC9B,OAAO,EAAE,gBAAgB,IAAI,KAAK,CACnC,CAAA;QACH,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,8BAA8B,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KAC7F,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"useGetTokenBalancesByContract.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesByContract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAwD,MAAM,qBAAqB,CAAA;AACxG,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAGlD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE,MAAM,0BAA0B,GAAG,KAAK,EACtC,oBAA4C,EAC5C,8BAA6E,EAC7E,gBAAyB,EACA,EAAE;IAC3B,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,0BAA0B,CAAC,8BAA8B,CAAC,CAAA;IAEjG,IAAI,gBAAgB,EAAE,CAAC;QACrB,KAAK,MAAM,YAAY,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;YACxC,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAChD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,OAAO,CACtG,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;AACzD,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,8BAA6E,EAC7E,OAA4B,EAC5B,EAAE;IACF,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,6BAA6B,EAAE,8BAA8B,EAAE,OAAO,CAAC;QAC7F,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,MAAM,0BAA0B,CACrC,oBAAoB,EACpB,8BAA8B,EAC9B,OAAO,EAAE,gBAAgB,IAAI,KAAK,CACnC,CAAA;QACH,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,8BAA8B,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KAC7F,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesDetails.d.ts

@@ -1,7 +1,96 @@
 import { IndexerGateway, TokenBalance } from '@0xsequence/indexer';
 import { BalanceHookOptions } from '../../types';
 /**
- * @description Gets token balances, with individual token details
+ * Hook to fetch detailed token balances including individual token metadata.
+ *
+ * Key differences from other balance hooks:
+ * - useGetTokenBalancesSummary: Returns basic token info, faster but less detailed
+ * - useGetTokenBalancesByContract: Only fetches specific contracts
+ * - useGetSingleTokenBalanceSummary: Fetches a single token balance
+ *
+ * This hook is best used when you need full token details, especially for NFTs and collectibles
+ * where metadata is important (images, attributes, etc).
+ * Results are sorted by type: native tokens first, then ERC20s, then collectibles.
+ *
+ * @param getTokenBalancesDetailsArgs - Arguments for fetching token balances
+ * @param getTokenBalancesDetailsArgs.chainIds - Array of chain IDs to fetch balances from
+ * @param getTokenBalancesDetailsArgs.filter - Filter criteria for the query
+ * @param getTokenBalancesDetailsArgs.filter.accountAddresses - List of account addresses to fetch balances for
+ * @param getTokenBalancesDetailsArgs.filter.contractWhitelist - Optional list of contracts to include
+ * @param getTokenBalancesDetailsArgs.filter.contractBlacklist - Optional list of contracts to exclude
+ * @param getTokenBalancesDetailsArgs.filter.omitNativeBalances - If true, excludes native token balances
+ * @param getTokenBalancesDetailsArgs.filter.contractStatus - Optional filter for contract verification status
+ * @param options - Optional configuration for the query behavior
+ * @param options.hideCollectibles - If true, filters out ERC721 and ERC1155 tokens
+ * @param options.disabled - If true, disables the query from automatically running
+ * @param options.retry - If true (default), retries failed queries
+ *
+ * Query configuration:
+ * - Marks data as stale after 30 seconds
+ * - Retries failed requests by default
+ * - Only enabled when account address is present and not explicitly disabled
+ *
+ * @returns Query result containing an array of TokenBalance objects with detailed information:
+ * - `contractType`: Type of the token contract (NATIVE, ERC20, ERC721, ERC1155)
+ * - `contractAddress`: Address of the token contract
+ * - `accountAddress`: Address of the account holding the tokens
+ * - `tokenID`: (for NFTs) ID of the token
+ * - `balance`: Token balance as a string
+ * - `blockHash`: Hash of the block where this balance was last updated
+ * - `blockNumber`: Block number where this balance was last updated
+ * - `chainId`: Chain ID where the token exists
+ * - `contractInfo`: Additional token contract information including:
+ *   - `name`: Token name
+ *   - `symbol`: Token symbol
+ *   - `decimals`: Number of decimals
+ *   - `logoURI`: URL of the token logo
+ * - `tokenMetadata`: (for NFTs) Detailed token metadata including:
+ *   - `name`: Token name
+ *   - `description`: Token description
+ *   - `image`: Token image URL
+ *   - `attributes`: Array of token attributes
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTokenBalancesDetails} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useGetTokenBalancesDetails } from '@0xsequence/hooks'
+ *
+ * // Fetch all token balances with full details
+ * function TokenList() {
+ *   const { data: tokens } = useGetTokenBalancesDetails({
+ *     chainIds: [1], // Ethereum mainnet
+ *     filter: {
+ *       accountAddresses: ['0x123...'],
+ *       omitNativeBalances: false,
+ *       // Optional: only include specific tokens
+ *       contractWhitelist: ['0x...', '0x...'],
+ *       // Optional: exclude specific tokens
+ *       contractBlacklist: ['0x...']
+ *     }
+ *   })
+ *
+ *   return tokens?.map(token => (
+ *     <div key={`${token.chainId}-${token.contractAddress}-${token.tokenID}`}>
+ *       {token.contractType === 'ERC721' ? (
+ *         // NFT display with metadata
+ *         <NFTCard
+ *           name={token.tokenMetadata?.name}
+ *           image={token.tokenMetadata?.image}
+ *           attributes={token.tokenMetadata?.attributes}
+ *         />
+ *       ) : (
+ *         // Regular token display
+ *         <TokenRow
+ *           symbol={token.contractInfo?.symbol}
+ *           balance={token.balance}
+ *           decimals={token.contractInfo?.decimals}
+ *         />
+ *       )}
+ *     </div>
+ *   ))
+ * }
+ * ```
  */
 export declare const useGetTokenBalancesDetails: (getTokenBalancesDetailsArgs: IndexerGateway.GetTokenBalancesDetailsArgs, options?: BalanceHookOptions) => import("@tanstack/react-query").UseQueryResult<TokenBalance[], Error>;
 //# sourceMappingURL=useGetTokenBalancesDetails.d.ts.map

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesDetails.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useGetTokenBalancesDetails.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesDetails.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAA0B,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAIxG,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAqChD;;GAEG;AACH,eAAO,MAAM,0BAA0B,GACrC,6BAA6B,cAAc,CAAC,2BAA2B,EACvE,UAAU,kBAAkB,0EAa7B,CAAA"}
+{"version":3,"file":"useGetTokenBalancesDetails.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesDetails.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAA0B,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAIxG,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAqChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,eAAO,MAAM,0BAA0B,GACrC,6BAA6B,cAAc,CAAC,2BAA2B,EACvE,UAAU,kBAAkB,0EAa7B,CAAA"}

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesDetails.js

@@ -21,7 +21,96 @@ const getTokenBalancesDetails = async (getTokenBalancesDetailsArgs, indexerGatew
     }
 };
 /**
- * @description Gets token balances, with individual token details
+ * Hook to fetch detailed token balances including individual token metadata.
+ *
+ * Key differences from other balance hooks:
+ * - useGetTokenBalancesSummary: Returns basic token info, faster but less detailed
+ * - useGetTokenBalancesByContract: Only fetches specific contracts
+ * - useGetSingleTokenBalanceSummary: Fetches a single token balance
+ *
+ * This hook is best used when you need full token details, especially for NFTs and collectibles
+ * where metadata is important (images, attributes, etc).
+ * Results are sorted by type: native tokens first, then ERC20s, then collectibles.
+ *
+ * @param getTokenBalancesDetailsArgs - Arguments for fetching token balances
+ * @param getTokenBalancesDetailsArgs.chainIds - Array of chain IDs to fetch balances from
+ * @param getTokenBalancesDetailsArgs.filter - Filter criteria for the query
+ * @param getTokenBalancesDetailsArgs.filter.accountAddresses - List of account addresses to fetch balances for
+ * @param getTokenBalancesDetailsArgs.filter.contractWhitelist - Optional list of contracts to include
+ * @param getTokenBalancesDetailsArgs.filter.contractBlacklist - Optional list of contracts to exclude
+ * @param getTokenBalancesDetailsArgs.filter.omitNativeBalances - If true, excludes native token balances
+ * @param getTokenBalancesDetailsArgs.filter.contractStatus - Optional filter for contract verification status
+ * @param options - Optional configuration for the query behavior
+ * @param options.hideCollectibles - If true, filters out ERC721 and ERC1155 tokens
+ * @param options.disabled - If true, disables the query from automatically running
+ * @param options.retry - If true (default), retries failed queries
+ *
+ * Query configuration:
+ * - Marks data as stale after 30 seconds
+ * - Retries failed requests by default
+ * - Only enabled when account address is present and not explicitly disabled
+ *
+ * @returns Query result containing an array of TokenBalance objects with detailed information:
+ * - `contractType`: Type of the token contract (NATIVE, ERC20, ERC721, ERC1155)
+ * - `contractAddress`: Address of the token contract
+ * - `accountAddress`: Address of the account holding the tokens
+ * - `tokenID`: (for NFTs) ID of the token
+ * - `balance`: Token balance as a string
+ * - `blockHash`: Hash of the block where this balance was last updated
+ * - `blockNumber`: Block number where this balance was last updated
+ * - `chainId`: Chain ID where the token exists
+ * - `contractInfo`: Additional token contract information including:
+ *   - `name`: Token name
+ *   - `symbol`: Token symbol
+ *   - `decimals`: Number of decimals
+ *   - `logoURI`: URL of the token logo
+ * - `tokenMetadata`: (for NFTs) Detailed token metadata including:
+ *   - `name`: Token name
+ *   - `description`: Token description
+ *   - `image`: Token image URL
+ *   - `attributes`: Array of token attributes
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTokenBalancesDetails} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useGetTokenBalancesDetails } from '@0xsequence/hooks'
+ *
+ * // Fetch all token balances with full details
+ * function TokenList() {
+ *   const { data: tokens } = useGetTokenBalancesDetails({
+ *     chainIds: [1], // Ethereum mainnet
+ *     filter: {
+ *       accountAddresses: ['0x123...'],
+ *       omitNativeBalances: false,
+ *       // Optional: only include specific tokens
+ *       contractWhitelist: ['0x...', '0x...'],
+ *       // Optional: exclude specific tokens
+ *       contractBlacklist: ['0x...']
+ *     }
+ *   })
+ *
+ *   return tokens?.map(token => (
+ *     <div key={`${token.chainId}-${token.contractAddress}-${token.tokenID}`}>
+ *       {token.contractType === 'ERC721' ? (
+ *         // NFT display with metadata
+ *         <NFTCard
+ *           name={token.tokenMetadata?.name}
+ *           image={token.tokenMetadata?.image}
+ *           attributes={token.tokenMetadata?.attributes}
+ *         />
+ *       ) : (
+ *         // Regular token display
+ *         <TokenRow
+ *           symbol={token.contractInfo?.symbol}
+ *           balance={token.balance}
+ *           decimals={token.contractInfo?.decimals}
+ *         />
+ *       )}
+ *     </div>
+ *   ))
+ * }
+ * ```
  */
 export const useGetTokenBalancesDetails = (getTokenBalancesDetailsArgs, options) => {
     const indexerGatewayClient = useIndexerGatewayClient();

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesDetails.js.map

@@ -1 +1 @@
-{"version":3,"file":"useGetTokenBalancesDetails.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesDetails.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAwD,MAAM,qBAAqB,CAAA;AACxG,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAElD,OAAO,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAElF,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE,MAAM,uBAAuB,GAAG,KAAK,EACnC,2BAAuE,EACvE,oBAA4C,EAC5C,gBAAyB,EACA,EAAE;IAC3B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAA;QAE3F,IAAI,gBAAgB,EAAE,CAAC;YACrB,KAAK,MAAM,YAAY,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACxC,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAChD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,OAAO,CACtG,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAmB,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CACnF,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAClD,wBAAwB,CAAC,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,CAAC,cAAc,EAAE,kBAAkB,CAAC,OAAO,CAAC,CACpH,CACF,CAAA;QAED,MAAM,MAAM,GAAmB,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAEzF,MAAM,cAAc,GAAG,kBAAkB,CAAC,CAAC,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC,CAAC,CAAA;QAEvE,OAAO,CAAC,GAAG,cAAc,CAAC,YAAY,EAAE,GAAG,cAAc,CAAC,WAAW,EAAE,GAAG,cAAc,CAAC,YAAY,CAAC,CAAA;IACxG,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,CAAA;IACT,CAAC;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,2BAAuE,EACvE,OAA4B,EAC5B,EAAE;IACF,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,0BAA0B,EAAE,2BAA2B,EAAE,OAAO,CAAC;QACvF,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,MAAM,uBAAuB,CAAC,2BAA2B,EAAE,oBAAoB,EAAE,OAAO,EAAE,gBAAgB,IAAI,KAAK,CAAC,CAAA;QAC7H,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,2BAA2B,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KACxF,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"useGetTokenBalancesDetails.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesDetails.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAwD,MAAM,qBAAqB,CAAA;AACxG,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAElD,OAAO,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAElF,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE,MAAM,uBAAuB,GAAG,KAAK,EACnC,2BAAuE,EACvE,oBAA4C,EAC5C,gBAAyB,EACA,EAAE;IAC3B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAA;QAE3F,IAAI,gBAAgB,EAAE,CAAC;YACrB,KAAK,MAAM,YAAY,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACxC,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAChD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,OAAO,CACtG,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAmB,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CACnF,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAClD,wBAAwB,CAAC,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,CAAC,cAAc,EAAE,kBAAkB,CAAC,OAAO,CAAC,CACpH,CACF,CAAA;QAED,MAAM,MAAM,GAAmB,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAEzF,MAAM,cAAc,GAAG,kBAAkB,CAAC,CAAC,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC,CAAC,CAAA;QAEvE,OAAO,CAAC,GAAG,cAAc,CAAC,YAAY,EAAE,GAAG,cAAc,CAAC,WAAW,EAAE,GAAG,cAAc,CAAC,YAAY,CAAC,CAAA;IACxG,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,CAAA;IACT,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,2BAAuE,EACvE,OAA4B,EAC5B,EAAE;IACF,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,0BAA0B,EAAE,2BAA2B,EAAE,OAAO,CAAC;QACvF,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,MAAM,uBAAuB,CAAC,2BAA2B,EAAE,oBAAoB,EAAE,OAAO,EAAE,gBAAgB,IAAI,KAAK,CAAC,CAAA;QAC7H,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,2BAA2B,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KACxF,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesSummary.d.ts

@@ -1,7 +1,71 @@
 import { IndexerGateway, TokenBalance } from '@0xsequence/indexer';
 import { BalanceHookOptions } from '../../types';
 /**
- * @description Gets the token balances, with summarized contract info but not individual token details for non-native contracts
+ * Hook to fetch token balances with summarized contract information.
+ * This is a lighter version of useGetTokenBalancesDetails - it returns basic token information
+ * without detailed metadata, making it faster and more suitable for token lists and balances display.
+ * Results are sorted by type: native tokens first, then ERC20s, then collectibles.
+ *
+ * @param getTokenBalancesSummaryArgs - Arguments for fetching token balances
+ * @param getTokenBalancesSummaryArgs.chainIds - Array of chain IDs to fetch balances from
+ * @param getTokenBalancesSummaryArgs.filter - Filter criteria for the query
+ * @param getTokenBalancesSummaryArgs.filter.accountAddresses - List of account addresses to fetch balances for
+ * @param getTokenBalancesSummaryArgs.filter.contractWhitelist - Optional list of contracts to include
+ * @param getTokenBalancesSummaryArgs.filter.contractBlacklist - Optional list of contracts to exclude
+ * @param getTokenBalancesSummaryArgs.filter.omitNativeBalances - If true, excludes native token balances
+ * @param getTokenBalancesSummaryArgs.filter.contractStatus - Optional filter for contract verification status
+ * @param options - Optional configuration for the query behavior
+ * @param options.hideCollectibles - If true, filters out ERC721 and ERC1155 tokens
+ * @param options.disabled - If true, disables the query from automatically running
+ * @param options.retry - If true (default), retries failed queries
+ *
+ * Query configuration:
+ * - Marks data as stale after 30 seconds
+ * - Retries failed requests by default
+ * - Only enabled when account address is present and not explicitly disabled
+ *
+ * @returns Query result containing an array of TokenBalance objects with basic information:
+ * - `contractType`: Type of the token contract (NATIVE, ERC20, ERC721, ERC1155)
+ * - `contractAddress`: Address of the token contract
+ * - `accountAddress`: Address of the account holding the tokens
+ * - `balance`: Token balance as a string
+ * - `chainId`: Chain ID where the token exists
+ * - `contractInfo`: Basic token contract information including:
+ *   - `name`: Token name
+ *   - `symbol`: Token symbol
+ *   - `decimals`: Number of decimals
+ *   - `logoURI`: URL of the token logo
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTokenBalancesSummary} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useGetTokenBalancesSummary } from '@0xsequence/hooks'
+ *
+ * // Fetch token balances for a wallet
+ * function TokenBalances() {
+ *   const { data: tokens } = useGetTokenBalancesSummary({
+ *     chainIds: [1, 137], // Ethereum and Polygon
+ *     filter: {
+ *       accountAddresses: ['0x123...'],
+ *       omitNativeBalances: false,
+ *       // Optional: filter specific tokens
+ *       contractWhitelist: ['0x...', '0x...']
+ *     }
+ *   })
+ *
+ *   return tokens?.map(token => (
+ *     <div key={`${token.chainId}-${token.contractAddress}`}>
+ *       <TokenRow
+ *         symbol={token.contractInfo?.symbol}
+ *         balance={token.balance}
+ *         decimals={token.contractInfo?.decimals}
+ *         logoURI={token.contractInfo?.logoURI}
+ *       />
+ *     </div>
+ *   ))
+ * }
+ * ```
  */
 export declare const useGetTokenBalancesSummary: (getTokenBalancesSummaryArgs: IndexerGateway.GetTokenBalancesSummaryArgs, options?: BalanceHookOptions) => import("@tanstack/react-query").UseQueryResult<TokenBalance[], Error>;
 //# sourceMappingURL=useGetTokenBalancesSummary.d.ts.map

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesSummary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useGetTokenBalancesSummary.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesSummary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAA0B,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAIxG,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAqChD;;GAEG;AACH,eAAO,MAAM,0BAA0B,GACrC,6BAA6B,cAAc,CAAC,2BAA2B,EACvE,UAAU,kBAAkB,0EAa7B,CAAA"}
+{"version":3,"file":"useGetTokenBalancesSummary.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesSummary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAA0B,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAIxG,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAqChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,eAAO,MAAM,0BAA0B,GACrC,6BAA6B,cAAc,CAAC,2BAA2B,EACvE,UAAU,kBAAkB,0EAa7B,CAAA"}

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesSummary.js

@@ -21,7 +21,71 @@ const getTokenBalancesSummary = async (getTokenBalancesSummaryArgs, indexerGatew
     }
 };
 /**
- * @description Gets the token balances, with summarized contract info but not individual token details for non-native contracts
+ * Hook to fetch token balances with summarized contract information.
+ * This is a lighter version of useGetTokenBalancesDetails - it returns basic token information
+ * without detailed metadata, making it faster and more suitable for token lists and balances display.
+ * Results are sorted by type: native tokens first, then ERC20s, then collectibles.
+ *
+ * @param getTokenBalancesSummaryArgs - Arguments for fetching token balances
+ * @param getTokenBalancesSummaryArgs.chainIds - Array of chain IDs to fetch balances from
+ * @param getTokenBalancesSummaryArgs.filter - Filter criteria for the query
+ * @param getTokenBalancesSummaryArgs.filter.accountAddresses - List of account addresses to fetch balances for
+ * @param getTokenBalancesSummaryArgs.filter.contractWhitelist - Optional list of contracts to include
+ * @param getTokenBalancesSummaryArgs.filter.contractBlacklist - Optional list of contracts to exclude
+ * @param getTokenBalancesSummaryArgs.filter.omitNativeBalances - If true, excludes native token balances
+ * @param getTokenBalancesSummaryArgs.filter.contractStatus - Optional filter for contract verification status
+ * @param options - Optional configuration for the query behavior
+ * @param options.hideCollectibles - If true, filters out ERC721 and ERC1155 tokens
+ * @param options.disabled - If true, disables the query from automatically running
+ * @param options.retry - If true (default), retries failed queries
+ *
+ * Query configuration:
+ * - Marks data as stale after 30 seconds
+ * - Retries failed requests by default
+ * - Only enabled when account address is present and not explicitly disabled
+ *
+ * @returns Query result containing an array of TokenBalance objects with basic information:
+ * - `contractType`: Type of the token contract (NATIVE, ERC20, ERC721, ERC1155)
+ * - `contractAddress`: Address of the token contract
+ * - `accountAddress`: Address of the account holding the tokens
+ * - `balance`: Token balance as a string
+ * - `chainId`: Chain ID where the token exists
+ * - `contractInfo`: Basic token contract information including:
+ *   - `name`: Token name
+ *   - `symbol`: Token symbol
+ *   - `decimals`: Number of decimals
+ *   - `logoURI`: URL of the token logo
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetTokenBalancesSummary} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useGetTokenBalancesSummary } from '@0xsequence/hooks'
+ *
+ * // Fetch token balances for a wallet
+ * function TokenBalances() {
+ *   const { data: tokens } = useGetTokenBalancesSummary({
+ *     chainIds: [1, 137], // Ethereum and Polygon
+ *     filter: {
+ *       accountAddresses: ['0x123...'],
+ *       omitNativeBalances: false,
+ *       // Optional: filter specific tokens
+ *       contractWhitelist: ['0x...', '0x...']
+ *     }
+ *   })
+ *
+ *   return tokens?.map(token => (
+ *     <div key={`${token.chainId}-${token.contractAddress}`}>
+ *       <TokenRow
+ *         symbol={token.contractInfo?.symbol}
+ *         balance={token.balance}
+ *         decimals={token.contractInfo?.decimals}
+ *         logoURI={token.contractInfo?.logoURI}
+ *       />
+ *     </div>
+ *   ))
+ * }
+ * ```
  */
 export const useGetTokenBalancesSummary = (getTokenBalancesSummaryArgs, options) => {
     const indexerGatewayClient = useIndexerGatewayClient();

package/dist/esm/hooks/IndexerGateway/useGetTokenBalancesSummary.js.map

@@ -1 +1 @@
-{"version":3,"file":"useGetTokenBalancesSummary.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesSummary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAwD,MAAM,qBAAqB,CAAA;AACxG,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAElD,OAAO,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAElF,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE,MAAM,uBAAuB,GAAG,KAAK,EACnC,2BAAuE,EACvE,oBAA4C,EAC5C,gBAAyB,EACA,EAAE;IAC3B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAA;QAE3F,IAAI,gBAAgB,EAAE,CAAC;YACrB,KAAK,MAAM,YAAY,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACxC,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAChD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,OAAO,CACtG,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAmB,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CACnF,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAClD,wBAAwB,CAAC,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,CAAC,cAAc,EAAE,kBAAkB,CAAC,OAAO,CAAC,CACpH,CACF,CAAA;QAED,MAAM,MAAM,GAAmB,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAEzF,MAAM,cAAc,GAAG,kBAAkB,CAAC,CAAC,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC,CAAC,CAAA;QAEvE,OAAO,CAAC,GAAG,cAAc,CAAC,YAAY,EAAE,GAAG,cAAc,CAAC,WAAW,EAAE,GAAG,cAAc,CAAC,YAAY,CAAC,CAAA;IACxG,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,CAAA;IACT,CAAC;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,2BAAuE,EACvE,OAA4B,EAC5B,EAAE;IACF,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,0BAA0B,EAAE,2BAA2B,EAAE,OAAO,CAAC;QACvF,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,MAAM,uBAAuB,CAAC,2BAA2B,EAAE,oBAAoB,EAAE,OAAO,EAAE,gBAAgB,IAAI,KAAK,CAAC,CAAA;QAC7H,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,2BAA2B,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KACxF,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"useGetTokenBalancesSummary.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetTokenBalancesSummary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAwD,MAAM,qBAAqB,CAAA;AACxG,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAElD,OAAO,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAElF,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE,MAAM,uBAAuB,GAAG,KAAK,EACnC,2BAAuE,EACvE,oBAA4C,EAC5C,gBAAyB,EACA,EAAE;IAC3B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAA;QAE3F,IAAI,gBAAgB,EAAE,CAAC;YACrB,KAAK,MAAM,YAAY,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACxC,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAChD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,OAAO,CACtG,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAmB,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CACnF,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAClD,wBAAwB,CAAC,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,CAAC,cAAc,EAAE,kBAAkB,CAAC,OAAO,CAAC,CACpH,CACF,CAAA;QAED,MAAM,MAAM,GAAmB,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAEzF,MAAM,cAAc,GAAG,kBAAkB,CAAC,CAAC,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC,CAAC,CAAA;QAEvE,OAAO,CAAC,GAAG,cAAc,CAAC,YAAY,EAAE,GAAG,cAAc,CAAC,WAAW,EAAE,GAAG,cAAc,CAAC,YAAY,CAAC,CAAA;IACxG,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,CAAA;IACT,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,2BAAuE,EACvE,OAA4B,EAC5B,EAAE;IACF,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,0BAA0B,EAAE,2BAA2B,EAAE,OAAO,CAAC;QACvF,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,MAAM,uBAAuB,CAAC,2BAA2B,EAAE,oBAAoB,EAAE,OAAO,EAAE,gBAAgB,IAAI,KAAK,CAAC,CAAA;QAC7H,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,2BAA2B,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ;KACxF,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/esm/hooks/IndexerGateway/useIndexerGatewayClient.d.ts

@@ -1,3 +1,29 @@
 import { SequenceIndexerGateway } from '@0xsequence/indexer';
+/**
+ * Hook that provides an indexer gateway client for querying token balances across multiple chains.
+ * Unlike the regular indexer client, the gateway client can fetch token data from multiple
+ * chains in a single request.
+ *
+ * @returns A SequenceIndexerGateway instance
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useIndexerGatewayClient} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useIndexerGatewayClient } from '@0xsequence/hooks'
+ *
+ * const TokenBalances = () => {
+ *   const indexerGatewayClient = useIndexerGatewayClient()
+ *
+ *   // Get balances across multiple chains in one call
+ *   const { data } = useGetTokenBalancesSummary({
+ *     filter: {
+ *       accountAddresses: [address],
+ *       omitNativeBalances: false
+ *     }
+ *   })
+ * }
+ * ```
+ */
 export declare const useIndexerGatewayClient: () => SequenceIndexerGateway;
 //# sourceMappingURL=useIndexerGatewayClient.d.ts.map

package/dist/esm/hooks/IndexerGateway/useIndexerGatewayClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useIndexerGatewayClient.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useIndexerGatewayClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAK5D,eAAO,MAAM,uBAAuB,8BAQnC,CAAA"}
+{"version":3,"file":"useIndexerGatewayClient.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useIndexerGatewayClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAK5D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,uBAAuB,8BAQnC,CAAA"}

package/dist/esm/hooks/IndexerGateway/useIndexerGatewayClient.js

@@ -1,6 +1,32 @@
 import { SequenceIndexerGateway } from '@0xsequence/indexer';
 import { useMemo } from 'react';
 import { useConfig } from '../useConfig';
+/**
+ * Hook that provides an indexer gateway client for querying token balances across multiple chains.
+ * Unlike the regular indexer client, the gateway client can fetch token data from multiple
+ * chains in a single request.
+ *
+ * @returns A SequenceIndexerGateway instance
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useIndexerGatewayClient} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useIndexerGatewayClient } from '@0xsequence/hooks'
+ *
+ * const TokenBalances = () => {
+ *   const indexerGatewayClient = useIndexerGatewayClient()
+ *
+ *   // Get balances across multiple chains in one call
+ *   const { data } = useGetTokenBalancesSummary({
+ *     filter: {
+ *       accountAddresses: [address],
+ *       omitNativeBalances: false
+ *     }
+ *   })
+ * }
+ * ```
+ */
 export const useIndexerGatewayClient = () => {
     const { env, projectAccessKey, jwt } = useConfig();
     const indexerGatewayClient = useMemo(() => {

package/dist/esm/hooks/IndexerGateway/useIndexerGatewayClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"useIndexerGatewayClient.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useIndexerGatewayClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAExC,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE;IAC1C,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,GAAG,EAAE,GAAG,SAAS,EAAE,CAAA;IAElD,MAAM,oBAAoB,GAAG,OAAO,CAAC,GAAG,EAAE;QACxC,OAAO,IAAI,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAA;IACjF,CAAC,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC,CAAA;IAE3B,OAAO,oBAAoB,CAAA;AAC7B,CAAC,CAAA"}
+{"version":3,"file":"useIndexerGatewayClient.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useIndexerGatewayClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE;IAC1C,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,GAAG,EAAE,GAAG,SAAS,EAAE,CAAA;IAElD,MAAM,oBAAoB,GAAG,OAAO,CAAC,GAAG,EAAE;QACxC,OAAO,IAAI,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAA;IACjF,CAAC,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC,CAAA;IAE3B,OAAO,oBAAoB,CAAA;AAC7B,CAAC,CAAA"}

package/dist/esm/tests/handlers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handlers.d.ts","sourceRoot":"","sources":["../../../src/tests/handlers.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,QAAQ,6BA+UpB,CAAA"}
+{"version":3,"file":"handlers.d.ts","sourceRoot":"","sources":["../../../src/tests/handlers.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,QAAQ,6BAuWpB,CAAA"}

package/dist/esm/tests/handlers.js

@@ -255,6 +255,26 @@ export const handlers = [
             ]
         }, { status: 200 });
     }),
+    http.post('*/GetSwapPermit2Prices', async () => {
+        return HttpResponse.json({
+            swapPermit2Prices: [
+                {
+                    currencyAddress: '0x7ceb23fd6bc0add59e62ac25578270cff1b9f619',
+                    currencyBalance: '180000000000000',
+                    price: '7351402238115',
+                    maxPrice: '7718972350021',
+                    transactionValue: '0'
+                },
+                {
+                    currencyAddress: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee',
+                    currencyBalance: '1478702455538610019',
+                    price: '64490918485610659',
+                    maxPrice: '67715464409891192',
+                    transactionValue: '67715464409891192'
+                }
+            ]
+        }, { status: 200 });
+    }),
     http.post('*/GetSwapQuote', async () => {
         return HttpResponse.json({
             swapQuote: {