@safe-global/safe-react-hooks/dist/hooks/useBalance.d.ts

A collection of React Hooks that facilitates the interaction of React apps with Safe Smart Accounts

import { type UseBalanceReturnType as UseBalanceReturnTypeWagmi } from 'wagmi';
import { type GetBalanceQueryFnData } from 'wagmi/query';
import type { ConfigParam, SafeConfig } from '../types/index.js';
export type UseBalanceParams = ConfigParam<SafeConfig>;
export type UseBalanceReturnType = UseBalanceReturnTypeWagmi<GetBalanceQueryFnData>;
/**
 * Hook to get the connected Safe's balance.
 * @param params Parameters to customize the hook behavior.
 * @param params.config SafeConfig to use instead of the one provided by `SafeProvider`.
 * @returns Query result object containing the Safe's balance.
 */
export declare function useBalance(params?: UseBalanceParams): UseBalanceReturnType;