@metamask-previews/network-controller 34.0.0-preview-75ce9748b → 34.0.0-preview-5cac90a

package/CHANGELOG.md

@@ -9,6 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** `BuiltInNetworkClientId` is now `string` instead of `InfuraNetworkType` ([#9432](https://github.com/MetaMask/core/pull/9432))
+  - This type was previously constrained to known Infura network names (e.g. `"mainnet"`, `"sepolia"`). It is now `string` to allow dynamically configured Infura networks whose names are not bundled into the package.
+  - If you have code that narrows on `BuiltInNetworkClientId`, you will need to remove the narrowing or check the network client type via `NetworkClientType` instead.
+- **BREAKING:** `getNetworkClientById` no longer uses the given network client ID to determine RPC endpoint type, prioritizing Infura RPC endpoints over custom RPC endpoints ([#9432](https://github.com/MetaMask/core/pull/9432))
+  - If you have an RPC endpoint with a `type` of `custom` but with a `networkClientId` that previously matched a known Infura network name (e.g. `mainnet`), this will now be treated as an Infura network rather than a custom network.
+  - This method is not only public but is also used internally to resolve network client IDs, so this is a change in behavior across the whole controller.
+- `InfuraNetworkClientConfiguration.network` is now `string` instead of `InfuraNetworkType` ([#9432](https://github.com/MetaMask/core/pull/9432))
+  - Previously only known Infura network names were accepted. Any valid Infura subdomain string is now accepted.
+- Remove validation that prevented a custom RPC endpoint from having a `networkClientId` that matches a known Infura network name ([#9432](https://github.com/MetaMask/core/pull/9432))
+- Remove validation that required an Infura RPC endpoint URL's implied chain ID to match the chain ID of the network configuration it belongs to ([#9432](https://github.com/MetaMask/core/pull/9432))
+  - This allows Infura-backed networks to be added and updated dynamically without being constrained to the known Infura network list bundled in `@metamask/controller-utils`.
 - Bump `@metamask/messenger` from `^1.2.0` to `^2.0.0` ([#9392](https://github.com/MetaMask/core/pull/9392))
 - Bump `@metamask/connectivity-controller` from `^0.2.0` to `^0.3.0` ([#9435](https://github.com/MetaMask/core/pull/9435))
 

package/dist/NetworkController.cjs

@@ -286,16 +286,12 @@ function isValidUrl(url) {
  *
  * @param rpcEndpointUrl - The URL to operate on.
  * @returns The Infura network name that the URL references.
- * @throws if the URL is not an Infura API URL, or if an Infura network is not
- * present in the URL.
+ * @throws if no Infura network is present in the URL.
  */
 function deriveInfuraNetworkNameFromRpcEndpointUrl(rpcEndpointUrl) {
     const match = INFURA_URL_REGEX.exec(rpcEndpointUrl);
     if (match?.groups) {
-        if ((0, controller_utils_1.isInfuraNetworkType)(match.groups.networkName)) {
-            return match.groups.networkName;
-        }
-        throw new Error(`Unknown Infura network '${match.groups.networkName}'`);
+        return match.groups.networkName;
     }
     throw new Error('Could not derive Infura network from RPC endpoint URL');
 }
@@ -531,18 +527,13 @@ class NetworkController extends base_controller_1.BaseController {
             throw new Error('No network client ID was provided.');
         }
         const autoManagedNetworkClientRegistry = __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated).call(this);
-        if ((0, controller_utils_1.isInfuraNetworkType)(networkClientId)) {
-            const infuraNetworkClient = autoManagedNetworkClientRegistry[types_1.NetworkClientType.Infura][networkClientId];
-            // This is impossible to reach
-            /* istanbul ignore if */
-            if (!infuraNetworkClient) {
-                throw new Error(`No Infura network client was found with the ID "${networkClientId}".`);
-            }
+        const infuraNetworkClient = autoManagedNetworkClientRegistry[types_1.NetworkClientType.Infura][networkClientId];
+        if (infuraNetworkClient) {
             return infuraNetworkClient;
         }
         const customNetworkClient = autoManagedNetworkClientRegistry[types_1.NetworkClientType.Custom][networkClientId];
         if (!customNetworkClient) {
-            throw new Error(`No custom network client was found with the ID "${networkClientId}".`);
+            throw new Error(`No network client was found with ID "${networkClientId}".`);
         }
         return customNetworkClient;
     }
@@ -1053,7 +1044,6 @@ _NetworkController_ethQuery = new WeakMap(), _NetworkController_infuraProjectId
     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) {
@@ -1101,10 +1091,7 @@ async function _NetworkController_refreshNetwork(networkClientId, options = {})
  * @returns The resulting metadata for the network.
  */
 async function _NetworkController_determineNetworkMetadata(networkClientId) {
-    // Force TypeScript to use one of the two overloads explicitly
-    const networkClient = (0, controller_utils_1.isInfuraNetworkType)(networkClientId)
-        ? this.getNetworkClientById(networkClientId)
-        : this.getNetworkClientById(networkClientId);
+    const networkClient = this.getNetworkClientById(networkClientId);
     const isInfura = networkClient.configuration.type === types_1.NetworkClientType.Infura;
     let networkStatus;
     let isEIP1559Compatible;
@@ -1331,11 +1318,6 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         const networkClientId = 'networkClientId' in rpcEndpointFields
             ? rpcEndpointFields.networkClientId
             : undefined;
-        if (rpcEndpointFields.type === RpcEndpointType.Custom &&
-            networkClientId !== undefined &&
-            (0, controller_utils_1.isInfuraNetworkType)(networkClientId)) {
-            throw new Error(`${errorMessagePrefix}: Custom RPC endpoint '${rpcEndpointFields.url}' has invalid network client ID '${networkClientId}'`);
-        }
         if (mode === 'update' &&
             networkClientId !== undefined &&
             rpcEndpointFields.type === RpcEndpointType.Custom &&
@@ -1378,17 +1360,6 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
     if (infuraRpcEndpoints.length > 1) {
         throw new Error(`${errorMessagePrefix}: There cannot be more than one Infura RPC endpoint`);
     }
-    const soleInfuraRpcEndpoint = infuraRpcEndpoints[0];
-    if (soleInfuraRpcEndpoint) {
-        const infuraNetworkName = deriveInfuraNetworkNameFromRpcEndpointUrl(soleInfuraRpcEndpoint.url);
-        const infuraNetworkNickname = controller_utils_1.NetworkNickname[infuraNetworkName];
-        const infuraChainId = controller_utils_1.ChainId[infuraNetworkName];
-        if (networkFields.chainId !== infuraChainId) {
-            throw new Error(mode === 'add'
-                ? `Could not add network with chain ID ${networkFields.chainId} and Infura RPC endpoint for '${infuraNetworkNickname}' which represents ${infuraChainId}, as the two conflict`
-                : `Could not update network with chain ID ${networkFields.chainId} and Infura RPC endpoint for '${infuraNetworkNickname}' which represents ${infuraChainId}, as the two conflict`);
-        }
-    }
     if (networkFields.rpcEndpoints[networkFields.defaultRpcEndpointIndex] ===
         undefined) {
         throw new Error(`${errorMessagePrefix}: \`defaultRpcEndpointIndex\` must refer to an entry in \`rpcEndpoints\``);
@@ -1550,25 +1521,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         [types_1.NetworkClientType.Infura]: {},
     });
 }, _NetworkController_applyNetworkSelection = function _NetworkController_applyNetworkSelection(networkClientId, { updateState, } = {}) {
-    const autoManagedNetworkClientRegistry = __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated).call(this);
-    let autoManagedNetworkClient;
-    if ((0, controller_utils_1.isInfuraNetworkType)(networkClientId)) {
-        const possibleAutoManagedNetworkClient = autoManagedNetworkClientRegistry[types_1.NetworkClientType.Infura][networkClientId];
-        // This is impossible to reach
-        /* istanbul ignore if */
-        if (!possibleAutoManagedNetworkClient) {
-            throw new Error(`No Infura network client found with ID '${networkClientId}'`);
-        }
-        autoManagedNetworkClient = possibleAutoManagedNetworkClient;
-    }
-    else {
-        const possibleAutoManagedNetworkClient = autoManagedNetworkClientRegistry[types_1.NetworkClientType.Custom][networkClientId];
-        if (!possibleAutoManagedNetworkClient) {
-            throw new Error(`No network client found with ID '${networkClientId}'`);
-        }
-        autoManagedNetworkClient = possibleAutoManagedNetworkClient;
-    }
-    __classPrivateFieldSet(this, _NetworkController_autoManagedNetworkClient, autoManagedNetworkClient, "f");
+    __classPrivateFieldSet(this, _NetworkController_autoManagedNetworkClient, this.getNetworkClientById(networkClientId), "f");
     this.update((state) => {
         var _a;
         state.selectedNetworkClientId = networkClientId;