@metamask/network-controller 5.0.0 → 7.0.0

package/CHANGELOG.md

@@ -6,6 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.0.0]
+### Changed
+- **BREAKING:** Replace `providerConfig` setter with a public `initializeProvider` method ([#1133](https://github.com/MetaMask/core/pull/1133))
+  - The property `providerConfig` should no longer be set to initialize the provider. That property no longer exists.
+  - The method `initializeProvider` must be called instead to initialize the provider after constructing the network controller.
+
+## [6.0.0]
+### Added
+- Add rollbackToPreviousProvider method ([#1132](https://github.com/MetaMask/core/pull/1132))
+
+### Changed
+- **BREAKING:** Migrate network configurations from `PreferencesController` to `NetworkController` ([#1064](https://github.com/MetaMask/core/pull/1064))
+  - Consumers will need to adapt to reading network data from `NetworkConfigurations` state on `NetworkController` rather than `frequentRpcList` on `PreferencesController`.
+  - `setRpcTarget` becomes `setActiveNetwork` on `NetworkController` and accepts a `networkConfigurationId` argument rather than an `rpcUrl`.
+  - `addToFrequentRpcList` on `PreferencesController` becomes `upsertNetworkConfiguration` on `NetworkController`.
+  - `removeFromFrequentRpcList` on `PreferencesController` becomes `removeNetworkConfiguration` on `NetworkController`
+  - The `NetworkController` requires a `trackMetaMetricsEvent` callback function argument in its constructor.
+- **BREAKING:** Expose `getProviderAndBlockTracker` instead of `provider` ([#1091](https://github.com/MetaMask/core/pull/1091))
+  - This change is breaking because it removes the provider property from `NetworkController`. Instead, a new method `getProviderAndBlockTracker` method is available for accessing the current provider object.
+
 ## [5.0.0]
 ### Changed
 - **BREAKING:** Rename `properties` property in state object to `networkDetails` ([#1074](https://github.com/MetaMask/controllers/pull/1074))
@@ -50,7 +70,9 @@ 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@5.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@7.0.0...HEAD
+[7.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@6.0.0...@metamask/network-controller@7.0.0
+[6.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@5.0.0...@metamask/network-controller@6.0.0
 [5.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@4.0.0...@metamask/network-controller@5.0.0
 [4.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@3.0.0...@metamask/network-controller@4.0.0
 [3.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@2.0.0...@metamask/network-controller@3.0.0

package/dist/NetworkController.d.ts

@@ -1,3 +1,4 @@
+import type { SwappableProxy } from '@metamask/swappable-obj-proxy';
 import type { Patch } from 'immer';
 import { BaseControllerV2, RestrictedControllerMessenger } from '@metamask/base-controller';
 import { NetworkType } from '@metamask/controller-utils';
@@ -10,6 +11,7 @@ import { NetworkType } from '@metamask/controller-utils';
  * @property chainId - Network ID as per EIP-155.
  * @property ticker - Currency ticker.
  * @property nickname - Personalized network name.
+ * @property id - Network Configuration Id.
  */
 export declare type ProviderConfig = {
     rpcTarget?: string;
@@ -17,6 +19,10 @@ export declare type ProviderConfig = {
     chainId: string;
     ticker?: string;
     nickname?: string;
+    rpcPrefs?: {
+        blockExplorerUrl?: string;
+    };
+    id?: NetworkConfigurationId;
 };
 export declare type Block = {
     baseFeePerGas?: string;
@@ -24,22 +30,48 @@ export declare type Block = {
 export declare type NetworkDetails = {
     isEIP1559Compatible?: boolean;
 };
+/**
+ * Custom RPC network information
+ *
+ * @property rpcTarget - RPC target URL.
+ * @property chainId - Network ID as per EIP-155
+ * @property nickname - Personalized network name.
+ * @property ticker - Currency ticker.
+ * @property rpcPrefs - Personalized preferences.
+ */
+export declare type NetworkConfiguration = {
+    rpcUrl: string;
+    chainId: string;
+    ticker: string;
+    nickname?: string;
+    rpcPrefs?: {
+        blockExplorerUrl: string;
+    };
+};
 /**
  * @type NetworkState
  *
  * Network controller state
- * @property network - Network ID as per net_version
- * @property isCustomNetwork - Identifies if the network is a custom network
- * @property provider - RPC URL and network name provider settings
+ * @property network - Network ID as per net_version of the currently connected network
+ * @property isCustomNetwork - Identifies if the currently connected network is a custom network
+ * @property providerConfig - RPC URL and network name provider settings of the currently connected network
+ * @property properties - an additional set of network properties for the currently connected network
+ * @property networkConfigurations - the full list of configured networks either preloaded or added by the user.
  */
 export declare type NetworkState = {
     network: string;
     isCustomNetwork: boolean;
     providerConfig: ProviderConfig;
     networkDetails: NetworkDetails;
+    networkConfigurations: Record<string, NetworkConfiguration & {
+        id: string;
+    }>;
 };
 declare const name = "NetworkController";
 export declare type EthQuery = any;
+declare type Provider = any;
+export declare type ProviderProxy = SwappableProxy<Provider>;
+declare type BlockTracker = any;
 export declare type NetworkControllerStateChangeEvent = {
     type: `NetworkController:stateChange`;
     payload: [NetworkState, Patch[]];
@@ -61,21 +93,27 @@ export declare type NetworkControllerActions = NetworkControllerGetProviderConfi
 export declare type NetworkControllerMessenger = RestrictedControllerMessenger<typeof name, NetworkControllerGetProviderConfigAction | NetworkControllerGetEthQueryAction, NetworkControllerStateChangeEvent | NetworkControllerProviderConfigChangeEvent, string, string>;
 export declare type NetworkControllerOptions = {
     messenger: NetworkControllerMessenger;
+    trackMetaMetricsEvent: () => void;
     infuraProjectId?: string;
     state?: Partial<NetworkState>;
 };
 export declare const defaultState: NetworkState;
+declare type NetworkConfigurationId = string;
 /**
  * Controller that creates and manages an Ethereum network provider.
  */
 export declare class NetworkController extends BaseControllerV2<typeof name, NetworkState, NetworkControllerMessenger> {
     #private;
     private ethQuery;
-    private internalProviderConfig;
     private infuraProjectId;
+    private trackMetaMetricsEvent;
     private mutex;
-    constructor({ messenger, state, infuraProjectId }: NetworkControllerOptions);
-    private initializeProvider;
+    constructor({ messenger, state, infuraProjectId, trackMetaMetricsEvent, }: NetworkControllerOptions);
+    private configureProvider;
+    getProviderAndBlockTracker(): {
+        provider: SwappableProxy<Provider> | undefined;
+        blockTracker: SwappableProxy<BlockTracker> | undefined;
+    };
     private refreshNetwork;
     private registerProvider;
     private setupInfuraProvider;
@@ -85,18 +123,12 @@ export declare class NetworkController extends BaseControllerV2<typeof name, Net
     private safelyStopProvider;
     private verifyNetwork;
     /**
-     * Ethereum provider object for the current network
-     */
-    provider: any;
-    /**
-     * Sets a new configuration for web3-provider-engine.
-     *
-     * TODO: Replace this wth a method.
+     * Method to inilialize the provider,
+     * Creates the provider and block tracker for the configured network,
+     * using the provider to gather details about the network.
      *
-     * @param providerConfig - The web3-provider-engine configuration.
      */
-    set providerConfig(providerConfig: ProviderConfig);
-    get providerConfig(): ProviderConfig;
+    initializeProvider(): void;
     /**
      * Refreshes the current network code.
      */
@@ -110,12 +142,41 @@ export declare class NetworkController extends BaseControllerV2<typeof name, Net
     /**
      * Convenience method to update provider RPC settings.
      *
-     * @param rpcTarget - The RPC endpoint URL.
-     * @param chainId - The chain ID as per EIP-155.
-     * @param ticker - The currency ticker.
-     * @param nickname - Personalized network name.
+     * @param networkConfigurationId - The unique id for the network configuration to set as the active provider.
      */
-    setRpcTarget(rpcTarget: string, chainId: string, ticker?: string, nickname?: string): void;
+    setActiveNetwork(networkConfigurationId: string): void;
     getEIP1559Compatibility(): Promise<boolean>;
+    /**
+     * Adds a network configuration if the rpcUrl is not already present on an
+     * existing network configuration. Otherwise updates the entry with the matching rpcUrl.
+     *
+     * @param networkConfiguration - The network configuration to add or, if rpcUrl matches an existing entry, to modify.
+     * @param networkConfiguration.rpcUrl -  RPC provider url.
+     * @param networkConfiguration.chainId - Network ID as per EIP-155.
+     * @param networkConfiguration.ticker - Currency ticker.
+     * @param networkConfiguration.nickname - Personalized network name.
+     * @param networkConfiguration.rpcPrefs - Personalized preferences (i.e. preferred blockExplorer)
+     * @param options - additional configuration options.
+     * @param options.setActive - An option to set the newly added networkConfiguration as the active provider.
+     * @param options.referrer - The site from which the call originated, or 'metamask' for internal calls - used for event metrics.
+     * @param options.source - Where the upsertNetwork event originated (i.e. from a dapp or from the network form) - used for event metrics.
+     * @returns id for the added or updated network configuration
+     */
+    upsertNetworkConfiguration({ rpcUrl, chainId, ticker, nickname, rpcPrefs }: NetworkConfiguration, { setActive, referrer, source, }: {
+        setActive?: boolean;
+        referrer: string;
+        source: string;
+    }): string;
+    /**
+     * Removes network configuration from state.
+     *
+     * @param networkConfigurationId - The networkConfigurationId of an existing network configuration
+     */
+    removeNetworkConfiguration(networkConfigurationId: string): void;
+    /**
+     * Rolls back provider config to the previous provider in case of errors or inability to connect during network switch.
+     */
+    rollbackToPreviousProvider(): void;
 }
 export default NetworkController;
+//# sourceMappingURL=NetworkController.d.ts.map

package/dist/NetworkController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkController.d.ts","sourceRoot":"","sources":["../src/NetworkController.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAGpE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EACL,gBAAgB,EAChB,6BAA6B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAEL,WAAW,EAKZ,MAAM,4BAA4B,CAAC;AAIpC;;;;;;;;;;GAUG;AACH,oBAAY,cAAc,GAAG;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,EAAE,CAAC,EAAE,sBAAsB,CAAC;CAC7B,CAAC;AAEF,oBAAY,KAAK,GAAG;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF;;;;;;;;GAQG;AACH,oBAAY,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE;QACT,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH,CAAC;AAEF;;;;;;;;;GASG;AACH,oBAAY,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC9E,CAAC;AAIF,QAAA,MAAM,IAAI,sBAAsB,CAAC;AAEjC,oBAAY,QAAQ,GAAG,GAAG,CAAC;AAE3B,aAAK,QAAQ,GAAG,GAAG,CAAC;AAEpB,oBAAY,aAAa,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;AAErD,aAAK,YAAY,GAAG,GAAG,CAAC;AAIxB,oBAAY,iCAAiC,GAAG;IAC9C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,CAAC,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;CAClC,CAAC;AAEF,oBAAY,0CAA0C,GAAG;IACvD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC;CAC3B,CAAC;AAEF,oBAAY,uBAAuB,GAC/B,iCAAiC,GACjC,0CAA0C,CAAC;AAE/C,oBAAY,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,MAAM,cAAc,CAAC;CAC/B,CAAC;AAEF,oBAAY,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,MAAM,QAAQ,CAAC;CACzB,CAAC;AAEF,oBAAY,wBAAwB,GAChC,wCAAwC,GACxC,kCAAkC,CAAC;AAEvC,oBAAY,0BAA0B,GAAG,6BAA6B,CACpE,OAAO,IAAI,EACX,wCAAwC,GAAG,kCAAkC,EAC3E,iCAAiC,GACjC,0CAA0C,EAC5C,MAAM,EACN,MAAM,CACP,CAAC;AAEF,oBAAY,wBAAwB,GAAG;IACrC,SAAS,EAAE,0BAA0B,CAAC;IACtC,qBAAqB,EAAE,MAAM,IAAI,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,YAS1B,CAAC;AAeF,aAAK,sBAAsB,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB,CACrD,OAAO,IAAI,EACX,YAAY,EACZ,0BAA0B,CAC3B;;IACC,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,CAAC,eAAe,CAAqB;IAE5C,OAAO,CAAC,qBAAqB,CAA2C;IAExE,OAAO,CAAC,KAAK,CAAe;gBAUhB,EACV,SAAS,EACT,KAAK,EACL,eAAe,EACf,qBAAqB,GACtB,EAAE,wBAAwB;IA+C3B,OAAO,CAAC,iBAAiB;IA8BzB,0BAA0B,IAAI;QAC5B,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;QAC/C,YAAY,EAAE,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;KACxD;IAOD,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,mBAAmB;IAgB3B,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,qBAAqB;IAgB7B,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,aAAa;IAIrB;;;;;OAKG;IACH,kBAAkB;IAuBlB;;OAEG;IACG,aAAa;IA2CnB;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,WAAW;IAoBjC;;;;OAIG;IACH,gBAAgB,CAAC,sBAAsB,EAAE,MAAM;IAwCzC,uBAAuB;IAyC7B;;;;;;;;;;;;;;;OAeG;IACH,0BAA0B,CACxB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,oBAAoB,EACrE,EACE,SAAiB,EACjB,QAAQ,EACR,MAAM,GACP,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAC3D,MAAM;IAsFT;;;;OAIG;IACH,0BAA0B,CAAC,sBAAsB,EAAE,MAAM;IAWzD;;OAEG;IACH,0BAA0B;CAQ3B;AAED,eAAe,iBAAiB,CAAC"}

package/dist/NetworkController.js

@@ -8,6 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
@@ -16,29 +22,36 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _NetworkController_instances, _NetworkController_getNetworkId, _NetworkController_getLatestBlock;
+var _NetworkController_instances, _NetworkController_previousNetworkSpecifier, _NetworkController_provider, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_getNetworkId, _NetworkController_setCurrentAsPreviousProvider, _NetworkController_getLatestBlock, _NetworkController_setProviderAndBlockTracker;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NetworkController = exports.defaultState = void 0;
 const eth_query_1 = __importDefault(require("eth-query"));
 const provider_1 = __importDefault(require("web3-provider-engine/subproviders/provider"));
 const createProvider_1 = __importDefault(require("eth-json-rpc-infura/src/createProvider"));
 const zero_1 = __importDefault(require("web3-provider-engine/zero"));
+const swappable_obj_proxy_1 = require("@metamask/swappable-obj-proxy");
 const async_mutex_1 = require("async-mutex");
+const uuid_1 = require("uuid");
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
+const utils_1 = require("@metamask/utils");
 const LOCALHOST_RPC_URL = 'http://localhost:8545';
 const name = 'NetworkController';
 exports.defaultState = {
     network: 'loading',
     isCustomNetwork: false,
-    providerConfig: { type: controller_utils_1.MAINNET, chainId: controller_utils_1.NetworksChainId.mainnet },
+    providerConfig: {
+        type: controller_utils_1.NetworkType.mainnet,
+        chainId: controller_utils_1.NetworksChainId.mainnet,
+    },
     networkDetails: { isEIP1559Compatible: false },
+    networkConfigurations: {},
 };
 /**
  * Controller that creates and manages an Ethereum network provider.
  */
 class NetworkController extends base_controller_1.BaseControllerV2 {
-    constructor({ messenger, state, infuraProjectId }) {
+    constructor({ messenger, state, infuraProjectId, trackMetaMetricsEvent, }) {
         super({
             name,
             metadata: {
@@ -58,35 +71,44 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
                     persist: true,
                     anonymous: false,
                 },
+                networkConfigurations: {
+                    persist: true,
+                    anonymous: false,
+                },
             },
             messenger,
             state: Object.assign(Object.assign({}, exports.defaultState), state),
         });
         _NetworkController_instances.add(this);
-        this.internalProviderConfig = {};
         this.mutex = new async_mutex_1.Mutex();
+        _NetworkController_previousNetworkSpecifier.set(this, void 0);
+        _NetworkController_provider.set(this, void 0);
+        _NetworkController_providerProxy.set(this, void 0);
+        _NetworkController_blockTrackerProxy.set(this, void 0);
         this.infuraProjectId = infuraProjectId;
+        this.trackMetaMetricsEvent = trackMetaMetricsEvent;
         this.messagingSystem.registerActionHandler(`${this.name}:getProviderConfig`, () => {
             return this.state.providerConfig;
         });
         this.messagingSystem.registerActionHandler(`${this.name}:getEthQuery`, () => {
             return this.ethQuery;
         });
+        __classPrivateFieldSet(this, _NetworkController_previousNetworkSpecifier, this.state.providerConfig.type, "f");
     }
-    initializeProvider(type, rpcTarget, chainId, ticker, nickname) {
+    configureProvider(type, rpcTarget, chainId, ticker, nickname) {
         this.update((state) => {
             state.isCustomNetwork = this.getIsCustomNetwork(chainId);
         });
         switch (type) {
-            case controller_utils_1.MAINNET:
-            case 'goerli':
-            case 'sepolia':
+            case controller_utils_1.NetworkType.mainnet:
+            case controller_utils_1.NetworkType.goerli:
+            case controller_utils_1.NetworkType.sepolia:
                 this.setupInfuraProvider(type);
                 break;
-            case 'localhost':
+            case controller_utils_1.NetworkType.localhost:
                 this.setupStandardProvider(LOCALHOST_RPC_URL);
                 break;
-            case controller_utils_1.RPC:
+            case controller_utils_1.NetworkType.rpc:
                 rpcTarget &&
                     this.setupStandardProvider(rpcTarget, chainId, ticker, nickname);
                 break;
@@ -95,18 +117,27 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
         }
         this.getEIP1559Compatibility();
     }
+    getProviderAndBlockTracker() {
+        return {
+            provider: __classPrivateFieldGet(this, _NetworkController_providerProxy, "f"),
+            blockTracker: __classPrivateFieldGet(this, _NetworkController_blockTrackerProxy, "f"),
+        };
+    }
     refreshNetwork() {
         this.update((state) => {
             state.network = 'loading';
             state.networkDetails = {};
         });
         const { rpcTarget, type, chainId, ticker } = this.state.providerConfig;
-        this.initializeProvider(type, rpcTarget, chainId, ticker);
+        this.configureProvider(type, rpcTarget, chainId, ticker);
         this.lookupNetwork();
     }
     registerProvider() {
-        this.provider.on('error', this.verifyNetwork.bind(this));
-        this.ethQuery = new eth_query_1.default(this.provider);
+        const { provider } = this.getProviderAndBlockTracker();
+        if (provider) {
+            provider.on('error', this.verifyNetwork.bind(this));
+            this.ethQuery = new eth_query_1.default(provider);
+        }
     }
     setupInfuraProvider(type) {
         const infuraProvider = (0, createProvider_1.default)({
@@ -114,13 +145,13 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
             projectId: this.infuraProjectId,
         });
         const infuraSubprovider = new provider_1.default(infuraProvider);
-        const config = Object.assign(Object.assign({}, this.internalProviderConfig), {
+        const config = {
             dataSubprovider: infuraSubprovider,
             engineParams: {
                 blockTrackerProvider: infuraProvider,
                 pollingInterval: 12000,
             },
-        });
+        };
         this.updateProvider((0, zero_1.default)(config));
     }
     getIsCustomNetwork(chainId) {
@@ -130,18 +161,21 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
             chainId !== controller_utils_1.NetworksChainId.localhost);
     }
     setupStandardProvider(rpcTarget, chainId, ticker, nickname) {
-        const config = Object.assign(Object.assign({}, this.internalProviderConfig), {
+        const config = {
             chainId,
             engineParams: { pollingInterval: 12000 },
             nickname,
             rpcUrl: rpcTarget,
             ticker,
-        });
+        };
         this.updateProvider((0, zero_1.default)(config));
     }
     updateProvider(provider) {
-        this.safelyStopProvider(this.provider);
-        this.provider = provider;
+        this.safelyStopProvider(__classPrivateFieldGet(this, _NetworkController_provider, "f"));
+        __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_setProviderAndBlockTracker).call(this, {
+            provider,
+            blockTracker: provider._blockTracker,
+        });
         this.registerProvider();
     }
     safelyStopProvider(provider) {
@@ -153,24 +187,17 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
         this.state.network === 'loading' && this.lookupNetwork();
     }
     /**
-     * Sets a new configuration for web3-provider-engine.
+     * Method to inilialize the provider,
+     * Creates the provider and block tracker for the configured network,
+     * using the provider to gather details about the network.
      *
-     * TODO: Replace this wth a method.
-     *
-     * @param providerConfig - The web3-provider-engine configuration.
      */
-    set providerConfig(providerConfig) {
-        this.internalProviderConfig = providerConfig;
+    initializeProvider() {
         const { type, rpcTarget, chainId, ticker, nickname } = this.state.providerConfig;
-        this.initializeProvider(type, rpcTarget, chainId, ticker, nickname);
-        if (this.provider !== undefined) {
-            this.registerProvider();
-        }
+        this.configureProvider(type, rpcTarget, chainId, ticker, nickname);
+        this.registerProvider();
         this.lookupNetwork();
     }
-    get providerConfig() {
-        throw new Error('Property only used for setting');
-    }
     /**
      * Refreshes the current network code.
      */
@@ -208,35 +235,41 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
      * @param type - Human readable network name.
      */
     setProviderType(type) {
+        __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_setCurrentAsPreviousProvider).call(this);
         // If testnet the ticker symbol should use a testnet prefix
-        const ticker = type in controller_utils_1.TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL &&
-            controller_utils_1.TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type].length > 0
-            ? controller_utils_1.TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type]
+        const ticker = type in controller_utils_1.NetworksTicker && controller_utils_1.NetworksTicker[type].length > 0
+            ? controller_utils_1.NetworksTicker[type]
             : 'ETH';
         this.update((state) => {
             state.providerConfig.type = type;
             state.providerConfig.ticker = ticker;
             state.providerConfig.chainId = controller_utils_1.NetworksChainId[type];
+            state.providerConfig.rpcPrefs = controller_utils_1.BUILT_IN_NETWORKS[type].rpcPrefs;
             state.providerConfig.rpcTarget = undefined;
             state.providerConfig.nickname = undefined;
+            state.providerConfig.id = undefined;
         });
         this.refreshNetwork();
     }
     /**
      * Convenience method to update provider RPC settings.
      *
-     * @param rpcTarget - The RPC endpoint URL.
-     * @param chainId - The chain ID as per EIP-155.
-     * @param ticker - The currency ticker.
-     * @param nickname - Personalized network name.
+     * @param networkConfigurationId - The unique id for the network configuration to set as the active provider.
      */
-    setRpcTarget(rpcTarget, chainId, ticker, nickname) {
+    setActiveNetwork(networkConfigurationId) {
+        __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_setCurrentAsPreviousProvider).call(this);
+        const targetNetwork = this.state.networkConfigurations[networkConfigurationId];
+        if (!targetNetwork) {
+            throw new Error(`networkConfigurationId ${networkConfigurationId} does not match a configured networkConfiguration`);
+        }
         this.update((state) => {
-            state.providerConfig.type = controller_utils_1.RPC;
-            state.providerConfig.rpcTarget = rpcTarget;
-            state.providerConfig.chainId = chainId;
-            state.providerConfig.ticker = ticker;
-            state.providerConfig.nickname = nickname;
+            state.providerConfig.type = controller_utils_1.NetworkType.rpc;
+            state.providerConfig.rpcTarget = targetNetwork.rpcUrl;
+            state.providerConfig.chainId = targetNetwork.chainId;
+            state.providerConfig.ticker = targetNetwork.ticker;
+            state.providerConfig.nickname = targetNetwork.nickname;
+            state.providerConfig.rpcPrefs = targetNetwork.rpcPrefs;
+            state.providerConfig.id = targetNetwork.id;
         });
         this.refreshNetwork();
     }
@@ -256,9 +289,106 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
             return isEIP1559Compatible;
         });
     }
+    /**
+     * Adds a network configuration if the rpcUrl is not already present on an
+     * existing network configuration. Otherwise updates the entry with the matching rpcUrl.
+     *
+     * @param networkConfiguration - The network configuration to add or, if rpcUrl matches an existing entry, to modify.
+     * @param networkConfiguration.rpcUrl -  RPC provider url.
+     * @param networkConfiguration.chainId - Network ID as per EIP-155.
+     * @param networkConfiguration.ticker - Currency ticker.
+     * @param networkConfiguration.nickname - Personalized network name.
+     * @param networkConfiguration.rpcPrefs - Personalized preferences (i.e. preferred blockExplorer)
+     * @param options - additional configuration options.
+     * @param options.setActive - An option to set the newly added networkConfiguration as the active provider.
+     * @param options.referrer - The site from which the call originated, or 'metamask' for internal calls - used for event metrics.
+     * @param options.source - Where the upsertNetwork event originated (i.e. from a dapp or from the network form) - used for event metrics.
+     * @returns id for the added or updated network configuration
+     */
+    upsertNetworkConfiguration({ rpcUrl, chainId, ticker, nickname, rpcPrefs }, { setActive = false, referrer, source, }) {
+        var _a;
+        (0, utils_1.assertIsStrictHexString)(chainId);
+        if (!(0, controller_utils_1.isSafeChainId)(parseInt(chainId, 16))) {
+            throw new Error(`Invalid chain ID "${chainId}": numerical value greater than max safe value.`);
+        }
+        if (!rpcUrl) {
+            throw new Error('An rpcUrl is required to add or update network configuration');
+        }
+        if (!referrer || !source) {
+            throw new Error('referrer and source are required arguments for adding or updating a network configuration');
+        }
+        try {
+            // eslint-disable-next-line no-new
+            new URL(rpcUrl);
+        }
+        catch (e) {
+            if (e.message.includes('Invalid URL')) {
+                throw new Error('rpcUrl must be a valid URL');
+            }
+        }
+        if (!ticker) {
+            throw new Error('A ticker is required to add or update networkConfiguration');
+        }
+        const newNetworkConfiguration = {
+            rpcUrl,
+            chainId,
+            ticker,
+            nickname,
+            rpcPrefs,
+        };
+        const oldNetworkConfigurations = this.state.networkConfigurations;
+        const oldNetworkConfigurationId = (_a = Object.values(oldNetworkConfigurations).find((networkConfiguration) => { var _a; return ((_a = networkConfiguration.rpcUrl) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === (rpcUrl === null || rpcUrl === void 0 ? void 0 : rpcUrl.toLowerCase()); })) === null || _a === void 0 ? void 0 : _a.id;
+        const newNetworkConfigurationId = oldNetworkConfigurationId || (0, uuid_1.v4)();
+        this.update((state) => {
+            state.networkConfigurations = Object.assign(Object.assign({}, oldNetworkConfigurations), { [newNetworkConfigurationId]: Object.assign(Object.assign({}, newNetworkConfiguration), { id: newNetworkConfigurationId }) });
+        });
+        if (!oldNetworkConfigurationId) {
+            this.trackMetaMetricsEvent({
+                event: 'Custom Network Added',
+                category: 'Network',
+                referrer: {
+                    url: referrer,
+                },
+                properties: {
+                    chain_id: chainId,
+                    symbol: ticker,
+                    source,
+                },
+            });
+        }
+        if (setActive) {
+            this.setActiveNetwork(newNetworkConfigurationId);
+        }
+        return newNetworkConfigurationId;
+    }
+    /**
+     * Removes network configuration from state.
+     *
+     * @param networkConfigurationId - The networkConfigurationId of an existing network configuration
+     */
+    removeNetworkConfiguration(networkConfigurationId) {
+        if (!this.state.networkConfigurations[networkConfigurationId]) {
+            throw new Error(`networkConfigurationId ${networkConfigurationId} does not match a configured networkConfiguration`);
+        }
+        this.update((state) => {
+            delete state.networkConfigurations[networkConfigurationId];
+        });
+    }
+    /**
+     * Rolls back provider config to the previous provider in case of errors or inability to connect during network switch.
+     */
+    rollbackToPreviousProvider() {
+        const specifier = __classPrivateFieldGet(this, _NetworkController_previousNetworkSpecifier, "f");
+        if ((0, controller_utils_1.isNetworkType)(specifier)) {
+            this.setProviderType(specifier);
+        }
+        else if (typeof specifier === 'string') {
+            this.setActiveNetwork(specifier);
+        }
+    }
 }
 exports.NetworkController = NetworkController;
-_NetworkController_instances = new WeakSet(), _NetworkController_getNetworkId = function _NetworkController_getNetworkId() {
+_NetworkController_previousNetworkSpecifier = new WeakMap(), _NetworkController_provider = new WeakMap(), _NetworkController_providerProxy = new WeakMap(), _NetworkController_blockTrackerProxy = new WeakMap(), _NetworkController_instances = new WeakSet(), _NetworkController_getNetworkId = function _NetworkController_getNetworkId() {
     return __awaiter(this, void 0, void 0, function* () {
         return yield new Promise((resolve, reject) => {
             this.ethQuery.sendAsync({ method: 'net_version' }, (error, result) => {
@@ -271,6 +401,14 @@ _NetworkController_instances = new WeakSet(), _NetworkController_getNetworkId =
             });
         });
     });
+}, _NetworkController_setCurrentAsPreviousProvider = function _NetworkController_setCurrentAsPreviousProvider() {
+    const { type, id } = this.state.providerConfig;
+    if (type === controller_utils_1.NetworkType.rpc && id) {
+        __classPrivateFieldSet(this, _NetworkController_previousNetworkSpecifier, id, "f");
+    }
+    else {
+        __classPrivateFieldSet(this, _NetworkController_previousNetworkSpecifier, type, "f");
+    }
 }, _NetworkController_getLatestBlock = function _NetworkController_getLatestBlock() {
     return new Promise((resolve, reject) => {
         this.ethQuery.sendAsync({ method: 'eth_getBlockByNumber', params: ['latest', false] }, (error, block) => {
@@ -282,6 +420,22 @@ _NetworkController_instances = new WeakSet(), _NetworkController_getNetworkId =
             }
         });
     });
+}, _NetworkController_setProviderAndBlockTracker = function _NetworkController_setProviderAndBlockTracker({ provider, blockTracker, }) {
+    if (__classPrivateFieldGet(this, _NetworkController_providerProxy, "f")) {
+        __classPrivateFieldGet(this, _NetworkController_providerProxy, "f").setTarget(provider);
+    }
+    else {
+        __classPrivateFieldSet(this, _NetworkController_providerProxy, (0, swappable_obj_proxy_1.createEventEmitterProxy)(provider), "f");
+    }
+    __classPrivateFieldSet(this, _NetworkController_provider, provider, "f");
+    if (__classPrivateFieldGet(this, _NetworkController_blockTrackerProxy, "f")) {
+        __classPrivateFieldGet(this, _NetworkController_blockTrackerProxy, "f").setTarget(blockTracker);
+    }
+    else {
+        __classPrivateFieldSet(this, _NetworkController_blockTrackerProxy, (0, swappable_obj_proxy_1.createEventEmitterProxy)(blockTracker, {
+            eventFilter: 'skipInternal',
+        }), "f");
+    }
 };
 exports.default = NetworkController;
 //# sourceMappingURL=NetworkController.js.map

package/dist/NetworkController.js.map

@@ -1 +1 @@
-{"version":3,"file":"NetworkController.js","sourceRoot":"","sources":["../src/NetworkController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,0DAAiC;AACjC,0FAAqE;AACrE,4FAA0E;AAC1E,qEAA+D;AAC/D,6CAAoC;AAEpC,+DAGmC;AACnC,iEAMoC;AA2CpC,MAAM,iBAAiB,GAAG,uBAAuB,CAAC;AAElD,MAAM,IAAI,GAAG,mBAAmB,CAAC;AA+CpB,QAAA,YAAY,GAAiB;IACxC,OAAO,EAAE,SAAS;IAClB,eAAe,EAAE,KAAK;IACtB,cAAc,EAAE,EAAE,IAAI,EAAE,0BAAO,EAAE,OAAO,EAAE,kCAAe,CAAC,OAAO,EAAE;IACnE,cAAc,EAAE,EAAE,mBAAmB,EAAE,KAAK,EAAE;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAa,iBAAkB,SAAQ,kCAItC;IASC,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,eAAe,EAA4B;QACzE,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ,EAAE;gBACR,OAAO,EAAE;oBACP,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;aACF;YACD,SAAS;YACT,KAAK,kCAAO,oBAAY,GAAK,KAAK,CAAE;SACrC,CAAC,CAAC;;QA7BG,2BAAsB,GAAmB,EAAoB,CAAC;QAI9D,UAAK,GAAG,IAAI,mBAAK,EAAE,CAAC;QA0B1B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,CAAC,IAAI,oBAAoB,EAChC,GAAG,EAAE;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QACnC,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,CAAC,IAAI,cAAc,EAC1B,GAAG,EAAE;YACH,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,kBAAkB,CACxB,IAAiB,EACjB,SAAkB,EAClB,OAAgB,EAChB,MAAe,EACf,QAAiB;QAEjB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,QAAQ,IAAI,EAAE;YACZ,KAAK,0BAAO,CAAC;YACb,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,WAAW;gBACd,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;gBAC9C,MAAM;YACR,KAAK,sBAAG;gBACN,SAAS;oBACP,IAAI,CAAC,qBAAqB,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACnE,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,GAAG,CAAC,CAAC;SAC3D;QACD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;YAC1B,KAAK,CAAC,cAAc,GAAG,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QACvE,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,gBAAgB;QACtB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAEO,mBAAmB,CAAC,IAAiB;QAC3C,MAAM,cAAc,GAAG,IAAA,wBAAoB,EAAC;YAC1C,OAAO,EAAE,IAAI;YACb,SAAS,EAAE,IAAI,CAAC,eAAe;SAChC,CAAC,CAAC;QACH,MAAM,iBAAiB,GAAG,IAAI,kBAAW,CAAC,cAAc,CAAC,CAAC;QAC1D,MAAM,MAAM,mCACP,IAAI,CAAC,sBAAsB,GAC3B;YACD,eAAe,EAAE,iBAAiB;YAClC,YAAY,EAAE;gBACZ,oBAAoB,EAAE,cAAc;gBACpC,eAAe,EAAE,KAAK;aACvB;SACF,CACF,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,IAAA,cAAsB,EAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,kBAAkB,CAAC,OAAgB;QACzC,OAAO,CACL,OAAO,KAAK,kCAAe,CAAC,OAAO;YACnC,OAAO,KAAK,kCAAe,CAAC,MAAM;YAClC,OAAO,KAAK,kCAAe,CAAC,OAAO;YACnC,OAAO,KAAK,kCAAe,CAAC,SAAS,CACtC,CAAC;IACJ,CAAC;IAEO,qBAAqB,CAC3B,SAAiB,EACjB,OAAgB,EAChB,MAAe,EACf,QAAiB;QAEjB,MAAM,MAAM,mCACP,IAAI,CAAC,sBAAsB,GAC3B;YACD,OAAO;YACP,YAAY,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE;YACxC,QAAQ;YACR,MAAM,EAAE,SAAS;YACjB,MAAM;SACP,CACF,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,IAAA,cAAsB,EAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,cAAc,CAAC,QAAa;QAClC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAEO,kBAAkB,CAAC,QAAa;QACtC,UAAU,CAAC,GAAG,EAAE;YACd,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,EAAE,CAAC;QACnB,CAAC,EAAE,GAAG,CAAC,CAAC;IACV,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;IAC3D,CAAC;IAOD;;;;;;OAMG;IACH,IAAI,cAAc,CAAC,cAA8B;QAC/C,IAAI,CAAC,sBAAsB,GAAG,cAAc,CAAC;QAC7C,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAClD,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QAC5B,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QACpE,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,gBAAgB,EAAE,CAAC;SACzB;QACD,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAED,IAAI,cAAc;QAChB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAiBD;;OAEG;IACG,aAAa;;YACjB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;gBAClB,OAAO;aACR;YACD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAE/C,IAAI;gBACF,IAAI;oBACF,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,qEAAc,MAAlB,IAAI,CAAgB,CAAC;oBAC7C,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE;wBACpC,OAAO;qBACR;oBAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;oBAC5B,CAAC,CAAC,CAAC;iBACJ;gBAAC,OAAO,MAAM,EAAE;oBACf,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;oBAC5B,CAAC,CAAC,CAAC;iBACJ;gBAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,wCAAwC,EACxC,IAAI,CAAC,KAAK,CAAC,cAAc,CAC1B,CAAC;aACH;oBAAS;gBACR,WAAW,EAAE,CAAC;aACf;QACH,CAAC;KAAA;IAED;;;;OAIG;IACH,eAAe,CAAC,IAAiB;QAC/B,2DAA2D;QAC3D,MAAM,MAAM,GACV,IAAI,IAAI,wDAAqC;YAC7C,wDAAqC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC;YACpD,CAAC,CAAC,wDAAqC,CAAC,IAAI,CAAC;YAC7C,CAAC,CAAC,KAAK,CAAC;QAEZ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC;YACjC,KAAK,CAAC,cAAc,CAAC,MAAM,GAAG,MAAM,CAAC;YACrC,KAAK,CAAC,cAAc,CAAC,OAAO,GAAG,kCAAe,CAAC,IAAI,CAAC,CAAC;YACrD,KAAK,CAAC,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3C,KAAK,CAAC,cAAc,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,SAAiB,EACjB,OAAe,EACf,MAAe,EACf,QAAiB;QAEjB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,cAAc,CAAC,IAAI,GAAG,sBAAG,CAAC;YAChC,KAAK,CAAC,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3C,KAAK,CAAC,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;YACvC,KAAK,CAAC,cAAc,CAAC,MAAM,GAAG,MAAM,CAAC;YACrC,KAAK,CAAC,cAAc,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC3C,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAiBK,uBAAuB;;YAC3B,MAAM,EAAE,cAAc,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;YAE3C,IAAI,cAAc,CAAC,mBAAmB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACxD,OAAO,IAAI,CAAC;aACb;YAED,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,uEAAgB,MAApB,IAAI,CAAkB,CAAC;YACjD,MAAM,mBAAmB,GACvB,OAAO,WAAW,CAAC,aAAa,KAAK,WAAW,CAAC;YACnD,IAAI,cAAc,CAAC,mBAAmB,KAAK,mBAAmB,EAAE;gBAC9D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,cAAc,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;gBACjE,CAAC,CAAC,CAAC;aACJ;YACD,OAAO,mBAAmB,CAAC;QAC7B,CAAC;KAAA;CACF;AA5TD,8CA4TC;;;QA/HG,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,EAAE,MAAM,EAAE,aAAa,EAAE,EACzB,CAAC,KAAY,EAAE,MAAc,EAAE,EAAE;gBAC/B,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,CAAC;iBACf;qBAAM;oBACL,OAAO,CAAC,MAAM,CAAC,CAAC;iBACjB;YACH,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;;IAoFC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAC7D,CAAC,KAAY,EAAE,KAAY,EAAE,EAAE;YAC7B,IAAI,KAAK,EAAE;gBACT,MAAM,CAAC,KAAK,CAAC,CAAC;aACf;iBAAM;gBACL,OAAO,CAAC,KAAK,CAAC,CAAC;aAChB;QACH,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAqBH,kBAAe,iBAAiB,CAAC","sourcesContent":["import EthQuery from 'eth-query';\nimport Subprovider from 'web3-provider-engine/subproviders/provider';\nimport createInfuraProvider from 'eth-json-rpc-infura/src/createProvider';\nimport createMetamaskProvider from 'web3-provider-engine/zero';\nimport { Mutex } from 'async-mutex';\nimport type { Patch } from 'immer';\nimport {\n  BaseControllerV2,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport {\n  MAINNET,\n  RPC,\n  TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL,\n  NetworksChainId,\n  NetworkType,\n} from '@metamask/controller-utils';\n\n/**\n * @type ProviderConfig\n *\n * Configuration passed to web3-provider-engine\n * @property rpcTarget - RPC target URL.\n * @property type - Human-readable network name.\n * @property chainId - Network ID as per EIP-155.\n * @property ticker - Currency ticker.\n * @property nickname - Personalized network name.\n */\nexport type ProviderConfig = {\n  rpcTarget?: string;\n  type: NetworkType;\n  chainId: string;\n  ticker?: string;\n  nickname?: string;\n};\n\nexport type Block = {\n  baseFeePerGas?: string;\n};\n\nexport type NetworkDetails = {\n  isEIP1559Compatible?: boolean;\n};\n\n/**\n * @type NetworkState\n *\n * Network controller state\n * @property network - Network ID as per net_version\n * @property isCustomNetwork - Identifies if the network is a custom network\n * @property provider - RPC URL and network name provider settings\n */\nexport type NetworkState = {\n  network: string;\n  isCustomNetwork: boolean;\n  providerConfig: ProviderConfig;\n  networkDetails: NetworkDetails;\n};\n\nconst LOCALHOST_RPC_URL = 'http://localhost:8545';\n\nconst name = 'NetworkController';\n\nexport type EthQuery = any;\n\nexport type NetworkControllerStateChangeEvent = {\n  type: `NetworkController:stateChange`;\n  payload: [NetworkState, Patch[]];\n};\n\nexport type NetworkControllerProviderConfigChangeEvent = {\n  type: `NetworkController:providerConfigChange`;\n  payload: [ProviderConfig];\n};\n\nexport type NetworkControllerEvents =\n  | NetworkControllerStateChangeEvent\n  | NetworkControllerProviderConfigChangeEvent;\n\nexport type NetworkControllerGetProviderConfigAction = {\n  type: `NetworkController:getProviderConfig`;\n  handler: () => ProviderConfig;\n};\n\nexport type NetworkControllerGetEthQueryAction = {\n  type: `NetworkController:getEthQuery`;\n  handler: () => EthQuery;\n};\n\nexport type NetworkControllerActions =\n  | NetworkControllerGetProviderConfigAction\n  | NetworkControllerGetEthQueryAction;\n\nexport type NetworkControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  NetworkControllerGetProviderConfigAction | NetworkControllerGetEthQueryAction,\n  | NetworkControllerStateChangeEvent\n  | NetworkControllerProviderConfigChangeEvent,\n  string,\n  string\n>;\n\nexport type NetworkControllerOptions = {\n  messenger: NetworkControllerMessenger;\n  infuraProjectId?: string;\n  state?: Partial<NetworkState>;\n};\n\nexport const defaultState: NetworkState = {\n  network: 'loading',\n  isCustomNetwork: false,\n  providerConfig: { type: MAINNET, chainId: NetworksChainId.mainnet },\n  networkDetails: { isEIP1559Compatible: false },\n};\n\n/**\n * Controller that creates and manages an Ethereum network provider.\n */\nexport class NetworkController extends BaseControllerV2<\n  typeof name,\n  NetworkState,\n  NetworkControllerMessenger\n> {\n  private ethQuery: EthQuery;\n\n  private internalProviderConfig: ProviderConfig = {} as ProviderConfig;\n\n  private infuraProjectId: string | undefined;\n\n  private mutex = new Mutex();\n\n  constructor({ messenger, state, infuraProjectId }: NetworkControllerOptions) {\n    super({\n      name,\n      metadata: {\n        network: {\n          persist: true,\n          anonymous: false,\n        },\n        isCustomNetwork: {\n          persist: true,\n          anonymous: false,\n        },\n        networkDetails: {\n          persist: true,\n          anonymous: false,\n        },\n        providerConfig: {\n          persist: true,\n          anonymous: false,\n        },\n      },\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.infuraProjectId = infuraProjectId;\n    this.messagingSystem.registerActionHandler(\n      `${this.name}:getProviderConfig`,\n      () => {\n        return this.state.providerConfig;\n      },\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${this.name}:getEthQuery`,\n      () => {\n        return this.ethQuery;\n      },\n    );\n  }\n\n  private initializeProvider(\n    type: NetworkType,\n    rpcTarget?: string,\n    chainId?: string,\n    ticker?: string,\n    nickname?: string,\n  ) {\n    this.update((state) => {\n      state.isCustomNetwork = this.getIsCustomNetwork(chainId);\n    });\n\n    switch (type) {\n      case MAINNET:\n      case 'goerli':\n      case 'sepolia':\n        this.setupInfuraProvider(type);\n        break;\n      case 'localhost':\n        this.setupStandardProvider(LOCALHOST_RPC_URL);\n        break;\n      case RPC:\n        rpcTarget &&\n          this.setupStandardProvider(rpcTarget, chainId, ticker, nickname);\n        break;\n      default:\n        throw new Error(`Unrecognized network type: '${type}'`);\n    }\n    this.getEIP1559Compatibility();\n  }\n\n  private refreshNetwork() {\n    this.update((state) => {\n      state.network = 'loading';\n      state.networkDetails = {};\n    });\n    const { rpcTarget, type, chainId, ticker } = this.state.providerConfig;\n    this.initializeProvider(type, rpcTarget, chainId, ticker);\n    this.lookupNetwork();\n  }\n\n  private registerProvider() {\n    this.provider.on('error', this.verifyNetwork.bind(this));\n    this.ethQuery = new EthQuery(this.provider);\n  }\n\n  private setupInfuraProvider(type: NetworkType) {\n    const infuraProvider = createInfuraProvider({\n      network: type,\n      projectId: this.infuraProjectId,\n    });\n    const infuraSubprovider = new Subprovider(infuraProvider);\n    const config = {\n      ...this.internalProviderConfig,\n      ...{\n        dataSubprovider: infuraSubprovider,\n        engineParams: {\n          blockTrackerProvider: infuraProvider,\n          pollingInterval: 12000,\n        },\n      },\n    };\n    this.updateProvider(createMetamaskProvider(config));\n  }\n\n  private getIsCustomNetwork(chainId?: string) {\n    return (\n      chainId !== NetworksChainId.mainnet &&\n      chainId !== NetworksChainId.goerli &&\n      chainId !== NetworksChainId.sepolia &&\n      chainId !== NetworksChainId.localhost\n    );\n  }\n\n  private setupStandardProvider(\n    rpcTarget: string,\n    chainId?: string,\n    ticker?: string,\n    nickname?: string,\n  ) {\n    const config = {\n      ...this.internalProviderConfig,\n      ...{\n        chainId,\n        engineParams: { pollingInterval: 12000 },\n        nickname,\n        rpcUrl: rpcTarget,\n        ticker,\n      },\n    };\n    this.updateProvider(createMetamaskProvider(config));\n  }\n\n  private updateProvider(provider: any) {\n    this.safelyStopProvider(this.provider);\n    this.provider = provider;\n    this.registerProvider();\n  }\n\n  private safelyStopProvider(provider: any) {\n    setTimeout(() => {\n      provider?.stop();\n    }, 500);\n  }\n\n  private verifyNetwork() {\n    this.state.network === 'loading' && this.lookupNetwork();\n  }\n\n  /**\n   * Ethereum provider object for the current network\n   */\n  provider: any;\n\n  /**\n   * Sets a new configuration for web3-provider-engine.\n   *\n   * TODO: Replace this wth a method.\n   *\n   * @param providerConfig - The web3-provider-engine configuration.\n   */\n  set providerConfig(providerConfig: ProviderConfig) {\n    this.internalProviderConfig = providerConfig;\n    const { type, rpcTarget, chainId, ticker, nickname } =\n      this.state.providerConfig;\n    this.initializeProvider(type, rpcTarget, chainId, ticker, nickname);\n    if (this.provider !== undefined) {\n      this.registerProvider();\n    }\n    this.lookupNetwork();\n  }\n\n  get providerConfig() {\n    throw new Error('Property only used for setting');\n  }\n\n  async #getNetworkId(): Promise<string> {\n    return await new Promise((resolve, reject) => {\n      this.ethQuery.sendAsync(\n        { method: 'net_version' },\n        (error: Error, result: string) => {\n          if (error) {\n            reject(error);\n          } else {\n            resolve(result);\n          }\n        },\n      );\n    });\n  }\n\n  /**\n   * Refreshes the current network code.\n   */\n  async lookupNetwork() {\n    if (!this.ethQuery) {\n      return;\n    }\n    const releaseLock = await this.mutex.acquire();\n\n    try {\n      try {\n        const networkId = await this.#getNetworkId();\n        if (this.state.network === networkId) {\n          return;\n        }\n\n        this.update((state) => {\n          state.network = networkId;\n        });\n      } catch (_error) {\n        this.update((state) => {\n          state.network = 'loading';\n        });\n      }\n\n      this.messagingSystem.publish(\n        `NetworkController:providerConfigChange`,\n        this.state.providerConfig,\n      );\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Convenience method to update provider network type settings.\n   *\n   * @param type - Human readable network name.\n   */\n  setProviderType(type: NetworkType) {\n    // If testnet the ticker symbol should use a testnet prefix\n    const ticker =\n      type in TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL &&\n      TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type].length > 0\n        ? TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type]\n        : 'ETH';\n\n    this.update((state) => {\n      state.providerConfig.type = type;\n      state.providerConfig.ticker = ticker;\n      state.providerConfig.chainId = NetworksChainId[type];\n      state.providerConfig.rpcTarget = undefined;\n      state.providerConfig.nickname = undefined;\n    });\n    this.refreshNetwork();\n  }\n\n  /**\n   * Convenience method to update provider RPC settings.\n   *\n   * @param rpcTarget - The RPC endpoint URL.\n   * @param chainId - The chain ID as per EIP-155.\n   * @param ticker - The currency ticker.\n   * @param nickname - Personalized network name.\n   */\n  setRpcTarget(\n    rpcTarget: string,\n    chainId: string,\n    ticker?: string,\n    nickname?: string,\n  ) {\n    this.update((state) => {\n      state.providerConfig.type = RPC;\n      state.providerConfig.rpcTarget = rpcTarget;\n      state.providerConfig.chainId = chainId;\n      state.providerConfig.ticker = ticker;\n      state.providerConfig.nickname = nickname;\n    });\n    this.refreshNetwork();\n  }\n\n  #getLatestBlock(): Promise<Block> {\n    return new Promise((resolve, reject) => {\n      this.ethQuery.sendAsync(\n        { method: 'eth_getBlockByNumber', params: ['latest', false] },\n        (error: Error, block: Block) => {\n          if (error) {\n            reject(error);\n          } else {\n            resolve(block);\n          }\n        },\n      );\n    });\n  }\n\n  async getEIP1559Compatibility() {\n    const { networkDetails = {} } = this.state;\n\n    if (networkDetails.isEIP1559Compatible || !this.ethQuery) {\n      return true;\n    }\n\n    const latestBlock = await this.#getLatestBlock();\n    const isEIP1559Compatible =\n      typeof latestBlock.baseFeePerGas !== 'undefined';\n    if (networkDetails.isEIP1559Compatible !== isEIP1559Compatible) {\n      this.update((state) => {\n        state.networkDetails.isEIP1559Compatible = isEIP1559Compatible;\n      });\n    }\n    return isEIP1559Compatible;\n  }\n}\n\nexport default NetworkController;\n"]}
+{"version":3,"file":"NetworkController.js","sourceRoot":"","sources":["../src/NetworkController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAiC;AACjC,0FAAqE;AACrE,4FAA0E;AAC1E,qEAA+D;AAC/D,uEAAwE;AAExE,6CAAoC;AACpC,+BAAoC;AAEpC,+DAGmC;AACnC,iEAOoC;AAEpC,2CAA0D;AAoE1D,MAAM,iBAAiB,GAAG,uBAAuB,CAAC;AAElD,MAAM,IAAI,GAAG,mBAAmB,CAAC;AAwDpB,QAAA,YAAY,GAAiB;IACxC,OAAO,EAAE,SAAS;IAClB,eAAe,EAAE,KAAK;IACtB,cAAc,EAAE;QACd,IAAI,EAAE,8BAAW,CAAC,OAAO;QACzB,OAAO,EAAE,kCAAe,CAAC,OAAO;KACjC;IACD,cAAc,EAAE,EAAE,mBAAmB,EAAE,KAAK,EAAE;IAC9C,qBAAqB,EAAE,EAAE;CAC1B,CAAC;AAiBF;;GAEG;AACH,MAAa,iBAAkB,SAAQ,kCAItC;IAiBC,YAAY,EACV,SAAS,EACT,KAAK,EACL,eAAe,EACf,qBAAqB,GACI;QACzB,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ,EAAE;gBACR,OAAO,EAAE;oBACP,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,qBAAqB,EAAE;oBACrB,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;aACF;YACD,SAAS;YACT,KAAK,kCAAO,oBAAY,GAAK,KAAK,CAAE;SACrC,CAAC,CAAC;;QA1CG,UAAK,GAAG,IAAI,mBAAK,EAAE,CAAC;QAE5B,8DAAuE;QAEvE,8CAAgC;QAEhC,mDAA0C;QAE1C,uDAAkD;QAmChD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,CAAC,IAAI,oBAAoB,EAChC,GAAG,EAAE;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QACnC,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,CAAC,IAAI,cAAc,EAC1B,GAAG,EAAE;YACH,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC,CACF,CAAC;QAEF,uBAAA,IAAI,+CAA6B,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,MAAA,CAAC;IAClE,CAAC;IAEO,iBAAiB,CACvB,IAAiB,EACjB,SAAkB,EAClB,OAAgB,EAChB,MAAe,EACf,QAAiB;QAEjB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,QAAQ,IAAI,EAAE;YACZ,KAAK,8BAAW,CAAC,OAAO,CAAC;YACzB,KAAK,8BAAW,CAAC,MAAM,CAAC;YACxB,KAAK,8BAAW,CAAC,OAAO;gBACtB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,8BAAW,CAAC,SAAS;gBACxB,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;gBAC9C,MAAM;YACR,KAAK,8BAAW,CAAC,GAAG;gBAClB,SAAS;oBACP,IAAI,CAAC,qBAAqB,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACnE,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,GAAG,CAAC,CAAC;SAC3D;QACD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAED,0BAA0B;QAIxB,OAAO;YACL,QAAQ,EAAE,uBAAA,IAAI,wCAAe;YAC7B,YAAY,EAAE,uBAAA,IAAI,4CAAmB;SACtC,CAAC;IACJ,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;YAC1B,KAAK,CAAC,cAAc,GAAG,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QACvE,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,gBAAgB;QACtB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAEvD,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,QAAQ,CAAC,CAAC;SACxC;IACH,CAAC;IAEO,mBAAmB,CAAC,IAAiB;QAC3C,MAAM,cAAc,GAAG,IAAA,wBAAoB,EAAC;YAC1C,OAAO,EAAE,IAAI;YACb,SAAS,EAAE,IAAI,CAAC,eAAe;SAChC,CAAC,CAAC;QACH,MAAM,iBAAiB,GAAG,IAAI,kBAAW,CAAC,cAAc,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG;YACb,eAAe,EAAE,iBAAiB;YAClC,YAAY,EAAE;gBACZ,oBAAoB,EAAE,cAAc;gBACpC,eAAe,EAAE,KAAK;aACvB;SACF,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,IAAA,cAAsB,EAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,kBAAkB,CAAC,OAAgB;QACzC,OAAO,CACL,OAAO,KAAK,kCAAe,CAAC,OAAO;YACnC,OAAO,KAAK,kCAAe,CAAC,MAAM;YAClC,OAAO,KAAK,kCAAe,CAAC,OAAO;YACnC,OAAO,KAAK,kCAAe,CAAC,SAAS,CACtC,CAAC;IACJ,CAAC;IAEO,qBAAqB,CAC3B,SAAiB,EACjB,OAAgB,EAChB,MAAe,EACf,QAAiB;QAEjB,MAAM,MAAM,GAAG;YACb,OAAO;YACP,YAAY,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE;YACxC,QAAQ;YACR,MAAM,EAAE,SAAS;YACjB,MAAM;SACP,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,IAAA,cAAsB,EAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,cAAc,CAAC,QAAkB;QACvC,IAAI,CAAC,kBAAkB,CAAC,uBAAA,IAAI,mCAAU,CAAC,CAAC;QACxC,uBAAA,IAAI,mFAA4B,MAAhC,IAAI,EAA6B;YAC/B,QAAQ;YACR,YAAY,EAAE,QAAQ,CAAC,aAAa;SACrC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAEO,kBAAkB,CAAC,QAA8B;QACvD,UAAU,CAAC,GAAG,EAAE;YACd,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,EAAE,CAAC;QACnB,CAAC,EAAE,GAAG,CAAC,CAAC;IACV,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACH,kBAAkB;QAChB,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAClD,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QAC5B,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QACnE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAiBD;;OAEG;IACG,aAAa;;YACjB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;gBAClB,OAAO;aACR;YACD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAE/C,IAAI;gBACF,IAAI;oBACF,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,qEAAc,MAAlB,IAAI,CAAgB,CAAC;oBAC7C,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE;wBACpC,OAAO;qBACR;oBAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;oBAC5B,CAAC,CAAC,CAAC;iBACJ;gBAAC,OAAO,MAAM,EAAE;oBACf,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;oBAC5B,CAAC,CAAC,CAAC;iBACJ;gBAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,wCAAwC,EACxC,IAAI,CAAC,KAAK,CAAC,cAAc,CAC1B,CAAC;aACH;oBAAS;gBACR,WAAW,EAAE,CAAC;aACf;QACH,CAAC;KAAA;IAcD;;;;OAIG;IACH,eAAe,CAAC,IAAiB;QAC/B,uBAAA,IAAI,qFAA8B,MAAlC,IAAI,CAAgC,CAAC;QACrC,2DAA2D;QAC3D,MAAM,MAAM,GACV,IAAI,IAAI,iCAAc,IAAI,iCAAc,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC;YACvD,CAAC,CAAC,iCAAc,CAAC,IAAI,CAAC;YACtB,CAAC,CAAC,KAAK,CAAC;QAEZ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC;YACjC,KAAK,CAAC,cAAc,CAAC,MAAM,GAAG,MAAM,CAAC;YACrC,KAAK,CAAC,cAAc,CAAC,OAAO,GAAG,kCAAe,CAAC,IAAI,CAAC,CAAC;YACrD,KAAK,CAAC,cAAc,CAAC,QAAQ,GAAG,oCAAiB,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;YACjE,KAAK,CAAC,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3C,KAAK,CAAC,cAAc,CAAC,QAAQ,GAAG,SAAS,CAAC;YAC1C,KAAK,CAAC,cAAc,CAAC,EAAE,GAAG,SAAS,CAAC;QACtC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,sBAA8B;QAC7C,uBAAA,IAAI,qFAA8B,MAAlC,IAAI,CAAgC,CAAC;QAErC,MAAM,aAAa,GACjB,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,CAAC;QAE3D,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,IAAI,KAAK,CACb,0BAA0B,sBAAsB,mDAAmD,CACpG,CAAC;SACH;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,cAAc,CAAC,IAAI,GAAG,8BAAW,CAAC,GAAG,CAAC;YAC5C,KAAK,CAAC,cAAc,CAAC,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC;YACtD,KAAK,CAAC,cAAc,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACrD,KAAK,CAAC,cAAc,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;YACnD,KAAK,CAAC,cAAc,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;YACvD,KAAK,CAAC,cAAc,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;YACvD,KAAK,CAAC,cAAc,CAAC,EAAE,GAAG,aAAa,CAAC,EAAE,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAiBK,uBAAuB;;YAC3B,MAAM,EAAE,cAAc,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;YAE3C,IAAI,cAAc,CAAC,mBAAmB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACxD,OAAO,IAAI,CAAC;aACb;YAED,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,uEAAgB,MAApB,IAAI,CAAkB,CAAC;YACjD,MAAM,mBAAmB,GACvB,OAAO,WAAW,CAAC,aAAa,KAAK,WAAW,CAAC;YACnD,IAAI,cAAc,CAAC,mBAAmB,KAAK,mBAAmB,EAAE;gBAC9D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,cAAc,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;gBACjE,CAAC,CAAC,CAAC;aACJ;YACD,OAAO,mBAAmB,CAAC;QAC7B,CAAC;KAAA;IAyBD;;;;;;;;;;;;;;;OAeG;IACH,0BAA0B,CACxB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAwB,EACrE,EACE,SAAS,GAAG,KAAK,EACjB,QAAQ,EACR,MAAM,GACoD;;QAE5D,IAAA,+BAAuB,EAAC,OAAO,CAAC,CAAC;QAEjC,IAAI,CAAC,IAAA,gCAAa,EAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE;YACzC,MAAM,IAAI,KAAK,CACb,qBAAqB,OAAO,iDAAiD,CAC9E,CAAC;SACH;QAED,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;QAED,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,EAAE;YACxB,MAAM,IAAI,KAAK,CACb,2FAA2F,CAC5F,CAAC;SACH;QAED,IAAI;YACF,kCAAkC;YAClC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;SACjB;QAAC,OAAO,CAAM,EAAE;YACf,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;gBACrC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;aAC/C;SACF;QAED,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAC;SACH;QAED,MAAM,uBAAuB,GAAG;YAC9B,MAAM;YACN,OAAO;YACP,MAAM;YACN,QAAQ;YACR,QAAQ;SACT,CAAC;QAEF,MAAM,wBAAwB,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC;QAElE,MAAM,yBAAyB,GAAG,MAAA,MAAM,CAAC,MAAM,CAC7C,wBAAwB,CACzB,CAAC,IAAI,CACJ,CAAC,oBAAoB,EAAE,EAAE,WACvB,OAAA,CAAA,MAAA,oBAAoB,CAAC,MAAM,0CAAE,WAAW,EAAE,OAAK,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,EAAE,CAAA,CAAA,EAAA,CACvE,0CAAE,EAAE,CAAC;QAEN,MAAM,yBAAyB,GAAG,yBAAyB,IAAI,IAAA,SAAM,GAAE,CAAC;QACxE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,qBAAqB,mCACtB,wBAAwB,KAC3B,CAAC,yBAAyB,CAAC,kCACtB,uBAAuB,KAC1B,EAAE,EAAE,yBAAyB,MAEhC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,yBAAyB,EAAE;YAC9B,IAAI,CAAC,qBAAqB,CAAC;gBACzB,KAAK,EAAE,sBAAsB;gBAC7B,QAAQ,EAAE,SAAS;gBACnB,QAAQ,EAAE;oBACR,GAAG,EAAE,QAAQ;iBACd;gBACD,UAAU,EAAE;oBACV,QAAQ,EAAE,OAAO;oBACjB,MAAM,EAAE,MAAM;oBACd,MAAM;iBACP;aACF,CAAC,CAAC;SACJ;QAED,IAAI,SAAS,EAAE;YACb,IAAI,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;SAClD;QAED,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,0BAA0B,CAAC,sBAA8B;QACvD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,EAAE;YAC7D,MAAM,IAAI,KAAK,CACb,0BAA0B,sBAAsB,mDAAmD,CACpG,CAAC;SACH;QACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,KAAK,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,0BAA0B;QACxB,MAAM,SAAS,GAAG,uBAAA,IAAI,mDAA0B,CAAC;QACjD,IAAI,IAAA,gCAAa,EAAC,SAAS,CAAC,EAAE;YAC5B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;SACjC;aAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACxC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;SAClC;IACH,CAAC;CACF;AAlgBD,8CAkgBC;;;QAnTG,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,EAAE,MAAM,EAAE,aAAa,EAAE,EACzB,CAAC,KAAY,EAAE,MAAc,EAAE,EAAE;gBAC/B,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,CAAC;iBACf;qBAAM;oBACL,OAAO,CAAC,MAAM,CAAC,CAAC;iBACjB;YACH,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;;IAwCC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;IAC/C,IAAI,IAAI,KAAK,8BAAW,CAAC,GAAG,IAAI,EAAE,EAAE;QAClC,uBAAA,IAAI,+CAA6B,EAAE,MAAA,CAAC;KACrC;SAAM;QACL,uBAAA,IAAI,+CAA6B,IAAI,MAAA,CAAC;KACvC;AACH,CAAC;IA0DC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAC7D,CAAC,KAAY,EAAE,KAAY,EAAE,EAAE;YAC7B,IAAI,KAAK,EAAE;gBACT,MAAM,CAAC,KAAK,CAAC,CAAC;aACf;iBAAM;gBACL,OAAO,CAAC,KAAK,CAAC,CAAC;aAChB;QACH,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,yGAoB2B,EAC1B,QAAQ,EACR,YAAY,GAIb;IACC,IAAI,uBAAA,IAAI,wCAAe,EAAE;QACvB,uBAAA,IAAI,wCAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;KACzC;SAAM;QACL,uBAAA,IAAI,oCAAkB,IAAA,6CAAuB,EAAC,QAAQ,CAAC,MAAA,CAAC;KACzD;IACD,uBAAA,IAAI,+BAAa,QAAQ,MAAA,CAAC;IAE1B,IAAI,uBAAA,IAAI,4CAAmB,EAAE;QAC3B,uBAAA,IAAI,4CAAmB,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;KACjD;SAAM;QACL,uBAAA,IAAI,wCAAsB,IAAA,6CAAuB,EAAC,YAAY,EAAE;YAC9D,WAAW,EAAE,cAAc;SAC5B,CAAC,MAAA,CAAC;KACJ;AACH,CAAC;AA4IH,kBAAe,iBAAiB,CAAC","sourcesContent":["import EthQuery from 'eth-query';\nimport Subprovider from 'web3-provider-engine/subproviders/provider';\nimport createInfuraProvider from 'eth-json-rpc-infura/src/createProvider';\nimport createMetamaskProvider from 'web3-provider-engine/zero';\nimport { createEventEmitterProxy } from '@metamask/swappable-obj-proxy';\nimport type { SwappableProxy } from '@metamask/swappable-obj-proxy';\nimport { Mutex } from 'async-mutex';\nimport { v4 as random } from 'uuid';\nimport type { Patch } from 'immer';\nimport {\n  BaseControllerV2,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport {\n  NetworksChainId,\n  NetworkType,\n  isSafeChainId,\n  NetworksTicker,\n  isNetworkType,\n  BUILT_IN_NETWORKS,\n} from '@metamask/controller-utils';\n\nimport { assertIsStrictHexString } from '@metamask/utils';\n\n/**\n * @type ProviderConfig\n *\n * Configuration passed to web3-provider-engine\n * @property rpcTarget - RPC target URL.\n * @property type - Human-readable network name.\n * @property chainId - Network ID as per EIP-155.\n * @property ticker - Currency ticker.\n * @property nickname - Personalized network name.\n * @property id - Network Configuration Id.\n */\nexport type ProviderConfig = {\n  rpcTarget?: string;\n  type: NetworkType;\n  chainId: string;\n  ticker?: string;\n  nickname?: string;\n  rpcPrefs?: { blockExplorerUrl?: string };\n  id?: NetworkConfigurationId;\n};\n\nexport type Block = {\n  baseFeePerGas?: string;\n};\n\nexport type NetworkDetails = {\n  isEIP1559Compatible?: boolean;\n};\n\n/**\n * Custom RPC network information\n *\n * @property rpcTarget - RPC target URL.\n * @property chainId - Network ID as per EIP-155\n * @property nickname - Personalized network name.\n * @property ticker - Currency ticker.\n * @property rpcPrefs - Personalized preferences.\n */\nexport type NetworkConfiguration = {\n  rpcUrl: string;\n  chainId: string;\n  ticker: string;\n  nickname?: string;\n  rpcPrefs?: {\n    blockExplorerUrl: string;\n  };\n};\n\n/**\n * @type NetworkState\n *\n * Network controller state\n * @property network - Network ID as per net_version of the currently connected network\n * @property isCustomNetwork - Identifies if the currently connected network is a custom network\n * @property providerConfig - RPC URL and network name provider settings of the currently connected network\n * @property properties - an additional set of network properties for the currently connected network\n * @property networkConfigurations - the full list of configured networks either preloaded or added by the user.\n */\nexport type NetworkState = {\n  network: string;\n  isCustomNetwork: boolean;\n  providerConfig: ProviderConfig;\n  networkDetails: NetworkDetails;\n  networkConfigurations: Record<string, NetworkConfiguration & { id: string }>;\n};\n\nconst LOCALHOST_RPC_URL = 'http://localhost:8545';\n\nconst name = 'NetworkController';\n\nexport type EthQuery = any;\n\ntype Provider = any;\n\nexport type ProviderProxy = SwappableProxy<Provider>;\n\ntype BlockTracker = any;\n\ntype BlockTrackerProxy = SwappableProxy<BlockTracker>;\n\nexport type NetworkControllerStateChangeEvent = {\n  type: `NetworkController:stateChange`;\n  payload: [NetworkState, Patch[]];\n};\n\nexport type NetworkControllerProviderConfigChangeEvent = {\n  type: `NetworkController:providerConfigChange`;\n  payload: [ProviderConfig];\n};\n\nexport type NetworkControllerEvents =\n  | NetworkControllerStateChangeEvent\n  | NetworkControllerProviderConfigChangeEvent;\n\nexport type NetworkControllerGetProviderConfigAction = {\n  type: `NetworkController:getProviderConfig`;\n  handler: () => ProviderConfig;\n};\n\nexport type NetworkControllerGetEthQueryAction = {\n  type: `NetworkController:getEthQuery`;\n  handler: () => EthQuery;\n};\n\nexport type NetworkControllerActions =\n  | NetworkControllerGetProviderConfigAction\n  | NetworkControllerGetEthQueryAction;\n\nexport type NetworkControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  NetworkControllerGetProviderConfigAction | NetworkControllerGetEthQueryAction,\n  | NetworkControllerStateChangeEvent\n  | NetworkControllerProviderConfigChangeEvent,\n  string,\n  string\n>;\n\nexport type NetworkControllerOptions = {\n  messenger: NetworkControllerMessenger;\n  trackMetaMetricsEvent: () => void;\n  infuraProjectId?: string;\n  state?: Partial<NetworkState>;\n};\n\nexport const defaultState: NetworkState = {\n  network: 'loading',\n  isCustomNetwork: false,\n  providerConfig: {\n    type: NetworkType.mainnet,\n    chainId: NetworksChainId.mainnet,\n  },\n  networkDetails: { isEIP1559Compatible: false },\n  networkConfigurations: {},\n};\n\ntype MetaMetricsEventPayload = {\n  event: string;\n  category: string;\n  referrer?: { url: string };\n  actionId?: number;\n  environmentType?: string;\n  properties?: unknown;\n  sensitiveProperties?: unknown;\n  revenue?: number;\n  currency?: string;\n  value?: number;\n};\n\ntype NetworkConfigurationId = string;\n\n/**\n * Controller that creates and manages an Ethereum network provider.\n */\nexport class NetworkController extends BaseControllerV2<\n  typeof name,\n  NetworkState,\n  NetworkControllerMessenger\n> {\n  private ethQuery: EthQuery;\n\n  private infuraProjectId: string | undefined;\n\n  private trackMetaMetricsEvent: (event: MetaMetricsEventPayload) => void;\n\n  private mutex = new Mutex();\n\n  #previousNetworkSpecifier: NetworkType | NetworkConfigurationId | null;\n\n  #provider: Provider | undefined;\n\n  #providerProxy: ProviderProxy | undefined;\n\n  #blockTrackerProxy: BlockTrackerProxy | undefined;\n\n  constructor({\n    messenger,\n    state,\n    infuraProjectId,\n    trackMetaMetricsEvent,\n  }: NetworkControllerOptions) {\n    super({\n      name,\n      metadata: {\n        network: {\n          persist: true,\n          anonymous: false,\n        },\n        isCustomNetwork: {\n          persist: true,\n          anonymous: false,\n        },\n        networkDetails: {\n          persist: true,\n          anonymous: false,\n        },\n        providerConfig: {\n          persist: true,\n          anonymous: false,\n        },\n        networkConfigurations: {\n          persist: true,\n          anonymous: false,\n        },\n      },\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.infuraProjectId = infuraProjectId;\n    this.trackMetaMetricsEvent = trackMetaMetricsEvent;\n    this.messagingSystem.registerActionHandler(\n      `${this.name}:getProviderConfig`,\n      () => {\n        return this.state.providerConfig;\n      },\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${this.name}:getEthQuery`,\n      () => {\n        return this.ethQuery;\n      },\n    );\n\n    this.#previousNetworkSpecifier = this.state.providerConfig.type;\n  }\n\n  private configureProvider(\n    type: NetworkType,\n    rpcTarget?: string,\n    chainId?: string,\n    ticker?: string,\n    nickname?: string,\n  ) {\n    this.update((state) => {\n      state.isCustomNetwork = this.getIsCustomNetwork(chainId);\n    });\n\n    switch (type) {\n      case NetworkType.mainnet:\n      case NetworkType.goerli:\n      case NetworkType.sepolia:\n        this.setupInfuraProvider(type);\n        break;\n      case NetworkType.localhost:\n        this.setupStandardProvider(LOCALHOST_RPC_URL);\n        break;\n      case NetworkType.rpc:\n        rpcTarget &&\n          this.setupStandardProvider(rpcTarget, chainId, ticker, nickname);\n        break;\n      default:\n        throw new Error(`Unrecognized network type: '${type}'`);\n    }\n    this.getEIP1559Compatibility();\n  }\n\n  getProviderAndBlockTracker(): {\n    provider: SwappableProxy<Provider> | undefined;\n    blockTracker: SwappableProxy<BlockTracker> | undefined;\n  } {\n    return {\n      provider: this.#providerProxy,\n      blockTracker: this.#blockTrackerProxy,\n    };\n  }\n\n  private refreshNetwork() {\n    this.update((state) => {\n      state.network = 'loading';\n      state.networkDetails = {};\n    });\n    const { rpcTarget, type, chainId, ticker } = this.state.providerConfig;\n    this.configureProvider(type, rpcTarget, chainId, ticker);\n    this.lookupNetwork();\n  }\n\n  private registerProvider() {\n    const { provider } = this.getProviderAndBlockTracker();\n\n    if (provider) {\n      provider.on('error', this.verifyNetwork.bind(this));\n      this.ethQuery = new EthQuery(provider);\n    }\n  }\n\n  private setupInfuraProvider(type: NetworkType) {\n    const infuraProvider = createInfuraProvider({\n      network: type,\n      projectId: this.infuraProjectId,\n    });\n    const infuraSubprovider = new Subprovider(infuraProvider);\n    const config = {\n      dataSubprovider: infuraSubprovider,\n      engineParams: {\n        blockTrackerProvider: infuraProvider,\n        pollingInterval: 12000,\n      },\n    };\n    this.updateProvider(createMetamaskProvider(config));\n  }\n\n  private getIsCustomNetwork(chainId?: string) {\n    return (\n      chainId !== NetworksChainId.mainnet &&\n      chainId !== NetworksChainId.goerli &&\n      chainId !== NetworksChainId.sepolia &&\n      chainId !== NetworksChainId.localhost\n    );\n  }\n\n  private setupStandardProvider(\n    rpcTarget: string,\n    chainId?: string,\n    ticker?: string,\n    nickname?: string,\n  ) {\n    const config = {\n      chainId,\n      engineParams: { pollingInterval: 12000 },\n      nickname,\n      rpcUrl: rpcTarget,\n      ticker,\n    };\n    this.updateProvider(createMetamaskProvider(config));\n  }\n\n  private updateProvider(provider: Provider) {\n    this.safelyStopProvider(this.#provider);\n    this.#setProviderAndBlockTracker({\n      provider,\n      blockTracker: provider._blockTracker,\n    });\n    this.registerProvider();\n  }\n\n  private safelyStopProvider(provider: Provider | undefined) {\n    setTimeout(() => {\n      provider?.stop();\n    }, 500);\n  }\n\n  private verifyNetwork() {\n    this.state.network === 'loading' && this.lookupNetwork();\n  }\n\n  /**\n   * Method to inilialize the provider,\n   * Creates the provider and block tracker for the configured network,\n   * using the provider to gather details about the network.\n   *\n   */\n  initializeProvider() {\n    const { type, rpcTarget, chainId, ticker, nickname } =\n      this.state.providerConfig;\n    this.configureProvider(type, rpcTarget, chainId, ticker, nickname);\n    this.registerProvider();\n    this.lookupNetwork();\n  }\n\n  async #getNetworkId(): Promise<string> {\n    return await new Promise((resolve, reject) => {\n      this.ethQuery.sendAsync(\n        { method: 'net_version' },\n        (error: Error, result: string) => {\n          if (error) {\n            reject(error);\n          } else {\n            resolve(result);\n          }\n        },\n      );\n    });\n  }\n\n  /**\n   * Refreshes the current network code.\n   */\n  async lookupNetwork() {\n    if (!this.ethQuery) {\n      return;\n    }\n    const releaseLock = await this.mutex.acquire();\n\n    try {\n      try {\n        const networkId = await this.#getNetworkId();\n        if (this.state.network === networkId) {\n          return;\n        }\n\n        this.update((state) => {\n          state.network = networkId;\n        });\n      } catch (_error) {\n        this.update((state) => {\n          state.network = 'loading';\n        });\n      }\n\n      this.messagingSystem.publish(\n        `NetworkController:providerConfigChange`,\n        this.state.providerConfig,\n      );\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Convenience method to set the current provider config to the private providerConfig class variable.\n   */\n  #setCurrentAsPreviousProvider() {\n    const { type, id } = this.state.providerConfig;\n    if (type === NetworkType.rpc && id) {\n      this.#previousNetworkSpecifier = id;\n    } else {\n      this.#previousNetworkSpecifier = type;\n    }\n  }\n\n  /**\n   * Convenience method to update provider network type settings.\n   *\n   * @param type - Human readable network name.\n   */\n  setProviderType(type: NetworkType) {\n    this.#setCurrentAsPreviousProvider();\n    // If testnet the ticker symbol should use a testnet prefix\n    const ticker =\n      type in NetworksTicker && NetworksTicker[type].length > 0\n        ? NetworksTicker[type]\n        : 'ETH';\n\n    this.update((state) => {\n      state.providerConfig.type = type;\n      state.providerConfig.ticker = ticker;\n      state.providerConfig.chainId = NetworksChainId[type];\n      state.providerConfig.rpcPrefs = BUILT_IN_NETWORKS[type].rpcPrefs;\n      state.providerConfig.rpcTarget = undefined;\n      state.providerConfig.nickname = undefined;\n      state.providerConfig.id = undefined;\n    });\n    this.refreshNetwork();\n  }\n\n  /**\n   * Convenience method to update provider RPC settings.\n   *\n   * @param networkConfigurationId - The unique id for the network configuration to set as the active provider.\n   */\n  setActiveNetwork(networkConfigurationId: string) {\n    this.#setCurrentAsPreviousProvider();\n\n    const targetNetwork =\n      this.state.networkConfigurations[networkConfigurationId];\n\n    if (!targetNetwork) {\n      throw new Error(\n        `networkConfigurationId ${networkConfigurationId} does not match a configured networkConfiguration`,\n      );\n    }\n\n    this.update((state) => {\n      state.providerConfig.type = NetworkType.rpc;\n      state.providerConfig.rpcTarget = targetNetwork.rpcUrl;\n      state.providerConfig.chainId = targetNetwork.chainId;\n      state.providerConfig.ticker = targetNetwork.ticker;\n      state.providerConfig.nickname = targetNetwork.nickname;\n      state.providerConfig.rpcPrefs = targetNetwork.rpcPrefs;\n      state.providerConfig.id = targetNetwork.id;\n    });\n\n    this.refreshNetwork();\n  }\n\n  #getLatestBlock(): Promise<Block> {\n    return new Promise((resolve, reject) => {\n      this.ethQuery.sendAsync(\n        { method: 'eth_getBlockByNumber', params: ['latest', false] },\n        (error: Error, block: Block) => {\n          if (error) {\n            reject(error);\n          } else {\n            resolve(block);\n          }\n        },\n      );\n    });\n  }\n\n  async getEIP1559Compatibility() {\n    const { networkDetails = {} } = this.state;\n\n    if (networkDetails.isEIP1559Compatible || !this.ethQuery) {\n      return true;\n    }\n\n    const latestBlock = await this.#getLatestBlock();\n    const isEIP1559Compatible =\n      typeof latestBlock.baseFeePerGas !== 'undefined';\n    if (networkDetails.isEIP1559Compatible !== isEIP1559Compatible) {\n      this.update((state) => {\n        state.networkDetails.isEIP1559Compatible = isEIP1559Compatible;\n      });\n    }\n    return isEIP1559Compatible;\n  }\n\n  #setProviderAndBlockTracker({\n    provider,\n    blockTracker,\n  }: {\n    provider: Provider;\n    blockTracker: BlockTracker;\n  }) {\n    if (this.#providerProxy) {\n      this.#providerProxy.setTarget(provider);\n    } else {\n      this.#providerProxy = createEventEmitterProxy(provider);\n    }\n    this.#provider = provider;\n\n    if (this.#blockTrackerProxy) {\n      this.#blockTrackerProxy.setTarget(blockTracker);\n    } else {\n      this.#blockTrackerProxy = createEventEmitterProxy(blockTracker, {\n        eventFilter: 'skipInternal',\n      });\n    }\n  }\n\n  /**\n   * Adds a network configuration if the rpcUrl is not already present on an\n   * existing network configuration. Otherwise updates the entry with the matching rpcUrl.\n   *\n   * @param networkConfiguration - The network configuration to add or, if rpcUrl matches an existing entry, to modify.\n   * @param networkConfiguration.rpcUrl -  RPC provider url.\n   * @param networkConfiguration.chainId - Network ID as per EIP-155.\n   * @param networkConfiguration.ticker - Currency ticker.\n   * @param networkConfiguration.nickname - Personalized network name.\n   * @param networkConfiguration.rpcPrefs - Personalized preferences (i.e. preferred blockExplorer)\n   * @param options - additional configuration options.\n   * @param options.setActive - An option to set the newly added networkConfiguration as the active provider.\n   * @param options.referrer - The site from which the call originated, or 'metamask' for internal calls - used for event metrics.\n   * @param options.source - Where the upsertNetwork event originated (i.e. from a dapp or from the network form) - used for event metrics.\n   * @returns id for the added or updated network configuration\n   */\n  upsertNetworkConfiguration(\n    { rpcUrl, chainId, ticker, nickname, rpcPrefs }: NetworkConfiguration,\n    {\n      setActive = false,\n      referrer,\n      source,\n    }: { setActive?: boolean; referrer: string; source: string },\n  ): string {\n    assertIsStrictHexString(chainId);\n\n    if (!isSafeChainId(parseInt(chainId, 16))) {\n      throw new Error(\n        `Invalid chain ID \"${chainId}\": numerical value greater than max safe value.`,\n      );\n    }\n\n    if (!rpcUrl) {\n      throw new Error(\n        'An rpcUrl is required to add or update network configuration',\n      );\n    }\n\n    if (!referrer || !source) {\n      throw new Error(\n        'referrer and source are required arguments for adding or updating a network configuration',\n      );\n    }\n\n    try {\n      // eslint-disable-next-line no-new\n      new URL(rpcUrl);\n    } catch (e: any) {\n      if (e.message.includes('Invalid URL')) {\n        throw new Error('rpcUrl must be a valid URL');\n      }\n    }\n\n    if (!ticker) {\n      throw new Error(\n        'A ticker is required to add or update networkConfiguration',\n      );\n    }\n\n    const newNetworkConfiguration = {\n      rpcUrl,\n      chainId,\n      ticker,\n      nickname,\n      rpcPrefs,\n    };\n\n    const oldNetworkConfigurations = this.state.networkConfigurations;\n\n    const oldNetworkConfigurationId = Object.values(\n      oldNetworkConfigurations,\n    ).find(\n      (networkConfiguration) =>\n        networkConfiguration.rpcUrl?.toLowerCase() === rpcUrl?.toLowerCase(),\n    )?.id;\n\n    const newNetworkConfigurationId = oldNetworkConfigurationId || random();\n    this.update((state) => {\n      state.networkConfigurations = {\n        ...oldNetworkConfigurations,\n        [newNetworkConfigurationId]: {\n          ...newNetworkConfiguration,\n          id: newNetworkConfigurationId,\n        },\n      };\n    });\n\n    if (!oldNetworkConfigurationId) {\n      this.trackMetaMetricsEvent({\n        event: 'Custom Network Added',\n        category: 'Network',\n        referrer: {\n          url: referrer,\n        },\n        properties: {\n          chain_id: chainId,\n          symbol: ticker,\n          source,\n        },\n      });\n    }\n\n    if (setActive) {\n      this.setActiveNetwork(newNetworkConfigurationId);\n    }\n\n    return newNetworkConfigurationId;\n  }\n\n  /**\n   * Removes network configuration from state.\n   *\n   * @param networkConfigurationId - The networkConfigurationId of an existing network configuration\n   */\n  removeNetworkConfiguration(networkConfigurationId: string) {\n    if (!this.state.networkConfigurations[networkConfigurationId]) {\n      throw new Error(\n        `networkConfigurationId ${networkConfigurationId} does not match a configured networkConfiguration`,\n      );\n    }\n    this.update((state) => {\n      delete state.networkConfigurations[networkConfigurationId];\n    });\n  }\n\n  /**\n   * Rolls back provider config to the previous provider in case of errors or inability to connect during network switch.\n   */\n  rollbackToPreviousProvider() {\n    const specifier = this.#previousNetworkSpecifier;\n    if (isNetworkType(specifier)) {\n      this.setProviderType(specifier);\n    } else if (typeof specifier === 'string') {\n      this.setActiveNetwork(specifier);\n    }\n  }\n}\n\nexport default NetworkController;\n"]}

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from './NetworkController';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/network-controller",
-  "version": "5.0.0",
+  "version": "7.0.0",
   "description": "Provides an interface to the currently selected network via a MetaMask-compatible provider object",
   "keywords": [
     "MetaMask",
@@ -30,19 +30,26 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^2.0.0",
-    "@metamask/controller-utils": "^3.0.0",
+    "@metamask/controller-utils": "^3.1.0",
+    "@metamask/swappable-obj-proxy": "^2.1.0",
+    "@metamask/utils": "^3.3.1",
     "async-mutex": "^0.2.6",
     "babel-runtime": "^6.26.0",
     "eth-json-rpc-infura": "^5.1.0",
     "eth-query": "^2.1.2",
     "immer": "^9.0.6",
+    "uuid": "^8.3.2",
     "web3-provider-engine": "^16.0.3"
   },
   "devDependencies": {
+    "@json-rpc-specification/meta-schema": "^1.0.6",
     "@metamask/auto-changelog": "^3.1.0",
     "@types/jest": "^26.0.22",
+    "@types/lodash": "^4.14.191",
     "deepmerge": "^4.2.2",
     "jest": "^26.4.2",
+    "lodash": "^4.17.21",
+    "nock": "^13.0.7",
     "sinon": "^9.2.4",
     "ts-jest": "^26.5.2",
     "typedoc": "^0.22.15",