feat(ramps): rename onRamp* controller & service to ramps* (#7502)

## Explanation

This PR renames all of the "on*" prefixed ramps controllers, services,
interfaces, comments, variable names to just "Ramps".

It also adds a build script and a watch script to improve the ramps
development environment.

Lastly, it updates the return structure of the geolocation fetch so that
the correct values can be access and set to the ramp controller state.

To use: place `metamask-mobile` and `core` in the same directory, then
`cd core/packages/ramps-controller`, `yarn dev`. The watcher will build
and replace in the metamask-mobile project.

If the mobile watcher is running the app will auto-refresh.


<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

## 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
-->


## Changelog

### `@metamask/ramps-controller`

#### Added
- Renamed variables and added dev script

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




<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Renames OnRampService to RampsService (including action namespaces),
adds dev watch/link scripts for mobile integration, and fixes
geolocation response handling.
> 
> - **Core renames**
> - Rename `OnRampService` → `RampsService` and `OnRampEnvironment` →
`RampsEnvironment`.
> - Update action namespaces/types from `OnRampService:*` →
`RampsService:*` (e.g., `getGeolocation`).
> - Adjust imports, messenger types/namespaces, and exports in
`src/index.ts`, controller/service, and tests.
> - **Bug fix**
> - `RampsService#getGeolocation`: read and return response text within
policy execution; validate non-empty result.
> - **Dev tooling**
> - Add `dev-watch.js` and `link-ramp-controller.js` to auto-build and
copy `dist/` to `metamask-mobile`.
>   - Add `"dev": "node dev-watch.js"` script to `package.json`.
> - **Changelog**
>   - Document added scripts, renames, and geolocation fix.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
91c391d. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: georgeweiler

packages/ramps-controller/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `dev-watch.js` and `link-ramp-controller.js` scripts to auto-build and copy `dist/` into `metamask-mobile/node_modules/@metamask/ramps-controller`
+- Add `"dev": "node dev-watch.js"` script to `package.json`
+
+### Changed
+
+- Rename `OnRampService` to `RampsService` and `OnRampEnvironment` to `RampsEnvironment` ([#7316](https://github.com/MetaMask/core/pull/7316))
+- Rename action types from `OnRampService:*` to `RampsService:*` (e.g., `OnRampService:getGeolocation` → `RampsService:getGeolocation`)
+- Update imports, messenger types/namespaces, and exports in `src/index.ts`, controller/service files, and tests
+
+### Fixed
+
+- Fix `RampsService#getGeolocation` to read response text within the policy execution and return parsed text
+
 ## [1.0.0]
 
 ### Added

packages/ramps-controller/dev-watch.js

@@ -0,0 +1,78 @@
+/* eslint-disable */
+const { spawn } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Simple file watcher for ramps-controller development
+ * Watches src/ directory and runs link script on changes
+ */
+
+const srcDir = path.join(__dirname, 'src');
+const linkScript = path.join(__dirname, 'link-ramp-controller.js');
+
+console.log('👀 Watching ramps-controller src/ directory...');
+console.log('📁 Press Ctrl+C to stop watching\n');
+
+// Keep track of last build time to avoid rapid rebuilds
+let lastBuildTime = 0;
+const BUILD_THROTTLE_MS = 500; // Wait 500ms after last change before building
+
+// Function to run the link script
+function runLinkScript() {
+  return new Promise((resolve, reject) => {
+    console.log('🔄 Changes detected, rebuilding and linking...');
+    const child = spawn('node', [linkScript], {
+      stdio: 'inherit',
+      cwd: __dirname,
+    });
+
+    child.on('close', (code) => {
+      if (code !== 0) {
+        console.error(`❌ Failed to rebuild and link (exit code ${code})`);
+        reject(new Error(`Link script exited with code ${code}`));
+      } else {
+        console.log('✅ Rebuild and link complete\n');
+        console.log('👀 Watching for changes...\n');
+        resolve();
+      }
+    });
+
+    child.on('error', (error) => {
+      console.error('❌ Failed to spawn link script:', error.message);
+      reject(error);
+    });
+  });
+}
+
+// Simple file watcher using fs.watch
+function watchDirectory(dir) {
+  fs.watch(dir, { recursive: true }, (_eventType, filename) => {
+    if (filename && (filename.endsWith('.ts') || filename.endsWith('.js'))) {
+      const now = Date.now();
+      if (now - lastBuildTime > BUILD_THROTTLE_MS) {
+        lastBuildTime = now;
+        // Debounce the build to avoid multiple rapid builds
+        setTimeout(async () => {
+          if (Date.now() - lastBuildTime >= BUILD_THROTTLE_MS) {
+            await runLinkScript();
+          }
+        }, BUILD_THROTTLE_MS);
+      }
+    }
+  });
+}
+
+// Watch the src directory
+watchDirectory(srcDir);
+
+// Also watch the link script itself
+fs.watchFile(linkScript, () => {
+  console.log('🔄 Link script changed, will rebuild on next src change');
+});
+
+// Initial build and link
+console.log('🏗️  Performing initial build and link...');
+runLinkScript().catch(() => {
+  // Initial build errors are handled within runLinkScript
+});

packages/ramps-controller/link-ramp-controller.js

@@ -0,0 +1,126 @@
+/* eslint-disable */
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+// Helper function to check if path exists (replacement for deprecated fs.existsSync)
+function pathExistsSync(filePath) {
+  try {
+    fs.accessSync(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Script to link ramps-controller for local development in MetaMask Mobile
+ * This builds and copies the ramps-controller files to the mobile app's node_modules
+ */
+
+const rampsControllerPath = __dirname;
+const mobileNodeModulesPath = path.join(
+  __dirname,
+  '..',
+  '..',
+  '..',
+  'metamask-mobile',
+  'node_modules',
+  '@metamask',
+);
+const rampsControllerDestPath = path.join(
+  mobileNodeModulesPath,
+  'ramps-controller',
+);
+
+// Always rebuild ramps-controller to ensure we have the latest changes
+const distPath = path.join(rampsControllerPath, 'dist');
+console.log('🔨 Building ramps-controller...');
+
+// Clear any existing dist directory first
+if (pathExistsSync(distPath)) {
+  fs.rmSync(distPath, { recursive: true, force: true });
+  console.log('🗑️  Cleared existing build artifacts.');
+}
+
+try {
+  execSync('yarn build', {
+    cwd: rampsControllerPath,
+    stdio: 'inherit',
+    env: { ...process.env, FORCE_COLOR: '1' }
+  });
+  console.log('✅ ramps-controller built successfully!');
+} catch (error) {
+  console.error('❌ Failed to build ramps-controller:', error.message);
+  process.exit(1);
+}
+
+// Check if mobile app exists
+const mobilePath = path.join(__dirname, '..', '..', '..', 'metamask-mobile');
+if (!pathExistsSync(mobilePath)) {
+  console.error('❌ MetaMask mobile app not found at expected location.');
+  process.exit(1);
+}
+
+console.log('🔗 Linking ramps-controller for local development...');
+
+// Create @metamask directory if it doesn't exist
+if (!pathExistsSync(mobileNodeModulesPath)) {
+  fs.mkdirSync(mobileNodeModulesPath, { recursive: true });
+}
+
+// Remove existing link if it exists
+if (pathExistsSync(rampsControllerDestPath)) {
+  fs.rmSync(rampsControllerDestPath, { recursive: true, force: true });
+}
+
+// Files and directories to include (matches package.json "files" field + essential files)
+const INCLUDED_ENTRIES = new Set([
+  'dist',
+  'package.json',
+  'LICENSE',
+  'README.md',
+]);
+
+// Copy a directory recursively
+function copyDir(src, dest) {
+  if (!pathExistsSync(dest)) {
+    fs.mkdirSync(dest, { recursive: true });
+  }
+
+  const entries = fs.readdirSync(src, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+// Copy only the files needed for the package (per package.json "files" field)
+fs.mkdirSync(rampsControllerDestPath, { recursive: true });
+
+for (const entryName of INCLUDED_ENTRIES) {
+  const srcPath = path.join(rampsControllerPath, entryName);
+  const destPath = path.join(rampsControllerDestPath, entryName);
+
+  if (!pathExistsSync(srcPath)) {
+    continue;
+  }
+
+  const stat = fs.statSync(srcPath);
+  if (stat.isDirectory()) {
+    copyDir(srcPath, destPath);
+  } else {
+    fs.copyFileSync(srcPath, destPath);
+  }
+}
+
+console.log('✅ Successfully linked ramps-controller to MetaMask mobile app!');
+console.log(`📁 Copied to: ${rampsControllerDestPath}`);
+console.log('🔄 Re-run this script when you make changes to automatically rebuild and relink.');

packages/ramps-controller/package.json

@@ -40,6 +40,7 @@
     "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/ramps-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/ramps-controller",
+    "dev": "node dev-watch.js",
     "publish:preview": "yarn npm publish --tag preview",
     "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",

packages/ramps-controller/src/RampsController.test.ts

@@ -6,9 +6,9 @@ import type {
   MessengerEvents,
 } from '@metamask/messenger';
 
-import type { OnRampServiceGetGeolocationAction } from './OnRampService-method-action-types';
 import type { RampsControllerMessenger } from './RampsController';
 import { RampsController } from './RampsController';
+import type { RampsServiceGetGeolocationAction } from './RampsService-method-action-types';
 
 describe('RampsController', () => {
   describe('constructor', () => {
@@ -116,7 +116,7 @@ describe('RampsController', () => {
     it('updates geolocation state when geolocation is fetched', async () => {
       await withController(async ({ controller, rootMessenger }) => {
         rootMessenger.registerActionHandler(
-          'OnRampService:getGeolocation',
+          'RampsService:getGeolocation',
           async () => 'US',
         );
 
@@ -134,8 +134,7 @@ describe('RampsController', () => {
  */
 type RootMessenger = Messenger<
   MockAnyNamespace,
-  | MessengerActions<RampsControllerMessenger>
-  | OnRampServiceGetGeolocationAction,
+  MessengerActions<RampsControllerMessenger> | RampsServiceGetGeolocationAction,
   MessengerEvents<RampsControllerMessenger>
 >;
 
@@ -179,7 +178,7 @@ function getMessenger(rootMessenger: RootMessenger): RampsControllerMessenger {
   });
   rootMessenger.delegate({
     messenger,
-    actions: ['OnRampService:getGeolocation'],
+    actions: ['RampsService:getGeolocation'],
   });
   return messenger;
 }

packages/ramps-controller/src/RampsController.ts

@@ -6,7 +6,7 @@ import type {
 import { BaseController } from '@metamask/base-controller';
 import type { Messenger } from '@metamask/messenger';
 
-import type { OnRampServiceGetGeolocationAction } from './OnRampService-method-action-types';
+import type { RampsServiceGetGeolocationAction } from './RampsService-method-action-types';
 
 // === GENERAL ===
 
@@ -73,7 +73,7 @@ export type RampsControllerActions = RampsControllerGetStateAction;
 /**
  * Actions from other messengers that {@link RampsController} calls.
  */
-type AllowedActions = OnRampServiceGetGeolocationAction;
+type AllowedActions = RampsServiceGetGeolocationAction;
 
 /**
  * Published when the state of {@link RampsController} changes.
@@ -141,12 +141,12 @@ export class RampsController extends BaseController<
 
   /**
    * Updates the user's geolocation.
-   * This method calls the OnRampService to get the geolocation
+   * This method calls the RampsService to get the geolocation
    * and stores the result in state.
    */
   async updateGeolocation(): Promise<void> {
     const geolocation = await this.messenger.call(
-      'OnRampService:getGeolocation',
+      'RampsService:getGeolocation',
     );
 
     this.update((state) => {

…src/OnRampService-method-action-types.ts …/src/RampsService-method-action-types.tspackages/ramps-controller/src/OnRampService-method-action-types.ts renamed to packages/ramps-controller/src/RampsService-method-action-types.ts packages/ramps-controller/src/OnRampService-method-action-types.ts renamed to packages/ramps-controller/src/RampsService-method-action-types.ts

@@ -3,20 +3,20 @@
  * Do not edit manually.
  */
 
-import type { OnRampService } from './OnRampService';
+import type { RampsService } from './RampsService';
 
 /**
  * Makes a request to the API in order to retrieve the user's geolocation
  * based on their IP address.
  *
  * @returns The user's country/region code (e.g., "US-UT" for Utah, USA).
  */
-export type OnRampServiceGetGeolocationAction = {
-  type: `OnRampService:getGeolocation`;
-  handler: OnRampService['getGeolocation'];
+export type RampsServiceGetGeolocationAction = {
+  type: `RampsService:getGeolocation`;
+  handler: RampsService['getGeolocation'];
 };
 
 /**
- * Union of all OnRampService action types.
+ * Union of all RampsService action types.
  */
-export type OnRampServiceMethodActions = OnRampServiceGetGeolocationAction;
+export type RampsServiceMethodActions = RampsServiceGetGeolocationAction;