@metamask/transaction-controller 62.20.0 → 62.22.0

package/dist/utils/first-time-interaction.mjs

@@ -4,6 +4,25 @@ import { validateParamTo } from "./validation.mjs";
 import { getAccountAddressRelationship } from "../api/accounts-api.mjs";
 import { projectLogger as log } from "../logger.mjs";
 import { TransactionType } from "../types.mjs";
+const TOKEN_TRANSFER_TYPES = [
+    TransactionType.tokenMethodTransfer,
+    TransactionType.tokenMethodTransferFrom,
+];
+/**
+ * Returns the effective recipient for first-time-interaction checks (decoded from data for token transfers).
+ * Used when comparing existing transactions so we match by actual recipient, not txParams.to (contract for ERC20).
+ *
+ * @param tx - Transaction meta with txParams and type
+ * @returns Effective recipient address, or undefined
+ */
+function getEffectiveRecipient(tx) {
+    const { data, to } = tx?.txParams ?? {};
+    if (data && TOKEN_TRANSFER_TYPES.includes(tx?.type)) {
+        const parsed = decodeTransactionData(data);
+        return (parsed?.args?._to ?? parsed?.args?.to ?? to);
+    }
+    return to;
+}
 /**
  * Updates the first-time interaction status for a transaction.
  *
@@ -21,32 +40,21 @@ export async function updateFirstTimeInteraction({ existingTransactions, getTran
     if (!isFirstTimeInteractionEnabled()) {
         return;
     }
-    const { chainId, id: transactionId, txParams: { data, from, to }, type, } = transactionMeta;
-    let recipient;
-    if (data &&
-        [
-            TransactionType.tokenMethodTransfer,
-            TransactionType.tokenMethodTransferFrom,
-        ].includes(type)) {
-        const parsedData = decodeTransactionData(data);
-        // _to is for ERC20, ERC721 and USDC
-        // to is for ERC1155
-        recipient = parsedData?.args?._to ?? parsedData?.args?.to;
-    }
-    // Use as fallback if no recipient is found from decode or no data is present
-    recipient ?? (recipient = to);
+    const { chainId, id: transactionId, txParams: { from }, } = transactionMeta;
+    const recipient = getEffectiveRecipient(transactionMeta);
     const request = {
         chainId: hexToNumber(chainId),
         to: recipient,
         from,
     };
     validateParamTo(recipient);
-    const existingTransaction = existingTransactions.find((tx) => tx.chainId === chainId &&
-        tx.txParams.from.toLowerCase() === from.toLowerCase() &&
-        tx.txParams.to?.toLowerCase() === to?.toLowerCase() &&
-        tx.id !== transactionId);
-    // Check if there is an existing transaction with the same from, to, and chainId
-    // else we continue to check the account address relationship from API
+    const recipientLower = recipient?.toLowerCase();
+    const existingTransaction = existingTransactions.find((tx) => tx.id !== transactionId &&
+        tx.chainId === chainId &&
+        tx.txParams?.from?.toLowerCase() === from?.toLowerCase() &&
+        getEffectiveRecipient(tx)?.toLowerCase() === recipientLower);
+    // Skip API call only if we already have a tx with same from and same effective recipient (e.g. duplicate or pending).
+    // For ERC20, effective recipient is decoded from data; using txParams.to would wrongly match any send of that token.
     if (existingTransaction) {
         return;
     }

package/dist/utils/first-time-interaction.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"first-time-interaction.mjs","sourceRoot":"","sources":["../../src/utils/first-time-interaction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,wBAAwB;AAE9C,OAAO,EAAE,qBAAqB,EAAE,+BAA2B;AAC3D,OAAO,EAAE,eAAe,EAAE,yBAAqB;AAC/C,OAAO,EAAE,6BAA6B,EAAE,gCAA4B;AAEpE,OAAO,EAAE,aAAa,IAAI,GAAG,EAAE,sBAAkB;AACjD,OAAO,EAAE,eAAe,EAAE,qBAAiB;AAmB3C;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,EAC/C,oBAAoB,EACpB,cAAc,EACd,6BAA6B,EAC7B,KAAK,EACL,YAAY,EACZ,eAAe,EACf,iBAAiB,GACiB;IAClC,IAAI,CAAC,6BAA6B,EAAE,EAAE,CAAC;QACrC,OAAO;IACT,CAAC;IAED,MAAM,EACJ,OAAO,EACP,EAAE,EAAE,aAAa,EACjB,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,EAC5B,IAAI,GACL,GAAG,eAAe,CAAC;IAEpB,IAAI,SAAS,CAAC;IACd,IACE,IAAI;QACJ;YACE,eAAe,CAAC,mBAAmB;YACnC,eAAe,CAAC,uBAAuB;SACxC,CAAC,QAAQ,CAAC,IAAuB,CAAC,EACnC,CAAC;QACD,MAAM,UAAU,GAAG,qBAAqB,CAAC,IAAI,CAA2B,CAAC;QACzE,oCAAoC;QACpC,oBAAoB;QACpB,SAAS,GAAG,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC;IAC5D,CAAC;IAED,6EAA6E;IAC7E,SAAS,KAAT,SAAS,GAAK,EAAE,EAAC;IAEjB,MAAM,OAAO,GAAyC;QACpD,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAC7B,EAAE,EAAE,SAAmB;QACvB,IAAI;KACL,CAAC;IAEF,eAAe,CAAC,SAAS,CAAC,CAAC;IAE3B,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,IAAI,CACnD,CAAC,EAAE,EAAE,EAAE,CACL,EAAE,CAAC,OAAO,KAAK,OAAO;QACtB,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE;QACrD,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE;QACnD,EAAE,CAAC,EAAE,KAAK,aAAa,CAC1B,CAAC;IAEF,gFAAgF;IAChF,sEAAsE;IACtE,IAAI,mBAAmB,EAAE,CAAC;QACxB,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,KAAK,CAC3B,EAAE,IAAI,EAAE,8BAA8B,EAAE,aAAa,EAAE,YAAY,EAAE,EACrE,GAAG,EAAE,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAC7C,CAAC;QAEF,MAAM,sBAAsB,GAC1B,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC;QAEhD,MAAM,oBAAoB,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;QAE3D,wBAAwB;QACxB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,GAAG,CACD,+DAA+D,EAC/D,aAAa,CACd,CAAC;YACF,OAAO;QACT,CAAC;QAED,iBAAiB,CACf;YACE,aAAa;YACb,IAAI,EAAE,8EAA8E;SACrF,EACD,CAAC,MAAM,EAAE,EAAE;YACT,MAAM,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;QACzD,CAAC,CACF,CAAC;QAEF,GAAG,CAAC,gCAAgC,EAAE,aAAa,EAAE;YACnD,sBAAsB;SACvB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,GAAG,CACD,qFAAqF,EACrF,KAAK,CACN,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import type { TransactionDescription } from '@ethersproject/abi';\nimport type { TraceContext, TraceCallback } from '@metamask/controller-utils';\nimport { hexToNumber } from '@metamask/utils';\n\nimport { decodeTransactionData } from './transaction-type';\nimport { validateParamTo } from './validation';\nimport { getAccountAddressRelationship } from '../api/accounts-api';\nimport type { GetAccountAddressRelationshipRequest } from '../api/accounts-api';\nimport { projectLogger as log } from '../logger';\nimport { TransactionType } from '../types';\nimport type { TransactionMeta } from '../types';\n\ntype UpdateFirstTimeInteractionRequest = {\n  existingTransactions: TransactionMeta[];\n  getTransaction: (transactionId: string) => TransactionMeta | undefined;\n  isFirstTimeInteractionEnabled: () => boolean;\n  trace: TraceCallback;\n  traceContext?: TraceContext;\n  transactionMeta: TransactionMeta;\n  updateTransaction: (\n    updateParams: {\n      transactionId: string;\n      note: string;\n    },\n    updater: (txMeta: TransactionMeta) => void,\n  ) => void;\n};\n\n/**\n * Updates the first-time interaction status for a transaction.\n *\n * @param params - The parameters for updating first time interaction.\n * @param params.existingTransactions - The existing transactions.\n * @param params.getTransaction - Function to get a transaction by ID.\n * @param params.isFirstTimeInteractionEnabled - The function to check if first time interaction is enabled.\n * @param params.trace - The trace callback.\n * @param params.traceContext - The trace context.\n * @param params.transactionMeta - The transaction meta object.\n * @param params.updateTransaction - Function to update transaction internal state.\n * @returns Promise that resolves when the update is complete.\n */\nexport async function updateFirstTimeInteraction({\n  existingTransactions,\n  getTransaction,\n  isFirstTimeInteractionEnabled,\n  trace,\n  traceContext,\n  transactionMeta,\n  updateTransaction,\n}: UpdateFirstTimeInteractionRequest): Promise<void> {\n  if (!isFirstTimeInteractionEnabled()) {\n    return;\n  }\n\n  const {\n    chainId,\n    id: transactionId,\n    txParams: { data, from, to },\n    type,\n  } = transactionMeta;\n\n  let recipient;\n  if (\n    data &&\n    [\n      TransactionType.tokenMethodTransfer,\n      TransactionType.tokenMethodTransferFrom,\n    ].includes(type as TransactionType)\n  ) {\n    const parsedData = decodeTransactionData(data) as TransactionDescription;\n    // _to is for ERC20, ERC721 and USDC\n    // to is for ERC1155\n    recipient = parsedData?.args?._to ?? parsedData?.args?.to;\n  }\n\n  // Use as fallback if no recipient is found from decode or no data is present\n  recipient ??= to;\n\n  const request: GetAccountAddressRelationshipRequest = {\n    chainId: hexToNumber(chainId),\n    to: recipient as string,\n    from,\n  };\n\n  validateParamTo(recipient);\n\n  const existingTransaction = existingTransactions.find(\n    (tx) =>\n      tx.chainId === chainId &&\n      tx.txParams.from.toLowerCase() === from.toLowerCase() &&\n      tx.txParams.to?.toLowerCase() === to?.toLowerCase() &&\n      tx.id !== transactionId,\n  );\n\n  // Check if there is an existing transaction with the same from, to, and chainId\n  // else we continue to check the account address relationship from API\n  if (existingTransaction) {\n    return;\n  }\n\n  try {\n    const { count } = await trace(\n      { name: 'Account Address Relationship', parentContext: traceContext },\n      () => getAccountAddressRelationship(request),\n    );\n\n    const isFirstTimeInteraction =\n      count === undefined ? undefined : count === 0;\n\n    const finalTransactionMeta = getTransaction(transactionId);\n\n    /* istanbul ignore if */\n    if (!finalTransactionMeta) {\n      log(\n        'Cannot update first time interaction as transaction not found',\n        transactionId,\n      );\n      return;\n    }\n\n    updateTransaction(\n      {\n        transactionId,\n        note: 'TransactionController#updateFirstInteraction - Update first time interaction',\n      },\n      (txMeta) => {\n        txMeta.isFirstTimeInteraction = isFirstTimeInteraction;\n      },\n    );\n\n    log('Updated first time interaction', transactionId, {\n      isFirstTimeInteraction,\n    });\n  } catch (error) {\n    log(\n      'Error fetching account address relationship, skipping first time interaction update',\n      error,\n    );\n  }\n}\n"]}
+{"version":3,"file":"first-time-interaction.mjs","sourceRoot":"","sources":["../../src/utils/first-time-interaction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,wBAAwB;AAE9C,OAAO,EAAE,qBAAqB,EAAE,+BAA2B;AAC3D,OAAO,EAAE,eAAe,EAAE,yBAAqB;AAC/C,OAAO,EAAE,6BAA6B,EAAE,gCAA4B;AAEpE,OAAO,EAAE,aAAa,IAAI,GAAG,EAAE,sBAAkB;AACjD,OAAO,EAAE,eAAe,EAAE,qBAAiB;AAG3C,MAAM,oBAAoB,GAAG;IAC3B,eAAe,CAAC,mBAAmB;IACnC,eAAe,CAAC,uBAAuB;CACxC,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,EAAmB;IAChD,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,QAAQ,IAAI,EAAE,CAAC;IACxC,IAAI,IAAI,IAAI,oBAAoB,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAuB,CAAC,EAAE,CAAC;QACvE,MAAM,MAAM,GAAG,qBAAqB,CAAC,IAAI,CAA2B,CAAC;QACrE,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,CAAuB,CAAC;IAC7E,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAkBD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,EAC/C,oBAAoB,EACpB,cAAc,EACd,6BAA6B,EAC7B,KAAK,EACL,YAAY,EACZ,eAAe,EACf,iBAAiB,GACiB;IAClC,IAAI,CAAC,6BAA6B,EAAE,EAAE,CAAC;QACrC,OAAO;IACT,CAAC;IAED,MAAM,EACJ,OAAO,EACP,EAAE,EAAE,aAAa,EACjB,QAAQ,EAAE,EAAE,IAAI,EAAE,GACnB,GAAG,eAAe,CAAC;IAEpB,MAAM,SAAS,GAAG,qBAAqB,CAAC,eAAe,CAAC,CAAC;IAEzD,MAAM,OAAO,GAAyC;QACpD,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAC7B,EAAE,EAAE,SAAmB;QACvB,IAAI;KACL,CAAC;IAEF,eAAe,CAAC,SAAS,CAAC,CAAC;IAE3B,MAAM,cAAc,GAAG,SAAS,EAAE,WAAW,EAAE,CAAC;IAChD,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,IAAI,CACnD,CAAC,EAAE,EAAE,EAAE,CACL,EAAE,CAAC,EAAE,KAAK,aAAa;QACvB,EAAE,CAAC,OAAO,KAAK,OAAO;QACtB,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,EAAE,WAAW,EAAE;QACxD,qBAAqB,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,KAAK,cAAc,CAC9D,CAAC;IAEF,sHAAsH;IACtH,qHAAqH;IACrH,IAAI,mBAAmB,EAAE,CAAC;QACxB,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,KAAK,CAC3B,EAAE,IAAI,EAAE,8BAA8B,EAAE,aAAa,EAAE,YAAY,EAAE,EACrE,GAAG,EAAE,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAC7C,CAAC;QAEF,MAAM,sBAAsB,GAC1B,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC;QAEhD,MAAM,oBAAoB,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;QAE3D,wBAAwB;QACxB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,GAAG,CACD,+DAA+D,EAC/D,aAAa,CACd,CAAC;YACF,OAAO;QACT,CAAC;QAED,iBAAiB,CACf;YACE,aAAa;YACb,IAAI,EAAE,8EAA8E;SACrF,EACD,CAAC,MAAM,EAAE,EAAE;YACT,MAAM,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;QACzD,CAAC,CACF,CAAC;QAEF,GAAG,CAAC,gCAAgC,EAAE,aAAa,EAAE;YACnD,sBAAsB;SACvB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,GAAG,CACD,qFAAqF,EACrF,KAAK,CACN,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import type { TransactionDescription } from '@ethersproject/abi';\nimport type { TraceContext, TraceCallback } from '@metamask/controller-utils';\nimport { hexToNumber } from '@metamask/utils';\n\nimport { decodeTransactionData } from './transaction-type';\nimport { validateParamTo } from './validation';\nimport { getAccountAddressRelationship } from '../api/accounts-api';\nimport type { GetAccountAddressRelationshipRequest } from '../api/accounts-api';\nimport { projectLogger as log } from '../logger';\nimport { TransactionType } from '../types';\nimport type { TransactionMeta } from '../types';\n\nconst TOKEN_TRANSFER_TYPES = [\n  TransactionType.tokenMethodTransfer,\n  TransactionType.tokenMethodTransferFrom,\n];\n\n/**\n * Returns the effective recipient for first-time-interaction checks (decoded from data for token transfers).\n * Used when comparing existing transactions so we match by actual recipient, not txParams.to (contract for ERC20).\n *\n * @param tx - Transaction meta with txParams and type\n * @returns Effective recipient address, or undefined\n */\nfunction getEffectiveRecipient(tx: TransactionMeta): string | undefined {\n  const { data, to } = tx?.txParams ?? {};\n  if (data && TOKEN_TRANSFER_TYPES.includes(tx?.type as TransactionType)) {\n    const parsed = decodeTransactionData(data) as TransactionDescription;\n    return (parsed?.args?._to ?? parsed?.args?.to ?? to) as string | undefined;\n  }\n  return to;\n}\n\ntype UpdateFirstTimeInteractionRequest = {\n  existingTransactions: TransactionMeta[];\n  getTransaction: (transactionId: string) => TransactionMeta | undefined;\n  isFirstTimeInteractionEnabled: () => boolean;\n  trace: TraceCallback;\n  traceContext?: TraceContext;\n  transactionMeta: TransactionMeta;\n  updateTransaction: (\n    updateParams: {\n      transactionId: string;\n      note: string;\n    },\n    updater: (txMeta: TransactionMeta) => void,\n  ) => void;\n};\n\n/**\n * Updates the first-time interaction status for a transaction.\n *\n * @param params - The parameters for updating first time interaction.\n * @param params.existingTransactions - The existing transactions.\n * @param params.getTransaction - Function to get a transaction by ID.\n * @param params.isFirstTimeInteractionEnabled - The function to check if first time interaction is enabled.\n * @param params.trace - The trace callback.\n * @param params.traceContext - The trace context.\n * @param params.transactionMeta - The transaction meta object.\n * @param params.updateTransaction - Function to update transaction internal state.\n * @returns Promise that resolves when the update is complete.\n */\nexport async function updateFirstTimeInteraction({\n  existingTransactions,\n  getTransaction,\n  isFirstTimeInteractionEnabled,\n  trace,\n  traceContext,\n  transactionMeta,\n  updateTransaction,\n}: UpdateFirstTimeInteractionRequest): Promise<void> {\n  if (!isFirstTimeInteractionEnabled()) {\n    return;\n  }\n\n  const {\n    chainId,\n    id: transactionId,\n    txParams: { from },\n  } = transactionMeta;\n\n  const recipient = getEffectiveRecipient(transactionMeta);\n\n  const request: GetAccountAddressRelationshipRequest = {\n    chainId: hexToNumber(chainId),\n    to: recipient as string,\n    from,\n  };\n\n  validateParamTo(recipient);\n\n  const recipientLower = recipient?.toLowerCase();\n  const existingTransaction = existingTransactions.find(\n    (tx) =>\n      tx.id !== transactionId &&\n      tx.chainId === chainId &&\n      tx.txParams?.from?.toLowerCase() === from?.toLowerCase() &&\n      getEffectiveRecipient(tx)?.toLowerCase() === recipientLower,\n  );\n\n  // Skip API call only if we already have a tx with same from and same effective recipient (e.g. duplicate or pending).\n  // For ERC20, effective recipient is decoded from data; using txParams.to would wrongly match any send of that token.\n  if (existingTransaction) {\n    return;\n  }\n\n  try {\n    const { count } = await trace(\n      { name: 'Account Address Relationship', parentContext: traceContext },\n      () => getAccountAddressRelationship(request),\n    );\n\n    const isFirstTimeInteraction =\n      count === undefined ? undefined : count === 0;\n\n    const finalTransactionMeta = getTransaction(transactionId);\n\n    /* istanbul ignore if */\n    if (!finalTransactionMeta) {\n      log(\n        'Cannot update first time interaction as transaction not found',\n        transactionId,\n      );\n      return;\n    }\n\n    updateTransaction(\n      {\n        transactionId,\n        note: 'TransactionController#updateFirstInteraction - Update first time interaction',\n      },\n      (txMeta) => {\n        txMeta.isFirstTimeInteraction = isFirstTimeInteraction;\n      },\n    );\n\n    log('Updated first time interaction', transactionId, {\n      isFirstTimeInteraction,\n    });\n  } catch (error) {\n    log(\n      'Error fetching account address relationship, skipping first time interaction update',\n      error,\n    );\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/transaction-controller",
-  "version": "62.20.0",
+  "version": "62.22.0",
   "description": "Stores transactions alongside their periodically updated statuses and manages interactions such as approval and cancellation",
   "keywords": [
     "MetaMask",
@@ -54,11 +54,11 @@
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.7.0",
     "@ethersproject/wallet": "^5.7.0",
-    "@metamask/accounts-controller": "^36.0.1",
+    "@metamask/accounts-controller": "^37.0.0",
     "@metamask/approval-controller": "^8.0.0",
     "@metamask/base-controller": "^9.0.0",
     "@metamask/controller-utils": "^11.19.0",
-    "@metamask/core-backend": "^6.0.0",
+    "@metamask/core-backend": "^6.1.1",
     "@metamask/eth-query": "^4.0.0",
     "@metamask/gas-fee-controller": "^26.0.3",
     "@metamask/messenger": "^0.3.0",