Feat/rwds 274 rewards controller

app/scripts/controller-init/controller-list.ts

@@ -94,6 +94,7 @@ import { MetaMetricsDataDeletionController } from '../controllers/metametrics-da
 import AppMetadataController from '../controllers/app-metadata';
 import DecryptMessageController from '../controllers/decrypt-message';
 import EncryptionPublicKeyController from '../controllers/encryption-public-key';
+import { RewardsController } from './rewards-controller-init';
 
 /**
  * Union of all controllers supporting or required by modular initialization.
@@ -153,6 +154,7 @@ export type Controller =
   | RateLimitController<RateLimitedApiMap>
   | RatesController
   | RemoteFeatureFlagController
+  | RewardsController
   | SeedlessOnboardingController<EncryptionKey>
   | SelectedNetworkController
   | ShieldController
@@ -231,6 +233,7 @@ export type ControllerFlatState = AccountOrderController['state'] &
   PreferencesController['state'] &
   RatesController['state'] &
   RemoteFeatureFlagController['state'] &
+  RewardsController['state'] &
   SeedlessOnboardingController<EncryptionKey>['state'] &
   SelectedNetworkController['state'] &
   ShieldController['state'] &

app/scripts/controller-init/messengers/index.ts

@@ -130,6 +130,10 @@ import {
   getRemoteFeatureFlagControllerInitMessenger,
   getRemoteFeatureFlagControllerMessenger,
 } from './remote-feature-flag-controller-messenger';
+import {
+  getRewardsControllerInitMessenger,
+  getRewardsControllerMessenger,
+} from './rewards-controller-messenger';
 import {
   getSwapsControllerInitMessenger,
   getSwapsControllerMessenger,
@@ -328,6 +332,8 @@ export {
 } from './signature-controller-messenger';
 export type { SubjectMetadataControllerMessenger } from './subject-metadata-controller-messenger';
 export { getSubjectMetadataControllerMessenger } from './subject-metadata-controller-messenger';
+export type { RewardsControllerMessenger } from './rewards-controller-messenger';
+export { getRewardsControllerMessenger } from './rewards-controller-messenger';
 export type {
   SwapsControllerMessenger,
   SwapsControllerInitMessenger,
@@ -618,6 +624,10 @@ export const CONTROLLER_MESSENGERS = {
     getMessenger: getSubscriptionServiceMessenger,
     getInitMessenger: noop,
   },
+  RewardsController: {
+    getMessenger: getRewardsControllerMessenger,
+    getInitMessenger: getRewardsControllerInitMessenger,
+  },
   SwapsController: {
     getMessenger: getSwapsControllerMessenger,
     getInitMessenger: getSwapsControllerInitMessenger,

app/scripts/controller-init/messengers/rewards-controller-messenger.ts

@@ -0,0 +1,127 @@
+import { Messenger, RestrictedMessenger } from '@metamask/base-controller';
+
+import {
+  KeyringControllerSignPersonalMessageAction,
+  KeyringControllerUnlockEvent,
+} from '@metamask/keyring-controller';
+
+import {
+  AccountsControllerGetSelectedMultichainAccountAction,
+  AccountsControllerSelectedAccountChangeEvent,
+  AccountsControllerListMultichainAccountsAction,
+} from '@metamask/accounts-controller';
+import { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';
+import {
+  RewardsDataServiceGetPointsEventsAction,
+  RewardsDataServiceGetPointsEventsLastUpdatedAction,
+  RewardsDataServiceGetOptInStatusAction,
+  RewardsDataServiceGetActivePointsBoostsAction,
+  RewardsDataServiceGetUnlockedRewardsAction,
+  RewardsDataServiceClaimRewardAction,
+  RewardsDataServiceGetPerpsDiscountAction,
+  RewardsDataServiceEstimatePointsAction,
+  RewardsDataServiceFetchGeoLocationAction,
+  RewardsDataServiceGetReferralDetailsAction,
+  RewardsDataServiceGetSeasonStatusAction,
+  RewardsDataServiceLoginAction,
+  RewardsDataServiceLogoutAction,
+  RewardsDataServiceMobileJoinAction,
+  RewardsDataServiceMobileOptinAction,
+  RewardsDataServiceOptOutAction,
+  RewardsDataServiceValidateReferralCodeAction,
+} from '../../controllers/rewards/rewards-data-service';
+import {
+  RewardsControllerActions,
+  RewardsControllerEvents,
+} from '../../controllers/rewards/rewards-controller.types';
+
+const name = 'RewardsController';
+
+// Don't reexport as per guidelines
+type AllowedActions =
+  | AccountsControllerGetSelectedMultichainAccountAction
+  | AccountsControllerListMultichainAccountsAction
+  | KeyringControllerSignPersonalMessageAction
+  | RewardsDataServiceLoginAction
+  | RewardsDataServiceGetPointsEventsAction
+  | RewardsDataServiceGetPointsEventsLastUpdatedAction
+  | RewardsDataServiceEstimatePointsAction
+  | RewardsDataServiceGetPerpsDiscountAction
+  | RewardsDataServiceGetSeasonStatusAction
+  | RewardsDataServiceGetReferralDetailsAction
+  | RewardsDataServiceMobileOptinAction
+  | RewardsDataServiceLogoutAction
+  | RewardsDataServiceFetchGeoLocationAction
+  | RewardsDataServiceValidateReferralCodeAction
+  | RewardsDataServiceMobileJoinAction
+  | RewardsDataServiceGetOptInStatusAction
+  | RewardsDataServiceOptOutAction
+  | RewardsDataServiceGetActivePointsBoostsAction
+  | RewardsDataServiceGetUnlockedRewardsAction
+  | RewardsDataServiceClaimRewardAction;
+
+// Don't reexport as per guidelines
+type AllowedEvents =
+  | AccountsControllerSelectedAccountChangeEvent
+  | KeyringControllerUnlockEvent;
+
+export type RewardsControllerMessenger = RestrictedMessenger<
+  typeof name,
+  RewardsControllerActions | AllowedActions,
+  RewardsControllerEvents | AllowedEvents,
+  AllowedActions['type'],
+  AllowedEvents['type'] // ← This was wrong!
+>;
+
+export function getRewardsControllerMessenger(
+  messenger: Messenger<
+    RewardsControllerActions | AllowedActions,
+    RewardsControllerEvents | AllowedEvents
+  >,
+): RewardsControllerMessenger {
+  return messenger.getRestricted({
+    name,
+    allowedActions: [
+      'AccountsController:getSelectedMultichainAccount',
+      'AccountsController:listMultichainAccounts',
+      'KeyringController:signPersonalMessage',
+      'RewardsDataService:login',
+      'RewardsDataService:getPointsEvents',
+      'RewardsDataService:getPointsEventsLastUpdated',
+      'RewardsDataService:estimatePoints',
+      'RewardsDataService:getPerpsDiscount',
+      'RewardsDataService:getSeasonStatus',
+      'RewardsDataService:getReferralDetails',
+      'RewardsDataService:mobileOptin',
+      'RewardsDataService:logout',
+      'RewardsDataService:fetchGeoLocation',
+      'RewardsDataService:validateReferralCode',
+      'RewardsDataService:mobileJoin',
+      'RewardsDataService:getOptInStatus',
+      'RewardsDataService:optOut',
+      'RewardsDataService:getActivePointsBoosts',
+      'RewardsDataService:getUnlockedRewards',
+      'RewardsDataService:claimReward',
+    ],
+    allowedEvents: [
+      'AccountsController:selectedAccountChange',
+      'KeyringController:unlock',
+    ],
+  });
+}
+
+type AllowedInitializationActions = RemoteFeatureFlagControllerGetStateAction;
+
+export type RewardsControllerInitMessenger = ReturnType<
+  typeof getRewardsControllerInitMessenger
+>;
+
+export function getRewardsControllerInitMessenger(
+  messenger: Messenger<AllowedInitializationActions, never>,
+) {
+  return messenger.getRestricted({
+    name: 'RewardsControllerInit',
+    allowedActions: ['RemoteFeatureFlagController:getState'],
+    allowedEvents: [],
+  });
+}

app/scripts/controller-init/rewards-controller-init.ts

@@ -0,0 +1,62 @@
+import {
+  defaultRewardsControllerState,
+  RewardsController,
+  RewardsControllerMessenger,
+} from '../controllers/rewards/rewards-controller';
+import { getManifestFlags } from '../../../shared/lib/manifestFlags';
+import {
+  validatedVersionGatedFeatureFlag,
+  VersionGatedFeatureFlag,
+} from '../../../shared/lib/feature-flags/version-gating';
+import { RewardsControllerInitMessenger } from './messengers/rewards-controller-messenger';
+import { ControllerInitFunction } from './types';
+
+/**
+ * Initialize the RewardsController.
+ *
+ * @param request - The request object.
+ * @returns The RewardsController.
+ */
+export const RewardsControllerInit: ControllerInitFunction<
+  RewardsController,
+  RewardsControllerMessenger,
+  RewardsControllerInitMessenger
+> = (request) => {
+  const { controllerMessenger, persistedState, initMessenger } = request;
+
+  const rewardsControllerState =
+    persistedState.RewardsController ?? defaultRewardsControllerState;
+
+  const { remoteFeatureFlags } = initMessenger.call(
+    'RemoteFeatureFlagController:getState',
+  );
+  const rewardsFeatureFlag = remoteFeatureFlags?.rewardsEnabled as
+    | VersionGatedFeatureFlag
+    | undefined;
+
+  // Seed with manifest override first; fallback to remote flag
+  const manifestFlag = getManifestFlags().remoteFeatureFlags?.rewardsEnabled;
+  const resolveFlag = (flag: unknown) => {
+    if (typeof flag === 'boolean') {
+      return flag;
+    }
+    return Boolean(
+      validatedVersionGatedFeatureFlag(flag as VersionGatedFeatureFlag),
+    );
+  };
+  const effectiveEnabled =
+    manifestFlag === undefined
+      ? resolveFlag(rewardsFeatureFlag)
+      : resolveFlag(manifestFlag);
+
+  const controller = new RewardsController({
+    messenger: controllerMessenger,
+    state: rewardsControllerState,
+    rewardsEnabled: effectiveEnabled,
+  });
+
+  return { controller };
+};
+
+export { RewardsController };
+export type { RewardsControllerMessenger };