@metamask-previews/network-enablement-controller 0.1.0-preview-037d305

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# 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]
+
+## [0.1.0]
+
+### Added
+
+- Initial release ([#6028](https://github.com/MetaMask/core/pull/6028))
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-enablement-controller@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/network-enablement-controller@0.1.0

package/LICENSE

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

package/README.md

@@ -0,0 +1,182 @@
+# Network Enablement Controller
+
+A MetaMask controller for managing network enablement state across different blockchain networks.
+
+## Overview
+
+The NetworkEnablementController tracks which networks are enabled/disabled for the user and provides methods to toggle network states. It supports both EVM (EIP-155) and non-EVM networks like Solana.
+
+## Installation
+
+```bash
+npm install @metamask/network-enablement-controller
+```
+
+```bash
+yarn add @metamask/network-enablement-controller
+```
+
+## Usage
+
+### Basic Controller Usage
+
+```typescript
+import { NetworkEnablementController } from '@metamask/network-enablement-controller';
+
+// Create controller instance
+const controller = new NetworkEnablementController({
+  messenger,
+  state: {
+    enabledNetworkMap: {
+      eip155: {
+        '0x1': true, // Ethereum mainnet enabled
+        '0xa': false, // Optimism disabled
+      },
+      solana: {
+        'solana:mainnet': true,
+      },
+    },
+  },
+});
+
+// Enable a network
+controller.setEnabledNetwork('0x1'); // Hex format for EVM
+controller.setEnabledNetwork('eip155:1'); // CAIP-2 format for EVM
+controller.setEnabledNetwork('solana:mainnet'); // CAIP-2 format for Solana
+
+// Disable a network
+controller.setDisabledNetwork('0xa');
+
+// Check if network is enabled
+const isEnabled = controller.isNetworkEnabled('0x1');
+
+// Get all enabled networks for a namespace
+const evmNetworks = controller.getEnabledNetworksForNamespace('eip155');
+
+// Get all enabled networks across all namespaces
+const allNetworks = controller.getAllEnabledNetworks();
+```
+
+### Using Selectors (Redux-style)
+
+The controller also provides selectors that can be used in Redux contexts or any state management system:
+
+```typescript
+import {
+  selectIsNetworkEnabled,
+  selectAllEnabledNetworks,
+  selectEnabledNetworksForNamespace,
+  selectEnabledEvmNetworks,
+  selectEnabledSolanaNetworks,
+} from '@metamask/network-enablement-controller';
+
+// Get controller state
+const state = controller.state;
+
+// Check if a specific network is enabled
+const isEthereumEnabled = selectIsNetworkEnabled('0x1')(state);
+const isSolanaEnabled = selectIsNetworkEnabled('solana:mainnet')(state);
+
+// Get all enabled networks across all namespaces
+const allEnabledNetworks = selectAllEnabledNetworks(state);
+// Returns: { eip155: ['0x1'], solana: ['solana:mainnet'] }
+
+// Get enabled networks for a specific namespace
+const evmNetworks = selectEnabledNetworksForNamespace('eip155')(state);
+const solanaNetworks = selectEnabledNetworksForNamespace('solana')(state);
+
+// Convenience selectors for specific network types
+const enabledEvmNetworks = selectEnabledEvmNetworks(state);
+const enabledSolanaNetworks = selectEnabledSolanaNetworks(state);
+
+// Get total count of enabled networks
+const totalEnabled = selectEnabledNetworksCount(state);
+
+// Check if any networks are enabled for a namespace
+const hasEvmNetworks = selectHasEnabledNetworksForNamespace('eip155')(state);
+```
+
+## API Reference
+
+### Controller Methods
+
+#### `setEnabledNetwork(chainId: Hex | CaipChainId): void`
+
+Enables a network for the user. Accepts either Hex chain IDs (for EVM networks) or CAIP-2 chain IDs (for any blockchain network).
+
+#### `setDisabledNetwork(chainId: Hex | CaipChainId): void`
+
+Disables a network for the user. Prevents disabling the last remaining enabled network.
+
+#### `isNetworkEnabled(chainId: Hex | CaipChainId): boolean`
+
+Checks if a network is currently enabled. Returns false for unknown networks.
+
+#### `getEnabledNetworksForNamespace(namespace: CaipNamespace): string[]`
+
+Gets all enabled networks for a specific namespace.
+
+#### `getAllEnabledNetworks(): Record<CaipNamespace, string[]>`
+
+Gets all enabled networks across all namespaces.
+
+### Selectors
+
+#### `selectIsNetworkEnabled(chainId: Hex | CaipChainId)`
+
+Returns a selector function that checks if a specific network is enabled.
+
+#### `selectAllEnabledNetworks`
+
+Returns a selector function that gets all enabled networks across all namespaces.
+
+#### `selectEnabledNetworksForNamespace(namespace: CaipNamespace)`
+
+Returns a selector function that gets enabled networks for a specific namespace.
+
+#### `selectEnabledNetworksCount`
+
+Returns a selector function that gets the total count of enabled networks.
+
+#### `selectHasEnabledNetworksForNamespace(namespace: CaipNamespace)`
+
+Returns a selector function that checks if any networks are enabled for a namespace.
+
+#### `selectEnabledEvmNetworks`
+
+Returns a selector function that gets all enabled EVM networks.
+
+#### `selectEnabledSolanaNetworks`
+
+Returns a selector function that gets all enabled Solana networks.
+
+## Chain ID Formats
+
+The controller supports two chain ID formats:
+
+1. **Hex format**: Traditional EVM chain IDs (e.g., `'0x1'` for Ethereum mainnet)
+2. **CAIP-2 format**: Chain Agnostic Improvement Proposal format (e.g., `'eip155:1'` for Ethereum mainnet, `'solana:mainnet'` for Solana)
+
+## Network Types
+
+### EVM Networks (eip155 namespace)
+
+- Ethereum Mainnet: `'0x1'` or `'eip155:1'`
+- Optimism: `'0xa'` or `'eip155:10'`
+- Arbitrum One: `'0xa4b1'` or `'eip155:42161'`
+
+### Solana Networks (solana namespace)
+
+- Solana Mainnet: `'solana:mainnet'`
+- Solana Testnet: `'solana:testnet'`
+
+## State Persistence
+
+The controller state is automatically persisted and restored between sessions. The `enabledNetworkMap` is stored anonymously to protect user privacy.
+
+## Safety Features
+
+- **At least one network enabled**: The controller ensures at least one network is always enabled
+- **Unknown network protection**: Prevents enabling networks not configured in the system
+- **Exclusive mode**: When enabling non-popular networks, all other networks are disabled
+- **Last network protection**: Prevents disabling the last remaining enabled network

package/dist/NetworkEnablementController.cjs

@@ -0,0 +1,178 @@
+"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 _NetworkEnablementController_instances, _NetworkEnablementController_ensureNamespaceBucket, _NetworkEnablementController_removeNetworkEntry, _NetworkEnablementController_onAddNetwork;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkEnablementController = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const utils_1 = require("@metamask/utils");
+const types_1 = require("./types.cjs");
+const utils_2 = require("./utils.cjs");
+const controllerName = 'NetworkEnablementController';
+/**
+ * Gets the default state for the NetworkEnablementController.
+ *
+ * @returns The default state with pre-enabled networks.
+ */
+const getDefaultNetworkEnablementControllerState = () => ({
+    enabledNetworkMap: {
+        [utils_1.KnownCaipNamespace.Eip155]: {
+            [controller_utils_1.ChainId[controller_utils_1.BuiltInNetworkName.Mainnet]]: true,
+            [controller_utils_1.ChainId[controller_utils_1.BuiltInNetworkName.LineaMainnet]]: true,
+            [controller_utils_1.ChainId[controller_utils_1.BuiltInNetworkName.BaseMainnet]]: true,
+        },
+        [utils_1.KnownCaipNamespace.Solana]: {
+            [types_1.SolScope.Mainnet]: true,
+        },
+    },
+});
+// Metadata for the controller state
+const metadata = {
+    enabledNetworkMap: {
+        persist: true,
+        anonymous: true,
+    },
+};
+/**
+ * Controller responsible for managing network enablement state across different blockchain networks.
+ *
+ * This controller tracks which networks are enabled/disabled for the user and provides methods
+ * to toggle network states. It supports both EVM (EIP-155) and non-EVM networks like Solana.
+ *
+ * The controller maintains a map of enabled networks organized by namespace (e.g., 'eip155', 'solana')
+ * and provides methods to query and modify network enablement states.
+ */
+class NetworkEnablementController extends base_controller_1.BaseController {
+    /**
+     * Creates a NetworkEnablementController instance.
+     *
+     * @param args - The arguments to this function.
+     * @param args.messenger - Messenger used to communicate with BaseV2 controller.
+     * @param args.state - Initial state to set on this controller.
+     */
+    constructor({ messenger, state, }) {
+        super({
+            messenger,
+            metadata,
+            name: controllerName,
+            state: {
+                ...getDefaultNetworkEnablementControllerState(),
+                ...state,
+            },
+        });
+        _NetworkEnablementController_instances.add(this);
+        messenger.subscribe('NetworkController:networkAdded', ({ chainId }) => {
+            __classPrivateFieldGet(this, _NetworkEnablementController_instances, "m", _NetworkEnablementController_onAddNetwork).call(this, chainId);
+        });
+        messenger.subscribe('NetworkController:networkRemoved', ({ chainId }) => {
+            __classPrivateFieldGet(this, _NetworkEnablementController_instances, "m", _NetworkEnablementController_removeNetworkEntry).call(this, chainId);
+        });
+    }
+    /**
+     * Enables or disables a network for the user.
+     *
+     * This method accepts either a Hex chain ID (for EVM networks) or a CAIP-2 chain ID
+     * (for any blockchain network). The method will automatically convert Hex chain IDs
+     * to CAIP-2 format internally. This dual parameter support allows for backward
+     * compatibility with existing EVM chain ID formats while supporting newer
+     * multi-chain standards.
+     *
+     * When enabling a non-popular network, this method will disable all other networks
+     * to ensure only one network is active at a time (exclusive mode).
+     *
+     * @param chainId - The chain ID of the network to enable or disable. Can be either:
+     * - A Hex string (e.g., '0x1' for Ethereum mainnet) for EVM networks
+     * - A CAIP-2 chain ID (e.g., 'eip155:1' for Ethereum mainnet, 'solana:mainnet' for Solana)
+     */
+    enableNetwork(chainId) {
+        const { namespace, storageKey, reference } = (0, utils_2.deriveKeys)(chainId);
+        const isPopular = (0, utils_2.isPopularNetwork)(reference);
+        this.update((s) => {
+            // if the namespace bucket does not exist, return
+            // new nemespace are added only when a new network is added
+            if (!s.enabledNetworkMap[namespace]) {
+                return;
+            }
+            // If enabling a non-popular network, disable all networks in the same namespace
+            if (!isPopular) {
+                // disable all networks in the same namespace
+                Object.keys(s.enabledNetworkMap[namespace]).forEach((key) => {
+                    s.enabledNetworkMap[namespace][key] = false;
+                });
+            }
+            else {
+                // disable all custom networks
+                Object.keys(s.enabledNetworkMap[namespace]).forEach((key) => {
+                    const { reference: keyReference } = (0, utils_2.deriveKeys)(key);
+                    if (!(0, utils_2.isPopularNetwork)(keyReference)) {
+                        s.enabledNetworkMap[namespace][key] = false;
+                    }
+                });
+            }
+            s.enabledNetworkMap[namespace][storageKey] = true;
+        });
+    }
+    /**
+     * Disables a network for the user.
+     *
+     * This method accepts either a Hex chain ID (for EVM networks) or a CAIP-2 chain ID
+     * (for any blockchain network). The method will automatically convert Hex chain IDs
+     * to CAIP-2 format internally.
+     *
+     * Note: This method will prevent disabling the last remaining enabled network
+     * to ensure at least one network is always available.
+     *
+     * @param chainId - The chain ID of the network to disable. Can be either:
+     * - A Hex string (e.g., '0x1' for Ethereum mainnet) for EVM networks
+     * - A CAIP-2 chain ID (e.g., 'eip155:1' for Ethereum mainnet, 'solana:mainnet' for Solana)
+     */
+    disableNetwork(chainId) {
+        const derivedKeys = (0, utils_2.deriveKeys)(chainId);
+        const { namespace, storageKey } = derivedKeys;
+        if ((0, utils_2.isOnlyNetworkEnabledInNamespace)(this.state, derivedKeys)) {
+            throw new Error('Cannot disable the last remaining enabled network');
+        }
+        this.update((s) => {
+            s.enabledNetworkMap[namespace][storageKey] = false;
+        });
+    }
+}
+exports.NetworkEnablementController = NetworkEnablementController;
+_NetworkEnablementController_instances = new WeakSet(), _NetworkEnablementController_ensureNamespaceBucket = function _NetworkEnablementController_ensureNamespaceBucket(state, ns) {
+    if (!state.enabledNetworkMap[ns]) {
+        state.enabledNetworkMap[ns] = {};
+    }
+}, _NetworkEnablementController_removeNetworkEntry = function _NetworkEnablementController_removeNetworkEntry(chainId) {
+    const derivedKeys = (0, utils_2.deriveKeys)(chainId);
+    const { namespace, storageKey } = derivedKeys;
+    this.update((s) => {
+        // fallback and enable ethereum mainnet
+        if ((0, utils_2.isOnlyNetworkEnabledInNamespace)(this.state, derivedKeys)) {
+            s.enabledNetworkMap[namespace][controller_utils_1.ChainId[controller_utils_1.BuiltInNetworkName.Mainnet]] =
+                true;
+        }
+        if (namespace in s.enabledNetworkMap) {
+            delete s.enabledNetworkMap[namespace][storageKey];
+        }
+    });
+}, _NetworkEnablementController_onAddNetwork = function _NetworkEnablementController_onAddNetwork(chainId) {
+    const { namespace, storageKey, reference } = (0, utils_2.deriveKeys)(chainId);
+    this.update((s) => {
+        // Ensure the namespace bucket exists
+        __classPrivateFieldGet(this, _NetworkEnablementController_instances, "m", _NetworkEnablementController_ensureNamespaceBucket).call(this, s, namespace);
+        // If adding a non-popular network, disable all other networks in the same namespace
+        // This implements exclusive mode where only one non-popular network can be active
+        if (!(0, utils_2.isPopularNetwork)(reference)) {
+            Object.keys(s.enabledNetworkMap[namespace]).forEach((key) => {
+                s.enabledNetworkMap[namespace][key] = false;
+            });
+        }
+        // Add the new network as enabled
+        s.enabledNetworkMap[namespace][storageKey] = true;
+    });
+};
+//# sourceMappingURL=NetworkEnablementController.cjs.map

package/dist/NetworkEnablementController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkEnablementController.cjs","sourceRoot":"","sources":["../src/NetworkEnablementController.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+DAA2D;AAM3D,iEAAyE;AASzE,2CAAqD;AAErD,uCAAmC;AACnC,uCAIiB;AAEjB,MAAM,cAAc,GAAG,6BAA6B,CAAC;AA6ErD;;;;GAIG;AACH,MAAM,0CAA0C,GAC9C,GAAqC,EAAE,CAAC,CAAC;IACvC,iBAAiB,EAAE;QACjB,CAAC,0BAAkB,CAAC,MAAM,CAAC,EAAE;YAC3B,CAAC,0BAAO,CAAC,qCAAkB,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI;YAC3C,CAAC,0BAAO,CAAC,qCAAkB,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI;YAChD,CAAC,0BAAO,CAAC,qCAAkB,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI;SAChD;QACD,CAAC,0BAAkB,CAAC,MAAM,CAAC,EAAE;YAC3B,CAAC,gBAAQ,CAAC,OAAO,CAAC,EAAE,IAAI;SACzB;KACF;CACF,CAAC,CAAC;AAEL,oCAAoC;AACpC,MAAM,QAAQ,GAAG;IACf,iBAAiB,EAAE;QACjB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;CACF,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAa,2BAA4B,SAAQ,gCAIhD;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ;YACR,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,0CAA0C,EAAE;gBAC/C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAEH,SAAS,CAAC,SAAS,CAAC,gCAAgC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACpE,uBAAA,IAAI,yFAAc,MAAlB,IAAI,EAAe,OAAO,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,SAAS,CAAC,kCAAkC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACtE,uBAAA,IAAI,+FAAoB,MAAxB,IAAI,EAAqB,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,OAA0B;QACtC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAA,kBAAU,EAAC,OAAO,CAAC,CAAC;QAEjE,MAAM,SAAS,GAAG,IAAA,wBAAgB,EAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YAChB,iDAAiD;YACjD,2DAA2D;YAC3D,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE;gBACnC,OAAO;aACR;YAED,gFAAgF;YAChF,IAAI,CAAC,SAAS,EAAE;gBACd,6CAA6C;gBAC7C,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;oBAC1D,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,GAAwB,CAAC,GAAG,KAAK,CAAC;gBACnE,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,8BAA8B;gBAC9B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;oBAC1D,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,IAAA,kBAAU,EAAC,GAAkB,CAAC,CAAC;oBACnE,IAAI,CAAC,IAAA,wBAAgB,EAAC,YAAY,CAAC,EAAE;wBACnC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,GAAwB,CAAC,GAAG,KAAK,CAAC;qBAClE;gBACH,CAAC,CAAC,CAAC;aACJ;YACD,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,OAA0B;QACvC,MAAM,WAAW,GAAG,IAAA,kBAAU,EAAC,OAAO,CAAC,CAAC;QACxC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;QAE9C,IAAI,IAAA,uCAA+B,EAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE;YAC5D,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;SACtE;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YAChB,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC;CA0EF;AAxLD,kEAwLC;yKA7DG,KAAuC,EACvC,EAAiB;IAEjB,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC,EAAE;QAChC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;KAClC;AACH,CAAC,6GAUmB,OAA0B;IAC5C,MAAM,WAAW,GAAG,IAAA,kBAAU,EAAC,OAAO,CAAC,CAAC;IACxC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;IAE9C,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QAChB,uCAAuC;QACvC,IAAI,IAAA,uCAA+B,EAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE;YAC5D,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,0BAAO,CAAC,qCAAkB,CAAC,OAAO,CAAC,CAAC;gBACjE,IAAI,CAAC;SACR;QAED,IAAI,SAAS,IAAI,CAAC,CAAC,iBAAiB,EAAE;YACpC,OAAO,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;SACnD;IACH,CAAC,CAAC,CAAC;AACL,CAAC,iGAWa,OAA0B;IACtC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAA,kBAAU,EAAC,OAAO,CAAC,CAAC;IAEjE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QAChB,qCAAqC;QACrC,uBAAA,IAAI,kGAAuB,MAA3B,IAAI,EAAwB,CAAC,EAAE,SAAS,CAAC,CAAC;QAE1C,oFAAoF;QACpF,kFAAkF;QAClF,IAAI,CAAC,IAAA,wBAAgB,EAAC,SAAS,CAAC,EAAE;YAChC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC1D,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,GAAwB,CAAC,GAAG,KAAK,CAAC;YACnE,CAAC,CAAC,CAAC;SACJ;QAED,iCAAiC;QACjC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport { BuiltInNetworkName, ChainId } from '@metamask/controller-utils';\nimport type { MultichainNetworkControllerGetStateAction } from '@metamask/multichain-network-controller';\nimport type {\n  NetworkControllerGetStateAction,\n  NetworkControllerNetworkAddedEvent,\n  NetworkControllerNetworkRemovedEvent,\n  NetworkControllerStateChangeEvent,\n} from '@metamask/network-controller';\nimport type { CaipChainId, CaipNamespace, Hex } from '@metamask/utils';\nimport { KnownCaipNamespace } from '@metamask/utils';\n\nimport { SolScope } from './types';\nimport {\n  deriveKeys,\n  isOnlyNetworkEnabledInNamespace,\n  isPopularNetwork,\n} from './utils';\n\nconst controllerName = 'NetworkEnablementController';\n\n/**\n * Information about an ordered network.\n */\nexport type NetworksInfo = {\n  /**\n   * The network's chain id\n   */\n  networkId: CaipChainId;\n};\n\n/**\n * A map of enabled networks by CAIP namespace and chain ID.\n * For EIP-155 networks, the keys are Hex chain IDs.\n * For other networks, the keys are CAIP chain IDs.\n */\ntype EnabledMap = Record<CaipNamespace, Record<CaipChainId | Hex, boolean>>;\n\n// State shape for NetworkEnablementController\nexport type NetworkEnablementControllerState = {\n  enabledNetworkMap: EnabledMap;\n};\n\nexport type NetworkEnablementControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    NetworkEnablementControllerState\n  >;\n\nexport type NetworkEnablementControllerSetEnabledNetworksAction = {\n  type: `${typeof controllerName}:enableNetwork`;\n  handler: NetworkEnablementController['enableNetwork'];\n};\n\nexport type NetworkEnablementControllerDisableNetworkAction = {\n  type: `${typeof controllerName}:disableNetwork`;\n  handler: NetworkEnablementController['disableNetwork'];\n};\n\n/**\n * All actions that {@link NetworkEnablementController} calls internally.\n */\nexport type AllowedActions =\n  | NetworkControllerGetStateAction\n  | MultichainNetworkControllerGetStateAction;\n\nexport type NetworkEnablementControllerActions =\n  | NetworkEnablementControllerGetStateAction\n  | NetworkEnablementControllerSetEnabledNetworksAction\n  | NetworkEnablementControllerDisableNetworkAction;\n\nexport type NetworkEnablementControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    NetworkEnablementControllerState\n  >;\n\nexport type NetworkEnablementControllerEvents =\n  NetworkEnablementControllerStateChangeEvent;\n\n/**\n * All events that {@link NetworkEnablementController} subscribes to internally.\n */\nexport type AllowedEvents =\n  | NetworkControllerNetworkAddedEvent\n  | NetworkControllerNetworkRemovedEvent\n  | NetworkControllerStateChangeEvent;\n\nexport type NetworkEnablementControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  NetworkEnablementControllerActions | AllowedActions,\n  NetworkEnablementControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Gets the default state for the NetworkEnablementController.\n *\n * @returns The default state with pre-enabled networks.\n */\nconst getDefaultNetworkEnablementControllerState =\n  (): NetworkEnablementControllerState => ({\n    enabledNetworkMap: {\n      [KnownCaipNamespace.Eip155]: {\n        [ChainId[BuiltInNetworkName.Mainnet]]: true,\n        [ChainId[BuiltInNetworkName.LineaMainnet]]: true,\n        [ChainId[BuiltInNetworkName.BaseMainnet]]: true,\n      },\n      [KnownCaipNamespace.Solana]: {\n        [SolScope.Mainnet]: true,\n      },\n    },\n  });\n\n// Metadata for the controller state\nconst metadata = {\n  enabledNetworkMap: {\n    persist: true,\n    anonymous: true,\n  },\n};\n\n/**\n * Controller responsible for managing network enablement state across different blockchain networks.\n *\n * This controller tracks which networks are enabled/disabled for the user and provides methods\n * to toggle network states. It supports both EVM (EIP-155) and non-EVM networks like Solana.\n *\n * The controller maintains a map of enabled networks organized by namespace (e.g., 'eip155', 'solana')\n * and provides methods to query and modify network enablement states.\n */\nexport class NetworkEnablementController extends BaseController<\n  typeof controllerName,\n  NetworkEnablementControllerState,\n  NetworkEnablementControllerMessenger\n> {\n  /**\n   * Creates a NetworkEnablementController instance.\n   *\n   * @param args - The arguments to this function.\n   * @param args.messenger - Messenger used to communicate with BaseV2 controller.\n   * @param args.state - Initial state to set on this controller.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: NetworkEnablementControllerMessenger;\n    state?: Partial<NetworkEnablementControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata,\n      name: controllerName,\n      state: {\n        ...getDefaultNetworkEnablementControllerState(),\n        ...state,\n      },\n    });\n\n    messenger.subscribe('NetworkController:networkAdded', ({ chainId }) => {\n      this.#onAddNetwork(chainId);\n    });\n\n    messenger.subscribe('NetworkController:networkRemoved', ({ chainId }) => {\n      this.#removeNetworkEntry(chainId);\n    });\n  }\n\n  /**\n   * Enables or disables a network for the user.\n   *\n   * This method accepts either a Hex chain ID (for EVM networks) or a CAIP-2 chain ID\n   * (for any blockchain network). The method will automatically convert Hex chain IDs\n   * to CAIP-2 format internally. This dual parameter support allows for backward\n   * compatibility with existing EVM chain ID formats while supporting newer\n   * multi-chain standards.\n   *\n   * When enabling a non-popular network, this method will disable all other networks\n   * to ensure only one network is active at a time (exclusive mode).\n   *\n   * @param chainId - The chain ID of the network to enable or disable. Can be either:\n   * - A Hex string (e.g., '0x1' for Ethereum mainnet) for EVM networks\n   * - A CAIP-2 chain ID (e.g., 'eip155:1' for Ethereum mainnet, 'solana:mainnet' for Solana)\n   */\n  enableNetwork(chainId: Hex | CaipChainId): void {\n    const { namespace, storageKey, reference } = deriveKeys(chainId);\n\n    const isPopular = isPopularNetwork(reference);\n\n    this.update((s) => {\n      // if the namespace bucket does not exist, return\n      // new nemespace are added only when a new network is added\n      if (!s.enabledNetworkMap[namespace]) {\n        return;\n      }\n\n      // If enabling a non-popular network, disable all networks in the same namespace\n      if (!isPopular) {\n        // disable all networks in the same namespace\n        Object.keys(s.enabledNetworkMap[namespace]).forEach((key) => {\n          s.enabledNetworkMap[namespace][key as CaipChainId | Hex] = false;\n        });\n      } else {\n        // disable all custom networks\n        Object.keys(s.enabledNetworkMap[namespace]).forEach((key) => {\n          const { reference: keyReference } = deriveKeys(key as CaipChainId);\n          if (!isPopularNetwork(keyReference)) {\n            s.enabledNetworkMap[namespace][key as CaipChainId | Hex] = false;\n          }\n        });\n      }\n      s.enabledNetworkMap[namespace][storageKey] = true;\n    });\n  }\n\n  /**\n   * Disables a network for the user.\n   *\n   * This method accepts either a Hex chain ID (for EVM networks) or a CAIP-2 chain ID\n   * (for any blockchain network). The method will automatically convert Hex chain IDs\n   * to CAIP-2 format internally.\n   *\n   * Note: This method will prevent disabling the last remaining enabled network\n   * to ensure at least one network is always available.\n   *\n   * @param chainId - The chain ID of the network to disable. Can be either:\n   * - A Hex string (e.g., '0x1' for Ethereum mainnet) for EVM networks\n   * - A CAIP-2 chain ID (e.g., 'eip155:1' for Ethereum mainnet, 'solana:mainnet' for Solana)\n   */\n  disableNetwork(chainId: Hex | CaipChainId): void {\n    const derivedKeys = deriveKeys(chainId);\n    const { namespace, storageKey } = derivedKeys;\n\n    if (isOnlyNetworkEnabledInNamespace(this.state, derivedKeys)) {\n      throw new Error('Cannot disable the last remaining enabled network');\n    }\n\n    this.update((s) => {\n      s.enabledNetworkMap[namespace][storageKey] = false;\n    });\n  }\n\n  /**\n   * Ensures that a namespace bucket exists in the state.\n   *\n   * This method creates the namespace entry in the enabledNetworkMap if it doesn't\n   * already exist. This is used to prepare the state structure before adding\n   * network entries.\n   *\n   * @param state - The current controller state\n   * @param ns - The CAIP namespace to ensure exists\n   */\n  #ensureNamespaceBucket(\n    state: NetworkEnablementControllerState,\n    ns: CaipNamespace,\n  ) {\n    if (!state.enabledNetworkMap[ns]) {\n      state.enabledNetworkMap[ns] = {};\n    }\n  }\n\n  /**\n   * Removes a network entry from the state.\n   *\n   * This method is called when a network is removed from the system. It cleans up\n   * the network entry and ensures that at least one network remains enabled.\n   *\n   * @param chainId - The chain ID to remove (Hex or CAIP-2 format)\n   */\n  #removeNetworkEntry(chainId: Hex | CaipChainId): void {\n    const derivedKeys = deriveKeys(chainId);\n    const { namespace, storageKey } = derivedKeys;\n\n    this.update((s) => {\n      // fallback and enable ethereum mainnet\n      if (isOnlyNetworkEnabledInNamespace(this.state, derivedKeys)) {\n        s.enabledNetworkMap[namespace][ChainId[BuiltInNetworkName.Mainnet]] =\n          true;\n      }\n\n      if (namespace in s.enabledNetworkMap) {\n        delete s.enabledNetworkMap[namespace][storageKey];\n      }\n    });\n  }\n\n  /**\n   * Handles the addition of a new network to the controller.\n   *\n   * This method is called when a network is added to the system. It automatically\n   * enables the new network and implements exclusive mode for non-popular networks.\n   * If the network already exists, no changes are made.\n   *\n   * @param chainId - The chain ID of the network being added (Hex or CAIP-2 format)\n   */\n  #onAddNetwork(chainId: Hex | CaipChainId): void {\n    const { namespace, storageKey, reference } = deriveKeys(chainId);\n\n    this.update((s) => {\n      // Ensure the namespace bucket exists\n      this.#ensureNamespaceBucket(s, namespace);\n\n      // If adding a non-popular network, disable all other networks in the same namespace\n      // This implements exclusive mode where only one non-popular network can be active\n      if (!isPopularNetwork(reference)) {\n        Object.keys(s.enabledNetworkMap[namespace]).forEach((key) => {\n          s.enabledNetworkMap[namespace][key as CaipChainId | Hex] = false;\n        });\n      }\n\n      // Add the new network as enabled\n      s.enabledNetworkMap[namespace][storageKey] = true;\n    });\n  }\n}\n"]}

package/dist/NetworkEnablementController.d.cts

@@ -0,0 +1,102 @@
+import { BaseController } from "@metamask/base-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
+import type { MultichainNetworkControllerGetStateAction } from "@metamask/multichain-network-controller";
+import type { NetworkControllerGetStateAction, NetworkControllerNetworkAddedEvent, NetworkControllerNetworkRemovedEvent, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
+import type { CaipChainId, CaipNamespace, Hex } from "@metamask/utils";
+declare const controllerName = "NetworkEnablementController";
+/**
+ * Information about an ordered network.
+ */
+export type NetworksInfo = {
+    /**
+     * The network's chain id
+     */
+    networkId: CaipChainId;
+};
+/**
+ * A map of enabled networks by CAIP namespace and chain ID.
+ * For EIP-155 networks, the keys are Hex chain IDs.
+ * For other networks, the keys are CAIP chain IDs.
+ */
+type EnabledMap = Record<CaipNamespace, Record<CaipChainId | Hex, boolean>>;
+export type NetworkEnablementControllerState = {
+    enabledNetworkMap: EnabledMap;
+};
+export type NetworkEnablementControllerGetStateAction = ControllerGetStateAction<typeof controllerName, NetworkEnablementControllerState>;
+export type NetworkEnablementControllerSetEnabledNetworksAction = {
+    type: `${typeof controllerName}:enableNetwork`;
+    handler: NetworkEnablementController['enableNetwork'];
+};
+export type NetworkEnablementControllerDisableNetworkAction = {
+    type: `${typeof controllerName}:disableNetwork`;
+    handler: NetworkEnablementController['disableNetwork'];
+};
+/**
+ * All actions that {@link NetworkEnablementController} calls internally.
+ */
+export type AllowedActions = NetworkControllerGetStateAction | MultichainNetworkControllerGetStateAction;
+export type NetworkEnablementControllerActions = NetworkEnablementControllerGetStateAction | NetworkEnablementControllerSetEnabledNetworksAction | NetworkEnablementControllerDisableNetworkAction;
+export type NetworkEnablementControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, NetworkEnablementControllerState>;
+export type NetworkEnablementControllerEvents = NetworkEnablementControllerStateChangeEvent;
+/**
+ * All events that {@link NetworkEnablementController} subscribes to internally.
+ */
+export type AllowedEvents = NetworkControllerNetworkAddedEvent | NetworkControllerNetworkRemovedEvent | NetworkControllerStateChangeEvent;
+export type NetworkEnablementControllerMessenger = RestrictedMessenger<typeof controllerName, NetworkEnablementControllerActions | AllowedActions, NetworkEnablementControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Controller responsible for managing network enablement state across different blockchain networks.
+ *
+ * This controller tracks which networks are enabled/disabled for the user and provides methods
+ * to toggle network states. It supports both EVM (EIP-155) and non-EVM networks like Solana.
+ *
+ * The controller maintains a map of enabled networks organized by namespace (e.g., 'eip155', 'solana')
+ * and provides methods to query and modify network enablement states.
+ */
+export declare class NetworkEnablementController extends BaseController<typeof controllerName, NetworkEnablementControllerState, NetworkEnablementControllerMessenger> {
+    #private;
+    /**
+     * Creates a NetworkEnablementController instance.
+     *
+     * @param args - The arguments to this function.
+     * @param args.messenger - Messenger used to communicate with BaseV2 controller.
+     * @param args.state - Initial state to set on this controller.
+     */
+    constructor({ messenger, state, }: {
+        messenger: NetworkEnablementControllerMessenger;
+        state?: Partial<NetworkEnablementControllerState>;
+    });
+    /**
+     * Enables or disables a network for the user.
+     *
+     * This method accepts either a Hex chain ID (for EVM networks) or a CAIP-2 chain ID
+     * (for any blockchain network). The method will automatically convert Hex chain IDs
+     * to CAIP-2 format internally. This dual parameter support allows for backward
+     * compatibility with existing EVM chain ID formats while supporting newer
+     * multi-chain standards.
+     *
+     * When enabling a non-popular network, this method will disable all other networks
+     * to ensure only one network is active at a time (exclusive mode).
+     *
+     * @param chainId - The chain ID of the network to enable or disable. Can be either:
+     * - A Hex string (e.g., '0x1' for Ethereum mainnet) for EVM networks
+     * - A CAIP-2 chain ID (e.g., 'eip155:1' for Ethereum mainnet, 'solana:mainnet' for Solana)
+     */
+    enableNetwork(chainId: Hex | CaipChainId): void;
+    /**
+     * Disables a network for the user.
+     *
+     * This method accepts either a Hex chain ID (for EVM networks) or a CAIP-2 chain ID
+     * (for any blockchain network). The method will automatically convert Hex chain IDs
+     * to CAIP-2 format internally.
+     *
+     * Note: This method will prevent disabling the last remaining enabled network
+     * to ensure at least one network is always available.
+     *
+     * @param chainId - The chain ID of the network to disable. Can be either:
+     * - A Hex string (e.g., '0x1' for Ethereum mainnet) for EVM networks
+     * - A CAIP-2 chain ID (e.g., 'eip155:1' for Ethereum mainnet, 'solana:mainnet' for Solana)
+     */
+    disableNetwork(chainId: Hex | CaipChainId): void;
+}
+export {};
+//# sourceMappingURL=NetworkEnablementController.d.cts.map

package/dist/NetworkEnablementController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkEnablementController.d.cts","sourceRoot":"","sources":["../src/NetworkEnablementController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AAEnC,OAAO,KAAK,EAAE,yCAAyC,EAAE,gDAAgD;AACzG,OAAO,KAAK,EACV,+BAA+B,EAC/B,kCAAkC,EAClC,oCAAoC,EACpC,iCAAiC,EAClC,qCAAqC;AACtC,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,EAAE,wBAAwB;AAUvE,QAAA,MAAM,cAAc,gCAAgC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,KAAK,UAAU,GAAG,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,WAAW,GAAG,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;AAG5E,MAAM,MAAM,gCAAgC,GAAG;IAC7C,iBAAiB,EAAE,UAAU,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,yCAAyC,GACnD,wBAAwB,CACtB,OAAO,cAAc,EACrB,gCAAgC,CACjC,CAAC;AAEJ,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,2BAA2B,CAAC,eAAe,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,2BAA2B,CAAC,gBAAgB,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,+BAA+B,GAC/B,yCAAyC,CAAC;AAE9C,MAAM,MAAM,kCAAkC,GAC1C,yCAAyC,GACzC,mDAAmD,GACnD,+CAA+C,CAAC;AAEpD,MAAM,MAAM,2CAA2C,GACrD,0BAA0B,CACxB,OAAO,cAAc,EACrB,gCAAgC,CACjC,CAAC;AAEJ,MAAM,MAAM,iCAAiC,GAC3C,2CAA2C,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,kCAAkC,GAClC,oCAAoC,GACpC,iCAAiC,CAAC;AAEtC,MAAM,MAAM,oCAAoC,GAAG,mBAAmB,CACpE,OAAO,cAAc,EACrB,kCAAkC,GAAG,cAAc,EACnD,iCAAiC,GAAG,aAAa,EACjD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AA6BF;;;;;;;;GAQG;AACH,qBAAa,2BAA4B,SAAQ,cAAc,CAC7D,OAAO,cAAc,EACrB,gCAAgC,EAChC,oCAAoC,CACrC;;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,oCAAoC,CAAC;QAChD,KAAK,CAAC,EAAE,OAAO,CAAC,gCAAgC,CAAC,CAAC;KACnD;IAoBD;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,GAAG,WAAW,GAAG,IAAI;IA+B/C;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,WAAW,GAAG,IAAI;CAqFjD"}

package/dist/NetworkEnablementController.d.mts

@@ -0,0 +1,102 @@
+import { BaseController } from "@metamask/base-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
+import type { MultichainNetworkControllerGetStateAction } from "@metamask/multichain-network-controller";
+import type { NetworkControllerGetStateAction, NetworkControllerNetworkAddedEvent, NetworkControllerNetworkRemovedEvent, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
+import type { CaipChainId, CaipNamespace, Hex } from "@metamask/utils";
+declare const controllerName = "NetworkEnablementController";
+/**
+ * Information about an ordered network.
+ */
+export type NetworksInfo = {
+    /**
+     * The network's chain id
+     */
+    networkId: CaipChainId;
+};
+/**
+ * A map of enabled networks by CAIP namespace and chain ID.
+ * For EIP-155 networks, the keys are Hex chain IDs.
+ * For other networks, the keys are CAIP chain IDs.
+ */
+type EnabledMap = Record<CaipNamespace, Record<CaipChainId | Hex, boolean>>;
+export type NetworkEnablementControllerState = {
+    enabledNetworkMap: EnabledMap;
+};
+export type NetworkEnablementControllerGetStateAction = ControllerGetStateAction<typeof controllerName, NetworkEnablementControllerState>;
+export type NetworkEnablementControllerSetEnabledNetworksAction = {
+    type: `${typeof controllerName}:enableNetwork`;
+    handler: NetworkEnablementController['enableNetwork'];
+};
+export type NetworkEnablementControllerDisableNetworkAction = {
+    type: `${typeof controllerName}:disableNetwork`;
+    handler: NetworkEnablementController['disableNetwork'];
+};
+/**
+ * All actions that {@link NetworkEnablementController} calls internally.
+ */
+export type AllowedActions = NetworkControllerGetStateAction | MultichainNetworkControllerGetStateAction;
+export type NetworkEnablementControllerActions = NetworkEnablementControllerGetStateAction | NetworkEnablementControllerSetEnabledNetworksAction | NetworkEnablementControllerDisableNetworkAction;
+export type NetworkEnablementControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, NetworkEnablementControllerState>;
+export type NetworkEnablementControllerEvents = NetworkEnablementControllerStateChangeEvent;
+/**
+ * All events that {@link NetworkEnablementController} subscribes to internally.
+ */
+export type AllowedEvents = NetworkControllerNetworkAddedEvent | NetworkControllerNetworkRemovedEvent | NetworkControllerStateChangeEvent;
+export type NetworkEnablementControllerMessenger = RestrictedMessenger<typeof controllerName, NetworkEnablementControllerActions | AllowedActions, NetworkEnablementControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Controller responsible for managing network enablement state across different blockchain networks.
+ *
+ * This controller tracks which networks are enabled/disabled for the user and provides methods
+ * to toggle network states. It supports both EVM (EIP-155) and non-EVM networks like Solana.
+ *
+ * The controller maintains a map of enabled networks organized by namespace (e.g., 'eip155', 'solana')
+ * and provides methods to query and modify network enablement states.
+ */
+export declare class NetworkEnablementController extends BaseController<typeof controllerName, NetworkEnablementControllerState, NetworkEnablementControllerMessenger> {
+    #private;
+    /**
+     * Creates a NetworkEnablementController instance.
+     *
+     * @param args - The arguments to this function.
+     * @param args.messenger - Messenger used to communicate with BaseV2 controller.
+     * @param args.state - Initial state to set on this controller.
+     */
+    constructor({ messenger, state, }: {
+        messenger: NetworkEnablementControllerMessenger;
+        state?: Partial<NetworkEnablementControllerState>;
+    });
+    /**
+     * Enables or disables a network for the user.
+     *
+     * This method accepts either a Hex chain ID (for EVM networks) or a CAIP-2 chain ID
+     * (for any blockchain network). The method will automatically convert Hex chain IDs
+     * to CAIP-2 format internally. This dual parameter support allows for backward
+     * compatibility with existing EVM chain ID formats while supporting newer
+     * multi-chain standards.
+     *
+     * When enabling a non-popular network, this method will disable all other networks
+     * to ensure only one network is active at a time (exclusive mode).
+     *
+     * @param chainId - The chain ID of the network to enable or disable. Can be either:
+     * - A Hex string (e.g., '0x1' for Ethereum mainnet) for EVM networks
+     * - A CAIP-2 chain ID (e.g., 'eip155:1' for Ethereum mainnet, 'solana:mainnet' for Solana)
+     */
+    enableNetwork(chainId: Hex | CaipChainId): void;
+    /**
+     * Disables a network for the user.
+     *
+     * This method accepts either a Hex chain ID (for EVM networks) or a CAIP-2 chain ID
+     * (for any blockchain network). The method will automatically convert Hex chain IDs
+     * to CAIP-2 format internally.
+     *
+     * Note: This method will prevent disabling the last remaining enabled network
+     * to ensure at least one network is always available.
+     *
+     * @param chainId - The chain ID of the network to disable. Can be either:
+     * - A Hex string (e.g., '0x1' for Ethereum mainnet) for EVM networks
+     * - A CAIP-2 chain ID (e.g., 'eip155:1' for Ethereum mainnet, 'solana:mainnet' for Solana)
+     */
+    disableNetwork(chainId: Hex | CaipChainId): void;
+}
+export {};
+//# sourceMappingURL=NetworkEnablementController.d.mts.map

package/dist/NetworkEnablementController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkEnablementController.d.mts","sourceRoot":"","sources":["../src/NetworkEnablementController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AAEnC,OAAO,KAAK,EAAE,yCAAyC,EAAE,gDAAgD;AACzG,OAAO,KAAK,EACV,+BAA+B,EAC/B,kCAAkC,EAClC,oCAAoC,EACpC,iCAAiC,EAClC,qCAAqC;AACtC,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,EAAE,wBAAwB;AAUvE,QAAA,MAAM,cAAc,gCAAgC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,KAAK,UAAU,GAAG,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,WAAW,GAAG,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;AAG5E,MAAM,MAAM,gCAAgC,GAAG;IAC7C,iBAAiB,EAAE,UAAU,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,yCAAyC,GACnD,wBAAwB,CACtB,OAAO,cAAc,EACrB,gCAAgC,CACjC,CAAC;AAEJ,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,2BAA2B,CAAC,eAAe,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,2BAA2B,CAAC,gBAAgB,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,+BAA+B,GAC/B,yCAAyC,CAAC;AAE9C,MAAM,MAAM,kCAAkC,GAC1C,yCAAyC,GACzC,mDAAmD,GACnD,+CAA+C,CAAC;AAEpD,MAAM,MAAM,2CAA2C,GACrD,0BAA0B,CACxB,OAAO,cAAc,EACrB,gCAAgC,CACjC,CAAC;AAEJ,MAAM,MAAM,iCAAiC,GAC3C,2CAA2C,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,kCAAkC,GAClC,oCAAoC,GACpC,iCAAiC,CAAC;AAEtC,MAAM,MAAM,oCAAoC,GAAG,mBAAmB,CACpE,OAAO,cAAc,EACrB,kCAAkC,GAAG,cAAc,EACnD,iCAAiC,GAAG,aAAa,EACjD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AA6BF;;;;;;;;GAQG;AACH,qBAAa,2BAA4B,SAAQ,cAAc,CAC7D,OAAO,cAAc,EACrB,gCAAgC,EAChC,oCAAoC,CACrC;;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,oCAAoC,CAAC;QAChD,KAAK,CAAC,EAAE,OAAO,CAAC,gCAAgC,CAAC,CAAC;KACnD;IAoBD;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,GAAG,WAAW,GAAG,IAAI;IA+B/C;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,WAAW,GAAG,IAAI;CAqFjD"}