@metamask-previews/network-controller 23.2.0-preview-7f6d081 → 23.2.0-preview-772debef

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -10,14 +10,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
10
10
  ### Added
11
11
 
12
12
  - Add optional `getBlockTrackerOptions` argument to NetworkController constructor ([#5702](https://github.com/MetaMask/core/pull/5702))
13
- - Add optional `rpcFailoverEnabled` option to NetworkController constructor (`false` by default) ([#5668](https://github.com/MetaMask/core/pull/5668))
14
- - Add `enableRpcFailover` and `disableRpcFailover` methods to NetworkController ([#5668](https://github.com/MetaMask/core/pull/5668))
15
-
16
- ### Changed
17
-
18
- - Disable the RPC failover behavior by default ([#5668](https://github.com/MetaMask/core/pull/5668))
19
- - You are free to set the `failoverUrls` property on an RPC endpoint, but it won't have any effect
20
- - To enable this behavior, either pass `rpcFailoverEnabled: true` to the constructor or call `enableRpcFailover` after initialization
21
13
 
22
14
  ## [23.2.0]
23
15
 
@@ -36,7 +36,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
36
36
  var __importDefault = (this && this.__importDefault) || function (mod) {
37
37
  return (mod && mod.__esModule) ? mod : { "default": mod };
38
38
  };
39
- var _NetworkController_instances, _NetworkController_ethQuery, _NetworkController_infuraProjectId, _NetworkController_previouslySelectedNetworkClientId, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_autoManagedNetworkClientRegistry, _NetworkController_autoManagedNetworkClient, _NetworkController_log, _NetworkController_getRpcServiceOptions, _NetworkController_getBlockTrackerOptions, _NetworkController_networkConfigurationsByNetworkClientId, _NetworkController_isRpcFailoverEnabled, _NetworkController_updateRpcFailoverEnabled, _NetworkController_refreshNetwork, _NetworkController_getLatestBlock, _NetworkController_determineEIP1559Compatibility, _NetworkController_validateNetworkFields, _NetworkController_determineNetworkConfigurationToPersist, _NetworkController_registerNetworkClientsAsNeeded, _NetworkController_unregisterNetworkClientsAsNeeded, _NetworkController_updateNetworkConfigurations, _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated, _NetworkController_createAutoManagedNetworkClientRegistry, _NetworkController_applyNetworkSelection;
39
+ var _NetworkController_instances, _NetworkController_ethQuery, _NetworkController_infuraProjectId, _NetworkController_previouslySelectedNetworkClientId, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_autoManagedNetworkClientRegistry, _NetworkController_autoManagedNetworkClient, _NetworkController_log, _NetworkController_getRpcServiceOptions, _NetworkController_getBlockTrackerOptions, _NetworkController_networkConfigurationsByNetworkClientId, _NetworkController_refreshNetwork, _NetworkController_getLatestBlock, _NetworkController_determineEIP1559Compatibility, _NetworkController_validateNetworkFields, _NetworkController_determineNetworkConfigurationToPersist, _NetworkController_registerNetworkClientsAsNeeded, _NetworkController_unregisterNetworkClientsAsNeeded, _NetworkController_updateNetworkConfigurations, _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated, _NetworkController_createAutoManagedNetworkClientRegistry, _NetworkController_applyNetworkSelection;
40
40
  Object.defineProperty(exports, "__esModule", { value: true });
41
41
  exports.NetworkController = exports.selectAvailableNetworkClientIds = exports.getAvailableNetworkClientIds = exports.selectNetworkConfigurations = exports.getNetworkConfigurations = exports.getDefaultNetworkControllerState = exports.knownKeysOf = exports.RpcEndpointType = void 0;
42
42
  const base_controller_1 = require("@metamask/base-controller");
@@ -342,7 +342,7 @@ class NetworkController extends base_controller_1.BaseController {
342
342
  * @param options - The options; see {@link NetworkControllerOptions}.
343
343
  */
344
344
  constructor(options) {
345
- const { messenger, state, infuraProjectId, log, getRpcServiceOptions, getBlockTrackerOptions, additionalDefaultNetworks, isRpcFailoverEnabled = false, } = options;
345
+ const { messenger, state, infuraProjectId, log, getRpcServiceOptions, getBlockTrackerOptions, additionalDefaultNetworks, } = options;
346
346
  const initialState = {
347
347
  ...getDefaultNetworkControllerState(additionalDefaultNetworks),
348
348
  ...state,
@@ -382,12 +382,10 @@ class NetworkController extends base_controller_1.BaseController {
382
382
  _NetworkController_getRpcServiceOptions.set(this, void 0);
383
383
  _NetworkController_getBlockTrackerOptions.set(this, void 0);
384
384
  _NetworkController_networkConfigurationsByNetworkClientId.set(this, void 0);
385
- _NetworkController_isRpcFailoverEnabled.set(this, void 0);
386
385
  __classPrivateFieldSet(this, _NetworkController_infuraProjectId, infuraProjectId, "f");
387
386
  __classPrivateFieldSet(this, _NetworkController_log, log, "f");
388
387
  __classPrivateFieldSet(this, _NetworkController_getRpcServiceOptions, getRpcServiceOptions, "f");
389
388
  __classPrivateFieldSet(this, _NetworkController_getBlockTrackerOptions, getBlockTrackerOptions, "f");
390
- __classPrivateFieldSet(this, _NetworkController_isRpcFailoverEnabled, isRpcFailoverEnabled, "f");
391
389
  __classPrivateFieldSet(this, _NetworkController_previouslySelectedNetworkClientId, this.state.selectedNetworkClientId, "f");
392
390
  __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
393
391
  this.messagingSystem.registerActionHandler(
@@ -439,22 +437,6 @@ class NetworkController extends base_controller_1.BaseController {
439
437
  // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
440
438
  `${this.name}:updateNetwork`, this.updateNetwork.bind(this));
441
439
  }
442
- /**
443
- * Enables the RPC failover functionality. That is, if any RPC endpoints are
444
- * configured with failover URLs, then traffic will automatically be diverted
445
- * to them if those RPC endpoints are unavailable.
446
- */
447
- enableRpcFailover() {
448
- __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateRpcFailoverEnabled).call(this, true);
449
- }
450
- /**
451
- * Disables the RPC failover functionality. That is, even if any RPC endpoints
452
- * are configured with failover URLs, then traffic will not automatically be
453
- * diverted to them if those RPC endpoints are unavailable.
454
- */
455
- disableRpcFailover() {
456
- __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_updateRpcFailoverEnabled).call(this, false);
457
- }
458
440
  /**
459
441
  * Accesses the provider and block tracker for the currently selected network.
460
442
  * @returns The proxy and block tracker proxies.
@@ -1195,25 +1177,7 @@ class NetworkController extends base_controller_1.BaseController {
1195
1177
  }
1196
1178
  }
1197
1179
  exports.NetworkController = NetworkController;
1198
- _NetworkController_ethQuery = new WeakMap(), _NetworkController_infuraProjectId = new WeakMap(), _NetworkController_previouslySelectedNetworkClientId = new WeakMap(), _NetworkController_providerProxy = new WeakMap(), _NetworkController_blockTrackerProxy = new WeakMap(), _NetworkController_autoManagedNetworkClientRegistry = new WeakMap(), _NetworkController_autoManagedNetworkClient = new WeakMap(), _NetworkController_log = new WeakMap(), _NetworkController_getRpcServiceOptions = new WeakMap(), _NetworkController_getBlockTrackerOptions = new WeakMap(), _NetworkController_networkConfigurationsByNetworkClientId = new WeakMap(), _NetworkController_isRpcFailoverEnabled = new WeakMap(), _NetworkController_instances = new WeakSet(), _NetworkController_updateRpcFailoverEnabled = function _NetworkController_updateRpcFailoverEnabled(newIsRpcFailoverEnabled) {
1199
- if (__classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f") === newIsRpcFailoverEnabled) {
1200
- return;
1201
- }
1202
- const autoManagedNetworkClientRegistry = __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated).call(this);
1203
- for (const networkClientsById of Object.values(autoManagedNetworkClientRegistry)) {
1204
- for (const networkClientId of Object.keys(networkClientsById)) {
1205
- // Type assertion: We can assume that `networkClientId` is valid here.
1206
- const networkClient = networkClientsById[networkClientId];
1207
- if (networkClient.configuration.failoverRpcUrls &&
1208
- networkClient.configuration.failoverRpcUrls.length > 0) {
1209
- newIsRpcFailoverEnabled
1210
- ? networkClient.enableRpcFailover()
1211
- : networkClient.disableRpcFailover();
1212
- }
1213
- }
1214
- }
1215
- __classPrivateFieldSet(this, _NetworkController_isRpcFailoverEnabled, newIsRpcFailoverEnabled, "f");
1216
- }, _NetworkController_refreshNetwork =
1180
+ _NetworkController_ethQuery = new WeakMap(), _NetworkController_infuraProjectId = new WeakMap(), _NetworkController_previouslySelectedNetworkClientId = new WeakMap(), _NetworkController_providerProxy = new WeakMap(), _NetworkController_blockTrackerProxy = new WeakMap(), _NetworkController_autoManagedNetworkClientRegistry = new WeakMap(), _NetworkController_autoManagedNetworkClient = new WeakMap(), _NetworkController_log = new WeakMap(), _NetworkController_getRpcServiceOptions = new WeakMap(), _NetworkController_getBlockTrackerOptions = new WeakMap(), _NetworkController_networkConfigurationsByNetworkClientId = new WeakMap(), _NetworkController_instances = new WeakSet(), _NetworkController_refreshNetwork =
1217
1181
  /**
1218
1182
  * Executes a series of steps to switch the network:
1219
1183
  *
@@ -1434,7 +1398,6 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
1434
1398
  getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
1435
1399
  getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
1436
1400
  messenger: this.messagingSystem,
1437
- isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
1438
1401
  });
1439
1402
  }
1440
1403
  else {
@@ -1449,7 +1412,6 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
1449
1412
  getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
1450
1413
  getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
1451
1414
  messenger: this.messagingSystem,
1452
- isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
1453
1415
  });
1454
1416
  }
1455
1417
  }
@@ -1508,7 +1470,6 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
1508
1470
  getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
1509
1471
  getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
1510
1472
  messenger: this.messagingSystem,
1511
- isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
1512
1473
  }),
1513
1474
  ];
1514
1475
  }
@@ -1525,7 +1486,6 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
1525
1486
  getRpcServiceOptions: __classPrivateFieldGet(this, _NetworkController_getRpcServiceOptions, "f"),
1526
1487
  getBlockTrackerOptions: __classPrivateFieldGet(this, _NetworkController_getBlockTrackerOptions, "f"),
1527
1488
  messenger: this.messagingSystem,
1528
- isRpcFailoverEnabled: __classPrivateFieldGet(this, _NetworkController_isRpcFailoverEnabled, "f"),
1529
1489
  }),
1530
1490
  ];
1531
1491
  });