@metamask-previews/network-controller 22.0.2-preview-1c8fd633 → 22.0.2-preview-a82fd89

package/dist/NetworkController.cjs

@@ -45,10 +45,9 @@ const eth_query_1 = __importDefault(require("@metamask/eth-query"));
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const swappable_obj_proxy_1 = require("@metamask/swappable-obj-proxy");
 const utils_1 = require("@metamask/utils");
-const assert_1 = require("assert");
+const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
 const reselect_1 = require("reselect");
 const URI = __importStar(require("uri-js"));
-const util_1 = require("util");
 const uuid_1 = require("uuid");
 const constants_1 = require("./constants.cjs");
 const create_auto_managed_network_client_1 = require("./create-auto-managed-network-client.cjs");
@@ -112,7 +111,7 @@ function getDefaultNetworkConfigurationsByChainId() {
     return Object.values(controller_utils_1.InfuraNetworkType).reduce((obj, infuraNetworkType) => {
         const chainId = controller_utils_1.ChainId[infuraNetworkType];
         const rpcEndpointUrl = 
-        // False negative - this is a string.
+        // This ESLint rule mistakenly produces an error.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `https://${infuraNetworkType}.infura.io/v3/{infuraProjectId}`;
         const networkConfiguration = {
@@ -237,7 +236,10 @@ function validateNetworkControllerState(state) {
         throw new Error('NetworkController state has invalid `networkConfigurationsByChainId`: Every RPC endpoint across all network configurations must have a unique `networkClientId`');
     }
     if (!networkClientIds.includes(state.selectedNetworkClientId)) {
-        throw new Error(`NetworkController state is invalid: \`selectedNetworkClientId\` ${(0, util_1.inspect)(state.selectedNetworkClientId)} does not refer to an RPC endpoint within a network configuration`);
+        throw new Error(
+        // This ESLint rule mistakenly produces an error.
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        `NetworkController state is invalid: \`selectedNetworkClientId\` '${state.selectedNetworkClientId}' does not refer to an RPC endpoint within a network configuration`);
     }
 }
 /**
@@ -336,6 +338,18 @@ class NetworkController extends base_controller_1.BaseController {
         // TODO: Either fix this lint violation or explain why it's necessary to ignore.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `${this.name}:getSelectedNetworkClient`, this.getSelectedNetworkClient.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // ESLint is mistaken here; `name` is a string.
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        `${this.name}:addNetwork`, this.addNetwork.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // ESLint is mistaken here; `name` is a string.
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        `${this.name}:removeNetwork`, this.removeNetwork.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // ESLint is mistaken here; `name` is a string.
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        `${this.name}:updateNetwork`, this.updateNetwork.bind(this));
     }
     /**
      * Accesses the provider and block tracker for the currently selected network.
@@ -595,14 +609,15 @@ class NetworkController extends base_controller_1.BaseController {
      * removed in a future release
      */
     async setProviderType(type) {
-        assert_1.strict.notStrictEqual(type, controller_utils_1.NetworkType.rpc, 
-        // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-        `NetworkController - cannot call "setProviderType" with type "${controller_utils_1.NetworkType.rpc}". Use "setActiveNetwork"`);
-        assert_1.strict.ok((0, controller_utils_1.isInfuraNetworkType)(type), 
-        // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-        `Unknown Infura provider type "${type}".`);
+        if (type === controller_utils_1.NetworkType.rpc) {
+            throw new Error(
+            // This ESLint rule mistakenly produces an error.
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            `NetworkController - cannot call "setProviderType" with type "${controller_utils_1.NetworkType.rpc}". Use "setActiveNetwork"`);
+        }
+        if (!(0, controller_utils_1.isInfuraNetworkType)(type)) {
+            throw new Error(`Unknown Infura provider type "${String(type)}".`);
+        }
         await this.setActiveNetwork(type);
     }
     /**
@@ -764,7 +779,7 @@ class NetworkController extends base_controller_1.BaseController {
     async updateNetwork(chainId, fields, { replacementSelectedRpcEndpointIndex, } = {}) {
         const existingNetworkConfiguration = this.state.networkConfigurationsByChainId[chainId];
         if (existingNetworkConfiguration === undefined) {
-            throw new Error(`Could not update network: Cannot find network configuration for chain ${(0, util_1.inspect)(chainId)}`);
+            throw new Error(`Could not update network: Cannot find network configuration for chain '${chainId}'`);
         }
         const existingChainId = chainId;
         const { chainId: newChainId, rpcEndpoints: setOfNewRpcEndpointFields } = fields;
@@ -893,7 +908,7 @@ class NetworkController extends base_controller_1.BaseController {
                         this.state.selectedNetworkClientId);
             })) {
             throw new Error(
-            // False negative - this is a string.
+            // This ESLint rule mistakenly produces an error.
             // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
             `Could not update network: Cannot update RPC endpoints in such a way that the selected network '${this.state.selectedNetworkClientId}' would be removed without a replacement. Choose a different RPC endpoint as the selected network via the \`replacementSelectedRpcEndpointIndex\` option.`);
         }
@@ -963,7 +978,7 @@ class NetworkController extends base_controller_1.BaseController {
     removeNetwork(chainId) {
         const existingNetworkConfiguration = this.state.networkConfigurationsByChainId[chainId];
         if (existingNetworkConfiguration === undefined) {
-            throw new Error(`Cannot find network configuration for chain ${(0, util_1.inspect)(chainId)}`);
+            throw new Error(`Cannot find network configuration for chain '${chainId}'`);
         }
         if (existingNetworkConfiguration.rpcEndpoints.some((rpcEndpoint) => rpcEndpoint.networkClientId === this.state.selectedNetworkClientId)) {
             throw new Error(`Cannot remove the currently selected network`);
@@ -987,6 +1002,7 @@ class NetworkController extends base_controller_1.BaseController {
             });
         });
         __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
+        this.messagingSystem.publish('NetworkController:networkRemoved', existingNetworkConfiguration);
     }
     /**
      * Assuming that the network has been previously switched, switches to this
@@ -1102,7 +1118,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
     const errorMessagePrefix = mode === 'update' ? 'Could not update network' : 'Could not add network';
     if (!(0, utils_1.isStrictHexString)(networkFields.chainId) ||
         !(0, controller_utils_1.isSafeChainId)(networkFields.chainId)) {
-        throw new Error(`${errorMessagePrefix}: Invalid \`chainId\` ${(0, util_1.inspect)(networkFields.chainId)} (must start with "0x" and not exceed the maximum)`);
+        throw new Error(`${errorMessagePrefix}: Invalid \`chainId\` '${networkFields.chainId}' (must start with "0x" and not exceed the maximum)`);
     }
     if (existingNetworkConfiguration === null ||
         networkFields.chainId !== existingNetworkConfiguration.chainId) {
@@ -1110,13 +1126,13 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         if (existingNetworkConfigurationViaChainId !== undefined) {
             if (existingNetworkConfiguration === null) {
                 throw new Error(
-                // False negative - these are strings.
+                // This ESLint rule mistakenly produces an error.
                 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
                 `Could not add network for chain ${args.networkFields.chainId} as another network for that chain already exists ('${existingNetworkConfigurationViaChainId.name}')`);
             }
             else {
                 throw new Error(
-                // False negative - these are strings.
+                // This ESLint rule mistakenly produces an error.
                 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
                 `Cannot move network from chain ${existingNetworkConfiguration.chainId} to ${networkFields.chainId} as another network for that chain already exists ('${existingNetworkConfigurationViaChainId.name}')`);
             }
@@ -1134,7 +1150,10 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
     }
     for (const rpcEndpointFields of networkFields.rpcEndpoints) {
         if (!isValidUrl(rpcEndpointFields.url)) {
-            throw new Error(`${errorMessagePrefix}: An entry in \`rpcEndpoints\` has invalid URL ${(0, util_1.inspect)(rpcEndpointFields.url)}`);
+            throw new Error(
+            // This ESLint rule mistakenly produces an error.
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            `${errorMessagePrefix}: An entry in \`rpcEndpoints\` has invalid URL '${rpcEndpointFields.url}'`);
         }
         const networkClientId = 'networkClientId' in rpcEndpointFields
             ? rpcEndpointFields.networkClientId
@@ -1151,10 +1170,10 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
             networkClientId !== undefined &&
             rpcEndpointFields.type === RpcEndpointType.Custom &&
             !Object.values(autoManagedNetworkClientRegistry).some((networkClientsById) => networkClientId in networkClientsById)) {
-            throw new Error(`${errorMessagePrefix}: RPC endpoint '${
+            throw new Error(
             // This is a string.
             // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-            rpcEndpointFields.url}' refers to network client ${(0, util_1.inspect)(networkClientId)} that does not exist`);
+            `${errorMessagePrefix}: RPC endpoint '${rpcEndpointFields.url}' refers to network client '${networkClientId}' that does not exist`);
         }
         if (networkFields.rpcEndpoints.some((otherRpcEndpointFields) => otherRpcEndpointFields !== rpcEndpointFields &&
             URI.equal(otherRpcEndpointFields.url, rpcEndpointFields.url))) {
@@ -1167,13 +1186,18 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         for (const networkConfiguration of networkConfigurationsForOtherChains) {
             const rpcEndpoint = networkConfiguration.rpcEndpoints.find((existingRpcEndpoint) => URI.equal(rpcEndpointFields.url, existingRpcEndpoint.url));
             if (rpcEndpoint) {
-                throw new Error(mode === 'update'
-                    ? // False negative - these are strings.
-                        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                        `Could not update network to point to same RPC endpoint as existing network for chain ${networkConfiguration.chainId} ('${networkConfiguration.name}')`
-                    : // False negative - these are strings.
-                        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                        `Could not add network that points to same RPC endpoint as existing network for chain ${networkConfiguration.chainId} ('${networkConfiguration.name}')`);
+                if (mode === 'update') {
+                    throw new Error(
+                    // This ESLint rule mistakenly produces an error.
+                    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                    `Could not update network to point to same RPC endpoint as existing network for chain ${networkConfiguration.chainId} ('${networkConfiguration.name}')`);
+                }
+                else {
+                    throw new Error(
+                    // This ESLint rule mistakenly produces an error.
+                    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                    `Could not add network that points to same RPC endpoint as existing network for chain ${networkConfiguration.chainId} ('${networkConfiguration.name}')`);
+                }
             }
         }
     }
@@ -1280,6 +1304,9 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         delete state.networkConfigurationsByChainId[args.existingNetworkConfiguration.chainId];
     }
     if (mode === 'add' || mode === 'update') {
+        if (!(0, fast_deep_equal_1.default)(state.networkConfigurationsByChainId[args.networkFields.chainId], args.networkConfigurationToPersist)) {
+            args.networkConfigurationToPersist.lastUpdatedAt = Date.now();
+        }
         state.networkConfigurationsByChainId[args.networkFields.chainId] =
             args.networkConfigurationToPersist;
     }
@@ -1334,14 +1361,14 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         // This is impossible to reach
         /* istanbul ignore if */
         if (!possibleAutoManagedNetworkClient) {
-            throw new Error(`No Infura network client found with ID ${(0, util_1.inspect)(networkClientId)}`);
+            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 ${(0, util_1.inspect)(networkClientId)}`);
+            throw new Error(`No network client found with ID '${networkClientId}'`);
         }
         autoManagedNetworkClient = possibleAutoManagedNetworkClient;
     }