@metamask-previews/network-controller 24.1.0-preview-8029191 → 24.1.0-preview-e85a6854

package/CHANGELOG.md

@@ -10,8 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6525](https://github.com/MetaMask/core/pull/6525))
-- Add `lookupNetwork` option to `initializeProvider`, to allow for skipping the request used to populate metadata for the globally selected network ([#6575](https://github.com/MetaMask/core/pull/6575), [#6607](https://github.com/MetaMask/core/pull/6607))
-  - If `lookupNetwork` is set to `false`, the function is fully synchronous, and does not return a promise.
+- Add `lookupNetwork` option to `initializeProvider`, to allow for skipping the request used to populate metadata for the globally selected network ([#6575](https://github.com/MetaMask/core/pull/6575))
 
 ### Changed
 

package/dist/NetworkController.cjs

@@ -565,12 +565,29 @@ class NetworkController extends base_controller_1.BaseController {
         }
         return customNetworkClient;
     }
-    initializeProvider({ lookupNetwork = true, } = {}) {
+    /**
+     * Creates proxies for accessing the global network client and its block
+     * tracker. You must call this method in order to use
+     * `getProviderAndBlockTracker` (or its replacement,
+     * `getSelectedNetworkClient`).
+     *
+     * @param options - Optional arguments.
+     * @param options.lookupNetwork - Usually, metadata for the global network
+     * will be populated via a call to `lookupNetwork` after creating the provider
+     * and block tracker proxies. This allows for responding to the status of the
+     * global network after initializing this controller; however, it requires
+     * making a request to the network to do so. In the clients, where controllers
+     * are initialized before the UI is shown, this may be undesirable, as it
+     * means that if the user has just installed MetaMask, their IP address may be
+     * shared with a third party before they have a chance to finish onboarding.
+     * You can pass `false` if you'd like to disable this request and call
+     * `lookupNetwork` yourself.
+     */
+    async initializeProvider({ lookupNetwork = true, } = {}) {
         __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_applyNetworkSelection).call(this, this.state.selectedNetworkClientId);
         if (lookupNetwork) {
-            return this.lookupNetwork();
+            await this.lookupNetwork();
         }
-        return undefined;
     }
     /**
      * Uses a request for the latest block to gather the following information on