@metamask/selected-network-controller - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0

CHANGELOG.md

@@ -9,2 +9,12 @@ # Changelog
 
+## [3.0.0]
+### Changed
+- **BREAKING:** Bump dependency and peer dependency on `@metamask/network-controller` to ^14.0.0 ([#1747](https://github.com/MetaMask/core/pull/1747))
+- **BREAKING:** Move from `json-rpc-engine` ^7.1.1 to `@metamask/json-rpc-engine` ^8.0.0 ([#1653](https://github.com/MetaMask/core/pull/1653))
+- **BREAKING:** Bump dependency and peer dependency on `@metamask/network-controller` to ^15.0.0
+- Bump dependency on `@metamask/base-controller` to ^3.2.3 ([#1747](https://github.com/MetaMask/core/pull/1747))
+
+### Fixed
+- `setNetworkClientIdForDomain()` will now ignore the passed in domain value and set the `networkClientId` for the metamask domain instead when the `state.perDomainNetwork` flag is false (default) ([#1757](https://github.com/MetaMask/core/pull/1757))
+
 ## [2.0.1]
@@ -22,5 +32,6 @@ ### Changed
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/selected-network-controller@2.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/selected-network-controller@3.0.0...HEAD
+[3.0.0]: https://github.com/MetaMask/core/compare/@metamask/selected-network-controller@2.0.1...@metamask/selected-network-controller@3.0.0
 [2.0.1]: https://github.com/MetaMask/core/compare/@metamask/selected-network-controller@2.0.0...@metamask/selected-network-controller@2.0.1
 [2.0.0]: https://github.com/MetaMask/core/compare/@metamask/selected-network-controller@1.0.0...@metamask/selected-network-controller@2.0.0
 [1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/selected-network-controller@1.0.0

dist/SelectedNetworkController.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"SelectedNetworkController.d.ts","sourceRoot":"","sources":["../src/SelectedNetworkController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EACV,eAAe,EACf,iCAAiC,EAElC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,QAAA,MAAM,cAAc,8BAA8B,CAAC;AAYnD,aAAK,MAAM,GAAG,MAAM,CAAC;AAIrB,eAAO,MAAM,oCAAoC;;;;CAMhD,CAAC;AAEF,eAAO,MAAM,mCAAmC;;CAE/C,CAAC;AAEF,oBAAY,8BAA8B,GAAG;IAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACzC;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,oBAAY,yCAAyC,GAAG;IACtD,IAAI,EAAE,OAAO,mCAAmC,CAAC,WAAW,CAAC;IAC7D,OAAO,EAAE,CAAC,8BAA8B,EAAE,KAAK,EAAE,CAAC,CAAC;CACpD,CAAC;AAEF,oBAAY,sDAAsD,GAAG;IACnE,IAAI,EAAE,OAAO,oCAAoC,CAAC,QAAQ,CAAC;IAC3D,OAAO,EAAE,MAAM,8BAA8B,CAAC;CAC/C,CAAC;AAEF,oBAAY,0DAA0D,GAAG;IACvE,IAAI,EAAE,OAAO,oCAAoC,CAAC,2BAA2B,CAAC;IAC9E,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,eAAe,CAAC;CAC9C,CAAC;AAEF,oBAAY,0DAA0D,GAAG;IACvE,IAAI,EAAE,OAAO,oCAAoC,CAAC,2BAA2B,CAAC;IAC9E,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,KAAK,IAAI,CAAC;CACrE,CAAC;AAEF,oBAAY,+BAA+B,GACvC,sDAAsD,GACtD,0DAA0D,GAC1D,0DAA0D,CAAC;AAE/D,oBAAY,8BAA8B,GACxC,yCAAyC,CAAC;AAE5C,oBAAY,kCAAkC,GAAG,6BAA6B,CAC5E,OAAO,cAAc,EACrB,+BAA+B,EAC/B,iCAAiC,GAAG,8BAA8B,EAClE,MAAM,EACN,MAAM,CACP,CAAC;AAEF,oBAAY,gCAAgC,GAAG;IAC7C,SAAS,EAAE,kCAAkC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,gBAAgB,CAC7D,OAAO,cAAc,EACrB,8BAA8B,EAC9B,kCAAkC,CACnC;;IACC;;;;;OAKG;gBACS,EAAE,SAAS,EAAE,EAAE,gCAAgC;IAwC3D,6BAA6B,CAAC,eAAe,EAAE,eAAe;IAI9D,2BAA2B,CACzB,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,eAAe;IAOlC,2BAA2B,CAAC,MAAM,EAAE,MAAM;CAM3C"}
+{"version":3,"file":"SelectedNetworkController.d.ts","sourceRoot":"","sources":["../src/SelectedNetworkController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EACV,eAAe,EACf,iCAAiC,EAElC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,QAAA,MAAM,cAAc,8BAA8B,CAAC;AAYnD,aAAK,MAAM,GAAG,MAAM,CAAC;AAIrB,eAAO,MAAM,oCAAoC;;;;CAMhD,CAAC;AAEF,eAAO,MAAM,mCAAmC;;CAE/C,CAAC;AAEF,oBAAY,8BAA8B,GAAG;IAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACzC;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,oBAAY,yCAAyC,GAAG;IACtD,IAAI,EAAE,OAAO,mCAAmC,CAAC,WAAW,CAAC;IAC7D,OAAO,EAAE,CAAC,8BAA8B,EAAE,KAAK,EAAE,CAAC,CAAC;CACpD,CAAC;AAEF,oBAAY,sDAAsD,GAAG;IACnE,IAAI,EAAE,OAAO,oCAAoC,CAAC,QAAQ,CAAC;IAC3D,OAAO,EAAE,MAAM,8BAA8B,CAAC;CAC/C,CAAC;AAEF,oBAAY,0DAA0D,GAAG;IACvE,IAAI,EAAE,OAAO,oCAAoC,CAAC,2BAA2B,CAAC;IAC9E,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,eAAe,CAAC;CAC9C,CAAC;AAEF,oBAAY,0DAA0D,GAAG;IACvE,IAAI,EAAE,OAAO,oCAAoC,CAAC,2BAA2B,CAAC;IAC9E,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,KAAK,IAAI,CAAC;CACrE,CAAC;AAEF,oBAAY,+BAA+B,GACvC,sDAAsD,GACtD,0DAA0D,GAC1D,0DAA0D,CAAC;AAE/D,oBAAY,8BAA8B,GACxC,yCAAyC,CAAC;AAE5C,oBAAY,kCAAkC,GAAG,6BAA6B,CAC5E,OAAO,cAAc,EACrB,+BAA+B,EAC/B,iCAAiC,GAAG,8BAA8B,EAClE,MAAM,EACN,MAAM,CACP,CAAC;AAEF,oBAAY,gCAAgC,GAAG;IAC7C,SAAS,EAAE,kCAAkC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,gBAAgB,CAC7D,OAAO,cAAc,EACrB,8BAA8B,EAC9B,kCAAkC,CACnC;;IACC;;;;;OAKG;gBACS,EAAE,SAAS,EAAE,EAAE,gCAAgC;IAwC3D,6BAA6B,CAAC,eAAe,EAAE,eAAe;IAI9D,2BAA2B,CACzB,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,eAAe;IAWlC,2BAA2B,CAAC,MAAM,EAAE,MAAM;CAM3C"}

dist/SelectedNetworkController.js

@@ -54,3 +54,7 @@ "use strict";
         this.update((state) => {
-            state.domains[domain] = networkClientId;
+            if (state.perDomainNetwork) {
+                state.domains[domain] = networkClientId;
+                return;
+            }
+            state.domains[METAMASK_DOMAIN] = networkClientId;
         });
@@ -57,0 +61,0 @@ }

dist/SelectedNetworkController.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"SelectedNetworkController.js","sourceRoot":"","sources":["../src/SelectedNetworkController.ts"],"names":[],"mappings":";;;;;;;;;AACA,+DAA6D;AAQ7D,MAAM,cAAc,GAAG,2BAA2B,CAAC;AAEnD,MAAM,aAAa,GAAG;IACpB,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC5C,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACtD,CAAC;AAEF,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,CAAC;IAC7B,OAAO,EAAE,EAAE;IACX,gBAAgB,EAAE,KAAK;CACxB,CAAC,CAAC;AAIH,MAAM,eAAe,GAAG,UAAmB,CAAC;AAE/B,QAAA,oCAAoC,GAAG;IAClD,QAAQ,EAAE,GAAG,cAAc,WAAoB;IAC/C,2BAA2B,EACzB,GAAG,cAAc,8BAAuC;IAC1D,2BAA2B,EACzB,GAAG,cAAc,8BAAuC;CAC3D,CAAC;AAEW,QAAA,mCAAmC,GAAG;IACjD,WAAW,EAAE,GAAG,cAAc,cAAuB;CACtD,CAAC;AAoDF;;GAEG;AACH,MAAa,yBAA0B,SAAQ,kCAI9C;IACC;;;;;OAKG;IACH,YAAY,EAAE,SAAS,EAAoC;QACzD,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,EAAE,eAAe,EAAE;SACzB,CAAC,CAAC;;QACH,uBAAA,IAAI,gGAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IAgCD,6BAA6B,CAAC,eAAgC;QAC5D,IAAI,CAAC,2BAA2B,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IACrE,CAAC;IAED,2BAA2B,CACzB,MAAc,EACd,eAAgC;QAEhC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,2BAA2B,CAAC,MAAc;QACxC,IAAI,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE;YAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SACnC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAC7C,CAAC;CACF;AAtED,8DAsEC;;IAhDG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4CAAoC,CAAC,2BAA2B,EAChE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5C,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4CAAoC,CAAC,2BAA2B,EAChE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5C,CAAC;IAEF,+EAA+E;IAC/E,6CAA6C;IAC7C,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,+BAA+B,EAC/B,CAAC,KAAmB,EAAE,KAAc,EAAE,EAAE;QACtC,MAAM,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAClC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,yBAAyB,CAC/C,CAAC;QACF,IAAI,CAAC,iBAAiB,EAAE;YACtB,OAAO;SACR;QAED,oEAAoE;QACpE,oEAAoE;QACpE,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACpE,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseControllerV2 } from '@metamask/base-controller';\nimport type {\n  NetworkClientId,\n  NetworkControllerStateChangeEvent,\n  NetworkState,\n} from '@metamask/network-controller';\nimport type { Patch } from 'immer';\n\nconst controllerName = 'SelectedNetworkController';\n\nconst stateMetadata = {\n  domains: { persist: true, anonymous: false },\n  perDomainNetwork: { persist: true, anonymous: false },\n};\n\nconst getDefaultState = () => ({\n  domains: {},\n  perDomainNetwork: false,\n});\n\ntype Domain = string;\n\nconst METAMASK_DOMAIN = 'metamask' as const;\n\nexport const SelectedNetworkControllerActionTypes = {\n  getState: `${controllerName}:getState` as const,\n  getNetworkClientIdForDomain:\n    `${controllerName}:getNetworkClientIdForDomain` as const,\n  setNetworkClientIdForDomain:\n    `${controllerName}:setNetworkClientIdForDomain` as const,\n};\n\nexport const SelectedNetworkControllerEventTypes = {\n  stateChange: `${controllerName}:stateChange` as const,\n};\n\nexport type SelectedNetworkControllerState = {\n  domains: Record<Domain, NetworkClientId>;\n  /**\n   * Feature flag to start returning networkClientId based on the domain.\n   * when the flag is false, the 'metamask' domain will always be used.\n   * defaults to false\n   */\n  perDomainNetwork: boolean;\n};\n\nexport type SelectedNetworkControllerStateChangeEvent = {\n  type: typeof SelectedNetworkControllerEventTypes.stateChange;\n  payload: [SelectedNetworkControllerState, Patch[]];\n};\n\nexport type SelectedNetworkControllerGetSelectedNetworkStateAction = {\n  type: typeof SelectedNetworkControllerActionTypes.getState;\n  handler: () => SelectedNetworkControllerState;\n};\n\nexport type SelectedNetworkControllerGetNetworkClientIdForDomainAction = {\n  type: typeof SelectedNetworkControllerActionTypes.getNetworkClientIdForDomain;\n  handler: (domain: string) => NetworkClientId;\n};\n\nexport type SelectedNetworkControllerSetNetworkClientIdForDomainAction = {\n  type: typeof SelectedNetworkControllerActionTypes.setNetworkClientIdForDomain;\n  handler: (domain: string, NetworkClientId: NetworkClientId) => void;\n};\n\nexport type SelectedNetworkControllerAction =\n  | SelectedNetworkControllerGetSelectedNetworkStateAction\n  | SelectedNetworkControllerGetNetworkClientIdForDomainAction\n  | SelectedNetworkControllerSetNetworkClientIdForDomainAction;\n\nexport type SelectedNetworkControllerEvent =\n  SelectedNetworkControllerStateChangeEvent;\n\nexport type SelectedNetworkControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  SelectedNetworkControllerAction,\n  NetworkControllerStateChangeEvent | SelectedNetworkControllerEvent,\n  string,\n  string\n>;\n\nexport type SelectedNetworkControllerOptions = {\n  messenger: SelectedNetworkControllerMessenger;\n};\n\n/**\n * Controller for getting and setting the network for a particular domain.\n */\nexport class SelectedNetworkController extends BaseControllerV2<\n  typeof controllerName,\n  SelectedNetworkControllerState,\n  SelectedNetworkControllerMessenger\n> {\n  /**\n   * Construct a SelectedNetworkController controller.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The restricted controller messenger for the EncryptionPublicKey controller.\n   */\n  constructor({ messenger }: SelectedNetworkControllerOptions) {\n    super({\n      name: controllerName,\n      metadata: stateMetadata,\n      messenger,\n      state: getDefaultState(),\n    });\n    this.#registerMessageHandlers();\n  }\n\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      SelectedNetworkControllerActionTypes.getNetworkClientIdForDomain,\n      this.getNetworkClientIdForDomain.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      SelectedNetworkControllerActionTypes.setNetworkClientIdForDomain,\n      this.setNetworkClientIdForDomain.bind(this),\n    );\n\n    // subscribe to networkController statechange:: selectedNetworkClientId changed\n    // update the value for the domain 'metamask'\n    this.messagingSystem.subscribe(\n      'NetworkController:stateChange',\n      (state: NetworkState, patch: Patch[]) => {\n        const isChangingNetwork = patch.some(\n          (p) => p.path[0] === 'selectedNetworkClientId',\n        );\n        if (!isChangingNetwork) {\n          return;\n        }\n\n        // set it for the 'global' network to preserve functionality for the\n        // selectedNetworkController.perDomainNetwork feature flag being off\n        this.setNetworkClientIdForMetamask(state.selectedNetworkClientId);\n      },\n    );\n  }\n\n  setNetworkClientIdForMetamask(networkClientId: NetworkClientId) {\n    this.setNetworkClientIdForDomain(METAMASK_DOMAIN, networkClientId);\n  }\n\n  setNetworkClientIdForDomain(\n    domain: Domain,\n    networkClientId: NetworkClientId,\n  ) {\n    this.update((state) => {\n      state.domains[domain] = networkClientId;\n    });\n  }\n\n  getNetworkClientIdForDomain(domain: Domain) {\n    if (this.state.perDomainNetwork) {\n      return this.state.domains[domain];\n    }\n    return this.state.domains[METAMASK_DOMAIN];\n  }\n}\n"]}
+{"version":3,"file":"SelectedNetworkController.js","sourceRoot":"","sources":["../src/SelectedNetworkController.ts"],"names":[],"mappings":";;;;;;;;;AACA,+DAA6D;AAQ7D,MAAM,cAAc,GAAG,2BAA2B,CAAC;AAEnD,MAAM,aAAa,GAAG;IACpB,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC5C,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACtD,CAAC;AAEF,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,CAAC;IAC7B,OAAO,EAAE,EAAE;IACX,gBAAgB,EAAE,KAAK;CACxB,CAAC,CAAC;AAIH,MAAM,eAAe,GAAG,UAAmB,CAAC;AAE/B,QAAA,oCAAoC,GAAG;IAClD,QAAQ,EAAE,GAAG,cAAc,WAAoB;IAC/C,2BAA2B,EACzB,GAAG,cAAc,8BAAuC;IAC1D,2BAA2B,EACzB,GAAG,cAAc,8BAAuC;CAC3D,CAAC;AAEW,QAAA,mCAAmC,GAAG;IACjD,WAAW,EAAE,GAAG,cAAc,cAAuB;CACtD,CAAC;AAoDF;;GAEG;AACH,MAAa,yBAA0B,SAAQ,kCAI9C;IACC;;;;;OAKG;IACH,YAAY,EAAE,SAAS,EAAoC;QACzD,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,EAAE,eAAe,EAAE;SACzB,CAAC,CAAC;;QACH,uBAAA,IAAI,gGAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IAgCD,6BAA6B,CAAC,eAAgC;QAC5D,IAAI,CAAC,2BAA2B,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IACrE,CAAC;IAED,2BAA2B,CACzB,MAAc,EACd,eAAgC;QAEhC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,IAAI,KAAK,CAAC,gBAAgB,EAAE;gBAC1B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC;gBACxC,OAAO;aACR;YACD,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,eAAe,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,2BAA2B,CAAC,MAAc;QACxC,IAAI,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE;YAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SACnC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAC7C,CAAC;CACF;AA1ED,8DA0EC;;IApDG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4CAAoC,CAAC,2BAA2B,EAChE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5C,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4CAAoC,CAAC,2BAA2B,EAChE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5C,CAAC;IAEF,+EAA+E;IAC/E,6CAA6C;IAC7C,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,+BAA+B,EAC/B,CAAC,KAAmB,EAAE,KAAc,EAAE,EAAE;QACtC,MAAM,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAClC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,yBAAyB,CAC/C,CAAC;QACF,IAAI,CAAC,iBAAiB,EAAE;YACtB,OAAO;SACR;QAED,oEAAoE;QACpE,oEAAoE;QACpE,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACpE,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseControllerV2 } from '@metamask/base-controller';\nimport type {\n  NetworkClientId,\n  NetworkControllerStateChangeEvent,\n  NetworkState,\n} from '@metamask/network-controller';\nimport type { Patch } from 'immer';\n\nconst controllerName = 'SelectedNetworkController';\n\nconst stateMetadata = {\n  domains: { persist: true, anonymous: false },\n  perDomainNetwork: { persist: true, anonymous: false },\n};\n\nconst getDefaultState = () => ({\n  domains: {},\n  perDomainNetwork: false,\n});\n\ntype Domain = string;\n\nconst METAMASK_DOMAIN = 'metamask' as const;\n\nexport const SelectedNetworkControllerActionTypes = {\n  getState: `${controllerName}:getState` as const,\n  getNetworkClientIdForDomain:\n    `${controllerName}:getNetworkClientIdForDomain` as const,\n  setNetworkClientIdForDomain:\n    `${controllerName}:setNetworkClientIdForDomain` as const,\n};\n\nexport const SelectedNetworkControllerEventTypes = {\n  stateChange: `${controllerName}:stateChange` as const,\n};\n\nexport type SelectedNetworkControllerState = {\n  domains: Record<Domain, NetworkClientId>;\n  /**\n   * Feature flag to start returning networkClientId based on the domain.\n   * when the flag is false, the 'metamask' domain will always be used.\n   * defaults to false\n   */\n  perDomainNetwork: boolean;\n};\n\nexport type SelectedNetworkControllerStateChangeEvent = {\n  type: typeof SelectedNetworkControllerEventTypes.stateChange;\n  payload: [SelectedNetworkControllerState, Patch[]];\n};\n\nexport type SelectedNetworkControllerGetSelectedNetworkStateAction = {\n  type: typeof SelectedNetworkControllerActionTypes.getState;\n  handler: () => SelectedNetworkControllerState;\n};\n\nexport type SelectedNetworkControllerGetNetworkClientIdForDomainAction = {\n  type: typeof SelectedNetworkControllerActionTypes.getNetworkClientIdForDomain;\n  handler: (domain: string) => NetworkClientId;\n};\n\nexport type SelectedNetworkControllerSetNetworkClientIdForDomainAction = {\n  type: typeof SelectedNetworkControllerActionTypes.setNetworkClientIdForDomain;\n  handler: (domain: string, NetworkClientId: NetworkClientId) => void;\n};\n\nexport type SelectedNetworkControllerAction =\n  | SelectedNetworkControllerGetSelectedNetworkStateAction\n  | SelectedNetworkControllerGetNetworkClientIdForDomainAction\n  | SelectedNetworkControllerSetNetworkClientIdForDomainAction;\n\nexport type SelectedNetworkControllerEvent =\n  SelectedNetworkControllerStateChangeEvent;\n\nexport type SelectedNetworkControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  SelectedNetworkControllerAction,\n  NetworkControllerStateChangeEvent | SelectedNetworkControllerEvent,\n  string,\n  string\n>;\n\nexport type SelectedNetworkControllerOptions = {\n  messenger: SelectedNetworkControllerMessenger;\n};\n\n/**\n * Controller for getting and setting the network for a particular domain.\n */\nexport class SelectedNetworkController extends BaseControllerV2<\n  typeof controllerName,\n  SelectedNetworkControllerState,\n  SelectedNetworkControllerMessenger\n> {\n  /**\n   * Construct a SelectedNetworkController controller.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The restricted controller messenger for the EncryptionPublicKey controller.\n   */\n  constructor({ messenger }: SelectedNetworkControllerOptions) {\n    super({\n      name: controllerName,\n      metadata: stateMetadata,\n      messenger,\n      state: getDefaultState(),\n    });\n    this.#registerMessageHandlers();\n  }\n\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      SelectedNetworkControllerActionTypes.getNetworkClientIdForDomain,\n      this.getNetworkClientIdForDomain.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      SelectedNetworkControllerActionTypes.setNetworkClientIdForDomain,\n      this.setNetworkClientIdForDomain.bind(this),\n    );\n\n    // subscribe to networkController statechange:: selectedNetworkClientId changed\n    // update the value for the domain 'metamask'\n    this.messagingSystem.subscribe(\n      'NetworkController:stateChange',\n      (state: NetworkState, patch: Patch[]) => {\n        const isChangingNetwork = patch.some(\n          (p) => p.path[0] === 'selectedNetworkClientId',\n        );\n        if (!isChangingNetwork) {\n          return;\n        }\n\n        // set it for the 'global' network to preserve functionality for the\n        // selectedNetworkController.perDomainNetwork feature flag being off\n        this.setNetworkClientIdForMetamask(state.selectedNetworkClientId);\n      },\n    );\n  }\n\n  setNetworkClientIdForMetamask(networkClientId: NetworkClientId) {\n    this.setNetworkClientIdForDomain(METAMASK_DOMAIN, networkClientId);\n  }\n\n  setNetworkClientIdForDomain(\n    domain: Domain,\n    networkClientId: NetworkClientId,\n  ) {\n    this.update((state) => {\n      if (state.perDomainNetwork) {\n        state.domains[domain] = networkClientId;\n        return;\n      }\n      state.domains[METAMASK_DOMAIN] = networkClientId;\n    });\n  }\n\n  getNetworkClientIdForDomain(domain: Domain) {\n    if (this.state.perDomainNetwork) {\n      return this.state.domains[domain];\n    }\n    return this.state.domains[METAMASK_DOMAIN];\n  }\n}\n"]}

dist/SelectedNetworkMiddleware.d.ts

 import type { ControllerMessenger } from '@metamask/base-controller';
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
 import type { NetworkControllerGetStateAction } from '@metamask/network-controller';
-import type { JsonRpcMiddleware } from 'json-rpc-engine';
 import type { SelectedNetworkControllerGetNetworkClientIdForDomainAction, SelectedNetworkControllerSetNetworkClientIdForDomainAction } from './SelectedNetworkController';
 export declare const createSelectedNetworkMiddleware: (messenger: ControllerMessenger<SelectedNetworkControllerGetNetworkClientIdForDomainAction | SelectedNetworkControllerSetNetworkClientIdForDomainAction | NetworkControllerGetStateAction, never>) => JsonRpcMiddleware<any, any>;
 //# sourceMappingURL=SelectedNetworkMiddleware.d.ts.map

dist/SelectedNetworkMiddleware.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"SelectedNetworkMiddleware.d.ts","sourceRoot":"","sources":["../src/SelectedNetworkMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAEV,+BAA+B,EAChC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,OAAO,KAAK,EACV,0DAA0D,EAC1D,0DAA0D,EAC3D,MAAM,6BAA6B,CAAC;AAGrC,eAAO,MAAM,+BAA+B,cAC/B,oBACP,0DAA0D,GAC1D,0DAA0D,GAC1D,+BAA+B,EACjC,KAAK,CACN,KACA,kBAAkB,GAAG,EAAE,GAAG,CA4B5B,CAAC"}
+{"version":3,"file":"SelectedNetworkMiddleware.d.ts","sourceRoot":"","sources":["../src/SelectedNetworkMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EAEV,+BAA+B,EAChC,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EACV,0DAA0D,EAC1D,0DAA0D,EAC3D,MAAM,6BAA6B,CAAC;AAGrC,eAAO,MAAM,+BAA+B,cAC/B,oBACP,0DAA0D,GAC1D,0DAA0D,GAC1D,+BAA+B,EACjC,KAAK,CACN,KACA,kBAAkB,GAAG,EAAE,GAAG,CA4B5B,CAAC"}

dist/SelectedNetworkMiddleware.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"SelectedNetworkMiddleware.js","sourceRoot":"","sources":["../src/SelectedNetworkMiddleware.ts"],"names":[],"mappings":";;;AAWA,2EAAmF;AAE5E,MAAM,+BAA+B,GAAG,CAC7C,SAKC,EAC4B,EAAE;IAC/B,MAAM,2BAA2B,GAAG,CAAC,MAAc,EAAE,EAAE,CACrD,SAAS,CAAC,IAAI,CACZ,gEAAoC,CAAC,2BAA2B,EAChE,MAAM,CACP,CAAC;IAEJ,MAAM,2BAA2B,GAAG,CAClC,MAAc,EACd,eAAgC,EAChC,EAAE,CACF,SAAS,CAAC,IAAI,CACZ,gEAAoC,CAAC,2BAA2B,EAChE,MAAM,EACN,eAAe,CAChB,CAAC;IAEJ,MAAM,yBAAyB,GAAG,GAAG,EAAE,CACrC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC,uBAAuB,CAAC;IAEvE,OAAO,CAAC,GAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE;QAC3B,IAAI,2BAA2B,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YACzD,2BAA2B,CAAC,GAAG,CAAC,MAAM,EAAE,yBAAyB,EAAE,CAAC,CAAC;SACtE;QAED,GAAG,CAAC,eAAe,GAAG,2BAA2B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9D,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAnCW,QAAA,+BAA+B,mCAmC1C","sourcesContent":["import type { ControllerMessenger } from '@metamask/base-controller';\nimport type {\n  NetworkClientId,\n  NetworkControllerGetStateAction,\n} from '@metamask/network-controller';\nimport type { JsonRpcMiddleware } from 'json-rpc-engine';\n\nimport type {\n  SelectedNetworkControllerGetNetworkClientIdForDomainAction,\n  SelectedNetworkControllerSetNetworkClientIdForDomainAction,\n} from './SelectedNetworkController';\nimport { SelectedNetworkControllerActionTypes } from './SelectedNetworkController';\n\nexport const createSelectedNetworkMiddleware = (\n  messenger: ControllerMessenger<\n    | SelectedNetworkControllerGetNetworkClientIdForDomainAction\n    | SelectedNetworkControllerSetNetworkClientIdForDomainAction\n    | NetworkControllerGetStateAction,\n    never\n  >,\n): JsonRpcMiddleware<any, any> => {\n  const getNetworkClientIdForDomain = (origin: string) =>\n    messenger.call(\n      SelectedNetworkControllerActionTypes.getNetworkClientIdForDomain,\n      origin,\n    );\n\n  const setNetworkClientIdForDomain = (\n    origin: string,\n    networkClientId: NetworkClientId,\n  ) =>\n    messenger.call(\n      SelectedNetworkControllerActionTypes.setNetworkClientIdForDomain,\n      origin,\n      networkClientId,\n    );\n\n  const getDefaultNetworkClientId = () =>\n    messenger.call('NetworkController:getState').selectedNetworkClientId;\n\n  return (req: any, _, next) => {\n    if (getNetworkClientIdForDomain(req.origin) === undefined) {\n      setNetworkClientIdForDomain(req.origin, getDefaultNetworkClientId());\n    }\n\n    req.networkClientId = getNetworkClientIdForDomain(req.origin);\n    return next();\n  };\n};\n"]}
+{"version":3,"file":"SelectedNetworkMiddleware.js","sourceRoot":"","sources":["../src/SelectedNetworkMiddleware.ts"],"names":[],"mappings":";;;AAWA,2EAAmF;AAE5E,MAAM,+BAA+B,GAAG,CAC7C,SAKC,EAC4B,EAAE;IAC/B,MAAM,2BAA2B,GAAG,CAAC,MAAc,EAAE,EAAE,CACrD,SAAS,CAAC,IAAI,CACZ,gEAAoC,CAAC,2BAA2B,EAChE,MAAM,CACP,CAAC;IAEJ,MAAM,2BAA2B,GAAG,CAClC,MAAc,EACd,eAAgC,EAChC,EAAE,CACF,SAAS,CAAC,IAAI,CACZ,gEAAoC,CAAC,2BAA2B,EAChE,MAAM,EACN,eAAe,CAChB,CAAC;IAEJ,MAAM,yBAAyB,GAAG,GAAG,EAAE,CACrC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC,uBAAuB,CAAC;IAEvE,OAAO,CAAC,GAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE;QAC3B,IAAI,2BAA2B,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YACzD,2BAA2B,CAAC,GAAG,CAAC,MAAM,EAAE,yBAAyB,EAAE,CAAC,CAAC;SACtE;QAED,GAAG,CAAC,eAAe,GAAG,2BAA2B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9D,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAnCW,QAAA,+BAA+B,mCAmC1C","sourcesContent":["import type { ControllerMessenger } from '@metamask/base-controller';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport type {\n  NetworkClientId,\n  NetworkControllerGetStateAction,\n} from '@metamask/network-controller';\n\nimport type {\n  SelectedNetworkControllerGetNetworkClientIdForDomainAction,\n  SelectedNetworkControllerSetNetworkClientIdForDomainAction,\n} from './SelectedNetworkController';\nimport { SelectedNetworkControllerActionTypes } from './SelectedNetworkController';\n\nexport const createSelectedNetworkMiddleware = (\n  messenger: ControllerMessenger<\n    | SelectedNetworkControllerGetNetworkClientIdForDomainAction\n    | SelectedNetworkControllerSetNetworkClientIdForDomainAction\n    | NetworkControllerGetStateAction,\n    never\n  >,\n): JsonRpcMiddleware<any, any> => {\n  const getNetworkClientIdForDomain = (origin: string) =>\n    messenger.call(\n      SelectedNetworkControllerActionTypes.getNetworkClientIdForDomain,\n      origin,\n    );\n\n  const setNetworkClientIdForDomain = (\n    origin: string,\n    networkClientId: NetworkClientId,\n  ) =>\n    messenger.call(\n      SelectedNetworkControllerActionTypes.setNetworkClientIdForDomain,\n      origin,\n      networkClientId,\n    );\n\n  const getDefaultNetworkClientId = () =>\n    messenger.call('NetworkController:getState').selectedNetworkClientId;\n\n  return (req: any, _, next) => {\n    if (getNetworkClientIdForDomain(req.origin) === undefined) {\n      setNetworkClientIdForDomain(req.origin, getDefaultNetworkClientId());\n    }\n\n    req.networkClientId = getNetworkClientIdForDomain(req.origin);\n    return next();\n  };\n};\n"]}

package.json

 {
   "name": "@metamask/selected-network-controller",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Provides an interface to the currently selected networkClientId for a given domain",
@@ -28,8 +28,9 @@ "keywords": [
     "test": "jest",
+    "test:clean": "jest --clearCache",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^3.2.2",
-    "@metamask/network-controller": "^13.0.1",
-    "json-rpc-engine": "^6.1.0"
+    "@metamask/base-controller": "^3.2.3",
+    "@metamask/json-rpc-engine": "^7.1.1",
+    "@metamask/network-controller": "^15.0.0"
   },
@@ -46,8 +47,8 @@ "devDependencies": {
     "ts-jest": "^27.1.4",
-    "typedoc": "^0.23.15",
-    "typedoc-plugin-missing-exports": "^0.23.0",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "~4.8.4"
   },
   "peerDependencies": {
-    "@metamask/network-controller": "^13.0.1"
+    "@metamask/network-controller": "^15.0.0"
   },
@@ -54,0 +55,0 @@ "engines": {

No alert changes

Improved metrics

Total package byte prevSize

28649

5.01%

Lines of code

188

2.17%

Dependency changes

• + Added

  @metamask/json-rpc-engine@^7.1.1

• + Added

  @metamask/abi-utils@2.0.4
  (transitive)

• + Added

  @metamask/eth-block-tracker@9.0.3
  (transitive)

• + Added

  @metamask/eth-json-rpc-infura@9.1.0
  (transitive)

• + Added

  @metamask/eth-json-rpc-middleware@12.1.2
  (transitive)

• + Added

  @metamask/eth-json-rpc-provider@2.3.23.0.2
  (transitive)

• + Added

  @metamask/eth-sig-util@7.0.3
  (transitive)

• + Added

  @metamask/json-rpc-engine@8.0.2
  (transitive)

• + Added

  @metamask/network-controller@15.2.0
  (transitive)

• + Added

  eth-block-tracker@8.1.0
  (transitive)

• + Added

  klona@2.0.6
  (transitive)

• + Added

  pify@5.0.0
  (transitive)

• - Removed

  json-rpc-engine@^6.1.0

• - Removed

  @metamask/abi-utils@1.2.0
  (transitive)

• - Removed

  @metamask/eth-json-rpc-infura@8.1.1
  (transitive)

• - Removed

  @metamask/eth-json-rpc-middleware@11.0.2
  (transitive)

• - Removed

  @metamask/eth-json-rpc-provider@1.0.1
  (transitive)

• - Removed

  @metamask/eth-sig-util@6.0.2
  (transitive)

• - Removed

  @metamask/network-controller@13.0.1
  (transitive)

• - Removed

  @metamask/safe-event-emitter@2.0.0
  (transitive)

• - Removed

  @metamask/utils@3.6.04.0.05.0.26.2.0
  (transitive)

• - Removed

  @scure/base@1.2.6
  (transitive)

• - Removed

  clone@2.1.2
  (transitive)

• - Removed

  eth-block-tracker@7.1.0
  (transitive)

• - Removed

  eth-rpc-errors@4.0.3
  (transitive)

• - Removed

  ethjs-util@0.1.6
  (transitive)

• - Removed

  json-rpc-engine@6.1.0
  (transitive)

• - Removed

  pify@3.0.0
  (transitive)

• - Removed

  superstruct@1.0.4
  (transitive)

• - Removed

  tweetnacl-util@0.15.1
  (transitive)

• Updated

  @metamask/base-controller@^3.2.3

• Updated

  @metamask/network-controller@^15.0.0