Release/170.0.0 #4498

montelaidev · 2024-07-03T13:45:19Z

Explanation

Create release for:

@metamask/accounts-controller to ^17.2.0
@metamask/gas-fee-controller to ^18.0.0
@metamask/transaction-controller to ^34.0.0
@metamask/user-operation-controller to ^13.0.0

References

Changelog

`@metamask/accounts-controller`

ADDED: accountAdded and accountRemoved events (#4496)
ADDED: Export AccountsControllerListMultichainAccounts,AccountsControllerGetSelectedMultichainAccount,AccountsControllerGetNextAvailableAccountName}Action actions (#4497)
FIXED: Use listMultichainAccounts for non-EVM specific methods. (#4494)
FIXED: Set lastSelected for initial account (#4494)

`@metamask/gas-fee-controller`

BREAKING: Added back the constructor options legacyAPIEndpoint and EIP1559APIEndpoint. These URLs are no longer hardcoded within the controller.
BREAKING: Removed the infuraAPIKey. This was used to construct and send the Authorization header for Infura gas API requests. (#4446)
CHANGED: Changing providerConfig to selectedNetworkClientId (#4356)

`@metamask/user-operation-controller`

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)

`@metamask/transaction-controller`

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

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've highlighted breaking changes using the "BREAKING" category above as appropriate

packages/accounts-controller/CHANGELOG.md

dbrans · 2024-07-03T15:19:19Z

package.json

Hi @montelaidev, any chance you could release the gas-fee-controller? The fix that I need released is #4446.

packages/gas-fee-controller/CHANGELOG.md

packages/transaction-controller/CHANGELOG.md

packages/gas-fee-controller/CHANGELOG.md

Co-authored-by: Jongsun Suh <[email protected]>

dbrans

Thank you @montelaidev!

dbrans · 2024-07-03T16:57:13Z

@metamaskbot publish-preview

MajorLift · 2024-07-03T17:08:21Z

packages/accounts-controller/CHANGELOG.md

+## [17.2.0]
+
+### Added
+
+- Add `accountAdded` and `accountRemoved` events ([#4496](https://github.com/MetaMask/core/pull/4496))
+- Export `AccountsControllerListMultichainAccounts`,`AccountsControllerGetSelectedMultichainAccount`,`AccountsControllerGetNextAvailableAccountName}Action` actions ([#4497](https://github.com/MetaMask/core/pull/4497))
+
+### Fixed
+
+- Use `listMultichainAccounts` for non-EVM specific methods ([#4494](https://github.com/MetaMask/core/pull/4494))
+- Set `lastSelected` for initial account ([#4494](https://github.com/MetaMask/core/pull/4494))


Suggested change

## [17.2.0]

### Added

- Add `accountAdded` and `accountRemoved` events ([#4496](https://github.com/MetaMask/core/pull/4496))

- Export `AccountsControllerListMultichainAccounts`,`AccountsControllerGetSelectedMultichainAccount`,`AccountsControllerGetNextAvailableAccountName}Action` actions ([#4497](https://github.com/MetaMask/core/pull/4497))

### Fixed

- Use `listMultichainAccounts` for non-EVM specific methods ([#4494](https://github.com/MetaMask/core/pull/4494))

- Set `lastSelected` for initial account ([#4494](https://github.com/MetaMask/core/pull/4494))

## [18.0.0]

### Added

- **BREAKING:** `AccountsControllerMessenger` must allow the new internal events `AccountsController:accountAdded` and `AccountsController:accountRemoved`. ([#4496](https://github.com/MetaMask/core/pull/4496))

- Add and export corresponding event types `AccountsControllerAccountAddedEvent`, `AccountsControllerAccountRemovedEvent`.

- Export action types `AccountsControllerListMultichainAccounts`,`AccountsControllerGetSelectedMultichainAccount`,`AccountsControllerGetNextAvailableAccountName}Action`. ([#4497](https://github.com/MetaMask/core/pull/4497))

### Fixed

- Use `listMultichainAccounts` instead of `listAccounts` for non-EVM specific multichain methods. ([#4494](https://github.com/MetaMask/core/pull/4494))

- For initial account, emit `selectedAccountChange ` and update `lastSelected`. ([#4494](https://github.com/MetaMask/core/pull/4494))

I think the Fixed entries could be more user-friendly, and less reliant on knowledge of internal variables, but I'm lacking the understanding to come up with better phrasing. @montelaidev could you maybe provide some context on the user-facing changes here?

@mcmire Should we see the addition of new internal actions/events as a breaking change?

My initial reasoning was that the added actions/events now need to be present in the generic arguments of the non-restricted controller-messenger, but I'm not sure about this since unlike Allowed{Actions,Events}, we do export ExampleController{Action,Event}s, enabling the consumer to define a controller-messenger without keeping up with changes to the internal actions/events.

Previous discussion: #4413 (comment)

@MajorLift That's the way I've thought about it too: the reason it's a breaking change is that consumers now needs to allowlist that action or event when initializing the messenger, otherwise an error will be thrown when attempting to call or subscribe to that action or event. The fact that the messenger doesn't throw immediately if a used action or event is omitted from the allowlist is unfortunate, but there will be an error eventually.

For the fixed entries, they are only internal changes that fixes a bug.

The new events are internal AccountsController events though. It would be a breaking change if they were external actions/events that the AccountsController require.

For restricted messengers, only allowlists for external actions/events need to be supplied, but for unrestricted controller-messengers, consumers still define them by enumerating all actions/events e.g.

new ControllerMessenger< | AccountsControllerActions | NetworkControllerActions | NetworkControllerAllowedActions, ..., >();

The part I'm confused about is whether to call this non-breaking because users have access to the union types that fully enumerate internal actions/events, or to call this breaking because users could choose to use individual action/event type exports, in which case they'd need to keep track of additions to the internal actions/events e.g.

new ControllerMessenger< // | TokensControllerGetStateAction | TokensControllerAddDetectedTokensAction | TokensControllerExampleNewAction, ..., >();

(where tokens-controller only has the getState and addDetectedTokens actions)

Hmm, good point. I am inclined in this case not to treat it as a breaking change. My reasoning is that even if a consumer left out AccountsControllerAccountAddedEvent and AccountsControllerAccountRemovedEvent from the type parameter for the unrestricted controller messenger, the controller itself would still be able to emit the event. Whether the consumer is actually subscribing to the event or not is on the consumer, but I don't believe they'd be required to do that in order to upgrade. Does that reasoning make sense?

Hmm I was going to argue that adding these new internal actions/events represents additional requirements for the messenger constructor option, and will cause type errors in downstream controller instantiations, especially where we're deriving multiple restricted messengers from one ControllerMessenger.

However, I've found that restricted messengers with incomplete or even empty internal actions/events lists are being accepted by our controller constructors, as long as they have compatible allowlists for external actions/events. I'll have to create a ticket for addressing this.

I think it's accurate to say, at least for now, that this wouldn't be a breaking change for consumers. Once the controller has been instantiated, I agree that it makes sense to only look at whether the controller can publish the new events, and have the controller be agnostic about whether any given messenger (other than its own messagingSystem) subscribes to those events.

I put together a playground repro for this.

Looks like constructor controllers do raise a type error if they're passed a messenger that was defined with an incomplete list of internal actions/events, but fail to raise that error if either the Action or Event type union is completely missing all of the controller's internal actions/events. Interesting...

[base-controller] Controller constructors accept messengers that do not allow any of its internal actions and/or events #4501

Co-authored-by: Jongsun Suh <[email protected]>

packages/gas-fee-controller/CHANGELOG.md

mcmire · 2024-07-03T17:31:19Z

packages/accounts-controller/CHANGELOG.md

+## [17.2.0]
+
+### Added
+
+- Add `accountAdded` and `accountRemoved` events ([#4496](https://github.com/MetaMask/core/pull/4496))
+- Export `AccountsControllerListMultichainAccounts`,`AccountsControllerGetSelectedMultichainAccount`,`AccountsControllerGetNextAvailableAccountName}Action` actions ([#4497](https://github.com/MetaMask/core/pull/4497))
+
+### Fixed
+
+- Use `listMultichainAccounts` for non-EVM specific methods ([#4494](https://github.com/MetaMask/core/pull/4494))
+- Set `lastSelected` for initial account ([#4494](https://github.com/MetaMask/core/pull/4494))


@MajorLift Oh, I just realized you're talking about internal actions/events. Consumers don't need to explicitly allowlist internal actions/events, right? So then this would not be breaking after all. Is that right?

Co-authored-by: Elliot Winkler <[email protected]>

packages/accounts-controller/CHANGELOG.md

Co-authored-by: Jongsun Suh <[email protected]>

MajorLift

LGTM! Thanks everyone for your patience with the many update requests.

mcmire

LGTM!

ccharly · 2024-07-03T21:34:21Z

Thanks for all those feedback guys! :)

## Explanation Releases assets-controllers to new version `36.0.0` ## References  ## Changelog  ### `@metamask/assets-controllers` ### Added - **Added**: Add optional `topBid` property to the `NftMetadata` type. This property must be of type `TopBid`. ([#4522](#4522)) - **Added**: Add optional `floorAsk` property to the `TokenCollection` type. This property must be of type `FloorAskCollection`. ([#4522](#4522)) - **Added**: Add linea mainnet support to nft detection supported networks ([#4515](#4515)) - **Added**: Fetch NFT collections data from the NFT-API `getCollections` API when calling the `detectNfts` method of `NftDetectionController`, and the `updateNftMetadata` and `watchNft` methods of `NftController`. ([#4443](#4443)) ### Changed - **Changed**: Bump `@metamask/utils` to `^9.0.0` ([#4508](#4516)) - **Changed**: Bump `@metamask/rpc-errors` to `^6.3.1` ([#4498](#4516)) ### Fixed - **Breaking**: Changed attributes type in `NftMetadata` to `Attributes[]` ([#4522](#4522)) ## Checklist - [ ] I've updated the test suite for new or updated code as appropriate - [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [ ] I've highlighted breaking changes using the "BREAKING" category above as appropriate

montelaidev requested a review from a team as a code owner July 3, 2024 13:45

ccharly reviewed Jul 3, 2024

View reviewed changes

packages/accounts-controller/CHANGELOG.md Outdated Show resolved Hide resolved

dbrans reviewed Jul 3, 2024

View reviewed changes

montelaidev force-pushed the release/170.0.0 branch from c62acc6 to 48990da Compare July 3, 2024 15:22

montelaidev requested review from dbrans and ccharly July 3, 2024 15:24

montelaidev added the team-accounts label Jul 3, 2024

dbrans previously approved these changes Jul 3, 2024

View reviewed changes

montelaidev added 5 commits July 3, 2024 23:35

Initialize Release 170.0.0

f4e1b96

Update Release 170.0.0

05b1337

chore: update changelog

cb09fd8

fix: changelog

07256ab

fix: update changelog

1fd0e72

ccharly reviewed Jul 3, 2024

View reviewed changes

packages/gas-fee-controller/CHANGELOG.md Outdated Show resolved Hide resolved

packages/gas-fee-controller/CHANGELOG.md Outdated Show resolved Hide resolved

fix: changelog for user-op-controller and transactino-controller

c37dda1

montelaidev dismissed dbrans’s stale review via c37dda1 July 3, 2024 15:44

montelaidev force-pushed the release/170.0.0 branch from e6ecf1f to c37dda1 Compare July 3, 2024 15:44

montelaidev added 2 commits July 3, 2024 23:45

fix: missing colon

abb8d47

fix: user-operation changelog category

cb744f7

montelaidev requested review from ccharly and dbrans July 3, 2024 15:55

MajorLift reviewed Jul 3, 2024

View reviewed changes

packages/transaction-controller/CHANGELOG.md Show resolved Hide resolved

MajorLift reviewed Jul 3, 2024

View reviewed changes

packages/gas-fee-controller/CHANGELOG.md Outdated Show resolved Hide resolved

montelaidev and others added 2 commits July 4, 2024 00:35

Apply suggestions from code review

a79251c

Co-authored-by: Jongsun Suh <[email protected]>

fix: changelog for gas fee controller

32de691

dbrans previously approved these changes Jul 3, 2024

View reviewed changes

MajorLift reviewed Jul 3, 2024

View reviewed changes

montelaidev dismissed dbrans’s stale review via 283f758 July 3, 2024 17:12

Update packages/accounts-controller/CHANGELOG.md

283f758

Co-authored-by: Jongsun Suh <[email protected]>

dbrans previously approved these changes Jul 3, 2024

View reviewed changes

mcmire reviewed Jul 3, 2024

View reviewed changes

Update packages/gas-fee-controller/CHANGELOG.md

3986e36

Co-authored-by: Elliot Winkler <[email protected]>

montelaidev dismissed dbrans’s stale review via 3986e36 July 3, 2024 17:34

montelaidev added 2 commits July 4, 2024 01:36

fix: prettier

502f49c

fix: accounts controller changelog

644f74e

dbrans previously approved these changes Jul 3, 2024

View reviewed changes

MajorLift reviewed Jul 3, 2024

View reviewed changes

packages/accounts-controller/CHANGELOG.md Outdated Show resolved Hide resolved

MajorLift reviewed Jul 3, 2024

View reviewed changes

packages/accounts-controller/CHANGELOG.md Outdated Show resolved Hide resolved

chore: update accounts-controller changelog

9860c57

Co-authored-by: Jongsun Suh <[email protected]>

ccharly dismissed dbrans’s stale review via 9860c57 July 3, 2024 19:47

ccharly added 2 commits July 3, 2024 21:55

chore: fix action type naming

78a8f58

chore: update changelog

247271c

MajorLift approved these changes Jul 3, 2024

View reviewed changes

mcmire approved these changes Jul 3, 2024

View reviewed changes

dbrans approved these changes Jul 3, 2024

View reviewed changes

Merge branch 'main' into release/170.0.0

6cb3dde

ccharly merged commit a3acb59 into main Jul 3, 2024
116 checks passed

ccharly deleted the release/170.0.0 branch July 3, 2024 21:45

MajorLift mentioned this pull request Jul 25, 2024

Release 180.0.0 #4548

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release/170.0.0 #4498

Release/170.0.0 #4498

montelaidev commented Jul 3, 2024 •

edited

Loading

dbrans Jul 3, 2024

dbrans left a comment

dbrans commented Jul 3, 2024

MajorLift Jul 3, 2024

MajorLift Jul 3, 2024

MajorLift Jul 3, 2024 •

edited

Loading

mcmire Jul 3, 2024

montelaidev Jul 3, 2024

montelaidev Jul 3, 2024

MajorLift Jul 3, 2024 •

edited

Loading

mcmire Jul 3, 2024 •

edited

Loading

MajorLift Jul 3, 2024 •

edited

Loading

MajorLift Jul 3, 2024 •

edited

Loading

mcmire Jul 3, 2024

MajorLift left a comment

mcmire left a comment

ccharly commented Jul 3, 2024

Release/170.0.0 #4498

Release/170.0.0 #4498

Conversation

montelaidev commented Jul 3, 2024 • edited Loading

Explanation

References

Changelog

@metamask/accounts-controller

@metamask/gas-fee-controller

@metamask/user-operation-controller

@metamask/transaction-controller

Checklist

dbrans Jul 3, 2024

Choose a reason for hiding this comment

dbrans left a comment

Choose a reason for hiding this comment

dbrans commented Jul 3, 2024

MajorLift Jul 3, 2024

Choose a reason for hiding this comment

MajorLift Jul 3, 2024

Choose a reason for hiding this comment

MajorLift Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

mcmire Jul 3, 2024

Choose a reason for hiding this comment

montelaidev Jul 3, 2024

Choose a reason for hiding this comment

montelaidev Jul 3, 2024

Choose a reason for hiding this comment

MajorLift Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

mcmire Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

MajorLift Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

MajorLift Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

mcmire Jul 3, 2024

Choose a reason for hiding this comment

MajorLift left a comment

Choose a reason for hiding this comment

mcmire left a comment

Choose a reason for hiding this comment

ccharly commented Jul 3, 2024

montelaidev commented Jul 3, 2024 •

edited

Loading

`@metamask/accounts-controller`

`@metamask/gas-fee-controller`

`@metamask/user-operation-controller`

`@metamask/transaction-controller`

MajorLift Jul 3, 2024 •

edited

Loading

MajorLift Jul 3, 2024 •

edited

Loading

mcmire Jul 3, 2024 •

edited

Loading

MajorLift Jul 3, 2024 •

edited

Loading

MajorLift Jul 3, 2024 •

edited

Loading