feat: link rewards to shield subscription (#38489)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

This PR allows rewards opted in users to claim points from shield
subscription.

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/38489?quickstart=1)

## **Changelog**

<!--
If this PR is not End-User-Facing and should not show up in the
CHANGELOG, you can choose to either:
1. Write `CHANGELOG entry: null`
2. Label with `no-changelog`

If this PR is End-User-Facing, please write a short User-Facing
description in the past tense like:
`CHANGELOG entry: Added a new tab for users to see their NFTs`
`CHANGELOG entry: Fixed a bug that was causing some NFTs to flicker`

(This helps the Release Engineer do their job more quickly and
accurately)
-->

CHANGELOG entry: link/claims rewards points from shield subscription

## **Related issues**

Fixes: #38038

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [x] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [x] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.



<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Integrates rewards with Shield subscriptions and shifts
crypto-approval post-transaction handling into `SubscriptionService`,
adding post-tx cohort assignment, UI hooks, and tests.
> 
> - **Subscription Service**:
> - Adds rewards integration: resolves primary `rewardAccountId` (CAIP),
links rewards to existing Shield (`linkRewardToExistingSubscription`).
> - Handles Shield crypto approval post-tx in `handlePostTransaction`
(incl. gas sponsorship check) and tracks events.
> - Assigns post-tx Shield cohort via
`AppStateController:setPendingShieldCohort` and emits metrics.
>   - New helpers: primary CAIP account lookup, season/opt-in checks.
> - **Controllers/Messaging**:
> - `metamask-controller`: delegate
`TransactionController:transactionSubmitted` to
`subscriptionService.handlePostTransaction`; remove legacy internal
approval handler; expose `linkRewardToShieldSubscription`.
> - `AppStateController`: add `setPendingShieldCohort` action and
handler.
> - Subscription service messenger/types: add actions
`submitShieldSubscriptionCryptoApproval`, `linkRewards`, rewards
getters, and new AppState action.
> - **UI**:
>   - Remove `startSubscriptionWithCrypto` thunk.
>   - Add `linkRewardToShieldSubscription` thunk.
> - **Tests**:
> - Unit tests for reward ID inclusion on card flow, post-tx handling,
and reward linking conditions.
> - **Dependencies/Config**:
> - Bump `@metamask/subscription-controller` to `^5.3.1` (and related
lockfile updates).
>   - Privacy: allow `rewards.uat-api.cx.metamask.io`.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
5b9bc4e. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: MetaMask Bot <[email protected]>
Co-authored-by: Chaitanya Potti <[email protected]>

Author: 3 people

app/scripts/controller-init/messengers/subscription/subscription-service-messenger.ts

@@ -40,7 +40,10 @@ export function getSubscriptionServiceMessenger(
       'SubscriptionController:getBillingPortalUrl',
       'SubscriptionController:submitSponsorshipIntents',
       'SubscriptionController:getState',
+      'SubscriptionController:submitShieldSubscriptionCryptoApproval',
+      'SubscriptionController:linkRewards',
       'AppStateController:getState',
+      'AppStateController:setPendingShieldCohort',
       'AuthenticationController:getBearerToken',
       'TransactionController:getTransactions',
       'AccountsController:getState',
@@ -50,6 +53,10 @@ export function getSubscriptionServiceMessenger(
       'SwapsController:getState',
       'MetaMetricsController:trackEvent',
       'KeyringController:getState',
+      // Rewards Integration
+      'RewardsController:getSeasonStatus',
+      'RewardsController:getSeasonMetadata',
+      'RewardsController:getHasAccountOptedIn',
     ],
   });
   return serviceMessenger;

app/scripts/controllers/app-state-controller.ts

@@ -192,14 +192,20 @@ export type AppStateControllerSetCanTrackWalletFundsObtainedAction = {
   handler: AppStateController['setCanTrackWalletFundsObtained'];
 };
 
+export type AppStateControllerSetPendingShieldCohortAction = {
+  type: 'AppStateController:setPendingShieldCohort';
+  handler: AppStateController['setPendingShieldCohort'];
+};
+
 /**
  * Actions exposed by the {@link AppStateController}.
  */
 export type AppStateControllerActions =
   | AppStateControllerGetStateAction
   | AppStateControllerGetUnlockPromiseAction
   | AppStateControllerRequestQrCodeScanAction
-  | AppStateControllerSetCanTrackWalletFundsObtainedAction;
+  | AppStateControllerSetCanTrackWalletFundsObtainedAction
+  | AppStateControllerSetPendingShieldCohortAction;
 
 /**
  * Actions that this controller is allowed to call.
@@ -778,6 +784,11 @@ export class AppStateController extends BaseController<
       this.setCanTrackWalletFundsObtained.bind(this),
     );
 
+    this.messenger.registerActionHandler(
+      'AppStateController:setPendingShieldCohort',
+      this.setPendingShieldCohort.bind(this),
+    );
+
     this.#approvalRequestId = null;
   }
 

app/scripts/metamask-controller.js

@@ -129,7 +129,7 @@ import {
   SecretType,
   RecoveryError,
 } from '@metamask/seedless-onboarding-controller';
-import { COHORT_NAMES, PRODUCT_TYPES } from '@metamask/subscription-controller';
+import { PRODUCT_TYPES } from '@metamask/subscription-controller';
 import { isSnapId } from '@metamask/snaps-utils';
 import {
   findAtomicBatchSupportForChain,
@@ -916,11 +916,11 @@ export default class MetamaskController extends EventEmitter {
     this.controllerMessenger.subscribe(
       'TransactionController:transactionSubmitted',
       ({ transactionMeta }) => {
-        this._onShieldSubscriptionApprovalTransaction(transactionMeta).catch(
-          (err) => {
+        this.subscriptionService
+          .handlePostTransaction(transactionMeta)
+          .catch((err) => {
             console.error('Error onShieldSubscriptionApprovalTransaction', err);
-          },
-        );
+          });
       },
     );
 
@@ -2618,10 +2618,6 @@ export default class MetamaskController extends EventEmitter {
         this.subscriptionService.updateSubscriptionCardPaymentMethod.bind(
           this.subscriptionService,
         ),
-      startSubscriptionWithCrypto:
-        this.subscriptionController.startSubscriptionWithCrypto.bind(
-          this.subscriptionController,
-        ),
       updateSubscriptionCryptoPaymentMethod:
         this.subscriptionService.updateSubscriptionCryptoPaymentMethod.bind(
           this.subscriptionService,
@@ -2630,6 +2626,10 @@ export default class MetamaskController extends EventEmitter {
         this.subscriptionController.submitUserEvent.bind(
           this.subscriptionController,
         ),
+      linkRewardToShieldSubscription:
+        this.subscriptionService.linkRewardToExistingSubscription.bind(
+          this.subscriptionService,
+        ),
 
       // rewards
       getRewardsCandidateSubscriptionId:
@@ -8658,66 +8658,6 @@ export default class MetamaskController extends EventEmitter {
     });
   }
 
-  /**
-   * Handles the shield subscription approval transaction after confirm
-   * NOTE: This doesn't subscribe to messenger internally inside controller because we need more info from the client as params
-   *
-   * @param transactionMeta - The transaction metadata.
-   */
-  async _onShieldSubscriptionApprovalTransaction(transactionMeta) {
-    const { isGasFeeSponsored, chainId } = transactionMeta;
-    const bundlerSupported = await isSendBundleSupported(chainId);
-    const isSponsored = isGasFeeSponsored && bundlerSupported;
-
-    try {
-      this.subscriptionService.trackSubscriptionRequestEvent(
-        'started',
-        transactionMeta,
-        {
-          has_sufficient_crypto_balance: true,
-        },
-      );
-
-      await this.subscriptionController.submitShieldSubscriptionCryptoApproval(
-        transactionMeta,
-        isSponsored,
-      );
-
-      // Mark send/transfer/swap transactions for Shield post_tx cohort evaluation
-      const isPostTxTransaction = [
-        TransactionType.simpleSend,
-        TransactionType.tokenMethodTransfer,
-        TransactionType.swap,
-        TransactionType.swapAndSend,
-      ].includes(transactionMeta.type);
-
-      const { pendingShieldCohort } = this.appStateController.state;
-      if (isPostTxTransaction && !pendingShieldCohort) {
-        this.appStateController.setPendingShieldCohort(
-          COHORT_NAMES.POST_TX,
-          transactionMeta.type,
-        );
-      }
-      this.subscriptionService.trackSubscriptionRequestEvent(
-        'completed',
-        transactionMeta,
-        {
-          gas_sponsored: isSponsored,
-        },
-      );
-    } catch (error) {
-      log.error('Error on Shield subscription approval transaction', error);
-      this.subscriptionService.trackSubscriptionRequestEvent(
-        'failed',
-        transactionMeta,
-        {
-          error_message: error.message,
-        },
-      );
-      throw error;
-    }
-  }
-
   /**
    * @deprecated
    * Controllers should subscribe to messenger events internally rather than relying on the client.