@metamask-previews/notification-services-controller 10.0.0-preview-7dcef379 → 10.0.0-preview-f9611039

package/dist/NotificationServicesController/services/onchain-notifications.cjs

@@ -3,97 +3,165 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.markNotificationsAsRead = exports.getOnChainNotifications = exports.updateOnChainNotifications = exports.getOnChainNotificationsConfigCached = exports.NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = exports.NOTIFICATION_API_LIST_ENDPOINT = exports.TRIGGER_API_NOTIFICATIONS_ENDPOINT = exports.TRIGGER_API_NOTIFICATIONS_QUERY_ENDPOINT = exports.NOTIFICATION_API = exports.TRIGGER_API = void 0;
+exports.markNotificationsAsRead = exports.getOnChainNotifications = exports.deleteOnChainTriggers = exports.createOnChainTriggers = exports.NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = exports.NOTIFICATION_API_LIST_ENDPOINT_PAGE_QUERY = exports.NOTIFICATION_API_LIST_ENDPOINT = exports.TRIGGER_API_BATCH_ENDPOINT = exports.NOTIFICATION_API = exports.TRIGGER_API = void 0;
+const profile_sync_controller_1 = require("@metamask/profile-sync-controller");
 const loglevel_1 = __importDefault(require("loglevel"));
-const notification_config_cache_1 = require("./notification-config-cache.cjs");
 const to_raw_notification_1 = require("../../shared/to-raw-notification.cjs");
 const utils_1 = require("../utils/utils.cjs");
 exports.TRIGGER_API = 'https://trigger.api.cx.metamask.io';
 exports.NOTIFICATION_API = 'https://notification.api.cx.metamask.io';
-// Gets notification settings for each account provided
-exports.TRIGGER_API_NOTIFICATIONS_QUERY_ENDPOINT = `${exports.TRIGGER_API}/api/v2/notifications/query`;
-// Used to create/update account notifications for each account provided
-exports.TRIGGER_API_NOTIFICATIONS_ENDPOINT = `${exports.TRIGGER_API}/api/v2/notifications`;
-// Lists notifications for each account provided
-exports.NOTIFICATION_API_LIST_ENDPOINT = `${exports.NOTIFICATION_API}/api/v2/notifications`;
-// Makrs notifications as read
-exports.NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = `${exports.NOTIFICATION_API}/api/v2/notifications/mark-as-read`;
+exports.TRIGGER_API_BATCH_ENDPOINT = `${exports.TRIGGER_API}/api/v1/triggers/batch`;
+exports.NOTIFICATION_API_LIST_ENDPOINT = `${exports.NOTIFICATION_API}/api/v1/notifications`;
+const NOTIFICATION_API_LIST_ENDPOINT_PAGE_QUERY = (page) => `${exports.NOTIFICATION_API_LIST_ENDPOINT}?page=${page}&per_page=100`;
+exports.NOTIFICATION_API_LIST_ENDPOINT_PAGE_QUERY = NOTIFICATION_API_LIST_ENDPOINT_PAGE_QUERY;
+exports.NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = `${exports.NOTIFICATION_API}/api/v1/notifications/mark-as-read`;
 /**
- * fetches notification config (accounts enabled vs disabled)
+ * Creates on-chain triggers based on the provided notification triggers.
+ * This method generates a unique token for each trigger using the trigger ID and storage key,
+ * proving ownership of the trigger being updated. It then makes an API call to create these triggers.
+ * Upon successful creation, it updates the userStorage to reflect the new trigger status.
  *
- * @param bearerToken - jwt
- * @param addresses - list of addresses to check
- * NOTE the API will return addresses config with false if they have not been created before.
- * NOTE this is cached for 1s to prevent multiple update calls
- * @returns object of notification config, or null if missing
+ * @param userStorage - The user's storage object where triggers and their statuses are stored.
+ * @param storageKey - A key used along with the trigger ID to generate a unique token for each trigger.
+ * @param bearerToken - The JSON Web Token used for authentication in the API call.
+ * @param triggers - An array of notification triggers to be created. Each trigger includes an ID, chain ID, kind, and address.
+ * @returns A promise that resolves to void. Throws an error if the API call fails or if there's an issue creating the triggers.
  */
-async function getOnChainNotificationsConfigCached(bearerToken, addresses) {
-    if (addresses.length === 0) {
-        return [];
+async function createOnChainTriggers(userStorage, storageKey, bearerToken, triggers) {
+    const triggersToCreate = triggers.map((t) => ({
+        id: t.id,
+        token: profile_sync_controller_1.UserStorageController.createSHA256Hash(t.id + storageKey),
+        config: {
+            kind: t.kind,
+            chain_id: Number(t.chainId),
+            address: t.address,
+        },
+    }));
+    if (triggersToCreate.length === 0) {
+        return;
     }
-    addresses = addresses.map((a) => a.toLowerCase());
-    const cached = notification_config_cache_1.notificationsConfigCache.get(addresses);
-    if (cached) {
-        return cached;
+    const response = await (0, utils_1.makeApiCall)(bearerToken, exports.TRIGGER_API_BATCH_ENDPOINT, 'POST', triggersToCreate);
+    if (!response.ok) {
+        const errorData = await response.json().catch(() => undefined);
+        loglevel_1.default.error('Error creating triggers:', errorData);
+        throw new Error('OnChain Notifications - unable to create triggers');
     }
-    const body = addresses.map((address) => ({ address }));
-    const data = await (0, utils_1.makeApiCall)(bearerToken, exports.TRIGGER_API_NOTIFICATIONS_QUERY_ENDPOINT, 'POST', body)
-        .then((r) => (r.ok ? r.json() : null))
-        .catch(() => null);
-    const result = data ?? [];
-    if (result.length > 0) {
-        notification_config_cache_1.notificationsConfigCache.set(result);
+    // If the trigger creation was fine
+    // then update the userStorage
+    for (const trigger of triggersToCreate) {
+        (0, utils_1.toggleUserStorageTriggerStatus)(userStorage, trigger.config.address, String(trigger.config.chain_id), trigger.id, true);
     }
-    return result;
+    (0, utils_1.cleanUserStorage)(userStorage);
 }
-exports.getOnChainNotificationsConfigCached = getOnChainNotificationsConfigCached;
+exports.createOnChainTriggers = createOnChainTriggers;
 /**
- * updates notifications for a given addresses
+ * Deletes on-chain triggers based on the provided UUIDs.
+ * This method generates a unique token for each trigger using the UUID and storage key,
+ * proving ownership of the trigger being deleted. It then makes an API call to delete these triggers.
+ * Upon successful deletion, it updates the userStorage to remove the deleted trigger statuses.
  *
- * @param bearerToken - jwt
- * @param addresses - list of addresses to check
- * @returns void
+ * @param userStorage - The user's storage object where triggers and their statuses are stored.
+ * @param storageKey - A key used along with the UUID to generate a unique token for each trigger.
+ * @param bearerToken - The JSON Web Token used for authentication in the API call.
+ * @param uuids - An array of UUIDs representing the triggers to be deleted.
+ * @returns A promise that resolves to the updated UserStorage object. Throws an error if the API call fails or if there's an issue deleting the triggers.
  */
-async function updateOnChainNotifications(bearerToken, addresses) {
-    if (addresses.length === 0) {
-        return;
+async function deleteOnChainTriggers(userStorage, storageKey, bearerToken, uuids) {
+    const triggersToDelete = uuids.map((uuid) => ({
+        id: uuid,
+        token: profile_sync_controller_1.UserStorageController.createSHA256Hash(uuid + storageKey),
+    }));
+    try {
+        const response = await (0, utils_1.makeApiCall)(bearerToken, exports.TRIGGER_API_BATCH_ENDPOINT, 'DELETE', triggersToDelete);
+        if (!response.ok) {
+            throw new Error(`Failed to delete on-chain notifications for uuids ${uuids.join(', ')}`);
+        }
+        // Update the state of the deleted trigger to false
+        for (const uuid of uuids) {
+            for (const address in userStorage) {
+                if (address in userStorage) {
+                    for (const chainId in userStorage[address]) {
+                        if (userStorage?.[address]?.[chainId]?.[uuid]) {
+                            delete userStorage[address][chainId][uuid];
+                        }
+                    }
+                }
+            }
+        }
+        // Follow-up cleanup, if an address had no triggers whatsoever, then we can delete the address
+        const isEmpty = (obj = {}) => Object.keys(obj).length === 0;
+        for (const address in userStorage) {
+            if (address in userStorage) {
+                for (const chainId in userStorage[address]) {
+                    // Chain isEmpty Check
+                    if (isEmpty(userStorage?.[address]?.[chainId])) {
+                        delete userStorage[address][chainId];
+                    }
+                }
+                // Address isEmpty Check
+                if (isEmpty(userStorage?.[address])) {
+                    delete userStorage[address];
+                }
+            }
+        }
     }
-    addresses = addresses.map((a) => {
-        a.address = a.address.toLowerCase();
-        return a;
-    });
-    const body = addresses;
-    await (0, utils_1.makeApiCall)(bearerToken, exports.TRIGGER_API_NOTIFICATIONS_ENDPOINT, 'POST', body)
-        .then(() => notification_config_cache_1.notificationsConfigCache.replace(addresses))
-        .catch(() => null);
+    catch (err) {
+        loglevel_1.default.error(`Error deleting on-chain notifications for uuids ${uuids.join(', ')}:`, err);
+        throw err;
+    }
+    return userStorage;
 }
-exports.updateOnChainNotifications = updateOnChainNotifications;
+exports.deleteOnChainTriggers = deleteOnChainTriggers;
 /**
- * Fetches on-chain notifications for the given addresses
+ * Fetches on-chain notifications for the given user storage and BearerToken.
+ * This method iterates through the userStorage to find enabled triggers and fetches notifications for those triggers.
+ * It makes paginated API calls to the notifications service, transforming and aggregating the notifications into a single array.
+ * The process stops either when all pages have been fetched or when a page has less than 100 notifications, indicating the end of the data.
  *
+ * @param userStorage - The user's storage object containing trigger information.
  * @param bearerToken - The JSON Web Token used for authentication in the API call.
- * @param addresses - List of addresses
  * @returns A promise that resolves to an array of OnChainRawNotification objects. If no triggers are enabled or an error occurs, it may return an empty array.
  */
-async function getOnChainNotifications(bearerToken, addresses) {
-    if (addresses.length === 0) {
+async function getOnChainNotifications(userStorage, bearerToken) {
+    const triggerIds = (0, utils_1.traverseUserStorageTriggers)(userStorage, {
+        mapTrigger: (t) => {
+            if (!t.enabled) {
+                return undefined;
+            }
+            return t.id;
+        },
+    });
+    if (triggerIds.length === 0) {
         return [];
     }
-    addresses = addresses.map((a) => a.toLowerCase());
-    const body = addresses.map((address) => ({ address }));
-    const notifications = await (0, utils_1.makeApiCall)(bearerToken, exports.NOTIFICATION_API_LIST_ENDPOINT, 'POST', body)
-        .then((r) => r.ok ? r.json() : null)
-        .catch(() => null);
-    // Transform and sort notifications
-    const transformedNotifications = notifications
-        ?.map((n) => {
-        if (!n.data?.kind) {
-            return undefined;
+    const onChainNotifications = [];
+    const PAGE_LIMIT = 2;
+    for (let page = 1; page <= PAGE_LIMIT; page++) {
+        try {
+            const response = await (0, utils_1.makeApiCall)(bearerToken, (0, exports.NOTIFICATION_API_LIST_ENDPOINT_PAGE_QUERY)(page), 'POST', { trigger_ids: triggerIds });
+            const notifications = (await response.json());
+            // Transform and sort notifications
+            const transformedNotifications = notifications
+                .map((n) => {
+                if (!n.data?.kind) {
+                    return undefined;
+                }
+                return (0, to_raw_notification_1.toRawOnChainNotification)(n);
+            })
+                .filter((n) => Boolean(n));
+            onChainNotifications.push(...transformedNotifications);
+            // if less than 100 notifications on page, then means we reached end
+            if (notifications.length < 100) {
+                page = PAGE_LIMIT + 1;
+                break;
+            }
+        }
+        catch (err) {
+            loglevel_1.default.error(`Error fetching on-chain notifications for trigger IDs ${triggerIds.join(', ')}:`, err);
+            // do nothing
         }
-        return (0, to_raw_notification_1.toRawOnChainNotification)(n);
-    })
-        .filter((n) => Boolean(n));
-    return transformedNotifications ?? [];
+    }
+    return onChainNotifications;
 }
 exports.getOnChainNotifications = getOnChainNotifications;
 /**
@@ -110,10 +178,15 @@ async function markNotificationsAsRead(bearerToken, notificationIds) {
         return;
     }
     try {
-        await (0, utils_1.makeApiCall)(bearerToken, exports.NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT, 'POST', { ids: notificationIds });
+        const response = await (0, utils_1.makeApiCall)(bearerToken, exports.NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT, 'POST', { ids: notificationIds });
+        if (response.status !== 200) {
+            const errorData = await response.json().catch(() => undefined);
+            throw new Error(`Error marking notifications as read: ${errorData?.message}`);
+        }
     }
     catch (err) {
         loglevel_1.default.error('Error marking notifications as read:', err);
+        throw err;
     }
 }
 exports.markNotificationsAsRead = markNotificationsAsRead;

package/dist/NotificationServicesController/services/onchain-notifications.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"onchain-notifications.cjs","sourceRoot":"","sources":["../../../src/NotificationServicesController/services/onchain-notifications.ts"],"names":[],"mappings":";;;;;;AAAA,wDAA2B;AAE3B,+EAAuE;AACvE,8EAA4E;AAK5E,8CAA6C;AAShC,QAAA,WAAW,GAAG,oCAAoC,CAAC;AACnD,QAAA,gBAAgB,GAAG,yCAAyC,CAAC;AAE1E,uDAAuD;AAC1C,QAAA,wCAAwC,GAAG,GAAG,mBAAW,6BAA6B,CAAC;AAEpG,wEAAwE;AAC3D,QAAA,kCAAkC,GAAG,GAAG,mBAAW,uBAAuB,CAAC;AAExF,gDAAgD;AACnC,QAAA,8BAA8B,GAAG,GAAG,wBAAgB,uBAAuB,CAAC;AAEzF,8BAA8B;AACjB,QAAA,0CAA0C,GAAG,GAAG,wBAAgB,oCAAoC,CAAC;AAElH;;;;;;;;GAQG;AACI,KAAK,UAAU,mCAAmC,CACvD,WAAmB,EACnB,SAAmB;IAEnB,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO,EAAE,CAAC;KACX;IAED,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,oDAAwB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACvD,IAAI,MAAM,EAAE;QACV,OAAO,MAAM,CAAC;KACf;IAID,MAAM,IAAI,GAAgB,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,MAAM,IAAA,mBAAW,EAC5B,WAAW,EACX,gDAAwC,EACxC,MAAM,EACN,IAAI,CACL;SACE,IAAI,CAAkB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACtD,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;IAErB,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;IAE1B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,oDAAwB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KACtC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAlCD,kFAkCC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,0BAA0B,CAC9C,WAAmB,EACnB,SAAkD;IAElD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO;KACR;IAED,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC9B,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACpC,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;IAGH,MAAM,IAAI,GAAgB,SAAS,CAAC;IACpC,MAAM,IAAA,mBAAW,EACf,WAAW,EACX,0CAAkC,EAClC,MAAM,EACN,IAAI,CACL;SACE,IAAI,CAAC,GAAG,EAAE,CAAC,oDAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;SACvD,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC;AAvBD,gEAuBC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,uBAAuB,CAC3C,WAAmB,EACnB,SAAmB;IAEnB,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO,EAAE,CAAC;KACX;IAED,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAGlD,MAAM,IAAI,GAAgB,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,MAAM,IAAA,mBAAW,EACrC,WAAW,EACX,sCAA8B,EAC9B,MAAM,EACN,IAAI,CACL;SACE,IAAI,CAA6C,CAAC,CAAC,EAAE,EAAE,CACtD,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CACvB;SACA,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;IAErB,mCAAmC;IACnC,MAAM,wBAAwB,GAAG,aAAa;QAC5C,EAAE,GAAG,CAAC,CAAC,CAAC,EAAsC,EAAE;QAC9C,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE;YACjB,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,IAAA,8CAAwB,EAAC,CAAC,CAAC,CAAC;IACrC,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,CAAC,EAA+B,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1D,OAAO,wBAAwB,IAAI,EAAE,CAAC;AACxC,CAAC;AAnCD,0DAmCC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,uBAAuB,CAC3C,WAAmB,EACnB,eAAyB;IAEzB,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;QAChC,OAAO;KACR;IAED,IAAI;QACF,MAAM,IAAA,mBAAW,EACf,WAAW,EACX,kDAA0C,EAC1C,MAAM,EACN,EAAE,GAAG,EAAE,eAAe,EAAE,CACzB,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,kBAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAC;KACxD;AACH,CAAC;AAlBD,0DAkBC","sourcesContent":["import log from 'loglevel';\n\nimport { notificationsConfigCache } from './notification-config-cache';\nimport { toRawOnChainNotification } from '../../shared/to-raw-notification';\nimport type {\n  OnChainRawNotification,\n  UnprocessedOnChainRawNotification,\n} from '../types/on-chain-notification/on-chain-notification';\nimport { makeApiCall } from '../utils/utils';\n\nexport type NotificationTrigger = {\n  id: string;\n  chainId: string;\n  kind: string;\n  address: string;\n};\n\nexport const TRIGGER_API = 'https://trigger.api.cx.metamask.io';\nexport const NOTIFICATION_API = 'https://notification.api.cx.metamask.io';\n\n// Gets notification settings for each account provided\nexport const TRIGGER_API_NOTIFICATIONS_QUERY_ENDPOINT = `${TRIGGER_API}/api/v2/notifications/query`;\n\n// Used to create/update account notifications for each account provided\nexport const TRIGGER_API_NOTIFICATIONS_ENDPOINT = `${TRIGGER_API}/api/v2/notifications`;\n\n// Lists notifications for each account provided\nexport const NOTIFICATION_API_LIST_ENDPOINT = `${NOTIFICATION_API}/api/v2/notifications`;\n\n// Makrs notifications as read\nexport const NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = `${NOTIFICATION_API}/api/v2/notifications/mark-as-read`;\n\n/**\n * fetches notification config (accounts enabled vs disabled)\n *\n * @param bearerToken - jwt\n * @param addresses - list of addresses to check\n * NOTE the API will return addresses config with false if they have not been created before.\n * NOTE this is cached for 1s to prevent multiple update calls\n * @returns object of notification config, or null if missing\n */\nexport async function getOnChainNotificationsConfigCached(\n  bearerToken: string,\n  addresses: string[],\n) {\n  if (addresses.length === 0) {\n    return [];\n  }\n\n  addresses = addresses.map((a) => a.toLowerCase());\n\n  const cached = notificationsConfigCache.get(addresses);\n  if (cached) {\n    return cached;\n  }\n\n  type RequestBody = { address: string }[];\n  type Response = { address: string; enabled: boolean }[];\n  const body: RequestBody = addresses.map((address) => ({ address }));\n  const data = await makeApiCall(\n    bearerToken,\n    TRIGGER_API_NOTIFICATIONS_QUERY_ENDPOINT,\n    'POST',\n    body,\n  )\n    .then<Response | null>((r) => (r.ok ? r.json() : null))\n    .catch(() => null);\n\n  const result = data ?? [];\n\n  if (result.length > 0) {\n    notificationsConfigCache.set(result);\n  }\n\n  return result;\n}\n\n/**\n * updates notifications for a given addresses\n *\n * @param bearerToken - jwt\n * @param addresses - list of addresses to check\n * @returns void\n */\nexport async function updateOnChainNotifications(\n  bearerToken: string,\n  addresses: { address: string; enabled: boolean }[],\n) {\n  if (addresses.length === 0) {\n    return;\n  }\n\n  addresses = addresses.map((a) => {\n    a.address = a.address.toLowerCase();\n    return a;\n  });\n\n  type RequestBody = { address: string; enabled: boolean }[];\n  const body: RequestBody = addresses;\n  await makeApiCall(\n    bearerToken,\n    TRIGGER_API_NOTIFICATIONS_ENDPOINT,\n    'POST',\n    body,\n  )\n    .then(() => notificationsConfigCache.replace(addresses))\n    .catch(() => null);\n}\n\n/**\n * Fetches on-chain notifications for the given addresses\n *\n * @param bearerToken - The JSON Web Token used for authentication in the API call.\n * @param addresses - List of addresses\n * @returns A promise that resolves to an array of OnChainRawNotification objects. If no triggers are enabled or an error occurs, it may return an empty array.\n */\nexport async function getOnChainNotifications(\n  bearerToken: string,\n  addresses: string[],\n): Promise<OnChainRawNotification[]> {\n  if (addresses.length === 0) {\n    return [];\n  }\n\n  addresses = addresses.map((a) => a.toLowerCase());\n\n  type RequestBody = { address: string }[];\n  const body: RequestBody = addresses.map((address) => ({ address }));\n  const notifications = await makeApiCall(\n    bearerToken,\n    NOTIFICATION_API_LIST_ENDPOINT,\n    'POST',\n    body,\n  )\n    .then<UnprocessedOnChainRawNotification[] | null>((r) =>\n      r.ok ? r.json() : null,\n    )\n    .catch(() => null);\n\n  // Transform and sort notifications\n  const transformedNotifications = notifications\n    ?.map((n): OnChainRawNotification | undefined => {\n      if (!n.data?.kind) {\n        return undefined;\n      }\n\n      return toRawOnChainNotification(n);\n    })\n    .filter((n): n is OnChainRawNotification => Boolean(n));\n\n  return transformedNotifications ?? [];\n}\n\n/**\n * Marks the specified notifications as read.\n * This method sends a POST request to the notifications service to mark the provided notification IDs as read.\n * If the operation is successful, it completes without error. If the operation fails, it throws an error with details.\n *\n * @param bearerToken - The JSON Web Token used for authentication in the API call.\n * @param notificationIds - An array of notification IDs to be marked as read.\n * @returns A promise that resolves to void. The promise will reject if there's an error during the API call or if the response status is not 200.\n */\nexport async function markNotificationsAsRead(\n  bearerToken: string,\n  notificationIds: string[],\n): Promise<void> {\n  if (notificationIds.length === 0) {\n    return;\n  }\n\n  try {\n    await makeApiCall(\n      bearerToken,\n      NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT,\n      'POST',\n      { ids: notificationIds },\n    );\n  } catch (err) {\n    log.error('Error marking notifications as read:', err);\n  }\n}\n"]}
+{"version":3,"file":"onchain-notifications.cjs","sourceRoot":"","sources":["../../../src/NotificationServicesController/services/onchain-notifications.ts"],"names":[],"mappings":";;;;;;AAAA,+EAA0E;AAC1E,wDAA2B;AAE3B,8EAA4E;AAM5E,8CAKwB;AASX,QAAA,WAAW,GAAG,oCAAoC,CAAC;AACnD,QAAA,gBAAgB,GAAG,yCAAyC,CAAC;AAC7D,QAAA,0BAA0B,GAAG,GAAG,mBAAW,wBAAwB,CAAC;AACpE,QAAA,8BAA8B,GAAG,GAAG,wBAAgB,uBAAuB,CAAC;AAClF,MAAM,yCAAyC,GAAG,CAAC,IAAY,EAAE,EAAE,CACxE,GAAG,sCAA8B,SAAS,IAAI,eAAe,CAAC;AADnD,QAAA,yCAAyC,6CACU;AACnD,QAAA,0CAA0C,GAAG,GAAG,wBAAgB,oCAAoC,CAAC;AAElH;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,qBAAqB,CACzC,WAAwB,EACxB,UAAkB,EAClB,WAAmB,EACnB,QAA+B;IAY/B,MAAM,gBAAgB,GAA4B,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACrE,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,KAAK,EAAE,+CAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAAG,UAAU,CAAC;QAChE,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YAC3B,OAAO,EAAE,CAAC,CAAC,OAAO;SACnB;KACF,CAAC,CAAC,CAAC;IAEJ,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;QACjC,OAAO;KACR;IAED,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAW,EAChC,WAAW,EACX,kCAA0B,EAC1B,MAAM,EACN,gBAAgB,CACjB,CAAC;IAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;QAChB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC/D,kBAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,SAAS,CAAC,CAAC;QACjD,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;KACtE;IAED,mCAAmC;IACnC,8BAA8B;IAC9B,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE;QACtC,IAAA,sCAA8B,EAC5B,WAAW,EACX,OAAO,CAAC,MAAM,CAAC,OAAO,EACtB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC/B,OAAO,CAAC,EAAE,EACV,IAAI,CACL,CAAC;KACH;IAED,IAAA,wBAAgB,EAAC,WAAW,CAAC,CAAC;AAChC,CAAC;AAxDD,sDAwDC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,qBAAqB,CACzC,WAAwB,EACxB,UAAkB,EAClB,WAAmB,EACnB,KAAe;IAEf,MAAM,gBAAgB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC5C,EAAE,EAAE,IAAI;QACR,KAAK,EAAE,+CAAqB,CAAC,gBAAgB,CAAC,IAAI,GAAG,UAAU,CAAC;KACjE,CAAC,CAAC,CAAC;IAEJ,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAW,EAChC,WAAW,EACX,kCAA0B,EAC1B,QAAQ,EACR,gBAAgB,CACjB,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CACb,qDAAqD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACxE,CAAC;SACH;QAED,mDAAmD;QACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE;gBACjC,IAAI,OAAO,IAAI,WAAW,EAAE;oBAC1B,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE;wBAC1C,IAAI,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;4BAC7C,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;yBAC5C;qBACF;iBACF;aACF;SACF;QAED,8FAA8F;QAC9F,MAAM,OAAO,GAAG,CAAC,GAAG,GAAG,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;QAC5D,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE;YACjC,IAAI,OAAO,IAAI,WAAW,EAAE;gBAC1B,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE;oBAC1C,sBAAsB;oBACtB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE;wBAC9C,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;qBACtC;iBACF;gBAED,wBAAwB;gBACxB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE;oBACnC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;iBAC7B;aACF;SACF;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,kBAAG,CAAC,KAAK,CACP,mDAAmD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EACtE,GAAG,CACJ,CAAC;QACF,MAAM,GAAG,CAAC;KACX;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAhED,sDAgEC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,uBAAuB,CAC3C,WAAwB,EACxB,WAAmB;IAEnB,MAAM,UAAU,GAAG,IAAA,mCAA2B,EAAC,WAAW,EAAE;QAC1D,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE;YAChB,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACd,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,CAAC,CAAC,EAAE,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,OAAO,EAAE,CAAC;KACX;IAED,MAAM,oBAAoB,GAA6B,EAAE,CAAC;IAC1D,MAAM,UAAU,GAAG,CAAC,CAAC;IACrB,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,IAAI,UAAU,EAAE,IAAI,EAAE,EAAE;QAC7C,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAW,EAChC,WAAW,EACX,IAAA,iDAAyC,EAAC,IAAI,CAAC,EAC/C,MAAM,EACN,EAAE,WAAW,EAAE,UAAU,EAAE,CAC5B,CAAC;YAEF,MAAM,aAAa,GACjB,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAwC,CAAC;YAEjE,mCAAmC;YACnC,MAAM,wBAAwB,GAAG,aAAa;iBAC3C,GAAG,CAAC,CAAC,CAAC,EAAsC,EAAE;gBAC7C,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE;oBACjB,OAAO,SAAS,CAAC;iBAClB;gBAED,OAAO,IAAA,8CAAwB,EAAC,CAAC,CAAC,CAAC;YACrC,CAAC,CAAC;iBACD,MAAM,CAAC,CAAC,CAAC,EAA+B,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAE1D,oBAAoB,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,CAAC;YAEvD,oEAAoE;YACpE,IAAI,aAAa,CAAC,MAAM,GAAG,GAAG,EAAE;gBAC9B,IAAI,GAAG,UAAU,GAAG,CAAC,CAAC;gBACtB,MAAM;aACP;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,kBAAG,CAAC,KAAK,CACP,yDAAyD,UAAU,CAAC,IAAI,CACtE,IAAI,CACL,GAAG,EACJ,GAAG,CACJ,CAAC;YACF,aAAa;SACd;KACF;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AA7DD,0DA6DC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,uBAAuB,CAC3C,WAAmB,EACnB,eAAyB;IAEzB,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;QAChC,OAAO;KACR;IAED,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAW,EAChC,WAAW,EACX,kDAA0C,EAC1C,MAAM,EACN,EAAE,GAAG,EAAE,eAAe,EAAE,CACzB,CAAC;QAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC/D,MAAM,IAAI,KAAK,CACb,wCAAwC,SAAS,EAAE,OAAiB,EAAE,CACvE,CAAC;SACH;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,kBAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AA1BD,0DA0BC","sourcesContent":["import { UserStorageController } from '@metamask/profile-sync-controller';\nimport log from 'loglevel';\n\nimport { toRawOnChainNotification } from '../../shared/to-raw-notification';\nimport type {\n  OnChainRawNotification,\n  UnprocessedOnChainRawNotification,\n} from '../types/on-chain-notification/on-chain-notification';\nimport type { UserStorage } from '../types/user-storage/user-storage';\nimport {\n  cleanUserStorage,\n  makeApiCall,\n  toggleUserStorageTriggerStatus,\n  traverseUserStorageTriggers,\n} from '../utils/utils';\n\nexport type NotificationTrigger = {\n  id: string;\n  chainId: string;\n  kind: string;\n  address: string;\n};\n\nexport const TRIGGER_API = 'https://trigger.api.cx.metamask.io';\nexport const NOTIFICATION_API = 'https://notification.api.cx.metamask.io';\nexport const TRIGGER_API_BATCH_ENDPOINT = `${TRIGGER_API}/api/v1/triggers/batch`;\nexport const NOTIFICATION_API_LIST_ENDPOINT = `${NOTIFICATION_API}/api/v1/notifications`;\nexport const NOTIFICATION_API_LIST_ENDPOINT_PAGE_QUERY = (page: number) =>\n  `${NOTIFICATION_API_LIST_ENDPOINT}?page=${page}&per_page=100`;\nexport const NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = `${NOTIFICATION_API}/api/v1/notifications/mark-as-read`;\n\n/**\n * Creates on-chain triggers based on the provided notification triggers.\n * This method generates a unique token for each trigger using the trigger ID and storage key,\n * proving ownership of the trigger being updated. It then makes an API call to create these triggers.\n * Upon successful creation, it updates the userStorage to reflect the new trigger status.\n *\n * @param userStorage - The user's storage object where triggers and their statuses are stored.\n * @param storageKey - A key used along with the trigger ID to generate a unique token for each trigger.\n * @param bearerToken - The JSON Web Token used for authentication in the API call.\n * @param triggers - An array of notification triggers to be created. Each trigger includes an ID, chain ID, kind, and address.\n * @returns A promise that resolves to void. Throws an error if the API call fails or if there's an issue creating the triggers.\n */\nexport async function createOnChainTriggers(\n  userStorage: UserStorage,\n  storageKey: string,\n  bearerToken: string,\n  triggers: NotificationTrigger[],\n): Promise<void> {\n  type RequestPayloadTrigger = {\n    id: string;\n    // this is the trigger token, generated by using the uuid + storage key. It proves you own the trigger you are updating\n    token: string;\n    config: {\n      kind: string;\n      chain_id: number;\n      address: string;\n    };\n  };\n  const triggersToCreate: RequestPayloadTrigger[] = triggers.map((t) => ({\n    id: t.id,\n    token: UserStorageController.createSHA256Hash(t.id + storageKey),\n    config: {\n      kind: t.kind,\n      chain_id: Number(t.chainId),\n      address: t.address,\n    },\n  }));\n\n  if (triggersToCreate.length === 0) {\n    return;\n  }\n\n  const response = await makeApiCall(\n    bearerToken,\n    TRIGGER_API_BATCH_ENDPOINT,\n    'POST',\n    triggersToCreate,\n  );\n\n  if (!response.ok) {\n    const errorData = await response.json().catch(() => undefined);\n    log.error('Error creating triggers:', errorData);\n    throw new Error('OnChain Notifications - unable to create triggers');\n  }\n\n  // If the trigger creation was fine\n  // then update the userStorage\n  for (const trigger of triggersToCreate) {\n    toggleUserStorageTriggerStatus(\n      userStorage,\n      trigger.config.address,\n      String(trigger.config.chain_id),\n      trigger.id,\n      true,\n    );\n  }\n\n  cleanUserStorage(userStorage);\n}\n\n/**\n * Deletes on-chain triggers based on the provided UUIDs.\n * This method generates a unique token for each trigger using the UUID and storage key,\n * proving ownership of the trigger being deleted. It then makes an API call to delete these triggers.\n * Upon successful deletion, it updates the userStorage to remove the deleted trigger statuses.\n *\n * @param userStorage - The user's storage object where triggers and their statuses are stored.\n * @param storageKey - A key used along with the UUID to generate a unique token for each trigger.\n * @param bearerToken - The JSON Web Token used for authentication in the API call.\n * @param uuids - An array of UUIDs representing the triggers to be deleted.\n * @returns A promise that resolves to the updated UserStorage object. Throws an error if the API call fails or if there's an issue deleting the triggers.\n */\nexport async function deleteOnChainTriggers(\n  userStorage: UserStorage,\n  storageKey: string,\n  bearerToken: string,\n  uuids: string[],\n): Promise<UserStorage> {\n  const triggersToDelete = uuids.map((uuid) => ({\n    id: uuid,\n    token: UserStorageController.createSHA256Hash(uuid + storageKey),\n  }));\n\n  try {\n    const response = await makeApiCall(\n      bearerToken,\n      TRIGGER_API_BATCH_ENDPOINT,\n      'DELETE',\n      triggersToDelete,\n    );\n\n    if (!response.ok) {\n      throw new Error(\n        `Failed to delete on-chain notifications for uuids ${uuids.join(', ')}`,\n      );\n    }\n\n    // Update the state of the deleted trigger to false\n    for (const uuid of uuids) {\n      for (const address in userStorage) {\n        if (address in userStorage) {\n          for (const chainId in userStorage[address]) {\n            if (userStorage?.[address]?.[chainId]?.[uuid]) {\n              delete userStorage[address][chainId][uuid];\n            }\n          }\n        }\n      }\n    }\n\n    // Follow-up cleanup, if an address had no triggers whatsoever, then we can delete the address\n    const isEmpty = (obj = {}) => Object.keys(obj).length === 0;\n    for (const address in userStorage) {\n      if (address in userStorage) {\n        for (const chainId in userStorage[address]) {\n          // Chain isEmpty Check\n          if (isEmpty(userStorage?.[address]?.[chainId])) {\n            delete userStorage[address][chainId];\n          }\n        }\n\n        // Address isEmpty Check\n        if (isEmpty(userStorage?.[address])) {\n          delete userStorage[address];\n        }\n      }\n    }\n  } catch (err) {\n    log.error(\n      `Error deleting on-chain notifications for uuids ${uuids.join(', ')}:`,\n      err,\n    );\n    throw err;\n  }\n\n  return userStorage;\n}\n\n/**\n * Fetches on-chain notifications for the given user storage and BearerToken.\n * This method iterates through the userStorage to find enabled triggers and fetches notifications for those triggers.\n * It makes paginated API calls to the notifications service, transforming and aggregating the notifications into a single array.\n * The process stops either when all pages have been fetched or when a page has less than 100 notifications, indicating the end of the data.\n *\n * @param userStorage - The user's storage object containing trigger information.\n * @param bearerToken - The JSON Web Token used for authentication in the API call.\n * @returns A promise that resolves to an array of OnChainRawNotification objects. If no triggers are enabled or an error occurs, it may return an empty array.\n */\nexport async function getOnChainNotifications(\n  userStorage: UserStorage,\n  bearerToken: string,\n): Promise<OnChainRawNotification[]> {\n  const triggerIds = traverseUserStorageTriggers(userStorage, {\n    mapTrigger: (t) => {\n      if (!t.enabled) {\n        return undefined;\n      }\n      return t.id;\n    },\n  });\n\n  if (triggerIds.length === 0) {\n    return [];\n  }\n\n  const onChainNotifications: OnChainRawNotification[] = [];\n  const PAGE_LIMIT = 2;\n  for (let page = 1; page <= PAGE_LIMIT; page++) {\n    try {\n      const response = await makeApiCall(\n        bearerToken,\n        NOTIFICATION_API_LIST_ENDPOINT_PAGE_QUERY(page),\n        'POST',\n        { trigger_ids: triggerIds },\n      );\n\n      const notifications =\n        (await response.json()) as UnprocessedOnChainRawNotification[];\n\n      // Transform and sort notifications\n      const transformedNotifications = notifications\n        .map((n): OnChainRawNotification | undefined => {\n          if (!n.data?.kind) {\n            return undefined;\n          }\n\n          return toRawOnChainNotification(n);\n        })\n        .filter((n): n is OnChainRawNotification => Boolean(n));\n\n      onChainNotifications.push(...transformedNotifications);\n\n      // if less than 100 notifications on page, then means we reached end\n      if (notifications.length < 100) {\n        page = PAGE_LIMIT + 1;\n        break;\n      }\n    } catch (err) {\n      log.error(\n        `Error fetching on-chain notifications for trigger IDs ${triggerIds.join(\n          ', ',\n        )}:`,\n        err,\n      );\n      // do nothing\n    }\n  }\n\n  return onChainNotifications;\n}\n\n/**\n * Marks the specified notifications as read.\n * This method sends a POST request to the notifications service to mark the provided notification IDs as read.\n * If the operation is successful, it completes without error. If the operation fails, it throws an error with details.\n *\n * @param bearerToken - The JSON Web Token used for authentication in the API call.\n * @param notificationIds - An array of notification IDs to be marked as read.\n * @returns A promise that resolves to void. The promise will reject if there's an error during the API call or if the response status is not 200.\n */\nexport async function markNotificationsAsRead(\n  bearerToken: string,\n  notificationIds: string[],\n): Promise<void> {\n  if (notificationIds.length === 0) {\n    return;\n  }\n\n  try {\n    const response = await makeApiCall(\n      bearerToken,\n      NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT,\n      'POST',\n      { ids: notificationIds },\n    );\n\n    if (response.status !== 200) {\n      const errorData = await response.json().catch(() => undefined);\n      throw new Error(\n        `Error marking notifications as read: ${errorData?.message as string}`,\n      );\n    }\n  } catch (err) {\n    log.error('Error marking notifications as read:', err);\n    throw err;\n  }\n}\n"]}

package/dist/NotificationServicesController/services/onchain-notifications.d.cts

@@ -1,4 +1,5 @@
 import type { OnChainRawNotification } from "../types/on-chain-notification/on-chain-notification.cjs";
+import type { UserStorage } from "../types/user-storage/user-storage.cjs";
 export type NotificationTrigger = {
     id: string;
     chainId: string;
@@ -7,42 +8,47 @@ export type NotificationTrigger = {
 };
 export declare const TRIGGER_API = "https://trigger.api.cx.metamask.io";
 export declare const NOTIFICATION_API = "https://notification.api.cx.metamask.io";
-export declare const TRIGGER_API_NOTIFICATIONS_QUERY_ENDPOINT = "https://trigger.api.cx.metamask.io/api/v2/notifications/query";
-export declare const TRIGGER_API_NOTIFICATIONS_ENDPOINT = "https://trigger.api.cx.metamask.io/api/v2/notifications";
-export declare const NOTIFICATION_API_LIST_ENDPOINT = "https://notification.api.cx.metamask.io/api/v2/notifications";
-export declare const NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = "https://notification.api.cx.metamask.io/api/v2/notifications/mark-as-read";
+export declare const TRIGGER_API_BATCH_ENDPOINT = "https://trigger.api.cx.metamask.io/api/v1/triggers/batch";
+export declare const NOTIFICATION_API_LIST_ENDPOINT = "https://notification.api.cx.metamask.io/api/v1/notifications";
+export declare const NOTIFICATION_API_LIST_ENDPOINT_PAGE_QUERY: (page: number) => string;
+export declare const NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = "https://notification.api.cx.metamask.io/api/v1/notifications/mark-as-read";
 /**
- * fetches notification config (accounts enabled vs disabled)
+ * Creates on-chain triggers based on the provided notification triggers.
+ * This method generates a unique token for each trigger using the trigger ID and storage key,
+ * proving ownership of the trigger being updated. It then makes an API call to create these triggers.
+ * Upon successful creation, it updates the userStorage to reflect the new trigger status.
  *
- * @param bearerToken - jwt
- * @param addresses - list of addresses to check
- * NOTE the API will return addresses config with false if they have not been created before.
- * NOTE this is cached for 1s to prevent multiple update calls
- * @returns object of notification config, or null if missing
+ * @param userStorage - The user's storage object where triggers and their statuses are stored.
+ * @param storageKey - A key used along with the trigger ID to generate a unique token for each trigger.
+ * @param bearerToken - The JSON Web Token used for authentication in the API call.
+ * @param triggers - An array of notification triggers to be created. Each trigger includes an ID, chain ID, kind, and address.
+ * @returns A promise that resolves to void. Throws an error if the API call fails or if there's an issue creating the triggers.
  */
-export declare function getOnChainNotificationsConfigCached(bearerToken: string, addresses: string[]): Promise<{
-    address: string;
-    enabled: boolean;
-}[]>;
+export declare function createOnChainTriggers(userStorage: UserStorage, storageKey: string, bearerToken: string, triggers: NotificationTrigger[]): Promise<void>;
 /**
- * updates notifications for a given addresses
+ * Deletes on-chain triggers based on the provided UUIDs.
+ * This method generates a unique token for each trigger using the UUID and storage key,
+ * proving ownership of the trigger being deleted. It then makes an API call to delete these triggers.
+ * Upon successful deletion, it updates the userStorage to remove the deleted trigger statuses.
  *
- * @param bearerToken - jwt
- * @param addresses - list of addresses to check
- * @returns void
+ * @param userStorage - The user's storage object where triggers and their statuses are stored.
+ * @param storageKey - A key used along with the UUID to generate a unique token for each trigger.
+ * @param bearerToken - The JSON Web Token used for authentication in the API call.
+ * @param uuids - An array of UUIDs representing the triggers to be deleted.
+ * @returns A promise that resolves to the updated UserStorage object. Throws an error if the API call fails or if there's an issue deleting the triggers.
  */
-export declare function updateOnChainNotifications(bearerToken: string, addresses: {
-    address: string;
-    enabled: boolean;
-}[]): Promise<void>;
+export declare function deleteOnChainTriggers(userStorage: UserStorage, storageKey: string, bearerToken: string, uuids: string[]): Promise<UserStorage>;
 /**
- * Fetches on-chain notifications for the given addresses
+ * Fetches on-chain notifications for the given user storage and BearerToken.
+ * This method iterates through the userStorage to find enabled triggers and fetches notifications for those triggers.
+ * It makes paginated API calls to the notifications service, transforming and aggregating the notifications into a single array.
+ * The process stops either when all pages have been fetched or when a page has less than 100 notifications, indicating the end of the data.
  *
+ * @param userStorage - The user's storage object containing trigger information.
  * @param bearerToken - The JSON Web Token used for authentication in the API call.
- * @param addresses - List of addresses
  * @returns A promise that resolves to an array of OnChainRawNotification objects. If no triggers are enabled or an error occurs, it may return an empty array.
  */
-export declare function getOnChainNotifications(bearerToken: string, addresses: string[]): Promise<OnChainRawNotification[]>;
+export declare function getOnChainNotifications(userStorage: UserStorage, bearerToken: string): Promise<OnChainRawNotification[]>;
 /**
  * Marks the specified notifications as read.
  * This method sends a POST request to the notifications service to mark the provided notification IDs as read.

package/dist/NotificationServicesController/services/onchain-notifications.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"onchain-notifications.d.cts","sourceRoot":"","sources":["../../../src/NotificationServicesController/services/onchain-notifications.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,sBAAsB,EAEvB,iEAA6D;AAG9D,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,WAAW,uCAAuC,CAAC;AAChE,eAAO,MAAM,gBAAgB,4CAA4C,CAAC;AAG1E,eAAO,MAAM,wCAAwC,kEAA8C,CAAC;AAGpG,eAAO,MAAM,kCAAkC,4DAAwC,CAAC;AAGxF,eAAO,MAAM,8BAA8B,iEAA6C,CAAC;AAGzF,eAAO,MAAM,0CAA0C,8EAA0D,CAAC;AAElH;;;;;;;;GAQG;AACH,wBAAsB,mCAAmC,CACvD,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EAAE;;;KAgCpB;AAED;;;;;;GAMG;AACH,wBAAsB,0BAA0B,CAC9C,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,EAAE,iBAqBnD;AAED;;;;;;GAMG;AACH,wBAAsB,uBAAuB,CAC3C,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAgCnC;AAED;;;;;;;;GAQG;AACH,wBAAsB,uBAAuB,CAC3C,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC,CAef"}
+{"version":3,"file":"onchain-notifications.d.cts","sourceRoot":"","sources":["../../../src/NotificationServicesController/services/onchain-notifications.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,sBAAsB,EAEvB,iEAA6D;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,+CAA2C;AAQtE,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,WAAW,uCAAuC,CAAC;AAChE,eAAO,MAAM,gBAAgB,4CAA4C,CAAC;AAC1E,eAAO,MAAM,0BAA0B,6DAAyC,CAAC;AACjF,eAAO,MAAM,8BAA8B,iEAA6C,CAAC;AACzF,eAAO,MAAM,yCAAyC,SAAU,MAAM,WACP,CAAC;AAChE,eAAO,MAAM,0CAA0C,8EAA0D,CAAC;AAElH;;;;;;;;;;;GAWG;AACH,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,mBAAmB,EAAE,GAC9B,OAAO,CAAC,IAAI,CAAC,CAmDf;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EAAE,GACd,OAAO,CAAC,WAAW,CAAC,CA2DtB;AAED;;;;;;;;;GASG;AACH,wBAAsB,uBAAuB,CAC3C,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,sBAAsB,EAAE,CAAC,CA0DnC;AAED;;;;;;;;GAQG;AACH,wBAAsB,uBAAuB,CAC3C,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC,CAuBf"}

package/dist/NotificationServicesController/services/onchain-notifications.d.mts

@@ -1,4 +1,5 @@
 import type { OnChainRawNotification } from "../types/on-chain-notification/on-chain-notification.mjs";
+import type { UserStorage } from "../types/user-storage/user-storage.mjs";
 export type NotificationTrigger = {
     id: string;
     chainId: string;
@@ -7,42 +8,47 @@ export type NotificationTrigger = {
 };
 export declare const TRIGGER_API = "https://trigger.api.cx.metamask.io";
 export declare const NOTIFICATION_API = "https://notification.api.cx.metamask.io";
-export declare const TRIGGER_API_NOTIFICATIONS_QUERY_ENDPOINT = "https://trigger.api.cx.metamask.io/api/v2/notifications/query";
-export declare const TRIGGER_API_NOTIFICATIONS_ENDPOINT = "https://trigger.api.cx.metamask.io/api/v2/notifications";
-export declare const NOTIFICATION_API_LIST_ENDPOINT = "https://notification.api.cx.metamask.io/api/v2/notifications";
-export declare const NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = "https://notification.api.cx.metamask.io/api/v2/notifications/mark-as-read";
+export declare const TRIGGER_API_BATCH_ENDPOINT = "https://trigger.api.cx.metamask.io/api/v1/triggers/batch";
+export declare const NOTIFICATION_API_LIST_ENDPOINT = "https://notification.api.cx.metamask.io/api/v1/notifications";
+export declare const NOTIFICATION_API_LIST_ENDPOINT_PAGE_QUERY: (page: number) => string;
+export declare const NOTIFICATION_API_MARK_ALL_AS_READ_ENDPOINT = "https://notification.api.cx.metamask.io/api/v1/notifications/mark-as-read";
 /**
- * fetches notification config (accounts enabled vs disabled)
+ * Creates on-chain triggers based on the provided notification triggers.
+ * This method generates a unique token for each trigger using the trigger ID and storage key,
+ * proving ownership of the trigger being updated. It then makes an API call to create these triggers.
+ * Upon successful creation, it updates the userStorage to reflect the new trigger status.
  *
- * @param bearerToken - jwt
- * @param addresses - list of addresses to check
- * NOTE the API will return addresses config with false if they have not been created before.
- * NOTE this is cached for 1s to prevent multiple update calls
- * @returns object of notification config, or null if missing
+ * @param userStorage - The user's storage object where triggers and their statuses are stored.
+ * @param storageKey - A key used along with the trigger ID to generate a unique token for each trigger.
+ * @param bearerToken - The JSON Web Token used for authentication in the API call.
+ * @param triggers - An array of notification triggers to be created. Each trigger includes an ID, chain ID, kind, and address.
+ * @returns A promise that resolves to void. Throws an error if the API call fails or if there's an issue creating the triggers.
  */
-export declare function getOnChainNotificationsConfigCached(bearerToken: string, addresses: string[]): Promise<{
-    address: string;
-    enabled: boolean;
-}[]>;
+export declare function createOnChainTriggers(userStorage: UserStorage, storageKey: string, bearerToken: string, triggers: NotificationTrigger[]): Promise<void>;
 /**
- * updates notifications for a given addresses
+ * Deletes on-chain triggers based on the provided UUIDs.
+ * This method generates a unique token for each trigger using the UUID and storage key,
+ * proving ownership of the trigger being deleted. It then makes an API call to delete these triggers.
+ * Upon successful deletion, it updates the userStorage to remove the deleted trigger statuses.
  *
- * @param bearerToken - jwt
- * @param addresses - list of addresses to check
- * @returns void
+ * @param userStorage - The user's storage object where triggers and their statuses are stored.
+ * @param storageKey - A key used along with the UUID to generate a unique token for each trigger.
+ * @param bearerToken - The JSON Web Token used for authentication in the API call.
+ * @param uuids - An array of UUIDs representing the triggers to be deleted.
+ * @returns A promise that resolves to the updated UserStorage object. Throws an error if the API call fails or if there's an issue deleting the triggers.
  */
-export declare function updateOnChainNotifications(bearerToken: string, addresses: {
-    address: string;
-    enabled: boolean;
-}[]): Promise<void>;
+export declare function deleteOnChainTriggers(userStorage: UserStorage, storageKey: string, bearerToken: string, uuids: string[]): Promise<UserStorage>;
 /**
- * Fetches on-chain notifications for the given addresses
+ * Fetches on-chain notifications for the given user storage and BearerToken.
+ * This method iterates through the userStorage to find enabled triggers and fetches notifications for those triggers.
+ * It makes paginated API calls to the notifications service, transforming and aggregating the notifications into a single array.
+ * The process stops either when all pages have been fetched or when a page has less than 100 notifications, indicating the end of the data.
  *
+ * @param userStorage - The user's storage object containing trigger information.
  * @param bearerToken - The JSON Web Token used for authentication in the API call.
- * @param addresses - List of addresses
  * @returns A promise that resolves to an array of OnChainRawNotification objects. If no triggers are enabled or an error occurs, it may return an empty array.
  */
-export declare function getOnChainNotifications(bearerToken: string, addresses: string[]): Promise<OnChainRawNotification[]>;
+export declare function getOnChainNotifications(userStorage: UserStorage, bearerToken: string): Promise<OnChainRawNotification[]>;
 /**
  * Marks the specified notifications as read.
  * This method sends a POST request to the notifications service to mark the provided notification IDs as read.

package/dist/NotificationServicesController/services/onchain-notifications.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"onchain-notifications.d.mts","sourceRoot":"","sources":["../../../src/NotificationServicesController/services/onchain-notifications.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,sBAAsB,EAEvB,iEAA6D;AAG9D,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,WAAW,uCAAuC,CAAC;AAChE,eAAO,MAAM,gBAAgB,4CAA4C,CAAC;AAG1E,eAAO,MAAM,wCAAwC,kEAA8C,CAAC;AAGpG,eAAO,MAAM,kCAAkC,4DAAwC,CAAC;AAGxF,eAAO,MAAM,8BAA8B,iEAA6C,CAAC;AAGzF,eAAO,MAAM,0CAA0C,8EAA0D,CAAC;AAElH;;;;;;;;GAQG;AACH,wBAAsB,mCAAmC,CACvD,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EAAE;;;KAgCpB;AAED;;;;;;GAMG;AACH,wBAAsB,0BAA0B,CAC9C,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,EAAE,iBAqBnD;AAED;;;;;;GAMG;AACH,wBAAsB,uBAAuB,CAC3C,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAgCnC;AAED;;;;;;;;GAQG;AACH,wBAAsB,uBAAuB,CAC3C,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC,CAef"}
+{"version":3,"file":"onchain-notifications.d.mts","sourceRoot":"","sources":["../../../src/NotificationServicesController/services/onchain-notifications.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,sBAAsB,EAEvB,iEAA6D;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,+CAA2C;AAQtE,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,WAAW,uCAAuC,CAAC;AAChE,eAAO,MAAM,gBAAgB,4CAA4C,CAAC;AAC1E,eAAO,MAAM,0BAA0B,6DAAyC,CAAC;AACjF,eAAO,MAAM,8BAA8B,iEAA6C,CAAC;AACzF,eAAO,MAAM,yCAAyC,SAAU,MAAM,WACP,CAAC;AAChE,eAAO,MAAM,0CAA0C,8EAA0D,CAAC;AAElH;;;;;;;;;;;GAWG;AACH,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,mBAAmB,EAAE,GAC9B,OAAO,CAAC,IAAI,CAAC,CAmDf;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EAAE,GACd,OAAO,CAAC,WAAW,CAAC,CA2DtB;AAED;;;;;;;;;GASG;AACH,wBAAsB,uBAAuB,CAC3C,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,sBAAsB,EAAE,CAAC,CA0DnC;AAED;;;;;;;;GAQG;AACH,wBAAsB,uBAAuB,CAC3C,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC,CAuBf"}