@metamask-previews/transaction-pay-controller 27.1.2-preview-6eff555ee → 28.0.0-preview-0a30e47

package/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [28.0.0]
+
+### Changed
+
+- **BREAKING:** Drop CommonJS support ([#9536](https://github.com/MetaMask/core/pull/9536))
+  - This package is now ESM-only, but can still be used in CommonJS projects via `require(esm)` in modern Node.js versions (22+), or dynamic imports in older Node.js versions.
+- **BREAKING:** Bump minimum Node.js version to 22 ([#9976](https://github.com/MetaMask/core/pull/9976))
+- **BREAKING:** Bump TypeScript target to ES2022 ([#10019](https://github.com/MetaMask/core/pull/10019))
+  - This package now ships ES2022 code, requiring a compatible modern environment or bundler configuration to consume.
+- Bump `@metamask/assets-controllers` from `^111.2.0` to `^112.0.0` ([#10152](https://github.com/MetaMask/core/pull/10152), [#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/assets-controller` from `^15.1.0` to `^16.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/base-controller` from `^9.1.0` to `^10.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/controller-utils` from `^12.3.0` to `^13.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/gas-fee-controller` from `^26.3.2` to `^27.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/keyring-controller` from `^27.1.1` to `^28.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/messenger` from `^2.0.0` to `^3.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/network-controller` from `^36.0.0` to `^37.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/ramps-controller` from `^20.3.0` to `^21.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/remote-feature-flag-controller` from `^6.1.1` to `^7.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/sentinel-api-service` from `^1.0.1` to `^2.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/transaction-controller` from `^69.8.1` to `^70.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+
 ## [27.1.2]
 
 ### Changed
@@ -1505,7 +1527,8 @@ 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@27.1.2...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@28.0.0...HEAD
+[28.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@27.1.2...@metamask/transaction-pay-controller@28.0.0
 [27.1.2]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@27.1.1...@metamask/transaction-pay-controller@27.1.2
 [27.1.1]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@27.1.0...@metamask/transaction-pay-controller@27.1.1
 [27.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@27.0.0...@metamask/transaction-pay-controller@27.1.0

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

@@ -0,0 +1,132 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { TransactionPayController } from './TransactionPayController.js';
+/**
+ * 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'];
+};
+/**
+ * Returns additional transactions for the paymentOverride flow.
+ *
+ * Delegates to the client-supplied {@link GetPaymentOverrideDataCallback}.
+ * Called during quote execution when `paymentOverride` is defined on the transaction.
+ * Returns an empty array when no callback is configured.
+ *
+ * @param args - The arguments forwarded to the {@link GetPaymentOverrideDataCallback}.
+ * @returns A promise resolving to the additional transactions array.
+ */
+export type TransactionPayControllerGetAmountDataAction = {
+    type: `TransactionPayController:getAmountData`;
+    handler: TransactionPayController['getAmountData'];
+};
+/**
+ * Returns optional fiat execution configuration.
+ *
+ * This is intentionally not stored in controller state.
+ *
+ * @returns Fiat execution options, if configured.
+ */
+export type TransactionPayControllerGetFiatOptionsAction = {
+    type: `TransactionPayController:getFiatOptions`;
+    handler: TransactionPayController['getFiatOptions'];
+};
+export type TransactionPayControllerGetPaymentOverrideDataAction = {
+    type: `TransactionPayController:getPaymentOverrideData`;
+    handler: TransactionPayController['getPaymentOverrideData'];
+};
+/**
+ * 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'];
+};
+/**
+ * Derives the Polymarket deposit-wallet address for an EOA via the
+ * client-supplied callback.
+ *
+ * @param args - The arguments forwarded to {@link PolymarketCallbacks.getDepositWalletAddress}.
+ * @returns A promise resolving to the deposit-wallet address.
+ */
+export type TransactionPayControllerPolymarketGetDepositWalletAddressAction = {
+    type: `TransactionPayController:polymarketGetDepositWalletAddress`;
+    handler: TransactionPayController['polymarketGetDepositWalletAddress'];
+};
+/**
+ * Signs and broadcasts a Polymarket deposit-wallet batch via the
+ * client-supplied callback.
+ *
+ * @param args - The arguments forwarded to {@link PolymarketCallbacks.submitDepositWalletBatch}.
+ * @returns A promise resolving to the relayer-issued source hash.
+ */
+export type TransactionPayControllerPolymarketSubmitDepositWalletBatchAction = {
+    type: `TransactionPayController:polymarketSubmitDepositWalletBatch`;
+    handler: TransactionPayController['polymarketSubmitDepositWalletBatch'];
+};
+/**
+ * Union of all TransactionPayController action types.
+ */
+export type TransactionPayControllerMethodActions = TransactionPayControllerSetTransactionConfigAction | TransactionPayControllerUpdatePaymentTokenAction | TransactionPayControllerUpdateFiatPaymentAction | TransactionPayControllerGetDelegationTransactionAction | TransactionPayControllerGetAmountDataAction | TransactionPayControllerGetFiatOptionsAction | TransactionPayControllerGetPaymentOverrideDataAction | TransactionPayControllerGetStrategyAction | TransactionPayControllerPolymarketGetDepositWalletAddressAction | TransactionPayControllerPolymarketSubmitDepositWalletBatchAction;
+//# sourceMappingURL=TransactionPayController-method-action-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController-method-action-types.d.ts","sourceRoot":"","sources":["../src/TransactionPayController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAE9E;;;;;;;;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,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,wBAAwB,CAAC,eAAe,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,wBAAwB,CAAC,wBAAwB,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,wBAAwB,CAAC,aAAa,CAAC,CAAC;CAClD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+DAA+D,GAAG;IAC5E,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,wBAAwB,CAAC,mCAAmC,CAAC,CAAC;CACxE,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,gEAAgE,GAAG;IAC7E,IAAI,EAAE,6DAA6D,CAAC;IACpE,OAAO,EAAE,wBAAwB,CAAC,oCAAoC,CAAC,CAAC;CACzE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC7C,kDAAkD,GAClD,gDAAgD,GAChD,+CAA+C,GAC/C,sDAAsD,GACtD,2CAA2C,GAC3C,4CAA4C,GAC5C,oDAAoD,GACpD,yCAAyC,GACzC,+DAA+D,GAC/D,gEAAgE,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController-method-action-types.js","sourceRoot":"","sources":["../src/TransactionPayController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { TransactionPayController } from './TransactionPayController.js';\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 * Returns additional transactions for the paymentOverride flow.\n *\n * Delegates to the client-supplied {@link GetPaymentOverrideDataCallback}.\n * Called during quote execution when `paymentOverride` is defined on the transaction.\n * Returns an empty array when no callback is configured.\n *\n * @param args - The arguments forwarded to the {@link GetPaymentOverrideDataCallback}.\n * @returns A promise resolving to the additional transactions array.\n */\nexport type TransactionPayControllerGetAmountDataAction = {\n  type: `TransactionPayController:getAmountData`;\n  handler: TransactionPayController['getAmountData'];\n};\n\n/**\n * Returns optional fiat execution configuration.\n *\n * This is intentionally not stored in controller state.\n *\n * @returns Fiat execution options, if configured.\n */\nexport type TransactionPayControllerGetFiatOptionsAction = {\n  type: `TransactionPayController:getFiatOptions`;\n  handler: TransactionPayController['getFiatOptions'];\n};\n\nexport type TransactionPayControllerGetPaymentOverrideDataAction = {\n  type: `TransactionPayController:getPaymentOverrideData`;\n  handler: TransactionPayController['getPaymentOverrideData'];\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 * Derives the Polymarket deposit-wallet address for an EOA via the\n * client-supplied callback.\n *\n * @param args - The arguments forwarded to {@link PolymarketCallbacks.getDepositWalletAddress}.\n * @returns A promise resolving to the deposit-wallet address.\n */\nexport type TransactionPayControllerPolymarketGetDepositWalletAddressAction = {\n  type: `TransactionPayController:polymarketGetDepositWalletAddress`;\n  handler: TransactionPayController['polymarketGetDepositWalletAddress'];\n};\n\n/**\n * Signs and broadcasts a Polymarket deposit-wallet batch via the\n * client-supplied callback.\n *\n * @param args - The arguments forwarded to {@link PolymarketCallbacks.submitDepositWalletBatch}.\n * @returns A promise resolving to the relayer-issued source hash.\n */\nexport type TransactionPayControllerPolymarketSubmitDepositWalletBatchAction = {\n  type: `TransactionPayController:polymarketSubmitDepositWalletBatch`;\n  handler: TransactionPayController['polymarketSubmitDepositWalletBatch'];\n};\n\n/**\n * Union of all TransactionPayController action types.\n */\nexport type TransactionPayControllerMethodActions =\n  | TransactionPayControllerSetTransactionConfigAction\n  | TransactionPayControllerUpdatePaymentTokenAction\n  | TransactionPayControllerUpdateFiatPaymentAction\n  | TransactionPayControllerGetDelegationTransactionAction\n  | TransactionPayControllerGetAmountDataAction\n  | TransactionPayControllerGetFiatOptionsAction\n  | TransactionPayControllerGetPaymentOverrideDataAction\n  | TransactionPayControllerGetStrategyAction\n  | TransactionPayControllerPolymarketGetDepositWalletAddressAction\n  | TransactionPayControllerPolymarketSubmitDepositWalletBatchAction;\n"]}

package/dist/TransactionPayController.d.ts

@@ -0,0 +1,101 @@
+import { BaseController } from '@metamask/base-controller';
+import type { TransactionMeta } from '@metamask/transaction-controller';
+import { CONTROLLER_NAME, TransactionPayStrategy } from './constants.js';
+import type { GetAmountDataCallback, GetDelegationTransactionCallback, GetPaymentOverrideDataCallback, PolymarketCallbacks, TransactionConfigCallback, TransactionPayControllerMessenger, TransactionPayFiatOptions, TransactionPayControllerOptions, TransactionPayControllerState, UpdateFiatPaymentRequest, UpdatePaymentTokenRequest } from './types.js';
+export declare class TransactionPayController extends BaseController<typeof CONTROLLER_NAME, TransactionPayControllerState, TransactionPayControllerMessenger> {
+    #private;
+    constructor({ fiatOptions, getAmountData, getBalance, getDelegationTransaction, getPaymentOverrideData, getStrategy, getStrategies, messenger, polymarket, 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>;
+    /**
+     * Returns additional transactions for the paymentOverride flow.
+     *
+     * Delegates to the client-supplied {@link GetPaymentOverrideDataCallback}.
+     * Called during quote execution when `paymentOverride` is defined on the transaction.
+     * Returns an empty array when no callback is configured.
+     *
+     * @param args - The arguments forwarded to the {@link GetPaymentOverrideDataCallback}.
+     * @returns A promise resolving to the additional transactions array.
+     */
+    getAmountData(...args: Parameters<GetAmountDataCallback>): ReturnType<GetAmountDataCallback>;
+    /**
+     * Returns optional fiat execution configuration.
+     *
+     * This is intentionally not stored in controller state.
+     *
+     * @returns Fiat execution options, if configured.
+     */
+    getFiatOptions(): TransactionPayFiatOptions | undefined;
+    getPaymentOverrideData(...args: Parameters<GetPaymentOverrideDataCallback>): ReturnType<GetPaymentOverrideDataCallback>;
+    /**
+     * 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;
+    /**
+     * Derives the Polymarket deposit-wallet address for an EOA via the
+     * client-supplied callback.
+     *
+     * @param args - The arguments forwarded to {@link PolymarketCallbacks.getDepositWalletAddress}.
+     * @returns A promise resolving to the deposit-wallet address.
+     */
+    polymarketGetDepositWalletAddress(...args: Parameters<PolymarketCallbacks['getDepositWalletAddress']>): ReturnType<PolymarketCallbacks['getDepositWalletAddress']>;
+    /**
+     * Signs and broadcasts a Polymarket deposit-wallet batch via the
+     * client-supplied callback.
+     *
+     * @param args - The arguments forwarded to {@link PolymarketCallbacks.submitDepositWalletBatch}.
+     * @returns A promise resolving to the relayer-issued source hash.
+     */
+    polymarketSubmitDepositWalletBatch(...args: Parameters<PolymarketCallbacks['submitDepositWalletBatch']>): ReturnType<PolymarketCallbacks['submitDepositWalletBatch']>;
+}
+//# sourceMappingURL=TransactionPayController.d.ts.map

package/dist/TransactionPayController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController.d.ts","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAMxE,OAAO,EACL,eAAe,EAEf,sBAAsB,EACvB,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EACV,qBAAqB,EAErB,gCAAgC,EAChC,8BAA8B,EAC9B,mBAAmB,EAEnB,yBAAyB,EAEzB,iCAAiC,EACjC,yBAAyB,EACzB,+BAA+B,EAC/B,6BAA6B,EAC7B,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,YAAY,CAAC;AAmCpB,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,eAAe,EACtB,6BAA6B,EAC7B,iCAAiC,CAClC;;IAqBC,YAAY,EACV,WAAW,EACX,aAAa,EACb,UAAU,EACV,wBAAwB,EACxB,sBAAsB,EACtB,WAAW,EACX,aAAa,EACb,SAAS,EACT,UAAU,EACV,KAAK,GACN,EAAE,+BAA+B,EAwCjC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAClB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,yBAAyB,GAClC,IAAI,CA2BN;IAED;;;;;;;;;OASG;IACH,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,IAAI,CAK3D;IAED;;;;;;;;;OASG;IACH,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAKzD;IAED;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,GAAG,IAAI,EAAE,UAAU,CAAC,gCAAgC,CAAC,GACpD,UAAU,CAAC,gCAAgC,CAAC,CAE9C;IAED;;;;;;;;;OASG;IACH,aAAa,CACX,GAAG,IAAI,EAAE,UAAU,CAAC,qBAAqB,CAAC,GACzC,UAAU,CAAC,qBAAqB,CAAC,CAEnC;IAED;;;;;;OAMG;IACH,cAAc,IAAI,yBAAyB,GAAG,SAAS,CAEtD;IAED,sBAAsB,CACpB,GAAG,IAAI,EAAE,UAAU,CAAC,8BAA8B,CAAC,GAClD,UAAU,CAAC,8BAA8B,CAAC,CAI5C;IAED;;;;;;;;;OASG;IACH,WAAW,CAAC,WAAW,EAAE,eAAe,GAAG,sBAAsB,CAEhE;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,GAAG,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC,GAClE,UAAU,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC,CAE5D;IAED;;;;;;OAMG;IACH,kCAAkC,CAChC,GAAG,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,0BAA0B,CAAC,CAAC,GACnE,UAAU,CAAC,mBAAmB,CAAC,0BAA0B,CAAC,CAAC,CAE7D;CA0HF"}

package/dist/TransactionPayController.js

@@ -0,0 +1,281 @@
+import { BaseController } from '@metamask/base-controller';
+import { noop } from 'lodash-es';
+import { updateFiatPayment } from './actions/update-fiat-payment.js';
+import { updatePaymentToken } from './actions/update-payment-token.js';
+import { CONTROLLER_NAME, isTransactionPayStrategy, } from './constants.js';
+import { QuoteRefresher } from './helpers/QuoteRefresher.js';
+import { getStrategyOrder } from './utils/feature-flags.js';
+import { updateQuotes } from './utils/quotes.js';
+import { updateSourceAmounts } from './utils/source-amounts.js';
+import { subscribeAssetChanges, subscribeTransactionChanges, } from './utils/transaction.js';
+const MESSENGER_EXPOSED_METHODS = [
+    'getAmountData',
+    'getDelegationTransaction',
+    'getFiatOptions',
+    'getPaymentOverrideData',
+    'getStrategy',
+    'polymarketGetDepositWalletAddress',
+    'polymarketSubmitDepositWalletBatch',
+    'setTransactionConfig',
+    'updateFiatPayment',
+    'updatePaymentToken',
+];
+const stateMetadata = {
+    transactionData: {
+        includeInDebugSnapshot: false,
+        includeInStateLogs: true,
+        persist: false,
+        usedInUi: true,
+    },
+};
+const getDefaultState = () => ({
+    transactionData: {},
+});
+export class TransactionPayController extends BaseController {
+    #fiatOptions;
+    #getAmountData;
+    #getBalance;
+    #getDelegationTransaction;
+    #getPaymentOverrideData;
+    #getStrategy;
+    #getStrategies;
+    #polymarket;
+    constructor({ fiatOptions, getAmountData, getBalance, getDelegationTransaction, getPaymentOverrideData, getStrategy, getStrategies, messenger, polymarket, state, }) {
+        super({
+            name: CONTROLLER_NAME,
+            metadata: stateMetadata,
+            messenger,
+            state: { ...getDefaultState(), ...state },
+        });
+        this.#fiatOptions = fiatOptions;
+        this.#getAmountData = getAmountData;
+        this.#getBalance = getBalance;
+        this.#getDelegationTransaction = getDelegationTransaction;
+        this.#getPaymentOverrideData = getPaymentOverrideData;
+        this.#getStrategy = getStrategy;
+        this.#getStrategies = getStrategies;
+        this.#polymarket = polymarket;
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+        subscribeTransactionChanges(messenger, this.#updateTransactionData.bind(this), this.#removeTransactionData.bind(this));
+        subscribeAssetChanges(messenger, () => this.state, this.#updateTransactionData.bind(this));
+        // eslint-disable-next-line no-new
+        new QuoteRefresher({
+            getStrategies: this.#getStrategiesWithFallback.bind(this),
+            messenger,
+            updateTransactionData: this.#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) {
+        this.#updateTransactionData(transactionId, (transactionData) => {
+            const config = {
+                accountOverride: transactionData.accountOverride,
+                atomic: transactionData.atomic,
+                isHyperliquidSource: transactionData.isHyperliquidSource,
+                isMaxAmount: transactionData.isMaxAmount,
+                isPolymarketDepositWallet: transactionData.isPolymarketDepositWallet,
+                isPostQuote: transactionData.isPostQuote,
+                isQuoteRequired: transactionData.isQuoteRequired,
+                paymentOverride: transactionData.paymentOverride,
+                refundTo: transactionData.refundTo,
+            };
+            const previousAccountOverride = config.accountOverride;
+            callback(config);
+            Object.assign(transactionData, config);
+            if (!config.isPostQuote &&
+                config.accountOverride !== previousAccountOverride) {
+                transactionData.paymentToken = undefined;
+            }
+        });
+    }
+    /**
+     * 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) {
+        updatePaymentToken(request, {
+            messenger: this.messenger,
+            updateTransactionData: this.#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) {
+        updateFiatPayment(request, {
+            messenger: this.messenger,
+            updateTransactionData: this.#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 this.#getDelegationTransaction(...args);
+    }
+    /**
+     * Returns additional transactions for the paymentOverride flow.
+     *
+     * Delegates to the client-supplied {@link GetPaymentOverrideDataCallback}.
+     * Called during quote execution when `paymentOverride` is defined on the transaction.
+     * Returns an empty array when no callback is configured.
+     *
+     * @param args - The arguments forwarded to the {@link GetPaymentOverrideDataCallback}.
+     * @returns A promise resolving to the additional transactions array.
+     */
+    getAmountData(...args) {
+        return this.#getAmountData?.(...args) ?? Promise.resolve({ updates: [] });
+    }
+    /**
+     * Returns optional fiat execution configuration.
+     *
+     * This is intentionally not stored in controller state.
+     *
+     * @returns Fiat execution options, if configured.
+     */
+    getFiatOptions() {
+        return this.#fiatOptions;
+    }
+    getPaymentOverrideData(...args) {
+        return (this.#getPaymentOverrideData?.(...args) ?? Promise.resolve({ calls: [] }));
+    }
+    /**
+     * 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 this.#getStrategiesWithFallback(transaction)[0];
+    }
+    /**
+     * Derives the Polymarket deposit-wallet address for an EOA via the
+     * client-supplied callback.
+     *
+     * @param args - The arguments forwarded to {@link PolymarketCallbacks.getDepositWalletAddress}.
+     * @returns A promise resolving to the deposit-wallet address.
+     */
+    polymarketGetDepositWalletAddress(...args) {
+        return this.#requirePolymarket().getDepositWalletAddress(...args);
+    }
+    /**
+     * Signs and broadcasts a Polymarket deposit-wallet batch via the
+     * client-supplied callback.
+     *
+     * @param args - The arguments forwarded to {@link PolymarketCallbacks.submitDepositWalletBatch}.
+     * @returns A promise resolving to the relayer-issued source hash.
+     */
+    polymarketSubmitDepositWalletBatch(...args) {
+        return this.#requirePolymarket().submitDepositWalletBatch(...args);
+    }
+    #requirePolymarket() {
+        if (!this.#polymarket) {
+            throw new Error('TransactionPayController: Polymarket callbacks missing');
+        }
+        return this.#polymarket;
+    }
+    #removeTransactionData(transactionId) {
+        this.update((state) => {
+            delete state.transactionData[transactionId];
+        });
+    }
+    #updateTransactionData(transactionId, fn) {
+        let shouldUpdateQuotes = false;
+        this.update((state) => {
+            const { transactionData } = state;
+            let current = transactionData[transactionId];
+            const originalPaymentToken = current?.paymentToken;
+            const originalTokens = current?.tokens;
+            const originalIsMaxAmount = current?.isMaxAmount;
+            const originalIsPostQuote = current?.isPostQuote;
+            const originalAccountOverride = current?.accountOverride;
+            const originalFiatPaymentAmount = current?.fiatPayment?.amountFiat;
+            const originalFiatPaymentMethodId = current?.fiatPayment?.selectedPaymentMethodId;
+            if (!current) {
+                transactionData[transactionId] = {
+                    fiatPayment: {},
+                    isLoading: false,
+                    tokens: [],
+                };
+                current = transactionData[transactionId];
+            }
+            fn(current);
+            const isPaymentTokenUpdated = current.paymentToken?.address?.toLowerCase() !==
+                originalPaymentToken?.address?.toLowerCase() ||
+                current.paymentToken?.chainId !== originalPaymentToken?.chainId;
+            const isTokensUpdated = current.tokens !== originalTokens;
+            const isIsMaxUpdated = current.isMaxAmount !== originalIsMaxAmount;
+            const isPostQuoteUpdated = current.isPostQuote !== originalIsPostQuote;
+            const isAccountOverrideUpdated = current.accountOverride !== originalAccountOverride;
+            const isFiatAmountUpdated = current.fiatPayment?.amountFiat !== originalFiatPaymentAmount;
+            const isFiatPaymentMethodUpdated = current.fiatPayment?.selectedPaymentMethodId !==
+                originalFiatPaymentMethodId;
+            if (isPaymentTokenUpdated ||
+                isIsMaxUpdated ||
+                isTokensUpdated ||
+                isPostQuoteUpdated ||
+                isAccountOverrideUpdated) {
+                updateSourceAmounts(transactionId, current, this.messenger, this.#getBalance);
+                shouldUpdateQuotes = true;
+            }
+            if (isFiatAmountUpdated || isFiatPaymentMethodUpdated) {
+                shouldUpdateQuotes = true;
+            }
+        });
+        if (shouldUpdateQuotes) {
+            updateQuotes({
+                getStrategies: this.#getStrategiesWithFallback.bind(this),
+                messenger: this.messenger,
+                transactionData: this.state.transactionData[transactionId],
+                transactionId,
+                updateTransactionData: this.#updateTransactionData.bind(this),
+            }).catch(noop);
+        }
+    }
+    #getStrategiesWithFallback(transaction) {
+        const transactionData = this.state.transactionData[transaction.id];
+        const strategyCandidates = this.#getStrategies?.(transaction) ??
+            (this.#getStrategy ? [this.#getStrategy(transaction)] : []);
+        const validStrategies = strategyCandidates.filter((strategy) => isTransactionPayStrategy(strategy));
+        if (validStrategies.length) {
+            return validStrategies;
+        }
+        const paymentToken = transactionData?.paymentToken;
+        return getStrategyOrder(this.messenger, paymentToken?.chainId, paymentToken?.address, transaction.type, transactionData?.fiatPayment?.selectedPaymentMethodId);
+    }
+}
+//# sourceMappingURL=TransactionPayController.js.map

package/dist/TransactionPayController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController.js","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAG3D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EACL,eAAe,EACf,wBAAwB,GAEzB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAiB7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EACL,qBAAqB,EACrB,2BAA2B,GAC5B,MAAM,wBAAwB,CAAC;AAEhC,MAAM,yBAAyB,GAAG;IAChC,eAAe;IACf,0BAA0B;IAC1B,gBAAgB;IAChB,wBAAwB;IACxB,aAAa;IACb,mCAAmC;IACnC,oCAAoC;IACpC,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,MAAM,OAAO,wBAAyB,SAAQ,cAI7C;IACU,YAAY,CAA6B;IAEzC,cAAc,CAAyB;IAEvC,WAAW,CAAsB;IAEjC,yBAAyB,CAAmC;IAE5D,uBAAuB,CAAkC;IAEzD,YAAY,CAEO;IAEnB,cAAc,CAEO;IAErB,WAAW,CAAuB;IAE3C,YAAY,EACV,WAAW,EACX,aAAa,EACb,UAAU,EACV,wBAAwB,EACxB,sBAAsB,EACtB,WAAW,EACX,aAAa,EACb,SAAS,EACT,UAAU,EACV,KAAK,GAC2B;QAChC,KAAK,CAAC;YACJ,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,eAAe,EAAE,EAAE,GAAG,KAAK,EAAE;SAC1C,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,yBAAyB,GAAG,wBAAwB,CAAC;QAC1D,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAE9B,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,2BAA2B,CACzB,SAAS,EACT,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,EACtC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;QAEF,qBAAqB,CACnB,SAAS,EACT,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAChB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;QAEF,kCAAkC;QAClC,IAAI,cAAc,CAAC;YACjB,aAAa,EAAE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC;YACzD,SAAS;YACT,qBAAqB,EAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAClB,aAAqB,EACrB,QAAmC;QAEnC,IAAI,CAAC,sBAAsB,CAAC,aAAa,EAAE,CAAC,eAAe,EAAE,EAAE;YAC7D,MAAM,MAAM,GAAsB;gBAChC,eAAe,EAAE,eAAe,CAAC,eAAe;gBAChD,MAAM,EAAE,eAAe,CAAC,MAAM;gBAC9B,mBAAmB,EAAE,eAAe,CAAC,mBAAmB;gBACxD,WAAW,EAAE,eAAe,CAAC,WAAW;gBACxC,yBAAyB,EAAE,eAAe,CAAC,yBAAyB;gBACpE,WAAW,EAAE,eAAe,CAAC,WAAW;gBACxC,eAAe,EAAE,eAAe,CAAC,eAAe;gBAChD,eAAe,EAAE,eAAe,CAAC,eAAe;gBAChD,QAAQ,EAAE,eAAe,CAAC,QAAQ;aACnC,CAAC;YAEF,MAAM,uBAAuB,GAAG,MAAM,CAAC,eAAe,CAAC;YAEvD,QAAQ,CAAC,MAAM,CAAC,CAAC;YAEjB,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;YAEvC,IACE,CAAC,MAAM,CAAC,WAAW;gBACnB,MAAM,CAAC,eAAe,KAAK,uBAAuB,EAClD,CAAC;gBACD,eAAe,CAAC,YAAY,GAAG,SAAS,CAAC;YAC3C,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,kBAAkB,CAAC,OAAkC;QACnD,kBAAkB,CAAC,OAAO,EAAE;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,qBAAqB,EAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CAAC,OAAiC;QACjD,iBAAiB,CAAC,OAAO,EAAE;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,qBAAqB,EAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,GAAG,IAAkD;QAErD,OAAO,IAAI,CAAC,yBAAyB,CAAC,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;OASG;IACH,aAAa,CACX,GAAG,IAAuC;QAE1C,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,sBAAsB,CACpB,GAAG,IAAgD;QAEnD,OAAO,CACL,IAAI,CAAC,uBAAuB,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAC1E,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,WAAW,CAAC,WAA4B;QACtC,OAAO,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,GAAG,IAAgE;QAEnE,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;OAMG;IACH,kCAAkC,CAChC,GAAG,IAAiE;QAEpE,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,CAAC;IACrE,CAAC;IAED,kBAAkB;QAChB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,sBAAsB,CAAC,aAAqB;QAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sBAAsB,CACpB,aAAqB,EACrB,EAAqD;QAErD,IAAI,kBAAkB,GAAG,KAAK,CAAC;QAE/B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;YAClC,IAAI,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;YAC7C,MAAM,oBAAoB,GAAG,OAAO,EAAE,YAAY,CAAC;YACnD,MAAM,cAAc,GAAG,OAAO,EAAE,MAAM,CAAC;YACvC,MAAM,mBAAmB,GAAG,OAAO,EAAE,WAAW,CAAC;YACjD,MAAM,mBAAmB,GAAG,OAAO,EAAE,WAAW,CAAC;YACjD,MAAM,uBAAuB,GAAG,OAAO,EAAE,eAAe,CAAC;YACzD,MAAM,yBAAyB,GAAG,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC;YACnE,MAAM,2BAA2B,GAC/B,OAAO,EAAE,WAAW,EAAE,uBAAuB,CAAC;YAEhD,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,eAAe,CAAC,aAAa,CAAC,GAAG;oBAC/B,WAAW,EAAE,EAAE;oBACf,SAAS,EAAE,KAAK;oBAChB,MAAM,EAAE,EAAE;iBACX,CAAC;gBAEF,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;YAC3C,CAAC;YAED,EAAE,CAAC,OAAO,CAAC,CAAC;YAEZ,MAAM,qBAAqB,GACzB,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE;gBAC1C,oBAAoB,EAAE,OAAO,EAAE,WAAW,EAAE;gBAC9C,OAAO,CAAC,YAAY,EAAE,OAAO,KAAK,oBAAoB,EAAE,OAAO,CAAC;YAElE,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,KAAK,cAAc,CAAC;YAC1D,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,KAAK,mBAAmB,CAAC;YACnE,MAAM,kBAAkB,GAAG,OAAO,CAAC,WAAW,KAAK,mBAAmB,CAAC;YACvE,MAAM,wBAAwB,GAC5B,OAAO,CAAC,eAAe,KAAK,uBAAuB,CAAC;YACtD,MAAM,mBAAmB,GACvB,OAAO,CAAC,WAAW,EAAE,UAAU,KAAK,yBAAyB,CAAC;YAChE,MAAM,0BAA0B,GAC9B,OAAO,CAAC,WAAW,EAAE,uBAAuB;gBAC5C,2BAA2B,CAAC;YAE9B,IACE,qBAAqB;gBACrB,cAAc;gBACd,eAAe;gBACf,kBAAkB;gBAClB,wBAAwB,EACxB,CAAC;gBACD,mBAAmB,CACjB,aAAa,EACb,OAAgB,EAChB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,WAAW,CACjB,CAAC;gBAEF,kBAAkB,GAAG,IAAI,CAAC;YAC5B,CAAC;YAED,IAAI,mBAAmB,IAAI,0BAA0B,EAAE,CAAC;gBACtD,kBAAkB,GAAG,IAAI,CAAC;YAC5B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,kBAAkB,EAAE,CAAC;YACvB,YAAY,CAAC;gBACX,aAAa,EAAE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC;gBACzD,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC;gBAC1D,aAAa;gBACb,qBAAqB,EAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC;aAC9D,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IAED,0BAA0B,CACxB,WAA4B;QAE5B,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEnE,MAAM,kBAAkB,GACtB,IAAI,CAAC,cAAc,EAAE,CAAC,WAAW,CAAC;YAClC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAE9D,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAC/C,CAAC,QAAQ,EAAsC,EAAE,CAC/C,wBAAwB,CAAC,QAAQ,CAAC,CACrC,CAAC;QAEF,IAAI,eAAe,CAAC,MAAM,EAAE,CAAC;YAC3B,OAAO,eAAe,CAAC;QACzB,CAAC;QAED,MAAM,YAAY,GAAG,eAAe,EAAE,YAAY,CAAC;QAEnD,OAAO,gBAAgB,CACrB,IAAI,CAAC,SAAS,EACd,YAAY,EAAE,OAAO,EACrB,YAAY,EAAE,OAAO,EACrB,WAAW,CAAC,IAAI,EAChB,eAAe,EAAE,WAAW,EAAE,uBAAuB,CACtD,CAAC;IACJ,CAAC;CACF","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-es';\n\nimport { updateFiatPayment } from './actions/update-fiat-payment.js';\nimport { updatePaymentToken } from './actions/update-payment-token.js';\nimport {\n  CONTROLLER_NAME,\n  isTransactionPayStrategy,\n  TransactionPayStrategy,\n} from './constants.js';\nimport { QuoteRefresher } from './helpers/QuoteRefresher.js';\nimport type {\n  GetAmountDataCallback,\n  GetBalanceCallback,\n  GetDelegationTransactionCallback,\n  GetPaymentOverrideDataCallback,\n  PolymarketCallbacks,\n  TransactionConfig,\n  TransactionConfigCallback,\n  TransactionData,\n  TransactionPayControllerMessenger,\n  TransactionPayFiatOptions,\n  TransactionPayControllerOptions,\n  TransactionPayControllerState,\n  UpdateFiatPaymentRequest,\n  UpdatePaymentTokenRequest,\n} from './types.js';\nimport { getStrategyOrder } from './utils/feature-flags.js';\nimport { updateQuotes } from './utils/quotes.js';\nimport { updateSourceAmounts } from './utils/source-amounts.js';\nimport {\n  subscribeAssetChanges,\n  subscribeTransactionChanges,\n} from './utils/transaction.js';\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'getAmountData',\n  'getDelegationTransaction',\n  'getFiatOptions',\n  'getPaymentOverrideData',\n  'getStrategy',\n  'polymarketGetDepositWalletAddress',\n  'polymarketSubmitDepositWalletBatch',\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 #fiatOptions?: TransactionPayFiatOptions;\n\n  readonly #getAmountData?: GetAmountDataCallback;\n\n  readonly #getBalance?: GetBalanceCallback;\n\n  readonly #getDelegationTransaction: GetDelegationTransactionCallback;\n\n  readonly #getPaymentOverrideData?: GetPaymentOverrideDataCallback;\n\n  readonly #getStrategy?: (\n    transaction: TransactionMeta,\n  ) => TransactionPayStrategy;\n\n  readonly #getStrategies?: (\n    transaction: TransactionMeta,\n  ) => TransactionPayStrategy[];\n\n  readonly #polymarket?: PolymarketCallbacks;\n\n  constructor({\n    fiatOptions,\n    getAmountData,\n    getBalance,\n    getDelegationTransaction,\n    getPaymentOverrideData,\n    getStrategy,\n    getStrategies,\n    messenger,\n    polymarket,\n    state,\n  }: TransactionPayControllerOptions) {\n    super({\n      name: CONTROLLER_NAME,\n      metadata: stateMetadata,\n      messenger,\n      state: { ...getDefaultState(), ...state },\n    });\n\n    this.#fiatOptions = fiatOptions;\n    this.#getAmountData = getAmountData;\n    this.#getBalance = getBalance;\n    this.#getDelegationTransaction = getDelegationTransaction;\n    this.#getPaymentOverrideData = getPaymentOverrideData;\n    this.#getStrategy = getStrategy;\n    this.#getStrategies = getStrategies;\n    this.#polymarket = polymarket;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    subscribeTransactionChanges(\n      messenger,\n      this.#updateTransactionData.bind(this),\n      this.#removeTransactionData.bind(this),\n    );\n\n    subscribeAssetChanges(\n      messenger,\n      () => this.state,\n      this.#updateTransactionData.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: TransactionConfig = {\n        accountOverride: transactionData.accountOverride,\n        atomic: transactionData.atomic,\n        isHyperliquidSource: transactionData.isHyperliquidSource,\n        isMaxAmount: transactionData.isMaxAmount,\n        isPolymarketDepositWallet: transactionData.isPolymarketDepositWallet,\n        isPostQuote: transactionData.isPostQuote,\n        isQuoteRequired: transactionData.isQuoteRequired,\n        paymentOverride: transactionData.paymentOverride,\n        refundTo: transactionData.refundTo,\n      };\n\n      const previousAccountOverride = config.accountOverride;\n\n      callback(config);\n\n      Object.assign(transactionData, config);\n\n      if (\n        !config.isPostQuote &&\n        config.accountOverride !== previousAccountOverride\n      ) {\n        transactionData.paymentToken = undefined;\n      }\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   * Returns additional transactions for the paymentOverride flow.\n   *\n   * Delegates to the client-supplied {@link GetPaymentOverrideDataCallback}.\n   * Called during quote execution when `paymentOverride` is defined on the transaction.\n   * Returns an empty array when no callback is configured.\n   *\n   * @param args - The arguments forwarded to the {@link GetPaymentOverrideDataCallback}.\n   * @returns A promise resolving to the additional transactions array.\n   */\n  getAmountData(\n    ...args: Parameters<GetAmountDataCallback>\n  ): ReturnType<GetAmountDataCallback> {\n    return this.#getAmountData?.(...args) ?? Promise.resolve({ updates: [] });\n  }\n\n  /**\n   * Returns optional fiat execution configuration.\n   *\n   * This is intentionally not stored in controller state.\n   *\n   * @returns Fiat execution options, if configured.\n   */\n  getFiatOptions(): TransactionPayFiatOptions | undefined {\n    return this.#fiatOptions;\n  }\n\n  getPaymentOverrideData(\n    ...args: Parameters<GetPaymentOverrideDataCallback>\n  ): ReturnType<GetPaymentOverrideDataCallback> {\n    return (\n      this.#getPaymentOverrideData?.(...args) ?? Promise.resolve({ calls: [] })\n    );\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  /**\n   * Derives the Polymarket deposit-wallet address for an EOA via the\n   * client-supplied callback.\n   *\n   * @param args - The arguments forwarded to {@link PolymarketCallbacks.getDepositWalletAddress}.\n   * @returns A promise resolving to the deposit-wallet address.\n   */\n  polymarketGetDepositWalletAddress(\n    ...args: Parameters<PolymarketCallbacks['getDepositWalletAddress']>\n  ): ReturnType<PolymarketCallbacks['getDepositWalletAddress']> {\n    return this.#requirePolymarket().getDepositWalletAddress(...args);\n  }\n\n  /**\n   * Signs and broadcasts a Polymarket deposit-wallet batch via the\n   * client-supplied callback.\n   *\n   * @param args - The arguments forwarded to {@link PolymarketCallbacks.submitDepositWalletBatch}.\n   * @returns A promise resolving to the relayer-issued source hash.\n   */\n  polymarketSubmitDepositWalletBatch(\n    ...args: Parameters<PolymarketCallbacks['submitDepositWalletBatch']>\n  ): ReturnType<PolymarketCallbacks['submitDepositWalletBatch']> {\n    return this.#requirePolymarket().submitDepositWalletBatch(...args);\n  }\n\n  #requirePolymarket(): PolymarketCallbacks {\n    if (!this.#polymarket) {\n      throw new Error('TransactionPayController: Polymarket callbacks missing');\n    }\n    return this.#polymarket;\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      const originalAccountOverride = current?.accountOverride;\n      const originalFiatPaymentAmount = current?.fiatPayment?.amountFiat;\n      const originalFiatPaymentMethodId =\n        current?.fiatPayment?.selectedPaymentMethodId;\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      const isAccountOverrideUpdated =\n        current.accountOverride !== originalAccountOverride;\n      const isFiatAmountUpdated =\n        current.fiatPayment?.amountFiat !== originalFiatPaymentAmount;\n      const isFiatPaymentMethodUpdated =\n        current.fiatPayment?.selectedPaymentMethodId !==\n        originalFiatPaymentMethodId;\n\n      if (\n        isPaymentTokenUpdated ||\n        isIsMaxUpdated ||\n        isTokensUpdated ||\n        isPostQuoteUpdated ||\n        isAccountOverrideUpdated\n      ) {\n        updateSourceAmounts(\n          transactionId,\n          current as never,\n          this.messenger,\n          this.#getBalance,\n        );\n\n        shouldUpdateQuotes = true;\n      }\n\n      if (isFiatAmountUpdated || isFiatPaymentMethodUpdated) {\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 transactionData = this.state.transactionData[transaction.id];\n\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    if (validStrategies.length) {\n      return validStrategies;\n    }\n\n    const paymentToken = transactionData?.paymentToken;\n\n    return getStrategyOrder(\n      this.messenger,\n      paymentToken?.chainId,\n      paymentToken?.address,\n      transaction.type,\n      transactionData?.fiatPayment?.selectedPaymentMethodId,\n    );\n  }\n}\n"]}

package/dist/actions/update-fiat-payment.d.ts

@@ -0,0 +1,14 @@
+import type { TransactionPayControllerMessenger } from '../index.js';
+import type { UpdateFiatPaymentRequest, UpdateTransactionDataCallback } from '../types.js';
+export type UpdateFiatPaymentOptions = {
+    messenger: TransactionPayControllerMessenger;
+    updateTransactionData: UpdateTransactionDataCallback;
+};
+/**
+ * Update fiat payment state for a specific transaction.
+ *
+ * @param request - Request parameters.
+ * @param options - Options bag.
+ */
+export declare function updateFiatPayment(request: UpdateFiatPaymentRequest, options: UpdateFiatPaymentOptions): void;
+//# sourceMappingURL=update-fiat-payment.d.ts.map