@metamask-previews/network-controller 22.0.2-preview-f4bb6719 → 22.0.2-preview-50bb1e2c

package/dist/NetworkController.cjs

@@ -36,7 +36,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _NetworkController_instances, _NetworkController_ethQuery, _NetworkController_infuraProjectId, _NetworkController_previouslySelectedNetworkClientId, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_autoManagedNetworkClientRegistry, _NetworkController_autoManagedNetworkClient, _NetworkController_log, _NetworkController_networkConfigurationsByNetworkClientId, _NetworkController_refreshNetwork, _NetworkController_getLatestBlock, _NetworkController_determineEIP1559Compatibility, _NetworkController_validateNetworkFields, _NetworkController_determineNetworkConfigurationToPersist, _NetworkController_registerNetworkClientsAsNeeded, _NetworkController_unregisterNetworkClientsAsNeeded, _NetworkController_updateNetworkConfigurations, _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated, _NetworkController_createAutoManagedNetworkClientRegistry, _NetworkController_applyNetworkSelection;
+var _NetworkController_instances, _NetworkController_ethQuery, _NetworkController_infuraProjectId, _NetworkController_previouslySelectedNetworkClientId, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_autoManagedNetworkClientRegistry, _NetworkController_autoManagedNetworkClient, _NetworkController_log, _NetworkController_networkConfigurationsByNetworkClientId, _NetworkController_refreshNetwork, _NetworkController_getLatestBlock, _NetworkController_determineEIP1559Compatibility, _NetworkController_dangerouslySetNetworkConfiguration, _NetworkController_validateNetworkFields, _NetworkController_determineNetworkConfigurationToPersist, _NetworkController_registerNetworkClientsAsNeeded, _NetworkController_unregisterNetworkClientsAsNeeded, _NetworkController_updateNetworkConfigurations, _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated, _NetworkController_createAutoManagedNetworkClientRegistry, _NetworkController_applyNetworkSelection;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NetworkController = exports.selectAvailableNetworkClientIds = exports.getAvailableNetworkClientIds = exports.getNetworkConfigurations = exports.getDefaultNetworkControllerState = exports.knownKeysOf = exports.RpcEndpointType = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -336,6 +336,18 @@ class NetworkController extends base_controller_1.BaseController {
         // 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(
+        // 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(
+        // 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}:dangerouslySetNetworkConfiguration`, __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_dangerouslySetNetworkConfiguration).bind(this));
     }
     /**
      * Accesses the provider and block tracker for the currently selected network.
@@ -708,7 +720,7 @@ class NetworkController extends base_controller_1.BaseController {
             const rpcEndpoint = defaultOrCustomRpcEndpointFields.type === RpcEndpointType.Custom
                 ? {
                     ...defaultOrCustomRpcEndpointFields,
-                    networkClientId: (0, uuid_1.v4)(),
+                    networkClientId: defaultOrCustomRpcEndpointFields.networkClientId ?? (0, uuid_1.v4)(),
                 }
                 : defaultOrCustomRpcEndpointFields;
             return {
@@ -987,6 +999,7 @@ class NetworkController extends base_controller_1.BaseController {
             });
         });
         __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
+        this.messagingSystem.publish('NetworkController:networkRemoved', existingNetworkConfiguration);
     }
     /**
      * Assuming that the network has been previously switched, switches to this
@@ -1094,6 +1107,97 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         return undefined;
     }
     return latestBlock.baseFeePerGas !== undefined;
+}, _NetworkController_dangerouslySetNetworkConfiguration = 
+/**
+ * This is used to override an existing network configuration.
+ * This is only meant for internal use only and not to be exposed via the UI.
+ * It is used as part of "Network Syncing", to sync networks, RPCs and block explorers cross devices.
+ *
+ * This will subsequently update the network client registry; state.networksMetadata, and state.selectedNetworkClientId
+ * @param networkConfiguration - the network configuration to override
+ */
+async function _NetworkController_dangerouslySetNetworkConfiguration(networkConfiguration) {
+    const prevNetworkConfig = networkConfiguration.chainId in this.state.networkConfigurationsByChainId
+        ? this.state.networkConfigurationsByChainId[networkConfiguration.chainId]
+        : undefined;
+    if (!prevNetworkConfig) {
+        // We only want to perform overrides, not add new network configurations
+        return;
+    }
+    // Update Registry (remove old and add new)
+    const updateRegistry = () => {
+        // Unregister old networks we want to override
+        const autoManagedNetworkClientRegistry = __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated).call(this);
+        const networkClientRemoveOperations = prevNetworkConfig.rpcEndpoints.map((rpcEndpoint) => {
+            return {
+                type: 'remove',
+                rpcEndpoint,
+            };
+        });
+        __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_unregisterNetworkClientsAsNeeded).call(this, {
+            networkClientOperations: networkClientRemoveOperations,
+            autoManagedNetworkClientRegistry,
+        });
+        // Register new networks we want to override
+        const networkClientAddOperations = networkConfiguration.rpcEndpoints.map((rpcEndpoint) => {
+            return {
+                type: 'add',
+                rpcEndpoint,
+            };
+        });
+        __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_registerNetworkClientsAsNeeded).call(this, {
+            networkFields: networkConfiguration,
+            networkClientOperations: networkClientAddOperations,
+            autoManagedNetworkClientRegistry,
+        });
+    };
+    // Replace the networkConfiguration with our new networkConfiguration
+    // This is a full replace (no merging)
+    const replaceNetworkConfiguration = () => {
+        // Update State
+        this.update((state) => {
+            state.networkConfigurationsByChainId[networkConfiguration.chainId] =
+                networkConfiguration;
+        });
+        // Update Cache
+        __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
+    };
+    // Updates the NetworksMetadata State
+    const updateNetworksMetadata = async () => {
+        // Remove old metadata state
+        this.update((state) => {
+            prevNetworkConfig.rpcEndpoints.forEach((r) => {
+                if (state.networksMetadata?.[r.networkClientId]) {
+                    delete state.networksMetadata[r.networkClientId];
+                }
+            });
+        });
+        // Add new metadata state
+        for (const r of networkConfiguration.rpcEndpoints) {
+            await this.lookupNetwork(r.networkClientId);
+        }
+    };
+    // Update selectedNetworkId State
+    // Will try to keep the same OR will select a new RPC from new network OR any network (edge case)
+    const updateSelectedNetworkId = async () => {
+        const selectedClientId = this.state.selectedNetworkClientId;
+        const wasClientIdReplaced = prevNetworkConfig.rpcEndpoints.some((r) => r.networkClientId === selectedClientId);
+        const doesExistInNewNetwork = networkConfiguration.rpcEndpoints.some((r) => r.networkClientId === selectedClientId);
+        const shouldUpdateSelectedNetworkId = wasClientIdReplaced && !doesExistInNewNetwork;
+        if (shouldUpdateSelectedNetworkId) {
+            // Update the clientId to "something" that exists
+            const newRPCClientId = networkConfiguration.rpcEndpoints.find((r) => r.networkClientId in this.state.networksMetadata)?.networkClientId;
+            const anyRPCClientId = Object.keys(this.state.networksMetadata)[0];
+            /* istanbul ignore next: anyRPCClientId and selectedClientId are fallbacks and should be impossible to reach  */
+            const newlySelectedNetwork = newRPCClientId ?? anyRPCClientId ?? selectedClientId;
+            await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_refreshNetwork).call(this, newlySelectedNetwork);
+        }
+    };
+    // Execute Set Network Config
+    updateRegistry();
+    replaceNetworkConfiguration();
+    await updateNetworksMetadata();
+    await updateSelectedNetworkId();
 }, _NetworkController_validateNetworkFields = function _NetworkController_validateNetworkFields(args) {
     const { mode, networkFields, autoManagedNetworkClientRegistry } = args;
     const existingNetworkConfiguration = 'existingNetworkConfiguration' in args
@@ -1280,6 +1384,9 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         delete state.networkConfigurationsByChainId[args.existingNetworkConfiguration.chainId];
     }
     if (mode === 'add' || mode === 'update') {
+        if (JSON.stringify(state.networkConfigurationsByChainId[args.networkFields.chainId]) !== JSON.stringify(args.networkConfigurationToPersist)) {
+            args.networkConfigurationToPersist.lastUpdatedAt = Date.now();
+        }
         state.networkConfigurationsByChainId[args.networkFields.chainId] =
             args.networkConfigurationToPersist;
     }