@metamask/transaction-pay-controller 16.5.0 → 17.1.0

package/CHANGELOG.md

@@ -7,6 +7,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [17.1.0]
+
+### Added
+
+- New public wrapper methods: `getDelegationTransaction()`, `getStrategy()` ([#8183](https://github.com/MetaMask/core/pull/8183))
+
+### Changed
+
+- Bump `@metamask/assets-controller` from `^2.3.0` to `^2.4.0` ([#8225](https://github.com/MetaMask/core/pull/8225))
+- Bump `@metamask/assets-controllers` from `^100.2.1` to `^101.0.0` ([#8225](https://github.com/MetaMask/core/pull/8225))
+- Bump `@metamask/bridge-controller` from `^69.1.0` to `^69.1.1` ([#8225](https://github.com/MetaMask/core/pull/8225))
+- Bump `@metamask/bridge-status-controller` from `^68.1.0` to `^69.0.0` ([#8225](https://github.com/MetaMask/core/pull/8225))
+- Bump `@metamask/gas-fee-controller` from `^26.0.3` to `^26.1.0` ([#8225](https://github.com/MetaMask/core/pull/8225))
+- Bump `@metamask/transaction-controller` from `^62.22.0` to `^63.0.0` ([#8225](https://github.com/MetaMask/core/pull/8225))
+
+## [17.0.0]
+
+### Added
+
+- **BREAKING:** Add `AssetsControllerGetStateForTransactionPayAction` to the `AllowedActions` messenger type ([#8163](https://github.com/MetaMask/core/pull/8163))
+
+### Changed
+
+- `getTokenBalance`, `getTokenInfo`, and `getTokenFiatRate` now source token metadata, balances, and pricing from `AssetsControllerGetStateForTransactionPayAction` when the `assetsUnifyState` remote feature flag is enabled, falling back to individual controller state calls otherwise ([#8163](https://github.com/MetaMask/core/pull/8163))
+- Zero out source network fees in Relay strategy when quote indicates execute flow ([#8181](https://github.com/MetaMask/core/pull/8181))
+- Harden relay status polling ([#8189](https://github.com/MetaMask/core/pull/8189))
+  - Throw if status not recognised.
+  - Support feature flags for polling interval and timeout.
+  - Ignore transient network errors.
+- Bump `@metamask/transaction-controller` from `^62.21.0` to `^62.22.0` ([#8217](https://github.com/MetaMask/core/pull/8217))
+
 ## [16.5.0]
 
 ### Added
@@ -510,7 +541,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release ([#6820](https://github.com/MetaMask/core/pull/6820))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@16.5.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@17.1.0...HEAD
+[17.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@17.0.0...@metamask/transaction-pay-controller@17.1.0
+[17.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@16.5.0...@metamask/transaction-pay-controller@17.0.0
 [16.5.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@16.4.1...@metamask/transaction-pay-controller@16.5.0
 [16.4.1]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@16.4.0...@metamask/transaction-pay-controller@16.4.1
 [16.4.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@16.3.0...@metamask/transaction-pay-controller@16.4.0

package/dist/TransactionPayController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TransactionPayController-method-action-types.cjs.map

package/dist/TransactionPayController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController-method-action-types.cjs","sourceRoot":"","sources":["../src/TransactionPayController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { TransactionPayController } from './TransactionPayController';\n\n/**\n * Sets the transaction configuration.\n *\n * The callback receives the current configuration properties and can mutate\n * them in place. Updated values are written back to the transaction data.\n *\n * @param transactionId - The ID of the transaction to configure.\n * @param callback - A callback that receives a mutable {@link TransactionConfig} object.\n */\nexport type TransactionPayControllerSetTransactionConfigAction = {\n  type: `TransactionPayController:setTransactionConfig`;\n  handler: TransactionPayController['setTransactionConfig'];\n};\n\n/**\n * Updates the payment token for a transaction.\n *\n * Resolves token metadata and balances, then stores the new payment token\n * in the transaction data. This triggers recalculation of source amounts\n * and quote retrieval.\n *\n * @param request - The payment token update request containing the\n * transaction ID, token address, and chain ID.\n */\nexport type TransactionPayControllerUpdatePaymentTokenAction = {\n  type: `TransactionPayController:updatePaymentToken`;\n  handler: TransactionPayController['updatePaymentToken'];\n};\n\n/**\n * Updates the fiat payment state for a transaction.\n *\n * The request callback receives the current fiat payment state and can\n * mutate it to update properties such as the selected payment method or\n * fiat amount.\n *\n * @param request - The fiat payment update request containing the\n * transaction ID and a callback to mutate fiat payment state.\n */\nexport type TransactionPayControllerUpdateFiatPaymentAction = {\n  type: `TransactionPayController:updateFiatPayment`;\n  handler: TransactionPayController['updateFiatPayment'];\n};\n\n/**\n * Gets the delegation transaction for a given transaction.\n *\n * Converts the provided transaction into a redeem delegation by delegating\n * to the configured callback. Returns the delegation transaction data\n * including the encoded call data, target address, value, and an optional\n * authorization list.\n *\n * @param args - The arguments forwarded to the {@link GetDelegationTransactionCallback},\n * containing the transaction metadata.\n * @returns A promise resolving to the delegation transaction data.\n */\nexport type TransactionPayControllerGetDelegationTransactionAction = {\n  type: `TransactionPayController:getDelegationTransaction`;\n  handler: TransactionPayController['getDelegationTransaction'];\n};\n\n/**\n * Gets the preferred strategy for a transaction.\n *\n * Returns the first strategy from the ordered list of strategies applicable\n * to the given transaction. Falls back to the default strategy order derived\n * from feature flags when no custom strategy callback is configured.\n *\n * @param transaction - The transaction metadata to determine the strategy for.\n * @returns The preferred {@link TransactionPayStrategy} for the transaction.\n */\nexport type TransactionPayControllerGetStrategyAction = {\n  type: `TransactionPayController:getStrategy`;\n  handler: TransactionPayController['getStrategy'];\n};\n\n/**\n * Union of all TransactionPayController action types.\n */\nexport type TransactionPayControllerMethodActions =\n  | TransactionPayControllerSetTransactionConfigAction\n  | TransactionPayControllerUpdatePaymentTokenAction\n  | TransactionPayControllerUpdateFiatPaymentAction\n  | TransactionPayControllerGetDelegationTransactionAction\n  | TransactionPayControllerGetStrategyAction;\n"]}

package/dist/TransactionPayController-method-action-types.d.cts

@@ -0,0 +1,81 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { TransactionPayController } from "./TransactionPayController.cjs";
+/**
+ * Sets the transaction configuration.
+ *
+ * The callback receives the current configuration properties and can mutate
+ * them in place. Updated values are written back to the transaction data.
+ *
+ * @param transactionId - The ID of the transaction to configure.
+ * @param callback - A callback that receives a mutable {@link TransactionConfig} object.
+ */
+export type TransactionPayControllerSetTransactionConfigAction = {
+    type: `TransactionPayController:setTransactionConfig`;
+    handler: TransactionPayController['setTransactionConfig'];
+};
+/**
+ * Updates the payment token for a transaction.
+ *
+ * Resolves token metadata and balances, then stores the new payment token
+ * in the transaction data. This triggers recalculation of source amounts
+ * and quote retrieval.
+ *
+ * @param request - The payment token update request containing the
+ * transaction ID, token address, and chain ID.
+ */
+export type TransactionPayControllerUpdatePaymentTokenAction = {
+    type: `TransactionPayController:updatePaymentToken`;
+    handler: TransactionPayController['updatePaymentToken'];
+};
+/**
+ * Updates the fiat payment state for a transaction.
+ *
+ * The request callback receives the current fiat payment state and can
+ * mutate it to update properties such as the selected payment method or
+ * fiat amount.
+ *
+ * @param request - The fiat payment update request containing the
+ * transaction ID and a callback to mutate fiat payment state.
+ */
+export type TransactionPayControllerUpdateFiatPaymentAction = {
+    type: `TransactionPayController:updateFiatPayment`;
+    handler: TransactionPayController['updateFiatPayment'];
+};
+/**
+ * Gets the delegation transaction for a given transaction.
+ *
+ * Converts the provided transaction into a redeem delegation by delegating
+ * to the configured callback. Returns the delegation transaction data
+ * including the encoded call data, target address, value, and an optional
+ * authorization list.
+ *
+ * @param args - The arguments forwarded to the {@link GetDelegationTransactionCallback},
+ * containing the transaction metadata.
+ * @returns A promise resolving to the delegation transaction data.
+ */
+export type TransactionPayControllerGetDelegationTransactionAction = {
+    type: `TransactionPayController:getDelegationTransaction`;
+    handler: TransactionPayController['getDelegationTransaction'];
+};
+/**
+ * Gets the preferred strategy for a transaction.
+ *
+ * Returns the first strategy from the ordered list of strategies applicable
+ * to the given transaction. Falls back to the default strategy order derived
+ * from feature flags when no custom strategy callback is configured.
+ *
+ * @param transaction - The transaction metadata to determine the strategy for.
+ * @returns The preferred {@link TransactionPayStrategy} for the transaction.
+ */
+export type TransactionPayControllerGetStrategyAction = {
+    type: `TransactionPayController:getStrategy`;
+    handler: TransactionPayController['getStrategy'];
+};
+/**
+ * Union of all TransactionPayController action types.
+ */
+export type TransactionPayControllerMethodActions = TransactionPayControllerSetTransactionConfigAction | TransactionPayControllerUpdatePaymentTokenAction | TransactionPayControllerUpdateFiatPaymentAction | TransactionPayControllerGetDelegationTransactionAction | TransactionPayControllerGetStrategyAction;
+//# sourceMappingURL=TransactionPayController-method-action-types.d.cts.map

package/dist/TransactionPayController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController-method-action-types.d.cts","sourceRoot":"","sources":["../src/TransactionPayController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,uCAAmC;AAE3E;;;;;;;;GAQG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,wBAAwB,CAAC,sBAAsB,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,wBAAwB,CAAC,oBAAoB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,wBAAwB,CAAC,mBAAmB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,wBAAwB,CAAC,0BAA0B,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,wBAAwB,CAAC,aAAa,CAAC,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC7C,kDAAkD,GAClD,gDAAgD,GAChD,+CAA+C,GAC/C,sDAAsD,GACtD,yCAAyC,CAAC"}

package/dist/TransactionPayController-method-action-types.d.mts

@@ -0,0 +1,81 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { TransactionPayController } from "./TransactionPayController.mjs";
+/**
+ * Sets the transaction configuration.
+ *
+ * The callback receives the current configuration properties and can mutate
+ * them in place. Updated values are written back to the transaction data.
+ *
+ * @param transactionId - The ID of the transaction to configure.
+ * @param callback - A callback that receives a mutable {@link TransactionConfig} object.
+ */
+export type TransactionPayControllerSetTransactionConfigAction = {
+    type: `TransactionPayController:setTransactionConfig`;
+    handler: TransactionPayController['setTransactionConfig'];
+};
+/**
+ * Updates the payment token for a transaction.
+ *
+ * Resolves token metadata and balances, then stores the new payment token
+ * in the transaction data. This triggers recalculation of source amounts
+ * and quote retrieval.
+ *
+ * @param request - The payment token update request containing the
+ * transaction ID, token address, and chain ID.
+ */
+export type TransactionPayControllerUpdatePaymentTokenAction = {
+    type: `TransactionPayController:updatePaymentToken`;
+    handler: TransactionPayController['updatePaymentToken'];
+};
+/**
+ * Updates the fiat payment state for a transaction.
+ *
+ * The request callback receives the current fiat payment state and can
+ * mutate it to update properties such as the selected payment method or
+ * fiat amount.
+ *
+ * @param request - The fiat payment update request containing the
+ * transaction ID and a callback to mutate fiat payment state.
+ */
+export type TransactionPayControllerUpdateFiatPaymentAction = {
+    type: `TransactionPayController:updateFiatPayment`;
+    handler: TransactionPayController['updateFiatPayment'];
+};
+/**
+ * Gets the delegation transaction for a given transaction.
+ *
+ * Converts the provided transaction into a redeem delegation by delegating
+ * to the configured callback. Returns the delegation transaction data
+ * including the encoded call data, target address, value, and an optional
+ * authorization list.
+ *
+ * @param args - The arguments forwarded to the {@link GetDelegationTransactionCallback},
+ * containing the transaction metadata.
+ * @returns A promise resolving to the delegation transaction data.
+ */
+export type TransactionPayControllerGetDelegationTransactionAction = {
+    type: `TransactionPayController:getDelegationTransaction`;
+    handler: TransactionPayController['getDelegationTransaction'];
+};
+/**
+ * Gets the preferred strategy for a transaction.
+ *
+ * Returns the first strategy from the ordered list of strategies applicable
+ * to the given transaction. Falls back to the default strategy order derived
+ * from feature flags when no custom strategy callback is configured.
+ *
+ * @param transaction - The transaction metadata to determine the strategy for.
+ * @returns The preferred {@link TransactionPayStrategy} for the transaction.
+ */
+export type TransactionPayControllerGetStrategyAction = {
+    type: `TransactionPayController:getStrategy`;
+    handler: TransactionPayController['getStrategy'];
+};
+/**
+ * Union of all TransactionPayController action types.
+ */
+export type TransactionPayControllerMethodActions = TransactionPayControllerSetTransactionConfigAction | TransactionPayControllerUpdatePaymentTokenAction | TransactionPayControllerUpdateFiatPaymentAction | TransactionPayControllerGetDelegationTransactionAction | TransactionPayControllerGetStrategyAction;
+//# sourceMappingURL=TransactionPayController-method-action-types.d.mts.map

package/dist/TransactionPayController-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController-method-action-types.d.mts","sourceRoot":"","sources":["../src/TransactionPayController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,uCAAmC;AAE3E;;;;;;;;GAQG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,wBAAwB,CAAC,sBAAsB,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,wBAAwB,CAAC,oBAAoB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,wBAAwB,CAAC,mBAAmB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,wBAAwB,CAAC,0BAA0B,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,wBAAwB,CAAC,aAAa,CAAC,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC7C,kDAAkD,GAClD,gDAAgD,GAChD,+CAA+C,GAC/C,sDAAsD,GACtD,yCAAyC,CAAC"}

package/dist/TransactionPayController-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=TransactionPayController-method-action-types.mjs.map

package/dist/TransactionPayController-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController-method-action-types.mjs","sourceRoot":"","sources":["../src/TransactionPayController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { TransactionPayController } from './TransactionPayController';\n\n/**\n * Sets the transaction configuration.\n *\n * The callback receives the current configuration properties and can mutate\n * them in place. Updated values are written back to the transaction data.\n *\n * @param transactionId - The ID of the transaction to configure.\n * @param callback - A callback that receives a mutable {@link TransactionConfig} object.\n */\nexport type TransactionPayControllerSetTransactionConfigAction = {\n  type: `TransactionPayController:setTransactionConfig`;\n  handler: TransactionPayController['setTransactionConfig'];\n};\n\n/**\n * Updates the payment token for a transaction.\n *\n * Resolves token metadata and balances, then stores the new payment token\n * in the transaction data. This triggers recalculation of source amounts\n * and quote retrieval.\n *\n * @param request - The payment token update request containing the\n * transaction ID, token address, and chain ID.\n */\nexport type TransactionPayControllerUpdatePaymentTokenAction = {\n  type: `TransactionPayController:updatePaymentToken`;\n  handler: TransactionPayController['updatePaymentToken'];\n};\n\n/**\n * Updates the fiat payment state for a transaction.\n *\n * The request callback receives the current fiat payment state and can\n * mutate it to update properties such as the selected payment method or\n * fiat amount.\n *\n * @param request - The fiat payment update request containing the\n * transaction ID and a callback to mutate fiat payment state.\n */\nexport type TransactionPayControllerUpdateFiatPaymentAction = {\n  type: `TransactionPayController:updateFiatPayment`;\n  handler: TransactionPayController['updateFiatPayment'];\n};\n\n/**\n * Gets the delegation transaction for a given transaction.\n *\n * Converts the provided transaction into a redeem delegation by delegating\n * to the configured callback. Returns the delegation transaction data\n * including the encoded call data, target address, value, and an optional\n * authorization list.\n *\n * @param args - The arguments forwarded to the {@link GetDelegationTransactionCallback},\n * containing the transaction metadata.\n * @returns A promise resolving to the delegation transaction data.\n */\nexport type TransactionPayControllerGetDelegationTransactionAction = {\n  type: `TransactionPayController:getDelegationTransaction`;\n  handler: TransactionPayController['getDelegationTransaction'];\n};\n\n/**\n * Gets the preferred strategy for a transaction.\n *\n * Returns the first strategy from the ordered list of strategies applicable\n * to the given transaction. Falls back to the default strategy order derived\n * from feature flags when no custom strategy callback is configured.\n *\n * @param transaction - The transaction metadata to determine the strategy for.\n * @returns The preferred {@link TransactionPayStrategy} for the transaction.\n */\nexport type TransactionPayControllerGetStrategyAction = {\n  type: `TransactionPayController:getStrategy`;\n  handler: TransactionPayController['getStrategy'];\n};\n\n/**\n * Union of all TransactionPayController action types.\n */\nexport type TransactionPayControllerMethodActions =\n  | TransactionPayControllerSetTransactionConfigAction\n  | TransactionPayControllerUpdatePaymentTokenAction\n  | TransactionPayControllerUpdateFiatPaymentAction\n  | TransactionPayControllerGetDelegationTransactionAction\n  | TransactionPayControllerGetStrategyAction;\n"]}

package/dist/TransactionPayController.cjs

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _TransactionPayController_instances, _TransactionPayController_getDelegationTransaction, _TransactionPayController_getStrategy, _TransactionPayController_getStrategies, _TransactionPayController_removeTransactionData, _TransactionPayController_updateTransactionData, _TransactionPayController_registerActionHandlers, _TransactionPayController_getStrategiesWithFallback;
+var _TransactionPayController_instances, _TransactionPayController_getDelegationTransaction, _TransactionPayController_getStrategy, _TransactionPayController_getStrategies, _TransactionPayController_removeTransactionData, _TransactionPayController_updateTransactionData, _TransactionPayController_getStrategiesWithFallback;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionPayController = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -23,6 +23,13 @@ const feature_flags_1 = require("./utils/feature-flags.cjs");
 const quotes_1 = require("./utils/quotes.cjs");
 const source_amounts_1 = require("./utils/source-amounts.cjs");
 const transaction_1 = require("./utils/transaction.cjs");
+const MESSENGER_EXPOSED_METHODS = [
+    'getDelegationTransaction',
+    'getStrategy',
+    'setTransactionConfig',
+    'updateFiatPayment',
+    'updatePaymentToken',
+];
 const stateMetadata = {
     transactionData: {
         includeInDebugSnapshot: false,
@@ -49,7 +56,7 @@ class TransactionPayController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _TransactionPayController_getDelegationTransaction, getDelegationTransaction, "f");
         __classPrivateFieldSet(this, _TransactionPayController_getStrategy, getStrategy, "f");
         __classPrivateFieldSet(this, _TransactionPayController_getStrategies, getStrategies, "f");
-        __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_registerActionHandlers).call(this);
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
         (0, transaction_1.pollTransactionChanges)(messenger, __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this), __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_removeTransactionData).bind(this));
         // eslint-disable-next-line no-new
         new QuoteRefresher_1.QuoteRefresher({
@@ -58,6 +65,15 @@ class TransactionPayController extends base_controller_1.BaseController {
             updateTransactionData: __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this),
         });
     }
+    /**
+     * Sets the transaction configuration.
+     *
+     * The callback receives the current configuration properties and can mutate
+     * them in place. Updated values are written back to the transaction data.
+     *
+     * @param transactionId - The ID of the transaction to configure.
+     * @param callback - A callback that receives a mutable {@link TransactionConfig} object.
+     */
     setTransactionConfig(transactionId, callback) {
         __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).call(this, transactionId, (transactionData) => {
             const config = {
@@ -71,18 +87,66 @@ class TransactionPayController extends base_controller_1.BaseController {
             transactionData.refundTo = config.refundTo;
         });
     }
+    /**
+     * Updates the payment token for a transaction.
+     *
+     * Resolves token metadata and balances, then stores the new payment token
+     * in the transaction data. This triggers recalculation of source amounts
+     * and quote retrieval.
+     *
+     * @param request - The payment token update request containing the
+     * transaction ID, token address, and chain ID.
+     */
     updatePaymentToken(request) {
         (0, update_payment_token_1.updatePaymentToken)(request, {
             messenger: this.messenger,
             updateTransactionData: __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this),
         });
     }
+    /**
+     * Updates the fiat payment state for a transaction.
+     *
+     * The request callback receives the current fiat payment state and can
+     * mutate it to update properties such as the selected payment method or
+     * fiat amount.
+     *
+     * @param request - The fiat payment update request containing the
+     * transaction ID and a callback to mutate fiat payment state.
+     */
     updateFiatPayment(request) {
         (0, update_fiat_payment_1.updateFiatPayment)(request, {
             messenger: this.messenger,
             updateTransactionData: __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this),
         });
     }
+    /**
+     * Gets the delegation transaction for a given transaction.
+     *
+     * Converts the provided transaction into a redeem delegation by delegating
+     * to the configured callback. Returns the delegation transaction data
+     * including the encoded call data, target address, value, and an optional
+     * authorization list.
+     *
+     * @param args - The arguments forwarded to the {@link GetDelegationTransactionCallback},
+     * containing the transaction metadata.
+     * @returns A promise resolving to the delegation transaction data.
+     */
+    getDelegationTransaction(...args) {
+        return __classPrivateFieldGet(this, _TransactionPayController_getDelegationTransaction, "f").call(this, ...args);
+    }
+    /**
+     * Gets the preferred strategy for a transaction.
+     *
+     * Returns the first strategy from the ordered list of strategies applicable
+     * to the given transaction. Falls back to the default strategy order derived
+     * from feature flags when no custom strategy callback is configured.
+     *
+     * @param transaction - The transaction metadata to determine the strategy for.
+     * @returns The preferred {@link TransactionPayStrategy} for the transaction.
+     */
+    getStrategy(transaction) {
+        return __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_getStrategiesWithFallback).call(this, transaction)[0];
+    }
 }
 exports.TransactionPayController = TransactionPayController;
 _TransactionPayController_getDelegationTransaction = new WeakMap(), _TransactionPayController_getStrategy = new WeakMap(), _TransactionPayController_getStrategies = new WeakMap(), _TransactionPayController_instances = new WeakSet(), _TransactionPayController_removeTransactionData = function _TransactionPayController_removeTransactionData(transactionId) {
@@ -130,12 +194,6 @@ _TransactionPayController_getDelegationTransaction = new WeakMap(), _Transaction
             updateTransactionData: __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this),
         }).catch(lodash_1.noop);
     }
-}, _TransactionPayController_registerActionHandlers = function _TransactionPayController_registerActionHandlers() {
-    this.messenger.registerActionHandler('TransactionPayController:getDelegationTransaction', __classPrivateFieldGet(this, _TransactionPayController_getDelegationTransaction, "f").bind(this));
-    this.messenger.registerActionHandler('TransactionPayController:getStrategy', (transaction) => __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_getStrategiesWithFallback).call(this, transaction)[0]);
-    this.messenger.registerActionHandler('TransactionPayController:setTransactionConfig', this.setTransactionConfig.bind(this));
-    this.messenger.registerActionHandler('TransactionPayController:updatePaymentToken', this.updatePaymentToken.bind(this));
-    this.messenger.registerActionHandler('TransactionPayController:updateFiatPayment', this.updateFiatPayment.bind(this));
 }, _TransactionPayController_getStrategiesWithFallback = function _TransactionPayController_getStrategiesWithFallback(transaction) {
     const strategyCandidates = __classPrivateFieldGet(this, _TransactionPayController_getStrategies, "f")?.call(this, transaction) ??
         (__classPrivateFieldGet(this, _TransactionPayController_getStrategy, "f") ? [__classPrivateFieldGet(this, _TransactionPayController_getStrategy, "f").call(this, transaction)] : []);

package/dist/TransactionPayController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"TransactionPayController.cjs","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,+DAA2D;AAG3D,mCAA8B;AAE9B,2EAAkE;AAClE,6EAAoE;AACpE,+CAIqB;AACrB,iEAA0D;AAW1D,6DAAyD;AACzD,+CAA8C;AAC9C,+DAA6D;AAC7D,yDAA6D;AAE7D,MAAM,aAAa,GAAiD;IAClE,eAAe,EAAE;QACf,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF,MAAM,eAAe,GAAG,GAAkC,EAAE,CAAC,CAAC;IAC5D,eAAe,EAAE,EAAE;CACpB,CAAC,CAAC;AAEH,MAAa,wBAAyB,SAAQ,gCAI7C;IAWC,YAAY,EACV,wBAAwB,EACxB,WAAW,EACX,aAAa,EACb,SAAS,EACT,KAAK,GAC2B;QAChC,KAAK,CAAC;YACJ,IAAI,EAAE,2BAAe;YACrB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,eAAe,EAAE,EAAE,GAAG,KAAK,EAAE;SAC1C,CAAC,CAAC;;QAtBI,qEAA4D;QAE5D,wDAEmB;QAEnB,0DAEqB;QAgB5B,uBAAA,IAAI,sDAA6B,wBAAwB,MAAA,CAAC;QAC1D,uBAAA,IAAI,yCAAgB,WAAW,MAAA,CAAC;QAChC,uBAAA,IAAI,2CAAkB,aAAa,MAAA,CAAC;QAEpC,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC;QAE/B,IAAA,oCAAsB,EACpB,SAAS,EACT,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,EACtC,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;QAEF,kCAAkC;QAClC,IAAI,+BAAc,CAAC;YACjB,aAAa,EAAE,uBAAA,IAAI,gGAA2B,CAAC,IAAI,CAAC,IAAI,CAAC;YACzD,SAAS;YACT,qBAAqB,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;IAED,oBAAoB,CAClB,aAAqB,EACrB,QAAmC;QAEnC,uBAAA,IAAI,4FAAuB,MAA3B,IAAI,EAAwB,aAAa,EAAE,CAAC,eAAe,EAAE,EAAE;YAC7D,MAAM,MAAM,GAAG;gBACb,WAAW,EAAE,eAAe,CAAC,WAAW;gBACxC,WAAW,EAAE,eAAe,CAAC,WAAW;gBACxC,QAAQ,EAAE,eAAe,CAAC,QAAQ;aACnC,CAAC;YAEF,QAAQ,CAAC,MAAM,CAAC,CAAC;YAEjB,eAAe,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;YACjD,eAAe,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;YACjD,eAAe,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,kBAAkB,CAAC,OAAkC;QACnD,IAAA,yCAAkB,EAAC,OAAO,EAAE;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,qBAAqB,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB,CAAC,OAAiC;QACjD,IAAA,uCAAiB,EAAC,OAAO,EAAE;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,qBAAqB,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;CA8GF;AA9LD,4DA8LC;oVA5GwB,aAAqB;IAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,OAAO,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,6GAGC,aAAqB,EACrB,EAAqD;IAErD,IAAI,kBAAkB,GAAG,KAAK,CAAC;IAE/B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;QAClC,IAAI,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;QAC7C,MAAM,oBAAoB,GAAG,OAAO,EAAE,YAAY,CAAC;QACnD,MAAM,cAAc,GAAG,OAAO,EAAE,MAAM,CAAC;QACvC,MAAM,mBAAmB,GAAG,OAAO,EAAE,WAAW,CAAC;QACjD,MAAM,mBAAmB,GAAG,OAAO,EAAE,WAAW,CAAC;QAEjD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,eAAe,CAAC,aAAa,CAAC,GAAG;gBAC/B,WAAW,EAAE,EAAE;gBACf,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,EAAE;aACX,CAAC;YAEF,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;QAC3C,CAAC;QAED,EAAE,CAAC,OAAO,CAAC,CAAC;QAEZ,MAAM,qBAAqB,GACzB,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE;YAC1C,oBAAoB,EAAE,OAAO,EAAE,WAAW,EAAE;YAC9C,OAAO,CAAC,YAAY,EAAE,OAAO,KAAK,oBAAoB,EAAE,OAAO,CAAC;QAElE,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,KAAK,cAAc,CAAC;QAC1D,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,KAAK,mBAAmB,CAAC;QACnE,MAAM,kBAAkB,GAAG,OAAO,CAAC,WAAW,KAAK,mBAAmB,CAAC;QAEvE,IACE,qBAAqB;YACrB,cAAc;YACd,eAAe;YACf,kBAAkB,EAClB,CAAC;YACD,IAAA,oCAAmB,EAAC,aAAa,EAAE,OAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAErE,kBAAkB,GAAG,IAAI,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,kBAAkB,EAAE,CAAC;QACvB,IAAA,qBAAY,EAAC;YACX,aAAa,EAAE,uBAAA,IAAI,gGAA2B,CAAC,IAAI,CAAC,IAAI,CAAC;YACzD,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC;YAC1D,aAAa;YACb,qBAAqB,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC,KAAK,CAAC,aAAI,CAAC,CAAC;IACjB,CAAC;AACH,CAAC;IAGC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,mDAAmD,EACnD,uBAAA,IAAI,0DAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1C,CAAC;IAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,sCAAsC,EACtC,CAAC,WAA4B,EAA0B,EAAE,CACvD,uBAAA,IAAI,gGAA2B,MAA/B,IAAI,EAA4B,WAAW,CAAC,CAAC,CAAC,CAAC,CAClD,CAAC;IAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,+CAA+C,EAC/C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;IAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,6CAA6C,EAC7C,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CACnC,CAAC;IAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,4CAA4C,EAC5C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;AACJ,CAAC,qHAGC,WAA4B;IAE5B,MAAM,kBAAkB,GACtB,uBAAA,IAAI,+CAAe,EAAE,KAArB,IAAI,EAAkB,WAAW,CAAC;QAClC,CAAC,uBAAA,IAAI,6CAAa,CAAC,CAAC,CAAC,CAAC,uBAAA,IAAI,6CAAa,MAAjB,IAAI,EAAc,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAE9D,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAC/C,CAAC,QAAQ,EAAsC,EAAE,CAC/C,IAAA,oCAAwB,EAAC,QAAQ,CAAC,CACrC,CAAC;IAEF,OAAO,eAAe,CAAC,MAAM;QAC3B,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,IAAA,gCAAgB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACvC,CAAC","sourcesContent":["import type { StateMetadata } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { Draft } from 'immer';\nimport { noop } from 'lodash';\n\nimport { updateFiatPayment } from './actions/update-fiat-payment';\nimport { updatePaymentToken } from './actions/update-payment-token';\nimport {\n  CONTROLLER_NAME,\n  isTransactionPayStrategy,\n  TransactionPayStrategy,\n} from './constants';\nimport { QuoteRefresher } from './helpers/QuoteRefresher';\nimport type {\n  GetDelegationTransactionCallback,\n  TransactionConfigCallback,\n  TransactionData,\n  TransactionPayControllerMessenger,\n  TransactionPayControllerOptions,\n  TransactionPayControllerState,\n  UpdateFiatPaymentRequest,\n  UpdatePaymentTokenRequest,\n} from './types';\nimport { getStrategyOrder } from './utils/feature-flags';\nimport { updateQuotes } from './utils/quotes';\nimport { updateSourceAmounts } from './utils/source-amounts';\nimport { pollTransactionChanges } from './utils/transaction';\n\nconst stateMetadata: StateMetadata<TransactionPayControllerState> = {\n  transactionData: {\n    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    persist: false,\n    usedInUi: true,\n  },\n};\n\nconst getDefaultState = (): TransactionPayControllerState => ({\n  transactionData: {},\n});\n\nexport class TransactionPayController extends BaseController<\n  typeof CONTROLLER_NAME,\n  TransactionPayControllerState,\n  TransactionPayControllerMessenger\n> {\n  readonly #getDelegationTransaction: GetDelegationTransactionCallback;\n\n  readonly #getStrategy?: (\n    transaction: TransactionMeta,\n  ) => TransactionPayStrategy;\n\n  readonly #getStrategies?: (\n    transaction: TransactionMeta,\n  ) => TransactionPayStrategy[];\n\n  constructor({\n    getDelegationTransaction,\n    getStrategy,\n    getStrategies,\n    messenger,\n    state,\n  }: TransactionPayControllerOptions) {\n    super({\n      name: CONTROLLER_NAME,\n      metadata: stateMetadata,\n      messenger,\n      state: { ...getDefaultState(), ...state },\n    });\n\n    this.#getDelegationTransaction = getDelegationTransaction;\n    this.#getStrategy = getStrategy;\n    this.#getStrategies = getStrategies;\n\n    this.#registerActionHandlers();\n\n    pollTransactionChanges(\n      messenger,\n      this.#updateTransactionData.bind(this),\n      this.#removeTransactionData.bind(this),\n    );\n\n    // eslint-disable-next-line no-new\n    new QuoteRefresher({\n      getStrategies: this.#getStrategiesWithFallback.bind(this),\n      messenger,\n      updateTransactionData: this.#updateTransactionData.bind(this),\n    });\n  }\n\n  setTransactionConfig(\n    transactionId: string,\n    callback: TransactionConfigCallback,\n  ): void {\n    this.#updateTransactionData(transactionId, (transactionData) => {\n      const config = {\n        isMaxAmount: transactionData.isMaxAmount,\n        isPostQuote: transactionData.isPostQuote,\n        refundTo: transactionData.refundTo,\n      };\n\n      callback(config);\n\n      transactionData.isMaxAmount = config.isMaxAmount;\n      transactionData.isPostQuote = config.isPostQuote;\n      transactionData.refundTo = config.refundTo;\n    });\n  }\n\n  updatePaymentToken(request: UpdatePaymentTokenRequest): void {\n    updatePaymentToken(request, {\n      messenger: this.messenger,\n      updateTransactionData: this.#updateTransactionData.bind(this),\n    });\n  }\n\n  updateFiatPayment(request: UpdateFiatPaymentRequest): void {\n    updateFiatPayment(request, {\n      messenger: this.messenger,\n      updateTransactionData: this.#updateTransactionData.bind(this),\n    });\n  }\n\n  #removeTransactionData(transactionId: string): void {\n    this.update((state) => {\n      delete state.transactionData[transactionId];\n    });\n  }\n\n  #updateTransactionData(\n    transactionId: string,\n    fn: (transactionData: Draft<TransactionData>) => void,\n  ): void {\n    let shouldUpdateQuotes = false;\n\n    this.update((state) => {\n      const { transactionData } = state;\n      let current = transactionData[transactionId];\n      const originalPaymentToken = current?.paymentToken;\n      const originalTokens = current?.tokens;\n      const originalIsMaxAmount = current?.isMaxAmount;\n      const originalIsPostQuote = current?.isPostQuote;\n\n      if (!current) {\n        transactionData[transactionId] = {\n          fiatPayment: {},\n          isLoading: false,\n          tokens: [],\n        };\n\n        current = transactionData[transactionId];\n      }\n\n      fn(current);\n\n      const isPaymentTokenUpdated =\n        current.paymentToken?.address?.toLowerCase() !==\n          originalPaymentToken?.address?.toLowerCase() ||\n        current.paymentToken?.chainId !== originalPaymentToken?.chainId;\n\n      const isTokensUpdated = current.tokens !== originalTokens;\n      const isIsMaxUpdated = current.isMaxAmount !== originalIsMaxAmount;\n      const isPostQuoteUpdated = current.isPostQuote !== originalIsPostQuote;\n\n      if (\n        isPaymentTokenUpdated ||\n        isIsMaxUpdated ||\n        isTokensUpdated ||\n        isPostQuoteUpdated\n      ) {\n        updateSourceAmounts(transactionId, current as never, this.messenger);\n\n        shouldUpdateQuotes = true;\n      }\n    });\n\n    if (shouldUpdateQuotes) {\n      updateQuotes({\n        getStrategies: this.#getStrategiesWithFallback.bind(this),\n        messenger: this.messenger,\n        transactionData: this.state.transactionData[transactionId],\n        transactionId,\n        updateTransactionData: this.#updateTransactionData.bind(this),\n      }).catch(noop);\n    }\n  }\n\n  #registerActionHandlers(): void {\n    this.messenger.registerActionHandler(\n      'TransactionPayController:getDelegationTransaction',\n      this.#getDelegationTransaction.bind(this),\n    );\n\n    this.messenger.registerActionHandler(\n      'TransactionPayController:getStrategy',\n      (transaction: TransactionMeta): TransactionPayStrategy =>\n        this.#getStrategiesWithFallback(transaction)[0],\n    );\n\n    this.messenger.registerActionHandler(\n      'TransactionPayController:setTransactionConfig',\n      this.setTransactionConfig.bind(this),\n    );\n\n    this.messenger.registerActionHandler(\n      'TransactionPayController:updatePaymentToken',\n      this.updatePaymentToken.bind(this),\n    );\n\n    this.messenger.registerActionHandler(\n      'TransactionPayController:updateFiatPayment',\n      this.updateFiatPayment.bind(this),\n    );\n  }\n\n  #getStrategiesWithFallback(\n    transaction: TransactionMeta,\n  ): TransactionPayStrategy[] {\n    const strategyCandidates: unknown[] =\n      this.#getStrategies?.(transaction) ??\n      (this.#getStrategy ? [this.#getStrategy(transaction)] : []);\n\n    const validStrategies = strategyCandidates.filter(\n      (strategy): strategy is TransactionPayStrategy =>\n        isTransactionPayStrategy(strategy),\n    );\n\n    return validStrategies.length\n      ? validStrategies\n      : getStrategyOrder(this.messenger);\n  }\n}\n"]}
+{"version":3,"file":"TransactionPayController.cjs","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,+DAA2D;AAG3D,mCAA8B;AAE9B,2EAAkE;AAClE,6EAAoE;AACpE,+CAIqB;AACrB,iEAA0D;AAW1D,6DAAyD;AACzD,+CAA8C;AAC9C,+DAA6D;AAC7D,yDAA6D;AAE7D,MAAM,yBAAyB,GAAG;IAChC,0BAA0B;IAC1B,aAAa;IACb,sBAAsB;IACtB,mBAAmB;IACnB,oBAAoB;CACZ,CAAC;AAEX,MAAM,aAAa,GAAiD;IAClE,eAAe,EAAE;QACf,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF,MAAM,eAAe,GAAG,GAAkC,EAAE,CAAC,CAAC;IAC5D,eAAe,EAAE,EAAE;CACpB,CAAC,CAAC;AAEH,MAAa,wBAAyB,SAAQ,gCAI7C;IAWC,YAAY,EACV,wBAAwB,EACxB,WAAW,EACX,aAAa,EACb,SAAS,EACT,KAAK,GAC2B;QAChC,KAAK,CAAC;YACJ,IAAI,EAAE,2BAAe;YACrB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,eAAe,EAAE,EAAE,GAAG,KAAK,EAAE;SAC1C,CAAC,CAAC;;QAtBI,qEAA4D;QAE5D,wDAEmB;QAEnB,0DAEqB;QAgB5B,uBAAA,IAAI,sDAA6B,wBAAwB,MAAA,CAAC;QAC1D,uBAAA,IAAI,yCAAgB,WAAW,MAAA,CAAC;QAChC,uBAAA,IAAI,2CAAkB,aAAa,MAAA,CAAC;QAEpC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAA,oCAAsB,EACpB,SAAS,EACT,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,EACtC,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;QAEF,kCAAkC;QAClC,IAAI,+BAAc,CAAC;YACjB,aAAa,EAAE,uBAAA,IAAI,gGAA2B,CAAC,IAAI,CAAC,IAAI,CAAC;YACzD,SAAS;YACT,qBAAqB,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAClB,aAAqB,EACrB,QAAmC;QAEnC,uBAAA,IAAI,4FAAuB,MAA3B,IAAI,EAAwB,aAAa,EAAE,CAAC,eAAe,EAAE,EAAE;YAC7D,MAAM,MAAM,GAAG;gBACb,WAAW,EAAE,eAAe,CAAC,WAAW;gBACxC,WAAW,EAAE,eAAe,CAAC,WAAW;gBACxC,QAAQ,EAAE,eAAe,CAAC,QAAQ;aACnC,CAAC;YAEF,QAAQ,CAAC,MAAM,CAAC,CAAC;YAEjB,eAAe,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;YACjD,eAAe,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;YACjD,eAAe,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,kBAAkB,CAAC,OAAkC;QACnD,IAAA,yCAAkB,EAAC,OAAO,EAAE;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,qBAAqB,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CAAC,OAAiC;QACjD,IAAA,uCAAiB,EAAC,OAAO,EAAE;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,qBAAqB,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,GAAG,IAAkD;QAErD,OAAO,uBAAA,IAAI,0DAA0B,MAA9B,IAAI,EAA2B,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;OASG;IACH,WAAW,CAAC,WAA4B;QACtC,OAAO,uBAAA,IAAI,gGAA2B,MAA/B,IAAI,EAA4B,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;CAkFF;AAlOD,4DAkOC;oVAhFwB,aAAqB;IAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,OAAO,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,6GAGC,aAAqB,EACrB,EAAqD;IAErD,IAAI,kBAAkB,GAAG,KAAK,CAAC;IAE/B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;QAClC,IAAI,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;QAC7C,MAAM,oBAAoB,GAAG,OAAO,EAAE,YAAY,CAAC;QACnD,MAAM,cAAc,GAAG,OAAO,EAAE,MAAM,CAAC;QACvC,MAAM,mBAAmB,GAAG,OAAO,EAAE,WAAW,CAAC;QACjD,MAAM,mBAAmB,GAAG,OAAO,EAAE,WAAW,CAAC;QAEjD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,eAAe,CAAC,aAAa,CAAC,GAAG;gBAC/B,WAAW,EAAE,EAAE;gBACf,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,EAAE;aACX,CAAC;YAEF,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;QAC3C,CAAC;QAED,EAAE,CAAC,OAAO,CAAC,CAAC;QAEZ,MAAM,qBAAqB,GACzB,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE;YAC1C,oBAAoB,EAAE,OAAO,EAAE,WAAW,EAAE;YAC9C,OAAO,CAAC,YAAY,EAAE,OAAO,KAAK,oBAAoB,EAAE,OAAO,CAAC;QAElE,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,KAAK,cAAc,CAAC;QAC1D,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,KAAK,mBAAmB,CAAC;QACnE,MAAM,kBAAkB,GAAG,OAAO,CAAC,WAAW,KAAK,mBAAmB,CAAC;QAEvE,IACE,qBAAqB;YACrB,cAAc;YACd,eAAe;YACf,kBAAkB,EAClB,CAAC;YACD,IAAA,oCAAmB,EAAC,aAAa,EAAE,OAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAErE,kBAAkB,GAAG,IAAI,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,kBAAkB,EAAE,CAAC;QACvB,IAAA,qBAAY,EAAC;YACX,aAAa,EAAE,uBAAA,IAAI,gGAA2B,CAAC,IAAI,CAAC,IAAI,CAAC;YACzD,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC;YAC1D,aAAa;YACb,qBAAqB,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC,KAAK,CAAC,aAAI,CAAC,CAAC;IACjB,CAAC;AACH,CAAC,qHAGC,WAA4B;IAE5B,MAAM,kBAAkB,GACtB,uBAAA,IAAI,+CAAe,EAAE,KAArB,IAAI,EAAkB,WAAW,CAAC;QAClC,CAAC,uBAAA,IAAI,6CAAa,CAAC,CAAC,CAAC,CAAC,uBAAA,IAAI,6CAAa,MAAjB,IAAI,EAAc,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAE9D,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAC/C,CAAC,QAAQ,EAAsC,EAAE,CAC/C,IAAA,oCAAwB,EAAC,QAAQ,CAAC,CACrC,CAAC;IAEF,OAAO,eAAe,CAAC,MAAM;QAC3B,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,IAAA,gCAAgB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACvC,CAAC","sourcesContent":["import type { StateMetadata } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { Draft } from 'immer';\nimport { noop } from 'lodash';\n\nimport { updateFiatPayment } from './actions/update-fiat-payment';\nimport { updatePaymentToken } from './actions/update-payment-token';\nimport {\n  CONTROLLER_NAME,\n  isTransactionPayStrategy,\n  TransactionPayStrategy,\n} from './constants';\nimport { QuoteRefresher } from './helpers/QuoteRefresher';\nimport type {\n  GetDelegationTransactionCallback,\n  TransactionConfigCallback,\n  TransactionData,\n  TransactionPayControllerMessenger,\n  TransactionPayControllerOptions,\n  TransactionPayControllerState,\n  UpdateFiatPaymentRequest,\n  UpdatePaymentTokenRequest,\n} from './types';\nimport { getStrategyOrder } from './utils/feature-flags';\nimport { updateQuotes } from './utils/quotes';\nimport { updateSourceAmounts } from './utils/source-amounts';\nimport { pollTransactionChanges } from './utils/transaction';\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'getDelegationTransaction',\n  'getStrategy',\n  'setTransactionConfig',\n  'updateFiatPayment',\n  'updatePaymentToken',\n] as const;\n\nconst stateMetadata: StateMetadata<TransactionPayControllerState> = {\n  transactionData: {\n    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    persist: false,\n    usedInUi: true,\n  },\n};\n\nconst getDefaultState = (): TransactionPayControllerState => ({\n  transactionData: {},\n});\n\nexport class TransactionPayController extends BaseController<\n  typeof CONTROLLER_NAME,\n  TransactionPayControllerState,\n  TransactionPayControllerMessenger\n> {\n  readonly #getDelegationTransaction: GetDelegationTransactionCallback;\n\n  readonly #getStrategy?: (\n    transaction: TransactionMeta,\n  ) => TransactionPayStrategy;\n\n  readonly #getStrategies?: (\n    transaction: TransactionMeta,\n  ) => TransactionPayStrategy[];\n\n  constructor({\n    getDelegationTransaction,\n    getStrategy,\n    getStrategies,\n    messenger,\n    state,\n  }: TransactionPayControllerOptions) {\n    super({\n      name: CONTROLLER_NAME,\n      metadata: stateMetadata,\n      messenger,\n      state: { ...getDefaultState(), ...state },\n    });\n\n    this.#getDelegationTransaction = getDelegationTransaction;\n    this.#getStrategy = getStrategy;\n    this.#getStrategies = getStrategies;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    pollTransactionChanges(\n      messenger,\n      this.#updateTransactionData.bind(this),\n      this.#removeTransactionData.bind(this),\n    );\n\n    // eslint-disable-next-line no-new\n    new QuoteRefresher({\n      getStrategies: this.#getStrategiesWithFallback.bind(this),\n      messenger,\n      updateTransactionData: this.#updateTransactionData.bind(this),\n    });\n  }\n\n  /**\n   * Sets the transaction configuration.\n   *\n   * The callback receives the current configuration properties and can mutate\n   * them in place. Updated values are written back to the transaction data.\n   *\n   * @param transactionId - The ID of the transaction to configure.\n   * @param callback - A callback that receives a mutable {@link TransactionConfig} object.\n   */\n  setTransactionConfig(\n    transactionId: string,\n    callback: TransactionConfigCallback,\n  ): void {\n    this.#updateTransactionData(transactionId, (transactionData) => {\n      const config = {\n        isMaxAmount: transactionData.isMaxAmount,\n        isPostQuote: transactionData.isPostQuote,\n        refundTo: transactionData.refundTo,\n      };\n\n      callback(config);\n\n      transactionData.isMaxAmount = config.isMaxAmount;\n      transactionData.isPostQuote = config.isPostQuote;\n      transactionData.refundTo = config.refundTo;\n    });\n  }\n\n  /**\n   * Updates the payment token for a transaction.\n   *\n   * Resolves token metadata and balances, then stores the new payment token\n   * in the transaction data. This triggers recalculation of source amounts\n   * and quote retrieval.\n   *\n   * @param request - The payment token update request containing the\n   * transaction ID, token address, and chain ID.\n   */\n  updatePaymentToken(request: UpdatePaymentTokenRequest): void {\n    updatePaymentToken(request, {\n      messenger: this.messenger,\n      updateTransactionData: this.#updateTransactionData.bind(this),\n    });\n  }\n\n  /**\n   * Updates the fiat payment state for a transaction.\n   *\n   * The request callback receives the current fiat payment state and can\n   * mutate it to update properties such as the selected payment method or\n   * fiat amount.\n   *\n   * @param request - The fiat payment update request containing the\n   * transaction ID and a callback to mutate fiat payment state.\n   */\n  updateFiatPayment(request: UpdateFiatPaymentRequest): void {\n    updateFiatPayment(request, {\n      messenger: this.messenger,\n      updateTransactionData: this.#updateTransactionData.bind(this),\n    });\n  }\n\n  /**\n   * Gets the delegation transaction for a given transaction.\n   *\n   * Converts the provided transaction into a redeem delegation by delegating\n   * to the configured callback. Returns the delegation transaction data\n   * including the encoded call data, target address, value, and an optional\n   * authorization list.\n   *\n   * @param args - The arguments forwarded to the {@link GetDelegationTransactionCallback},\n   * containing the transaction metadata.\n   * @returns A promise resolving to the delegation transaction data.\n   */\n  getDelegationTransaction(\n    ...args: Parameters<GetDelegationTransactionCallback>\n  ): ReturnType<GetDelegationTransactionCallback> {\n    return this.#getDelegationTransaction(...args);\n  }\n\n  /**\n   * Gets the preferred strategy for a transaction.\n   *\n   * Returns the first strategy from the ordered list of strategies applicable\n   * to the given transaction. Falls back to the default strategy order derived\n   * from feature flags when no custom strategy callback is configured.\n   *\n   * @param transaction - The transaction metadata to determine the strategy for.\n   * @returns The preferred {@link TransactionPayStrategy} for the transaction.\n   */\n  getStrategy(transaction: TransactionMeta): TransactionPayStrategy {\n    return this.#getStrategiesWithFallback(transaction)[0];\n  }\n\n  #removeTransactionData(transactionId: string): void {\n    this.update((state) => {\n      delete state.transactionData[transactionId];\n    });\n  }\n\n  #updateTransactionData(\n    transactionId: string,\n    fn: (transactionData: Draft<TransactionData>) => void,\n  ): void {\n    let shouldUpdateQuotes = false;\n\n    this.update((state) => {\n      const { transactionData } = state;\n      let current = transactionData[transactionId];\n      const originalPaymentToken = current?.paymentToken;\n      const originalTokens = current?.tokens;\n      const originalIsMaxAmount = current?.isMaxAmount;\n      const originalIsPostQuote = current?.isPostQuote;\n\n      if (!current) {\n        transactionData[transactionId] = {\n          fiatPayment: {},\n          isLoading: false,\n          tokens: [],\n        };\n\n        current = transactionData[transactionId];\n      }\n\n      fn(current);\n\n      const isPaymentTokenUpdated =\n        current.paymentToken?.address?.toLowerCase() !==\n          originalPaymentToken?.address?.toLowerCase() ||\n        current.paymentToken?.chainId !== originalPaymentToken?.chainId;\n\n      const isTokensUpdated = current.tokens !== originalTokens;\n      const isIsMaxUpdated = current.isMaxAmount !== originalIsMaxAmount;\n      const isPostQuoteUpdated = current.isPostQuote !== originalIsPostQuote;\n\n      if (\n        isPaymentTokenUpdated ||\n        isIsMaxUpdated ||\n        isTokensUpdated ||\n        isPostQuoteUpdated\n      ) {\n        updateSourceAmounts(transactionId, current as never, this.messenger);\n\n        shouldUpdateQuotes = true;\n      }\n    });\n\n    if (shouldUpdateQuotes) {\n      updateQuotes({\n        getStrategies: this.#getStrategiesWithFallback.bind(this),\n        messenger: this.messenger,\n        transactionData: this.state.transactionData[transactionId],\n        transactionId,\n        updateTransactionData: this.#updateTransactionData.bind(this),\n      }).catch(noop);\n    }\n  }\n\n  #getStrategiesWithFallback(\n    transaction: TransactionMeta,\n  ): TransactionPayStrategy[] {\n    const strategyCandidates: unknown[] =\n      this.#getStrategies?.(transaction) ??\n      (this.#getStrategy ? [this.#getStrategy(transaction)] : []);\n\n    const validStrategies = strategyCandidates.filter(\n      (strategy): strategy is TransactionPayStrategy =>\n        isTransactionPayStrategy(strategy),\n    );\n\n    return validStrategies.length\n      ? validStrategies\n      : getStrategyOrder(this.messenger);\n  }\n}\n"]}

package/dist/TransactionPayController.d.cts

@@ -1,11 +1,65 @@
 import { BaseController } from "@metamask/base-controller";
-import { CONTROLLER_NAME } from "./constants.cjs";
-import type { TransactionConfigCallback, TransactionPayControllerMessenger, TransactionPayControllerOptions, TransactionPayControllerState, UpdateFiatPaymentRequest, UpdatePaymentTokenRequest } from "./types.cjs";
+import type { TransactionMeta } from "@metamask/transaction-controller";
+import { CONTROLLER_NAME, TransactionPayStrategy } from "./constants.cjs";
+import type { GetDelegationTransactionCallback, TransactionConfigCallback, TransactionPayControllerMessenger, TransactionPayControllerOptions, TransactionPayControllerState, UpdateFiatPaymentRequest, UpdatePaymentTokenRequest } from "./types.cjs";
 export declare class TransactionPayController extends BaseController<typeof CONTROLLER_NAME, TransactionPayControllerState, TransactionPayControllerMessenger> {
     #private;
     constructor({ getDelegationTransaction, getStrategy, getStrategies, messenger, state, }: TransactionPayControllerOptions);
+    /**
+     * Sets the transaction configuration.
+     *
+     * The callback receives the current configuration properties and can mutate
+     * them in place. Updated values are written back to the transaction data.
+     *
+     * @param transactionId - The ID of the transaction to configure.
+     * @param callback - A callback that receives a mutable {@link TransactionConfig} object.
+     */
     setTransactionConfig(transactionId: string, callback: TransactionConfigCallback): void;
+    /**
+     * Updates the payment token for a transaction.
+     *
+     * Resolves token metadata and balances, then stores the new payment token
+     * in the transaction data. This triggers recalculation of source amounts
+     * and quote retrieval.
+     *
+     * @param request - The payment token update request containing the
+     * transaction ID, token address, and chain ID.
+     */
     updatePaymentToken(request: UpdatePaymentTokenRequest): void;
+    /**
+     * Updates the fiat payment state for a transaction.
+     *
+     * The request callback receives the current fiat payment state and can
+     * mutate it to update properties such as the selected payment method or
+     * fiat amount.
+     *
+     * @param request - The fiat payment update request containing the
+     * transaction ID and a callback to mutate fiat payment state.
+     */
     updateFiatPayment(request: UpdateFiatPaymentRequest): void;
+    /**
+     * Gets the delegation transaction for a given transaction.
+     *
+     * Converts the provided transaction into a redeem delegation by delegating
+     * to the configured callback. Returns the delegation transaction data
+     * including the encoded call data, target address, value, and an optional
+     * authorization list.
+     *
+     * @param args - The arguments forwarded to the {@link GetDelegationTransactionCallback},
+     * containing the transaction metadata.
+     * @returns A promise resolving to the delegation transaction data.
+     */
+    getDelegationTransaction(...args: Parameters<GetDelegationTransactionCallback>): ReturnType<GetDelegationTransactionCallback>;
+    /**
+     * Gets the preferred strategy for a transaction.
+     *
+     * Returns the first strategy from the ordered list of strategies applicable
+     * to the given transaction. Falls back to the default strategy order derived
+     * from feature flags when no custom strategy callback is configured.
+     *
+     * @param transaction - The transaction metadata to determine the strategy for.
+     * @returns The preferred {@link TransactionPayStrategy} for the transaction.
+     */
+    getStrategy(transaction: TransactionMeta): TransactionPayStrategy;
 }
 //# sourceMappingURL=TransactionPayController.d.cts.map

package/dist/TransactionPayController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"TransactionPayController.d.cts","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAO3D,OAAO,EACL,eAAe,EAGhB,wBAAoB;AAErB,OAAO,KAAK,EAEV,yBAAyB,EAEzB,iCAAiC,EACjC,+BAA+B,EAC/B,6BAA6B,EAC7B,wBAAwB,EACxB,yBAAyB,EAC1B,oBAAgB;AAmBjB,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,eAAe,EACtB,6BAA6B,EAC7B,iCAAiC,CAClC;;gBAWa,EACV,wBAAwB,EACxB,WAAW,EACX,aAAa,EACb,SAAS,EACT,KAAK,GACN,EAAE,+BAA+B;IA4BlC,oBAAoB,CAClB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,yBAAyB,GAClC,IAAI;IAgBP,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,IAAI;IAO5D,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;CAmH3D"}
+{"version":3,"file":"TransactionPayController.d.cts","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAMxE,OAAO,EACL,eAAe,EAEf,sBAAsB,EACvB,wBAAoB;AAErB,OAAO,KAAK,EACV,gCAAgC,EAChC,yBAAyB,EAEzB,iCAAiC,EACjC,+BAA+B,EAC/B,6BAA6B,EAC7B,wBAAwB,EACxB,yBAAyB,EAC1B,oBAAgB;AA2BjB,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,eAAe,EACtB,6BAA6B,EAC7B,iCAAiC,CAClC;;gBAWa,EACV,wBAAwB,EACxB,WAAW,EACX,aAAa,EACb,SAAS,EACT,KAAK,GACN,EAAE,+BAA+B;IA+BlC;;;;;;;;OAQG;IACH,oBAAoB,CAClB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,yBAAyB,GAClC,IAAI;IAgBP;;;;;;;;;OASG;IACH,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,IAAI;IAO5D;;;;;;;;;OASG;IACH,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;IAO1D;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,GAAG,IAAI,EAAE,UAAU,CAAC,gCAAgC,CAAC,GACpD,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;OASG;IACH,WAAW,CAAC,WAAW,EAAE,eAAe,GAAG,sBAAsB;CAoFlE"}

package/dist/TransactionPayController.d.mts

@@ -1,11 +1,65 @@
 import { BaseController } from "@metamask/base-controller";
-import { CONTROLLER_NAME } from "./constants.mjs";
-import type { TransactionConfigCallback, TransactionPayControllerMessenger, TransactionPayControllerOptions, TransactionPayControllerState, UpdateFiatPaymentRequest, UpdatePaymentTokenRequest } from "./types.mjs";
+import type { TransactionMeta } from "@metamask/transaction-controller";
+import { CONTROLLER_NAME, TransactionPayStrategy } from "./constants.mjs";
+import type { GetDelegationTransactionCallback, TransactionConfigCallback, TransactionPayControllerMessenger, TransactionPayControllerOptions, TransactionPayControllerState, UpdateFiatPaymentRequest, UpdatePaymentTokenRequest } from "./types.mjs";
 export declare class TransactionPayController extends BaseController<typeof CONTROLLER_NAME, TransactionPayControllerState, TransactionPayControllerMessenger> {
     #private;
     constructor({ getDelegationTransaction, getStrategy, getStrategies, messenger, state, }: TransactionPayControllerOptions);
+    /**
+     * Sets the transaction configuration.
+     *
+     * The callback receives the current configuration properties and can mutate
+     * them in place. Updated values are written back to the transaction data.
+     *
+     * @param transactionId - The ID of the transaction to configure.
+     * @param callback - A callback that receives a mutable {@link TransactionConfig} object.
+     */
     setTransactionConfig(transactionId: string, callback: TransactionConfigCallback): void;
+    /**
+     * Updates the payment token for a transaction.
+     *
+     * Resolves token metadata and balances, then stores the new payment token
+     * in the transaction data. This triggers recalculation of source amounts
+     * and quote retrieval.
+     *
+     * @param request - The payment token update request containing the
+     * transaction ID, token address, and chain ID.
+     */
     updatePaymentToken(request: UpdatePaymentTokenRequest): void;
+    /**
+     * Updates the fiat payment state for a transaction.
+     *
+     * The request callback receives the current fiat payment state and can
+     * mutate it to update properties such as the selected payment method or
+     * fiat amount.
+     *
+     * @param request - The fiat payment update request containing the
+     * transaction ID and a callback to mutate fiat payment state.
+     */
     updateFiatPayment(request: UpdateFiatPaymentRequest): void;
+    /**
+     * Gets the delegation transaction for a given transaction.
+     *
+     * Converts the provided transaction into a redeem delegation by delegating
+     * to the configured callback. Returns the delegation transaction data
+     * including the encoded call data, target address, value, and an optional
+     * authorization list.
+     *
+     * @param args - The arguments forwarded to the {@link GetDelegationTransactionCallback},
+     * containing the transaction metadata.
+     * @returns A promise resolving to the delegation transaction data.
+     */
+    getDelegationTransaction(...args: Parameters<GetDelegationTransactionCallback>): ReturnType<GetDelegationTransactionCallback>;
+    /**
+     * Gets the preferred strategy for a transaction.
+     *
+     * Returns the first strategy from the ordered list of strategies applicable
+     * to the given transaction. Falls back to the default strategy order derived
+     * from feature flags when no custom strategy callback is configured.
+     *
+     * @param transaction - The transaction metadata to determine the strategy for.
+     * @returns The preferred {@link TransactionPayStrategy} for the transaction.
+     */
+    getStrategy(transaction: TransactionMeta): TransactionPayStrategy;
 }
 //# sourceMappingURL=TransactionPayController.d.mts.map

package/dist/TransactionPayController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"TransactionPayController.d.mts","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAO3D,OAAO,EACL,eAAe,EAGhB,wBAAoB;AAErB,OAAO,KAAK,EAEV,yBAAyB,EAEzB,iCAAiC,EACjC,+BAA+B,EAC/B,6BAA6B,EAC7B,wBAAwB,EACxB,yBAAyB,EAC1B,oBAAgB;AAmBjB,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,eAAe,EACtB,6BAA6B,EAC7B,iCAAiC,CAClC;;gBAWa,EACV,wBAAwB,EACxB,WAAW,EACX,aAAa,EACb,SAAS,EACT,KAAK,GACN,EAAE,+BAA+B;IA4BlC,oBAAoB,CAClB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,yBAAyB,GAClC,IAAI;IAgBP,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,IAAI;IAO5D,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;CAmH3D"}
+{"version":3,"file":"TransactionPayController.d.mts","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAMxE,OAAO,EACL,eAAe,EAEf,sBAAsB,EACvB,wBAAoB;AAErB,OAAO,KAAK,EACV,gCAAgC,EAChC,yBAAyB,EAEzB,iCAAiC,EACjC,+BAA+B,EAC/B,6BAA6B,EAC7B,wBAAwB,EACxB,yBAAyB,EAC1B,oBAAgB;AA2BjB,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,eAAe,EACtB,6BAA6B,EAC7B,iCAAiC,CAClC;;gBAWa,EACV,wBAAwB,EACxB,WAAW,EACX,aAAa,EACb,SAAS,EACT,KAAK,GACN,EAAE,+BAA+B;IA+BlC;;;;;;;;OAQG;IACH,oBAAoB,CAClB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,yBAAyB,GAClC,IAAI;IAgBP;;;;;;;;;OASG;IACH,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,IAAI;IAO5D;;;;;;;;;OASG;IACH,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;IAO1D;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,GAAG,IAAI,EAAE,UAAU,CAAC,gCAAgC,CAAC,GACpD,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;OASG;IACH,WAAW,CAAC,WAAW,EAAE,eAAe,GAAG,sBAAsB;CAoFlE"}