feat: upgrade notification services controller to v4 api#9384
Merged
Conversation
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. Learn how to use preview builds in other projects. Expand for full list of packages and versions. |
zelkibuilds
added
the
team-notifications
7 tasks
![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 f65fb14. Configure here.
kirillzyusko
approved these changes
Jul 7, 2026
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
@metamask/notification-services-controllercurrently targets Notification API v3, which uses fixednotification_typevalues ("on-chain"/"platform") to distinguish notification shapes. The backend has moved to v4, wherenotification_typeandnotification_subtypeare producer-set database fields (e.g."wallet_activity"+"eth_sent"for on-chain,"perps"+"position_liquidated"for platform). Without this change, the controller continues calling v3 endpoints and types responses using the old discriminator model./api/v4/notificationsand/api/v4/notifications/mark-as-readschema.tsfrom the latest Notification API OpenAPI spec (v4 + legacy v1–v3 schemas)NotificationOutputV4,PlatformNotificationV4,OnChainNotificationV4)isOnChainNotification()/isPlatformNotification()— on-chain is identified bynotification_type === "wallet_activity"toRawAPINotification()to normalize v4 responses into the existing internal model:typefrompayload.data.kind(preserves existing processor routing)typetoTRIGGER_TYPES.PLATFORMregardless of producernotification_type(e.g."perps"), soprocessNotification()routing continues to workReferences
https://consensyssoftware.atlassian.net/browse/GE-330
schema.tsregeneration)notification_type === "on-chain" | "platform"must migrate to v4 values and/or useisOnChainNotification()/isPlatformNotification()Checklist
Note
High Risk
Marked breaking: consumers and any code still checking v3
notification_typevalues must update; incorrect discrimination could mis-route notifications, though in-package normalization is designed to preserve existing processors.Overview
Breaking:
@metamask/notification-services-controllernow calls Notification API v4 for listing and mark-as-read (/api/v4/notifications), with types and OpenAPIschema.tsaligned toNotificationOutputV4.v4 no longer uses fixed
notification_typevalues"on-chain"/"platform". On-chain items usenotification_type: "wallet_activity"and anotification_subtypefrom the on-chain kind; platform items use producer-setnotification_type/notification_subtype(e.g."perps"/"position_liquidated"). The package exportsisOnChainNotification/isPlatformNotificationandPlatformNotification/OnChainNotificationfor consumers.toRawAPINotificationnow branches onwallet_activity, still sets internal on-chaintypefrompayload.data.kind, and forces platform notifications toTRIGGER_TYPES.PLATFORMso existing processing paths stay the same. Mocks and changelog document the new shapes;AppPlatformgainsportfolio.Reviewed by Cursor Bugbot for commit 9c5002d. Bugbot is set up for automated code reviews on this repo. Configure here.