@metamask/network-controller 5.0.0 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6
6
 
7
7
  ## [Unreleased]
8
8
 
9
+ ## [6.0.0]
10
+ ### Added
11
+ - Add rollbackToPreviousProvider method ([#1132](https://github.com/MetaMask/core/pull/1132))
12
+
13
+ ### Changed
14
+ - **BREAKING:** Migrate network configurations from `PreferencesController` to `NetworkController` ([#1064](https://github.com/MetaMask/core/pull/1064))
15
+ - Consumers will need to adapt to reading network data from `NetworkConfigurations` state on `NetworkController` rather than `frequentRpcList` on `PreferencesController`.
16
+ - `setRpcTarget` becomes `setActiveNetwork` on `NetworkController` and accepts a `networkConfigurationId` argument rather than an `rpcUrl`.
17
+ - `addToFrequentRpcList` on `PreferencesController` becomes `upsertNetworkConfiguration` on `NetworkController`.
18
+ - `removeFromFrequentRpcList` on `PreferencesController` becomes `removeNetworkConfiguration` on `NetworkController`
19
+ - The `NetworkController` requires a `trackMetaMetricsEvent` callback function argument in its constructor.
20
+ - **BREAKING:** Expose `getProviderAndBlockTracker` instead of `provider` ([#1091](https://github.com/MetaMask/core/pull/1091))
21
+ - 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.
22
+
9
23
  ## [5.0.0]
10
24
  ### Changed
11
25
  - **BREAKING:** Rename `properties` property in state object to `networkDetails` ([#1074](https://github.com/MetaMask/controllers/pull/1074))
@@ -50,7 +64,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
50
64
 
51
65
  All changes listed after this point were applied to this package following the monorepo conversion.
52
66
 
53
- [Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@5.0.0...HEAD
67
+ [Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@6.0.0...HEAD
68
+ [6.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@5.0.0...@metamask/network-controller@6.0.0
54
69
  [5.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@4.0.0...@metamask/network-controller@5.0.0
55
70
  [4.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@3.0.0...@metamask/network-controller@4.0.0
56
71
  [3.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@2.0.0...@metamask/network-controller@3.0.0
@@ -1,3 +1,4 @@
1
+ import type { SwappableProxy } from '@metamask/swappable-obj-proxy';
1
2
  import type { Patch } from 'immer';
2
3
  import { BaseControllerV2, RestrictedControllerMessenger } from '@metamask/base-controller';
3
4
  import { NetworkType } from '@metamask/controller-utils';
@@ -10,6 +11,7 @@ import { NetworkType } from '@metamask/controller-utils';
10
11
  * @property chainId - Network ID as per EIP-155.
11
12
  * @property ticker - Currency ticker.
12
13
  * @property nickname - Personalized network name.
14
+ * @property id - Network Configuration Id.
13
15
  */
14
16
  export declare type ProviderConfig = {
15
17
  rpcTarget?: string;
@@ -17,6 +19,10 @@ export declare type ProviderConfig = {
17
19
  chainId: string;
18
20
  ticker?: string;
19
21
  nickname?: string;
22
+ rpcPrefs?: {
23
+ blockExplorerUrl?: string;
24
+ };
25
+ id?: NetworkConfigurationId;
20
26
  };
21
27
  export declare type Block = {
22
28
  baseFeePerGas?: string;
@@ -24,22 +30,48 @@ export declare type Block = {
24
30
  export declare type NetworkDetails = {
25
31
  isEIP1559Compatible?: boolean;
26
32
  };
33
+ /**
34
+ * Custom RPC network information
35
+ *
36
+ * @property rpcTarget - RPC target URL.
37
+ * @property chainId - Network ID as per EIP-155
38
+ * @property nickname - Personalized network name.
39
+ * @property ticker - Currency ticker.
40
+ * @property rpcPrefs - Personalized preferences.
41
+ */
42
+ export declare type NetworkConfiguration = {
43
+ rpcUrl: string;
44
+ chainId: string;
45
+ ticker: string;
46
+ nickname?: string;
47
+ rpcPrefs?: {
48
+ blockExplorerUrl: string;
49
+ };
50
+ };
27
51
  /**
28
52
  * @type NetworkState
29
53
  *
30
54
  * Network controller state
31
- * @property network - Network ID as per net_version
32
- * @property isCustomNetwork - Identifies if the network is a custom network
33
- * @property provider - RPC URL and network name provider settings
55
+ * @property network - Network ID as per net_version of the currently connected network
56
+ * @property isCustomNetwork - Identifies if the currently connected network is a custom network
57
+ * @property providerConfig - RPC URL and network name provider settings of the currently connected network
58
+ * @property properties - an additional set of network properties for the currently connected network
59
+ * @property networkConfigurations - the full list of configured networks either preloaded or added by the user.
34
60
  */
35
61
  export declare type NetworkState = {
36
62
  network: string;
37
63
  isCustomNetwork: boolean;
38
64
  providerConfig: ProviderConfig;
39
65
  networkDetails: NetworkDetails;
66
+ networkConfigurations: Record<string, NetworkConfiguration & {
67
+ id: string;
68
+ }>;
40
69
  };
41
70
  declare const name = "NetworkController";
42
71
  export declare type EthQuery = any;
72
+ declare type Provider = any;
73
+ export declare type ProviderProxy = SwappableProxy<Provider>;
74
+ declare type BlockTracker = any;
43
75
  export declare type NetworkControllerStateChangeEvent = {
44
76
  type: `NetworkController:stateChange`;
45
77
  payload: [NetworkState, Patch[]];
@@ -61,10 +93,12 @@ export declare type NetworkControllerActions = NetworkControllerGetProviderConfi
61
93
  export declare type NetworkControllerMessenger = RestrictedControllerMessenger<typeof name, NetworkControllerGetProviderConfigAction | NetworkControllerGetEthQueryAction, NetworkControllerStateChangeEvent | NetworkControllerProviderConfigChangeEvent, string, string>;
62
94
  export declare type NetworkControllerOptions = {
63
95
  messenger: NetworkControllerMessenger;
96
+ trackMetaMetricsEvent: () => void;
64
97
  infuraProjectId?: string;
65
98
  state?: Partial<NetworkState>;
66
99
  };
67
100
  export declare const defaultState: NetworkState;
101
+ declare type NetworkConfigurationId = string;
68
102
  /**
69
103
  * Controller that creates and manages an Ethereum network provider.
70
104
  */
@@ -73,9 +107,14 @@ export declare class NetworkController extends BaseControllerV2<typeof name, Net
73
107
  private ethQuery;
74
108
  private internalProviderConfig;
75
109
  private infuraProjectId;
110
+ private trackMetaMetricsEvent;
76
111
  private mutex;
77
- constructor({ messenger, state, infuraProjectId }: NetworkControllerOptions);
112
+ constructor({ messenger, state, infuraProjectId, trackMetaMetricsEvent, }: NetworkControllerOptions);
78
113
  private initializeProvider;
114
+ getProviderAndBlockTracker(): {
115
+ provider: SwappableProxy<Provider> | undefined;
116
+ blockTracker: SwappableProxy<BlockTracker> | undefined;
117
+ };
79
118
  private refreshNetwork;
80
119
  private registerProvider;
81
120
  private setupInfuraProvider;
@@ -84,10 +123,6 @@ export declare class NetworkController extends BaseControllerV2<typeof name, Net
84
123
  private updateProvider;
85
124
  private safelyStopProvider;
86
125
  private verifyNetwork;
87
- /**
88
- * Ethereum provider object for the current network
89
- */
90
- provider: any;
91
126
  /**
92
127
  * Sets a new configuration for web3-provider-engine.
93
128
  *
@@ -110,12 +145,40 @@ export declare class NetworkController extends BaseControllerV2<typeof name, Net
110
145
  /**
111
146
  * Convenience method to update provider RPC settings.
112
147
  *
113
- * @param rpcTarget - The RPC endpoint URL.
114
- * @param chainId - The chain ID as per EIP-155.
115
- * @param ticker - The currency ticker.
116
- * @param nickname - Personalized network name.
148
+ * @param networkConfigurationId - The unique id for the network configuration to set as the active provider.
117
149
  */
118
- setRpcTarget(rpcTarget: string, chainId: string, ticker?: string, nickname?: string): void;
150
+ setActiveNetwork(networkConfigurationId: string): void;
119
151
  getEIP1559Compatibility(): Promise<boolean>;
152
+ /**
153
+ * Adds a network configuration if the rpcUrl is not already present on an
154
+ * existing network configuration. Otherwise updates the entry with the matching rpcUrl.
155
+ *
156
+ * @param networkConfiguration - The network configuration to add or, if rpcUrl matches an existing entry, to modify.
157
+ * @param networkConfiguration.rpcUrl - RPC provider url.
158
+ * @param networkConfiguration.chainId - Network ID as per EIP-155.
159
+ * @param networkConfiguration.ticker - Currency ticker.
160
+ * @param networkConfiguration.nickname - Personalized network name.
161
+ * @param networkConfiguration.rpcPrefs - Personalized preferences (i.e. preferred blockExplorer)
162
+ * @param options - additional configuration options.
163
+ * @param options.setActive - An option to set the newly added networkConfiguration as the active provider.
164
+ * @param options.referrer - The site from which the call originated, or 'metamask' for internal calls - used for event metrics.
165
+ * @param options.source - Where the upsertNetwork event originated (i.e. from a dapp or from the network form) - used for event metrics.
166
+ * @returns id for the added or updated network configuration
167
+ */
168
+ upsertNetworkConfiguration({ rpcUrl, chainId, ticker, nickname, rpcPrefs }: NetworkConfiguration, { setActive, referrer, source, }: {
169
+ setActive?: boolean;
170
+ referrer: string;
171
+ source: string;
172
+ }): string;
173
+ /**
174
+ * Removes network configuration from state.
175
+ *
176
+ * @param networkConfigurationId - The networkConfigurationId of an existing network configuration
177
+ */
178
+ removeNetworkConfiguration(networkConfigurationId: string): void;
179
+ /**
180
+ * Rolls back provider config to the previous provider in case of errors or inability to connect during network switch.
181
+ */
182
+ rollbackToPreviousProvider(): void;
120
183
  }
121
184
  export default NetworkController;
@@ -8,6 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
8
8
  step((generator = generator.apply(thisArg, _arguments || [])).next());
9
9
  });
10
10
  };
11
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
12
+ if (kind === "m") throw new TypeError("Private method is not writable");
13
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
14
+ 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");
15
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
16
+ };
11
17
  var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
12
18
  if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
13
19
  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 (
16
22
  var __importDefault = (this && this.__importDefault) || function (mod) {
17
23
  return (mod && mod.__esModule) ? mod : { "default": mod };
18
24
  };
19
- var _NetworkController_instances, _NetworkController_getNetworkId, _NetworkController_getLatestBlock;
25
+ var _NetworkController_instances, _NetworkController_previousNetworkSpecifier, _NetworkController_provider, _NetworkController_providerProxy, _NetworkController_blockTrackerProxy, _NetworkController_getNetworkId, _NetworkController_setCurrentAsPreviousProvider, _NetworkController_getLatestBlock, _NetworkController_setProviderAndBlockTracker;
20
26
  Object.defineProperty(exports, "__esModule", { value: true });
21
27
  exports.NetworkController = exports.defaultState = void 0;
22
28
  const eth_query_1 = __importDefault(require("eth-query"));
23
29
  const provider_1 = __importDefault(require("web3-provider-engine/subproviders/provider"));
24
30
  const createProvider_1 = __importDefault(require("eth-json-rpc-infura/src/createProvider"));
25
31
  const zero_1 = __importDefault(require("web3-provider-engine/zero"));
32
+ const swappable_obj_proxy_1 = require("@metamask/swappable-obj-proxy");
26
33
  const async_mutex_1 = require("async-mutex");
34
+ const uuid_1 = require("uuid");
27
35
  const base_controller_1 = require("@metamask/base-controller");
28
36
  const controller_utils_1 = require("@metamask/controller-utils");
37
+ const utils_1 = require("@metamask/utils");
29
38
  const LOCALHOST_RPC_URL = 'http://localhost:8545';
30
39
  const name = 'NetworkController';
31
40
  exports.defaultState = {
32
41
  network: 'loading',
33
42
  isCustomNetwork: false,
34
- providerConfig: { type: controller_utils_1.MAINNET, chainId: controller_utils_1.NetworksChainId.mainnet },
43
+ providerConfig: {
44
+ type: controller_utils_1.NetworkType.mainnet,
45
+ chainId: controller_utils_1.NetworksChainId.mainnet,
46
+ },
35
47
  networkDetails: { isEIP1559Compatible: false },
48
+ networkConfigurations: {},
36
49
  };
37
50
  /**
38
51
  * Controller that creates and manages an Ethereum network provider.
39
52
  */
40
53
  class NetworkController extends base_controller_1.BaseControllerV2 {
41
- constructor({ messenger, state, infuraProjectId }) {
54
+ constructor({ messenger, state, infuraProjectId, trackMetaMetricsEvent, }) {
42
55
  super({
43
56
  name,
44
57
  metadata: {
@@ -58,6 +71,10 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
58
71
  persist: true,
59
72
  anonymous: false,
60
73
  },
74
+ networkConfigurations: {
75
+ persist: true,
76
+ anonymous: false,
77
+ },
61
78
  },
62
79
  messenger,
63
80
  state: Object.assign(Object.assign({}, exports.defaultState), state),
@@ -65,28 +82,34 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
65
82
  _NetworkController_instances.add(this);
66
83
  this.internalProviderConfig = {};
67
84
  this.mutex = new async_mutex_1.Mutex();
85
+ _NetworkController_previousNetworkSpecifier.set(this, void 0);
86
+ _NetworkController_provider.set(this, void 0);
87
+ _NetworkController_providerProxy.set(this, void 0);
88
+ _NetworkController_blockTrackerProxy.set(this, void 0);
68
89
  this.infuraProjectId = infuraProjectId;
90
+ this.trackMetaMetricsEvent = trackMetaMetricsEvent;
69
91
  this.messagingSystem.registerActionHandler(`${this.name}:getProviderConfig`, () => {
70
92
  return this.state.providerConfig;
71
93
  });
72
94
  this.messagingSystem.registerActionHandler(`${this.name}:getEthQuery`, () => {
73
95
  return this.ethQuery;
74
96
  });
97
+ __classPrivateFieldSet(this, _NetworkController_previousNetworkSpecifier, this.state.providerConfig.type, "f");
75
98
  }
76
99
  initializeProvider(type, rpcTarget, chainId, ticker, nickname) {
77
100
  this.update((state) => {
78
101
  state.isCustomNetwork = this.getIsCustomNetwork(chainId);
79
102
  });
80
103
  switch (type) {
81
- case controller_utils_1.MAINNET:
82
- case 'goerli':
83
- case 'sepolia':
104
+ case controller_utils_1.NetworkType.mainnet:
105
+ case controller_utils_1.NetworkType.goerli:
106
+ case controller_utils_1.NetworkType.sepolia:
84
107
  this.setupInfuraProvider(type);
85
108
  break;
86
- case 'localhost':
109
+ case controller_utils_1.NetworkType.localhost:
87
110
  this.setupStandardProvider(LOCALHOST_RPC_URL);
88
111
  break;
89
- case controller_utils_1.RPC:
112
+ case controller_utils_1.NetworkType.rpc:
90
113
  rpcTarget &&
91
114
  this.setupStandardProvider(rpcTarget, chainId, ticker, nickname);
92
115
  break;
@@ -95,6 +118,12 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
95
118
  }
96
119
  this.getEIP1559Compatibility();
97
120
  }
121
+ getProviderAndBlockTracker() {
122
+ return {
123
+ provider: __classPrivateFieldGet(this, _NetworkController_providerProxy, "f"),
124
+ blockTracker: __classPrivateFieldGet(this, _NetworkController_blockTrackerProxy, "f"),
125
+ };
126
+ }
98
127
  refreshNetwork() {
99
128
  this.update((state) => {
100
129
  state.network = 'loading';
@@ -105,8 +134,11 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
105
134
  this.lookupNetwork();
106
135
  }
107
136
  registerProvider() {
108
- this.provider.on('error', this.verifyNetwork.bind(this));
109
- this.ethQuery = new eth_query_1.default(this.provider);
137
+ const { provider } = this.getProviderAndBlockTracker();
138
+ if (provider) {
139
+ provider.on('error', this.verifyNetwork.bind(this));
140
+ this.ethQuery = new eth_query_1.default(provider);
141
+ }
110
142
  }
111
143
  setupInfuraProvider(type) {
112
144
  const infuraProvider = (0, createProvider_1.default)({
@@ -140,8 +172,11 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
140
172
  this.updateProvider((0, zero_1.default)(config));
141
173
  }
142
174
  updateProvider(provider) {
143
- this.safelyStopProvider(this.provider);
144
- this.provider = provider;
175
+ this.safelyStopProvider(__classPrivateFieldGet(this, _NetworkController_provider, "f"));
176
+ __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_setProviderAndBlockTracker).call(this, {
177
+ provider,
178
+ blockTracker: provider._blockTracker,
179
+ });
145
180
  this.registerProvider();
146
181
  }
147
182
  safelyStopProvider(provider) {
@@ -163,9 +198,7 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
163
198
  this.internalProviderConfig = providerConfig;
164
199
  const { type, rpcTarget, chainId, ticker, nickname } = this.state.providerConfig;
165
200
  this.initializeProvider(type, rpcTarget, chainId, ticker, nickname);
166
- if (this.provider !== undefined) {
167
- this.registerProvider();
168
- }
201
+ this.registerProvider();
169
202
  this.lookupNetwork();
170
203
  }
171
204
  get providerConfig() {
@@ -208,35 +241,41 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
208
241
  * @param type - Human readable network name.
209
242
  */
210
243
  setProviderType(type) {
244
+ __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_setCurrentAsPreviousProvider).call(this);
211
245
  // If testnet the ticker symbol should use a testnet prefix
212
- const ticker = type in controller_utils_1.TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL &&
213
- controller_utils_1.TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type].length > 0
214
- ? controller_utils_1.TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type]
246
+ const ticker = type in controller_utils_1.NetworksTicker && controller_utils_1.NetworksTicker[type].length > 0
247
+ ? controller_utils_1.NetworksTicker[type]
215
248
  : 'ETH';
216
249
  this.update((state) => {
217
250
  state.providerConfig.type = type;
218
251
  state.providerConfig.ticker = ticker;
219
252
  state.providerConfig.chainId = controller_utils_1.NetworksChainId[type];
253
+ state.providerConfig.rpcPrefs = controller_utils_1.BUILT_IN_NETWORKS[type].rpcPrefs;
220
254
  state.providerConfig.rpcTarget = undefined;
221
255
  state.providerConfig.nickname = undefined;
256
+ state.providerConfig.id = undefined;
222
257
  });
223
258
  this.refreshNetwork();
224
259
  }
225
260
  /**
226
261
  * Convenience method to update provider RPC settings.
227
262
  *
228
- * @param rpcTarget - The RPC endpoint URL.
229
- * @param chainId - The chain ID as per EIP-155.
230
- * @param ticker - The currency ticker.
231
- * @param nickname - Personalized network name.
263
+ * @param networkConfigurationId - The unique id for the network configuration to set as the active provider.
232
264
  */
233
- setRpcTarget(rpcTarget, chainId, ticker, nickname) {
265
+ setActiveNetwork(networkConfigurationId) {
266
+ __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_setCurrentAsPreviousProvider).call(this);
267
+ const targetNetwork = this.state.networkConfigurations[networkConfigurationId];
268
+ if (!targetNetwork) {
269
+ throw new Error(`networkConfigurationId ${networkConfigurationId} does not match a configured networkConfiguration`);
270
+ }
234
271
  this.update((state) => {
235
- state.providerConfig.type = controller_utils_1.RPC;
236
- state.providerConfig.rpcTarget = rpcTarget;
237
- state.providerConfig.chainId = chainId;
238
- state.providerConfig.ticker = ticker;
239
- state.providerConfig.nickname = nickname;
272
+ state.providerConfig.type = controller_utils_1.NetworkType.rpc;
273
+ state.providerConfig.rpcTarget = targetNetwork.rpcUrl;
274
+ state.providerConfig.chainId = targetNetwork.chainId;
275
+ state.providerConfig.ticker = targetNetwork.ticker;
276
+ state.providerConfig.nickname = targetNetwork.nickname;
277
+ state.providerConfig.rpcPrefs = targetNetwork.rpcPrefs;
278
+ state.providerConfig.id = targetNetwork.id;
240
279
  });
241
280
  this.refreshNetwork();
242
281
  }
@@ -256,9 +295,106 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
256
295
  return isEIP1559Compatible;
257
296
  });
258
297
  }
298
+ /**
299
+ * Adds a network configuration if the rpcUrl is not already present on an
300
+ * existing network configuration. Otherwise updates the entry with the matching rpcUrl.
301
+ *
302
+ * @param networkConfiguration - The network configuration to add or, if rpcUrl matches an existing entry, to modify.
303
+ * @param networkConfiguration.rpcUrl - RPC provider url.
304
+ * @param networkConfiguration.chainId - Network ID as per EIP-155.
305
+ * @param networkConfiguration.ticker - Currency ticker.
306
+ * @param networkConfiguration.nickname - Personalized network name.
307
+ * @param networkConfiguration.rpcPrefs - Personalized preferences (i.e. preferred blockExplorer)
308
+ * @param options - additional configuration options.
309
+ * @param options.setActive - An option to set the newly added networkConfiguration as the active provider.
310
+ * @param options.referrer - The site from which the call originated, or 'metamask' for internal calls - used for event metrics.
311
+ * @param options.source - Where the upsertNetwork event originated (i.e. from a dapp or from the network form) - used for event metrics.
312
+ * @returns id for the added or updated network configuration
313
+ */
314
+ upsertNetworkConfiguration({ rpcUrl, chainId, ticker, nickname, rpcPrefs }, { setActive = false, referrer, source, }) {
315
+ var _a;
316
+ (0, utils_1.assertIsStrictHexString)(chainId);
317
+ if (!(0, controller_utils_1.isSafeChainId)(parseInt(chainId, 16))) {
318
+ throw new Error(`Invalid chain ID "${chainId}": numerical value greater than max safe value.`);
319
+ }
320
+ if (!rpcUrl) {
321
+ throw new Error('An rpcUrl is required to add or update network configuration');
322
+ }
323
+ if (!referrer || !source) {
324
+ throw new Error('referrer and source are required arguments for adding or updating a network configuration');
325
+ }
326
+ try {
327
+ // eslint-disable-next-line no-new
328
+ new URL(rpcUrl);
329
+ }
330
+ catch (e) {
331
+ if (e.message.includes('Invalid URL')) {
332
+ throw new Error('rpcUrl must be a valid URL');
333
+ }
334
+ }
335
+ if (!ticker) {
336
+ throw new Error('A ticker is required to add or update networkConfiguration');
337
+ }
338
+ const newNetworkConfiguration = {
339
+ rpcUrl,
340
+ chainId,
341
+ ticker,
342
+ nickname,
343
+ rpcPrefs,
344
+ };
345
+ const oldNetworkConfigurations = this.state.networkConfigurations;
346
+ 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;
347
+ const newNetworkConfigurationId = oldNetworkConfigurationId || (0, uuid_1.v4)();
348
+ this.update((state) => {
349
+ state.networkConfigurations = Object.assign(Object.assign({}, oldNetworkConfigurations), { [newNetworkConfigurationId]: Object.assign(Object.assign({}, newNetworkConfiguration), { id: newNetworkConfigurationId }) });
350
+ });
351
+ if (!oldNetworkConfigurationId) {
352
+ this.trackMetaMetricsEvent({
353
+ event: 'Custom Network Added',
354
+ category: 'Network',
355
+ referrer: {
356
+ url: referrer,
357
+ },
358
+ properties: {
359
+ chain_id: chainId,
360
+ symbol: ticker,
361
+ source,
362
+ },
363
+ });
364
+ }
365
+ if (setActive) {
366
+ this.setActiveNetwork(newNetworkConfigurationId);
367
+ }
368
+ return newNetworkConfigurationId;
369
+ }
370
+ /**
371
+ * Removes network configuration from state.
372
+ *
373
+ * @param networkConfigurationId - The networkConfigurationId of an existing network configuration
374
+ */
375
+ removeNetworkConfiguration(networkConfigurationId) {
376
+ if (!this.state.networkConfigurations[networkConfigurationId]) {
377
+ throw new Error(`networkConfigurationId ${networkConfigurationId} does not match a configured networkConfiguration`);
378
+ }
379
+ this.update((state) => {
380
+ delete state.networkConfigurations[networkConfigurationId];
381
+ });
382
+ }
383
+ /**
384
+ * Rolls back provider config to the previous provider in case of errors or inability to connect during network switch.
385
+ */
386
+ rollbackToPreviousProvider() {
387
+ const specifier = __classPrivateFieldGet(this, _NetworkController_previousNetworkSpecifier, "f");
388
+ if ((0, controller_utils_1.isNetworkType)(specifier)) {
389
+ this.setProviderType(specifier);
390
+ }
391
+ else if (typeof specifier === 'string') {
392
+ this.setActiveNetwork(specifier);
393
+ }
394
+ }
259
395
  }
260
396
  exports.NetworkController = NetworkController;
261
- _NetworkController_instances = new WeakSet(), _NetworkController_getNetworkId = function _NetworkController_getNetworkId() {
397
+ _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() {
262
398
  return __awaiter(this, void 0, void 0, function* () {
263
399
  return yield new Promise((resolve, reject) => {
264
400
  this.ethQuery.sendAsync({ method: 'net_version' }, (error, result) => {
@@ -271,6 +407,14 @@ _NetworkController_instances = new WeakSet(), _NetworkController_getNetworkId =
271
407
  });
272
408
  });
273
409
  });
410
+ }, _NetworkController_setCurrentAsPreviousProvider = function _NetworkController_setCurrentAsPreviousProvider() {
411
+ const { type, id } = this.state.providerConfig;
412
+ if (type === controller_utils_1.NetworkType.rpc && id) {
413
+ __classPrivateFieldSet(this, _NetworkController_previousNetworkSpecifier, id, "f");
414
+ }
415
+ else {
416
+ __classPrivateFieldSet(this, _NetworkController_previousNetworkSpecifier, type, "f");
417
+ }
274
418
  }, _NetworkController_getLatestBlock = function _NetworkController_getLatestBlock() {
275
419
  return new Promise((resolve, reject) => {
276
420
  this.ethQuery.sendAsync({ method: 'eth_getBlockByNumber', params: ['latest', false] }, (error, block) => {
@@ -282,6 +426,22 @@ _NetworkController_instances = new WeakSet(), _NetworkController_getNetworkId =
282
426
  }
283
427
  });
284
428
  });
429
+ }, _NetworkController_setProviderAndBlockTracker = function _NetworkController_setProviderAndBlockTracker({ provider, blockTracker, }) {
430
+ if (__classPrivateFieldGet(this, _NetworkController_providerProxy, "f")) {
431
+ __classPrivateFieldGet(this, _NetworkController_providerProxy, "f").setTarget(provider);
432
+ }
433
+ else {
434
+ __classPrivateFieldSet(this, _NetworkController_providerProxy, (0, swappable_obj_proxy_1.createEventEmitterProxy)(provider), "f");
435
+ }
436
+ __classPrivateFieldSet(this, _NetworkController_provider, provider, "f");
437
+ if (__classPrivateFieldGet(this, _NetworkController_blockTrackerProxy, "f")) {
438
+ __classPrivateFieldGet(this, _NetworkController_blockTrackerProxy, "f").setTarget(blockTracker);
439
+ }
440
+ else {
441
+ __classPrivateFieldSet(this, _NetworkController_blockTrackerProxy, (0, swappable_obj_proxy_1.createEventEmitterProxy)(blockTracker, {
442
+ eventFilter: 'skipInternal',
443
+ }), "f");
444
+ }
285
445
  };
286
446
  exports.default = NetworkController;
287
447
  //# sourceMappingURL=NetworkController.js.map
@@ -1 +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"]}
1
+ {"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;IAmBC,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;;QAhDG,2BAAsB,GAAmB,EAAoB,CAAC;QAM9D,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,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,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,kBAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1D,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,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,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;;;;;;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,CAAC,gBAAgB,EAAE,CAAC;QACxB,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;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;AAhhBD,8CAghBC;;;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 internalProviderConfig: ProviderConfig = {} as ProviderConfig;\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 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 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.initializeProvider(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 ...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: 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 * 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 this.registerProvider();\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 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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask/network-controller",
3
- "version": "5.0.0",
3
+ "version": "6.0.0",
4
4
  "description": "Provides an interface to the currently selected network via a MetaMask-compatible provider object",
5
5
  "keywords": [
6
6
  "MetaMask",
@@ -30,19 +30,26 @@
30
30
  },
31
31
  "dependencies": {
32
32
  "@metamask/base-controller": "^2.0.0",
33
- "@metamask/controller-utils": "^3.0.0",
33
+ "@metamask/controller-utils": "^3.1.0",
34
+ "@metamask/swappable-obj-proxy": "^2.1.0",
35
+ "@metamask/utils": "^3.3.1",
34
36
  "async-mutex": "^0.2.6",
35
37
  "babel-runtime": "^6.26.0",
36
38
  "eth-json-rpc-infura": "^5.1.0",
37
39
  "eth-query": "^2.1.2",
38
40
  "immer": "^9.0.6",
41
+ "uuid": "^8.3.2",
39
42
  "web3-provider-engine": "^16.0.3"
40
43
  },
41
44
  "devDependencies": {
45
+ "@json-rpc-specification/meta-schema": "^1.0.6",
42
46
  "@metamask/auto-changelog": "^3.1.0",
43
47
  "@types/jest": "^26.0.22",
48
+ "@types/lodash": "^4.14.191",
44
49
  "deepmerge": "^4.2.2",
45
50
  "jest": "^26.4.2",
51
+ "lodash": "^4.17.21",
52
+ "nock": "^13.0.7",
46
53
  "sinon": "^9.2.4",
47
54
  "ts-jest": "^26.5.2",
48
55
  "typedoc": "^0.22.15",