chore: create network order controller

.github/CODEOWNERS

@@ -13,6 +13,7 @@
 
 ## Assets Team
 /packages/assets-controllers         @MetaMask/metamask-assets
+/packages/network-order-controller @MetaMask/metamask-assets
 
 ## Confirmations Team
 /packages/address-book-controller           @MetaMask/confirmations
@@ -153,3 +154,5 @@
 /packages/foundryup/CHANGELOG.md @MetaMask/mobile-platform @MetaMask/extension-platform @MetaMask/wallet-framework-engineers
 /packages/seedless-onboarding-controller/package.json @MetaMask/web3auth @MetaMask/wallet-framework-engineers
 /packages/seedless-onboarding-controller/CHANGELOG.md @MetaMask/web3auth @MetaMask/wallet-framework-engineers
+/packages/network-order-controller/package.json @MetaMask/metamask-assets @MetaMask/wallet-framework-engineers
+/packages/network-order-controller/CHANGELOG.md @MetaMask/metamask-assets @MetaMask/wallet-framework-engineers

README.md

@@ -52,6 +52,7 @@ Each package in this repository has its own README where you can find installati
 - [`@metamask/multichain-transactions-controller`](packages/multichain-transactions-controller)
 - [`@metamask/name-controller`](packages/name-controller)
 - [`@metamask/network-controller`](packages/network-controller)
+- [`@metamask/network-order-controller`](packages/network-order-controller)
 - [`@metamask/notification-services-controller`](packages/notification-services-controller)
 - [`@metamask/permission-controller`](packages/permission-controller)
 - [`@metamask/permission-log-controller`](packages/permission-log-controller)
@@ -109,6 +110,7 @@ linkStyle default opacity:0.5
   multichain_transactions_controller(["@metamask/multichain-transactions-controller"]);
   name_controller(["@metamask/name-controller"]);
   network_controller(["@metamask/network-controller"]);
+  network_order_controller(["@metamask/network-order-controller"]);
   notification_services_controller(["@metamask/notification-services-controller"]);
   permission_controller(["@metamask/permission-controller"]);
   permission_log_controller(["@metamask/permission-log-controller"]);

packages/network-order-controller/CHANGELOG.md

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

packages/network-order-controller/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

packages/network-order-controller/README.md

@@ -0,0 +1,15 @@
+# `@metamask/network-order-controller`
+
+Provides an interface to the currently network order via a MetaMask-compatible provider object
+
+## Installation
+
+`yarn add @metamask/network-order-controller`
+
+or
+
+`npm install @metamask/network-order-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

packages/network-order-controller/jest.config.js

@@ -0,0 +1,30 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+const merge = require('deepmerge');
+const path = require('path');
+
+const baseConfig = require('../../jest.config.packages');
+
+const displayName = path.basename(__dirname);
+
+module.exports = merge(baseConfig, {
+  // The display name when running multiple projects
+  displayName,
+
+  // An object that configures minimum threshold enforcement for coverage results
+  coverageThreshold: {
+    global: {
+      branches: 88.47,
+      functions: 97.43,
+      lines: 94.47,
+      statements: 94.29,
+    },
+  },
+
+  // Currently the tests for NetworkController have a race condition which
+  // causes intermittent failures. This seems to fix it.
+  testEnvironment: 'jsdom',
+});

packages/network-order-controller/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@metamask/network-order-controller",
+  "version": "0.0.0",
+  "description": "Provides an interface to the currently network order via a MetaMask-compatible provider object",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/network-order-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/network-order-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/network-order-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^8.0.1",
+    "@metamask/keyring-api": "^18.0.0",
+    "@metamask/multichain-network-controller": "^0.9.0",
+    "@metamask/utils": "^11.2.0",
+    "@metamask/network-controller": "^24.0.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

packages/network-order-controller/src/NetworkOrderController.ts

@@ -0,0 +1,168 @@
+import { BaseController } from '@metamask/base-controller';
+import type { RestrictedMessenger } from '@metamask/base-controller';
+import { BtcScope, SolScope } from '@metamask/keyring-api';
+import { toEvmCaipChainId } from '@metamask/multichain-network-controller';
+import type {
+  NetworkControllerStateChangeEvent,
+  NetworkState,
+} from '@metamask/network-controller';
+import type { CaipChainId, Hex } from '@metamask/utils';
+import type { Patch } from 'immer';
+
+import { TEST_CHAINS } from './constant';
+
+// Unique name for the controller
+const controllerName = 'NetworkOrderController';
+
+/**
+ * Information about an ordered network.
+ */
+export type NetworksInfo = {
+  networkId: CaipChainId; // The network's chain id
+};
+
+// State shape for NetworkOrderController
+export type NetworkOrderControllerState = {
+  orderedNetworkList: NetworksInfo[];
+};
+
+// Describes the structure of a state change event
+export type NetworkOrderStateChange = {
+  type: `${typeof controllerName}:stateChange`;
+  payload: [NetworkOrderControllerState, Patch[]];
+};
+
+// Describes the action for updating the networks list
+export type NetworkOrderControllerupdateNetworksListAction = {
+  type: `${typeof controllerName}:updateNetworksList`;
+  handler: NetworkOrderController['updateNetworksList'];
+};
+
+// Union of all possible actions for the messenger
+export type NetworkOrderControllerMessengerActions =
+  NetworkOrderControllerupdateNetworksListAction;
+
+// Type for the messenger of NetworkOrderController
+export type NetworkOrderControllerMessenger = RestrictedMessenger<
+  typeof controllerName,
+  NetworkOrderControllerMessengerActions,
+  NetworkOrderStateChange | NetworkControllerStateChangeEvent,
+  never,
+  NetworkOrderStateChange['type'] | NetworkControllerStateChangeEvent['type']
+>;
+
+// Default state for the controller
+const defaultState: NetworkOrderControllerState = {
+  orderedNetworkList: [],
+};
+
+// Metadata for the controller state
+const metadata = {
+  orderedNetworkList: {
+    persist: true,
+    anonymous: true,
+  },
+};
+
+/**
+ * Controller that updates the order of the network list.
+ * This controller subscribes to network state changes and ensures
+ * that the network list is updated based on the latest network configurations.
+ */
+
+export class NetworkOrderController extends BaseController<
+  typeof controllerName,
+  NetworkOrderControllerState,
+  NetworkOrderControllerMessenger
+> {
+  /**
+   * Creates a NetworkOrderController 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: NetworkOrderControllerMessenger;
+    state?: NetworkOrderControllerState;
+  }) {
+    // Call the constructor of BaseControllerV2
+    super({
+      messenger,
+      metadata,
+      name: controllerName,
+      state: { ...defaultState, ...state },
+    });
+
+    // Subscribe to network state changes
+    this.messagingSystem.subscribe(
+      'NetworkController:stateChange',
+      (networkControllerState: NetworkState) => {
+        this.onNetworkControllerStateChange(networkControllerState);
+      },
+    );
+  }
+
+  /**
+   * Handles the state change of the network controller and updates the networks list.
+   *
+   * @param networkControllerState - The state of the network controller.
+   * @param networkControllerState.networkConfigurationsByChainId - The network configurations by chain id.
+   */
+  onNetworkControllerStateChange({
+    networkConfigurationsByChainId,
+  }: NetworkState) {
+    this.update((state: NetworkOrderControllerState) => {
+      // Filter out testnets, which are in the state but not orderable
+      const hexChainIds = Object.keys(networkConfigurationsByChainId).filter(
+        (chainId) =>
+          !TEST_CHAINS.includes(chainId as (typeof TEST_CHAINS)[number]),
+      ) as Hex[];
+      const chainIds: CaipChainId[] = hexChainIds.map(toEvmCaipChainId);
+      const nonEvmChainIds: CaipChainId[] = [
+        BtcScope.Mainnet,
+        SolScope.Mainnet,
+      ];
+
+      const newNetworks = chainIds
+        .filter(
+          (chainId) =>
+            !state.orderedNetworkList.some(
+              ({ networkId }: { networkId: CaipChainId }) =>
+                networkId === chainId,
+            ),
+        )
+        .map((chainId) => ({ networkId: chainId }));
+
+      state.orderedNetworkList = state.orderedNetworkList
+        // Filter out deleted networks
+        .filter(
+          ({ networkId }: { networkId: CaipChainId }) =>
+            chainIds.includes(networkId) ||
+            // Since Bitcoin and Solana are not part of the @metamask/network-controller, we have
+            // to add a second check to make sure it is not filtered out.
+            // TODO: Update this logic to @metamask/multichain-network-controller once all networks are migrated.
+            nonEvmChainIds.includes(networkId),
+        )
+        // Append new networks to the end
+        .concat(newNetworks);
+    });
+  }
+
+  /**
+   * Updates the networks list in the state with the provided list of networks.
+   *
+   * @param networkList - The list of networks to update in the state.
+   */
+
+  updateNetworksList(chainIds: CaipChainId[]) {
+    this.update((state: NetworkOrderControllerState) => {
+      state.orderedNetworkList = chainIds.map((chainId) => ({
+        networkId: chainId,
+      }));
+    });
+  }
+}

packages/network-order-controller/src/constant.ts

@@ -0,0 +1,9 @@
+import type { Hex } from '@metamask/utils';
+
+export const TEST_CHAINS: Hex[] = [
+  '0xaa36a7',
+  '0xe705',
+  '0x539',
+  '0x18c6',
+  '0x279f',
+];

packages/network-order-controller/src/index.ts

@@ -0,0 +1,10 @@
+export {
+  NetworkOrderController,
+  type NetworkOrderControllerState,
+  type NetworkOrderControllerMessenger,
+  type NetworkOrderControllerMessengerActions,
+  type NetworkOrderStateChange,
+  type NetworksInfo,
+} from './NetworkOrderController';
+
+export { TEST_CHAINS } from './constant';