@metamask-previews/config-registry-controller 0.0.0-preview-32ed9958c

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial release ([#7668](https://github.com/MetaMask/core/pull/7668), [#7809](https://github.com/MetaMask/core/pull/7809))
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/config-registry-controller`
+
+Manages configuration registry for MetaMask
+
+## Installation
+
+`yarn add @metamask/config-registry-controller`
+
+or
+
+`npm install @metamask/config-registry-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/ConfigRegistryController.cjs

@@ -0,0 +1,132 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    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 __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ConfigRegistryController_isConfigRegistryApiEnabled;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigRegistryController = exports.DEFAULT_POLLING_INTERVAL = void 0;
+const polling_controller_1 = require("@metamask/polling-controller");
+const utils_1 = require("@metamask/utils");
+const feature_flags_1 = require("./utils/feature-flags.cjs");
+const controllerName = 'ConfigRegistryController';
+exports.DEFAULT_POLLING_INTERVAL = (0, utils_1.inMilliseconds)(1, utils_1.Duration.Day);
+const stateMetadata = {
+    configs: {
+        persist: true,
+        includeInStateLogs: false,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+    version: {
+        persist: true,
+        includeInStateLogs: true,
+        includeInDebugSnapshot: true,
+        usedInUi: false,
+    },
+    lastFetched: {
+        persist: true,
+        includeInStateLogs: true,
+        includeInDebugSnapshot: true,
+        usedInUi: false,
+    },
+    etag: {
+        persist: true,
+        includeInStateLogs: false,
+        includeInDebugSnapshot: false,
+        usedInUi: false,
+    },
+};
+/**
+ * Default fallback configuration when no configs are available.
+ */
+const DEFAULT_FALLBACK_CONFIG = {};
+class ConfigRegistryController extends (0, polling_controller_1.StaticIntervalPollingController)() {
+    /**
+     * @param options - The controller options.
+     * @param options.messenger - The controller messenger. Must have
+     * `ConfigRegistryApiService:fetchConfig` action handler registered.
+     * @param options.state - Initial state.
+     * @param options.pollingInterval - Polling interval in milliseconds.
+     * @param options.fallbackConfig - Fallback configuration.
+     * @param options.isConfigRegistryApiEnabled - Function to check if the config
+     * registry API is enabled. Defaults to checking the remote feature flag.
+     */
+    constructor({ messenger, state = {}, pollingInterval = exports.DEFAULT_POLLING_INTERVAL, fallbackConfig = DEFAULT_FALLBACK_CONFIG, isConfigRegistryApiEnabled = feature_flags_1.isConfigRegistryApiEnabled, }) {
+        super({
+            name: controllerName,
+            metadata: stateMetadata,
+            messenger,
+            state: {
+                configs: {
+                    networks: state.configs?.networks ?? { ...fallbackConfig },
+                },
+                version: state.version ?? null,
+                lastFetched: state.lastFetched ?? null,
+                etag: state.etag ?? null,
+            },
+        });
+        _ConfigRegistryController_isConfigRegistryApiEnabled.set(this, void 0);
+        this.setIntervalLength(pollingInterval);
+        __classPrivateFieldSet(this, _ConfigRegistryController_isConfigRegistryApiEnabled, isConfigRegistryApiEnabled, "f");
+        this.messenger.registerActionHandler(`${controllerName}:startPolling`, this.startPolling.bind(this));
+        this.messenger.registerActionHandler(`${controllerName}:stopPolling`, this.stopAllPolling.bind(this));
+        this.messenger.subscribe('KeyringController:unlock', () => this.startPolling(null));
+        this.messenger.subscribe('KeyringController:lock', () => this.stopAllPolling());
+    }
+    async _executePoll(_input) {
+        const isApiEnabled = __classPrivateFieldGet(this, _ConfigRegistryController_isConfigRegistryApiEnabled, "f").call(this, this.messenger);
+        // Skip fetch when API is disabled; client uses static config.
+        if (!isApiEnabled) {
+            return;
+        }
+        const interval = this.getIntervalLength() ?? exports.DEFAULT_POLLING_INTERVAL;
+        if (this.state.lastFetched !== null &&
+            Date.now() - this.state.lastFetched < interval) {
+            return;
+        }
+        try {
+            const result = await this.messenger.call('ConfigRegistryApiService:fetchConfig', {
+                etag: this.state.etag ?? undefined,
+            });
+            if (!result.modified) {
+                this.update((state) => {
+                    state.lastFetched = Date.now();
+                    if (result.etag !== undefined) {
+                        state.etag = result.etag ?? null;
+                    }
+                });
+                return;
+            }
+            const apiChains = result.data.data.chains;
+            const newConfigs = {};
+            // duplicate chainIds from API response are not expected
+            apiChains.forEach((chainConfig) => {
+                const { chainId } = chainConfig;
+                newConfigs[chainId] = chainConfig;
+            });
+            this.update((state) => {
+                state.configs.networks = newConfigs;
+                state.version = result.data.data.version;
+                state.lastFetched = Date.now();
+                if (result.etag !== undefined) {
+                    state.etag = result.etag;
+                }
+            });
+        }
+        catch (error) {
+            const errorInstance = error instanceof Error ? error : new Error(String(error));
+            this.messenger.captureException?.(errorInstance);
+        }
+    }
+}
+exports.ConfigRegistryController = ConfigRegistryController;
+_ConfigRegistryController_isConfigRegistryApiEnabled = new WeakMap();
+//# sourceMappingURL=ConfigRegistryController.cjs.map

package/dist/ConfigRegistryController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigRegistryController.cjs","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAUA,qEAA+E;AAE/E,2CAA2D;AAO3D,6DAAwG;AAExG,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAErC,QAAA,wBAAwB,GAAG,IAAA,sBAAc,EAAC,CAAC,EAAE,gBAAQ,CAAC,GAAG,CAAC,CAAC;AAwCxE,MAAM,aAAa,GAAG;IACpB,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,IAAI;QACxB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;IACD,WAAW,EAAE;QACX,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,IAAI;QACxB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;CACqD,CAAC;AAEzD;;GAEG;AACH,MAAM,uBAAuB,GAA0C,EAAE,CAAC;AAwF1E,MAAa,wBAAyB,SAAQ,IAAA,oDAA+B,GAI5E;IAKC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,EACV,eAAe,GAAG,gCAAwB,EAC1C,cAAc,GAAG,uBAAuB,EACxC,0BAA0B,GAAG,0CAAiC,GAC9B;QAChC,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,EAAE;gBACL,OAAO,EAAE;oBACP,QAAQ,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,IAAI,EAAE,GAAG,cAAc,EAAE;iBAC3D;gBACD,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;gBAC9B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;gBACtC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;aACzB;SACF,CAAC,CAAC;QAjCI,uEAEI;QAiCX,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QACxC,uBAAA,IAAI,wDAA+B,0BAA0B,MAAA,CAAC;QAE9D,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,eAAe,EAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,cAAc,EAC/B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE,CACxD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CACxB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE,CACtD,IAAI,CAAC,cAAc,EAAE,CACtB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAY;QAC7B,MAAM,YAAY,GAAG,uBAAA,IAAI,4DAA4B,MAAhC,IAAI,EAA6B,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtE,8DAA8D;QAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,IAAI,gCAAwB,CAAC;QACtE,IACE,IAAI,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI;YAC/B,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,QAAQ,EAC9C,CAAC;YACD,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAsB,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACzD,sCAAsC,EACtC;gBACE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,SAAS;aACnC,CACF,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACrB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC/B,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;wBAC9B,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC;oBACnC,CAAC;gBACH,CAAC,CAAC,CAAC;gBACH,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YAC1C,MAAM,UAAU,GAA0C,EAAE,CAAC;YAC7D,wDAAwD;YACxD,SAAS,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;gBAChC,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;gBAChC,UAAU,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC;YACpC,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC;gBACpC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;gBACzC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC9B,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;gBAC3B,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,aAAa,GACjB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5D,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,aAAa,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;CACF;AAvHD,4DAuHC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type {\n  FetchConfigOptions,\n  FetchConfigResult,\n  RegistryNetworkConfig,\n} from './config-registry-api-service';\nimport { isConfigRegistryApiEnabled as defaultIsConfigRegistryApiEnabled } from './utils/feature-flags';\n\nconst controllerName = 'ConfigRegistryController';\n\nexport const DEFAULT_POLLING_INTERVAL = inMilliseconds(1, Duration.Day);\n\n/**\n * State for the ConfigRegistryController.\n *\n * Tracks network configurations fetched from the config registry API,\n * along with metadata about the fetch status and caching.\n */\nexport type ConfigRegistryControllerState = {\n  /**\n   * Network configurations organized by chain ID.\n   * Stores the full API response including isFeatured, isTestnet, etc.\n   * Use selectors (e.g. selectFeaturedNetworks) to filter when needed.\n   */\n  configs: {\n    networks: Record<string, RegistryNetworkConfig>;\n  };\n  /**\n   * Semantic version string of the configuration data from the API.\n   * Indicates the version/schema of the configuration structure itself\n   * (e.g., \"v1.0.0\", \"1.0.0\").\n   * This is different from `etag` which is used for HTTP cache validation.\n   */\n  version: string | null;\n  /**\n   * Timestamp (milliseconds since epoch) of when the configuration\n   * was last successfully fetched from the API.\n   */\n  lastFetched: number | null;\n  /**\n   * HTTP entity tag (ETag) used for cache validation.\n   * Sent as `If-None-Match` header in subsequent requests to check\n   * if the content has changed. If the server returns 304 Not Modified,\n   * the full response body is not downloaded, improving efficiency.\n   * This is different from `version` which is a semantic version string\n   * indicating the schema/version of the configuration data itself.\n   */\n  etag: string | null;\n};\n\nconst stateMetadata = {\n  configs: {\n    persist: true,\n    includeInStateLogs: false,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  version: {\n    persist: true,\n    includeInStateLogs: true,\n    includeInDebugSnapshot: true,\n    usedInUi: false,\n  },\n  lastFetched: {\n    persist: true,\n    includeInStateLogs: true,\n    includeInDebugSnapshot: true,\n    usedInUi: false,\n  },\n  etag: {\n    persist: true,\n    includeInStateLogs: false,\n    includeInDebugSnapshot: false,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<ConfigRegistryControllerState>;\n\n/**\n * Default fallback configuration when no configs are available.\n */\nconst DEFAULT_FALLBACK_CONFIG: Record<string, RegistryNetworkConfig> = {};\n\n/**\n * Published when the state of {@link ConfigRegistryController} changes.\n */\nexport type ConfigRegistryControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    ConfigRegistryControllerState\n  >;\n\n/**\n * Retrieves the state of the {@link ConfigRegistryController}.\n */\nexport type ConfigRegistryControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ConfigRegistryControllerState\n>;\n\n/**\n * Starts polling the config registry API. Returns a polling token that can be\n * used to stop this polling session.\n */\nexport type ConfigRegistryControllerStartPollingAction = {\n  type: `${typeof controllerName}:startPolling`;\n  handler: (input: null) => string;\n};\n\n/**\n * Stops all config registry polling.\n */\nexport type ConfigRegistryControllerStopPollingAction = {\n  type: `${typeof controllerName}:stopPolling`;\n  handler: () => void;\n};\n\n/**\n * Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerActions =\n  | ConfigRegistryControllerGetStateAction\n  | ConfigRegistryControllerStartPollingAction\n  | ConfigRegistryControllerStopPollingAction;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryControllerMessenger}\n * calls.\n */\ntype AllowedActions =\n  | RemoteFeatureFlagControllerGetStateAction\n  | {\n      type: 'ConfigRegistryApiService:fetchConfig';\n      handler: (options?: FetchConfigOptions) => Promise<FetchConfigResult>;\n    };\n\n/**\n * Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerEvents =\n  ConfigRegistryControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ConfigRegistryControllerMessenger}\n * subscribes to.\n */\ntype AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ConfigRegistryController}.\n */\nexport type ConfigRegistryControllerMessenger = Messenger<\n  typeof controllerName,\n  ConfigRegistryControllerActions | AllowedActions,\n  ConfigRegistryControllerEvents | AllowedEvents\n>;\n\n/** @deprecated Use {@link ConfigRegistryControllerMessenger} instead. */\nexport type ConfigRegistryMessenger = ConfigRegistryControllerMessenger;\n\nexport type ConfigRegistryControllerOptions = {\n  messenger: ConfigRegistryMessenger;\n  state?: Partial<ConfigRegistryControllerState>;\n  pollingInterval?: number;\n  fallbackConfig?: Record<string, RegistryNetworkConfig>;\n  isConfigRegistryApiEnabled?: (messenger: ConfigRegistryMessenger) => boolean;\n};\n\nexport class ConfigRegistryController extends StaticIntervalPollingController<null>()<\n  typeof controllerName,\n  ConfigRegistryControllerState,\n  ConfigRegistryMessenger\n> {\n  readonly #isConfigRegistryApiEnabled: (\n    messenger: ConfigRegistryMessenger,\n  ) => boolean;\n\n  /**\n   * @param options - The controller options.\n   * @param options.messenger - The controller messenger. Must have\n   * `ConfigRegistryApiService:fetchConfig` action handler registered.\n   * @param options.state - Initial state.\n   * @param options.pollingInterval - Polling interval in milliseconds.\n   * @param options.fallbackConfig - Fallback configuration.\n   * @param options.isConfigRegistryApiEnabled - Function to check if the config\n   * registry API is enabled. Defaults to checking the remote feature flag.\n   */\n  constructor({\n    messenger,\n    state = {},\n    pollingInterval = DEFAULT_POLLING_INTERVAL,\n    fallbackConfig = DEFAULT_FALLBACK_CONFIG,\n    isConfigRegistryApiEnabled = defaultIsConfigRegistryApiEnabled,\n  }: ConfigRegistryControllerOptions) {\n    super({\n      name: controllerName,\n      metadata: stateMetadata,\n      messenger,\n      state: {\n        configs: {\n          networks: state.configs?.networks ?? { ...fallbackConfig },\n        },\n        version: state.version ?? null,\n        lastFetched: state.lastFetched ?? null,\n        etag: state.etag ?? null,\n      },\n    });\n\n    this.setIntervalLength(pollingInterval);\n    this.#isConfigRegistryApiEnabled = isConfigRegistryApiEnabled;\n\n    this.messenger.registerActionHandler(\n      `${controllerName}:startPolling`,\n      this.startPolling.bind(this),\n    );\n\n    this.messenger.registerActionHandler(\n      `${controllerName}:stopPolling`,\n      this.stopAllPolling.bind(this),\n    );\n\n    this.messenger.subscribe('KeyringController:unlock', () =>\n      this.startPolling(null),\n    );\n\n    this.messenger.subscribe('KeyringController:lock', () =>\n      this.stopAllPolling(),\n    );\n  }\n\n  async _executePoll(_input: null): Promise<void> {\n    const isApiEnabled = this.#isConfigRegistryApiEnabled(this.messenger);\n\n    // Skip fetch when API is disabled; client uses static config.\n    if (!isApiEnabled) {\n      return;\n    }\n\n    const interval = this.getIntervalLength() ?? DEFAULT_POLLING_INTERVAL;\n    if (\n      this.state.lastFetched !== null &&\n      Date.now() - this.state.lastFetched < interval\n    ) {\n      return;\n    }\n\n    try {\n      const result: FetchConfigResult = await this.messenger.call(\n        'ConfigRegistryApiService:fetchConfig',\n        {\n          etag: this.state.etag ?? undefined,\n        },\n      );\n\n      if (!result.modified) {\n        this.update((state) => {\n          state.lastFetched = Date.now();\n          if (result.etag !== undefined) {\n            state.etag = result.etag ?? null;\n          }\n        });\n        return;\n      }\n\n      const apiChains = result.data.data.chains;\n      const newConfigs: Record<string, RegistryNetworkConfig> = {};\n      // duplicate chainIds from API response are not expected\n      apiChains.forEach((chainConfig) => {\n        const { chainId } = chainConfig;\n        newConfigs[chainId] = chainConfig;\n      });\n\n      this.update((state) => {\n        state.configs.networks = newConfigs;\n        state.version = result.data.data.version;\n        state.lastFetched = Date.now();\n        if (result.etag !== undefined) {\n          state.etag = result.etag;\n        }\n      });\n    } catch (error) {\n      const errorInstance =\n        error instanceof Error ? error : new Error(String(error));\n\n      this.messenger.captureException?.(errorInstance);\n    }\n  }\n}\n"]}

package/dist/ConfigRegistryController.d.cts

@@ -0,0 +1,134 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
+import type { Messenger } from "@metamask/messenger";
+import { RemoteFeatureFlagControllerGetStateAction } from "@metamask/remote-feature-flag-controller";
+import type { FetchConfigOptions, FetchConfigResult, RegistryNetworkConfig } from "./config-registry-api-service/index.cjs";
+declare const controllerName = "ConfigRegistryController";
+export declare const DEFAULT_POLLING_INTERVAL: number;
+/**
+ * State for the ConfigRegistryController.
+ *
+ * Tracks network configurations fetched from the config registry API,
+ * along with metadata about the fetch status and caching.
+ */
+export type ConfigRegistryControllerState = {
+    /**
+     * Network configurations organized by chain ID.
+     * Stores the full API response including isFeatured, isTestnet, etc.
+     * Use selectors (e.g. selectFeaturedNetworks) to filter when needed.
+     */
+    configs: {
+        networks: Record<string, RegistryNetworkConfig>;
+    };
+    /**
+     * Semantic version string of the configuration data from the API.
+     * Indicates the version/schema of the configuration structure itself
+     * (e.g., "v1.0.0", "1.0.0").
+     * This is different from `etag` which is used for HTTP cache validation.
+     */
+    version: string | null;
+    /**
+     * Timestamp (milliseconds since epoch) of when the configuration
+     * was last successfully fetched from the API.
+     */
+    lastFetched: number | null;
+    /**
+     * HTTP entity tag (ETag) used for cache validation.
+     * Sent as `If-None-Match` header in subsequent requests to check
+     * if the content has changed. If the server returns 304 Not Modified,
+     * the full response body is not downloaded, improving efficiency.
+     * This is different from `version` which is a semantic version string
+     * indicating the schema/version of the configuration data itself.
+     */
+    etag: string | null;
+};
+/**
+ * Published when the state of {@link ConfigRegistryController} changes.
+ */
+export type ConfigRegistryControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ConfigRegistryControllerState>;
+/**
+ * Retrieves the state of the {@link ConfigRegistryController}.
+ */
+export type ConfigRegistryControllerGetStateAction = ControllerGetStateAction<typeof controllerName, ConfigRegistryControllerState>;
+/**
+ * Starts polling the config registry API. Returns a polling token that can be
+ * used to stop this polling session.
+ */
+export type ConfigRegistryControllerStartPollingAction = {
+    type: `${typeof controllerName}:startPolling`;
+    handler: (input: null) => string;
+};
+/**
+ * Stops all config registry polling.
+ */
+export type ConfigRegistryControllerStopPollingAction = {
+    type: `${typeof controllerName}:stopPolling`;
+    handler: () => void;
+};
+/**
+ * Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.
+ */
+export type ConfigRegistryControllerActions = ConfigRegistryControllerGetStateAction | ConfigRegistryControllerStartPollingAction | ConfigRegistryControllerStopPollingAction;
+/**
+ * Actions from other messengers that {@link ConfigRegistryControllerMessenger}
+ * calls.
+ */
+type AllowedActions = RemoteFeatureFlagControllerGetStateAction | {
+    type: 'ConfigRegistryApiService:fetchConfig';
+    handler: (options?: FetchConfigOptions) => Promise<FetchConfigResult>;
+};
+/**
+ * Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.
+ */
+export type ConfigRegistryControllerEvents = ConfigRegistryControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link ConfigRegistryControllerMessenger}
+ * subscribes to.
+ */
+type AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link ConfigRegistryController}.
+ */
+export type ConfigRegistryControllerMessenger = Messenger<typeof controllerName, ConfigRegistryControllerActions | AllowedActions, ConfigRegistryControllerEvents | AllowedEvents>;
+/** @deprecated Use {@link ConfigRegistryControllerMessenger} instead. */
+export type ConfigRegistryMessenger = ConfigRegistryControllerMessenger;
+export type ConfigRegistryControllerOptions = {
+    messenger: ConfigRegistryMessenger;
+    state?: Partial<ConfigRegistryControllerState>;
+    pollingInterval?: number;
+    fallbackConfig?: Record<string, RegistryNetworkConfig>;
+    isConfigRegistryApiEnabled?: (messenger: ConfigRegistryMessenger) => boolean;
+};
+declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
+    readonly "__#15@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#15@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPolling(input: null): void;
+    _stopPollingByPollingTokenSetId(key: string): void;
+    readonly "__#3@#pollingTokenSets": Map<string, Set<string>>;
+    readonly "__#3@#callbacks": Map<string, Set<(input: null) => void>>;
+    _executePoll(input: null): Promise<void>;
+    startPolling(input: null): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingComplete(input: null, callback: (input: null) => void): void;
+}) & typeof import("@metamask/base-controller").BaseController;
+export declare class ConfigRegistryController extends ConfigRegistryController_base<typeof controllerName, ConfigRegistryControllerState, ConfigRegistryMessenger> {
+    #private;
+    /**
+     * @param options - The controller options.
+     * @param options.messenger - The controller messenger. Must have
+     * `ConfigRegistryApiService:fetchConfig` action handler registered.
+     * @param options.state - Initial state.
+     * @param options.pollingInterval - Polling interval in milliseconds.
+     * @param options.fallbackConfig - Fallback configuration.
+     * @param options.isConfigRegistryApiEnabled - Function to check if the config
+     * registry API is enabled. Defaults to checking the remote feature flag.
+     */
+    constructor({ messenger, state, pollingInterval, fallbackConfig, isConfigRegistryApiEnabled, }: ConfigRegistryControllerOptions);
+    _executePoll(_input: null): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ConfigRegistryController.d.cts.map

package/dist/ConfigRegistryController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigRegistryController.d.cts","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,yCAAyC,EAAE,iDAAiD;AAGrG,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EACtB,gDAAsC;AAGvC,QAAA,MAAM,cAAc,6BAA6B,CAAC;AAElD,eAAO,MAAM,wBAAwB,QAAkC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;KACjD,CAAC;IACF;;;;;OAKG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAkCF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,GAAG,OAAO,cAAc,eAAe,CAAC;IAC9C,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,KAAK,MAAM,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,GAAG,OAAO,cAAc,cAAc,CAAC;IAC7C,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,0CAA0C,GAC1C,yCAAyC,CAAC;AAE9C;;;GAGG;AACH,KAAK,cAAc,GACf,yCAAyC,GACzC;IACE,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACvE,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GAAG,4BAA4B,GAAG,0BAA0B,CAAC;AAE/E;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,uBAAuB,GAAG,iCAAiC,CAAC;AAExE,MAAM,MAAM,+BAA+B,GAAG;IAC5C,SAAS,EAAE,uBAAuB,CAAC;IACnC,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACvD,0BAA0B,CAAC,EAAE,CAAC,SAAS,EAAE,uBAAuB,KAAK,OAAO,CAAC;CAC9E,CAAC;;;;;;;;;;;;;;;;AAEF,qBAAa,wBAAyB,SAAQ,8BAC5C,OAAO,cAAc,EACrB,6BAA6B,EAC7B,uBAAuB,CACxB;;IAKC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAU,EACV,eAA0C,EAC1C,cAAwC,EACxC,0BAA8D,GAC/D,EAAE,+BAA+B;IAqC5B,YAAY,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAyDhD"}

package/dist/ConfigRegistryController.d.mts

@@ -0,0 +1,134 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
+import type { Messenger } from "@metamask/messenger";
+import { RemoteFeatureFlagControllerGetStateAction } from "@metamask/remote-feature-flag-controller";
+import type { FetchConfigOptions, FetchConfigResult, RegistryNetworkConfig } from "./config-registry-api-service/index.mjs";
+declare const controllerName = "ConfigRegistryController";
+export declare const DEFAULT_POLLING_INTERVAL: number;
+/**
+ * State for the ConfigRegistryController.
+ *
+ * Tracks network configurations fetched from the config registry API,
+ * along with metadata about the fetch status and caching.
+ */
+export type ConfigRegistryControllerState = {
+    /**
+     * Network configurations organized by chain ID.
+     * Stores the full API response including isFeatured, isTestnet, etc.
+     * Use selectors (e.g. selectFeaturedNetworks) to filter when needed.
+     */
+    configs: {
+        networks: Record<string, RegistryNetworkConfig>;
+    };
+    /**
+     * Semantic version string of the configuration data from the API.
+     * Indicates the version/schema of the configuration structure itself
+     * (e.g., "v1.0.0", "1.0.0").
+     * This is different from `etag` which is used for HTTP cache validation.
+     */
+    version: string | null;
+    /**
+     * Timestamp (milliseconds since epoch) of when the configuration
+     * was last successfully fetched from the API.
+     */
+    lastFetched: number | null;
+    /**
+     * HTTP entity tag (ETag) used for cache validation.
+     * Sent as `If-None-Match` header in subsequent requests to check
+     * if the content has changed. If the server returns 304 Not Modified,
+     * the full response body is not downloaded, improving efficiency.
+     * This is different from `version` which is a semantic version string
+     * indicating the schema/version of the configuration data itself.
+     */
+    etag: string | null;
+};
+/**
+ * Published when the state of {@link ConfigRegistryController} changes.
+ */
+export type ConfigRegistryControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ConfigRegistryControllerState>;
+/**
+ * Retrieves the state of the {@link ConfigRegistryController}.
+ */
+export type ConfigRegistryControllerGetStateAction = ControllerGetStateAction<typeof controllerName, ConfigRegistryControllerState>;
+/**
+ * Starts polling the config registry API. Returns a polling token that can be
+ * used to stop this polling session.
+ */
+export type ConfigRegistryControllerStartPollingAction = {
+    type: `${typeof controllerName}:startPolling`;
+    handler: (input: null) => string;
+};
+/**
+ * Stops all config registry polling.
+ */
+export type ConfigRegistryControllerStopPollingAction = {
+    type: `${typeof controllerName}:stopPolling`;
+    handler: () => void;
+};
+/**
+ * Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.
+ */
+export type ConfigRegistryControllerActions = ConfigRegistryControllerGetStateAction | ConfigRegistryControllerStartPollingAction | ConfigRegistryControllerStopPollingAction;
+/**
+ * Actions from other messengers that {@link ConfigRegistryControllerMessenger}
+ * calls.
+ */
+type AllowedActions = RemoteFeatureFlagControllerGetStateAction | {
+    type: 'ConfigRegistryApiService:fetchConfig';
+    handler: (options?: FetchConfigOptions) => Promise<FetchConfigResult>;
+};
+/**
+ * Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.
+ */
+export type ConfigRegistryControllerEvents = ConfigRegistryControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link ConfigRegistryControllerMessenger}
+ * subscribes to.
+ */
+type AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link ConfigRegistryController}.
+ */
+export type ConfigRegistryControllerMessenger = Messenger<typeof controllerName, ConfigRegistryControllerActions | AllowedActions, ConfigRegistryControllerEvents | AllowedEvents>;
+/** @deprecated Use {@link ConfigRegistryControllerMessenger} instead. */
+export type ConfigRegistryMessenger = ConfigRegistryControllerMessenger;
+export type ConfigRegistryControllerOptions = {
+    messenger: ConfigRegistryMessenger;
+    state?: Partial<ConfigRegistryControllerState>;
+    pollingInterval?: number;
+    fallbackConfig?: Record<string, RegistryNetworkConfig>;
+    isConfigRegistryApiEnabled?: (messenger: ConfigRegistryMessenger) => boolean;
+};
+declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
+    readonly "__#15@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#15@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPolling(input: null): void;
+    _stopPollingByPollingTokenSetId(key: string): void;
+    readonly "__#3@#pollingTokenSets": Map<string, Set<string>>;
+    readonly "__#3@#callbacks": Map<string, Set<(input: null) => void>>;
+    _executePoll(input: null): Promise<void>;
+    startPolling(input: null): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingComplete(input: null, callback: (input: null) => void): void;
+}) & typeof import("@metamask/base-controller").BaseController;
+export declare class ConfigRegistryController extends ConfigRegistryController_base<typeof controllerName, ConfigRegistryControllerState, ConfigRegistryMessenger> {
+    #private;
+    /**
+     * @param options - The controller options.
+     * @param options.messenger - The controller messenger. Must have
+     * `ConfigRegistryApiService:fetchConfig` action handler registered.
+     * @param options.state - Initial state.
+     * @param options.pollingInterval - Polling interval in milliseconds.
+     * @param options.fallbackConfig - Fallback configuration.
+     * @param options.isConfigRegistryApiEnabled - Function to check if the config
+     * registry API is enabled. Defaults to checking the remote feature flag.
+     */
+    constructor({ messenger, state, pollingInterval, fallbackConfig, isConfigRegistryApiEnabled, }: ConfigRegistryControllerOptions);
+    _executePoll(_input: null): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ConfigRegistryController.d.mts.map

package/dist/ConfigRegistryController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigRegistryController.d.mts","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,yCAAyC,EAAE,iDAAiD;AAGrG,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EACtB,gDAAsC;AAGvC,QAAA,MAAM,cAAc,6BAA6B,CAAC;AAElD,eAAO,MAAM,wBAAwB,QAAkC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;KACjD,CAAC;IACF;;;;;OAKG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAkCF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,GAAG,OAAO,cAAc,eAAe,CAAC;IAC9C,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,KAAK,MAAM,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,GAAG,OAAO,cAAc,cAAc,CAAC;IAC7C,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,0CAA0C,GAC1C,yCAAyC,CAAC;AAE9C;;;GAGG;AACH,KAAK,cAAc,GACf,yCAAyC,GACzC;IACE,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACvE,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GAAG,4BAA4B,GAAG,0BAA0B,CAAC;AAE/E;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,uBAAuB,GAAG,iCAAiC,CAAC;AAExE,MAAM,MAAM,+BAA+B,GAAG;IAC5C,SAAS,EAAE,uBAAuB,CAAC;IACnC,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACvD,0BAA0B,CAAC,EAAE,CAAC,SAAS,EAAE,uBAAuB,KAAK,OAAO,CAAC;CAC9E,CAAC;;;;;;;;;;;;;;;;AAEF,qBAAa,wBAAyB,SAAQ,8BAC5C,OAAO,cAAc,EACrB,6BAA6B,EAC7B,uBAAuB,CACxB;;IAKC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAU,EACV,eAA0C,EAC1C,cAAwC,EACxC,0BAA8D,GAC/D,EAAE,+BAA+B;IAqC5B,YAAY,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAyDhD"}

package/dist/ConfigRegistryController.mjs

@@ -0,0 +1,128 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    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 __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ConfigRegistryController_isConfigRegistryApiEnabled;
+import { StaticIntervalPollingController } from "@metamask/polling-controller";
+import { Duration, inMilliseconds } from "@metamask/utils";
+import { isConfigRegistryApiEnabled as defaultIsConfigRegistryApiEnabled } from "./utils/feature-flags.mjs";
+const controllerName = 'ConfigRegistryController';
+export const DEFAULT_POLLING_INTERVAL = inMilliseconds(1, Duration.Day);
+const stateMetadata = {
+    configs: {
+        persist: true,
+        includeInStateLogs: false,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+    version: {
+        persist: true,
+        includeInStateLogs: true,
+        includeInDebugSnapshot: true,
+        usedInUi: false,
+    },
+    lastFetched: {
+        persist: true,
+        includeInStateLogs: true,
+        includeInDebugSnapshot: true,
+        usedInUi: false,
+    },
+    etag: {
+        persist: true,
+        includeInStateLogs: false,
+        includeInDebugSnapshot: false,
+        usedInUi: false,
+    },
+};
+/**
+ * Default fallback configuration when no configs are available.
+ */
+const DEFAULT_FALLBACK_CONFIG = {};
+export class ConfigRegistryController extends StaticIntervalPollingController() {
+    /**
+     * @param options - The controller options.
+     * @param options.messenger - The controller messenger. Must have
+     * `ConfigRegistryApiService:fetchConfig` action handler registered.
+     * @param options.state - Initial state.
+     * @param options.pollingInterval - Polling interval in milliseconds.
+     * @param options.fallbackConfig - Fallback configuration.
+     * @param options.isConfigRegistryApiEnabled - Function to check if the config
+     * registry API is enabled. Defaults to checking the remote feature flag.
+     */
+    constructor({ messenger, state = {}, pollingInterval = DEFAULT_POLLING_INTERVAL, fallbackConfig = DEFAULT_FALLBACK_CONFIG, isConfigRegistryApiEnabled = defaultIsConfigRegistryApiEnabled, }) {
+        super({
+            name: controllerName,
+            metadata: stateMetadata,
+            messenger,
+            state: {
+                configs: {
+                    networks: state.configs?.networks ?? { ...fallbackConfig },
+                },
+                version: state.version ?? null,
+                lastFetched: state.lastFetched ?? null,
+                etag: state.etag ?? null,
+            },
+        });
+        _ConfigRegistryController_isConfigRegistryApiEnabled.set(this, void 0);
+        this.setIntervalLength(pollingInterval);
+        __classPrivateFieldSet(this, _ConfigRegistryController_isConfigRegistryApiEnabled, isConfigRegistryApiEnabled, "f");
+        this.messenger.registerActionHandler(`${controllerName}:startPolling`, this.startPolling.bind(this));
+        this.messenger.registerActionHandler(`${controllerName}:stopPolling`, this.stopAllPolling.bind(this));
+        this.messenger.subscribe('KeyringController:unlock', () => this.startPolling(null));
+        this.messenger.subscribe('KeyringController:lock', () => this.stopAllPolling());
+    }
+    async _executePoll(_input) {
+        const isApiEnabled = __classPrivateFieldGet(this, _ConfigRegistryController_isConfigRegistryApiEnabled, "f").call(this, this.messenger);
+        // Skip fetch when API is disabled; client uses static config.
+        if (!isApiEnabled) {
+            return;
+        }
+        const interval = this.getIntervalLength() ?? DEFAULT_POLLING_INTERVAL;
+        if (this.state.lastFetched !== null &&
+            Date.now() - this.state.lastFetched < interval) {
+            return;
+        }
+        try {
+            const result = await this.messenger.call('ConfigRegistryApiService:fetchConfig', {
+                etag: this.state.etag ?? undefined,
+            });
+            if (!result.modified) {
+                this.update((state) => {
+                    state.lastFetched = Date.now();
+                    if (result.etag !== undefined) {
+                        state.etag = result.etag ?? null;
+                    }
+                });
+                return;
+            }
+            const apiChains = result.data.data.chains;
+            const newConfigs = {};
+            // duplicate chainIds from API response are not expected
+            apiChains.forEach((chainConfig) => {
+                const { chainId } = chainConfig;
+                newConfigs[chainId] = chainConfig;
+            });
+            this.update((state) => {
+                state.configs.networks = newConfigs;
+                state.version = result.data.data.version;
+                state.lastFetched = Date.now();
+                if (result.etag !== undefined) {
+                    state.etag = result.etag;
+                }
+            });
+        }
+        catch (error) {
+            const errorInstance = error instanceof Error ? error : new Error(String(error));
+            this.messenger.captureException?.(errorInstance);
+        }
+    }
+}
+_ConfigRegistryController_isConfigRegistryApiEnabled = new WeakMap();
+//# sourceMappingURL=ConfigRegistryController.mjs.map