wagmi-extended 1.1.8 → 2.0.1

package/dist/index.esm.js

@@ -1,11 +1,24 @@
-import { useConfig, useWriteContract, useSendTransaction, useAccount } from 'wagmi';
+import { useConfig, usePublicClient, useWriteContract, useSendTransaction, useAccount } from 'wagmi';
 import { waitForTransactionReceipt } from 'wagmi/actions';
 import { useState, useEffect } from 'react';
-import { ContractFunctionRevertedError, erc20Abi, maxUint256, zeroAddress } from 'viem';
 import { useQueryClient, useQuery } from '@tanstack/react-query';
-import { readContract } from 'viem/actions';
+import { ContractFunctionRevertedError, erc20Abi, maxUint256, zeroAddress, erc4626Abi } from 'viem';
 import { readContractQueryOptions } from 'wagmi/query';
 
+/**
+ * Hook to invalidate multiple queries in the React Query cache.
+ *
+ * @returns An object with the invalidateMany function.
+ */
+function useInvalidateQueries() {
+    const queryClient = useQueryClient();
+    const invalidateMany = async (queries) => {
+        const promises = queries.map((queryKey) => queryClient.invalidateQueries({ queryKey }));
+        await Promise.all(promises);
+    };
+    return { invalidateMany };
+}
+
 /**
  * Default error mapping that contains a set of error identifiers mapped to user-friendly error messages.
  */
@@ -89,20 +102,6 @@ const getParsedErrorX = (error) => {
     return message;
 };
 
-/**
- * Hook to invalidate multiple queries in the React Query cache.
- *
- * @returns An object with the invalidateMany function.
- */
-function useInvalidateQueries() {
-    const queryClient = useQueryClient();
-    const invalidateMany = async (queries) => {
-        const promises = queries.map((queryKey) => queryClient.invalidateQueries({ queryKey }));
-        await Promise.all(promises);
-    };
-    return { invalidateMany };
-}
-
 /**
  * Custom hook to handle transaction mutations.
  *
@@ -110,6 +109,7 @@ function useInvalidateQueries() {
  */
 function useHandleTransactionMutationX({ settings, }) {
     const wagmiConfig = useConfig();
+    const queryClient = useQueryClient();
     const { invalidateMany } = useInvalidateQueries();
     const [isPending, setIsPending] = useState(false);
     const [errorMessage, setErrorMessage] = useState(undefined);
@@ -134,10 +134,21 @@ function useHandleTransactionMutationX({ settings, }) {
                     throw new Error("Execution reverted.");
             }
             // 3. invalidate queries
-            if (settings === null || settings === void 0 ? void 0 : settings.queriesToInvalidate)
-                await invalidateMany(settings === null || settings === void 0 ? void 0 : settings.queriesToInvalidate);
+            const { queriesToInvalidate, invalidatePredicate } = settings || {};
+            if (invalidatePredicate) {
+                // 1) predicate-based
+                await queryClient.invalidateQueries({
+                    predicate: invalidatePredicate,
+                });
+            }
+            if (queriesToInvalidate) {
+                // 2) explicit key list
+                await invalidateMany(queriesToInvalidate);
+            }
             // 4. call onSuccess callback
             (_a = settings === null || settings === void 0 ? void 0 : settings.onSuccess) === null || _a === void 0 ? void 0 : _a.call(settings, txHash);
+            if (settings === null || settings === void 0 ? void 0 : settings.onSuccessAsync)
+                await settings.onSuccessAsync(txHash);
             if (!(settings === null || settings === void 0 ? void 0 : settings.disableLogging)) {
                 // 5. log result
                 // eslint-disable-next-line no-console
@@ -157,11 +168,15 @@ function useHandleTransactionMutationX({ settings, }) {
             setErrorMessage(parsedError);
             // 3. call callback
             (_b = settings === null || settings === void 0 ? void 0 : settings.onError) === null || _b === void 0 ? void 0 : _b.call(settings, error);
+            if (settings === null || settings === void 0 ? void 0 : settings.onErrorAsync)
+                await settings.onErrorAsync(error);
         }
         finally {
             setIsPending(false);
             // 1. call callback
             (_c = settings === null || settings === void 0 ? void 0 : settings.onSettled) === null || _c === void 0 ? void 0 : _c.call(settings);
+            if (settings === null || settings === void 0 ? void 0 : settings.onSettledAsync)
+                await settings.onSettledAsync();
         }
         return undefined;
     };
@@ -233,20 +248,33 @@ function useHandleTransactionMutationX({ settings, }) {
  * }
  */
 function useContractWriteX(settings) {
-    const { isPending, errorMessage, onMutate, onSettled } = useHandleTransactionMutationX({
-        settings,
-    });
-    const { writeContractAsync, ...rest } = useWriteContract({
-        mutation: {
-            onMutate,
-            onSettled,
-        },
+    const publicClient = usePublicClient();
+    const { isPending, errorMessage, onMutate, onSettled } = useHandleTransactionMutationX({ settings });
+    // Underlying Wagmi write hook:
+    const wagmiWrite = useWriteContract({
+        mutation: { onMutate, onSettled },
     });
+    async function simulateAsyncAndWriteContract(params) {
+        // 0) signal start
+        onMutate();
+        try {
+            // 1) optional dry-run
+            const { chain, ...others } = params;
+            await (publicClient === null || publicClient === void 0 ? void 0 : publicClient.simulateContract({
+                ...others,
+                ...(chain != null ? { chain } : {}),
+            }));
+            wagmiWrite.writeContract(params);
+        }
+        catch (err) {
+            await onSettled(undefined, err, params);
+        }
+    }
     return {
-        ...rest,
+        ...wagmiWrite,
+        simulateAsyncAndWriteContract,
         isPending,
         errorMessage,
-        writeContractAsync,
     };
 }
 
@@ -297,44 +325,135 @@ function useContractWriteX(settings) {
  * }
  */
 function useSendTransactionX(settings) {
+    const publicClient = usePublicClient();
     const { isPending, errorMessage, onMutate, onSettled } = useHandleTransactionMutationX({
         settings,
     });
-    const { sendTransactionAsync, ...rest } = useSendTransaction({
+    const { sendTransaction, ...rest } = useSendTransaction({
         mutation: {
             onMutate,
             onSettled,
         },
     });
+    /**
+     * Wraps sendTransaction with an optional simulation.
+     */
+    async function simulateAsyncAndSendTransaction(params, simulationParams) {
+        var _a;
+        onMutate();
+        try {
+            if (params.to) {
+                //simulate!
+                await (publicClient === null || publicClient === void 0 ? void 0 : publicClient.simulateContract({
+                    address: params.to,
+                    abi: simulationParams.abi,
+                    functionName: simulationParams.functionName,
+                    args: (_a = simulationParams.args) !== null && _a !== void 0 ? _a : [],
+                    account: params.account,
+                    ...(simulationParams.chain != null
+                        ? { chain: simulationParams.chain }
+                        : {}),
+                }));
+            }
+            // actual send!
+            await sendTransaction(params);
+        }
+        catch (err) {
+            await onSettled(undefined, err, params);
+        }
+    }
     return {
         ...rest,
         isPending,
         errorMessage,
-        sendTransactionAsync,
+        simulateAsyncAndSendTransaction,
     };
 }
 
 const queryConfig = {
-    metadataQueryConfig: {
-        staleTime: Infinity,
+    metaDataQuery: {
+        staleTime: Number.POSITIVE_INFINITY,
+        meta: { category: "metadata" },
     },
-    sensitiveDataQueryConfig: {
+    lowSensitiveQuery: {
         staleTime: 60000,
+        meta: { category: "lowSensitive" },
     },
-};
+    semiSensitiveQuery: {
+        staleTime: 180000,
+        meta: { category: "semiSensitive" },
+    }};
 
-const fetchAllowance = async (asset, spender, userAddress, config) => {
-    const allowance = await readContract(config, {
-        address: asset,
-        abi: erc20Abi,
-        functionName: "allowance",
-        args: [userAddress, spender],
-    });
-    if (allowance == null) {
-        throw new Error("Failed to fetch token data or allowance");
+// You can adjust the type for wagmiConfig to match your needs.
+let defaultQueryClient = null;
+let defaultWagmiConfig = null;
+/**
+ * Sets the default configuration values.
+ *
+ * @param queryClient - The default QueryClient instance.
+ * @param wagmiConfig - The default Wagmi configuration.
+ * @example
+ * //In your application initialization (e.g., index.tsx or App.tsx):
+ * import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+ * import { wagmiConfig } from "/path/to/wagmi-config";
+ * import { setDefaults } from "wagmi-extended";
+ *
+ * const queryClient = new QueryClient();
+ *
+ * //Set defaults for the extended library functions.
+ * setDefaults(queryClient, wagmiConfig);
+ *
+ * //Now helper functions like fetchTokenX can use these defaults if no explicit parameters are provided.
+ */
+function setDefaults(queryClient, wagmiConfig) {
+    defaultQueryClient = queryClient;
+    defaultWagmiConfig = wagmiConfig;
+}
+/**
+ * Retrieves the currently set default configurations.
+ *
+ * @throws Will throw an error if defaults are not initialized.
+ * @returns An object containing the default queryClient and wagmiConfig.
+ *
+ * @example
+ * // Usage in a helper function:
+ * import { getDefaults } from "wagmi-extended";
+ *
+ * function exampleFunction() {
+ *   const { queryClient, wagmiConfig } = getDefaults();
+ *   // Use queryClient and wagmiConfig as needed...
+ * }
+ */
+function getDefaults() {
+    if (!defaultQueryClient || !defaultWagmiConfig) {
+        throw new Error("Default configuration not set. Please call setDefaults() first.");
+    }
+    return { queryClient: defaultQueryClient, wagmiConfig: defaultWagmiConfig };
+}
+
+function ensureClientAndConfig(queryClient, wagmiConfig) {
+    if (!queryClient || !wagmiConfig) {
+        ({ queryClient, wagmiConfig } = getDefaults());
+    }
+    if (!queryClient || !wagmiConfig) {
+        throw new Error("Could not find queryClient or wagmiConfig; pass them in or setDefaults() first");
     }
+    return { queryClient, wagmiConfig };
+}
+
+async function fetchAllowanceX(asset, spender, user, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    const allowance = await queryClient.fetchQuery({
+        ...readContractQueryOptions(wagmiConfig, {
+            address: asset,
+            abi: erc20Abi,
+            functionName: "allowance",
+            args: [user, spender],
+        }),
+        ...queryConfig.metaDataQuery,
+    });
     return allowance;
-};
+}
 
 const HookFetchAssetAllowanceQK = (asset, spender, userAddress) => ["HookFetchAllowance", asset, spender, userAddress];
 /**
@@ -364,12 +483,13 @@ const HookFetchAssetAllowanceQK = (asset, spender, userAddress) => ["HookFetchAl
  */
 const useFetchAssetAllowanceX = ({ asset, spender, }) => {
     const config = useConfig();
+    const queryClient = useQueryClient();
     const { address: userAddress } = useAccount();
     const { data, ...rest } = useQuery({
         queryKey: HookFetchAssetAllowanceQK(asset, spender, userAddress),
-        queryFn: () => fetchAllowance(asset, spender, userAddress, config),
+        queryFn: () => fetchAllowanceX(asset, spender, userAddress, queryClient, config),
         enabled: Boolean(asset) && Boolean(spender) && Boolean(userAddress),
-        ...queryConfig.sensitiveDataQueryConfig,
+        ...queryConfig.lowSensitiveQuery,
     });
     return {
         ...rest,
@@ -467,65 +587,13 @@ const useERC20ApproveX = (tokenAddress, spenderAddress, amount, approveMax) => {
     };
 };
 
-// You can adjust the type for wagmiConfig to match your needs.
-let defaultQueryClient = null;
-let defaultWagmiConfig = null;
-/**
- * Sets the default configuration values.
- *
- * @param queryClient - The default QueryClient instance.
- * @param wagmiConfig - The default Wagmi configuration.
- * @example
- * //In your application initialization (e.g., index.tsx or App.tsx):
- * import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
- * import { wagmiConfig } from "/path/to/wagmi-config";
- * import { setDefaults } from "wagmi-extended";
- *
- * const queryClient = new QueryClient();
- *
- * //Set defaults for the extended library functions.
- * setDefaults(queryClient, wagmiConfig);
- *
- * //Now helper functions like fetchTokenX can use these defaults if no explicit parameters are provided.
- */
-function setDefaults(queryClient, wagmiConfig) {
-    defaultQueryClient = queryClient;
-    defaultWagmiConfig = wagmiConfig;
-}
-/**
- * Retrieves the currently set default configurations.
- *
- * @throws Will throw an error if defaults are not initialized.
- * @returns An object containing the default queryClient and wagmiConfig.
- *
- * @example
- * // Usage in a helper function:
- * import { getDefaults } from "wagmi-extended";
- *
- * function exampleFunction() {
- *   const { queryClient, wagmiConfig } = getDefaults();
- *   // Use queryClient and wagmiConfig as needed...
- * }
- */
-function getDefaults() {
-    if (!defaultQueryClient || !defaultWagmiConfig) {
-        throw new Error("Default configuration not set. Please call setDefaults() first.");
-    }
-    return { queryClient: defaultQueryClient, wagmiConfig: defaultWagmiConfig };
-}
-
 const EthTokenData = {
     symbol: "ETH",
     decimals: 18,
     name: "Ethereum",
 };
 async function fetchDecimalsX(token, queryClient, wagmiConfig) {
-    if (!queryClient || !wagmiConfig) {
-        ({ queryClient, wagmiConfig } = getDefaults());
-    }
-    if (!queryClient || !wagmiConfig) {
-        throw new Error("Could not find queryClient or wagmiConfig, either pass them as arguments or set them using setDefaults()");
-    }
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
     if (token === zeroAddress)
         return EthTokenData.decimals;
     const decimals = await queryClient.fetchQuery({
@@ -534,17 +602,12 @@ async function fetchDecimalsX(token, queryClient, wagmiConfig) {
             abi: erc20Abi,
             functionName: "decimals",
         }),
-        ...queryConfig.metadataQueryConfig,
+        ...queryConfig.metaDataQuery,
     });
     return decimals;
 }
 async function fetchSymbolX(token, queryClient, wagmiConfig) {
-    if (!queryClient || !wagmiConfig) {
-        ({ queryClient, wagmiConfig } = getDefaults());
-    }
-    if (!queryClient || !wagmiConfig) {
-        throw new Error("Could not find queryClient or wagmiConfig, either pass them as arguments or set them using setDefaults()");
-    }
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
     if (token === zeroAddress)
         return EthTokenData.symbol;
     const symbol = await queryClient.fetchQuery({
@@ -553,26 +616,21 @@ async function fetchSymbolX(token, queryClient, wagmiConfig) {
             abi: erc20Abi,
             functionName: "symbol",
         }),
-        ...queryConfig.metadataQueryConfig,
+        ...queryConfig.metaDataQuery,
     });
     return symbol;
 }
 async function fetchNameX(token, queryClient, wagmiConfig) {
     if (token === zeroAddress)
         return EthTokenData.name;
-    if (!queryClient || !wagmiConfig) {
-        ({ queryClient, wagmiConfig } = getDefaults());
-    }
-    if (!queryClient || !wagmiConfig) {
-        throw new Error("Could not find queryClient or wagmiConfig, either pass them as arguments or set them using setDefaults()");
-    }
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
     const name = await queryClient.fetchQuery({
         ...readContractQueryOptions(wagmiConfig, {
             address: token,
             abi: erc20Abi,
             functionName: "name",
         }),
-        ...queryConfig.metadataQueryConfig,
+        ...queryConfig.metaDataQuery,
     });
     return name;
 }
@@ -661,5 +719,170 @@ const useTokenX = (asset) => {
     };
 };
 
-export { EthTokenData, HookFetchTokenQK, fetchDecimalsX, fetchNameX, fetchSymbolX, fetchTokenX, getDefaults, getErrorMapping, getParsedErrorX, resetErrorMapping, setDefaults, setErrorMapping, useContractWriteX, useERC20ApproveX, useFetchAssetAllowanceX, useSendTransactionX, useTokenX };
+async function fetchBalanceOfX(asset, user, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    return await queryClient.fetchQuery({
+        ...readContractQueryOptions(wagmiConfig, {
+            address: asset,
+            abi: erc20Abi,
+            functionName: "balanceOf",
+            args: [user],
+        }),
+        ...queryConfig.lowSensitiveQuery,
+    });
+}
+
+async function fetchTotalSupplyX(asset, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    return await queryClient.fetchQuery({
+        ...readContractQueryOptions(wagmiConfig, {
+            address: asset,
+            abi: erc20Abi,
+            functionName: "totalSupply",
+        }),
+        ...queryConfig.semiSensitiveQuery,
+    });
+}
+
+/**
+ * Fetches the full ERC-20 “summary” for a given vault and user context.
+ */
+async function fetchERC20DataX(address, user, spender, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    const [name, symbol, decimals, allowance, balanceOf, asset] = await Promise.all([
+        fetchNameX(address, queryClient, wagmiConfig),
+        fetchSymbolX(address, queryClient, wagmiConfig),
+        fetchDecimalsX(address, queryClient, wagmiConfig),
+        spender && user
+            ? fetchAllowanceX(address, spender, user, queryClient, wagmiConfig)
+            : undefined,
+        user
+            ? fetchBalanceOfX(address, user, queryClient, wagmiConfig)
+            : undefined,
+        fetchTotalSupplyX(address, queryClient, wagmiConfig),
+    ]);
+    return {
+        name,
+        symbol,
+        decimals,
+        allowance,
+        balanceOf,
+        asset,
+        address,
+        user,
+        spender,
+    };
+}
+
+async function fetchERC4626AssetX(vault, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    return queryClient.fetchQuery({
+        ...readContractQueryOptions(wagmiConfig, {
+            address: vault,
+            abi: erc4626Abi,
+            functionName: "asset",
+        }),
+        ...queryConfig.metaDataQuery,
+    });
+}
+
+async function fetchERC4626TotalAssetsX(vault, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    return queryClient.fetchQuery({
+        ...readContractQueryOptions(wagmiConfig, {
+            address: vault,
+            abi: erc4626Abi,
+            functionName: "totalAssets",
+        }),
+        ...queryConfig.semiSensitiveQuery,
+    });
+}
+
+async function fetchERC4626MaxDepositX(vault, caller, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    return queryClient.fetchQuery({
+        ...readContractQueryOptions(wagmiConfig, {
+            address: vault,
+            abi: erc4626Abi,
+            functionName: "maxDeposit",
+            args: [caller],
+        }),
+        ...queryConfig.semiSensitiveQuery,
+    });
+}
+
+async function fetchERC4626MaxMintX(vault, caller, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    return queryClient.fetchQuery({
+        ...readContractQueryOptions(wagmiConfig, {
+            address: vault,
+            abi: erc4626Abi,
+            functionName: "maxMint",
+            args: [caller],
+        }),
+        ...queryConfig.semiSensitiveQuery,
+    });
+}
+
+async function fetchERC4626MaxRedeemX(vault, owner, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    return queryClient.fetchQuery({
+        ...readContractQueryOptions(wagmiConfig, {
+            address: vault,
+            abi: erc4626Abi,
+            functionName: "maxRedeem",
+            args: [owner],
+        }),
+        ...queryConfig.semiSensitiveQuery,
+    });
+}
+
+async function fetchERC4626MaxWithdrawX(vault, owner, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    return queryClient.fetchQuery({
+        ...readContractQueryOptions(wagmiConfig, {
+            address: vault,
+            abi: erc4626Abi,
+            functionName: "maxWithdraw",
+            args: [owner],
+        }),
+        ...queryConfig.semiSensitiveQuery,
+    });
+}
+
+/**
+ * Fetches the full ERC-4626 “summary” for a given vault and user context.
+ */
+async function fetchERC4626DataX(vault, user, spender, queryClient, wagmiConfig) {
+    ({ queryClient, wagmiConfig } = ensureClientAndConfig(queryClient, wagmiConfig));
+    const [erc20Data, maxDeposit, maxMint, maxRedeem, maxWithdraw] = await Promise.all([
+        fetchERC20DataX(vault, user, spender, queryClient, wagmiConfig),
+        fetchERC4626AssetX(vault, queryClient, wagmiConfig),
+        fetchERC4626TotalAssetsX(vault, queryClient, wagmiConfig),
+        user
+            ? fetchERC4626MaxDepositX(vault, user, queryClient, wagmiConfig)
+            : undefined,
+        user
+            ? fetchERC4626MaxMintX(vault, user, queryClient, wagmiConfig)
+            : undefined,
+        user
+            ? fetchERC4626MaxRedeemX(vault, user, queryClient, wagmiConfig)
+            : undefined,
+        user
+            ? fetchERC4626MaxWithdrawX(vault, user, queryClient, wagmiConfig)
+            : undefined,
+    ]);
+    return {
+        ...erc20Data,
+        maxDeposit,
+        maxMint,
+        maxRedeem,
+        maxWithdraw,
+        vault,
+        owner: user,
+        spender,
+    };
+}
+
+export { EthTokenData, HookFetchTokenQK, fetchAllowanceX, fetchBalanceOfX, fetchDecimalsX, fetchERC20DataX, fetchERC4626AssetX, fetchERC4626DataX, fetchERC4626MaxDepositX, fetchERC4626MaxMintX, fetchERC4626MaxRedeemX, fetchERC4626MaxWithdrawX, fetchERC4626TotalAssetsX, fetchNameX, fetchSymbolX, fetchTokenX, fetchTotalSupplyX, getDefaults, getErrorMapping, getParsedErrorX, resetErrorMapping, setDefaults, setErrorMapping, useContractWriteX, useERC20ApproveX, useFetchAssetAllowanceX, useSendTransactionX, useTokenX };
 //# sourceMappingURL=index.esm.js.map