@metamask-previews/network-controller 24.3.0-preview-cd26f001 → 24.3.0-preview-e9856975

package/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6386](https://github.com/MetaMask/core/pull/6386))
+  - Previously, `NetworkController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
+
 ## [24.3.0]
 
 ### Changed

package/dist/NetworkController.cjs

@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 var _NetworkController_instances, _NetworkController_ethQuery, _NetworkController_infuraProjectId, _NetworkController_previouslySelectedNetworkClientId, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_autoManagedNetworkClientRegistry, _NetworkController_autoManagedNetworkClient, _NetworkController_log, _NetworkController_getRpcServiceOptions, _NetworkController_getBlockTrackerOptions, _NetworkController_networkConfigurationsByNetworkClientId, _NetworkController_isRpcFailoverEnabled, _NetworkController_updateRpcFailoverEnabled, _NetworkController_refreshNetwork, _NetworkController_determineNetworkMetadata, _NetworkController_lookupGivenNetwork, _NetworkController_lookupSelectedNetwork, _NetworkController_updateMetadataForNetwork, _NetworkController_getLatestBlock, _NetworkController_determineEIP1559Compatibility, _NetworkController_validateNetworkFields, _NetworkController_determineNetworkConfigurationToPersist, _NetworkController_registerNetworkClientsAsNeeded, _NetworkController_unregisterNetworkClientsAsNeeded, _NetworkController_updateNetworkConfigurations, _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated, _NetworkController_createAutoManagedNetworkClientRegistry, _NetworkController_applyNetworkSelection;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NetworkController = exports.selectAvailableNetworkClientIds = exports.getAvailableNetworkClientIds = exports.selectNetworkConfigurations = exports.getNetworkConfigurations = exports.getDefaultNetworkControllerState = exports.knownKeysOf = exports.RpcEndpointType = void 0;
-const base_controller_1 = require("@metamask/base-controller");
+const next_1 = require("@metamask/base-controller/next");
 const controller_utils_1 = require("@metamask/controller-utils");
 const eth_query_1 = __importDefault(require("@metamask/eth-query"));
 const rpc_errors_1 = require("@metamask/rpc-errors");
@@ -365,7 +365,7 @@ function buildNetworkConfigurationsByNetworkClientId(networkConfigurationsByChai
 /**
  * Controller that creates and manages an Ethereum network provider.
  */
-class NetworkController extends base_controller_1.BaseController {
+class NetworkController extends next_1.BaseController {
     /**
      * Constructs a NetworkController.
      *
@@ -388,19 +388,19 @@ class NetworkController extends base_controller_1.BaseController {
                 selectedNetworkClientId: {
                     includeInStateLogs: true,
                     persist: true,
-                    anonymous: false,
+                    includeInDebugSnapshot: false,
                     usedInUi: true,
                 },
                 networksMetadata: {
                     includeInStateLogs: true,
                     persist: true,
-                    anonymous: false,
+                    includeInDebugSnapshot: false,
                     usedInUi: true,
                 },
                 networkConfigurationsByChainId: {
                     includeInStateLogs: true,
                     persist: true,
-                    anonymous: false,
+                    includeInDebugSnapshot: false,
                     usedInUi: true,
                 },
             },
@@ -427,51 +427,51 @@ class NetworkController extends base_controller_1.BaseController {
         __classPrivateFieldSet(this, _NetworkController_isRpcFailoverEnabled, isRpcFailoverEnabled, "f");
         __classPrivateFieldSet(this, _NetworkController_previouslySelectedNetworkClientId, this.state.selectedNetworkClientId, "f");
         __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // TODO: Either fix this lint violation or explain why it's necessary to ignore.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:getEthQuery`, () => {
             return __classPrivateFieldGet(this, _NetworkController_ethQuery, "f");
         });
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // TODO: Either fix this lint violation or explain why it's necessary to ignore.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:getNetworkClientById`, this.getNetworkClientById.bind(this));
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // TODO: Either fix this lint violation or explain why it's necessary to ignore.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:getEIP1559Compatibility`, this.getEIP1559Compatibility.bind(this));
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // TODO: Either fix this lint violation or explain why it's necessary to ignore.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:setActiveNetwork`, this.setActiveNetwork.bind(this));
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // TODO: Either fix this lint violation or explain why it's necessary to ignore.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:setProviderType`, this.setProviderType.bind(this));
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // TODO: Either fix this lint violation or explain why it's necessary to ignore.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:findNetworkClientIdByChainId`, this.findNetworkClientIdByChainId.bind(this));
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // TODO: Either fix this lint violation or explain why it's necessary to ignore.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:getNetworkConfigurationByChainId`, this.getNetworkConfigurationByChainId.bind(this));
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // ESLint is mistaken here; `name` is a string.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:getNetworkConfigurationByNetworkClientId`, this.getNetworkConfigurationByNetworkClientId.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:getSelectedNetworkClient`, this.getSelectedNetworkClient.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:getSelectedChainId`, this.getSelectedChainId.bind(this));
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(`${this.name}:getSelectedNetworkClient`, this.getSelectedNetworkClient.bind(this));
+        this.messenger.registerActionHandler(`${this.name}:getSelectedChainId`, this.getSelectedChainId.bind(this));
+        this.messenger.registerActionHandler(
         // ESLint is mistaken here; `name` is a string.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:addNetwork`, this.addNetwork.bind(this));
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // ESLint is mistaken here; `name` is a string.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:removeNetwork`, this.removeNetwork.bind(this));
-        this.messagingSystem.registerActionHandler(
+        this.messenger.registerActionHandler(
         // ESLint is mistaken here; `name` is a string.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:updateNetwork`, this.updateNetwork.bind(this));
@@ -758,7 +758,7 @@ class NetworkController extends base_controller_1.BaseController {
                 networkConfigurationToPersist: newNetworkConfiguration,
             });
         });
-        this.messagingSystem.publish(`${controllerName}:networkAdded`, newNetworkConfiguration);
+        this.messenger.publish(`${controllerName}:networkAdded`, newNetworkConfiguration);
         return newNetworkConfiguration;
     }
     /**
@@ -1009,7 +1009,7 @@ class NetworkController extends base_controller_1.BaseController {
                 existingNetworkConfiguration,
             });
         });
-        this.messagingSystem.publish('NetworkController:networkRemoved', existingNetworkConfiguration);
+        this.messenger.publish('NetworkController:networkRemoved', existingNetworkConfiguration);
     }
     /**
      * Assuming that the network has been previously switched, switches to this
@@ -1101,9 +1101,9 @@ _NetworkController_ethQuery = new WeakMap(), _NetworkController_infuraProjectId
  * @param options.updateState - Allows for updating state.
  */
 async function _NetworkController_refreshNetwork(networkClientId, options = {}) {
-    this.messagingSystem.publish('NetworkController:networkWillChange', this.state);
+    this.messenger.publish('NetworkController:networkWillChange', this.state);
     __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_applyNetworkSelection).call(this, networkClientId, options);
-    this.messagingSystem.publish('NetworkController:networkDidChange', this.state);
+    this.messenger.publish('NetworkController:networkDidChange', this.state);
     await this.lookupNetwork();
 }, _NetworkController_determineNetworkMetadata = 
 /**
@@ -1204,7 +1204,7 @@ async function _NetworkController_lookupSelectedNetwork() {
     const listener = () => {
         networkChanged = true;
         try {
-            this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
+            this.messenger.unsubscribe('NetworkController:networkDidChange', listener);
         }
         catch (error) {
             // In theory, this `catch` should not be necessary given that this error
@@ -1224,7 +1224,7 @@ async function _NetworkController_lookupSelectedNetwork() {
             }
         }
     };
-    this.messagingSystem.subscribe('NetworkController:networkDidChange', listener);
+    this.messenger.subscribe('NetworkController:networkDidChange', listener);
     const { isInfura, networkStatus, isEIP1559Compatible } = await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_determineNetworkMetadata).call(this, this.state.selectedNetworkClientId);
     if (networkChanged) {
         // If the network has changed, then `lookupNetwork` either has been or is
@@ -1232,7 +1232,7 @@ async function _NetworkController_lookupSelectedNetwork() {
         return;
     }
     try {
-        this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
+        this.messenger.unsubscribe('NetworkController:networkDidChange', listener);
     }
     catch (error) {
         if (!(error instanceof Error) ||
@@ -1244,17 +1244,17 @@ async function _NetworkController_lookupSelectedNetwork() {
     __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateMetadataForNetwork).call(this, this.state.selectedNetworkClientId, networkStatus, isEIP1559Compatible);
     if (isInfura) {
         if (networkStatus === constants_1.NetworkStatus.Available) {
-            this.messagingSystem.publish('NetworkController:infuraIsUnblocked');
+            this.messenger.publish('NetworkController:infuraIsUnblocked');
         }
         else if (networkStatus === constants_1.NetworkStatus.Blocked) {
-            this.messagingSystem.publish('NetworkController:infuraIsBlocked');
+            this.messenger.publish('NetworkController:infuraIsBlocked');
         }
     }
     else {
         // Always publish infuraIsUnblocked regardless of network status to
         // prevent consumers from being stuck in a blocked state if they were
         // previously connected to an Infura network that was blocked
-        this.messagingSystem.publish('NetworkController:infuraIsUnblocked');
+        this.messenger.publish('NetworkController:infuraIsUnblocked');
     }
 }, _NetworkController_updateMetadataForNetwork = function _NetworkController_updateMetadataForNetwork(networkClientId, networkStatus, isEIP1559Compatible) {
     this.update((state) => {
@@ -1469,7 +1469,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                 },
                 getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
                 getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
-                messenger: this.messagingSystem,
+                messenger: this.messenger,
                 isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
                 logger: __classPrivateFieldGet(this, _NetworkController_log, "f"),
             });
@@ -1485,7 +1485,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                 },
                 getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
                 getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
-                messenger: this.messagingSystem,
+                messenger: this.messenger,
                 isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
                 logger: __classPrivateFieldGet(this, _NetworkController_log, "f"),
             });
@@ -1545,7 +1545,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                         },
                         getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
                         getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
-                        messenger: this.messagingSystem,
+                        messenger: this.messenger,
                         isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
                         logger: __classPrivateFieldGet(this, _NetworkController_log, "f"),
                     }),
@@ -1563,7 +1563,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                     },
                     getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
                     getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
-                    messenger: this.messagingSystem,
+                    messenger: this.messenger,
                     isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
                     logger: __classPrivateFieldGet(this, _NetworkController_log, "f"),
                 }),