wagmi-extended 0.2.0 → 0.5.0

package/dist/index.cjs.js

@@ -1,8 +1,252 @@
 'use strict';
 
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./hooks/useContractWriteExtended"), exports);
-tslib_1.__exportStar(require("./hooks/useSendTransactionExtended"), exports);
-tslib_1.__exportStar(require("./utils/errorParser"), exports);
+var wagmi = require('wagmi');
+var actions = require('wagmi/actions');
+var reactQuery = require('@tanstack/react-query');
+var react = require('react');
+var viem = require('viem');
+
+/**
+ * Hook to invalidate multiple queries in the React Query cache.
+ *
+ * @returns An object with the invalidateMany function.
+ */
+function useInvalidateQueries() {
+    const queryClient = reactQuery.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.
+ */
+const defaultErrorMapping = {
+    EnforcedPause: "Temporary pause in effect, please check Discord for updates.",
+    ErrorNotEnoughAllowance: "Not enough allowance, did you approve your tokens first?",
+    "0xc2139725": "Not enough allowance, did you approve your tokens first?",
+    SharesReceivedBelowMinimum: "Action exceeded safe slippage parameters, please try again later",
+    "0xea8d7f02": "Action exceeded safe slippage parameters, please try again later",
+    MaxSlippageExceeded: "Action exceeded safe slippage parameters, please try again later",
+    "51": "Supply cap exceeded",
+};
+/**
+ * A mutable copy of the default error mapping that can be extended or overridden by users.
+ */
+let currentErrorMapping = { ...defaultErrorMapping };
+/**
+ * Merges a custom error mapping into the current error mapping.
+ * Custom values override any existing keys.
+ *
+ * @param customMapping - An object containing error keys and the corresponding custom messages.
+ *
+ * @example
+ * setErrorMapping({
+ *   ErrorNotEnoughAllowance: "Custom message: Please approve tokens first!",
+ *   NewCustomError: "A custom error occurred."
+ * });
+ */
+const setErrorMapping = (customMapping) => {
+    currentErrorMapping = { ...currentErrorMapping, ...customMapping };
+};
+/**
+ * Resets the current error mapping to the default error mapping.
+ *
+ * @example
+ * resetErrorMapping();
+ */
+const resetErrorMapping = () => {
+    currentErrorMapping = { ...defaultErrorMapping };
+};
+/**
+ * Retrieves the current error mapping.
+ *
+ * @returns The current error mapping object.
+ *
+ * @example
+ * const mapping = getErrorMapping();
+ * console.log(mapping);
+ */
+const getErrorMapping = () => currentErrorMapping;
+/**
+ * Parses an error object and returns a user-friendly error message.
+ *
+ * The function checks if the error is a ContractFunctionRevertedError by attempting to walk through
+ * the error using its `walk` method. If a matching error is found and its error key exists in the
+ * current error mapping, the corresponding custom message will be returned. Otherwise, it falls back
+ * to the error's own message properties.
+ *
+ * @param error - The error object, potentially including additional error details.
+ * @returns A user-friendly error message.
+ *
+ * @example
+ * const message = getParsedError(someError);
+ * console.log(message); // Outputs a custom error message or a default error message.
+ */
+const getParsedError = (error) => {
+    var _a, _b, _c, _d;
+    const defaultMessage = "An unknown error occurred. Please contact support.";
+    let message = defaultMessage;
+    let errorKey = "";
+    const revertedError = (error === null || error === void 0 ? void 0 : error.walk)
+        ? error.walk((err) => err instanceof viem.ContractFunctionRevertedError)
+        : null;
+    if (revertedError instanceof viem.ContractFunctionRevertedError) {
+        errorKey =
+            (_d = (_c = (_b = (_a = revertedError.data) === null || _a === void 0 ? void 0 : _a.errorName) !== null && _b !== void 0 ? _b : revertedError.signature) !== null && _c !== void 0 ? _c : revertedError.reason) !== null && _d !== void 0 ? _d : "";
+        if (currentErrorMapping[errorKey])
+            return currentErrorMapping[errorKey];
+    }
+    message = error.shortMessage || error.details || error.message || message;
+    return message;
+};
+
+/**
+ * Custom hook to handle transaction mutations.
+ *
+ * @returns {Function} A shared `onSettled` callback for transaction mutations.
+ */
+function useHandleTransactionMutation({ settings, }) {
+    const wagmiConfig = wagmi.useConfig();
+    const { invalidateMany } = useInvalidateQueries();
+    const [isPending, setIsPending] = react.useState(false);
+    const [errorMessage, setErrorMessage] = react.useState(undefined);
+    const onMutate = () => {
+        setIsPending(true);
+        setErrorMessage(undefined);
+    };
+    const onSettled = async (txHash, error, args) => {
+        var _a, _b, _c;
+        try {
+            if (error)
+                throw error;
+            if (!(settings === null || settings === void 0 ? void 0 : settings.disableWaitingForReceipt)) {
+                // 1. wait for transaction receipt
+                const txReceipt = await actions.waitForTransactionReceipt(wagmiConfig, {
+                    hash: txHash,
+                });
+                // 2. throw if receipt is not valid
+                if (txReceipt.status === "reverted")
+                    throw new Error("Execution reverted.");
+                if (txReceipt.status !== "success")
+                    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);
+            // 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.disableLogging)) {
+                // 5. log result
+                // eslint-disable-next-line no-console
+                console.info("Operation successful:", txHash); // todo: add logging service
+            }
+            // 6. return result
+            return txHash;
+        }
+        catch (error) {
+            const parsedError = getParsedError(error);
+            if (!(settings === null || settings === void 0 ? void 0 : settings.disableLogging)) {
+                // 1. log error
+                console.error(`ContractWriteExtended Operation failed with error(parsed): ${parsedError}`, { error }, { args });
+                console.error({ error });
+            }
+            // 2. set error message
+            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);
+        }
+        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);
+        }
+        return undefined;
+    };
+    return {
+        onMutate,
+        onSettled,
+        isPending,
+        errorMessage,
+    };
+}
+
+/**
+ * Custom hook for writing to a smart contract using Wagmi.
+ *
+ * This hook provides functionality for sending a transaction using Wagmi, handling the asynchronous nature of the operation, waiting for the transaction receipt, and error handling.
+ *
+ * @param {WriteExtendedAsyncParams} [settings] - Optional settings for the write operation.
+ * @param {boolean} [settings.disableWaitingForReceipt] - Disables waiting for the transaction receipt.
+ * @param {boolean} [settings.disableLogging] - Disables logging the result of the transaction.
+ * @param {Function} [settings.onSuccess] - Callback function to be called on successful transaction.
+ * @param {Function} [settings.onError] - Callback function to be called on transaction error.
+ * @param {Function} [settings.onSettled] - Callback function to be called after the transaction settles (whether success or failure).
+ * @param {QueryKey[]} [settings.queriesToInvalidate] - Array of query keys to invalidate after the transaction receives a receipt.
+ * @returns {Object} Object containing the following properties:
+ * - {boolean} isPending - Indicates whether the transaction is pending.
+ * - {string|undefined} errorMessage - The error message, if an error occurred during the transaction.
+ * - {Function} writeContractAsync - Function to trigger the write operation.
+ */
+function useContractWriteExtended(settings) {
+    const { isPending, errorMessage, onMutate, onSettled } = useHandleTransactionMutation({
+        settings,
+    });
+    const { writeContractAsync, ...rest } = wagmi.useWriteContract({
+        mutation: {
+            onMutate,
+            onSettled,
+        },
+    });
+    return {
+        ...rest,
+        isPending,
+        errorMessage,
+        writeContractAsync,
+    };
+}
+
+/**
+ * Custom hook for sending a transaction using Wagmi.
+ *
+ * This hook provides functionality for sending a transaction using Wagmi, handling the asynchronous nature of the operation, waiting for the transaction receipt, and error handling.
+ *
+ * @param {SeamlessWriteAsyncParams} [settings] - Optional settings for the write operation.
+ * @param {boolean} [settings.disableWaitingForReceipt] - Disables waiting for the transaction receipt.
+ * @param {boolean} [settings.disableLogging] - Disables logging the result of the transaction.
+ * @param {Function} [settings.onSuccess] - Callback function to be called on successful transaction.
+ * @param {Function} [settings.onError] - Callback function to be called on transaction error.
+ * @param {Function} [settings.onSettled] - Callback function to be called after the transaction settles (whether success or failure).
+ * @param {QueryKey[]} [settings.queriesToInvalidate] - Array of query keys to invalidate after the transaction receives a receipt.
+ * @returns {Object} Object containing the following properties:
+ * - {boolean} isPending - Indicates whether the transaction is pending.
+ * - {string|undefined} errorMessage - The error message, if an error occurred during the transaction.
+ * - {Function} sendTransactionAsync - Function to trigger the send transaction mutation.
+ */
+function useSendTransactionExtended(settings) {
+    const { isPending, errorMessage, onMutate, onSettled } = useHandleTransactionMutation({
+        settings,
+    });
+    const { sendTransactionAsync, ...rest } = wagmi.useSendTransaction({
+        mutation: {
+            onMutate,
+            onSettled,
+        },
+    });
+    return {
+        ...rest,
+        isPending,
+        errorMessage,
+        sendTransactionAsync,
+    };
+}
+
+exports.getErrorMapping = getErrorMapping;
+exports.getParsedError = getParsedError;
+exports.resetErrorMapping = resetErrorMapping;
+exports.setErrorMapping = setErrorMapping;
+exports.useContractWriteExtended = useContractWriteExtended;
+exports.useSendTransactionExtended = useSendTransactionExtended;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/index.ts"],"sourcesContent":["export * from \"./hooks/useContractWriteExtended\";\nexport * from \"./hooks/useSendTransactionExtended\";\nexport * from \"./utils/errorParser\";\n"],"names":[],"mappings":";;;;AAAA,OAAiD,CAAA,YAAA,CAAA,OAAA,CAAA,kCAAA,CAAA,EAAA,OAAA,CAAA;AACjD,OAAmD,CAAA,YAAA,CAAA,OAAA,CAAA,oCAAA,CAAA,EAAA,OAAA,CAAA;AACnD,OAAoC,CAAA,YAAA,CAAA,OAAA,CAAA,qBAAA,CAAA,EAAA,OAAA,CAAA;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/hooks/useInvalidateQueries.ts","../src/utils/errorParser.ts","../src/hooks/useHandleTransactionMutation.ts","../src/hooks/useContractWriteExtended.ts","../src/hooks/useSendTransactionExtended.ts"],"sourcesContent":["import { QueryKey, useQueryClient } from \"@tanstack/react-query\";\n\n/**\n * Hook to invalidate multiple queries in the React Query cache.\n *\n * @returns An object with the invalidateMany function.\n */\nexport function useInvalidateQueries() {\n  const queryClient = useQueryClient();\n\n  const invalidateMany = async (queries: (QueryKey | undefined)[]) => {\n    const promises = queries.map((queryKey) =>\n      queryClient.invalidateQueries({ queryKey })\n    );\n    await Promise.all(promises);\n  };\n\n  return { invalidateMany };\n}\n","import { BaseError, ContractFunctionRevertedError } from \"viem\";\n\n/**\n * Default error mapping that contains a set of error identifiers mapped to user-friendly error messages.\n */\nconst defaultErrorMapping: Record<string, string> = {\n  EnforcedPause: \"Temporary pause in effect, please check Discord for updates.\",\n  ErrorNotEnoughAllowance:\n    \"Not enough allowance, did you approve your tokens first?\",\n  \"0xc2139725\": \"Not enough allowance, did you approve your tokens first?\",\n  SharesReceivedBelowMinimum:\n    \"Action exceeded safe slippage parameters, please try again later\",\n  \"0xea8d7f02\":\n    \"Action exceeded safe slippage parameters, please try again later\",\n  MaxSlippageExceeded:\n    \"Action exceeded safe slippage parameters, please try again later\",\n  \"51\": \"Supply cap exceeded\",\n};\n\n/**\n * A mutable copy of the default error mapping that can be extended or overridden by users.\n */\nlet currentErrorMapping: Record<string, string> = { ...defaultErrorMapping };\n\n/**\n * Merges a custom error mapping into the current error mapping.\n * Custom values override any existing keys.\n *\n * @param customMapping - An object containing error keys and the corresponding custom messages.\n *\n * @example\n * setErrorMapping({\n *   ErrorNotEnoughAllowance: \"Custom message: Please approve tokens first!\",\n *   NewCustomError: \"A custom error occurred.\"\n * });\n */\nexport const setErrorMapping = (\n  customMapping: Record<string, string>\n): void => {\n  currentErrorMapping = { ...currentErrorMapping, ...customMapping };\n};\n\n/**\n * Resets the current error mapping to the default error mapping.\n *\n * @example\n * resetErrorMapping();\n */\nexport const resetErrorMapping = (): void => {\n  currentErrorMapping = { ...defaultErrorMapping };\n};\n\n/**\n * Retrieves the current error mapping.\n *\n * @returns The current error mapping object.\n *\n * @example\n * const mapping = getErrorMapping();\n * console.log(mapping);\n */\nexport const getErrorMapping = (): Record<string, string> =>\n  currentErrorMapping;\n\n/**\n * Parses an error object and returns a user-friendly error message.\n *\n * The function checks if the error is a ContractFunctionRevertedError by attempting to walk through\n * the error using its `walk` method. If a matching error is found and its error key exists in the\n * current error mapping, the corresponding custom message will be returned. Otherwise, it falls back\n * to the error's own message properties.\n *\n * @param error - The error object, potentially including additional error details.\n * @returns A user-friendly error message.\n *\n * @example\n * const message = getParsedError(someError);\n * console.log(message); // Outputs a custom error message or a default error message.\n */\nexport const getParsedError = (error: any | BaseError): string => {\n  const defaultMessage = \"An unknown error occurred. Please contact support.\";\n  let message = defaultMessage;\n  let errorKey = \"\";\n\n  const revertedError = error?.walk\n    ? error.walk((err: unknown) => err instanceof ContractFunctionRevertedError)\n    : null;\n  if (revertedError instanceof ContractFunctionRevertedError) {\n    errorKey =\n      revertedError.data?.errorName ??\n      revertedError.signature ??\n      revertedError.reason ??\n      \"\";\n    if (currentErrorMapping[errorKey]) return currentErrorMapping[errorKey];\n  }\n\n  message = error.shortMessage || error.details || error.message || message;\n  return message;\n};\n","import { waitForTransactionReceipt } from \"wagmi/actions\";\nimport { useInvalidateQueries } from \"./useInvalidateQueries\";\nimport { useConfig } from \"wagmi\";\nimport { QueryKey } from \"@tanstack/query-core\";\nimport { Address } from \"viem\";\nimport { useState } from \"react\";\nimport { getParsedError } from \"../utils/errorParser\";\n\nexport type WriteExtendedAsyncParams = {\n  onSuccess?: (txHash: Address) => void;\n  onError?: (e: any) => void;\n  onSettled?: () => void;\n  queriesToInvalidate?: (QueryKey | undefined)[];\n  disableLogging?: boolean;\n  disableWaitingForReceipt?: boolean;\n};\n\n/**\n * Custom hook to handle transaction mutations.\n *\n * @returns {Function} A shared `onSettled` callback for transaction mutations.\n */\nexport function useHandleTransactionMutation({\n  settings,\n}: {\n  settings?: WriteExtendedAsyncParams;\n}) {\n  const wagmiConfig = useConfig();\n\n  const { invalidateMany } = useInvalidateQueries();\n  const [isPending, setIsPending] = useState(false);\n  const [errorMessage, setErrorMessage] = useState<string | undefined>(\n    undefined\n  );\n\n  const onMutate = () => {\n    setIsPending(true);\n    setErrorMessage(undefined);\n  };\n\n  const onSettled = async (\n    txHash: Address | undefined,\n    error: any,\n    args: any\n  ) => {\n    try {\n      if (error) throw error;\n\n      if (!settings?.disableWaitingForReceipt) {\n        // 1. wait for transaction receipt\n        const txReceipt = await waitForTransactionReceipt(wagmiConfig, {\n          hash: txHash!,\n        });\n\n        // 2. throw if receipt is not valid\n        if (txReceipt.status === \"reverted\")\n          throw new Error(\"Execution reverted.\");\n        if (txReceipt.status !== \"success\")\n          throw new Error(\"Execution reverted.\");\n      }\n\n      // 3. invalidate queries\n      if (settings?.queriesToInvalidate)\n        await invalidateMany(settings?.queriesToInvalidate);\n\n      // 4. call onSuccess callback\n      settings?.onSuccess?.(txHash!);\n\n      if (!settings?.disableLogging) {\n        // 5. log result\n        // eslint-disable-next-line no-console\n        console.info(\"Operation successful:\", txHash); // todo: add logging service\n      }\n      // 6. return result\n      return txHash;\n    } catch (error) {\n      const parsedError = getParsedError(error);\n\n      if (!settings?.disableLogging) {\n        // 1. log error\n        console.error(\n          `ContractWriteExtended Operation failed with error(parsed): ${parsedError}`,\n          { error },\n          { args }\n        );\n        console.error({ error });\n      }\n      // 2. set error message\n      setErrorMessage(parsedError);\n\n      // 3. call callback\n      settings?.onError?.(error);\n    } finally {\n      setIsPending(false);\n      // 1. call callback\n      settings?.onSettled?.();\n    }\n    return undefined;\n  };\n\n  return {\n    onMutate,\n    onSettled,\n    isPending,\n    errorMessage,\n  };\n}\n","import { useWriteContract } from \"wagmi\";\nimport {\n  WriteExtendedAsyncParams,\n  useHandleTransactionMutation,\n} from \"./useHandleTransactionMutation\";\n\n/**\n * Custom hook for writing to a smart contract using Wagmi.\n *\n * This hook provides functionality for sending a transaction using Wagmi, handling the asynchronous nature of the operation, waiting for the transaction receipt, and error handling.\n *\n * @param {WriteExtendedAsyncParams} [settings] - Optional settings for the write operation.\n * @param {boolean} [settings.disableWaitingForReceipt] - Disables waiting for the transaction receipt.\n * @param {boolean} [settings.disableLogging] - Disables logging the result of the transaction.\n * @param {Function} [settings.onSuccess] - Callback function to be called on successful transaction.\n * @param {Function} [settings.onError] - Callback function to be called on transaction error.\n * @param {Function} [settings.onSettled] - Callback function to be called after the transaction settles (whether success or failure).\n * @param {QueryKey[]} [settings.queriesToInvalidate] - Array of query keys to invalidate after the transaction receives a receipt.\n * @returns {Object} Object containing the following properties:\n * - {boolean} isPending - Indicates whether the transaction is pending.\n * - {string|undefined} errorMessage - The error message, if an error occurred during the transaction.\n * - {Function} writeContractAsync - Function to trigger the write operation.\n */\n\nexport function useContractWriteExtended(settings?: WriteExtendedAsyncParams) {\n  const { isPending, errorMessage, onMutate, onSettled } =\n    useHandleTransactionMutation({\n      settings,\n    });\n\n  const { writeContractAsync, ...rest } = useWriteContract({\n    mutation: {\n      onMutate,\n      onSettled,\n    },\n  });\n\n  return {\n    ...rest,\n    isPending,\n    errorMessage,\n    writeContractAsync,\n  };\n}\n","import { Hash } from \"viem\";\nimport { useSendTransaction } from \"wagmi\";\nimport { QueryKey } from \"@tanstack/query-core\";\nimport { useHandleTransactionMutation } from \"./useHandleTransactionMutation\";\n\nexport type SeamlessSendAsyncParams = {\n  onSuccess?: (txHash: Hash) => void;\n  onError?: (e: any) => void;\n  onSettled?: () => void;\n  queriesToInvalidate?: (QueryKey | undefined)[];\n};\n\n/**\n * Custom hook for sending a transaction using Wagmi.\n *\n * This hook provides functionality for sending a transaction using Wagmi, handling the asynchronous nature of the operation, waiting for the transaction receipt, and error handling.\n *\n * @param {SeamlessWriteAsyncParams} [settings] - Optional settings for the write operation.\n * @param {boolean} [settings.disableWaitingForReceipt] - Disables waiting for the transaction receipt.\n * @param {boolean} [settings.disableLogging] - Disables logging the result of the transaction.\n * @param {Function} [settings.onSuccess] - Callback function to be called on successful transaction.\n * @param {Function} [settings.onError] - Callback function to be called on transaction error.\n * @param {Function} [settings.onSettled] - Callback function to be called after the transaction settles (whether success or failure).\n * @param {QueryKey[]} [settings.queriesToInvalidate] - Array of query keys to invalidate after the transaction receives a receipt.\n * @returns {Object} Object containing the following properties:\n * - {boolean} isPending - Indicates whether the transaction is pending.\n * - {string|undefined} errorMessage - The error message, if an error occurred during the transaction.\n * - {Function} sendTransactionAsync - Function to trigger the send transaction mutation.\n */\n\nexport function useSendTransactionExtended(settings?: SeamlessSendAsyncParams) {\n  const { isPending, errorMessage, onMutate, onSettled } =\n    useHandleTransactionMutation({\n      settings,\n    });\n\n  const { sendTransactionAsync, ...rest } = useSendTransaction({\n    mutation: {\n      onMutate,\n      onSettled,\n    },\n  });\n\n  return {\n    ...rest,\n    isPending,\n    errorMessage,\n    sendTransactionAsync,\n  };\n}\n"],"names":["useQueryClient","ContractFunctionRevertedError","useConfig","useState","waitForTransactionReceipt","useWriteContract","useSendTransaction"],"mappings":";;;;;;;;AAEA;;;;AAIG;SACa,oBAAoB,GAAA;AAClC,IAAA,MAAM,WAAW,GAAGA,yBAAc,EAAE;AAEpC,IAAA,MAAM,cAAc,GAAG,OAAO,OAAiC,KAAI;QACjE,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,KACpC,WAAW,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAC5C;AACD,QAAA,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC7B,KAAC;IAED,OAAO,EAAE,cAAc,EAAE;AAC3B;;AChBA;;AAEG;AACH,MAAM,mBAAmB,GAA2B;AAClD,IAAA,aAAa,EAAE,8DAA8D;AAC7E,IAAA,uBAAuB,EACrB,0DAA0D;AAC5D,IAAA,YAAY,EAAE,0DAA0D;AACxE,IAAA,0BAA0B,EACxB,kEAAkE;AACpE,IAAA,YAAY,EACV,kEAAkE;AACpE,IAAA,mBAAmB,EACjB,kEAAkE;AACpE,IAAA,IAAI,EAAE,qBAAqB;CAC5B;AAED;;AAEG;AACH,IAAI,mBAAmB,GAA2B,EAAE,GAAG,mBAAmB,EAAE;AAE5E;;;;;;;;;;;AAWG;AACU,MAAA,eAAe,GAAG,CAC7B,aAAqC,KAC7B;IACR,mBAAmB,GAAG,EAAE,GAAG,mBAAmB,EAAE,GAAG,aAAa,EAAE;AACpE;AAEA;;;;;AAKG;AACI,MAAM,iBAAiB,GAAG,MAAW;AAC1C,IAAA,mBAAmB,GAAG,EAAE,GAAG,mBAAmB,EAAE;AAClD;AAEA;;;;;;;;AAQG;MACU,eAAe,GAAG,MAC7B;AAEF;;;;;;;;;;;;;;AAcG;AACU,MAAA,cAAc,GAAG,CAAC,KAAsB,KAAY;;IAC/D,MAAM,cAAc,GAAG,oDAAoD;IAC3E,IAAI,OAAO,GAAG,cAAc;IAC5B,IAAI,QAAQ,GAAG,EAAE;IAEjB,MAAM,aAAa,GAAG,CAAA,KAAK,aAAL,KAAK,KAAA,MAAA,GAAA,MAAA,GAAL,KAAK,CAAE,IAAI;AAC/B,UAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAY,KAAK,GAAG,YAAYC,kCAA6B;UACzE,IAAI;AACR,IAAA,IAAI,aAAa,YAAYA,kCAA6B,EAAE;QAC1D,QAAQ;AACN,YAAA,CAAA,EAAA,GAAA,MAAA,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,aAAa,CAAC,IAAI,0CAAE,SAAS,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAC7B,aAAa,CAAC,SAAS,MACvB,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAA,aAAa,CAAC,MAAM,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GACpB,EAAE;QACJ,IAAI,mBAAmB,CAAC,QAAQ,CAAC;AAAE,YAAA,OAAO,mBAAmB,CAAC,QAAQ,CAAC;;AAGzE,IAAA,OAAO,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,IAAI,OAAO;AACzE,IAAA,OAAO,OAAO;AAChB;;ACjFA;;;;AAIG;AACa,SAAA,4BAA4B,CAAC,EAC3C,QAAQ,GAGT,EAAA;AACC,IAAA,MAAM,WAAW,GAAGC,eAAS,EAAE;AAE/B,IAAA,MAAM,EAAE,cAAc,EAAE,GAAG,oBAAoB,EAAE;IACjD,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAGC,cAAQ,CAAC,KAAK,CAAC;IACjD,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAGA,cAAQ,CAC9C,SAAS,CACV;IAED,MAAM,QAAQ,GAAG,MAAK;QACpB,YAAY,CAAC,IAAI,CAAC;QAClB,eAAe,CAAC,SAAS,CAAC;AAC5B,KAAC;IAED,MAAM,SAAS,GAAG,OAChB,MAA2B,EAC3B,KAAU,EACV,IAAS,KACP;;AACF,QAAA,IAAI;AACF,YAAA,IAAI,KAAK;AAAE,gBAAA,MAAM,KAAK;YAEtB,IAAI,EAAC,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAE,wBAAwB,CAAA,EAAE;;AAEvC,gBAAA,MAAM,SAAS,GAAG,MAAMC,iCAAyB,CAAC,WAAW,EAAE;AAC7D,oBAAA,IAAI,EAAE,MAAO;AACd,iBAAA,CAAC;;AAGF,gBAAA,IAAI,SAAS,CAAC,MAAM,KAAK,UAAU;AACjC,oBAAA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC;AACxC,gBAAA,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS;AAChC,oBAAA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC;;;AAI1C,YAAA,IAAI,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAE,mBAAmB;gBAC/B,MAAM,cAAc,CAAC,QAAQ,KAAR,IAAA,IAAA,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC;;YAGrD,CAAA,EAAA,GAAA,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAE,SAAS,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,CAAA,QAAA,EAAG,MAAO,CAAC;YAE9B,IAAI,EAAC,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAE,cAAc,CAAA,EAAE;;;gBAG7B,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;;;AAGhD,YAAA,OAAO,MAAM;;QACb,OAAO,KAAK,EAAE;AACd,YAAA,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC;YAEzC,IAAI,EAAC,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,MAAA,GAAA,MAAA,GAAA,QAAQ,CAAE,cAAc,CAAA,EAAE;;AAE7B,gBAAA,OAAO,CAAC,KAAK,CACX,CAAA,2DAAA,EAA8D,WAAW,CAAE,CAAA,EAC3E,EAAE,KAAK,EAAE,EACT,EAAE,IAAI,EAAE,CACT;AACD,gBAAA,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC;;;YAG1B,eAAe,CAAC,WAAW,CAAC;;YAG5B,CAAA,EAAA,GAAA,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,MAAA,GAAA,MAAA,GAAA,QAAQ,CAAE,OAAO,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAA,IAAA,CAAA,QAAA,EAAG,KAAK,CAAC;;gBAClB;YACR,YAAY,CAAC,KAAK,CAAC;;YAEnB,CAAA,EAAA,GAAA,QAAQ,aAAR,QAAQ,KAAA,MAAA,GAAA,MAAA,GAAR,QAAQ,CAAE,SAAS,wDAAI;;AAEzB,QAAA,OAAO,SAAS;AAClB,KAAC;IAED,OAAO;QACL,QAAQ;QACR,SAAS;QACT,SAAS;QACT,YAAY;KACb;AACH;;ACpGA;;;;;;;;;;;;;;;;AAgBG;AAEG,SAAU,wBAAwB,CAAC,QAAmC,EAAA;IAC1E,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,GACpD,4BAA4B,CAAC;QAC3B,QAAQ;AACT,KAAA,CAAC;IAEJ,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAGC,sBAAgB,CAAC;AACvD,QAAA,QAAQ,EAAE;YACR,QAAQ;YACR,SAAS;AACV,SAAA;AACF,KAAA,CAAC;IAEF,OAAO;AACL,QAAA,GAAG,IAAI;QACP,SAAS;QACT,YAAY;QACZ,kBAAkB;KACnB;AACH;;AC/BA;;;;;;;;;;;;;;;;AAgBG;AAEG,SAAU,0BAA0B,CAAC,QAAkC,EAAA;IAC3E,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,GACpD,4BAA4B,CAAC;QAC3B,QAAQ;AACT,KAAA,CAAC;IAEJ,MAAM,EAAE,oBAAoB,EAAE,GAAG,IAAI,EAAE,GAAGC,wBAAkB,CAAC;AAC3D,QAAA,QAAQ,EAAE;YACR,QAAQ;YACR,SAAS;AACV,SAAA;AACF,KAAA,CAAC;IAEF,OAAO;AACL,QAAA,GAAG,IAAI;QACP,SAAS;QACT,YAAY;QACZ,oBAAoB;KACrB;AACH;;;;;;;;;"}

package/dist/index.esm.js

@@ -1,6 +1,245 @@
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./hooks/useContractWriteExtended"), exports);
-tslib_1.__exportStar(require("./hooks/useSendTransactionExtended"), exports);
-tslib_1.__exportStar(require("./utils/errorParser"), exports);
+import { useConfig, useWriteContract, useSendTransaction } from 'wagmi';
+import { waitForTransactionReceipt } from 'wagmi/actions';
+import { useQueryClient } from '@tanstack/react-query';
+import { useState } from 'react';
+import { ContractFunctionRevertedError } from 'viem';
+
+/**
+ * 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.
+ */
+const defaultErrorMapping = {
+    EnforcedPause: "Temporary pause in effect, please check Discord for updates.",
+    ErrorNotEnoughAllowance: "Not enough allowance, did you approve your tokens first?",
+    "0xc2139725": "Not enough allowance, did you approve your tokens first?",
+    SharesReceivedBelowMinimum: "Action exceeded safe slippage parameters, please try again later",
+    "0xea8d7f02": "Action exceeded safe slippage parameters, please try again later",
+    MaxSlippageExceeded: "Action exceeded safe slippage parameters, please try again later",
+    "51": "Supply cap exceeded",
+};
+/**
+ * A mutable copy of the default error mapping that can be extended or overridden by users.
+ */
+let currentErrorMapping = { ...defaultErrorMapping };
+/**
+ * Merges a custom error mapping into the current error mapping.
+ * Custom values override any existing keys.
+ *
+ * @param customMapping - An object containing error keys and the corresponding custom messages.
+ *
+ * @example
+ * setErrorMapping({
+ *   ErrorNotEnoughAllowance: "Custom message: Please approve tokens first!",
+ *   NewCustomError: "A custom error occurred."
+ * });
+ */
+const setErrorMapping = (customMapping) => {
+    currentErrorMapping = { ...currentErrorMapping, ...customMapping };
+};
+/**
+ * Resets the current error mapping to the default error mapping.
+ *
+ * @example
+ * resetErrorMapping();
+ */
+const resetErrorMapping = () => {
+    currentErrorMapping = { ...defaultErrorMapping };
+};
+/**
+ * Retrieves the current error mapping.
+ *
+ * @returns The current error mapping object.
+ *
+ * @example
+ * const mapping = getErrorMapping();
+ * console.log(mapping);
+ */
+const getErrorMapping = () => currentErrorMapping;
+/**
+ * Parses an error object and returns a user-friendly error message.
+ *
+ * The function checks if the error is a ContractFunctionRevertedError by attempting to walk through
+ * the error using its `walk` method. If a matching error is found and its error key exists in the
+ * current error mapping, the corresponding custom message will be returned. Otherwise, it falls back
+ * to the error's own message properties.
+ *
+ * @param error - The error object, potentially including additional error details.
+ * @returns A user-friendly error message.
+ *
+ * @example
+ * const message = getParsedError(someError);
+ * console.log(message); // Outputs a custom error message or a default error message.
+ */
+const getParsedError = (error) => {
+    var _a, _b, _c, _d;
+    const defaultMessage = "An unknown error occurred. Please contact support.";
+    let message = defaultMessage;
+    let errorKey = "";
+    const revertedError = (error === null || error === void 0 ? void 0 : error.walk)
+        ? error.walk((err) => err instanceof ContractFunctionRevertedError)
+        : null;
+    if (revertedError instanceof ContractFunctionRevertedError) {
+        errorKey =
+            (_d = (_c = (_b = (_a = revertedError.data) === null || _a === void 0 ? void 0 : _a.errorName) !== null && _b !== void 0 ? _b : revertedError.signature) !== null && _c !== void 0 ? _c : revertedError.reason) !== null && _d !== void 0 ? _d : "";
+        if (currentErrorMapping[errorKey])
+            return currentErrorMapping[errorKey];
+    }
+    message = error.shortMessage || error.details || error.message || message;
+    return message;
+};
+
+/**
+ * Custom hook to handle transaction mutations.
+ *
+ * @returns {Function} A shared `onSettled` callback for transaction mutations.
+ */
+function useHandleTransactionMutation({ settings, }) {
+    const wagmiConfig = useConfig();
+    const { invalidateMany } = useInvalidateQueries();
+    const [isPending, setIsPending] = useState(false);
+    const [errorMessage, setErrorMessage] = useState(undefined);
+    const onMutate = () => {
+        setIsPending(true);
+        setErrorMessage(undefined);
+    };
+    const onSettled = async (txHash, error, args) => {
+        var _a, _b, _c;
+        try {
+            if (error)
+                throw error;
+            if (!(settings === null || settings === void 0 ? void 0 : settings.disableWaitingForReceipt)) {
+                // 1. wait for transaction receipt
+                const txReceipt = await waitForTransactionReceipt(wagmiConfig, {
+                    hash: txHash,
+                });
+                // 2. throw if receipt is not valid
+                if (txReceipt.status === "reverted")
+                    throw new Error("Execution reverted.");
+                if (txReceipt.status !== "success")
+                    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);
+            // 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.disableLogging)) {
+                // 5. log result
+                // eslint-disable-next-line no-console
+                console.info("Operation successful:", txHash); // todo: add logging service
+            }
+            // 6. return result
+            return txHash;
+        }
+        catch (error) {
+            const parsedError = getParsedError(error);
+            if (!(settings === null || settings === void 0 ? void 0 : settings.disableLogging)) {
+                // 1. log error
+                console.error(`ContractWriteExtended Operation failed with error(parsed): ${parsedError}`, { error }, { args });
+                console.error({ error });
+            }
+            // 2. set error message
+            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);
+        }
+        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);
+        }
+        return undefined;
+    };
+    return {
+        onMutate,
+        onSettled,
+        isPending,
+        errorMessage,
+    };
+}
+
+/**
+ * Custom hook for writing to a smart contract using Wagmi.
+ *
+ * This hook provides functionality for sending a transaction using Wagmi, handling the asynchronous nature of the operation, waiting for the transaction receipt, and error handling.
+ *
+ * @param {WriteExtendedAsyncParams} [settings] - Optional settings for the write operation.
+ * @param {boolean} [settings.disableWaitingForReceipt] - Disables waiting for the transaction receipt.
+ * @param {boolean} [settings.disableLogging] - Disables logging the result of the transaction.
+ * @param {Function} [settings.onSuccess] - Callback function to be called on successful transaction.
+ * @param {Function} [settings.onError] - Callback function to be called on transaction error.
+ * @param {Function} [settings.onSettled] - Callback function to be called after the transaction settles (whether success or failure).
+ * @param {QueryKey[]} [settings.queriesToInvalidate] - Array of query keys to invalidate after the transaction receives a receipt.
+ * @returns {Object} Object containing the following properties:
+ * - {boolean} isPending - Indicates whether the transaction is pending.
+ * - {string|undefined} errorMessage - The error message, if an error occurred during the transaction.
+ * - {Function} writeContractAsync - Function to trigger the write operation.
+ */
+function useContractWriteExtended(settings) {
+    const { isPending, errorMessage, onMutate, onSettled } = useHandleTransactionMutation({
+        settings,
+    });
+    const { writeContractAsync, ...rest } = useWriteContract({
+        mutation: {
+            onMutate,
+            onSettled,
+        },
+    });
+    return {
+        ...rest,
+        isPending,
+        errorMessage,
+        writeContractAsync,
+    };
+}
+
+/**
+ * Custom hook for sending a transaction using Wagmi.
+ *
+ * This hook provides functionality for sending a transaction using Wagmi, handling the asynchronous nature of the operation, waiting for the transaction receipt, and error handling.
+ *
+ * @param {SeamlessWriteAsyncParams} [settings] - Optional settings for the write operation.
+ * @param {boolean} [settings.disableWaitingForReceipt] - Disables waiting for the transaction receipt.
+ * @param {boolean} [settings.disableLogging] - Disables logging the result of the transaction.
+ * @param {Function} [settings.onSuccess] - Callback function to be called on successful transaction.
+ * @param {Function} [settings.onError] - Callback function to be called on transaction error.
+ * @param {Function} [settings.onSettled] - Callback function to be called after the transaction settles (whether success or failure).
+ * @param {QueryKey[]} [settings.queriesToInvalidate] - Array of query keys to invalidate after the transaction receives a receipt.
+ * @returns {Object} Object containing the following properties:
+ * - {boolean} isPending - Indicates whether the transaction is pending.
+ * - {string|undefined} errorMessage - The error message, if an error occurred during the transaction.
+ * - {Function} sendTransactionAsync - Function to trigger the send transaction mutation.
+ */
+function useSendTransactionExtended(settings) {
+    const { isPending, errorMessage, onMutate, onSettled } = useHandleTransactionMutation({
+        settings,
+    });
+    const { sendTransactionAsync, ...rest } = useSendTransaction({
+        mutation: {
+            onMutate,
+            onSettled,
+        },
+    });
+    return {
+        ...rest,
+        isPending,
+        errorMessage,
+        sendTransactionAsync,
+    };
+}
+
+export { getErrorMapping, getParsedError, resetErrorMapping, setErrorMapping, useContractWriteExtended, useSendTransactionExtended };
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":["../src/index.ts"],"sourcesContent":["export * from \"./hooks/useContractWriteExtended\";\nexport * from \"./hooks/useSendTransactionExtended\";\nexport * from \"./utils/errorParser\";\n"],"names":[],"mappings":";;AAAA,OAAiD,CAAA,YAAA,CAAA,OAAA,CAAA,kCAAA,CAAA,EAAA,OAAA,CAAA;AACjD,OAAmD,CAAA,YAAA,CAAA,OAAA,CAAA,oCAAA,CAAA,EAAA,OAAA,CAAA;AACnD,OAAoC,CAAA,YAAA,CAAA,OAAA,CAAA,qBAAA,CAAA,EAAA,OAAA,CAAA"}
+{"version":3,"file":"index.esm.js","sources":["../src/hooks/useInvalidateQueries.ts","../src/utils/errorParser.ts","../src/hooks/useHandleTransactionMutation.ts","../src/hooks/useContractWriteExtended.ts","../src/hooks/useSendTransactionExtended.ts"],"sourcesContent":["import { QueryKey, useQueryClient } from \"@tanstack/react-query\";\n\n/**\n * Hook to invalidate multiple queries in the React Query cache.\n *\n * @returns An object with the invalidateMany function.\n */\nexport function useInvalidateQueries() {\n  const queryClient = useQueryClient();\n\n  const invalidateMany = async (queries: (QueryKey | undefined)[]) => {\n    const promises = queries.map((queryKey) =>\n      queryClient.invalidateQueries({ queryKey })\n    );\n    await Promise.all(promises);\n  };\n\n  return { invalidateMany };\n}\n","import { BaseError, ContractFunctionRevertedError } from \"viem\";\n\n/**\n * Default error mapping that contains a set of error identifiers mapped to user-friendly error messages.\n */\nconst defaultErrorMapping: Record<string, string> = {\n  EnforcedPause: \"Temporary pause in effect, please check Discord for updates.\",\n  ErrorNotEnoughAllowance:\n    \"Not enough allowance, did you approve your tokens first?\",\n  \"0xc2139725\": \"Not enough allowance, did you approve your tokens first?\",\n  SharesReceivedBelowMinimum:\n    \"Action exceeded safe slippage parameters, please try again later\",\n  \"0xea8d7f02\":\n    \"Action exceeded safe slippage parameters, please try again later\",\n  MaxSlippageExceeded:\n    \"Action exceeded safe slippage parameters, please try again later\",\n  \"51\": \"Supply cap exceeded\",\n};\n\n/**\n * A mutable copy of the default error mapping that can be extended or overridden by users.\n */\nlet currentErrorMapping: Record<string, string> = { ...defaultErrorMapping };\n\n/**\n * Merges a custom error mapping into the current error mapping.\n * Custom values override any existing keys.\n *\n * @param customMapping - An object containing error keys and the corresponding custom messages.\n *\n * @example\n * setErrorMapping({\n *   ErrorNotEnoughAllowance: \"Custom message: Please approve tokens first!\",\n *   NewCustomError: \"A custom error occurred.\"\n * });\n */\nexport const setErrorMapping = (\n  customMapping: Record<string, string>\n): void => {\n  currentErrorMapping = { ...currentErrorMapping, ...customMapping };\n};\n\n/**\n * Resets the current error mapping to the default error mapping.\n *\n * @example\n * resetErrorMapping();\n */\nexport const resetErrorMapping = (): void => {\n  currentErrorMapping = { ...defaultErrorMapping };\n};\n\n/**\n * Retrieves the current error mapping.\n *\n * @returns The current error mapping object.\n *\n * @example\n * const mapping = getErrorMapping();\n * console.log(mapping);\n */\nexport const getErrorMapping = (): Record<string, string> =>\n  currentErrorMapping;\n\n/**\n * Parses an error object and returns a user-friendly error message.\n *\n * The function checks if the error is a ContractFunctionRevertedError by attempting to walk through\n * the error using its `walk` method. If a matching error is found and its error key exists in the\n * current error mapping, the corresponding custom message will be returned. Otherwise, it falls back\n * to the error's own message properties.\n *\n * @param error - The error object, potentially including additional error details.\n * @returns A user-friendly error message.\n *\n * @example\n * const message = getParsedError(someError);\n * console.log(message); // Outputs a custom error message or a default error message.\n */\nexport const getParsedError = (error: any | BaseError): string => {\n  const defaultMessage = \"An unknown error occurred. Please contact support.\";\n  let message = defaultMessage;\n  let errorKey = \"\";\n\n  const revertedError = error?.walk\n    ? error.walk((err: unknown) => err instanceof ContractFunctionRevertedError)\n    : null;\n  if (revertedError instanceof ContractFunctionRevertedError) {\n    errorKey =\n      revertedError.data?.errorName ??\n      revertedError.signature ??\n      revertedError.reason ??\n      \"\";\n    if (currentErrorMapping[errorKey]) return currentErrorMapping[errorKey];\n  }\n\n  message = error.shortMessage || error.details || error.message || message;\n  return message;\n};\n","import { waitForTransactionReceipt } from \"wagmi/actions\";\nimport { useInvalidateQueries } from \"./useInvalidateQueries\";\nimport { useConfig } from \"wagmi\";\nimport { QueryKey } from \"@tanstack/query-core\";\nimport { Address } from \"viem\";\nimport { useState } from \"react\";\nimport { getParsedError } from \"../utils/errorParser\";\n\nexport type WriteExtendedAsyncParams = {\n  onSuccess?: (txHash: Address) => void;\n  onError?: (e: any) => void;\n  onSettled?: () => void;\n  queriesToInvalidate?: (QueryKey | undefined)[];\n  disableLogging?: boolean;\n  disableWaitingForReceipt?: boolean;\n};\n\n/**\n * Custom hook to handle transaction mutations.\n *\n * @returns {Function} A shared `onSettled` callback for transaction mutations.\n */\nexport function useHandleTransactionMutation({\n  settings,\n}: {\n  settings?: WriteExtendedAsyncParams;\n}) {\n  const wagmiConfig = useConfig();\n\n  const { invalidateMany } = useInvalidateQueries();\n  const [isPending, setIsPending] = useState(false);\n  const [errorMessage, setErrorMessage] = useState<string | undefined>(\n    undefined\n  );\n\n  const onMutate = () => {\n    setIsPending(true);\n    setErrorMessage(undefined);\n  };\n\n  const onSettled = async (\n    txHash: Address | undefined,\n    error: any,\n    args: any\n  ) => {\n    try {\n      if (error) throw error;\n\n      if (!settings?.disableWaitingForReceipt) {\n        // 1. wait for transaction receipt\n        const txReceipt = await waitForTransactionReceipt(wagmiConfig, {\n          hash: txHash!,\n        });\n\n        // 2. throw if receipt is not valid\n        if (txReceipt.status === \"reverted\")\n          throw new Error(\"Execution reverted.\");\n        if (txReceipt.status !== \"success\")\n          throw new Error(\"Execution reverted.\");\n      }\n\n      // 3. invalidate queries\n      if (settings?.queriesToInvalidate)\n        await invalidateMany(settings?.queriesToInvalidate);\n\n      // 4. call onSuccess callback\n      settings?.onSuccess?.(txHash!);\n\n      if (!settings?.disableLogging) {\n        // 5. log result\n        // eslint-disable-next-line no-console\n        console.info(\"Operation successful:\", txHash); // todo: add logging service\n      }\n      // 6. return result\n      return txHash;\n    } catch (error) {\n      const parsedError = getParsedError(error);\n\n      if (!settings?.disableLogging) {\n        // 1. log error\n        console.error(\n          `ContractWriteExtended Operation failed with error(parsed): ${parsedError}`,\n          { error },\n          { args }\n        );\n        console.error({ error });\n      }\n      // 2. set error message\n      setErrorMessage(parsedError);\n\n      // 3. call callback\n      settings?.onError?.(error);\n    } finally {\n      setIsPending(false);\n      // 1. call callback\n      settings?.onSettled?.();\n    }\n    return undefined;\n  };\n\n  return {\n    onMutate,\n    onSettled,\n    isPending,\n    errorMessage,\n  };\n}\n","import { useWriteContract } from \"wagmi\";\nimport {\n  WriteExtendedAsyncParams,\n  useHandleTransactionMutation,\n} from \"./useHandleTransactionMutation\";\n\n/**\n * Custom hook for writing to a smart contract using Wagmi.\n *\n * This hook provides functionality for sending a transaction using Wagmi, handling the asynchronous nature of the operation, waiting for the transaction receipt, and error handling.\n *\n * @param {WriteExtendedAsyncParams} [settings] - Optional settings for the write operation.\n * @param {boolean} [settings.disableWaitingForReceipt] - Disables waiting for the transaction receipt.\n * @param {boolean} [settings.disableLogging] - Disables logging the result of the transaction.\n * @param {Function} [settings.onSuccess] - Callback function to be called on successful transaction.\n * @param {Function} [settings.onError] - Callback function to be called on transaction error.\n * @param {Function} [settings.onSettled] - Callback function to be called after the transaction settles (whether success or failure).\n * @param {QueryKey[]} [settings.queriesToInvalidate] - Array of query keys to invalidate after the transaction receives a receipt.\n * @returns {Object} Object containing the following properties:\n * - {boolean} isPending - Indicates whether the transaction is pending.\n * - {string|undefined} errorMessage - The error message, if an error occurred during the transaction.\n * - {Function} writeContractAsync - Function to trigger the write operation.\n */\n\nexport function useContractWriteExtended(settings?: WriteExtendedAsyncParams) {\n  const { isPending, errorMessage, onMutate, onSettled } =\n    useHandleTransactionMutation({\n      settings,\n    });\n\n  const { writeContractAsync, ...rest } = useWriteContract({\n    mutation: {\n      onMutate,\n      onSettled,\n    },\n  });\n\n  return {\n    ...rest,\n    isPending,\n    errorMessage,\n    writeContractAsync,\n  };\n}\n","import { Hash } from \"viem\";\nimport { useSendTransaction } from \"wagmi\";\nimport { QueryKey } from \"@tanstack/query-core\";\nimport { useHandleTransactionMutation } from \"./useHandleTransactionMutation\";\n\nexport type SeamlessSendAsyncParams = {\n  onSuccess?: (txHash: Hash) => void;\n  onError?: (e: any) => void;\n  onSettled?: () => void;\n  queriesToInvalidate?: (QueryKey | undefined)[];\n};\n\n/**\n * Custom hook for sending a transaction using Wagmi.\n *\n * This hook provides functionality for sending a transaction using Wagmi, handling the asynchronous nature of the operation, waiting for the transaction receipt, and error handling.\n *\n * @param {SeamlessWriteAsyncParams} [settings] - Optional settings for the write operation.\n * @param {boolean} [settings.disableWaitingForReceipt] - Disables waiting for the transaction receipt.\n * @param {boolean} [settings.disableLogging] - Disables logging the result of the transaction.\n * @param {Function} [settings.onSuccess] - Callback function to be called on successful transaction.\n * @param {Function} [settings.onError] - Callback function to be called on transaction error.\n * @param {Function} [settings.onSettled] - Callback function to be called after the transaction settles (whether success or failure).\n * @param {QueryKey[]} [settings.queriesToInvalidate] - Array of query keys to invalidate after the transaction receives a receipt.\n * @returns {Object} Object containing the following properties:\n * - {boolean} isPending - Indicates whether the transaction is pending.\n * - {string|undefined} errorMessage - The error message, if an error occurred during the transaction.\n * - {Function} sendTransactionAsync - Function to trigger the send transaction mutation.\n */\n\nexport function useSendTransactionExtended(settings?: SeamlessSendAsyncParams) {\n  const { isPending, errorMessage, onMutate, onSettled } =\n    useHandleTransactionMutation({\n      settings,\n    });\n\n  const { sendTransactionAsync, ...rest } = useSendTransaction({\n    mutation: {\n      onMutate,\n      onSettled,\n    },\n  });\n\n  return {\n    ...rest,\n    isPending,\n    errorMessage,\n    sendTransactionAsync,\n  };\n}\n"],"names":[],"mappings":";;;;;;AAEA;;;;AAIG;SACa,oBAAoB,GAAA;AAClC,IAAA,MAAM,WAAW,GAAG,cAAc,EAAE;AAEpC,IAAA,MAAM,cAAc,GAAG,OAAO,OAAiC,KAAI;QACjE,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,KACpC,WAAW,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAC5C;AACD,QAAA,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC7B,KAAC;IAED,OAAO,EAAE,cAAc,EAAE;AAC3B;;AChBA;;AAEG;AACH,MAAM,mBAAmB,GAA2B;AAClD,IAAA,aAAa,EAAE,8DAA8D;AAC7E,IAAA,uBAAuB,EACrB,0DAA0D;AAC5D,IAAA,YAAY,EAAE,0DAA0D;AACxE,IAAA,0BAA0B,EACxB,kEAAkE;AACpE,IAAA,YAAY,EACV,kEAAkE;AACpE,IAAA,mBAAmB,EACjB,kEAAkE;AACpE,IAAA,IAAI,EAAE,qBAAqB;CAC5B;AAED;;AAEG;AACH,IAAI,mBAAmB,GAA2B,EAAE,GAAG,mBAAmB,EAAE;AAE5E;;;;;;;;;;;AAWG;AACU,MAAA,eAAe,GAAG,CAC7B,aAAqC,KAC7B;IACR,mBAAmB,GAAG,EAAE,GAAG,mBAAmB,EAAE,GAAG,aAAa,EAAE;AACpE;AAEA;;;;;AAKG;AACI,MAAM,iBAAiB,GAAG,MAAW;AAC1C,IAAA,mBAAmB,GAAG,EAAE,GAAG,mBAAmB,EAAE;AAClD;AAEA;;;;;;;;AAQG;MACU,eAAe,GAAG,MAC7B;AAEF;;;;;;;;;;;;;;AAcG;AACU,MAAA,cAAc,GAAG,CAAC,KAAsB,KAAY;;IAC/D,MAAM,cAAc,GAAG,oDAAoD;IAC3E,IAAI,OAAO,GAAG,cAAc;IAC5B,IAAI,QAAQ,GAAG,EAAE;IAEjB,MAAM,aAAa,GAAG,CAAA,KAAK,aAAL,KAAK,KAAA,MAAA,GAAA,MAAA,GAAL,KAAK,CAAE,IAAI;AAC/B,UAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAY,KAAK,GAAG,YAAY,6BAA6B;UACzE,IAAI;AACR,IAAA,IAAI,aAAa,YAAY,6BAA6B,EAAE;QAC1D,QAAQ;AACN,YAAA,CAAA,EAAA,GAAA,MAAA,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,aAAa,CAAC,IAAI,0CAAE,SAAS,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAC7B,aAAa,CAAC,SAAS,MACvB,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAA,aAAa,CAAC,MAAM,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GACpB,EAAE;QACJ,IAAI,mBAAmB,CAAC,QAAQ,CAAC;AAAE,YAAA,OAAO,mBAAmB,CAAC,QAAQ,CAAC;;AAGzE,IAAA,OAAO,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,IAAI,OAAO;AACzE,IAAA,OAAO,OAAO;AAChB;;ACjFA;;;;AAIG;AACa,SAAA,4BAA4B,CAAC,EAC3C,QAAQ,GAGT,EAAA;AACC,IAAA,MAAM,WAAW,GAAG,SAAS,EAAE;AAE/B,IAAA,MAAM,EAAE,cAAc,EAAE,GAAG,oBAAoB,EAAE;IACjD,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC;IACjD,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,QAAQ,CAC9C,SAAS,CACV;IAED,MAAM,QAAQ,GAAG,MAAK;QACpB,YAAY,CAAC,IAAI,CAAC;QAClB,eAAe,CAAC,SAAS,CAAC;AAC5B,KAAC;IAED,MAAM,SAAS,GAAG,OAChB,MAA2B,EAC3B,KAAU,EACV,IAAS,KACP;;AACF,QAAA,IAAI;AACF,YAAA,IAAI,KAAK;AAAE,gBAAA,MAAM,KAAK;YAEtB,IAAI,EAAC,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAE,wBAAwB,CAAA,EAAE;;AAEvC,gBAAA,MAAM,SAAS,GAAG,MAAM,yBAAyB,CAAC,WAAW,EAAE;AAC7D,oBAAA,IAAI,EAAE,MAAO;AACd,iBAAA,CAAC;;AAGF,gBAAA,IAAI,SAAS,CAAC,MAAM,KAAK,UAAU;AACjC,oBAAA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC;AACxC,gBAAA,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS;AAChC,oBAAA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC;;;AAI1C,YAAA,IAAI,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAE,mBAAmB;gBAC/B,MAAM,cAAc,CAAC,QAAQ,KAAR,IAAA,IAAA,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC;;YAGrD,CAAA,EAAA,GAAA,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAE,SAAS,MAAA,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,CAAA,QAAA,EAAG,MAAO,CAAC;YAE9B,IAAI,EAAC,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAE,cAAc,CAAA,EAAE;;;gBAG7B,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;;;AAGhD,YAAA,OAAO,MAAM;;QACb,OAAO,KAAK,EAAE;AACd,YAAA,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC;YAEzC,IAAI,EAAC,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,MAAA,GAAA,MAAA,GAAA,QAAQ,CAAE,cAAc,CAAA,EAAE;;AAE7B,gBAAA,OAAO,CAAC,KAAK,CACX,CAAA,2DAAA,EAA8D,WAAW,CAAE,CAAA,EAC3E,EAAE,KAAK,EAAE,EACT,EAAE,IAAI,EAAE,CACT;AACD,gBAAA,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC;;;YAG1B,eAAe,CAAC,WAAW,CAAC;;YAG5B,CAAA,EAAA,GAAA,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,MAAA,GAAA,MAAA,GAAA,QAAQ,CAAE,OAAO,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAA,IAAA,CAAA,QAAA,EAAG,KAAK,CAAC;;gBAClB;YACR,YAAY,CAAC,KAAK,CAAC;;YAEnB,CAAA,EAAA,GAAA,QAAQ,aAAR,QAAQ,KAAA,MAAA,GAAA,MAAA,GAAR,QAAQ,CAAE,SAAS,wDAAI;;AAEzB,QAAA,OAAO,SAAS;AAClB,KAAC;IAED,OAAO;QACL,QAAQ;QACR,SAAS;QACT,SAAS;QACT,YAAY;KACb;AACH;;ACpGA;;;;;;;;;;;;;;;;AAgBG;AAEG,SAAU,wBAAwB,CAAC,QAAmC,EAAA;IAC1E,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,GACpD,4BAA4B,CAAC;QAC3B,QAAQ;AACT,KAAA,CAAC;IAEJ,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,gBAAgB,CAAC;AACvD,QAAA,QAAQ,EAAE;YACR,QAAQ;YACR,SAAS;AACV,SAAA;AACF,KAAA,CAAC;IAEF,OAAO;AACL,QAAA,GAAG,IAAI;QACP,SAAS;QACT,YAAY;QACZ,kBAAkB;KACnB;AACH;;AC/BA;;;;;;;;;;;;;;;;AAgBG;AAEG,SAAU,0BAA0B,CAAC,QAAkC,EAAA;IAC3E,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,GACpD,4BAA4B,CAAC;QAC3B,QAAQ;AACT,KAAA,CAAC;IAEJ,MAAM,EAAE,oBAAoB,EAAE,GAAG,IAAI,EAAE,GAAG,kBAAkB,CAAC;AAC3D,QAAA,QAAQ,EAAE;YACR,QAAQ;YACR,SAAS;AACV,SAAA;AACF,KAAA,CAAC;IAEF,OAAO;AACL,QAAA,GAAG,IAAI;QACP,SAAS;QACT,YAAY;QACZ,oBAAoB;KACrB;AACH;;;;"}

package/package.json

@@ -1,11 +1,20 @@
 {
   "name": "wagmi-extended",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "type": "module",
   "description": "A library providing extended hooks on top of Wagmi with additional features.",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./hooks/*": "./dist/hooks/*.js",
+    "./utils/*": "./dist/utils/*.js"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/WingsDevelopment/wagmi-extended.git"
@@ -20,7 +29,8 @@
   "author": "Srdjan Rakic <bans.cowboy@gmail.com>",
   "license": "MIT",
   "scripts": {
-    "build": "rollup -c --bundleConfigAsCjs",
+    "clean": "rimraf dist",
+    "build": "npm run clean && npm version minor && rollup -c --bundleConfigAsCjs",
     "prepublishOnly": "npm run build"
   },
   "peerDependencies": {
@@ -35,6 +45,7 @@
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/node": "^22.14.0",
     "@types/react": "^19.1.0",
+    "rimraf": "^6.0.1",
     "rollup": "^4.39.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "typescript": "^5.0.0"

package/rollup.config.mjs

@@ -1,4 +1,4 @@
-// rollup.config.js
+// rollup.config.mjs
 import typescript from "@rollup/plugin-typescript";
 import peerDepsExternal from "rollup-plugin-peer-deps-external";
 import resolve from "@rollup/plugin-node-resolve";
@@ -19,15 +19,10 @@ export default {
     },
   ],
   plugins: [
-    // Automatically externalize peerDependencies in package.json
     peerDepsExternal(),
-    // Locate and bundle third party dependencies in node_modules
     resolve(),
-    // Convert CommonJS modules to ES6, so they can be included in a Rollup bundle
     commonjs(),
-    // Compile TypeScript files
     typescript({ tsconfig: "./tsconfig.json" }),
   ],
-  // Ensure that critical peer dependencies are marked as external (optional since peerDepsExternal may handle this)
   external: ["react", "@tanstack/react-query", "wagmi", "viem"],
 };

package/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "ES2019",
-    "module": "CommonJS",
+    "module": "esnext",
     "declaration": true,
     "outDir": "dist",
     "strict": true,