@0xsquid/react-hooks 6.4.1-beta.1 → 6.4.1-beta.2

package/dist/services/internal/errorService.d.ts

@@ -1,30 +1,28 @@
-import type { SquidRouteError, SquidStatusError, TransactionError, TransactionErrorWithMessage } from "../../core/types/error";
+import { RouteResponse } from "@0xsquid/squid-types";
+import type { SquidRouteError, SquidStatusError, TransactionErrorWithMessage } from "../../core/types/error";
+import type { TransactionParams } from "../../core/types/transaction";
 export declare const transactionErrorCode: Record<string, TransactionErrorWithMessage>;
 /**
- * Check if the error is an EVM transaction error
- * Because Typescript supports casting but that's only for compilation time,
- * We need it at runtime since we're getting the error object from the wallet
- * @param error
- * @returns boolean
+ * Converts any transaction error into a standardized TransactionErrorWithMessage format
+ * @param error The error to convert
+ * @returns A standardized error object
  */
-export declare const isTransactionError: (error: any) => error is TransactionError;
+export declare const getTransactionError: (error: any) => TransactionErrorWithMessage;
 /**
- * Return the error from enum entry
- * @param error
- * @returns boolean
+ * Handles dispatching appropriate events based on the error type
  */
-export declare const getTransactionError: (error: any) => TransactionErrorWithMessage;
+export declare const handleTransactionErrorEvents: ({ error, transactionParams, walletProviderName, squidRoute, }: {
+    error: TransactionErrorWithMessage;
+    transactionParams?: TransactionParams | undefined;
+    walletProviderName?: string | undefined;
+    squidRoute?: {
+        estimate: import("@0xsquid/squid-types").Estimate;
+        transactionRequest?: import("@0xsquid/squid-types").SquidData | undefined;
+        params: import("@0xsquid/squid-types").RouteRequest;
+    } | undefined;
+}) => TransactionErrorWithMessage;
 /**
- * Check if the error is an Squid route error
- * Because Typescript supports casting but that's only for compilation time,
- * We need it at runtime since we're getting the error object from the wallet
- * @param error
- * @returns boolean
+ * Check if the error is a Squid route error
  */
 export declare const isSwapRouteError: (error: any) => error is SquidRouteError;
 export declare const isStatusError: (error: any) => error is SquidStatusError;
-/**
- * Tries to parse as SquidRouteError Type & Return the error from Record entries
- * @param error
- * @returns string error message
- */

package/dist/services/internal/errorService.js

@@ -1,103 +1,152 @@
 import { TransactionErrorType } from "../../core/types/error";
+import { WidgetEvents } from "./eventService";
+/**
+ * Normalizes different error structures into a consistent format
+ * This helps handle different wallet error formats uniformly
+ */
+const normalizeError = (error) => {
+    // Handle nested error objects (like Rainbow's error.error structure)
+    if (error?.error && typeof error.error === "object") {
+        return {
+            code: error.error.code,
+            message: error.error.message,
+            reason: error.error.reason,
+        };
+    }
+    // Handle direct error properties
+    return {
+        code: error?.code,
+        message: error?.message,
+        reason: error?.reason,
+    };
+};
 export const transactionErrorCode = {
     // Metamask
     ACTION_REJECTED: {
         type: TransactionErrorType.REJECTED_BY_USER,
+        internalLabel: "EVM: ACTION_REJECTED",
         message: "Return to the swap page and try again.",
     },
     // Keplr
     "Request rejected": {
         type: TransactionErrorType.REJECTED_BY_USER,
+        internalLabel: "Request rejected",
         message: "Return to the swap page and try again.",
     },
     // Phantom Solana
     "User rejected the request.": {
         type: TransactionErrorType.REJECTED_BY_USER,
+        internalLabel: "SOL: User rejected the request",
+        message: "Return to the swap page and try again.",
+    },
+    // Gnosis Safe
+    "Transaction was rejected": {
+        type: TransactionErrorType.REJECTED_BY_USER,
+        internalLabel: "GNOSIS: Transaction was rejected",
         message: "Return to the swap page and try again.",
     },
     // Metamask
     4001: {
         type: TransactionErrorType.REJECTED_BY_USER,
+        internalLabel: "EVM: REJECTED: CODE 4001",
+        message: "Return to the swap page and try again.",
+    },
+    // Rainbow
+    "-32603": {
+        type: TransactionErrorType.REJECTED_BY_USER,
+        internalLabel: "EVM: REJECTED: CODE -32603",
         message: "Return to the swap page and try again.",
     },
     CALL_EXCEPTION: {
         type: TransactionErrorType.CALL_EXCEPTION,
+        internalLabel: "EVM: CALL_EXCEPTION",
         message: "Swap failed on the source chain. Please let us know by submitting a ticket here.",
     },
     UNKNOWN: {
         type: TransactionErrorType.UNKNOWN,
+        internalLabel: "UNKNOWN ERROR: Transaction failed",
         message: "The transaction could not be initiated.",
     },
 };
 /**
- * Check if the error is an EVM transaction error
- * Because Typescript supports casting but that's only for compilation time,
- * We need it at runtime since we're getting the error object from the wallet
- * @param error
- * @returns boolean
+ * Detects if an error is a user rejection based on normalized error structure
  */
-export const isTransactionError = (error) => {
-    return (error &&
-        (typeof error.code === "string" ||
-            typeof error.code === "number" ||
-            typeof error.message === "string" ||
-            typeof error.reason === "string" ||
-            typeof error.action === "string"));
-};
-const isGnosisSafeTxRejectedError = (error) => {
-    try {
-        return error.error.message === "Transaction was rejected";
-    }
-    catch {
+const isUserRejectionError = (normalizedError) => {
+    const { code, message } = normalizedError;
+    // Check if the error matches any known rejection patterns from transactionErrorCode
+    return Object.entries(transactionErrorCode).some(([key, value]) => {
+        if (value.type !== TransactionErrorType.REJECTED_BY_USER)
+            return false;
+        // Check if code matches (converting to string for comparison)
+        if (code != undefined && key === code.toString())
+            return true;
+        // Check if message matches
+        if (message && key === message)
+            return true;
         return false;
-    }
-};
-const isRainbowWalletTxRejectedError = (error) => {
-    try {
-        return error.error.code === -32603;
-    }
-    catch {
-        return false;
-    }
+    });
 };
 /**
- * Return the error from enum entry
- * @param error
- * @returns boolean
+ * Converts any transaction error into a standardized TransactionErrorWithMessage format
+ * @param error The error to convert
+ * @returns A standardized error object
  */
 export const getTransactionError = (error) => {
-    if (isRainbowWalletTxRejectedError(error) ||
-        isGnosisSafeTxRejectedError(error)) {
+    const normalizedError = normalizeError(error);
+    if (isUserRejectionError(normalizedError)) {
+        // Return the specific rejection error if we can find it
+        if (normalizedError.code) {
+            const codeError = transactionErrorCode[normalizedError.code.toString()];
+            if (codeError?.type === TransactionErrorType.REJECTED_BY_USER)
+                return codeError;
+        }
+        if (normalizedError.message) {
+            const messageError = transactionErrorCode[normalizedError.message];
+            if (messageError?.type === TransactionErrorType.REJECTED_BY_USER)
+                return messageError;
+        }
         return transactionErrorCode.ACTION_REJECTED;
     }
-    if (isTransactionError(error)) {
-        const castError = error;
-        if (castError.code)
-            return transactionErrorCode[castError.code];
-        if (castError.message)
-            return transactionErrorCode[castError.message];
-        return transactionErrorCode.UNKNOWN;
+    if (normalizedError.code) {
+        return (transactionErrorCode[normalizedError.code.toString()] ||
+            transactionErrorCode.UNKNOWN);
+    }
+    if (normalizedError.message) {
+        return (transactionErrorCode[normalizedError.message] ||
+            transactionErrorCode.UNKNOWN);
     }
     return transactionErrorCode.UNKNOWN;
 };
-// --------------------
-// SQUID ROUTE ERRORS
-// --------------------
-// TODO: Components will be handled outside hooks lib
-// const squidRouteErrorMapping: Record<
-//   SquidRouteErrorType,
-//   string | JSX.Element
-// > = {
-//   Unknown: RouteDefaultErrorMsg(),
-//   UnknownError: RouteDefaultErrorMsg(),
-//   SquidServiceError: RouteDefaultErrorMsg(),
-// };
 /**
- * Check if the error is an Squid route error
- * Because Typescript supports casting but that's only for compilation time,
- * We need it at runtime since we're getting the error object from the wallet
- * @param error
- * @returns boolean
+ * Handles dispatching appropriate events based on the error type
+ */
+export const handleTransactionErrorEvents = ({ error, transactionParams, walletProviderName, squidRoute, }) => {
+    // Handle wallet rejection events
+    if (error.type === TransactionErrorType.REJECTED_BY_USER) {
+        // At this point, we don't have transactionParams so we should use the squidRoute
+        WidgetEvents.getInstance().dispatchWalletReject({
+            chainId: squidRoute?.params.fromChain || "",
+            provider: walletProviderName || "",
+            reason: error.internalLabel,
+        });
+    }
+    else if (error.type === TransactionErrorType.CALL_EXCEPTION) {
+        // Handle on-chain transaction errors
+        WidgetEvents.getInstance().dispatchOnchainReject({
+            walletAddress: transactionParams?.fromAddress || "",
+            chainId: transactionParams?.fromChain?.chainId || "",
+            reason: error.internalLabel,
+            txHash: transactionParams?.transactionId,
+        });
+    }
+    // Always dispatch the swap route execution error
+    WidgetEvents.getInstance().dispatchSwapRouteExecutionError({
+        error,
+    });
+    return error;
+};
+/**
+ * Check if the error is a Squid route error
  */
 export const isSwapRouteError = (error) => {
     return (error &&
@@ -106,25 +155,4 @@ export const isSwapRouteError = (error) => {
 export const isStatusError = (error) => {
     return error && typeof error.errorType === "string";
 };
-/**
- * Tries to parse as SquidRouteError Type & Return the error from Record entries
- * @param error
- * @returns string error message
- */
-// TODO: move this outside hooks
-// export const getSquidRouteErrorMessage = (error: any): string | JSX.Element => {
-//   if (isSwapRouteError(error)) {
-//     // Try to get the error message from the error code
-//     const codeMsg =
-//       error.code || error.errorType
-//         ? squidRouteErrorMapping[
-//             (error.code ?? error.errorType) as SquidRouteErrorType
-//           ]
-//         : undefined;
-//     if (codeMsg) return codeMsg;
-//     // If there is no error code, try to get the error message from backend
-//     if (error.message) return error.message;
-//   }
-//   return squidRouteErrorMapping.Unknown;
-// };
 //# sourceMappingURL=errorService.js.map

package/dist/services/internal/errorService.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorService.js","sourceRoot":"","sources":["../../../src/services/internal/errorService.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,MAAM,CAAC,MAAM,oBAAoB,GAC/B;IACE,WAAW;IACX,eAAe,EAAE;QACf,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,OAAO,EAAE,wCAAwC;KAClD;IACD,QAAQ;IACR,kBAAkB,EAAE;QAClB,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,OAAO,EAAE,wCAAwC;KAClD;IACD,iBAAiB;IACjB,4BAA4B,EAAE;QAC5B,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,OAAO,EAAE,wCAAwC;KAClD;IACD,WAAW;IACX,IAAI,EAAE;QACJ,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,OAAO,EAAE,wCAAwC;KAClD;IACD,cAAc,EAAE;QACd,IAAI,EAAE,oBAAoB,CAAC,cAAc;QACzC,OAAO,EACL,kFAAkF;KACrF;IACD,OAAO,EAAE;QACP,IAAI,EAAE,oBAAoB,CAAC,OAAO;QAClC,OAAO,EAAE,yCAAyC;KACnD;CACF,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAU,EAA6B,EAAE;IAC1E,OAAO,CACL,KAAK;QACL,CAAC,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;YAC7B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;YAC9B,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;YACjC,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;YAChC,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CACpC,CAAC;AACJ,CAAC,CAAC;AACF,MAAM,2BAA2B,GAAG,CAAC,KAAU,EAAW,EAAE;IAC1D,IAAI;QACF,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,0BAA0B,CAAC;KAC3D;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC,CAAC;AAEF,MAAM,8BAA8B,GAAG,CAAC,KAAU,EAAW,EAAE;IAC7D,IAAI;QACF,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC;KACpC;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,KAAU,EACmB,EAAE;IAC/B,IACE,8BAA8B,CAAC,KAAK,CAAC;QACrC,2BAA2B,CAAC,KAAK,CAAC,EAClC;QACA,OAAO,oBAAoB,CAAC,eAAe,CAAC;KAC7C;IAED,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE;QAC7B,MAAM,SAAS,GAAG,KAAyB,CAAC;QAC5C,IAAI,SAAS,CAAC,IAAI;YAAE,OAAO,oBAAoB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAChE,IAAI,SAAS,CAAC,OAAO;YAAE,OAAO,oBAAoB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACtE,OAAO,oBAAoB,CAAC,OAAO,CAAC;KACrC;IACD,OAAO,oBAAoB,CAAC,OAAO,CAAC;AACtC,CAAC,CAAC;AAEF,uBAAuB;AACvB,qBAAqB;AACrB,uBAAuB;AACvB,qDAAqD;AACrD,wCAAwC;AACxC,yBAAyB;AACzB,yBAAyB;AACzB,QAAQ;AACR,qCAAqC;AACrC,0CAA0C;AAC1C,+CAA+C;AAC/C,KAAK;AAEL;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAU,EAA4B,EAAE;IACvE,OAAO,CACL,KAAK;QACL,CAAC,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,CAAC,CACxE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAU,EAA6B,EAAE;IACrE,OAAO,KAAK,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,CAAC;AACtD,CAAC,CAAC;AAEF;;;;GAIG;AACH,gCAAgC;AAChC,mFAAmF;AACnF,mCAAmC;AACnC,0DAA0D;AAC1D,sBAAsB;AACtB,sCAAsC;AACtC,oCAAoC;AACpC,qEAAqE;AACrE,cAAc;AACd,uBAAuB;AAEvB,mCAAmC;AACnC,8EAA8E;AAC9E,+CAA+C;AAC/C,MAAM;AACN,2CAA2C;AAC3C,KAAK"}
+{"version":3,"file":"errorService.js","sourceRoot":"","sources":["../../../src/services/internal/errorService.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAS9C;;;GAGG;AACH,MAAM,cAAc,GAAG,CAAC,KAAU,EAAmB,EAAE;IACrD,qEAAqE;IACrE,IAAI,KAAK,EAAE,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE;QACnD,OAAO;YACL,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI;YACtB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO;YAC5B,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM;SAC3B,CAAC;KACH;IAED,iCAAiC;IACjC,OAAO;QACL,IAAI,EAAE,KAAK,EAAE,IAAI;QACjB,OAAO,EAAE,KAAK,EAAE,OAAO;QACvB,MAAM,EAAE,KAAK,EAAE,MAAM;KACtB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAC/B;IACE,WAAW;IACX,eAAe,EAAE;QACf,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,aAAa,EAAE,sBAAsB;QACrC,OAAO,EAAE,wCAAwC;KAClD;IACD,QAAQ;IACR,kBAAkB,EAAE;QAClB,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,aAAa,EAAE,kBAAkB;QACjC,OAAO,EAAE,wCAAwC;KAClD;IACD,iBAAiB;IACjB,4BAA4B,EAAE;QAC5B,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,aAAa,EAAE,gCAAgC;QAC/C,OAAO,EAAE,wCAAwC;KAClD;IACD,cAAc;IACd,0BAA0B,EAAE;QAC1B,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,aAAa,EAAE,kCAAkC;QACjD,OAAO,EAAE,wCAAwC;KAClD;IACD,WAAW;IACX,IAAI,EAAE;QACJ,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,aAAa,EAAE,0BAA0B;QACzC,OAAO,EAAE,wCAAwC;KAClD;IACD,UAAU;IACV,QAAQ,EAAE;QACR,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,aAAa,EAAE,4BAA4B;QAC3C,OAAO,EAAE,wCAAwC;KAClD;IACD,cAAc,EAAE;QACd,IAAI,EAAE,oBAAoB,CAAC,cAAc;QACzC,aAAa,EAAE,qBAAqB;QACpC,OAAO,EACL,kFAAkF;KACrF;IACD,OAAO,EAAE;QACP,IAAI,EAAE,oBAAoB,CAAC,OAAO;QAClC,aAAa,EAAE,mCAAmC;QAClD,OAAO,EAAE,yCAAyC;KACnD;CACF,CAAC;AAEJ;;GAEG;AACH,MAAM,oBAAoB,GAAG,CAAC,eAAgC,EAAW,EAAE;IACzE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;IAE1C,oFAAoF;IACpF,OAAO,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAChE,IAAI,KAAK,CAAC,IAAI,KAAK,oBAAoB,CAAC,gBAAgB;YAAE,OAAO,KAAK,CAAC;QAEvE,8DAA8D;QAC9D,IAAI,IAAI,IAAI,SAAS,IAAI,GAAG,KAAK,IAAI,CAAC,QAAQ,EAAE;YAAE,OAAO,IAAI,CAAC;QAE9D,2BAA2B;QAC3B,IAAI,OAAO,IAAI,GAAG,KAAK,OAAO;YAAE,OAAO,IAAI,CAAC;QAE5C,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,KAAU,EACmB,EAAE;IAC/B,MAAM,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAE9C,IAAI,oBAAoB,CAAC,eAAe,CAAC,EAAE;QACzC,wDAAwD;QACxD,IAAI,eAAe,CAAC,IAAI,EAAE;YACxB,MAAM,SAAS,GAAG,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxE,IAAI,SAAS,EAAE,IAAI,KAAK,oBAAoB,CAAC,gBAAgB;gBAC3D,OAAO,SAAS,CAAC;SACpB;QACD,IAAI,eAAe,CAAC,OAAO,EAAE;YAC3B,MAAM,YAAY,GAAG,oBAAoB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACnE,IAAI,YAAY,EAAE,IAAI,KAAK,oBAAoB,CAAC,gBAAgB;gBAC9D,OAAO,YAAY,CAAC;SACvB;QACD,OAAO,oBAAoB,CAAC,eAAe,CAAC;KAC7C;IAED,IAAI,eAAe,CAAC,IAAI,EAAE;QACxB,OAAO,CACL,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACrD,oBAAoB,CAAC,OAAO,CAC7B,CAAC;KACH;IAED,IAAI,eAAe,CAAC,OAAO,EAAE;QAC3B,OAAO,CACL,oBAAoB,CAAC,eAAe,CAAC,OAAO,CAAC;YAC7C,oBAAoB,CAAC,OAAO,CAC7B,CAAC;KACH;IAED,OAAO,oBAAoB,CAAC,OAAO,CAAC;AACtC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,EAC3C,KAAK,EACL,iBAAiB,EACjB,kBAAkB,EAClB,UAAU,GAMX,EAA+B,EAAE;IAChC,iCAAiC;IACjC,IAAI,KAAK,CAAC,IAAI,KAAK,oBAAoB,CAAC,gBAAgB,EAAE;QACxD,iFAAiF;QACjF,YAAY,CAAC,WAAW,EAAE,CAAC,oBAAoB,CAAC;YAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE;YAC3C,QAAQ,EAAE,kBAAkB,IAAI,EAAE;YAClC,MAAM,EAAE,KAAK,CAAC,aAAa;SAC5B,CAAC,CAAC;KACJ;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,oBAAoB,CAAC,cAAc,EAAE;QAC7D,qCAAqC;QACrC,YAAY,CAAC,WAAW,EAAE,CAAC,qBAAqB,CAAC;YAC/C,aAAa,EAAE,iBAAiB,EAAE,WAAW,IAAI,EAAE;YACnD,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,OAAO,IAAI,EAAE;YACpD,MAAM,EAAE,KAAK,CAAC,aAAa;YAC3B,MAAM,EAAE,iBAAiB,EAAE,aAAa;SACzC,CAAC,CAAC;KACJ;IAED,iDAAiD;IACjD,YAAY,CAAC,WAAW,EAAE,CAAC,+BAA+B,CAAC;QACzD,KAAK;KACN,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAU,EAA4B,EAAE;IACvE,OAAO,CACL,KAAK;QACL,CAAC,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,CAAC,CACxE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAU,EAA6B,EAAE;IACrE,OAAO,KAAK,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,CAAC;AACtD,CAAC,CAAC"}

package/dist/services/internal/eventService.d.ts

@@ -1,5 +1,10 @@
-import type { RouteResponse } from "@0xsquid/squid-types";
+import type { RouteRequest, RouteResponse, Token } from "@0xsquid/squid-types";
 import type { EventListenerFunction, WidgetEventMap } from "../../core/types/event";
+type FindTokenMethod = (address?: string, chainId?: string) => Token | undefined;
+/**
+ * Creates a hash string from quote request parameters to track changes
+ */
+export declare const createQuoteRequestParamsHash: (params: RouteRequest) => string;
 export declare class WidgetEvents extends EventTarget {
     private static instance;
     private constructor();
@@ -59,4 +64,37 @@ export declare class WidgetEvents extends EventTarget {
      * @param data
      */
     dispatchSwapRouteExecutionError(data: WidgetEventMap["swapRouteExecutionError"]): void;
+    /**
+     * Dispatch event when requesting a quote for swap
+     * @param data Quote request parameters
+     */
+    dispatchRequestQuote(data: WidgetEventMap["requestQuote"]): void;
+    /**
+     * Dispatch event before swap execution
+     * @param data Pre-swap parameters
+     * @param findToken Function to find token details
+     */
+    dispatchPreSwap(data: WidgetEventMap["preSwap"], findToken: FindTokenMethod): void;
+    /**
+     * Dispatch event after swap execution
+     * @param data Post-swap parameters including transaction hash
+     * @param findToken Function to find token details
+     */
+    dispatchPostSwap(data: WidgetEventMap["postSwap"], findToken: FindTokenMethod): void;
+    /**
+     * Dispatch event when wallet is successfully connected
+     * @param data Wallet connection details
+     */
+    dispatchWalletConnect(data: WidgetEventMap["walletConnect"]): void;
+    /**
+     * Dispatch event when wallet connection is rejected
+     * @param data Wallet rejection details
+     */
+    dispatchWalletReject(data: WidgetEventMap["walletReject"]): void;
+    /**
+     * Dispatch event when onchain transaction is rejected
+     * @param data Onchain rejection details
+     */
+    dispatchOnchainReject(data: WidgetEventMap["onchainReject"]): void;
 }
+export {};

package/dist/services/internal/eventService.js

@@ -1,3 +1,35 @@
+import { formatAmount } from "./estimateService";
+/**
+ * Creates a hash string from quote request parameters to track changes
+ */
+export const createQuoteRequestParamsHash = (params) => {
+    return [
+        params.fromAddress || "",
+        params.toAddress || "",
+        params.fromChain,
+        params.toChain,
+        `${params.fromToken}_${params.fromChain}`,
+        `${params.toToken}_${params.toChain}`,
+        params.fromAmount,
+    ].join("|");
+};
+/**
+ * Formats the amount based on token details
+ * @param data Event parameters containing fromToken, fromChain, and fromAmount
+ * @param findToken Function to find token details
+ * @returns Original data with formatted amount
+ */
+const formatTokenAmount = (data, findToken) => {
+    const fromToken = findToken(data.fromToken, data.fromChain);
+    const formattedFromAmount = formatAmount(data.fromAmount, fromToken?.decimals);
+    // Rewrite the fromAmount with the formatted amount
+    // Example: 1000000000000000000 -> 1 with decimals 18
+    // For readability of the event data
+    return {
+        ...data,
+        fromAmount: formattedFromAmount,
+    };
+};
 export class WidgetEvents extends EventTarget {
     static instance;
     constructor() {
@@ -76,5 +108,49 @@ export class WidgetEvents extends EventTarget {
     dispatchSwapRouteExecutionError(data) {
         this.dispatch("swapRouteExecutionError", data);
     }
+    /**
+     * Dispatch event when requesting a quote for swap
+     * @param data Quote request parameters
+     */
+    dispatchRequestQuote(data) {
+        this.dispatch("requestQuote", data);
+    }
+    /**
+     * Dispatch event before swap execution
+     * @param data Pre-swap parameters
+     * @param findToken Function to find token details
+     */
+    dispatchPreSwap(data, findToken) {
+        this.dispatch("preSwap", formatTokenAmount(data, findToken));
+    }
+    /**
+     * Dispatch event after swap execution
+     * @param data Post-swap parameters including transaction hash
+     * @param findToken Function to find token details
+     */
+    dispatchPostSwap(data, findToken) {
+        this.dispatch("postSwap", formatTokenAmount(data, findToken));
+    }
+    /**
+     * Dispatch event when wallet is successfully connected
+     * @param data Wallet connection details
+     */
+    dispatchWalletConnect(data) {
+        this.dispatch("walletConnect", data);
+    }
+    /**
+     * Dispatch event when wallet connection is rejected
+     * @param data Wallet rejection details
+     */
+    dispatchWalletReject(data) {
+        this.dispatch("walletReject", data);
+    }
+    /**
+     * Dispatch event when onchain transaction is rejected
+     * @param data Onchain rejection details
+     */
+    dispatchOnchainReject(data) {
+        this.dispatch("onchainReject", data);
+    }
 }
 //# sourceMappingURL=eventService.js.map

package/dist/services/internal/eventService.js.map

@@ -1 +1 @@
-{"version":3,"file":"eventService.js","sourceRoot":"","sources":["../../../src/services/internal/eventService.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,YAAa,SAAQ,WAAW;IACnC,MAAM,CAAC,QAAQ,CAAe;IAEtC;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;YAC1B,YAAY,CAAC,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC;SAC5C;QACD,OAAO,YAAY,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,cAAc,CACZ,IAAO,EACP,QAAkC,EAClC,OAA2C;QAE3C,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAoC,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAClB,IAAO,EACP,QAAkC,EAClC,OAAwC;QAExC,KAAK,CAAC,mBAAmB,CACvB,IAAI,EACJ,QAAoC,EACpC,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAiC,IAAO,EAAE,IAAuB;QACvE,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,MAAc;QAC/B,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CAAC,KAA6B,EAAE,MAAc;QACnE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,UAKzB;QACC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,gCAAgC,CAC9B,IAAgD;QAEhD,IAAI,CAAC,QAAQ,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,+BAA+B,CAC7B,IAA+C;QAE/C,IAAI,CAAC,QAAQ,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;CACF"}
+{"version":3,"file":"eventService.js","sourceRoot":"","sources":["../../../src/services/internal/eventService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAOjD;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,MAAoB,EAAU,EAAE;IAC3E,OAAO;QACL,MAAM,CAAC,WAAW,IAAI,EAAE;QACxB,MAAM,CAAC,SAAS,IAAI,EAAE;QACtB,MAAM,CAAC,SAAS;QAChB,MAAM,CAAC,OAAO;QACd,GAAG,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,EAAE;QACzC,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE;QACrC,MAAM,CAAC,UAAU;KAClB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACd,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,iBAAiB,GAAG,CAGxB,IAAO,EACP,SAA0B,EACvB,EAAE;IACL,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC5D,MAAM,mBAAmB,GAAG,YAAY,CACtC,IAAI,CAAC,UAAU,EACf,SAAS,EAAE,QAAQ,CACpB,CAAC;IAEF,mDAAmD;IACnD,qDAAqD;IACrD,oCAAoC;IACpC,OAAO;QACL,GAAG,IAAI;QACP,UAAU,EAAE,mBAAmB;KAChC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,OAAO,YAAa,SAAQ,WAAW;IACnC,MAAM,CAAC,QAAQ,CAAe;IAEtC;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;YAC1B,YAAY,CAAC,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC;SAC5C;QACD,OAAO,YAAY,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,cAAc,CACZ,IAAO,EACP,QAAkC,EAClC,OAA2C;QAE3C,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAoC,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAClB,IAAO,EACP,QAAkC,EAClC,OAAwC;QAExC,KAAK,CAAC,mBAAmB,CACvB,IAAI,EACJ,QAAoC,EACpC,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAiC,IAAO,EAAE,IAAuB;QACvE,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,MAAc;QAC/B,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CAAC,KAA6B,EAAE,MAAc;QACnE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,UAKzB;QACC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,gCAAgC,CAC9B,IAAgD;QAEhD,IAAI,CAAC,QAAQ,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,+BAA+B,CAC7B,IAA+C;QAE/C,IAAI,CAAC,QAAQ,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAAC,IAAoC;QACvD,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,IAA+B,EAAE,SAA0B;QACzE,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CACd,IAAgC,EAChC,SAA0B;QAE1B,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,iBAAiB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACH,qBAAqB,CAAC,IAAqC;QACzD,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAAC,IAAoC;QACvD,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,qBAAqB,CAAC,IAAqC;QACzD,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;CACF"}

package/dist/services/internal/fiatToCryptoService.js

@@ -1,5 +1,6 @@
 import { countries } from "countries-list";
 import getSymbolFromCurrency from "currency-symbol-map";
+import { DEFAULT_COUNTRY_CODE } from "../../core/constants";
 import { countryCurrencyMap } from "./countryCurrencyMap";
 export class FiatToCryptoService {
     provider;
@@ -9,7 +10,7 @@ export class FiatToCryptoService {
     static getProviderInfo(provider) {
         return provider.getInfo();
     }
-    async getQuote(fiatCurrency, cryptoCurrencyID, amount, paymentMethod = "card", region = "GB") {
+    async getQuote(fiatCurrency, cryptoCurrencyID, amount, paymentMethod = "card", region = DEFAULT_COUNTRY_CODE) {
         if (!this.provider)
             throw new Error("Provider is not initialized");
         return this.provider.getQuote(fiatCurrency, cryptoCurrencyID, amount, paymentMethod, region);

package/dist/services/internal/fiatToCryptoService.js.map

@@ -1 +1 @@
-{"version":3,"file":"fiatToCryptoService.js","sourceRoot":"","sources":["../../../src/services/internal/fiatToCryptoService.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,qBAAqB,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,MAAM,OAAO,mBAAmB;IACtB,QAAQ,CAAwB;IAExC,YAAY,QAA+B;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,QAA8B;QACnD,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,YAAoB,EACpB,gBAAwB,EACxB,MAAc,EACd,gBAAwB,MAAM,EAC9B,SAAiB,IAAI;QAErB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAC3B,YAAY,EACZ,gBAAgB,EAChB,MAAM,EACN,aAAa,EACb,MAAM,CACP,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,aAAqB;QAErB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,mBAAuC;QAEvC,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,WAGtB;QACC,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,OAAO,SAAS,CAAC;QACrC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,WAAmB;IAChD,MAAM,gBAAgB,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;IACnD,MAAM,gBAAgB,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;IAEnD,OAAO;QACL,GAAG,SAAS,CAAC,gBAA0C,CAAC;QACxD,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,gBAAgB;YACvB,CAAC,CAAC,2BAA2B,gBAAgB,MAAM;YACnD,CAAC,CAAC,EAAE;KACP,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,YAAoB;IAEpB,MAAM,MAAM,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;IACnD,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAE9B,MAAM,YAAY,GAAG,kBAAkB,CAAC,IAAI,CAC1C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,YAAY,CACvC,CAAC;IAEF,MAAM,WAAW,GAAG,cAAc,CAAC,YAAY,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC;IAEpE,OAAO;QACL,YAAY,EAAE,YAAY;QAC1B,MAAM;QACN,IAAI,EAAE,YAAY,EAAE,IAAI;QACxB,OAAO,EAAE,WAAW,CAAC,OAAO;KAC7B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"fiatToCryptoService.js","sourceRoot":"","sources":["../../../src/services/internal/fiatToCryptoService.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,qBAAqB,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,MAAM,OAAO,mBAAmB;IACtB,QAAQ,CAAwB;IAExC,YAAY,QAA+B;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,QAA8B;QACnD,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,YAAoB,EACpB,gBAAwB,EACxB,MAAc,EACd,gBAAwB,MAAM,EAC9B,SAAiB,oBAAoB;QAErC,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAC3B,YAAY,EACZ,gBAAgB,EAChB,MAAM,EACN,aAAa,EACb,MAAM,CACP,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,aAAqB;QAErB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,mBAAuC;QAEvC,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,WAGtB;QACC,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,OAAO,SAAS,CAAC;QACrC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,WAAmB;IAChD,MAAM,gBAAgB,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;IACnD,MAAM,gBAAgB,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;IAEnD,OAAO;QACL,GAAG,SAAS,CAAC,gBAA0C,CAAC;QACxD,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,gBAAgB;YACvB,CAAC,CAAC,2BAA2B,gBAAgB,MAAM;YACnD,CAAC,CAAC,EAAE;KACP,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,YAAoB;IAEpB,MAAM,MAAM,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;IACnD,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAE9B,MAAM,YAAY,GAAG,kBAAkB,CAAC,IAAI,CAC1C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,YAAY,CACvC,CAAC;IAEF,MAAM,WAAW,GAAG,cAAc,CAAC,YAAY,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC;IAEpE,OAAO;QACL,YAAY,EAAE,YAAY;QAC1B,MAAM;QACN,IAAI,EAAE,YAAY,EAAE,IAAI;QACxB,OAAO,EAAE,WAAW,CAAC,OAAO;KAC7B,CAAC;AACJ,CAAC"}

package/dist/services/internal/numberService.d.ts

@@ -16,11 +16,30 @@ export declare const parseToBigInt: (value: string, decimals?: number) => bigint
 export declare const formatBNToReadable: (value: bigint | string, decimals?: number) => string;
 export declare const roundNumericValue: (value?: string, precision?: number, useComaEvery3Digits?: boolean, significantFigures?: number) => string;
 export declare function formatUnitsRounded(value: string, decimals?: string | number, maxDecimalDigits?: number): string;
-export declare function formatTokenAmount(amount: string, { exact }?: {
-    exact?: boolean | undefined;
-}): string;
+interface FormatTokenAmountOptions {
+    /**
+     * When set to true, formats `amount` to its exact value, without any rounding.
+     */
+    exact?: boolean;
+    /**
+     * When set to true, formats `amount` to a compact value.
+     * Useful for cases where precision isn’t needed, just a rough estimate.
+     */
+    simplified?: boolean;
+}
+export declare function formatTokenAmount(amount: string, { exact, simplified }?: FormatTokenAmountOptions): string;
 interface FormatUsdAmountOptions {
+    /**
+     * When set to true, `amount` will be prefixed with a dollar sign ($)
+     */
     includeSign?: boolean;
+    /**
+     * If amount is above the threshold, uses 2 decimal places.
+     *
+     * If amount is below the threshold, uses a minimum of 2 decimal places
+     * and a maximum of 5 decimal places.
+     * If there are more decimal places than the maximum, will round the extra decimals.
+     */
     decimalPrecision?: boolean;
 }
 export declare function formatUsdAmount(amount?: number | bigint | string, { includeSign, decimalPrecision }?: FormatUsdAmountOptions): string;

package/dist/services/internal/numberService.js

@@ -2,6 +2,7 @@
 import take from "lodash/take";
 import takeWhile from "lodash/takeWhile";
 import { formatUnits, parseUnits } from "viem";
+import { DEFAULT_LOCALE } from "../../core/constants";
 // =====================================================
 // NOTE: We wrap viem utility method here
 // So that in the future we can change the implementation
@@ -47,7 +48,7 @@ export const roundNumericValue = (value = "0", precision = 2, useComaEvery3Digit
     // We might monitor and have a polyfill if some people are not
     // Seeing the comas.
     if (useComaEvery3Digits && integers !== "0") {
-        integers = parseInt(integers, 10).toLocaleString("en-US").toString();
+        integers = parseInt(integers, 10).toLocaleString(DEFAULT_LOCALE).toString();
     }
     if (significantFigures && decimals) {
         const zeros = takeWhile(decimals?.toString(), (c) => c === "0").length;
@@ -73,17 +74,20 @@ export function formatUnitsRounded(value, decimals, maxDecimalDigits) {
     }
 }
 const MAX_TOKEN_DECIMALS = 8;
-const TOKEN_EXACT_AMOUNT_INTL_FORMATTER = new Intl.NumberFormat("en-US", {
+const TOKEN_EXACT_AMOUNT_FORMATTER = new Intl.NumberFormat(DEFAULT_LOCALE, {
     minimumFractionDigits: 0,
     maximumFractionDigits: MAX_TOKEN_DECIMALS,
 });
-const TOKEN_ROUNDED_AMOUNT_INTL_FORMATTER = new Intl.NumberFormat("en-US", {
+const TOKEN_ROUNDED_AMOUNT_FORMATTER = new Intl.NumberFormat(DEFAULT_LOCALE, {
     minimumFractionDigits: 0,
     maximumFractionDigits: MAX_TOKEN_DECIMALS,
     minimumSignificantDigits: 2,
     maximumSignificantDigits: 4,
 });
-export function formatTokenAmount(amount, { exact = true } = {}) {
+const TOKEN_SIMPLIFIED_AMOUNT_FORMATTER = new Intl.NumberFormat(DEFAULT_LOCALE, {
+    maximumSignificantDigits: 2,
+});
+export function formatTokenAmount(amount, { exact = true, simplified = false } = {}) {
     const numericAmount = parseFloat(amount || "0");
     if (numericAmount <= 0) {
         return "0";
@@ -92,13 +96,17 @@ export function formatTokenAmount(amount, { exact = true } = {}) {
     if (numericAmount < Math.pow(10, -MAX_TOKEN_DECIMALS)) {
         return `<${Math.pow(10, -MAX_TOKEN_DECIMALS).toFixed(MAX_TOKEN_DECIMALS)}`;
     }
-    return exact
-        ? TOKEN_EXACT_AMOUNT_INTL_FORMATTER.format(numericAmount)
-        : TOKEN_ROUNDED_AMOUNT_INTL_FORMATTER.format(numericAmount);
+    if (simplified) {
+        return TOKEN_SIMPLIFIED_AMOUNT_FORMATTER.format(numericAmount);
+    }
+    if (exact) {
+        return TOKEN_EXACT_AMOUNT_FORMATTER.format(numericAmount);
+    }
+    return TOKEN_ROUNDED_AMOUNT_FORMATTER.format(numericAmount);
 }
 // For values below 100,000, use exact integer precision
 // e.g 1,234.56, 98,765.43
-const STANDARD_USD_INTL_FORMATTER = new Intl.NumberFormat("en-US", {
+const STANDARD_USD_INTL_FORMATTER = new Intl.NumberFormat(DEFAULT_LOCALE, {
     style: "currency",
     currency: "USD",
     minimumFractionDigits: 2,
@@ -106,7 +114,7 @@ const STANDARD_USD_INTL_FORMATTER = new Intl.NumberFormat("en-US", {
 });
 // For values above 100,000, use compact notation
 // e.g $12,34K, $98,765.43M
-const COMPACT_USD_INTL_FORMATTER = new Intl.NumberFormat("en-US", {
+const COMPACT_USD_INTL_FORMATTER = new Intl.NumberFormat(DEFAULT_LOCALE, {
     style: "currency",
     currency: "USD",
     notation: "compact",
@@ -116,12 +124,13 @@ const COMPACT_USD_INTL_FORMATTER = new Intl.NumberFormat("en-US", {
 });
 // For small amounts where decimal precision is important
 // e.g $0.00045, $1,231.3209, $57.00002
-const PRECISE_USD_INTL_FORMATTER = new Intl.NumberFormat("en-US", {
+const PRECISE_USD_INTL_FORMATTER = new Intl.NumberFormat(DEFAULT_LOCALE, {
     style: "currency",
     currency: "USD",
     minimumFractionDigits: 2,
     maximumFractionDigits: 5,
 });
+const DECIMAL_PRECISION_THRESHOLD = 1;
 export function formatUsdAmount(amount = "0", { includeSign = true, decimalPrecision = false } = {}) {
     const parsedAmount = Number(amount);
     if (parsedAmount < 0.01 && parsedAmount > 0 && !decimalPrecision) {
@@ -131,7 +140,9 @@ export function formatUsdAmount(amount = "0", { includeSign = true, decimalPreci
     if (parsedAmount >= 100_000) {
         return COMPACT_USD_INTL_FORMATTER.format(parsedAmount).replace(/^\$/, includeSign ? "$" : "");
     }
-    if (decimalPrecision) {
+    // Handle small amounts with decimal precision
+    // We don't care about decimal precision for big amounts
+    if (decimalPrecision && parsedAmount < DECIMAL_PRECISION_THRESHOLD) {
         return PRECISE_USD_INTL_FORMATTER.format(parsedAmount).replace(/^\$/, includeSign ? "$" : "");
     }
     // Handle amounts less than 100,000 with exact integer precision