@metamask/network-controller 22.1.1 → 22.2.0

package/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [22.2.0]
+
+### Added
+
+- Export `AbstractRpcService` type ([#5263](https://github.com/MetaMask/core/pull/5263))
+
+### Changed
+
+- Bump `@metamask/base-controller` from `^7.0.0` to `^7.1.1` ([#5079](https://github.com/MetaMask/core/pull/5079), [#5135](https://github.com/MetaMask/core/pull/5135))
+- Bump `@metamask/controller-utils` from `^11.4.4` to `^11.5.0` ([#5135](https://github.com/MetaMask/core/pull/5135), [#5272](https://github.com/MetaMask/core/pull/5272))
+- Bump `@metamask/eth-json-rpc-provider` from `^4.1.6` to `^4.1.8` ([#5082](https://github.com/MetaMask/core/pull/5082), [#5272](https://github.com/MetaMask/core/pull/5272))
+- Bump `@metamask/json-rpc-engine` from `^10.0.1` to `^10.0.3` ([#5082](https://github.com/MetaMask/core/pull/5082), [#5272](https://github.com/MetaMask/core/pull/5272))
+- Bump `@metamask/rpc-errors` from `^7.0.1` to `^7.0.2` ([#5080](https://github.com/MetaMask/core/pull/5080))
+- Bump `@metamask/utils` from `^10.0.0` to `^11.1.0` ([#5080](https://github.com/MetaMask/core/pull/5080), [#5223](https://github.com/MetaMask/core/pull/5223))
+
+### Fixed
+
+- Fix `lookupNetwork` so that it will no longer throw an error if `networkDidChange` subscriptions have been removed before it returns ([#5116](https://github.com/MetaMask/core/pull/5116))
+  - This error could occur if the NetworkController's messenger is cleared of subscriptions, as in a "destroy" step.
+- Fix race condition so that after adding a new RPC endpoint to a network, it is possible to access the new endpoint inside of a `stateChange` event listener via `getNetworkConfigurationByNetworkClientId` ([#5122](https://github.com/MetaMask/core/pull/5122))
+- Fix `selectAvailableNetworkClientIds` so that it is properly memoized ([#5193](https://github.com/MetaMask/core/pull/5193))
+
 ## [22.1.1]
 
 ### Changed
@@ -694,7 +716,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.1.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.2.0...HEAD
+[22.2.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.1.1...@metamask/network-controller@22.2.0
 [22.1.1]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.1.0...@metamask/network-controller@22.1.1
 [22.1.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.0.2...@metamask/network-controller@22.1.0
 [22.0.2]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.0.1...@metamask/network-controller@22.0.2

package/dist/NetworkController.cjs

@@ -38,7 +38,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_networkConfigurationsByNetworkClientId, _NetworkController_refreshNetwork, _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.getNetworkConfigurations = exports.getDefaultNetworkControllerState = exports.knownKeysOf = exports.RpcEndpointType = void 0;
+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 controller_utils_1 = require("@metamask/controller-utils");
 const eth_query_1 = __importDefault(require("@metamask/eth-query"));
@@ -46,6 +46,7 @@ const rpc_errors_1 = require("@metamask/rpc-errors");
 const swappable_obj_proxy_1 = require("@metamask/swappable-obj-proxy");
 const utils_1 = require("@metamask/utils");
 const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
+const lodash_1 = require("lodash");
 const reselect_1 = require("reselect");
 const URI = __importStar(require("uri-js"));
 const uuid_1 = require("uuid");
@@ -147,6 +148,14 @@ function getDefaultNetworkControllerState() {
     };
 }
 exports.getDefaultNetworkControllerState = getDefaultNetworkControllerState;
+/**
+ * Redux selector for getting all network configurations from NetworkController
+ * state, keyed by chain ID.
+ *
+ * @param state - NetworkController state
+ * @returns All registered network configurations, keyed by chain ID.
+ */
+const selectNetworkConfigurationsByChainId = (state) => state.networkConfigurationsByChainId;
 /**
  * Get a list of all network configurations.
  *
@@ -158,8 +167,17 @@ function getNetworkConfigurations(state) {
 }
 exports.getNetworkConfigurations = getNetworkConfigurations;
 /**
- * Get a list of all available client IDs from a list of
- * network configurations
+ * Redux selector for getting a list of all network configurations from
+ * NetworkController state.
+ *
+ * @param state - NetworkController state
+ * @returns A list of all available network configurations
+ */
+exports.selectNetworkConfigurations = (0, reselect_1.createSelector)(selectNetworkConfigurationsByChainId, (networkConfigurationsByChainId) => Object.values(networkConfigurationsByChainId));
+/**
+ * Get a list of all available network client IDs from a list of network
+ * configurations.
+ *
  * @param networkConfigurations - The array of network configurations
  * @returns A list of all available client IDs
  */
@@ -167,7 +185,14 @@ function getAvailableNetworkClientIds(networkConfigurations) {
     return networkConfigurations.flatMap((networkConfiguration) => networkConfiguration.rpcEndpoints.map((rpcEndpoint) => rpcEndpoint.networkClientId));
 }
 exports.getAvailableNetworkClientIds = getAvailableNetworkClientIds;
-exports.selectAvailableNetworkClientIds = (0, reselect_1.createSelector)([getNetworkConfigurations], getAvailableNetworkClientIds);
+/**
+ * Redux selector for getting a list of all available network client IDs
+ * from NetworkController state.
+ *
+ * @param state - NetworkController state
+ * @returns A list of all available network client IDs.
+ */
+exports.selectAvailableNetworkClientIds = (0, reselect_1.createSelector)(exports.selectNetworkConfigurations, getAvailableNetworkClientIds);
 /**
  * Determines whether the given URL is valid by attempting to parse it.
  *
@@ -213,7 +238,7 @@ function deriveInfuraNetworkNameFromRpcEndpointUrl(rpcEndpointUrl) {
  */
 function validateNetworkControllerState(state) {
     const networkConfigurationEntries = Object.entries(state.networkConfigurationsByChainId);
-    const networkClientIds = (0, exports.selectAvailableNetworkClientIds)(state);
+    const networkClientIds = getAvailableNetworkClientIds(getNetworkConfigurations(state));
     if (networkConfigurationEntries.length === 0) {
         throw new Error('NetworkController state is invalid: `networkConfigurationsByChainId` cannot be empty');
     }
@@ -525,7 +550,26 @@ class NetworkController extends base_controller_1.BaseController {
         let networkChanged = false;
         const listener = () => {
             networkChanged = true;
-            this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
+            try {
+                this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
+            }
+            catch (error) {
+                // In theory, this `catch` should not be necessary given that this error
+                // would occur "inside" of the call to `#determineEIP1559Compatibility`
+                // below and so it should be caught by the `try`/`catch` below (it is
+                // impossible to reproduce in tests for that reason). However, somehow
+                // it occurs within Mobile and so we have to add our own `try`/`catch`
+                // here.
+                /* istanbul ignore next */
+                if (!(error instanceof Error) ||
+                    error.message !==
+                        'Subscription not found for event: NetworkController:networkDidChange') {
+                    // Again, this error should not happen and is impossible to reproduce
+                    // in tests.
+                    /* istanbul ignore next */
+                    throw error;
+                }
+            }
         };
         this.messagingSystem.subscribe('NetworkController:networkDidChange', listener);
         let updatedNetworkStatus;
@@ -575,7 +619,16 @@ class NetworkController extends base_controller_1.BaseController {
             // in the process of being called, so we don't need to go further.
             return;
         }
-        this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
+        try {
+            this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
+        }
+        catch (error) {
+            if (!(error instanceof Error) ||
+                error.message !==
+                    'Subscription not found for event: NetworkController:networkDidChange') {
+                throw error;
+            }
+        }
         this.update((state) => {
             const meta = state.networksMetadata[state.selectedNetworkClientId];
             meta.status = updatedNetworkStatus;
@@ -748,7 +801,6 @@ class NetworkController extends base_controller_1.BaseController {
                 networkConfigurationToPersist: newNetworkConfiguration,
             });
         });
-        __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
         this.messagingSystem.publish(`${controllerName}:networkAdded`, newNetworkConfiguration);
         return newNetworkConfiguration;
     }
@@ -959,7 +1011,6 @@ class NetworkController extends base_controller_1.BaseController {
                 });
             });
         }
-        __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
         __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_unregisterNetworkClientsAsNeeded).call(this, {
             networkClientOperations,
             autoManagedNetworkClientRegistry,
@@ -1001,7 +1052,6 @@ class NetworkController extends base_controller_1.BaseController {
                 existingNetworkConfiguration,
             });
         });
-        __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
         this.messagingSystem.publish('NetworkController:networkRemoved', existingNetworkConfiguration);
     }
     /**
@@ -1310,6 +1360,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         state.networkConfigurationsByChainId[args.networkFields.chainId] =
             args.networkConfigurationToPersist;
     }
+    __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId((0, lodash_1.cloneDeep)(state.networkConfigurationsByChainId)), "f");
 }, _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated = function _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated() {
     return (__classPrivateFieldSet(this, _NetworkController_autoManagedNetworkClientRegistry, __classPrivateFieldGet(this, _NetworkController_autoManagedNetworkClientRegistry, "f") ?? __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_createAutoManagedNetworkClientRegistry).call(this), "f"));
 }, _NetworkController_createAutoManagedNetworkClientRegistry = function _NetworkController_createAutoManagedNetworkClientRegistry() {