@metamask-previews/network-controller 22.0.1-preview-3f52b814 → 22.0.1-preview-c10c8117

package/dist/NetworkController.cjs

@@ -52,6 +52,7 @@ const util_1 = require("util");
 const uuid_1 = require("uuid");
 const constants_1 = require("./constants.cjs");
 const create_auto_managed_network_client_1 = require("./create-auto-managed-network-client.cjs");
+const last_updated_at_network_configuration_1 = require("./last-updated-at-network-configuration.cjs");
 const logger_1 = require("./logger.cjs");
 const types_1 = require("./types.cjs");
 const debugLog = (0, logger_1.createModuleLogger)(logger_1.projectLogger, 'NetworkController');
@@ -336,6 +337,19 @@ 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}:updateNetwork`, this.updateNetwork.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(`${this.name}:dangerouslySetNetworkConfiguration`, this.dangerouslySetNetworkConfiguration.bind(this));
     }
     /**
      * Accesses the provider and block tracker for the currently selected network.
@@ -708,7 +722,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 {
@@ -949,6 +963,7 @@ class NetworkController extends base_controller_1.BaseController {
             networkClientOperations,
             autoManagedNetworkClientRegistry,
         });
+        this.messagingSystem.publish('NetworkController:networkUpdated', updatedNetworkConfiguration);
         return updatedNetworkConfiguration;
     }
     /**
@@ -987,6 +1002,79 @@ class NetworkController extends base_controller_1.BaseController {
             });
         });
         __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
+        this.messagingSystem.publish('NetworkController:networkRemoved', existingNetworkConfiguration);
+    }
+    /**
+     * 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 dangerouslySetNetworkConfiguration(networkConfiguration) {
+        const prevNetworkConfig = networkConfiguration.chainId in this.state.networkConfigurationsByChainId
+            ? this.state.networkConfigurationsByChainId[networkConfiguration.chainId]
+            : undefined;
+        // Update Registry (remove old and add new)
+        const autoManagedNetworkClientRegistry = __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_ensureAutoManagedNetworkClientRegistryPopulated).call(this);
+        if (prevNetworkConfig) {
+            const networkClientOperations = prevNetworkConfig.rpcEndpoints.map((rpcEndpoint) => {
+                return {
+                    type: 'remove',
+                    rpcEndpoint,
+                };
+            });
+            __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_unregisterNetworkClientsAsNeeded).call(this, {
+                networkClientOperations,
+                autoManagedNetworkClientRegistry,
+            });
+        }
+        const networkClientOperations = networkConfiguration.rpcEndpoints.map((rpcEndpoint) => {
+            return {
+                type: 'add',
+                rpcEndpoint,
+            };
+        });
+        __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_registerNetworkClientsAsNeeded).call(this, {
+            networkFields: networkConfiguration,
+            networkClientOperations,
+            autoManagedNetworkClientRegistry,
+        });
+        // update new `networkConfigurationsByChainId` (full replace)
+        this.update((state) => {
+            state.networkConfigurationsByChainId[networkConfiguration.chainId] =
+                networkConfiguration;
+        });
+        __classPrivateFieldSet(this, _NetworkController_networkConfigurationsByNetworkClientId, buildNetworkConfigurationsByNetworkClientId(this.state.networkConfigurationsByChainId), "f");
+        // update `networksMetadata` remove old
+        if (prevNetworkConfig) {
+            this.update((state) => {
+                const newNetworksMetadata = {
+                    ...state.networksMetadata,
+                };
+                prevNetworkConfig.rpcEndpoints.forEach((rpcEndpoint) => {
+                    delete newNetworksMetadata[rpcEndpoint.networkClientId];
+                });
+            });
+        }
+        // update `networksMetadata` update new
+        for (const rpcEndpoint of networkConfiguration.rpcEndpoints) {
+            await this.lookupNetwork(rpcEndpoint.networkClientId);
+        }
+        // update selectedNetworkId
+        const selectedClientId = this.state.selectedNetworkClientId;
+        const wasReplacedClientId = prevNetworkConfig?.rpcEndpoints.some((r) => r.networkClientId === selectedClientId);
+        const isValidClientIdInNewNetworks = networkConfiguration.rpcEndpoints.some((r) => r.networkClientId === selectedClientId);
+        if (wasReplacedClientId) {
+            if (!isValidClientIdInNewNetworks) {
+                // Update clientId to something that exists
+                const newSelectedNetworkMetadata = networkConfiguration.rpcEndpoints.find((r) => r.networkClientId in this.state.networksMetadata)?.networkClientId;
+                const anyClientId = Object.keys(this.state.networksMetadata)[0];
+                const newlySelectedNetwork = newSelectedNetworkMetadata ?? anyClientId ?? selectedClientId;
+                await __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_refreshNetwork).call(this, newlySelectedNetwork);
+            }
+        }
     }
     /**
      * Assuming that the network has been previously switched, switches to this
@@ -1280,6 +1368,7 @@ async function _NetworkController_determineEIP1559Compatibility(networkClientId)
         delete state.networkConfigurationsByChainId[args.existingNetworkConfiguration.chainId];
     }
     if (mode === 'add' || mode === 'update') {
+        (0, last_updated_at_network_configuration_1.lastUpdatedNetworkConfiguration)(args.networkConfigurationToPersist);
         state.networkConfigurationsByChainId[args.networkFields.chainId] =
             args.networkConfigurationToPersist;
     }