@metamask-previews/network-controller 22.2.1-preview-ac664446 → 22.2.1-preview-ea165590

package/CHANGELOG.md

@@ -7,11 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### 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 down after 5 attempts, further retries will be paused for 30 seconds
+  - "Down" 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)
+
+### Changed
+
+- **BREAKING:** `NetworkController` constructor now takes two required options, `fetch` and `btoa` ([#5290](https://github.com/MetaMask/core/pull/5290))
+  - These are passed along to functions that create the JSON-RPC middleware
+- 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`
+
 ## [22.2.1]
 
 ### Changed
 
-- Bump `@metamask/base-controller` from `^7.1.1` to `^8.0.0` [#5305](https://github.com/MetaMask/core/pull/5305))
+- Bump `@metamask/base-controller` from `^7.1.1` to `^8.0.0` ([#5305](https://github.com/MetaMask/core/pull/5305))
 
 ## [22.2.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_fetch, _NetworkController_btoa, _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");
@@ -286,7 +286,7 @@ function buildNetworkConfigurationsByNetworkClientId(networkConfigurationsByChai
  * Controller that creates and manages an Ethereum network provider.
  */
 class NetworkController extends base_controller_1.BaseController {
-    constructor({ messenger, state, infuraProjectId, log, }) {
+    constructor({ messenger, state, infuraProjectId, log, fetch: givenFetch, btoa: givenBtoa, }) {
         const initialState = { ...getDefaultNetworkControllerState(), ...state };
         validateNetworkControllerState(initialState);
         if (!infuraProjectId || typeof infuraProjectId !== 'string') {
@@ -320,9 +320,13 @@ 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_fetch.set(this, void 0);
+        _NetworkController_btoa.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_fetch, givenFetch, "f");
+        __classPrivateFieldSet(this, _NetworkController_btoa, givenBtoa, "f");
         __classPrivateFieldSet(this, _NetworkController_previouslySelectedNetworkClientId, this.state.selectedNetworkClientId, "f");
         __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
         this.messagingSystem.registerActionHandler(
@@ -1103,7 +1107,7 @@ class NetworkController extends base_controller_1.BaseController {
     }
 }
 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_fetch = new WeakMap(), _NetworkController_btoa = new WeakMap(), _NetworkController_networkConfigurationsByNetworkClientId = new WeakMap(), _NetworkController_instances = new WeakSet(), _NetworkController_refreshNetwork = 
 /**
  * Executes a series of steps to switch the network:
  *
@@ -1313,19 +1317,27 @@ 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,
+                    infuraProjectId: __classPrivateFieldGet(this, _NetworkController_infuraProjectId, "f"),
+                    ticker: networkFields.nativeCurrency,
+                },
+                fetch: __classPrivateFieldGet(this, _NetworkController_fetch, "f"),
+                btoa: __classPrivateFieldGet(this, _NetworkController_btoa, "f"),
             });
         }
         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,
+                    rpcUrl: addedRpcEndpoint.url,
+                    ticker: networkFields.nativeCurrency,
+                },
+                fetch: __classPrivateFieldGet(this, _NetworkController_fetch, "f"),
+                btoa: __classPrivateFieldGet(this, _NetworkController_btoa, "f"),
             });
         }
     }
@@ -1373,21 +1385,29 @@ 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,
+                            infuraProjectId: __classPrivateFieldGet(this, _NetworkController_infuraProjectId, "f"),
+                            chainId: networkConfiguration.chainId,
+                            ticker: networkConfiguration.nativeCurrency,
+                        },
+                        fetch: __classPrivateFieldGet(this, _NetworkController_fetch, "f"),
+                        btoa: __classPrivateFieldGet(this, _NetworkController_btoa, "f"),
                     }),
                 ];
             }
             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,
+                        rpcUrl: rpcEndpoint.url,
+                        ticker: networkConfiguration.nativeCurrency,
+                    },
+                    fetch: __classPrivateFieldGet(this, _NetworkController_fetch, "f"),
+                    btoa: __classPrivateFieldGet(this, _NetworkController_btoa, "f"),
                 }),
             ];
         });