@metamask-previews/perps-controller 0.0.0-preview-ce3ee897a → 0.0.0-preview-e4aa1532

package/dist/services/EligibilityService.cjs

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EligibilityService = void 0;
+/* eslint-disable id-denylist, no-restricted-syntax, @typescript-eslint/naming-convention */
+// TODO: Fix ESLint errors in this file - tracked for Phase 5 cleanup
+const controller_utils_1 = require("@metamask/controller-utils");
+const utils_1 = require("./utils.cjs");
+// Geo-blocking API URLs
+const ON_RAMP_GEO_BLOCKING_URLS = {
+    DEV: 'https://on-ramp.uat-api.cx.metamask.io/geolocation',
+    PROD: 'https://on-ramp.api.cx.metamask.io/geolocation',
+};
+/**
+ * EligibilityService
+ *
+ * Handles geo-location fetching and eligibility checking.
+ * Manages caching to minimize API calls.
+ *
+ * Instance-based service with constructor injection of platform dependencies.
+ * Cache is instance-scoped to support multiple service instances (e.g., testing).
+ */
+class EligibilityService {
+    /**
+     * Create a new EligibilityService instance.
+     *
+     * @param deps - Platform dependencies for logging, metrics, etc.
+     */
+    constructor(deps) {
+        this.GEO_CACHE_TTL_MS = 5 * 60 * 1000; // 5 minutes
+        this.geoLocationCache = null;
+        this.geoLocationFetchPromise = null;
+        this.deps = deps;
+    }
+    /**
+     * Fetch geo location with caching and deduplication.
+     *
+     * @returns The geo location string (e.g., 'US', 'GB') or 'UNKNOWN' if fetch fails
+     */
+    async fetchGeoLocation() {
+        // Check cache first
+        if (this.geoLocationCache) {
+            const cacheAge = Date.now() - this.geoLocationCache.timestamp;
+            if (cacheAge < this.GEO_CACHE_TTL_MS) {
+                this.deps.debugLogger.log('EligibilityService: Using cached geo location', {
+                    location: this.geoLocationCache.location,
+                    cacheAge: `${(cacheAge / 1000).toFixed(1)}s`,
+                });
+                return this.geoLocationCache.location;
+            }
+        }
+        // If already fetching, return the existing promise
+        if (this.geoLocationFetchPromise) {
+            this.deps.debugLogger.log('EligibilityService: Geo location fetch already in progress, waiting...');
+            return this.geoLocationFetchPromise;
+        }
+        // Start new fetch
+        this.geoLocationFetchPromise = this.performGeoLocationFetch();
+        try {
+            const location = await this.geoLocationFetchPromise;
+            return location;
+        }
+        finally {
+            // Clear the promise after completion (success or failure)
+            this.geoLocationFetchPromise = null;
+        }
+    }
+    /**
+     * Perform the actual geo location fetch.
+     * Separated to allow proper promise management.
+     *
+     * @returns The geo location string or 'UNKNOWN' on failure
+     */
+    async performGeoLocationFetch() {
+        let location = 'UNKNOWN';
+        try {
+            const environment = (0, utils_1.getEnvironment)();
+            this.deps.debugLogger.log('EligibilityService: Fetching geo location from API', {
+                environment,
+            });
+            const response = await (0, controller_utils_1.successfulFetch)(ON_RAMP_GEO_BLOCKING_URLS[environment]);
+            const textResult = await response?.text();
+            location = textResult || 'UNKNOWN';
+            // Cache the successful result
+            this.geoLocationCache = {
+                location,
+                timestamp: Date.now(),
+            };
+            this.deps.debugLogger.log('EligibilityService: Geo location fetched successfully', {
+                location,
+            });
+            return location;
+        }
+        catch (err) {
+            const error = err instanceof Error ? err : new Error(String(err));
+            this.deps.logger.error(error, {
+                context: {
+                    name: 'EligibilityService.performGeoLocationFetch',
+                    data: {},
+                },
+            });
+            // Don't cache failures
+            return location;
+        }
+    }
+    /**
+     * Check if user is eligible based on geo-blocked regions.
+     *
+     * @param blockedRegions - List of blocked region codes (e.g., ['US', 'CN'])
+     * @returns true if eligible (not in blocked region), false otherwise
+     */
+    async checkEligibility(blockedRegions) {
+        try {
+            this.deps.debugLogger.log('EligibilityService: Checking eligibility', {
+                blockedRegionsCount: blockedRegions.length,
+            });
+            // Returns UNKNOWN if we can't fetch the geo location
+            const geoLocation = await this.fetchGeoLocation();
+            // Only set to eligible if we have valid geolocation and it's not blocked
+            if (geoLocation !== 'UNKNOWN') {
+                const isEligible = blockedRegions.every((geoBlockedRegion) => !geoLocation
+                    .toUpperCase()
+                    .startsWith(geoBlockedRegion.toUpperCase()));
+                this.deps.debugLogger.log('EligibilityService: Eligibility check completed', {
+                    geoLocation,
+                    isEligible,
+                    blockedRegions,
+                });
+                return isEligible;
+            }
+            // Default to eligible if location is unknown
+            return true;
+        }
+        catch (err) {
+            const error = err instanceof Error ? err : new Error(String(err));
+            this.deps.logger.error(error, {
+                context: {
+                    name: 'EligibilityService.checkEligibility',
+                    data: {},
+                },
+            });
+            // Default to eligible on error
+            return true;
+        }
+    }
+    /**
+     * Clear the geo-location cache.
+     * Useful for testing or forcing a fresh fetch.
+     */
+    clearCache() {
+        this.geoLocationCache = null;
+        this.geoLocationFetchPromise = null;
+        this.deps.debugLogger.log('EligibilityService: Cache cleared');
+    }
+}
+exports.EligibilityService = EligibilityService;
+//# sourceMappingURL=EligibilityService.cjs.map

package/dist/services/EligibilityService.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"EligibilityService.cjs","sourceRoot":"","sources":["../../src/services/EligibilityService.ts"],"names":[],"mappings":";;;AAAA,4FAA4F;AAC5F,qEAAqE;AACrE,iEAA6D;AAE7D,uCAAyC;AAGzC,wBAAwB;AACxB,MAAM,yBAAyB,GAAG;IAChC,GAAG,EAAE,oDAAoD;IACzD,IAAI,EAAE,gDAAgD;CAC9C,CAAC;AAUX;;;;;;;;GAQG;AACH,MAAa,kBAAkB;IAS7B;;;;OAIG;IACH,YAAY,IAA+B;QAb1B,qBAAgB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,YAAY;QAIvD,qBAAgB,GAA4B,IAAI,CAAC;QAEjD,4BAAuB,GAA2B,IAAI,CAAC;QAQ7D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB;QACpB,oBAAoB;QACpB,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAC9D,IAAI,QAAQ,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACrC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,+CAA+C,EAC/C;oBACE,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,QAAQ;oBACxC,QAAQ,EAAE,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;iBAC7C,CACF,CAAC;gBACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;YACxC,CAAC;QACH,CAAC;QAED,mDAAmD;QACnD,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YACjC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,wEAAwE,CACzE,CAAC;YACF,OAAO,IAAI,CAAC,uBAAuB,CAAC;QACtC,CAAC;QAED,kBAAkB;QAClB,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAE9D,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC;YACpD,OAAO,QAAQ,CAAC;QAClB,CAAC;gBAAS,CAAC;YACT,0DAA0D;YAC1D,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,uBAAuB;QACnC,IAAI,QAAQ,GAAG,SAAS,CAAC;QAEzB,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAA,sBAAc,GAAE,CAAC;YAErC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,oDAAoD,EACpD;gBACE,WAAW;aACZ,CACF,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,kCAAe,EACpC,yBAAyB,CAAC,WAAW,CAAC,CACvC,CAAC;YAEF,MAAM,UAAU,GAAG,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC1C,QAAQ,GAAG,UAAU,IAAI,SAAS,CAAC;YAEnC,8BAA8B;YAC9B,IAAI,CAAC,gBAAgB,GAAG;gBACtB,QAAQ;gBACR,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACtB,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,uDAAuD,EACvD;gBACE,QAAQ;aACT,CACF,CAAC;YAEF,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE;gBAC5B,OAAO,EAAE;oBACP,IAAI,EAAE,4CAA4C;oBAClD,IAAI,EAAE,EAAE;iBACT;aACF,CAAC,CAAC;YACH,uBAAuB;YACvB,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CAAC,cAAwB;QAC7C,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,0CAA0C,EAAE;gBACpE,mBAAmB,EAAE,cAAc,CAAC,MAAM;aAC3C,CAAC,CAAC;YAEH,qDAAqD;YACrD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAElD,yEAAyE;YACzE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CACrC,CAAC,gBAAgB,EAAE,EAAE,CACnB,CAAC,WAAW;qBACT,WAAW,EAAE;qBACb,UAAU,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAChD,CAAC;gBAEF,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,iDAAiD,EACjD;oBACE,WAAW;oBACX,UAAU;oBACV,cAAc;iBACf,CACF,CAAC;gBAEF,OAAO,UAAU,CAAC;YACpB,CAAC;YAED,6CAA6C;YAC7C,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE;gBAC5B,OAAO,EAAE;oBACP,IAAI,EAAE,qCAAqC;oBAC3C,IAAI,EAAE,EAAE;iBACT;aACF,CAAC,CAAC;YACH,+BAA+B;YAC/B,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACpC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;IACjE,CAAC;CACF;AA5KD,gDA4KC","sourcesContent":["/* eslint-disable id-denylist, no-restricted-syntax, @typescript-eslint/naming-convention */\n// TODO: Fix ESLint errors in this file - tracked for Phase 5 cleanup\nimport { successfulFetch } from '@metamask/controller-utils';\n\nimport { getEnvironment } from './utils';\nimport type { PerpsPlatformDependencies } from '../types';\n\n// Geo-blocking API URLs\nconst ON_RAMP_GEO_BLOCKING_URLS = {\n  DEV: 'https://on-ramp.uat-api.cx.metamask.io/geolocation',\n  PROD: 'https://on-ramp.api.cx.metamask.io/geolocation',\n} as const;\n\n/**\n * Geo-location cache entry\n */\ntype GeoLocationCache = {\n  location: string;\n  timestamp: number;\n};\n\n/**\n * EligibilityService\n *\n * Handles geo-location fetching and eligibility checking.\n * Manages caching to minimize API calls.\n *\n * Instance-based service with constructor injection of platform dependencies.\n * Cache is instance-scoped to support multiple service instances (e.g., testing).\n */\nexport class EligibilityService {\n  private readonly GEO_CACHE_TTL_MS = 5 * 60 * 1000; // 5 minutes\n\n  private readonly deps: PerpsPlatformDependencies;\n\n  private geoLocationCache: GeoLocationCache | null = null;\n\n  private geoLocationFetchPromise: Promise<string> | null = null;\n\n  /**\n   * Create a new EligibilityService instance.\n   *\n   * @param deps - Platform dependencies for logging, metrics, etc.\n   */\n  constructor(deps: PerpsPlatformDependencies) {\n    this.deps = deps;\n  }\n\n  /**\n   * Fetch geo location with caching and deduplication.\n   *\n   * @returns The geo location string (e.g., 'US', 'GB') or 'UNKNOWN' if fetch fails\n   */\n  async fetchGeoLocation(): Promise<string> {\n    // Check cache first\n    if (this.geoLocationCache) {\n      const cacheAge = Date.now() - this.geoLocationCache.timestamp;\n      if (cacheAge < this.GEO_CACHE_TTL_MS) {\n        this.deps.debugLogger.log(\n          'EligibilityService: Using cached geo location',\n          {\n            location: this.geoLocationCache.location,\n            cacheAge: `${(cacheAge / 1000).toFixed(1)}s`,\n          },\n        );\n        return this.geoLocationCache.location;\n      }\n    }\n\n    // If already fetching, return the existing promise\n    if (this.geoLocationFetchPromise) {\n      this.deps.debugLogger.log(\n        'EligibilityService: Geo location fetch already in progress, waiting...',\n      );\n      return this.geoLocationFetchPromise;\n    }\n\n    // Start new fetch\n    this.geoLocationFetchPromise = this.performGeoLocationFetch();\n\n    try {\n      const location = await this.geoLocationFetchPromise;\n      return location;\n    } finally {\n      // Clear the promise after completion (success or failure)\n      this.geoLocationFetchPromise = null;\n    }\n  }\n\n  /**\n   * Perform the actual geo location fetch.\n   * Separated to allow proper promise management.\n   *\n   * @returns The geo location string or 'UNKNOWN' on failure\n   */\n  private async performGeoLocationFetch(): Promise<string> {\n    let location = 'UNKNOWN';\n\n    try {\n      const environment = getEnvironment();\n\n      this.deps.debugLogger.log(\n        'EligibilityService: Fetching geo location from API',\n        {\n          environment,\n        },\n      );\n\n      const response = await successfulFetch(\n        ON_RAMP_GEO_BLOCKING_URLS[environment],\n      );\n\n      const textResult = await response?.text();\n      location = textResult || 'UNKNOWN';\n\n      // Cache the successful result\n      this.geoLocationCache = {\n        location,\n        timestamp: Date.now(),\n      };\n\n      this.deps.debugLogger.log(\n        'EligibilityService: Geo location fetched successfully',\n        {\n          location,\n        },\n      );\n\n      return location;\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      this.deps.logger.error(error, {\n        context: {\n          name: 'EligibilityService.performGeoLocationFetch',\n          data: {},\n        },\n      });\n      // Don't cache failures\n      return location;\n    }\n  }\n\n  /**\n   * Check if user is eligible based on geo-blocked regions.\n   *\n   * @param blockedRegions - List of blocked region codes (e.g., ['US', 'CN'])\n   * @returns true if eligible (not in blocked region), false otherwise\n   */\n  async checkEligibility(blockedRegions: string[]): Promise<boolean> {\n    try {\n      this.deps.debugLogger.log('EligibilityService: Checking eligibility', {\n        blockedRegionsCount: blockedRegions.length,\n      });\n\n      // Returns UNKNOWN if we can't fetch the geo location\n      const geoLocation = await this.fetchGeoLocation();\n\n      // Only set to eligible if we have valid geolocation and it's not blocked\n      if (geoLocation !== 'UNKNOWN') {\n        const isEligible = blockedRegions.every(\n          (geoBlockedRegion) =>\n            !geoLocation\n              .toUpperCase()\n              .startsWith(geoBlockedRegion.toUpperCase()),\n        );\n\n        this.deps.debugLogger.log(\n          'EligibilityService: Eligibility check completed',\n          {\n            geoLocation,\n            isEligible,\n            blockedRegions,\n          },\n        );\n\n        return isEligible;\n      }\n\n      // Default to eligible if location is unknown\n      return true;\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      this.deps.logger.error(error, {\n        context: {\n          name: 'EligibilityService.checkEligibility',\n          data: {},\n        },\n      });\n      // Default to eligible on error\n      return true;\n    }\n  }\n\n  /**\n   * Clear the geo-location cache.\n   * Useful for testing or forcing a fresh fetch.\n   */\n  clearCache(): void {\n    this.geoLocationCache = null;\n    this.geoLocationFetchPromise = null;\n    this.deps.debugLogger.log('EligibilityService: Cache cleared');\n  }\n}\n"]}

package/dist/services/EligibilityService.d.cts

@@ -0,0 +1,48 @@
+import type { PerpsPlatformDependencies } from "../types/index.cjs";
+/**
+ * EligibilityService
+ *
+ * Handles geo-location fetching and eligibility checking.
+ * Manages caching to minimize API calls.
+ *
+ * Instance-based service with constructor injection of platform dependencies.
+ * Cache is instance-scoped to support multiple service instances (e.g., testing).
+ */
+export declare class EligibilityService {
+    private readonly GEO_CACHE_TTL_MS;
+    private readonly deps;
+    private geoLocationCache;
+    private geoLocationFetchPromise;
+    /**
+     * Create a new EligibilityService instance.
+     *
+     * @param deps - Platform dependencies for logging, metrics, etc.
+     */
+    constructor(deps: PerpsPlatformDependencies);
+    /**
+     * Fetch geo location with caching and deduplication.
+     *
+     * @returns The geo location string (e.g., 'US', 'GB') or 'UNKNOWN' if fetch fails
+     */
+    fetchGeoLocation(): Promise<string>;
+    /**
+     * Perform the actual geo location fetch.
+     * Separated to allow proper promise management.
+     *
+     * @returns The geo location string or 'UNKNOWN' on failure
+     */
+    private performGeoLocationFetch;
+    /**
+     * Check if user is eligible based on geo-blocked regions.
+     *
+     * @param blockedRegions - List of blocked region codes (e.g., ['US', 'CN'])
+     * @returns true if eligible (not in blocked region), false otherwise
+     */
+    checkEligibility(blockedRegions: string[]): Promise<boolean>;
+    /**
+     * Clear the geo-location cache.
+     * Useful for testing or forcing a fresh fetch.
+     */
+    clearCache(): void;
+}
+//# sourceMappingURL=EligibilityService.d.cts.map

package/dist/services/EligibilityService.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EligibilityService.d.cts","sourceRoot":"","sources":["../../src/services/EligibilityService.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,yBAAyB,EAAE,2BAAiB;AAgB1D;;;;;;;;GAQG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAiB;IAElD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA4B;IAEjD,OAAO,CAAC,gBAAgB,CAAiC;IAEzD,OAAO,CAAC,uBAAuB,CAAgC;IAE/D;;;;OAIG;gBACS,IAAI,EAAE,yBAAyB;IAI3C;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAoCzC;;;;;OAKG;YACW,uBAAuB;IA+CrC;;;;;OAKG;IACG,gBAAgB,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA6ClE;;;OAGG;IACH,UAAU,IAAI,IAAI;CAKnB"}

package/dist/services/EligibilityService.d.mts

@@ -0,0 +1,48 @@
+import type { PerpsPlatformDependencies } from "../types/index.mjs";
+/**
+ * EligibilityService
+ *
+ * Handles geo-location fetching and eligibility checking.
+ * Manages caching to minimize API calls.
+ *
+ * Instance-based service with constructor injection of platform dependencies.
+ * Cache is instance-scoped to support multiple service instances (e.g., testing).
+ */
+export declare class EligibilityService {
+    private readonly GEO_CACHE_TTL_MS;
+    private readonly deps;
+    private geoLocationCache;
+    private geoLocationFetchPromise;
+    /**
+     * Create a new EligibilityService instance.
+     *
+     * @param deps - Platform dependencies for logging, metrics, etc.
+     */
+    constructor(deps: PerpsPlatformDependencies);
+    /**
+     * Fetch geo location with caching and deduplication.
+     *
+     * @returns The geo location string (e.g., 'US', 'GB') or 'UNKNOWN' if fetch fails
+     */
+    fetchGeoLocation(): Promise<string>;
+    /**
+     * Perform the actual geo location fetch.
+     * Separated to allow proper promise management.
+     *
+     * @returns The geo location string or 'UNKNOWN' on failure
+     */
+    private performGeoLocationFetch;
+    /**
+     * Check if user is eligible based on geo-blocked regions.
+     *
+     * @param blockedRegions - List of blocked region codes (e.g., ['US', 'CN'])
+     * @returns true if eligible (not in blocked region), false otherwise
+     */
+    checkEligibility(blockedRegions: string[]): Promise<boolean>;
+    /**
+     * Clear the geo-location cache.
+     * Useful for testing or forcing a fresh fetch.
+     */
+    clearCache(): void;
+}
+//# sourceMappingURL=EligibilityService.d.mts.map

package/dist/services/EligibilityService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EligibilityService.d.mts","sourceRoot":"","sources":["../../src/services/EligibilityService.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,yBAAyB,EAAE,2BAAiB;AAgB1D;;;;;;;;GAQG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAiB;IAElD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA4B;IAEjD,OAAO,CAAC,gBAAgB,CAAiC;IAEzD,OAAO,CAAC,uBAAuB,CAAgC;IAE/D;;;;OAIG;gBACS,IAAI,EAAE,yBAAyB;IAI3C;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAoCzC;;;;;OAKG;YACW,uBAAuB;IA+CrC;;;;;OAKG;IACG,gBAAgB,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA6ClE;;;OAGG;IACH,UAAU,IAAI,IAAI;CAKnB"}

package/dist/services/EligibilityService.mjs

@@ -0,0 +1,152 @@
+/* eslint-disable id-denylist, no-restricted-syntax, @typescript-eslint/naming-convention */
+// TODO: Fix ESLint errors in this file - tracked for Phase 5 cleanup
+import { successfulFetch } from "@metamask/controller-utils";
+import { getEnvironment } from "./utils.mjs";
+// Geo-blocking API URLs
+const ON_RAMP_GEO_BLOCKING_URLS = {
+    DEV: 'https://on-ramp.uat-api.cx.metamask.io/geolocation',
+    PROD: 'https://on-ramp.api.cx.metamask.io/geolocation',
+};
+/**
+ * EligibilityService
+ *
+ * Handles geo-location fetching and eligibility checking.
+ * Manages caching to minimize API calls.
+ *
+ * Instance-based service with constructor injection of platform dependencies.
+ * Cache is instance-scoped to support multiple service instances (e.g., testing).
+ */
+export class EligibilityService {
+    /**
+     * Create a new EligibilityService instance.
+     *
+     * @param deps - Platform dependencies for logging, metrics, etc.
+     */
+    constructor(deps) {
+        this.GEO_CACHE_TTL_MS = 5 * 60 * 1000; // 5 minutes
+        this.geoLocationCache = null;
+        this.geoLocationFetchPromise = null;
+        this.deps = deps;
+    }
+    /**
+     * Fetch geo location with caching and deduplication.
+     *
+     * @returns The geo location string (e.g., 'US', 'GB') or 'UNKNOWN' if fetch fails
+     */
+    async fetchGeoLocation() {
+        // Check cache first
+        if (this.geoLocationCache) {
+            const cacheAge = Date.now() - this.geoLocationCache.timestamp;
+            if (cacheAge < this.GEO_CACHE_TTL_MS) {
+                this.deps.debugLogger.log('EligibilityService: Using cached geo location', {
+                    location: this.geoLocationCache.location,
+                    cacheAge: `${(cacheAge / 1000).toFixed(1)}s`,
+                });
+                return this.geoLocationCache.location;
+            }
+        }
+        // If already fetching, return the existing promise
+        if (this.geoLocationFetchPromise) {
+            this.deps.debugLogger.log('EligibilityService: Geo location fetch already in progress, waiting...');
+            return this.geoLocationFetchPromise;
+        }
+        // Start new fetch
+        this.geoLocationFetchPromise = this.performGeoLocationFetch();
+        try {
+            const location = await this.geoLocationFetchPromise;
+            return location;
+        }
+        finally {
+            // Clear the promise after completion (success or failure)
+            this.geoLocationFetchPromise = null;
+        }
+    }
+    /**
+     * Perform the actual geo location fetch.
+     * Separated to allow proper promise management.
+     *
+     * @returns The geo location string or 'UNKNOWN' on failure
+     */
+    async performGeoLocationFetch() {
+        let location = 'UNKNOWN';
+        try {
+            const environment = getEnvironment();
+            this.deps.debugLogger.log('EligibilityService: Fetching geo location from API', {
+                environment,
+            });
+            const response = await successfulFetch(ON_RAMP_GEO_BLOCKING_URLS[environment]);
+            const textResult = await response?.text();
+            location = textResult || 'UNKNOWN';
+            // Cache the successful result
+            this.geoLocationCache = {
+                location,
+                timestamp: Date.now(),
+            };
+            this.deps.debugLogger.log('EligibilityService: Geo location fetched successfully', {
+                location,
+            });
+            return location;
+        }
+        catch (err) {
+            const error = err instanceof Error ? err : new Error(String(err));
+            this.deps.logger.error(error, {
+                context: {
+                    name: 'EligibilityService.performGeoLocationFetch',
+                    data: {},
+                },
+            });
+            // Don't cache failures
+            return location;
+        }
+    }
+    /**
+     * Check if user is eligible based on geo-blocked regions.
+     *
+     * @param blockedRegions - List of blocked region codes (e.g., ['US', 'CN'])
+     * @returns true if eligible (not in blocked region), false otherwise
+     */
+    async checkEligibility(blockedRegions) {
+        try {
+            this.deps.debugLogger.log('EligibilityService: Checking eligibility', {
+                blockedRegionsCount: blockedRegions.length,
+            });
+            // Returns UNKNOWN if we can't fetch the geo location
+            const geoLocation = await this.fetchGeoLocation();
+            // Only set to eligible if we have valid geolocation and it's not blocked
+            if (geoLocation !== 'UNKNOWN') {
+                const isEligible = blockedRegions.every((geoBlockedRegion) => !geoLocation
+                    .toUpperCase()
+                    .startsWith(geoBlockedRegion.toUpperCase()));
+                this.deps.debugLogger.log('EligibilityService: Eligibility check completed', {
+                    geoLocation,
+                    isEligible,
+                    blockedRegions,
+                });
+                return isEligible;
+            }
+            // Default to eligible if location is unknown
+            return true;
+        }
+        catch (err) {
+            const error = err instanceof Error ? err : new Error(String(err));
+            this.deps.logger.error(error, {
+                context: {
+                    name: 'EligibilityService.checkEligibility',
+                    data: {},
+                },
+            });
+            // Default to eligible on error
+            return true;
+        }
+    }
+    /**
+     * Clear the geo-location cache.
+     * Useful for testing or forcing a fresh fetch.
+     */
+    clearCache() {
+        this.geoLocationCache = null;
+        this.geoLocationFetchPromise = null;
+        this.deps.debugLogger.log('EligibilityService: Cache cleared');
+    }
+}
+//# sourceMappingURL=EligibilityService.mjs.map

package/dist/services/EligibilityService.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"EligibilityService.mjs","sourceRoot":"","sources":["../../src/services/EligibilityService.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,qEAAqE;AACrE,OAAO,EAAE,eAAe,EAAE,mCAAmC;AAE7D,OAAO,EAAE,cAAc,EAAE,oBAAgB;AAGzC,wBAAwB;AACxB,MAAM,yBAAyB,GAAG;IAChC,GAAG,EAAE,oDAAoD;IACzD,IAAI,EAAE,gDAAgD;CAC9C,CAAC;AAUX;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAAkB;IAS7B;;;;OAIG;IACH,YAAY,IAA+B;QAb1B,qBAAgB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,YAAY;QAIvD,qBAAgB,GAA4B,IAAI,CAAC;QAEjD,4BAAuB,GAA2B,IAAI,CAAC;QAQ7D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB;QACpB,oBAAoB;QACpB,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAC9D,IAAI,QAAQ,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACrC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,+CAA+C,EAC/C;oBACE,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,QAAQ;oBACxC,QAAQ,EAAE,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;iBAC7C,CACF,CAAC;gBACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;YACxC,CAAC;QACH,CAAC;QAED,mDAAmD;QACnD,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YACjC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,wEAAwE,CACzE,CAAC;YACF,OAAO,IAAI,CAAC,uBAAuB,CAAC;QACtC,CAAC;QAED,kBAAkB;QAClB,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAE9D,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC;YACpD,OAAO,QAAQ,CAAC;QAClB,CAAC;gBAAS,CAAC;YACT,0DAA0D;YAC1D,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,uBAAuB;QACnC,IAAI,QAAQ,GAAG,SAAS,CAAC;QAEzB,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;YAErC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,oDAAoD,EACpD;gBACE,WAAW;aACZ,CACF,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,eAAe,CACpC,yBAAyB,CAAC,WAAW,CAAC,CACvC,CAAC;YAEF,MAAM,UAAU,GAAG,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC1C,QAAQ,GAAG,UAAU,IAAI,SAAS,CAAC;YAEnC,8BAA8B;YAC9B,IAAI,CAAC,gBAAgB,GAAG;gBACtB,QAAQ;gBACR,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACtB,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,uDAAuD,EACvD;gBACE,QAAQ;aACT,CACF,CAAC;YAEF,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE;gBAC5B,OAAO,EAAE;oBACP,IAAI,EAAE,4CAA4C;oBAClD,IAAI,EAAE,EAAE;iBACT;aACF,CAAC,CAAC;YACH,uBAAuB;YACvB,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CAAC,cAAwB;QAC7C,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,0CAA0C,EAAE;gBACpE,mBAAmB,EAAE,cAAc,CAAC,MAAM;aAC3C,CAAC,CAAC;YAEH,qDAAqD;YACrD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAElD,yEAAyE;YACzE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CACrC,CAAC,gBAAgB,EAAE,EAAE,CACnB,CAAC,WAAW;qBACT,WAAW,EAAE;qBACb,UAAU,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAChD,CAAC;gBAEF,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CACvB,iDAAiD,EACjD;oBACE,WAAW;oBACX,UAAU;oBACV,cAAc;iBACf,CACF,CAAC;gBAEF,OAAO,UAAU,CAAC;YACpB,CAAC;YAED,6CAA6C;YAC7C,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE;gBAC5B,OAAO,EAAE;oBACP,IAAI,EAAE,qCAAqC;oBAC3C,IAAI,EAAE,EAAE;iBACT;aACF,CAAC,CAAC;YACH,+BAA+B;YAC/B,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACpC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;IACjE,CAAC;CACF","sourcesContent":["/* eslint-disable id-denylist, no-restricted-syntax, @typescript-eslint/naming-convention */\n// TODO: Fix ESLint errors in this file - tracked for Phase 5 cleanup\nimport { successfulFetch } from '@metamask/controller-utils';\n\nimport { getEnvironment } from './utils';\nimport type { PerpsPlatformDependencies } from '../types';\n\n// Geo-blocking API URLs\nconst ON_RAMP_GEO_BLOCKING_URLS = {\n  DEV: 'https://on-ramp.uat-api.cx.metamask.io/geolocation',\n  PROD: 'https://on-ramp.api.cx.metamask.io/geolocation',\n} as const;\n\n/**\n * Geo-location cache entry\n */\ntype GeoLocationCache = {\n  location: string;\n  timestamp: number;\n};\n\n/**\n * EligibilityService\n *\n * Handles geo-location fetching and eligibility checking.\n * Manages caching to minimize API calls.\n *\n * Instance-based service with constructor injection of platform dependencies.\n * Cache is instance-scoped to support multiple service instances (e.g., testing).\n */\nexport class EligibilityService {\n  private readonly GEO_CACHE_TTL_MS = 5 * 60 * 1000; // 5 minutes\n\n  private readonly deps: PerpsPlatformDependencies;\n\n  private geoLocationCache: GeoLocationCache | null = null;\n\n  private geoLocationFetchPromise: Promise<string> | null = null;\n\n  /**\n   * Create a new EligibilityService instance.\n   *\n   * @param deps - Platform dependencies for logging, metrics, etc.\n   */\n  constructor(deps: PerpsPlatformDependencies) {\n    this.deps = deps;\n  }\n\n  /**\n   * Fetch geo location with caching and deduplication.\n   *\n   * @returns The geo location string (e.g., 'US', 'GB') or 'UNKNOWN' if fetch fails\n   */\n  async fetchGeoLocation(): Promise<string> {\n    // Check cache first\n    if (this.geoLocationCache) {\n      const cacheAge = Date.now() - this.geoLocationCache.timestamp;\n      if (cacheAge < this.GEO_CACHE_TTL_MS) {\n        this.deps.debugLogger.log(\n          'EligibilityService: Using cached geo location',\n          {\n            location: this.geoLocationCache.location,\n            cacheAge: `${(cacheAge / 1000).toFixed(1)}s`,\n          },\n        );\n        return this.geoLocationCache.location;\n      }\n    }\n\n    // If already fetching, return the existing promise\n    if (this.geoLocationFetchPromise) {\n      this.deps.debugLogger.log(\n        'EligibilityService: Geo location fetch already in progress, waiting...',\n      );\n      return this.geoLocationFetchPromise;\n    }\n\n    // Start new fetch\n    this.geoLocationFetchPromise = this.performGeoLocationFetch();\n\n    try {\n      const location = await this.geoLocationFetchPromise;\n      return location;\n    } finally {\n      // Clear the promise after completion (success or failure)\n      this.geoLocationFetchPromise = null;\n    }\n  }\n\n  /**\n   * Perform the actual geo location fetch.\n   * Separated to allow proper promise management.\n   *\n   * @returns The geo location string or 'UNKNOWN' on failure\n   */\n  private async performGeoLocationFetch(): Promise<string> {\n    let location = 'UNKNOWN';\n\n    try {\n      const environment = getEnvironment();\n\n      this.deps.debugLogger.log(\n        'EligibilityService: Fetching geo location from API',\n        {\n          environment,\n        },\n      );\n\n      const response = await successfulFetch(\n        ON_RAMP_GEO_BLOCKING_URLS[environment],\n      );\n\n      const textResult = await response?.text();\n      location = textResult || 'UNKNOWN';\n\n      // Cache the successful result\n      this.geoLocationCache = {\n        location,\n        timestamp: Date.now(),\n      };\n\n      this.deps.debugLogger.log(\n        'EligibilityService: Geo location fetched successfully',\n        {\n          location,\n        },\n      );\n\n      return location;\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      this.deps.logger.error(error, {\n        context: {\n          name: 'EligibilityService.performGeoLocationFetch',\n          data: {},\n        },\n      });\n      // Don't cache failures\n      return location;\n    }\n  }\n\n  /**\n   * Check if user is eligible based on geo-blocked regions.\n   *\n   * @param blockedRegions - List of blocked region codes (e.g., ['US', 'CN'])\n   * @returns true if eligible (not in blocked region), false otherwise\n   */\n  async checkEligibility(blockedRegions: string[]): Promise<boolean> {\n    try {\n      this.deps.debugLogger.log('EligibilityService: Checking eligibility', {\n        blockedRegionsCount: blockedRegions.length,\n      });\n\n      // Returns UNKNOWN if we can't fetch the geo location\n      const geoLocation = await this.fetchGeoLocation();\n\n      // Only set to eligible if we have valid geolocation and it's not blocked\n      if (geoLocation !== 'UNKNOWN') {\n        const isEligible = blockedRegions.every(\n          (geoBlockedRegion) =>\n            !geoLocation\n              .toUpperCase()\n              .startsWith(geoBlockedRegion.toUpperCase()),\n        );\n\n        this.deps.debugLogger.log(\n          'EligibilityService: Eligibility check completed',\n          {\n            geoLocation,\n            isEligible,\n            blockedRegions,\n          },\n        );\n\n        return isEligible;\n      }\n\n      // Default to eligible if location is unknown\n      return true;\n    } catch (err) {\n      const error = err instanceof Error ? err : new Error(String(err));\n      this.deps.logger.error(error, {\n        context: {\n          name: 'EligibilityService.checkEligibility',\n          data: {},\n        },\n      });\n      // Default to eligible on error\n      return true;\n    }\n  }\n\n  /**\n   * Clear the geo-location cache.\n   * Useful for testing or forcing a fresh fetch.\n   */\n  clearCache(): void {\n    this.geoLocationCache = null;\n    this.geoLocationFetchPromise = null;\n    this.deps.debugLogger.log('EligibilityService: Cache cleared');\n  }\n}\n"]}