@metamask-previews/network-controller 26.0.0-preview-81c9cf83 → 26.0.0-preview-d6fe4594

package/CHANGELOG.md

@@ -7,8 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### 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)

package/dist/NetworkController.cjs

@@ -1399,6 +1399,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 +1417,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 +1477,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 +1497,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,