Skip to content

feat: adopt messenger-cli pattern for 4 controller packages#8391

Merged
cryptodev-2s merged 4 commits intomainfrom
feat/messenger-cli-adoption
Apr 8, 2026
Merged

feat: adopt messenger-cli pattern for 4 controller packages#8391
cryptodev-2s merged 4 commits intomainfrom
feat/messenger-cli-adoption

Conversation

@cryptodev-2s
Copy link
Copy Markdown
Contributor

@cryptodev-2s cryptodev-2s commented Apr 7, 2026

Explanation

Several controller packages still manually define messenger action types and register action handlers individually. The @metamask/messenger-cli tool automates this by scanning for MESSENGER_EXPOSED_METHODS and generating type-safe action type files.

This PR migrates 4 packages to use the messenger-cli pattern:

  • keyring-controller — Replaces 20 manual registerActionHandler calls and 20 manually defined action types with a single registerMethodActionHandlers call and auto-generated types.
  • multichain-transactions-controller — Exposes updateTransactionsForAccount as a new messenger action (previously public but not registered).
  • multichain-network-controller — Replaces 2 manual handler registrations and manually defined action types with auto-generated ones.
  • ai-controllers — Replaces 2 manual handler registrations and manually defined action types with auto-generated ones.

All exported type names and shapes are unchanged — no breaking changes.

References

  • @metamask/messenger-cli package: packages/messenger-cli/
  • Reference implementation: packages/sample-controllers/src/sample-gas-prices-controller.ts

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 communicated my changes to consumers by updating changelogs for packages I've changed
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

Note

Medium Risk
Primarily a refactor of messenger action typing/registration, but it touches keyring-controller signing/vault-related messenger exposure; incorrect MESSENGER_EXPOSED_METHODS configuration could accidentally change which privileged methods are callable.

Overview
Migrates ai-controllers, keyring-controller, multichain-network-controller, and multichain-transactions-controller to the @metamask/messenger-cli pattern by defining MESSENGER_EXPOSED_METHODS, generating *-method-action-types.ts, and switching to messenger.registerMethodActionHandlers instead of many manual registerActionHandler calls.

Adds package scripts to check/generate messenger action types (and tsx devDependency) and updates exports so the generated action types remain available. multichain-transactions-controller now actually exposes updateTransactionsForAccount via messenger, and multichain-network-controller changelog notes exporting the getNetworksWithTransactionActivityByAccounts action type.

Reviewed by Cursor Bugbot for commit 47dc390. Bugbot is set up for automated code reviews on this repo. Configure here.

@cryptodev-2s cryptodev-2s requested review from a team as code owners April 7, 2026 16:22
@cryptodev-2s
Copy link
Copy Markdown
Contributor Author

@metamaskbot publish-preview

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2026

Preview builds have been published. Learn how to use preview builds in other projects.

Expand for full list of packages and versions.
@metamask-previews/account-tree-controller@7.0.0-preview-119723bcd
@metamask-previews/accounts-controller@37.2.0-preview-119723bcd
@metamask-previews/address-book-controller@7.1.1-preview-119723bcd
@metamask-previews/ai-controllers@0.6.3-preview-119723bcd
@metamask-previews/analytics-controller@1.0.1-preview-119723bcd
@metamask-previews/analytics-data-regulation-controller@0.0.0-preview-119723bcd
@metamask-previews/announcement-controller@8.1.0-preview-119723bcd
@metamask-previews/app-metadata-controller@2.0.1-preview-119723bcd
@metamask-previews/approval-controller@9.0.1-preview-119723bcd
@metamask-previews/assets-controller@4.0.0-preview-119723bcd
@metamask-previews/assets-controllers@103.1.1-preview-119723bcd
@metamask-previews/base-controller@9.0.1-preview-119723bcd
@metamask-previews/base-data-service@0.1.1-preview-119723bcd
@metamask-previews/bridge-controller@70.0.1-preview-119723bcd
@metamask-previews/bridge-status-controller@70.0.5-preview-119723bcd
@metamask-previews/build-utils@3.0.4-preview-119723bcd
@metamask-previews/chain-agnostic-permission@1.5.0-preview-119723bcd
@metamask-previews/claims-controller@0.5.0-preview-119723bcd
@metamask-previews/client-controller@1.0.1-preview-119723bcd
@metamask-previews/compliance-controller@2.0.0-preview-119723bcd
@metamask-previews/composable-controller@12.0.1-preview-119723bcd
@metamask-previews/config-registry-controller@0.2.0-preview-119723bcd
@metamask-previews/connectivity-controller@0.2.0-preview-119723bcd
@metamask-previews/controller-utils@11.20.0-preview-119723bcd
@metamask-previews/core-backend@6.2.1-preview-119723bcd
@metamask-previews/delegation-controller@2.1.0-preview-119723bcd
@metamask-previews/earn-controller@11.2.1-preview-119723bcd
@metamask-previews/eip-5792-middleware@3.0.3-preview-119723bcd
@metamask-previews/eip-7702-internal-rpc-middleware@0.1.0-preview-119723bcd
@metamask-previews/eip1193-permission-middleware@1.0.3-preview-119723bcd
@metamask-previews/ens-controller@19.1.1-preview-119723bcd
@metamask-previews/eth-block-tracker@15.0.1-preview-119723bcd
@metamask-previews/eth-json-rpc-middleware@23.1.1-preview-119723bcd
@metamask-previews/eth-json-rpc-provider@6.0.1-preview-119723bcd
@metamask-previews/foundryup@1.0.1-preview-119723bcd
@metamask-previews/gas-fee-controller@26.1.1-preview-119723bcd
@metamask-previews/gator-permissions-controller@3.0.1-preview-119723bcd
@metamask-previews/geolocation-controller@0.1.2-preview-119723bcd
@metamask-previews/json-rpc-engine@10.2.4-preview-119723bcd
@metamask-previews/json-rpc-middleware-stream@8.0.8-preview-119723bcd
@metamask-previews/keyring-controller@25.2.0-preview-119723bcd
@metamask-previews/logging-controller@8.0.1-preview-119723bcd
@metamask-previews/message-manager@14.1.1-preview-119723bcd
@metamask-previews/messenger@1.1.1-preview-119723bcd
@metamask-previews/messenger-cli@0.1.0-preview-119723bcd
@metamask-previews/money-account-controller@0.1.0-preview-119723bcd
@metamask-previews/multichain-account-service@8.0.1-preview-119723bcd
@metamask-previews/multichain-api-middleware@2.0.0-preview-119723bcd
@metamask-previews/multichain-network-controller@3.0.6-preview-119723bcd
@metamask-previews/multichain-transactions-controller@7.0.4-preview-119723bcd
@metamask-previews/name-controller@9.1.1-preview-119723bcd
@metamask-previews/network-controller@30.0.1-preview-119723bcd
@metamask-previews/network-enablement-controller@5.0.2-preview-119723bcd
@metamask-previews/notification-services-controller@23.0.1-preview-119723bcd
@metamask-previews/permission-controller@12.3.0-preview-119723bcd
@metamask-previews/permission-log-controller@5.1.0-preview-119723bcd
@metamask-previews/perps-controller@2.0.0-preview-119723bcd
@metamask-previews/phishing-controller@17.1.1-preview-119723bcd
@metamask-previews/polling-controller@16.0.4-preview-119723bcd
@metamask-previews/preferences-controller@23.1.0-preview-119723bcd
@metamask-previews/profile-metrics-controller@3.1.3-preview-119723bcd
@metamask-previews/profile-sync-controller@28.0.2-preview-119723bcd
@metamask-previews/ramps-controller@13.0.0-preview-119723bcd
@metamask-previews/rate-limit-controller@7.0.1-preview-119723bcd
@metamask-previews/react-data-query@0.2.0-preview-119723bcd
@metamask-previews/remote-feature-flag-controller@4.2.0-preview-119723bcd
@metamask-previews/sample-controllers@4.0.4-preview-119723bcd
@metamask-previews/seedless-onboarding-controller@9.1.0-preview-119723bcd
@metamask-previews/selected-network-controller@26.1.0-preview-119723bcd
@metamask-previews/shield-controller@5.1.1-preview-119723bcd
@metamask-previews/signature-controller@39.1.2-preview-119723bcd
@metamask-previews/social-controllers@0.1.0-preview-119723bcd
@metamask-previews/storage-service@1.0.1-preview-119723bcd
@metamask-previews/subscription-controller@6.1.2-preview-119723bcd
@metamask-previews/transaction-controller@64.0.0-preview-119723bcd
@metamask-previews/transaction-pay-controller@19.0.3-preview-119723bcd
@metamask-previews/user-operation-controller@41.2.0-preview-119723bcd

…s, multichain-network, and ai-controllers

Replace manually defined messenger action types and handlers with
auto-generated ones via @metamask/messenger-cli.
@cryptodev-2s cryptodev-2s force-pushed the feat/messenger-cli-adoption branch from 397012d to a78e4b2 Compare April 7, 2026 16:32
@cryptodev-2s
Copy link
Copy Markdown
Contributor Author

@metamaskbot publish-preview

@cryptodev-2s cryptodev-2s marked this pull request as draft April 7, 2026 16:39
@cryptodev-2s cryptodev-2s marked this pull request as ready for review April 7, 2026 16:40
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2026

Preview builds have been published. Learn how to use preview builds in other projects.

Expand for full list of packages and versions.
@metamask-previews/account-tree-controller@7.0.0-preview-47dc390
@metamask-previews/accounts-controller@37.2.0-preview-47dc390
@metamask-previews/address-book-controller@7.1.1-preview-47dc390
@metamask-previews/ai-controllers@0.6.3-preview-47dc390
@metamask-previews/analytics-controller@1.0.1-preview-47dc390
@metamask-previews/analytics-data-regulation-controller@0.0.0-preview-47dc390
@metamask-previews/announcement-controller@8.1.0-preview-47dc390
@metamask-previews/app-metadata-controller@2.0.1-preview-47dc390
@metamask-previews/approval-controller@9.0.1-preview-47dc390
@metamask-previews/assets-controller@4.0.0-preview-47dc390
@metamask-previews/assets-controllers@103.1.1-preview-47dc390
@metamask-previews/base-controller@9.0.1-preview-47dc390
@metamask-previews/base-data-service@0.1.1-preview-47dc390
@metamask-previews/bridge-controller@70.0.1-preview-47dc390
@metamask-previews/bridge-status-controller@70.0.5-preview-47dc390
@metamask-previews/build-utils@3.0.4-preview-47dc390
@metamask-previews/chain-agnostic-permission@1.5.0-preview-47dc390
@metamask-previews/claims-controller@0.5.0-preview-47dc390
@metamask-previews/client-controller@1.0.1-preview-47dc390
@metamask-previews/compliance-controller@2.0.0-preview-47dc390
@metamask-previews/composable-controller@12.0.1-preview-47dc390
@metamask-previews/config-registry-controller@0.2.0-preview-47dc390
@metamask-previews/connectivity-controller@0.2.0-preview-47dc390
@metamask-previews/controller-utils@11.20.0-preview-47dc390
@metamask-previews/core-backend@6.2.1-preview-47dc390
@metamask-previews/delegation-controller@2.1.0-preview-47dc390
@metamask-previews/earn-controller@11.2.1-preview-47dc390
@metamask-previews/eip-5792-middleware@3.0.3-preview-47dc390
@metamask-previews/eip-7702-internal-rpc-middleware@0.1.0-preview-47dc390
@metamask-previews/eip1193-permission-middleware@1.0.3-preview-47dc390
@metamask-previews/ens-controller@19.1.1-preview-47dc390
@metamask-previews/eth-block-tracker@15.0.1-preview-47dc390
@metamask-previews/eth-json-rpc-middleware@23.1.1-preview-47dc390
@metamask-previews/eth-json-rpc-provider@6.0.1-preview-47dc390
@metamask-previews/foundryup@1.0.1-preview-47dc390
@metamask-previews/gas-fee-controller@26.1.1-preview-47dc390
@metamask-previews/gator-permissions-controller@3.0.1-preview-47dc390
@metamask-previews/geolocation-controller@0.1.2-preview-47dc390
@metamask-previews/json-rpc-engine@10.2.4-preview-47dc390
@metamask-previews/json-rpc-middleware-stream@8.0.8-preview-47dc390
@metamask-previews/keyring-controller@25.2.0-preview-47dc390
@metamask-previews/logging-controller@8.0.1-preview-47dc390
@metamask-previews/message-manager@14.1.1-preview-47dc390
@metamask-previews/messenger@1.1.1-preview-47dc390
@metamask-previews/messenger-cli@0.1.0-preview-47dc390
@metamask-previews/money-account-controller@0.1.0-preview-47dc390
@metamask-previews/multichain-account-service@8.0.1-preview-47dc390
@metamask-previews/multichain-api-middleware@2.0.0-preview-47dc390
@metamask-previews/multichain-network-controller@3.0.6-preview-47dc390
@metamask-previews/multichain-transactions-controller@7.0.4-preview-47dc390
@metamask-previews/name-controller@9.1.1-preview-47dc390
@metamask-previews/network-controller@30.0.1-preview-47dc390
@metamask-previews/network-enablement-controller@5.0.2-preview-47dc390
@metamask-previews/notification-services-controller@23.0.1-preview-47dc390
@metamask-previews/permission-controller@12.3.0-preview-47dc390
@metamask-previews/permission-log-controller@5.1.0-preview-47dc390
@metamask-previews/perps-controller@2.0.0-preview-47dc390
@metamask-previews/phishing-controller@17.1.1-preview-47dc390
@metamask-previews/polling-controller@16.0.4-preview-47dc390
@metamask-previews/preferences-controller@23.1.0-preview-47dc390
@metamask-previews/profile-metrics-controller@3.1.3-preview-47dc390
@metamask-previews/profile-sync-controller@28.0.2-preview-47dc390
@metamask-previews/ramps-controller@13.0.0-preview-47dc390
@metamask-previews/rate-limit-controller@7.0.1-preview-47dc390
@metamask-previews/react-data-query@0.2.0-preview-47dc390
@metamask-previews/remote-feature-flag-controller@4.2.0-preview-47dc390
@metamask-previews/sample-controllers@4.0.4-preview-47dc390
@metamask-previews/seedless-onboarding-controller@9.1.0-preview-47dc390
@metamask-previews/selected-network-controller@26.1.0-preview-47dc390
@metamask-previews/shield-controller@5.1.1-preview-47dc390
@metamask-previews/signature-controller@39.1.2-preview-47dc390
@metamask-previews/social-controllers@0.1.0-preview-47dc390
@metamask-previews/storage-service@1.0.1-preview-47dc390
@metamask-previews/subscription-controller@6.1.2-preview-47dc390
@metamask-previews/transaction-controller@64.0.0-preview-47dc390
@metamask-previews/transaction-pay-controller@19.0.3-preview-47dc390
@metamask-previews/user-operation-controller@41.2.0-preview-47dc390

@cryptodev-2s
Copy link
Copy Markdown
Contributor Author

Adding no-changelog label (KeyringController & AiControllers) doesn't require a changelog.

@cryptodev-2s cryptodev-2s enabled auto-merge April 7, 2026 16:46
Copy link
Copy Markdown
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@cryptodev-2s cryptodev-2s added this pull request to the merge queue Apr 8, 2026
Merged via the queue into main with commit b9f60d5 Apr 8, 2026
342 of 343 checks passed
@cryptodev-2s cryptodev-2s deleted the feat/messenger-cli-adoption branch April 8, 2026 09:14
github-merge-queue bot pushed a commit that referenced this pull request Apr 8, 2026
…8408)

## Explanation

This adds `KeyringController:signTransaction` to
`MESSENGER_EXPOSED_METHODS` and exports the type, as this was missed in
#8391.

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## 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 communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/processes/updating-changelogs.md)
- [ ] I've introduced [breaking
changes](https://github.com/MetaMask/core/tree/main/docs/processes/breaking-changes.md)
in this PR and have prepared draft pull requests for clients and
consumer packages to resolve them

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Expands the controller’s messenger API to allow remote callers to
request transaction signatures, which is security-sensitive despite
being a small change. Risk is mainly around new call surface/permissions
and ensuring consumers handle the new action correctly.
> 
> **Overview**
> Enables `KeyringController:signTransaction` to be invoked through the
`KeyringController` messenger by adding it to the exposed method
allowlist.
> 
> Adds and exports the corresponding
`KeyringControllerSignTransactionAction` type (and updates the
method-action union), and records the new messenger exposure in the
package changelog.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
497b413. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants