feat: shield controller wire in wallet package#9616
Open
tuna1207 wants to merge 8 commits into
Open
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ 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 0fc9607. Configure here.
lwin-kyaw
reviewed
Jul 23, 2026
| options: ShieldControllerInstanceOptions; | ||
| }) => { | ||
| return new ShieldController({ | ||
| messenger: messenger as unknown as ShieldControllerMessenger, |
Comment on lines
+62
to
+64
| transactionHistoryLimit: options.transactionHistoryLimit, | ||
| coverageHistoryLimit: options.coverageHistoryLimit, | ||
| normalizeSignatureRequest: options.normalizeSignatureRequest, |
Contributor
There was a problem hiding this comment.
Let's just forward instead of hard assigning each.
Suggested change
| transactionHistoryLimit: options.transactionHistoryLimit, | |
| coverageHistoryLimit: options.coverageHistoryLimit, | |
| normalizeSignatureRequest: options.normalizeSignatureRequest, | |
| ...options, |
| import type { SignatureStateChange } from '@metamask/signature-controller'; | ||
| import type { TransactionControllerStateChangeEvent } from '@metamask/transaction-controller'; | ||
|
|
||
| export type ShieldBackend = Pick< |
Contributor
There was a problem hiding this comment.
Why do we need to modify this?
I've noticed that this is being used in ShieldControllerInstanceOptions. I don't think we will ever provide the custom backend instance here.
Comment on lines
+21
to
+27
| export type ShieldControllerInitializationMessenger = Messenger< | ||
| 'ShieldController', | ||
| ShieldControllerActions | AuthenticationControllerGetBearerTokenAction, | ||
| | ShieldControllerEvents | ||
| | SignatureStateChange | ||
| | TransactionControllerStateChangeEvent | ||
| >; |
Contributor
There was a problem hiding this comment.
Messenger should come from the controller package right? Why?
Comment on lines
+29
to
+45
| export type ShieldControllerInstanceOptions = { | ||
| /** | ||
| * When set, used as-is; `baseUrl`, `fetchFunction`, `getAccessToken`, and | ||
| * `captureException` are ignored for backend construction. | ||
| */ | ||
| backend?: ShieldBackend; | ||
| /** Required when building the default `ShieldRemoteBackend`. */ | ||
| baseUrl: string; | ||
| fetchFunction: typeof fetch; | ||
| getAccessToken?: () => Promise<string>; | ||
| captureException?: (error: Error) => void; | ||
| getCoverageResultTimeout?: number; | ||
| getCoverageResultPollInterval?: number; | ||
| transactionHistoryLimit?: number; | ||
| coverageHistoryLimit?: number; | ||
| normalizeSignatureRequest?: NormalizeSignatureRequestFn; | ||
| }; |
Contributor
There was a problem hiding this comment.
Please use direct type reference from controller, instead of redefining or overrides.
Suggested change
| export type ShieldControllerInstanceOptions = { | |
| /** | |
| * When set, used as-is; `baseUrl`, `fetchFunction`, `getAccessToken`, and | |
| * `captureException` are ignored for backend construction. | |
| */ | |
| backend?: ShieldBackend; | |
| /** Required when building the default `ShieldRemoteBackend`. */ | |
| baseUrl: string; | |
| fetchFunction: typeof fetch; | |
| getAccessToken?: () => Promise<string>; | |
| captureException?: (error: Error) => void; | |
| getCoverageResultTimeout?: number; | |
| getCoverageResultPollInterval?: number; | |
| transactionHistoryLimit?: number; | |
| coverageHistoryLimit?: number; | |
| normalizeSignatureRequest?: NormalizeSignatureRequestFn; | |
| }; | |
| export type ShieldControllerInstanceOptions = | |
| ConstructorParameters<typeof ShieldController>[0]; |
| transactionController?: TransactionControllerInstanceOptions; | ||
| passkeyController?: PasskeyControllerInstanceOptions; | ||
| seedlessOnboardingController?: SeedlessOnboardingControllerInstanceOptions; | ||
| shieldController: ShieldControllerInstanceOptions; |
Contributor
There was a problem hiding this comment.
Why shieldController is required type here?
Contributor
There was a problem hiding this comment.
Most controllers/services are optional here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
Adds ShieldController as a default initialized unit in @metamask/wallet.
@metamask/wallet is the shared controller-integration layer for extension, mobile, and other clients. Build-specific and runtime values are injected via instanceOptions rather than hardcoded.
Breaking changes
References
Checklist
Note
High Risk
Breaking change for all wallet consumers; Shield touches transaction/signature coverage and auth token wiring, so misconfiguration or missing peer controllers could affect security-related flows.
Overview
Breaking:
@metamask/walletnow initializes ShieldController by default and requires a newinstanceOptions.shieldControllerslot (baseUrl,fetchFunction, or an injectedbackend).The wallet adds a shield initialization module that builds
ShieldRemoteBackendby default (optionalgetAccessToken, polling, history limits,normalizeSignatureRequest), delegatesAuthenticationController:getBearerTokenand transaction/signaturestateChangeevents on the root messenger, and does not auto-start Shield—hosts must registerAuthenticationControllerandSignatureControllerand callShieldController:startexplicitly.wallet-cli passes the production ruleset URL (
https://ruleset-engine.api.cx.metamask.io) andfetchfor the daemon. shield-controller tests update the default API host to the same URL. Package deps add@metamask/shield-controllerand@metamask/signature-controller; CODEOWNERS and README dependency graph are updated.Reviewed by Cursor Bugbot for commit a905ac5. Bugbot is set up for automated code reviews on this repo. Configure here.