@metamask/network-controller 23.4.0 → 23.5.1

package/CHANGELOG.md

@@ -7,6 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [23.5.1]
+
+### Changed
+
+- Block tracker errors will no longer be wrapped under "PollingBlockTracker - encountered an error while attempting to update latest block" ([#5860](https://github.com/MetaMask/core/pull/5860))
+- Bump dependencies ([#5867](https://github.com/MetaMask/core/pull/5867), [#5860](https://github.com/MetaMask/core/pull/5860))
+  - Bump `@metamask/eth-block-tracker` to `^12.0.1`
+  - Bump `@metamask/eth-json-rpc-infura` to `^10.2.0`
+  - Bump `@metamask/eth-json-rpc-middleware` to `^17.0.1`
+
+### Fixed
+
+- Rather than throwing an error, NetworkController now corrects an invalid initial `selectedNetworkClientId` to point to the default RPC endpoint of the first network sorted by chain ID ([#5851](https://github.com/MetaMask/core/pull/5851))
+- Fix the block tracker so that it will now reject if an error is thrown while making the request instead of hanging ([#5860](https://github.com/MetaMask/core/pull/5860))
+
+## [23.5.0]
+
+### Changed
+
+- Remove obsolete `eth_getBlockByNumber` error handling for load balancer errors ([#5808](https://github.com/MetaMask/core/pull/5808))
+- Bump `@metamask/controller-utils` to `^11.9.0` ([#5812](https://github.com/MetaMask/core/pull/5812))
+
+### Fixed
+
+- Improved handling of HTTP status codes to prevent unnecessary circuit breaker triggers ([#5798](https://github.com/MetaMask/core/pull/5798), [#5809](https://github.com/MetaMask/core/pull/5809))
+  - HTTP 4XX responses (e.g. rate limit errors) will no longer trigger the circuit breaker policy.
+
 ## [23.4.0]
 
 ### Added
@@ -839,7 +866,9 @@ 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@23.4.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.5.1...HEAD
+[23.5.1]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.5.0...@metamask/network-controller@23.5.1
+[23.5.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.4.0...@metamask/network-controller@23.5.0
 [23.4.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.3.0...@metamask/network-controller@23.4.0
 [23.3.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.2.0...@metamask/network-controller@23.3.0
 [23.2.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.1.0...@metamask/network-controller@23.2.0

package/dist/NetworkController.cjs

@@ -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 immer_1 = require("immer");
 const lodash_1 = require("lodash");
 const reselect_1 = require("reselect");
 const URI = __importStar(require("uri-js"));
@@ -300,7 +301,7 @@ function deriveInfuraNetworkNameFromRpcEndpointUrl(rpcEndpointUrl) {
  * @param state - The NetworkController state to verify.
  * @throws if the state is invalid in some way.
  */
-function validateNetworkControllerState(state) {
+function validateInitialState(state) {
     const networkConfigurationEntries = Object.entries(state.networkConfigurationsByChainId);
     const networkClientIds = getAvailableNetworkClientIds(getNetworkConfigurations(state));
     if (networkConfigurationEntries.length === 0) {
@@ -324,12 +325,27 @@ function validateNetworkControllerState(state) {
     if ([...new Set(networkClientIds)].length < networkClientIds.length) {
         throw new Error('NetworkController state has invalid `networkConfigurationsByChainId`: Every RPC endpoint across all network configurations must have a unique `networkClientId`');
     }
-    if (!networkClientIds.includes(state.selectedNetworkClientId)) {
-        throw new Error(
-        // This ESLint rule mistakenly produces an error.
-        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-        `NetworkController state is invalid: \`selectedNetworkClientId\` '${state.selectedNetworkClientId}' does not refer to an RPC endpoint within a network configuration`);
-    }
+}
+/**
+ * Checks that the given initial NetworkController state is internally
+ * consistent similar to `validateInitialState`, but if an anomaly is detected,
+ * it does its best to correct the state and logs an error to Sentry.
+ *
+ * @param state - The NetworkController state to verify.
+ * @param messenger - The NetworkController messenger.
+ * @returns The corrected state.
+ */
+function correctInitialState(state, messenger) {
+    const networkConfigurationsSortedByChainId = getNetworkConfigurations(state).sort((a, b) => a.chainId.localeCompare(b.chainId));
+    const networkClientIds = getAvailableNetworkClientIds(networkConfigurationsSortedByChainId);
+    return (0, immer_1.produce)(state, (newState) => {
+        if (!networkClientIds.includes(state.selectedNetworkClientId)) {
+            const firstNetworkConfiguration = networkConfigurationsSortedByChainId[0];
+            const newSelectedNetworkClientId = firstNetworkConfiguration.rpcEndpoints[firstNetworkConfiguration.defaultRpcEndpointIndex].networkClientId;
+            messenger.call('ErrorReportingService:captureException', new Error(`\`selectedNetworkClientId\` '${state.selectedNetworkClientId}' does not refer to an RPC endpoint within a network configuration; correcting to '${newSelectedNetworkClientId}'`));
+            newState.selectedNetworkClientId = newSelectedNetworkClientId;
+        }
+    });
 }
 /**
  * Transforms a map of chain ID to network configuration to a map of network
@@ -361,7 +377,8 @@ class NetworkController extends base_controller_1.BaseController {
             ...getDefaultNetworkControllerState(additionalDefaultNetworks),
             ...state,
         };
-        validateNetworkControllerState(initialState);
+        validateInitialState(initialState);
+        const correctedInitialState = correctInitialState(initialState, messenger);
         if (!infuraProjectId || typeof infuraProjectId !== 'string') {
             throw new Error('Invalid Infura project ID');
         }
@@ -382,7 +399,7 @@ class NetworkController extends base_controller_1.BaseController {
                 },
             },
             messenger,
-            state: initialState,
+            state: correctedInitialState,
         });
         _NetworkController_instances.add(this);
         _NetworkController_ethQuery.set(this, void 0);