Skip to content

CHANGELOG.md

Latest commit

 

History

History
391 lines (253 loc) · 25.1 KB

CHANGELOG.md

File metadata and controls

391 lines (253 loc) · 25.1 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

22.0.0

Changed

  • BREAKING: Bump peer dependency @metamask/network-controller to ^23.0.0 (#5507)
  • Bump @metamask/utils to ^11.2.0 (#5301)

21.0.1

Changed

  • Bump @metamask/base-controller from ^7.1.1 to ^8.0.0 (#5305)
  • Bump @metamask/json-rpc-engine from ^10.0.2 to ^10.0.3 (#5272)
  • Bump @metamask/utils from ^11.0.1 to ^11.1.0 (#5223)

21.0.0

Added

  • BREAKING: The SelectedNetworkController constructor now expects both useRequestQueuePreference and onPreferencesStateChange options (#5065)
    • These were previously removed in 20.0.0, but have been re-added for compatibility with Mobile.

Changed

  • Bump @metamask/base-controller from ^7.0.0 to ^7.1.1 (#5079), #5135)
  • Bump @metamask/json-rpc-engine from ^10.0.1 to ^10.0.2 (#5082)
  • Bump @metamask/utils from ^10.0.0 to ^11.0.1 (#5080)
    • This upgrade is not a breaking change because this package does not use generateRandomMnemonic.

20.0.2

Changed

  • Bump swappable-obj-proxy from ^2.2.0 to ^2.3.0 (#5036)

20.0.1

Fixed

  • Correct ESM-compatible build so that imports of the following packages that re-export other modules via export * are no longer corrupted: (#5011)
    • @metamask/swappable-obj-proxy

20.0.0

Changed

  • Bump @metamask/base-controller from ^7.0.1 to ^7.0.2 (#4862)
  • Bump @metamask/json-rpc-engine from ^10.0.0 to ^10.0.1 (#4862)

Removed

  • BREAKING: The SelectedNetworkController constructor no longer expects a useRequestPreference boolean nor an onPreferencesStateChange listener. Removal of these parameters means that domains state will always be added for sites that are granted permissions. (#4941)

19.0.0

Changed

  • BREAKING: Bump @metamask/network-controller peer dependency from ^21.0.0 to ^22.0.0 (#4841)
  • Bump @metamask/utils to ^10.0.0 (#4831)

18.0.2

Fixed

  • Ensure that the networkClientID is updated in domains state before fetching the network proxy for a given domain. This ensures that the network proxy being fetched has not already been garbage collected. (#4801)

18.0.1

Changed

  • Redirect domains to default endpoint (#4679)
    • When the default RPC endpoint changes for a network, domains that were referencing a network client id on that network are redirected to the new default RPC endpoint.

Fixed

  • Produce and export ESM-compatible TypeScript type declaration files in addition to CommonJS-compatible declaration files (#4648)
    • Previously, this package shipped with only one variant of type declaration files, and these files were only CommonJS-compatible, and the exports field in package.json linked to these files. This is an anti-pattern and was rightfully flagged by the "Are the Types Wrong?" tool as "masquerading as CJS". All of the ATTW checks now pass.
  • Remove chunk files (#4648).
    • Previously, the build tool we used to generate JavaScript files extracted common code to "chunk" files. While this was intended to make this package more tree-shakeable, it also made debugging more difficult for our development teams. These chunk files are no longer present.

18.0.0

Changed

  • BREAKING: Bump devDependency and peerDependency @metamask/network-controller from ^20.0.0 to ^21.0.0 (#4618, #4651)
  • Bump @metamask/base-controller from ^6.0.2 to ^7.0.0 (#4625, #4643)
  • Bump typescript from ~5.0.4 to ~5.2.2 (#4576, #4584)

17.0.0

Changed

  • BREAKING: Bump dependency and peerDependency @metamask/permission-controller from ^10.0.0 to ^11.0.0 (#4544)
  • Remove @metamask/network-controller and @metamask/permission-controller dependencies #4556
    • These were listed under peerDependencies already, so they were redundant as dependencies.
  • Upgrade TypeScript version to ~5.0.4 and set moduleResolution option to Node16 (#3645)
  • Bump @metamask/base-controller from ^6.0.0 to ^6.0.2 (#4517, #4544)
  • Bump @metamask/json-rpc-engine from ^9.0.0 to ^9.0.2 (#4517, #4544)
  • Bump @metamask/utils from ^8.3.0 to ^9.1.0 (#4516, #4529)

16.0.0

Changed

  • BREAKING: Bump peerDependency @metamask/network-controller to ^20.0.0 (#4508)

15.0.2

Fixed

  • setNetworkClientId() no longer modifies state nor creates/updates proxies when the useRequestQueuePreference flag is false (#4388)

15.0.1

Fixed

  • No longer add domains that have been granted permissions to domains state (nor create a selected network proxy for it) unless the useRequestQueuePreference flag is true (#4368)

15.0.0

Changed

  • BREAKING: Bump minimum Node version to 18.18 (#3611)
  • BREAKING: Bump dependency and peer dependency @metamask/network-controller to ^19.0.0 (#4352)
  • BREAKING: Bump dependency and peer dependency @metamask/permission-controller to ^10.0.0 (#4352)
  • Bump @metamask/base-controller to ^6.0.0 (#4352)
  • Bump @metamask/json-rpc-engine to ^9.0.0 (#4352)

14.0.0

Changed

  • BREAKING: Bump dependency and peer dependency @metamask/network-controller to ^18.1.3 (#4342)
  • BREAKING: Bump dependency and peer dependency @metamask/permission-controller to ^9.1.1 (#4342)

13.0.0

Changed

  • getProviderAndBlockTracker now returns the NetworkController's globally selected network client proxy if the domain arg is either metamask or a snap (identified as starting with npm: or local:) (#4259)
  • BREAKING: Now when setNetworkClientIdForDomain is called with a snap's domain (identified as starting with npm: or local:), the domain will not be added to state and no proxy will be created for this domain in the domainProxyMap (#4258)
    • In order to remove snaps that made it into domains state prior to this change, consumers will need to run a migration.
  • Bump @metamask/json-rpc-engine to ^8.0.2 (#4234)
  • Bump @metamask/base-controller to ^5.0.2 (#4232)

12.0.1

Fixed

  • When getProviderAndBlockTracker is called with a domain for which there is no cached networkProxy in the domainProxyMap, if the useRequestQueue preference is off and the domain does not have permissions the newly created networkProxy for this domain will be pointed at the NetworkController's own proxy of the globally selected networkClient. (#4187)

12.0.0

Added

  • These changes keep the per domain proxies (stored in domainProxyMap) pointing to the correct network client instance when the "Select networks for each site" toggle is turned on and off.
    • BREAKING: A parameter useRequestQueuePreference which should point to the current preferences state for useRequestQueue is now required by the constructor (#4130)
      • BREAKING: An onPreferencesStateChange argument that should subscribe to PreferencesController state changes and call a callback with the updated state is now a required parameter in the constructor options object. (#4130)

Removed

  • The getUseRequestQueue parameter is no longer expected by the constructor. (#4130)

11.0.0

Added

  • Now exports the Domain type (#4104)

Changed

  • Previously the SelectedNetworkController only constructed proxies for domains that had permissions. Other domains have no associated proxy and the getProviderAndBlockTracker method would throw an error. This was problematic because we grab the network client for an origin a single time when constructing an RPC pipeline for that origin in the MetaMask extension. We don't re-create the RPC pipeline when permissions change. That means that the pipeline is setup with the wrong network client and cannot be updated. The following changes ensure seamlessly proxying calls during sessions where a dapp connects/disconnects and provides a path for clients to prune inactive proxies:
    • BREAKING: SelectedNetworkController now expects a domainProxyMap param - which is a Map of Domain to NetworkProxy - in its constructor (#4104)
      • This domainProxyMap is expected to automatically delete entries for domains that are no longer connected to the wallet. The SelectedNetworkController handles adding entries, but it can't handle removal, as it doesn't know which connections are active.
      • You can pass in a plain Map here and it will work, but during longer sessions this might grow unbounded, resulting in a memory leak.
    • BREAKING: SelectedNetworkController now requires NetworkController:getSelectedNetworkClient as an allowed action (#4063)
    • getProviderAndBlockTracker method no longer throws an error if the useRequestQueue flag is false (#4063)
    • getProviderAndBlockTracker method no longer throws an error if there is no networkClientId set for the passed domain. Now it returns a proxy pointed at the globally selected network instead. (#4063)
  • Bump dependency @metamask/network-controller to ^18.1.0 (#4121)

Fixed

  • Previously when a domain's permission was removed from PermissionsController, it's network client proxy would continue to point at the networkClientId it was last set to. Now it is set to follow the globally selected network (#4063)

10.0.1

Fixed

  • Fix types field in package.json (#4047)

10.0.0

Added

  • BREAKING: Add ESM build (#3998)
    • It's no longer possible to import files from ./dist directly.

Changed

  • BREAKING: Bump @metamask/base-controller to ^5.0.0 (#4039)
    • This version has a number of breaking changes. See the changelog for more.
  • BREAKING: Bump dependency and peer dependency on @metamask/network-controller to ^18.0.0 (#4007)
  • BREAKING: Bump dependency and peer dependency on @metamask/permission-controller to ^9.0.0 (#4007)
  • Bump @metamask/json-rpc-engine to ^8.0.0 (#4007)

9.0.0

Added

  • Listen to permissions changes and add/remove domains (#3969)

Changed

  • BREAKING remove perDomainNetwork from state (#3989)
  • BREAKING Add dependency and peer dependency on @metamask/permission-controller ^8.0.1 (#4000)

8.0.0

Changed

  • BREAKING: setNetworkClientIdForDomain now throws an error if passed metamask for the domain param (#3908).
  • BREAKING: setNetworkClientIdForDomain now fails and throws an error if the passed in domain is not currently permissioned in the PermissionsController (#3908).
  • BREAKING: the domains state now no longer contains a metamask domain key. Consumers should instead use the selectedNetworkClientId from the NetworkController to get the selected network for the metamask domain (#3908).
  • BREAKING: getProviderAndBlockTracker now throws an error if called with any domain while the perDomainNetwork flag is false. Consumers should instead use the provider and blockTracker from the NetworkController when the perDomainNetwork flag is false (#3908).
  • BREAKING: getProviderAndBlockTracker now throws an error if called with a domain that does not have a networkClientId set (#3908).
  • BREAKING: getNetworkClientIdForDomain now returns the selectedNetworkClientId for the globally selected network if the perDomainNetwork flag is false or if the domain is not in the domains state (#3908).

Removed

  • BREAKING: Remove logic in selectedNetworkMiddleware to set a default networkClientId for the requesting origin in the SelectedNetworkController when not already set. Now if networkClientId is not already set for the requesting origin, the middleware will not set a default networkClientId for that origin in the SelectedNetworkController but will continue to add the selectedNetworkClientId from the NetworkController to the networkClientId property on the request object (#3908).

Fixed

  • The SelectedNetworkController now listens for networkConfiguration removal events on the NetworkController and updates domains pointed at a removed networkClientId to the selectedNetworkClientId (#3926).

7.0.1

Changed

  • Selected network controller should update all domains when perDomainNetwork feature flag is off (#3834)

7.0.0

Changed

  • BREAKING: Bump @metamask/network-controller peer dependency to ^17.2.0 (#3821)
  • Bump @metamask/swappable-obj-proxy to ^2.2.0 (#3784)
  • Bump @metamask/utils to ^8.3.0 (#3769)
  • Bump @metamask/base-controller to ^4.1.1 (#3760, #3821)
  • Bump @metamask/json-rpc-engine to ^7.3.2 (#3821)

6.0.0

Changed

  • BREAKING: Bump @metamask/network-controller dependency and peer dependency from ^17.0.0 to ^17.1.0 (#3695)
  • Bump @metamask/base-controller to ^4.0.1 (#3695)
  • Bump @metamask/json-rpc-engine to ^7.3.1 (#3695)

5.0.0

Added

  • Add SelectedNetworkMiddlewareJsonRpcRequest type (#1970).
  • Add setPerDomainNetwork method to reset proxies when flag toggled (#3593).
  • Add state as a constructor argument (#3585).

Changed

  • BREAKING: Rename SelectedNetworkControllerAction to SelectedNetworkControllerActions and SelectedNetworkControllerEvent to SelectedNetworkControllerEvents for consistency with corresponding type exports from other controllers (#1970).
  • BREAKING: createSelectedNetworkMiddleware return type is constrained to satisfy JsonRpcMiddleware<JsonRpcParams, Json>, and its req parameter is constrained to satisfy SelectedNetworkMiddlewareJsonRpcRequest (#1970).

4.0.0

Changed

  • BREAKING: Bump @metamask/base-controller to ^4.0.0 (#2063)
    • This is breaking because the type of the messenger has backward-incompatible changes. See the changelog for this package for more.
  • Bump @metamask/network-controller to ^17.0.0 (#2063)

3.1.2

Changed

  • BREAKING: Bump dependency and peer dependency on @metamask/network-controller to ^16.0.0

3.1.1

Changed

  • Bump @metamask/json-rpc-engine from ^7.1.0 to ^7.2.0 (#1895)

3.1.0

Added

  • Add getProviderAndBlockTracker method to get a proxy provider from NetworkController for a given origin/domain. (#1806)

Changed

  • No longer update selectedNetworkClientId when the NetworkController provider changes. (#1806)
  • Bump dependency and peer dependency on @metamask/network-controller to ^15.1.0

3.0.0

Changed

  • BREAKING: Bump dependency and peer dependency on @metamask/network-controller to ^14.0.0 (#1747)
  • BREAKING: Move from json-rpc-engine ^7.1.1 to @metamask/json-rpc-engine ^8.0.0 (#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)

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)

2.0.1

Changed

  • Update TypeScript to v4.8.x (#1718)

2.0.0

Changed

  • BREAKING: Bump peer dependency on @metamask/network-controller to ^13.0.0 (#1633)

1.0.0

Added

  • Initial Release (#1643)