@metamask/transaction-pay-controller 19.0.3 → 19.1.0

package/dist/utils/source-amounts.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"source-amounts.d.cts","sourceRoot":"","sources":["../../src/utils/source-amounts.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,iCAAiC,EAElC,qBAAW;AAKZ,OAAO,KAAK,EAEV,eAAe,EAEhB,qBAAiB;AAIlB;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,eAAe,GAAG,SAAS,EAC5C,SAAS,EAAE,iCAAiC,GAC3C,IAAI,CAuCN"}
+{"version":3,"file":"source-amounts.d.cts","sourceRoot":"","sources":["../../src/utils/source-amounts.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,iCAAiC,EAElC,qBAAW;AAKZ,OAAO,KAAK,EAEV,eAAe,EAEhB,qBAAiB;AAIlB;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,eAAe,GAAG,SAAS,EAC5C,SAAS,EAAE,iCAAiC,GAC3C,IAAI,CAyCN"}

package/dist/utils/source-amounts.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"source-amounts.d.mts","sourceRoot":"","sources":["../../src/utils/source-amounts.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,iCAAiC,EAElC,qBAAW;AAKZ,OAAO,KAAK,EAEV,eAAe,EAEhB,qBAAiB;AAIlB;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,eAAe,GAAG,SAAS,EAC5C,SAAS,EAAE,iCAAiC,GAC3C,IAAI,CAuCN"}
+{"version":3,"file":"source-amounts.d.mts","sourceRoot":"","sources":["../../src/utils/source-amounts.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,iCAAiC,EAElC,qBAAW;AAKZ,OAAO,KAAK,EAEV,eAAe,EAEhB,qBAAiB;AAIlB;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,eAAe,GAAG,SAAS,EAC5C,SAAS,EAAE,iCAAiC,GAC3C,IAAI,CAyCN"}

package/dist/utils/source-amounts.mjs

@@ -1,3 +1,4 @@
+import { TransactionType } from "@metamask/transaction-controller";
 import { createModuleLogger } from "@metamask/utils";
 import { BigNumber } from "bignumber.js";
 import { getTokenFiatRate, isSameToken } from "./token.mjs";
@@ -24,7 +25,8 @@ export function updateSourceAmounts(transactionId, transactionData, messenger) {
     // For post-quote flows, source amounts are calculated differently
     // The source is the transaction's required token, not the selected token
     if (isPostQuote) {
-        const sourceAmounts = calculatePostQuoteSourceAmounts(tokens, paymentToken, isMaxAmount ?? false);
+        const { isHyperliquidSource } = transactionData;
+        const sourceAmounts = calculatePostQuoteSourceAmounts(tokens, paymentToken, isMaxAmount ?? false, isHyperliquidSource);
         log('Updated post-quote source amounts', { transactionId, sourceAmounts });
         transactionData.sourceAmounts = sourceAmounts;
         return;
@@ -43,9 +45,10 @@ export function updateSourceAmounts(transactionId, transactionData, messenger) {
  * @param tokens - Required tokens from the transaction.
  * @param paymentToken - Selected payment/destination token.
  * @param isMaxAmount - Whether the transaction is a maximum amount transaction.
+ * @param isHyperliquidSource - Whether the source is HyperLiquid (perps withdrawal).
  * @returns Array of source amounts.
  */
-function calculatePostQuoteSourceAmounts(tokens, paymentToken, isMaxAmount) {
+function calculatePostQuoteSourceAmounts(tokens, paymentToken, isMaxAmount, isHyperliquidSource) {
     return tokens
         .filter((token) => {
         if (token.skipIfBalance) {
@@ -56,8 +59,11 @@ function calculatePostQuoteSourceAmounts(tokens, paymentToken, isMaxAmount) {
             log('Skipping token as zero amount', { tokenAddress: token.address });
             return false;
         }
-        // Skip same token on same chain
-        if (isSameToken(token, paymentToken)) {
+        // Skip same token on same chain, unless the source is HyperLiquid.
+        // For HyperLiquid withdrawals the relay strategy renormalizes the
+        // source from Arbitrum USDC to HyperCore USDC (a different chain),
+        // so the tokens are not actually the same after normalization.
+        if (isSameToken(token, paymentToken) && !isHyperliquidSource) {
             log('Skipping token as same as destination token');
             return false;
         }
@@ -94,8 +100,8 @@ function calculateSourceAmount(paymentToken, token, messenger, transactionId, is
         });
         return undefined;
     }
-    const strategy = getStrategyType(transactionId, messenger);
-    const isAlwaysRequired = isQuoteAlwaysRequired(token, strategy);
+    const { parentTransactionType, strategy } = getStrategyContext(transactionId, messenger);
+    const isAlwaysRequired = isQuoteAlwaysRequired(token, strategy, parentTransactionType);
     if (isSameToken(token, paymentToken) && !isAlwaysRequired) {
         log('Skipping token as same as payment token');
         return undefined;
@@ -127,22 +133,22 @@ function calculateSourceAmount(paymentToken, token, messenger, transactionId, is
  *
  * @param token - Target token.
  * @param strategy - Payment strategy.
+ * @param parentTransactionType - Parent transaction type, if available.
  * @returns True if a quote is always required, false otherwise.
  */
-function isQuoteAlwaysRequired(token, strategy) {
+function isQuoteAlwaysRequired(token, strategy, parentTransactionType) {
     const isHyperliquidDeposit = token.chainId === CHAIN_ID_ARBITRUM &&
         token.address.toLowerCase() === ARBITRUM_USDC_ADDRESS.toLowerCase();
-    return strategy === TransactionPayStrategy.Relay && isHyperliquidDeposit;
+    return (isHyperliquidDeposit &&
+        (strategy === TransactionPayStrategy.Relay ||
+            (strategy === TransactionPayStrategy.Across &&
+                parentTransactionType === TransactionType.perpsDeposit)));
 }
-/**
- * Get the strategy type for a transaction.
- *
- * @param transactionId - ID of the transaction.
- * @param messenger - Controller messenger.
- * @returns Payment strategy type.
- */
-function getStrategyType(transactionId, messenger) {
+function getStrategyContext(transactionId, messenger) {
     const transaction = getTransaction(transactionId, messenger);
-    return messenger.call('TransactionPayController:getStrategy', transaction);
+    return {
+        parentTransactionType: transaction.type,
+        strategy: messenger.call('TransactionPayController:getStrategy', transaction),
+    };
 }
 //# sourceMappingURL=source-amounts.mjs.map

package/dist/utils/source-amounts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"source-amounts.mjs","sourceRoot":"","sources":["../../src/utils/source-amounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;AACrD,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAEzC,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,oBAAgB;AACxD,OAAO,EAAE,cAAc,EAAE,0BAAsB;AAK/C,OAAO,EAAE,sBAAsB,EAAE,qBAAW;AAE5C,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,yBAAqB;AACxE,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAO1C,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,aAAqB,EACrB,eAA4C,EAC5C,SAA4C;IAE5C,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO;IACT,CAAC;IAED,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;IAE3E,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QACpC,OAAO;IACT,CAAC;IAED,kEAAkE;IAClE,yEAAyE;IACzE,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,aAAa,GAAG,+BAA+B,CACnD,MAAM,EACN,YAAY,EACZ,WAAW,IAAI,KAAK,CACrB,CAAC;QACF,GAAG,CAAC,mCAAmC,EAAE,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC,CAAC;QAC3E,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC;QAC9C,OAAO;IACT,CAAC;IAED,MAAM,aAAa,GAAG,MAAM;SACzB,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CACnB,qBAAqB,CACnB,YAAY,EACZ,WAAW,EACX,SAAS,EACT,aAAa,EACb,WAAW,IAAI,KAAK,CACrB,CACF;SACA,MAAM,CAAC,OAAO,CAAiC,CAAC;IAEnD,GAAG,CAAC,wBAAwB,EAAE,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC,CAAC;IAEhE,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC;AAChD,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,+BAA+B,CACtC,MAAqC,EACrC,YAAqC,EACrC,WAAoB;IAEpB,OAAO,MAAM;SACV,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QAChB,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,8DAA8D;QAC9D,IAAI,KAAK,CAAC,SAAS,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5C,GAAG,CAAC,+BAA+B,EAAE,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,gCAAgC;QAChC,IAAI,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,6CAA6C,CAAC,CAAC;YACnD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACf,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW;QACvE,eAAe,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS;QACjE,gBAAgB,EAAE,KAAK,CAAC,UAAU;QAClC,aAAa,EAAE,KAAK,CAAC,OAAO;QAC5B,kBAAkB,EAAE,KAAK,CAAC,OAAO;QACjC,kBAAkB,EAAE,YAAY,CAAC,OAAO;KACzC,CAAC,CAAC,CAAC;AACR,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,qBAAqB,CAC5B,YAAqC,EACrC,KAAkC,EAClC,SAA4C,EAC5C,aAAqB,EACrB,WAAoB;IAEpB,MAAM,oBAAoB,GAAG,gBAAgB,CAC3C,SAAS,EACT,YAAY,CAAC,OAAO,EACpB,YAAY,CAAC,OAAO,CACrB,CAAC;IAEF,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAExE,IAAI,KAAK,CAAC,aAAa,IAAI,UAAU,EAAE,CAAC;QACtC,GAAG,CAAC,sCAAsC,EAAE;YAC1C,YAAY,EAAE,KAAK,CAAC,OAAO;SAC5B,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,eAAe,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAEhE,IAAI,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1D,GAAG,CAAC,yCAAyC,CAAC,CAAC;QAC/C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,sBAAsB,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,CAC/D,oBAAoB,CAAC,OAAO,CAC7B,CAAC;IAEF,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAE9D,MAAM,eAAe,GAAG,sBAAsB;SAC3C,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC;SAChC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd,IAAI,KAAK,CAAC,SAAS,KAAK,GAAG,EAAE,CAAC;QAC5B,GAAG,CAAC,+BAA+B,EAAE,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACtE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO;YACL,iBAAiB,EAAE,YAAY,CAAC,YAAY;YAC5C,eAAe,EAAE,YAAY,CAAC,UAAU;YACxC,kBAAkB,EAAE,KAAK,CAAC,OAAO;SAClC,CAAC;IACJ,CAAC;IAED,OAAO;QACL,iBAAiB;QACjB,eAAe;QACf,kBAAkB,EAAE,KAAK,CAAC,OAAO;KAClC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAC5B,KAAkC,EAClC,QAAgC;IAEhC,MAAM,oBAAoB,GACxB,KAAK,CAAC,OAAO,KAAK,iBAAiB;QACnC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,qBAAqB,CAAC,WAAW,EAAE,CAAC;IAEtE,OAAO,QAAQ,KAAK,sBAAsB,CAAC,KAAK,IAAI,oBAAoB,CAAC;AAC3E,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CACtB,aAAqB,EACrB,SAA4C;IAE5C,MAAM,WAAW,GAAG,cAAc,CAChC,aAAa,EACb,SAAS,CACS,CAAC;IAErB,OAAO,SAAS,CAAC,IAAI,CAAC,sCAAsC,EAAE,WAAW,CAAC,CAAC;AAC7E,CAAC","sourcesContent":["import { createModuleLogger } from '@metamask/utils';\nimport { BigNumber } from 'bignumber.js';\n\nimport { getTokenFiatRate, isSameToken } from './token';\nimport { getTransaction } from './transaction';\nimport type {\n  TransactionPayControllerMessenger,\n  TransactionPaymentToken,\n} from '..';\nimport { TransactionPayStrategy } from '..';\nimport type { TransactionMeta } from '../../../transaction-controller/src';\nimport { ARBITRUM_USDC_ADDRESS, CHAIN_ID_ARBITRUM } from '../constants';\nimport { projectLogger } from '../logger';\nimport type {\n  TransactionPaySourceAmount,\n  TransactionData,\n  TransactionPayRequiredToken,\n} from '../types';\n\nconst log = createModuleLogger(projectLogger, 'source-amounts');\n\n/**\n * Update the source amounts for a transaction.\n *\n * @param transactionId - ID of the transaction to update.\n * @param transactionData - Existing transaction data.\n * @param messenger - Controller messenger.\n */\nexport function updateSourceAmounts(\n  transactionId: string,\n  transactionData: TransactionData | undefined,\n  messenger: TransactionPayControllerMessenger,\n): void {\n  if (!transactionData) {\n    return;\n  }\n\n  const { isMaxAmount, isPostQuote, paymentToken, tokens } = transactionData;\n\n  if (!tokens.length || !paymentToken) {\n    return;\n  }\n\n  // For post-quote flows, source amounts are calculated differently\n  // The source is the transaction's required token, not the selected token\n  if (isPostQuote) {\n    const sourceAmounts = calculatePostQuoteSourceAmounts(\n      tokens,\n      paymentToken,\n      isMaxAmount ?? false,\n    );\n    log('Updated post-quote source amounts', { transactionId, sourceAmounts });\n    transactionData.sourceAmounts = sourceAmounts;\n    return;\n  }\n\n  const sourceAmounts = tokens\n    .map((singleToken) =>\n      calculateSourceAmount(\n        paymentToken,\n        singleToken,\n        messenger,\n        transactionId,\n        isMaxAmount ?? false,\n      ),\n    )\n    .filter(Boolean) as TransactionPaySourceAmount[];\n\n  log('Updated source amounts', { transactionId, sourceAmounts });\n\n  transactionData.sourceAmounts = sourceAmounts;\n}\n\n/**\n * Calculate source amounts for post-quote flows.\n * In this flow, the required tokens ARE the source tokens,\n * and the payment token is the target (destination).\n *\n * @param tokens - Required tokens from the transaction.\n * @param paymentToken - Selected payment/destination token.\n * @param isMaxAmount - Whether the transaction is a maximum amount transaction.\n * @returns Array of source amounts.\n */\nfunction calculatePostQuoteSourceAmounts(\n  tokens: TransactionPayRequiredToken[],\n  paymentToken: TransactionPaymentToken,\n  isMaxAmount: boolean,\n): TransactionPaySourceAmount[] {\n  return tokens\n    .filter((token) => {\n      if (token.skipIfBalance) {\n        return false;\n      }\n\n      // Skip zero amounts (unless max amount, where we use balance)\n      if (token.amountRaw === '0' && !isMaxAmount) {\n        log('Skipping token as zero amount', { tokenAddress: token.address });\n        return false;\n      }\n\n      // Skip same token on same chain\n      if (isSameToken(token, paymentToken)) {\n        log('Skipping token as same as destination token');\n        return false;\n      }\n\n      return true;\n    })\n    .map((token) => ({\n      sourceAmountHuman: isMaxAmount ? token.balanceHuman : token.amountHuman,\n      sourceAmountRaw: isMaxAmount ? token.balanceRaw : token.amountRaw,\n      sourceBalanceRaw: token.balanceRaw,\n      sourceChainId: token.chainId,\n      sourceTokenAddress: token.address,\n      targetTokenAddress: paymentToken.address,\n    }));\n}\n\n/**\n * Calculate the required source amount for a payment token to cover a target token.\n *\n * @param paymentToken - Selected payment token.\n * @param token - Target token to cover.\n * @param messenger - Controller messenger.\n * @param transactionId - ID of the transaction.\n * @param isMaxAmount - Whether the transaction is a maximum amount transaction.\n * @returns The source amount or undefined if calculation failed.\n */\nfunction calculateSourceAmount(\n  paymentToken: TransactionPaymentToken,\n  token: TransactionPayRequiredToken,\n  messenger: TransactionPayControllerMessenger,\n  transactionId: string,\n  isMaxAmount: boolean,\n): TransactionPaySourceAmount | undefined {\n  const paymentTokenFiatRate = getTokenFiatRate(\n    messenger,\n    paymentToken.address,\n    paymentToken.chainId,\n  );\n\n  if (!paymentTokenFiatRate) {\n    return undefined;\n  }\n\n  const hasBalance = new BigNumber(token.balanceRaw).gte(token.amountRaw);\n\n  if (token.skipIfBalance && hasBalance) {\n    log('Skipping token as sufficient balance', {\n      tokenAddress: token.address,\n    });\n    return undefined;\n  }\n\n  const strategy = getStrategyType(transactionId, messenger);\n  const isAlwaysRequired = isQuoteAlwaysRequired(token, strategy);\n\n  if (isSameToken(token, paymentToken) && !isAlwaysRequired) {\n    log('Skipping token as same as payment token');\n    return undefined;\n  }\n\n  const sourceAmountHumanValue = new BigNumber(token.amountUsd).div(\n    paymentTokenFiatRate.usdRate,\n  );\n\n  const sourceAmountHuman = sourceAmountHumanValue.toString(10);\n\n  const sourceAmountRaw = sourceAmountHumanValue\n    .shiftedBy(paymentToken.decimals)\n    .toFixed(0);\n\n  if (token.amountRaw === '0') {\n    log('Skipping token as zero amount', { tokenAddress: token.address });\n    return undefined;\n  }\n\n  if (isMaxAmount) {\n    return {\n      sourceAmountHuman: paymentToken.balanceHuman,\n      sourceAmountRaw: paymentToken.balanceRaw,\n      targetTokenAddress: token.address,\n    };\n  }\n\n  return {\n    sourceAmountHuman,\n    sourceAmountRaw,\n    targetTokenAddress: token.address,\n  };\n}\n\n/**\n * Determine if a quote is always required for a token and strategy.\n *\n * @param token - Target token.\n * @param strategy - Payment strategy.\n * @returns True if a quote is always required, false otherwise.\n */\nfunction isQuoteAlwaysRequired(\n  token: TransactionPayRequiredToken,\n  strategy: TransactionPayStrategy,\n): boolean {\n  const isHyperliquidDeposit =\n    token.chainId === CHAIN_ID_ARBITRUM &&\n    token.address.toLowerCase() === ARBITRUM_USDC_ADDRESS.toLowerCase();\n\n  return strategy === TransactionPayStrategy.Relay && isHyperliquidDeposit;\n}\n\n/**\n * Get the strategy type for a transaction.\n *\n * @param transactionId - ID of the transaction.\n * @param messenger - Controller messenger.\n * @returns Payment strategy type.\n */\nfunction getStrategyType(\n  transactionId: string,\n  messenger: TransactionPayControllerMessenger,\n): TransactionPayStrategy {\n  const transaction = getTransaction(\n    transactionId,\n    messenger,\n  ) as TransactionMeta;\n\n  return messenger.call('TransactionPayController:getStrategy', transaction);\n}\n"]}
+{"version":3,"file":"source-amounts.mjs","sourceRoot":"","sources":["../../src/utils/source-amounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,yCAAyC;AACnE,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;AACrD,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAEzC,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,oBAAgB;AACxD,OAAO,EAAE,cAAc,EAAE,0BAAsB;AAK/C,OAAO,EAAE,sBAAsB,EAAE,qBAAW;AAE5C,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,yBAAqB;AACxE,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAO1C,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,aAAqB,EACrB,eAA4C,EAC5C,SAA4C;IAE5C,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO;IACT,CAAC;IAED,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;IAE3E,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QACpC,OAAO;IACT,CAAC;IAED,kEAAkE;IAClE,yEAAyE;IACzE,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAC;QAChD,MAAM,aAAa,GAAG,+BAA+B,CACnD,MAAM,EACN,YAAY,EACZ,WAAW,IAAI,KAAK,EACpB,mBAAmB,CACpB,CAAC;QACF,GAAG,CAAC,mCAAmC,EAAE,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC,CAAC;QAC3E,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC;QAC9C,OAAO;IACT,CAAC;IAED,MAAM,aAAa,GAAG,MAAM;SACzB,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CACnB,qBAAqB,CACnB,YAAY,EACZ,WAAW,EACX,SAAS,EACT,aAAa,EACb,WAAW,IAAI,KAAK,CACrB,CACF;SACA,MAAM,CAAC,OAAO,CAAiC,CAAC;IAEnD,GAAG,CAAC,wBAAwB,EAAE,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC,CAAC;IAEhE,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC;AAChD,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,+BAA+B,CACtC,MAAqC,EACrC,YAAqC,EACrC,WAAoB,EACpB,mBAA6B;IAE7B,OAAO,MAAM;SACV,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QAChB,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,8DAA8D;QAC9D,IAAI,KAAK,CAAC,SAAS,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5C,GAAG,CAAC,+BAA+B,EAAE,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,mEAAmE;QACnE,kEAAkE;QAClE,mEAAmE;QACnE,+DAA+D;QAC/D,IAAI,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7D,GAAG,CAAC,6CAA6C,CAAC,CAAC;YACnD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACf,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW;QACvE,eAAe,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS;QACjE,gBAAgB,EAAE,KAAK,CAAC,UAAU;QAClC,aAAa,EAAE,KAAK,CAAC,OAAO;QAC5B,kBAAkB,EAAE,KAAK,CAAC,OAAO;QACjC,kBAAkB,EAAE,YAAY,CAAC,OAAO;KACzC,CAAC,CAAC,CAAC;AACR,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,qBAAqB,CAC5B,YAAqC,EACrC,KAAkC,EAClC,SAA4C,EAC5C,aAAqB,EACrB,WAAoB;IAEpB,MAAM,oBAAoB,GAAG,gBAAgB,CAC3C,SAAS,EACT,YAAY,CAAC,OAAO,EACpB,YAAY,CAAC,OAAO,CACrB,CAAC;IAEF,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAExE,IAAI,KAAK,CAAC,aAAa,IAAI,UAAU,EAAE,CAAC;QACtC,GAAG,CAAC,sCAAsC,EAAE;YAC1C,YAAY,EAAE,KAAK,CAAC,OAAO;SAC5B,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,EAAE,qBAAqB,EAAE,QAAQ,EAAE,GAAG,kBAAkB,CAC5D,aAAa,EACb,SAAS,CACV,CAAC;IACF,MAAM,gBAAgB,GAAG,qBAAqB,CAC5C,KAAK,EACL,QAAQ,EACR,qBAAqB,CACtB,CAAC;IAEF,IAAI,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1D,GAAG,CAAC,yCAAyC,CAAC,CAAC;QAC/C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,sBAAsB,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,CAC/D,oBAAoB,CAAC,OAAO,CAC7B,CAAC;IAEF,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAE9D,MAAM,eAAe,GAAG,sBAAsB;SAC3C,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC;SAChC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd,IAAI,KAAK,CAAC,SAAS,KAAK,GAAG,EAAE,CAAC;QAC5B,GAAG,CAAC,+BAA+B,EAAE,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACtE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO;YACL,iBAAiB,EAAE,YAAY,CAAC,YAAY;YAC5C,eAAe,EAAE,YAAY,CAAC,UAAU;YACxC,kBAAkB,EAAE,KAAK,CAAC,OAAO;SAClC,CAAC;IACJ,CAAC;IAED,OAAO;QACL,iBAAiB;QACjB,eAAe;QACf,kBAAkB,EAAE,KAAK,CAAC,OAAO;KAClC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,qBAAqB,CAC5B,KAAkC,EAClC,QAAgC,EAChC,qBAAuC;IAEvC,MAAM,oBAAoB,GACxB,KAAK,CAAC,OAAO,KAAK,iBAAiB;QACnC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,qBAAqB,CAAC,WAAW,EAAE,CAAC;IAEtE,OAAO,CACL,oBAAoB;QACpB,CAAC,QAAQ,KAAK,sBAAsB,CAAC,KAAK;YACxC,CAAC,QAAQ,KAAK,sBAAsB,CAAC,MAAM;gBACzC,qBAAqB,KAAK,eAAe,CAAC,YAAY,CAAC,CAAC,CAC7D,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CACzB,aAAqB,EACrB,SAA4C;IAK5C,MAAM,WAAW,GAAG,cAAc,CAChC,aAAa,EACb,SAAS,CACS,CAAC;IAErB,OAAO;QACL,qBAAqB,EAAE,WAAW,CAAC,IAAI;QACvC,QAAQ,EAAE,SAAS,CAAC,IAAI,CACtB,sCAAsC,EACtC,WAAW,CACZ;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { TransactionType } from '@metamask/transaction-controller';\nimport { createModuleLogger } from '@metamask/utils';\nimport { BigNumber } from 'bignumber.js';\n\nimport { getTokenFiatRate, isSameToken } from './token';\nimport { getTransaction } from './transaction';\nimport type {\n  TransactionPayControllerMessenger,\n  TransactionPaymentToken,\n} from '..';\nimport { TransactionPayStrategy } from '..';\nimport type { TransactionMeta } from '../../../transaction-controller/src';\nimport { ARBITRUM_USDC_ADDRESS, CHAIN_ID_ARBITRUM } from '../constants';\nimport { projectLogger } from '../logger';\nimport type {\n  TransactionPaySourceAmount,\n  TransactionData,\n  TransactionPayRequiredToken,\n} from '../types';\n\nconst log = createModuleLogger(projectLogger, 'source-amounts');\n\n/**\n * Update the source amounts for a transaction.\n *\n * @param transactionId - ID of the transaction to update.\n * @param transactionData - Existing transaction data.\n * @param messenger - Controller messenger.\n */\nexport function updateSourceAmounts(\n  transactionId: string,\n  transactionData: TransactionData | undefined,\n  messenger: TransactionPayControllerMessenger,\n): void {\n  if (!transactionData) {\n    return;\n  }\n\n  const { isMaxAmount, isPostQuote, paymentToken, tokens } = transactionData;\n\n  if (!tokens.length || !paymentToken) {\n    return;\n  }\n\n  // For post-quote flows, source amounts are calculated differently\n  // The source is the transaction's required token, not the selected token\n  if (isPostQuote) {\n    const { isHyperliquidSource } = transactionData;\n    const sourceAmounts = calculatePostQuoteSourceAmounts(\n      tokens,\n      paymentToken,\n      isMaxAmount ?? false,\n      isHyperliquidSource,\n    );\n    log('Updated post-quote source amounts', { transactionId, sourceAmounts });\n    transactionData.sourceAmounts = sourceAmounts;\n    return;\n  }\n\n  const sourceAmounts = tokens\n    .map((singleToken) =>\n      calculateSourceAmount(\n        paymentToken,\n        singleToken,\n        messenger,\n        transactionId,\n        isMaxAmount ?? false,\n      ),\n    )\n    .filter(Boolean) as TransactionPaySourceAmount[];\n\n  log('Updated source amounts', { transactionId, sourceAmounts });\n\n  transactionData.sourceAmounts = sourceAmounts;\n}\n\n/**\n * Calculate source amounts for post-quote flows.\n * In this flow, the required tokens ARE the source tokens,\n * and the payment token is the target (destination).\n *\n * @param tokens - Required tokens from the transaction.\n * @param paymentToken - Selected payment/destination token.\n * @param isMaxAmount - Whether the transaction is a maximum amount transaction.\n * @param isHyperliquidSource - Whether the source is HyperLiquid (perps withdrawal).\n * @returns Array of source amounts.\n */\nfunction calculatePostQuoteSourceAmounts(\n  tokens: TransactionPayRequiredToken[],\n  paymentToken: TransactionPaymentToken,\n  isMaxAmount: boolean,\n  isHyperliquidSource?: boolean,\n): TransactionPaySourceAmount[] {\n  return tokens\n    .filter((token) => {\n      if (token.skipIfBalance) {\n        return false;\n      }\n\n      // Skip zero amounts (unless max amount, where we use balance)\n      if (token.amountRaw === '0' && !isMaxAmount) {\n        log('Skipping token as zero amount', { tokenAddress: token.address });\n        return false;\n      }\n\n      // Skip same token on same chain, unless the source is HyperLiquid.\n      // For HyperLiquid withdrawals the relay strategy renormalizes the\n      // source from Arbitrum USDC to HyperCore USDC (a different chain),\n      // so the tokens are not actually the same after normalization.\n      if (isSameToken(token, paymentToken) && !isHyperliquidSource) {\n        log('Skipping token as same as destination token');\n        return false;\n      }\n\n      return true;\n    })\n    .map((token) => ({\n      sourceAmountHuman: isMaxAmount ? token.balanceHuman : token.amountHuman,\n      sourceAmountRaw: isMaxAmount ? token.balanceRaw : token.amountRaw,\n      sourceBalanceRaw: token.balanceRaw,\n      sourceChainId: token.chainId,\n      sourceTokenAddress: token.address,\n      targetTokenAddress: paymentToken.address,\n    }));\n}\n\n/**\n * Calculate the required source amount for a payment token to cover a target token.\n *\n * @param paymentToken - Selected payment token.\n * @param token - Target token to cover.\n * @param messenger - Controller messenger.\n * @param transactionId - ID of the transaction.\n * @param isMaxAmount - Whether the transaction is a maximum amount transaction.\n * @returns The source amount or undefined if calculation failed.\n */\nfunction calculateSourceAmount(\n  paymentToken: TransactionPaymentToken,\n  token: TransactionPayRequiredToken,\n  messenger: TransactionPayControllerMessenger,\n  transactionId: string,\n  isMaxAmount: boolean,\n): TransactionPaySourceAmount | undefined {\n  const paymentTokenFiatRate = getTokenFiatRate(\n    messenger,\n    paymentToken.address,\n    paymentToken.chainId,\n  );\n\n  if (!paymentTokenFiatRate) {\n    return undefined;\n  }\n\n  const hasBalance = new BigNumber(token.balanceRaw).gte(token.amountRaw);\n\n  if (token.skipIfBalance && hasBalance) {\n    log('Skipping token as sufficient balance', {\n      tokenAddress: token.address,\n    });\n    return undefined;\n  }\n\n  const { parentTransactionType, strategy } = getStrategyContext(\n    transactionId,\n    messenger,\n  );\n  const isAlwaysRequired = isQuoteAlwaysRequired(\n    token,\n    strategy,\n    parentTransactionType,\n  );\n\n  if (isSameToken(token, paymentToken) && !isAlwaysRequired) {\n    log('Skipping token as same as payment token');\n    return undefined;\n  }\n\n  const sourceAmountHumanValue = new BigNumber(token.amountUsd).div(\n    paymentTokenFiatRate.usdRate,\n  );\n\n  const sourceAmountHuman = sourceAmountHumanValue.toString(10);\n\n  const sourceAmountRaw = sourceAmountHumanValue\n    .shiftedBy(paymentToken.decimals)\n    .toFixed(0);\n\n  if (token.amountRaw === '0') {\n    log('Skipping token as zero amount', { tokenAddress: token.address });\n    return undefined;\n  }\n\n  if (isMaxAmount) {\n    return {\n      sourceAmountHuman: paymentToken.balanceHuman,\n      sourceAmountRaw: paymentToken.balanceRaw,\n      targetTokenAddress: token.address,\n    };\n  }\n\n  return {\n    sourceAmountHuman,\n    sourceAmountRaw,\n    targetTokenAddress: token.address,\n  };\n}\n\n/**\n * Determine if a quote is always required for a token and strategy.\n *\n * @param token - Target token.\n * @param strategy - Payment strategy.\n * @param parentTransactionType - Parent transaction type, if available.\n * @returns True if a quote is always required, false otherwise.\n */\nfunction isQuoteAlwaysRequired(\n  token: TransactionPayRequiredToken,\n  strategy: TransactionPayStrategy,\n  parentTransactionType?: TransactionType,\n): boolean {\n  const isHyperliquidDeposit =\n    token.chainId === CHAIN_ID_ARBITRUM &&\n    token.address.toLowerCase() === ARBITRUM_USDC_ADDRESS.toLowerCase();\n\n  return (\n    isHyperliquidDeposit &&\n    (strategy === TransactionPayStrategy.Relay ||\n      (strategy === TransactionPayStrategy.Across &&\n        parentTransactionType === TransactionType.perpsDeposit))\n  );\n}\n\nfunction getStrategyContext(\n  transactionId: string,\n  messenger: TransactionPayControllerMessenger,\n): {\n  parentTransactionType?: TransactionType;\n  strategy: TransactionPayStrategy;\n} {\n  const transaction = getTransaction(\n    transactionId,\n    messenger,\n  ) as TransactionMeta;\n\n  return {\n    parentTransactionType: transaction.type,\n    strategy: messenger.call(\n      'TransactionPayController:getStrategy',\n      transaction,\n    ),\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/transaction-pay-controller",
-  "version": "19.0.3",
+  "version": "19.1.0",
   "description": "Manages alternate payment strategies to provide required funds for transactions in MetaMask",
   "keywords": [
     "MetaMask",
@@ -40,7 +40,8 @@
     "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/transaction-pay-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/transaction-pay-controller",
-    "generate-method-action-types": "tsx ../../packages/messenger/src/generate-action-types/cli.ts",
+    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check",
+    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate",
     "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
@@ -52,7 +53,7 @@
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.7.0",
-    "@metamask/assets-controller": "^4.0.0",
+    "@metamask/assets-controller": "^5.0.0",
     "@metamask/assets-controllers": "^103.1.1",
     "@metamask/base-controller": "^9.0.1",
     "@metamask/bridge-controller": "^70.0.1",