Skip to content

feat!: expose snap-only keyring methods through service + use explicit keyring.v1 for v1 account management Snaps#9390

Open
ccharly wants to merge 26 commits into
mainfrom
cc/feat/snap-account-service-snap-rpc-methods
Open

feat!: expose snap-only keyring methods through service + use explicit keyring.v1 for v1 account management Snaps#9390
ccharly wants to merge 26 commits into
mainfrom
cc/feat/snap-account-service-snap-rpc-methods

Conversation

@ccharly

@ccharly ccharly commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Explanation

The new SnapKeyring (v2), is no longer inheriting SnapKeyringV1 (to make v1 calls more explicit).

This PR now uses this new pattern (keyring.v1) and also re-expose Snap-only methods that were part of the v1 keyring-API on the SnapAccountService directly. Those methods can also be called using a standard KeyringClient (v1 or v2), but using the service is generally preferred to remove the need of constructing a keyring client to submit the request to the Snap.

References

N/A

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

High Risk
Breaking changes to RestrictedSnapKeyring and new SnapAccountService messenger permissions affect account creation and snap integration; incorrect v1/v2 routing could break multichain account provisioning or selected-account sync.

Overview
Aligns with eth-snap-keyring v23, where v1 APIs are no longer mixed onto the v2 keyring surface. Snap account flows now use an optional keyring.v1 for legacy create-account and keyring Snap messages, and fail clearly when a Snap is v2-only.

SnapAccountService gains messenger-backed getAccountAssets, getAccountBalances, getAccountTransactions, resolveAccountAddress, and setSelectedAccounts, implemented via KeyringInternalSnapClient and SnapController:handleRequest. Selected-account notification and automatic forwarding use keyring.v1.setSelectedAccounts for v1 Snaps and the RPC client for v2-only Snaps; handleKeyringSnapMessage rejects v2-only keyrings instead of delegating blindly.

multichain-account-service updates RestrictedSnapKeyring (breaking: top-level createAccountv1?.createAccount) and adds v1 guards in BTC/SOL/TRX/XLM providers plus tests. The monorepo bumps @metamask/keyring-api, eth-snap-keyring, and keyring-snap-client across dependent packages.

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

@socket-security

socket-security Bot commented Jul 6, 2026

Copy link
Copy Markdown

@ccharly ccharly force-pushed the cc/feat/snap-account-service-snap-rpc-methods branch from 9cd4cab to 0221bce Compare July 6, 2026 13:59
@ccharly

ccharly commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

@metamaskbot publish-preview

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

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.5.3-preview-272ce4465
@metamask-previews/accounts-controller@39.0.4-preview-272ce4465
@metamask-previews/address-book-controller@7.1.2-preview-272ce4465
@metamask-previews/ai-controllers@0.7.0-preview-272ce4465
@metamask-previews/analytics-controller@1.2.1-preview-272ce4465
@metamask-previews/analytics-data-regulation-controller@0.0.0-preview-272ce4465
@metamask-previews/announcement-controller@8.1.0-preview-272ce4465
@metamask-previews/app-metadata-controller@2.0.1-preview-272ce4465
@metamask-previews/approval-controller@9.0.2-preview-272ce4465
@metamask-previews/assets-controller@10.0.1-preview-272ce4465
@metamask-previews/assets-controllers@109.3.0-preview-272ce4465
@metamask-previews/authenticated-user-storage@3.0.0-preview-272ce4465
@metamask-previews/base-controller@9.1.0-preview-272ce4465
@metamask-previews/base-data-service@0.1.3-preview-272ce4465
@metamask-previews/bitcoin-regtest-up@1.0.0-preview-272ce4465
@metamask-previews/bridge-controller@77.3.2-preview-272ce4465
@metamask-previews/bridge-status-controller@74.0.2-preview-272ce4465
@metamask-previews/build-utils@3.0.4-preview-272ce4465
@metamask-previews/chain-agnostic-permission@1.6.2-preview-272ce4465
@metamask-previews/chomp-api-service@3.1.0-preview-272ce4465
@metamask-previews/claims-controller@0.5.3-preview-272ce4465
@metamask-previews/client-controller@1.0.1-preview-272ce4465
@metamask-previews/client-utils@0.0.0-preview-272ce4465
@metamask-previews/compliance-controller@2.1.0-preview-272ce4465
@metamask-previews/composable-controller@12.0.1-preview-272ce4465
@metamask-previews/config-registry-controller@0.4.1-preview-272ce4465
@metamask-previews/connectivity-controller@0.2.0-preview-272ce4465
@metamask-previews/controller-utils@12.3.0-preview-272ce4465
@metamask-previews/core-backend@6.5.0-preview-272ce4465
@metamask-previews/delegation-controller@3.0.2-preview-272ce4465
@metamask-previews/earn-controller@12.2.2-preview-272ce4465
@metamask-previews/eip-5792-middleware@3.0.4-preview-272ce4465
@metamask-previews/eip-7702-internal-rpc-middleware@0.1.1-preview-272ce4465
@metamask-previews/eip1193-permission-middleware@2.0.1-preview-272ce4465
@metamask-previews/ens-controller@19.1.5-preview-272ce4465
@metamask-previews/eth-block-tracker@15.0.1-preview-272ce4465
@metamask-previews/eth-json-rpc-middleware@23.1.3-preview-272ce4465
@metamask-previews/eth-json-rpc-provider@6.0.1-preview-272ce4465
@metamask-previews/foundryup@1.0.1-preview-272ce4465
@metamask-previews/gas-fee-controller@26.2.4-preview-272ce4465
@metamask-previews/gator-permissions-controller@4.2.2-preview-272ce4465
@metamask-previews/geolocation-controller@0.1.3-preview-272ce4465
@metamask-previews/java-tron-up@1.0.0-preview-272ce4465
@metamask-previews/json-rpc-engine@10.5.0-preview-272ce4465
@metamask-previews/json-rpc-middleware-stream@8.0.8-preview-272ce4465
@metamask-previews/keyring-controller@27.1.0-preview-272ce4465
@metamask-previews/local-node-utils@1.0.0-preview-272ce4465
@metamask-previews/logging-controller@8.0.2-preview-272ce4465
@metamask-previews/message-manager@14.1.2-preview-272ce4465
@metamask-previews/messenger@2.0.0-preview-272ce4465
@metamask-previews/messenger-cli@0.2.0-preview-272ce4465
@metamask-previews/money-account-balance-service@2.1.2-preview-272ce4465
@metamask-previews/money-account-controller@0.3.3-preview-272ce4465
@metamask-previews/money-account-upgrade-controller@2.2.1-preview-272ce4465
@metamask-previews/multichain-account-service@11.1.0-preview-272ce4465
@metamask-previews/multichain-api-middleware@4.0.0-preview-272ce4465
@metamask-previews/multichain-network-controller@3.2.1-preview-272ce4465
@metamask-previews/multichain-transactions-controller@7.1.1-preview-272ce4465
@metamask-previews/name-controller@9.1.2-preview-272ce4465
@metamask-previews/network-controller@34.0.0-preview-272ce4465
@metamask-previews/network-enablement-controller@5.4.1-preview-272ce4465
@metamask-previews/notification-services-controller@24.3.0-preview-272ce4465
@metamask-previews/passkey-controller@2.0.1-preview-272ce4465
@metamask-previews/permission-controller@13.1.1-preview-272ce4465
@metamask-previews/permission-log-controller@5.1.0-preview-272ce4465
@metamask-previews/perps-controller@9.2.0-preview-272ce4465
@metamask-previews/phishing-controller@17.2.0-preview-272ce4465
@metamask-previews/platform-api-docs@0.0.0-preview-272ce4465
@metamask-previews/polling-controller@16.0.8-preview-272ce4465
@metamask-previews/preferences-controller@23.1.0-preview-272ce4465
@metamask-previews/profile-metrics-controller@4.0.1-preview-272ce4465
@metamask-previews/profile-sync-controller@28.2.0-preview-272ce4465
@metamask-previews/ramps-controller@15.0.0-preview-272ce4465
@metamask-previews/rate-limit-controller@7.0.1-preview-272ce4465
@metamask-previews/react-data-query@0.2.1-preview-272ce4465
@metamask-previews/remote-feature-flag-controller@4.2.2-preview-272ce4465
@metamask-previews/sample-controllers@5.0.3-preview-272ce4465
@metamask-previews/seedless-onboarding-controller@10.0.3-preview-272ce4465
@metamask-previews/selected-network-controller@26.1.5-preview-272ce4465
@metamask-previews/shield-controller@5.1.2-preview-272ce4465
@metamask-previews/signature-controller@39.2.7-preview-272ce4465
@metamask-previews/smart-transactions-controller@24.2.4-preview-272ce4465
@metamask-previews/snap-account-service@1.0.0-preview-272ce4465
@metamask-previews/social-controllers@2.3.1-preview-272ce4465
@metamask-previews/solana-test-validator-up@1.0.0-preview-272ce4465
@metamask-previews/stellar-quickstart-up@0.0.0-preview-272ce4465
@metamask-previews/storage-service@1.0.2-preview-272ce4465
@metamask-previews/subscription-controller@6.2.0-preview-272ce4465
@metamask-previews/transaction-controller@68.2.2-preview-272ce4465
@metamask-previews/transaction-pay-controller@23.17.4-preview-272ce4465
@metamask-previews/user-operation-controller@41.2.6-preview-272ce4465
@metamask-previews/wallet@6.0.0-preview-272ce4465
@metamask-previews/wallet-cli@0.0.0-preview-272ce4465

@ccharly ccharly changed the title feat(snap-account-service)!: expose snap-only keyring methods through the service feat!: expose snap-only keyring methods through service + use explicit keyring.v1 for v1 account management Snaps Jul 7, 2026
@ccharly ccharly marked this pull request as ready for review July 7, 2026 10:37
@ccharly ccharly requested review from a team as code owners July 7, 2026 10:37
@ccharly ccharly temporarily deployed to default-branch July 7, 2026 10:37 — with GitHub Actions Inactive

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 3065189. Configure here.

Comment thread packages/multichain-account-service/src/providers/SnapAccountProvider.ts Outdated
@ccharly ccharly requested review from a team as code owners July 7, 2026 10:45
@ccharly ccharly force-pushed the cc/feat/snap-account-service-snap-rpc-methods branch from 8c7abb2 to 803c8d6 Compare July 7, 2026 10:53
@ccharly

ccharly commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

@metamaskbot publish-preview

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

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.5.3-preview-3a27accda
@metamask-previews/accounts-controller@39.0.4-preview-3a27accda
@metamask-previews/address-book-controller@7.1.2-preview-3a27accda
@metamask-previews/ai-controllers@0.7.0-preview-3a27accda
@metamask-previews/analytics-controller@1.2.1-preview-3a27accda
@metamask-previews/analytics-data-regulation-controller@0.0.0-preview-3a27accda
@metamask-previews/announcement-controller@8.1.0-preview-3a27accda
@metamask-previews/app-metadata-controller@2.0.1-preview-3a27accda
@metamask-previews/approval-controller@9.0.2-preview-3a27accda
@metamask-previews/assets-controller@10.0.1-preview-3a27accda
@metamask-previews/assets-controllers@109.3.0-preview-3a27accda
@metamask-previews/authenticated-user-storage@3.0.0-preview-3a27accda
@metamask-previews/base-controller@9.1.0-preview-3a27accda
@metamask-previews/base-data-service@0.1.3-preview-3a27accda
@metamask-previews/bitcoin-regtest-up@1.0.0-preview-3a27accda
@metamask-previews/bridge-controller@77.3.2-preview-3a27accda
@metamask-previews/bridge-status-controller@74.0.2-preview-3a27accda
@metamask-previews/build-utils@3.0.4-preview-3a27accda
@metamask-previews/chain-agnostic-permission@1.7.0-preview-3a27accda
@metamask-previews/chomp-api-service@3.1.0-preview-3a27accda
@metamask-previews/claims-controller@0.5.3-preview-3a27accda
@metamask-previews/client-controller@1.0.1-preview-3a27accda
@metamask-previews/client-utils@0.0.0-preview-3a27accda
@metamask-previews/compliance-controller@2.1.0-preview-3a27accda
@metamask-previews/composable-controller@12.0.1-preview-3a27accda
@metamask-previews/config-registry-controller@0.4.1-preview-3a27accda
@metamask-previews/connectivity-controller@0.2.0-preview-3a27accda
@metamask-previews/controller-utils@12.3.0-preview-3a27accda
@metamask-previews/core-backend@6.5.0-preview-3a27accda
@metamask-previews/delegation-controller@3.0.2-preview-3a27accda
@metamask-previews/earn-controller@12.2.2-preview-3a27accda
@metamask-previews/eip-5792-middleware@3.0.4-preview-3a27accda
@metamask-previews/eip-7702-internal-rpc-middleware@0.1.1-preview-3a27accda
@metamask-previews/eip1193-permission-middleware@2.0.1-preview-3a27accda
@metamask-previews/ens-controller@19.1.5-preview-3a27accda
@metamask-previews/eth-block-tracker@15.0.1-preview-3a27accda
@metamask-previews/eth-json-rpc-middleware@23.1.3-preview-3a27accda
@metamask-previews/eth-json-rpc-provider@6.0.1-preview-3a27accda
@metamask-previews/foundryup@1.0.1-preview-3a27accda
@metamask-previews/gas-fee-controller@26.2.4-preview-3a27accda
@metamask-previews/gator-permissions-controller@4.2.2-preview-3a27accda
@metamask-previews/geolocation-controller@0.1.3-preview-3a27accda
@metamask-previews/java-tron-up@1.0.0-preview-3a27accda
@metamask-previews/json-rpc-engine@10.5.0-preview-3a27accda
@metamask-previews/json-rpc-middleware-stream@8.0.8-preview-3a27accda
@metamask-previews/keyring-controller@27.1.0-preview-3a27accda
@metamask-previews/local-node-utils@1.0.0-preview-3a27accda
@metamask-previews/logging-controller@8.0.2-preview-3a27accda
@metamask-previews/message-manager@14.1.2-preview-3a27accda
@metamask-previews/messenger@2.0.0-preview-3a27accda
@metamask-previews/messenger-cli@0.2.0-preview-3a27accda
@metamask-previews/money-account-api-data-service@0.0.0-preview-3a27accda
@metamask-previews/money-account-balance-service@2.1.2-preview-3a27accda
@metamask-previews/money-account-controller@0.3.3-preview-3a27accda
@metamask-previews/money-account-upgrade-controller@2.2.1-preview-3a27accda
@metamask-previews/multichain-account-service@11.1.0-preview-3a27accda
@metamask-previews/multichain-api-middleware@4.0.1-preview-3a27accda
@metamask-previews/multichain-network-controller@3.2.1-preview-3a27accda
@metamask-previews/multichain-transactions-controller@7.1.1-preview-3a27accda
@metamask-previews/name-controller@9.1.2-preview-3a27accda
@metamask-previews/network-controller@34.0.0-preview-3a27accda
@metamask-previews/network-enablement-controller@5.4.1-preview-3a27accda
@metamask-previews/notification-services-controller@24.3.0-preview-3a27accda
@metamask-previews/passkey-controller@2.0.1-preview-3a27accda
@metamask-previews/permission-controller@13.1.1-preview-3a27accda
@metamask-previews/permission-log-controller@5.1.0-preview-3a27accda
@metamask-previews/perps-controller@9.2.1-preview-3a27accda
@metamask-previews/phishing-controller@17.2.0-preview-3a27accda
@metamask-previews/platform-api-docs@0.0.0-preview-3a27accda
@metamask-previews/polling-controller@16.0.8-preview-3a27accda
@metamask-previews/preferences-controller@23.1.0-preview-3a27accda
@metamask-previews/profile-metrics-controller@4.0.1-preview-3a27accda
@metamask-previews/profile-sync-controller@28.2.0-preview-3a27accda
@metamask-previews/ramps-controller@15.1.0-preview-3a27accda
@metamask-previews/rate-limit-controller@7.0.1-preview-3a27accda
@metamask-previews/react-data-query@0.2.1-preview-3a27accda
@metamask-previews/remote-feature-flag-controller@4.2.2-preview-3a27accda
@metamask-previews/sample-controllers@5.0.3-preview-3a27accda
@metamask-previews/seedless-onboarding-controller@10.0.3-preview-3a27accda
@metamask-previews/selected-network-controller@26.1.5-preview-3a27accda
@metamask-previews/shield-controller@5.1.2-preview-3a27accda
@metamask-previews/signature-controller@39.2.7-preview-3a27accda
@metamask-previews/smart-transactions-controller@24.2.4-preview-3a27accda
@metamask-previews/snap-account-service@1.0.0-preview-3a27accda
@metamask-previews/social-controllers@2.3.1-preview-3a27accda
@metamask-previews/solana-test-validator-up@1.0.0-preview-3a27accda
@metamask-previews/stellar-quickstart-up@0.0.0-preview-3a27accda
@metamask-previews/storage-service@1.0.2-preview-3a27accda
@metamask-previews/subscription-controller@6.2.0-preview-3a27accda
@metamask-previews/transaction-controller@68.2.2-preview-3a27accda
@metamask-previews/transaction-pay-controller@23.17.4-preview-3a27accda
@metamask-previews/user-operation-controller@41.2.6-preview-3a27accda
@metamask-previews/wallet@7.0.0-preview-3a27accda
@metamask-previews/wallet-cli@0.0.0-preview-3a27accda

Comment thread packages/multichain-account-service/CHANGELOG.md Outdated
Comment thread packages/multichain-account-service/src/providers/SnapAccountProvider.ts Outdated
ccharly and others added 2 commits July 7, 2026 16:37
Co-authored-by: Hassan Malik <41640681+hmalik88@users.noreply.github.com>
Co-authored-by: Hassan Malik <41640681+hmalik88@users.noreply.github.com>
hmalik88
hmalik88 previously approved these changes Jul 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants