@metamask/subscription-controller 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,32 @@
+# 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]
+
+## [0.1.0]
+
+### Added
+
+- Initial release of the subscription controller ([#6233](https://github.com/MetaMask/core/pull/6233))
+  - `getSubscription`: Retrieve current user subscription info if exist.
+  - `cancelSubscription`: Cancel user active subscription.
+- `startShieldSubscriptionWithCard`: start shield subscription via card (with trial option) ([#6300](https://github.com/MetaMask/core/pull/6300))
+- Add `getPricing` method ([#6356](https://github.com/MetaMask/core/pull/6356))
+- Add methods `startSubscriptionWithCrypto` and `getCryptoApproveTransactionParams` method ([#6456](https://github.com/MetaMask/core/pull/6456))
+- Added `triggerAccessTokenRefresh` to trigger an access token refresh ([#6374](https://github.com/MetaMask/core/pull/6374))
+- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6504](https://github.com/MetaMask/core/pull/6504))
+- Added `updatePaymentMethodCard` and `updatePaymentMethodCrypto` methods ([#6539](https://github.com/MetaMask/core/pull/6539))
+- Added `getBillingPortalUrl` method ([#6580](https://github.com/MetaMask/core/pull/6580))
+- Added `unCancelSubscription` method ([#6596](https://github.com/MetaMask/core/pull/6596))
+
+### Changed
+
+- Bump `@metamask/controller-utils` from `^11.12.0` to `^11.14.0` ([#6620](https://github.com/MetaMask/core/pull/6620), [#6629](https://github.com/MetaMask/core/pull/6629))
+- Bump `@metamask/utils` from `^11.4.2` to `^11.8.0` ([#6588](https://github.com/MetaMask/core/pull/6588))
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/subscription-controller@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/subscription-controller@0.1.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/subscription-controller`
+
+Handle user subscription
+
+## Installation
+
+`yarn add @metamask/subscription-controller`
+
+or
+
+`npm install @metamask/subscription-controller`
+
+## Architecture
+
+[Reference](./ARCHITECTURE.md)
+
+## 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/SubscriptionController.cjs

@@ -0,0 +1,266 @@
+"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 _SubscriptionController_instances, _SubscriptionController_subscriptionService, _SubscriptionController_registerMessageHandlers, _SubscriptionController_getSubscriptionPriceAmount, _SubscriptionController_assertIsUserNotSubscribed, _SubscriptionController_assertIsUserSubscribed;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionController = exports.getDefaultSubscriptionControllerState = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const constants_1 = require("./constants.cjs");
+const types_1 = require("./types.cjs");
+/**
+ * Get the default state for the Subscription Controller.
+ *
+ * @returns The default state for the Subscription Controller.
+ */
+function getDefaultSubscriptionControllerState() {
+    return {
+        subscriptions: [],
+        trialedProducts: [],
+    };
+}
+exports.getDefaultSubscriptionControllerState = getDefaultSubscriptionControllerState;
+/**
+ * Seedless Onboarding Controller State Metadata.
+ *
+ * This allows us to choose if fields of the state should be persisted or not
+ * using the `persist` flag; and if they can be sent to Sentry or not, using
+ * the `anonymous` flag.
+ */
+const subscriptionControllerMetadata = {
+    subscriptions: {
+        includeInStateLogs: true,
+        persist: true,
+        anonymous: false,
+        usedInUi: true,
+    },
+    customerId: {
+        includeInStateLogs: true,
+        persist: true,
+        anonymous: false,
+        usedInUi: true,
+    },
+    trialedProducts: {
+        includeInStateLogs: true,
+        persist: true,
+        anonymous: true,
+        usedInUi: true,
+    },
+    pricing: {
+        includeInStateLogs: true,
+        persist: true,
+        anonymous: true,
+        usedInUi: true,
+    },
+};
+class SubscriptionController extends base_controller_1.BaseController {
+    /**
+     * Creates a new SubscriptionController instance.
+     *
+     * @param options - The options for the SubscriptionController.
+     * @param options.messenger - A restricted messenger.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.subscriptionService - The subscription service for communicating with subscription server.
+     */
+    constructor({ messenger, state, subscriptionService, }) {
+        super({
+            name: constants_1.controllerName,
+            metadata: subscriptionControllerMetadata,
+            state: {
+                ...getDefaultSubscriptionControllerState(),
+                ...state,
+            },
+            messenger,
+        });
+        _SubscriptionController_instances.add(this);
+        _SubscriptionController_subscriptionService.set(this, void 0);
+        __classPrivateFieldSet(this, _SubscriptionController_subscriptionService, subscriptionService, "f");
+        __classPrivateFieldGet(this, _SubscriptionController_instances, "m", _SubscriptionController_registerMessageHandlers).call(this);
+    }
+    /**
+     * Gets the pricing information from the subscription service.
+     *
+     * @returns The pricing information.
+     */
+    async getPricing() {
+        const pricing = await __classPrivateFieldGet(this, _SubscriptionController_subscriptionService, "f").getPricing();
+        this.update((state) => {
+            state.pricing = pricing;
+        });
+        return pricing;
+    }
+    async getSubscriptions() {
+        const { subscriptions, customerId, trialedProducts } = await __classPrivateFieldGet(this, _SubscriptionController_subscriptionService, "f").getSubscriptions();
+        this.update((state) => {
+            state.subscriptions = subscriptions;
+            state.customerId = customerId;
+            state.trialedProducts = trialedProducts;
+        });
+        return subscriptions;
+    }
+    async cancelSubscription(request) {
+        __classPrivateFieldGet(this, _SubscriptionController_instances, "m", _SubscriptionController_assertIsUserSubscribed).call(this, { subscriptionId: request.subscriptionId });
+        const cancelledSubscription = await __classPrivateFieldGet(this, _SubscriptionController_subscriptionService, "f").cancelSubscription({
+            subscriptionId: request.subscriptionId,
+        });
+        this.update((state) => {
+            state.subscriptions = state.subscriptions.map((subscription) => subscription.id === request.subscriptionId
+                ? { ...subscription, ...cancelledSubscription }
+                : subscription);
+        });
+        this.triggerAccessTokenRefresh();
+    }
+    async unCancelSubscription(request) {
+        __classPrivateFieldGet(this, _SubscriptionController_instances, "m", _SubscriptionController_assertIsUserSubscribed).call(this, { subscriptionId: request.subscriptionId });
+        const uncancelledSubscription = await __classPrivateFieldGet(this, _SubscriptionController_subscriptionService, "f").unCancelSubscription({
+            subscriptionId: request.subscriptionId,
+        });
+        this.update((state) => {
+            state.subscriptions = state.subscriptions.map((subscription) => subscription.id === request.subscriptionId
+                ? { ...subscription, ...uncancelledSubscription }
+                : subscription);
+        });
+        this.triggerAccessTokenRefresh();
+    }
+    async startShieldSubscriptionWithCard(request) {
+        __classPrivateFieldGet(this, _SubscriptionController_instances, "m", _SubscriptionController_assertIsUserNotSubscribed).call(this, { products: request.products });
+        const response = await __classPrivateFieldGet(this, _SubscriptionController_subscriptionService, "f").startSubscriptionWithCard(request);
+        this.triggerAccessTokenRefresh();
+        return response;
+    }
+    async startSubscriptionWithCrypto(request) {
+        __classPrivateFieldGet(this, _SubscriptionController_instances, "m", _SubscriptionController_assertIsUserNotSubscribed).call(this, { products: request.products });
+        const response = await __classPrivateFieldGet(this, _SubscriptionController_subscriptionService, "f").startSubscriptionWithCrypto(request);
+        this.triggerAccessTokenRefresh();
+        return response;
+    }
+    /**
+     * Get transaction params to create crypto approve transaction for subscription payment
+     *
+     * @param request - The request object
+     * @param request.chainId - The chain ID
+     * @param request.tokenAddress - The address of the token
+     * @param request.productType - The product type
+     * @param request.interval - The interval
+     * @returns The crypto approve transaction params
+     */
+    async getCryptoApproveTransactionParams(request) {
+        const pricing = await this.getPricing();
+        const product = pricing.products.find((p) => p.name === request.productType);
+        if (!product) {
+            throw new Error('Product price not found');
+        }
+        const price = product.prices.find((p) => p.interval === request.interval);
+        if (!price) {
+            throw new Error('Price not found');
+        }
+        const chainsPaymentInfo = pricing.paymentMethods.find((t) => t.type === types_1.PAYMENT_TYPES.byCrypto);
+        if (!chainsPaymentInfo) {
+            throw new Error('Chains payment info not found');
+        }
+        const chainPaymentInfo = chainsPaymentInfo.chains?.find((t) => t.chainId === request.chainId);
+        if (!chainPaymentInfo) {
+            throw new Error('Invalid chain id');
+        }
+        const tokenPaymentInfo = chainPaymentInfo.tokens.find((t) => t.address === request.paymentTokenAddress);
+        if (!tokenPaymentInfo) {
+            throw new Error('Invalid token address');
+        }
+        const tokenApproveAmount = this.getTokenApproveAmount(price, tokenPaymentInfo);
+        return {
+            approveAmount: tokenApproveAmount,
+            paymentAddress: chainPaymentInfo.paymentAddress,
+            paymentTokenAddress: request.paymentTokenAddress,
+            chainId: request.chainId,
+        };
+    }
+    async updatePaymentMethod(opts) {
+        if (opts.paymentType === types_1.PAYMENT_TYPES.byCard) {
+            const { paymentType, ...cardRequest } = opts;
+            await __classPrivateFieldGet(this, _SubscriptionController_subscriptionService, "f").updatePaymentMethodCard(cardRequest);
+        }
+        else if (opts.paymentType === types_1.PAYMENT_TYPES.byCrypto) {
+            const { paymentType, ...cryptoRequest } = opts;
+            await __classPrivateFieldGet(this, _SubscriptionController_subscriptionService, "f").updatePaymentMethodCrypto(cryptoRequest);
+        }
+        else {
+            throw new Error('Invalid payment type');
+        }
+        await this.getSubscriptions();
+    }
+    /**
+     * Calculate token approve amount from price info
+     *
+     * @param price - The price info
+     * @param tokenPaymentInfo - The token price info
+     * @returns The token approve amount
+     */
+    getTokenApproveAmount(price, tokenPaymentInfo) {
+        const conversionRate = tokenPaymentInfo.conversionRate[price.currency];
+        if (!conversionRate) {
+            throw new Error('Conversion rate not found');
+        }
+        // conversion rate is a float string e.g: "1.0"
+        // We need to handle float conversion rates with integer math for BigInt.
+        // We'll scale the conversion rate to an integer by multiplying by 10^4.
+        // conversionRate is in usd decimal. In most currencies, we only care about 2 decimals (cents)
+        // So, scale must be max of 10 ** 4 (most exchanges trade with max 4 decimals of usd)
+        // This allows us to avoid floating point math and keep precision.
+        const SCALE = 10n ** 4n;
+        const conversionRateScaled = BigInt(Math.round(Number(conversionRate) * Number(SCALE))) / SCALE;
+        // price of the product
+        const priceAmount = __classPrivateFieldGet(this, _SubscriptionController_instances, "m", _SubscriptionController_getSubscriptionPriceAmount).call(this, price);
+        const priceAmountScaled = BigInt(Math.round(priceAmount * Number(SCALE))) / SCALE;
+        const tokenDecimal = BigInt(10) ** BigInt(tokenPaymentInfo.decimals);
+        const tokenAmount = (priceAmountScaled * tokenDecimal) / conversionRateScaled;
+        return tokenAmount.toString();
+    }
+    /**
+     * Triggers an access token refresh.
+     */
+    triggerAccessTokenRefresh() {
+        // We perform a sign out to clear the access token from the authentication
+        // controller. Next time the access token is requested, a new access token
+        // will be fetched.
+        this.messagingSystem.call('AuthenticationController:performSignOut');
+    }
+    /**
+     * Gets the billing portal URL.
+     *
+     * @returns The billing portal URL
+     */
+    async getBillingPortalUrl() {
+        return await __classPrivateFieldGet(this, _SubscriptionController_subscriptionService, "f").getBillingPortalUrl();
+    }
+}
+exports.SubscriptionController = SubscriptionController;
+_SubscriptionController_subscriptionService = new WeakMap(), _SubscriptionController_instances = new WeakSet(), _SubscriptionController_registerMessageHandlers = function _SubscriptionController_registerMessageHandlers() {
+    this.messagingSystem.registerActionHandler('SubscriptionController:getSubscriptions', this.getSubscriptions.bind(this));
+    this.messagingSystem.registerActionHandler('SubscriptionController:cancelSubscription', this.cancelSubscription.bind(this));
+    this.messagingSystem.registerActionHandler('SubscriptionController:startShieldSubscriptionWithCard', this.startShieldSubscriptionWithCard.bind(this));
+    this.messagingSystem.registerActionHandler('SubscriptionController:getPricing', this.getPricing.bind(this));
+    this.messagingSystem.registerActionHandler('SubscriptionController:getCryptoApproveTransactionParams', this.getCryptoApproveTransactionParams.bind(this));
+    this.messagingSystem.registerActionHandler('SubscriptionController:startSubscriptionWithCrypto', this.startSubscriptionWithCrypto.bind(this));
+    this.messagingSystem.registerActionHandler('SubscriptionController:updatePaymentMethod', this.updatePaymentMethod.bind(this));
+}, _SubscriptionController_getSubscriptionPriceAmount = function _SubscriptionController_getSubscriptionPriceAmount(price) {
+    // no need to use BigInt since max unitDecimals are always 2 for price
+    const amount = (price.unitAmount / 10 ** price.unitDecimals) * price.minBillingCycles;
+    return amount;
+}, _SubscriptionController_assertIsUserNotSubscribed = function _SubscriptionController_assertIsUserNotSubscribed({ products }) {
+    if (this.state.subscriptions.find((subscription) => subscription.products.some((p) => products.includes(p.name)))) {
+        throw new Error(constants_1.SubscriptionControllerErrorMessage.UserAlreadySubscribed);
+    }
+}, _SubscriptionController_assertIsUserSubscribed = function _SubscriptionController_assertIsUserSubscribed(request) {
+    if (!this.state.subscriptions.find((subscription) => subscription.id === request.subscriptionId)) {
+        throw new Error(constants_1.SubscriptionControllerErrorMessage.UserNotSubscribed);
+    }
+};
+//# sourceMappingURL=SubscriptionController.cjs.map

package/dist/SubscriptionController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController.cjs","sourceRoot":"","sources":["../src/SubscriptionController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAMmC;AAGnC,+CAGqB;AAUrB,uCAOiB;AA8FjB;;;;GAIG;AACH,SAAgB,qCAAqC;IACnD,OAAO;QACL,aAAa,EAAE,EAAE;QACjB,eAAe,EAAE,EAAE;KACpB,CAAC;AACJ,CAAC;AALD,sFAKC;AAED;;;;;;GAMG;AACH,MAAM,8BAA8B,GAClC;IACE,aAAa,EAAE;QACb,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;QACf,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;QACf,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEJ,MAAa,sBAAuB,SAAQ,gCAI3C;IAGC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,mBAAmB,GACW;QAC9B,KAAK,CAAC;YACJ,IAAI,EAAE,0BAAc;YACpB,QAAQ,EAAE,8BAA8B;YACxC,KAAK,EAAE;gBACL,GAAG,qCAAqC,EAAE;gBAC1C,GAAG,KAAK;aACT;YACD,SAAS;SACV,CAAC,CAAC;;QAvBI,8DAA2C;QAyBlD,uBAAA,IAAI,+CAAwB,mBAAmB,MAAA,CAAC;QAChD,uBAAA,IAAI,0FAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IA2CD;;;;OAIG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,OAAO,GAAG,MAAM,uBAAA,IAAI,mDAAqB,CAAC,UAAU,EAAE,CAAC;QAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,eAAe,EAAE,GAClD,MAAM,uBAAA,IAAI,mDAAqB,CAAC,gBAAgB,EAAE,CAAC;QAErD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,aAAa,GAAG,aAAa,CAAC;YACpC,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;YAC9B,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,OAAmC;QAC1D,uBAAA,IAAI,yFAAwB,MAA5B,IAAI,EAAyB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;QAEzE,MAAM,qBAAqB,GACzB,MAAM,uBAAA,IAAI,mDAAqB,CAAC,kBAAkB,CAAC;YACjD,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAC;QAEL,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAC7D,YAAY,CAAC,EAAE,KAAK,OAAO,CAAC,cAAc;gBACxC,CAAC,CAAC,EAAE,GAAG,YAAY,EAAE,GAAG,qBAAqB,EAAE;gBAC/C,CAAC,CAAC,YAAY,CACjB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,yBAAyB,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,OAAmC;QAC5D,uBAAA,IAAI,yFAAwB,MAA5B,IAAI,EAAyB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;QAEzE,MAAM,uBAAuB,GAC3B,MAAM,uBAAA,IAAI,mDAAqB,CAAC,oBAAoB,CAAC;YACnD,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAC;QAEL,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAC7D,YAAY,CAAC,EAAE,KAAK,OAAO,CAAC,cAAc;gBACxC,CAAC,CAAC,EAAE,GAAG,YAAY,EAAE,GAAG,uBAAuB,EAAE;gBACjD,CAAC,CAAC,YAAY,CACjB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,yBAAyB,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,+BAA+B,CAAC,OAAiC;QACrE,uBAAA,IAAI,4FAA2B,MAA/B,IAAI,EAA4B,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEhE,MAAM,QAAQ,GACZ,MAAM,uBAAA,IAAI,mDAAqB,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAErE,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAEjC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,OAAuC;QACvE,uBAAA,IAAI,4FAA2B,MAA/B,IAAI,EAA4B,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAChE,MAAM,QAAQ,GACZ,MAAM,uBAAA,IAAI,mDAAqB,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;QACvE,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACjC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,iCAAiC,CACrC,OAA2C;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACxC,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CACnC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,WAAW,CACtC,CAAC;QACF,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC5C;QAED,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC1E,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;SACpC;QAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,CACnD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,qBAAa,CAAC,QAAQ,CACzC,CAAC;QACF,IAAI,CAAC,iBAAiB,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;SAClD;QACD,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,EAAE,IAAI,CACrD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CACrC,CAAC;QACF,IAAI,CAAC,gBAAgB,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;QACD,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CACnD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,mBAAmB,CACjD,CAAC;QACF,IAAI,CAAC,gBAAgB,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC1C;QAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CACnD,KAAK,EACL,gBAAgB,CACjB,CAAC;QAEF,OAAO;YACL,aAAa,EAAE,kBAAkB;YACjC,cAAc,EAAE,gBAAgB,CAAC,cAAc;YAC/C,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;YAChD,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,IAA6B;QACrD,IAAI,IAAI,CAAC,WAAW,KAAK,qBAAa,CAAC,MAAM,EAAE;YAC7C,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,EAAE,GAAG,IAAI,CAAC;YAC7C,MAAM,uBAAA,IAAI,mDAAqB,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;SACtE;aAAM,IAAI,IAAI,CAAC,WAAW,KAAK,qBAAa,CAAC,QAAQ,EAAE;YACtD,MAAM,EAAE,WAAW,EAAE,GAAG,aAAa,EAAE,GAAG,IAAI,CAAC;YAC/C,MAAM,uBAAA,IAAI,mDAAqB,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;SAC1E;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACzC;QACD,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAChC,CAAC;IAgBD;;;;;;OAMG;IACH,qBAAqB,CACnB,KAAmB,EACnB,gBAAkC;QAElC,MAAM,cAAc,GAClB,gBAAgB,CAAC,cAAc,CAC7B,KAAK,CAAC,QAAwD,CAC/D,CAAC;QACJ,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QACD,+CAA+C;QAC/C,yEAAyE;QACzE,wEAAwE;QACxE,8FAA8F;QAC9F,qFAAqF;QACrF,kEAAkE;QAClE,MAAM,KAAK,GAAG,GAAG,IAAI,EAAE,CAAC;QACxB,MAAM,oBAAoB,GACxB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACrE,uBAAuB;QACvB,MAAM,WAAW,GAAG,uBAAA,IAAI,6FAA4B,MAAhC,IAAI,EAA6B,KAAK,CAAC,CAAC;QAC5D,MAAM,iBAAiB,GACrB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QAE1D,MAAM,YAAY,GAAG,MAAM,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAErE,MAAM,WAAW,GACf,CAAC,iBAAiB,GAAG,YAAY,CAAC,GAAG,oBAAoB,CAAC;QAC5D,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAYD;;OAEG;IACH,yBAAyB;QACvB,0EAA0E;QAC1E,0EAA0E;QAC1E,mBAAmB;QACnB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;IACvE,CAAC;IAYD;;;;OAIG;IACH,KAAK,CAAC,mBAAmB;QACvB,OAAO,MAAM,uBAAA,IAAI,mDAAqB,CAAC,mBAAmB,EAAE,CAAC;IAC/D,CAAC;CACF;AAhUD,wDAgUC;;IAzRG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,yCAAyC,EACzC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CACjC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,2CAA2C,EAC3C,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CACnC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,wDAAwD,EACxD,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,CAChD,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,mCAAmC,EACnC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAC3B,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,0DAA0D,EAC1D,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,IAAI,CAAC,CAClD,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,oDAAoD,EACpD,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5C,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4CAA4C,EAC5C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CACpC,CAAC;AACJ,CAAC,mHAmK2B,KAAmB;IAC7C,sEAAsE;IACtE,MAAM,MAAM,GACV,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,IAAI,KAAK,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,gBAAgB,CAAC;IACzE,OAAO,MAAM,CAAC;AAChB,CAAC,iHAyC0B,EAAE,QAAQ,EAA+B;IAClE,IACE,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAC7C,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAC7D,EACD;QACA,MAAM,IAAI,KAAK,CAAC,8CAAkC,CAAC,qBAAqB,CAAC,CAAC;KAC3E;AACH,CAAC,2GAYuB,OAAmC;IACzD,IACE,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAC5B,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,OAAO,CAAC,cAAc,CAC7D,EACD;QACA,MAAM,IAAI,KAAK,CAAC,8CAAkC,CAAC,iBAAiB,CAAC,CAAC;KACvE;AACH,CAAC","sourcesContent":["import {\n  BaseController,\n  type StateMetadata,\n  type ControllerStateChangeEvent,\n  type ControllerGetStateAction,\n  type RestrictedMessenger,\n} from '@metamask/base-controller';\nimport type { AuthenticationController } from '@metamask/profile-sync-controller';\n\nimport {\n  controllerName,\n  SubscriptionControllerErrorMessage,\n} from './constants';\nimport type {\n  BillingPortalResponse,\n  GetCryptoApproveTransactionRequest,\n  GetCryptoApproveTransactionResponse,\n  ProductPrice,\n  StartCryptoSubscriptionRequest,\n  TokenPaymentInfo,\n  UpdatePaymentMethodOpts,\n} from './types';\nimport {\n  PAYMENT_TYPES,\n  type ISubscriptionService,\n  type PricingResponse,\n  type ProductType,\n  type StartSubscriptionRequest,\n  type Subscription,\n} from './types';\n\nexport type SubscriptionControllerState = {\n  customerId?: string;\n  trialedProducts: ProductType[];\n  subscriptions: Subscription[];\n  pricing?: PricingResponse;\n};\n\n// Messenger Actions\nexport type SubscriptionControllerGetSubscriptionsAction = {\n  type: `${typeof controllerName}:getSubscriptions`;\n  handler: SubscriptionController['getSubscriptions'];\n};\nexport type SubscriptionControllerCancelSubscriptionAction = {\n  type: `${typeof controllerName}:cancelSubscription`;\n  handler: SubscriptionController['cancelSubscription'];\n};\nexport type SubscriptionControllerStartShieldSubscriptionWithCardAction = {\n  type: `${typeof controllerName}:startShieldSubscriptionWithCard`;\n  handler: SubscriptionController['startShieldSubscriptionWithCard'];\n};\nexport type SubscriptionControllerGetPricingAction = {\n  type: `${typeof controllerName}:getPricing`;\n  handler: SubscriptionController['getPricing'];\n};\nexport type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {\n  type: `${typeof controllerName}:getCryptoApproveTransactionParams`;\n  handler: SubscriptionController['getCryptoApproveTransactionParams'];\n};\nexport type SubscriptionControllerStartSubscriptionWithCryptoAction = {\n  type: `${typeof controllerName}:startSubscriptionWithCrypto`;\n  handler: SubscriptionController['startSubscriptionWithCrypto'];\n};\nexport type SubscriptionControllerUpdatePaymentMethodAction = {\n  type: `${typeof controllerName}:updatePaymentMethod`;\n  handler: SubscriptionController['updatePaymentMethod'];\n};\n\nexport type SubscriptionControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SubscriptionControllerState\n>;\nexport type SubscriptionControllerActions =\n  | SubscriptionControllerGetSubscriptionsAction\n  | SubscriptionControllerCancelSubscriptionAction\n  | SubscriptionControllerStartShieldSubscriptionWithCardAction\n  | SubscriptionControllerGetPricingAction\n  | SubscriptionControllerGetStateAction\n  | SubscriptionControllerGetCryptoApproveTransactionParamsAction\n  | SubscriptionControllerStartSubscriptionWithCryptoAction\n  | SubscriptionControllerUpdatePaymentMethodAction;\n\nexport type AllowedActions =\n  | AuthenticationController.AuthenticationControllerGetBearerToken\n  | AuthenticationController.AuthenticationControllerPerformSignOut;\n\n// Events\nexport type SubscriptionControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  SubscriptionControllerState\n>;\nexport type SubscriptionControllerEvents =\n  SubscriptionControllerStateChangeEvent;\n\nexport type AllowedEvents =\n  AuthenticationController.AuthenticationControllerStateChangeEvent;\n\n// Messenger\nexport type SubscriptionControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  SubscriptionControllerActions | AllowedActions,\n  SubscriptionControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Subscription Controller Options.\n */\nexport type SubscriptionControllerOptions = {\n  messenger: SubscriptionControllerMessenger;\n\n  /**\n   * Initial state to set on this controller.\n   */\n  state?: Partial<SubscriptionControllerState>;\n\n  /**\n   * Subscription service to use for the subscription controller.\n   */\n  subscriptionService: ISubscriptionService;\n};\n\n/**\n * Get the default state for the Subscription Controller.\n *\n * @returns The default state for the Subscription Controller.\n */\nexport function getDefaultSubscriptionControllerState(): SubscriptionControllerState {\n  return {\n    subscriptions: [],\n    trialedProducts: [],\n  };\n}\n\n/**\n * Seedless Onboarding Controller State Metadata.\n *\n * This allows us to choose if fields of the state should be persisted or not\n * using the `persist` flag; and if they can be sent to Sentry or not, using\n * the `anonymous` flag.\n */\nconst subscriptionControllerMetadata: StateMetadata<SubscriptionControllerState> =\n  {\n    subscriptions: {\n      includeInStateLogs: true,\n      persist: true,\n      anonymous: false,\n      usedInUi: true,\n    },\n    customerId: {\n      includeInStateLogs: true,\n      persist: true,\n      anonymous: false,\n      usedInUi: true,\n    },\n    trialedProducts: {\n      includeInStateLogs: true,\n      persist: true,\n      anonymous: true,\n      usedInUi: true,\n    },\n    pricing: {\n      includeInStateLogs: true,\n      persist: true,\n      anonymous: true,\n      usedInUi: true,\n    },\n  };\n\nexport class SubscriptionController extends BaseController<\n  typeof controllerName,\n  SubscriptionControllerState,\n  SubscriptionControllerMessenger\n> {\n  readonly #subscriptionService: ISubscriptionService;\n\n  /**\n   * Creates a new SubscriptionController instance.\n   *\n   * @param options - The options for the SubscriptionController.\n   * @param options.messenger - A restricted messenger.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.subscriptionService - The subscription service for communicating with subscription server.\n   */\n  constructor({\n    messenger,\n    state,\n    subscriptionService,\n  }: SubscriptionControllerOptions) {\n    super({\n      name: controllerName,\n      metadata: subscriptionControllerMetadata,\n      state: {\n        ...getDefaultSubscriptionControllerState(),\n        ...state,\n      },\n      messenger,\n    });\n\n    this.#subscriptionService = subscriptionService;\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      'SubscriptionController:getSubscriptions',\n      this.getSubscriptions.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'SubscriptionController:cancelSubscription',\n      this.cancelSubscription.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'SubscriptionController:startShieldSubscriptionWithCard',\n      this.startShieldSubscriptionWithCard.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'SubscriptionController:getPricing',\n      this.getPricing.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'SubscriptionController:getCryptoApproveTransactionParams',\n      this.getCryptoApproveTransactionParams.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'SubscriptionController:startSubscriptionWithCrypto',\n      this.startSubscriptionWithCrypto.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'SubscriptionController:updatePaymentMethod',\n      this.updatePaymentMethod.bind(this),\n    );\n  }\n\n  /**\n   * Gets the pricing information from the subscription service.\n   *\n   * @returns The pricing information.\n   */\n  async getPricing(): Promise<PricingResponse> {\n    const pricing = await this.#subscriptionService.getPricing();\n    this.update((state) => {\n      state.pricing = pricing;\n    });\n    return pricing;\n  }\n\n  async getSubscriptions() {\n    const { subscriptions, customerId, trialedProducts } =\n      await this.#subscriptionService.getSubscriptions();\n\n    this.update((state) => {\n      state.subscriptions = subscriptions;\n      state.customerId = customerId;\n      state.trialedProducts = trialedProducts;\n    });\n\n    return subscriptions;\n  }\n\n  async cancelSubscription(request: { subscriptionId: string }) {\n    this.#assertIsUserSubscribed({ subscriptionId: request.subscriptionId });\n\n    const cancelledSubscription =\n      await this.#subscriptionService.cancelSubscription({\n        subscriptionId: request.subscriptionId,\n      });\n\n    this.update((state) => {\n      state.subscriptions = state.subscriptions.map((subscription) =>\n        subscription.id === request.subscriptionId\n          ? { ...subscription, ...cancelledSubscription }\n          : subscription,\n      );\n    });\n\n    this.triggerAccessTokenRefresh();\n  }\n\n  async unCancelSubscription(request: { subscriptionId: string }) {\n    this.#assertIsUserSubscribed({ subscriptionId: request.subscriptionId });\n\n    const uncancelledSubscription =\n      await this.#subscriptionService.unCancelSubscription({\n        subscriptionId: request.subscriptionId,\n      });\n\n    this.update((state) => {\n      state.subscriptions = state.subscriptions.map((subscription) =>\n        subscription.id === request.subscriptionId\n          ? { ...subscription, ...uncancelledSubscription }\n          : subscription,\n      );\n    });\n\n    this.triggerAccessTokenRefresh();\n  }\n\n  async startShieldSubscriptionWithCard(request: StartSubscriptionRequest) {\n    this.#assertIsUserNotSubscribed({ products: request.products });\n\n    const response =\n      await this.#subscriptionService.startSubscriptionWithCard(request);\n\n    this.triggerAccessTokenRefresh();\n\n    return response;\n  }\n\n  async startSubscriptionWithCrypto(request: StartCryptoSubscriptionRequest) {\n    this.#assertIsUserNotSubscribed({ products: request.products });\n    const response =\n      await this.#subscriptionService.startSubscriptionWithCrypto(request);\n    this.triggerAccessTokenRefresh();\n    return response;\n  }\n\n  /**\n   * Get transaction params to create crypto approve transaction for subscription payment\n   *\n   * @param request - The request object\n   * @param request.chainId - The chain ID\n   * @param request.tokenAddress - The address of the token\n   * @param request.productType - The product type\n   * @param request.interval - The interval\n   * @returns The crypto approve transaction params\n   */\n  async getCryptoApproveTransactionParams(\n    request: GetCryptoApproveTransactionRequest,\n  ): Promise<GetCryptoApproveTransactionResponse> {\n    const pricing = await this.getPricing();\n    const product = pricing.products.find(\n      (p) => p.name === request.productType,\n    );\n    if (!product) {\n      throw new Error('Product price not found');\n    }\n\n    const price = product.prices.find((p) => p.interval === request.interval);\n    if (!price) {\n      throw new Error('Price not found');\n    }\n\n    const chainsPaymentInfo = pricing.paymentMethods.find(\n      (t) => t.type === PAYMENT_TYPES.byCrypto,\n    );\n    if (!chainsPaymentInfo) {\n      throw new Error('Chains payment info not found');\n    }\n    const chainPaymentInfo = chainsPaymentInfo.chains?.find(\n      (t) => t.chainId === request.chainId,\n    );\n    if (!chainPaymentInfo) {\n      throw new Error('Invalid chain id');\n    }\n    const tokenPaymentInfo = chainPaymentInfo.tokens.find(\n      (t) => t.address === request.paymentTokenAddress,\n    );\n    if (!tokenPaymentInfo) {\n      throw new Error('Invalid token address');\n    }\n\n    const tokenApproveAmount = this.getTokenApproveAmount(\n      price,\n      tokenPaymentInfo,\n    );\n\n    return {\n      approveAmount: tokenApproveAmount,\n      paymentAddress: chainPaymentInfo.paymentAddress,\n      paymentTokenAddress: request.paymentTokenAddress,\n      chainId: request.chainId,\n    };\n  }\n\n  async updatePaymentMethod(opts: UpdatePaymentMethodOpts) {\n    if (opts.paymentType === PAYMENT_TYPES.byCard) {\n      const { paymentType, ...cardRequest } = opts;\n      await this.#subscriptionService.updatePaymentMethodCard(cardRequest);\n    } else if (opts.paymentType === PAYMENT_TYPES.byCrypto) {\n      const { paymentType, ...cryptoRequest } = opts;\n      await this.#subscriptionService.updatePaymentMethodCrypto(cryptoRequest);\n    } else {\n      throw new Error('Invalid payment type');\n    }\n    await this.getSubscriptions();\n  }\n\n  /**\n   * Calculate total subscription price amount from price info\n   * e.g: $8 per month * 12 months min billing cycles = $96\n   *\n   * @param price - The price info\n   * @returns The price amount\n   */\n  #getSubscriptionPriceAmount(price: ProductPrice) {\n    // no need to use BigInt since max unitDecimals are always 2 for price\n    const amount =\n      (price.unitAmount / 10 ** price.unitDecimals) * price.minBillingCycles;\n    return amount;\n  }\n\n  /**\n   * Calculate token approve amount from price info\n   *\n   * @param price - The price info\n   * @param tokenPaymentInfo - The token price info\n   * @returns The token approve amount\n   */\n  getTokenApproveAmount(\n    price: ProductPrice,\n    tokenPaymentInfo: TokenPaymentInfo,\n  ): string {\n    const conversionRate =\n      tokenPaymentInfo.conversionRate[\n        price.currency as keyof typeof tokenPaymentInfo.conversionRate\n      ];\n    if (!conversionRate) {\n      throw new Error('Conversion rate not found');\n    }\n    // conversion rate is a float string e.g: \"1.0\"\n    // We need to handle float conversion rates with integer math for BigInt.\n    // We'll scale the conversion rate to an integer by multiplying by 10^4.\n    // conversionRate is in usd decimal. In most currencies, we only care about 2 decimals (cents)\n    // So, scale must be max of 10 ** 4 (most exchanges trade with max 4 decimals of usd)\n    // This allows us to avoid floating point math and keep precision.\n    const SCALE = 10n ** 4n;\n    const conversionRateScaled =\n      BigInt(Math.round(Number(conversionRate) * Number(SCALE))) / SCALE;\n    // price of the product\n    const priceAmount = this.#getSubscriptionPriceAmount(price);\n    const priceAmountScaled =\n      BigInt(Math.round(priceAmount * Number(SCALE))) / SCALE;\n\n    const tokenDecimal = BigInt(10) ** BigInt(tokenPaymentInfo.decimals);\n\n    const tokenAmount =\n      (priceAmountScaled * tokenDecimal) / conversionRateScaled;\n    return tokenAmount.toString();\n  }\n\n  #assertIsUserNotSubscribed({ products }: { products: ProductType[] }) {\n    if (\n      this.state.subscriptions.find((subscription) =>\n        subscription.products.some((p) => products.includes(p.name)),\n      )\n    ) {\n      throw new Error(SubscriptionControllerErrorMessage.UserAlreadySubscribed);\n    }\n  }\n\n  /**\n   * Triggers an access token refresh.\n   */\n  triggerAccessTokenRefresh() {\n    // We perform a sign out to clear the access token from the authentication\n    // controller. Next time the access token is requested, a new access token\n    // will be fetched.\n    this.messagingSystem.call('AuthenticationController:performSignOut');\n  }\n\n  #assertIsUserSubscribed(request: { subscriptionId: string }) {\n    if (\n      !this.state.subscriptions.find(\n        (subscription) => subscription.id === request.subscriptionId,\n      )\n    ) {\n      throw new Error(SubscriptionControllerErrorMessage.UserNotSubscribed);\n    }\n  }\n\n  /**\n   * Gets the billing portal URL.\n   *\n   * @returns The billing portal URL\n   */\n  async getBillingPortalUrl(): Promise<BillingPortalResponse> {\n    return await this.#subscriptionService.getBillingPortalUrl();\n  }\n}\n"]}

package/dist/SubscriptionController.d.cts

@@ -0,0 +1,124 @@
+import { BaseController, type ControllerStateChangeEvent, type ControllerGetStateAction, type RestrictedMessenger } from "@metamask/base-controller";
+import type { AuthenticationController } from "@metamask/profile-sync-controller";
+import { controllerName } from "./constants.cjs";
+import type { BillingPortalResponse, GetCryptoApproveTransactionRequest, GetCryptoApproveTransactionResponse, ProductPrice, StartCryptoSubscriptionRequest, TokenPaymentInfo, UpdatePaymentMethodOpts } from "./types.cjs";
+import { type ISubscriptionService, type PricingResponse, type ProductType, type StartSubscriptionRequest, type Subscription } from "./types.cjs";
+export type SubscriptionControllerState = {
+    customerId?: string;
+    trialedProducts: ProductType[];
+    subscriptions: Subscription[];
+    pricing?: PricingResponse;
+};
+export type SubscriptionControllerGetSubscriptionsAction = {
+    type: `${typeof controllerName}:getSubscriptions`;
+    handler: SubscriptionController['getSubscriptions'];
+};
+export type SubscriptionControllerCancelSubscriptionAction = {
+    type: `${typeof controllerName}:cancelSubscription`;
+    handler: SubscriptionController['cancelSubscription'];
+};
+export type SubscriptionControllerStartShieldSubscriptionWithCardAction = {
+    type: `${typeof controllerName}:startShieldSubscriptionWithCard`;
+    handler: SubscriptionController['startShieldSubscriptionWithCard'];
+};
+export type SubscriptionControllerGetPricingAction = {
+    type: `${typeof controllerName}:getPricing`;
+    handler: SubscriptionController['getPricing'];
+};
+export type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {
+    type: `${typeof controllerName}:getCryptoApproveTransactionParams`;
+    handler: SubscriptionController['getCryptoApproveTransactionParams'];
+};
+export type SubscriptionControllerStartSubscriptionWithCryptoAction = {
+    type: `${typeof controllerName}:startSubscriptionWithCrypto`;
+    handler: SubscriptionController['startSubscriptionWithCrypto'];
+};
+export type SubscriptionControllerUpdatePaymentMethodAction = {
+    type: `${typeof controllerName}:updatePaymentMethod`;
+    handler: SubscriptionController['updatePaymentMethod'];
+};
+export type SubscriptionControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SubscriptionControllerState>;
+export type SubscriptionControllerActions = SubscriptionControllerGetSubscriptionsAction | SubscriptionControllerCancelSubscriptionAction | SubscriptionControllerStartShieldSubscriptionWithCardAction | SubscriptionControllerGetPricingAction | SubscriptionControllerGetStateAction | SubscriptionControllerGetCryptoApproveTransactionParamsAction | SubscriptionControllerStartSubscriptionWithCryptoAction | SubscriptionControllerUpdatePaymentMethodAction;
+export type AllowedActions = AuthenticationController.AuthenticationControllerGetBearerToken | AuthenticationController.AuthenticationControllerPerformSignOut;
+export type SubscriptionControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SubscriptionControllerState>;
+export type SubscriptionControllerEvents = SubscriptionControllerStateChangeEvent;
+export type AllowedEvents = AuthenticationController.AuthenticationControllerStateChangeEvent;
+export type SubscriptionControllerMessenger = RestrictedMessenger<typeof controllerName, SubscriptionControllerActions | AllowedActions, SubscriptionControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Subscription Controller Options.
+ */
+export type SubscriptionControllerOptions = {
+    messenger: SubscriptionControllerMessenger;
+    /**
+     * Initial state to set on this controller.
+     */
+    state?: Partial<SubscriptionControllerState>;
+    /**
+     * Subscription service to use for the subscription controller.
+     */
+    subscriptionService: ISubscriptionService;
+};
+/**
+ * Get the default state for the Subscription Controller.
+ *
+ * @returns The default state for the Subscription Controller.
+ */
+export declare function getDefaultSubscriptionControllerState(): SubscriptionControllerState;
+export declare class SubscriptionController extends BaseController<typeof controllerName, SubscriptionControllerState, SubscriptionControllerMessenger> {
+    #private;
+    /**
+     * Creates a new SubscriptionController instance.
+     *
+     * @param options - The options for the SubscriptionController.
+     * @param options.messenger - A restricted messenger.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.subscriptionService - The subscription service for communicating with subscription server.
+     */
+    constructor({ messenger, state, subscriptionService, }: SubscriptionControllerOptions);
+    /**
+     * Gets the pricing information from the subscription service.
+     *
+     * @returns The pricing information.
+     */
+    getPricing(): Promise<PricingResponse>;
+    getSubscriptions(): Promise<Subscription[]>;
+    cancelSubscription(request: {
+        subscriptionId: string;
+    }): Promise<void>;
+    unCancelSubscription(request: {
+        subscriptionId: string;
+    }): Promise<void>;
+    startShieldSubscriptionWithCard(request: StartSubscriptionRequest): Promise<import("./types.cjs").StartSubscriptionResponse>;
+    startSubscriptionWithCrypto(request: StartCryptoSubscriptionRequest): Promise<import("./types.cjs").StartCryptoSubscriptionResponse>;
+    /**
+     * Get transaction params to create crypto approve transaction for subscription payment
+     *
+     * @param request - The request object
+     * @param request.chainId - The chain ID
+     * @param request.tokenAddress - The address of the token
+     * @param request.productType - The product type
+     * @param request.interval - The interval
+     * @returns The crypto approve transaction params
+     */
+    getCryptoApproveTransactionParams(request: GetCryptoApproveTransactionRequest): Promise<GetCryptoApproveTransactionResponse>;
+    updatePaymentMethod(opts: UpdatePaymentMethodOpts): Promise<void>;
+    /**
+     * Calculate token approve amount from price info
+     *
+     * @param price - The price info
+     * @param tokenPaymentInfo - The token price info
+     * @returns The token approve amount
+     */
+    getTokenApproveAmount(price: ProductPrice, tokenPaymentInfo: TokenPaymentInfo): string;
+    /**
+     * Triggers an access token refresh.
+     */
+    triggerAccessTokenRefresh(): void;
+    /**
+     * Gets the billing portal URL.
+     *
+     * @returns The billing portal URL
+     */
+    getBillingPortalUrl(): Promise<BillingPortalResponse>;
+}
+//# sourceMappingURL=SubscriptionController.d.cts.map

package/dist/SubscriptionController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController.d.cts","sourceRoot":"","sources":["../src/SubscriptionController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAEd,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,wBAAwB,EAAE,0CAA0C;AAElF,OAAO,EACL,cAAc,EAEf,wBAAoB;AACrB,OAAO,KAAK,EACV,qBAAqB,EACrB,kCAAkC,EAClC,mCAAmC,EACnC,YAAY,EACZ,8BAA8B,EAC9B,gBAAgB,EAChB,uBAAuB,EACxB,oBAAgB;AACjB,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,KAAK,YAAY,EAClB,oBAAgB;AAEjB,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,WAAW,EAAE,CAAC;IAC/B,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC;AAGF,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,GAAG,OAAO,cAAc,mBAAmB,CAAC;IAClD,OAAO,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;CACrD,CAAC;AACF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,GAAG,OAAO,cAAc,qBAAqB,CAAC;IACpD,OAAO,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;CACvD,CAAC;AACF,MAAM,MAAM,2DAA2D,GAAG;IACxE,IAAI,EAAE,GAAG,OAAO,cAAc,kCAAkC,CAAC;IACjE,OAAO,EAAE,sBAAsB,CAAC,iCAAiC,CAAC,CAAC;CACpE,CAAC;AACF,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,GAAG,OAAO,cAAc,aAAa,CAAC;IAC5C,OAAO,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AACF,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,GAAG,OAAO,cAAc,oCAAoC,CAAC;IACnE,OAAO,EAAE,sBAAsB,CAAC,mCAAmC,CAAC,CAAC;CACtE,CAAC;AACF,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,GAAG,OAAO,cAAc,8BAA8B,CAAC;IAC7D,OAAO,EAAE,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;CAChE,CAAC;AACF,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,GAAG,OAAO,cAAc,sBAAsB,CAAC;IACrD,OAAO,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,wBAAwB,CACzE,OAAO,cAAc,EACrB,2BAA2B,CAC5B,CAAC;AACF,MAAM,MAAM,6BAA6B,GACrC,4CAA4C,GAC5C,8CAA8C,GAC9C,2DAA2D,GAC3D,sCAAsC,GACtC,oCAAoC,GACpC,6DAA6D,GAC7D,uDAAuD,GACvD,+CAA+C,CAAC;AAEpD,MAAM,MAAM,cAAc,GACtB,wBAAwB,CAAC,sCAAsC,GAC/D,wBAAwB,CAAC,sCAAsC,CAAC;AAGpE,MAAM,MAAM,sCAAsC,GAAG,0BAA0B,CAC7E,OAAO,cAAc,EACrB,2BAA2B,CAC5B,CAAC;AACF,MAAM,MAAM,4BAA4B,GACtC,sCAAsC,CAAC;AAEzC,MAAM,MAAM,aAAa,GACvB,wBAAwB,CAAC,wCAAwC,CAAC;AAGpE,MAAM,MAAM,+BAA+B,GAAG,mBAAmB,CAC/D,OAAO,cAAc,EACrB,6BAA6B,GAAG,cAAc,EAC9C,4BAA4B,GAAG,aAAa,EAC5C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,SAAS,EAAE,+BAA+B,CAAC;IAE3C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAE7C;;OAEG;IACH,mBAAmB,EAAE,oBAAoB,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,qCAAqC,IAAI,2BAA2B,CAKnF;AAqCD,qBAAa,sBAAuB,SAAQ,cAAc,CACxD,OAAO,cAAc,EACrB,2BAA2B,EAC3B,+BAA+B,CAChC;;IAGC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,EACL,mBAAmB,GACpB,EAAE,6BAA6B;IAwDhC;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC;IAQtC,gBAAgB;IAahB,kBAAkB,CAAC,OAAO,EAAE;QAAE,cAAc,EAAE,MAAM,CAAA;KAAE;IAmBtD,oBAAoB,CAAC,OAAO,EAAE;QAAE,cAAc,EAAE,MAAM,CAAA;KAAE;IAmBxD,+BAA+B,CAAC,OAAO,EAAE,wBAAwB;IAWjE,2BAA2B,CAAC,OAAO,EAAE,8BAA8B;IAQzE;;;;;;;;;OASG;IACG,iCAAiC,CACrC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA8CzC,mBAAmB,CAAC,IAAI,EAAE,uBAAuB;IA2BvD;;;;;;OAMG;IACH,qBAAqB,CACnB,KAAK,EAAE,YAAY,EACnB,gBAAgB,EAAE,gBAAgB,GACjC,MAAM;IAuCT;;OAEG;IACH,yBAAyB;IAiBzB;;;;OAIG;IACG,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC;CAG5D"}

package/dist/SubscriptionController.d.mts

@@ -0,0 +1,124 @@
+import { BaseController, type ControllerStateChangeEvent, type ControllerGetStateAction, type RestrictedMessenger } from "@metamask/base-controller";
+import type { AuthenticationController } from "@metamask/profile-sync-controller";
+import { controllerName } from "./constants.mjs";
+import type { BillingPortalResponse, GetCryptoApproveTransactionRequest, GetCryptoApproveTransactionResponse, ProductPrice, StartCryptoSubscriptionRequest, TokenPaymentInfo, UpdatePaymentMethodOpts } from "./types.mjs";
+import { type ISubscriptionService, type PricingResponse, type ProductType, type StartSubscriptionRequest, type Subscription } from "./types.mjs";
+export type SubscriptionControllerState = {
+    customerId?: string;
+    trialedProducts: ProductType[];
+    subscriptions: Subscription[];
+    pricing?: PricingResponse;
+};
+export type SubscriptionControllerGetSubscriptionsAction = {
+    type: `${typeof controllerName}:getSubscriptions`;
+    handler: SubscriptionController['getSubscriptions'];
+};
+export type SubscriptionControllerCancelSubscriptionAction = {
+    type: `${typeof controllerName}:cancelSubscription`;
+    handler: SubscriptionController['cancelSubscription'];
+};
+export type SubscriptionControllerStartShieldSubscriptionWithCardAction = {
+    type: `${typeof controllerName}:startShieldSubscriptionWithCard`;
+    handler: SubscriptionController['startShieldSubscriptionWithCard'];
+};
+export type SubscriptionControllerGetPricingAction = {
+    type: `${typeof controllerName}:getPricing`;
+    handler: SubscriptionController['getPricing'];
+};
+export type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {
+    type: `${typeof controllerName}:getCryptoApproveTransactionParams`;
+    handler: SubscriptionController['getCryptoApproveTransactionParams'];
+};
+export type SubscriptionControllerStartSubscriptionWithCryptoAction = {
+    type: `${typeof controllerName}:startSubscriptionWithCrypto`;
+    handler: SubscriptionController['startSubscriptionWithCrypto'];
+};
+export type SubscriptionControllerUpdatePaymentMethodAction = {
+    type: `${typeof controllerName}:updatePaymentMethod`;
+    handler: SubscriptionController['updatePaymentMethod'];
+};
+export type SubscriptionControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SubscriptionControllerState>;
+export type SubscriptionControllerActions = SubscriptionControllerGetSubscriptionsAction | SubscriptionControllerCancelSubscriptionAction | SubscriptionControllerStartShieldSubscriptionWithCardAction | SubscriptionControllerGetPricingAction | SubscriptionControllerGetStateAction | SubscriptionControllerGetCryptoApproveTransactionParamsAction | SubscriptionControllerStartSubscriptionWithCryptoAction | SubscriptionControllerUpdatePaymentMethodAction;
+export type AllowedActions = AuthenticationController.AuthenticationControllerGetBearerToken | AuthenticationController.AuthenticationControllerPerformSignOut;
+export type SubscriptionControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SubscriptionControllerState>;
+export type SubscriptionControllerEvents = SubscriptionControllerStateChangeEvent;
+export type AllowedEvents = AuthenticationController.AuthenticationControllerStateChangeEvent;
+export type SubscriptionControllerMessenger = RestrictedMessenger<typeof controllerName, SubscriptionControllerActions | AllowedActions, SubscriptionControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Subscription Controller Options.
+ */
+export type SubscriptionControllerOptions = {
+    messenger: SubscriptionControllerMessenger;
+    /**
+     * Initial state to set on this controller.
+     */
+    state?: Partial<SubscriptionControllerState>;
+    /**
+     * Subscription service to use for the subscription controller.
+     */
+    subscriptionService: ISubscriptionService;
+};
+/**
+ * Get the default state for the Subscription Controller.
+ *
+ * @returns The default state for the Subscription Controller.
+ */
+export declare function getDefaultSubscriptionControllerState(): SubscriptionControllerState;
+export declare class SubscriptionController extends BaseController<typeof controllerName, SubscriptionControllerState, SubscriptionControllerMessenger> {
+    #private;
+    /**
+     * Creates a new SubscriptionController instance.
+     *
+     * @param options - The options for the SubscriptionController.
+     * @param options.messenger - A restricted messenger.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.subscriptionService - The subscription service for communicating with subscription server.
+     */
+    constructor({ messenger, state, subscriptionService, }: SubscriptionControllerOptions);
+    /**
+     * Gets the pricing information from the subscription service.
+     *
+     * @returns The pricing information.
+     */
+    getPricing(): Promise<PricingResponse>;
+    getSubscriptions(): Promise<Subscription[]>;
+    cancelSubscription(request: {
+        subscriptionId: string;
+    }): Promise<void>;
+    unCancelSubscription(request: {
+        subscriptionId: string;
+    }): Promise<void>;
+    startShieldSubscriptionWithCard(request: StartSubscriptionRequest): Promise<import("./types.mjs").StartSubscriptionResponse>;
+    startSubscriptionWithCrypto(request: StartCryptoSubscriptionRequest): Promise<import("./types.mjs").StartCryptoSubscriptionResponse>;
+    /**
+     * Get transaction params to create crypto approve transaction for subscription payment
+     *
+     * @param request - The request object
+     * @param request.chainId - The chain ID
+     * @param request.tokenAddress - The address of the token
+     * @param request.productType - The product type
+     * @param request.interval - The interval
+     * @returns The crypto approve transaction params
+     */
+    getCryptoApproveTransactionParams(request: GetCryptoApproveTransactionRequest): Promise<GetCryptoApproveTransactionResponse>;
+    updatePaymentMethod(opts: UpdatePaymentMethodOpts): Promise<void>;
+    /**
+     * Calculate token approve amount from price info
+     *
+     * @param price - The price info
+     * @param tokenPaymentInfo - The token price info
+     * @returns The token approve amount
+     */
+    getTokenApproveAmount(price: ProductPrice, tokenPaymentInfo: TokenPaymentInfo): string;
+    /**
+     * Triggers an access token refresh.
+     */
+    triggerAccessTokenRefresh(): void;
+    /**
+     * Gets the billing portal URL.
+     *
+     * @returns The billing portal URL
+     */
+    getBillingPortalUrl(): Promise<BillingPortalResponse>;
+}
+//# sourceMappingURL=SubscriptionController.d.mts.map