@metamask-previews/network-connection-banner-controller 0.1.0-preview-7507a11

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 ([#9041](https://github.com/MetaMask/core/pull/9041))
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 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,18 @@
+# `@metamask/network-connection-banner-controller`
+
+NetworkConnectionBannerController decides when and how to surface the network
+connection banner based on RPC endpoint health. It encapsulates the shared
+rule, the 5s/30s timer state machine, and the eTLD+1 grouping previously
+duplicated across MetaMask clients.
+
+## Installation
+
+`yarn add @metamask/network-connection-banner-controller`
+
+or
+
+`npm install @metamask/network-connection-banner-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/NetworkConnectionBannerController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=NetworkConnectionBannerController-method-action-types.cjs.map

package/dist/NetworkConnectionBannerController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkConnectionBannerController-method-action-types.cjs","sourceRoot":"","sources":["../src/NetworkConnectionBannerController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { NetworkConnectionBannerController } from './NetworkConnectionBannerController';\n\n/**\n * Clears the banner state regardless of the current rule outcome. The next\n * subscription-driven evaluation will re-show the banner if the conditions\n * still hold.\n */\nexport type NetworkConnectionBannerControllerDismissBannerAction = {\n  type: `NetworkConnectionBannerController:dismissBanner`;\n  handler: NetworkConnectionBannerController['dismissBanner'];\n};\n\n/**\n * Switches the chain's default RPC endpoint to its first Infura endpoint,\n * causing the banner to clear once the network becomes available again.\n *\n * @param args - The arguments to this action.\n * @param args.chainId - The chain whose default RPC should be switched.\n * @throws If the chain configuration cannot be found, or if it has no\n * Infura endpoint to switch to, or if the default is already Infura.\n */\nexport type NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcAction = {\n  type: `NetworkConnectionBannerController:switchToDefaultInfuraRpc`;\n  handler: NetworkConnectionBannerController['switchToDefaultInfuraRpc'];\n};\n\n/**\n * Union of all NetworkConnectionBannerController action types.\n */\nexport type NetworkConnectionBannerControllerMethodActions =\n  | NetworkConnectionBannerControllerDismissBannerAction\n  | NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcAction;\n"]}

package/dist/NetworkConnectionBannerController-method-action-types.d.cts

@@ -0,0 +1,32 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { NetworkConnectionBannerController } from "./NetworkConnectionBannerController.cjs";
+/**
+ * Clears the banner state regardless of the current rule outcome. The next
+ * subscription-driven evaluation will re-show the banner if the conditions
+ * still hold.
+ */
+export type NetworkConnectionBannerControllerDismissBannerAction = {
+    type: `NetworkConnectionBannerController:dismissBanner`;
+    handler: NetworkConnectionBannerController['dismissBanner'];
+};
+/**
+ * Switches the chain's default RPC endpoint to its first Infura endpoint,
+ * causing the banner to clear once the network becomes available again.
+ *
+ * @param args - The arguments to this action.
+ * @param args.chainId - The chain whose default RPC should be switched.
+ * @throws If the chain configuration cannot be found, or if it has no
+ * Infura endpoint to switch to, or if the default is already Infura.
+ */
+export type NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcAction = {
+    type: `NetworkConnectionBannerController:switchToDefaultInfuraRpc`;
+    handler: NetworkConnectionBannerController['switchToDefaultInfuraRpc'];
+};
+/**
+ * Union of all NetworkConnectionBannerController action types.
+ */
+export type NetworkConnectionBannerControllerMethodActions = NetworkConnectionBannerControllerDismissBannerAction | NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcAction;
+//# sourceMappingURL=NetworkConnectionBannerController-method-action-types.d.cts.map

package/dist/NetworkConnectionBannerController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkConnectionBannerController-method-action-types.d.cts","sourceRoot":"","sources":["../src/NetworkConnectionBannerController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iCAAiC,EAAE,gDAA4C;AAE7F;;;;GAIG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,iCAAiC,CAAC,eAAe,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,+DAA+D,GAAG;IAC5E,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,iCAAiC,CAAC,0BAA0B,CAAC,CAAC;CACxE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8CAA8C,GACtD,oDAAoD,GACpD,+DAA+D,CAAC"}

package/dist/NetworkConnectionBannerController-method-action-types.d.mts

@@ -0,0 +1,32 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { NetworkConnectionBannerController } from "./NetworkConnectionBannerController.mjs";
+/**
+ * Clears the banner state regardless of the current rule outcome. The next
+ * subscription-driven evaluation will re-show the banner if the conditions
+ * still hold.
+ */
+export type NetworkConnectionBannerControllerDismissBannerAction = {
+    type: `NetworkConnectionBannerController:dismissBanner`;
+    handler: NetworkConnectionBannerController['dismissBanner'];
+};
+/**
+ * Switches the chain's default RPC endpoint to its first Infura endpoint,
+ * causing the banner to clear once the network becomes available again.
+ *
+ * @param args - The arguments to this action.
+ * @param args.chainId - The chain whose default RPC should be switched.
+ * @throws If the chain configuration cannot be found, or if it has no
+ * Infura endpoint to switch to, or if the default is already Infura.
+ */
+export type NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcAction = {
+    type: `NetworkConnectionBannerController:switchToDefaultInfuraRpc`;
+    handler: NetworkConnectionBannerController['switchToDefaultInfuraRpc'];
+};
+/**
+ * Union of all NetworkConnectionBannerController action types.
+ */
+export type NetworkConnectionBannerControllerMethodActions = NetworkConnectionBannerControllerDismissBannerAction | NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcAction;
+//# sourceMappingURL=NetworkConnectionBannerController-method-action-types.d.mts.map

package/dist/NetworkConnectionBannerController-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkConnectionBannerController-method-action-types.d.mts","sourceRoot":"","sources":["../src/NetworkConnectionBannerController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iCAAiC,EAAE,gDAA4C;AAE7F;;;;GAIG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,iCAAiC,CAAC,eAAe,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,+DAA+D,GAAG;IAC5E,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,iCAAiC,CAAC,0BAA0B,CAAC,CAAC;CACxE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8CAA8C,GACtD,oDAAoD,GACpD,+DAA+D,CAAC"}

package/dist/NetworkConnectionBannerController-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=NetworkConnectionBannerController-method-action-types.mjs.map

package/dist/NetworkConnectionBannerController-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkConnectionBannerController-method-action-types.mjs","sourceRoot":"","sources":["../src/NetworkConnectionBannerController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { NetworkConnectionBannerController } from './NetworkConnectionBannerController';\n\n/**\n * Clears the banner state regardless of the current rule outcome. The next\n * subscription-driven evaluation will re-show the banner if the conditions\n * still hold.\n */\nexport type NetworkConnectionBannerControllerDismissBannerAction = {\n  type: `NetworkConnectionBannerController:dismissBanner`;\n  handler: NetworkConnectionBannerController['dismissBanner'];\n};\n\n/**\n * Switches the chain's default RPC endpoint to its first Infura endpoint,\n * causing the banner to clear once the network becomes available again.\n *\n * @param args - The arguments to this action.\n * @param args.chainId - The chain whose default RPC should be switched.\n * @throws If the chain configuration cannot be found, or if it has no\n * Infura endpoint to switch to, or if the default is already Infura.\n */\nexport type NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcAction = {\n  type: `NetworkConnectionBannerController:switchToDefaultInfuraRpc`;\n  handler: NetworkConnectionBannerController['switchToDefaultInfuraRpc'];\n};\n\n/**\n * Union of all NetworkConnectionBannerController action types.\n */\nexport type NetworkConnectionBannerControllerMethodActions =\n  | NetworkConnectionBannerControllerDismissBannerAction\n  | NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcAction;\n"]}

package/dist/NetworkConnectionBannerController.cjs

@@ -0,0 +1,288 @@
+"use strict";
+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 __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 _NetworkConnectionBannerController_instances, _NetworkConnectionBannerController_degradedTimer, _NetworkConnectionBannerController_unavailableTimer, _NetworkConnectionBannerController_evaluate, _NetworkConnectionBannerController_resetBanner, _NetworkConnectionBannerController_clearTimers, _NetworkConnectionBannerController_findFailedNetworkForBanner;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkConnectionBannerController = exports.getDefaultNetworkConnectionBannerControllerState = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const connectivity_controller_1 = require("@metamask/connectivity-controller");
+const network_controller_1 = require("@metamask/network-controller");
+const utils_1 = require("@metamask/utils");
+const url_utils_1 = require("./url-utils.cjs");
+/**
+ * The name of the {@link NetworkConnectionBannerController}, used to namespace
+ * the controller's actions and events and to namespace the controller's state
+ * data when composed with other controllers.
+ */
+exports.controllerName = 'NetworkConnectionBannerController';
+const networkConnectionBannerControllerMetadata = {
+    status: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
+    network: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
+};
+/**
+ * Constructs the default {@link NetworkConnectionBannerController} state.
+ *
+ * @returns The default state.
+ */
+function getDefaultNetworkConnectionBannerControllerState() {
+    return {
+        status: 'available',
+        network: null,
+    };
+}
+exports.getDefaultNetworkConnectionBannerControllerState = getDefaultNetworkConnectionBannerControllerState;
+const DEGRADED_BANNER_TIMEOUT_MS = 5000;
+const UNAVAILABLE_BANNER_TIMEOUT_MS = 30000;
+const MESSENGER_EXPOSED_METHODS = [
+    'dismissBanner',
+    'switchToDefaultInfuraRpc',
+];
+/**
+ * NetworkConnectionBannerController decides whether the network connection
+ * banner should be shown for the user, and which failing network it should
+ * describe. It encapsulates the rule, the 5s / 30s timer escalation, and the
+ * eTLD+1 grouping that was previously duplicated across MetaMask clients.
+ *
+ * The banner shows when:
+ *
+ * - The first failing network's default RPC is a custom (non-Infura) endpoint
+ *   — users always want to be informed about errors with RPCs they've chosen.
+ * - Failed RPCs span more than one registrable domain (likely client-side).
+ * - Every enabled EVM network is failing (escape hatch for single-network
+ *   setups so they still get a signal).
+ *
+ * A wide single-provider outage (e.g. every `*.infura.io` network goes down at
+ * once) collapses to one domain and is suppressed, except in the all-down
+ * single-network case. When a custom failure is present, it's surfaced first
+ * so the "Switch to MetaMask default RPC" CTA targets the network the user
+ * can act on.
+ *
+ * Clients only need to render the banner from the controller's state and wire
+ * click handlers to {@link dismissBanner} or {@link switchToDefaultInfuraRpc}.
+ */
+class NetworkConnectionBannerController extends base_controller_1.BaseController {
+    /**
+     * Constructs a new {@link NetworkConnectionBannerController}.
+     *
+     * @param args - The arguments to this controller.
+     * @param args.messenger - The messenger suited for this controller.
+     */
+    constructor({ messenger }) {
+        super({
+            messenger,
+            metadata: networkConnectionBannerControllerMetadata,
+            name: exports.controllerName,
+            state: getDefaultNetworkConnectionBannerControllerState(),
+        });
+        _NetworkConnectionBannerController_instances.add(this);
+        _NetworkConnectionBannerController_degradedTimer.set(this, void 0);
+        _NetworkConnectionBannerController_unavailableTimer.set(this, void 0);
+        const onStateChange = () => __classPrivateFieldGet(this, _NetworkConnectionBannerController_instances, "m", _NetworkConnectionBannerController_evaluate).call(this);
+        this.messenger.subscribe('NetworkController:stateChanged', onStateChange);
+        this.messenger.subscribe('NetworkEnablementController:stateChanged', onStateChange);
+        this.messenger.subscribe('ConnectivityController:stateChanged', onStateChange);
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Clears the banner state regardless of the current rule outcome. The next
+     * subscription-driven evaluation will re-show the banner if the conditions
+     * still hold.
+     */
+    dismissBanner() {
+        __classPrivateFieldGet(this, _NetworkConnectionBannerController_instances, "m", _NetworkConnectionBannerController_resetBanner).call(this);
+    }
+    /**
+     * Switches the chain's default RPC endpoint to its first Infura endpoint,
+     * causing the banner to clear once the network becomes available again.
+     *
+     * @param args - The arguments to this action.
+     * @param args.chainId - The chain whose default RPC should be switched.
+     * @throws If the chain configuration cannot be found, or if it has no
+     * Infura endpoint to switch to, or if the default is already Infura.
+     */
+    async switchToDefaultInfuraRpc({ chainId }) {
+        const networkConfiguration = this.messenger.call('NetworkController:getNetworkConfigurationByChainId', chainId);
+        if (!networkConfiguration) {
+            throw new Error(`No network configuration found for chain ID "${chainId}".`);
+        }
+        const infuraEndpointIndex = networkConfiguration.rpcEndpoints.findIndex((endpoint) => isInfuraEndpoint(endpoint.url));
+        if (infuraEndpointIndex === -1) {
+            throw new Error(`No Infura endpoint available for chain ID "${chainId}".`);
+        }
+        if (infuraEndpointIndex === networkConfiguration.defaultRpcEndpointIndex) {
+            // The default is already Infura; nothing to do.
+            return;
+        }
+        await this.messenger.call('NetworkController:updateNetwork', chainId, {
+            ...networkConfiguration,
+            defaultRpcEndpointIndex: infuraEndpointIndex,
+        }, { replacementSelectedRpcEndpointIndex: infuraEndpointIndex });
+    }
+}
+exports.NetworkConnectionBannerController = NetworkConnectionBannerController;
+_NetworkConnectionBannerController_degradedTimer = new WeakMap(), _NetworkConnectionBannerController_unavailableTimer = new WeakMap(), _NetworkConnectionBannerController_instances = new WeakSet(), _NetworkConnectionBannerController_evaluate = function _NetworkConnectionBannerController_evaluate() {
+    const { connectivityStatus } = this.messenger.call('ConnectivityController:getState');
+    if (connectivityStatus === connectivity_controller_1.CONNECTIVITY_STATUSES.Offline) {
+        __classPrivateFieldGet(this, _NetworkConnectionBannerController_instances, "m", _NetworkConnectionBannerController_resetBanner).call(this);
+        return;
+    }
+    const failed = __classPrivateFieldGet(this, _NetworkConnectionBannerController_instances, "m", _NetworkConnectionBannerController_findFailedNetworkForBanner).call(this);
+    if (!failed) {
+        __classPrivateFieldGet(this, _NetworkConnectionBannerController_instances, "m", _NetworkConnectionBannerController_resetBanner).call(this);
+        return;
+    }
+    // If the banner is currently showing for a different network or status,
+    // restart the escalation timeline for the new one. Otherwise let the
+    // existing timers continue.
+    if (this.state.status !== 'available' &&
+        this.state.network?.networkClientId === failed.networkClientId) {
+        this.update((draft) => {
+            draft.network = failed;
+        });
+        return;
+    }
+    __classPrivateFieldGet(this, _NetworkConnectionBannerController_instances, "m", _NetworkConnectionBannerController_clearTimers).call(this);
+    this.update((draft) => {
+        draft.status = 'available';
+        draft.network = null;
+    });
+    __classPrivateFieldSet(this, _NetworkConnectionBannerController_degradedTimer, setTimeout(() => {
+        __classPrivateFieldSet(this, _NetworkConnectionBannerController_degradedTimer, undefined, "f");
+        const stillFailed = __classPrivateFieldGet(this, _NetworkConnectionBannerController_instances, "m", _NetworkConnectionBannerController_findFailedNetworkForBanner).call(this);
+        if (!stillFailed) {
+            return;
+        }
+        this.update((draft) => {
+            draft.status = 'degraded';
+            draft.network = stillFailed;
+        });
+        __classPrivateFieldSet(this, _NetworkConnectionBannerController_unavailableTimer, setTimeout(() => {
+            __classPrivateFieldSet(this, _NetworkConnectionBannerController_unavailableTimer, undefined, "f");
+            const stillFailedAtEscalation = __classPrivateFieldGet(this, _NetworkConnectionBannerController_instances, "m", _NetworkConnectionBannerController_findFailedNetworkForBanner).call(this);
+            if (!stillFailedAtEscalation) {
+                return;
+            }
+            this.update((draft) => {
+                draft.status = 'unavailable';
+                draft.network = stillFailedAtEscalation;
+            });
+        }, UNAVAILABLE_BANNER_TIMEOUT_MS - DEGRADED_BANNER_TIMEOUT_MS), "f");
+    }, DEGRADED_BANNER_TIMEOUT_MS), "f");
+}, _NetworkConnectionBannerController_resetBanner = function _NetworkConnectionBannerController_resetBanner() {
+    __classPrivateFieldGet(this, _NetworkConnectionBannerController_instances, "m", _NetworkConnectionBannerController_clearTimers).call(this);
+    if (this.state.status !== 'available' || this.state.network !== null) {
+        this.update((draft) => {
+            draft.status = 'available';
+            draft.network = null;
+        });
+    }
+}, _NetworkConnectionBannerController_clearTimers = function _NetworkConnectionBannerController_clearTimers() {
+    if (__classPrivateFieldGet(this, _NetworkConnectionBannerController_degradedTimer, "f") !== undefined) {
+        clearTimeout(__classPrivateFieldGet(this, _NetworkConnectionBannerController_degradedTimer, "f"));
+        __classPrivateFieldSet(this, _NetworkConnectionBannerController_degradedTimer, undefined, "f");
+    }
+    if (__classPrivateFieldGet(this, _NetworkConnectionBannerController_unavailableTimer, "f") !== undefined) {
+        clearTimeout(__classPrivateFieldGet(this, _NetworkConnectionBannerController_unavailableTimer, "f"));
+        __classPrivateFieldSet(this, _NetworkConnectionBannerController_unavailableTimer, undefined, "f");
+    }
+}, _NetworkConnectionBannerController_findFailedNetworkForBanner = function _NetworkConnectionBannerController_findFailedNetworkForBanner() {
+    const { enabledNetworkMap } = this.messenger.call('NetworkEnablementController:getState');
+    const enabledEvmChainIds = Object.entries(enabledNetworkMap[utils_1.KnownCaipNamespace.Eip155] ?? {})
+        .filter(([, enabled]) => enabled)
+        .map(([chainId]) => chainId);
+    const { networkConfigurationsByChainId, networksMetadata } = this.messenger.call('NetworkController:getState');
+    const failedNetworks = [];
+    let totalEnabled = 0;
+    for (const chainId of enabledEvmChainIds) {
+        const networkConfiguration = networkConfigurationsByChainId[chainId];
+        if (!networkConfiguration) {
+            continue;
+        }
+        const { rpcEndpoints, defaultRpcEndpointIndex, name } = networkConfiguration;
+        const defaultRpcEndpoint = rpcEndpoints[defaultRpcEndpointIndex];
+        if (!defaultRpcEndpoint) {
+            continue;
+        }
+        totalEnabled += 1;
+        const metadata = networksMetadata[defaultRpcEndpoint.networkClientId];
+        if (metadata === undefined ||
+            metadata.status === network_controller_1.NetworkStatus.Available) {
+            continue;
+        }
+        const endpointIsInfura = isInfuraEndpoint(defaultRpcEndpoint.url);
+        // For custom endpoints (non-Infura), find an Infura endpoint on this
+        // chain that we could offer to switch to.
+        let infuraNetworkClientId = null;
+        if (!endpointIsInfura) {
+            const otherInfura = rpcEndpoints.find((endpoint, index) => index !== defaultRpcEndpointIndex && isInfuraEndpoint(endpoint.url));
+            infuraNetworkClientId = otherInfura?.networkClientId ?? null;
+        }
+        failedNetworks.push({
+            chainId,
+            networkClientId: defaultRpcEndpoint.networkClientId,
+            networkName: name,
+            rpcUrl: defaultRpcEndpoint.url,
+            isInfuraEndpoint: endpointIsInfura,
+            infuraNetworkClientId,
+            domain: (0, url_utils_1.getDomain)(defaultRpcEndpoint.url),
+        });
+    }
+    if (failedNetworks.length === 0) {
+        return null;
+    }
+    const firstCustomFailed = failedNetworks.find((entry) => !entry.isInfuraEndpoint);
+    const distinctDomains = new Set(failedNetworks
+        .map((entry) => entry.domain)
+        .filter((domain) => domain !== null)).size;
+    const areAllEnabledNetworksFailed = failedNetworks.length === totalEnabled;
+    if (!firstCustomFailed &&
+        distinctDomains <= 1 &&
+        !areAllEnabledNetworksFailed) {
+        return null;
+    }
+    const selected = firstCustomFailed ?? failedNetworks[0];
+    return {
+        chainId: selected.chainId,
+        networkClientId: selected.networkClientId,
+        networkName: selected.networkName,
+        rpcUrl: selected.rpcUrl,
+        isInfuraEndpoint: selected.isInfuraEndpoint,
+        infuraNetworkClientId: selected.infuraNetworkClientId,
+    };
+};
+/**
+ * Checks if an RPC URL is hosted on the Infura service. Detection is by
+ * hostname suffix rather than the exact MetaMask-key URL pattern, so any
+ * `*.infura.io` URL counts. That's the right shape for grouping by provider.
+ *
+ * @param url - The RPC URL to check.
+ * @returns True if the URL's host is on `infura.io`.
+ */
+function isInfuraEndpoint(url) {
+    try {
+        return new URL(url).hostname.toLowerCase().endsWith('.infura.io');
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=NetworkConnectionBannerController.cjs.map

package/dist/NetworkConnectionBannerController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkConnectionBannerController.cjs","sourceRoot":"","sources":["../src/NetworkConnectionBannerController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,+DAA2D;AAC3D,+EAA0E;AAY1E,qEAA6D;AAM7D,2CAAqD;AAGrD,+CAAwC;AAExC;;;;GAIG;AACU,QAAA,cAAc,GAAG,mCAAmC,CAAC;AAsClE,MAAM,yCAAyC,GAAG;IAChD,MAAM,EAAE;QACN,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,IAAI;KACf;CAC8D,CAAC;AAElE;;;;GAIG;AACH,SAAgB,gDAAgD;IAC9D,OAAO;QACL,MAAM,EAAE,WAAW;QACnB,OAAO,EAAE,IAAI;KACd,CAAC;AACJ,CAAC;AALD,4GAKC;AAED,MAAM,0BAA0B,GAAG,IAAK,CAAC;AACzC,MAAM,6BAA6B,GAAG,KAAM,CAAC;AAE7C,MAAM,yBAAyB,GAAG;IAChC,eAAe;IACf,0BAA0B;CAClB,CAAC;AAkFX;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,iCAAkC,SAAQ,gCAItD;IAKC;;;;;OAKG;IACH,YAAY,EAAE,SAAS,EAA4C;QACjE,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,yCAAyC;YACnD,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE,gDAAgD,EAAE;SAC1D,CAAC,CAAC;;QAhBL,mEAA0D;QAE1D,sEAA6D;QAgB3D,MAAM,aAAa,GAAG,GAAS,EAAE,CAAC,uBAAA,IAAI,iGAAU,MAAd,IAAI,CAAY,CAAC;QACnD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,gCAAgC,EAAE,aAAa,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,0CAA0C,EAC1C,aAAa,CACd,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,qCAAqC,EACrC,aAAa,CACd,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,uBAAA,IAAI,oGAAa,MAAjB,IAAI,CAAe,CAAC;IACtB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,wBAAwB,CAAC,EAAE,OAAO,EAAoB;QAC1D,MAAM,oBAAoB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9C,oDAAoD,EACpD,OAAO,CACR,CAAC;QACF,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,gDAAgD,OAAO,IAAI,CAC5D,CAAC;QACJ,CAAC;QAED,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,YAAY,CAAC,SAAS,CACrE,CAAC,QAAQ,EAAE,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAC7C,CAAC;QACF,IAAI,mBAAmB,KAAK,CAAC,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,8CAA8C,OAAO,IAAI,CAC1D,CAAC;QACJ,CAAC;QACD,IAAI,mBAAmB,KAAK,oBAAoB,CAAC,uBAAuB,EAAE,CAAC;YACzE,gDAAgD;YAChD,OAAO;QACT,CAAC;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACvB,iCAAiC,EACjC,OAAO,EACP;YACE,GAAG,oBAAoB;YACvB,uBAAuB,EAAE,mBAAmB;SAC7C,EACD,EAAE,mCAAmC,EAAE,mBAAmB,EAAE,CAC7D,CAAC;IACJ,CAAC;CAuLF;AAlRD,8EAkRC;;IApLG,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAChD,iCAAiC,CAClC,CAAC;IACF,IAAI,kBAAkB,KAAK,+CAAqB,CAAC,OAAO,EAAE,CAAC;QACzD,uBAAA,IAAI,oGAAa,MAAjB,IAAI,CAAe,CAAC;QACpB,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,uBAAA,IAAI,mHAA4B,MAAhC,IAAI,CAA8B,CAAC;IAElD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,uBAAA,IAAI,oGAAa,MAAjB,IAAI,CAAe,CAAC;QACpB,OAAO;IACT,CAAC;IAED,wEAAwE;IACxE,qEAAqE;IACrE,4BAA4B;IAC5B,IACE,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,WAAW;QACjC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,eAAe,KAAK,MAAM,CAAC,eAAe,EAC9D,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;QACzB,CAAC,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,uBAAA,IAAI,oGAAa,MAAjB,IAAI,CAAe,CAAC;IACpB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC;QAC3B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,uBAAA,IAAI,oDAAkB,UAAU,CAAC,GAAG,EAAE;QACpC,uBAAA,IAAI,oDAAkB,SAAS,MAAA,CAAC;QAChC,MAAM,WAAW,GAAG,uBAAA,IAAI,mHAA4B,MAAhC,IAAI,CAA8B,CAAC;QACvD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC;YAC1B,KAAK,CAAC,OAAO,GAAG,WAAW,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,uBAAA,IAAI,uDAAqB,UAAU,CAAC,GAAG,EAAE;YACvC,uBAAA,IAAI,uDAAqB,SAAS,MAAA,CAAC;YACnC,MAAM,uBAAuB,GAAG,uBAAA,IAAI,mHAA4B,MAAhC,IAAI,CAA8B,CAAC;YACnE,IAAI,CAAC,uBAAuB,EAAE,CAAC;gBAC7B,OAAO;YACT,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC;gBAC7B,KAAK,CAAC,OAAO,GAAG,uBAAuB,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC,EAAE,6BAA6B,GAAG,0BAA0B,CAAC,MAAA,CAAC;IACjE,CAAC,EAAE,0BAA0B,CAAC,MAAA,CAAC;AACjC,CAAC;IAOC,uBAAA,IAAI,oGAAa,MAAjB,IAAI,CAAe,CAAC;IACpB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QACrE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC;YAC3B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;IAGC,IAAI,uBAAA,IAAI,wDAAe,KAAK,SAAS,EAAE,CAAC;QACtC,YAAY,CAAC,uBAAA,IAAI,wDAAe,CAAC,CAAC;QAClC,uBAAA,IAAI,oDAAkB,SAAS,MAAA,CAAC;IAClC,CAAC;IACD,IAAI,uBAAA,IAAI,2DAAkB,KAAK,SAAS,EAAE,CAAC;QACzC,YAAY,CAAC,uBAAA,IAAI,2DAAkB,CAAC,CAAC;QACrC,uBAAA,IAAI,uDAAqB,SAAS,MAAA,CAAC;IACrC,CAAC;AACH,CAAC;IAGC,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAC/C,sCAAsC,CACvC,CAAC;IACF,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,CACvC,iBAAiB,CAAC,0BAAkB,CAAC,MAAM,CAAC,IAAI,EAAE,CACnD;SACE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC;SAChC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAc,CAAC,CAAC;IACtC,MAAM,EAAE,8BAA8B,EAAE,gBAAgB,EAAE,GACxD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAKpD,MAAM,cAAc,GAA4B,EAAE,CAAC;IACnD,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;QACzC,MAAM,oBAAoB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;QACrE,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,SAAS;QACX,CAAC;QAED,MAAM,EAAE,YAAY,EAAE,uBAAuB,EAAE,IAAI,EAAE,GACnD,oBAAoB,CAAC;QACvB,MAAM,kBAAkB,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAC;QACjE,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,SAAS;QACX,CAAC;QAED,YAAY,IAAI,CAAC,CAAC;QAElB,MAAM,QAAQ,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACtE,IACE,QAAQ,KAAK,SAAS;YACtB,QAAQ,CAAC,MAAM,KAAK,kCAAa,CAAC,SAAS,EAC3C,CAAC;YACD,SAAS;QACX,CAAC;QAED,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAElE,qEAAqE;QACrE,0CAA0C;QAC1C,IAAI,qBAAqB,GAAkB,IAAI,CAAC;QAChD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,WAAW,GAAG,YAAY,CAAC,IAAI,CACnC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAClB,KAAK,KAAK,uBAAuB,IAAI,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CACtE,CAAC;YACF,qBAAqB,GAAG,WAAW,EAAE,eAAe,IAAI,IAAI,CAAC;QAC/D,CAAC;QAED,cAAc,CAAC,IAAI,CAAC;YAClB,OAAO;YACP,eAAe,EAAE,kBAAkB,CAAC,eAAe;YACnD,WAAW,EAAE,IAAI;YACjB,MAAM,EAAE,kBAAkB,CAAC,GAAG;YAC9B,gBAAgB,EAAE,gBAAgB;YAClC,qBAAqB;YACrB,MAAM,EAAE,IAAA,qBAAS,EAAC,kBAAkB,CAAC,GAAG,CAAC;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,iBAAiB,GAAG,cAAc,CAAC,IAAI,CAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CACnC,CAAC;IACF,MAAM,eAAe,GAAG,IAAI,GAAG,CAC7B,cAAc;SACX,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC;SAC5B,MAAM,CAAC,CAAC,MAAM,EAAoB,EAAE,CAAC,MAAM,KAAK,IAAI,CAAC,CACzD,CAAC,IAAI,CAAC;IACP,MAAM,2BAA2B,GAAG,cAAc,CAAC,MAAM,KAAK,YAAY,CAAC;IAE3E,IACE,CAAC,iBAAiB;QAClB,eAAe,IAAI,CAAC;QACpB,CAAC,2BAA2B,EAC5B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,QAAQ,GAAG,iBAAiB,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;IACxD,OAAO;QACL,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,eAAe,EAAE,QAAQ,CAAC,eAAe;QACzC,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;QAC3C,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB;KACtD,CAAC;AACJ,CAAC;AAGH;;;;;;;GAOG;AACH,SAAS,gBAAgB,CAAC,GAAW;IACnC,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACpE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangedEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { CONNECTIVITY_STATUSES } from '@metamask/connectivity-controller';\nimport type {\n  ConnectivityControllerGetStateAction,\n  ConnectivityControllerState,\n} from '@metamask/connectivity-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport type {\n  NetworkControllerGetNetworkConfigurationByChainIdAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerUpdateNetworkAction,\n  NetworkState,\n} from '@metamask/network-controller';\nimport { NetworkStatus } from '@metamask/network-controller';\nimport type {\n  NetworkEnablementControllerGetStateAction,\n  NetworkEnablementControllerState,\n} from '@metamask/network-enablement-controller';\nimport type { Hex } from '@metamask/utils';\nimport { KnownCaipNamespace } from '@metamask/utils';\n\nimport type { NetworkConnectionBannerControllerMethodActions } from './NetworkConnectionBannerController-method-action-types';\nimport { getDomain } from './url-utils';\n\n/**\n * The name of the {@link NetworkConnectionBannerController}, used to namespace\n * the controller's actions and events and to namespace the controller's state\n * data when composed with other controllers.\n */\nexport const controllerName = 'NetworkConnectionBannerController';\n\n/**\n * Status the banner can be in. `available` means no banner is shown; the\n * `degraded` and `unavailable` values mirror the two-tier escalation that the\n * UI renders.\n */\nexport type NetworkConnectionBannerStatus =\n  | 'available'\n  | 'degraded'\n  | 'unavailable';\n\n/**\n * Details of the failing network the banner should describe. Populated when\n * {@link NetworkConnectionBannerControllerState.status} is `degraded` or\n * `unavailable`, `null` otherwise.\n *\n * `infuraNetworkClientId` is the networkClientId of an Infura endpoint on the\n * same chain that the user can switch to. `null` when the failing endpoint is\n * already Infura, or when no Infura alternative exists.\n */\nexport type NetworkConnectionBannerFailedNetwork = {\n  chainId: Hex;\n  networkClientId: string;\n  networkName: string;\n  rpcUrl: string;\n  isInfuraEndpoint: boolean;\n  infuraNetworkClientId: string | null;\n};\n\n/**\n * State for the {@link NetworkConnectionBannerController}.\n */\nexport type NetworkConnectionBannerControllerState = {\n  status: NetworkConnectionBannerStatus;\n  network: NetworkConnectionBannerFailedNetwork | null;\n};\n\nconst networkConnectionBannerControllerMetadata = {\n  status: {\n    persist: false,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: true,\n  },\n  network: {\n    persist: false,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: true,\n  },\n} satisfies StateMetadata<NetworkConnectionBannerControllerState>;\n\n/**\n * Constructs the default {@link NetworkConnectionBannerController} state.\n *\n * @returns The default state.\n */\nexport function getDefaultNetworkConnectionBannerControllerState(): NetworkConnectionBannerControllerState {\n  return {\n    status: 'available',\n    network: null,\n  };\n}\n\nconst DEGRADED_BANNER_TIMEOUT_MS = 5_000;\nconst UNAVAILABLE_BANNER_TIMEOUT_MS = 30_000;\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'dismissBanner',\n  'switchToDefaultInfuraRpc',\n] as const;\n\n/**\n * Retrieves the state of the {@link NetworkConnectionBannerController}.\n */\nexport type NetworkConnectionBannerControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    NetworkConnectionBannerControllerState\n  >;\n\n/**\n * Actions that {@link NetworkConnectionBannerControllerMessenger} exposes to\n * other consumers.\n */\nexport type NetworkConnectionBannerControllerActions =\n  | NetworkConnectionBannerControllerGetStateAction\n  | NetworkConnectionBannerControllerMethodActions;\n\n/**\n * Actions from other messengers that\n * {@link NetworkConnectionBannerControllerMessenger} calls.\n */\ntype AllowedActions =\n  | NetworkControllerGetStateAction\n  | NetworkControllerGetNetworkConfigurationByChainIdAction\n  | NetworkControllerUpdateNetworkAction\n  | NetworkEnablementControllerGetStateAction\n  | ConnectivityControllerGetStateAction;\n\n/**\n * Published when the state of {@link NetworkConnectionBannerController}\n * changes.\n */\nexport type NetworkConnectionBannerControllerStateChangedEvent =\n  ControllerStateChangedEvent<\n    typeof controllerName,\n    NetworkConnectionBannerControllerState\n  >;\n\n/**\n * Events that {@link NetworkConnectionBannerControllerMessenger} exposes to\n * other consumers.\n */\nexport type NetworkConnectionBannerControllerEvents =\n  NetworkConnectionBannerControllerStateChangedEvent;\n\n/**\n * Events from other messengers that\n * {@link NetworkConnectionBannerControllerMessenger} subscribes to.\n */\ntype AllowedEvents =\n  | ControllerStateChangedEvent<'NetworkController', NetworkState>\n  | ControllerStateChangedEvent<\n      'NetworkEnablementController',\n      NetworkEnablementControllerState\n    >\n  | ControllerStateChangedEvent<\n      'ConnectivityController',\n      ConnectivityControllerState\n    >;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link NetworkConnectionBannerController}.\n */\nexport type NetworkConnectionBannerControllerMessenger = Messenger<\n  typeof controllerName,\n  NetworkConnectionBannerControllerActions | AllowedActions,\n  NetworkConnectionBannerControllerEvents | AllowedEvents\n>;\n\n/**\n * Options for constructing the {@link NetworkConnectionBannerController}.\n */\nexport type NetworkConnectionBannerControllerOptions = {\n  /**\n   * The messenger for inter-controller communication.\n   */\n  messenger: NetworkConnectionBannerControllerMessenger;\n};\n\n/**\n * NetworkConnectionBannerController decides whether the network connection\n * banner should be shown for the user, and which failing network it should\n * describe. It encapsulates the rule, the 5s / 30s timer escalation, and the\n * eTLD+1 grouping that was previously duplicated across MetaMask clients.\n *\n * The banner shows when:\n *\n * - The first failing network's default RPC is a custom (non-Infura) endpoint\n *   — users always want to be informed about errors with RPCs they've chosen.\n * - Failed RPCs span more than one registrable domain (likely client-side).\n * - Every enabled EVM network is failing (escape hatch for single-network\n *   setups so they still get a signal).\n *\n * A wide single-provider outage (e.g. every `*.infura.io` network goes down at\n * once) collapses to one domain and is suppressed, except in the all-down\n * single-network case. When a custom failure is present, it's surfaced first\n * so the \"Switch to MetaMask default RPC\" CTA targets the network the user\n * can act on.\n *\n * Clients only need to render the banner from the controller's state and wire\n * click handlers to {@link dismissBanner} or {@link switchToDefaultInfuraRpc}.\n */\nexport class NetworkConnectionBannerController extends BaseController<\n  typeof controllerName,\n  NetworkConnectionBannerControllerState,\n  NetworkConnectionBannerControllerMessenger\n> {\n  #degradedTimer: ReturnType<typeof setTimeout> | undefined;\n\n  #unavailableTimer: ReturnType<typeof setTimeout> | undefined;\n\n  /**\n   * Constructs a new {@link NetworkConnectionBannerController}.\n   *\n   * @param args - The arguments to this controller.\n   * @param args.messenger - The messenger suited for this controller.\n   */\n  constructor({ messenger }: NetworkConnectionBannerControllerOptions) {\n    super({\n      messenger,\n      metadata: networkConnectionBannerControllerMetadata,\n      name: controllerName,\n      state: getDefaultNetworkConnectionBannerControllerState(),\n    });\n\n    const onStateChange = (): void => this.#evaluate();\n    this.messenger.subscribe('NetworkController:stateChanged', onStateChange);\n    this.messenger.subscribe(\n      'NetworkEnablementController:stateChanged',\n      onStateChange,\n    );\n    this.messenger.subscribe(\n      'ConnectivityController:stateChanged',\n      onStateChange,\n    );\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Clears the banner state regardless of the current rule outcome. The next\n   * subscription-driven evaluation will re-show the banner if the conditions\n   * still hold.\n   */\n  dismissBanner(): void {\n    this.#resetBanner();\n  }\n\n  /**\n   * Switches the chain's default RPC endpoint to its first Infura endpoint,\n   * causing the banner to clear once the network becomes available again.\n   *\n   * @param args - The arguments to this action.\n   * @param args.chainId - The chain whose default RPC should be switched.\n   * @throws If the chain configuration cannot be found, or if it has no\n   * Infura endpoint to switch to, or if the default is already Infura.\n   */\n  async switchToDefaultInfuraRpc({ chainId }: { chainId: Hex }): Promise<void> {\n    const networkConfiguration = this.messenger.call(\n      'NetworkController:getNetworkConfigurationByChainId',\n      chainId,\n    );\n    if (!networkConfiguration) {\n      throw new Error(\n        `No network configuration found for chain ID \"${chainId}\".`,\n      );\n    }\n\n    const infuraEndpointIndex = networkConfiguration.rpcEndpoints.findIndex(\n      (endpoint) => isInfuraEndpoint(endpoint.url),\n    );\n    if (infuraEndpointIndex === -1) {\n      throw new Error(\n        `No Infura endpoint available for chain ID \"${chainId}\".`,\n      );\n    }\n    if (infuraEndpointIndex === networkConfiguration.defaultRpcEndpointIndex) {\n      // The default is already Infura; nothing to do.\n      return;\n    }\n\n    await this.messenger.call(\n      'NetworkController:updateNetwork',\n      chainId,\n      {\n        ...networkConfiguration,\n        defaultRpcEndpointIndex: infuraEndpointIndex,\n      },\n      { replacementSelectedRpcEndpointIndex: infuraEndpointIndex },\n    );\n  }\n\n  #evaluate(): void {\n    const { connectivityStatus } = this.messenger.call(\n      'ConnectivityController:getState',\n    );\n    if (connectivityStatus === CONNECTIVITY_STATUSES.Offline) {\n      this.#resetBanner();\n      return;\n    }\n\n    const failed = this.#findFailedNetworkForBanner();\n\n    if (!failed) {\n      this.#resetBanner();\n      return;\n    }\n\n    // If the banner is currently showing for a different network or status,\n    // restart the escalation timeline for the new one. Otherwise let the\n    // existing timers continue.\n    if (\n      this.state.status !== 'available' &&\n      this.state.network?.networkClientId === failed.networkClientId\n    ) {\n      this.update((draft) => {\n        draft.network = failed;\n      });\n      return;\n    }\n\n    this.#clearTimers();\n    this.update((draft) => {\n      draft.status = 'available';\n      draft.network = null;\n    });\n\n    this.#degradedTimer = setTimeout(() => {\n      this.#degradedTimer = undefined;\n      const stillFailed = this.#findFailedNetworkForBanner();\n      if (!stillFailed) {\n        return;\n      }\n      this.update((draft) => {\n        draft.status = 'degraded';\n        draft.network = stillFailed;\n      });\n      this.#unavailableTimer = setTimeout(() => {\n        this.#unavailableTimer = undefined;\n        const stillFailedAtEscalation = this.#findFailedNetworkForBanner();\n        if (!stillFailedAtEscalation) {\n          return;\n        }\n        this.update((draft) => {\n          draft.status = 'unavailable';\n          draft.network = stillFailedAtEscalation;\n        });\n      }, UNAVAILABLE_BANNER_TIMEOUT_MS - DEGRADED_BANNER_TIMEOUT_MS);\n    }, DEGRADED_BANNER_TIMEOUT_MS);\n  }\n\n  /**\n   * Clears timers and resets banner state to {@link NetworkConnectionBannerStatus|`available`}\n   * if it isn't there already.\n   */\n  #resetBanner(): void {\n    this.#clearTimers();\n    if (this.state.status !== 'available' || this.state.network !== null) {\n      this.update((draft) => {\n        draft.status = 'available';\n        draft.network = null;\n      });\n    }\n  }\n\n  #clearTimers(): void {\n    if (this.#degradedTimer !== undefined) {\n      clearTimeout(this.#degradedTimer);\n      this.#degradedTimer = undefined;\n    }\n    if (this.#unavailableTimer !== undefined) {\n      clearTimeout(this.#unavailableTimer);\n      this.#unavailableTimer = undefined;\n    }\n  }\n\n  #findFailedNetworkForBanner(): NetworkConnectionBannerFailedNetwork | null {\n    const { enabledNetworkMap } = this.messenger.call(\n      'NetworkEnablementController:getState',\n    );\n    const enabledEvmChainIds = Object.entries(\n      enabledNetworkMap[KnownCaipNamespace.Eip155] ?? {},\n    )\n      .filter(([, enabled]) => enabled)\n      .map(([chainId]) => chainId as Hex);\n    const { networkConfigurationsByChainId, networksMetadata } =\n      this.messenger.call('NetworkController:getState');\n\n    type EnrichedFailedNetwork = NetworkConnectionBannerFailedNetwork & {\n      domain: string | null;\n    };\n    const failedNetworks: EnrichedFailedNetwork[] = [];\n    let totalEnabled = 0;\n\n    for (const chainId of enabledEvmChainIds) {\n      const networkConfiguration = networkConfigurationsByChainId[chainId];\n      if (!networkConfiguration) {\n        continue;\n      }\n\n      const { rpcEndpoints, defaultRpcEndpointIndex, name } =\n        networkConfiguration;\n      const defaultRpcEndpoint = rpcEndpoints[defaultRpcEndpointIndex];\n      if (!defaultRpcEndpoint) {\n        continue;\n      }\n\n      totalEnabled += 1;\n\n      const metadata = networksMetadata[defaultRpcEndpoint.networkClientId];\n      if (\n        metadata === undefined ||\n        metadata.status === NetworkStatus.Available\n      ) {\n        continue;\n      }\n\n      const endpointIsInfura = isInfuraEndpoint(defaultRpcEndpoint.url);\n\n      // For custom endpoints (non-Infura), find an Infura endpoint on this\n      // chain that we could offer to switch to.\n      let infuraNetworkClientId: string | null = null;\n      if (!endpointIsInfura) {\n        const otherInfura = rpcEndpoints.find(\n          (endpoint, index) =>\n            index !== defaultRpcEndpointIndex && isInfuraEndpoint(endpoint.url),\n        );\n        infuraNetworkClientId = otherInfura?.networkClientId ?? null;\n      }\n\n      failedNetworks.push({\n        chainId,\n        networkClientId: defaultRpcEndpoint.networkClientId,\n        networkName: name,\n        rpcUrl: defaultRpcEndpoint.url,\n        isInfuraEndpoint: endpointIsInfura,\n        infuraNetworkClientId,\n        domain: getDomain(defaultRpcEndpoint.url),\n      });\n    }\n\n    if (failedNetworks.length === 0) {\n      return null;\n    }\n\n    const firstCustomFailed = failedNetworks.find(\n      (entry) => !entry.isInfuraEndpoint,\n    );\n    const distinctDomains = new Set(\n      failedNetworks\n        .map((entry) => entry.domain)\n        .filter((domain): domain is string => domain !== null),\n    ).size;\n    const areAllEnabledNetworksFailed = failedNetworks.length === totalEnabled;\n\n    if (\n      !firstCustomFailed &&\n      distinctDomains <= 1 &&\n      !areAllEnabledNetworksFailed\n    ) {\n      return null;\n    }\n\n    const selected = firstCustomFailed ?? failedNetworks[0];\n    return {\n      chainId: selected.chainId,\n      networkClientId: selected.networkClientId,\n      networkName: selected.networkName,\n      rpcUrl: selected.rpcUrl,\n      isInfuraEndpoint: selected.isInfuraEndpoint,\n      infuraNetworkClientId: selected.infuraNetworkClientId,\n    };\n  }\n}\n\n/**\n * Checks if an RPC URL is hosted on the Infura service. Detection is by\n * hostname suffix rather than the exact MetaMask-key URL pattern, so any\n * `*.infura.io` URL counts. That's the right shape for grouping by provider.\n *\n * @param url - The RPC URL to check.\n * @returns True if the URL's host is on `infura.io`.\n */\nfunction isInfuraEndpoint(url: string): boolean {\n  try {\n    return new URL(url).hostname.toLowerCase().endsWith('.infura.io');\n  } catch {\n    return false;\n  }\n}\n"]}

package/dist/NetworkConnectionBannerController.d.cts

@@ -0,0 +1,146 @@
+import type { ControllerGetStateAction, ControllerStateChangedEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { ConnectivityControllerGetStateAction, ConnectivityControllerState } from "@metamask/connectivity-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { NetworkControllerGetNetworkConfigurationByChainIdAction, NetworkControllerGetStateAction, NetworkControllerUpdateNetworkAction, NetworkState } from "@metamask/network-controller";
+import type { NetworkEnablementControllerGetStateAction, NetworkEnablementControllerState } from "@metamask/network-enablement-controller";
+import type { Hex } from "@metamask/utils";
+import type { NetworkConnectionBannerControllerMethodActions } from "./NetworkConnectionBannerController-method-action-types.cjs";
+/**
+ * The name of the {@link NetworkConnectionBannerController}, used to namespace
+ * the controller's actions and events and to namespace the controller's state
+ * data when composed with other controllers.
+ */
+export declare const controllerName = "NetworkConnectionBannerController";
+/**
+ * Status the banner can be in. `available` means no banner is shown; the
+ * `degraded` and `unavailable` values mirror the two-tier escalation that the
+ * UI renders.
+ */
+export type NetworkConnectionBannerStatus = 'available' | 'degraded' | 'unavailable';
+/**
+ * Details of the failing network the banner should describe. Populated when
+ * {@link NetworkConnectionBannerControllerState.status} is `degraded` or
+ * `unavailable`, `null` otherwise.
+ *
+ * `infuraNetworkClientId` is the networkClientId of an Infura endpoint on the
+ * same chain that the user can switch to. `null` when the failing endpoint is
+ * already Infura, or when no Infura alternative exists.
+ */
+export type NetworkConnectionBannerFailedNetwork = {
+    chainId: Hex;
+    networkClientId: string;
+    networkName: string;
+    rpcUrl: string;
+    isInfuraEndpoint: boolean;
+    infuraNetworkClientId: string | null;
+};
+/**
+ * State for the {@link NetworkConnectionBannerController}.
+ */
+export type NetworkConnectionBannerControllerState = {
+    status: NetworkConnectionBannerStatus;
+    network: NetworkConnectionBannerFailedNetwork | null;
+};
+/**
+ * Constructs the default {@link NetworkConnectionBannerController} state.
+ *
+ * @returns The default state.
+ */
+export declare function getDefaultNetworkConnectionBannerControllerState(): NetworkConnectionBannerControllerState;
+/**
+ * Retrieves the state of the {@link NetworkConnectionBannerController}.
+ */
+export type NetworkConnectionBannerControllerGetStateAction = ControllerGetStateAction<typeof controllerName, NetworkConnectionBannerControllerState>;
+/**
+ * Actions that {@link NetworkConnectionBannerControllerMessenger} exposes to
+ * other consumers.
+ */
+export type NetworkConnectionBannerControllerActions = NetworkConnectionBannerControllerGetStateAction | NetworkConnectionBannerControllerMethodActions;
+/**
+ * Actions from other messengers that
+ * {@link NetworkConnectionBannerControllerMessenger} calls.
+ */
+type AllowedActions = NetworkControllerGetStateAction | NetworkControllerGetNetworkConfigurationByChainIdAction | NetworkControllerUpdateNetworkAction | NetworkEnablementControllerGetStateAction | ConnectivityControllerGetStateAction;
+/**
+ * Published when the state of {@link NetworkConnectionBannerController}
+ * changes.
+ */
+export type NetworkConnectionBannerControllerStateChangedEvent = ControllerStateChangedEvent<typeof controllerName, NetworkConnectionBannerControllerState>;
+/**
+ * Events that {@link NetworkConnectionBannerControllerMessenger} exposes to
+ * other consumers.
+ */
+export type NetworkConnectionBannerControllerEvents = NetworkConnectionBannerControllerStateChangedEvent;
+/**
+ * Events from other messengers that
+ * {@link NetworkConnectionBannerControllerMessenger} subscribes to.
+ */
+type AllowedEvents = ControllerStateChangedEvent<'NetworkController', NetworkState> | ControllerStateChangedEvent<'NetworkEnablementController', NetworkEnablementControllerState> | ControllerStateChangedEvent<'ConnectivityController', ConnectivityControllerState>;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link NetworkConnectionBannerController}.
+ */
+export type NetworkConnectionBannerControllerMessenger = Messenger<typeof controllerName, NetworkConnectionBannerControllerActions | AllowedActions, NetworkConnectionBannerControllerEvents | AllowedEvents>;
+/**
+ * Options for constructing the {@link NetworkConnectionBannerController}.
+ */
+export type NetworkConnectionBannerControllerOptions = {
+    /**
+     * The messenger for inter-controller communication.
+     */
+    messenger: NetworkConnectionBannerControllerMessenger;
+};
+/**
+ * NetworkConnectionBannerController decides whether the network connection
+ * banner should be shown for the user, and which failing network it should
+ * describe. It encapsulates the rule, the 5s / 30s timer escalation, and the
+ * eTLD+1 grouping that was previously duplicated across MetaMask clients.
+ *
+ * The banner shows when:
+ *
+ * - The first failing network's default RPC is a custom (non-Infura) endpoint
+ *   — users always want to be informed about errors with RPCs they've chosen.
+ * - Failed RPCs span more than one registrable domain (likely client-side).
+ * - Every enabled EVM network is failing (escape hatch for single-network
+ *   setups so they still get a signal).
+ *
+ * A wide single-provider outage (e.g. every `*.infura.io` network goes down at
+ * once) collapses to one domain and is suppressed, except in the all-down
+ * single-network case. When a custom failure is present, it's surfaced first
+ * so the "Switch to MetaMask default RPC" CTA targets the network the user
+ * can act on.
+ *
+ * Clients only need to render the banner from the controller's state and wire
+ * click handlers to {@link dismissBanner} or {@link switchToDefaultInfuraRpc}.
+ */
+export declare class NetworkConnectionBannerController extends BaseController<typeof controllerName, NetworkConnectionBannerControllerState, NetworkConnectionBannerControllerMessenger> {
+    #private;
+    /**
+     * Constructs a new {@link NetworkConnectionBannerController}.
+     *
+     * @param args - The arguments to this controller.
+     * @param args.messenger - The messenger suited for this controller.
+     */
+    constructor({ messenger }: NetworkConnectionBannerControllerOptions);
+    /**
+     * Clears the banner state regardless of the current rule outcome. The next
+     * subscription-driven evaluation will re-show the banner if the conditions
+     * still hold.
+     */
+    dismissBanner(): void;
+    /**
+     * Switches the chain's default RPC endpoint to its first Infura endpoint,
+     * causing the banner to clear once the network becomes available again.
+     *
+     * @param args - The arguments to this action.
+     * @param args.chainId - The chain whose default RPC should be switched.
+     * @throws If the chain configuration cannot be found, or if it has no
+     * Infura endpoint to switch to, or if the default is already Infura.
+     */
+    switchToDefaultInfuraRpc({ chainId }: {
+        chainId: Hex;
+    }): Promise<void>;
+}
+export {};
+//# sourceMappingURL=NetworkConnectionBannerController.d.cts.map