wagmi-extended 0.1.0 → 0.2.0

package/dist/index.cjs.js

@@ -0,0 +1,8 @@
+'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);
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +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;;"}

package/dist/index.esm.js

@@ -0,0 +1,6 @@
+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);
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +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"}

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "wagmi-extended",
-  "version": "0.1.0",
+  "version": "0.2.0",
+  "type": "module",
   "description": "A library providing extended hooks on top of Wagmi with additional features.",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
@@ -15,10 +17,10 @@
     "react",
     "blockchain"
   ],
-  "author": "Your Name",
+  "author": "Srdjan Rakic <bans.cowboy@gmail.com>",
   "license": "MIT",
   "scripts": {
-    "build": "tsc",
+    "build": "rollup -c --bundleConfigAsCjs",
     "prepublishOnly": "npm run build"
   },
   "peerDependencies": {
@@ -28,8 +30,13 @@
     "wagmi": "^2.0.0"
   },
   "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.2",
     "@types/node": "^22.14.0",
     "@types/react": "^19.1.0",
+    "rollup": "^4.39.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
     "typescript": "^5.0.0"
   }
 }

package/rollup.config.mjs

@@ -0,0 +1,33 @@
+// rollup.config.js
+import typescript from "@rollup/plugin-typescript";
+import peerDepsExternal from "rollup-plugin-peer-deps-external";
+import resolve from "@rollup/plugin-node-resolve";
+import commonjs from "@rollup/plugin-commonjs";
+
+export default {
+  input: "src/index.ts",
+  output: [
+    {
+      file: "dist/index.cjs.js",
+      format: "cjs",
+      sourcemap: true,
+    },
+    {
+      file: "dist/index.esm.js",
+      format: "esm",
+      sourcemap: true,
+    },
+  ],
+  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/dist/hooks/useContractWriteExtended.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useContractWriteExtended = useContractWriteExtended;
-const wagmi_1 = require("wagmi");
-const useHandleTransactionMutation_1 = require("./useHandleTransactionMutation");
-/**
- * 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 } = (0, useHandleTransactionMutation_1.useHandleTransactionMutation)({
-        settings,
-    });
-    const { writeContractAsync, ...rest } = (0, wagmi_1.useWriteContract)({
-        mutation: {
-            onMutate,
-            onSettled,
-        },
-    });
-    return {
-        ...rest,
-        isPending,
-        errorMessage,
-        writeContractAsync,
-    };
-}

package/dist/hooks/useHandleTransactionMutation.js

@@ -1,77 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useHandleTransactionMutation = useHandleTransactionMutation;
-const actions_1 = require("wagmi/actions");
-const useInvalidateQueries_1 = require("./useInvalidateQueries");
-const wagmi_1 = require("wagmi");
-const react_1 = require("react");
-const errorParser_1 = require("../utils/errorParser");
-/**
- * Custom hook to handle transaction mutations.
- *
- * @returns {Function} A shared `onSettled` callback for transaction mutations.
- */
-function useHandleTransactionMutation({ settings, }) {
-    const wagmiConfig = (0, wagmi_1.useConfig)();
-    const { invalidateMany } = (0, useInvalidateQueries_1.useInvalidateQueries)();
-    const [isPending, setIsPending] = (0, react_1.useState)(false);
-    const [errorMessage, setErrorMessage] = (0, react_1.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 (0, actions_1.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 = (0, errorParser_1.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,
-    };
-}

package/dist/hooks/useInvalidateQueries.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useInvalidateQueries = useInvalidateQueries;
-const react_query_1 = require("@tanstack/react-query");
-/**
- * Hook to invalidate multiple queries in the React Query cache.
- *
- * @returns An object with the invalidateMany function.
- */
-function useInvalidateQueries() {
-    const queryClient = (0, react_query_1.useQueryClient)();
-    const invalidateMany = async (queries) => {
-        const promises = queries.map((queryKey) => queryClient.invalidateQueries({ queryKey }));
-        await Promise.all(promises);
-    };
-    return { invalidateMany };
-}

package/dist/hooks/useSendTransactionExtended.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useSendTransactionExtended = useSendTransactionExtended;
-const wagmi_1 = require("wagmi");
-const useHandleTransactionMutation_1 = require("./useHandleTransactionMutation");
-/**
- * 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 } = (0, useHandleTransactionMutation_1.useHandleTransactionMutation)({
-        settings,
-    });
-    const { sendTransactionAsync, ...rest } = (0, wagmi_1.useSendTransaction)({
-        mutation: {
-            onMutate,
-            onSettled,
-        },
-    });
-    return {
-        ...rest,
-        isPending,
-        errorMessage,
-        sendTransactionAsync,
-    };
-}

package/dist/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./hooks/useContractWriteExtended"), exports);
-__exportStar(require("./hooks/useSendTransactionExtended"), exports);
-__exportStar(require("./utils/errorParser"), exports);

package/dist/utils/errorParser.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParsedError = exports.getErrorMapping = exports.resetErrorMapping = exports.setErrorMapping = void 0;
-const viem_1 = require("viem");
-/**
- * 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 };
-};
-exports.setErrorMapping = setErrorMapping;
-/**
- * Resets the current error mapping to the default error mapping.
- *
- * @example
- * resetErrorMapping();
- */
-const resetErrorMapping = () => {
-    currentErrorMapping = { ...defaultErrorMapping };
-};
-exports.resetErrorMapping = resetErrorMapping;
-/**
- * Retrieves the current error mapping.
- *
- * @returns The current error mapping object.
- *
- * @example
- * const mapping = getErrorMapping();
- * console.log(mapping);
- */
-const getErrorMapping = () => currentErrorMapping;
-exports.getErrorMapping = getErrorMapping;
-/**
- * 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_1.ContractFunctionRevertedError)
-        : null;
-    if (revertedError instanceof viem_1.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;
-};
-exports.getParsedError = getParsedError;