@metamask/ramps-controller 2.0.0 → 3.0.0

package/dist/RampsService.d.mts

@@ -1,6 +1,149 @@
 import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
 import type { Messenger } from "@metamask/messenger";
 import type { RampsServiceMethodActions } from "./RampsService-method-action-types.mjs";
+/**
+ * Represents phone number information for a country.
+ */
+export type CountryPhone = {
+    prefix: string;
+    placeholder: string;
+    template: string;
+};
+/**
+ * Represents a state/province within a country.
+ */
+export type State = {
+    /**
+     * State identifier. Can be in path format (e.g., "/regions/us-ut") or ISO code format (e.g., "us-ut").
+     */
+    id?: string;
+    /**
+     * State name.
+     */
+    name?: string;
+    /**
+     * ISO state code (e.g., "UT", "NY").
+     */
+    stateId?: string;
+    /**
+     * Whether this state is supported for ramps.
+     */
+    supported?: boolean;
+    /**
+     * Whether this state is recommended.
+     */
+    recommended?: boolean;
+};
+/**
+ * Represents eligibility information for a region.
+ * Returned from the /regions/countries/{isoCode} endpoint.
+ */
+export type Eligibility = {
+    /**
+     * Whether aggregator providers are available.
+     */
+    aggregator?: boolean;
+    /**
+     * Whether deposit (buy) is available.
+     */
+    deposit?: boolean;
+    /**
+     * Whether global providers are available.
+     */
+    global?: boolean;
+};
+/**
+ * Represents a country returned from the regions/countries API.
+ */
+export type Country = {
+    /**
+     * ISO-2 country code (e.g., "US", "GB").
+     */
+    isoCode: string;
+    /**
+     * Country identifier. Can be in path format (e.g., "/regions/us") or ISO code format.
+     * If not provided, defaults to isoCode.
+     */
+    id?: string;
+    /**
+     * Country flag emoji or code.
+     */
+    flag: string;
+    /**
+     * Country name.
+     */
+    name: string;
+    /**
+     * Phone number information.
+     */
+    phone: CountryPhone;
+    /**
+     * Default currency code.
+     */
+    currency: string;
+    /**
+     * Whether this country is supported for ramps.
+     */
+    supported: boolean;
+    /**
+     * Whether this country is recommended.
+     */
+    recommended?: boolean;
+    /**
+     * Array of state objects.
+     */
+    states?: State[];
+};
+/**
+ * Represents a token returned from the regions/{region}/tokens API.
+ */
+export type RampsToken = {
+    /**
+     * The asset identifier in CAIP-19 format (e.g., "eip155:1/erc20:0x...").
+     */
+    assetId: string;
+    /**
+     * The chain identifier in CAIP-2 format (e.g., "eip155:1").
+     */
+    chainId: string;
+    /**
+     * Token name (e.g., "USD Coin").
+     */
+    name: string;
+    /**
+     * Token symbol (e.g., "USDC").
+     */
+    symbol: string;
+    /**
+     * Number of decimals for the token.
+     */
+    decimals: number;
+    /**
+     * URL to the token icon.
+     */
+    iconUrl: string;
+    /**
+     * Whether this token is supported.
+     */
+    tokenSupported: boolean;
+};
+/**
+ * Response from the regions/{region}/tokens API.
+ */
+export type TokensResponse = {
+    /**
+     * Top/popular tokens for the region.
+     */
+    topTokens: RampsToken[];
+    /**
+     * All available tokens for the region.
+     */
+    allTokens: RampsToken[];
+};
+/**
+ * The SDK version to send with API requests. (backwards-compatibility)
+ */
+export declare const RAMPS_SDK_VERSION = "2.1.6";
 /**
  * The name of the {@link RampsService}, used to namespace the
  * service's actions and events.
@@ -14,6 +157,14 @@ export declare enum RampsEnvironment {
     Staging = "staging",
     Development = "development"
 }
+/**
+ * The type of ramps API service.
+ * Determines which base URL to use (cache vs standard).
+ */
+export declare enum RampsApiService {
+    Regions = "regions",
+    Orders = "orders"
+}
 /**
  * Actions that {@link RampsService} exposes to other consumers.
  */
@@ -65,6 +216,7 @@ export type RampsServiceMessenger = Messenger<typeof serviceName, RampsServiceAc
  * new RampsService({
  *   messenger: rampsServiceMessenger,
  *   environment: RampsEnvironment.Production,
+ *   context: 'mobile-ios',
  *   fetch,
  * });
  *
@@ -88,6 +240,7 @@ export declare class RampsService {
      * @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.context - The context for API requests (e.g., 'mobile-ios', 'mobile-android').
      * @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
@@ -95,9 +248,10 @@ export declare class RampsService {
      * @param args.policyOptions - Options to pass to `createServicePolicy`, which
      * is used to wrap each request. See {@link CreateServicePolicyOptions}.
      */
-    constructor({ messenger, environment, fetch: fetchFunction, policyOptions, }: {
+    constructor({ messenger, environment, context, fetch: fetchFunction, policyOptions, }: {
         messenger: RampsServiceMessenger;
         environment?: RampsEnvironment;
+        context: string;
         fetch: typeof fetch;
         policyOptions?: CreateServicePolicyOptions;
     });
@@ -147,6 +301,29 @@ export declare class RampsService {
      * @returns The user's country/region code (e.g., "US-UT" for Utah, USA).
      */
     getGeolocation(): Promise<string>;
+    /**
+     * Makes a request to the cached API to retrieve the list of supported countries.
+     * Filters countries based on aggregator support (preserves OnRampSDK logic).
+     *
+     * @param action - The ramp action type ('buy' or 'sell').
+     * @returns An array of countries filtered by aggregator support.
+     */
+    getCountries(action?: 'buy' | 'sell'): Promise<Country[]>;
+    /**
+     * Fetches eligibility information for a specific region.
+     *
+     * @param isoCode - The ISO code for the region (e.g., "us", "fr", "us-ny").
+     * @returns Eligibility information for the region.
+     */
+    getEligibility(isoCode: string): Promise<Eligibility>;
+    /**
+     * Fetches the list of available tokens for a given region and action.
+     *
+     * @param region - The region code (e.g., "us", "fr", "us-ny").
+     * @param action - The ramp action type ('buy' or 'sell').
+     * @returns The tokens response containing topTokens and allTokens.
+     */
+    getTokens(region: string, action?: 'buy' | 'sell'): Promise<TokensResponse>;
 }
 export {};
 //# sourceMappingURL=RampsService.d.mts.map

package/dist/RampsService.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"RampsService.d.mts","sourceRoot":"","sources":["../src/RampsService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAEpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,yBAAyB,EAAE,+CAA2C;AAIpF;;;GAGG;AACH,eAAO,MAAM,WAAW,iBAAiB,CAAC;AAE1C;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,WAAW,gBAAgB;CAC5B;AAMD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,yBAAyB,CAAC;AAE5D;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC;AAEvC;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,SAAS,CAC3C,OAAO,WAAW,EAClB,mBAAmB,GAAG,cAAc,EACpC,kBAAkB,GAAG,aAAa,CACnC,CAAC;AAuBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,YAAY;;IACvB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA0BlC;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,WAAsC,EACtC,KAAK,EAAE,aAAa,EACpB,aAAkB,GACnB,EAAE;QACD,SAAS,EAAE,qBAAqB,CAAC;QACjC,WAAW,CAAC,EAAE,gBAAgB,CAAC;QAC/B,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;CAwBxC"}
+{"version":3,"file":"RampsService.d.mts","sourceRoot":"","sources":["../src/RampsService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAEpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,yBAAyB,EAAE,+CAA2C;AAGpF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,UAAU,EAAE,CAAC;IACxB;;OAEG;IACH,SAAS,EAAE,UAAU,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,UAAU,CAAC;AAIzC;;;GAGG;AACH,eAAO,MAAM,WAAW,iBAAiB,CAAC;AAE1C;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,WAAW,gBAAgB;CAC5B;AAED;;;GAGG;AACH,oBAAY,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;CAClB;AAWD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,yBAAyB,CAAC;AAE5D;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC;AAEvC;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,SAAS,CAC3C,OAAO,WAAW,EAClB,mBAAmB,GAAG,cAAc,EACpC,kBAAkB,GAAG,aAAa,CACnC,CAAC;AA6BF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,YAAY;;IACvB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA+BlC;;;;;;;;;;;;;OAaG;gBACS,EACV,SAAS,EACT,WAAsC,EACtC,OAAO,EACP,KAAK,EAAE,aAAa,EACpB,aAAkB,GACnB,EAAE;QACD,SAAS,EAAE,qBAAqB,CAAC;QACjC,WAAW,CAAC,EAAE,gBAAgB,CAAC;QAC/B,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C;IAcD;;;;;;;;;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;IAwD1C;;;;;OAKG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAevC;;;;;;OAMG;IACG,YAAY,CAAC,MAAM,GAAE,KAAK,GAAG,MAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAuBtE;;;;;OAKG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAS3D;;;;;;OAMG;IACG,SAAS,CACb,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,KAAK,GAAG,MAAc,GAC7B,OAAO,CAAC,cAAc,CAAC;CAqB3B"}

package/dist/RampsService.mjs

@@ -9,8 +9,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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, _RampsService_messenger, _RampsService_fetch, _RampsService_policy, _RampsService_baseUrl;
+var _RampsService_instances, _a, _RampsService_messenger, _RampsService_fetch, _RampsService_policy, _RampsService_environment, _RampsService_context, _RampsService_addCommonParams, _RampsService_request;
 import { createServicePolicy, HttpError } from "@metamask/controller-utils";
+import packageJson from "../package.json" with { type: "json" };
+/**
+ * The SDK version to send with API requests. (backwards-compatibility)
+ */
+export const RAMPS_SDK_VERSION = '2.1.6';
 // === GENERAL ===
 /**
  * The name of the {@link RampsService}, used to namespace the
@@ -26,23 +31,39 @@ export var RampsEnvironment;
     RampsEnvironment["Staging"] = "staging";
     RampsEnvironment["Development"] = "development";
 })(RampsEnvironment || (RampsEnvironment = {}));
+/**
+ * The type of ramps API service.
+ * Determines which base URL to use (cache vs standard).
+ */
+export var RampsApiService;
+(function (RampsApiService) {
+    RampsApiService["Regions"] = "regions";
+    RampsApiService["Orders"] = "orders";
+})(RampsApiService || (RampsApiService = {}));
 // === MESSENGER ===
-const MESSENGER_EXPOSED_METHODS = ['getGeolocation'];
+const MESSENGER_EXPOSED_METHODS = [
+    'getGeolocation',
+    'getCountries',
+    'getEligibility',
+    'getTokens',
+];
 // === SERVICE DEFINITION ===
 /**
- * Gets the base URL for API requests based on the environment.
+ * Gets the base URL for API requests based on the environment and service type.
+ * The Regions service uses a cache URL, while other services use the standard URL.
  *
  * @param environment - The environment to use.
+ * @param service - The API service type (determines if cache URL is used).
  * @returns The base URL for API requests.
  */
-function getBaseUrl(environment) {
+function getBaseUrl(environment, service) {
+    const cache = service === RampsApiService.Regions ? '-cache' : '';
     switch (environment) {
         case RampsEnvironment.Production:
-            return 'https://on-ramp.api.cx.metamask.io';
+            return `https://on-ramp${cache}.api.cx.metamask.io`;
         case RampsEnvironment.Staging:
-            return 'https://on-ramp.uat-api.cx.metamask.io';
         case RampsEnvironment.Development:
-            return 'http://localhost:3000';
+            return `https://on-ramp${cache}.uat-api.cx.metamask.io`;
         default:
             throw new Error(`Invalid environment: ${String(environment)}`);
     }
@@ -77,6 +98,7 @@ function getBaseUrl(environment) {
  * new RampsService({
  *   messenger: rampsServiceMessenger,
  *   environment: RampsEnvironment.Production,
+ *   context: 'mobile-ios',
  *   fetch,
  * });
  *
@@ -95,6 +117,7 @@ export class RampsService {
      * @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.context - The context for API requests (e.g., 'mobile-ios', 'mobile-android').
      * @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
@@ -102,7 +125,8 @@ export class RampsService {
      * @param args.policyOptions - Options to pass to `createServicePolicy`, which
      * is used to wrap each request. See {@link CreateServicePolicyOptions}.
      */
-    constructor({ messenger, environment = RampsEnvironment.Staging, fetch: fetchFunction, policyOptions = {}, }) {
+    constructor({ messenger, environment = RampsEnvironment.Staging, context, fetch: fetchFunction, policyOptions = {}, }) {
+        _RampsService_instances.add(this);
         /**
          * The messenger suited for this service.
          */
@@ -118,14 +142,19 @@ export class RampsService {
          */
         _RampsService_policy.set(this, void 0);
         /**
-         * The base URL for API requests.
+         * The environment used for API requests.
          */
-        _RampsService_baseUrl.set(this, void 0);
+        _RampsService_environment.set(this, void 0);
+        /**
+         * The context for API requests (e.g., 'mobile-ios', 'mobile-android').
+         */
+        _RampsService_context.set(this, void 0);
         this.name = serviceName;
         __classPrivateFieldSet(this, _RampsService_messenger, messenger, "f");
         __classPrivateFieldSet(this, _RampsService_fetch, fetchFunction, "f");
         __classPrivateFieldSet(this, _RampsService_policy, createServicePolicy(policyOptions), "f");
-        __classPrivateFieldSet(this, _RampsService_baseUrl, getBaseUrl(environment), "f");
+        __classPrivateFieldSet(this, _RampsService_environment, environment, "f");
+        __classPrivateFieldSet(this, _RampsService_context, context, "f");
         __classPrivateFieldGet(this, _RampsService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
     }
     /**
@@ -180,23 +209,93 @@ export class RampsService {
      * @returns The user's country/region code (e.g., "US-UT" for Utah, USA).
      */
     async getGeolocation() {
-        const responseData = await __classPrivateFieldGet(this, _RampsService_policy, "f").execute(async () => {
-            const url = new URL('geolocation', __classPrivateFieldGet(this, _RampsService_baseUrl, "f"));
-            const localResponse = await __classPrivateFieldGet(this, _RampsService_fetch, "f").call(this, url);
-            if (!localResponse.ok) {
-                throw new HttpError(localResponse.status, `Fetching '${url.toString()}' failed with status '${localResponse.status}'`);
-            }
-            const textResponse = await localResponse.text();
-            // Return both response and text content since we consumed the body
-            return { response: localResponse, text: textResponse };
-        });
-        const textResponse = responseData.text;
+        const textResponse = await __classPrivateFieldGet(this, _RampsService_instances, "m", _RampsService_request).call(this, RampsApiService.Orders, 'geolocation', { responseType: 'text' });
         const trimmedResponse = textResponse.trim();
         if (trimmedResponse.length > 0) {
             return trimmedResponse;
         }
         throw new Error('Malformed response received from geolocation API');
     }
+    /**
+     * Makes a request to the cached API to retrieve the list of supported countries.
+     * Filters countries based on aggregator support (preserves OnRampSDK logic).
+     *
+     * @param action - The ramp action type ('buy' or 'sell').
+     * @returns An array of countries filtered by aggregator support.
+     */
+    async getCountries(action = 'buy') {
+        const countries = await __classPrivateFieldGet(this, _RampsService_instances, "m", _RampsService_request).call(this, RampsApiService.Regions, 'regions/countries', { action, responseType: 'json' });
+        if (!Array.isArray(countries)) {
+            throw new Error('Malformed response received from countries API');
+        }
+        return countries.filter((country) => {
+            if (country.states && country.states.length > 0) {
+                const hasSupportedState = country.states.some((state) => state.supported !== false);
+                return country.supported || hasSupportedState;
+            }
+            return country.supported;
+        });
+    }
+    /**
+     * Fetches eligibility information for a specific region.
+     *
+     * @param isoCode - The ISO code for the region (e.g., "us", "fr", "us-ny").
+     * @returns Eligibility information for the region.
+     */
+    async getEligibility(isoCode) {
+        const normalizedIsoCode = isoCode.toLowerCase().trim();
+        return __classPrivateFieldGet(this, _RampsService_instances, "m", _RampsService_request).call(this, RampsApiService.Regions, `regions/countries/${normalizedIsoCode}`, { responseType: 'json' });
+    }
+    /**
+     * Fetches the list of available tokens for a given region and action.
+     *
+     * @param region - The region code (e.g., "us", "fr", "us-ny").
+     * @param action - The ramp action type ('buy' or 'sell').
+     * @returns The tokens response containing topTokens and allTokens.
+     */
+    async getTokens(region, action = 'buy') {
+        const normalizedRegion = region.toLowerCase().trim();
+        const response = await __classPrivateFieldGet(this, _RampsService_instances, "m", _RampsService_request).call(this, RampsApiService.Regions, `regions/${normalizedRegion}/tokens`, { action, responseType: 'json' });
+        if (!response || typeof response !== 'object') {
+            throw new Error('Malformed response received from tokens API');
+        }
+        if (!Array.isArray(response.topTokens) ||
+            !Array.isArray(response.allTokens)) {
+            throw new Error('Malformed response received from tokens API');
+        }
+        return response;
+    }
 }
-_a = RampsService, _RampsService_messenger = new WeakMap(), _RampsService_fetch = new WeakMap(), _RampsService_policy = new WeakMap(), _RampsService_baseUrl = new WeakMap();
+_a = RampsService, _RampsService_messenger = new WeakMap(), _RampsService_fetch = new WeakMap(), _RampsService_policy = new WeakMap(), _RampsService_environment = new WeakMap(), _RampsService_context = new WeakMap(), _RampsService_instances = new WeakSet(), _RampsService_addCommonParams = function _RampsService_addCommonParams(url, action) {
+    if (action) {
+        url.searchParams.set('action', action);
+    }
+    url.searchParams.set('sdk', RAMPS_SDK_VERSION);
+    url.searchParams.set('controller', packageJson.version);
+    url.searchParams.set('context', __classPrivateFieldGet(this, _RampsService_context, "f"));
+}, _RampsService_request = 
+/**
+ * Makes an API request with retry policy and error handling.
+ *
+ * @param service - The API service type (determines base URL).
+ * @param path - The endpoint path.
+ * @param options - Request options.
+ * @param options.action - The ramp action type (optional).
+ * @param options.responseType - How to parse the response ('json' or 'text').
+ * @returns The parsed response data.
+ */
+async function _RampsService_request(service, path, options) {
+    return __classPrivateFieldGet(this, _RampsService_policy, "f").execute(async () => {
+        const baseUrl = getBaseUrl(__classPrivateFieldGet(this, _RampsService_environment, "f"), service);
+        const url = new URL(path, baseUrl);
+        __classPrivateFieldGet(this, _RampsService_instances, "m", _RampsService_addCommonParams).call(this, url, options.action);
+        const response = await __classPrivateFieldGet(this, _RampsService_fetch, "f").call(this, url);
+        if (!response.ok) {
+            throw new HttpError(response.status, `Fetching '${url.toString()}' failed with status '${response.status}'`);
+        }
+        return options.responseType === 'json'
+            ? response.json()
+            : response.text();
+    });
+};
 //# sourceMappingURL=RampsService.mjs.map

package/dist/RampsService.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"RampsService.mjs","sourceRoot":"","sources":["../src/RampsService.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,mCAAmC;AAK5E,kBAAkB;AAElB;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CAAC;AAE1C;;GAEG;AACH,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,6CAAyB,CAAA;IACzB,uCAAmB,CAAA;IACnB,+CAA2B,CAAA;AAC7B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,gBAAgB,CAAU,CAAC;AAgC9D,6BAA6B;AAE7B;;;;;GAKG;AACH,SAAS,UAAU,CAAC,WAA6B;IAC/C,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,gBAAgB,CAAC,UAAU;YAC9B,OAAO,oCAAoC,CAAC;QAC9C,KAAK,gBAAgB,CAAC,OAAO;YAC3B,OAAO,wCAAwC,CAAC;QAClD,KAAK,gBAAgB,CAAC,WAAW;YAC/B,OAAO,uBAAuB,CAAC;QACjC;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,OAAO,YAAY;IA8BvB;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,WAAW,GAAG,gBAAgB,CAAC,OAAO,EACtC,KAAK,EAAE,aAAa,EACpB,aAAa,GAAG,EAAE,GAMnB;QA/CD;;WAEG;QACM,0CAES;QAElB;;WAEG;QACM,sCAA+D;QAExE;;;;WAIG;QACM,uCAAuB;QAEhC;;WAEG;QACM,wCAAiB;QA0BxB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,uBAAA,IAAI,2BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,uBAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,wBAAW,mBAAmB,CAAC,aAAa,CAAC,MAAA,CAAC;QAClD,uBAAA,IAAI,yBAAY,UAAU,CAAC,WAAW,CAAC,MAAA,CAAC;QAExC,uBAAA,IAAI,+BAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,QAAiD;QAEjD,OAAO,uBAAA,IAAI,4BAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CACL,QAAiD;QAEjD,OAAO,uBAAA,IAAI,4BAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,QAAoD;QAEpD,OAAO,uBAAA,IAAI,4BAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,YAAY,GAAG,MAAM,uBAAA,IAAI,4BAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACzD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,aAAa,EAAE,uBAAA,IAAI,6BAAS,CAAC,CAAC;YAClD,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,2BAAO,MAAX,IAAI,EAAQ,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBACtB,MAAM,IAAI,SAAS,CACjB,aAAa,CAAC,MAAM,EACpB,aAAa,GAAG,CAAC,QAAQ,EAAE,yBAAyB,aAAa,CAAC,MAAM,GAAG,CAC5E,CAAC;YACJ,CAAC;YACD,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAC;YAChD,mEAAmE;YACnE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC;QACvC,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","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 { RampsServiceMethodActions } from './RampsService-method-action-types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link RampsService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'RampsService';\n\n/**\n * The environment to use for API requests.\n */\nexport enum RampsEnvironment {\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 RampsService} exposes to other consumers.\n */\nexport type RampsServiceActions = RampsServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link RampsService} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link RampsService} exposes to other consumers.\n */\nexport type RampsServiceEvents = never;\n\n/**\n * Events from other messengers that {@link RampsService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link RampsService}.\n */\nexport type RampsServiceMessenger = Messenger<\n  typeof serviceName,\n  RampsServiceActions | AllowedActions,\n  RampsServiceEvents | 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: RampsEnvironment): string {\n  switch (environment) {\n    case RampsEnvironment.Production:\n      return 'https://on-ramp.api.cx.metamask.io';\n    case RampsEnvironment.Staging:\n      return 'https://on-ramp.uat-api.cx.metamask.io';\n    case RampsEnvironment.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 Ramps API.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   RampsServiceActions,\n *   RampsServiceEvents,\n * } from '@metamask/ramps-controller';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   RampsServiceActions\n *   RampsServiceEvents\n * >({ namespace: 'Root' });\n * const rampsServiceMessenger = new Messenger<\n *   'RampsService',\n *   RampsServiceActions,\n *   RampsServiceEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'RampsService',\n *   parent: rootMessenger,\n * });\n * // Instantiate the service to register its actions on the messenger\n * new RampsService({\n *   messenger: rampsServiceMessenger,\n *   environment: RampsEnvironment.Production,\n *   fetch,\n * });\n *\n * // Later...\n * // Get the user's geolocation\n * const geolocation = await rootMessenger.call(\n *   'RampsService:getGeolocation',\n * );\n * // ... Do something with the geolocation ...\n * ```\n */\nexport class RampsService {\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 RampsService\n  >[0]['messenger'];\n\n  /**\n   * A function that can be used to make an HTTP request.\n   */\n  readonly #fetch: ConstructorParameters<typeof RampsService>[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 RampsService 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 = RampsEnvironment.Staging,\n    fetch: fetchFunction,\n    policyOptions = {},\n  }: {\n    messenger: RampsServiceMessenger;\n    environment?: RampsEnvironment;\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 responseData = 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      const textResponse = await localResponse.text();\n      // Return both response and text content since we consumed the body\n      return { response: localResponse, text: textResponse };\n    });\n\n    const textResponse = responseData.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"]}
+{"version":3,"file":"RampsService.mjs","sourceRoot":"","sources":["../src/RampsService.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,mCAAmC;AAI5E,OAAO,WAAW,8CAAwB;AAmJ1C;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAEzC,kBAAkB;AAElB;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CAAC;AAE1C;;GAEG;AACH,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,6CAAyB,CAAA;IACzB,uCAAmB,CAAA;IACnB,+CAA2B,CAAA;AAC7B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;AACnB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,WAAW;CACH,CAAC;AAgCX,6BAA6B;AAE7B;;;;;;;GAOG;AACH,SAAS,UAAU,CACjB,WAA6B,EAC7B,OAAwB;IAExB,MAAM,KAAK,GAAG,OAAO,KAAK,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAElE,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,gBAAgB,CAAC,UAAU;YAC9B,OAAO,kBAAkB,KAAK,qBAAqB,CAAC;QACtD,KAAK,gBAAgB,CAAC,OAAO,CAAC;QAC9B,KAAK,gBAAgB,CAAC,WAAW;YAC/B,OAAO,kBAAkB,KAAK,yBAAyB,CAAC;QAC1D;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,OAAO,YAAY;IAmCvB;;;;;;;;;;;;;OAaG;IACH,YAAY,EACV,SAAS,EACT,WAAW,GAAG,gBAAgB,CAAC,OAAO,EACtC,OAAO,EACP,KAAK,EAAE,aAAa,EACpB,aAAa,GAAG,EAAE,GAOnB;;QAvDD;;WAEG;QACM,0CAES;QAElB;;WAEG;QACM,sCAA+D;QAExE;;;;WAIG;QACM,uCAAuB;QAEhC;;WAEG;QACM,4CAA+B;QAExC;;WAEG;QACM,wCAAiB;QA6BxB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,uBAAA,IAAI,2BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,uBAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,wBAAW,mBAAmB,CAAC,aAAa,CAAC,MAAA,CAAC;QAClD,uBAAA,IAAI,6BAAgB,WAAW,MAAA,CAAC;QAChC,uBAAA,IAAI,yBAAY,OAAO,MAAA,CAAC;QAExB,uBAAA,IAAI,+BAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,QAAiD;QAEjD,OAAO,uBAAA,IAAI,4BAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CACL,QAAiD;QAEjD,OAAO,uBAAA,IAAI,4BAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,QAAoD;QAEpD,OAAO,uBAAA,IAAI,4BAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAsDD;;;;;OAKG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,YAAY,GAAG,MAAM,uBAAA,IAAI,sDAAS,MAAb,IAAI,EAC7B,eAAe,CAAC,MAAM,EACtB,aAAa,EACb,EAAE,YAAY,EAAE,MAAM,EAAE,CACzB,CAAC;QAEF,MAAM,eAAe,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC;QAC5C,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;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,SAAyB,KAAK;QAC/C,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,sDAAS,MAAb,IAAI,EAC1B,eAAe,CAAC,OAAO,EACvB,mBAAmB,EACnB,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CACjC,CAAC;QAEF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QAED,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;YAClC,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChD,MAAM,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CACrC,CAAC;gBACF,OAAO,OAAO,CAAC,SAAS,IAAI,iBAAiB,CAAC;YAChD,CAAC;YAED,OAAO,OAAO,CAAC,SAAS,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,OAAe;QAClC,MAAM,iBAAiB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;QACvD,OAAO,uBAAA,IAAI,sDAAS,MAAb,IAAI,EACT,eAAe,CAAC,OAAO,EACvB,qBAAqB,iBAAiB,EAAE,EACxC,EAAE,YAAY,EAAE,MAAM,EAAE,CACzB,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACb,MAAc,EACd,SAAyB,KAAK;QAE9B,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;QACrD,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,sDAAS,MAAb,IAAI,EACzB,eAAe,CAAC,OAAO,EACvB,WAAW,gBAAgB,SAAS,EACpC,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CACjC,CAAC;QAEF,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;YAClC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,EAClC,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;yUA/IkB,GAAQ,EAAE,MAAuB;IAChD,IAAI,MAAM,EAAE,CAAC;QACX,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IACD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;IAC/C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IACxD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,uBAAA,IAAI,6BAAS,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,gCACH,OAAwB,EACxB,IAAY,EACZ,OAGC;IAED,OAAO,uBAAA,IAAI,4BAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;QACrC,MAAM,OAAO,GAAG,UAAU,CAAC,uBAAA,IAAI,iCAAa,EAAE,OAAO,CAAC,CAAC;QACvD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,uBAAA,IAAI,8DAAiB,MAArB,IAAI,EAAkB,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAE3C,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,2BAAO,MAAX,IAAI,EAAQ,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,SAAS,CACjB,QAAQ,CAAC,MAAM,EACf,aAAa,GAAG,CAAC,QAAQ,EAAE,yBAAyB,QAAQ,CAAC,MAAM,GAAG,CACvE,CAAC;QACJ,CAAC;QAED,OAAO,OAAO,CAAC,YAAY,KAAK,MAAM;YACpC,CAAC,CAAE,QAAQ,CAAC,IAAI,EAAyB;YACzC,CAAC,CAAE,QAAQ,CAAC,IAAI,EAAyB,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC","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 { RampsServiceMethodActions } from './RampsService-method-action-types';\nimport packageJson from '../package.json';\n\n/**\n * Represents phone number information for a country.\n */\nexport type CountryPhone = {\n  prefix: string;\n  placeholder: string;\n  template: string;\n};\n\n/**\n * Represents a state/province within a country.\n */\nexport type State = {\n  /**\n   * State identifier. Can be in path format (e.g., \"/regions/us-ut\") or ISO code format (e.g., \"us-ut\").\n   */\n  id?: string;\n  /**\n   * State name.\n   */\n  name?: string;\n  /**\n   * ISO state code (e.g., \"UT\", \"NY\").\n   */\n  stateId?: string;\n  /**\n   * Whether this state is supported for ramps.\n   */\n  supported?: boolean;\n  /**\n   * Whether this state is recommended.\n   */\n  recommended?: boolean;\n};\n\n/**\n * Represents eligibility information for a region.\n * Returned from the /regions/countries/{isoCode} endpoint.\n */\nexport type Eligibility = {\n  /**\n   * Whether aggregator providers are available.\n   */\n  aggregator?: boolean;\n  /**\n   * Whether deposit (buy) is available.\n   */\n  deposit?: boolean;\n  /**\n   * Whether global providers are available.\n   */\n  global?: boolean;\n};\n\n/**\n * Represents a country returned from the regions/countries API.\n */\nexport type Country = {\n  /**\n   * ISO-2 country code (e.g., \"US\", \"GB\").\n   */\n  isoCode: string;\n  /**\n   * Country identifier. Can be in path format (e.g., \"/regions/us\") or ISO code format.\n   * If not provided, defaults to isoCode.\n   */\n  id?: string;\n  /**\n   * Country flag emoji or code.\n   */\n  flag: string;\n  /**\n   * Country name.\n   */\n  name: string;\n  /**\n   * Phone number information.\n   */\n  phone: CountryPhone;\n  /**\n   * Default currency code.\n   */\n  currency: string;\n  /**\n   * Whether this country is supported for ramps.\n   */\n  supported: boolean;\n  /**\n   * Whether this country is recommended.\n   */\n  recommended?: boolean;\n  /**\n   * Array of state objects.\n   */\n  states?: State[];\n};\n\n/**\n * Represents a token returned from the regions/{region}/tokens API.\n */\nexport type RampsToken = {\n  /**\n   * The asset identifier in CAIP-19 format (e.g., \"eip155:1/erc20:0x...\").\n   */\n  assetId: string;\n  /**\n   * The chain identifier in CAIP-2 format (e.g., \"eip155:1\").\n   */\n  chainId: string;\n  /**\n   * Token name (e.g., \"USD Coin\").\n   */\n  name: string;\n  /**\n   * Token symbol (e.g., \"USDC\").\n   */\n  symbol: string;\n  /**\n   * Number of decimals for the token.\n   */\n  decimals: number;\n  /**\n   * URL to the token icon.\n   */\n  iconUrl: string;\n  /**\n   * Whether this token is supported.\n   */\n  tokenSupported: boolean;\n};\n\n/**\n * Response from the regions/{region}/tokens API.\n */\nexport type TokensResponse = {\n  /**\n   * Top/popular tokens for the region.\n   */\n  topTokens: RampsToken[];\n  /**\n   * All available tokens for the region.\n   */\n  allTokens: RampsToken[];\n};\n\n/**\n * The SDK version to send with API requests. (backwards-compatibility)\n */\nexport const RAMPS_SDK_VERSION = '2.1.6';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link RampsService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'RampsService';\n\n/**\n * The environment to use for API requests.\n */\nexport enum RampsEnvironment {\n  Production = 'production',\n  Staging = 'staging',\n  Development = 'development',\n}\n\n/**\n * The type of ramps API service.\n * Determines which base URL to use (cache vs standard).\n */\nexport enum RampsApiService {\n  Regions = 'regions',\n  Orders = 'orders',\n}\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'getGeolocation',\n  'getCountries',\n  'getEligibility',\n  'getTokens',\n] as const;\n\n/**\n * Actions that {@link RampsService} exposes to other consumers.\n */\nexport type RampsServiceActions = RampsServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link RampsService} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link RampsService} exposes to other consumers.\n */\nexport type RampsServiceEvents = never;\n\n/**\n * Events from other messengers that {@link RampsService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link RampsService}.\n */\nexport type RampsServiceMessenger = Messenger<\n  typeof serviceName,\n  RampsServiceActions | AllowedActions,\n  RampsServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Gets the base URL for API requests based on the environment and service type.\n * The Regions service uses a cache URL, while other services use the standard URL.\n *\n * @param environment - The environment to use.\n * @param service - The API service type (determines if cache URL is used).\n * @returns The base URL for API requests.\n */\nfunction getBaseUrl(\n  environment: RampsEnvironment,\n  service: RampsApiService,\n): string {\n  const cache = service === RampsApiService.Regions ? '-cache' : '';\n\n  switch (environment) {\n    case RampsEnvironment.Production:\n      return `https://on-ramp${cache}.api.cx.metamask.io`;\n    case RampsEnvironment.Staging:\n    case RampsEnvironment.Development:\n      return `https://on-ramp${cache}.uat-api.cx.metamask.io`;\n    default:\n      throw new Error(`Invalid environment: ${String(environment)}`);\n  }\n}\n\n/**\n * This service object is responsible for interacting with the Ramps API.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   RampsServiceActions,\n *   RampsServiceEvents,\n * } from '@metamask/ramps-controller';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   RampsServiceActions\n *   RampsServiceEvents\n * >({ namespace: 'Root' });\n * const rampsServiceMessenger = new Messenger<\n *   'RampsService',\n *   RampsServiceActions,\n *   RampsServiceEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'RampsService',\n *   parent: rootMessenger,\n * });\n * // Instantiate the service to register its actions on the messenger\n * new RampsService({\n *   messenger: rampsServiceMessenger,\n *   environment: RampsEnvironment.Production,\n *   context: 'mobile-ios',\n *   fetch,\n * });\n *\n * // Later...\n * // Get the user's geolocation\n * const geolocation = await rootMessenger.call(\n *   'RampsService:getGeolocation',\n * );\n * // ... Do something with the geolocation ...\n * ```\n */\nexport class RampsService {\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 RampsService\n  >[0]['messenger'];\n\n  /**\n   * A function that can be used to make an HTTP request.\n   */\n  readonly #fetch: ConstructorParameters<typeof RampsService>[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 environment used for API requests.\n   */\n  readonly #environment: RampsEnvironment;\n\n  /**\n   * The context for API requests (e.g., 'mobile-ios', 'mobile-android').\n   */\n  readonly #context: string;\n\n  /**\n   * Constructs a new RampsService 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.context - The context for API requests (e.g., 'mobile-ios', 'mobile-android').\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 = RampsEnvironment.Staging,\n    context,\n    fetch: fetchFunction,\n    policyOptions = {},\n  }: {\n    messenger: RampsServiceMessenger;\n    environment?: RampsEnvironment;\n    context: string;\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.#environment = environment;\n    this.#context = context;\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   * Adds common request parameters to a URL.\n   *\n   * @param url - The URL to add parameters to.\n   * @param action - The ramp action type (optional, not all endpoints require it).\n   */\n  #addCommonParams(url: URL, action?: 'buy' | 'sell'): void {\n    if (action) {\n      url.searchParams.set('action', action);\n    }\n    url.searchParams.set('sdk', RAMPS_SDK_VERSION);\n    url.searchParams.set('controller', packageJson.version);\n    url.searchParams.set('context', this.#context);\n  }\n\n  /**\n   * Makes an API request with retry policy and error handling.\n   *\n   * @param service - The API service type (determines base URL).\n   * @param path - The endpoint path.\n   * @param options - Request options.\n   * @param options.action - The ramp action type (optional).\n   * @param options.responseType - How to parse the response ('json' or 'text').\n   * @returns The parsed response data.\n   */\n  async #request<TResponse>(\n    service: RampsApiService,\n    path: string,\n    options: {\n      action?: 'buy' | 'sell';\n      responseType: 'json' | 'text';\n    },\n  ): Promise<TResponse> {\n    return this.#policy.execute(async () => {\n      const baseUrl = getBaseUrl(this.#environment, service);\n      const url = new URL(path, baseUrl);\n      this.#addCommonParams(url, options.action);\n\n      const response = await this.#fetch(url);\n      if (!response.ok) {\n        throw new HttpError(\n          response.status,\n          `Fetching '${url.toString()}' failed with status '${response.status}'`,\n        );\n      }\n\n      return options.responseType === 'json'\n        ? (response.json() as Promise<TResponse>)\n        : (response.text() as Promise<TResponse>);\n    });\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 textResponse = await this.#request<string>(\n      RampsApiService.Orders,\n      'geolocation',\n      { responseType: 'text' },\n    );\n\n    const trimmedResponse = textResponse.trim();\n    if (trimmedResponse.length > 0) {\n      return trimmedResponse;\n    }\n\n    throw new Error('Malformed response received from geolocation API');\n  }\n\n  /**\n   * Makes a request to the cached API to retrieve the list of supported countries.\n   * Filters countries based on aggregator support (preserves OnRampSDK logic).\n   *\n   * @param action - The ramp action type ('buy' or 'sell').\n   * @returns An array of countries filtered by aggregator support.\n   */\n  async getCountries(action: 'buy' | 'sell' = 'buy'): Promise<Country[]> {\n    const countries = await this.#request<Country[]>(\n      RampsApiService.Regions,\n      'regions/countries',\n      { action, responseType: 'json' },\n    );\n\n    if (!Array.isArray(countries)) {\n      throw new Error('Malformed response received from countries API');\n    }\n\n    return countries.filter((country) => {\n      if (country.states && country.states.length > 0) {\n        const hasSupportedState = country.states.some(\n          (state) => state.supported !== false,\n        );\n        return country.supported || hasSupportedState;\n      }\n\n      return country.supported;\n    });\n  }\n\n  /**\n   * Fetches eligibility information for a specific region.\n   *\n   * @param isoCode - The ISO code for the region (e.g., \"us\", \"fr\", \"us-ny\").\n   * @returns Eligibility information for the region.\n   */\n  async getEligibility(isoCode: string): Promise<Eligibility> {\n    const normalizedIsoCode = isoCode.toLowerCase().trim();\n    return this.#request<Eligibility>(\n      RampsApiService.Regions,\n      `regions/countries/${normalizedIsoCode}`,\n      { responseType: 'json' },\n    );\n  }\n\n  /**\n   * Fetches the list of available tokens for a given region and action.\n   *\n   * @param region - The region code (e.g., \"us\", \"fr\", \"us-ny\").\n   * @param action - The ramp action type ('buy' or 'sell').\n   * @returns The tokens response containing topTokens and allTokens.\n   */\n  async getTokens(\n    region: string,\n    action: 'buy' | 'sell' = 'buy',\n  ): Promise<TokensResponse> {\n    const normalizedRegion = region.toLowerCase().trim();\n    const response = await this.#request<TokensResponse>(\n      RampsApiService.Regions,\n      `regions/${normalizedRegion}/tokens`,\n      { action, responseType: 'json' },\n    );\n\n    if (!response || typeof response !== 'object') {\n      throw new Error('Malformed response received from tokens API');\n    }\n\n    if (\n      !Array.isArray(response.topTokens) ||\n      !Array.isArray(response.allTokens)\n    ) {\n      throw new Error('Malformed response received from tokens API');\n    }\n\n    return response;\n  }\n}\n"]}

package/dist/RequestCache.cjs

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createErrorState = exports.createSuccessState = exports.createLoadingState = exports.isCacheExpired = exports.createCacheKey = exports.DEFAULT_REQUEST_CACHE_MAX_SIZE = exports.DEFAULT_REQUEST_CACHE_TTL = exports.RequestStatus = void 0;
+/**
+ * Status of a cached request.
+ */
+var RequestStatus;
+(function (RequestStatus) {
+    RequestStatus["IDLE"] = "idle";
+    RequestStatus["LOADING"] = "loading";
+    RequestStatus["SUCCESS"] = "success";
+    RequestStatus["ERROR"] = "error";
+})(RequestStatus || (exports.RequestStatus = RequestStatus = {}));
+/**
+ * Default TTL for cached requests in milliseconds (15 minutes).
+ */
+exports.DEFAULT_REQUEST_CACHE_TTL = 15 * 60 * 1000;
+/**
+ * Default maximum number of entries in the request cache.
+ */
+exports.DEFAULT_REQUEST_CACHE_MAX_SIZE = 250;
+/**
+ * Creates a cache key from a method name and parameters.
+ *
+ * @param method - The method name.
+ * @param params - The parameters passed to the method.
+ * @returns A unique cache key string.
+ */
+function createCacheKey(method, params) {
+    return `${method}:${JSON.stringify(params)}`;
+}
+exports.createCacheKey = createCacheKey;
+/**
+ * Checks if a cached request has expired based on TTL.
+ *
+ * @param requestState - The cached request state.
+ * @param ttl - Time to live in milliseconds.
+ * @returns True if the cache entry has expired.
+ */
+function isCacheExpired(requestState, ttl = exports.DEFAULT_REQUEST_CACHE_TTL) {
+    if (requestState.status !== RequestStatus.SUCCESS) {
+        return true;
+    }
+    const now = Date.now();
+    return now - requestState.timestamp > ttl;
+}
+exports.isCacheExpired = isCacheExpired;
+/**
+ * Creates an initial loading state for a request.
+ *
+ * @returns A new RequestState in loading status.
+ */
+function createLoadingState() {
+    const now = Date.now();
+    return {
+        status: RequestStatus.LOADING,
+        data: null,
+        error: null,
+        timestamp: now,
+        lastFetchedAt: now,
+    };
+}
+exports.createLoadingState = createLoadingState;
+/**
+ * Creates a success state for a request.
+ *
+ * @param data - The data returned by the request.
+ * @param lastFetchedAt - When the fetch started.
+ * @returns A new RequestState in success status.
+ */
+function createSuccessState(data, lastFetchedAt) {
+    return {
+        status: RequestStatus.SUCCESS,
+        data,
+        error: null,
+        timestamp: Date.now(),
+        lastFetchedAt,
+    };
+}
+exports.createSuccessState = createSuccessState;
+/**
+ * Creates an error state for a request.
+ *
+ * @param error - The error message.
+ * @param lastFetchedAt - When the fetch started.
+ * @returns A new RequestState in error status.
+ */
+function createErrorState(error, lastFetchedAt) {
+    return {
+        status: RequestStatus.ERROR,
+        data: null,
+        error,
+        timestamp: Date.now(),
+        lastFetchedAt,
+    };
+}
+exports.createErrorState = createErrorState;
+//# sourceMappingURL=RequestCache.cjs.map

package/dist/RequestCache.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestCache.cjs","sourceRoot":"","sources":["../src/RequestCache.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EALW,aAAa,6BAAb,aAAa,QAKxB;AAwBD;;GAEG;AACU,QAAA,yBAAyB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAExD;;GAEG;AACU,QAAA,8BAA8B,GAAG,GAAG,CAAC;AAElD;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,MAAc,EAAE,MAAiB;IAC9D,OAAO,GAAG,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;AAC/C,CAAC;AAFD,wCAEC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAC5B,YAA0B,EAC1B,MAAc,iCAAyB;IAEvC,IAAI,YAAY,CAAC,MAAM,KAAK,aAAa,CAAC,OAAO,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,OAAO,GAAG,GAAG,YAAY,CAAC,SAAS,GAAG,GAAG,CAAC;AAC5C,CAAC;AATD,wCASC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB;IAChC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,OAAO;QACL,MAAM,EAAE,aAAa,CAAC,OAAO;QAC7B,IAAI,EAAE,IAAI;QACV,KAAK,EAAE,IAAI;QACX,SAAS,EAAE,GAAG;QACd,aAAa,EAAE,GAAG;KACnB,CAAC;AACJ,CAAC;AATD,gDASC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAChC,IAAU,EACV,aAAqB;IAErB,OAAO;QACL,MAAM,EAAE,aAAa,CAAC,OAAO;QAC7B,IAAI;QACJ,KAAK,EAAE,IAAI;QACX,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,aAAa;KACd,CAAC;AACJ,CAAC;AAXD,gDAWC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,KAAa,EACb,aAAqB;IAErB,OAAO;QACL,MAAM,EAAE,aAAa,CAAC,KAAK;QAC3B,IAAI,EAAE,IAAI;QACV,KAAK;QACL,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,aAAa;KACd,CAAC;AACJ,CAAC;AAXD,4CAWC","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * Status of a cached request.\n */\nexport enum RequestStatus {\n  IDLE = 'idle',\n  LOADING = 'loading',\n  SUCCESS = 'success',\n  ERROR = 'error',\n}\n\n/**\n * State of a single cached request.\n * All properties must be JSON-serializable to satisfy StateConstraint.\n */\nexport type RequestState = {\n  /** Current status of the request */\n  status: `${RequestStatus}`;\n  /** The data returned by the request, if successful */\n  data: Json | null;\n  /** Error message if the request failed */\n  error: string | null;\n  /** Timestamp when the request completed (for TTL calculation) */\n  timestamp: number;\n  /** Timestamp when the fetch started */\n  lastFetchedAt: number;\n};\n\n/**\n * Cache of request states, keyed by cache key.\n */\nexport type RequestCache = Record<string, RequestState>;\n\n/**\n * Default TTL for cached requests in milliseconds (15 minutes).\n */\nexport const DEFAULT_REQUEST_CACHE_TTL = 15 * 60 * 1000;\n\n/**\n * Default maximum number of entries in the request cache.\n */\nexport const DEFAULT_REQUEST_CACHE_MAX_SIZE = 250;\n\n/**\n * Creates a cache key from a method name and parameters.\n *\n * @param method - The method name.\n * @param params - The parameters passed to the method.\n * @returns A unique cache key string.\n */\nexport function createCacheKey(method: string, params: unknown[]): string {\n  return `${method}:${JSON.stringify(params)}`;\n}\n\n/**\n * Checks if a cached request has expired based on TTL.\n *\n * @param requestState - The cached request state.\n * @param ttl - Time to live in milliseconds.\n * @returns True if the cache entry has expired.\n */\nexport function isCacheExpired(\n  requestState: RequestState,\n  ttl: number = DEFAULT_REQUEST_CACHE_TTL,\n): boolean {\n  if (requestState.status !== RequestStatus.SUCCESS) {\n    return true;\n  }\n  const now = Date.now();\n  return now - requestState.timestamp > ttl;\n}\n\n/**\n * Creates an initial loading state for a request.\n *\n * @returns A new RequestState in loading status.\n */\nexport function createLoadingState(): RequestState {\n  const now = Date.now();\n  return {\n    status: RequestStatus.LOADING,\n    data: null,\n    error: null,\n    timestamp: now,\n    lastFetchedAt: now,\n  };\n}\n\n/**\n * Creates a success state for a request.\n *\n * @param data - The data returned by the request.\n * @param lastFetchedAt - When the fetch started.\n * @returns A new RequestState in success status.\n */\nexport function createSuccessState(\n  data: Json,\n  lastFetchedAt: number,\n): RequestState {\n  return {\n    status: RequestStatus.SUCCESS,\n    data,\n    error: null,\n    timestamp: Date.now(),\n    lastFetchedAt,\n  };\n}\n\n/**\n * Creates an error state for a request.\n *\n * @param error - The error message.\n * @param lastFetchedAt - When the fetch started.\n * @returns A new RequestState in error status.\n */\nexport function createErrorState(\n  error: string,\n  lastFetchedAt: number,\n): RequestState {\n  return {\n    status: RequestStatus.ERROR,\n    data: null,\n    error,\n    timestamp: Date.now(),\n    lastFetchedAt,\n  };\n}\n\n/**\n * Options for executing a cached request.\n */\nexport type ExecuteRequestOptions = {\n  /** Force a refresh even if cached data exists */\n  forceRefresh?: boolean;\n  /** Custom TTL for this request in milliseconds */\n  ttl?: number;\n};\n\n/**\n * Represents a pending request with its promise and abort controller.\n */\nexport type PendingRequest<TResult = unknown> = {\n  promise: Promise<TResult>;\n  abortController: AbortController;\n};\n"]}