@metamask-previews/network-controller 24.1.0-preview-aa8c4291 → 24.1.0-preview-8facad04

package/CHANGELOG.md

@@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Bump `@metamask/base-controller` from `^8.1.0` to `^8.2.0` ([#6355](https://github.com/MetaMask/core/pull/6355))
 
+### Deprecated
+
+- Deprecate `lookupNetworkByClientId` ([#6308](https://github.com/MetaMask/core/pull/6308))
+  - `lookupNetwork` already supports passing in a network client ID; please use this going forward instead.
+
 ## [24.1.0]
 
 ### Added

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_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;
+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_determineNetworkMetadata, _NetworkController_lookupGivenNetwork, _NetworkController_lookupSelectedNetwork, _NetworkController_updateMetadataForNetwork, _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");
@@ -569,211 +569,44 @@ class NetworkController extends base_controller_1.BaseController {
         await this.lookupNetwork();
     }
     /**
-     * Refreshes the network meta with EIP-1559 support and the network status
-     * based on the given network client ID.
+     * Uses a request for the latest block to gather the following information on
+     * the given or selected network, persisting it to state:
      *
-     * @param networkClientId - The ID of the network client to update.
-     */
-    async lookupNetworkByClientId(networkClientId) {
-        const isInfura = (0, controller_utils_1.isInfuraNetworkType)(networkClientId);
-        let updatedNetworkStatus;
-        let updatedIsEIP1559Compatible;
-        try {
-            updatedIsEIP1559Compatible =
-                await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_determineEIP1559Compatibility).call(this, networkClientId);
-            updatedNetworkStatus = constants_1.NetworkStatus.Available;
-        }
-        catch (error) {
-            debugLog('NetworkController: lookupNetworkByClientId: ', error);
-            // TODO: mock ethQuery.sendAsync to throw error without error code
-            /* istanbul ignore else */
-            if (isErrorWithCode(error)) {
-                let responseBody;
-                if (isInfura &&
-                    (0, utils_1.hasProperty)(error, 'message') &&
-                    typeof error.message === 'string') {
-                    try {
-                        responseBody = JSON.parse(error.message);
-                    }
-                    catch {
-                        // error.message must not be JSON
-                        __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetworkByClientId: json parse error: ', error);
-                    }
-                }
-                if ((0, utils_1.isPlainObject)(responseBody) &&
-                    responseBody.error === constants_1.INFURA_BLOCKED_KEY) {
-                    updatedNetworkStatus = constants_1.NetworkStatus.Blocked;
-                }
-                else if (error.code === rpc_errors_1.errorCodes.rpc.internal) {
-                    updatedNetworkStatus = constants_1.NetworkStatus.Unknown;
-                    __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetworkByClientId: rpc internal error: ', error);
-                }
-                else {
-                    updatedNetworkStatus = constants_1.NetworkStatus.Unavailable;
-                    __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetworkByClientId: ', error);
-                }
-            }
-            else if (typeof Error !== 'undefined' &&
-                (0, utils_1.hasProperty)(error, 'message') &&
-                typeof error.message === 'string' &&
-                error.message.includes('No custom network client was found with the ID')) {
-                throw error;
-            }
-            else {
-                debugLog('NetworkController - could not determine network status', error);
-                updatedNetworkStatus = constants_1.NetworkStatus.Unknown;
-                __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetworkByClientId: ', error);
-            }
-        }
-        this.update((state) => {
-            if (state.networksMetadata[networkClientId] === undefined) {
-                state.networksMetadata[networkClientId] = {
-                    status: constants_1.NetworkStatus.Unknown,
-                    EIPS: {},
-                };
-            }
-            const meta = state.networksMetadata[networkClientId];
-            meta.status = updatedNetworkStatus;
-            if (updatedIsEIP1559Compatible === undefined) {
-                delete meta.EIPS[1559];
-            }
-            else {
-                meta.EIPS[1559] = updatedIsEIP1559Compatible;
-            }
-        });
-    }
-    /**
-     * Persists the following metadata about the given or selected network to
-     * state:
+     * - The connectivity status: whether it is available, geo-blocked (Infura
+     * only), unavailable, or unknown
+     * - The capabilities status: whether it supports EIP-1559, whether it does
+     * not, or whether it is unknown
      *
-     * - The status of the network, namely, whether it is available, geo-blocked
-     * (Infura only), or unavailable, or whether the status is unknown
-     * - Whether the network supports EIP-1559, or whether it is unknown
-     *
-     * Note that it is possible for the network to be switched while this data is
-     * being collected. If that is the case, no metadata for the (now previously)
-     * selected network will be updated.
-     *
-     * @param networkClientId - The ID of the network client to update.
+     * @param networkClientId - The ID of the network client to inspect.
      * If no ID is provided, uses the currently selected network.
      */
     async lookupNetwork(networkClientId) {
         if (networkClientId) {
-            await this.lookupNetworkByClientId(networkClientId);
-            return;
-        }
-        if (!__classPrivateFieldGet(this, _NetworkController_ethQuery, "f")) {
-            return;
-        }
-        const isInfura = __classPrivateFieldGet(this, _NetworkController_autoManagedNetworkClient, "f")?.configuration.type ===
-            types_1.NetworkClientType.Infura;
-        let networkChanged = false;
-        const listener = () => {
-            networkChanged = true;
-            try {
-                this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
-            }
-            catch (error) {
-                // In theory, this `catch` should not be necessary given that this error
-                // would occur "inside" of the call to `#determineEIP1559Compatibility`
-                // below and so it should be caught by the `try`/`catch` below (it is
-                // impossible to reproduce in tests for that reason). However, somehow
-                // it occurs within Mobile and so we have to add our own `try`/`catch`
-                // here.
-                /* istanbul ignore next */
-                if (!(error instanceof Error) ||
-                    error.message !==
-                        'Subscription not found for event: NetworkController:networkDidChange') {
-                    // Again, this error should not happen and is impossible to reproduce
-                    // in tests.
-                    /* istanbul ignore next */
-                    throw error;
-                }
-            }
-        };
-        this.messagingSystem.subscribe('NetworkController:networkDidChange', listener);
-        let updatedNetworkStatus;
-        let updatedIsEIP1559Compatible;
-        try {
-            const isEIP1559Compatible = await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_determineEIP1559Compatibility).call(this, this.state.selectedNetworkClientId);
-            updatedNetworkStatus = constants_1.NetworkStatus.Available;
-            updatedIsEIP1559Compatible = isEIP1559Compatible;
-        }
-        catch (error) {
-            // TODO: mock ethQuery.sendAsync to throw error without error code
-            /* istanbul ignore else */
-            if (isErrorWithCode(error)) {
-                let responseBody;
-                if (isInfura &&
-                    (0, utils_1.hasProperty)(error, 'message') &&
-                    typeof error.message === 'string') {
-                    try {
-                        responseBody = JSON.parse(error.message);
-                    }
-                    catch (parseError) {
-                        // error.message must not be JSON
-                        __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetwork: json parse error', parseError);
-                    }
-                }
-                if ((0, utils_1.isPlainObject)(responseBody) &&
-                    responseBody.error === constants_1.INFURA_BLOCKED_KEY) {
-                    updatedNetworkStatus = constants_1.NetworkStatus.Blocked;
-                }
-                else if (error.code === rpc_errors_1.errorCodes.rpc.internal) {
-                    updatedNetworkStatus = constants_1.NetworkStatus.Unknown;
-                    __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetwork: rpc internal error', error);
-                }
-                else {
-                    updatedNetworkStatus = constants_1.NetworkStatus.Unavailable;
-                    __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetwork: ', error);
-                }
-            }
-            else {
-                debugLog('NetworkController - could not determine network status', error);
-                updatedNetworkStatus = constants_1.NetworkStatus.Unknown;
-                __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetwork: ', error);
-            }
-        }
-        if (networkChanged) {
-            // If the network has changed, then `lookupNetwork` either has been or is
-            // in the process of being called, so we don't need to go further.
-            return;
-        }
-        try {
-            this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
-        }
-        catch (error) {
-            if (!(error instanceof Error) ||
-                error.message !==
-                    'Subscription not found for event: NetworkController:networkDidChange') {
-                throw error;
-            }
-        }
-        this.update((state) => {
-            const meta = state.networksMetadata[state.selectedNetworkClientId];
-            meta.status = updatedNetworkStatus;
-            if (updatedIsEIP1559Compatible === undefined) {
-                delete meta.EIPS[1559];
-            }
-            else {
-                meta.EIPS[1559] = updatedIsEIP1559Compatible;
-            }
-        });
-        if (isInfura) {
-            if (updatedNetworkStatus === constants_1.NetworkStatus.Available) {
-                this.messagingSystem.publish('NetworkController:infuraIsUnblocked');
-            }
-            else if (updatedNetworkStatus === constants_1.NetworkStatus.Blocked) {
-                this.messagingSystem.publish('NetworkController:infuraIsBlocked');
-            }
+            await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_lookupGivenNetwork).call(this, networkClientId);
         }
         else {
-            // Always publish infuraIsUnblocked regardless of network status to
-            // prevent consumers from being stuck in a blocked state if they were
-            // previously connected to an Infura network that was blocked
-            this.messagingSystem.publish('NetworkController:infuraIsUnblocked');
+            await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_lookupSelectedNetwork).call(this);
         }
     }
+    /**
+     * Uses a request for the latest block to gather the following information on
+     * the given network, persisting it to state:
+     *
+     * - The connectivity status: whether the network is available, geo-blocked
+     * (Infura only), unavailable, or unknown
+     * - The feature compatibility status: whether the network supports EIP-1559,
+     * whether it does not, or whether it is unknown
+     *
+     * @param networkClientId - The ID of the network client to inspect.
+     * @deprecated Please use `lookupNetwork` and pass a network client ID
+     * instead. This method will be removed in a future major version.
+     */
+    // We are planning on removing this so we aren't interested in testing this
+    // right now.
+    /* istanbul ignore next */
+    async lookupNetworkByClientId(networkClientId) {
+        await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_lookupGivenNetwork).call(this, networkClientId);
+    }
     /**
      * Convenience method to update provider network type settings.
      *
@@ -1268,6 +1101,174 @@ async function _NetworkController_refreshNetwork(networkClientId, options = {})
     __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_applyNetworkSelection).call(this, networkClientId, options);
     this.messagingSystem.publish('NetworkController:networkDidChange', this.state);
     await this.lookupNetwork();
+}, _NetworkController_determineNetworkMetadata = 
+/**
+ * Uses a request for the latest block to gather the following information on
+ * the given network:
+ *
+ * - The connectivity status: whether it is available, geo-blocked (Infura
+ * only), unavailable, or unknown
+ * - The capabilities status: whether it supports EIP-1559, whether it does
+ * not, or whether it is unknown
+ *
+ * @param networkClientId - The ID of the network client to inspect.
+ * If no ID is provided, uses the currently selected network.
+ * @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 isInfura = networkClient.configuration.type === types_1.NetworkClientType.Infura;
+    let networkStatus;
+    let isEIP1559Compatible;
+    try {
+        isEIP1559Compatible =
+            await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_determineEIP1559Compatibility).call(this, networkClientId);
+        networkStatus = constants_1.NetworkStatus.Available;
+    }
+    catch (error) {
+        debugLog('NetworkController: lookupNetwork: ', error);
+        if (isErrorWithCode(error)) {
+            let responseBody;
+            if (isInfura &&
+                (0, utils_1.hasProperty)(error, 'message') &&
+                typeof error.message === 'string') {
+                try {
+                    responseBody = JSON.parse(error.message);
+                }
+                catch {
+                    // error.message must not be JSON
+                    __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetwork: json parse error: ', error);
+                }
+            }
+            if ((0, utils_1.isPlainObject)(responseBody) &&
+                responseBody.error === constants_1.INFURA_BLOCKED_KEY) {
+                networkStatus = constants_1.NetworkStatus.Blocked;
+            }
+            else if (error.code === rpc_errors_1.errorCodes.rpc.internal) {
+                networkStatus = constants_1.NetworkStatus.Unknown;
+                __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetwork: rpc internal error: ', error);
+            }
+            else {
+                networkStatus = constants_1.NetworkStatus.Unavailable;
+                __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetwork: ', error);
+            }
+        }
+        else {
+            debugLog('NetworkController - could not determine network status', error);
+            networkStatus = constants_1.NetworkStatus.Unknown;
+            __classPrivateFieldGet(this, _NetworkController_log, "f")?.warn('NetworkController: lookupNetwork: ', error);
+        }
+    }
+    return { isInfura, networkStatus, isEIP1559Compatible };
+}, _NetworkController_lookupGivenNetwork = 
+/**
+ * Uses a request for the latest block to gather the following information on
+ * the given network, persisting it to state:
+ *
+ * - The connectivity status: whether the network is available, geo-blocked
+ * (Infura only), unavailable, or unknown
+ * - The feature compatibility status: whether the network supports EIP-1559,
+ * whether it does not, or whether it is unknown
+ *
+ * @param networkClientId - The ID of the network client to inspect.
+ */
+async function _NetworkController_lookupGivenNetwork(networkClientId) {
+    const { networkStatus, isEIP1559Compatible } = await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_determineNetworkMetadata).call(this, networkClientId);
+    __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateMetadataForNetwork).call(this, networkClientId, networkStatus, isEIP1559Compatible);
+}, _NetworkController_lookupSelectedNetwork = 
+/**
+ * Uses a request for the latest block to gather the following information on
+ * the currently selected network, persisting it to state:
+ *
+ * - The connectivity status: whether the network is available, geo-blocked
+ * (Infura only), unavailable, or unknown
+ * - The feature compatibility status: whether the network supports EIP-1559,
+ * whether it does not, or whether it is unknown
+ *
+ * Note that it is possible for the current network to be switched while this
+ * method is running. If that is the case, it will exit early (as this method
+ * will also run for the new network).
+ */
+async function _NetworkController_lookupSelectedNetwork() {
+    if (!__classPrivateFieldGet(this, _NetworkController_ethQuery, "f")) {
+        return;
+    }
+    let networkChanged = false;
+    const listener = () => {
+        networkChanged = true;
+        try {
+            this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
+        }
+        catch (error) {
+            // In theory, this `catch` should not be necessary given that this error
+            // would occur "inside" of the call to `#determineEIP1559Compatibility`
+            // below and so it should be caught by the `try`/`catch` below (it is
+            // impossible to reproduce in tests for that reason). However, somehow
+            // it occurs within Mobile and so we have to add our own `try`/`catch`
+            // here.
+            /* istanbul ignore next */
+            if (!(error instanceof Error) ||
+                error.message !==
+                    'Subscription not found for event: NetworkController:networkDidChange') {
+                // Again, this error should not happen and is impossible to reproduce
+                // in tests.
+                /* istanbul ignore next */
+                throw error;
+            }
+        }
+    };
+    this.messagingSystem.subscribe('NetworkController:networkDidChange', listener);
+    const { isInfura, networkStatus, isEIP1559Compatible } = await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_determineNetworkMetadata).call(this, this.state.selectedNetworkClientId);
+    if (networkChanged) {
+        // If the network has changed, then `lookupNetwork` either has been or is
+        // in the process of being called, so we don't need to go further.
+        return;
+    }
+    try {
+        this.messagingSystem.unsubscribe('NetworkController:networkDidChange', listener);
+    }
+    catch (error) {
+        if (!(error instanceof Error) ||
+            error.message !==
+                'Subscription not found for event: NetworkController:networkDidChange') {
+            throw error;
+        }
+    }
+    __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateMetadataForNetwork).call(this, this.state.selectedNetworkClientId, networkStatus, isEIP1559Compatible);
+    if (isInfura) {
+        if (networkStatus === constants_1.NetworkStatus.Available) {
+            this.messagingSystem.publish('NetworkController:infuraIsUnblocked');
+        }
+        else if (networkStatus === constants_1.NetworkStatus.Blocked) {
+            this.messagingSystem.publish('NetworkController:infuraIsBlocked');
+        }
+    }
+    else {
+        // Always publish infuraIsUnblocked regardless of network status to
+        // prevent consumers from being stuck in a blocked state if they were
+        // previously connected to an Infura network that was blocked
+        this.messagingSystem.publish('NetworkController:infuraIsUnblocked');
+    }
+}, _NetworkController_updateMetadataForNetwork = function _NetworkController_updateMetadataForNetwork(networkClientId, networkStatus, isEIP1559Compatible) {
+    this.update((state) => {
+        if (state.networksMetadata[networkClientId] === undefined) {
+            state.networksMetadata[networkClientId] = {
+                status: constants_1.NetworkStatus.Unknown,
+                EIPS: {},
+            };
+        }
+        const meta = state.networksMetadata[networkClientId];
+        meta.status = networkStatus;
+        if (isEIP1559Compatible === undefined) {
+            delete meta.EIPS[1559];
+        }
+        else {
+            meta.EIPS[1559] = isEIP1559Compatible;
+        }
+    });
 }, _NetworkController_getLatestBlock = function _NetworkController_getLatestBlock(networkClientId) {
     if (networkClientId === undefined) {
         networkClientId = this.state.selectedNetworkClientId;