@metamask/transaction-pay-controller 1.0.0

package/dist/utils/quotes.cjs

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queueRefreshQuotes = exports.updateQuotes = void 0;
+const utils_1 = require("@metamask/utils");
+const strategy_1 = require("./strategy.cjs");
+const totals_1 = require("./totals.cjs");
+const transaction_1 = require("./transaction.cjs");
+const logger_1 = require("../logger.cjs");
+const QUOTES_CHECK_INTERVAL = 1 * 1000; // 1 Second
+const DEFAULT_REFRESH_INTERVAL = 30 * 1000; // 30 Seconds
+const log = (0, utils_1.createModuleLogger)(logger_1.projectLogger, 'quotes');
+/**
+ * Update the quotes for a specific transaction.
+ *
+ * @param request - Request parameters.
+ */
+async function updateQuotes(request) {
+    const { messenger, transactionData, transactionId, updateTransactionData } = request;
+    const transaction = (0, transaction_1.getTransaction)(transactionId, messenger);
+    log('Updating quotes', { transactionId });
+    if (!transaction || !transactionData) {
+        throw new Error('Transaction not found');
+    }
+    const { paymentToken, sourceAmounts, tokens } = transactionData;
+    if (!paymentToken) {
+        return;
+    }
+    const requests = (sourceAmounts ?? []).map((sourceAmount, i) => {
+        const token = tokens[i];
+        return {
+            from: transaction.txParams.from,
+            sourceBalanceRaw: paymentToken.balanceRaw,
+            sourceTokenAmount: sourceAmount.sourceAmountRaw,
+            sourceChainId: paymentToken.chainId,
+            sourceTokenAddress: paymentToken.address,
+            targetAmountMinimum: token.allowUnderMinimum ? '0' : token.amountRaw,
+            targetChainId: token.chainId,
+            targetTokenAddress: token.address,
+        };
+    });
+    if (!requests?.length) {
+        log('No quote requests', { transactionId });
+    }
+    let quotes = [];
+    const strategy = await (0, strategy_1.getStrategy)(messenger, transaction);
+    try {
+        quotes = requests?.length
+            ? (await strategy.getQuotes({
+                messenger,
+                requests,
+                transaction,
+            }))
+            : [];
+    }
+    catch (error) {
+        log('Error fetching quotes', { error, transactionId });
+    }
+    log('Updated', { transactionId, quotes });
+    const batchTransactions = quotes?.length && strategy.getBatchTransactions
+        ? await strategy.getBatchTransactions({
+            messenger,
+            quotes,
+        })
+        : [];
+    log('Batch transactions', { transactionId, batchTransactions });
+    const totals = (0, totals_1.calculateTotals)(quotes, tokens, messenger);
+    log('Calculated totals', { transactionId, totals });
+    syncTransaction({
+        batchTransactions,
+        messenger: messenger,
+        paymentToken,
+        totals,
+        transactionId,
+    });
+    updateTransactionData(transactionId, (data) => {
+        data.quotes = quotes;
+        data.quotesLastUpdated = Date.now();
+        data.totals = totals;
+        data.isLoading = false;
+    });
+}
+exports.updateQuotes = updateQuotes;
+/**
+ * Poll quotes at regular intervals.
+ *
+ * @param messenger - Messenger instance.
+ * @param updateTransactionData - Callback to update transaction data.
+ */
+function queueRefreshQuotes(messenger, updateTransactionData) {
+    setTimeout(() => {
+        refreshQuotes(messenger, updateTransactionData)
+            .finally(() => queueRefreshQuotes(messenger, updateTransactionData))
+            .catch((error) => {
+            log('Error polling quotes', { messenger, error });
+        });
+    }, QUOTES_CHECK_INTERVAL);
+}
+exports.queueRefreshQuotes = queueRefreshQuotes;
+/**
+ * Sync batch transactions to the transaction meta.
+ *
+ * @param request - Request object.
+ * @param request.batchTransactions - Batch transactions to sync.
+ * @param request.messenger - Messenger instance.
+ * @param request.paymentToken - Payment token used.
+ * @param request.totals - Calculated totals.
+ * @param request.transactionId - ID of the transaction to sync.
+ */
+function syncTransaction({ batchTransactions, messenger, paymentToken, totals, transactionId, }) {
+    (0, transaction_1.updateTransaction)({
+        transactionId,
+        messenger: messenger,
+        note: 'Update transaction pay data',
+    }, (tx) => {
+        tx.batchTransactions = batchTransactions;
+        tx.batchTransactionsOptions = {};
+        tx.metamaskPay = {
+            bridgeFeeFiat: totals.fees.provider.usd,
+            chainId: paymentToken.chainId,
+            networkFeeFiat: totals.fees.sourceNetwork.usd,
+            tokenAddress: paymentToken.address,
+            totalFiat: totals.total.usd,
+        };
+    });
+}
+/**
+ * Refresh quotes for all transactions if expired.
+ *
+ * @param messenger - Messenger instance.
+ * @param updateTransactionData - Callback to update transaction data.
+ */
+async function refreshQuotes(messenger, updateTransactionData) {
+    const state = messenger.call('TransactionPayController:getState');
+    const transactionIds = Object.keys(state.transactionData);
+    for (const transactionId of transactionIds) {
+        const transactionData = state.transactionData[transactionId];
+        const { isLoading, quotes, quotesLastUpdated } = transactionData;
+        if (isLoading || !quotes?.length) {
+            continue;
+        }
+        const strategyName = quotes[0].strategy;
+        const strategy = (0, strategy_1.getStrategyByName)(strategyName);
+        const refreshInterval = (await strategy.getRefreshInterval?.({
+            chainId: quotes[0].request.sourceChainId,
+            messenger,
+        })) ?? DEFAULT_REFRESH_INTERVAL;
+        const isExpired = Date.now() - (quotesLastUpdated ?? 0) > refreshInterval;
+        if (!isExpired) {
+            continue;
+        }
+        log('Refreshing expired quotes', {
+            transactionId,
+            strategy: strategyName,
+            refreshInterval,
+        });
+        updateTransactionData(transactionId, (data) => {
+            data.isLoading = true;
+        });
+        await updateQuotes({
+            messenger,
+            transactionData,
+            transactionId,
+            updateTransactionData,
+        });
+        log('Refreshed quotes', { transactionId, strategy: strategyName });
+    }
+}
+//# sourceMappingURL=quotes.cjs.map

package/dist/utils/quotes.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"quotes.cjs","sourceRoot":"","sources":["../../src/utils/quotes.ts"],"names":[],"mappings":";;;AAGA,2CAAqD;AAErD,6CAA4D;AAC5D,yCAA2C;AAC3C,mDAAkE;AAClE,0CAA0C;AAW1C,MAAM,qBAAqB,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,WAAW;AACnD,MAAM,wBAAwB,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAEzD,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,sBAAa,EAAE,QAAQ,CAAC,CAAC;AASxD;;;;GAIG;AACI,KAAK,UAAU,YAAY,CAAC,OAA4B;IAC7D,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,aAAa,EAAE,qBAAqB,EAAE,GACxE,OAAO,CAAC;IAEV,MAAM,WAAW,GAAG,IAAA,4BAAc,EAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAE7D,GAAG,CAAC,iBAAiB,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;IAE1C,IAAI,CAAC,WAAW,IAAI,CAAC,eAAe,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IAED,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;IAEhE,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO;KACR;IAED,MAAM,QAAQ,GAAmB,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,GAAG,CACxD,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE;QAClB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAExB,OAAO;YACL,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,IAAW;YACtC,gBAAgB,EAAE,YAAY,CAAC,UAAU;YACzC,iBAAiB,EAAE,YAAY,CAAC,eAAe;YAC/C,aAAa,EAAE,YAAY,CAAC,OAAO;YACnC,kBAAkB,EAAE,YAAY,CAAC,OAAO;YACxC,mBAAmB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS;YACpE,aAAa,EAAE,KAAK,CAAC,OAAO;YAC5B,kBAAkB,EAAE,KAAK,CAAC,OAAO;SAClC,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE;QACrB,GAAG,CAAC,mBAAmB,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;KAC7C;IAED,IAAI,MAAM,GAA4C,EAAE,CAAC;IAEzD,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAW,EAAC,SAAkB,EAAE,WAAW,CAAC,CAAC;IAEpE,IAAI;QACF,MAAM,GAAG,QAAQ,EAAE,MAAM;YACvB,CAAC,CAAE,CAAC,MAAM,QAAQ,CAAC,SAAS,CAAC;gBACzB,SAAS;gBACT,QAAQ;gBACR,WAAW;aACZ,CAAC,CAAiC;YACrC,CAAC,CAAC,EAAE,CAAC;KACR;IAAC,OAAO,KAAK,EAAE;QACd,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;KACxD;IAED,GAAG,CAAC,SAAS,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC;IAE1C,MAAM,iBAAiB,GACrB,MAAM,EAAE,MAAM,IAAI,QAAQ,CAAC,oBAAoB;QAC7C,CAAC,CAAC,MAAM,QAAQ,CAAC,oBAAoB,CAAC;YAClC,SAAS;YACT,MAAM;SACP,CAAC;QACJ,CAAC,CAAC,EAAE,CAAC;IAET,GAAG,CAAC,oBAAoB,EAAE,EAAE,aAAa,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,IAAA,wBAAe,EAAC,MAAe,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAEnE,GAAG,CAAC,mBAAmB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC;IAEpD,eAAe,CAAC;QACd,iBAAiB;QACjB,SAAS,EAAE,SAAkB;QAC7B,YAAY;QACZ,MAAM;QACN,aAAa;KACd,CAAC,CAAC;IAEH,qBAAqB,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;QAC5C,IAAI,CAAC,MAAM,GAAG,MAAe,CAAC;QAC9B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC;AArFD,oCAqFC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,SAA4C,EAC5C,qBAAoD;IAEpD,UAAU,CAAC,GAAG,EAAE;QACd,aAAa,CAAC,SAAS,EAAE,qBAAqB,CAAC;aAC5C,OAAO,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;aACnE,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,GAAG,CAAC,sBAAsB,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACP,CAAC,EAAE,qBAAqB,CAAC,CAAC;AAC5B,CAAC;AAXD,gDAWC;AAED;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,EACvB,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,MAAM,EACN,aAAa,GAOd;IACC,IAAA,+BAAiB,EACf;QACE,aAAa;QACb,SAAS,EAAE,SAAkB;QAC7B,IAAI,EAAE,6BAA6B;KACpC,EACD,CAAC,EAAmB,EAAE,EAAE;QACtB,EAAE,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QACzC,EAAE,CAAC,wBAAwB,GAAG,EAAE,CAAC;QAEjC,EAAE,CAAC,WAAW,GAAG;YACf,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG;YACvC,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG;YAC7C,YAAY,EAAE,YAAY,CAAC,OAAO;YAClC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG;SAC5B,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,aAAa,CAC1B,SAA4C,EAC5C,qBAAoD;IAEpD,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IAClE,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAE1D,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;QAC1C,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QAC7D,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,eAAe,CAAC;QAEjE,IAAI,SAAS,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE;YAChC,SAAS;SACV;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAA,4BAAiB,EAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,eAAe,GACnB,CAAC,MAAM,QAAQ,CAAC,kBAAkB,EAAE,CAAC;YACnC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa;YACxC,SAAS;SACV,CAAC,CAAC,IAAI,wBAAwB,CAAC;QAElC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,iBAAiB,IAAI,CAAC,CAAC,GAAG,eAAe,CAAC;QAE1E,IAAI,CAAC,SAAS,EAAE;YACd,SAAS;SACV;QAED,GAAG,CAAC,2BAA2B,EAAE;YAC/B,aAAa;YACb,QAAQ,EAAE,YAAY;YACtB,eAAe;SAChB,CAAC,CAAC;QAEH,qBAAqB,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,MAAM,YAAY,CAAC;YACjB,SAAS;YACT,eAAe;YACf,aAAa;YACb,qBAAqB;SACtB,CAAC,CAAC;QAEH,GAAG,CAAC,kBAAkB,EAAE,EAAE,aAAa,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;KACpE;AACH,CAAC","sourcesContent":["import type { BatchTransaction } from '@metamask/transaction-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { Hex, Json } from '@metamask/utils';\nimport { createModuleLogger } from '@metamask/utils';\n\nimport { getStrategy, getStrategyByName } from './strategy';\nimport { calculateTotals } from './totals';\nimport { getTransaction, updateTransaction } from './transaction';\nimport { projectLogger } from '../logger';\nimport type {\n  QuoteRequest,\n  TransactionData,\n  TransactionPayControllerMessenger,\n  TransactionPayQuote,\n  TransactionPayTotals,\n  TransactionPaymentToken,\n  UpdateTransactionDataCallback,\n} from '../types';\n\nconst QUOTES_CHECK_INTERVAL = 1 * 1000; // 1 Second\nconst DEFAULT_REFRESH_INTERVAL = 30 * 1000; // 30 Seconds\n\nconst log = createModuleLogger(projectLogger, 'quotes');\n\nexport type UpdateQuotesRequest = {\n  messenger: TransactionPayControllerMessenger;\n  transactionData: TransactionData | undefined;\n  transactionId: string;\n  updateTransactionData: UpdateTransactionDataCallback;\n};\n\n/**\n * Update the quotes for a specific transaction.\n *\n * @param request - Request parameters.\n */\nexport async function updateQuotes(request: UpdateQuotesRequest) {\n  const { messenger, transactionData, transactionId, updateTransactionData } =\n    request;\n\n  const transaction = getTransaction(transactionId, messenger);\n\n  log('Updating quotes', { transactionId });\n\n  if (!transaction || !transactionData) {\n    throw new Error('Transaction not found');\n  }\n\n  const { paymentToken, sourceAmounts, tokens } = transactionData;\n\n  if (!paymentToken) {\n    return;\n  }\n\n  const requests: QuoteRequest[] = (sourceAmounts ?? []).map(\n    (sourceAmount, i) => {\n      const token = tokens[i];\n\n      return {\n        from: transaction.txParams.from as Hex,\n        sourceBalanceRaw: paymentToken.balanceRaw,\n        sourceTokenAmount: sourceAmount.sourceAmountRaw,\n        sourceChainId: paymentToken.chainId,\n        sourceTokenAddress: paymentToken.address,\n        targetAmountMinimum: token.allowUnderMinimum ? '0' : token.amountRaw,\n        targetChainId: token.chainId,\n        targetTokenAddress: token.address,\n      };\n    },\n  );\n\n  if (!requests?.length) {\n    log('No quote requests', { transactionId });\n  }\n\n  let quotes: TransactionPayQuote<Json>[] | undefined = [];\n\n  const strategy = await getStrategy(messenger as never, transaction);\n\n  try {\n    quotes = requests?.length\n      ? ((await strategy.getQuotes({\n          messenger,\n          requests,\n          transaction,\n        })) as TransactionPayQuote<Json>[])\n      : [];\n  } catch (error) {\n    log('Error fetching quotes', { error, transactionId });\n  }\n\n  log('Updated', { transactionId, quotes });\n\n  const batchTransactions =\n    quotes?.length && strategy.getBatchTransactions\n      ? await strategy.getBatchTransactions({\n          messenger,\n          quotes,\n        })\n      : [];\n\n  log('Batch transactions', { transactionId, batchTransactions });\n\n  const totals = calculateTotals(quotes as never, tokens, messenger);\n\n  log('Calculated totals', { transactionId, totals });\n\n  syncTransaction({\n    batchTransactions,\n    messenger: messenger as never,\n    paymentToken,\n    totals,\n    transactionId,\n  });\n\n  updateTransactionData(transactionId, (data) => {\n    data.quotes = quotes as never;\n    data.quotesLastUpdated = Date.now();\n    data.totals = totals;\n    data.isLoading = false;\n  });\n}\n\n/**\n * Poll quotes at regular intervals.\n *\n * @param messenger - Messenger instance.\n * @param updateTransactionData - Callback to update transaction data.\n */\nexport function queueRefreshQuotes(\n  messenger: TransactionPayControllerMessenger,\n  updateTransactionData: UpdateTransactionDataCallback,\n) {\n  setTimeout(() => {\n    refreshQuotes(messenger, updateTransactionData)\n      .finally(() => queueRefreshQuotes(messenger, updateTransactionData))\n      .catch((error) => {\n        log('Error polling quotes', { messenger, error });\n      });\n  }, QUOTES_CHECK_INTERVAL);\n}\n\n/**\n * Sync batch transactions to the transaction meta.\n *\n * @param request - Request object.\n * @param request.batchTransactions - Batch transactions to sync.\n * @param request.messenger - Messenger instance.\n * @param request.paymentToken - Payment token used.\n * @param request.totals - Calculated totals.\n * @param request.transactionId - ID of the transaction to sync.\n */\nfunction syncTransaction({\n  batchTransactions,\n  messenger,\n  paymentToken,\n  totals,\n  transactionId,\n}: {\n  batchTransactions: BatchTransaction[];\n  messenger: TransactionPayControllerMessenger;\n  paymentToken: TransactionPaymentToken;\n  totals: TransactionPayTotals;\n  transactionId: string;\n}) {\n  updateTransaction(\n    {\n      transactionId,\n      messenger: messenger as never,\n      note: 'Update transaction pay data',\n    },\n    (tx: TransactionMeta) => {\n      tx.batchTransactions = batchTransactions;\n      tx.batchTransactionsOptions = {};\n\n      tx.metamaskPay = {\n        bridgeFeeFiat: totals.fees.provider.usd,\n        chainId: paymentToken.chainId,\n        networkFeeFiat: totals.fees.sourceNetwork.usd,\n        tokenAddress: paymentToken.address,\n        totalFiat: totals.total.usd,\n      };\n    },\n  );\n}\n\n/**\n * Refresh quotes for all transactions if expired.\n *\n * @param messenger - Messenger instance.\n * @param updateTransactionData - Callback to update transaction data.\n */\nasync function refreshQuotes(\n  messenger: TransactionPayControllerMessenger,\n  updateTransactionData: UpdateTransactionDataCallback,\n) {\n  const state = messenger.call('TransactionPayController:getState');\n  const transactionIds = Object.keys(state.transactionData);\n\n  for (const transactionId of transactionIds) {\n    const transactionData = state.transactionData[transactionId];\n    const { isLoading, quotes, quotesLastUpdated } = transactionData;\n\n    if (isLoading || !quotes?.length) {\n      continue;\n    }\n\n    const strategyName = quotes[0].strategy;\n    const strategy = getStrategyByName(strategyName);\n\n    const refreshInterval =\n      (await strategy.getRefreshInterval?.({\n        chainId: quotes[0].request.sourceChainId,\n        messenger,\n      })) ?? DEFAULT_REFRESH_INTERVAL;\n\n    const isExpired = Date.now() - (quotesLastUpdated ?? 0) > refreshInterval;\n\n    if (!isExpired) {\n      continue;\n    }\n\n    log('Refreshing expired quotes', {\n      transactionId,\n      strategy: strategyName,\n      refreshInterval,\n    });\n\n    updateTransactionData(transactionId, (data) => {\n      data.isLoading = true;\n    });\n\n    await updateQuotes({\n      messenger,\n      transactionData,\n      transactionId,\n      updateTransactionData,\n    });\n\n    log('Refreshed quotes', { transactionId, strategy: strategyName });\n  }\n}\n"]}

package/dist/utils/quotes.d.cts

@@ -0,0 +1,21 @@
+import type { TransactionData, TransactionPayControllerMessenger, UpdateTransactionDataCallback } from "../types.cjs";
+export type UpdateQuotesRequest = {
+    messenger: TransactionPayControllerMessenger;
+    transactionData: TransactionData | undefined;
+    transactionId: string;
+    updateTransactionData: UpdateTransactionDataCallback;
+};
+/**
+ * Update the quotes for a specific transaction.
+ *
+ * @param request - Request parameters.
+ */
+export declare function updateQuotes(request: UpdateQuotesRequest): Promise<void>;
+/**
+ * Poll quotes at regular intervals.
+ *
+ * @param messenger - Messenger instance.
+ * @param updateTransactionData - Callback to update transaction data.
+ */
+export declare function queueRefreshQuotes(messenger: TransactionPayControllerMessenger, updateTransactionData: UpdateTransactionDataCallback): void;
+//# sourceMappingURL=quotes.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"quotes.d.cts","sourceRoot":"","sources":["../../src/utils/quotes.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAEV,eAAe,EACf,iCAAiC,EAIjC,6BAA6B,EAC9B,qBAAiB;AAOlB,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,iCAAiC,CAAC;IAC7C,eAAe,EAAE,eAAe,GAAG,SAAS,CAAC;IAC7C,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,6BAA6B,CAAC;CACtD,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,mBAAmB,iBAqF9D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,iCAAiC,EAC5C,qBAAqB,EAAE,6BAA6B,QASrD"}

package/dist/utils/quotes.d.mts

@@ -0,0 +1,21 @@
+import type { TransactionData, TransactionPayControllerMessenger, UpdateTransactionDataCallback } from "../types.mjs";
+export type UpdateQuotesRequest = {
+    messenger: TransactionPayControllerMessenger;
+    transactionData: TransactionData | undefined;
+    transactionId: string;
+    updateTransactionData: UpdateTransactionDataCallback;
+};
+/**
+ * Update the quotes for a specific transaction.
+ *
+ * @param request - Request parameters.
+ */
+export declare function updateQuotes(request: UpdateQuotesRequest): Promise<void>;
+/**
+ * Poll quotes at regular intervals.
+ *
+ * @param messenger - Messenger instance.
+ * @param updateTransactionData - Callback to update transaction data.
+ */
+export declare function queueRefreshQuotes(messenger: TransactionPayControllerMessenger, updateTransactionData: UpdateTransactionDataCallback): void;
+//# sourceMappingURL=quotes.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"quotes.d.mts","sourceRoot":"","sources":["../../src/utils/quotes.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAEV,eAAe,EACf,iCAAiC,EAIjC,6BAA6B,EAC9B,qBAAiB;AAOlB,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,iCAAiC,CAAC;IAC7C,eAAe,EAAE,eAAe,GAAG,SAAS,CAAC;IAC7C,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,6BAA6B,CAAC;CACtD,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,mBAAmB,iBAqF9D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,iCAAiC,EAC5C,qBAAqB,EAAE,6BAA6B,QASrD"}

package/dist/utils/quotes.mjs

@@ -0,0 +1,163 @@
+import { createModuleLogger } from "@metamask/utils";
+import { getStrategy, getStrategyByName } from "./strategy.mjs";
+import { calculateTotals } from "./totals.mjs";
+import { getTransaction, updateTransaction } from "./transaction.mjs";
+import { projectLogger } from "../logger.mjs";
+const QUOTES_CHECK_INTERVAL = 1 * 1000; // 1 Second
+const DEFAULT_REFRESH_INTERVAL = 30 * 1000; // 30 Seconds
+const log = createModuleLogger(projectLogger, 'quotes');
+/**
+ * Update the quotes for a specific transaction.
+ *
+ * @param request - Request parameters.
+ */
+export async function updateQuotes(request) {
+    const { messenger, transactionData, transactionId, updateTransactionData } = request;
+    const transaction = getTransaction(transactionId, messenger);
+    log('Updating quotes', { transactionId });
+    if (!transaction || !transactionData) {
+        throw new Error('Transaction not found');
+    }
+    const { paymentToken, sourceAmounts, tokens } = transactionData;
+    if (!paymentToken) {
+        return;
+    }
+    const requests = (sourceAmounts ?? []).map((sourceAmount, i) => {
+        const token = tokens[i];
+        return {
+            from: transaction.txParams.from,
+            sourceBalanceRaw: paymentToken.balanceRaw,
+            sourceTokenAmount: sourceAmount.sourceAmountRaw,
+            sourceChainId: paymentToken.chainId,
+            sourceTokenAddress: paymentToken.address,
+            targetAmountMinimum: token.allowUnderMinimum ? '0' : token.amountRaw,
+            targetChainId: token.chainId,
+            targetTokenAddress: token.address,
+        };
+    });
+    if (!requests?.length) {
+        log('No quote requests', { transactionId });
+    }
+    let quotes = [];
+    const strategy = await getStrategy(messenger, transaction);
+    try {
+        quotes = requests?.length
+            ? (await strategy.getQuotes({
+                messenger,
+                requests,
+                transaction,
+            }))
+            : [];
+    }
+    catch (error) {
+        log('Error fetching quotes', { error, transactionId });
+    }
+    log('Updated', { transactionId, quotes });
+    const batchTransactions = quotes?.length && strategy.getBatchTransactions
+        ? await strategy.getBatchTransactions({
+            messenger,
+            quotes,
+        })
+        : [];
+    log('Batch transactions', { transactionId, batchTransactions });
+    const totals = calculateTotals(quotes, tokens, messenger);
+    log('Calculated totals', { transactionId, totals });
+    syncTransaction({
+        batchTransactions,
+        messenger: messenger,
+        paymentToken,
+        totals,
+        transactionId,
+    });
+    updateTransactionData(transactionId, (data) => {
+        data.quotes = quotes;
+        data.quotesLastUpdated = Date.now();
+        data.totals = totals;
+        data.isLoading = false;
+    });
+}
+/**
+ * Poll quotes at regular intervals.
+ *
+ * @param messenger - Messenger instance.
+ * @param updateTransactionData - Callback to update transaction data.
+ */
+export function queueRefreshQuotes(messenger, updateTransactionData) {
+    setTimeout(() => {
+        refreshQuotes(messenger, updateTransactionData)
+            .finally(() => queueRefreshQuotes(messenger, updateTransactionData))
+            .catch((error) => {
+            log('Error polling quotes', { messenger, error });
+        });
+    }, QUOTES_CHECK_INTERVAL);
+}
+/**
+ * Sync batch transactions to the transaction meta.
+ *
+ * @param request - Request object.
+ * @param request.batchTransactions - Batch transactions to sync.
+ * @param request.messenger - Messenger instance.
+ * @param request.paymentToken - Payment token used.
+ * @param request.totals - Calculated totals.
+ * @param request.transactionId - ID of the transaction to sync.
+ */
+function syncTransaction({ batchTransactions, messenger, paymentToken, totals, transactionId, }) {
+    updateTransaction({
+        transactionId,
+        messenger: messenger,
+        note: 'Update transaction pay data',
+    }, (tx) => {
+        tx.batchTransactions = batchTransactions;
+        tx.batchTransactionsOptions = {};
+        tx.metamaskPay = {
+            bridgeFeeFiat: totals.fees.provider.usd,
+            chainId: paymentToken.chainId,
+            networkFeeFiat: totals.fees.sourceNetwork.usd,
+            tokenAddress: paymentToken.address,
+            totalFiat: totals.total.usd,
+        };
+    });
+}
+/**
+ * Refresh quotes for all transactions if expired.
+ *
+ * @param messenger - Messenger instance.
+ * @param updateTransactionData - Callback to update transaction data.
+ */
+async function refreshQuotes(messenger, updateTransactionData) {
+    const state = messenger.call('TransactionPayController:getState');
+    const transactionIds = Object.keys(state.transactionData);
+    for (const transactionId of transactionIds) {
+        const transactionData = state.transactionData[transactionId];
+        const { isLoading, quotes, quotesLastUpdated } = transactionData;
+        if (isLoading || !quotes?.length) {
+            continue;
+        }
+        const strategyName = quotes[0].strategy;
+        const strategy = getStrategyByName(strategyName);
+        const refreshInterval = (await strategy.getRefreshInterval?.({
+            chainId: quotes[0].request.sourceChainId,
+            messenger,
+        })) ?? DEFAULT_REFRESH_INTERVAL;
+        const isExpired = Date.now() - (quotesLastUpdated ?? 0) > refreshInterval;
+        if (!isExpired) {
+            continue;
+        }
+        log('Refreshing expired quotes', {
+            transactionId,
+            strategy: strategyName,
+            refreshInterval,
+        });
+        updateTransactionData(transactionId, (data) => {
+            data.isLoading = true;
+        });
+        await updateQuotes({
+            messenger,
+            transactionData,
+            transactionId,
+            updateTransactionData,
+        });
+        log('Refreshed quotes', { transactionId, strategy: strategyName });
+    }
+}
+//# sourceMappingURL=quotes.mjs.map

package/dist/utils/quotes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"quotes.mjs","sourceRoot":"","sources":["../../src/utils/quotes.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;AAErD,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,uBAAmB;AAC5D,OAAO,EAAE,eAAe,EAAE,qBAAiB;AAC3C,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,0BAAsB;AAClE,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAW1C,MAAM,qBAAqB,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,WAAW;AACnD,MAAM,wBAAwB,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAEzD,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AASxD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAA4B;IAC7D,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,aAAa,EAAE,qBAAqB,EAAE,GACxE,OAAO,CAAC;IAEV,MAAM,WAAW,GAAG,cAAc,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAE7D,GAAG,CAAC,iBAAiB,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;IAE1C,IAAI,CAAC,WAAW,IAAI,CAAC,eAAe,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IAED,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;IAEhE,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO;KACR;IAED,MAAM,QAAQ,GAAmB,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,GAAG,CACxD,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE;QAClB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAExB,OAAO;YACL,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,IAAW;YACtC,gBAAgB,EAAE,YAAY,CAAC,UAAU;YACzC,iBAAiB,EAAE,YAAY,CAAC,eAAe;YAC/C,aAAa,EAAE,YAAY,CAAC,OAAO;YACnC,kBAAkB,EAAE,YAAY,CAAC,OAAO;YACxC,mBAAmB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS;YACpE,aAAa,EAAE,KAAK,CAAC,OAAO;YAC5B,kBAAkB,EAAE,KAAK,CAAC,OAAO;SAClC,CAAC;IACJ,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE;QACrB,GAAG,CAAC,mBAAmB,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;KAC7C;IAED,IAAI,MAAM,GAA4C,EAAE,CAAC;IAEzD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,SAAkB,EAAE,WAAW,CAAC,CAAC;IAEpE,IAAI;QACF,MAAM,GAAG,QAAQ,EAAE,MAAM;YACvB,CAAC,CAAE,CAAC,MAAM,QAAQ,CAAC,SAAS,CAAC;gBACzB,SAAS;gBACT,QAAQ;gBACR,WAAW;aACZ,CAAC,CAAiC;YACrC,CAAC,CAAC,EAAE,CAAC;KACR;IAAC,OAAO,KAAK,EAAE;QACd,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;KACxD;IAED,GAAG,CAAC,SAAS,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC;IAE1C,MAAM,iBAAiB,GACrB,MAAM,EAAE,MAAM,IAAI,QAAQ,CAAC,oBAAoB;QAC7C,CAAC,CAAC,MAAM,QAAQ,CAAC,oBAAoB,CAAC;YAClC,SAAS;YACT,MAAM;SACP,CAAC;QACJ,CAAC,CAAC,EAAE,CAAC;IAET,GAAG,CAAC,oBAAoB,EAAE,EAAE,aAAa,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,eAAe,CAAC,MAAe,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAEnE,GAAG,CAAC,mBAAmB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC;IAEpD,eAAe,CAAC;QACd,iBAAiB;QACjB,SAAS,EAAE,SAAkB;QAC7B,YAAY;QACZ,MAAM;QACN,aAAa;KACd,CAAC,CAAC;IAEH,qBAAqB,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;QAC5C,IAAI,CAAC,MAAM,GAAG,MAAe,CAAC;QAC9B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,SAA4C,EAC5C,qBAAoD;IAEpD,UAAU,CAAC,GAAG,EAAE;QACd,aAAa,CAAC,SAAS,EAAE,qBAAqB,CAAC;aAC5C,OAAO,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;aACnE,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,GAAG,CAAC,sBAAsB,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;IACP,CAAC,EAAE,qBAAqB,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,EACvB,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,MAAM,EACN,aAAa,GAOd;IACC,iBAAiB,CACf;QACE,aAAa;QACb,SAAS,EAAE,SAAkB;QAC7B,IAAI,EAAE,6BAA6B;KACpC,EACD,CAAC,EAAmB,EAAE,EAAE;QACtB,EAAE,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QACzC,EAAE,CAAC,wBAAwB,GAAG,EAAE,CAAC;QAEjC,EAAE,CAAC,WAAW,GAAG;YACf,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG;YACvC,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG;YAC7C,YAAY,EAAE,YAAY,CAAC,OAAO;YAClC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG;SAC5B,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,aAAa,CAC1B,SAA4C,EAC5C,qBAAoD;IAEpD,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IAClE,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAE1D,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;QAC1C,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QAC7D,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,eAAe,CAAC;QAEjE,IAAI,SAAS,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE;YAChC,SAAS;SACV;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACxC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,eAAe,GACnB,CAAC,MAAM,QAAQ,CAAC,kBAAkB,EAAE,CAAC;YACnC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa;YACxC,SAAS;SACV,CAAC,CAAC,IAAI,wBAAwB,CAAC;QAElC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,iBAAiB,IAAI,CAAC,CAAC,GAAG,eAAe,CAAC;QAE1E,IAAI,CAAC,SAAS,EAAE;YACd,SAAS;SACV;QAED,GAAG,CAAC,2BAA2B,EAAE;YAC/B,aAAa;YACb,QAAQ,EAAE,YAAY;YACtB,eAAe;SAChB,CAAC,CAAC;QAEH,qBAAqB,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,MAAM,YAAY,CAAC;YACjB,SAAS;YACT,eAAe;YACf,aAAa;YACb,qBAAqB;SACtB,CAAC,CAAC;QAEH,GAAG,CAAC,kBAAkB,EAAE,EAAE,aAAa,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;KACpE;AACH,CAAC","sourcesContent":["import type { BatchTransaction } from '@metamask/transaction-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { Hex, Json } from '@metamask/utils';\nimport { createModuleLogger } from '@metamask/utils';\n\nimport { getStrategy, getStrategyByName } from './strategy';\nimport { calculateTotals } from './totals';\nimport { getTransaction, updateTransaction } from './transaction';\nimport { projectLogger } from '../logger';\nimport type {\n  QuoteRequest,\n  TransactionData,\n  TransactionPayControllerMessenger,\n  TransactionPayQuote,\n  TransactionPayTotals,\n  TransactionPaymentToken,\n  UpdateTransactionDataCallback,\n} from '../types';\n\nconst QUOTES_CHECK_INTERVAL = 1 * 1000; // 1 Second\nconst DEFAULT_REFRESH_INTERVAL = 30 * 1000; // 30 Seconds\n\nconst log = createModuleLogger(projectLogger, 'quotes');\n\nexport type UpdateQuotesRequest = {\n  messenger: TransactionPayControllerMessenger;\n  transactionData: TransactionData | undefined;\n  transactionId: string;\n  updateTransactionData: UpdateTransactionDataCallback;\n};\n\n/**\n * Update the quotes for a specific transaction.\n *\n * @param request - Request parameters.\n */\nexport async function updateQuotes(request: UpdateQuotesRequest) {\n  const { messenger, transactionData, transactionId, updateTransactionData } =\n    request;\n\n  const transaction = getTransaction(transactionId, messenger);\n\n  log('Updating quotes', { transactionId });\n\n  if (!transaction || !transactionData) {\n    throw new Error('Transaction not found');\n  }\n\n  const { paymentToken, sourceAmounts, tokens } = transactionData;\n\n  if (!paymentToken) {\n    return;\n  }\n\n  const requests: QuoteRequest[] = (sourceAmounts ?? []).map(\n    (sourceAmount, i) => {\n      const token = tokens[i];\n\n      return {\n        from: transaction.txParams.from as Hex,\n        sourceBalanceRaw: paymentToken.balanceRaw,\n        sourceTokenAmount: sourceAmount.sourceAmountRaw,\n        sourceChainId: paymentToken.chainId,\n        sourceTokenAddress: paymentToken.address,\n        targetAmountMinimum: token.allowUnderMinimum ? '0' : token.amountRaw,\n        targetChainId: token.chainId,\n        targetTokenAddress: token.address,\n      };\n    },\n  );\n\n  if (!requests?.length) {\n    log('No quote requests', { transactionId });\n  }\n\n  let quotes: TransactionPayQuote<Json>[] | undefined = [];\n\n  const strategy = await getStrategy(messenger as never, transaction);\n\n  try {\n    quotes = requests?.length\n      ? ((await strategy.getQuotes({\n          messenger,\n          requests,\n          transaction,\n        })) as TransactionPayQuote<Json>[])\n      : [];\n  } catch (error) {\n    log('Error fetching quotes', { error, transactionId });\n  }\n\n  log('Updated', { transactionId, quotes });\n\n  const batchTransactions =\n    quotes?.length && strategy.getBatchTransactions\n      ? await strategy.getBatchTransactions({\n          messenger,\n          quotes,\n        })\n      : [];\n\n  log('Batch transactions', { transactionId, batchTransactions });\n\n  const totals = calculateTotals(quotes as never, tokens, messenger);\n\n  log('Calculated totals', { transactionId, totals });\n\n  syncTransaction({\n    batchTransactions,\n    messenger: messenger as never,\n    paymentToken,\n    totals,\n    transactionId,\n  });\n\n  updateTransactionData(transactionId, (data) => {\n    data.quotes = quotes as never;\n    data.quotesLastUpdated = Date.now();\n    data.totals = totals;\n    data.isLoading = false;\n  });\n}\n\n/**\n * Poll quotes at regular intervals.\n *\n * @param messenger - Messenger instance.\n * @param updateTransactionData - Callback to update transaction data.\n */\nexport function queueRefreshQuotes(\n  messenger: TransactionPayControllerMessenger,\n  updateTransactionData: UpdateTransactionDataCallback,\n) {\n  setTimeout(() => {\n    refreshQuotes(messenger, updateTransactionData)\n      .finally(() => queueRefreshQuotes(messenger, updateTransactionData))\n      .catch((error) => {\n        log('Error polling quotes', { messenger, error });\n      });\n  }, QUOTES_CHECK_INTERVAL);\n}\n\n/**\n * Sync batch transactions to the transaction meta.\n *\n * @param request - Request object.\n * @param request.batchTransactions - Batch transactions to sync.\n * @param request.messenger - Messenger instance.\n * @param request.paymentToken - Payment token used.\n * @param request.totals - Calculated totals.\n * @param request.transactionId - ID of the transaction to sync.\n */\nfunction syncTransaction({\n  batchTransactions,\n  messenger,\n  paymentToken,\n  totals,\n  transactionId,\n}: {\n  batchTransactions: BatchTransaction[];\n  messenger: TransactionPayControllerMessenger;\n  paymentToken: TransactionPaymentToken;\n  totals: TransactionPayTotals;\n  transactionId: string;\n}) {\n  updateTransaction(\n    {\n      transactionId,\n      messenger: messenger as never,\n      note: 'Update transaction pay data',\n    },\n    (tx: TransactionMeta) => {\n      tx.batchTransactions = batchTransactions;\n      tx.batchTransactionsOptions = {};\n\n      tx.metamaskPay = {\n        bridgeFeeFiat: totals.fees.provider.usd,\n        chainId: paymentToken.chainId,\n        networkFeeFiat: totals.fees.sourceNetwork.usd,\n        tokenAddress: paymentToken.address,\n        totalFiat: totals.total.usd,\n      };\n    },\n  );\n}\n\n/**\n * Refresh quotes for all transactions if expired.\n *\n * @param messenger - Messenger instance.\n * @param updateTransactionData - Callback to update transaction data.\n */\nasync function refreshQuotes(\n  messenger: TransactionPayControllerMessenger,\n  updateTransactionData: UpdateTransactionDataCallback,\n) {\n  const state = messenger.call('TransactionPayController:getState');\n  const transactionIds = Object.keys(state.transactionData);\n\n  for (const transactionId of transactionIds) {\n    const transactionData = state.transactionData[transactionId];\n    const { isLoading, quotes, quotesLastUpdated } = transactionData;\n\n    if (isLoading || !quotes?.length) {\n      continue;\n    }\n\n    const strategyName = quotes[0].strategy;\n    const strategy = getStrategyByName(strategyName);\n\n    const refreshInterval =\n      (await strategy.getRefreshInterval?.({\n        chainId: quotes[0].request.sourceChainId,\n        messenger,\n      })) ?? DEFAULT_REFRESH_INTERVAL;\n\n    const isExpired = Date.now() - (quotesLastUpdated ?? 0) > refreshInterval;\n\n    if (!isExpired) {\n      continue;\n    }\n\n    log('Refreshing expired quotes', {\n      transactionId,\n      strategy: strategyName,\n      refreshInterval,\n    });\n\n    updateTransactionData(transactionId, (data) => {\n      data.isLoading = true;\n    });\n\n    await updateQuotes({\n      messenger,\n      transactionData,\n      transactionId,\n      updateTransactionData,\n    });\n\n    log('Refreshed quotes', { transactionId, strategy: strategyName });\n  }\n}\n"]}

package/dist/utils/required-tokens.cjs

@@ -0,0 +1,179 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseRequiredTokens = void 0;
+const abi_1 = require("@ethersproject/abi");
+const controller_utils_1 = require("@metamask/controller-utils");
+const metamask_eth_abis_1 = require("@metamask/metamask-eth-abis");
+const utils_1 = require("@metamask/utils");
+const bignumber_js_1 = require("bignumber.js");
+const token_1 = require("./token.cjs");
+const FOUR_BYTE_TOKEN_TRANSFER = '0xa9059cbb';
+/**
+ * Parse required tokens from a transaction.
+ *
+ * @param transaction - Transaction metadata.
+ * @param messenger - Controller messenger.
+ * @returns An array of required tokens.
+ */
+function parseRequiredTokens(transaction, messenger) {
+    return [
+        getTokenTransferToken(transaction, messenger),
+        getGasFeeToken(transaction, messenger),
+    ].filter(Boolean);
+}
+exports.parseRequiredTokens = parseRequiredTokens;
+/**
+ * Parse a required token from a token transfer.
+ *
+ * @param transaction - Transaction metadata.
+ * @param messenger - Controller messenger.
+ * @returns The required token or undefined if the transaction is not a token transfer.
+ */
+function getTokenTransferToken(transaction, messenger) {
+    const { data, to } = getTokenTransferData(transaction) ?? {};
+    if (!to || !data) {
+        return undefined;
+    }
+    let transferAmount;
+    try {
+        const result = new abi_1.Interface(metamask_eth_abis_1.abiERC20).decodeFunctionData('transfer', data);
+        transferAmount = (0, controller_utils_1.toHex)(result._value);
+    }
+    catch {
+        // Intentionally empty
+    }
+    if (transferAmount === undefined) {
+        return undefined;
+    }
+    return buildRequiredToken(transaction, to, transferAmount, messenger);
+}
+/**
+ * Get the gas fee token required for a transaction.
+ *
+ * @param transaction - Transaction metadata.
+ * @param messenger - Controller messenger.
+ * @returns The gas fee token or undefined if it could not be determined.
+ */
+function getGasFeeToken(transaction, messenger) {
+    const { chainId, txParams } = transaction;
+    const { gas, maxFeePerGas } = txParams;
+    const nativeTokenAddress = (0, token_1.getNativeToken)(chainId);
+    const maxGasCostRawHex = (0, utils_1.add0x)(new bignumber_js_1.BigNumber(gas ?? '0x0')
+        .multipliedBy(new bignumber_js_1.BigNumber(maxFeePerGas ?? '0x0'))
+        .toString(16));
+    const token = buildRequiredToken(transaction, nativeTokenAddress, maxGasCostRawHex, messenger);
+    if (!token) {
+        return undefined;
+    }
+    const amountUsdValue = new bignumber_js_1.BigNumber(token.amountUsd);
+    const hasBalance = new bignumber_js_1.BigNumber(token.balanceRaw).isGreaterThanOrEqualTo(token.amountRaw);
+    if (hasBalance || amountUsdValue.isGreaterThanOrEqualTo(1)) {
+        return {
+            ...token,
+            allowUnderMinimum: true,
+            skipIfBalance: true,
+        };
+    }
+    const fiatRates = (0, token_1.getTokenFiatRate)(messenger, nativeTokenAddress, chainId);
+    const oneDollarRawHex = (0, utils_1.add0x)(new bignumber_js_1.BigNumber(1).dividedBy(fiatRates.usdRate).shiftedBy(18).toString(16));
+    const oneDollarToken = buildRequiredToken(transaction, nativeTokenAddress, oneDollarRawHex, messenger);
+    /* istanbul ignore next */
+    if (!oneDollarToken) {
+        return undefined;
+    }
+    return {
+        ...oneDollarToken,
+        allowUnderMinimum: true,
+        skipIfBalance: true,
+    };
+}
+/**
+ * Get the full token properties for a specific token and amount.
+ *
+ * @param transaction - Transaction metadata.
+ * @param tokenAddress - Token address.
+ * @param amountRawHex - Raw token amount in hexadecimal format.
+ * @param messenger - Controller messenger.
+ * @returns The full token properties or undefined if the token data could not be retrieved.
+ */
+function buildRequiredToken(transaction, tokenAddress, amountRawHex, messenger) {
+    const { chainId, txParams } = transaction;
+    const from = txParams.from;
+    const { decimals: tokenDecimals, symbol } = (0, token_1.getTokenInfo)(messenger, tokenAddress, chainId) ?? {};
+    const fiatRates = (0, token_1.getTokenFiatRate)(messenger, tokenAddress, chainId);
+    const tokenBalance = (0, token_1.getTokenBalance)(messenger, from, chainId, tokenAddress);
+    if (tokenDecimals === undefined || !symbol || fiatRates === undefined) {
+        return undefined;
+    }
+    const { amountHuman: balanceHuman, amountRaw: balanceRaw, amountFiat: balanceFiat, amountUsd: balanceUsd, } = calculateAmounts(tokenBalance, tokenDecimals, fiatRates);
+    const { amountHuman, amountRaw, amountFiat, amountUsd } = calculateAmounts(amountRawHex, tokenDecimals, fiatRates);
+    return {
+        address: tokenAddress,
+        allowUnderMinimum: false,
+        amountFiat,
+        amountHuman,
+        amountRaw,
+        amountUsd,
+        balanceFiat,
+        balanceHuman,
+        balanceRaw,
+        balanceUsd,
+        chainId,
+        decimals: tokenDecimals,
+        skipIfBalance: false,
+        symbol,
+    };
+}
+/**
+ * Calculates the various amount representations for a token value.
+ *
+ * @param amountRawInput - Raw amount.
+ * @param decimals - Number of decimals for the token.
+ * @param fiatRates - Fiat rates for the token.
+ * @returns Object containing amount in fiat, human-readable, raw, and USD formats.
+ */
+function calculateAmounts(amountRawInput, decimals, fiatRates) {
+    const amountRawValue = new bignumber_js_1.BigNumber(amountRawInput);
+    const amountHumanValue = amountRawValue.shiftedBy(-decimals);
+    const amountFiat = amountHumanValue
+        .multipliedBy(fiatRates.fiatRate)
+        .toString(10);
+    const amountUsd = amountHumanValue
+        .multipliedBy(fiatRates.usdRate)
+        .toString(10);
+    const amountRaw = amountRawValue.toFixed(0);
+    const amountHuman = amountHumanValue.toString(10);
+    return {
+        amountFiat,
+        amountHuman,
+        amountRaw,
+        amountUsd,
+    };
+}
+/**
+ * Find token transfer data in a transaction.
+ *
+ * @param transactionMeta - Transaction metadata.
+ * @returns - Token transfer data or undefined if not found.
+ */
+function getTokenTransferData(transactionMeta) {
+    const { nestedTransactions, txParams } = transactionMeta;
+    const { data: singleData } = txParams;
+    const singleTo = txParams?.to;
+    if (singleData?.startsWith(FOUR_BYTE_TOKEN_TRANSFER) && singleTo) {
+        return { data: singleData, to: singleTo, index: undefined };
+    }
+    const nestedCallIndex = nestedTransactions?.findIndex((call) => call.data?.startsWith(FOUR_BYTE_TOKEN_TRANSFER));
+    const nestedCall = nestedCallIndex !== undefined
+        ? nestedTransactions?.[nestedCallIndex]
+        : undefined;
+    if (nestedCall?.data && nestedCall.to) {
+        return {
+            data: nestedCall.data,
+            to: nestedCall.to,
+            index: nestedCallIndex,
+        };
+    }
+    return undefined;
+}
+//# sourceMappingURL=required-tokens.cjs.map

package/dist/utils/required-tokens.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"required-tokens.cjs","sourceRoot":"","sources":["../../src/utils/required-tokens.ts"],"names":[],"mappings":";;;AAAA,4CAA+C;AAC/C,iEAAmD;AACnD,mEAAuD;AAEvD,2CAAkD;AAClD,+CAAyC;AAEzC,uCAKiB;AAOjB,MAAM,wBAAwB,GAAG,YAAY,CAAC;AAE9C;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,WAA4B,EAC5B,SAA4C;IAE5C,OAAO;QACL,qBAAqB,CAAC,WAAW,EAAE,SAAS,CAAC;QAC7C,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC;KACvC,CAAC,MAAM,CAAC,OAAO,CAAkC,CAAC;AACrD,CAAC;AARD,kDAQC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAC5B,WAA4B,EAC5B,SAA4C;IAE5C,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,oBAAoB,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IAE7D,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE;QAChB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,cAA+B,CAAC;IAEpC,IAAI;QACF,MAAM,MAAM,GAAG,IAAI,eAAS,CAAC,4BAAQ,CAAC,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC5E,cAAc,GAAG,IAAA,wBAAK,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KACvC;IAAC,MAAM;QACN,sBAAsB;KACvB;IAED,IAAI,cAAc,KAAK,SAAS,EAAE;QAChC,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,kBAAkB,CAAC,WAAW,EAAE,EAAE,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CACrB,WAA4B,EAC5B,SAA4C;IAE5C,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;IAC1C,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC;IACvC,MAAM,kBAAkB,GAAG,IAAA,sBAAc,EAAC,OAAO,CAAC,CAAC;IAEnD,MAAM,gBAAgB,GAAG,IAAA,aAAK,EAC5B,IAAI,wBAAS,CAAC,GAAG,IAAI,KAAK,CAAC;SACxB,YAAY,CAAC,IAAI,wBAAS,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;SAClD,QAAQ,CAAC,EAAE,CAAC,CAChB,CAAC;IAEF,MAAM,KAAK,GAAG,kBAAkB,CAC9B,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,CACV,CAAC;IAEF,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,cAAc,GAAG,IAAI,wBAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAEtD,MAAM,UAAU,GAAG,IAAI,wBAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,sBAAsB,CACvE,KAAK,CAAC,SAAS,CAChB,CAAC;IAEF,IAAI,UAAU,IAAI,cAAc,CAAC,sBAAsB,CAAC,CAAC,CAAC,EAAE;QAC1D,OAAO;YACL,GAAG,KAAK;YACR,iBAAiB,EAAE,IAAI;YACvB,aAAa,EAAE,IAAI;SACpB,CAAC;KACH;IAED,MAAM,SAAS,GAAG,IAAA,wBAAgB,EAChC,SAAS,EACT,kBAAkB,EAClB,OAAO,CACK,CAAC;IAEf,MAAM,eAAe,GAAG,IAAA,aAAK,EAC3B,IAAI,wBAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CACzE,CAAC;IAEF,MAAM,cAAc,GAAG,kBAAkB,CACvC,WAAW,EACX,kBAAkB,EAClB,eAAe,EACf,SAAS,CACV,CAAC;IAEF,0BAA0B;IAC1B,IAAI,CAAC,cAAc,EAAE;QACnB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO;QACL,GAAG,cAAc;QACjB,iBAAiB,EAAE,IAAI;QACvB,aAAa,EAAE,IAAI;KACpB,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,kBAAkB,CACzB,WAA4B,EAC5B,YAAiB,EACjB,YAAiB,EACjB,SAA4C;IAE5C,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAW,CAAC;IAElC,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,GACvC,IAAA,oBAAY,EAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IAEvD,MAAM,SAAS,GAAG,IAAA,wBAAgB,EAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACrE,MAAM,YAAY,GAAG,IAAA,uBAAe,EAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IAE7E,IAAI,aAAa,KAAK,SAAS,IAAI,CAAC,MAAM,IAAI,SAAS,KAAK,SAAS,EAAE;QACrE,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,EACJ,WAAW,EAAE,YAAY,EACzB,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,WAAW,EACvB,SAAS,EAAE,UAAU,GACtB,GAAG,gBAAgB,CAAC,YAAY,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;IAE7D,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,gBAAgB,CACxE,YAAY,EACZ,aAAa,EACb,SAAS,CACV,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,YAAY;QACrB,iBAAiB,EAAE,KAAK;QACxB,UAAU;QACV,WAAW;QACX,SAAS;QACT,SAAS;QACT,WAAW;QACX,YAAY;QACZ,UAAU;QACV,UAAU;QACV,OAAO;QACP,QAAQ,EAAE,aAAa;QACvB,aAAa,EAAE,KAAK;QACpB,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,cAA+B,EAC/B,QAAgB,EAChB,SAAoB;IAEpB,MAAM,cAAc,GAAG,IAAI,wBAAS,CAAC,cAAc,CAAC,CAAC;IACrD,MAAM,gBAAgB,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;IAE7D,MAAM,UAAU,GAAG,gBAAgB;SAChC,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC;SAChC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEhB,MAAM,SAAS,GAAG,gBAAgB;SAC/B,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC;SAC/B,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEhB,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAElD,OAAO;QACL,UAAU;QACV,WAAW;QACX,SAAS;QACT,SAAS;KACV,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,eAAgC;IAO5D,MAAM,EAAE,kBAAkB,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC;IACzD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;IACtC,MAAM,QAAQ,GAAG,QAAQ,EAAE,EAAqB,CAAC;IAEjD,IAAI,UAAU,EAAE,UAAU,CAAC,wBAAwB,CAAC,IAAI,QAAQ,EAAE;QAChE,OAAO,EAAE,IAAI,EAAE,UAAiB,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;KACpE;IAED,MAAM,eAAe,GAAG,kBAAkB,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7D,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,wBAAwB,CAAC,CAChD,CAAC;IAEF,MAAM,UAAU,GACd,eAAe,KAAK,SAAS;QAC3B,CAAC,CAAC,kBAAkB,EAAE,CAAC,eAAe,CAAC;QACvC,CAAC,CAAC,SAAS,CAAC;IAEhB,IAAI,UAAU,EAAE,IAAI,IAAI,UAAU,CAAC,EAAE,EAAE;QACrC,OAAO;YACL,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,EAAE,EAAE,UAAU,CAAC,EAAE;YACjB,KAAK,EAAE,eAAe;SACvB,CAAC;KACH;IAED,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["import { Interface } from '@ethersproject/abi';\nimport { toHex } from '@metamask/controller-utils';\nimport { abiERC20 } from '@metamask/metamask-eth-abis';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport { add0x, type Hex } from '@metamask/utils';\nimport { BigNumber } from 'bignumber.js';\n\nimport {\n  getNativeToken,\n  getTokenBalance,\n  getTokenFiatRate,\n  getTokenInfo,\n} from './token';\nimport type {\n  FiatRates,\n  TransactionPayControllerMessenger,\n  TransactionPayRequiredToken,\n} from '../types';\n\nconst FOUR_BYTE_TOKEN_TRANSFER = '0xa9059cbb';\n\n/**\n * Parse required tokens from a transaction.\n *\n * @param transaction - Transaction metadata.\n * @param messenger - Controller messenger.\n * @returns An array of required tokens.\n */\nexport function parseRequiredTokens(\n  transaction: TransactionMeta,\n  messenger: TransactionPayControllerMessenger,\n): TransactionPayRequiredToken[] {\n  return [\n    getTokenTransferToken(transaction, messenger),\n    getGasFeeToken(transaction, messenger),\n  ].filter(Boolean) as TransactionPayRequiredToken[];\n}\n\n/**\n * Parse a required token from a token transfer.\n *\n * @param transaction - Transaction metadata.\n * @param messenger - Controller messenger.\n * @returns The required token or undefined if the transaction is not a token transfer.\n */\nfunction getTokenTransferToken(\n  transaction: TransactionMeta,\n  messenger: TransactionPayControllerMessenger,\n): TransactionPayRequiredToken | undefined {\n  const { data, to } = getTokenTransferData(transaction) ?? {};\n\n  if (!to || !data) {\n    return undefined;\n  }\n\n  let transferAmount: Hex | undefined;\n\n  try {\n    const result = new Interface(abiERC20).decodeFunctionData('transfer', data);\n    transferAmount = toHex(result._value);\n  } catch {\n    // Intentionally empty\n  }\n\n  if (transferAmount === undefined) {\n    return undefined;\n  }\n\n  return buildRequiredToken(transaction, to, transferAmount, messenger);\n}\n\n/**\n * Get the gas fee token required for a transaction.\n *\n * @param transaction - Transaction metadata.\n * @param messenger - Controller messenger.\n * @returns The gas fee token or undefined if it could not be determined.\n */\nfunction getGasFeeToken(\n  transaction: TransactionMeta,\n  messenger: TransactionPayControllerMessenger,\n): TransactionPayRequiredToken | undefined {\n  const { chainId, txParams } = transaction;\n  const { gas, maxFeePerGas } = txParams;\n  const nativeTokenAddress = getNativeToken(chainId);\n\n  const maxGasCostRawHex = add0x(\n    new BigNumber(gas ?? '0x0')\n      .multipliedBy(new BigNumber(maxFeePerGas ?? '0x0'))\n      .toString(16),\n  );\n\n  const token = buildRequiredToken(\n    transaction,\n    nativeTokenAddress,\n    maxGasCostRawHex,\n    messenger,\n  );\n\n  if (!token) {\n    return undefined;\n  }\n\n  const amountUsdValue = new BigNumber(token.amountUsd);\n\n  const hasBalance = new BigNumber(token.balanceRaw).isGreaterThanOrEqualTo(\n    token.amountRaw,\n  );\n\n  if (hasBalance || amountUsdValue.isGreaterThanOrEqualTo(1)) {\n    return {\n      ...token,\n      allowUnderMinimum: true,\n      skipIfBalance: true,\n    };\n  }\n\n  const fiatRates = getTokenFiatRate(\n    messenger,\n    nativeTokenAddress,\n    chainId,\n  ) as FiatRates;\n\n  const oneDollarRawHex = add0x(\n    new BigNumber(1).dividedBy(fiatRates.usdRate).shiftedBy(18).toString(16),\n  );\n\n  const oneDollarToken = buildRequiredToken(\n    transaction,\n    nativeTokenAddress,\n    oneDollarRawHex,\n    messenger,\n  );\n\n  /* istanbul ignore next */\n  if (!oneDollarToken) {\n    return undefined;\n  }\n\n  return {\n    ...oneDollarToken,\n    allowUnderMinimum: true,\n    skipIfBalance: true,\n  };\n}\n\n/**\n * Get the full token properties for a specific token and amount.\n *\n * @param transaction - Transaction metadata.\n * @param tokenAddress - Token address.\n * @param amountRawHex - Raw token amount in hexadecimal format.\n * @param messenger - Controller messenger.\n * @returns The full token properties or undefined if the token data could not be retrieved.\n */\nfunction buildRequiredToken(\n  transaction: TransactionMeta,\n  tokenAddress: Hex,\n  amountRawHex: Hex,\n  messenger: TransactionPayControllerMessenger,\n): TransactionPayRequiredToken | undefined {\n  const { chainId, txParams } = transaction;\n  const from = txParams.from as Hex;\n\n  const { decimals: tokenDecimals, symbol } =\n    getTokenInfo(messenger, tokenAddress, chainId) ?? {};\n\n  const fiatRates = getTokenFiatRate(messenger, tokenAddress, chainId);\n  const tokenBalance = getTokenBalance(messenger, from, chainId, tokenAddress);\n\n  if (tokenDecimals === undefined || !symbol || fiatRates === undefined) {\n    return undefined;\n  }\n\n  const {\n    amountHuman: balanceHuman,\n    amountRaw: balanceRaw,\n    amountFiat: balanceFiat,\n    amountUsd: balanceUsd,\n  } = calculateAmounts(tokenBalance, tokenDecimals, fiatRates);\n\n  const { amountHuman, amountRaw, amountFiat, amountUsd } = calculateAmounts(\n    amountRawHex,\n    tokenDecimals,\n    fiatRates,\n  );\n\n  return {\n    address: tokenAddress,\n    allowUnderMinimum: false,\n    amountFiat,\n    amountHuman,\n    amountRaw,\n    amountUsd,\n    balanceFiat,\n    balanceHuman,\n    balanceRaw,\n    balanceUsd,\n    chainId,\n    decimals: tokenDecimals,\n    skipIfBalance: false,\n    symbol,\n  };\n}\n\n/**\n * Calculates the various amount representations for a token value.\n *\n * @param amountRawInput - Raw amount.\n * @param decimals - Number of decimals for the token.\n * @param fiatRates - Fiat rates for the token.\n * @returns Object containing amount in fiat, human-readable, raw, and USD formats.\n */\nfunction calculateAmounts(\n  amountRawInput: BigNumber.Value,\n  decimals: number,\n  fiatRates: FiatRates,\n) {\n  const amountRawValue = new BigNumber(amountRawInput);\n  const amountHumanValue = amountRawValue.shiftedBy(-decimals);\n\n  const amountFiat = amountHumanValue\n    .multipliedBy(fiatRates.fiatRate)\n    .toString(10);\n\n  const amountUsd = amountHumanValue\n    .multipliedBy(fiatRates.usdRate)\n    .toString(10);\n\n  const amountRaw = amountRawValue.toFixed(0);\n  const amountHuman = amountHumanValue.toString(10);\n\n  return {\n    amountFiat,\n    amountHuman,\n    amountRaw,\n    amountUsd,\n  };\n}\n\n/**\n * Find token transfer data in a transaction.\n *\n * @param transactionMeta - Transaction metadata.\n * @returns - Token transfer data or undefined if not found.\n */\nfunction getTokenTransferData(transactionMeta: TransactionMeta):\n  | {\n      data: Hex;\n      to: Hex;\n      index?: number;\n    }\n  | undefined {\n  const { nestedTransactions, txParams } = transactionMeta;\n  const { data: singleData } = txParams;\n  const singleTo = txParams?.to as Hex | undefined;\n\n  if (singleData?.startsWith(FOUR_BYTE_TOKEN_TRANSFER) && singleTo) {\n    return { data: singleData as Hex, to: singleTo, index: undefined };\n  }\n\n  const nestedCallIndex = nestedTransactions?.findIndex((call) =>\n    call.data?.startsWith(FOUR_BYTE_TOKEN_TRANSFER),\n  );\n\n  const nestedCall =\n    nestedCallIndex !== undefined\n      ? nestedTransactions?.[nestedCallIndex]\n      : undefined;\n\n  if (nestedCall?.data && nestedCall.to) {\n    return {\n      data: nestedCall.data,\n      to: nestedCall.to,\n      index: nestedCallIndex,\n    };\n  }\n\n  return undefined;\n}\n"]}

package/dist/utils/required-tokens.d.cts

@@ -0,0 +1,11 @@
+import type { TransactionMeta } from "@metamask/transaction-controller";
+import type { TransactionPayControllerMessenger, TransactionPayRequiredToken } from "../types.cjs";
+/**
+ * Parse required tokens from a transaction.
+ *
+ * @param transaction - Transaction metadata.
+ * @param messenger - Controller messenger.
+ * @returns An array of required tokens.
+ */
+export declare function parseRequiredTokens(transaction: TransactionMeta, messenger: TransactionPayControllerMessenger): TransactionPayRequiredToken[];
+//# sourceMappingURL=required-tokens.d.cts.map

package/dist/utils/required-tokens.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"required-tokens.d.cts","sourceRoot":"","sources":["../../src/utils/required-tokens.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAUxE,OAAO,KAAK,EAEV,iCAAiC,EACjC,2BAA2B,EAC5B,qBAAiB;AAIlB;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,eAAe,EAC5B,SAAS,EAAE,iCAAiC,GAC3C,2BAA2B,EAAE,CAK/B"}