@metamask/ramps-controller 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0]
+
+### Added
+
+- Initial release ([#7316](https://github.com/MetaMask/core/pull/7316))
+  - Add `RampsController` for managing on/off ramps state
+  - Add `OnRampService` for interacting with the OnRamp API
+  - Add geolocation detection via IP address lookup
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ramps-controller@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/ramps-controller@1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/ramps-controller`
+
+A controller for managing cryptocurrency on/off ramps functionality.
+
+## Installation
+
+`yarn add @metamask/ramps-controller`
+
+or
+
+`npm install @metamask/ramps-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/OnRampService-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=OnRampService-method-action-types.cjs.map

package/dist/OnRampService-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"OnRampService-method-action-types.cjs","sourceRoot":"","sources":["../src/OnRampService-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { OnRampService } from './OnRampService';\n\n/**\n * Makes a request to the API in order to retrieve the user's geolocation\n * based on their IP address.\n *\n * @returns The user's country/region code (e.g., \"US-UT\" for Utah, USA).\n */\nexport type OnRampServiceGetGeolocationAction = {\n  type: `OnRampService:getGeolocation`;\n  handler: OnRampService['getGeolocation'];\n};\n\n/**\n * Union of all OnRampService action types.\n */\nexport type OnRampServiceMethodActions = OnRampServiceGetGeolocationAction;\n"]}

package/dist/OnRampService-method-action-types.d.cts

@@ -0,0 +1,20 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { OnRampService } from "./OnRampService.cjs";
+/**
+ * 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'];
+};
+/**
+ * Union of all OnRampService action types.
+ */
+export type OnRampServiceMethodActions = OnRampServiceGetGeolocationAction;
+//# sourceMappingURL=OnRampService-method-action-types.d.cts.map

package/dist/OnRampService-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OnRampService-method-action-types.d.cts","sourceRoot":"","sources":["../src/OnRampService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,4BAAwB;AAErD;;;;;GAKG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,iCAAiC,CAAC"}

package/dist/OnRampService-method-action-types.d.mts

@@ -0,0 +1,20 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { OnRampService } from "./OnRampService.mjs";
+/**
+ * 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'];
+};
+/**
+ * Union of all OnRampService action types.
+ */
+export type OnRampServiceMethodActions = OnRampServiceGetGeolocationAction;
+//# sourceMappingURL=OnRampService-method-action-types.d.mts.map

package/dist/OnRampService-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OnRampService-method-action-types.d.mts","sourceRoot":"","sources":["../src/OnRampService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,4BAAwB;AAErD;;;;;GAKG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,iCAAiC,CAAC"}

package/dist/OnRampService-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=OnRampService-method-action-types.mjs.map

package/dist/OnRampService-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"OnRampService-method-action-types.mjs","sourceRoot":"","sources":["../src/OnRampService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { OnRampService } from './OnRampService';\n\n/**\n * Makes a request to the API in order to retrieve the user's geolocation\n * based on their IP address.\n *\n * @returns The user's country/region code (e.g., \"US-UT\" for Utah, USA).\n */\nexport type OnRampServiceGetGeolocationAction = {\n  type: `OnRampService:getGeolocation`;\n  handler: OnRampService['getGeolocation'];\n};\n\n/**\n * Union of all OnRampService action types.\n */\nexport type OnRampServiceMethodActions = OnRampServiceGetGeolocationAction;\n"]}

package/dist/OnRampService.cjs

@@ -0,0 +1,204 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _a, _OnRampService_messenger, _OnRampService_fetch, _OnRampService_policy, _OnRampService_baseUrl;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnRampService = exports.OnRampEnvironment = exports.serviceName = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+// === GENERAL ===
+/**
+ * The name of the {@link OnRampService}, used to namespace the
+ * service's actions and events.
+ */
+exports.serviceName = 'OnRampService';
+/**
+ * The environment to use for API requests.
+ */
+var OnRampEnvironment;
+(function (OnRampEnvironment) {
+    OnRampEnvironment["Production"] = "production";
+    OnRampEnvironment["Staging"] = "staging";
+    OnRampEnvironment["Development"] = "development";
+})(OnRampEnvironment || (exports.OnRampEnvironment = OnRampEnvironment = {}));
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['getGeolocation'];
+// === SERVICE DEFINITION ===
+/**
+ * Gets the base URL for API requests based on the environment.
+ *
+ * @param environment - The environment to use.
+ * @returns The base URL for API requests.
+ */
+function getBaseUrl(environment) {
+    switch (environment) {
+        case OnRampEnvironment.Production:
+            return 'https://on-ramp.api.cx.metamask.io';
+        case OnRampEnvironment.Staging:
+            return 'https://on-ramp.uat-api.cx.metamask.io';
+        case OnRampEnvironment.Development:
+            return 'http://localhost:3000';
+        default:
+            throw new Error(`Invalid environment: ${String(environment)}`);
+    }
+}
+/**
+ * This service object is responsible for interacting with the OnRamp API.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   OnRampServiceActions,
+ *   OnRampServiceEvents,
+ * } from '@metamask/ramps-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   OnRampServiceActions
+ *   OnRampServiceEvents
+ * >({ namespace: 'Root' });
+ * const onRampServiceMessenger = new Messenger<
+ *   'OnRampService',
+ *   OnRampServiceActions,
+ *   OnRampServiceEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'OnRampService',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new OnRampService({
+ *   messenger: onRampServiceMessenger,
+ *   environment: OnRampEnvironment.Production,
+ *   fetch,
+ * });
+ *
+ * // Later...
+ * // Get the user's geolocation
+ * const geolocation = await rootMessenger.call(
+ *   'OnRampService:getGeolocation',
+ * );
+ * // ... Do something with the geolocation ...
+ * ```
+ */
+class OnRampService {
+    /**
+     * Constructs a new OnRampService object.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this service.
+     * @param args.environment - The environment to use for API requests.
+     * @param args.fetch - A function that can be used to make an HTTP request. If
+     * your JavaScript environment supports `fetch` natively, you'll probably want
+     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
+     * `node-fetch`).
+     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
+     */
+    constructor({ messenger, environment = OnRampEnvironment.Staging, fetch: fetchFunction, policyOptions = {}, }) {
+        /**
+         * The messenger suited for this service.
+         */
+        _OnRampService_messenger.set(this, void 0);
+        /**
+         * A function that can be used to make an HTTP request.
+         */
+        _OnRampService_fetch.set(this, void 0);
+        /**
+         * The policy that wraps the request.
+         *
+         * @see {@link createServicePolicy}
+         */
+        _OnRampService_policy.set(this, void 0);
+        /**
+         * The base URL for API requests.
+         */
+        _OnRampService_baseUrl.set(this, void 0);
+        this.name = exports.serviceName;
+        __classPrivateFieldSet(this, _OnRampService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _OnRampService_fetch, fetchFunction, "f");
+        __classPrivateFieldSet(this, _OnRampService_policy, (0, controller_utils_1.createServicePolicy)(policyOptions), "f");
+        __classPrivateFieldSet(this, _OnRampService_baseUrl, getBaseUrl(environment), "f");
+        __classPrivateFieldGet(this, _OnRampService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Registers a handler that will be called after a request returns a non-500
+     * response, causing a retry. Primarily useful in tests where timers are being
+     * mocked.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener) {
+        return __classPrivateFieldGet(this, _OnRampService_policy, "f").onRetry(listener);
+    }
+    /**
+     * Registers a handler that will be called after a set number of retry rounds
+     * prove that requests to the API endpoint consistently return a 5xx response.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener) {
+        return __classPrivateFieldGet(this, _OnRampService_policy, "f").onBreak(listener);
+    }
+    /**
+     * Registers a handler that will be called under one of two circumstances:
+     *
+     * 1. After a set number of retries prove that requests to the API
+     * consistently result in one of the following failures:
+     *    1. A connection initiation error
+     *    2. A connection reset error
+     *    3. A timeout error
+     *    4. A non-JSON response
+     *    5. A 502, 503, or 504 response
+     * 2. After a successful request is made to the API, but the response takes
+     * longer than a set duration to return.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     */
+    onDegraded(listener) {
+        return __classPrivateFieldGet(this, _OnRampService_policy, "f").onDegraded(listener);
+    }
+    /**
+     * 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).
+     */
+    async getGeolocation() {
+        const response = await __classPrivateFieldGet(this, _OnRampService_policy, "f").execute(async () => {
+            const url = new URL('geolocation', __classPrivateFieldGet(this, _OnRampService_baseUrl, "f"));
+            const localResponse = await __classPrivateFieldGet(this, _OnRampService_fetch, "f").call(this, url);
+            if (!localResponse.ok) {
+                throw new controller_utils_1.HttpError(localResponse.status, `Fetching '${url.toString()}' failed with status '${localResponse.status}'`);
+            }
+            return localResponse;
+        });
+        const textResponse = await response.text();
+        const trimmedResponse = textResponse.trim();
+        if (trimmedResponse.length > 0) {
+            return trimmedResponse;
+        }
+        throw new Error('Malformed response received from geolocation API');
+    }
+}
+exports.OnRampService = OnRampService;
+_a = OnRampService, _OnRampService_messenger = new WeakMap(), _OnRampService_fetch = new WeakMap(), _OnRampService_policy = new WeakMap(), _OnRampService_baseUrl = new WeakMap();
+//# sourceMappingURL=OnRampService.cjs.map

package/dist/OnRampService.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"OnRampService.cjs","sourceRoot":"","sources":["../src/OnRampService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIA,iEAA4E;AAK5E,kBAAkB;AAElB;;;GAGG;AACU,QAAA,WAAW,GAAG,eAAe,CAAC;AAE3C;;GAEG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,8CAAyB,CAAA;IACzB,wCAAmB,CAAA;IACnB,gDAA2B,CAAA;AAC7B,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,gBAAgB,CAAU,CAAC;AAgC9D,6BAA6B;AAE7B;;;;;GAKG;AACH,SAAS,UAAU,CAAC,WAA8B;IAChD,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,iBAAiB,CAAC,UAAU;YAC/B,OAAO,oCAAoC,CAAC;QAC9C,KAAK,iBAAiB,CAAC,OAAO;YAC5B,OAAO,wCAAwC,CAAC;QAClD,KAAK,iBAAiB,CAAC,WAAW;YAChC,OAAO,uBAAuB,CAAC;QACjC;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAa,aAAa;IA8BxB;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,WAAW,GAAG,iBAAiB,CAAC,OAAO,EACvC,KAAK,EAAE,aAAa,EACpB,aAAa,GAAG,EAAE,GAMnB;QA/CD;;WAEG;QACM,2CAES;QAElB;;WAEG;QACM,uCAAgE;QAEzE;;;;WAIG;QACM,wCAAuB;QAEhC;;WAEG;QACM,yCAAiB;QA0BxB,IAAI,CAAC,IAAI,GAAG,mBAAW,CAAC;QACxB,uBAAA,IAAI,4BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,wBAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,yBAAW,IAAA,sCAAmB,EAAC,aAAa,CAAC,MAAA,CAAC;QAClD,uBAAA,IAAI,0BAAY,UAAU,CAAC,WAAW,CAAC,MAAA,CAAC;QAExC,uBAAA,IAAI,gCAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,QAAiD;QAEjD,OAAO,uBAAA,IAAI,6BAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CACL,QAAiD;QAEjD,OAAO,uBAAA,IAAI,6BAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,QAAoD;QAEpD,OAAO,uBAAA,IAAI,6BAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,6BAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,aAAa,EAAE,uBAAA,IAAI,8BAAS,CAAC,CAAC;YAClD,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,4BAAO,MAAX,IAAI,EAAQ,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBACtB,MAAM,IAAI,4BAAS,CACjB,aAAa,CAAC,MAAM,EACpB,aAAa,GAAG,CAAC,QAAQ,EAAE,yBAAyB,aAAa,CAAC,MAAM,GAAG,CAC5E,CAAC;YACJ,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3C,MAAM,eAAe,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC;QAE5C,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO,eAAe,CAAC;QACzB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;CACF;AApJD,sCAoJC","sourcesContent":["import type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\n\nimport type { OnRampServiceMethodActions } from './OnRampService-method-action-types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link OnRampService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'OnRampService';\n\n/**\n * The environment to use for API requests.\n */\nexport enum OnRampEnvironment {\n  Production = 'production',\n  Staging = 'staging',\n  Development = 'development',\n}\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['getGeolocation'] as const;\n\n/**\n * Actions that {@link OnRampService} exposes to other consumers.\n */\nexport type OnRampServiceActions = OnRampServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link OnRampService} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link OnRampService} exposes to other consumers.\n */\nexport type OnRampServiceEvents = never;\n\n/**\n * Events from other messengers that {@link OnRampService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link OnRampService}.\n */\nexport type OnRampServiceMessenger = Messenger<\n  typeof serviceName,\n  OnRampServiceActions | AllowedActions,\n  OnRampServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Gets the base URL for API requests based on the environment.\n *\n * @param environment - The environment to use.\n * @returns The base URL for API requests.\n */\nfunction getBaseUrl(environment: OnRampEnvironment): string {\n  switch (environment) {\n    case OnRampEnvironment.Production:\n      return 'https://on-ramp.api.cx.metamask.io';\n    case OnRampEnvironment.Staging:\n      return 'https://on-ramp.uat-api.cx.metamask.io';\n    case OnRampEnvironment.Development:\n      return 'http://localhost:3000';\n    default:\n      throw new Error(`Invalid environment: ${String(environment)}`);\n  }\n}\n\n/**\n * This service object is responsible for interacting with the OnRamp API.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   OnRampServiceActions,\n *   OnRampServiceEvents,\n * } from '@metamask/ramps-controller';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   OnRampServiceActions\n *   OnRampServiceEvents\n * >({ namespace: 'Root' });\n * const onRampServiceMessenger = new Messenger<\n *   'OnRampService',\n *   OnRampServiceActions,\n *   OnRampServiceEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'OnRampService',\n *   parent: rootMessenger,\n * });\n * // Instantiate the service to register its actions on the messenger\n * new OnRampService({\n *   messenger: onRampServiceMessenger,\n *   environment: OnRampEnvironment.Production,\n *   fetch,\n * });\n *\n * // Later...\n * // Get the user's geolocation\n * const geolocation = await rootMessenger.call(\n *   'OnRampService:getGeolocation',\n * );\n * // ... Do something with the geolocation ...\n * ```\n */\nexport class OnRampService {\n  /**\n   * The name of the service.\n   */\n  readonly name: typeof serviceName;\n\n  /**\n   * The messenger suited for this service.\n   */\n  readonly #messenger: ConstructorParameters<\n    typeof OnRampService\n  >[0]['messenger'];\n\n  /**\n   * A function that can be used to make an HTTP request.\n   */\n  readonly #fetch: ConstructorParameters<typeof OnRampService>[0]['fetch'];\n\n  /**\n   * The policy that wraps the request.\n   *\n   * @see {@link createServicePolicy}\n   */\n  readonly #policy: ServicePolicy;\n\n  /**\n   * The base URL for API requests.\n   */\n  readonly #baseUrl: string;\n\n  /**\n   * Constructs a new OnRampService object.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this service.\n   * @param args.environment - The environment to use for API requests.\n   * @param args.fetch - A function that can be used to make an HTTP request. If\n   * your JavaScript environment supports `fetch` natively, you'll probably want\n   * to pass that; otherwise you can pass an equivalent (such as `fetch` via\n   * `node-fetch`).\n   * @param args.policyOptions - Options to pass to `createServicePolicy`, which\n   * is used to wrap each request. See {@link CreateServicePolicyOptions}.\n   */\n  constructor({\n    messenger,\n    environment = OnRampEnvironment.Staging,\n    fetch: fetchFunction,\n    policyOptions = {},\n  }: {\n    messenger: OnRampServiceMessenger;\n    environment?: OnRampEnvironment;\n    fetch: typeof fetch;\n    policyOptions?: CreateServicePolicyOptions;\n  }) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#fetch = fetchFunction;\n    this.#policy = createServicePolicy(policyOptions);\n    this.#baseUrl = getBaseUrl(environment);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers a handler that will be called after a request returns a non-500\n   * response, causing a retry. Primarily useful in tests where timers are being\n   * mocked.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(\n    listener: Parameters<ServicePolicy['onRetry']>[0],\n  ): ReturnType<ServicePolicy['onRetry']> {\n    return this.#policy.onRetry(listener);\n  }\n\n  /**\n   * Registers a handler that will be called after a set number of retry rounds\n   * prove that requests to the API endpoint consistently return a 5xx response.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(\n    listener: Parameters<ServicePolicy['onBreak']>[0],\n  ): ReturnType<ServicePolicy['onBreak']> {\n    return this.#policy.onBreak(listener);\n  }\n\n  /**\n   * Registers a handler that will be called under one of two circumstances:\n   *\n   * 1. After a set number of retries prove that requests to the API\n   * consistently result in one of the following failures:\n   *    1. A connection initiation error\n   *    2. A connection reset error\n   *    3. A timeout error\n   *    4. A non-JSON response\n   *    5. A 502, 503, or 504 response\n   * 2. After a successful request is made to the API, but the response takes\n   * longer than a set duration to return.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   */\n  onDegraded(\n    listener: Parameters<ServicePolicy['onDegraded']>[0],\n  ): ReturnType<ServicePolicy['onDegraded']> {\n    return this.#policy.onDegraded(listener);\n  }\n\n  /**\n   * Makes a request to the API in order to retrieve the user's geolocation\n   * based on their IP address.\n   *\n   * @returns The user's country/region code (e.g., \"US-UT\" for Utah, USA).\n   */\n  async getGeolocation(): Promise<string> {\n    const response = await this.#policy.execute(async () => {\n      const url = new URL('geolocation', this.#baseUrl);\n      const localResponse = await this.#fetch(url);\n      if (!localResponse.ok) {\n        throw new HttpError(\n          localResponse.status,\n          `Fetching '${url.toString()}' failed with status '${localResponse.status}'`,\n        );\n      }\n      return localResponse;\n    });\n\n    const textResponse = await response.text();\n    const trimmedResponse = textResponse.trim();\n\n    if (trimmedResponse.length > 0) {\n      return trimmedResponse;\n    }\n\n    throw new Error('Malformed response received from geolocation API');\n  }\n}\n"]}

package/dist/OnRampService.d.cts

@@ -0,0 +1,152 @@
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { OnRampServiceMethodActions } from "./OnRampService-method-action-types.cjs";
+/**
+ * The name of the {@link OnRampService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const serviceName = "OnRampService";
+/**
+ * The environment to use for API requests.
+ */
+export declare enum OnRampEnvironment {
+    Production = "production",
+    Staging = "staging",
+    Development = "development"
+}
+/**
+ * Actions that {@link OnRampService} exposes to other consumers.
+ */
+export type OnRampServiceActions = OnRampServiceMethodActions;
+/**
+ * Actions from other messengers that {@link OnRampService} calls.
+ */
+type AllowedActions = never;
+/**
+ * Events that {@link OnRampService} exposes to other consumers.
+ */
+export type OnRampServiceEvents = never;
+/**
+ * Events from other messengers that {@link OnRampService} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link OnRampService}.
+ */
+export type OnRampServiceMessenger = Messenger<typeof serviceName, OnRampServiceActions | AllowedActions, OnRampServiceEvents | AllowedEvents>;
+/**
+ * This service object is responsible for interacting with the OnRamp API.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   OnRampServiceActions,
+ *   OnRampServiceEvents,
+ * } from '@metamask/ramps-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   OnRampServiceActions
+ *   OnRampServiceEvents
+ * >({ namespace: 'Root' });
+ * const onRampServiceMessenger = new Messenger<
+ *   'OnRampService',
+ *   OnRampServiceActions,
+ *   OnRampServiceEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'OnRampService',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new OnRampService({
+ *   messenger: onRampServiceMessenger,
+ *   environment: OnRampEnvironment.Production,
+ *   fetch,
+ * });
+ *
+ * // Later...
+ * // Get the user's geolocation
+ * const geolocation = await rootMessenger.call(
+ *   'OnRampService:getGeolocation',
+ * );
+ * // ... Do something with the geolocation ...
+ * ```
+ */
+export declare class OnRampService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
+    /**
+     * Constructs a new OnRampService object.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this service.
+     * @param args.environment - The environment to use for API requests.
+     * @param args.fetch - A function that can be used to make an HTTP request. If
+     * your JavaScript environment supports `fetch` natively, you'll probably want
+     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
+     * `node-fetch`).
+     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
+     */
+    constructor({ messenger, environment, fetch: fetchFunction, policyOptions, }: {
+        messenger: OnRampServiceMessenger;
+        environment?: OnRampEnvironment;
+        fetch: typeof fetch;
+        policyOptions?: CreateServicePolicyOptions;
+    });
+    /**
+     * Registers a handler that will be called after a request returns a non-500
+     * response, causing a retry. Primarily useful in tests where timers are being
+     * mocked.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): ReturnType<ServicePolicy['onRetry']>;
+    /**
+     * Registers a handler that will be called after a set number of retry rounds
+     * prove that requests to the API endpoint consistently return a 5xx response.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): ReturnType<ServicePolicy['onBreak']>;
+    /**
+     * Registers a handler that will be called under one of two circumstances:
+     *
+     * 1. After a set number of retries prove that requests to the API
+     * consistently result in one of the following failures:
+     *    1. A connection initiation error
+     *    2. A connection reset error
+     *    3. A timeout error
+     *    4. A non-JSON response
+     *    5. A 502, 503, or 504 response
+     * 2. After a successful request is made to the API, but the response takes
+     * longer than a set duration to return.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     */
+    onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]): ReturnType<ServicePolicy['onDegraded']>;
+    /**
+     * 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).
+     */
+    getGeolocation(): Promise<string>;
+}
+export {};
+//# sourceMappingURL=OnRampService.d.cts.map

package/dist/OnRampService.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OnRampService.d.cts","sourceRoot":"","sources":["../src/OnRampService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAEpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,0BAA0B,EAAE,gDAA4C;AAItF;;;GAGG;AACH,eAAO,MAAM,WAAW,kBAAkB,CAAC;AAE3C;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,WAAW,gBAAgB;CAC5B;AAMD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,0BAA0B,CAAC;AAE9D;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC;AAExC;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,CAC5C,OAAO,WAAW,EAClB,oBAAoB,GAAG,cAAc,EACrC,mBAAmB,GAAG,aAAa,CACpC,CAAC;AAuBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,aAAa;;IACxB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA0BlC;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,WAAuC,EACvC,KAAK,EAAE,aAAa,EACpB,aAAkB,GACnB,EAAE;QACD,SAAS,EAAE,sBAAsB,CAAC;QAClC,WAAW,CAAC,EAAE,iBAAiB,CAAC;QAChC,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C;IAaD;;;;;;;;;OASG;IACH,OAAO,CACL,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAChD,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAIvC;;;;;;;;OAQG;IACH,OAAO,CACL,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAChD,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAIvC;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GACnD,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAI1C;;;;;OAKG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;CAsBxC"}