@metamask-previews/network-controller 24.2.0-preview-622f3f09 → 24.2.0-preview-bc80f5a1

package/CHANGELOG.md

@@ -9,8 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- **BREAKING:** Use `InternalProvider` instead of `SafeEventEmitterProvider` ([#6796](https://github.com/MetaMask/core/pull/6796))
-  - Providers accessible either via network clients or global proxies no longer emit events (or inherit from EventEmitter, for that matter).
 - Bump `@metamask/utils` from `^11.8.0` to `^11.8.1` ([#6708](https://github.com/MetaMask/core/pull/6708))
 - Update `@metamask/eth-json-rpc-middleware` from `^17.0.1` to `^18.0.0` ([#6714](https://github.com/MetaMask/core/pull/6714))
 - Bump `@metamask/error-reporting-service` from `^2.1.0` to `^2.2.0` ([#6782](https://github.com/MetaMask/core/pull/6782))

package/dist/NetworkController.cjs

@@ -81,6 +81,8 @@ var RpcEndpointType;
  * @returns The keys of an object, typed according to the type of the object
  * itself.
  */
+// TODO: Either fix this lint violation or explain why it's necessary to ignore.
+// eslint-disable-next-line @typescript-eslint/naming-convention
 function knownKeysOf(
 // TODO: Replace `any` with type
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -133,7 +135,7 @@ function getDefaultInfuraNetworkConfigurationsByChainId() {
             return obj;
         }
         const rpcEndpointUrl = 
-        // False positive - 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 = {
@@ -425,21 +427,54 @@ class NetworkController extends base_controller_1.BaseController {
         __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(`${this.name}:getEthQuery`, () => {
+        this.messagingSystem.registerActionHandler(
+        // 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}:getEthQuery`, () => {
             return __classPrivateFieldGet(this, _NetworkController_ethQuery, "f");
         });
-        this.messagingSystem.registerActionHandler(`${this.name}:getNetworkClientById`, this.getNetworkClientById.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:getEIP1559Compatibility`, this.getEIP1559Compatibility.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:setActiveNetwork`, this.setActiveNetwork.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:setProviderType`, this.setProviderType.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:findNetworkClientIdByChainId`, this.findNetworkClientIdByChainId.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:getNetworkConfigurationByChainId`, this.getNetworkConfigurationByChainId.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:getNetworkConfigurationByNetworkClientId`, this.getNetworkConfigurationByNetworkClientId.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // 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}:getNetworkClientById`, this.getNetworkClientById.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // 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}:getEIP1559Compatibility`, this.getEIP1559Compatibility.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // 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}:setActiveNetwork`, this.setActiveNetwork.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // 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}:setProviderType`, this.setProviderType.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // 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}:findNetworkClientIdByChainId`, this.findNetworkClientIdByChainId.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // 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}:getNetworkConfigurationByChainId`, this.getNetworkConfigurationByChainId.bind(this));
+        this.messagingSystem.registerActionHandler(
+        // ESLint is mistaken here; `name` is a string.
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        `${this.name}:getNetworkConfigurationByNetworkClientId`, this.getNetworkConfigurationByNetworkClientId.bind(this));
         this.messagingSystem.registerActionHandler(`${this.name}:getSelectedNetworkClient`, this.getSelectedNetworkClient.bind(this));
         this.messagingSystem.registerActionHandler(`${this.name}:getSelectedChainId`, this.getSelectedChainId.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:addNetwork`, this.addNetwork.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:removeNetwork`, this.removeNetwork.bind(this));
-        this.messagingSystem.registerActionHandler(`${this.name}:updateNetwork`, this.updateNetwork.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));
     }
     /**
      * Enables the RPC failover functionality. That is, if any RPC endpoints are
@@ -459,7 +494,6 @@ class NetworkController extends base_controller_1.BaseController {
     }
     /**
      * Accesses the provider and block tracker for the currently selected network.
-     *
      * @returns The proxy and block tracker proxies.
      * @deprecated This method has been replaced by `getSelectedNetworkClient` (which has a more easily used return type) and will be removed in a future release.
      */
@@ -515,13 +549,19 @@ class NetworkController extends base_controller_1.BaseController {
             // This is impossible to reach
             /* istanbul ignore if */
             if (!infuraNetworkClient) {
-                throw new Error(`No Infura network client was found with the ID "${networkClientId}".`);
+                throw new Error(
+                // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                `No Infura network client was found with the ID "${networkClientId}".`);
             }
             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(
+            // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            `No custom network client was found with the ID "${networkClientId}".`);
         }
         return customNetworkClient;
     }
@@ -580,7 +620,10 @@ class NetworkController extends base_controller_1.BaseController {
      */
     async setProviderType(type) {
         if (type === controller_utils_1.NetworkType.rpc) {
-            throw new Error(`NetworkController - cannot call "setProviderType" with type "${controller_utils_1.NetworkType.rpc}". Use "setActiveNetwork"`);
+            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)}".`);
@@ -873,7 +916,10 @@ class NetworkController extends base_controller_1.BaseController {
                     networkClientOperation.oldRpcEndpoint.networkClientId ===
                         this.state.selectedNetworkClientId);
             })) {
-            throw new Error(`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.`);
+            throw new Error(
+            // 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.`);
         }
         __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_registerNetworkClientsAsNeeded).call(this, {
             networkFields: fields,
@@ -1275,10 +1321,16 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         const existingNetworkConfigurationViaChainId = this.state.networkConfigurationsByChainId[networkFields.chainId];
         if (existingNetworkConfigurationViaChainId !== undefined) {
             if (existingNetworkConfiguration === null) {
-                throw new Error(`Could not add network for chain ${args.networkFields.chainId} as another network for that chain already exists ('${existingNetworkConfigurationViaChainId.name}')`);
+                throw new Error(
+                // 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(`Cannot move network from chain ${existingNetworkConfiguration.chainId} to ${networkFields.chainId} as another network for that chain already exists ('${existingNetworkConfigurationViaChainId.name}')`);
+                throw new Error(
+                // 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}')`);
             }
         }
     }
@@ -1294,7 +1346,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 '${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
@@ -1302,13 +1357,19 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         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}'`);
+            throw new Error(
+            // This is a string.
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            `${errorMessagePrefix}: Custom RPC endpoint '${rpcEndpointFields.url}' has invalid network client ID '${networkClientId}'`);
         }
         if (mode === 'update' &&
             networkClientId !== undefined &&
             rpcEndpointFields.type === RpcEndpointType.Custom &&
             !Object.values(autoManagedNetworkClientRegistry).some((networkClientsById) => networkClientId in networkClientsById)) {
-            throw new Error(`${errorMessagePrefix}: RPC endpoint '${rpcEndpointFields.url}' refers to network client '${networkClientId}' that does not exist`);
+            throw new Error(
+            // This is a string.
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            `${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))) {
@@ -1322,10 +1383,16 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
             const rpcEndpoint = networkConfiguration.rpcEndpoints.find((existingRpcEndpoint) => URI.equal(rpcEndpointFields.url, existingRpcEndpoint.url));
             if (rpcEndpoint) {
                 if (mode === 'update') {
-                    throw new Error(`Could not update network to point to same RPC endpoint as existing network for chain ${networkConfiguration.chainId} ('${networkConfiguration.name}')`);
+                    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(`Could not add network that points to same RPC endpoint as existing network for chain ${networkConfiguration.chainId} ('${networkConfiguration.name}')`);
+                    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}')`);
                 }
             }
         }
@@ -1353,8 +1420,12 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         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`);
+                ? // This is a string.
+                    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                    `Could not add network with chain ID ${networkFields.chainId} and Infura RPC endpoint for '${infuraNetworkNickname}' which represents ${infuraChainId}, as the two conflict`
+                : // This is a string.
+                    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                    `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] ===
@@ -1545,15 +1616,13 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         __classPrivateFieldGet(this, _NetworkController_providerProxy, "f").setTarget(__classPrivateFieldGet(this, _NetworkController_autoManagedNetworkClient, "f").provider);
     }
     else {
-        __classPrivateFieldSet(this, _NetworkController_providerProxy, (0, swappable_obj_proxy_1.createSwappableProxy)(__classPrivateFieldGet(this, _NetworkController_autoManagedNetworkClient, "f").provider), "f");
+        __classPrivateFieldSet(this, _NetworkController_providerProxy, (0, swappable_obj_proxy_1.createEventEmitterProxy)(__classPrivateFieldGet(this, _NetworkController_autoManagedNetworkClient, "f").provider), "f");
     }
     if (__classPrivateFieldGet(this, _NetworkController_blockTrackerProxy, "f")) {
         __classPrivateFieldGet(this, _NetworkController_blockTrackerProxy, "f").setTarget(__classPrivateFieldGet(this, _NetworkController_autoManagedNetworkClient, "f").blockTracker);
     }
     else {
-        __classPrivateFieldSet(this, _NetworkController_blockTrackerProxy, (0, swappable_obj_proxy_1.createEventEmitterProxy)(__classPrivateFieldGet(this, _NetworkController_autoManagedNetworkClient, "f").blockTracker, {
-            eventFilter: 'skipInternal',
-        }), "f");
+        __classPrivateFieldSet(this, _NetworkController_blockTrackerProxy, (0, swappable_obj_proxy_1.createEventEmitterProxy)(__classPrivateFieldGet(this, _NetworkController_autoManagedNetworkClient, "f").blockTracker, { eventFilter: 'skipInternal' }), "f");
     }
     __classPrivateFieldSet(this, _NetworkController_ethQuery, new eth_query_1.default(__classPrivateFieldGet(this, _NetworkController_providerProxy, "f")), "f");
 };