@0xsequence/hooks 5.1.0 → 5.2.0

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

@@ -1,7 +1,35 @@
 import { IndexerGateway, TokenBalance } from '@0xsequence/indexer';
 import { HooksOptions } from '../../types';
 /**
- * @description Gets the native token balance for a list of given networks or chainIds
+ * Hook to fetch native token balances (like ETH, POL) across multiple chains for a given address.
+ * Uses the indexer gateway client to efficiently fetch balances in a single request.
+ *
+ * @param getNativeTokenBalanceArgs - Arguments for fetching native token balances
+ * @param getNativeTokenBalanceArgs.accountAddress - The address to fetch balances for
+ * @param getNativeTokenBalanceArgs.chainIds - Array of chain IDs to fetch balances from
+ * @param options - Optional configuration for the query behavior
+ *
+ * @returns Query result containing an array of TokenBalance objects
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetNativeTokenBalance} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useGetNativeTokenBalance } from '@0xsequence/hooks'
+ *
+ * function NativeBalances() {
+ *   const { data: balances } = useGetNativeTokenBalance({
+ *     accountAddress: '0x123...',
+ *     chainIds: [1, 137] // Fetch ETH on Ethereum and MATIC on Polygon
+ *   })
+ *
+ *   return balances?.map(balance => (
+ *     <div key={balance.chainId}>
+ *       Chain {balance.chainId}: {balance.balance}
+ *     </div>
+ *   ))
+ * }
+ * ```
  */
 export declare const useGetNativeTokenBalance: (getNativeTokenBalanceArgs: IndexerGateway.GetNativeTokenBalanceArgs, options?: HooksOptions) => import("@tanstack/react-query").UseQueryResult<TokenBalance[], Error>;
 //# sourceMappingURL=useGetNativeTokenBalance.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useGetNativeTokenBalance.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetNativeTokenBalance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAA0B,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAI1F,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAkB1C;;GAEG;AACH,eAAO,MAAM,wBAAwB,GACnC,2BAA2B,cAAc,CAAC,yBAAyB,EACnE,UAAU,YAAY,0EAWvB,CAAA"}
+{"version":3,"file":"useGetNativeTokenBalance.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetNativeTokenBalance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAA0B,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAI1F,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAkB1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,wBAAwB,GACnC,2BAA2B,cAAc,CAAC,yBAAyB,EACnE,UAAU,YAAY,0EAWvB,CAAA"}

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

@@ -8,7 +8,35 @@ const getNativeTokenBalance = async (indexerGatewayClient, getNativeTokenBalance
     return balances;
 };
 /**
- * @description Gets the native token balance for a list of given networks or chainIds
+ * Hook to fetch native token balances (like ETH, POL) across multiple chains for a given address.
+ * Uses the indexer gateway client to efficiently fetch balances in a single request.
+ *
+ * @param getNativeTokenBalanceArgs - Arguments for fetching native token balances
+ * @param getNativeTokenBalanceArgs.accountAddress - The address to fetch balances for
+ * @param getNativeTokenBalanceArgs.chainIds - Array of chain IDs to fetch balances from
+ * @param options - Optional configuration for the query behavior
+ *
+ * @returns Query result containing an array of TokenBalance objects
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetNativeTokenBalance} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useGetNativeTokenBalance } from '@0xsequence/hooks'
+ *
+ * function NativeBalances() {
+ *   const { data: balances } = useGetNativeTokenBalance({
+ *     accountAddress: '0x123...',
+ *     chainIds: [1, 137] // Fetch ETH on Ethereum and MATIC on Polygon
+ *   })
+ *
+ *   return balances?.map(balance => (
+ *     <div key={balance.chainId}>
+ *       Chain {balance.chainId}: {balance.balance}
+ *     </div>
+ *   ))
+ * }
+ * ```
  */
 export const useGetNativeTokenBalance = (getNativeTokenBalanceArgs, options) => {
     const indexerGatewayClient = useIndexerGatewayClient();

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

@@ -1 +1 @@
-{"version":3,"file":"useGetNativeTokenBalance.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetNativeTokenBalance.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAElD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AAE9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE,MAAM,qBAAqB,GAAG,KAAK,EACjC,oBAA4C,EAC5C,yBAAmE,EAC1C,EAAE;IAC3B,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,CAAA;IAEvF,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAC3C,wBAAwB,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CACpG,CAAA;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,yBAAmE,EACnE,OAAsB,EACtB,EAAE;IACF,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,wBAAwB,EAAE,yBAAyB,EAAE,OAAO,CAAC;QACnF,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,qBAAqB,CAAC,oBAAoB,EAAE,yBAAyB,CAAC;QACjG,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,yBAAyB,CAAC,cAAc,IAAI,CAAC,OAAO,EAAE,QAAQ;KAC1E,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"useGetNativeTokenBalance.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetNativeTokenBalance.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAElD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AAE9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE,MAAM,qBAAqB,GAAG,KAAK,EACjC,oBAA4C,EAC5C,yBAAmE,EAC1C,EAAE;IAC3B,MAAM,GAAG,GAAG,MAAM,oBAAoB,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,CAAA;IAEvF,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAC3C,wBAAwB,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CACpG,CAAA;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,yBAAmE,EACnE,OAAsB,EACtB,EAAE;IACF,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,wBAAwB,EAAE,yBAAyB,EAAE,OAAO,CAAC;QACnF,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,qBAAqB,CAAC,oBAAoB,EAAE,yBAAyB,CAAC;QACjG,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,yBAAyB,CAAC,cAAc,IAAI,CAAC,OAAO,EAAE,QAAQ;KAC1E,CAAC,CAAA;AACJ,CAAC,CAAA"}

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

@@ -5,7 +5,44 @@ export interface GetSingleTokenBalanceSummaryArgs {
     contractAddress: string;
 }
 /**
- * @description Gets the single token balance summary for a given chainId and contractAddress
+ * Hook to fetch the balance of a specific token (native or ERC20) for an account on a specific chain.
+ * For native tokens, use ZERO_ADDRESS (0x0000...0000) as the contractAddress.
+ *
+ * @param args - Arguments for fetching the token balance
+ * @param args.chainId - The chain ID to fetch the balance from
+ * @param args.accountAddress - The address to fetch the balance for
+ * @param args.contractAddress - The token contract address (use ZERO_ADDRESS for native tokens)
+ * @param options - Optional configuration for the query behavior
+ * @param options.hideCollectibles - If true, filters out ERC721 and ERC1155 tokens
+ *
+ * @returns Query result containing the token balance
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetSingleTokenBalanceSummary} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useGetSingleTokenBalanceSummary, ZERO_ADDRESS } from '@0xsequence/hooks'
+ *
+ * // Fetch native ETH balance
+ * function NativeBalance() {
+ *   const { data: ethBalance } = useGetSingleTokenBalanceSummary({
+ *     chainId: 1,
+ *     accountAddress: '0x123...',
+ *     contractAddress: ZERO_ADDRESS
+ *   })
+ *   return <div>ETH Balance: {ethBalance?.balance}</div>
+ * }
+ *
+ * // Fetch USDC balance
+ * function TokenBalance() {
+ *   const { data: usdcBalance } = useGetSingleTokenBalanceSummary({
+ *     chainId: 1,
+ *     accountAddress: '0x123...',
+ *     contractAddress: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' // USDC
+ *   })
+ *   return <div>USDC Balance: {usdcBalance?.balance}</div>
+ * }
+ * ```
  */
 export declare const useGetSingleTokenBalanceSummary: (args: GetSingleTokenBalanceSummaryArgs, options?: BalanceHookOptions) => import("@tanstack/react-query").UseQueryResult<import("@0xsequence/indexer").TokenBalance, Error>;
 //# sourceMappingURL=useGetSingleTokenBalanceSummary.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useGetSingleTokenBalanceSummary.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetSingleTokenBalanceSummary.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAKhD,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,MAAM,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;CACxB;AA+BD;;GAEG;AACH,eAAO,MAAM,+BAA+B,GAAI,MAAM,gCAAgC,EAAE,UAAU,kBAAkB,sGAYnH,CAAA"}
+{"version":3,"file":"useGetSingleTokenBalanceSummary.d.ts","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetSingleTokenBalanceSummary.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAKhD,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,MAAM,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;CACxB;AA+BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,eAAO,MAAM,+BAA+B,GAAI,MAAM,gCAAgC,EAAE,UAAU,kBAAkB,sGAYnH,CAAA"}

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

@@ -25,7 +25,44 @@ const getSingleTokenBalanceSummary = async (args, indexerGatewayClient, hideColl
     }
 };
 /**
- * @description Gets the single token balance summary for a given chainId and contractAddress
+ * Hook to fetch the balance of a specific token (native or ERC20) for an account on a specific chain.
+ * For native tokens, use ZERO_ADDRESS (0x0000...0000) as the contractAddress.
+ *
+ * @param args - Arguments for fetching the token balance
+ * @param args.chainId - The chain ID to fetch the balance from
+ * @param args.accountAddress - The address to fetch the balance for
+ * @param args.contractAddress - The token contract address (use ZERO_ADDRESS for native tokens)
+ * @param options - Optional configuration for the query behavior
+ * @param options.hideCollectibles - If true, filters out ERC721 and ERC1155 tokens
+ *
+ * @returns Query result containing the token balance
+ *
+ * @see {@link https://docs.sequence.xyz/sdk/web/hooks/useGetSingleTokenBalanceSummary} for more detailed documentation.
+ *
+ * @example
+ * ```tsx
+ * import { useGetSingleTokenBalanceSummary, ZERO_ADDRESS } from '@0xsequence/hooks'
+ *
+ * // Fetch native ETH balance
+ * function NativeBalance() {
+ *   const { data: ethBalance } = useGetSingleTokenBalanceSummary({
+ *     chainId: 1,
+ *     accountAddress: '0x123...',
+ *     contractAddress: ZERO_ADDRESS
+ *   })
+ *   return <div>ETH Balance: {ethBalance?.balance}</div>
+ * }
+ *
+ * // Fetch USDC balance
+ * function TokenBalance() {
+ *   const { data: usdcBalance } = useGetSingleTokenBalanceSummary({
+ *     chainId: 1,
+ *     accountAddress: '0x123...',
+ *     contractAddress: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' // USDC
+ *   })
+ *   return <div>USDC Balance: {usdcBalance?.balance}</div>
+ * }
+ * ```
  */
 export const useGetSingleTokenBalanceSummary = (args, options) => {
     const indexerGatewayClient = useIndexerGatewayClient();

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

@@ -1 +1 @@
-{"version":3,"file":"useGetSingleTokenBalanceSummary.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetSingleTokenBalanceSummary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAA0B,MAAM,qBAAqB,CAAA;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAEhE,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AAE9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAQnE,MAAM,4BAA4B,GAAG,KAAK,EACxC,IAAsC,EACtC,oBAA4C,EAC5C,gBAAyB,EACzB,EAAE;IACF,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,uBAAuB,CAAC;QACjE,QAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;QACxB,MAAM,EAAE;YACN,gBAAgB,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC;YACvC,iBAAiB,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;YACzC,kBAAkB,EAAE,KAAK;SAC1B;KACF,CAAC,CAAA;IAEF,IAAI,gBAAgB,EAAE,CAAC;QACrB,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC5C,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,IAAI,cAAc,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,CAAC;QACvD,OAAO,wBAAwB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IAClH,CAAC;SAAM,CAAC;QACN,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACvC,CAAC;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,IAAsC,EAAE,OAA4B,EAAE,EAAE;IACtH,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,+BAA+B,EAAE,IAAI,EAAE,OAAO,CAAC;QACrE,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,MAAM,4BAA4B,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,gBAAgB,IAAI,KAAK,CAAC,CAAA;QAC3G,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,OAAO,EAAE,QAAQ;KACvE,CAAC,CAAA;AACJ,CAAC,CAAA"}
+{"version":3,"file":"useGetSingleTokenBalanceSummary.js","sourceRoot":"","sources":["../../../../src/hooks/IndexerGateway/useGetSingleTokenBalanceSummary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAA0B,MAAM,qBAAqB,CAAA;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAEhE,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AAE9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAQnE,MAAM,4BAA4B,GAAG,KAAK,EACxC,IAAsC,EACtC,oBAA4C,EAC5C,gBAAyB,EACzB,EAAE;IACF,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,uBAAuB,CAAC;QACjE,QAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;QACxB,MAAM,EAAE;YACN,gBAAgB,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC;YACvC,iBAAiB,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;YACzC,kBAAkB,EAAE,KAAK;SAC1B;KACF,CAAC,CAAA;IAEF,IAAI,gBAAgB,EAAE,CAAC;QACrB,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC5C,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,IAAI,cAAc,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,CAAC;QACvD,OAAO,wBAAwB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IAClH,CAAC;SAAM,CAAC;QACN,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACvC,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,IAAsC,EAAE,OAA4B,EAAE,EAAE;IACtH,MAAM,oBAAoB,GAAG,uBAAuB,EAAE,CAAA;IAEtD,OAAO,QAAQ,CAAC;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC,+BAA+B,EAAE,IAAI,EAAE,OAAO,CAAC;QACrE,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,MAAM,4BAA4B,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,gBAAgB,IAAI,KAAK,CAAC,CAAA;QAC3G,CAAC;QACD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;QAC7B,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,EAAE;QAC9B,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,OAAO,EAAE,QAAQ;KACvE,CAAC,CAAA;AACJ,CAAC,CAAA"}

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"}