Skip to content

Latest commit

 

History

History
221 lines (144 loc) · 11.8 KB

CHANGELOG.md

File metadata and controls

221 lines (144 loc) · 11.8 KB
Raw

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

Changed

  • Bump @metamask/base-controller from ^7.0.0 to ^7.1.0 (#5079)

6.0.2

Changed

  • Bump @metamask/utils from ^9.1.0 to ^10.0.0 (#4831)
  • Bump @metamask/base-controller from ^7.0.1 to ^7.0.2 (#4862)
  • Bump @metamask/controller-utils from ^11.3.0 to ^11.4.4 (#4834, #4862, #4870, #4915, #5012)

6.0.1

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.

6.0.0

Added

  • Add AddressBookController messenger types: AddressBookControllerMessenger, AddressBookControllerGetStateAction, AddressBookControllerActions, AddressBookControllerStateChangeEvent, AddressBookControllerEvents (#4392)
  • Add getDefaultAddressBookControllerState getter for the default state of AddressBookController (#4392)

Changed

  • BREAKING: AddressBookController inherits from BaseController, not BaseControllerV1 (#4392)
  • BREAKING: Add messenger as required constructor option to AddressBookController (#4392)
  • BREAKING: Rename AddressBookState type to AddressBookControllerState (#4392)
  • Bump @metamask/base-controller from ^6.0.0 to ^7.0.0 (#4517, #4544, #4625, #4643)
  • Bump @metamask/controller-utils from ^11.0.0 to ^11.2.0 (#4517, #4544, #4639, #4651)
  • Bump @metamask/utils from ^8.3.0 to ^9.1.0 (#4516, #4529)
  • Bump typescript from ~4.9.5 to ~5.2.2 and set module{,Resolution} options to Node16 (#3645, #4576, #4584)

Removed

  • BREAKING: Remove config from required constructor options of AddressBookController (#4392)
  • BREAKING: Remove AddressBookConfig type (#4392)

5.0.0

Changed

  • BREAKING: Bump minimum Node version to 18.18 (#3611)
  • Bump @metamask/base-controller to ^6.0.0 (#4352)
  • Bump @metamask/controller-utils to ^11.0.0 (#4352)

4.0.2

Changed

  • Bump @metamask/base-controller to ^5.0.2 (#4232)
  • Bump @metamask/controller-utils to ^10.0.0 (#4342)

Fixed

  • Fix delete method to protect against prototype-polluting assignments (#4041)

4.0.1

Fixed

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

4.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.
  • Bump @metamask/controller-utils to ^9.0.0 (#4039)

3.1.7

Changed

  • Bump @metamask/utils to ^8.3.0 (#3769)
  • Bump @metamask/base-controller to ^4.1.1 (#3760, #3821)
  • Bump @metamask/controller-utils to ^8.0.2 (#3821)

3.1.6

Changed

3.1.5

Changed

  • Bump @metamask/utils to ^8.2.0 (#1957)
  • Bump @metamask/base-controller to ^4.0.0 (#2063)
    • This is not a breaking change because this controller still inherits from BaseController v1.
  • Bump @metamask/controller-utils to ^6.0.0 (#2063)

3.1.4

Changed

  • Bump dependency on @metamask/utils to ^8.1.0 (#1639)
  • Bump dependency on @metamask/base-controller to ^3.2.3
  • Bump dependency on @metamask/controller-utils to ^5.0.2

3.1.3

Changed

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

3.1.2

Changed

  • Bump dependency on @metamask/controller-utils to ^5.0.0

3.1.1

Changed

  • Bump dependency on @metamask/base-controller to ^3.2.1
  • Bump dependency on @metamask/controller-utils to ^4.3.2

3.1.0

Changed

  • Update @metamask/utils to ^6.2.0 (#1514)

3.0.0

Changed

  • BREAKING:: Bump to Node 16 (#1262)
  • BREAKING: The addressBook state property is now keyed by Hex chain ID rather than string, and the chainId property of each address book entry is also Hex rather than string.
    • This requires a state migration (#1367)
  • BREAKING: The methods delete and set now except the chain ID as Hex rather than as a decimal string (#1367)
  • Add @metamask/utils dependency (#1367)

2.0.0

Removed

  • BREAKING: Remove isomorphic-fetch (#1106)
    • Consumers must now import isomorphic-fetch or another polyfill themselves if they are running in an environment without fetch

1.1.0

Changed

  • Add optional addressType property to address book entries (#828, #1068)
  • Rename this repository to core (#1031)
  • Update @metamask/controller-utils package (#1041)

1.0.1

Changed

  • Relax dependencies on @metamask/base-controller and @metamask/controller-utils (use ^ instead of ~) (#998)

1.0.0

Added

  • Initial release

    • As a result of converting our shared controllers repo into a monorepo (#831), we've created this package from select parts of @metamask/controllers v33.0.0, namely:

      • src/user/AddressBookController.ts
      • src/user/AddressBookController.test.ts

      All changes listed after this point were applied to this package following the monorepo conversion.