refactor: migrate SwapsController to @metamask/messenger

[mikesposito]

This PR migrates SwapsController to new @metamask/messenger instead of @metamask/base-controller. This is part of a larger effort to migrate all controllers to use @metamask/messenger.

• Fixes Replace RestrictedMessenger with delegated Messenger #405

---

Note

Migrate SwapsController to the new @metamask/messenger, rename metadata flag, and bump network/gas-fee controller peers to v25.

• Controller:
  • Replace RestrictedMessenger usage with new @metamask/messenger in SwapsController, using this.messenger for action handlers, calls, and subscriptions.
  • Rename state metadata flag from anonymous to includeInDebugSnapshot across metadata and tests.
  • Refactor stopPollingAndResetState to partially reset state using defaults.
  • Use messenger.call('NetworkController:getNetworkClientById', ...) for network lookups.
• Types/Tests:
  • Update SwapsControllerMessenger to Messenger<...> and related type wiring.
  • Rewrite tests to construct root and delegated messengers with @metamask/messenger and adjust snapshots.
• Dependencies:
  • Peer bumps: @metamask/gas-fee-controller ^25.0.0, @metamask/network-controller ^25.0.0.
  • Runtime: add @metamask/messenger ^0.3.0, bump @metamask/base-controller to ^9.0.0.
• Changelog:
  • Document breaking changes for messenger migration, metadata rename, and peer bumps.

^{Written by Cursor Bugbot for commit d49af03. This will update automatically on new commits. Configure here.}

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@​metamask/​eth-json-rpc-provider@​4.1.6 ⏵ 4.1.8	+1		+3	+3
	@​metamask/​base-controller@​8.3.0 ⏵ 9.0.0			-3	+1
	@​metamask/​gas-fee-controller@​24.0.0 ⏵ 25.0.0			+1	+9
	@​metamask/​controller-utils@​11.4.4 ⏵ 11.14.1	+1		+3	-2
	@​metamask/​network-controller@​25.0.0
	@​metamask/​json-rpc-engine@​10.0.1 ⏵ 10.1.1	+1			+4
	@​metamask/​utils@​11.8.0 ⏵ 11.8.1				-2

View full report

[mcmire]

LGTM!

Hmm, looks like CI is failing.

[Gudahtt]

The previous strategy of resetting the state one-property-at-a-time was causing a type error. The types for all properties were being combined into a single union, so then it wasn't able to ensure we were assigning a compatible type to each property.

It seemed simplest to reverse the process, and explicitly clear the properties we want, rather than clearing everything then restoring state to the properties we didn't want to clear.

[Gudahtt]

@metamaskbot publish-previews

[github-actions]

A preview build for this branch has been published.

You can configure your project to use the preview build with this identifier:

npm:@metamask-previews/swaps-controller@14.0.0-preview-4c94bcb

See these instructions for more information about preview builds.

[cryptodev-2s]

LGTM!

[Gudahtt]

LGTM!