@metamask/transaction-pay-controller 1.0.0

package/dist/utils/totals.mjs

@@ -0,0 +1,65 @@
+import { BigNumber } from "bignumber.js";
+/**
+ * Calculate totals for a list of quotes and tokens.
+ *
+ * @param quotes - List of bridge quotes.
+ * @param tokens - List of required transaction tokens.
+ * @param _messenger - Controller messenger.
+ * @returns The calculated totals in USD and fiat currency.
+ */
+export function calculateTotals(quotes, tokens, _messenger) {
+    const providerFeeFiat = sumProperty(quotes, (quote) => quote.fees.provider.fiat);
+    const providerFeeUsd = sumProperty(quotes, (quote) => quote.fees.provider.usd);
+    const sourceNetworkFeeFiat = sumProperty(quotes, (quote) => quote.fees.sourceNetwork.fiat);
+    const sourceNetworkFeeUsd = sumProperty(quotes, (quote) => quote.fees.sourceNetwork.usd);
+    const targetNetworkFeeFiat = sumProperty(quotes, (quote) => quote.fees.targetNetwork.fiat);
+    const targetNetworkFeeUsd = sumProperty(quotes, (quote) => quote.fees.targetNetwork.usd);
+    const amountFiat = sumProperty(tokens, (token) => token.amountFiat);
+    const amountUsd = sumProperty(tokens, (token) => token.amountUsd);
+    const totalFiat = new BigNumber(providerFeeFiat)
+        .plus(sourceNetworkFeeFiat)
+        .plus(targetNetworkFeeFiat)
+        .plus(amountFiat)
+        .toString(10);
+    const totalUsd = new BigNumber(providerFeeUsd)
+        .plus(sourceNetworkFeeUsd)
+        .plus(targetNetworkFeeUsd)
+        .plus(amountUsd)
+        .toString(10);
+    const estimatedDuration = Number(sumProperty(quotes, (quote) => quote.estimatedDuration));
+    return {
+        estimatedDuration,
+        fees: {
+            provider: {
+                fiat: providerFeeFiat,
+                usd: providerFeeUsd,
+            },
+            sourceNetwork: {
+                fiat: sourceNetworkFeeFiat,
+                usd: sourceNetworkFeeUsd,
+            },
+            targetNetwork: {
+                fiat: targetNetworkFeeFiat,
+                usd: targetNetworkFeeUsd,
+            },
+        },
+        total: {
+            fiat: totalFiat,
+            usd: totalUsd,
+        },
+    };
+}
+/**
+ * Sum a specific property from a list of items.
+ *
+ * @param data - List of items.
+ * @param getProperty - Function to extract the property to sum from each item.
+ * @returns The summed value as a string.
+ */
+function sumProperty(data, getProperty) {
+    return data
+        .map(getProperty)
+        .reduce((total, value) => total.plus(value), new BigNumber(0))
+        .toString(10);
+}
+//# sourceMappingURL=totals.mjs.map

package/dist/utils/totals.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"totals.mjs","sourceRoot":"","sources":["../../src/utils/totals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,qBAAqB;AASzC;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAsC,EACtC,MAAqC,EACrC,UAA6C;IAE7C,MAAM,eAAe,GAAG,WAAW,CACjC,MAAM,EACN,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CACpC,CAAC;IAEF,MAAM,cAAc,GAAG,WAAW,CAChC,MAAM,EACN,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CACnC,CAAC;IAEF,MAAM,oBAAoB,GAAG,WAAW,CACtC,MAAM,EACN,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CACzC,CAAC;IAEF,MAAM,mBAAmB,GAAG,WAAW,CACrC,MAAM,EACN,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CACxC,CAAC;IAEF,MAAM,oBAAoB,GAAG,WAAW,CACtC,MAAM,EACN,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CACzC,CAAC;IAEF,MAAM,mBAAmB,GAAG,WAAW,CACrC,MAAM,EACN,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CACxC,CAAC;IAEF,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAElE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,eAAe,CAAC;SAC7C,IAAI,CAAC,oBAAoB,CAAC;SAC1B,IAAI,CAAC,oBAAoB,CAAC;SAC1B,IAAI,CAAC,UAAU,CAAC;SAChB,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEhB,MAAM,QAAQ,GAAG,IAAI,SAAS,CAAC,cAAc,CAAC;SAC3C,IAAI,CAAC,mBAAmB,CAAC;SACzB,IAAI,CAAC,mBAAmB,CAAC;SACzB,IAAI,CAAC,SAAS,CAAC;SACf,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEhB,MAAM,iBAAiB,GAAG,MAAM,CAC9B,WAAW,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CACxD,CAAC;IAEF,OAAO;QACL,iBAAiB;QACjB,IAAI,EAAE;YACJ,QAAQ,EAAE;gBACR,IAAI,EAAE,eAAe;gBACrB,GAAG,EAAE,cAAc;aACpB;YACD,aAAa,EAAE;gBACb,IAAI,EAAE,oBAAoB;gBAC1B,GAAG,EAAE,mBAAmB;aACzB;YACD,aAAa,EAAE;gBACb,IAAI,EAAE,oBAAoB;gBAC1B,GAAG,EAAE,mBAAmB;aACzB;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,SAAS;YACf,GAAG,EAAE,QAAQ;SACd;KACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAClB,IAAS,EACT,WAAyC;IAEzC,OAAO,IAAI;SACR,GAAG,CAAC,WAAW,CAAC;SAChB,MAAM,CAAY,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;SACxE,QAAQ,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC","sourcesContent":["import { BigNumber } from 'bignumber.js';\n\nimport type {\n  TransactionPayControllerMessenger,\n  TransactionPayQuote,\n  TransactionPayRequiredToken,\n  TransactionPayTotals,\n} from '../types';\n\n/**\n * Calculate totals for a list of quotes and tokens.\n *\n * @param quotes - List of bridge quotes.\n * @param tokens - List of required transaction tokens.\n * @param _messenger - Controller messenger.\n * @returns The calculated totals in USD and fiat currency.\n */\nexport function calculateTotals(\n  quotes: TransactionPayQuote<unknown>[],\n  tokens: TransactionPayRequiredToken[],\n  _messenger: TransactionPayControllerMessenger,\n): TransactionPayTotals {\n  const providerFeeFiat = sumProperty(\n    quotes,\n    (quote) => quote.fees.provider.fiat,\n  );\n\n  const providerFeeUsd = sumProperty(\n    quotes,\n    (quote) => quote.fees.provider.usd,\n  );\n\n  const sourceNetworkFeeFiat = sumProperty(\n    quotes,\n    (quote) => quote.fees.sourceNetwork.fiat,\n  );\n\n  const sourceNetworkFeeUsd = sumProperty(\n    quotes,\n    (quote) => quote.fees.sourceNetwork.usd,\n  );\n\n  const targetNetworkFeeFiat = sumProperty(\n    quotes,\n    (quote) => quote.fees.targetNetwork.fiat,\n  );\n\n  const targetNetworkFeeUsd = sumProperty(\n    quotes,\n    (quote) => quote.fees.targetNetwork.usd,\n  );\n\n  const amountFiat = sumProperty(tokens, (token) => token.amountFiat);\n  const amountUsd = sumProperty(tokens, (token) => token.amountUsd);\n\n  const totalFiat = new BigNumber(providerFeeFiat)\n    .plus(sourceNetworkFeeFiat)\n    .plus(targetNetworkFeeFiat)\n    .plus(amountFiat)\n    .toString(10);\n\n  const totalUsd = new BigNumber(providerFeeUsd)\n    .plus(sourceNetworkFeeUsd)\n    .plus(targetNetworkFeeUsd)\n    .plus(amountUsd)\n    .toString(10);\n\n  const estimatedDuration = Number(\n    sumProperty(quotes, (quote) => quote.estimatedDuration),\n  );\n\n  return {\n    estimatedDuration,\n    fees: {\n      provider: {\n        fiat: providerFeeFiat,\n        usd: providerFeeUsd,\n      },\n      sourceNetwork: {\n        fiat: sourceNetworkFeeFiat,\n        usd: sourceNetworkFeeUsd,\n      },\n      targetNetwork: {\n        fiat: targetNetworkFeeFiat,\n        usd: targetNetworkFeeUsd,\n      },\n    },\n    total: {\n      fiat: totalFiat,\n      usd: totalUsd,\n    },\n  };\n}\n\n/**\n * Sum a specific property from a list of items.\n *\n * @param data - List of items.\n * @param getProperty - Function to extract the property to sum from each item.\n * @returns The summed value as a string.\n */\nfunction sumProperty<T>(\n  data: T[],\n  getProperty: (item: T) => BigNumber.Value,\n): string {\n  return data\n    .map(getProperty)\n    .reduce<BigNumber>((total, value) => total.plus(value), new BigNumber(0))\n    .toString(10);\n}\n"]}

package/dist/utils/transaction.cjs

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateTransaction = exports.waitForTransactionConfirmed = exports.pollTransactionChanges = exports.getTransaction = exports.FINALIZED_STATUSES = void 0;
+const transaction_controller_1 = require("@metamask/transaction-controller");
+const utils_1 = require("@metamask/utils");
+const lodash_1 = require("lodash");
+const required_tokens_1 = require("./required-tokens.cjs");
+const logger_1 = require("../logger.cjs");
+const log = (0, utils_1.createModuleLogger)(logger_1.projectLogger, 'transaction');
+exports.FINALIZED_STATUSES = [
+    transaction_controller_1.TransactionStatus.confirmed,
+    transaction_controller_1.TransactionStatus.dropped,
+    transaction_controller_1.TransactionStatus.failed,
+];
+/**
+ * Retrieve transaction metadata by ID.
+ *
+ * @param transactionId - ID of the transaction to retrieve.
+ * @param messenger - Controller messenger.
+ * @returns The transaction metadata or undefined if not found.
+ */
+function getTransaction(transactionId, messenger) {
+    const transactionControllerState = messenger.call('TransactionController:getState');
+    return transactionControllerState.transactions.find((tx) => tx.id === transactionId);
+}
+exports.getTransaction = getTransaction;
+/**
+ * Poll for transaction changes and update the transaction data accordingly.
+ *
+ * @param messenger - Controller messenger.
+ * @param updateTransactionData - Callback to update transaction data.
+ * @param removeTransactionData - Callback to remove transaction data.
+ */
+function pollTransactionChanges(messenger, updateTransactionData, removeTransactionData) {
+    messenger.subscribe('TransactionController:stateChange', (transactions, previousTransactions) => {
+        const newTransactions = transactions.filter((tx) => !previousTransactions?.find((prevTx) => prevTx.id === tx.id));
+        const updatedTransactions = transactions.filter((tx) => {
+            const previousTransaction = previousTransactions?.find((prevTx) => prevTx.id === tx.id);
+            return (previousTransaction &&
+                previousTransaction?.txParams.data !== tx.txParams.data);
+        });
+        const finalizedTransactions = transactions.filter((tx) => {
+            const previousTransaction = previousTransactions?.find((prevTx) => prevTx.id === tx.id);
+            return (previousTransaction &&
+                !exports.FINALIZED_STATUSES.includes(previousTransaction.status) &&
+                exports.FINALIZED_STATUSES.includes(tx.status));
+        });
+        finalizedTransactions.forEach((tx) => onTransactionFinalized(tx, removeTransactionData));
+        [...newTransactions, ...updatedTransactions].forEach((tx) => onTransactionChange(tx, messenger, updateTransactionData));
+    }, (state) => state.transactions);
+}
+exports.pollTransactionChanges = pollTransactionChanges;
+/**
+ * Wait for a transaction to be confirmed or fail.
+ *
+ * @param transactionId - ID of the transaction to wait for.
+ * @param messenger - Controller messenger.
+ * @returns A promise that resolves when the transaction is confirmed or rejects if it fails.
+ */
+function waitForTransactionConfirmed(transactionId, messenger) {
+    return new Promise((resolve, reject) => {
+        const isConfirmed = (tx, fn) => {
+            log('Checking transaction status', tx?.status, tx?.type);
+            if (tx?.status === transaction_controller_1.TransactionStatus.confirmed) {
+                fn?.();
+                resolve();
+                return true;
+            }
+            if ([transaction_controller_1.TransactionStatus.dropped, transaction_controller_1.TransactionStatus.failed].includes(tx?.status)) {
+                fn?.();
+                reject(new Error(`Transaction failed - ${tx?.type} - ${tx?.error?.message}`));
+                return true;
+            }
+            return false;
+        };
+        const initialState = messenger.call('TransactionController:getState');
+        const initialTx = initialState.transactions.find((t) => t.id === transactionId);
+        if (isConfirmed(initialTx)) {
+            return;
+        }
+        const handler = (tx) => {
+            const unsubscribe = () => messenger.unsubscribe('TransactionController:stateChange', handler);
+            isConfirmed(tx, unsubscribe);
+        };
+        messenger.subscribe('TransactionController:stateChange', handler, (state) => state.transactions.find((tx) => tx.id === transactionId));
+    });
+}
+exports.waitForTransactionConfirmed = waitForTransactionConfirmed;
+/**
+ * Update a transaction by applying a function to its draft.
+ *
+ * @param request - Request object.
+ * @param request.transactionId - ID of the transaction to update.
+ * @param request.messenger - Controller messenger.
+ * @param request.note - Note describing the update.
+ * @param fn - Function that applies updates to the transaction draft.
+ */
+function updateTransaction({ transactionId, messenger, note, }, fn) {
+    const transaction = getTransaction(transactionId, messenger);
+    if (!transaction) {
+        throw new Error(`Transaction not found: ${transactionId}`);
+    }
+    const newTransaction = (0, lodash_1.cloneDeep)(transaction);
+    fn(newTransaction);
+    messenger.call('TransactionController:updateTransaction', newTransaction, note);
+}
+exports.updateTransaction = updateTransaction;
+/**
+ * Handle a transaction change by updating its associated data.
+ *
+ * @param transaction - Transaction metadata.
+ * @param messenger - Controller messenger.
+ * @param updateTransactionData - Callback to update transaction data.
+ */
+function onTransactionChange(transaction, messenger, updateTransactionData) {
+    const tokens = (0, required_tokens_1.parseRequiredTokens)(transaction, messenger);
+    log('Transaction changed', { transaction, tokens });
+    updateTransactionData(transaction.id, (data) => {
+        data.tokens = tokens;
+    });
+}
+/**
+ * Handle a finalized transaction by removing its associated data.
+ *
+ * @param transaction - Transaction metadata.
+ * @param removeTransactionData - Callback to remove transaction data.
+ */
+function onTransactionFinalized(transaction, removeTransactionData) {
+    log('Transaction finalized', { transaction });
+    removeTransactionData(transaction.id);
+}
+//# sourceMappingURL=transaction.cjs.map

package/dist/utils/transaction.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.cjs","sourceRoot":"","sources":["../../src/utils/transaction.ts"],"names":[],"mappings":";;;AAAA,6EAG0C;AAC1C,2CAAqD;AACrD,mCAAmC;AAEnC,2DAAwD;AACxD,0CAA0C;AAM1C,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,sBAAa,EAAE,aAAa,CAAC,CAAC;AAEhD,QAAA,kBAAkB,GAAG;IAChC,0CAAiB,CAAC,SAAS;IAC3B,0CAAiB,CAAC,OAAO;IACzB,0CAAiB,CAAC,MAAM;CACzB,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,cAAc,CAC5B,aAAqB,EACrB,SAA4C;IAE5C,MAAM,0BAA0B,GAAG,SAAS,CAAC,IAAI,CAC/C,gCAAgC,CACjC,CAAC;IAEF,OAAO,0BAA0B,CAAC,YAAY,CAAC,IAAI,CACjD,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,aAAa,CAChC,CAAC;AACJ,CAAC;AAXD,wCAWC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CACpC,SAA4C,EAC5C,qBAAoD,EACpD,qBAAsD;IAEtD,SAAS,CAAC,SAAS,CACjB,mCAAmC,EACnC,CACE,YAA+B,EAC/B,oBAAmD,EACnD,EAAE;QACF,MAAM,eAAe,GAAG,YAAY,CAAC,MAAM,CACzC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CACrE,CAAC;QAEF,MAAM,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;YACrD,MAAM,mBAAmB,GAAG,oBAAoB,EAAE,IAAI,CACpD,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAChC,CAAC;YAEF,OAAO,CACL,mBAAmB;gBACnB,mBAAmB,EAAE,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,QAAQ,CAAC,IAAI,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,qBAAqB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;YACvD,MAAM,mBAAmB,GAAG,oBAAoB,EAAE,IAAI,CACpD,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAChC,CAAC;YAEF,OAAO,CACL,mBAAmB;gBACnB,CAAC,0BAAkB,CAAC,QAAQ,CAAC,mBAAmB,CAAC,MAAM,CAAC;gBACxD,0BAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CACvC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,qBAAqB,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CACnC,sBAAsB,CAAC,EAAE,EAAE,qBAAqB,CAAC,CAClD,CAAC;QAEF,CAAC,GAAG,eAAe,EAAE,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAC1D,mBAAmB,CAAC,EAAE,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAC1D,CAAC;IACJ,CAAC,EACD,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;AACJ,CAAC;AAhDD,wDAgDC;AAED;;;;;;GAMG;AACH,SAAgB,2BAA2B,CACzC,aAAqB,EACrB,SAA4C;IAE5C,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,WAAW,GAAG,CAAC,EAAoB,EAAE,EAAe,EAAE,EAAE;YAC5D,GAAG,CAAC,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;YAEzD,IAAI,EAAE,EAAE,MAAM,KAAK,0CAAiB,CAAC,SAAS,EAAE;gBAC9C,EAAE,EAAE,EAAE,CAAC;gBACP,OAAO,EAAE,CAAC;gBACV,OAAO,IAAI,CAAC;aACb;YAED,IACE,CAAC,0CAAiB,CAAC,OAAO,EAAE,0CAAiB,CAAC,MAAM,CAAC,CAAC,QAAQ,CAC5D,EAAE,EAAE,MAA2B,CAChC,EACD;gBACA,EAAE,EAAE,EAAE,CAAC;gBACP,MAAM,CACJ,IAAI,KAAK,CAAC,wBAAwB,EAAE,EAAE,IAAI,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CACtE,CAAC;gBACF,OAAO,IAAI,CAAC;aACb;YAED,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAEtE,MAAM,SAAS,GAAG,YAAY,CAAC,YAAY,CAAC,IAAI,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,aAAa,CAC9B,CAAC;QAEF,IAAI,WAAW,CAAC,SAAS,CAAC,EAAE;YAC1B,OAAO;SACR;QAED,MAAM,OAAO,GAAG,CAAC,EAAoB,EAAE,EAAE;YACvC,MAAM,WAAW,GAAG,GAAG,EAAE,CACvB,SAAS,CAAC,WAAW,CAAC,mCAAmC,EAAE,OAAO,CAAC,CAAC;YAEtE,WAAW,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,SAAS,CAAC,SAAS,CAAC,mCAAmC,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAC1E,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,aAAa,CAAC,CACzD,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAlDD,kEAkDC;AAED;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAC/B,EACE,aAAa,EACb,SAAS,EACT,IAAI,GAKL,EACD,EAAoC;IAEpC,MAAM,WAAW,GAAG,cAAc,CAAC,aAAa,EAAE,SAAkB,CAAC,CAAC;IAEtE,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,0BAA0B,aAAa,EAAE,CAAC,CAAC;KAC5D;IAED,MAAM,cAAc,GAAG,IAAA,kBAAS,EAAC,WAAW,CAAC,CAAC;IAE9C,EAAE,CAAC,cAAc,CAAC,CAAC;IAEnB,SAAS,CAAC,IAAI,CACZ,yCAAyC,EACzC,cAAc,EACd,IAAI,CACL,CAAC;AACJ,CAAC;AA3BD,8CA2BC;AAED;;;;;;GAMG;AACH,SAAS,mBAAmB,CAC1B,WAA4B,EAC5B,SAA4C,EAC5C,qBAAoD;IAEpD,MAAM,MAAM,GAAG,IAAA,qCAAmB,EAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAE3D,GAAG,CAAC,qBAAqB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;IAEpD,qBAAqB,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,sBAAsB,CAC7B,WAA4B,EAC5B,qBAAsD;IAEtD,GAAG,CAAC,uBAAuB,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC9C,qBAAqB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;AACxC,CAAC","sourcesContent":["import {\n  TransactionStatus,\n  type TransactionMeta,\n} from '@metamask/transaction-controller';\nimport { createModuleLogger } from '@metamask/utils';\nimport { cloneDeep } from 'lodash';\n\nimport { parseRequiredTokens } from './required-tokens';\nimport { projectLogger } from '../logger';\nimport type {\n  TransactionPayControllerMessenger,\n  UpdateTransactionDataCallback,\n} from '../types';\n\nconst log = createModuleLogger(projectLogger, 'transaction');\n\nexport const FINALIZED_STATUSES = [\n  TransactionStatus.confirmed,\n  TransactionStatus.dropped,\n  TransactionStatus.failed,\n];\n\n/**\n * Retrieve transaction metadata by ID.\n *\n * @param transactionId - ID of the transaction to retrieve.\n * @param messenger - Controller messenger.\n * @returns The transaction metadata or undefined if not found.\n */\nexport function getTransaction(\n  transactionId: string,\n  messenger: TransactionPayControllerMessenger,\n): TransactionMeta | undefined {\n  const transactionControllerState = messenger.call(\n    'TransactionController:getState',\n  );\n\n  return transactionControllerState.transactions.find(\n    (tx) => tx.id === transactionId,\n  );\n}\n\n/**\n * Poll for transaction changes and update the transaction data accordingly.\n *\n * @param messenger - Controller messenger.\n * @param updateTransactionData - Callback to update transaction data.\n * @param removeTransactionData - Callback to remove transaction data.\n */\nexport function pollTransactionChanges(\n  messenger: TransactionPayControllerMessenger,\n  updateTransactionData: UpdateTransactionDataCallback,\n  removeTransactionData: (transactionId: string) => void,\n) {\n  messenger.subscribe(\n    'TransactionController:stateChange',\n    (\n      transactions: TransactionMeta[],\n      previousTransactions: TransactionMeta[] | undefined,\n    ) => {\n      const newTransactions = transactions.filter(\n        (tx) => !previousTransactions?.find((prevTx) => prevTx.id === tx.id),\n      );\n\n      const updatedTransactions = transactions.filter((tx) => {\n        const previousTransaction = previousTransactions?.find(\n          (prevTx) => prevTx.id === tx.id,\n        );\n\n        return (\n          previousTransaction &&\n          previousTransaction?.txParams.data !== tx.txParams.data\n        );\n      });\n\n      const finalizedTransactions = transactions.filter((tx) => {\n        const previousTransaction = previousTransactions?.find(\n          (prevTx) => prevTx.id === tx.id,\n        );\n\n        return (\n          previousTransaction &&\n          !FINALIZED_STATUSES.includes(previousTransaction.status) &&\n          FINALIZED_STATUSES.includes(tx.status)\n        );\n      });\n\n      finalizedTransactions.forEach((tx) =>\n        onTransactionFinalized(tx, removeTransactionData),\n      );\n\n      [...newTransactions, ...updatedTransactions].forEach((tx) =>\n        onTransactionChange(tx, messenger, updateTransactionData),\n      );\n    },\n    (state) => state.transactions,\n  );\n}\n\n/**\n * Wait for a transaction to be confirmed or fail.\n *\n * @param transactionId - ID of the transaction to wait for.\n * @param messenger - Controller messenger.\n * @returns A promise that resolves when the transaction is confirmed or rejects if it fails.\n */\nexport function waitForTransactionConfirmed(\n  transactionId: string,\n  messenger: TransactionPayControllerMessenger,\n) {\n  return new Promise<void>((resolve, reject) => {\n    const isConfirmed = (tx?: TransactionMeta, fn?: () => void) => {\n      log('Checking transaction status', tx?.status, tx?.type);\n\n      if (tx?.status === TransactionStatus.confirmed) {\n        fn?.();\n        resolve();\n        return true;\n      }\n\n      if (\n        [TransactionStatus.dropped, TransactionStatus.failed].includes(\n          tx?.status as TransactionStatus,\n        )\n      ) {\n        fn?.();\n        reject(\n          new Error(`Transaction failed - ${tx?.type} - ${tx?.error?.message}`),\n        );\n        return true;\n      }\n\n      return false;\n    };\n\n    const initialState = messenger.call('TransactionController:getState');\n\n    const initialTx = initialState.transactions.find(\n      (t) => t.id === transactionId,\n    );\n\n    if (isConfirmed(initialTx)) {\n      return;\n    }\n\n    const handler = (tx?: TransactionMeta) => {\n      const unsubscribe = () =>\n        messenger.unsubscribe('TransactionController:stateChange', handler);\n\n      isConfirmed(tx, unsubscribe);\n    };\n\n    messenger.subscribe('TransactionController:stateChange', handler, (state) =>\n      state.transactions.find((tx) => tx.id === transactionId),\n    );\n  });\n}\n\n/**\n * Update a transaction by applying a function to its draft.\n *\n * @param request - Request object.\n * @param request.transactionId - ID of the transaction to update.\n * @param request.messenger - Controller messenger.\n * @param request.note - Note describing the update.\n * @param fn - Function that applies updates to the transaction draft.\n */\nexport function updateTransaction(\n  {\n    transactionId,\n    messenger,\n    note,\n  }: {\n    transactionId: string;\n    messenger: TransactionPayControllerMessenger;\n    note: string;\n  },\n  fn: (draft: TransactionMeta) => void,\n) {\n  const transaction = getTransaction(transactionId, messenger as never);\n\n  if (!transaction) {\n    throw new Error(`Transaction not found: ${transactionId}`);\n  }\n\n  const newTransaction = cloneDeep(transaction);\n\n  fn(newTransaction);\n\n  messenger.call(\n    'TransactionController:updateTransaction',\n    newTransaction,\n    note,\n  );\n}\n\n/**\n * Handle a transaction change by updating its associated data.\n *\n * @param transaction - Transaction metadata.\n * @param messenger - Controller messenger.\n * @param updateTransactionData - Callback to update transaction data.\n */\nfunction onTransactionChange(\n  transaction: TransactionMeta,\n  messenger: TransactionPayControllerMessenger,\n  updateTransactionData: UpdateTransactionDataCallback,\n) {\n  const tokens = parseRequiredTokens(transaction, messenger);\n\n  log('Transaction changed', { transaction, tokens });\n\n  updateTransactionData(transaction.id, (data) => {\n    data.tokens = tokens;\n  });\n}\n\n/**\n * Handle a finalized transaction by removing its associated data.\n *\n * @param transaction - Transaction metadata.\n * @param removeTransactionData - Callback to remove transaction data.\n */\nfunction onTransactionFinalized(\n  transaction: TransactionMeta,\n  removeTransactionData: (transactionId: string) => void,\n) {\n  log('Transaction finalized', { transaction });\n  removeTransactionData(transaction.id);\n}\n"]}

package/dist/utils/transaction.d.cts

@@ -0,0 +1,42 @@
+import { TransactionStatus, type TransactionMeta } from "@metamask/transaction-controller";
+import type { TransactionPayControllerMessenger, UpdateTransactionDataCallback } from "../types.cjs";
+export declare const FINALIZED_STATUSES: TransactionStatus[];
+/**
+ * Retrieve transaction metadata by ID.
+ *
+ * @param transactionId - ID of the transaction to retrieve.
+ * @param messenger - Controller messenger.
+ * @returns The transaction metadata or undefined if not found.
+ */
+export declare function getTransaction(transactionId: string, messenger: TransactionPayControllerMessenger): TransactionMeta | undefined;
+/**
+ * Poll for transaction changes and update the transaction data accordingly.
+ *
+ * @param messenger - Controller messenger.
+ * @param updateTransactionData - Callback to update transaction data.
+ * @param removeTransactionData - Callback to remove transaction data.
+ */
+export declare function pollTransactionChanges(messenger: TransactionPayControllerMessenger, updateTransactionData: UpdateTransactionDataCallback, removeTransactionData: (transactionId: string) => void): void;
+/**
+ * Wait for a transaction to be confirmed or fail.
+ *
+ * @param transactionId - ID of the transaction to wait for.
+ * @param messenger - Controller messenger.
+ * @returns A promise that resolves when the transaction is confirmed or rejects if it fails.
+ */
+export declare function waitForTransactionConfirmed(transactionId: string, messenger: TransactionPayControllerMessenger): Promise<void>;
+/**
+ * Update a transaction by applying a function to its draft.
+ *
+ * @param request - Request object.
+ * @param request.transactionId - ID of the transaction to update.
+ * @param request.messenger - Controller messenger.
+ * @param request.note - Note describing the update.
+ * @param fn - Function that applies updates to the transaction draft.
+ */
+export declare function updateTransaction({ transactionId, messenger, note, }: {
+    transactionId: string;
+    messenger: TransactionPayControllerMessenger;
+    note: string;
+}, fn: (draft: TransactionMeta) => void): void;
+//# sourceMappingURL=transaction.d.cts.map

package/dist/utils/transaction.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.cts","sourceRoot":"","sources":["../../src/utils/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,KAAK,eAAe,EACrB,yCAAyC;AAM1C,OAAO,KAAK,EACV,iCAAiC,EACjC,6BAA6B,EAC9B,qBAAiB;AAIlB,eAAO,MAAM,kBAAkB,qBAI9B,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,iCAAiC,GAC3C,eAAe,GAAG,SAAS,CAQ7B;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,iCAAiC,EAC5C,qBAAqB,EAAE,6BAA6B,EACpD,qBAAqB,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,IAAI,QA6CvD;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,iCAAiC,iBAgD7C;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,EACE,aAAa,EACb,SAAS,EACT,IAAI,GACL,EAAE;IACD,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,iCAAiC,CAAC;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd,EACD,EAAE,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,QAiBrC"}

package/dist/utils/transaction.d.mts

@@ -0,0 +1,42 @@
+import { TransactionStatus, type TransactionMeta } from "@metamask/transaction-controller";
+import type { TransactionPayControllerMessenger, UpdateTransactionDataCallback } from "../types.mjs";
+export declare const FINALIZED_STATUSES: TransactionStatus[];
+/**
+ * Retrieve transaction metadata by ID.
+ *
+ * @param transactionId - ID of the transaction to retrieve.
+ * @param messenger - Controller messenger.
+ * @returns The transaction metadata or undefined if not found.
+ */
+export declare function getTransaction(transactionId: string, messenger: TransactionPayControllerMessenger): TransactionMeta | undefined;
+/**
+ * Poll for transaction changes and update the transaction data accordingly.
+ *
+ * @param messenger - Controller messenger.
+ * @param updateTransactionData - Callback to update transaction data.
+ * @param removeTransactionData - Callback to remove transaction data.
+ */
+export declare function pollTransactionChanges(messenger: TransactionPayControllerMessenger, updateTransactionData: UpdateTransactionDataCallback, removeTransactionData: (transactionId: string) => void): void;
+/**
+ * Wait for a transaction to be confirmed or fail.
+ *
+ * @param transactionId - ID of the transaction to wait for.
+ * @param messenger - Controller messenger.
+ * @returns A promise that resolves when the transaction is confirmed or rejects if it fails.
+ */
+export declare function waitForTransactionConfirmed(transactionId: string, messenger: TransactionPayControllerMessenger): Promise<void>;
+/**
+ * Update a transaction by applying a function to its draft.
+ *
+ * @param request - Request object.
+ * @param request.transactionId - ID of the transaction to update.
+ * @param request.messenger - Controller messenger.
+ * @param request.note - Note describing the update.
+ * @param fn - Function that applies updates to the transaction draft.
+ */
+export declare function updateTransaction({ transactionId, messenger, note, }: {
+    transactionId: string;
+    messenger: TransactionPayControllerMessenger;
+    note: string;
+}, fn: (draft: TransactionMeta) => void): void;
+//# sourceMappingURL=transaction.d.mts.map

package/dist/utils/transaction.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.mts","sourceRoot":"","sources":["../../src/utils/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,KAAK,eAAe,EACrB,yCAAyC;AAM1C,OAAO,KAAK,EACV,iCAAiC,EACjC,6BAA6B,EAC9B,qBAAiB;AAIlB,eAAO,MAAM,kBAAkB,qBAI9B,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,iCAAiC,GAC3C,eAAe,GAAG,SAAS,CAQ7B;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,iCAAiC,EAC5C,qBAAqB,EAAE,6BAA6B,EACpD,qBAAqB,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,IAAI,QA6CvD;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,iCAAiC,iBAgD7C;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,EACE,aAAa,EACb,SAAS,EACT,IAAI,GACL,EAAE;IACD,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,iCAAiC,CAAC;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd,EACD,EAAE,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,QAiBrC"}

package/dist/utils/transaction.mjs

@@ -0,0 +1,126 @@
+import { TransactionStatus } from "@metamask/transaction-controller";
+import { createModuleLogger } from "@metamask/utils";
+import $lodash from "lodash";
+const { cloneDeep } = $lodash;
+import { parseRequiredTokens } from "./required-tokens.mjs";
+import { projectLogger } from "../logger.mjs";
+const log = createModuleLogger(projectLogger, 'transaction');
+export const FINALIZED_STATUSES = [
+    TransactionStatus.confirmed,
+    TransactionStatus.dropped,
+    TransactionStatus.failed,
+];
+/**
+ * Retrieve transaction metadata by ID.
+ *
+ * @param transactionId - ID of the transaction to retrieve.
+ * @param messenger - Controller messenger.
+ * @returns The transaction metadata or undefined if not found.
+ */
+export function getTransaction(transactionId, messenger) {
+    const transactionControllerState = messenger.call('TransactionController:getState');
+    return transactionControllerState.transactions.find((tx) => tx.id === transactionId);
+}
+/**
+ * Poll for transaction changes and update the transaction data accordingly.
+ *
+ * @param messenger - Controller messenger.
+ * @param updateTransactionData - Callback to update transaction data.
+ * @param removeTransactionData - Callback to remove transaction data.
+ */
+export function pollTransactionChanges(messenger, updateTransactionData, removeTransactionData) {
+    messenger.subscribe('TransactionController:stateChange', (transactions, previousTransactions) => {
+        const newTransactions = transactions.filter((tx) => !previousTransactions?.find((prevTx) => prevTx.id === tx.id));
+        const updatedTransactions = transactions.filter((tx) => {
+            const previousTransaction = previousTransactions?.find((prevTx) => prevTx.id === tx.id);
+            return (previousTransaction &&
+                previousTransaction?.txParams.data !== tx.txParams.data);
+        });
+        const finalizedTransactions = transactions.filter((tx) => {
+            const previousTransaction = previousTransactions?.find((prevTx) => prevTx.id === tx.id);
+            return (previousTransaction &&
+                !FINALIZED_STATUSES.includes(previousTransaction.status) &&
+                FINALIZED_STATUSES.includes(tx.status));
+        });
+        finalizedTransactions.forEach((tx) => onTransactionFinalized(tx, removeTransactionData));
+        [...newTransactions, ...updatedTransactions].forEach((tx) => onTransactionChange(tx, messenger, updateTransactionData));
+    }, (state) => state.transactions);
+}
+/**
+ * Wait for a transaction to be confirmed or fail.
+ *
+ * @param transactionId - ID of the transaction to wait for.
+ * @param messenger - Controller messenger.
+ * @returns A promise that resolves when the transaction is confirmed or rejects if it fails.
+ */
+export function waitForTransactionConfirmed(transactionId, messenger) {
+    return new Promise((resolve, reject) => {
+        const isConfirmed = (tx, fn) => {
+            log('Checking transaction status', tx?.status, tx?.type);
+            if (tx?.status === TransactionStatus.confirmed) {
+                fn?.();
+                resolve();
+                return true;
+            }
+            if ([TransactionStatus.dropped, TransactionStatus.failed].includes(tx?.status)) {
+                fn?.();
+                reject(new Error(`Transaction failed - ${tx?.type} - ${tx?.error?.message}`));
+                return true;
+            }
+            return false;
+        };
+        const initialState = messenger.call('TransactionController:getState');
+        const initialTx = initialState.transactions.find((t) => t.id === transactionId);
+        if (isConfirmed(initialTx)) {
+            return;
+        }
+        const handler = (tx) => {
+            const unsubscribe = () => messenger.unsubscribe('TransactionController:stateChange', handler);
+            isConfirmed(tx, unsubscribe);
+        };
+        messenger.subscribe('TransactionController:stateChange', handler, (state) => state.transactions.find((tx) => tx.id === transactionId));
+    });
+}
+/**
+ * Update a transaction by applying a function to its draft.
+ *
+ * @param request - Request object.
+ * @param request.transactionId - ID of the transaction to update.
+ * @param request.messenger - Controller messenger.
+ * @param request.note - Note describing the update.
+ * @param fn - Function that applies updates to the transaction draft.
+ */
+export function updateTransaction({ transactionId, messenger, note, }, fn) {
+    const transaction = getTransaction(transactionId, messenger);
+    if (!transaction) {
+        throw new Error(`Transaction not found: ${transactionId}`);
+    }
+    const newTransaction = cloneDeep(transaction);
+    fn(newTransaction);
+    messenger.call('TransactionController:updateTransaction', newTransaction, note);
+}
+/**
+ * Handle a transaction change by updating its associated data.
+ *
+ * @param transaction - Transaction metadata.
+ * @param messenger - Controller messenger.
+ * @param updateTransactionData - Callback to update transaction data.
+ */
+function onTransactionChange(transaction, messenger, updateTransactionData) {
+    const tokens = parseRequiredTokens(transaction, messenger);
+    log('Transaction changed', { transaction, tokens });
+    updateTransactionData(transaction.id, (data) => {
+        data.tokens = tokens;
+    });
+}
+/**
+ * Handle a finalized transaction by removing its associated data.
+ *
+ * @param transaction - Transaction metadata.
+ * @param removeTransactionData - Callback to remove transaction data.
+ */
+function onTransactionFinalized(transaction, removeTransactionData) {
+    log('Transaction finalized', { transaction });
+    removeTransactionData(transaction.id);
+}
+//# sourceMappingURL=transaction.mjs.map

package/dist/utils/transaction.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.mjs","sourceRoot":"","sources":["../../src/utils/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAElB,yCAAyC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;;;AAGrD,OAAO,EAAE,mBAAmB,EAAE,8BAA0B;AACxD,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAM1C,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAE7D,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,iBAAiB,CAAC,SAAS;IAC3B,iBAAiB,CAAC,OAAO;IACzB,iBAAiB,CAAC,MAAM;CACzB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC5B,aAAqB,EACrB,SAA4C;IAE5C,MAAM,0BAA0B,GAAG,SAAS,CAAC,IAAI,CAC/C,gCAAgC,CACjC,CAAC;IAEF,OAAO,0BAA0B,CAAC,YAAY,CAAC,IAAI,CACjD,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,aAAa,CAChC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,SAA4C,EAC5C,qBAAoD,EACpD,qBAAsD;IAEtD,SAAS,CAAC,SAAS,CACjB,mCAAmC,EACnC,CACE,YAA+B,EAC/B,oBAAmD,EACnD,EAAE;QACF,MAAM,eAAe,GAAG,YAAY,CAAC,MAAM,CACzC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CACrE,CAAC;QAEF,MAAM,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;YACrD,MAAM,mBAAmB,GAAG,oBAAoB,EAAE,IAAI,CACpD,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAChC,CAAC;YAEF,OAAO,CACL,mBAAmB;gBACnB,mBAAmB,EAAE,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,QAAQ,CAAC,IAAI,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,qBAAqB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;YACvD,MAAM,mBAAmB,GAAG,oBAAoB,EAAE,IAAI,CACpD,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAChC,CAAC;YAEF,OAAO,CACL,mBAAmB;gBACnB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,mBAAmB,CAAC,MAAM,CAAC;gBACxD,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CACvC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,qBAAqB,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CACnC,sBAAsB,CAAC,EAAE,EAAE,qBAAqB,CAAC,CAClD,CAAC;QAEF,CAAC,GAAG,eAAe,EAAE,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAC1D,mBAAmB,CAAC,EAAE,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAC1D,CAAC;IACJ,CAAC,EACD,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B,CACzC,aAAqB,EACrB,SAA4C;IAE5C,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,WAAW,GAAG,CAAC,EAAoB,EAAE,EAAe,EAAE,EAAE;YAC5D,GAAG,CAAC,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;YAEzD,IAAI,EAAE,EAAE,MAAM,KAAK,iBAAiB,CAAC,SAAS,EAAE;gBAC9C,EAAE,EAAE,EAAE,CAAC;gBACP,OAAO,EAAE,CAAC;gBACV,OAAO,IAAI,CAAC;aACb;YAED,IACE,CAAC,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,QAAQ,CAC5D,EAAE,EAAE,MAA2B,CAChC,EACD;gBACA,EAAE,EAAE,EAAE,CAAC;gBACP,MAAM,CACJ,IAAI,KAAK,CAAC,wBAAwB,EAAE,EAAE,IAAI,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CACtE,CAAC;gBACF,OAAO,IAAI,CAAC;aACb;YAED,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAEtE,MAAM,SAAS,GAAG,YAAY,CAAC,YAAY,CAAC,IAAI,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,aAAa,CAC9B,CAAC;QAEF,IAAI,WAAW,CAAC,SAAS,CAAC,EAAE;YAC1B,OAAO;SACR;QAED,MAAM,OAAO,GAAG,CAAC,EAAoB,EAAE,EAAE;YACvC,MAAM,WAAW,GAAG,GAAG,EAAE,CACvB,SAAS,CAAC,WAAW,CAAC,mCAAmC,EAAE,OAAO,CAAC,CAAC;YAEtE,WAAW,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,SAAS,CAAC,SAAS,CAAC,mCAAmC,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAC1E,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,aAAa,CAAC,CACzD,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAC/B,EACE,aAAa,EACb,SAAS,EACT,IAAI,GAKL,EACD,EAAoC;IAEpC,MAAM,WAAW,GAAG,cAAc,CAAC,aAAa,EAAE,SAAkB,CAAC,CAAC;IAEtE,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,0BAA0B,aAAa,EAAE,CAAC,CAAC;KAC5D;IAED,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;IAE9C,EAAE,CAAC,cAAc,CAAC,CAAC;IAEnB,SAAS,CAAC,IAAI,CACZ,yCAAyC,EACzC,cAAc,EACd,IAAI,CACL,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,mBAAmB,CAC1B,WAA4B,EAC5B,SAA4C,EAC5C,qBAAoD;IAEpD,MAAM,MAAM,GAAG,mBAAmB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAE3D,GAAG,CAAC,qBAAqB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;IAEpD,qBAAqB,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,sBAAsB,CAC7B,WAA4B,EAC5B,qBAAsD;IAEtD,GAAG,CAAC,uBAAuB,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC9C,qBAAqB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;AACxC,CAAC","sourcesContent":["import {\n  TransactionStatus,\n  type TransactionMeta,\n} from '@metamask/transaction-controller';\nimport { createModuleLogger } from '@metamask/utils';\nimport { cloneDeep } from 'lodash';\n\nimport { parseRequiredTokens } from './required-tokens';\nimport { projectLogger } from '../logger';\nimport type {\n  TransactionPayControllerMessenger,\n  UpdateTransactionDataCallback,\n} from '../types';\n\nconst log = createModuleLogger(projectLogger, 'transaction');\n\nexport const FINALIZED_STATUSES = [\n  TransactionStatus.confirmed,\n  TransactionStatus.dropped,\n  TransactionStatus.failed,\n];\n\n/**\n * Retrieve transaction metadata by ID.\n *\n * @param transactionId - ID of the transaction to retrieve.\n * @param messenger - Controller messenger.\n * @returns The transaction metadata or undefined if not found.\n */\nexport function getTransaction(\n  transactionId: string,\n  messenger: TransactionPayControllerMessenger,\n): TransactionMeta | undefined {\n  const transactionControllerState = messenger.call(\n    'TransactionController:getState',\n  );\n\n  return transactionControllerState.transactions.find(\n    (tx) => tx.id === transactionId,\n  );\n}\n\n/**\n * Poll for transaction changes and update the transaction data accordingly.\n *\n * @param messenger - Controller messenger.\n * @param updateTransactionData - Callback to update transaction data.\n * @param removeTransactionData - Callback to remove transaction data.\n */\nexport function pollTransactionChanges(\n  messenger: TransactionPayControllerMessenger,\n  updateTransactionData: UpdateTransactionDataCallback,\n  removeTransactionData: (transactionId: string) => void,\n) {\n  messenger.subscribe(\n    'TransactionController:stateChange',\n    (\n      transactions: TransactionMeta[],\n      previousTransactions: TransactionMeta[] | undefined,\n    ) => {\n      const newTransactions = transactions.filter(\n        (tx) => !previousTransactions?.find((prevTx) => prevTx.id === tx.id),\n      );\n\n      const updatedTransactions = transactions.filter((tx) => {\n        const previousTransaction = previousTransactions?.find(\n          (prevTx) => prevTx.id === tx.id,\n        );\n\n        return (\n          previousTransaction &&\n          previousTransaction?.txParams.data !== tx.txParams.data\n        );\n      });\n\n      const finalizedTransactions = transactions.filter((tx) => {\n        const previousTransaction = previousTransactions?.find(\n          (prevTx) => prevTx.id === tx.id,\n        );\n\n        return (\n          previousTransaction &&\n          !FINALIZED_STATUSES.includes(previousTransaction.status) &&\n          FINALIZED_STATUSES.includes(tx.status)\n        );\n      });\n\n      finalizedTransactions.forEach((tx) =>\n        onTransactionFinalized(tx, removeTransactionData),\n      );\n\n      [...newTransactions, ...updatedTransactions].forEach((tx) =>\n        onTransactionChange(tx, messenger, updateTransactionData),\n      );\n    },\n    (state) => state.transactions,\n  );\n}\n\n/**\n * Wait for a transaction to be confirmed or fail.\n *\n * @param transactionId - ID of the transaction to wait for.\n * @param messenger - Controller messenger.\n * @returns A promise that resolves when the transaction is confirmed or rejects if it fails.\n */\nexport function waitForTransactionConfirmed(\n  transactionId: string,\n  messenger: TransactionPayControllerMessenger,\n) {\n  return new Promise<void>((resolve, reject) => {\n    const isConfirmed = (tx?: TransactionMeta, fn?: () => void) => {\n      log('Checking transaction status', tx?.status, tx?.type);\n\n      if (tx?.status === TransactionStatus.confirmed) {\n        fn?.();\n        resolve();\n        return true;\n      }\n\n      if (\n        [TransactionStatus.dropped, TransactionStatus.failed].includes(\n          tx?.status as TransactionStatus,\n        )\n      ) {\n        fn?.();\n        reject(\n          new Error(`Transaction failed - ${tx?.type} - ${tx?.error?.message}`),\n        );\n        return true;\n      }\n\n      return false;\n    };\n\n    const initialState = messenger.call('TransactionController:getState');\n\n    const initialTx = initialState.transactions.find(\n      (t) => t.id === transactionId,\n    );\n\n    if (isConfirmed(initialTx)) {\n      return;\n    }\n\n    const handler = (tx?: TransactionMeta) => {\n      const unsubscribe = () =>\n        messenger.unsubscribe('TransactionController:stateChange', handler);\n\n      isConfirmed(tx, unsubscribe);\n    };\n\n    messenger.subscribe('TransactionController:stateChange', handler, (state) =>\n      state.transactions.find((tx) => tx.id === transactionId),\n    );\n  });\n}\n\n/**\n * Update a transaction by applying a function to its draft.\n *\n * @param request - Request object.\n * @param request.transactionId - ID of the transaction to update.\n * @param request.messenger - Controller messenger.\n * @param request.note - Note describing the update.\n * @param fn - Function that applies updates to the transaction draft.\n */\nexport function updateTransaction(\n  {\n    transactionId,\n    messenger,\n    note,\n  }: {\n    transactionId: string;\n    messenger: TransactionPayControllerMessenger;\n    note: string;\n  },\n  fn: (draft: TransactionMeta) => void,\n) {\n  const transaction = getTransaction(transactionId, messenger as never);\n\n  if (!transaction) {\n    throw new Error(`Transaction not found: ${transactionId}`);\n  }\n\n  const newTransaction = cloneDeep(transaction);\n\n  fn(newTransaction);\n\n  messenger.call(\n    'TransactionController:updateTransaction',\n    newTransaction,\n    note,\n  );\n}\n\n/**\n * Handle a transaction change by updating its associated data.\n *\n * @param transaction - Transaction metadata.\n * @param messenger - Controller messenger.\n * @param updateTransactionData - Callback to update transaction data.\n */\nfunction onTransactionChange(\n  transaction: TransactionMeta,\n  messenger: TransactionPayControllerMessenger,\n  updateTransactionData: UpdateTransactionDataCallback,\n) {\n  const tokens = parseRequiredTokens(transaction, messenger);\n\n  log('Transaction changed', { transaction, tokens });\n\n  updateTransactionData(transaction.id, (data) => {\n    data.tokens = tokens;\n  });\n}\n\n/**\n * Handle a finalized transaction by removing its associated data.\n *\n * @param transaction - Transaction metadata.\n * @param removeTransactionData - Callback to remove transaction data.\n */\nfunction onTransactionFinalized(\n  transaction: TransactionMeta,\n  removeTransactionData: (transactionId: string) => void,\n) {\n  log('Transaction finalized', { transaction });\n  removeTransactionData(transaction.id);\n}\n"]}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@metamask/transaction-pay-controller",
+  "version": "1.0.0",
+  "description": "Manages alternate payment strategies to provide required funds for transactions in MetaMask",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/transaction-pay-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "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",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/transaction-pay-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/transaction-pay-controller",
+    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@ethersproject/abi": "^5.7.0",
+    "@ethersproject/contracts": "^5.7.0",
+    "@metamask/base-controller": "^9.0.0",
+    "@metamask/controller-utils": "^11.15.0",
+    "@metamask/messenger": "^0.3.0",
+    "@metamask/metamask-eth-abis": "^3.1.1",
+    "@metamask/utils": "^11.8.1",
+    "bignumber.js": "^9.1.2",
+    "bn.js": "^5.2.1",
+    "immer": "^9.0.6",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@metamask/assets-controllers": "^85.0.0",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/bridge-controller": "^57.0.0",
+    "@metamask/bridge-status-controller": "^57.0.0",
+    "@metamask/gas-fee-controller": "^25.0.0",
+    "@metamask/network-controller": "^25.0.0",
+    "@metamask/remote-feature-flag-controller": "^2.0.0",
+    "@metamask/transaction-controller": "^61.1.0",
+    "@ts-bridge/cli": "^0.6.1",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2"
+  },
+  "peerDependencies": {
+    "@metamask/assets-controllers": "^85.0.0",
+    "@metamask/bridge-controller": "^57.0.0",
+    "@metamask/bridge-status-controller": "^57.0.0",
+    "@metamask/gas-fee-controller": "^25.0.0",
+    "@metamask/network-controller": "^25.0.0",
+    "@metamask/remote-feature-flag-controller": "^2.0.0",
+    "@metamask/transaction-controller": "^61.0.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}