wagmi-extended 1.1.5 → 1.1.7

package/README.md

@@ -111,6 +111,11 @@ Example:
 function MyTransactionComponent() {
 const { writeContractAsync, isPending, errorMessage } = useContractWriteX({
     queriesToInvalidate: [["userBalance"], ["userActivity"]],
+    {
+      // use calbacks here in writeContractAsync or in useContractWriteX
+      onSuccess: (txHash) => console.log("Transaction successful:", txHash),
+      onError: (error) => console.error("Transaction error:", error),
+    }
 });
 
 const handleWrite = async () => {
@@ -120,10 +125,6 @@ const handleWrite = async () => {
         abi: [], // Provide your contract ABI
         functionName: "executeFunction",
         args: [/* function arguments */],
-      }, {
-        // use calbacks here in writeContractAsync or in useContractWriteX
-        onSuccess: (txHash) => console.log("Transaction successful:", txHash),
-        onError: (error) => console.error("Transaction error:", error),
       });
       console.log("Received txHash:", txHash);
     } catch (err) {
@@ -142,6 +143,28 @@ return (
 }
 ```
 
+**Important:** To ensure transaction receipts are awaited correctly, **all settings and callbacks must be passed inside the hook itself**, not inside `mutate` or `mutateAsync` calls.
+
+Example of correct usage:
+
+```ts
+const { writeContractAsync } = useContractWriteX({
+  queriesToInvalidate: [["userBalance"]],
+  onSuccess: (txHash) => console.log("Tx success:", txHash),
+  onError: (err) => console.error("Tx error:", err),
+});
+```
+
+**Avoid passing callbacks like this:**
+
+```ts
+await writeContractAsync(config, {
+  onSuccess: () => {}, // ❌ This will NOT guarantee receipt handling!
+});
+```
+
+This design ensures that `wagmi-extended` can properly track and wait for the transaction receipt, giving your app reliable post-transaction state.
+
 ### useSendTransactionX Hook
 
 The `useSendTransactionX` hook wraps the transaction-sending functionality from Wagmi with additional features like `receipt` waiting, `logging` control, and `query invalidation` after receipt is successfully fetched.

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "wagmi-extended",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "type": "module",
-  "description": "A library providing extended hooks on top of Wagmi with additional features.",
+  "description": "A library providing extended hooks on top of Wagmi with additional hooks and features.",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -40,7 +40,7 @@
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.0.0",
-    "react": "^17.0.0 || ^18.0.0",
+    "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
     "viem": "^2.0.0",
     "wagmi": "^2.0.0"
   },