chore: create network order controller #6022

salimtb · 2025-06-23T12:20:41Z

Explanation

The NetworkOrderController is a core implementation of network ordering functionality that was previously only available in the extension. This PR moves and expands this functionality from the extension's NetworkOrder controller to core, enabling network ordering features across both extension and mobile platforms. It also renames it to NetworkOrderController to more accurately represent what it does. Maybe in the future this can be expanded to include other UX enhancements that don't need to be tightly coupled with the NetworkController

Key motivations for this change:

Platform Parity: Network ordering was previously only implemented in the extension via NetworkOrder controller, leaving mobile without this functionality. Moving this to core will unlock the ability to have this feature built on mobile.
Code Quality Improvements: The move to core has provided an opportunity to:
- Improve test coverage of the existing network ordering logic

The controller now handles three key aspects:

Network ordering (preserved from extension implementation)

References

Moves functionality from NetworkOrder controller in extension to core
Related to ongoing work related to Global Network Selector Removal

Changelog

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

cryptodev-2s · 2025-06-25T14:24:23Z

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

+
+  // Currently the tests for NetworkController have a race condition which
+  // causes intermittent failures. This seems to fix it.
+  testEnvironment: 'jsdom',


Nit: do you think we can drop this as may not be related to this controller ?

cryptodev-2s · 2025-06-25T14:26:48Z

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


Nit: what do you think about rephrasing this to ?

Suggested change

Provides an interface to the currently network order via a MetaMask-compatible provider object

Provides an interface to the current network display order via a MetaMask-compatible provider object

cryptodev-2s · 2025-06-25T14:27:45Z

packages/network-order-controller/package.json

+{
+  "name": "@metamask/network-order-controller",
+  "version": "0.0.0",
+  "description": "Provides an interface to the currently network order via a MetaMask-compatible provider object",


Nit: to align with README, if you opt in for the suggestion

Suggested change

"description": "Provides an interface to the currently network order via a MetaMask-compatible provider object",

"description": "Provides an interface to the current network display order via a MetaMask-compatible provider object",

cryptodev-2s · 2025-06-25T14:29:35Z

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

+export type NetworkOrderStateChange = {
+  type: `${typeof controllerName}:stateChange`;
+  payload: [NetworkOrderControllerState, Patch[]];
+};


Suggested change

export type NetworkOrderStateChange = {

type: `${typeof controllerName}:stateChange`;

payload: [NetworkOrderControllerState, Patch[]];

};

export type NetworkOrderStateControllerChangeEvent = ControllerStateChangeEvent<

typeof controllerName,

NetworkOrderControllerState

>;

export type NetworkOrderControllerEvents = NetworkOrderStateControllerChangeEvent;

/**

* All events that {@link NetworkOrderController} calls internally.

*/

type AllowedEvents = NetworkControllerStateChangeEvent;

cryptodev-2s · 2025-06-25T14:30:29Z

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

+};
+
+// Describes the action for updating the networks list
+export type NetworkOrderControllerupdateNetworksListAction = {


Suggested change

export type NetworkOrderControllerupdateNetworksListAction = {

export type NetworkOrderControllerUpdateNetworksListAction = {

cryptodev-2s · 2025-06-25T14:44:49Z

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

+   * @param networkControllerState - The state of the network controller.
+   * @param networkControllerState.networkConfigurationsByChainId - The network configurations by chain id.
+   */
+  onNetworkControllerStateChange({


Nit: this method can be private ?

Suggested change

onNetworkControllerStateChange({

#onNetworkControllerStateChange({

cryptodev-2s · 2025-06-25T14:46:09Z

packages/network-order-controller/tests/NetworkOrderController.test.ts

can we move this file under src directory ?

cryptodev-2s · 2025-06-25T14:47:12Z

packages/network-order-controller/tsconfig.build.json

+  "references": [
+    {
+      "path": "../../packages/base-controller/tsconfig.build.json"
+    },
+    {
+      "path": "../../packages/network-controller/tsconfig.build.json"
+    },
+    {
+      "path": "../../packages/multichain-network-controller/tsconfig.build.json"
+    }
+  ],


Suggested change

"references": [

{

"path": "../../packages/base-controller/tsconfig.build.json"

},

{

"path": "../../packages/network-controller/tsconfig.build.json"

},

{

"path": "../../packages/multichain-network-controller/tsconfig.build.json"

}

],

"references": [

{ "path": "../base-controller/tsconfig.build.json" },

{ "path": "../network-controller/tsconfig.build.json" },

{ "path": "../multichain-network-controller/tsconfig.build.json" }

],

cryptodev-2s · 2025-06-25T14:49:32Z

packages/network-order-controller/tsconfig.json

+  "references": [
+    {
+      "path": "../../packages/base-controller"
+    },
+    {
+      "path": "../../packages/network-controller"
+    },
+    {
+      "path": "../../packages/multichain-network-controller"
+    }
+  ],


Suggested change

"references": [

{

"path": "../../packages/base-controller"

},

{

"path": "../../packages/network-controller"

},

{

"path": "../../packages/multichain-network-controller"

}

],

"references": [

{ "path": "../base-controller" },

{ "path": "../network-controller" },

{ "path": "../multichain-network-controller" }

],

cryptodev-2s · 2025-06-25T14:50:13Z

packages/network-order-controller/tsconfig.json

+      "path": "../../packages/multichain-network-controller"
+    }
+  ],
+  "include": ["../../types", "./src", "tests/NetworkOrderController.test.ts"]


Nit: if you opt in for the suggestion to move NetworkOrderController.test.ts to test folder this can be dropped

Suggested change

"include": ["../../types", "./src", "tests/NetworkOrderController.test.ts"]

"include": ["../../types", "./src"]

mcmire

Looks good! As for the suggestions by @cryptodev-2s, I think they make sense, except perhaps we want to keep NetworkOrderController.ts as-is? We can consider aligning this controller with other controllers in another PR.

mcmire · 2025-06-27T16:57:53Z

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

+  '0xaa36a7',
+  '0xe705',
+  '0x539',
+  '0x18c6',
+  '0x279f',


Should we add comments to document what these are?

mcmire · 2025-06-27T16:58:05Z

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

Should this file be called constants.ts?

mcmire · 2025-06-27T17:02:20Z

packages/network-order-controller/package.json

+    "@metamask/keyring-api": "^18.0.0",
+    "@metamask/multichain-network-controller": "^0.9.0",
+    "@metamask/utils": "^11.2.0",
+    "@metamask/network-controller": "^24.0.0"


It looks like this controller talks to NetworkController, should this be a peer dependency instead?

mcmire · 2025-06-27T17:02:39Z

README.md

Can you re-run yarn update-readme-content? It looks like some dependencies are not reflected here.

salimtb added 3 commits June 23, 2025 14:20

chore: create network order controller

85b26a6

fix: fix yarn lock

bef91c8

fix: fix dependencies errors

66114bc

salimtb force-pushed the chore/create-network-order-controller branch from 0f98de3 to 66114bc Compare June 24, 2025 11:26

salimtb added no-changelog team-assets labels Jun 24, 2025

salimtb added 5 commits June 24, 2025 13:40

fix: fix dependencies

c1f0c6c

fix: fix dependencies

1744fb1

fix: fix formatting

cfb085b

fix: fix peer dependency

1d3aa06

fix: fix ts config

4c6bbd5

salimtb removed the no-changelog label Jun 24, 2025

fix: fix dependencies

d2a8ef8

salimtb force-pushed the chore/create-network-order-controller branch from 445dd16 to d2a8ef8 Compare June 24, 2025 12:36

salimtb marked this pull request as ready for review June 24, 2025 12:59

salimtb requested a review from a team as a code owner June 24, 2025 12:59

cryptodev-2s reviewed Jun 25, 2025

View reviewed changes

mcmire reviewed Jun 27, 2025

View reviewed changes

		@@ -0,0 +1,15 @@
		# `@metamask/network-order-controller`

		Provides an interface to the currently network order via a MetaMask-compatible provider object

	Provides an interface to the currently network order via a MetaMask-compatible provider object
	Provides an interface to the current network display order via a MetaMask-compatible provider object

	"description": "Provides an interface to the currently network order via a MetaMask-compatible provider object",
	"description": "Provides an interface to the current network display order via a MetaMask-compatible provider object",

-export type NetworkOrderStateChange = {
-  type: `${typeof controllerName}:stateChange`;
-  payload: [NetworkOrderControllerState, Patch[]];
-};
+export type NetworkOrderStateControllerChangeEvent = ControllerStateChangeEvent<
+  typeof controllerName,
+  NetworkOrderControllerState
+>;
+export type NetworkOrderControllerEvents = NetworkOrderStateControllerChangeEvent;
+/**
+ * All events that {@link NetworkOrderController} calls internally.
+ */
+type AllowedEvents = NetworkControllerStateChangeEvent;

	export type NetworkOrderControllerupdateNetworksListAction = {
	export type NetworkOrderControllerUpdateNetworksListAction = {

	onNetworkControllerStateChange({
	#onNetworkControllerStateChange({

	"include": ["../../types", "./src", "tests/NetworkOrderController.test.ts"]
	"include": ["../../types", "./src"]

Uh oh!

chore: create network order controller #6022

Are you sure you want to change the base?

chore: create network order controller #6022

Uh oh!

Conversation

salimtb commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Changelog

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

salimtb commented Jun 23, 2025 •

edited

Loading