feat: short description

scaffold-eth · May 1, 2024 · 05b67af · 05b67af
1 parent 042abaf
commit 05b67af
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/nextjs/hooks/scaffold-eth/useWatchBalance.ts b/packages/nextjs/hooks/scaffold-eth/useWatchBalance.ts
@@ -5,6 +5,9 @@ import { UseBalanceParameters, useBalance, useBlockNumber } from "wagmi";
 
 type UseWatchBalanceParameters = UseBalanceParameters;
 
+/**
+ * Wrapper around wagmi's useBalance hook. Updates data on every block change.
+ */
 export const useWatchBalance = (useBalanceParameters: UseWatchBalanceParameters) => {
   const { targetNetwork } = useTargetNetwork();
   const queryClient = useQueryClient();