@metamask/network-controller 23.0.0 → 23.2.0

package/CHANGELOG.md

@@ -7,6 +7,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [23.2.0]
+
+### Added
+
+- Add optional `additionalDefaultNetworks` option to `NetworkController` constructor ([#5527](https://github.com/MetaMask/core/pull/5527))
+  - This can be used to customize which custom networks the default `networkConfigurationsByChainId` includes.
+- Add `getSelectedChainId` method to `NetworkController` ([#5516](https://github.com/MetaMask/core/pull/5516))
+  - This is also callable via the messenger.
+- Add `DEPRECATED_NETWORKS` constant ([#5560](https://github.com/MetaMask/core/pull/5560))
+
+### Changed
+
+- Remove Goerli and Linea Goerli from set of default networks ([#5560](https://github.com/MetaMask/core/pull/5560))
+  - Note that if you do not pass any initial state to NetworkController, this means that `0x5` and `0xe704` will no longer be keys in `networkConfigurationsByChainId`.
+  - We are not counting this as a breaking change because we don't make any guarantees about what keys are present in `networkConfigurationsByChainId` at runtime — only that they must be valid chain IDs.
+  - If you want more of a guarantee, you are recommended to persist the NetworkController state and then pass it back through as initial state.
+- Update `RpcEndpoint` so that `failoverUrls` is optional ([#5561](https://github.com/MetaMask/core/pull/5561))
+  - This property was introduced in 23.0.0 as a breaking change, but this change makes it non-breaking.
+- Update `NetworkClientConfiguration` so that `failoverUrls` is optional ([#5561](https://github.com/MetaMask/core/pull/5561))
+  - This property was introduced in 23.0.0 as a breaking change, but this change makes it non-breaking.
+- Bump `@metamask/controller-utils` to `^11.7.0` ([#5583](https://github.com/MetaMask/core/pull/5583))
+
+### Fixed
+
+- Upgrade `@metamask/eth-json-rpc-infura` to `^10.1.1` and `@metamask/eth-json-rpc-infura` to `^16.0.1` ([#5573](https://github.com/MetaMask/core/pull/5573))
+  - This fixes a bug where non-standard unsuccessful JSON-RPC errors were being ignored/discarded
+
+## [23.1.0]
+
+### Added
+
+- The `NetworkController:rpcEndpointDegraded` messenger event now has a new `chainId` property in its data, which is the ID of the chain that the endpoint represents ([#5517](https://github.com/MetaMask/core/pull/5517))
+
 ## [23.0.0]
 
 ### Added
@@ -781,7 +814,9 @@ 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.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@23.2.0...HEAD
+[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
 [22.2.1]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.2.0...@metamask/network-controller@22.2.1
 [22.2.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@22.1.1...@metamask/network-controller@22.2.0

package/dist/NetworkController.cjs

@@ -106,11 +106,33 @@ const controllerName = 'NetworkController';
  * Constructs a value for the state property `networkConfigurationsByChainId`
  * which will be used if it has not been provided to the constructor.
  *
+ * @param [additionalDefaultNetworks] - An array of Hex Chain IDs representing the additional networks to be included as default.
  * @returns The default value for `networkConfigurationsByChainId`.
  */
-function getDefaultNetworkConfigurationsByChainId() {
+function getDefaultNetworkConfigurationsByChainId(additionalDefaultNetworks = []) {
+    const infuraNetworks = getDefaultInfuraNetworkConfigurationsByChainId();
+    const customNetworks = getDefaultCustomNetworkConfigurationsByChainId();
+    return additionalDefaultNetworks.reduce((obj, chainId) => {
+        if ((0, utils_1.hasProperty)(customNetworks, chainId)) {
+            obj[chainId] = customNetworks[chainId];
+        }
+        return obj;
+    }, 
+    // Always include the infura networks in the default networks
+    infuraNetworks);
+}
+/**
+ * Constructs a `networkConfigurationsByChainId` object for all default Infura networks.
+ *
+ * @returns The `networkConfigurationsByChainId` object of all Infura networks.
+ */
+function getDefaultInfuraNetworkConfigurationsByChainId() {
     return Object.values(controller_utils_1.InfuraNetworkType).reduce((obj, infuraNetworkType) => {
         const chainId = controller_utils_1.ChainId[infuraNetworkType];
+        // Skip deprecated network as default network.
+        if (constants_1.DEPRECATED_NETWORKS.has(chainId)) {
+            return obj;
+        }
         const rpcEndpointUrl = 
         // This ESLint rule mistakenly produces an error.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
@@ -133,15 +155,42 @@ function getDefaultNetworkConfigurationsByChainId() {
         return { ...obj, [chainId]: networkConfiguration };
     }, {});
 }
+/**
+ * Constructs a `networkConfigurationsByChainId` object for all default custom networks.
+ *
+ * @returns The `networkConfigurationsByChainId` object of all custom networks.
+ */
+function getDefaultCustomNetworkConfigurationsByChainId() {
+    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[controller_utils_1.BuiltInNetworkName.MegaETHTestnet],
+            defaultRpcEndpointIndex: 0,
+            defaultBlockExplorerUrlIndex: 0,
+            name: controller_utils_1.NetworkNickname[controller_utils_1.BuiltInNetworkName.MegaETHTestnet],
+            nativeCurrency: ticker,
+            rpcEndpoints: [
+                {
+                    failoverUrls: [],
+                    networkClientId: controller_utils_1.BuiltInNetworkName.MegaETHTestnet,
+                    type: RpcEndpointType.Custom,
+                    url: controller_utils_1.BUILT_IN_CUSTOM_NETWORKS_RPC.MEGAETH_TESTNET,
+                },
+            ],
+        },
+    };
+}
 /**
  * Constructs properties for the NetworkController state whose values will be
  * used if not provided to the constructor.
  *
+ * @param [additionalDefaultNetworks] - An array of Hex Chain IDs representing the additional networks to be included as default.
  * @returns The default NetworkController state.
  */
-function getDefaultNetworkControllerState() {
+function getDefaultNetworkControllerState(additionalDefaultNetworks) {
     const networksMetadata = {};
-    const networkConfigurationsByChainId = getDefaultNetworkConfigurationsByChainId();
+    const networkConfigurationsByChainId = getDefaultNetworkConfigurationsByChainId(additionalDefaultNetworks);
     return {
         selectedNetworkClientId: controller_utils_1.InfuraNetworkType.mainnet,
         networksMetadata,
@@ -293,8 +342,11 @@ class NetworkController extends base_controller_1.BaseController {
      * @param options - The options; see {@link NetworkControllerOptions}.
      */
     constructor(options) {
-        const { messenger, state, infuraProjectId, log, getRpcServiceOptions } = options;
-        const initialState = { ...getDefaultNetworkControllerState(), ...state };
+        const { messenger, state, infuraProjectId, log, getRpcServiceOptions, additionalDefaultNetworks, } = options;
+        const initialState = {
+            ...getDefaultNetworkControllerState(additionalDefaultNetworks),
+            ...state,
+        };
         validateNetworkControllerState(initialState);
         if (!infuraProjectId || typeof infuraProjectId !== 'string') {
             throw new Error('Invalid Infura project ID');
@@ -368,10 +420,8 @@ class NetworkController extends base_controller_1.BaseController {
         // 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(
-        // 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(`${this.name}:getSelectedNetworkClient`, this.getSelectedNetworkClient.bind(this));
+        this.messagingSystem.registerActionHandler(`${this.name}:getSelectedChainId`, this.getSelectedChainId.bind(this));
         this.messagingSystem.registerActionHandler(
         // ESLint is mistaken here; `name` is a string.
         // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
@@ -410,6 +460,15 @@ class NetworkController extends base_controller_1.BaseController {
         }
         return undefined;
     }
+    /**
+     * Accesses the chain ID from the selected network client.
+     *
+     * @returns The chain ID of the selected network client in hex format or undefined if there is no network client.
+     */
+    getSelectedChainId() {
+        const networkConfiguration = this.getNetworkConfigurationByNetworkClientId(this.state.selectedNetworkClientId);
+        return networkConfiguration?.chainId;
+    }
     /**
      * Internally, the Infura and custom network clients are categorized by type
      * so that when accessing either kind of network client, TypeScript knows