Skip to content

chore: adopt kyc-controller 0.13.0 and ramps-controller 28.0.0 - #38322

Merged
georgeweiler merged 2 commits into
mainfrom
chore/adopt-vba-analytics-controllers
Oct 28, 2026
Merged

georgeweiler merged 2 commits into
mainfrom
chore/adopt-vba-analytics-controllers

Conversation

@georgeweiler

@georgeweiler georgeweiler commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Description

Adopts the two controller releases that the VBA / KYC analytics work depends on, and nothing else. No app behaviour changes.

  • @metamask/kyc-controller ^0.12.0 → ^0.13.0
  • @metamask/ramps-controller ^27.1.0 → ^28.0.0

This is deliberately split out from the three analytics PRs that consume these APIs (#38078, #38160, #38161) for four reasons:

  1. ramps-controller is a major bump (27.1.0 → 28.0.0, also skipping 27.2.0). That is a Ramps/platform review, not an analytics review, and it should not be buried in a PR about Segment events.
  2. One lockfile change instead of three. If each analytics PR bumped, whichever merged first would force the other two to re-resolve yarn.lock.
  3. It makes the analytics PRs verifiable. All three currently reference APIs that did not exist in the installed versions, so none of them can produce a meaningful lint:tsc result until this lands.
  4. Revert safety. If the bump regresses something unrelated, it reverts on its own.

The breaking change is a no-op for us

ramps-controller@28.0.0 has one breaking change:

BREAKING: RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS now includes NeoBankService:listAutorampTransactions. Hosts must delegate that action to RampsController.

No code change is needed here. ramps-controller-messenger.ts already spreads the package-owned list rather than enumerating actions:

actions: [
  // Spread the package-owned required list so new service actions
  // (e.g. getDefaultRedirectCallbackUrl / NeoBankService) cannot be
  // forgotten at upgrade.
  ...RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS,
  ...
],

and NeoBankService is registered as a messenger client in Engine.ts, so the new action is delegated automatically.

Reviewer note: ramps-controller is now duplicated in the tree

@metamask/transaction-pay-controller@30.2.0 depends on @metamask/ramps-controller@^27.1.0, so this bump un-dedupes it:

├─ @metamask/transaction-pay-controller@npm:30.2.0
│  └─ @metamask/ramps-controller@npm:27.1.0 (via npm:^27.1.0)
└─ metamask@workspace:.
   └─ @metamask/ramps-controller@npm:28.0.0 (via npm:^28.0.0)

TPC references ramps in its messenger types (RampsControllerGetOrderAction, RampsControllerGetQuoteWithFeesAction). Those action shapes are unchanged in 28.0.0 — the only breaking change was the constant above — and lint:tsc passes, so this is a bundle-size cost rather than a correctness one. Flagging it so it is a conscious decision: the clean fix is a TPC release that widens its range to ^28.0.0, which can follow separately.

Changelog

CHANGELOG entry: null

Related issues

Refs: MetaMask/core#11017
Refs: MetaMask/core#11041
Refs: MetaMask/core#11141

Manual testing steps

Feature: VBA and KYC flows still work on the bumped controllers

  Scenario: Autoramp transactions still load on the VBA details screen
    Given a Money account with an approved autoramp
    When the user opens the virtual bank account details screen
    Then the deposit instructions render
    And no "action not registered" error is raised for NeoBankService:listAutorampTransactions

  Scenario: KYC identity verification still launches
    Given a user part way through VBA onboarding
    When the user reaches the identity verification step
    Then the SumSub webview opens as before
    And the stored KYC status still updates when the decision arrives

Screenshots/Recordings

N/A — dependency bump with no UI change.

Before

N/A

After

N/A

Pre-merge author checklist

  • I've followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
  • I've completed the PR template to the best of my ability
  • I've included tests if applicable — no new code, so no new tests. The existing ramps, KYC and ramps-messenger suites were run against the bumped packages (12 suites, 138 tests).
  • I've documented my code using JSDoc format if applicable — N/A, no new code.
  • I've applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Performance checks (if applicable)

  • I've tested on Android
  • I've tested with a power user scenario
  • I've instrumented key operations with Sentry traces for production performance metrics

Not applicable: no runtime code changes. The one performance-relevant consequence is the duplicated ramps-controller noted above, which is a bundle-size effect rather than a runtime one.

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

🤖 Generated with Claude Code


Note

Medium Risk
Major ramps-controller bump touches VBA/autoramp and KYC-adjacent flows; runtime wiring appears pre-covered, but regressions in money onboarding are still possible.

Overview
Dependency-only PR that upgrades @metamask/kyc-controller (^0.12.0 → ^0.13.0) and @metamask/ramps-controller (^27.1.0 → ^28.0.0), with matching yarn.lock resolution. No application logic changes beyond keeping tests aligned with the new controller default state.

The test background snapshot adds autorampTransactionRecords: {} under RampsController, matching new state shipped in ramps-controller 28. ramps-controller-messenger.ts already spreads RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS, so the 28.0 breaking requirement to delegate NeoBankService:listAutorampTransactions does not need a separate host change here.

This bump is split ahead of VBA/KYC analytics PRs that depend on these package APIs. Note that transaction-pay-controller may still pull ramps-controller@27.x, so the tree can temporarily carry two versions until TPC widens its range.

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

Dependency bump only, no app behaviour change. Split out from the three
VBA/KYC analytics PRs (#38078, #38160, #38161) that consume these APIs, so
the major ramps bump gets a platform review on its own, the lockfile moves
once rather than three times, and those PRs can produce a meaningful
lint:tsc result.

The one breaking change in ramps-controller 28.0.0 needs no code here:
RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS gained
NeoBankService:listAutorampTransactions, and the ramps controller messenger
already spreads that package-owned list instead of enumerating actions.

Note for review: @metamask/transaction-pay-controller@30.2.0 still pins
ramps-controller ^27.1.0, so the tree now carries both 27.1.0 and 28.0.0.
The action shapes it references are unchanged in 28.0.0; the clean fix is a
TPC release widening its range.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@metamask-ci metamask-ci Bot added the team-money-movement issues related to Money Movement features label Oct 27, 2026
@metamask-ci

metamask-ci Bot commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

PR template — items to address before "Ready for review"

Warnings — informational, address before merging:

  • Pre-merge author checklist has unchecked items (e.g. "I've applied the right labels on the PR (see labeling guidelines). Not required for external contributors."). Every box must be consciously checked — see docs/readme/ready-for-review.md.

See docs/readme/ready-for-review.md for the full Definition of Ready for Review.

@socket-security

socket-security Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

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

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updatednpm/​@​metamask/​kyc-controller@​0.12.0 ⏵ 0.13.077 -151008098 +1100
Addednpm/​@​metamask/​ramps-controller@​28.0.010010080100100

View full report

@georgeweiler
georgeweiler marked this pull request as ready for review October 27, 2026 20:21
@github-actions

github-actions Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Smart E2E Test Selection

Selected E2E tags: ALL

AI Confidence: 100

E2E reasoning

Expand to read

This PR contains two controller version bumps in package.json:

  1. @metamask/ramps-controller: ^27.1.0 → ^28.0.0 (MAJOR version bump) — This is the primary risk driver. A major version bump can introduce breaking API changes to the RampsController, which powers SmokeMoney flows (MetaMask Card, fiat on/off-ramp). The corresponding change to initial-background-state.json (adding 'autorampTransactionRecords: {}') confirms a new state shape was introduced, which could affect any E2E test that uses this fixture as a base state.

  2. @metamask/kyc-controller: ^0.12.0 → ^0.13.0 (minor bump) — Affects KYC flows which are part of Card/Money features.

  3. app/util/test/initial-background-state.json — Updated to include the new RampsController state field. This file is used as the base fixture state for E2E tests, meaning any test that relies on this fixture could be affected if the state shape is not correctly aligned.

The hard rule seed (controller-version-update) already mandated ALL tags due to controller package version updates. The major version bump of ramps-controller and the shared test fixture change justify running all smoke tests to ensure no regressions across any flow that depends on the controller state or the base fixture.

View run

amitabh94
amitabh94 previously approved these changes Oct 27, 2026
weitingsun
weitingsun previously approved these changes Oct 27, 2026
jiexi
jiexi previously approved these changes Oct 27, 2026
ramps-controller 28.0.0 adds autorampTransactionRecords to
getDefaultRampsControllerState, so Engine.test.ts "matches initial state
fixture" failed on the missing key.

The key is persisted state with a {} default, so existing installs pick it
up on the next write and no migration is needed. KycController 0.13.0 adds
no state, and this fixture is the only file that snapshots the ramps state
shape.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@georgeweiler
georgeweiler dismissed stale reviews from jiexi, weitingsun, and amitabh94 via 49c0f97 October 28, 2026 14:21
@sonarqubecloud

Copy link
Copy Markdown

@georgeweiler
georgeweiler added this pull request to the merge queue Oct 28, 2026
Merged via the queue into main with commit 35faf78 Oct 28, 2026
303 of 308 checks passed
@georgeweiler
georgeweiler deleted the chore/adopt-vba-analytics-controllers branch October 28, 2026 18:02
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 28, 2026
@metamask-ci metamask-ci Bot added the release-8.19.0 Issue or pull request that will be included in release 8.19.0 label Oct 28, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

release-8.19.0 Issue or pull request that will be included in release 8.19.0 size-XS team-money-movement issues related to Money Movement features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants