@metamask-previews/network-controller 23.2.0-preview-28cd3de3 → 23.3.0-preview-f603e07

package/CHANGELOG.md

@@ -7,14 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [23.3.0]
+
 ### Added
 
 - Add optional `getBlockTrackerOptions` argument to NetworkController constructor ([#5702](https://github.com/MetaMask/core/pull/5702))
-- Add Monad Testnet as default network ([#5724](https://github.com/MetaMask/core/pull/5724))
+- Add optional `rpcFailoverEnabled` option to NetworkController constructor (`false` by default) ([#5668](https://github.com/MetaMask/core/pull/5668))
+- Add `enableRpcFailover` and `disableRpcFailover` methods to NetworkController ([#5668](https://github.com/MetaMask/core/pull/5668))
 
 ### Changed
 
 - Bump `@metamask/base-controller` from ^8.0.0 to ^8.0.1 ([#5722](https://github.com/MetaMask/core/pull/5722))
+- Disable the RPC failover behavior by default ([#5668](https://github.com/MetaMask/core/pull/5668))
+  - You are free to set the `failoverUrls` property on an RPC endpoint, but it won't have any effect
+  - To enable this behavior, either pass `rpcFailoverEnabled: true` to the constructor or call `enableRpcFailover` after initialization
 
 ## [23.2.0]
 
@@ -823,7 +829,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@23.2.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.3.0...HEAD
+[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
 [23.1.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.0.0...@metamask/network-controller@23.1.0
 [23.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.2.1...@metamask/network-controller@23.0.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_getRpcServiceOptions, _NetworkController_getBlockTrackerOptions, _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_getBlockTrackerOptions, _NetworkController_networkConfigurationsByNetworkClientId, _NetworkController_isRpcFailoverEnabled, _NetworkController_updateRpcFailoverEnabled, _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");
@@ -161,35 +161,25 @@ function getDefaultInfuraNetworkConfigurationsByChainId() {
  * @returns The `networkConfigurationsByChainId` object of all custom networks.
  */
 function getDefaultCustomNetworkConfigurationsByChainId() {
-    return Object.values(controller_utils_1.CustomNetworkType).reduce((obj, customNetworkType) => {
-        const chainId = controller_utils_1.ChainId[customNetworkType];
-        const { ticker, rpcPrefs } = controller_utils_1.BUILT_IN_NETWORKS[customNetworkType];
-        // It converts client id to upper case and replace '-' with '_'
-        // to match the key in BUILT_IN_CUSTOM_NETWORKS_RPC
-        // e.g. 'megaeth-testnet' to 'MEGAETH_TESTNET'
-        // e.g. 'monad-testnet' to 'MONAD_TESTNET'
-        // TODO: Refactor controller-utils to use the same format as others
-        const rpcEndpointUrlKey = customNetworkType
-            .toUpperCase()
-            .replace('-', '_');
-        const networkConfiguration = {
+    const { ticker, rpcPrefs } = controller_utils_1.BUILT_IN_NETWORKS[controller_utils_1.BuiltInNetworkName.MegaETHTestnet];
+    return {
+        [controller_utils_1.ChainId[controller_utils_1.BuiltInNetworkName.MegaETHTestnet]]: {
             blockExplorerUrls: [rpcPrefs.blockExplorerUrl],
-            chainId: controller_utils_1.ChainId[customNetworkType],
+            chainId: controller_utils_1.ChainId[controller_utils_1.BuiltInNetworkName.MegaETHTestnet],
             defaultRpcEndpointIndex: 0,
             defaultBlockExplorerUrlIndex: 0,
-            name: controller_utils_1.NetworkNickname[customNetworkType],
+            name: controller_utils_1.NetworkNickname[controller_utils_1.BuiltInNetworkName.MegaETHTestnet],
             nativeCurrency: ticker,
             rpcEndpoints: [
                 {
                     failoverUrls: [],
-                    networkClientId: customNetworkType,
+                    networkClientId: controller_utils_1.BuiltInNetworkName.MegaETHTestnet,
                     type: RpcEndpointType.Custom,
-                    url: controller_utils_1.BUILT_IN_CUSTOM_NETWORKS_RPC[rpcEndpointUrlKey],
+                    url: controller_utils_1.BUILT_IN_CUSTOM_NETWORKS_RPC.MEGAETH_TESTNET,
                 },
             ],
-        };
-        return { ...obj, [chainId]: networkConfiguration };
-    }, {});
+        },
+    };
 }
 /**
  * Constructs properties for the NetworkController state whose values will be
@@ -352,7 +342,7 @@ class NetworkController extends base_controller_1.BaseController {
      * @param options - The options; see {@link NetworkControllerOptions}.
      */
     constructor(options) {
-        const { messenger, state, infuraProjectId, log, getRpcServiceOptions, getBlockTrackerOptions, additionalDefaultNetworks, } = options;
+        const { messenger, state, infuraProjectId, log, getRpcServiceOptions, getBlockTrackerOptions, additionalDefaultNetworks, isRpcFailoverEnabled = false, } = options;
         const initialState = {
             ...getDefaultNetworkControllerState(additionalDefaultNetworks),
             ...state,
@@ -392,10 +382,12 @@ class NetworkController extends base_controller_1.BaseController {
         _NetworkController_getRpcServiceOptions.set(this, void 0);
         _NetworkController_getBlockTrackerOptions.set(this, void 0);
         _NetworkController_networkConfigurationsByNetworkClientId.set(this, void 0);
+        _NetworkController_isRpcFailoverEnabled.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_getBlockTrackerOptions, getBlockTrackerOptions, "f");
+        __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(
@@ -447,6 +439,22 @@ class NetworkController extends base_controller_1.BaseController {
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:updateNetwork`, this.updateNetwork.bind(this));
     }
+    /**
+     * Enables the RPC failover functionality. That is, if any RPC endpoints are
+     * configured with failover URLs, then traffic will automatically be diverted
+     * to them if those RPC endpoints are unavailable.
+     */
+    enableRpcFailover() {
+        __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateRpcFailoverEnabled).call(this, true);
+    }
+    /**
+     * Disables the RPC failover functionality. That is, even if any RPC endpoints
+     * are configured with failover URLs, then traffic will not automatically be
+     * diverted to them if those RPC endpoints are unavailable.
+     */
+    disableRpcFailover() {
+        __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateRpcFailoverEnabled).call(this, false);
+    }
     /**
      * Accesses the provider and block tracker for the currently selected network.
      * @returns The proxy and block tracker proxies.
@@ -1187,7 +1195,25 @@ 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_getRpcServiceOptions = new WeakMap(), _NetworkController_getBlockTrackerOptions = 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_getBlockTrackerOptions = new WeakMap(), _NetworkController_networkConfigurationsByNetworkClientId = new WeakMap(), _NetworkController_isRpcFailoverEnabled = new WeakMap(), _NetworkController_instances = new WeakSet(), _NetworkController_updateRpcFailoverEnabled = function _NetworkController_updateRpcFailoverEnabled(newIsRpcFailoverEnabled) {
+    if (__classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f") === newIsRpcFailoverEnabled) {
+        return;
+    }
+    const autoManagedNetworkClientRegistry = __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated).call(this);
+    for (const networkClientsById of Object.values(autoManagedNetworkClientRegistry)) {
+        for (const networkClientId of Object.keys(networkClientsById)) {
+            // Type assertion: We can assume that `networkClientId` is valid here.
+            const networkClient = networkClientsById[networkClientId];
+            if (networkClient.configuration.failoverRpcUrls &&
+                networkClient.configuration.failoverRpcUrls.length > 0) {
+                newIsRpcFailoverEnabled
+                    ? networkClient.enableRpcFailover()
+                    : networkClient.disableRpcFailover();
+            }
+        }
+    }
+    __classPrivateFieldSet(this, _NetworkController_isRpcFailoverEnabled, newIsRpcFailoverEnabled, "f");
+}, _NetworkController_refreshNetwork = 
 /**
  * Executes a series of steps to switch the network:
  *
@@ -1408,6 +1434,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                 getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
                 getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
                 messenger: this.messagingSystem,
+                isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
             });
         }
         else {
@@ -1422,6 +1449,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                 getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
                 getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
                 messenger: this.messagingSystem,
+                isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
             });
         }
     }
@@ -1480,6 +1508,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                         getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
                         getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
                         messenger: this.messagingSystem,
+                        isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
                     }),
                 ];
             }
@@ -1496,6 +1525,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                     getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
                     getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
                     messenger: this.messagingSystem,
+                    isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
                 }),
             ];
         });