@metamask/network-controller 22.2.0 → 23.0.0

package/CHANGELOG.md

@@ -7,6 +7,71 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [23.0.0]
+
+### Added
+
+- Implement circuit breaker pattern when retrying requests to Infura and custom RPC endpoints ([#5290](https://github.com/MetaMask/core/pull/5290))
+  - If the network is perceived to be unavailable after 5 attempts, further retries will be paused for 30 seconds.
+  - "Unavailable" means the following:
+    - A failure to reach the network (exact error depending on platform / HTTP client)
+    - The request responds with a non-JSON-parseable or non-JSON-RPC-compatible body
+    - The request returns a non-200 response
+- Use exponential backoff / jitter when retrying requests to Infura and custom RPC endpoints ([#5290](https://github.com/MetaMask/core/pull/5290))
+  - As requests are retried, the delay between retries will increase exponentially (using random variance to prevent bursts).
+- Add support for automatic failover when Infura is unavailable ([#5360](https://github.com/MetaMask/core/pull/5360))
+  - An Infura RPC endpoint can now be configured with a list of failover URLs via `failoverUrls`.
+  - If, after many attempts, an Infura network is perceived to be down, the list of failover URLs will be tried in turn.
+- Add messenger action `NetworkController:rpcEndpointUnavailable` for responding to when a RPC endpoint becomes unavailable (see above) ([#5492](https://github.com/MetaMask/core/pull/5492), [#5501](https://github.com/MetaMask/core/pull/5501))
+  - Also add associated type `NetworkControllerRpcEndpointUnavailableEvent`.
+- Add messenger action `NetworkController:rpcEndpointDegraded` for responding to when a RPC endpoint becomes degraded ([#5492](https://github.com/MetaMask/core/pull/5492))
+  - Also add associated type `NetworkControllerRpcEndpointDegradedEvent`.
+- Add messenger action `NetworkController:rpcEndpointRequestRetried` for responding to when a RPC endpoint is retried following a retriable error ([#5492](https://github.com/MetaMask/core/pull/5492))
+  - Also add associated type `NetworkControllerRpcEndpointRequestRetriedEvent`.
+  - This is mainly useful for tests when mocking timers.
+- Export `RpcServiceRequestable` type, which was previously named `AbstractRpcService` ([#5492](https://github.com/MetaMask/core/pull/5492))
+- Export `isConnectionError` utility function ([#5501](https://github.com/MetaMask/core/pull/5501))
+
+### Changed
+
+- **BREAKING:** `NetworkController` constructor now takes a new required option, `getRpcServiceOptions` ([#5290](https://github.com/MetaMask/core/pull/5290), [#5492](https://github.com/MetaMask/core/pull/5492))
+  - This can be used to customize how RPC services (which eventually hit RPC endpoints) are constructed.
+  - For instance, you could set one `circuitBreakDuration` for one class of endpoints, and another `circuitBreakDuration` for another class.
+  - At minimum you will need to pass `fetch` and `btoa`.
+  - The `NetworkControllerOptions` also reflects this change.
+- **BREAKING:** Add required property `failoverUrls` to `RpcEndpoint` ([#5360](https://github.com/MetaMask/core/pull/5360))
+  - The `NetworkControllerState` and the `state` option to `NetworkController` also reflect this change.
+- **BREAKING:** Add required property `failoverRpcUrls` to `NetworkClientConfiguration` ([#5360](https://github.com/MetaMask/core/pull/5360))
+  - The `configuration` property in the `AutoManagedNetworkClient` and `NetworkClient` types also reflect this change.
+- **BREAKING:** The `AbstractRpcService` type now has a non-optional `endpointUrl` property ([#5492](https://github.com/MetaMask/core/pull/5492))
+  - The old version of `AbstractRpcService` is now called `RpcServiceRequestable`
+- Synchronize retry logic and error handling behavior between Infura and custom RPC endpoints ([#5290](https://github.com/MetaMask/core/pull/5290))
+  - A request to a custom endpoint that returns a 418 response will no longer return a JSON-RPC response with the error "Request is being rate limited".
+  - A request to a custom endpoint that returns a 429 response now returns a JSON-RPC response with the error "Request is being rate limited".
+  - A request to a custom endpoint that throws an "ECONNRESET" error will now be retried up to 5 times.
+  - A request to a Infura endpoint that fails more than 5 times in a row will now respond with a JSON-RPC error that encompasses the failure instead of hiding it as "InfuraProvider - cannot complete request. All retries exhausted".
+  - A request to a Infura endpoint that returns a non-retriable, non-2xx response will now respond with a JSON-RPC error that has the underling message "Non-200 status code: '\<code\>'" rather than including the raw response from the endpoint.
+  - A request to a custom endpoint that fails with a retriable error more than 5 times in a row will now respond with a JSON-RPC error that encompasses the failure instead of returning an empty response.
+  - A "retriable error" is now regarded as the following:
+    - A failure to reach the network (exact error depending on platform / HTTP client)
+    - The request responds with a non-JSON-parseable or non-JSON-RPC-compatible body
+    - The request returns a 503 or 504 response
+- Bump dependencies to support usage of RPC services internally for network requests ([#5290](https://github.com/MetaMask/core/pull/5290))
+  - Bump `@metamask/eth-json-rpc-infura` to `^10.1.0`
+  - Bump `@metamask/eth-json-rpc-middleware` to `^15.1.0`
+- Bump `@metamask/controller-utils` to `^11.5.0` ([#5439](https://github.com/MetaMask/core/pull/5439))
+- Bump `@metamask/utils` to `^11.2.0` ([#5301](https://github.com/MetaMask/core/pull/5301))
+
+### Fixed
+
+- Fix `findNetworkClientIdByChainId` to return the network client ID for the chain's configured default RPC endpoint instead of its first listed RPC endpoint ([#5344](https://github.com/MetaMask/core/pull/5344))
+
+## [22.2.1]
+
+### Changed
+
+- Bump `@metamask/base-controller` from `^7.1.1` to `^8.0.0` ([#5305](https://github.com/MetaMask/core/pull/5305))
+
 ## [22.2.0]
 
 ### Added
@@ -716,7 +781,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@22.2.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.0.0...HEAD
+[23.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.2.1...@metamask/network-controller@23.0.0
+[22.2.1]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.2.0...@metamask/network-controller@22.2.1
 [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

package/dist/NetworkController.cjs

@@ -36,7 +36,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": 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;
+var _NetworkController_instances, _NetworkController_ethQuery, _NetworkController_infuraProjectId, _NetworkController_previouslySelectedNetworkClientId, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_autoManagedNetworkClientRegistry, _NetworkController_autoManagedNetworkClient, _NetworkController_log, _NetworkController_getRpcServiceOptions, _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.selectNetworkConfigurations = exports.getNetworkConfigurations = exports.getDefaultNetworkControllerState = exports.knownKeysOf = exports.RpcEndpointType = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -123,6 +123,7 @@ function getDefaultNetworkConfigurationsByChainId() {
             nativeCurrency: controller_utils_1.NetworksTicker[infuraNetworkType],
             rpcEndpoints: [
                 {
+                    failoverUrls: [],
                     networkClientId: infuraNetworkType,
                     type: RpcEndpointType.Infura,
                     url: rpcEndpointUrl,
@@ -286,7 +287,13 @@ function buildNetworkConfigurationsByNetworkClientId(networkConfigurationsByChai
  * Controller that creates and manages an Ethereum network provider.
  */
 class NetworkController extends base_controller_1.BaseController {
-    constructor({ messenger, state, infuraProjectId, log, }) {
+    /**
+     * Constructs a NetworkController.
+     *
+     * @param options - The options; see {@link NetworkControllerOptions}.
+     */
+    constructor(options) {
+        const { messenger, state, infuraProjectId, log, getRpcServiceOptions } = options;
         const initialState = { ...getDefaultNetworkControllerState(), ...state };
         validateNetworkControllerState(initialState);
         if (!infuraProjectId || typeof infuraProjectId !== 'string') {
@@ -320,9 +327,11 @@ class NetworkController extends base_controller_1.BaseController {
         _NetworkController_autoManagedNetworkClientRegistry.set(this, void 0);
         _NetworkController_autoManagedNetworkClient.set(this, void 0);
         _NetworkController_log.set(this, void 0);
+        _NetworkController_getRpcServiceOptions.set(this, void 0);
         _NetworkController_networkConfigurationsByNetworkClientId.set(this, void 0);
         __classPrivateFieldSet(this, _NetworkController_infuraProjectId, infuraProjectId, "f");
         __classPrivateFieldSet(this, _NetworkController_log, log, "f");
+        __classPrivateFieldSet(this, _NetworkController_getRpcServiceOptions, getRpcServiceOptions, "f");
         __classPrivateFieldSet(this, _NetworkController_previouslySelectedNetworkClientId, this.state.selectedNetworkClientId, "f");
         __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
         this.messagingSystem.registerActionHandler(
@@ -460,7 +469,8 @@ class NetworkController extends base_controller_1.BaseController {
         let updatedNetworkStatus;
         let updatedIsEIP1559Compatible;
         try {
-            updatedIsEIP1559Compatible = await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_determineEIP1559Compatibility).call(this, networkClientId);
+            updatedIsEIP1559Compatible =
+                await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_determineEIP1559Compatibility).call(this, networkClientId);
             updatedNetworkStatus = constants_1.NetworkStatus.Available;
         }
         catch (error) {
@@ -1088,22 +1098,25 @@ class NetworkController extends base_controller_1.BaseController {
         });
     }
     /**
-     * Searches for a network configuration ID with the given ChainID and returns it.
+     * Searches for the default RPC endpoint configured for the given chain and
+     * returns its network client ID. This can then be passed to
+     * {@link getNetworkClientById} to retrieve the network client.
      *
-     * @param chainId - ChainId to search for
-     * @returns networkClientId of the network configuration with the given chainId
+     * @param chainId - Chain ID to search for.
+     * @returns The ID of the network client created for the chain's default RPC
+     * endpoint.
      */
     findNetworkClientIdByChainId(chainId) {
-        const networkClients = this.getNetworkClientRegistry();
-        const networkClientEntry = Object.entries(networkClients).find(([_, networkClient]) => networkClient.configuration.chainId === chainId);
-        if (networkClientEntry === undefined) {
-            throw new Error("Couldn't find networkClientId for chainId");
+        const networkConfiguration = this.state.networkConfigurationsByChainId[chainId];
+        if (!networkConfiguration) {
+            throw new Error(`Invalid chain ID "${chainId}"`);
         }
-        return networkClientEntry[0];
+        const { networkClientId } = networkConfiguration.rpcEndpoints[networkConfiguration.defaultRpcEndpointIndex];
+        return networkClientId;
     }
 }
 exports.NetworkController = NetworkController;
-_NetworkController_ethQuery = new WeakMap(), _NetworkController_infuraProjectId = new WeakMap(), _NetworkController_previouslySelectedNetworkClientId = new WeakMap(), _NetworkController_providerProxy = new WeakMap(), _NetworkController_blockTrackerProxy = new WeakMap(), _NetworkController_autoManagedNetworkClientRegistry = new WeakMap(), _NetworkController_autoManagedNetworkClient = new WeakMap(), _NetworkController_log = new WeakMap(), _NetworkController_networkConfigurationsByNetworkClientId = new WeakMap(), _NetworkController_instances = new WeakSet(), _NetworkController_refreshNetwork = 
+_NetworkController_ethQuery = new WeakMap(), _NetworkController_infuraProjectId = new WeakMap(), _NetworkController_previouslySelectedNetworkClientId = new WeakMap(), _NetworkController_providerProxy = new WeakMap(), _NetworkController_blockTrackerProxy = new WeakMap(), _NetworkController_autoManagedNetworkClientRegistry = new WeakMap(), _NetworkController_autoManagedNetworkClient = new WeakMap(), _NetworkController_log = new WeakMap(), _NetworkController_getRpcServiceOptions = new WeakMap(), _NetworkController_networkConfigurationsByNetworkClientId = new WeakMap(), _NetworkController_instances = new WeakSet(), _NetworkController_refreshNetwork = 
 /**
  * Executes a series of steps to switch the network:
  *
@@ -1313,19 +1326,29 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
     for (const addedRpcEndpoint of addedRpcEndpoints) {
         if (addedRpcEndpoint.type === RpcEndpointType.Infura) {
             autoManagedNetworkClientRegistry[types_1.NetworkClientType.Infura][addedRpcEndpoint.networkClientId] = (0, create_auto_managed_network_client_1.createAutoManagedNetworkClient)({
-                type: types_1.NetworkClientType.Infura,
-                chainId: networkFields.chainId,
-                network: addedRpcEndpoint.networkClientId,
-                infuraProjectId: __classPrivateFieldGet(this, _NetworkController_infuraProjectId, "f"),
-                ticker: networkFields.nativeCurrency,
+                networkClientConfiguration: {
+                    type: types_1.NetworkClientType.Infura,
+                    chainId: networkFields.chainId,
+                    network: addedRpcEndpoint.networkClientId,
+                    failoverRpcUrls: addedRpcEndpoint.failoverUrls,
+                    infuraProjectId: __classPrivateFieldGet(this, _NetworkController_infuraProjectId, "f"),
+                    ticker: networkFields.nativeCurrency,
+                },
+                getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
+                messenger: this.messagingSystem,
             });
         }
         else {
             autoManagedNetworkClientRegistry[types_1.NetworkClientType.Custom][addedRpcEndpoint.networkClientId] = (0, create_auto_managed_network_client_1.createAutoManagedNetworkClient)({
-                type: types_1.NetworkClientType.Custom,
-                chainId: networkFields.chainId,
-                rpcUrl: addedRpcEndpoint.url,
-                ticker: networkFields.nativeCurrency,
+                networkClientConfiguration: {
+                    type: types_1.NetworkClientType.Custom,
+                    chainId: networkFields.chainId,
+                    failoverRpcUrls: addedRpcEndpoint.failoverUrls,
+                    rpcUrl: addedRpcEndpoint.url,
+                    ticker: networkFields.nativeCurrency,
+                },
+                getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
+                messenger: this.messagingSystem,
             });
         }
     }
@@ -1373,21 +1396,31 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                 return [
                     rpcEndpoint.networkClientId,
                     (0, create_auto_managed_network_client_1.createAutoManagedNetworkClient)({
-                        type: types_1.NetworkClientType.Infura,
-                        network: infuraNetworkName,
-                        infuraProjectId: __classPrivateFieldGet(this, _NetworkController_infuraProjectId, "f"),
-                        chainId: networkConfiguration.chainId,
-                        ticker: networkConfiguration.nativeCurrency,
+                        networkClientConfiguration: {
+                            type: types_1.NetworkClientType.Infura,
+                            network: infuraNetworkName,
+                            failoverRpcUrls: rpcEndpoint.failoverUrls,
+                            infuraProjectId: __classPrivateFieldGet(this, _NetworkController_infuraProjectId, "f"),
+                            chainId: networkConfiguration.chainId,
+                            ticker: networkConfiguration.nativeCurrency,
+                        },
+                        getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
+                        messenger: this.messagingSystem,
                     }),
                 ];
             }
             return [
                 rpcEndpoint.networkClientId,
                 (0, create_auto_managed_network_client_1.createAutoManagedNetworkClient)({
-                    type: types_1.NetworkClientType.Custom,
-                    chainId: networkConfiguration.chainId,
-                    rpcUrl: rpcEndpoint.url,
-                    ticker: networkConfiguration.nativeCurrency,
+                    networkClientConfiguration: {
+                        type: types_1.NetworkClientType.Custom,
+                        chainId: networkConfiguration.chainId,
+                        failoverRpcUrls: rpcEndpoint.failoverUrls,
+                        rpcUrl: rpcEndpoint.url,
+                        ticker: networkConfiguration.nativeCurrency,
+                    },
+                    getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
+                    messenger: this.messagingSystem,
                 }),
             ];
         });