@metamask/transaction-pay-controller 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0]
+
+### Added
+
+- Initial release ([#6820](https://github.com/MetaMask/core/pull/6820))
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-pay-controller@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/transaction-pay-controller@1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,19 @@
+# `@metamask/transaction-pay-controller`
+
+Manages alternate payment strategies to provide required funds for transactions in MetaMask.
+
+## Installation
+
+`yarn add @metamask/transaction-pay-controller`
+
+or
+
+`npm install @metamask/transaction-pay-controller`
+
+## Compatibility
+
+This package relies implicitly upon the `EventEmitter` module. This module is available natively in Node.js, but when using this package for the browser, make sure to use a polyfill such as `events`.
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/TransactionPayController.cjs

@@ -0,0 +1,96 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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_getStrategy, _TransactionPayController_removeTransactionData, _TransactionPayController_updateTransactionData, _TransactionPayController_registerActionHandlers;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionPayController = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const lodash_1 = require("lodash");
+const update_payment_token_1 = require("./actions/update-payment-token.cjs");
+const constants_1 = require("./constants.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 stateMetadata = {
+    transactionData: {
+        includeInDebugSnapshot: false,
+        includeInStateLogs: true,
+        persist: false,
+        usedInUi: true,
+    },
+};
+const getDefaultState = () => ({
+    transactionData: {},
+});
+class TransactionPayController extends base_controller_1.BaseController {
+    constructor({ getStrategy, messenger, state, }) {
+        super({
+            name: constants_1.CONTROLLER_NAME,
+            metadata: stateMetadata,
+            messenger,
+            state: { ...getDefaultState(), ...state },
+        });
+        _TransactionPayController_instances.add(this);
+        _TransactionPayController_getStrategy.set(this, void 0);
+        __classPrivateFieldSet(this, _TransactionPayController_getStrategy, getStrategy, "f");
+        __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_registerActionHandlers).call(this);
+        (0, transaction_1.pollTransactionChanges)(messenger, __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this), __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_removeTransactionData).bind(this));
+        (0, quotes_1.queueRefreshQuotes)(messenger, __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this));
+    }
+    updatePaymentToken(request) {
+        (0, update_payment_token_1.updatePaymentToken)(request, {
+            messenger: this.messenger,
+            updateTransactionData: __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this),
+        });
+    }
+}
+exports.TransactionPayController = TransactionPayController;
+_TransactionPayController_getStrategy = new WeakMap(), _TransactionPayController_instances = new WeakSet(), _TransactionPayController_removeTransactionData = function _TransactionPayController_removeTransactionData(transactionId) {
+    this.update((state) => {
+        delete state.transactionData[transactionId];
+    });
+}, _TransactionPayController_updateTransactionData = function _TransactionPayController_updateTransactionData(transactionId, fn) {
+    let shouldUpdateQuotes = false;
+    this.update((state) => {
+        const { transactionData } = state;
+        let current = transactionData[transactionId];
+        const originalPaymentToken = current?.paymentToken;
+        const originalTokens = current?.tokens;
+        if (!current) {
+            transactionData[transactionId] = {
+                isLoading: false,
+                tokens: [],
+            };
+            current = transactionData[transactionId];
+        }
+        fn(current);
+        const isPaymentTokenUpdated = current.paymentToken !== originalPaymentToken;
+        const isTokensUpdated = current.tokens !== originalTokens;
+        if (isPaymentTokenUpdated || isTokensUpdated) {
+            (0, source_amounts_1.updateSourceAmounts)(transactionId, current, this.messenger);
+            shouldUpdateQuotes = true;
+            current.isLoading = true;
+        }
+    });
+    if (shouldUpdateQuotes) {
+        (0, quotes_1.updateQuotes)({
+            messenger: this.messenger,
+            transactionData: this.state.transactionData[transactionId],
+            transactionId,
+            updateTransactionData: __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this),
+        }).catch(lodash_1.noop);
+    }
+}, _TransactionPayController_registerActionHandlers = function _TransactionPayController_registerActionHandlers() {
+    this.messenger.registerActionHandler('TransactionPayController:getStrategy', __classPrivateFieldGet(this, _TransactionPayController_getStrategy, "f") ?? (async () => constants_1.TransactionPayStrategy.Relay));
+    this.messenger.registerActionHandler('TransactionPayController:updatePaymentToken', this.updatePaymentToken.bind(this));
+};
+//# sourceMappingURL=TransactionPayController.cjs.map

package/dist/TransactionPayController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController.cjs","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,+DAA2D;AAG3D,mCAA8B;AAE9B,6EAAoE;AACpE,+CAAsE;AAQtE,+CAAkE;AAClE,+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,GAAG,EAAE,CAAC,CAAC;IAC7B,eAAe,EAAE,EAAE;CACpB,CAAC,CAAC;AAEH,MAAa,wBAAyB,SAAQ,gCAI7C;IAKC,YAAY,EACV,WAAW,EACX,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;;QAdI,wDAE4B;QAcnC,uBAAA,IAAI,yCAAgB,WAAW,MAAA,CAAC;QAEhC,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,IAAA,2BAAkB,EAAC,SAAS,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,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;CAiEF;AAxGD,4DAwGC;uNA/DwB,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;QAEvC,IAAI,CAAC,OAAO,EAAE;YACZ,eAAe,CAAC,aAAa,CAAC,GAAG;gBAC/B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,EAAE;aACX,CAAC;YAEF,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;SAC1C;QAED,EAAE,CAAC,OAAO,CAAC,CAAC;QAEZ,MAAM,qBAAqB,GACzB,OAAO,CAAC,YAAY,KAAK,oBAAoB,CAAC;QAEhD,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,KAAK,cAAc,CAAC;QAE1D,IAAI,qBAAqB,IAAI,eAAe,EAAE;YAC5C,IAAA,oCAAmB,EAAC,aAAa,EAAE,OAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAErE,kBAAkB,GAAG,IAAI,CAAC;YAC1B,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;SAC1B;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,kBAAkB,EAAE;QACtB,IAAA,qBAAY,EAAC;YACX,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;KAChB;AACH,CAAC;IAGC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,sCAAsC,EACtC,uBAAA,IAAI,6CAAa,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,kCAAsB,CAAC,KAAK,CAAC,CAChE,CAAC;IAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,6CAA6C,EAC7C,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CACnC,CAAC;AACJ,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 { updatePaymentToken } from './actions/update-payment-token';\nimport { CONTROLLER_NAME, TransactionPayStrategy } from './constants';\nimport type {\n  TransactionData,\n  TransactionPayControllerMessenger,\n  TransactionPayControllerOptions,\n  TransactionPayControllerState,\n  UpdatePaymentTokenRequest,\n} from './types';\nimport { queueRefreshQuotes, 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 = () => ({\n  transactionData: {},\n});\n\nexport class TransactionPayController extends BaseController<\n  typeof CONTROLLER_NAME,\n  TransactionPayControllerState,\n  TransactionPayControllerMessenger\n> {\n  readonly #getStrategy?: (\n    transaction: TransactionMeta,\n  ) => Promise<TransactionPayStrategy>;\n\n  constructor({\n    getStrategy,\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.#getStrategy = getStrategy;\n\n    this.#registerActionHandlers();\n\n    pollTransactionChanges(\n      messenger,\n      this.#updateTransactionData.bind(this),\n      this.#removeTransactionData.bind(this),\n    );\n\n    queueRefreshQuotes(messenger, this.#updateTransactionData.bind(this));\n  }\n\n  updatePaymentToken(request: UpdatePaymentTokenRequest) {\n    updatePaymentToken(request, {\n      messenger: this.messenger,\n      updateTransactionData: this.#updateTransactionData.bind(this),\n    });\n  }\n\n  #removeTransactionData(transactionId: string) {\n    this.update((state) => {\n      delete state.transactionData[transactionId];\n    });\n  }\n\n  #updateTransactionData(\n    transactionId: string,\n    fn: (transactionData: Draft<TransactionData>) => void,\n  ) {\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\n      if (!current) {\n        transactionData[transactionId] = {\n          isLoading: false,\n          tokens: [],\n        };\n\n        current = transactionData[transactionId];\n      }\n\n      fn(current);\n\n      const isPaymentTokenUpdated =\n        current.paymentToken !== originalPaymentToken;\n\n      const isTokensUpdated = current.tokens !== originalTokens;\n\n      if (isPaymentTokenUpdated || isTokensUpdated) {\n        updateSourceAmounts(transactionId, current as never, this.messenger);\n\n        shouldUpdateQuotes = true;\n        current.isLoading = true;\n      }\n    });\n\n    if (shouldUpdateQuotes) {\n      updateQuotes({\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() {\n    this.messenger.registerActionHandler(\n      'TransactionPayController:getStrategy',\n      this.#getStrategy ?? (async () => TransactionPayStrategy.Relay),\n    );\n\n    this.messenger.registerActionHandler(\n      'TransactionPayController:updatePaymentToken',\n      this.updatePaymentToken.bind(this),\n    );\n  }\n}\n"]}

package/dist/TransactionPayController.d.cts

@@ -0,0 +1,9 @@
+import { BaseController } from "@metamask/base-controller";
+import { CONTROLLER_NAME } from "./constants.cjs";
+import type { TransactionPayControllerMessenger, TransactionPayControllerOptions, TransactionPayControllerState, UpdatePaymentTokenRequest } from "./types.cjs";
+export declare class TransactionPayController extends BaseController<typeof CONTROLLER_NAME, TransactionPayControllerState, TransactionPayControllerMessenger> {
+    #private;
+    constructor({ getStrategy, messenger, state, }: TransactionPayControllerOptions);
+    updatePaymentToken(request: UpdatePaymentTokenRequest): void;
+}
+//# sourceMappingURL=TransactionPayController.d.cts.map

package/dist/TransactionPayController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController.d.cts","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAM3D,OAAO,EAAE,eAAe,EAA0B,wBAAoB;AACtE,OAAO,KAAK,EAEV,iCAAiC,EACjC,+BAA+B,EAC/B,6BAA6B,EAC7B,yBAAyB,EAC1B,oBAAgB;AAkBjB,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,eAAe,EACtB,6BAA6B,EAC7B,iCAAiC,CAClC;;gBAKa,EACV,WAAW,EACX,SAAS,EACT,KAAK,GACN,EAAE,+BAA+B;IAqBlC,kBAAkB,CAAC,OAAO,EAAE,yBAAyB;CAsEtD"}

package/dist/TransactionPayController.d.mts

@@ -0,0 +1,9 @@
+import { BaseController } from "@metamask/base-controller";
+import { CONTROLLER_NAME } from "./constants.mjs";
+import type { TransactionPayControllerMessenger, TransactionPayControllerOptions, TransactionPayControllerState, UpdatePaymentTokenRequest } from "./types.mjs";
+export declare class TransactionPayController extends BaseController<typeof CONTROLLER_NAME, TransactionPayControllerState, TransactionPayControllerMessenger> {
+    #private;
+    constructor({ getStrategy, messenger, state, }: TransactionPayControllerOptions);
+    updatePaymentToken(request: UpdatePaymentTokenRequest): void;
+}
+//# sourceMappingURL=TransactionPayController.d.mts.map

package/dist/TransactionPayController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController.d.mts","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAM3D,OAAO,EAAE,eAAe,EAA0B,wBAAoB;AACtE,OAAO,KAAK,EAEV,iCAAiC,EACjC,+BAA+B,EAC/B,6BAA6B,EAC7B,yBAAyB,EAC1B,oBAAgB;AAkBjB,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,eAAe,EACtB,6BAA6B,EAC7B,iCAAiC,CAClC;;gBAKa,EACV,WAAW,EACX,SAAS,EACT,KAAK,GACN,EAAE,+BAA+B;IAqBlC,kBAAkB,CAAC,OAAO,EAAE,yBAAyB;CAsEtD"}

package/dist/TransactionPayController.mjs

@@ -0,0 +1,93 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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_getStrategy, _TransactionPayController_removeTransactionData, _TransactionPayController_updateTransactionData, _TransactionPayController_registerActionHandlers;
+import { BaseController } from "@metamask/base-controller";
+import $lodash from "lodash";
+const { noop } = $lodash;
+import { updatePaymentToken } from "./actions/update-payment-token.mjs";
+import { CONTROLLER_NAME, TransactionPayStrategy } from "./constants.mjs";
+import { queueRefreshQuotes, updateQuotes } from "./utils/quotes.mjs";
+import { updateSourceAmounts } from "./utils/source-amounts.mjs";
+import { pollTransactionChanges } from "./utils/transaction.mjs";
+const stateMetadata = {
+    transactionData: {
+        includeInDebugSnapshot: false,
+        includeInStateLogs: true,
+        persist: false,
+        usedInUi: true,
+    },
+};
+const getDefaultState = () => ({
+    transactionData: {},
+});
+export class TransactionPayController extends BaseController {
+    constructor({ getStrategy, messenger, state, }) {
+        super({
+            name: CONTROLLER_NAME,
+            metadata: stateMetadata,
+            messenger,
+            state: { ...getDefaultState(), ...state },
+        });
+        _TransactionPayController_instances.add(this);
+        _TransactionPayController_getStrategy.set(this, void 0);
+        __classPrivateFieldSet(this, _TransactionPayController_getStrategy, getStrategy, "f");
+        __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_registerActionHandlers).call(this);
+        pollTransactionChanges(messenger, __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this), __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_removeTransactionData).bind(this));
+        queueRefreshQuotes(messenger, __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this));
+    }
+    updatePaymentToken(request) {
+        updatePaymentToken(request, {
+            messenger: this.messenger,
+            updateTransactionData: __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this),
+        });
+    }
+}
+_TransactionPayController_getStrategy = new WeakMap(), _TransactionPayController_instances = new WeakSet(), _TransactionPayController_removeTransactionData = function _TransactionPayController_removeTransactionData(transactionId) {
+    this.update((state) => {
+        delete state.transactionData[transactionId];
+    });
+}, _TransactionPayController_updateTransactionData = function _TransactionPayController_updateTransactionData(transactionId, fn) {
+    let shouldUpdateQuotes = false;
+    this.update((state) => {
+        const { transactionData } = state;
+        let current = transactionData[transactionId];
+        const originalPaymentToken = current?.paymentToken;
+        const originalTokens = current?.tokens;
+        if (!current) {
+            transactionData[transactionId] = {
+                isLoading: false,
+                tokens: [],
+            };
+            current = transactionData[transactionId];
+        }
+        fn(current);
+        const isPaymentTokenUpdated = current.paymentToken !== originalPaymentToken;
+        const isTokensUpdated = current.tokens !== originalTokens;
+        if (isPaymentTokenUpdated || isTokensUpdated) {
+            updateSourceAmounts(transactionId, current, this.messenger);
+            shouldUpdateQuotes = true;
+            current.isLoading = true;
+        }
+    });
+    if (shouldUpdateQuotes) {
+        updateQuotes({
+            messenger: this.messenger,
+            transactionData: this.state.transactionData[transactionId],
+            transactionId,
+            updateTransactionData: __classPrivateFieldGet(this, _TransactionPayController_instances, "m", _TransactionPayController_updateTransactionData).bind(this),
+        }).catch(noop);
+    }
+}, _TransactionPayController_registerActionHandlers = function _TransactionPayController_registerActionHandlers() {
+    this.messenger.registerActionHandler('TransactionPayController:getStrategy', __classPrivateFieldGet(this, _TransactionPayController_getStrategy, "f") ?? (async () => TransactionPayStrategy.Relay));
+    this.messenger.registerActionHandler('TransactionPayController:updatePaymentToken', this.updatePaymentToken.bind(this));
+};
+//# sourceMappingURL=TransactionPayController.mjs.map

package/dist/TransactionPayController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionPayController.mjs","sourceRoot":"","sources":["../src/TransactionPayController.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;;;AAK3D,OAAO,EAAE,kBAAkB,EAAE,2CAAuC;AACpE,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,wBAAoB;AAQtE,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,2BAAuB;AAClE,OAAO,EAAE,mBAAmB,EAAE,mCAA+B;AAC7D,OAAO,EAAE,sBAAsB,EAAE,gCAA4B;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,GAAG,EAAE,CAAC,CAAC;IAC7B,eAAe,EAAE,EAAE;CACpB,CAAC,CAAC;AAEH,MAAM,OAAO,wBAAyB,SAAQ,cAI7C;IAKC,YAAY,EACV,WAAW,EACX,SAAS,EACT,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;;QAdI,wDAE4B;QAcnC,uBAAA,IAAI,yCAAgB,WAAW,MAAA,CAAC;QAEhC,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC;QAE/B,sBAAsB,CACpB,SAAS,EACT,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,EACtC,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;QAEF,kBAAkB,CAAC,SAAS,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IAED,kBAAkB,CAAC,OAAkC;QACnD,kBAAkB,CAAC,OAAO,EAAE;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,qBAAqB,EAAE,uBAAA,IAAI,4FAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC;CAiEF;uNA/DwB,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;QAEvC,IAAI,CAAC,OAAO,EAAE;YACZ,eAAe,CAAC,aAAa,CAAC,GAAG;gBAC/B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,EAAE;aACX,CAAC;YAEF,OAAO,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;SAC1C;QAED,EAAE,CAAC,OAAO,CAAC,CAAC;QAEZ,MAAM,qBAAqB,GACzB,OAAO,CAAC,YAAY,KAAK,oBAAoB,CAAC;QAEhD,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,KAAK,cAAc,CAAC;QAE1D,IAAI,qBAAqB,IAAI,eAAe,EAAE;YAC5C,mBAAmB,CAAC,aAAa,EAAE,OAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAErE,kBAAkB,GAAG,IAAI,CAAC;YAC1B,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;SAC1B;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,kBAAkB,EAAE;QACtB,YAAY,CAAC;YACX,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,IAAI,CAAC,CAAC;KAChB;AACH,CAAC;IAGC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,sCAAsC,EACtC,uBAAA,IAAI,6CAAa,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAChE,CAAC;IAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,6CAA6C,EAC7C,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CACnC,CAAC;AACJ,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 { updatePaymentToken } from './actions/update-payment-token';\nimport { CONTROLLER_NAME, TransactionPayStrategy } from './constants';\nimport type {\n  TransactionData,\n  TransactionPayControllerMessenger,\n  TransactionPayControllerOptions,\n  TransactionPayControllerState,\n  UpdatePaymentTokenRequest,\n} from './types';\nimport { queueRefreshQuotes, 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 = () => ({\n  transactionData: {},\n});\n\nexport class TransactionPayController extends BaseController<\n  typeof CONTROLLER_NAME,\n  TransactionPayControllerState,\n  TransactionPayControllerMessenger\n> {\n  readonly #getStrategy?: (\n    transaction: TransactionMeta,\n  ) => Promise<TransactionPayStrategy>;\n\n  constructor({\n    getStrategy,\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.#getStrategy = getStrategy;\n\n    this.#registerActionHandlers();\n\n    pollTransactionChanges(\n      messenger,\n      this.#updateTransactionData.bind(this),\n      this.#removeTransactionData.bind(this),\n    );\n\n    queueRefreshQuotes(messenger, this.#updateTransactionData.bind(this));\n  }\n\n  updatePaymentToken(request: UpdatePaymentTokenRequest) {\n    updatePaymentToken(request, {\n      messenger: this.messenger,\n      updateTransactionData: this.#updateTransactionData.bind(this),\n    });\n  }\n\n  #removeTransactionData(transactionId: string) {\n    this.update((state) => {\n      delete state.transactionData[transactionId];\n    });\n  }\n\n  #updateTransactionData(\n    transactionId: string,\n    fn: (transactionData: Draft<TransactionData>) => void,\n  ) {\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\n      if (!current) {\n        transactionData[transactionId] = {\n          isLoading: false,\n          tokens: [],\n        };\n\n        current = transactionData[transactionId];\n      }\n\n      fn(current);\n\n      const isPaymentTokenUpdated =\n        current.paymentToken !== originalPaymentToken;\n\n      const isTokensUpdated = current.tokens !== originalTokens;\n\n      if (isPaymentTokenUpdated || isTokensUpdated) {\n        updateSourceAmounts(transactionId, current as never, this.messenger);\n\n        shouldUpdateQuotes = true;\n        current.isLoading = true;\n      }\n    });\n\n    if (shouldUpdateQuotes) {\n      updateQuotes({\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() {\n    this.messenger.registerActionHandler(\n      'TransactionPayController:getStrategy',\n      this.#getStrategy ?? (async () => TransactionPayStrategy.Relay),\n    );\n\n    this.messenger.registerActionHandler(\n      'TransactionPayController:updatePaymentToken',\n      this.updatePaymentToken.bind(this),\n    );\n  }\n}\n"]}

package/dist/actions/update-payment-token.cjs

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updatePaymentToken = void 0;
+const utils_1 = require("@metamask/utils");
+const bignumber_js_1 = require("bignumber.js");
+const logger_1 = require("../logger.cjs");
+const token_1 = require("../utils/token.cjs");
+const transaction_1 = require("../utils/transaction.cjs");
+const log = (0, utils_1.createModuleLogger)(logger_1.projectLogger, 'update-payment-token');
+/**
+ * Update the payment token for a specific transaction.
+ *
+ * @param request  - Request parameters.
+ * @param options - Options bag.
+ */
+function updatePaymentToken(request, options) {
+    const { transactionId, tokenAddress, chainId } = request;
+    const { messenger, updateTransactionData } = options;
+    const transaction = (0, transaction_1.getTransaction)(transactionId, messenger);
+    if (!transaction) {
+        throw new Error('Transaction not found');
+    }
+    const paymentToken = getPaymentToken({
+        chainId,
+        from: transaction?.txParams.from,
+        messenger,
+        tokenAddress,
+    });
+    if (!paymentToken) {
+        throw new Error('Payment token not found');
+    }
+    log('Updated payment token', { transactionId, paymentToken });
+    updateTransactionData(transactionId, (data) => {
+        data.paymentToken = paymentToken;
+    });
+}
+exports.updatePaymentToken = updatePaymentToken;
+/**
+ * Generate the full payment token data from a token address and chain ID.
+ *
+ * @param request - The payment token request parameters.
+ * @param request.chainId - The chain ID.
+ * @param request.from - The address to get the token balance for.
+ * @param request.messenger - The transaction pay controller messenger.
+ * @param request.tokenAddress - The token address.
+ * @returns The payment token or undefined if the token data could not be retrieved.
+ */
+function getPaymentToken({ chainId, from, messenger, tokenAddress, }) {
+    const { decimals, symbol } = (0, token_1.getTokenInfo)(messenger, tokenAddress, chainId) ?? {};
+    if (decimals === undefined || !symbol) {
+        return undefined;
+    }
+    const tokenFiatRate = (0, token_1.getTokenFiatRate)(messenger, tokenAddress, chainId);
+    if (tokenFiatRate === undefined) {
+        return undefined;
+    }
+    const balance = (0, token_1.getTokenBalance)(messenger, from, chainId, tokenAddress);
+    const balanceRawValue = new bignumber_js_1.BigNumber(balance);
+    const balanceHumanValue = new bignumber_js_1.BigNumber(balance).shiftedBy(-decimals);
+    const balanceRaw = balanceRawValue.toFixed(0);
+    const balanceHuman = balanceHumanValue.toString(10);
+    const balanceFiat = balanceHumanValue
+        .multipliedBy(tokenFiatRate.fiatRate)
+        .toString(10);
+    const balanceUsd = balanceHumanValue
+        .multipliedBy(tokenFiatRate.usdRate)
+        .toString(10);
+    return {
+        address: tokenAddress,
+        balanceFiat,
+        balanceHuman,
+        balanceRaw,
+        balanceUsd,
+        chainId,
+        decimals,
+        symbol,
+    };
+}
+//# sourceMappingURL=update-payment-token.cjs.map

package/dist/actions/update-payment-token.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-payment-token.cjs","sourceRoot":"","sources":["../../src/actions/update-payment-token.ts"],"names":[],"mappings":";;;AAAA,2CAA+D;AAC/D,+CAAyC;AAGzC,0CAA0C;AAM1C,8CAIwB;AACxB,0DAAsD;AAEtD,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,sBAAa,EAAE,sBAAsB,CAAC,CAAC;AAOtE;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,OAAkC,EAClC,OAAkC;IAElC,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IACzD,MAAM,EAAE,SAAS,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAC;IAErD,MAAM,WAAW,GAAG,IAAA,4BAAc,EAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAE7D,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IAED,MAAM,YAAY,GAAG,eAAe,CAAC;QACnC,OAAO;QACP,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,IAAW;QACvC,SAAS;QACT,YAAY;KACb,CAAC,CAAC;IAEH,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,GAAG,CAAC,uBAAuB,EAAE,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,CAAC;IAE9D,qBAAqB,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;QAC5C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC;AA7BD,gDA6BC;AAED;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,EACvB,OAAO,EACP,IAAI,EACJ,SAAS,EACT,YAAY,GAMb;IACC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GACxB,IAAA,oBAAY,EAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IAEvD,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,MAAM,EAAE;QACrC,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,aAAa,GAAG,IAAA,wBAAgB,EAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAEzE,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,OAAO,GAAG,IAAA,uBAAe,EAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IACxE,MAAM,eAAe,GAAG,IAAI,wBAAS,CAAC,OAAO,CAAC,CAAC;IAC/C,MAAM,iBAAiB,GAAG,IAAI,wBAAS,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;IACtE,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,YAAY,GAAG,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEpD,MAAM,WAAW,GAAG,iBAAiB;SAClC,YAAY,CAAC,aAAa,CAAC,QAAQ,CAAC;SACpC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEhB,MAAM,UAAU,GAAG,iBAAiB;SACjC,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC;SACnC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEhB,OAAO;QACL,OAAO,EAAE,YAAY;QACrB,WAAW;QACX,YAAY;QACZ,UAAU;QACV,UAAU;QACV,OAAO;QACP,QAAQ;QACR,MAAM;KACP,CAAC;AACJ,CAAC","sourcesContent":["import { createModuleLogger, type Hex } from '@metamask/utils';\nimport { BigNumber } from 'bignumber.js';\n\nimport type { TransactionPayControllerMessenger } from '..';\nimport { projectLogger } from '../logger';\nimport type {\n  TransactionPaymentToken,\n  UpdatePaymentTokenRequest,\n  UpdateTransactionDataCallback,\n} from '../types';\nimport {\n  getTokenBalance,\n  getTokenFiatRate,\n  getTokenInfo,\n} from '../utils/token';\nimport { getTransaction } from '../utils/transaction';\n\nconst log = createModuleLogger(projectLogger, 'update-payment-token');\n\nexport type UpdatePaymentTokenOptions = {\n  messenger: TransactionPayControllerMessenger;\n  updateTransactionData: UpdateTransactionDataCallback;\n};\n\n/**\n * Update the payment token for a specific transaction.\n *\n * @param request  - Request parameters.\n * @param options - Options bag.\n */\nexport function updatePaymentToken(\n  request: UpdatePaymentTokenRequest,\n  options: UpdatePaymentTokenOptions,\n) {\n  const { transactionId, tokenAddress, chainId } = request;\n  const { messenger, updateTransactionData } = options;\n\n  const transaction = getTransaction(transactionId, messenger);\n\n  if (!transaction) {\n    throw new Error('Transaction not found');\n  }\n\n  const paymentToken = getPaymentToken({\n    chainId,\n    from: transaction?.txParams.from as Hex,\n    messenger,\n    tokenAddress,\n  });\n\n  if (!paymentToken) {\n    throw new Error('Payment token not found');\n  }\n\n  log('Updated payment token', { transactionId, paymentToken });\n\n  updateTransactionData(transactionId, (data) => {\n    data.paymentToken = paymentToken;\n  });\n}\n\n/**\n * Generate the full payment token data from a token address and chain ID.\n *\n * @param request - The payment token request parameters.\n * @param request.chainId - The chain ID.\n * @param request.from - The address to get the token balance for.\n * @param request.messenger - The transaction pay controller messenger.\n * @param request.tokenAddress - The token address.\n * @returns The payment token or undefined if the token data could not be retrieved.\n */\nfunction getPaymentToken({\n  chainId,\n  from,\n  messenger,\n  tokenAddress,\n}: {\n  chainId: Hex;\n  from: Hex;\n  messenger: TransactionPayControllerMessenger;\n  tokenAddress: Hex;\n}): TransactionPaymentToken | undefined {\n  const { decimals, symbol } =\n    getTokenInfo(messenger, tokenAddress, chainId) ?? {};\n\n  if (decimals === undefined || !symbol) {\n    return undefined;\n  }\n\n  const tokenFiatRate = getTokenFiatRate(messenger, tokenAddress, chainId);\n\n  if (tokenFiatRate === undefined) {\n    return undefined;\n  }\n\n  const balance = getTokenBalance(messenger, from, chainId, tokenAddress);\n  const balanceRawValue = new BigNumber(balance);\n  const balanceHumanValue = new BigNumber(balance).shiftedBy(-decimals);\n  const balanceRaw = balanceRawValue.toFixed(0);\n  const balanceHuman = balanceHumanValue.toString(10);\n\n  const balanceFiat = balanceHumanValue\n    .multipliedBy(tokenFiatRate.fiatRate)\n    .toString(10);\n\n  const balanceUsd = balanceHumanValue\n    .multipliedBy(tokenFiatRate.usdRate)\n    .toString(10);\n\n  return {\n    address: tokenAddress,\n    balanceFiat,\n    balanceHuman,\n    balanceRaw,\n    balanceUsd,\n    chainId,\n    decimals,\n    symbol,\n  };\n}\n"]}

package/dist/actions/update-payment-token.d.cts

@@ -0,0 +1,14 @@
+import type { TransactionPayControllerMessenger } from "../index.cjs";
+import type { UpdatePaymentTokenRequest, UpdateTransactionDataCallback } from "../types.cjs";
+export type UpdatePaymentTokenOptions = {
+    messenger: TransactionPayControllerMessenger;
+    updateTransactionData: UpdateTransactionDataCallback;
+};
+/**
+ * Update the payment token for a specific transaction.
+ *
+ * @param request  - Request parameters.
+ * @param options - Options bag.
+ */
+export declare function updatePaymentToken(request: UpdatePaymentTokenRequest, options: UpdatePaymentTokenOptions): void;
+//# sourceMappingURL=update-payment-token.d.cts.map

package/dist/actions/update-payment-token.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-payment-token.d.cts","sourceRoot":"","sources":["../../src/actions/update-payment-token.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iCAAiC,EAAE,qBAAW;AAE5D,OAAO,KAAK,EAEV,yBAAyB,EACzB,6BAA6B,EAC9B,qBAAiB;AAUlB,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,iCAAiC,CAAC;IAC7C,qBAAqB,EAAE,6BAA6B,CAAC;CACtD,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,yBAAyB,EAClC,OAAO,EAAE,yBAAyB,QA2BnC"}

package/dist/actions/update-payment-token.d.mts

@@ -0,0 +1,14 @@
+import type { TransactionPayControllerMessenger } from "../index.mjs";
+import type { UpdatePaymentTokenRequest, UpdateTransactionDataCallback } from "../types.mjs";
+export type UpdatePaymentTokenOptions = {
+    messenger: TransactionPayControllerMessenger;
+    updateTransactionData: UpdateTransactionDataCallback;
+};
+/**
+ * Update the payment token for a specific transaction.
+ *
+ * @param request  - Request parameters.
+ * @param options - Options bag.
+ */
+export declare function updatePaymentToken(request: UpdatePaymentTokenRequest, options: UpdatePaymentTokenOptions): void;
+//# sourceMappingURL=update-payment-token.d.mts.map

package/dist/actions/update-payment-token.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-payment-token.d.mts","sourceRoot":"","sources":["../../src/actions/update-payment-token.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iCAAiC,EAAE,qBAAW;AAE5D,OAAO,KAAK,EAEV,yBAAyB,EACzB,6BAA6B,EAC9B,qBAAiB;AAUlB,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,iCAAiC,CAAC;IAC7C,qBAAqB,EAAE,6BAA6B,CAAC;CACtD,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,yBAAyB,EAClC,OAAO,EAAE,yBAAyB,QA2BnC"}

package/dist/actions/update-payment-token.mjs

@@ -0,0 +1,75 @@
+import { createModuleLogger } from "@metamask/utils";
+import { BigNumber } from "bignumber.js";
+import { projectLogger } from "../logger.mjs";
+import { getTokenBalance, getTokenFiatRate, getTokenInfo } from "../utils/token.mjs";
+import { getTransaction } from "../utils/transaction.mjs";
+const log = createModuleLogger(projectLogger, 'update-payment-token');
+/**
+ * Update the payment token for a specific transaction.
+ *
+ * @param request  - Request parameters.
+ * @param options - Options bag.
+ */
+export function updatePaymentToken(request, options) {
+    const { transactionId, tokenAddress, chainId } = request;
+    const { messenger, updateTransactionData } = options;
+    const transaction = getTransaction(transactionId, messenger);
+    if (!transaction) {
+        throw new Error('Transaction not found');
+    }
+    const paymentToken = getPaymentToken({
+        chainId,
+        from: transaction?.txParams.from,
+        messenger,
+        tokenAddress,
+    });
+    if (!paymentToken) {
+        throw new Error('Payment token not found');
+    }
+    log('Updated payment token', { transactionId, paymentToken });
+    updateTransactionData(transactionId, (data) => {
+        data.paymentToken = paymentToken;
+    });
+}
+/**
+ * Generate the full payment token data from a token address and chain ID.
+ *
+ * @param request - The payment token request parameters.
+ * @param request.chainId - The chain ID.
+ * @param request.from - The address to get the token balance for.
+ * @param request.messenger - The transaction pay controller messenger.
+ * @param request.tokenAddress - The token address.
+ * @returns The payment token or undefined if the token data could not be retrieved.
+ */
+function getPaymentToken({ chainId, from, messenger, tokenAddress, }) {
+    const { decimals, symbol } = getTokenInfo(messenger, tokenAddress, chainId) ?? {};
+    if (decimals === undefined || !symbol) {
+        return undefined;
+    }
+    const tokenFiatRate = getTokenFiatRate(messenger, tokenAddress, chainId);
+    if (tokenFiatRate === undefined) {
+        return undefined;
+    }
+    const balance = getTokenBalance(messenger, from, chainId, tokenAddress);
+    const balanceRawValue = new BigNumber(balance);
+    const balanceHumanValue = new BigNumber(balance).shiftedBy(-decimals);
+    const balanceRaw = balanceRawValue.toFixed(0);
+    const balanceHuman = balanceHumanValue.toString(10);
+    const balanceFiat = balanceHumanValue
+        .multipliedBy(tokenFiatRate.fiatRate)
+        .toString(10);
+    const balanceUsd = balanceHumanValue
+        .multipliedBy(tokenFiatRate.usdRate)
+        .toString(10);
+    return {
+        address: tokenAddress,
+        balanceFiat,
+        balanceHuman,
+        balanceRaw,
+        balanceUsd,
+        chainId,
+        decimals,
+        symbol,
+    };
+}
+//# sourceMappingURL=update-payment-token.mjs.map

package/dist/actions/update-payment-token.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-payment-token.mjs","sourceRoot":"","sources":["../../src/actions/update-payment-token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAY,wBAAwB;AAC/D,OAAO,EAAE,SAAS,EAAE,qBAAqB;AAGzC,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAM1C,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,YAAY,EACb,2BAAuB;AACxB,OAAO,EAAE,cAAc,EAAE,iCAA6B;AAEtD,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,sBAAsB,CAAC,CAAC;AAOtE;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAkC,EAClC,OAAkC;IAElC,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IACzD,MAAM,EAAE,SAAS,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAC;IAErD,MAAM,WAAW,GAAG,cAAc,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAE7D,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IAED,MAAM,YAAY,GAAG,eAAe,CAAC;QACnC,OAAO;QACP,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,IAAW;QACvC,SAAS;QACT,YAAY;KACb,CAAC,CAAC;IAEH,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,GAAG,CAAC,uBAAuB,EAAE,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,CAAC;IAE9D,qBAAqB,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;QAC5C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,EACvB,OAAO,EACP,IAAI,EACJ,SAAS,EACT,YAAY,GAMb;IACC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GACxB,YAAY,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IAEvD,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,MAAM,EAAE;QACrC,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAEzE,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,OAAO,GAAG,eAAe,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IACxE,MAAM,eAAe,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/C,MAAM,iBAAiB,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;IACtE,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,YAAY,GAAG,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEpD,MAAM,WAAW,GAAG,iBAAiB;SAClC,YAAY,CAAC,aAAa,CAAC,QAAQ,CAAC;SACpC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEhB,MAAM,UAAU,GAAG,iBAAiB;SACjC,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC;SACnC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEhB,OAAO;QACL,OAAO,EAAE,YAAY;QACrB,WAAW;QACX,YAAY;QACZ,UAAU;QACV,UAAU;QACV,OAAO;QACP,QAAQ;QACR,MAAM;KACP,CAAC;AACJ,CAAC","sourcesContent":["import { createModuleLogger, type Hex } from '@metamask/utils';\nimport { BigNumber } from 'bignumber.js';\n\nimport type { TransactionPayControllerMessenger } from '..';\nimport { projectLogger } from '../logger';\nimport type {\n  TransactionPaymentToken,\n  UpdatePaymentTokenRequest,\n  UpdateTransactionDataCallback,\n} from '../types';\nimport {\n  getTokenBalance,\n  getTokenFiatRate,\n  getTokenInfo,\n} from '../utils/token';\nimport { getTransaction } from '../utils/transaction';\n\nconst log = createModuleLogger(projectLogger, 'update-payment-token');\n\nexport type UpdatePaymentTokenOptions = {\n  messenger: TransactionPayControllerMessenger;\n  updateTransactionData: UpdateTransactionDataCallback;\n};\n\n/**\n * Update the payment token for a specific transaction.\n *\n * @param request  - Request parameters.\n * @param options - Options bag.\n */\nexport function updatePaymentToken(\n  request: UpdatePaymentTokenRequest,\n  options: UpdatePaymentTokenOptions,\n) {\n  const { transactionId, tokenAddress, chainId } = request;\n  const { messenger, updateTransactionData } = options;\n\n  const transaction = getTransaction(transactionId, messenger);\n\n  if (!transaction) {\n    throw new Error('Transaction not found');\n  }\n\n  const paymentToken = getPaymentToken({\n    chainId,\n    from: transaction?.txParams.from as Hex,\n    messenger,\n    tokenAddress,\n  });\n\n  if (!paymentToken) {\n    throw new Error('Payment token not found');\n  }\n\n  log('Updated payment token', { transactionId, paymentToken });\n\n  updateTransactionData(transactionId, (data) => {\n    data.paymentToken = paymentToken;\n  });\n}\n\n/**\n * Generate the full payment token data from a token address and chain ID.\n *\n * @param request - The payment token request parameters.\n * @param request.chainId - The chain ID.\n * @param request.from - The address to get the token balance for.\n * @param request.messenger - The transaction pay controller messenger.\n * @param request.tokenAddress - The token address.\n * @returns The payment token or undefined if the token data could not be retrieved.\n */\nfunction getPaymentToken({\n  chainId,\n  from,\n  messenger,\n  tokenAddress,\n}: {\n  chainId: Hex;\n  from: Hex;\n  messenger: TransactionPayControllerMessenger;\n  tokenAddress: Hex;\n}): TransactionPaymentToken | undefined {\n  const { decimals, symbol } =\n    getTokenInfo(messenger, tokenAddress, chainId) ?? {};\n\n  if (decimals === undefined || !symbol) {\n    return undefined;\n  }\n\n  const tokenFiatRate = getTokenFiatRate(messenger, tokenAddress, chainId);\n\n  if (tokenFiatRate === undefined) {\n    return undefined;\n  }\n\n  const balance = getTokenBalance(messenger, from, chainId, tokenAddress);\n  const balanceRawValue = new BigNumber(balance);\n  const balanceHumanValue = new BigNumber(balance).shiftedBy(-decimals);\n  const balanceRaw = balanceRawValue.toFixed(0);\n  const balanceHuman = balanceHumanValue.toString(10);\n\n  const balanceFiat = balanceHumanValue\n    .multipliedBy(tokenFiatRate.fiatRate)\n    .toString(10);\n\n  const balanceUsd = balanceHumanValue\n    .multipliedBy(tokenFiatRate.usdRate)\n    .toString(10);\n\n  return {\n    address: tokenAddress,\n    balanceFiat,\n    balanceHuman,\n    balanceRaw,\n    balanceUsd,\n    chainId,\n    decimals,\n    symbol,\n  };\n}\n"]}

package/dist/constants.cjs

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionPayStrategy = exports.NATIVE_TOKEN_ADDRESS = exports.CONTROLLER_NAME = void 0;
+exports.CONTROLLER_NAME = 'TransactionPayController';
+exports.NATIVE_TOKEN_ADDRESS = '0x0000000000000000000000000000000000000000';
+var TransactionPayStrategy;
+(function (TransactionPayStrategy) {
+    TransactionPayStrategy["Bridge"] = "bridge";
+    TransactionPayStrategy["Relay"] = "relay";
+    TransactionPayStrategy["Test"] = "test";
+})(TransactionPayStrategy || (exports.TransactionPayStrategy = TransactionPayStrategy = {}));
+//# sourceMappingURL=constants.cjs.map

package/dist/constants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAEa,QAAA,eAAe,GAAG,0BAA0B,CAAC;AAE7C,QAAA,oBAAoB,GAC/B,4CAAmD,CAAC;AAEtD,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAChC,2CAAiB,CAAA;IACjB,yCAAe,CAAA;IACf,uCAAa,CAAA;AACf,CAAC,EAJW,sBAAsB,sCAAtB,sBAAsB,QAIjC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\nexport const CONTROLLER_NAME = 'TransactionPayController';\n\nexport const NATIVE_TOKEN_ADDRESS =\n  '0x0000000000000000000000000000000000000000' as Hex;\n\nexport enum TransactionPayStrategy {\n  Bridge = 'bridge',\n  Relay = 'relay',\n  Test = 'test',\n}\n"]}

package/dist/constants.d.cts

@@ -0,0 +1,8 @@
+export declare const CONTROLLER_NAME = "TransactionPayController";
+export declare const NATIVE_TOKEN_ADDRESS: `0x${string}`;
+export declare enum TransactionPayStrategy {
+    Bridge = "bridge",
+    Relay = "relay",
+    Test = "test"
+}
+//# sourceMappingURL=constants.d.cts.map

package/dist/constants.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.cts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,6BAA6B,CAAC;AAE1D,eAAO,MAAM,oBAAoB,eACoB,CAAC;AAEtD,oBAAY,sBAAsB;IAChC,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;CACd"}

package/dist/constants.d.mts

@@ -0,0 +1,8 @@
+export declare const CONTROLLER_NAME = "TransactionPayController";
+export declare const NATIVE_TOKEN_ADDRESS: `0x${string}`;
+export declare enum TransactionPayStrategy {
+    Bridge = "bridge",
+    Relay = "relay",
+    Test = "test"
+}
+//# sourceMappingURL=constants.d.mts.map

package/dist/constants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,6BAA6B,CAAC;AAE1D,eAAO,MAAM,oBAAoB,eACoB,CAAC;AAEtD,oBAAY,sBAAsB;IAChC,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;CACd"}

package/dist/constants.mjs

@@ -0,0 +1,9 @@
+export const CONTROLLER_NAME = 'TransactionPayController';
+export const NATIVE_TOKEN_ADDRESS = '0x0000000000000000000000000000000000000000';
+export var TransactionPayStrategy;
+(function (TransactionPayStrategy) {
+    TransactionPayStrategy["Bridge"] = "bridge";
+    TransactionPayStrategy["Relay"] = "relay";
+    TransactionPayStrategy["Test"] = "test";
+})(TransactionPayStrategy || (TransactionPayStrategy = {}));
+//# sourceMappingURL=constants.mjs.map

package/dist/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,eAAe,GAAG,0BAA0B,CAAC;AAE1D,MAAM,CAAC,MAAM,oBAAoB,GAC/B,4CAAmD,CAAC;AAEtD,MAAM,CAAN,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAChC,2CAAiB,CAAA;IACjB,yCAAe,CAAA;IACf,uCAAa,CAAA;AACf,CAAC,EAJW,sBAAsB,KAAtB,sBAAsB,QAIjC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\nexport const CONTROLLER_NAME = 'TransactionPayController';\n\nexport const NATIVE_TOKEN_ADDRESS =\n  '0x0000000000000000000000000000000000000000' as Hex;\n\nexport enum TransactionPayStrategy {\n  Bridge = 'bridge',\n  Relay = 'relay',\n  Test = 'test',\n}\n"]}