CHANGELOG.md

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)

21.0.0

Changed

• BREAKING: Bump @metamask/transaction-controller peer dependency from ^41.1.0 to ^42.0.0 (#5032)
• Bump @metamask/eth-block-tracker from to ^11.0.2 to ^11.0.3 (#5025)

20.0.1

Changed

• Bump @metamask/controller-utils from ^11.4.3 to ^11.4.4 (#5012)
• Bump @metamask/polling-controller from ^12.0.1 to ^12.0.2 (#5012)

Fixed

• Make implicit peer dependencies explicit (#4974)
  • Add the following packages as peer dependencies of this package to satisfy peer dependency requirements from other dependencies:
    • @metamask/eth-block-tracker >=9 (required by @metamask/transaction-controller)
  • These dependencies really should be present in projects that consume this package (e.g. MetaMask clients), and this change ensures that they now are.
  • Furthermore, we are assuming that clients already use these dependencies, since otherwise it would be impossible to consume this package in its entirety or even create a working build. Hence, the addition of these peer dependencies is really a formality and should not be breaking.
• Correct ESM-compatible build so that imports of the following packages that re-export other modules via export * are no longer corrupted: (#5011)
  • @metamask/eth-query
  • bn.js
  • lodash

20.0.0

Changed

• BREAKING: Bump @metamask/transaction-controller peer dependency from ^40.1.0 to ^41.0.0 (#4982)

19.0.0

Changed

• BREAKING: Bump @metamask/keyring-controller peer dependency from ^18.0.0 to ^19.0.0 (#4195)
• BREAKING: Bump @metamask/transaction-controller peer dependency from ^39.0.0 to ^40.0.0 (#4195)

18.0.0

Changed

• BREAKING: Bump peer depepdency @metamask/transaction-controller from ^38.0.0 to ^39.0.0 (#4915)
• BREAKING: Bump peer depepdency @metamask/keyring-controller from ^17.0.0 to ^18.0.0 (#4915)
• Bump @metamask/polling-controller from ^12.0.0 to ^12.0.1 (#4870)
• Bump @metamask/base-controller from ^7.0.1 to ^7.0.2 (#4862)
• Bump @metamask/controller-utils from ^11.4.0 to ^11.4.3 (#4862, #4870, #4915)

17.0.0

Changed

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

16.0.0

Added

• Added new entries bridge, bridgeApproval to the TransactionType enum (#4714)

Changed

• BREAKING: PendingUserOperationTracker now uses a new polling interface that accepts the generic parameter PollingInput (#4752)
• BREAKING: The inherited AbstractPollingController method startPollingByNetworkClientId has been renamed to startPolling (#4752)
• BREAKING: The inherited AbstractPollingController method onPollingComplete now returns the entire input object of type PollingInput, instead of a network client id (#4752)
• Bump @metamask/transaction-controller from ^37.1.0 to ^37.3.0 (#4754,#4805)
• Bump @metamask/approval-controller from ^7.0.4 to ^7.1.0 (#4734)
• Bump @metamask/keyring-controller from ^17.2.1 to ^17.2.2 (#4734)
• Bump @metamask/transaction-controller from ^37.0.0 to ^37.1.0 (#4734)

15.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.

15.0.0

Changed

• BREAKING: Bump devDependency and peerDependency @metamask/network-controller from ^20.0.0 to ^21.0.0 (#4618, #4651)
• BREAKING: Bump devDependency and peerDependency @metamask/transaction-controller from ^35.0.0 to ^36.0.0 ( #4651)
• BREAKING: Bump devDependency and peerDependency @metamask/gas-fee-controller from ^19.0.0 to ^20.0.0 ( #4651)
• Bump @metamask/base-controller from ^6.0.2 to ^7.0.0 (#4625, #4643)
• Bump @metamask/controller-utils from ^11.0.2 to ^11.2.0 (#4639, #4651)
• Bump @metamask/polling-controller from ^9.0.1 to ^10.0.0 (#4651)
• Bump typescript from ~5.0.4 to ~5.2.2 (#4576, #4584)

14.0.1

Changed

• Remove @metamask/approval-controller, @metamask/gas-fee-controller, @metamask/keyring-controller, @metamask/network-controller, and @metamask/transaction-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/controller-utils from ^11.0.0 to ^11.0.2 (#4517, #4544)
• Bump @metamask/polling-controller from ^9.0.0 to ^9.0.1 (#4548)
• Bump @metamask/rpc-errors from ^6.2.1 to ^6.3.1 (#4516)
• Bump @metamask/utils from ^8.3.0 to ^9.1.0 (#4516, #4529)

Fixed

• Replace superstruct with ESM-compatible @metamask/superstruct ^3.1.0 (#3645)
  • This fixes the issue of this package being unusable by any TypeScript project that uses Node16 or NodeNext as its moduleResolution option.

14.0.0

Changed

• BREAKING: Bump peerDependency @metamask/network-controller to ^20.0.0 (#4508)
• BREAKING: Bump peerDependency @metamask/gas-fee-controller to ^19.0.0 (#4508)
• BREAKING: Bump peerDependency @metamask/transaction-controller to ^35.0.0 (#4508)
• Bump @metamask/polling-controller to ^9.0.0 (#4508)

13.0.0

Changed

• BREAKING: Bump dependency and peer dependency @metamask/gas-fee-controller to ^18.0.0 (#4498)
• BREAKING: Bump dependency and peer dependency @metamask/transaction-controller to ^34.0.0 (#4498)

12.0.1

Changed

• Bump @metamask/transaction-controller to ^33.0.1 (#4460)

12.0.0

Changed

• BREAKING: Bump minimum Node version to 18.18 (#3611)
• BREAKING: Bump dependency and peer dependency @metamask/approval-controller to ^7.0.0 (#4352)
• BREAKING: Bump dependency and peer dependency @metamask/gas-fee-controller to ^17.0.0 (#4352)
• BREAKING: Bump dependency and peer dependency @metamask/keyring-controller to ^17.0.0 (#4352)
• BREAKING: Bump dependency and peer dependency @metamask/network-controller to ^19.0.0 (#4352)
• BREAKING: Bump dependency and peer dependency @metamask/transaction-controller to ^32.0.0 (#4352)
• Bump @metamask/base-controller to ^6.0.0 (#4352)
• Bump @metamask/controller-utils to ^11.0.0 (#4352)
• Bump @metamask/polling-controller to ^8.0.0 (#4352)

11.0.0

Added

• Add support for "swap+send" transactions (#4298)
  • Add optional properties destinationTokenAmount, sourceTokenAddress, sourceTokenAmount, sourceTokenDecimals, and swapAndSendRecipient to TransactionMeta
  • Add swapAndSend as a new entry in TransactionType enum
  • When persisting this type of transaction, copy source tokens, destination tokens, and recipient from swap data, and emit TransactionController:newSwapAndSend controller event

Changed

• BREAKING: Bump dependency and peer dependency @metamask/approval-controller to ^6.0.2 (#4342)
• BREAKING: Bump dependency and peer dependency @metamask/gas-fee-controller to ^16.0.0 (#4342)
• BREAKING: Bump dependency and peer dependency @metamask/keyring-controller to ^16.1.0 (#4342)
• BREAKING: Bump dependency and peer dependency @metamask/network-controller to ^18.1.3 (#4342)
• BREAKING: Bump dependency and peer dependency @metamask/transaction-controller to ^31.0.0 (#4342)
• Bump @metamask/controller-utils to ^10.0.0 (#4342)
• Bump @metamask/polling-controller to ^7.0.0 (#4342)

10.0.0

Changed

• BREAKING: Bump @metamask/transaction-controller peer dependency to ^29.0.0 (#4272)

9.0.0

Changed

• BREAKING Bump @metamask/keyring-controller peer dependency to ^16.0.0 (#4234)
• Bump @metamask/base-controller to ^5.0.2 (#4232)
• Bump @metamask/transaction-controller to ^28.1.1 (#4229)
• Bump @metamask/gas-fee-controller to ^15.1.1 (#4220, #4234)
• Bump @metamask/approval-controller to ^6.0.2 (#4234)
• Bump @metamask/polling-controller to ^6.0.2 (#4234)

8.0.1

Fixed

• Support number gas values in user operation receipts (#4161)

8.0.0

Changed

• BREAKING Bump peer dependency on @metamask/keyring-controller to ^15.0.0 and Pass CAIP-2 scope to execution context (#4090)
• Allow gas limits to be changed during #addPaymasterData (#3942)

7.0.0

Changed

• BREAKING: Bump peer dependency @metamask/gas-fee-controller to ^15.0.0 (#4121)
• BREAKING: Bump peer dependency @metamask/transaction-controller to ^26.0.0 (#4121)
• Bump dependency @metamask/network-controller to ^18.1.0 (#4121)

6.0.2

Fixed

• Include gas fees in user operations when using a paymaster (#4032)

6.0.1

Fixed

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

6.0.0

Added

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

Changed

• BREAKING: Bump dependency and peer dependency on @metamask/approval-controller to ^6.0.0 (#4039)
• BREAKING: Bump dependency and peer dependency on @metamask/gas-fee-controller to ^14.0.0 (#4039)
• BREAKING: Bump dependency and peer dependency on @metamask/keyring-controller to ^14.0.0 (#4039)
• BREAKING: Bump dependency and peer dependency on @metamask/network-controller to ^18.0.0 (#4039)
• BREAKING: Bump dependency and peer dependency on @metamask/transaction-controller to ^25.0.0 (#4039)
• BREAKING: Bump @metamask/controller-utils to ^9.0.0 (#4039)
• BREAKING: Bump @metamask/polling-controller to ^6.0.0 (#4039)

5.0.0

Changed

• BREAKING: Bump @metamask/keyring-controller dependency and peer dependency to ^13.0.0 (#4007)
• BREAKING: Bump @metamask/transaction-controller dependency and peer dependency to ^24.0.0 (#4007)
• Bump @metamask/approval-controller to ^5.1.3 (#4007)
• Bump @metamask/controller-utils to ^8.0.4 (#4007)
• Bump @metamask/gas-fee-controller to ^13.0.2 (#4007)
• Bump @metamask/network-controller to ^17.2.1 (#4007)
• Bump @metamask/rpc-errors to ^6.2.1 (#3954)
• Bump @metamask/polling-controller to ^5.0.1 (#4007)
• Replace ethereumjs-util with bn.js (#3943)

4.0.0

Changed

• BREAKING: Bump @metamask/transaction-controller dependency and peer dependency to ^23.0.0 (#3925)

3.0.0

Changed

• BREAKING: Add required from property to PrepareUserOperationRequest (#3844)
• BREAKING: Add required from property to AddUserOperationRequest (#3844)
• BREAKING: Make smartContractAccount optional in AddUserOperationOptions (#3844)
  • Use current account snap by default if not provided (#3844)
• Delete user operation if rejected during approval (#3844)
• Set userFeeLevel to custom in transaction event if using a paymaster (#3844)
• Validate arguments when calling addUserOperationFromTransaction (#3844)

2.0.0

Changed

• BREAKING: Bump @metamask/approval-controller peer dependency to ^5.1.2 (#3821)
• BREAKING: Bump @metamask/gas-fee-controller peer dependency to ^13.0.0 (#3821)
• BREAKING: Bump @metamask/network-controller peer dependency to ^17.2.0 (#3821)
• BREAKING: Bump @metamask/transaction-controller peer dependency to ^21.0.0 (#3821)
• Bump @metamask/base-controller to ^4.1.1 (#3821)
• Bump @metamask/controller-utils to ^8.0.2 (#3821)
• Bump @metamask/message-manager to ^7.3.8 (#3821)
• Bump @metamask/polling-controller to ^5.0.0 (#3821)

Removed

• Remove @metamask/polling-controller peer dependency (#3823)
  • This was mistakenly added as a peer dependency in v1. Now it's a regular dependency.

1.0.0

Added

• Initial Release (#3749)