@metamask/network-controller 4.0.0 → 5.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,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6
6
 
7
7
  ## [Unreleased]
8
8
 
9
+ ## [5.0.0]
10
+ ### Changed
11
+ - **BREAKING:** Rename `properties` property in state object to `networkDetails` ([#1074](https://github.com/MetaMask/controllers/pull/1074))
12
+
13
+ ### Removed
14
+ - **BREAKING:** Remove `isomorphic-fetch` ([#1106](https://github.com/MetaMask/controllers/pull/1106))
15
+ - Consumers must now import `isomorphic-fetch` or another polyfill themselves if they are running in an environment without `fetch`
16
+
9
17
  ## [4.0.0]
10
18
  ### Changed
11
19
  - **BREAKING:** Update type of state object by renaming `properties` property to `networkDetails` ([#1074](https://github.com/MetaMask/core/pull/1074))
@@ -42,7 +50,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
42
50
 
43
51
  All changes listed after this point were applied to this package following the monorepo conversion.
44
52
 
45
- [Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@4.0.0...HEAD
53
+ [Unreleased]: https://github.com/MetaMask/core/compare/@metamask/network-controller@5.0.0...HEAD
54
+ [5.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@4.0.0...@metamask/network-controller@5.0.0
46
55
  [4.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@3.0.0...@metamask/network-controller@4.0.0
47
56
  [3.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@2.0.0...@metamask/network-controller@3.0.0
48
57
  [2.0.0]: https://github.com/MetaMask/core/compare/@metamask/network-controller@1.0.0...@metamask/network-controller@2.0.0
@@ -176,7 +176,7 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
176
176
  */
177
177
  lookupNetwork() {
178
178
  return __awaiter(this, void 0, void 0, function* () {
179
- if (!this.ethQuery || !this.ethQuery.sendAsync) {
179
+ if (!this.ethQuery) {
180
180
  return;
181
181
  }
182
182
  const releaseLock = yield this.mutex.acquire();
@@ -241,11 +241,9 @@ class NetworkController extends base_controller_1.BaseControllerV2 {
241
241
  this.refreshNetwork();
242
242
  }
243
243
  getEIP1559Compatibility() {
244
- var _a;
245
244
  return __awaiter(this, void 0, void 0, function* () {
246
245
  const { networkDetails = {} } = this.state;
247
- if (networkDetails.isEIP1559Compatible ||
248
- typeof ((_a = this.ethQuery) === null || _a === void 0 ? void 0 : _a.sendAsync) !== 'function') {
246
+ if (networkDetails.isEIP1559Compatible || !this.ethQuery) {
249
247
  return true;
250
248
  }
251
249
  const latestBlock = yield __classPrivateFieldGet(this, _NetworkController_instances, "m", _NetworkController_getLatestBlock).call(this);
@@ -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,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;gBAC9C,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,IACE,cAAc,CAAC,mBAAmB;gBAClC,OAAO,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,CAAA,KAAK,UAAU,EAC9C;gBACA,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;;KAC5B;CACF;AA/TD,8CA+TC;;;QAlIG,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;AAwBH,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 || !this.ethQuery.sendAsync) {\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 (\n networkDetails.isEIP1559Compatible ||\n typeof this.ethQuery?.sendAsync !== 'function'\n ) {\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,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"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask/network-controller",
3
- "version": "4.0.0",
3
+ "version": "5.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",
@@ -29,8 +29,8 @@
29
29
  "test:watch": "jest --watch"
30
30
  },
31
31
  "dependencies": {
32
- "@metamask/base-controller": "^1.1.2",
33
- "@metamask/controller-utils": "^2.0.0",
32
+ "@metamask/base-controller": "^2.0.0",
33
+ "@metamask/controller-utils": "^3.0.0",
34
34
  "async-mutex": "^0.2.6",
35
35
  "babel-runtime": "^6.26.0",
36
36
  "eth-json-rpc-infura": "^5.1.0",