@metamask/smart-transactions-controller 18.1.0 → 19.0.0

package/dist/{utils.d.ts → utils.d.cts}

@@ -1,6 +1,6 @@
-import type { TransactionMeta } from '@metamask/transaction-controller';
-import type { SmartTransaction, SmartTransactionsStatus, FeatureFlags } from './types';
-import { APIType, SmartTransactionStatuses, ClientId } from './types';
+import type { TransactionControllerGetTransactionsAction, TransactionControllerUpdateTransactionAction } from "@metamask/transaction-controller";
+import type { SmartTransaction, SmartTransactionsStatus, FeatureFlags } from "./types.cjs";
+import { APIType, SmartTransactionStatuses, ClientId } from "./types.cjs";
 export declare function isSmartTransactionPending(smartTransaction: SmartTransaction): boolean;
 export declare const isSmartTransactionStatusResolved: (stxStatus: SmartTransactionsStatus | string) => boolean;
 export declare function getAPIRequestURL(apiType: APIType, chainId: string): string;
@@ -84,6 +84,7 @@ export declare const shouldMarkRegularTransactionAsFailed: ({ smartTransaction,
 }) => boolean;
 export declare const markRegularTransactionAsFailed: ({ smartTransaction, getRegularTransactions, updateTransaction, }: {
     smartTransaction: SmartTransaction;
-    getRegularTransactions: () => TransactionMeta[];
-    updateTransaction: (transaction: TransactionMeta, note: string) => void;
+    getRegularTransactions: TransactionControllerGetTransactionsAction['handler'];
+    updateTransaction: TransactionControllerUpdateTransactionAction['handler'];
 }) => void;
+//# sourceMappingURL=utils.d.cts.map

package/dist/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,0CAA0C,EAC1C,4CAA4C,EAE7C,yCAAyC;AAY1C,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACb,oBAAgB;AACjB,OAAO,EACL,OAAO,EACP,wBAAwB,EAIxB,QAAQ,EACT,oBAAgB;AAEjB,wBAAgB,yBAAyB,CAAC,gBAAgB,EAAE,gBAAgB,WAE3E;AAED,eAAO,MAAM,gCAAgC,cAChC,uBAAuB,GAAG,MAAM,YACV,CAAC;AAGpC,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CA+B1E;AAED,eAAO,MAAM,eAAe,cAAe,uBAAuB,6BAuCjE,CAAC;AAEF;;;;;;;;;;;EAWE;AACF,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,GAAG,EAClB,QAAQ,EAAE,GAAG,EACb,IAAI,EAAE,MAAM,OAYb;AAED;;;EAGE;AACF,wBAAgB,aAAa,CAAC,aAAa,EAAE,GAAG,OAK/C;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,GAAG,OAI7C;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,kCACA,MAAM,GAAG,SAAS,KAChD,MAAM,GAAG,SAKX,CAAC;AAEF,eAAO,MAAM,cAAc,QACpB,OAAO,MAAM,EAAE,GAAG,CAAC,KACvB,OAAO,MAAM,EAAE,GAAG,CAcpB,CAAC;AAEF,wBAAsB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,gBAavE;AAED,eAAO,MAAM,6BAA6B,cAC7B,uBAAuB,KACjC,OAOF,CAAC;AAEF,eAAO,MAAM,mBAAmB,eAAgB,MAAM,KAAG,MAGxD,CAAC;AAMF,eAAO,MAAM,SAAS,gBAAiB,GAAG,WAazC,CAAC;AAEF,eAAO,MAAM,oCAAoC,qBAC7B,gBAAgB;;;;;;;;;;;;;;;;;;;;;;CAkBnC,CAAC;AAEF,eAAO,MAAM,6CAA6C,qBACtC,gBAAgB;;;;;;;;;;;;CAYnC,CAAC;AAEF,eAAO,MAAM,mBAAmB,aACpB,QAAQ,iCACa,YAAY,CAAC,mBAAmB,CAAC,wBAKjE,CAAC;AAEF,eAAO,MAAM,oCAAoC;sBAK7B,gBAAgB;cACxB,QAAQ;qBACD,MAAM,YAAY;MACjC,OAqBH,CAAC;AAEF,eAAO,MAAM,8BAA8B;sBAKvB,gBAAgB;4BACV,0CAA0C,CAAC,SAAS,CAAC;uBAC1D,4CAA4C,CAAC,SAAS,CAAC;UAqB3E,CAAC"}

package/dist/utils.d.mts

@@ -0,0 +1,90 @@
+import type { TransactionControllerGetTransactionsAction, TransactionControllerUpdateTransactionAction } from "@metamask/transaction-controller";
+import type { SmartTransaction, SmartTransactionsStatus, FeatureFlags } from "./types.mjs";
+import { APIType, SmartTransactionStatuses, ClientId } from "./types.mjs";
+export declare function isSmartTransactionPending(smartTransaction: SmartTransaction): boolean;
+export declare const isSmartTransactionStatusResolved: (stxStatus: SmartTransactionsStatus | string) => boolean;
+export declare function getAPIRequestURL(apiType: APIType, chainId: string): string;
+export declare const calculateStatus: (stxStatus: SmartTransactionsStatus) => SmartTransactionStatuses;
+/**
+  Generates an array of history objects sense the previous state.
+  The object has the keys
+    op (the operation performed),
+    path (the key and if a nested object then each key will be separated with a `/`)
+    value
+  with the first entry having the note and a timestamp when the change took place
+  @param previousState - the previous state of the object
+  @param newState - the update object
+  @param [note] - a optional note for the state change
+  @returns
+*/
+export declare function generateHistoryEntry(previousState: any, newState: any, note: string): any;
+/**
+  Recovers previous txMeta state obj
+  @returns
+*/
+export declare function replayHistory(_shortHistory: any): any;
+/**
+ * Snapshot {@code txMeta}
+ * @param txMeta - the tx metadata object
+ * @returns a deep clone without history
+ */
+export declare function snapshotFromTxMeta(txMeta: any): any;
+/**
+ * Returns processing time for an STX in seconds.
+ * @param smartTransactionSubmittedtime
+ * @returns Processing time in seconds.
+ */
+export declare const getStxProcessingTime: (smartTransactionSubmittedtime: number | undefined) => number | undefined;
+export declare const mapKeysToCamel: (obj: Record<string, any>) => Record<string, any>;
+export declare function handleFetch(request: string, options?: RequestInit): Promise<any>;
+export declare const isSmartTransactionCancellable: (stxStatus: SmartTransactionsStatus) => boolean;
+export declare const incrementNonceInHex: (nonceInHex: string) => string;
+export declare const getTxHash: (signedTxHex: any) => string;
+export declare const getSmartTransactionMetricsProperties: (smartTransaction: SmartTransaction) => {
+    stx_status?: undefined;
+    type?: undefined;
+    processing_time?: undefined;
+    is_smart_transaction?: undefined;
+    stx_enabled?: undefined;
+    current_stx_enabled?: undefined;
+    stx_user_opt_in?: undefined;
+    stx_duplicated?: undefined;
+    stx_timed_out?: undefined;
+    stx_proxied?: undefined;
+} | {
+    stx_status: string | undefined;
+    type: string | undefined;
+    processing_time: number | undefined;
+    is_smart_transaction: boolean;
+    stx_enabled: boolean;
+    current_stx_enabled: boolean;
+    stx_user_opt_in: boolean;
+    stx_duplicated: boolean | undefined;
+    stx_timed_out: boolean | undefined;
+    stx_proxied: boolean | undefined;
+};
+export declare const getSmartTransactionMetricsSensitiveProperties: (smartTransaction: SmartTransaction) => {
+    token_from_symbol?: undefined;
+    token_to_symbol?: undefined;
+    account_hardware_type?: undefined;
+    account_type?: undefined;
+    device_model?: undefined;
+} | {
+    token_from_symbol: string | undefined;
+    token_to_symbol: string | undefined;
+    account_hardware_type: string | undefined;
+    account_type: string | undefined;
+    device_model: string | undefined;
+};
+export declare const getReturnTxHashAsap: (clientId: ClientId, smartTransactionsFeatureFlags: FeatureFlags['smartTransactions']) => boolean | undefined;
+export declare const shouldMarkRegularTransactionAsFailed: ({ smartTransaction, clientId, getFeatureFlags, }: {
+    smartTransaction: SmartTransaction;
+    clientId: ClientId;
+    getFeatureFlags: () => FeatureFlags;
+}) => boolean;
+export declare const markRegularTransactionAsFailed: ({ smartTransaction, getRegularTransactions, updateTransaction, }: {
+    smartTransaction: SmartTransaction;
+    getRegularTransactions: TransactionControllerGetTransactionsAction['handler'];
+    updateTransaction: TransactionControllerUpdateTransactionAction['handler'];
+}) => void;
+//# sourceMappingURL=utils.d.mts.map

package/dist/utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,0CAA0C,EAC1C,4CAA4C,EAE7C,yCAAyC;AAY1C,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACb,oBAAgB;AACjB,OAAO,EACL,OAAO,EACP,wBAAwB,EAIxB,QAAQ,EACT,oBAAgB;AAEjB,wBAAgB,yBAAyB,CAAC,gBAAgB,EAAE,gBAAgB,WAE3E;AAED,eAAO,MAAM,gCAAgC,cAChC,uBAAuB,GAAG,MAAM,YACV,CAAC;AAGpC,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CA+B1E;AAED,eAAO,MAAM,eAAe,cAAe,uBAAuB,6BAuCjE,CAAC;AAEF;;;;;;;;;;;EAWE;AACF,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,GAAG,EAClB,QAAQ,EAAE,GAAG,EACb,IAAI,EAAE,MAAM,OAYb;AAED;;;EAGE;AACF,wBAAgB,aAAa,CAAC,aAAa,EAAE,GAAG,OAK/C;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,GAAG,OAI7C;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,kCACA,MAAM,GAAG,SAAS,KAChD,MAAM,GAAG,SAKX,CAAC;AAEF,eAAO,MAAM,cAAc,QACpB,OAAO,MAAM,EAAE,GAAG,CAAC,KACvB,OAAO,MAAM,EAAE,GAAG,CAcpB,CAAC;AAEF,wBAAsB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,gBAavE;AAED,eAAO,MAAM,6BAA6B,cAC7B,uBAAuB,KACjC,OAOF,CAAC;AAEF,eAAO,MAAM,mBAAmB,eAAgB,MAAM,KAAG,MAGxD,CAAC;AAMF,eAAO,MAAM,SAAS,gBAAiB,GAAG,WAazC,CAAC;AAEF,eAAO,MAAM,oCAAoC,qBAC7B,gBAAgB;;;;;;;;;;;;;;;;;;;;;;CAkBnC,CAAC;AAEF,eAAO,MAAM,6CAA6C,qBACtC,gBAAgB;;;;;;;;;;;;CAYnC,CAAC;AAEF,eAAO,MAAM,mBAAmB,aACpB,QAAQ,iCACa,YAAY,CAAC,mBAAmB,CAAC,wBAKjE,CAAC;AAEF,eAAO,MAAM,oCAAoC;sBAK7B,gBAAgB;cACxB,QAAQ;qBACD,MAAM,YAAY;MACjC,OAqBH,CAAC;AAEF,eAAO,MAAM,8BAA8B;sBAKvB,gBAAgB;4BACV,0CAA0C,CAAC,SAAS,CAAC;uBAC1D,4CAA4C,CAAC,SAAS,CAAC;UAqB3E,CAAC"}

package/dist/utils.mjs

@@ -0,0 +1,265 @@
+function $importDefault(module) {
+    if (module === null || module === void 0 ? void 0 : module.__esModule) {
+        return module.default;
+    }
+    return module;
+}
+import { arrayify, hexlify } from "@ethersproject/bytes";
+import { keccak256 } from "@ethersproject/keccak256";
+import { parse } from "@ethersproject/transactions";
+import { TransactionStatus } from "@metamask/transaction-controller";
+import { BigNumber } from "bignumber.js";
+import $jsonDiffer from "fast-json-patch";
+const jsonDiffer = $importDefault($jsonDiffer);
+import $_ from "lodash";
+const _ = $importDefault($_);
+// Ignoring TypeScript errors here because this import is disallowed for production builds, because
+// the `package.json` file is above the root directory.
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import packageJson from "../package.json" assert { type: "json" };
+import { API_BASE_URL, SENTINEL_API_BASE_URL_MAP } from "./constants.mjs";
+import { APIType, SmartTransactionStatuses, SmartTransactionCancellationReason, SmartTransactionMinedTx, cancellationReasonToStatusMap, ClientId } from "./types.mjs";
+export function isSmartTransactionPending(smartTransaction) {
+    return smartTransaction.status === SmartTransactionStatuses.PENDING;
+}
+export const isSmartTransactionStatusResolved = (stxStatus) => stxStatus === 'uuid_not_found';
+// TODO use actual url once API is defined
+export function getAPIRequestURL(apiType, chainId) {
+    const chainIdDec = parseInt(chainId, 16);
+    switch (apiType) {
+        case APIType.GET_FEES: {
+            return `${API_BASE_URL}/networks/${chainIdDec}/getFees`;
+        }
+        case APIType.ESTIMATE_GAS: {
+            return `${API_BASE_URL}/networks/${chainIdDec}/estimateGas`;
+        }
+        case APIType.SUBMIT_TRANSACTIONS: {
+            return `${API_BASE_URL}/networks/${chainIdDec}/submitTransactions?stxControllerVersion=${packageJson.version}`;
+        }
+        case APIType.CANCEL: {
+            return `${API_BASE_URL}/networks/${chainIdDec}/cancel`;
+        }
+        case APIType.BATCH_STATUS: {
+            return `${API_BASE_URL}/networks/${chainIdDec}/batchStatus`;
+        }
+        case APIType.LIVENESS: {
+            return `${SENTINEL_API_BASE_URL_MAP[chainIdDec]}/network`;
+        }
+        default: {
+            throw new Error(`Invalid APIType`); // It can never get here thanks to TypeScript.
+        }
+    }
+}
+export const calculateStatus = (stxStatus) => {
+    if (isSmartTransactionStatusResolved(stxStatus)) {
+        return SmartTransactionStatuses.RESOLVED;
+    }
+    const cancellations = [
+        SmartTransactionCancellationReason.WOULD_REVERT,
+        SmartTransactionCancellationReason.TOO_CHEAP,
+        SmartTransactionCancellationReason.DEADLINE_MISSED,
+        SmartTransactionCancellationReason.INVALID_NONCE,
+        SmartTransactionCancellationReason.USER_CANCELLED,
+    ];
+    if ((stxStatus === null || stxStatus === void 0 ? void 0 : stxStatus.minedTx) === SmartTransactionMinedTx.NOT_MINED) {
+        if (stxStatus.cancellationReason ===
+            SmartTransactionCancellationReason.NOT_CANCELLED) {
+            return SmartTransactionStatuses.PENDING;
+        }
+        const isCancellation = cancellations.findIndex((cancellation) => cancellation === stxStatus.cancellationReason) > -1;
+        if (stxStatus.cancellationReason && isCancellation) {
+            if (!stxStatus.isSettled) {
+                return SmartTransactionStatuses.PENDING;
+            }
+            return cancellationReasonToStatusMap[stxStatus.cancellationReason];
+        }
+    }
+    else if ((stxStatus === null || stxStatus === void 0 ? void 0 : stxStatus.minedTx) === SmartTransactionMinedTx.SUCCESS) {
+        return SmartTransactionStatuses.SUCCESS;
+    }
+    else if ((stxStatus === null || stxStatus === void 0 ? void 0 : stxStatus.minedTx) === SmartTransactionMinedTx.CANCELLED) {
+        return SmartTransactionStatuses.CANCELLED;
+    }
+    else if ((stxStatus === null || stxStatus === void 0 ? void 0 : stxStatus.minedTx) === SmartTransactionMinedTx.REVERTED) {
+        return SmartTransactionStatuses.REVERTED;
+    }
+    else if ((stxStatus === null || stxStatus === void 0 ? void 0 : stxStatus.minedTx) === SmartTransactionMinedTx.UNKNOWN) {
+        return SmartTransactionStatuses.UNKNOWN;
+    }
+    return SmartTransactionStatuses.UNKNOWN;
+};
+/**
+  Generates an array of history objects sense the previous state.
+  The object has the keys
+    op (the operation performed),
+    path (the key and if a nested object then each key will be separated with a `/`)
+    value
+  with the first entry having the note and a timestamp when the change took place
+  @param previousState - the previous state of the object
+  @param newState - the update object
+  @param [note] - a optional note for the state change
+  @returns
+*/
+export function generateHistoryEntry(previousState, newState, note) {
+    const entry = jsonDiffer.compare(previousState, newState);
+    // Add a note to the first op, since it breaks if we append it to the entry
+    if (entry[0]) {
+        if (note) {
+            entry[0].note = note;
+        }
+        entry[0].timestamp = Date.now();
+    }
+    return entry;
+}
+/**
+  Recovers previous txMeta state obj
+  @returns
+*/
+export function replayHistory(_shortHistory) {
+    const shortHistory = _.cloneDeep(_shortHistory);
+    return shortHistory.reduce((val, entry) => jsonDiffer.applyPatch(val, entry).newDocument);
+}
+/**
+ * Snapshot {@code txMeta}
+ * @param txMeta - the tx metadata object
+ * @returns a deep clone without history
+ */
+export function snapshotFromTxMeta(txMeta) {
+    const shallow = Object.assign({}, txMeta);
+    delete shallow.history;
+    return _.cloneDeep(shallow);
+}
+/**
+ * Returns processing time for an STX in seconds.
+ * @param smartTransactionSubmittedtime
+ * @returns Processing time in seconds.
+ */
+export const getStxProcessingTime = (smartTransactionSubmittedtime) => {
+    if (!smartTransactionSubmittedtime) {
+        return undefined;
+    }
+    return Math.round((Date.now() - smartTransactionSubmittedtime) / 1000);
+};
+export const mapKeysToCamel = (obj) => {
+    if (!_.isObject(obj)) {
+        return obj;
+    }
+    const mappedValues = _.mapValues(obj, (val) => {
+        if (_.isArray(val)) {
+            return val.map(mapKeysToCamel);
+        }
+        else if (_.isObject(val)) {
+            return mapKeysToCamel(val);
+        }
+        return val;
+    });
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    return _.mapKeys(mappedValues, (value, key) => _.camelCase(key));
+};
+export async function handleFetch(request, options) {
+    const response = await fetch(request, options);
+    const json = await response.json();
+    if (!response.ok) {
+        console.log(`response`, response);
+        throw new Error(`Fetch error:${JSON.stringify(Object.assign({ status: response.status }, mapKeysToCamel(json)))}`);
+    }
+    return json;
+}
+export const isSmartTransactionCancellable = (stxStatus) => {
+    return (stxStatus.minedTx === SmartTransactionMinedTx.NOT_MINED &&
+        (!stxStatus.cancellationReason ||
+            stxStatus.cancellationReason ===
+                SmartTransactionCancellationReason.NOT_CANCELLED));
+};
+export const incrementNonceInHex = (nonceInHex) => {
+    const nonceInDec = new BigNumber(nonceInHex, 16).toString(10);
+    return hexlify(Number(nonceInDec) + 1);
+};
+const isType4Transaction = (signedTxHex) => {
+    return typeof signedTxHex === 'string' && signedTxHex.startsWith('0x04');
+};
+export const getTxHash = (signedTxHex) => {
+    var _a;
+    if (!signedTxHex) {
+        return '';
+    }
+    try {
+        const parsed = parse(signedTxHex);
+        return (_a = parsed === null || parsed === void 0 ? void 0 : parsed.hash) !== null && _a !== void 0 ? _a : '';
+    }
+    catch (error) {
+        if (isType4Transaction(signedTxHex)) {
+            return hexlify(keccak256(arrayify(signedTxHex)));
+        }
+        throw error;
+    }
+};
+export const getSmartTransactionMetricsProperties = (smartTransaction) => {
+    if (!smartTransaction) {
+        return {};
+    }
+    const smartTransactionStatusMetadata = smartTransaction.statusMetadata;
+    return {
+        stx_status: smartTransaction.status,
+        type: smartTransaction.type,
+        processing_time: getStxProcessingTime(smartTransaction.time),
+        is_smart_transaction: true,
+        stx_enabled: true,
+        current_stx_enabled: true,
+        stx_user_opt_in: true,
+        stx_duplicated: smartTransactionStatusMetadata === null || smartTransactionStatusMetadata === void 0 ? void 0 : smartTransactionStatusMetadata.duplicated,
+        stx_timed_out: smartTransactionStatusMetadata === null || smartTransactionStatusMetadata === void 0 ? void 0 : smartTransactionStatusMetadata.timedOut,
+        stx_proxied: smartTransactionStatusMetadata === null || smartTransactionStatusMetadata === void 0 ? void 0 : smartTransactionStatusMetadata.proxied,
+    };
+};
+export const getSmartTransactionMetricsSensitiveProperties = (smartTransaction) => {
+    if (!smartTransaction) {
+        return {};
+    }
+    return {
+        token_from_symbol: smartTransaction.sourceTokenSymbol,
+        token_to_symbol: smartTransaction.destinationTokenSymbol,
+        account_hardware_type: smartTransaction.accountHardwareType,
+        account_type: smartTransaction.accountType,
+        device_model: smartTransaction.deviceModel,
+    };
+};
+export const getReturnTxHashAsap = (clientId, smartTransactionsFeatureFlags) => {
+    return clientId === ClientId.Extension
+        ? smartTransactionsFeatureFlags === null || smartTransactionsFeatureFlags === void 0 ? void 0 : smartTransactionsFeatureFlags.extensionReturnTxHashAsap
+        : smartTransactionsFeatureFlags === null || smartTransactionsFeatureFlags === void 0 ? void 0 : smartTransactionsFeatureFlags.mobileReturnTxHashAsap;
+};
+export const shouldMarkRegularTransactionAsFailed = ({ smartTransaction, clientId, getFeatureFlags, }) => {
+    var _a;
+    const { status, transactionId } = smartTransaction;
+    const failureStatuses = [
+        SmartTransactionStatuses.CANCELLED,
+        SmartTransactionStatuses.CANCELLED_USER_CANCELLED,
+        SmartTransactionStatuses.UNKNOWN,
+        SmartTransactionStatuses.RESOLVED,
+    ];
+    if (!status ||
+        !failureStatuses.includes(status)) {
+        return false;
+    }
+    const { smartTransactions: smartTransactionsFeatureFlags } = (_a = getFeatureFlags()) !== null && _a !== void 0 ? _a : {};
+    const returnTxHashAsapEnabled = getReturnTxHashAsap(clientId, smartTransactionsFeatureFlags);
+    return Boolean(returnTxHashAsapEnabled && transactionId);
+};
+export const markRegularTransactionAsFailed = ({ smartTransaction, getRegularTransactions, updateTransaction, }) => {
+    const { transactionId, status } = smartTransaction;
+    const originalTransaction = getRegularTransactions().find((transaction) => transaction.id === transactionId);
+    if (!originalTransaction) {
+        throw new Error('Cannot find regular transaction to mark it as failed');
+    }
+    if (originalTransaction.status === TransactionStatus.failed) {
+        return; // Already marked as failed.
+    }
+    const updatedTransaction = Object.assign(Object.assign({}, originalTransaction), { status: TransactionStatus.failed, error: {
+            name: 'SmartTransactionFailed',
+            message: `Smart transaction failed with status: ${status}`,
+        } });
+    updateTransaction(updatedTransaction, `Smart transaction status: ${status}`);
+};
+//# sourceMappingURL=utils.mjs.map

package/dist/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,6BAA6B;AACzD,OAAO,EAAE,SAAS,EAAE,iCAAiC;AACrD,OAAO,EAAE,KAAK,EAAE,oCAAoC;AAMpD,OAAO,EAAE,iBAAiB,EAAE,yCAAyC;AACrE,OAAO,EAAE,SAAS,EAAE,qBAAqB;AACzC,OAAO,WAAU,wBAAwB;;AACzC,OAAO,EAAC,eAAe;;AAEvB,mGAAmG;AACnG,uDAAuD;AACvD,6DAA6D;AAC7D,aAAa;AACb,OAAO,WAAW,gDAAwB;AAC1C,OAAO,EAAE,YAAY,EAAE,yBAAyB,EAAE,wBAAoB;AAMtE,OAAO,EACL,OAAO,EACP,wBAAwB,EACxB,kCAAkC,EAClC,uBAAuB,EACvB,6BAA6B,EAC7B,QAAQ,EACT,oBAAgB;AAEjB,MAAM,UAAU,yBAAyB,CAAC,gBAAkC;IAC1E,OAAO,gBAAgB,CAAC,MAAM,KAAK,wBAAwB,CAAC,OAAO,CAAC;AACtE,CAAC;AAED,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC9C,SAA2C,EAC3C,EAAE,CAAC,SAAS,KAAK,gBAAgB,CAAC;AAEpC,0CAA0C;AAC1C,MAAM,UAAU,gBAAgB,CAAC,OAAgB,EAAE,OAAe;IAChE,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACzC,QAAQ,OAAO,EAAE;QACf,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;YACrB,OAAO,GAAG,YAAY,aAAa,UAAU,UAAU,CAAC;SACzD;QAED,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;YACzB,OAAO,GAAG,YAAY,aAAa,UAAU,cAAc,CAAC;SAC7D;QAED,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;YAChC,OAAO,GAAG,YAAY,aAAa,UAAU,4CAA4C,WAAW,CAAC,OAAO,EAAE,CAAC;SAChH;QAED,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;YACnB,OAAO,GAAG,YAAY,aAAa,UAAU,SAAS,CAAC;SACxD;QAED,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;YACzB,OAAO,GAAG,YAAY,aAAa,UAAU,cAAc,CAAC;SAC7D;QAED,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;YACrB,OAAO,GAAG,yBAAyB,CAAC,UAAU,CAAC,UAAU,CAAC;SAC3D;QAED,OAAO,CAAC,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,8CAA8C;SACnF;KACF;AACH,CAAC;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,SAAkC,EAAE,EAAE;IACpE,IAAI,gCAAgC,CAAC,SAAS,CAAC,EAAE;QAC/C,OAAO,wBAAwB,CAAC,QAAQ,CAAC;KAC1C;IACD,MAAM,aAAa,GAAG;QACpB,kCAAkC,CAAC,YAAY;QAC/C,kCAAkC,CAAC,SAAS;QAC5C,kCAAkC,CAAC,eAAe;QAClD,kCAAkC,CAAC,aAAa;QAChD,kCAAkC,CAAC,cAAc;KAClD,CAAC;IACF,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,MAAK,uBAAuB,CAAC,SAAS,EAAE;QAC5D,IACE,SAAS,CAAC,kBAAkB;YAC5B,kCAAkC,CAAC,aAAa,EAChD;YACA,OAAO,wBAAwB,CAAC,OAAO,CAAC;SACzC;QAED,MAAM,cAAc,GAClB,aAAa,CAAC,SAAS,CACrB,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,KAAK,SAAS,CAAC,kBAAkB,CAChE,GAAG,CAAC,CAAC,CAAC;QACT,IAAI,SAAS,CAAC,kBAAkB,IAAI,cAAc,EAAE;YAClD,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE;gBACxB,OAAO,wBAAwB,CAAC,OAAO,CAAC;aACzC;YACD,OAAO,6BAA6B,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;SACpE;KACF;SAAM,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,MAAK,uBAAuB,CAAC,OAAO,EAAE;QACjE,OAAO,wBAAwB,CAAC,OAAO,CAAC;KACzC;SAAM,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,MAAK,uBAAuB,CAAC,SAAS,EAAE;QACnE,OAAO,wBAAwB,CAAC,SAAS,CAAC;KAC3C;SAAM,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,MAAK,uBAAuB,CAAC,QAAQ,EAAE;QAClE,OAAO,wBAAwB,CAAC,QAAQ,CAAC;KAC1C;SAAM,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,MAAK,uBAAuB,CAAC,OAAO,EAAE;QACjE,OAAO,wBAAwB,CAAC,OAAO,CAAC;KACzC;IACD,OAAO,wBAAwB,CAAC,OAAO,CAAC;AAC1C,CAAC,CAAC;AAEF;;;;;;;;;;;EAWE;AACF,MAAM,UAAU,oBAAoB,CAClC,aAAkB,EAClB,QAAa,EACb,IAAY;IAEZ,MAAM,KAAK,GAAQ,UAAU,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IAC/D,2EAA2E;IAC3E,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE;QACZ,IAAI,IAAI,EAAE;YACR,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC;SACtB;QAED,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;KACjC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;EAGE;AACF,MAAM,UAAU,aAAa,CAAC,aAAkB;IAC9C,MAAM,YAAY,GAAG,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAChD,OAAO,YAAY,CAAC,MAAM,CACxB,CAAC,GAAQ,EAAE,KAAU,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,WAAW,CACxE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAW;IAC5C,MAAM,OAAO,qBAAQ,MAAM,CAAE,CAAC;IAC9B,OAAO,OAAO,CAAC,OAAO,CAAC;IACvB,OAAO,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,6BAAiD,EAC7B,EAAE;IACtB,IAAI,CAAC,6BAA6B,EAAE;QAClC,OAAO,SAAS,CAAC;KAClB;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,6BAA6B,CAAC,GAAG,IAAI,CAAC,CAAC;AACzE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,GAAwB,EACH,EAAE;IACvB,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACpB,OAAO,GAAG,CAAC;KACZ;IACD,MAAM,YAAY,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,GAAwB,EAAE,EAAE;QACjE,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAClB,OAAO,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;SAChC;aAAM,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC1B,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC;SAC5B;QACD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;IACH,6DAA6D;IAC7D,OAAO,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAe,EAAE,OAAqB;IACtE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;QAChB,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,eAAe,IAAI,CAAC,SAAS,iBAC3B,MAAM,EAAE,QAAQ,CAAC,MAAM,IACpB,cAAc,CAAC,IAAI,CAAC,EACvB,EAAE,CACL,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,SAAkC,EACzB,EAAE;IACX,OAAO,CACL,SAAS,CAAC,OAAO,KAAK,uBAAuB,CAAC,SAAS;QACvD,CAAC,CAAC,SAAS,CAAC,kBAAkB;YAC5B,SAAS,CAAC,kBAAkB;gBAC1B,kCAAkC,CAAC,aAAa,CAAC,CACtD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,UAAkB,EAAU,EAAE;IAChE,MAAM,UAAU,GAAG,IAAI,SAAS,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC9D,OAAO,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,WAAmB,EAAE,EAAE;IACjD,OAAO,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAC3E,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,WAAgB,EAAE,EAAE;;IAC5C,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,EAAE,CAAC;KACX;IACD,IAAI;QACF,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QAClC,OAAO,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,EAAE,CAAC;KAC3B;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,kBAAkB,CAAC,WAAW,CAAC,EAAE;YACnC,OAAO,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SAClD;QACD,MAAM,KAAK,CAAC;KACb;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAClD,gBAAkC,EAClC,EAAE;IACF,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO,EAAE,CAAC;KACX;IACD,MAAM,8BAA8B,GAAG,gBAAgB,CAAC,cAAc,CAAC;IACvE,OAAO;QACL,UAAU,EAAE,gBAAgB,CAAC,MAAM;QACnC,IAAI,EAAE,gBAAgB,CAAC,IAAI;QAC3B,eAAe,EAAE,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC;QAC5D,oBAAoB,EAAE,IAAI;QAC1B,WAAW,EAAE,IAAI;QACjB,mBAAmB,EAAE,IAAI;QACzB,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,UAAU;QAC1D,aAAa,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,QAAQ;QACvD,WAAW,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,OAAO;KACrD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,6CAA6C,GAAG,CAC3D,gBAAkC,EAClC,EAAE;IACF,IAAI,CAAC,gBAAgB,EAAE;QACrB,OAAO,EAAE,CAAC;KACX;IACD,OAAO;QACL,iBAAiB,EAAE,gBAAgB,CAAC,iBAAiB;QACrD,eAAe,EAAE,gBAAgB,CAAC,sBAAsB;QACxD,qBAAqB,EAAE,gBAAgB,CAAC,mBAAmB;QAC3D,YAAY,EAAE,gBAAgB,CAAC,WAAW;QAC1C,YAAY,EAAE,gBAAgB,CAAC,WAAW;KAC3C,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,QAAkB,EAClB,6BAAgE,EAChE,EAAE;IACF,OAAO,QAAQ,KAAK,QAAQ,CAAC,SAAS;QACpC,CAAC,CAAC,6BAA6B,aAA7B,6BAA6B,uBAA7B,6BAA6B,CAAE,yBAAyB;QAC1D,CAAC,CAAC,6BAA6B,aAA7B,6BAA6B,uBAA7B,6BAA6B,CAAE,sBAAsB,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,EACnD,gBAAgB,EAChB,QAAQ,EACR,eAAe,GAKhB,EAAW,EAAE;;IACZ,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,gBAAgB,CAAC;IACnD,MAAM,eAAe,GAA+B;QAClD,wBAAwB,CAAC,SAAS;QAClC,wBAAwB,CAAC,wBAAwB;QACjD,wBAAwB,CAAC,OAAO;QAChC,wBAAwB,CAAC,QAAQ;KAClC,CAAC;IACF,IACE,CAAC,MAAM;QACP,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAkC,CAAC,EAC7D;QACA,OAAO,KAAK,CAAC;KACd;IACD,MAAM,EAAE,iBAAiB,EAAE,6BAA6B,EAAE,GACxD,MAAA,eAAe,EAAE,mCAAI,EAAE,CAAC;IAC1B,MAAM,uBAAuB,GAAG,mBAAmB,CACjD,QAAQ,EACR,6BAA6B,CAC9B,CAAC;IACF,OAAO,OAAO,CAAC,uBAAuB,IAAI,aAAa,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,EAC7C,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,GAKlB,EAAE,EAAE;IACH,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;IACnD,MAAM,mBAAmB,GAAG,sBAAsB,EAAE,CAAC,IAAI,CACvD,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,EAAE,KAAK,aAAa,CAClD,CAAC;IACF,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;KACzE;IACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,iBAAiB,CAAC,MAAM,EAAE;QAC3D,OAAO,CAAC,4BAA4B;KACrC;IACD,MAAM,kBAAkB,mCACnB,mBAAmB,KACtB,MAAM,EAAE,iBAAiB,CAAC,MAAM,EAChC,KAAK,EAAE;YACL,IAAI,EAAE,wBAAwB;YAC9B,OAAO,EAAE,yCAAyC,MAAM,EAAE;SAC3D,GACF,CAAC;IACF,iBAAiB,CAAC,kBAAkB,EAAE,6BAA6B,MAAM,EAAE,CAAC,CAAC;AAC/E,CAAC,CAAC","sourcesContent":["import { arrayify, hexlify } from '@ethersproject/bytes';\nimport { keccak256 } from '@ethersproject/keccak256';\nimport { parse } from '@ethersproject/transactions';\nimport type {\n  TransactionControllerGetTransactionsAction,\n  TransactionControllerUpdateTransactionAction,\n  TransactionMeta,\n} from '@metamask/transaction-controller';\nimport { TransactionStatus } from '@metamask/transaction-controller';\nimport { BigNumber } from 'bignumber.js';\nimport jsonDiffer from 'fast-json-patch';\nimport _ from 'lodash';\n\n// Ignoring TypeScript errors here because this import is disallowed for production builds, because\n// the `package.json` file is above the root directory.\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nimport packageJson from '../package.json';\nimport { API_BASE_URL, SENTINEL_API_BASE_URL_MAP } from './constants';\nimport type {\n  SmartTransaction,\n  SmartTransactionsStatus,\n  FeatureFlags,\n} from './types';\nimport {\n  APIType,\n  SmartTransactionStatuses,\n  SmartTransactionCancellationReason,\n  SmartTransactionMinedTx,\n  cancellationReasonToStatusMap,\n  ClientId,\n} from './types';\n\nexport function isSmartTransactionPending(smartTransaction: SmartTransaction) {\n  return smartTransaction.status === SmartTransactionStatuses.PENDING;\n}\n\nexport const isSmartTransactionStatusResolved = (\n  stxStatus: SmartTransactionsStatus | string,\n) => stxStatus === 'uuid_not_found';\n\n// TODO use actual url once API is defined\nexport function getAPIRequestURL(apiType: APIType, chainId: string): string {\n  const chainIdDec = parseInt(chainId, 16);\n  switch (apiType) {\n    case APIType.GET_FEES: {\n      return `${API_BASE_URL}/networks/${chainIdDec}/getFees`;\n    }\n\n    case APIType.ESTIMATE_GAS: {\n      return `${API_BASE_URL}/networks/${chainIdDec}/estimateGas`;\n    }\n\n    case APIType.SUBMIT_TRANSACTIONS: {\n      return `${API_BASE_URL}/networks/${chainIdDec}/submitTransactions?stxControllerVersion=${packageJson.version}`;\n    }\n\n    case APIType.CANCEL: {\n      return `${API_BASE_URL}/networks/${chainIdDec}/cancel`;\n    }\n\n    case APIType.BATCH_STATUS: {\n      return `${API_BASE_URL}/networks/${chainIdDec}/batchStatus`;\n    }\n\n    case APIType.LIVENESS: {\n      return `${SENTINEL_API_BASE_URL_MAP[chainIdDec]}/network`;\n    }\n\n    default: {\n      throw new Error(`Invalid APIType`); // It can never get here thanks to TypeScript.\n    }\n  }\n}\n\nexport const calculateStatus = (stxStatus: SmartTransactionsStatus) => {\n  if (isSmartTransactionStatusResolved(stxStatus)) {\n    return SmartTransactionStatuses.RESOLVED;\n  }\n  const cancellations = [\n    SmartTransactionCancellationReason.WOULD_REVERT,\n    SmartTransactionCancellationReason.TOO_CHEAP,\n    SmartTransactionCancellationReason.DEADLINE_MISSED,\n    SmartTransactionCancellationReason.INVALID_NONCE,\n    SmartTransactionCancellationReason.USER_CANCELLED,\n  ];\n  if (stxStatus?.minedTx === SmartTransactionMinedTx.NOT_MINED) {\n    if (\n      stxStatus.cancellationReason ===\n      SmartTransactionCancellationReason.NOT_CANCELLED\n    ) {\n      return SmartTransactionStatuses.PENDING;\n    }\n\n    const isCancellation =\n      cancellations.findIndex(\n        (cancellation) => cancellation === stxStatus.cancellationReason,\n      ) > -1;\n    if (stxStatus.cancellationReason && isCancellation) {\n      if (!stxStatus.isSettled) {\n        return SmartTransactionStatuses.PENDING;\n      }\n      return cancellationReasonToStatusMap[stxStatus.cancellationReason];\n    }\n  } else if (stxStatus?.minedTx === SmartTransactionMinedTx.SUCCESS) {\n    return SmartTransactionStatuses.SUCCESS;\n  } else if (stxStatus?.minedTx === SmartTransactionMinedTx.CANCELLED) {\n    return SmartTransactionStatuses.CANCELLED;\n  } else if (stxStatus?.minedTx === SmartTransactionMinedTx.REVERTED) {\n    return SmartTransactionStatuses.REVERTED;\n  } else if (stxStatus?.minedTx === SmartTransactionMinedTx.UNKNOWN) {\n    return SmartTransactionStatuses.UNKNOWN;\n  }\n  return SmartTransactionStatuses.UNKNOWN;\n};\n\n/**\n  Generates an array of history objects sense the previous state.\n  The object has the keys\n    op (the operation performed),\n    path (the key and if a nested object then each key will be separated with a `/`)\n    value\n  with the first entry having the note and a timestamp when the change took place\n  @param previousState - the previous state of the object\n  @param newState - the update object\n  @param [note] - a optional note for the state change\n  @returns\n*/\nexport function generateHistoryEntry(\n  previousState: any,\n  newState: any,\n  note: string,\n) {\n  const entry: any = jsonDiffer.compare(previousState, newState);\n  // Add a note to the first op, since it breaks if we append it to the entry\n  if (entry[0]) {\n    if (note) {\n      entry[0].note = note;\n    }\n\n    entry[0].timestamp = Date.now();\n  }\n  return entry;\n}\n\n/**\n  Recovers previous txMeta state obj\n  @returns\n*/\nexport function replayHistory(_shortHistory: any) {\n  const shortHistory = _.cloneDeep(_shortHistory);\n  return shortHistory.reduce(\n    (val: any, entry: any) => jsonDiffer.applyPatch(val, entry).newDocument,\n  );\n}\n\n/**\n * Snapshot {@code txMeta}\n * @param txMeta - the tx metadata object\n * @returns a deep clone without history\n */\nexport function snapshotFromTxMeta(txMeta: any) {\n  const shallow = { ...txMeta };\n  delete shallow.history;\n  return _.cloneDeep(shallow);\n}\n\n/**\n * Returns processing time for an STX in seconds.\n * @param smartTransactionSubmittedtime\n * @returns Processing time in seconds.\n */\nexport const getStxProcessingTime = (\n  smartTransactionSubmittedtime: number | undefined,\n): number | undefined => {\n  if (!smartTransactionSubmittedtime) {\n    return undefined;\n  }\n  return Math.round((Date.now() - smartTransactionSubmittedtime) / 1000);\n};\n\nexport const mapKeysToCamel = (\n  obj: Record<string, any>,\n): Record<string, any> => {\n  if (!_.isObject(obj)) {\n    return obj;\n  }\n  const mappedValues = _.mapValues(obj, (val: Record<string, any>) => {\n    if (_.isArray(val)) {\n      return val.map(mapKeysToCamel);\n    } else if (_.isObject(val)) {\n      return mapKeysToCamel(val);\n    }\n    return val;\n  });\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  return _.mapKeys(mappedValues, (value, key) => _.camelCase(key));\n};\n\nexport async function handleFetch(request: string, options?: RequestInit) {\n  const response = await fetch(request, options);\n  const json = await response.json();\n  if (!response.ok) {\n    console.log(`response`, response);\n    throw new Error(\n      `Fetch error:${JSON.stringify({\n        status: response.status,\n        ...mapKeysToCamel(json),\n      })}`,\n    );\n  }\n  return json;\n}\n\nexport const isSmartTransactionCancellable = (\n  stxStatus: SmartTransactionsStatus,\n): boolean => {\n  return (\n    stxStatus.minedTx === SmartTransactionMinedTx.NOT_MINED &&\n    (!stxStatus.cancellationReason ||\n      stxStatus.cancellationReason ===\n        SmartTransactionCancellationReason.NOT_CANCELLED)\n  );\n};\n\nexport const incrementNonceInHex = (nonceInHex: string): string => {\n  const nonceInDec = new BigNumber(nonceInHex, 16).toString(10);\n  return hexlify(Number(nonceInDec) + 1);\n};\n\nconst isType4Transaction = (signedTxHex: string) => {\n  return typeof signedTxHex === 'string' && signedTxHex.startsWith('0x04');\n};\n\nexport const getTxHash = (signedTxHex: any) => {\n  if (!signedTxHex) {\n    return '';\n  }\n  try {\n    const parsed = parse(signedTxHex);\n    return parsed?.hash ?? '';\n  } catch (error) {\n    if (isType4Transaction(signedTxHex)) {\n      return hexlify(keccak256(arrayify(signedTxHex)));\n    }\n    throw error;\n  }\n};\n\nexport const getSmartTransactionMetricsProperties = (\n  smartTransaction: SmartTransaction,\n) => {\n  if (!smartTransaction) {\n    return {};\n  }\n  const smartTransactionStatusMetadata = smartTransaction.statusMetadata;\n  return {\n    stx_status: smartTransaction.status,\n    type: smartTransaction.type,\n    processing_time: getStxProcessingTime(smartTransaction.time),\n    is_smart_transaction: true,\n    stx_enabled: true,\n    current_stx_enabled: true,\n    stx_user_opt_in: true,\n    stx_duplicated: smartTransactionStatusMetadata?.duplicated,\n    stx_timed_out: smartTransactionStatusMetadata?.timedOut,\n    stx_proxied: smartTransactionStatusMetadata?.proxied,\n  };\n};\n\nexport const getSmartTransactionMetricsSensitiveProperties = (\n  smartTransaction: SmartTransaction,\n) => {\n  if (!smartTransaction) {\n    return {};\n  }\n  return {\n    token_from_symbol: smartTransaction.sourceTokenSymbol,\n    token_to_symbol: smartTransaction.destinationTokenSymbol,\n    account_hardware_type: smartTransaction.accountHardwareType,\n    account_type: smartTransaction.accountType,\n    device_model: smartTransaction.deviceModel,\n  };\n};\n\nexport const getReturnTxHashAsap = (\n  clientId: ClientId,\n  smartTransactionsFeatureFlags: FeatureFlags['smartTransactions'],\n) => {\n  return clientId === ClientId.Extension\n    ? smartTransactionsFeatureFlags?.extensionReturnTxHashAsap\n    : smartTransactionsFeatureFlags?.mobileReturnTxHashAsap;\n};\n\nexport const shouldMarkRegularTransactionAsFailed = ({\n  smartTransaction,\n  clientId,\n  getFeatureFlags,\n}: {\n  smartTransaction: SmartTransaction;\n  clientId: ClientId;\n  getFeatureFlags: () => FeatureFlags;\n}): boolean => {\n  const { status, transactionId } = smartTransaction;\n  const failureStatuses: SmartTransactionStatuses[] = [\n    SmartTransactionStatuses.CANCELLED,\n    SmartTransactionStatuses.CANCELLED_USER_CANCELLED,\n    SmartTransactionStatuses.UNKNOWN,\n    SmartTransactionStatuses.RESOLVED,\n  ];\n  if (\n    !status ||\n    !failureStatuses.includes(status as SmartTransactionStatuses)\n  ) {\n    return false;\n  }\n  const { smartTransactions: smartTransactionsFeatureFlags } =\n    getFeatureFlags() ?? {};\n  const returnTxHashAsapEnabled = getReturnTxHashAsap(\n    clientId,\n    smartTransactionsFeatureFlags,\n  );\n  return Boolean(returnTxHashAsapEnabled && transactionId);\n};\n\nexport const markRegularTransactionAsFailed = ({\n  smartTransaction,\n  getRegularTransactions,\n  updateTransaction,\n}: {\n  smartTransaction: SmartTransaction;\n  getRegularTransactions: TransactionControllerGetTransactionsAction['handler'];\n  updateTransaction: TransactionControllerUpdateTransactionAction['handler'];\n}) => {\n  const { transactionId, status } = smartTransaction;\n  const originalTransaction = getRegularTransactions().find(\n    (transaction) => transaction.id === transactionId,\n  );\n  if (!originalTransaction) {\n    throw new Error('Cannot find regular transaction to mark it as failed');\n  }\n  if (originalTransaction.status === TransactionStatus.failed) {\n    return; // Already marked as failed.\n  }\n  const updatedTransaction: TransactionMeta = {\n    ...originalTransaction,\n    status: TransactionStatus.failed,\n    error: {\n      name: 'SmartTransactionFailed',\n      message: `Smart transaction failed with status: ${status}`,\n    },\n  };\n  updateTransaction(updatedTransaction, `Smart transaction status: ${status}`);\n};\n"]}

package/package.json

@@ -1,28 +1,41 @@
 {
   "name": "@metamask/smart-transactions-controller",
-  "version": "18.1.0",
+  "version": "19.0.0",
   "description": "Improves success rates for swaps by trialing transactions privately and finding minimum fees",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/smart-transactions-controller.git"
   },
   "license": "SEE LICENSE IN LICENSE",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
   "files": [
-    "dist/"
+    "dist"
   ],
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
-    "build:clean": "rm -rf dist && yarn build",
-    "build:link": "yarn build && cd dist && yarn link && rm -rf node_modules && cd ..",
+    "build": "ts-bridge --project tsconfig.build.json --clean",
     "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog",
     "lint:changelog": "auto-changelog validate --prettier",
     "lint:eslint": "eslint . --cache --ext js,ts",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write && yarn lint:changelog",
     "lint:misc": "prettier '**/*.json' '**/*.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "prepack": "./scripts/prepack.sh",
-    "test": "jest",
+    "test": "jest && attw --pack",
     "test:watch": "jest --watchAll"
   },
   "dependencies": {
@@ -32,16 +45,17 @@
     "@ethersproject/bytes": "^5.7.0",
     "@ethersproject/keccak256": "^5.8.0",
     "@ethersproject/transactions": "^5.7.0",
-    "@metamask/base-controller": "^7.0.1",
+    "@metamask/base-controller": "^8.3.0",
     "@metamask/controller-utils": "^11.0.0",
     "@metamask/eth-json-rpc-provider": "^4.1.6",
     "@metamask/eth-query": "^4.0.0",
-    "@metamask/polling-controller": "^12.0.0",
+    "@metamask/polling-controller": "^14.0.0",
     "bignumber.js": "^9.0.1",
     "fast-json-patch": "^3.1.0",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
     "@lavamoat/allow-scripts": "^3.2.1",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.1.0",
@@ -52,7 +66,8 @@
     "@metamask/gas-fee-controller": "^22.0.0",
     "@metamask/json-rpc-engine": "^10.0.1",
     "@metamask/network-controller": "^24.0.0",
-    "@metamask/transaction-controller": "^42.0.0",
+    "@metamask/transaction-controller": "^60.4.0",
+    "@ts-bridge/cli": "^0.6.3",
     "@types/jest": "^26.0.24",
     "@types/lodash": "^4.14.194",
     "@types/node": "^18.19.17",
@@ -78,7 +93,7 @@
   },
   "peerDependencies": {
     "@metamask/network-controller": "^24.0.0",
-    "@metamask/transaction-controller": "^42.0.0"
+    "@metamask/transaction-controller": "^60.4.0"
   },
   "peerDependenciesMeta": {
     "@metamask/accounts-controller": {
@@ -86,6 +101,15 @@
     },
     "@metamask/approval-controller": {
       "optional": true
+    },
+    "@metamask/eth-block-tracker": {
+      "optional": true
+    },
+    "@metamask/gas-fee-controller": {
+      "optional": true
+    },
+    "@metamask/remote-feature-flag-controller": {
+      "optional": true
     }
   },
   "packageManager": "yarn@3.2.1",
@@ -101,9 +125,7 @@
       "@lavamoat/preinstall-always-fail": false,
       "@metamask/controller-utils>ethereumjs-util>ethereum-cryptography>keccak": false,
       "@metamask/controller-utils>ethereumjs-util>ethereum-cryptography>secp256k1": false,
-      "@metamask/controller-utils>babel-runtime>core-js": false,
-      "@metamask/transaction-controller>@metamask/accounts-controller>@metamask/keyring-controller>ethereumjs-wallet>ethereum-cryptography>keccak": false,
-      "@metamask/transaction-controller>@metamask/accounts-controller>@metamask/keyring-controller>ethereumjs-wallet>ethereum-cryptography>secp256k1": false
+      "@metamask/controller-utils>babel-runtime>core-js": false
     }
   }
 }