@metamask-previews/network-connection-banner-controller 0.2.1-preview-8bfa290fb → 1.0.0-preview-97d6b86c0

package/CHANGELOG.md

@@ -7,9 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0]
+
 ### Changed
 
+- **BREAKING:** Drop CommonJS support ([#9536](https://github.com/MetaMask/core/pull/9536))
+  - This package is now ESM-only, but can still be used in CommonJS projects via `require(esm)` in modern Node.js versions (22+), or dynamic imports in older Node.js versions.
+- **BREAKING:** Bump minimum Node.js version to 22 ([#9976](https://github.com/MetaMask/core/pull/9976))
+- **BREAKING:** Bump TypeScript target to ES2022 ([#10019](https://github.com/MetaMask/core/pull/10019))
+  - This package now ships ES2022 code, requiring a compatible modern environment or bundler configuration to consume.
 - Bump `@metamask/utils` from `^11.11.0` to `^11.12.0` ([#10076](https://github.com/MetaMask/core/pull/10076))
+- Bump `@metamask/base-controller` from `^9.1.0` to `^10.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/client-controller` from `^1.0.1` to `^2.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/connectivity-controller` from `^0.3.0` to `^1.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/keyring-controller` from `^27.1.1` to `^28.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/messenger` from `^2.0.0` to `^3.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/network-controller` from `^36.0.0` to `^37.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/network-enablement-controller` from `^6.0.5` to `^7.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
 
 ## [0.2.1]
 
@@ -49,7 +63,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   dismissal, and switching custom RPC endpoints to an available Infura endpoint
   ([#9041](https://github.com/MetaMask/core/pull/9041))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-connection-banner-controller@0.2.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-connection-banner-controller@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-connection-banner-controller@0.2.1...@metamask/network-connection-banner-controller@1.0.0
 [0.2.1]: https://github.com/MetaMask/core/compare/@metamask/network-connection-banner-controller@0.2.0...@metamask/network-connection-banner-controller@0.2.1
 [0.2.0]: https://github.com/MetaMask/core/compare/@metamask/network-connection-banner-controller@0.1.2...@metamask/network-connection-banner-controller@0.2.0
 [0.1.2]: https://github.com/MetaMask/core/compare/@metamask/network-connection-banner-controller@0.1.1...@metamask/network-connection-banner-controller@0.1.2

package/dist/{NetworkConnectionBannerController-method-action-types.d.mts → NetworkConnectionBannerController-method-action-types.d.ts}

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { NetworkConnectionBannerController } from "./NetworkConnectionBannerController.mjs";
+import type { NetworkConnectionBannerController } from './NetworkConnectionBannerController.js';
 /**
  * Clears the banner state such that the banner will be hidden.
  */
@@ -27,4 +27,4 @@ export type NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcEndpointAct
  * Union of all NetworkConnectionBannerController action types.
  */
 export type NetworkConnectionBannerControllerMethodActions = NetworkConnectionBannerControllerDismissBannerAction | NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcEndpointAction;
-//# sourceMappingURL=NetworkConnectionBannerController-method-action-types.d.mts.map
+//# sourceMappingURL=NetworkConnectionBannerController-method-action-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkConnectionBannerController-method-action-types.d.ts","sourceRoot":"","sources":["../src/NetworkConnectionBannerController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAEhG;;GAEG;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,uEAAuE,GACjF;IACE,IAAI,EAAE,oEAAoE,CAAC;IAC3E,OAAO,EAAE,iCAAiC,CAAC,kCAAkC,CAAC,CAAC;CAChF,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8CAA8C,GACtD,oDAAoD,GACpD,uEAAuE,CAAC"}

package/dist/{NetworkConnectionBannerController-method-action-types.mjs → NetworkConnectionBannerController-method-action-types.js}

@@ -3,4 +3,4 @@
  * Do not edit manually.
  */
 export {};
-//# sourceMappingURL=NetworkConnectionBannerController-method-action-types.mjs.map
+//# sourceMappingURL=NetworkConnectionBannerController-method-action-types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkConnectionBannerController-method-action-types.js","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.js';\n\n/**\n * Clears the banner state such that the banner will be hidden.\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 Infura endpoint and\n * makes it the active network, causing the banner to clear once the\n * network becomes available again.\n *\n * @param chainId - The chain whose default RPC endpoint 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 NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcEndpointAction =\n  {\n    type: `NetworkConnectionBannerController:switchToDefaultInfuraRpcEndpoint`;\n    handler: NetworkConnectionBannerController['switchToDefaultInfuraRpcEndpoint'];\n  };\n\n/**\n * Union of all NetworkConnectionBannerController action types.\n */\nexport type NetworkConnectionBannerControllerMethodActions =\n  | NetworkConnectionBannerControllerDismissBannerAction\n  | NetworkConnectionBannerControllerSwitchToDefaultInfuraRpcEndpointAction;\n"]}

package/dist/{NetworkConnectionBannerController.d.cts → NetworkConnectionBannerController.d.ts}

@@ -1,13 +1,13 @@
-import type { ControllerGetStateAction, ControllerStateChangedEvent } from "@metamask/base-controller";
-import { BaseController } from "@metamask/base-controller";
-import type { ClientControllerStateChangeEvent } from "@metamask/client-controller";
-import type { ConnectivityControllerGetStateAction, ConnectivityControllerStateChangeEvent } from "@metamask/connectivity-controller";
-import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
-import type { Messenger } from "@metamask/messenger";
-import type { NetworkControllerGetNetworkConfigurationByChainIdAction, NetworkControllerGetStateAction, NetworkControllerUpdateNetworkAction, NetworkControllerSetActiveNetworkAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
-import type { NetworkEnablementControllerGetStateAction, NetworkEnablementControllerStateChangeEvent } from "@metamask/network-enablement-controller";
-import type { Hex } from "@metamask/utils";
-import type { NetworkConnectionBannerControllerMethodActions } from "./NetworkConnectionBannerController-method-action-types.cjs";
+import type { ControllerGetStateAction, ControllerStateChangedEvent } from '@metamask/base-controller';
+import { BaseController } from '@metamask/base-controller';
+import type { ClientControllerStateChangeEvent } from '@metamask/client-controller';
+import type { ConnectivityControllerGetStateAction, ConnectivityControllerStateChangeEvent } from '@metamask/connectivity-controller';
+import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from '@metamask/keyring-controller';
+import type { Messenger } from '@metamask/messenger';
+import type { NetworkControllerGetNetworkConfigurationByChainIdAction, NetworkControllerGetStateAction, NetworkControllerUpdateNetworkAction, NetworkControllerSetActiveNetworkAction, NetworkControllerStateChangeEvent } from '@metamask/network-controller';
+import type { NetworkEnablementControllerGetStateAction, NetworkEnablementControllerStateChangeEvent } from '@metamask/network-enablement-controller';
+import type { Hex } from '@metamask/utils';
+import type { NetworkConnectionBannerControllerMethodActions } from './NetworkConnectionBannerController-method-action-types.js';
 /**
  * The name of the {@link NetworkConnectionBannerController}, used to namespace
  * the controller's actions and events and to namespace the controller's state
@@ -199,4 +199,4 @@ export declare class NetworkConnectionBannerController extends BaseController<ty
     switchToDefaultInfuraRpcEndpoint(chainId: Hex): Promise<void>;
 }
 export {};
-//# sourceMappingURL=NetworkConnectionBannerController.d.cts.map
+//# sourceMappingURL=NetworkConnectionBannerController.d.ts.map

package/dist/NetworkConnectionBannerController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkConnectionBannerController.d.ts","sourceRoot":"","sources":["../src/NetworkConnectionBannerController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAE5B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,6BAA6B,CAAC;AAKpF,OAAO,KAAK,EACV,oCAAoC,EAEpC,sCAAsC,EACvC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAEV,uDAAuD,EACvD,+BAA+B,EAC/B,oCAAoC,EACpC,uCAAuC,EACvC,iCAAiC,EAGlC,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EACV,yCAAyC,EAEzC,2CAA2C,EAC5C,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAI3C,OAAO,KAAK,EAAE,8CAA8C,EAAE,MAAM,4DAA4D,CAAC;AAGjI;;;;GAIG;AACH,QAAA,MAAM,eAAe,sCAAsC,CAAC;AAiE5D;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GACrC,WAAW,GACX,UAAU,GACV,aAAa,CAAC;AAgBlB;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,2CAA2C;IAC3C,OAAO,EAAE,GAAG,CAAC;IACb,iEAAiE;IACjE,eAAe,EAAE,MAAM,CAAC;IACxB,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,+BAA+B,EAAE,MAAM,GAAG,IAAI,CAAC;CAChD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,8BAA8B,EAAE,aAAa,GAAG,IAAI,CAAC;CACtD,CAAC;AAiBF;;;;GAIG;AACH,wBAAgB,gDAAgD,IAAI,sCAAsC,CAKzG;AAED;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,OAAQ,CAAC;AAErD;;;GAGG;AACH,eAAO,MAAM,kCAAkC,QAAS,CAAC;AAOzD;;GAEG;AACH,MAAM,MAAM,+CAA+C,GACzD,wBAAwB,CACtB,OAAO,eAAe,EACtB,sCAAsC,CACvC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,wCAAwC,GAChD,+CAA+C,GAC/C,8CAA8C,CAAC;AAEnD;;;GAGG;AACH,KAAK,cAAc,GACf,+BAA+B,GAC/B,uDAAuD,GACvD,oCAAoC,GACpC,uCAAuC,GACvC,yCAAyC,GACzC,oCAAoC,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,kDAAkD,GAC5D,2BAA2B,CACzB,OAAO,eAAe,EACtB,sCAAsC,CACvC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GACjD,kDAAkD,CAAC;AAErD;;;GAGG;AACH,KAAK,aAAa,GACd,iCAAiC,GACjC,2CAA2C,GAC3C,sCAAsC,GACtC,gCAAgC,GAChC,4BAA4B,GAC5B,0BAA0B,CAAC;AAE/B;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG,SAAS,CAChE,OAAO,eAAe,EACtB,wCAAwC,GAAG,cAAc,EACzD,uCAAuC,GAAG,aAAa,CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,SAAS,EAAE,0CAA0C,CAAC;IAEtD;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,iCAAkC,SAAQ,cAAc,CACnE,OAAO,eAAe,EACtB,sCAAsC,EACtC,0CAA0C,CAC3C;;IAqBC;;;;;;;;;;;;;OAaG;IACH,YAAY,EACV,SAAS,EACT,eAAe,EACf,qBAAuD,EACvD,wBAA6D,GAC9D,EAAE,wCAAwC,EAwF1C;IA4CD;;OAEG;IACH,aAAa,IAAI,IAAI,CAEpB;IAED;;;;;;;;OAQG;IACG,gCAAgC,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CA4ClE;CA8PF"}

package/dist/NetworkConnectionBannerController.js

@@ -0,0 +1,442 @@
+import { BaseController } from '@metamask/base-controller';
+import { clientControllerSelectors } from '@metamask/client-controller';
+import { CONNECTIVITY_STATUSES, connectivityControllerSelectors, } from '@metamask/connectivity-controller';
+import { NetworkStatus } from '@metamask/network-controller';
+import { selectEnabledNetworkMap } from '@metamask/network-enablement-controller';
+import { KnownCaipNamespace } from '@metamask/utils';
+import { createSelector } from 'reselect';
+import { getIsInfuraEndpoint } from './url-utils.js';
+/**
+ * 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.
+ */
+const CONTROLLER_NAME = 'NetworkConnectionBannerController';
+/**
+ * Selects `networksMetadata` from the `NetworkController` state.
+ *
+ * @param state - The `NetworkController` state.
+ * @returns The networks metadata map keyed by network client id.
+ */
+const selectNetworksMetadata = (state) => state.networksMetadata;
+/**
+ * Selects `networkConfigurationsByChainId` from the `NetworkController`
+ * state.
+ *
+ * @param state - The `NetworkController` state.
+ * @returns The network configurations keyed by chain id.
+ */
+const selectNetworkConfigurationsByChainId = (state) => state.networkConfigurationsByChainId;
+/**
+ * Selects the `NetworkController` state fields that influence the banner
+ * rule. Composed with `createSelector` so the return object stays reference
+ * stable while unrelated `NetworkController` state (e.g.
+ * `selectedNetworkClientId`) changes.
+ *
+ * @param state - The `NetworkController` state.
+ * @returns The relevant network fields.
+ */
+const selectNetworkControllerFields = createSelector([selectNetworksMetadata, selectNetworkConfigurationsByChainId], (networksMetadata, networkConfigurationsByChainId) => ({
+    networksMetadata,
+    networkConfigurationsByChainId,
+}));
+/**
+ * Selects the `NetworkEnablementController` state field that influences the
+ * banner rule.
+ *
+ * @param state - The `NetworkEnablementController` state.
+ * @returns The relevant enablement fields.
+ */
+const selectNetworkEnablementControllerFields = createSelector([selectEnabledNetworkMap], (enabledNetworkMap) => ({ enabledNetworkMap }));
+/**
+ * Selects the `ConnectivityController` state field that influences the
+ * banner rule.
+ *
+ * @param state - The `ConnectivityController` state.
+ * @returns The relevant connectivity fields.
+ */
+const selectConnectivityControllerFields = createSelector([connectivityControllerSelectors.selectConnectivityStatus], (connectivityStatus) => ({ connectivityStatus }));
+const networkConnectionBannerControllerMetadata = {
+    networkConnectionBannerStatus: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
+    networkConnectionBannerNetwork: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
+};
+/**
+ * Constructs the default {@link NetworkConnectionBannerController} state.
+ *
+ * @returns The default state.
+ */
+export function getDefaultNetworkConnectionBannerControllerState() {
+    return {
+        networkConnectionBannerStatus: 'available',
+        networkConnectionBannerNetwork: null,
+    };
+}
+/**
+ * The default for how long (in milliseconds) a failing network must remain
+ * in a "failed" status ("degraded" or "unavailable") before the degraded
+ * banner appears.
+ */
+export const DEFAULT_DEGRADED_BANNER_TIMEOUT = 5_000;
+/**
+ * The default for how long (in milliseconds) a failing network must remain
+ * in a "failed" status before the banner escalates to "unavailable".
+ */
+export const DEFAULT_UNAVAILABLE_BANNER_TIMEOUT = 30_000;
+const MESSENGER_EXPOSED_METHODS = [
+    'dismissBanner',
+    'switchToDefaultInfuraRpcEndpoint',
+];
+/**
+ * Drives the "network connection banner", a notice that appears within clients
+ * whose goal is to inform users about networks which have exhibited repeated
+ * request failures and offer potential workarounds.
+ *
+ * Some terminology: A "network" in this case is an RPC endpoint, and a network
+ * that has exhibited repeated request failures has entered a "failed" state (or
+ * is a "failed network").
+ *
+ * For simplicity, the banner always represents a single failed network. If
+ * multiple networks are failing, the first custom network takes priority over
+ * the first Infura network.
+ *
+ * To ensure that the banner is actionable, the banner does not always appear
+ * even if there is a failed network to display. Instead it appears under these
+ * conditions:
+ *
+ * - The failed network is a custom (non-Infura) endpoint (we want to inform
+ *   users about endpoints they've added so they don't cast blame on MetaMask).
+ * - Every enabled EVM network has entered a failed state (this indicates a
+ *   broad connectivity issue).
+ *
+ * Assuming that these conditions have been met, there are two variants of the
+ * banner which will be displayed at different times.
+ *
+ * - A "degraded" variant which will appear when 5 seconds has elapsed and there
+ *   is an eligible failed network to display
+ * - An "unavailable" variant which will appear when 30 seconds have elapsed and
+ *   there is an eligible failed network to display
+ *
+ * Finally, the controller contains actions that drive interactions with the
+ * banner. Namely, if the banner represents a custom network, then it will offer
+ * the user a way to switch to the default Infura network. The controller
+ * contains the logic to carry out that action.
+ */
+export class NetworkConnectionBannerController extends BaseController {
+    #degradedTimer;
+    #unavailableTimer;
+    #pendingNetworkClientId;
+    #isStarted = false;
+    /** Whether the client UI is open. Combined with {@link #isUnlocked}. */
+    #isUiOpen = false;
+    /** Whether the keyring is unlocked. Combined with {@link #isUiOpen}. */
+    #isUnlocked = false;
+    #infuraProjectId;
+    #degradedBannerTimeout;
+    #unavailableBannerTimeout;
+    /**
+     * Constructs a new {@link NetworkConnectionBannerController}.
+     *
+     * @param args - The arguments to this controller.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.infuraProjectId - The wallet's Infura project id.
+     * @param args.degradedBannerTimeout - How long (in milliseconds) a failing
+     * network must remain failed before the degraded banner appears.
+     * @param args.unavailableBannerTimeout - How long (in milliseconds) before
+     * the banner escalates to "unavailable". Must be greater than
+     * `degradedBannerTimeout`.
+     * @throws If `unavailableBannerTimeout` is not greater than
+     * `degradedBannerTimeout`.
+     */
+    constructor({ messenger, infuraProjectId, degradedBannerTimeout = DEFAULT_DEGRADED_BANNER_TIMEOUT, unavailableBannerTimeout = DEFAULT_UNAVAILABLE_BANNER_TIMEOUT, }) {
+        super({
+            messenger,
+            metadata: networkConnectionBannerControllerMetadata,
+            name: CONTROLLER_NAME,
+            state: getDefaultNetworkConnectionBannerControllerState(),
+        });
+        if (unavailableBannerTimeout <= degradedBannerTimeout) {
+            throw new Error(`\`unavailableBannerTimeout\` (${unavailableBannerTimeout}) must be greater than \`degradedBannerTimeout\` (${degradedBannerTimeout}).`);
+        }
+        this.#infuraProjectId = infuraProjectId;
+        this.#degradedBannerTimeout = degradedBannerTimeout;
+        this.#unavailableBannerTimeout = unavailableBannerTimeout;
+        // Upstream controllers still expose :stateChange; switch to :stateChanged
+        // once those packages migrate their event types.
+        /* eslint-disable no-restricted-syntax -- awaiting upstream :stateChanged migration */
+        this.messenger.subscribe('NetworkController:stateChange', (networkControllerState) => this.#refreshState({
+            networkControllerState,
+            networkEnablementControllerState: this.messenger.call('NetworkEnablementController:getState'),
+            connectivityControllerState: this.messenger.call('ConnectivityController:getState'),
+        }), selectNetworkControllerFields);
+        this.messenger.subscribe('NetworkEnablementController:stateChange', (networkEnablementControllerState) => this.#refreshState({
+            networkControllerState: this.messenger.call('NetworkController:getState'),
+            networkEnablementControllerState,
+            connectivityControllerState: this.messenger.call('ConnectivityController:getState'),
+        }), selectNetworkEnablementControllerFields);
+        this.messenger.subscribe('ConnectivityController:stateChange', (connectivityControllerState) => this.#refreshState({
+            networkControllerState: this.messenger.call('NetworkController:getState'),
+            networkEnablementControllerState: this.messenger.call('NetworkEnablementController:getState'),
+            connectivityControllerState,
+        }), selectConnectivityControllerFields);
+        /* eslint-enable no-restricted-syntax */
+        // Lifecycle: evaluate RPC health (and run the banner escalation timers)
+        // only while the client UI is open on an unlocked wallet.
+        this.messenger.subscribe('ClientController:stateChange', (isUiOpen) => {
+            this.#isUiOpen = isUiOpen;
+            this.#updateLifecycle();
+        }, clientControllerSelectors.selectIsUiOpen);
+        this.messenger.subscribe('KeyringController:unlock', () => {
+            this.#isUnlocked = true;
+            this.#updateLifecycle();
+        });
+        this.messenger.subscribe('KeyringController:lock', () => {
+            this.#isUnlocked = false;
+            this.#updateLifecycle();
+        });
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    #updateLifecycle() {
+        if (this.#isUiOpen && this.#isUnlocked) {
+            this.#start();
+        }
+        else {
+            this.#stop();
+        }
+    }
+    /**
+     * Look for a failed network, if any, and populate the initial state of the
+     * banner. Reacts to upstream state changes from this point on. Idempotent.
+     */
+    #start() {
+        if (this.#isStarted) {
+            return;
+        }
+        this.#isStarted = true;
+        this.#refreshState({
+            networkControllerState: this.messenger.call('NetworkController:getState'),
+            networkEnablementControllerState: this.messenger.call('NetworkEnablementController:getState'),
+            connectivityControllerState: this.messenger.call('ConnectivityController:getState'),
+        });
+    }
+    /**
+     * Stops evaluating network connection state. Clears any pending banner
+     * timers and resets state to `available`. Idempotent.
+     */
+    #stop() {
+        if (!this.#isStarted) {
+            return;
+        }
+        this.#isStarted = false;
+        this.#resetBanner();
+    }
+    /**
+     * Clears the banner state such that the banner will be hidden.
+     */
+    dismissBanner() {
+        this.#resetBanner();
+    }
+    /**
+     * Switches the chain's default RPC endpoint to its Infura endpoint and
+     * makes it the active network, causing the banner to clear once the
+     * network becomes available again.
+     *
+     * @param chainId - The chain whose default RPC endpoint 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 switchToDefaultInfuraRpcEndpoint(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) => getIsInfuraEndpoint(endpoint.url, this.#infuraProjectId));
+        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;
+        }
+        // Move the active connection onto the Infura endpoint first, then make
+        // it the default. In this order a partial failure leaves the failing
+        // default in place and the banner visible, rather than hiding the banner
+        // while the wallet is still connected to the broken endpoint.
+        const infuraNetworkClientId = networkConfiguration.rpcEndpoints[infuraEndpointIndex].networkClientId;
+        const { selectedNetworkClientId } = this.messenger.call('NetworkController:getState');
+        if (infuraNetworkClientId !== selectedNetworkClientId) {
+            await this.messenger.call('NetworkController:setActiveNetwork', infuraNetworkClientId);
+        }
+        await this.messenger.call('NetworkController:updateNetwork', chainId, {
+            ...networkConfiguration,
+            defaultRpcEndpointIndex: infuraEndpointIndex,
+        });
+    }
+    #refreshState({ networkControllerState, networkEnablementControllerState, connectivityControllerState, }) {
+        if (!this.#isStarted) {
+            return;
+        }
+        if (connectivityControllerState.connectivityStatus ===
+            CONNECTIVITY_STATUSES.Offline) {
+            this.#resetBanner();
+            return;
+        }
+        const failedNetwork = this.#findFailedNetwork(networkControllerState, networkEnablementControllerState);
+        if (!failedNetwork) {
+            this.#resetBanner();
+            return;
+        }
+        if (this.state.networkConnectionBannerStatus !== 'available' &&
+            this.state.networkConnectionBannerNetwork?.networkClientId ===
+                failedNetwork.networkClientId) {
+            this.update((state) => {
+                // Even if the network client ID has not changed, save the current
+                // version of the failed network to state in case the user has updated
+                // its RPC URL.
+                state.networkConnectionBannerNetwork = failedNetwork;
+            });
+            return;
+        }
+        // A degraded timer is already counting down for this same network.
+        // Repeated `stateChange` events must not clear and restart it, or a
+        // steady stream of updates could postpone the banner indefinitely.
+        if (this.#pendingNetworkClientId === failedNetwork.networkClientId) {
+            return;
+        }
+        this.#clearTimers();
+        this.update((state) => {
+            state.networkConnectionBannerStatus = 'available';
+            state.networkConnectionBannerNetwork = null;
+        });
+        // If `stop` is called before scheduling timers, bail early.
+        if (!this.#isStarted) {
+            return;
+        }
+        // Remember which network the pending timer is for (see the guard above)
+        // and capture the failing network at schedule time. If the failure
+        // resolves or a different network becomes the banner target while we
+        // wait, the subscription handlers re-enter this method and cancel or
+        // replace the timer before it fires.
+        this.#pendingNetworkClientId = failedNetwork.networkClientId;
+        this.#degradedTimer = setTimeout(() => {
+            this.#degradedTimer = undefined;
+            this.#pendingNetworkClientId = undefined;
+            this.update((state) => {
+                state.networkConnectionBannerStatus = 'degraded';
+                state.networkConnectionBannerNetwork = failedNetwork;
+            });
+            // If `stop` is called before scheduling timers, bail early.
+            if (!this.#isStarted) {
+                return;
+            }
+            this.#unavailableTimer = setTimeout(() => {
+                this.#unavailableTimer = undefined;
+                this.update((state) => {
+                    state.networkConnectionBannerStatus = 'unavailable';
+                    state.networkConnectionBannerNetwork = failedNetwork;
+                });
+            }, this.#unavailableBannerTimeout - this.#degradedBannerTimeout);
+        }, this.#degradedBannerTimeout);
+    }
+    /**
+     * Clears timers and resets banner state to {@link NetworkConnectionBannerStatus|`available`}
+     * if it isn't there already.
+     */
+    #resetBanner() {
+        this.#clearTimers();
+        this.#pendingNetworkClientId = undefined;
+        if (this.state.networkConnectionBannerStatus !== 'available' ||
+            this.state.networkConnectionBannerNetwork !== null) {
+            this.update((state) => {
+                state.networkConnectionBannerStatus = 'available';
+                state.networkConnectionBannerNetwork = null;
+            });
+        }
+    }
+    #clearTimers() {
+        if (this.#degradedTimer !== undefined) {
+            clearTimeout(this.#degradedTimer);
+            this.#degradedTimer = undefined;
+        }
+        if (this.#unavailableTimer !== undefined) {
+            clearTimeout(this.#unavailableTimer);
+            this.#unavailableTimer = undefined;
+        }
+    }
+    #findFailedNetwork(networkState, enablementState) {
+        const enabledNetworks = this.#collectEnabledNetworks(networkState, enablementState);
+        // Networks whose connectivity has not been looked up yet are not failed.
+        const failedNetworks = enabledNetworks
+            .filter(({ metadata }) => metadata !== undefined && metadata.status !== NetworkStatus.Available)
+            .map((network) => this.#buildFailedNetwork(network));
+        return this.#pickFailedNetworkToDisplay(failedNetworks, enabledNetworks.length);
+    }
+    #getEnabledEvmChainIds(enabledNetworkMap) {
+        return Object.entries(enabledNetworkMap[KnownCaipNamespace.Eip155] ?? {})
+            .filter(([, enabled]) => enabled)
+            .map(([chainId]) => chainId);
+    }
+    #collectEnabledNetworks({ networkConfigurationsByChainId, networksMetadata, }, { enabledNetworkMap, }) {
+        return this.#getEnabledEvmChainIds(enabledNetworkMap).flatMap((chainId) => {
+            const networkConfiguration = networkConfigurationsByChainId[chainId];
+            if (!networkConfiguration) {
+                return [];
+            }
+            const { rpcEndpoints, defaultRpcEndpointIndex, name } = networkConfiguration;
+            const defaultRpcEndpoint = rpcEndpoints[defaultRpcEndpointIndex];
+            if (!defaultRpcEndpoint) {
+                return [];
+            }
+            return [
+                {
+                    chainId,
+                    name,
+                    rpcEndpoints,
+                    defaultRpcEndpointIndex,
+                    defaultRpcEndpoint,
+                    metadata: networksMetadata[defaultRpcEndpoint.networkClientId],
+                },
+            ];
+        });
+    }
+    #buildFailedNetwork({ chainId, name, rpcEndpoints, defaultRpcEndpointIndex, defaultRpcEndpoint, }) {
+        const isInfuraEndpoint = getIsInfuraEndpoint(defaultRpcEndpoint.url, this.#infuraProjectId);
+        // For custom endpoints (non-Infura), find an Infura endpoint on this
+        // chain that we could offer to switch to.
+        let switchableInfuraNetworkClientId = null;
+        if (!isInfuraEndpoint) {
+            const infuraEndpoint = rpcEndpoints.find((endpoint, index) => index !== defaultRpcEndpointIndex &&
+                getIsInfuraEndpoint(endpoint.url, this.#infuraProjectId));
+            switchableInfuraNetworkClientId = infuraEndpoint?.networkClientId ?? null;
+        }
+        return {
+            chainId,
+            networkClientId: defaultRpcEndpoint.networkClientId,
+            name,
+            rpcUrl: defaultRpcEndpoint.url,
+            isInfuraEndpoint,
+            switchableInfuraNetworkClientId,
+        };
+    }
+    #pickFailedNetworkToDisplay(failedNetworks, totalEnabledNetworks) {
+        if (failedNetworks.length === 0) {
+            return null;
+        }
+        const firstCustomFailed = failedNetworks.find((entry) => !entry.isInfuraEndpoint);
+        const areAllEnabledNetworksFailed = failedNetworks.length === totalEnabledNetworks;
+        if (!firstCustomFailed && !areAllEnabledNetworksFailed) {
+            return null;
+        }
+        return firstCustomFailed ?? failedNetworks[0];
+    }
+}
+//# sourceMappingURL=NetworkConnectionBannerController.js.map

package/dist/NetworkConnectionBannerController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkConnectionBannerController.js","sourceRoot":"","sources":["../src/NetworkConnectionBannerController.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EACL,qBAAqB,EACrB,+BAA+B,GAChC,MAAM,mCAAmC,CAAC;AAqB3C,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAM7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAElF,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAG1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAErD;;;;GAIG;AACH,MAAM,eAAe,GAAG,mCAAmC,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,sBAAsB,GAAG,CAC7B,KAAmB,EACe,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC;AAE9D;;;;;;GAMG;AACH,MAAM,oCAAoC,GAAG,CAC3C,KAAmB,EAC6B,EAAE,CAClD,KAAK,CAAC,8BAA8B,CAAC;AAEvC;;;;;;;;GAQG;AACH,MAAM,6BAA6B,GAAG,cAAc,CAClD,CAAC,sBAAsB,EAAE,oCAAoC,CAAC,EAC9D,CAAC,gBAAgB,EAAE,8BAA8B,EAAE,EAAE,CAAC,CAAC;IACrD,gBAAgB;IAChB,8BAA8B;CAC/B,CAAC,CACH,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,uCAAuC,GAAG,cAAc,CAC5D,CAAC,uBAAuB,CAAC,EACzB,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAC/C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,kCAAkC,GAAG,cAAc,CACvD,CAAC,+BAA+B,CAAC,wBAAwB,CAAC,EAC1D,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,CACjD,CAAC;AA6DF,MAAM,yCAAyC,GAAG;IAChD,6BAA6B,EAAE;QAC7B,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,IAAI;KACf;IACD,8BAA8B,EAAE;QAC9B,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,IAAI;KACf;CAC8D,CAAC;AAElE;;;;GAIG;AACH,MAAM,UAAU,gDAAgD;IAC9D,OAAO;QACL,6BAA6B,EAAE,WAAW;QAC1C,8BAA8B,EAAE,IAAI;KACrC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,KAAK,CAAC;AAErD;;;GAGG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,MAAM,CAAC;AAEzD,MAAM,yBAAyB,GAAG;IAChC,eAAe;IACf,kCAAkC;CAC1B,CAAC;AAqGX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,OAAO,iCAAkC,SAAQ,cAItD;IACC,cAAc,CAA4C;IAE1D,iBAAiB,CAA4C;IAE7D,uBAAuB,CAAqB;IAE5C,UAAU,GAAG,KAAK,CAAC;IAEnB,wEAAwE;IACxE,SAAS,GAAG,KAAK,CAAC;IAElB,wEAAwE;IACxE,WAAW,GAAG,KAAK,CAAC;IAEX,gBAAgB,CAAS;IAEzB,sBAAsB,CAAS;IAE/B,yBAAyB,CAAS;IAE3C;;;;;;;;;;;;;OAaG;IACH,YAAY,EACV,SAAS,EACT,eAAe,EACf,qBAAqB,GAAG,+BAA+B,EACvD,wBAAwB,GAAG,kCAAkC,GACpB;QACzC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,yCAAyC;YACnD,IAAI,EAAE,eAAe;YACrB,KAAK,EAAE,gDAAgD,EAAE;SAC1D,CAAC,CAAC;QAEH,IAAI,wBAAwB,IAAI,qBAAqB,EAAE,CAAC;YACtD,MAAM,IAAI,KAAK,CACb,iCAAiC,wBAAwB,qDAAqD,qBAAqB,IAAI,CACxI,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,sBAAsB,GAAG,qBAAqB,CAAC;QACpD,IAAI,CAAC,yBAAyB,GAAG,wBAAwB,CAAC;QAE1D,0EAA0E;QAC1E,iDAAiD;QACjD,sFAAsF;QACtF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,+BAA+B,EAC/B,CAAC,sBAAsB,EAAE,EAAE,CACzB,IAAI,CAAC,aAAa,CAAC;YACjB,sBAAsB;YACtB,gCAAgC,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CACnD,sCAAsC,CACvC;YACD,2BAA2B,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9C,iCAAiC,CAClC;SACF,CAAC,EACJ,6BAA6B,CAC9B,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,yCAAyC,EACzC,CAAC,gCAAgC,EAAE,EAAE,CACnC,IAAI,CAAC,aAAa,CAAC;YACjB,sBAAsB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CACzC,4BAA4B,CAC7B;YACD,gCAAgC;YAChC,2BAA2B,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9C,iCAAiC,CAClC;SACF,CAAC,EACJ,uCAAuC,CACxC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,oCAAoC,EACpC,CAAC,2BAA2B,EAAE,EAAE,CAC9B,IAAI,CAAC,aAAa,CAAC;YACjB,sBAAsB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CACzC,4BAA4B,CAC7B;YACD,gCAAgC,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CACnD,sCAAsC,CACvC;YACD,2BAA2B;SAC5B,CAAC,EACJ,kCAAkC,CACnC,CAAC;QACF,wCAAwC;QAExC,wEAAwE;QACxE,0DAA0D;QAC1D,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,8BAA8B,EAC9B,CAAC,QAAQ,EAAE,EAAE;YACX,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC,EACD,yBAAyB,CAAC,cAAc,CACzC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACxD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACtD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;YACzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED,gBAAgB;QACd,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACvC,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,aAAa,CAAC;YACjB,sBAAsB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC;YACzE,gCAAgC,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CACnD,sCAAsC,CACvC;YACD,2BAA2B,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9C,iCAAiC,CAClC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,aAAa;QACX,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gCAAgC,CAAC,OAAY;QACjD,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,mBAAmB,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAC,CACvE,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,uEAAuE;QACvE,qEAAqE;QACrE,yEAAyE;QACzE,8DAA8D;QAC9D,MAAM,qBAAqB,GACzB,oBAAoB,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC,eAAe,CAAC;QACzE,MAAM,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACrD,4BAA4B,CAC7B,CAAC;QACF,IAAI,qBAAqB,KAAK,uBAAuB,EAAE,CAAC;YACtD,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACvB,oCAAoC,EACpC,qBAAqB,CACtB,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iCAAiC,EAAE,OAAO,EAAE;YACpE,GAAG,oBAAoB;YACvB,uBAAuB,EAAE,mBAAmB;SAC7C,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,EACZ,sBAAsB,EACtB,gCAAgC,EAChC,2BAA2B,GAc5B;QACC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,IACE,2BAA2B,CAAC,kBAAkB;YAC9C,qBAAqB,CAAC,OAAO,EAC7B,CAAC;YACD,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAC3C,sBAAsB,EACtB,gCAAgC,CACjC,CAAC;QACF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QAED,IACE,IAAI,CAAC,KAAK,CAAC,6BAA6B,KAAK,WAAW;YACxD,IAAI,CAAC,KAAK,CAAC,8BAA8B,EAAE,eAAe;gBACxD,aAAa,CAAC,eAAe,EAC/B,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,kEAAkE;gBAClE,sEAAsE;gBACtE,eAAe;gBACf,KAAK,CAAC,8BAA8B,GAAG,aAAa,CAAC;YACvD,CAAC,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,mEAAmE;QACnE,oEAAoE;QACpE,mEAAmE;QACnE,IAAI,IAAI,CAAC,uBAAuB,KAAK,aAAa,CAAC,eAAe,EAAE,CAAC;YACnE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,6BAA6B,GAAG,WAAW,CAAC;YAClD,KAAK,CAAC,8BAA8B,GAAG,IAAI,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,4DAA4D;QAC5D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,wEAAwE;QACxE,mEAAmE;QACnE,qEAAqE;QACrE,qEAAqE;QACrE,qCAAqC;QACrC,IAAI,CAAC,uBAAuB,GAAG,aAAa,CAAC,eAAe,CAAC;QAC7D,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,GAAG,EAAE;YACpC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,6BAA6B,GAAG,UAAU,CAAC;gBACjD,KAAK,CAAC,8BAA8B,GAAG,aAAa,CAAC;YACvD,CAAC,CAAC,CAAC;YACH,4DAA4D;YAC5D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBACrB,OAAO;YACT,CAAC;YACD,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,GAAG,EAAE;gBACvC,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;gBACnC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,6BAA6B,GAAG,aAAa,CAAC;oBACpD,KAAK,CAAC,8BAA8B,GAAG,aAAa,CAAC;gBACvD,CAAC,CAAC,CAAC;YACL,CAAC,EAAE,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACnE,CAAC,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzC,IACE,IAAI,CAAC,KAAK,CAAC,6BAA6B,KAAK,WAAW;YACxD,IAAI,CAAC,KAAK,CAAC,8BAA8B,KAAK,IAAI,EAClD,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,6BAA6B,GAAG,WAAW,CAAC;gBAClD,KAAK,CAAC,8BAA8B,GAAG,IAAI,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,YAAY;QACV,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACtC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAClC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAClC,CAAC;QACD,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACzC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YACrC,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;QACrC,CAAC;IACH,CAAC;IAED,kBAAkB,CAChB,YAGC,EACD,eAGC;QAED,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAClD,YAAY,EACZ,eAAe,CAChB,CAAC;QACF,yEAAyE;QACzE,MAAM,cAAc,GAAG,eAAe;aACnC,MAAM,CACL,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CACf,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,KAAK,aAAa,CAAC,SAAS,CACxE;aACA,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,2BAA2B,CACrC,cAAc,EACd,eAAe,CAAC,MAAM,CACvB,CAAC;IACJ,CAAC;IAED,sBAAsB,CACpB,iBAAwE;QAExE,OAAO,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;aACtE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC;aAChC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAc,CAAC,CAAC;IACxC,CAAC;IAED,uBAAuB,CACrB,EACE,8BAA8B,EAC9B,gBAAgB,GAIjB,EACD,EACE,iBAAiB,GAC2C;QAE9D,OAAO,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACxE,MAAM,oBAAoB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;YACrE,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC1B,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,MAAM,EAAE,YAAY,EAAE,uBAAuB,EAAE,IAAI,EAAE,GACnD,oBAAoB,CAAC;YACvB,MAAM,kBAAkB,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAC;YACjE,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO;gBACL;oBACE,OAAO;oBACP,IAAI;oBACJ,YAAY;oBACZ,uBAAuB;oBACvB,kBAAkB;oBAClB,QAAQ,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,eAAe,CAAC;iBAC/D;aACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mBAAmB,CAAC,EAClB,OAAO,EACP,IAAI,EACJ,YAAY,EACZ,uBAAuB,EACvB,kBAAkB,GACH;QACf,MAAM,gBAAgB,GAAG,mBAAmB,CAC1C,kBAAkB,CAAC,GAAG,EACtB,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEF,qEAAqE;QACrE,0CAA0C;QAC1C,IAAI,+BAA+B,GAAkB,IAAI,CAAC;QAC1D,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,cAAc,GAAG,YAAY,CAAC,IAAI,CACtC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAClB,KAAK,KAAK,uBAAuB;gBACjC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAC3D,CAAC;YACF,+BAA+B,GAAG,cAAc,EAAE,eAAe,IAAI,IAAI,CAAC;QAC5E,CAAC;QAED,OAAO;YACL,OAAO;YACP,eAAe,EAAE,kBAAkB,CAAC,eAAe;YACnD,IAAI;YACJ,MAAM,EAAE,kBAAkB,CAAC,GAAG;YAC9B,gBAAgB;YAChB,+BAA+B;SAChC,CAAC;IACJ,CAAC;IAED,2BAA2B,CACzB,cAA+B,EAC/B,oBAA4B;QAE5B,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,iBAAiB,GAAG,cAAc,CAAC,IAAI,CAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CACnC,CAAC;QACF,MAAM,2BAA2B,GAC/B,cAAc,CAAC,MAAM,KAAK,oBAAoB,CAAC;QAEjD,IAAI,CAAC,iBAAiB,IAAI,CAAC,2BAA2B,EAAE,CAAC;YACvD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,iBAAiB,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;CACF","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangedEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { clientControllerSelectors } from '@metamask/client-controller';\nimport type { ClientControllerStateChangeEvent } from '@metamask/client-controller';\nimport {\n  CONNECTIVITY_STATUSES,\n  connectivityControllerSelectors,\n} from '@metamask/connectivity-controller';\nimport type {\n  ConnectivityControllerGetStateAction,\n  ConnectivityControllerState,\n  ConnectivityControllerStateChangeEvent,\n} from '@metamask/connectivity-controller';\nimport type {\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport type {\n  NetworkConfiguration,\n  NetworkControllerGetNetworkConfigurationByChainIdAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerUpdateNetworkAction,\n  NetworkControllerSetActiveNetworkAction,\n  NetworkControllerStateChangeEvent,\n  NetworkMetadata,\n  NetworkState,\n} from '@metamask/network-controller';\nimport { NetworkStatus } from '@metamask/network-controller';\nimport type {\n  NetworkEnablementControllerGetStateAction,\n  NetworkEnablementControllerState,\n  NetworkEnablementControllerStateChangeEvent,\n} from '@metamask/network-enablement-controller';\nimport { selectEnabledNetworkMap } from '@metamask/network-enablement-controller';\nimport type { Hex } from '@metamask/utils';\nimport { KnownCaipNamespace } from '@metamask/utils';\nimport { createSelector } from 'reselect';\n\nimport type { NetworkConnectionBannerControllerMethodActions } from './NetworkConnectionBannerController-method-action-types.js';\nimport { getIsInfuraEndpoint } from './url-utils.js';\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 */\nconst CONTROLLER_NAME = 'NetworkConnectionBannerController';\n\n/**\n * Selects `networksMetadata` from the `NetworkController` state.\n *\n * @param state - The `NetworkController` state.\n * @returns The networks metadata map keyed by network client id.\n */\nconst selectNetworksMetadata = (\n  state: NetworkState,\n): NetworkState['networksMetadata'] => state.networksMetadata;\n\n/**\n * Selects `networkConfigurationsByChainId` from the `NetworkController`\n * state.\n *\n * @param state - The `NetworkController` state.\n * @returns The network configurations keyed by chain id.\n */\nconst selectNetworkConfigurationsByChainId = (\n  state: NetworkState,\n): NetworkState['networkConfigurationsByChainId'] =>\n  state.networkConfigurationsByChainId;\n\n/**\n * Selects the `NetworkController` state fields that influence the banner\n * rule. Composed with `createSelector` so the return object stays reference\n * stable while unrelated `NetworkController` state (e.g.\n * `selectedNetworkClientId`) changes.\n *\n * @param state - The `NetworkController` state.\n * @returns The relevant network fields.\n */\nconst selectNetworkControllerFields = createSelector(\n  [selectNetworksMetadata, selectNetworkConfigurationsByChainId],\n  (networksMetadata, networkConfigurationsByChainId) => ({\n    networksMetadata,\n    networkConfigurationsByChainId,\n  }),\n);\n\n/**\n * Selects the `NetworkEnablementController` state field that influences the\n * banner rule.\n *\n * @param state - The `NetworkEnablementController` state.\n * @returns The relevant enablement fields.\n */\nconst selectNetworkEnablementControllerFields = createSelector(\n  [selectEnabledNetworkMap],\n  (enabledNetworkMap) => ({ enabledNetworkMap }),\n);\n\n/**\n * Selects the `ConnectivityController` state field that influences the\n * banner rule.\n *\n * @param state - The `ConnectivityController` state.\n * @returns The relevant connectivity fields.\n */\nconst selectConnectivityControllerFields = createSelector(\n  [connectivityControllerSelectors.selectConnectivityStatus],\n  (connectivityStatus) => ({ connectivityStatus }),\n);\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 * An enabled network from `NetworkController` state with a default RPC\n * endpoint. Used as the input to the failed-network detection pipeline.\n * `metadata` is missing until the network's connectivity has been looked up.\n */\ntype EnabledNetwork = {\n  chainId: Hex;\n  name: string;\n  rpcEndpoints: NetworkConfiguration['rpcEndpoints'];\n  defaultRpcEndpointIndex: number;\n  defaultRpcEndpoint: NetworkConfiguration['rpcEndpoints'][number];\n  metadata: NetworkMetadata | undefined;\n};\n\n/**\n * Details of a failing network the banner describes.\n */\nexport type FailedNetwork = {\n  /** The chain id of the failing network. */\n  chainId: Hex;\n  /** The `networkClientId` of the failing default RPC endpoint. */\n  networkClientId: string;\n  /** The display name for the failing network. */\n  name: string;\n  /** The URL of the failing default RPC endpoint. */\n  rpcUrl: string;\n  /** Whether the failing endpoint is a MetaMask Infura endpoint. */\n  isInfuraEndpoint: boolean;\n  /**\n   * The networkClientId of an Infura endpoint on the same chain that the user\n   * can switch to. `null` when the failing endpoint is already Infura or when\n   * no Infura alternative exists.\n   */\n  switchableInfuraNetworkClientId: string | null;\n};\n\n/**\n * State for the {@link NetworkConnectionBannerController}.\n *\n * The keys carry the controller-domain prefix (like\n * `ConnectivityController`'s `connectivityStatus`) because some clients merge\n * all controller states into one flat object, where generic names like\n * `status` collide across controllers.\n */\nexport type NetworkConnectionBannerControllerState = {\n  networkConnectionBannerStatus: NetworkConnectionBannerStatus;\n  networkConnectionBannerNetwork: FailedNetwork | null;\n};\n\nconst networkConnectionBannerControllerMetadata = {\n  networkConnectionBannerStatus: {\n    persist: false,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: true,\n  },\n  networkConnectionBannerNetwork: {\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    networkConnectionBannerStatus: 'available',\n    networkConnectionBannerNetwork: null,\n  };\n}\n\n/**\n * The default for how long (in milliseconds) a failing network must remain\n * in a \"failed\" status (\"degraded\" or \"unavailable\") before the degraded\n * banner appears.\n */\nexport const DEFAULT_DEGRADED_BANNER_TIMEOUT = 5_000;\n\n/**\n * The default for how long (in milliseconds) a failing network must remain\n * in a \"failed\" status before the banner escalates to \"unavailable\".\n */\nexport const DEFAULT_UNAVAILABLE_BANNER_TIMEOUT = 30_000;\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'dismissBanner',\n  'switchToDefaultInfuraRpcEndpoint',\n] as const;\n\n/**\n * Retrieves the state of the {@link NetworkConnectionBannerController}.\n */\nexport type NetworkConnectionBannerControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof CONTROLLER_NAME,\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  | NetworkControllerSetActiveNetworkAction\n  | NetworkEnablementControllerGetStateAction\n  | ConnectivityControllerGetStateAction;\n\n/**\n * Published when the state of {@link NetworkConnectionBannerController}\n * changes.\n */\nexport type NetworkConnectionBannerControllerStateChangedEvent =\n  ControllerStateChangedEvent<\n    typeof CONTROLLER_NAME,\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  | NetworkControllerStateChangeEvent\n  | NetworkEnablementControllerStateChangeEvent\n  | ConnectivityControllerStateChangeEvent\n  | ClientControllerStateChangeEvent\n  | KeyringControllerUnlockEvent\n  | KeyringControllerLockEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link NetworkConnectionBannerController}.\n */\nexport type NetworkConnectionBannerControllerMessenger = Messenger<\n  typeof CONTROLLER_NAME,\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   * The wallet's Infura project id, used to recognize MetaMask Infura\n   * endpoints whose URL was persisted with the id already substituted.\n   */\n  infuraProjectId: string;\n\n  /**\n   * How long (in milliseconds) a failing network must remain in a \"failed\"\n   * status before the degraded banner appears. Defaults to\n   * {@link DEFAULT_DEGRADED_BANNER_TIMEOUT}.\n   */\n  degradedBannerTimeout?: number;\n\n  /**\n   * How long (in milliseconds), measured from the same failure start as\n   * `degradedBannerTimeout`, before the banner escalates to \"unavailable\".\n   * Must be greater than `degradedBannerTimeout`. Defaults to\n   * {@link DEFAULT_UNAVAILABLE_BANNER_TIMEOUT}.\n   */\n  unavailableBannerTimeout?: number;\n};\n\n/**\n * Drives the \"network connection banner\", a notice that appears within clients\n * whose goal is to inform users about networks which have exhibited repeated\n * request failures and offer potential workarounds.\n *\n * Some terminology: A \"network\" in this case is an RPC endpoint, and a network\n * that has exhibited repeated request failures has entered a \"failed\" state (or\n * is a \"failed network\").\n *\n * For simplicity, the banner always represents a single failed network. If\n * multiple networks are failing, the first custom network takes priority over\n * the first Infura network.\n *\n * To ensure that the banner is actionable, the banner does not always appear\n * even if there is a failed network to display. Instead it appears under these\n * conditions:\n *\n * - The failed network is a custom (non-Infura) endpoint (we want to inform\n *   users about endpoints they've added so they don't cast blame on MetaMask).\n * - Every enabled EVM network has entered a failed state (this indicates a\n *   broad connectivity issue).\n *\n * Assuming that these conditions have been met, there are two variants of the\n * banner which will be displayed at different times.\n *\n * - A \"degraded\" variant which will appear when 5 seconds has elapsed and there\n *   is an eligible failed network to display\n * - An \"unavailable\" variant which will appear when 30 seconds have elapsed and\n *   there is an eligible failed network to display\n *\n * Finally, the controller contains actions that drive interactions with the\n * banner. Namely, if the banner represents a custom network, then it will offer\n * the user a way to switch to the default Infura network. The controller\n * contains the logic to carry out that action.\n */\nexport class NetworkConnectionBannerController extends BaseController<\n  typeof CONTROLLER_NAME,\n  NetworkConnectionBannerControllerState,\n  NetworkConnectionBannerControllerMessenger\n> {\n  #degradedTimer: ReturnType<typeof setTimeout> | undefined;\n\n  #unavailableTimer: ReturnType<typeof setTimeout> | undefined;\n\n  #pendingNetworkClientId: string | undefined;\n\n  #isStarted = false;\n\n  /** Whether the client UI is open. Combined with {@link #isUnlocked}. */\n  #isUiOpen = false;\n\n  /** Whether the keyring is unlocked. Combined with {@link #isUiOpen}. */\n  #isUnlocked = false;\n\n  readonly #infuraProjectId: string;\n\n  readonly #degradedBannerTimeout: number;\n\n  readonly #unavailableBannerTimeout: number;\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   * @param args.infuraProjectId - The wallet's Infura project id.\n   * @param args.degradedBannerTimeout - How long (in milliseconds) a failing\n   * network must remain failed before the degraded banner appears.\n   * @param args.unavailableBannerTimeout - How long (in milliseconds) before\n   * the banner escalates to \"unavailable\". Must be greater than\n   * `degradedBannerTimeout`.\n   * @throws If `unavailableBannerTimeout` is not greater than\n   * `degradedBannerTimeout`.\n   */\n  constructor({\n    messenger,\n    infuraProjectId,\n    degradedBannerTimeout = DEFAULT_DEGRADED_BANNER_TIMEOUT,\n    unavailableBannerTimeout = DEFAULT_UNAVAILABLE_BANNER_TIMEOUT,\n  }: NetworkConnectionBannerControllerOptions) {\n    super({\n      messenger,\n      metadata: networkConnectionBannerControllerMetadata,\n      name: CONTROLLER_NAME,\n      state: getDefaultNetworkConnectionBannerControllerState(),\n    });\n\n    if (unavailableBannerTimeout <= degradedBannerTimeout) {\n      throw new Error(\n        `\\`unavailableBannerTimeout\\` (${unavailableBannerTimeout}) must be greater than \\`degradedBannerTimeout\\` (${degradedBannerTimeout}).`,\n      );\n    }\n\n    this.#infuraProjectId = infuraProjectId;\n    this.#degradedBannerTimeout = degradedBannerTimeout;\n    this.#unavailableBannerTimeout = unavailableBannerTimeout;\n\n    // Upstream controllers still expose :stateChange; switch to :stateChanged\n    // once those packages migrate their event types.\n    /* eslint-disable no-restricted-syntax -- awaiting upstream :stateChanged migration */\n    this.messenger.subscribe(\n      'NetworkController:stateChange',\n      (networkControllerState) =>\n        this.#refreshState({\n          networkControllerState,\n          networkEnablementControllerState: this.messenger.call(\n            'NetworkEnablementController:getState',\n          ),\n          connectivityControllerState: this.messenger.call(\n            'ConnectivityController:getState',\n          ),\n        }),\n      selectNetworkControllerFields,\n    );\n    this.messenger.subscribe(\n      'NetworkEnablementController:stateChange',\n      (networkEnablementControllerState) =>\n        this.#refreshState({\n          networkControllerState: this.messenger.call(\n            'NetworkController:getState',\n          ),\n          networkEnablementControllerState,\n          connectivityControllerState: this.messenger.call(\n            'ConnectivityController:getState',\n          ),\n        }),\n      selectNetworkEnablementControllerFields,\n    );\n    this.messenger.subscribe(\n      'ConnectivityController:stateChange',\n      (connectivityControllerState) =>\n        this.#refreshState({\n          networkControllerState: this.messenger.call(\n            'NetworkController:getState',\n          ),\n          networkEnablementControllerState: this.messenger.call(\n            'NetworkEnablementController:getState',\n          ),\n          connectivityControllerState,\n        }),\n      selectConnectivityControllerFields,\n    );\n    /* eslint-enable no-restricted-syntax */\n\n    // Lifecycle: evaluate RPC health (and run the banner escalation timers)\n    // only while the client UI is open on an unlocked wallet.\n    this.messenger.subscribe(\n      'ClientController:stateChange',\n      (isUiOpen) => {\n        this.#isUiOpen = isUiOpen;\n        this.#updateLifecycle();\n      },\n      clientControllerSelectors.selectIsUiOpen,\n    );\n    this.messenger.subscribe('KeyringController:unlock', () => {\n      this.#isUnlocked = true;\n      this.#updateLifecycle();\n    });\n    this.messenger.subscribe('KeyringController:lock', () => {\n      this.#isUnlocked = false;\n      this.#updateLifecycle();\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  #updateLifecycle(): void {\n    if (this.#isUiOpen && this.#isUnlocked) {\n      this.#start();\n    } else {\n      this.#stop();\n    }\n  }\n\n  /**\n   * Look for a failed network, if any, and populate the initial state of the\n   * banner. Reacts to upstream state changes from this point on. Idempotent.\n   */\n  #start(): void {\n    if (this.#isStarted) {\n      return;\n    }\n\n    this.#isStarted = true;\n    this.#refreshState({\n      networkControllerState: this.messenger.call('NetworkController:getState'),\n      networkEnablementControllerState: this.messenger.call(\n        'NetworkEnablementController:getState',\n      ),\n      connectivityControllerState: this.messenger.call(\n        'ConnectivityController:getState',\n      ),\n    });\n  }\n\n  /**\n   * Stops evaluating network connection state. Clears any pending banner\n   * timers and resets state to `available`. Idempotent.\n   */\n  #stop(): void {\n    if (!this.#isStarted) {\n      return;\n    }\n\n    this.#isStarted = false;\n    this.#resetBanner();\n  }\n\n  /**\n   * Clears the banner state such that the banner will be hidden.\n   */\n  dismissBanner(): void {\n    this.#resetBanner();\n  }\n\n  /**\n   * Switches the chain's default RPC endpoint to its Infura endpoint and\n   * makes it the active network, causing the banner to clear once the\n   * network becomes available again.\n   *\n   * @param chainId - The chain whose default RPC endpoint 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 switchToDefaultInfuraRpcEndpoint(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) => getIsInfuraEndpoint(endpoint.url, this.#infuraProjectId),\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    // Move the active connection onto the Infura endpoint first, then make\n    // it the default. In this order a partial failure leaves the failing\n    // default in place and the banner visible, rather than hiding the banner\n    // while the wallet is still connected to the broken endpoint.\n    const infuraNetworkClientId =\n      networkConfiguration.rpcEndpoints[infuraEndpointIndex].networkClientId;\n    const { selectedNetworkClientId } = this.messenger.call(\n      'NetworkController:getState',\n    );\n    if (infuraNetworkClientId !== selectedNetworkClientId) {\n      await this.messenger.call(\n        'NetworkController:setActiveNetwork',\n        infuraNetworkClientId,\n      );\n    }\n\n    await this.messenger.call('NetworkController:updateNetwork', chainId, {\n      ...networkConfiguration,\n      defaultRpcEndpointIndex: infuraEndpointIndex,\n    });\n  }\n\n  #refreshState({\n    networkControllerState,\n    networkEnablementControllerState,\n    connectivityControllerState,\n  }: {\n    networkControllerState: Pick<\n      NetworkState,\n      'networkConfigurationsByChainId' | 'networksMetadata'\n    >;\n    networkEnablementControllerState: Pick<\n      NetworkEnablementControllerState,\n      'enabledNetworkMap'\n    >;\n    connectivityControllerState: Pick<\n      ConnectivityControllerState,\n      'connectivityStatus'\n    >;\n  }): void {\n    if (!this.#isStarted) {\n      return;\n    }\n\n    if (\n      connectivityControllerState.connectivityStatus ===\n      CONNECTIVITY_STATUSES.Offline\n    ) {\n      this.#resetBanner();\n      return;\n    }\n\n    const failedNetwork = this.#findFailedNetwork(\n      networkControllerState,\n      networkEnablementControllerState,\n    );\n    if (!failedNetwork) {\n      this.#resetBanner();\n      return;\n    }\n\n    if (\n      this.state.networkConnectionBannerStatus !== 'available' &&\n      this.state.networkConnectionBannerNetwork?.networkClientId ===\n        failedNetwork.networkClientId\n    ) {\n      this.update((state) => {\n        // Even if the network client ID has not changed, save the current\n        // version of the failed network to state in case the user has updated\n        // its RPC URL.\n        state.networkConnectionBannerNetwork = failedNetwork;\n      });\n      return;\n    }\n\n    // A degraded timer is already counting down for this same network.\n    // Repeated `stateChange` events must not clear and restart it, or a\n    // steady stream of updates could postpone the banner indefinitely.\n    if (this.#pendingNetworkClientId === failedNetwork.networkClientId) {\n      return;\n    }\n\n    this.#clearTimers();\n    this.update((state) => {\n      state.networkConnectionBannerStatus = 'available';\n      state.networkConnectionBannerNetwork = null;\n    });\n\n    // If `stop` is called before scheduling timers, bail early.\n    if (!this.#isStarted) {\n      return;\n    }\n\n    // Remember which network the pending timer is for (see the guard above)\n    // and capture the failing network at schedule time. If the failure\n    // resolves or a different network becomes the banner target while we\n    // wait, the subscription handlers re-enter this method and cancel or\n    // replace the timer before it fires.\n    this.#pendingNetworkClientId = failedNetwork.networkClientId;\n    this.#degradedTimer = setTimeout(() => {\n      this.#degradedTimer = undefined;\n      this.#pendingNetworkClientId = undefined;\n      this.update((state) => {\n        state.networkConnectionBannerStatus = 'degraded';\n        state.networkConnectionBannerNetwork = failedNetwork;\n      });\n      // If `stop` is called before scheduling timers, bail early.\n      if (!this.#isStarted) {\n        return;\n      }\n      this.#unavailableTimer = setTimeout(() => {\n        this.#unavailableTimer = undefined;\n        this.update((state) => {\n          state.networkConnectionBannerStatus = 'unavailable';\n          state.networkConnectionBannerNetwork = failedNetwork;\n        });\n      }, this.#unavailableBannerTimeout - this.#degradedBannerTimeout);\n    }, this.#degradedBannerTimeout);\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    this.#pendingNetworkClientId = undefined;\n    if (\n      this.state.networkConnectionBannerStatus !== 'available' ||\n      this.state.networkConnectionBannerNetwork !== null\n    ) {\n      this.update((state) => {\n        state.networkConnectionBannerStatus = 'available';\n        state.networkConnectionBannerNetwork = 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  #findFailedNetwork(\n    networkState: Pick<\n      NetworkState,\n      'networkConfigurationsByChainId' | 'networksMetadata'\n    >,\n    enablementState: Pick<\n      NetworkEnablementControllerState,\n      'enabledNetworkMap'\n    >,\n  ): FailedNetwork | null {\n    const enabledNetworks = this.#collectEnabledNetworks(\n      networkState,\n      enablementState,\n    );\n    // Networks whose connectivity has not been looked up yet are not failed.\n    const failedNetworks = enabledNetworks\n      .filter(\n        ({ metadata }) =>\n          metadata !== undefined && metadata.status !== NetworkStatus.Available,\n      )\n      .map((network) => this.#buildFailedNetwork(network));\n    return this.#pickFailedNetworkToDisplay(\n      failedNetworks,\n      enabledNetworks.length,\n    );\n  }\n\n  #getEnabledEvmChainIds(\n    enabledNetworkMap: NetworkEnablementControllerState['enabledNetworkMap'],\n  ): Hex[] {\n    return Object.entries(enabledNetworkMap[KnownCaipNamespace.Eip155] ?? {})\n      .filter(([, enabled]) => enabled)\n      .map(([chainId]) => chainId as Hex);\n  }\n\n  #collectEnabledNetworks(\n    {\n      networkConfigurationsByChainId,\n      networksMetadata,\n    }: Pick<\n      NetworkState,\n      'networkConfigurationsByChainId' | 'networksMetadata'\n    >,\n    {\n      enabledNetworkMap,\n    }: Pick<NetworkEnablementControllerState, 'enabledNetworkMap'>,\n  ): EnabledNetwork[] {\n    return this.#getEnabledEvmChainIds(enabledNetworkMap).flatMap((chainId) => {\n      const networkConfiguration = networkConfigurationsByChainId[chainId];\n      if (!networkConfiguration) {\n        return [];\n      }\n      const { rpcEndpoints, defaultRpcEndpointIndex, name } =\n        networkConfiguration;\n      const defaultRpcEndpoint = rpcEndpoints[defaultRpcEndpointIndex];\n      if (!defaultRpcEndpoint) {\n        return [];\n      }\n      return [\n        {\n          chainId,\n          name,\n          rpcEndpoints,\n          defaultRpcEndpointIndex,\n          defaultRpcEndpoint,\n          metadata: networksMetadata[defaultRpcEndpoint.networkClientId],\n        },\n      ];\n    });\n  }\n\n  #buildFailedNetwork({\n    chainId,\n    name,\n    rpcEndpoints,\n    defaultRpcEndpointIndex,\n    defaultRpcEndpoint,\n  }: EnabledNetwork): FailedNetwork {\n    const isInfuraEndpoint = getIsInfuraEndpoint(\n      defaultRpcEndpoint.url,\n      this.#infuraProjectId,\n    );\n\n    // For custom endpoints (non-Infura), find an Infura endpoint on this\n    // chain that we could offer to switch to.\n    let switchableInfuraNetworkClientId: string | null = null;\n    if (!isInfuraEndpoint) {\n      const infuraEndpoint = rpcEndpoints.find(\n        (endpoint, index) =>\n          index !== defaultRpcEndpointIndex &&\n          getIsInfuraEndpoint(endpoint.url, this.#infuraProjectId),\n      );\n      switchableInfuraNetworkClientId = infuraEndpoint?.networkClientId ?? null;\n    }\n\n    return {\n      chainId,\n      networkClientId: defaultRpcEndpoint.networkClientId,\n      name,\n      rpcUrl: defaultRpcEndpoint.url,\n      isInfuraEndpoint,\n      switchableInfuraNetworkClientId,\n    };\n  }\n\n  #pickFailedNetworkToDisplay(\n    failedNetworks: FailedNetwork[],\n    totalEnabledNetworks: number,\n  ): FailedNetwork | null {\n    if (failedNetworks.length === 0) {\n      return null;\n    }\n\n    const firstCustomFailed = failedNetworks.find(\n      (entry) => !entry.isInfuraEndpoint,\n    );\n    const areAllEnabledNetworksFailed =\n      failedNetworks.length === totalEnabledNetworks;\n\n    if (!firstCustomFailed && !areAllEnabledNetworksFailed) {\n      return null;\n    }\n\n    return firstCustomFailed ?? failedNetworks[0];\n  }\n}\n"]}