feat: mobile push notifications

.android.env.example

@@ -1,16 +1,4 @@
 export MM_FOX_CODE="EXAMPLE_FOX_CODE"
 export MM_BRANCH_KEY_TEST=
 export MM_BRANCH_KEY_LIVE=
-export METAMASK_BUILD_TYPE=
-# Firebase
-export FCM_CONFIG_API_KEY=
-export FCM_CONFIG_AUTH_DOMAIN=
-export FCM_CONFIG_PROJECT_ID=
-export FCM_CONFIG_STORAGE_BUCKET=
-export FCM_CONFIG_MESSAGING_SENDER_ID=
-export FCM_CONFIG_APP_ID=
-export GOOGLE_SERVICES_B64_ANDROID=
-#Notifications Feature Announcements
-export FEATURES_ANNOUNCEMENTS_ACCESS_TOKEN=
-export FEATURES_ANNOUNCEMENTS_SPACE_ID=
-
+export METAMASK_BUILD_TYPE=

.ios.env.example

@@ -1,14 +1,3 @@
 MM_FOX_CODE = EXAMPLE_FOX_CODE
 MM_BRANCH_KEY_TEST =
 MM_BRANCH_KEY_LIVE =
-# Firebase
-FCM_CONFIG_API_KEY=
-FCM_CONFIG_AUTH_DOMAIN=
-FCM_CONFIG_PROJECT_ID=
-FCM_CONFIG_STORAGE_BUCKET=
-FCM_CONFIG_MESSAGING_SENDER_ID=
-FCM_CONFIG_APP_ID=
-GOOGLE_SERVICES_B64_IOS=
-#Notifications Feature Announcements
-FEATURES_ANNOUNCEMENTS_ACCESS_TOKEN=
-FEATURES_ANNOUNCEMENTS_SPACE_ID=

.js.env.example

@@ -76,12 +76,6 @@ export PORTFOLIO_VIEW="true"
 # Temporary mechanism to enable security alerts API prior to release.
 export MM_SECURITY_ALERTS_API_ENABLED="true"
 # Firebase
-export FCM_CONFIG_API_KEY=""
-export FCM_CONFIG_AUTH_DOMAIN=""
-export FCM_CONFIG_PROJECT_ID=""
-export FCM_CONFIG_STORAGE_BUCKET=""
-export FCM_CONFIG_MESSAGING_SENDER_ID=""
-export FCM_CONFIG_APP_ID=""
 export GOOGLE_SERVICES_B64_ANDROID=""
 export GOOGLE_SERVICES_B64_IOS=""
 # Notifications Feature Announcements

app/components/Nav/Main/index.js

@@ -69,7 +69,6 @@ import {
 } from '../../../selectors/networkInfos';
 import { selectShowIncomingTransactionNetworks } from '../../../selectors/preferencesController';
 
-import useNotificationHandler from '../../../util/notifications/hooks';
 import {
   DEPRECATED_NETWORKS,
   NETWORKS_CHAIN_ID,
@@ -115,7 +114,6 @@ const Main = (props) => {
   const { connectionChangeHandler } = useConnectionHandler(props.navigation);
 
   const removeNotVisibleNotifications = props.removeNotVisibleNotifications;
-  useNotificationHandler(props.navigation);
   useEnableAutomaticSecurityChecks();
   useMinimumVersions();
 

app/components/UI/Notification/BaseNotification/index.js

@@ -148,8 +148,6 @@ const getTitle = (status, { nonce, amount, assetType }) => {
       return strings('notifications.cancelled_title');
     case 'error':
       return strings('notifications.error_title');
-    case 'eth_received':
-      return strings('notifications.eth_received_title');
   }
 };
 

app/core/Analytics/MetaMetrics.events.ts

@@ -384,6 +384,8 @@ enum EVENT_NAME {
   NOTIFICATIONS_MARKED_ALL_AS_READ = 'Notifications Marked All as Read',
   NOTIFICATION_DETAIL_CLICKED = 'Notification Detail Clicked',
   NOTIFICATION_STORAGE_KEY_DELETED = 'Notification Storage Key Deleted',
+  PUSH_NOTIFICATIONS_RECEIVED = 'Push Notification Received',
+  PUSH_NOTIFICATIONS_CLICKED = 'Push Notification Clicked',
 
   // Smart transactions
   SMART_TRANSACTION_OPT_IN = 'Smart Transaction Opt In',
@@ -879,6 +881,12 @@ const events = {
   NOTIFICATION_STORAGE_KEY_DELETED: generateOpt(
     EVENT_NAME.NOTIFICATION_STORAGE_KEY_DELETED,
   ),
+  PUSH_NOTIFICATIONS_RECEIVED: generateOpt(
+    EVENT_NAME.PUSH_NOTIFICATIONS_RECEIVED,
+  ),
+  PUSH_NOTIFICATIONS_CLICKED: generateOpt(
+    EVENT_NAME.PUSH_NOTIFICATIONS_CLICKED,
+  ),
   // Simulations
   INCOMPLETE_ASSET_DISPLAYED: generateOpt(
     EVENT_NAME.INCOMPLETE_ASSET_DISPLAYED,

app/core/Engine/Engine.ts

@@ -120,10 +120,17 @@ import {
   AuthenticationController,
   UserStorageController,
 } from '@metamask/profile-sync-controller';
+import NotificationServicesController, {
+  type NotificationServicesControllerMessenger,
+} from '@metamask/notification-services-controller/notification-services';
+import NotificationServicesPushController, {
+  type NotificationServicesPushControllerMessenger,
+} from '@metamask/notification-services-controller/push-services';
 import {
-  NotificationServicesController,
-  NotificationServicesPushController,
-} from '@metamask/notification-services-controller';
+  createRegToken,
+  deleteRegToken,
+  createSubscribeToPushNotifications,
+} from './controllers/PushNotificationController/utils';
 ///: END:ONLY_INCLUDE_IF
 import {
   getCaveatSpecifications,
@@ -1062,50 +1069,15 @@ export class Engine {
       nativeScryptCrypto: scrypt,
     });
 
-    const notificationServicesController =
-      new NotificationServicesController.Controller({
-        messenger: this.controllerMessenger.getRestricted({
-          name: 'NotificationServicesController',
-          allowedActions: [
-            'KeyringController:getState',
-            'KeyringController:getAccounts',
-            'AuthenticationController:getBearerToken',
-            'AuthenticationController:isSignedIn',
-            'UserStorageController:enableProfileSyncing',
-            'UserStorageController:getStorageKey',
-            'UserStorageController:performGetStorage',
-            'UserStorageController:performSetStorage',
-            'NotificationServicesPushController:enablePushNotifications',
-            'NotificationServicesPushController:disablePushNotifications',
-            'NotificationServicesPushController:updateTriggerPushNotifications',
-          ],
-          allowedEvents: [
-            'KeyringController:unlock',
-            'KeyringController:lock',
-            'KeyringController:stateChange',
-          ],
-        }),
-        state: initialState.NotificationServicesController,
-        env: {
-          isPushIntegrated: false,
-          featureAnnouncements: {
-            platform: 'mobile',
-            accessToken: process.env
-              .FEATURES_ANNOUNCEMENTS_ACCESS_TOKEN as string,
-            spaceId: process.env.FEATURES_ANNOUNCEMENTS_SPACE_ID as string,
-          },
-        },
-      });
-
     const notificationServicesPushControllerMessenger =
       this.controllerMessenger.getRestricted({
         name: 'NotificationServicesPushController',
         allowedActions: ['AuthenticationController:getBearerToken'],
         allowedEvents: [],
-      });
+      }) as unknown as NotificationServicesPushControllerMessenger;
 
     const notificationServicesPushController =
-      new NotificationServicesPushController.Controller({
+      new NotificationServicesPushController({
         messenger: notificationServicesPushControllerMessenger,
         state: initialState.NotificationServicesPushController || {
           fcmToken: '',
@@ -1123,11 +1095,84 @@ export class Engine {
         config: {
           isPushEnabled: true,
           platform: 'mobile',
-          // TODO: Implement optionability for push notification handlers (depending of the platform) on the NotificationServicesPushController.
-          onPushNotificationReceived: () => Promise.resolve(undefined),
-          onPushNotificationClicked: () => Promise.resolve(undefined),
+          pushService: {
+            createRegToken,
+            deleteRegToken,
+            subscribeToPushNotifications: createSubscribeToPushNotifications({
+              messenger: notificationServicesPushControllerMessenger,
+            }),
+          },
         },
       });
+
+    notificationServicesPushControllerMessenger.subscribe(
+      'NotificationServicesPushController:onNewNotifications',
+      (notification) => {
+        MetaMetrics.getInstance().trackEvent(
+          MetricsEventBuilder.createEventBuilder(
+            MetaMetricsEvents.PUSH_NOTIFICATIONS_RECEIVED,
+          )
+            .addProperties({
+              notification_id: notification.id,
+              notification_type: notification.type,
+              chain_id:
+                'chain_id' in notification ? notification.chain_id : undefined,
+            })
+            .build(),
+        );
+      },
+    );
+    notificationServicesPushControllerMessenger.subscribe(
+      'NotificationServicesPushController:pushNotificationClicked',
+      (notification) => {
+        MetaMetrics.getInstance().trackEvent(
+          MetricsEventBuilder.createEventBuilder(
+            MetaMetricsEvents.PUSH_NOTIFICATIONS_CLICKED,
+          )
+            .addProperties({
+              notification_id: notification.id,
+              notification_type: notification.type,
+              chain_id:
+                'chain_id' in notification ? notification.chain_id : undefined,
+            })
+            .build(),
+        );
+      },
+    );
+
+    const notificationServicesController = new NotificationServicesController({
+      messenger: this.controllerMessenger.getRestricted({
+        name: 'NotificationServicesController',
+        allowedActions: [
+          'KeyringController:getState',
+          'KeyringController:getAccounts',
+          'AuthenticationController:getBearerToken',
+          'AuthenticationController:isSignedIn',
+          'UserStorageController:enableProfileSyncing',
+          'UserStorageController:getStorageKey',
+          'UserStorageController:performGetStorage',
+          'UserStorageController:performSetStorage',
+          'NotificationServicesPushController:enablePushNotifications',
+          'NotificationServicesPushController:disablePushNotifications',
+          'NotificationServicesPushController:updateTriggerPushNotifications',
+        ],
+        allowedEvents: [
+          'KeyringController:unlock',
+          'KeyringController:lock',
+          'KeyringController:stateChange',
+        ],
+      }) as unknown as NotificationServicesControllerMessenger,
+      state: initialState.NotificationServicesController,
+      env: {
+        isPushIntegrated: false,
+        featureAnnouncements: {
+          platform: 'mobile',
+          accessToken: process.env
+            .FEATURES_ANNOUNCEMENTS_ACCESS_TOKEN as string,
+          spaceId: process.env.FEATURES_ANNOUNCEMENTS_SPACE_ID as string,
+        },
+      },
+    });
     ///: END:ONLY_INCLUDE_IF
 
     this.transactionController = new TransactionController({

app/core/Engine/controllers/PushNotificationController/get-notification-message.ts

@@ -0,0 +1,97 @@
+import {
+  type TranslationKeys,
+  createOnChainPushNotificationMessage,
+} from '@metamask/notification-services-controller/push-services';
+import type { INotification } from '@metamask/notification-services-controller/notification-services';
+import { strings } from '../../../../../locales/i18n';
+import type Translations from '../../../../../locales/languages/en.json';
+
+type NotificationTranslations = (typeof Translations)['notifications'];
+type FlattenToString<TObj> = {
+  [K in keyof TObj]: TObj[K] extends string
+    ? `${K & string}`
+    : `${K & string}.${FlattenToString<TObj[K]>}`;
+}[keyof TObj];
+
+type NotificationStrings =
+  `notifications.${FlattenToString<NotificationTranslations>}`;
+
+const t = (name: NotificationStrings, params?: object) =>
+  strings(name, params) ?? '';
+
+const translations: TranslationKeys = {
+  pushPlatformNotificationsFundsSentTitle: () =>
+    t('notifications.push_notification_content.funds_sent_title'),
+  pushPlatformNotificationsFundsSentDescriptionDefault: () =>
+    t('notifications.push_notification_content.funds_sent_default_description'),
+  pushPlatformNotificationsFundsSentDescription: (amount, symbol) =>
+    t('notifications.push_notification_content.funds_sent_description', {
+      amount,
+      symbol,
+    }),
+  pushPlatformNotificationsFundsReceivedTitle: () =>
+    t('notifications.push_notification_content.funds_received_title'),
+  pushPlatformNotificationsFundsReceivedDescriptionDefault: () =>
+    t(
+      'notifications.push_notification_content.funds_received_default_description',
+    ),
+  pushPlatformNotificationsFundsReceivedDescription: (amount, symbol) =>
+    t('notifications.push_notification_content.funds_received_description', {
+      amount,
+      symbol,
+    }),
+  pushPlatformNotificationsSwapCompletedTitle: () =>
+    t('notifications.metamask_swap_completed_title'),
+  pushPlatformNotificationsSwapCompletedDescription: () =>
+    t(
+      'notifications.push_notification_content.metamask_swap_completed_description',
+    ),
+  pushPlatformNotificationsNftSentTitle: () =>
+    t('notifications.push_notification_content.nft_sent_title'),
+  pushPlatformNotificationsNftSentDescription: () =>
+    t('notifications.push_notification_content.nft_sent_description'),
+  pushPlatformNotificationsNftReceivedTitle: () =>
+    t('notifications.push_notification_content.nft_received_title'),
+  pushPlatformNotificationsNftReceivedDescription: () =>
+    t('notifications.push_notification_content.nft_received_description'),
+  pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle: () =>
+    t('notifications.rocketpool_stake_completed_title'),
+  pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription: () =>
+    t(
+      'notifications.push_notification_content.rocketpool_stake_completed_description',
+    ),
+  pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle: () =>
+    t('notifications.rocketpool_unstake_completed_title'),
+  pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription: () =>
+    t(
+      'notifications.push_notification_content.rocketpool_unstake_completed_description',
+    ),
+  pushPlatformNotificationsStakingLidoStakeCompletedTitle: () =>
+    t('notifications.lido_stake_completed_title'),
+  pushPlatformNotificationsStakingLidoStakeCompletedDescription: () =>
+    t(
+      'notifications.push_notification_content.lido_stake_completed_description',
+    ),
+  pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle: () =>
+    t('notifications.lido_stake_ready_to_be_withdrawn_title'),
+  pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription: () =>
+    t(
+      'notifications.push_notification_content.lido_stake_ready_to_be_withdrawn_description',
+    ),
+  pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle: () =>
+    t('notifications.lido_withdrawal_requested_title'),
+  pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription: () =>
+    t(
+      'notifications.push_notification_content.lido_withdrawal_requested_description',
+    ),
+  pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle: () =>
+    t('notifications.lido_withdrawal_completed_title'),
+  pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription: () =>
+    t(
+      'notifications.push_notification_content.lido_withdrawal_completed_description',
+    ),
+};
+
+export function createNotificationMessage(notification: INotification) {
+  return createOnChainPushNotificationMessage(notification, translations);
+}