@metamask-previews/network-controller 26.0.0-preview-bc80feb8 → 27.0.0-preview-84f90603

package/CHANGELOG.md

@@ -7,14 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [27.0.0]
+
+### Added
+
+- Add `NetworkController:rpcEndpointChainAvailable` messenger event ([#7166](https://github.com/MetaMask/core/pull/7166))
+  - This is a counterpart to the (new) `NetworkController:rpcEndpointChainUnavailable` and `NetworkController:rpcEndpointChainDegraded` events, but is published when a successful request to an endpoint within a chain of endpoints is made either initially or following a previously established degraded or unavailable status.
+
 ### Changed
 
+- **BREAKING:** Split up and update payload data for `NetworkController:rpcEndpointDegraded` and `NetworkController:rpcEndpointUnavailable` ([#7166](https://github.com/MetaMask/core/pull/7166))
+  - `NetworkController:rpcEndpointDegraded` and `NetworkController:rpcEndpointUnavailable` still exist and retain the same behavior as before.
+  - New events are `NetworkController:rpcEndpointChainDegraded` and `NetworkController:rpcEndpointChainUnavailable`, and are designed to represent an entire chain of endpoints. They are also guaranteed to not be published multiple times in a row. In particular, `NetworkController:rpcEndpointChainUnavailable` is published only after trying all of the endpoints for a chain and when the underlying circuit for the last endpoint breaks, not as each primary's or failover's circuit breaks.
+  - The event payloads have been changed:
+    - For individual endpoint events (`NetworkController:rpcEndpointUnavailable`, `NetworkController:rpcEndpointDegraded`): `failoverEndpointUrl` has been removed, and `primaryEndpointUrl` has been added. In addition, `networkClientId` has been added to the payload.
+    - For chain-level events (`NetworkController:rpcEndpointChainUnavailable`, `NetworkController:rpcEndpointChainDegraded`, `NetworkController:rpcEndpointChainAvailable`): These include `chainId`, `networkClientId`, and event-specific fields (e.g., `error`, `endpointUrl`) but do not include `primaryEndpointUrl`. Consumers can derive endpoint information from the `networkClientId` using `NetworkController:getNetworkClientById` or `NetworkController:getNetworkConfigurationByNetworkClientId`.
+- **BREAKING:** Rename and update payload data for `NetworkController:rpcEndpointRequestRetried` ([#7166](https://github.com/MetaMask/core/pull/7166))
+  - This event is now called `NetworkController:rpcEndpointRetried`.
+  - The event payload has been changed as well: `failoverEndpointUrl` has been removed, and `primaryEndpointUrl` has been added. In addition, `networkClientId` and `attempt` have been added to the payload.
+- **BREAKING:** Update `AbstractRpcService`/`RpcServiceRequestable` to remove `{ isolated: true }` from the `onBreak` event data type ([#7166](https://github.com/MetaMask/core/pull/7166))
+  - This represented the error produced when `isolate` is called on a Cockatiel circuit breaker policy. This never happens for our service (we use `isolate` internally, but this error is suppressed and cannot trigger `onBreak`)
 - Move peer dependencies for controller and service packages to direct dependencies ([#7209](https://github.com/MetaMask/core/pull/7209))
   - The dependencies moved are:
     - `@metamask/error-reporting-service` (^3.0.0)
   - In clients, it is now possible for multiple versions of these packages to exist in the dependency tree.
     - For example, this scenario would be valid: a client relies on `@metamask/controller-a` 1.0.0 and `@metamask/controller-b` 1.0.0, and `@metamask/controller-b` depends on `@metamask/controller-a` 1.1.0.
   - Note, however, that the versions specified in the client's `package.json` always "win", and you are expected to keep them up to date so as not to break controller and service intercommunication.
+- Automatically update network status metadata when chain-level RPC events are published ([#7186](https://github.com/MetaMask/core/pull/7186))
+  - `NetworkController` now automatically subscribes to `NetworkController:rpcEndpointChainUnavailable`, `NetworkController:rpcEndpointChainDegraded`, and `NetworkController:rpcEndpointChainAvailable` events and updates the corresponding network's status metadata in state when these events are published.
+  - This enables real-time network status updates without requiring explicit `lookupNetwork` calls, providing more accurate and timely network availability information.
 
 ## [26.0.0]
 
@@ -1024,7 +1045,8 @@ 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@26.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@27.0.0...HEAD
+[27.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@26.0.0...@metamask/network-controller@27.0.0
 [26.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@25.0.0...@metamask/network-controller@26.0.0
 [25.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@24.3.1...@metamask/network-controller@25.0.0
 [24.3.1]: https://github.com/MetaMask/core/compare/@metamask/network-controller@24.3.0...@metamask/network-controller@24.3.1

package/dist/NetworkController.cjs

@@ -444,6 +444,21 @@ class NetworkController extends base_controller_1.BaseController {
         this.messenger.registerActionHandler(`${this.name}:addNetwork`, this.addNetwork.bind(this));
         this.messenger.registerActionHandler(`${this.name}:removeNetwork`, this.removeNetwork.bind(this));
         this.messenger.registerActionHandler(`${this.name}:updateNetwork`, this.updateNetwork.bind(this));
+        this.messenger.subscribe(`${this.name}:rpcEndpointChainUnavailable`, ({ networkClientId }) => {
+            __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateMetadataForNetwork).call(this, networkClientId, {
+                networkStatus: constants_1.NetworkStatus.Unavailable,
+            });
+        });
+        this.messenger.subscribe(`${this.name}:rpcEndpointChainDegraded`, ({ networkClientId }) => {
+            __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateMetadataForNetwork).call(this, networkClientId, {
+                networkStatus: constants_1.NetworkStatus.Degraded,
+            });
+        });
+        this.messenger.subscribe(`${this.name}:rpcEndpointChainAvailable`, ({ networkClientId }) => {
+            __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateMetadataForNetwork).call(this, networkClientId, {
+                networkStatus: constants_1.NetworkStatus.Available,
+            });
+        });
     }
     /**
      * Enables the RPC failover functionality. That is, if any RPC endpoints are
@@ -1144,7 +1159,10 @@ async function _NetworkController_determineNetworkMetadata(networkClientId) {
  */
 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);
+    __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
@@ -1204,7 +1222,10 @@ async function _NetworkController_lookupSelectedNetwork() {
             throw error;
         }
     }
-    __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateMetadataForNetwork).call(this, this.state.selectedNetworkClientId, networkStatus, isEIP1559Compatible);
+    __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateMetadataForNetwork).call(this, this.state.selectedNetworkClientId, {
+        networkStatus,
+        isEIP1559Compatible,
+    });
     if (isInfura) {
         if (networkStatus === constants_1.NetworkStatus.Available) {
             this.messenger.publish('NetworkController:infuraIsUnblocked');
@@ -1219,7 +1240,7 @@ async function _NetworkController_lookupSelectedNetwork() {
         // previously connected to an Infura network that was blocked
         this.messenger.publish('NetworkController:infuraIsUnblocked');
     }
-}, _NetworkController_updateMetadataForNetwork = function _NetworkController_updateMetadataForNetwork(networkClientId, networkStatus, isEIP1559Compatible) {
+}, _NetworkController_updateMetadataForNetwork = function _NetworkController_updateMetadataForNetwork(networkClientId, metadata) {
     this.update((state) => {
         if (state.networksMetadata[networkClientId] === undefined) {
             state.networksMetadata[networkClientId] = {
@@ -1227,13 +1248,15 @@ async function _NetworkController_lookupSelectedNetwork() {
                 EIPS: {},
             };
         }
-        const meta = state.networksMetadata[networkClientId];
-        meta.status = networkStatus;
-        if (isEIP1559Compatible === undefined) {
-            delete meta.EIPS[1559];
-        }
-        else {
-            meta.EIPS[1559] = isEIP1559Compatible;
+        const newMetadata = state.networksMetadata[networkClientId];
+        newMetadata.status = metadata.networkStatus;
+        if ('isEIP1559Compatible' in metadata) {
+            if (metadata.isEIP1559Compatible === undefined) {
+                delete newMetadata.EIPS[1559];
+            }
+            else {
+                newMetadata.EIPS[1559] = metadata.isEIP1559Compatible;
+            }
         }
     });
 }, _NetworkController_getLatestBlock = function _NetworkController_getLatestBlock(networkClientId) {
@@ -1399,6 +1422,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
     for (const addedRpcEndpoint of addedRpcEndpoints) {
         if (addedRpcEndpoint.type === RpcEndpointType.Infura) {
             autoManagedNetworkClientRegistry[types_1.NetworkClientType.Infura][addedRpcEndpoint.networkClientId] = (0, create_auto_managed_network_client_1.createAutoManagedNetworkClient)({
+                networkClientId: addedRpcEndpoint.networkClientId,
                 networkClientConfiguration: {
                     type: types_1.NetworkClientType.Infura,
                     chainId: networkFields.chainId,
@@ -1416,6 +1440,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         }
         else {
             autoManagedNetworkClientRegistry[types_1.NetworkClientType.Custom][addedRpcEndpoint.networkClientId] = (0, create_auto_managed_network_client_1.createAutoManagedNetworkClient)({
+                networkClientId: addedRpcEndpoint.networkClientId,
                 networkClientConfiguration: {
                     type: types_1.NetworkClientType.Custom,
                     chainId: networkFields.chainId,
@@ -1475,6 +1500,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
                 return [
                     rpcEndpoint.networkClientId,
                     (0, create_auto_managed_network_client_1.createAutoManagedNetworkClient)({
+                        networkClientId: rpcEndpoint.networkClientId,
                         networkClientConfiguration: {
                             type: types_1.NetworkClientType.Infura,
                             network: infuraNetworkName,
@@ -1494,6 +1520,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
             return [
                 rpcEndpoint.networkClientId,
                 (0, create_auto_managed_network_client_1.createAutoManagedNetworkClient)({
+                    networkClientId: rpcEndpoint.networkClientId,
                     networkClientConfiguration: {
                         type: types_1.NetworkClientType.Custom,
                         chainId: networkConfiguration.chainId,