@metamask-previews/perps-controller 3.0.0-preview-e61cfa5 → 3.1.0-preview-548bdd1d9

package/dist/PerpsController.cjs

@@ -10,7 +10,7 @@ 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_marketCacheKey, _PerpsController_providerIsTestnet, _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_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;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PerpsController = exports.getDefaultPerpsControllerState = exports.InitializationState = exports.PERPS_ERROR_CODES = exports.resolveMyxAuthConfig = exports.firstNonEmpty = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -36,6 +36,7 @@ const TradingService_1 = require("./services/TradingService.cjs");
 const types_1 = require("./types/index.cjs");
 const accountUtils_1 = require("./utils/accountUtils.cjs");
 const errorUtils_1 = require("./utils/errorUtils.cjs");
+const perpsDiskPersistence_1 = require("./utils/perpsDiskPersistence.cjs");
 const wait_1 = require("./utils/wait.cjs");
 /**
  * Returns the first non-empty string from the given values.
@@ -535,22 +536,29 @@ class PerpsController extends base_controller_1.BaseController {
         this.providers = new Map();
         // Migrate old persisted data without accountAddress
         __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_migrateRequestsIfNeeded).call(this);
+        // Eagerly hydrate in-memory caches from disk so hooks see data on first render.
+        // Must happen at construction time — before any React component mounts.
+        __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_hydrateCacheFromDiskSync).call(this);
     }
     /**
      * Read cached market data for the currently active provider (or aggregated).
      * Returns null when no valid cache exists or when cache has expired.
      *
+     * @param options - Optional settings.
+     * @param options.skipTTL - When true, bypass the 5-minute TTL check.
+     * Used during initial render so disk-hydrated structural data (with
+     * placeholder prices) is returned regardless of age.
      * @returns The cached market data array, or null if no valid cache.
      */
-    getCachedMarketDataForActiveProvider() {
+    getCachedMarketDataForActiveProvider(options) {
         const { activeProvider } = this.state;
         const cache = this.state.cachedMarketDataByProvider;
         if (activeProvider === 'aggregated') {
             // Assemble from all registered provider entries
             const assembled = [];
             let oldestTimestamp = Infinity;
-            for (const [providerId] of this.providers) {
-                const key = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_marketCacheKey).call(this, providerId, __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_providerIsTestnet).call(this, providerId));
+            for (const providerId of __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_getAggregatedCacheProviderIds).call(this, Object.keys(cache))) {
+                const key = (0, perpsConfig_1.buildProviderCacheKey)(providerId, this.state.isTestnet);
                 const entry = cache[key];
                 if (!entry || entry.data.length === 0) {
                     continue;
@@ -562,18 +570,20 @@ class PerpsController extends base_controller_1.BaseController {
                 return null;
             }
             // Check TTL against the oldest entry
-            if (Date.now() - oldestTimestamp > __classPrivateFieldGet(_a, _a, "f", _PerpsController_preloadGuardMs) * 10) {
+            if (!options?.skipTTL &&
+                Date.now() - oldestTimestamp > __classPrivateFieldGet(_a, _a, "f", _PerpsController_preloadGuardMs) * 10) {
                 return null;
             }
             return assembled;
         }
         // Single provider mode
-        const key = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_marketCacheKey).call(this, activeProvider, __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_providerIsTestnet).call(this, activeProvider));
+        const key = (0, perpsConfig_1.buildProviderCacheKey)(activeProvider, this.state.isTestnet);
         const entry = cache[key];
         if (!entry || entry.data.length === 0) {
             return null;
         }
-        if (Date.now() - entry.timestamp > __classPrivateFieldGet(_a, _a, "f", _PerpsController_preloadGuardMs) * 10) {
+        if (!options?.skipTTL &&
+            Date.now() - entry.timestamp > __classPrivateFieldGet(_a, _a, "f", _PerpsController_preloadGuardMs) * 10) {
             return null;
         }
         return entry.data;
@@ -583,9 +593,13 @@ class PerpsController extends base_controller_1.BaseController {
      * Returns null when no valid cache exists, cache has expired, or address
      * does not match the currently selected EVM account.
      *
+     * @param options - Optional settings.
+     * @param options.skipTTL - When true, bypass the 60s staleness check.
+     * Used during initial render so disk-hydrated user data (positions/orders)
+     * is returned regardless of age, avoiding a skeleton flash.
      * @returns The cached user data, or null if no valid cache.
      */
-    getCachedUserDataForActiveProvider() {
+    getCachedUserDataForActiveProvider(options) {
         const { activeProvider } = this.state;
         const cache = this.state.cachedUserDataByProvider;
         const staleCutoff = __classPrivateFieldGet(_a, _a, "f", _PerpsController_preloadGuardMs) * 2; // 60s
@@ -598,11 +612,12 @@ class PerpsController extends base_controller_1.BaseController {
         catch {
             // Can't determine current account — trust the cache
         }
+        const skipTTL = options?.skipTTL ?? false;
         const isValidEntry = (entry) => {
             if (!entry) {
                 return false;
             }
-            if (Date.now() - entry.timestamp >= staleCutoff) {
+            if (!skipTTL && Date.now() - entry.timestamp >= staleCutoff) {
                 return false;
             }
             if (currentAddress &&
@@ -617,8 +632,8 @@ class PerpsController extends base_controller_1.BaseController {
             const allOrders = [];
             let defaultAccountState = null;
             let hasValidEntry = false;
-            for (const [providerId] of this.providers) {
-                const key = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_marketCacheKey).call(this, providerId, __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_providerIsTestnet).call(this, providerId));
+            for (const providerId of __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_getAggregatedCacheProviderIds).call(this, Object.keys(cache))) {
+                const key = (0, perpsConfig_1.buildProviderCacheKey)(providerId, this.state.isTestnet);
                 const entry = cache[key];
                 if (!isValidEntry(entry)) {
                     continue;
@@ -641,7 +656,7 @@ class PerpsController extends base_controller_1.BaseController {
             };
         }
         // Single provider mode
-        const key = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_marketCacheKey).call(this, activeProvider, __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_providerIsTestnet).call(this, activeProvider));
+        const key = (0, perpsConfig_1.buildProviderCacheKey)(activeProvider, this.state.isTestnet);
         const entry = cache[key];
         if (!entry || !isValidEntry(entry)) {
             return null;
@@ -1659,6 +1674,12 @@ class PerpsController extends base_controller_1.BaseController {
                 this.update((state) => {
                     state.cachedUserDataByProvider = {};
                 });
+                // Invalidate disk-cached user data for the old account
+                __classPrivateFieldGet(this, _PerpsController_options, "f").infrastructure.diskCache
+                    .removeItem(perpsConfig_1.PERPS_DISK_CACHE_USER_DATA)
+                    .catch(() => {
+                    /* fire-and-forget */
+                });
                 // Only preload if the new account is an EVM account
                 if (currentAddress) {
                     __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_performUserDataPreload).call(this).catch(() => {
@@ -2949,13 +2970,26 @@ _a = PerpsController, _PerpsController_initializationPromise = new WeakMap(), _P
     __classPrivateFieldGet(this, _PerpsController_options, "f").infrastructure.logger.error(error, options);
 }, _PerpsController_debugLog = function _PerpsController_debugLog(...args) {
     __classPrivateFieldGet(this, _PerpsController_options, "f").infrastructure.debugLogger.log(...args);
-}, _PerpsController_marketCacheKey = function _PerpsController_marketCacheKey(providerId, isTestnet) {
-    return `${providerId}:${isTestnet ? 'testnet' : 'mainnet'}`;
-}, _PerpsController_providerIsTestnet = function _PerpsController_providerIsTestnet(providerId) {
-    if (providerId === 'myx') {
-        return perpsConfig_1.PROVIDER_CONFIG.MYX_TESTNET_ONLY || this.state.isTestnet;
-    }
-    return this.state.isTestnet;
+}, _PerpsController_getAggregatedCacheProviderIds = function _PerpsController_getAggregatedCacheProviderIds(cacheKeys) {
+    const providerIds = new Set();
+    const currentNetwork = this.state.isTestnet ? 'testnet' : 'mainnet';
+    for (const [providerId] of this.providers) {
+        providerIds.add(providerId);
+    }
+    for (const key of cacheKeys) {
+        const [providerId, network] = key.split(':');
+        if (!providerId ||
+            network !== currentNetwork ||
+            providerId === 'aggregated') {
+            continue;
+        }
+        if (providerId === 'hyperliquid' ||
+            (providerId === 'myx' && __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_isMYXProviderEnabled).call(this)) ||
+            this.providers.has(providerId)) {
+            providerIds.add(providerId);
+        }
+    }
+    return Array.from(providerIds);
 }, _PerpsController_getOrCreateStandaloneProvider = function _PerpsController_getOrCreateStandaloneProvider() {
     const currentIsTestnet = this.state.isTestnet;
     const currentHip3Version = this.state.hip3ConfigVersion ?? 0;
@@ -3227,11 +3261,7 @@ async function _PerpsController_performInitialization() {
         // IMPORTANT: Must use import() — NOT require() — for core/extension tree-shaking.
         // require() is synchronous and bundlers include it in the main bundle.
         // import() enables true code splitting so MYX is excluded when not enabled.
-        // NOTE: Uses a variable so ts-bridge does not rewrite the import
-        // specifier (which would strip the webpackIgnore magic comment).
-        const myxModulePath = './providers/MYXProvider';
-        __classPrivateFieldSet(this, _PerpsController_myxRegistrationPromise, import(
-        /* webpackIgnore: true */ myxModulePath)
+        __classPrivateFieldSet(this, _PerpsController_myxRegistrationPromise, import("./providers/MYXProvider.cjs")
             .then(({ MYXProvider }) => {
             this.registerMYXProvider(MYXProvider);
             return undefined;
@@ -3312,6 +3342,26 @@ async function _PerpsController_performInitialization() {
     __classPrivateFieldGet(this, _PerpsController_tradingService, "f").setControllerDependencies({
         rewardsIntegrationService: __classPrivateFieldGet(this, _PerpsController_rewardsIntegrationService, "f"),
     });
+}, _PerpsController_hydrateCacheFromDiskSync = function _PerpsController_hydrateCacheFromDiskSync() {
+    const { marketUpdates, userUpdates, stats } = (0, perpsDiskPersistence_1.hydrateFromDiskSync)(__classPrivateFieldGet(this, _PerpsController_options, "f").infrastructure.diskCache, this.state.cachedMarketDataByProvider, this.state.cachedUserDataByProvider, __classPrivateFieldGet(_a, _a, "f", _PerpsController_preloadGuardMs));
+    const hasMarketUpdates = Object.keys(marketUpdates).length > 0;
+    const hasUserUpdates = Object.keys(userUpdates).length > 0;
+    if (hasMarketUpdates || hasUserUpdates) {
+        this.update((state) => {
+            if (hasMarketUpdates) {
+                Object.assign(state.cachedMarketDataByProvider, marketUpdates);
+            }
+            if (hasUserUpdates) {
+                Object.assign(state.cachedUserDataByProvider, userUpdates);
+            }
+        });
+    }
+    __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Disk cache hydrated (sync)', {
+        markets: stats.marketCount,
+        positions: stats.userPositions,
+        orders: stats.userOrders,
+        duration_ms: stats.durationMs,
+    });
 }, _PerpsController_performMarketDataPreload = 
 /**
  * Perform a single market data preload (best-effort, no throw).
@@ -3331,7 +3381,7 @@ async function _PerpsController_performMarketDataPreload() {
     const actualProviderId = this.activeProviderInstance
         ? this.state.activeProvider // includes 'aggregated'
         : 'hyperliquid';
-    const cacheKey = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_marketCacheKey).call(this, actualProviderId, __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_providerIsTestnet).call(this, actualProviderId));
+    const cacheKey = (0, perpsConfig_1.buildProviderCacheKey)(actualProviderId, this.state.isTestnet);
     const now = Date.now();
     const existingEntry = this.state.cachedMarketDataByProvider[cacheKey];
     if (existingEntry &&
@@ -3353,9 +3403,15 @@ async function _PerpsController_performMarketDataPreload() {
             },
         });
         __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Fetching market data in background');
+        __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: rest_preload_start');
         const data = await this.getMarketDataWithPrices({ standalone: true });
+        __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: rest_preload_end', {
+            duration_ms: Math.round(performance.now() - preloadStart),
+            markets: data.length,
+        });
         // Store under per-provider key(s)
         const ts = Date.now();
+        const marketDiskEntries = [];
         if (this.state.activeProvider === 'aggregated' &&
             this.activeProviderInstance) {
             // Split returned data by providerId and store each slice
@@ -3373,7 +3429,12 @@ async function _PerpsController_performMarketDataPreload() {
             }
             this.update((state) => {
                 for (const [pid, slice] of byProvider) {
-                    const key = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_marketCacheKey).call(this, pid, __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_providerIsTestnet).call(this, pid));
+                    const key = (0, perpsConfig_1.buildProviderCacheKey)(pid, this.state.isTestnet);
+                    marketDiskEntries.push({
+                        providerNetworkKey: key,
+                        data: slice,
+                        timestamp: ts,
+                    });
                     state.cachedMarketDataByProvider[key] = {
                         data: slice,
                         timestamp: ts,
@@ -3387,6 +3448,11 @@ async function _PerpsController_performMarketDataPreload() {
             });
         }
         else {
+            marketDiskEntries.push({
+                providerNetworkKey: cacheKey,
+                data,
+                timestamp: ts,
+            });
             this.update((state) => {
                 state.cachedMarketDataByProvider[cacheKey] = {
                     data,
@@ -3394,6 +3460,7 @@ async function _PerpsController_performMarketDataPreload() {
                 };
             });
         }
+        (0, perpsDiskPersistence_1.persistMarketEntriesToDisk)(__classPrivateFieldGet(this, _PerpsController_options, "f").infrastructure.diskCache, marketDiskEntries);
         __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: Market data preloaded', {
             marketCount: data.length,
         });
@@ -3441,7 +3508,7 @@ async function _PerpsController_performUserDataPreload() {
     const actualProviderId = this.activeProviderInstance
         ? this.state.activeProvider // includes 'aggregated'
         : 'hyperliquid';
-    const userCacheKey = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_marketCacheKey).call(this, actualProviderId, __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_providerIsTestnet).call(this, actualProviderId));
+    const userCacheKey = (0, perpsConfig_1.buildProviderCacheKey)(actualProviderId, this.state.isTestnet);
     // Skip if cache is fresh and for same account
     const now = Date.now();
     const existingEntry = this.state.cachedUserDataByProvider[userCacheKey];
@@ -3500,9 +3567,18 @@ async function _PerpsController_performUserDataPreload() {
             }
             // AccountState — assign to its provider bucket
             ensureBucket(accountState.providerId ?? fallbackProviderId).accountState = accountState;
+            const diskEntries = [];
             this.update((state) => {
                 for (const [pid, data] of byProvider) {
-                    const key = __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_marketCacheKey).call(this, pid, __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_providerIsTestnet).call(this, pid));
+                    const key = (0, perpsConfig_1.buildProviderCacheKey)(pid, this.state.isTestnet);
+                    diskEntries.push({
+                        providerNetworkKey: key,
+                        address: userAddress,
+                        positions: data.positions,
+                        orders: data.orders,
+                        accountState: data.accountState,
+                        timestamp: ts,
+                    });
                     state.cachedUserDataByProvider[key] = {
                         ...data,
                         timestamp: ts,
@@ -3518,18 +3594,30 @@ async function _PerpsController_performUserDataPreload() {
                     address: userAddress,
                 };
             });
+            (0, perpsDiskPersistence_1.persistUserEntriesToDisk)(__classPrivateFieldGet(this, _PerpsController_options, "f").infrastructure.diskCache, diskEntries);
         }
         else {
             // Single provider — store directly under its key
+            const ts = Date.now();
             this.update((state) => {
                 state.cachedUserDataByProvider[userCacheKey] = {
                     positions,
                     orders,
                     accountState,
-                    timestamp: Date.now(),
+                    timestamp: ts,
                     address: userAddress,
                 };
             });
+            (0, perpsDiskPersistence_1.persistUserEntriesToDisk)(__classPrivateFieldGet(this, _PerpsController_options, "f").infrastructure.diskCache, [
+                {
+                    providerNetworkKey: userCacheKey,
+                    address: userAddress,
+                    positions,
+                    orders,
+                    accountState,
+                    timestamp: ts,
+                },
+            ]);
         }
         __classPrivateFieldGet(this, _PerpsController_instances, "m", _PerpsController_debugLog).call(this, 'PerpsController: User data preloaded', {
             positionCount: positions.length,