@metamask-previews/perps-controller 8.0.0-preview-afaf415 → 8.0.0-preview-7bc7196a6

package/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Sync `watchlistMarkets` with `AuthenticatedUserStorageService` so the watchlist is persisted server-side per authenticated user account ([#9010](https://github.com/MetaMask/core/pull/9010))
+  - `toggleWatchlistMarket` now performs an optimistic local-state update followed by an async AUS read-merge-write; on failure the local state is reverted.
+  - On `init()`, `state.watchlistMarkets` is hydrated from AUS (source of truth). If no remote watchlist exists yet for the active exchange, any existing local markets are migrated to AUS in a one-time push.
+  - When unauthenticated, or when the active provider is not mapped to an AUS exchange key (e.g. `'aggregated'`), the controller falls back to local-only state without surfacing errors to callers.
+  - `toggleWatchlistMarket` return type changed from `void` to `Promise<void>` to allow callers to await the remote write.
+- Add `resolveWatchlistExchangeKey(activeProvider)` helper that maps a `PerpsActiveProviderMode` to the corresponding `PerpsWatchlistMarkets` exchange key, returning `null` for unsupported modes ([#9010](https://github.com/MetaMask/core/pull/9010))
+
 ### Changed
 
 - Bump `@metamask/controller-utils` from `^12.1.0` to `^12.1.1` ([#9058](https://github.com/MetaMask/core/pull/9058))

package/dist/PerpsController.cjs

@@ -10,9 +10,9 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     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 _PerpsController_instances, _a, _PerpsController_initializationPromise, _PerpsController_isReinitializing, _PerpsController_myxRegistrationPromise, _PerpsController_blockedRegionListVersion, _PerpsController_hip3Enabled, _PerpsController_hip3AllowlistMarkets, _PerpsController_hip3BlocklistMarkets, _PerpsController_hip3ConfigSource, _PerpsController_isMYXProviderEnabled, _PerpsController_standaloneProvider, _PerpsController_handlersRegistered, _PerpsController_standaloneProviderIsTestnet, _PerpsController_standaloneProviderHip3Version, _PerpsController_eligibilityCheckDeferred, _PerpsController_options, _PerpsController_tradingService, _PerpsController_marketDataService, _PerpsController_accountService, _PerpsController_eligibilityService, _PerpsController_dataLakeService, _PerpsController_depositService, _PerpsController_featureFlagConfigurationService, _PerpsController_rewardsIntegrationService, _PerpsController_logError, _PerpsController_debugLog, _PerpsController_getAggregatedCacheProviderIds, _PerpsController_getOrCreateStandaloneProvider, _PerpsController_cleanupStandaloneProvider, _PerpsController_getMetrics, _PerpsController_findNetworkClientIdForChain, _PerpsController_submitTransaction, _PerpsController_migrateRequestsIfNeeded, _PerpsController_withStreamPause, _PerpsController_performInitialization, _PerpsController_createProviders, _PerpsController_assignActiveProvider, _PerpsController_getErrorContext, _PerpsController_getControllerState, _PerpsController_createServiceContext, _PerpsController_ensureTradingServiceDeps, _PerpsController_preloadWatchedPaths, _PerpsController_preloadTimer, _PerpsController_isPreloading, _PerpsController_isPreloadingUserData, _PerpsController_preloadStateUnsubscribe, _PerpsController_accountChangeUnsubscribe, _PerpsController_previousIsTestnet, _PerpsController_previousHip3ConfigVersion, _PerpsController_preloadRefreshMs, _PerpsController_preloadGuardMs, _PerpsController_hydrateCacheFromDiskSync, _PerpsController_performMarketDataPreload, _PerpsController_performUserDataPreload;
+var _PerpsController_instances, _a, _PerpsController_initializationPromise, _PerpsController_isReinitializing, _PerpsController_myxRegistrationPromise, _PerpsController_blockedRegionListVersion, _PerpsController_hip3Enabled, _PerpsController_hip3AllowlistMarkets, _PerpsController_hip3BlocklistMarkets, _PerpsController_hip3ConfigSource, _PerpsController_isMYXProviderEnabled, _PerpsController_standaloneProvider, _PerpsController_handlersRegistered, _PerpsController_standaloneProviderIsTestnet, _PerpsController_standaloneProviderHip3Version, _PerpsController_eligibilityCheckDeferred, _PerpsController_options, _PerpsController_tradingService, _PerpsController_marketDataService, _PerpsController_accountService, _PerpsController_eligibilityService, _PerpsController_dataLakeService, _PerpsController_depositService, _PerpsController_featureFlagConfigurationService, _PerpsController_rewardsIntegrationService, _PerpsController_logError, _PerpsController_debugLog, _PerpsController_getAggregatedCacheProviderIds, _PerpsController_getOrCreateStandaloneProvider, _PerpsController_cleanupStandaloneProvider, _PerpsController_getMetrics, _PerpsController_findNetworkClientIdForChain, _PerpsController_submitTransaction, _PerpsController_migrateRequestsIfNeeded, _PerpsController_withStreamPause, _PerpsController_performInitialization, _PerpsController_createProviders, _PerpsController_assignActiveProvider, _PerpsController_getErrorContext, _PerpsController_getControllerState, _PerpsController_createServiceContext, _PerpsController_ensureTradingServiceDeps, _PerpsController_preloadWatchedPaths, _PerpsController_preloadTimer, _PerpsController_isPreloading, _PerpsController_isPreloadingUserData, _PerpsController_preloadStateUnsubscribe, _PerpsController_accountChangeUnsubscribe, _PerpsController_previousIsTestnet, _PerpsController_previousHip3ConfigVersion, _PerpsController_preloadRefreshMs, _PerpsController_preloadGuardMs, _PerpsController_hydrateCacheFromDiskSync, _PerpsController_performMarketDataPreload, _PerpsController_performUserDataPreload, _PerpsController_persistWatchlistToRemote, _PerpsController_syncWatchlistFromRemote;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PerpsController = exports.getDefaultPerpsControllerState = exports.InitializationState = exports.PERPS_ERROR_CODES = exports.resolveMyxAuthConfig = exports.firstNonEmpty = void 0;
+exports.PerpsController = exports.getDefaultPerpsControllerState = exports.InitializationState = exports.PERPS_ERROR_CODES = exports.resolveMyxAuthConfig = exports.resolveWatchlistExchangeKey = exports.firstNonEmpty = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
 const uuid_1 = require("uuid");
@@ -49,6 +49,26 @@ function firstNonEmpty(...vals) {
     return (vals.find((val) => val !== null && val !== undefined && val !== '') ?? '');
 }
 exports.firstNonEmpty = firstNonEmpty;
+/**
+ * Maps an active provider mode to the corresponding exchange key used in the
+ * AUS {@link PerpsWatchlistMarkets} schema.
+ *
+ * Returns `null` for modes that are not yet represented in the AUS schema
+ * (e.g. `'aggregated'`), which signals callers to skip remote sync and fall
+ * back to local state only.  Add new entries here as additional DEX providers
+ * gain AUS watchlist support.
+ *
+ * @param activeProvider - The current active provider mode from controller state.
+ * @returns The matching `PerpsWatchlistMarkets` key, or `null` if unsupported.
+ */
+function resolveWatchlistExchangeKey(activeProvider) {
+    const map = {
+        hyperliquid: 'hyperliquid',
+        myx: 'myx',
+    };
+    return map[activeProvider] ?? null;
+}
+exports.resolveWatchlistExchangeKey = resolveWatchlistExchangeKey;
 /**
  * Resolves MYX auth config from provider credentials, handling
  * testnet/mainnet fallback logic.
@@ -2931,12 +2951,21 @@ class PerpsController extends base_controller_1.BaseController {
         });
     }
     /**
-     * Toggle watchlist status for a market
-     * Watchlist markets are stored per network (testnet/mainnet)
+     * Toggle watchlist status for a market.
+     *
+     * Updates local state immediately (optimistic UI) and then syncs the new
+     * watchlist to AuthenticatedUserStorageService.  If the remote write fails,
+     * the local state is reverted so it stays consistent with AUS.
+     *
+     * When the user is unauthenticated, or the active provider is not yet
+     * supported by the AUS schema, the controller continues operating with
+     * local-persisted state only — no error is surfaced to the caller.
+     *
+     * Watchlist markets are stored per network (testnet/mainnet).
      *
      * @param symbol - The trading pair symbol.
      */
-    toggleWatchlistMarket(symbol) {
+    async toggleWatchlistMarket(symbol) {
         const currentNetwork = this.state.isTestnet ? 'testnet' : 'mainnet';
         const currentWatchlist = this.state.watchlistMarkets[currentNetwork];
         const isWatchlisted = currentWatchlist.includes(symbol);
@@ -2946,16 +2975,38 @@ class PerpsController extends base_controller_1.BaseController {
             symbol,
             action: isWatchlisted ? 'remove' : 'add',
         });
+        // Step 1: Optimistic local state update — UI reflects change immediately.
         this.update((state) => {
             if (isWatchlisted) {
-                // Remove from watchlist
                 state.watchlistMarkets[currentNetwork] = currentWatchlist.filter((marketSymbol) => marketSymbol !== symbol);
             }
             else {
-                // Add to watchlist
                 state.watchlistMarkets[currentNetwork] = [...currentWatchlist, symbol];
             }
         });
+        __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_getMetrics).call(this).trackPerpsEvent(types_1.PerpsAnalyticsEvent.UiInteraction, {
+            [eventNames_1.PERPS_EVENT_PROPERTY.INTERACTION_TYPE]: eventNames_1.PERPS_EVENT_VALUE.INTERACTION_TYPE.FAVORITE_TOGGLED,
+            [eventNames_1.PERPS_EVENT_PROPERTY.ASSET]: symbol,
+            [eventNames_1.PERPS_EVENT_PROPERTY.ACTION_TYPE]: isWatchlisted
+                ? eventNames_1.PERPS_EVENT_VALUE.ACTION_TYPE.UNFAVORITE_MARKET
+                : eventNames_1.PERPS_EVENT_VALUE.ACTION_TYPE.FAVORITE_MARKET,
+            [eventNames_1.PERPS_EVENT_PROPERTY.FAVORITES_COUNT]: this.state.watchlistMarkets[currentNetwork].length,
+        });
+        // Step 2: Persist to AUS; revert local state if the write fails.
+        try {
+            await __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_persistWatchlistToRemote).call(this, currentNetwork);
+        }
+        catch (error) {
+            __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_logError).call(this, (0, errorUtils_1.ensureError)(error, 'PerpsController.toggleWatchlistMarket'), __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_getErrorContext).call(this, 'toggleWatchlistMarket', {
+                symbol,
+                network: currentNetwork,
+                action: isWatchlisted ? 'remove' : 'add',
+            }));
+            // Revert the optimistic update.
+            this.update((state) => {
+                state.watchlistMarkets[currentNetwork] = currentWatchlist;
+            });
+        }
     }
     /**
      * Check if a market is in the watchlist on the current network
@@ -3268,6 +3319,11 @@ async function _PerpsController_performInitialization() {
                 timestamp: new Date().toISOString(),
                 attempts: attempt,
             });
+            // Hydrate watchlist from AUS (non-blocking — transient failures are
+            // caught inside and must not prevent init from completing).
+            __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_syncWatchlistFromRemote).call(this).catch(() => {
+                // Errors are already logged inside #syncWatchlistFromRemote.
+            });
             return; // Exit retry loop on success
         }
         catch (error) {
@@ -3727,6 +3783,135 @@ async function _PerpsController_performUserDataPreload() {
         });
         __classPrivateFieldSet(this, _PerpsController_isPreloadingUserData, false, "f");
     }
+}, _PerpsController_persistWatchlistToRemote = 
+/**
+ * Writes the current local watchlist to AuthenticatedUserStorageService
+ * using a read-merge-write strategy to avoid overwriting other preferences.
+ *
+ * Skips silently when:
+ * - The active provider has no AUS exchange key (e.g. `'aggregated'`).
+ * - The remote preferences blob does not yet exist (returns `null` / 404).
+ *   In that case, `NotificationServicesController.createOnChainTriggers` is
+ *   the canonical owner that creates the initial blob.
+ *
+ * Throws on remote write failure so the caller can decide whether to revert.
+ *
+ * @param network - Which network's list to sync ('testnet' | 'mainnet').
+ */
+async function _PerpsController_persistWatchlistToRemote(network) {
+    const exchangeKey = resolveWatchlistExchangeKey(this.state.activeProvider);
+    if (!exchangeKey) {
+        __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Skipping AUS watchlist sync — provider not mapped', { activeProvider: this.state.activeProvider });
+        return;
+    }
+    const prefs = await this.messenger.call('AuthenticatedUserStorageService:getNotificationPreferences');
+    if (!prefs) {
+        __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Skipping AUS watchlist write — preferences blob not yet initialised', { exchangeKey, network });
+        return;
+    }
+    const existingWatchlist = prefs.perps
+        .watchlistMarkets ?? {
+        hyperliquid: { testnet: [], mainnet: [] },
+        myx: { testnet: [], mainnet: [] },
+    };
+    const nextWatchlistMarkets = {
+        ...existingWatchlist,
+        [exchangeKey]: {
+            ...existingWatchlist[exchangeKey],
+            [network]: this.state.watchlistMarkets[network],
+        },
+    };
+    const nextPrefs = {
+        ...prefs,
+        perps: {
+            ...prefs.perps,
+            watchlistMarkets: nextWatchlistMarkets,
+        },
+    };
+    await this.messenger.call('AuthenticatedUserStorageService:putNotificationPreferences', nextPrefs);
+    __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Watchlist synced to AUS', {
+        exchangeKey,
+        network,
+        count: this.state.watchlistMarkets[network].length,
+    });
+}, _PerpsController_syncWatchlistFromRemote = 
+/**
+ * Hydrates `state.watchlistMarkets` from AuthenticatedUserStorageService on
+ * controller initialisation.
+ *
+ * AUS is the source of truth; local state is used as an offline cache.
+ * This method also handles the one-time migration from local-only state to
+ * AUS for users who had a watchlist before AUS sync was introduced.
+ *
+ * All remote errors are swallowed so a transient network failure does not
+ * block the rest of `init()`.
+ */
+async function _PerpsController_syncWatchlistFromRemote() {
+    const exchangeKey = resolveWatchlistExchangeKey(this.state.activeProvider);
+    if (!exchangeKey) {
+        __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Skipping AUS watchlist hydration — provider not mapped', { activeProvider: this.state.activeProvider });
+        return;
+    }
+    try {
+        const prefs = await this.messenger.call('AuthenticatedUserStorageService:getNotificationPreferences');
+        if (!prefs) {
+            __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: No AUS preferences blob — using local watchlist');
+            return;
+        }
+        const remoteExchangeWatchlist = prefs.perps.watchlistMarkets?.[exchangeKey];
+        if (remoteExchangeWatchlist) {
+            // AUS has data for this exchange — hydrate local state from it.
+            this.update((state) => {
+                state.watchlistMarkets.testnet = remoteExchangeWatchlist.testnet;
+                state.watchlistMarkets.mainnet = remoteExchangeWatchlist.mainnet;
+            });
+            __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Watchlist hydrated from AUS', {
+                exchangeKey,
+                testnetCount: remoteExchangeWatchlist.testnet.length,
+                mainnetCount: remoteExchangeWatchlist.mainnet.length,
+            });
+        }
+        else {
+            // Blob exists but has no watchlist for this exchange yet.
+            // If local state has any markets, push them up as a one-time migration.
+            const { testnet, mainnet } = this.state.watchlistMarkets;
+            const hasLocalMarkets = testnet.length > 0 || mainnet.length > 0;
+            if (hasLocalMarkets) {
+                __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Migrating local watchlist to AUS', {
+                    exchangeKey,
+                    testnetCount: testnet.length,
+                    mainnetCount: mainnet.length,
+                });
+                // Push testnet and mainnet together via a single read-merge-write.
+                // #persistWatchlistToRemote writes the network passed to it; call it
+                // for whichever networks have data (or both — duplicate writes are
+                // idempotent since we read before each write, but a single combined
+                // write is cleaner).  We combine both networks in one PUT here.
+                const existingWatchlist = {
+                    hyperliquid: { testnet: [], mainnet: [] },
+                    myx: { testnet: [], mainnet: [] },
+                };
+                const nextWatchlistMarkets = {
+                    ...existingWatchlist,
+                    [exchangeKey]: { testnet, mainnet },
+                };
+                const nextPrefs = {
+                    ...prefs,
+                    perps: {
+                        ...prefs.perps,
+                        watchlistMarkets: nextWatchlistMarkets,
+                    },
+                };
+                await this.messenger.call('AuthenticatedUserStorageService:putNotificationPreferences', nextPrefs);
+                __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Local watchlist migrated to AUS', {
+                    exchangeKey,
+                });
+            }
+        }
+    }
+    catch (error) {
+        __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_logError).call(this, (0, errorUtils_1.ensureError)(error, 'PerpsController.syncWatchlistFromRemote'), __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_getErrorContext).call(this, 'syncWatchlistFromRemote'));
+    }
 };
 // ============================================================================
 // Market Data Preload (client-agnostic background caching)