@metamask-previews/compliance-controller 2.1.0-preview-3866c0ff1 → 2.1.0-preview-e3275932a

package/CHANGELOG.md

@@ -9,7 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- **BREAKING:** Bump minimum Node.js version to 22 ([#9168](https://github.com/MetaMask/core/pull/9168))
 - Bump `@metamask/utils` from `^11.9.0` to `^11.11.0` ([#9074](https://github.com/MetaMask/core/pull/9074))
 - Bump `@metamask/controller-utils` from `^12.1.0` to `^12.3.0` ([#9058](https://github.com/MetaMask/core/pull/9058), [#9083](https://github.com/MetaMask/core/pull/9083), [#9218](https://github.com/MetaMask/core/pull/9218))
 - Bump `@metamask/messenger` from `^1.2.0` to `^2.0.0` ([#9392](https://github.com/MetaMask/core/pull/9392))

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceController-method-action-types.cjs","sourceRoot":"","sources":["../src/ComplianceController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { ComplianceController } from './ComplianceController.js';\n\n/**\n * Checks compliance status for a single wallet address via the API and\n * persists the result to state. If the API call fails and a previously\n * cached result exists for the address, the cached result is returned as a\n * fallback. If no cached result exists, the error is re-thrown.\n *\n * @param address - The wallet address to check.\n * @returns The compliance status of the wallet.\n */\nexport type ComplianceControllerCheckWalletComplianceAction = {\n  type: `ComplianceController:checkWalletCompliance`;\n  handler: ComplianceController['checkWalletCompliance'];\n};\n\n/**\n * Checks compliance status for multiple wallet addresses via the API and\n * persists the results to state. If the API call fails and every requested\n * address has a previously cached result, those cached results are returned\n * as a fallback. If any address lacks a cached result, the error is\n * re-thrown.\n *\n * @param addresses - The wallet addresses to check.\n * @returns The compliance statuses of the wallets.\n */\nexport type ComplianceControllerCheckWalletsComplianceAction = {\n  type: `ComplianceController:checkWalletsCompliance`;\n  handler: ComplianceController['checkWalletsCompliance'];\n};\n\n/**\n * Clears all compliance data from state.\n */\nexport type ComplianceControllerClearComplianceStateAction = {\n  type: `ComplianceController:clearComplianceState`;\n  handler: ComplianceController['clearComplianceState'];\n};\n\n/**\n * Union of all ComplianceController action types.\n */\nexport type ComplianceControllerMethodActions =\n  | ComplianceControllerCheckWalletComplianceAction\n  | ComplianceControllerCheckWalletsComplianceAction\n  | ComplianceControllerClearComplianceStateAction;\n"]}

package/dist/{ComplianceController-method-action-types.d.ts → ComplianceController-method-action-types.d.cts}

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { ComplianceController } from './ComplianceController.js';
+import type { ComplianceController } from "./ComplianceController.cjs";
 /**
  * Checks compliance status for a single wallet address via the API and
  * persists the result to state. If the API call fails and a previously
@@ -41,4 +41,4 @@ export type ComplianceControllerClearComplianceStateAction = {
  * Union of all ComplianceController action types.
  */
 export type ComplianceControllerMethodActions = ComplianceControllerCheckWalletComplianceAction | ComplianceControllerCheckWalletsComplianceAction | ComplianceControllerClearComplianceStateAction;
-//# sourceMappingURL=ComplianceController-method-action-types.d.ts.map
+//# sourceMappingURL=ComplianceController-method-action-types.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceController-method-action-types.d.cts","sourceRoot":"","sources":["../src/ComplianceController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,mCAAkC;AAEtE;;;;;;;;GAQG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;CACvD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GACzC,+CAA+C,GAC/C,gDAAgD,GAChD,8CAA8C,CAAC"}

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

@@ -0,0 +1,44 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { ComplianceController } from "./ComplianceController.mjs";
+/**
+ * Checks compliance status for a single wallet address via the API and
+ * persists the result to state. If the API call fails and a previously
+ * cached result exists for the address, the cached result is returned as a
+ * fallback. If no cached result exists, the error is re-thrown.
+ *
+ * @param address - The wallet address to check.
+ * @returns The compliance status of the wallet.
+ */
+export type ComplianceControllerCheckWalletComplianceAction = {
+    type: `ComplianceController:checkWalletCompliance`;
+    handler: ComplianceController['checkWalletCompliance'];
+};
+/**
+ * Checks compliance status for multiple wallet addresses via the API and
+ * persists the results to state. If the API call fails and every requested
+ * address has a previously cached result, those cached results are returned
+ * as a fallback. If any address lacks a cached result, the error is
+ * re-thrown.
+ *
+ * @param addresses - The wallet addresses to check.
+ * @returns The compliance statuses of the wallets.
+ */
+export type ComplianceControllerCheckWalletsComplianceAction = {
+    type: `ComplianceController:checkWalletsCompliance`;
+    handler: ComplianceController['checkWalletsCompliance'];
+};
+/**
+ * Clears all compliance data from state.
+ */
+export type ComplianceControllerClearComplianceStateAction = {
+    type: `ComplianceController:clearComplianceState`;
+    handler: ComplianceController['clearComplianceState'];
+};
+/**
+ * Union of all ComplianceController action types.
+ */
+export type ComplianceControllerMethodActions = ComplianceControllerCheckWalletComplianceAction | ComplianceControllerCheckWalletsComplianceAction | ComplianceControllerClearComplianceStateAction;
+//# sourceMappingURL=ComplianceController-method-action-types.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceController-method-action-types.d.mts","sourceRoot":"","sources":["../src/ComplianceController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,mCAAkC;AAEtE;;;;;;;;GAQG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;CACvD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GACzC,+CAA+C,GAC/C,gDAAgD,GAChD,8CAA8C,CAAC"}

package/dist/{ComplianceController-method-action-types.js → ComplianceController-method-action-types.mjs}

@@ -3,4 +3,4 @@
  * Do not edit manually.
  */
 export {};
-//# sourceMappingURL=ComplianceController-method-action-types.js.map
+//# sourceMappingURL=ComplianceController-method-action-types.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceController-method-action-types.mjs","sourceRoot":"","sources":["../src/ComplianceController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { ComplianceController } from './ComplianceController.js';\n\n/**\n * Checks compliance status for a single wallet address via the API and\n * persists the result to state. If the API call fails and a previously\n * cached result exists for the address, the cached result is returned as a\n * fallback. If no cached result exists, the error is re-thrown.\n *\n * @param address - The wallet address to check.\n * @returns The compliance status of the wallet.\n */\nexport type ComplianceControllerCheckWalletComplianceAction = {\n  type: `ComplianceController:checkWalletCompliance`;\n  handler: ComplianceController['checkWalletCompliance'];\n};\n\n/**\n * Checks compliance status for multiple wallet addresses via the API and\n * persists the results to state. If the API call fails and every requested\n * address has a previously cached result, those cached results are returned\n * as a fallback. If any address lacks a cached result, the error is\n * re-thrown.\n *\n * @param addresses - The wallet addresses to check.\n * @returns The compliance statuses of the wallets.\n */\nexport type ComplianceControllerCheckWalletsComplianceAction = {\n  type: `ComplianceController:checkWalletsCompliance`;\n  handler: ComplianceController['checkWalletsCompliance'];\n};\n\n/**\n * Clears all compliance data from state.\n */\nexport type ComplianceControllerClearComplianceStateAction = {\n  type: `ComplianceController:clearComplianceState`;\n  handler: ComplianceController['clearComplianceState'];\n};\n\n/**\n * Union of all ComplianceController action types.\n */\nexport type ComplianceControllerMethodActions =\n  | ComplianceControllerCheckWalletComplianceAction\n  | ComplianceControllerCheckWalletsComplianceAction\n  | ComplianceControllerClearComplianceStateAction;\n"]}

package/dist/ComplianceController.cjs

@@ -0,0 +1,158 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComplianceController = exports.getDefaultComplianceControllerState = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const utils_js_1 = require("./utils.cjs");
+// === GENERAL ===
+/**
+ * The name of the {@link ComplianceController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+exports.controllerName = 'ComplianceController';
+/**
+ * The metadata for each property in {@link ComplianceControllerState}.
+ */
+const complianceControllerMetadata = {
+    walletComplianceStatusMap: {
+        includeInDebugSnapshot: false,
+        includeInStateLogs: false,
+        persist: true,
+        usedInUi: true,
+    },
+    lastCheckedAt: {
+        includeInDebugSnapshot: false,
+        includeInStateLogs: true,
+        persist: true,
+        usedInUi: false,
+    },
+};
+/**
+ * Constructs the default {@link ComplianceController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link ComplianceController} state.
+ */
+function getDefaultComplianceControllerState() {
+    return {
+        walletComplianceStatusMap: {},
+        lastCheckedAt: null,
+    };
+}
+exports.getDefaultComplianceControllerState = getDefaultComplianceControllerState;
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = [
+    'checkWalletCompliance',
+    'checkWalletsCompliance',
+    'clearComplianceState',
+];
+// === CONTROLLER DEFINITION ===
+/**
+ * `ComplianceController` manages OFAC compliance state for wallet addresses.
+ * It performs on-demand compliance checks via the API and caches results
+ * per address in state. Cached results serve as a fallback if the API is
+ * unavailable for a subsequent check on the same address.
+ */
+class ComplianceController extends base_controller_1.BaseController {
+    /**
+     * Constructs a new {@link ComplianceController}.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.state - The desired state with which to init this
+     * controller. Missing properties will be filled in with defaults.
+     */
+    constructor({ messenger, state, }) {
+        super({
+            messenger,
+            metadata: complianceControllerMetadata,
+            name: exports.controllerName,
+            state: {
+                ...getDefaultComplianceControllerState(),
+                ...state,
+            },
+        });
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Checks compliance status for a single wallet address via the API and
+     * persists the result to state. If the API call fails and a previously
+     * cached result exists for the address, the cached result is returned as a
+     * fallback. If no cached result exists, the error is re-thrown.
+     *
+     * @param address - The wallet address to check.
+     * @returns The compliance status of the wallet.
+     */
+    async checkWalletCompliance(address) {
+        try {
+            const result = await this.messenger.call('ComplianceService:checkWalletCompliance', address);
+            const now = new Date().toISOString();
+            const status = {
+                address: result.address,
+                blocked: result.blocked,
+                checkedAt: now,
+            };
+            this.update((draftState) => {
+                draftState.walletComplianceStatusMap[address] = status;
+                draftState.lastCheckedAt = now;
+            });
+            return status;
+        }
+        catch (error) {
+            const cached = (0, utils_js_1.getWalletComplianceStatus)(this.state.walletComplianceStatusMap, address);
+            if (cached) {
+                return cached;
+            }
+            throw error;
+        }
+    }
+    /**
+     * Checks compliance status for multiple wallet addresses via the API and
+     * persists the results to state. If the API call fails and every requested
+     * address has a previously cached result, those cached results are returned
+     * as a fallback. If any address lacks a cached result, the error is
+     * re-thrown.
+     *
+     * @param addresses - The wallet addresses to check.
+     * @returns The compliance statuses of the wallets.
+     */
+    async checkWalletsCompliance(addresses) {
+        try {
+            const results = await this.messenger.call('ComplianceService:checkWalletsCompliance', addresses);
+            const now = new Date().toISOString();
+            const statuses = results.map((result) => ({
+                address: result.address,
+                blocked: result.blocked,
+                checkedAt: now,
+            }));
+            this.update((draftState) => {
+                for (let idx = 0; idx < statuses.length; idx++) {
+                    const callerAddress = addresses[idx];
+                    draftState.walletComplianceStatusMap[callerAddress] = statuses[idx];
+                }
+                draftState.lastCheckedAt = now;
+            });
+            return statuses;
+        }
+        catch (error) {
+            const cachedStatuses = addresses.map((address) => (0, utils_js_1.getWalletComplianceStatus)(this.state.walletComplianceStatusMap, address));
+            if (cachedStatuses.every((status) => Boolean(status))) {
+                return cachedStatuses;
+            }
+            throw error;
+        }
+    }
+    /**
+     * Clears all compliance data from state.
+     */
+    clearComplianceState() {
+        this.update((draftState) => {
+            draftState.walletComplianceStatusMap = {};
+            draftState.lastCheckedAt = null;
+        });
+    }
+}
+exports.ComplianceController = ComplianceController;
+//# sourceMappingURL=ComplianceController.cjs.map

package/dist/ComplianceController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceController.cjs","sourceRoot":"","sources":["../src/ComplianceController.ts"],"names":[],"mappings":";;;AAKA,+DAA2D;AAS3D,0CAAuD;AAEvD,kBAAkB;AAElB;;;;GAIG;AACU,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAqBrD;;GAEG;AACH,MAAM,4BAA4B,GAAG;IACnC,yBAAyB,EAAE;QACzB,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,IAAI;KACf;IACD,aAAa,EAAE;QACb,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,KAAK;KAChB;CACiD,CAAC;AAErD;;;;;;;GAOG;AACH,SAAgB,mCAAmC;IACjD,OAAO;QACL,yBAAyB,EAAE,EAAE;QAC7B,aAAa,EAAE,IAAI;KACpB,CAAC;AACJ,CAAC;AALD,kFAKC;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,uBAAuB;IACvB,wBAAwB;IACxB,sBAAsB;CACd,CAAC;AAoDX,gCAAgC;AAEhC;;;;;GAKG;AACH,MAAa,oBAAqB,SAAQ,gCAIzC;IACC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,4BAA4B;YACtC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,mCAAmC,EAAE;gBACxC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAe;QAEf,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,yCAAyC,EACzC,OAAO,CACR,CAAC;YAEF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACrC,MAAM,MAAM,GAA2B;gBACrC,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,SAAS,EAAE,GAAG;aACf,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;gBACzB,UAAU,CAAC,yBAAyB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;gBACvD,UAAU,CAAC,aAAa,GAAG,GAAG,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,GAAG,IAAA,oCAAyB,EACtC,IAAI,CAAC,KAAK,CAAC,yBAAyB,EACpC,OAAO,CACR,CAAC;YACF,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,sBAAsB,CAC1B,SAAmB;QAEnB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACvC,0CAA0C,EAC1C,SAAS,CACV,CAAC;YAEF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACrC,MAAM,QAAQ,GAA6B,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAClE,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,SAAS,EAAE,GAAG;aACf,CAAC,CAAC,CAAC;YAEJ,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;gBACzB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;oBAC/C,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;oBACrC,UAAU,CAAC,yBAAyB,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;gBACtE,CAAC;gBACD,UAAU,CAAC,aAAa,GAAG,GAAG,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,cAAc,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAC/C,IAAA,oCAAyB,EACvB,IAAI,CAAC,KAAK,CAAC,yBAAyB,EACpC,OAAO,CACR,CACF,CAAC;YACF,IACE,cAAc,CAAC,KAAK,CAAC,CAAC,MAAM,EAAoC,EAAE,CAChE,OAAO,CAAC,MAAM,CAAC,CAChB,EACD,CAAC;gBACD,OAAO,cAAc,CAAC;YACxB,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;YACzB,UAAU,CAAC,yBAAyB,GAAG,EAAE,CAAC;YAC1C,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA7ID,oDA6IC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport type { ComplianceControllerMethodActions } from './ComplianceController-method-action-types.js';\nimport type {\n  ComplianceServiceCheckWalletComplianceAction,\n  ComplianceServiceCheckWalletsComplianceAction,\n} from './ComplianceService-method-action-types.js';\nimport type { WalletComplianceStatus } from './types.js';\nimport { getWalletComplianceStatus } from './utils.js';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link ComplianceController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'ComplianceController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link ComplianceController}.\n */\nexport type ComplianceControllerState = {\n  /**\n   * A map of wallet addresses to their compliance check results, used as a\n   * fallback cache when the API is unavailable.\n   */\n  walletComplianceStatusMap: Record<string, WalletComplianceStatus>;\n\n  /**\n   * The date/time (in ISO-8601 format) when the last compliance check was\n   * performed, or `null` if no checks have been performed yet.\n   */\n  lastCheckedAt: string | null;\n};\n\n/**\n * The metadata for each property in {@link ComplianceControllerState}.\n */\nconst complianceControllerMetadata = {\n  walletComplianceStatusMap: {\n    includeInDebugSnapshot: false,\n    includeInStateLogs: false,\n    persist: true,\n    usedInUi: true,\n  },\n  lastCheckedAt: {\n    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    persist: true,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<ComplianceControllerState>;\n\n/**\n * Constructs the default {@link ComplianceController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link ComplianceController} state.\n */\nexport function getDefaultComplianceControllerState(): ComplianceControllerState {\n  return {\n    walletComplianceStatusMap: {},\n    lastCheckedAt: null,\n  };\n}\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'checkWalletCompliance',\n  'checkWalletsCompliance',\n  'clearComplianceState',\n] as const;\n\n/**\n * Retrieves the state of the {@link ComplianceController}.\n */\nexport type ComplianceControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ComplianceControllerState\n>;\n\n/**\n * Actions that {@link ComplianceController} exposes to other consumers.\n */\nexport type ComplianceControllerActions =\n  | ComplianceControllerGetStateAction\n  | ComplianceControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link ComplianceController} calls.\n */\ntype AllowedActions =\n  | ComplianceServiceCheckWalletComplianceAction\n  | ComplianceServiceCheckWalletsComplianceAction;\n\n/**\n * Published when the state of {@link ComplianceController} changes.\n */\nexport type ComplianceControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ComplianceControllerState\n>;\n\n/**\n * Events that {@link ComplianceController} exposes to other consumers.\n */\nexport type ComplianceControllerEvents = ComplianceControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ComplianceController} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ComplianceController}.\n */\nexport type ComplianceControllerMessenger = Messenger<\n  typeof controllerName,\n  ComplianceControllerActions | AllowedActions,\n  ComplianceControllerEvents | AllowedEvents\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * `ComplianceController` manages OFAC compliance state for wallet addresses.\n * It performs on-demand compliance checks via the API and caches results\n * per address in state. Cached results serve as a fallback if the API is\n * unavailable for a subsequent check on the same address.\n */\nexport class ComplianceController extends BaseController<\n  typeof controllerName,\n  ComplianceControllerState,\n  ComplianceControllerMessenger\n> {\n  /**\n   * Constructs a new {@link ComplianceController}.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to init this\n   * controller. Missing properties will be filled in with defaults.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: ComplianceControllerMessenger;\n    state?: Partial<ComplianceControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: complianceControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultComplianceControllerState(),\n        ...state,\n      },\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Checks compliance status for a single wallet address via the API and\n   * persists the result to state. If the API call fails and a previously\n   * cached result exists for the address, the cached result is returned as a\n   * fallback. If no cached result exists, the error is re-thrown.\n   *\n   * @param address - The wallet address to check.\n   * @returns The compliance status of the wallet.\n   */\n  async checkWalletCompliance(\n    address: string,\n  ): Promise<WalletComplianceStatus> {\n    try {\n      const result = await this.messenger.call(\n        'ComplianceService:checkWalletCompliance',\n        address,\n      );\n\n      const now = new Date().toISOString();\n      const status: WalletComplianceStatus = {\n        address: result.address,\n        blocked: result.blocked,\n        checkedAt: now,\n      };\n\n      this.update((draftState) => {\n        draftState.walletComplianceStatusMap[address] = status;\n        draftState.lastCheckedAt = now;\n      });\n\n      return status;\n    } catch (error) {\n      const cached = getWalletComplianceStatus(\n        this.state.walletComplianceStatusMap,\n        address,\n      );\n      if (cached) {\n        return cached;\n      }\n      throw error;\n    }\n  }\n\n  /**\n   * Checks compliance status for multiple wallet addresses via the API and\n   * persists the results to state. If the API call fails and every requested\n   * address has a previously cached result, those cached results are returned\n   * as a fallback. If any address lacks a cached result, the error is\n   * re-thrown.\n   *\n   * @param addresses - The wallet addresses to check.\n   * @returns The compliance statuses of the wallets.\n   */\n  async checkWalletsCompliance(\n    addresses: string[],\n  ): Promise<WalletComplianceStatus[]> {\n    try {\n      const results = await this.messenger.call(\n        'ComplianceService:checkWalletsCompliance',\n        addresses,\n      );\n\n      const now = new Date().toISOString();\n      const statuses: WalletComplianceStatus[] = results.map((result) => ({\n        address: result.address,\n        blocked: result.blocked,\n        checkedAt: now,\n      }));\n\n      this.update((draftState) => {\n        for (let idx = 0; idx < statuses.length; idx++) {\n          const callerAddress = addresses[idx];\n          draftState.walletComplianceStatusMap[callerAddress] = statuses[idx];\n        }\n        draftState.lastCheckedAt = now;\n      });\n\n      return statuses;\n    } catch (error) {\n      const cachedStatuses = addresses.map((address) =>\n        getWalletComplianceStatus(\n          this.state.walletComplianceStatusMap,\n          address,\n        ),\n      );\n      if (\n        cachedStatuses.every((status): status is WalletComplianceStatus =>\n          Boolean(status),\n        )\n      ) {\n        return cachedStatuses;\n      }\n      throw error;\n    }\n  }\n\n  /**\n   * Clears all compliance data from state.\n   */\n  clearComplianceState(): void {\n    this.update((draftState) => {\n      draftState.walletComplianceStatusMap = {};\n      draftState.lastCheckedAt = null;\n    });\n  }\n}\n"]}

package/dist/{ComplianceController.d.ts → ComplianceController.d.cts}

@@ -1,9 +1,9 @@
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
-import type { Messenger } from '@metamask/messenger';
-import type { ComplianceControllerMethodActions } from './ComplianceController-method-action-types.js';
-import type { ComplianceServiceCheckWalletComplianceAction, ComplianceServiceCheckWalletsComplianceAction } from './ComplianceService-method-action-types.js';
-import type { WalletComplianceStatus } from './types.js';
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { ComplianceControllerMethodActions } from "./ComplianceController-method-action-types.cjs";
+import type { ComplianceServiceCheckWalletComplianceAction, ComplianceServiceCheckWalletsComplianceAction } from "./ComplianceService-method-action-types.cjs";
+import type { WalletComplianceStatus } from "./types.cjs";
 /**
  * The name of the {@link ComplianceController}, used to namespace the
  * controller's actions and events and to namespace the controller's state data
@@ -109,4 +109,4 @@ export declare class ComplianceController extends BaseController<typeof controll
     clearComplianceState(): void;
 }
 export {};
-//# sourceMappingURL=ComplianceController.d.ts.map
+//# sourceMappingURL=ComplianceController.d.cts.map

package/dist/ComplianceController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceController.d.cts","sourceRoot":"","sources":["../src/ComplianceController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,iCAAiC,EAAE,uDAAsD;AACvG,OAAO,KAAK,EACV,4CAA4C,EAC5C,6CAA6C,EAC9C,oDAAmD;AACpD,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAmB;AAKzD;;;;GAIG;AACH,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAIrD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAElE;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B,CAAC;AAoBF;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,IAAI,yBAAyB,CAK/E;AAUD;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,wBAAwB,CACvE,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,kCAAkC,GAClC,iCAAiC,CAAC;AAEtC;;GAEG;AACH,KAAK,cAAc,GACf,4CAA4C,GAC5C,6CAA6C,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,0BAA0B,CAC3E,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,oCAAoC,CAAC;AAE9E;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,SAAS,CACnD,OAAO,cAAc,EACrB,2BAA2B,GAAG,cAAc,EAC5C,0BAA0B,GAAG,aAAa,CAC3C,CAAC;AAIF;;;;;GAKG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CACtD,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAC9B;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,6BAA6B,CAAC;QACzC,KAAK,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAiBD;;;;;;;;OAQG;IACG,qBAAqB,CACzB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,sBAAsB,CAAC;IAgClC;;;;;;;;;OASG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAyCpC;;OAEG;IACH,oBAAoB,IAAI,IAAI;CAM7B"}

package/dist/ComplianceController.d.mts

@@ -0,0 +1,112 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { ComplianceControllerMethodActions } from "./ComplianceController-method-action-types.mjs";
+import type { ComplianceServiceCheckWalletComplianceAction, ComplianceServiceCheckWalletsComplianceAction } from "./ComplianceService-method-action-types.mjs";
+import type { WalletComplianceStatus } from "./types.mjs";
+/**
+ * The name of the {@link ComplianceController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export declare const controllerName = "ComplianceController";
+/**
+ * Describes the shape of the state object for {@link ComplianceController}.
+ */
+export type ComplianceControllerState = {
+    /**
+     * A map of wallet addresses to their compliance check results, used as a
+     * fallback cache when the API is unavailable.
+     */
+    walletComplianceStatusMap: Record<string, WalletComplianceStatus>;
+    /**
+     * The date/time (in ISO-8601 format) when the last compliance check was
+     * performed, or `null` if no checks have been performed yet.
+     */
+    lastCheckedAt: string | null;
+};
+/**
+ * Constructs the default {@link ComplianceController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link ComplianceController} state.
+ */
+export declare function getDefaultComplianceControllerState(): ComplianceControllerState;
+/**
+ * Retrieves the state of the {@link ComplianceController}.
+ */
+export type ComplianceControllerGetStateAction = ControllerGetStateAction<typeof controllerName, ComplianceControllerState>;
+/**
+ * Actions that {@link ComplianceController} exposes to other consumers.
+ */
+export type ComplianceControllerActions = ComplianceControllerGetStateAction | ComplianceControllerMethodActions;
+/**
+ * Actions from other messengers that {@link ComplianceController} calls.
+ */
+type AllowedActions = ComplianceServiceCheckWalletComplianceAction | ComplianceServiceCheckWalletsComplianceAction;
+/**
+ * Published when the state of {@link ComplianceController} changes.
+ */
+export type ComplianceControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ComplianceControllerState>;
+/**
+ * Events that {@link ComplianceController} exposes to other consumers.
+ */
+export type ComplianceControllerEvents = ComplianceControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link ComplianceController} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link ComplianceController}.
+ */
+export type ComplianceControllerMessenger = Messenger<typeof controllerName, ComplianceControllerActions | AllowedActions, ComplianceControllerEvents | AllowedEvents>;
+/**
+ * `ComplianceController` manages OFAC compliance state for wallet addresses.
+ * It performs on-demand compliance checks via the API and caches results
+ * per address in state. Cached results serve as a fallback if the API is
+ * unavailable for a subsequent check on the same address.
+ */
+export declare class ComplianceController extends BaseController<typeof controllerName, ComplianceControllerState, ComplianceControllerMessenger> {
+    /**
+     * Constructs a new {@link ComplianceController}.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.state - The desired state with which to init this
+     * controller. Missing properties will be filled in with defaults.
+     */
+    constructor({ messenger, state, }: {
+        messenger: ComplianceControllerMessenger;
+        state?: Partial<ComplianceControllerState>;
+    });
+    /**
+     * Checks compliance status for a single wallet address via the API and
+     * persists the result to state. If the API call fails and a previously
+     * cached result exists for the address, the cached result is returned as a
+     * fallback. If no cached result exists, the error is re-thrown.
+     *
+     * @param address - The wallet address to check.
+     * @returns The compliance status of the wallet.
+     */
+    checkWalletCompliance(address: string): Promise<WalletComplianceStatus>;
+    /**
+     * Checks compliance status for multiple wallet addresses via the API and
+     * persists the results to state. If the API call fails and every requested
+     * address has a previously cached result, those cached results are returned
+     * as a fallback. If any address lacks a cached result, the error is
+     * re-thrown.
+     *
+     * @param addresses - The wallet addresses to check.
+     * @returns The compliance statuses of the wallets.
+     */
+    checkWalletsCompliance(addresses: string[]): Promise<WalletComplianceStatus[]>;
+    /**
+     * Clears all compliance data from state.
+     */
+    clearComplianceState(): void;
+}
+export {};
+//# sourceMappingURL=ComplianceController.d.mts.map

package/dist/ComplianceController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceController.d.mts","sourceRoot":"","sources":["../src/ComplianceController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,iCAAiC,EAAE,uDAAsD;AACvG,OAAO,KAAK,EACV,4CAA4C,EAC5C,6CAA6C,EAC9C,oDAAmD;AACpD,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAmB;AAKzD;;;;GAIG;AACH,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAIrD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAElE;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B,CAAC;AAoBF;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,IAAI,yBAAyB,CAK/E;AAUD;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,wBAAwB,CACvE,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,kCAAkC,GAClC,iCAAiC,CAAC;AAEtC;;GAEG;AACH,KAAK,cAAc,GACf,4CAA4C,GAC5C,6CAA6C,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,0BAA0B,CAC3E,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,oCAAoC,CAAC;AAE9E;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,SAAS,CACnD,OAAO,cAAc,EACrB,2BAA2B,GAAG,cAAc,EAC5C,0BAA0B,GAAG,aAAa,CAC3C,CAAC;AAIF;;;;;GAKG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CACtD,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAC9B;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,6BAA6B,CAAC;QACzC,KAAK,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAiBD;;;;;;;;OAQG;IACG,qBAAqB,CACzB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,sBAAsB,CAAC;IAgClC;;;;;;;;;OASG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAyCpC;;OAEG;IACH,oBAAoB,IAAI,IAAI;CAM7B"}

package/dist/{ComplianceController.js → ComplianceController.mjs}

@@ -1,5 +1,5 @@
-import { BaseController } from '@metamask/base-controller';
-import { getWalletComplianceStatus } from './utils.js';
+import { BaseController } from "@metamask/base-controller";
+import { getWalletComplianceStatus } from "./utils.mjs";
 // === GENERAL ===
 /**
  * The name of the {@link ComplianceController}, used to namespace the
@@ -150,4 +150,4 @@ export class ComplianceController extends BaseController {
         });
     }
 }
-//# sourceMappingURL=ComplianceController.js.map
+//# sourceMappingURL=ComplianceController.mjs.map

package/dist/ComplianceController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceController.mjs","sourceRoot":"","sources":["../src/ComplianceController.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAS3D,OAAO,EAAE,yBAAyB,EAAE,oBAAmB;AAEvD,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAqBrD;;GAEG;AACH,MAAM,4BAA4B,GAAG;IACnC,yBAAyB,EAAE;QACzB,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,IAAI;KACf;IACD,aAAa,EAAE;QACb,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,KAAK;KAChB;CACiD,CAAC;AAErD;;;;;;;GAOG;AACH,MAAM,UAAU,mCAAmC;IACjD,OAAO;QACL,yBAAyB,EAAE,EAAE;QAC7B,aAAa,EAAE,IAAI;KACpB,CAAC;AACJ,CAAC;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,uBAAuB;IACvB,wBAAwB;IACxB,sBAAsB;CACd,CAAC;AAoDX,gCAAgC;AAEhC;;;;;GAKG;AACH,MAAM,OAAO,oBAAqB,SAAQ,cAIzC;IACC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,4BAA4B;YACtC,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,mCAAmC,EAAE;gBACxC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAe;QAEf,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,yCAAyC,EACzC,OAAO,CACR,CAAC;YAEF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACrC,MAAM,MAAM,GAA2B;gBACrC,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,SAAS,EAAE,GAAG;aACf,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;gBACzB,UAAU,CAAC,yBAAyB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;gBACvD,UAAU,CAAC,aAAa,GAAG,GAAG,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,GAAG,yBAAyB,CACtC,IAAI,CAAC,KAAK,CAAC,yBAAyB,EACpC,OAAO,CACR,CAAC;YACF,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,sBAAsB,CAC1B,SAAmB;QAEnB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACvC,0CAA0C,EAC1C,SAAS,CACV,CAAC;YAEF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACrC,MAAM,QAAQ,GAA6B,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAClE,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,SAAS,EAAE,GAAG;aACf,CAAC,CAAC,CAAC;YAEJ,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;gBACzB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;oBAC/C,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;oBACrC,UAAU,CAAC,yBAAyB,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;gBACtE,CAAC;gBACD,UAAU,CAAC,aAAa,GAAG,GAAG,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,cAAc,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAC/C,yBAAyB,CACvB,IAAI,CAAC,KAAK,CAAC,yBAAyB,EACpC,OAAO,CACR,CACF,CAAC;YACF,IACE,cAAc,CAAC,KAAK,CAAC,CAAC,MAAM,EAAoC,EAAE,CAChE,OAAO,CAAC,MAAM,CAAC,CAChB,EACD,CAAC;gBACD,OAAO,cAAc,CAAC;YACxB,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;YACzB,UAAU,CAAC,yBAAyB,GAAG,EAAE,CAAC;YAC1C,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport type { ComplianceControllerMethodActions } from './ComplianceController-method-action-types.js';\nimport type {\n  ComplianceServiceCheckWalletComplianceAction,\n  ComplianceServiceCheckWalletsComplianceAction,\n} from './ComplianceService-method-action-types.js';\nimport type { WalletComplianceStatus } from './types.js';\nimport { getWalletComplianceStatus } from './utils.js';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link ComplianceController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'ComplianceController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link ComplianceController}.\n */\nexport type ComplianceControllerState = {\n  /**\n   * A map of wallet addresses to their compliance check results, used as a\n   * fallback cache when the API is unavailable.\n   */\n  walletComplianceStatusMap: Record<string, WalletComplianceStatus>;\n\n  /**\n   * The date/time (in ISO-8601 format) when the last compliance check was\n   * performed, or `null` if no checks have been performed yet.\n   */\n  lastCheckedAt: string | null;\n};\n\n/**\n * The metadata for each property in {@link ComplianceControllerState}.\n */\nconst complianceControllerMetadata = {\n  walletComplianceStatusMap: {\n    includeInDebugSnapshot: false,\n    includeInStateLogs: false,\n    persist: true,\n    usedInUi: true,\n  },\n  lastCheckedAt: {\n    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    persist: true,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<ComplianceControllerState>;\n\n/**\n * Constructs the default {@link ComplianceController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link ComplianceController} state.\n */\nexport function getDefaultComplianceControllerState(): ComplianceControllerState {\n  return {\n    walletComplianceStatusMap: {},\n    lastCheckedAt: null,\n  };\n}\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'checkWalletCompliance',\n  'checkWalletsCompliance',\n  'clearComplianceState',\n] as const;\n\n/**\n * Retrieves the state of the {@link ComplianceController}.\n */\nexport type ComplianceControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ComplianceControllerState\n>;\n\n/**\n * Actions that {@link ComplianceController} exposes to other consumers.\n */\nexport type ComplianceControllerActions =\n  | ComplianceControllerGetStateAction\n  | ComplianceControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link ComplianceController} calls.\n */\ntype AllowedActions =\n  | ComplianceServiceCheckWalletComplianceAction\n  | ComplianceServiceCheckWalletsComplianceAction;\n\n/**\n * Published when the state of {@link ComplianceController} changes.\n */\nexport type ComplianceControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ComplianceControllerState\n>;\n\n/**\n * Events that {@link ComplianceController} exposes to other consumers.\n */\nexport type ComplianceControllerEvents = ComplianceControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ComplianceController} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ComplianceController}.\n */\nexport type ComplianceControllerMessenger = Messenger<\n  typeof controllerName,\n  ComplianceControllerActions | AllowedActions,\n  ComplianceControllerEvents | AllowedEvents\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * `ComplianceController` manages OFAC compliance state for wallet addresses.\n * It performs on-demand compliance checks via the API and caches results\n * per address in state. Cached results serve as a fallback if the API is\n * unavailable for a subsequent check on the same address.\n */\nexport class ComplianceController extends BaseController<\n  typeof controllerName,\n  ComplianceControllerState,\n  ComplianceControllerMessenger\n> {\n  /**\n   * Constructs a new {@link ComplianceController}.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to init this\n   * controller. Missing properties will be filled in with defaults.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: ComplianceControllerMessenger;\n    state?: Partial<ComplianceControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: complianceControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultComplianceControllerState(),\n        ...state,\n      },\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Checks compliance status for a single wallet address via the API and\n   * persists the result to state. If the API call fails and a previously\n   * cached result exists for the address, the cached result is returned as a\n   * fallback. If no cached result exists, the error is re-thrown.\n   *\n   * @param address - The wallet address to check.\n   * @returns The compliance status of the wallet.\n   */\n  async checkWalletCompliance(\n    address: string,\n  ): Promise<WalletComplianceStatus> {\n    try {\n      const result = await this.messenger.call(\n        'ComplianceService:checkWalletCompliance',\n        address,\n      );\n\n      const now = new Date().toISOString();\n      const status: WalletComplianceStatus = {\n        address: result.address,\n        blocked: result.blocked,\n        checkedAt: now,\n      };\n\n      this.update((draftState) => {\n        draftState.walletComplianceStatusMap[address] = status;\n        draftState.lastCheckedAt = now;\n      });\n\n      return status;\n    } catch (error) {\n      const cached = getWalletComplianceStatus(\n        this.state.walletComplianceStatusMap,\n        address,\n      );\n      if (cached) {\n        return cached;\n      }\n      throw error;\n    }\n  }\n\n  /**\n   * Checks compliance status for multiple wallet addresses via the API and\n   * persists the results to state. If the API call fails and every requested\n   * address has a previously cached result, those cached results are returned\n   * as a fallback. If any address lacks a cached result, the error is\n   * re-thrown.\n   *\n   * @param addresses - The wallet addresses to check.\n   * @returns The compliance statuses of the wallets.\n   */\n  async checkWalletsCompliance(\n    addresses: string[],\n  ): Promise<WalletComplianceStatus[]> {\n    try {\n      const results = await this.messenger.call(\n        'ComplianceService:checkWalletsCompliance',\n        addresses,\n      );\n\n      const now = new Date().toISOString();\n      const statuses: WalletComplianceStatus[] = results.map((result) => ({\n        address: result.address,\n        blocked: result.blocked,\n        checkedAt: now,\n      }));\n\n      this.update((draftState) => {\n        for (let idx = 0; idx < statuses.length; idx++) {\n          const callerAddress = addresses[idx];\n          draftState.walletComplianceStatusMap[callerAddress] = statuses[idx];\n        }\n        draftState.lastCheckedAt = now;\n      });\n\n      return statuses;\n    } catch (error) {\n      const cachedStatuses = addresses.map((address) =>\n        getWalletComplianceStatus(\n          this.state.walletComplianceStatusMap,\n          address,\n        ),\n      );\n      if (\n        cachedStatuses.every((status): status is WalletComplianceStatus =>\n          Boolean(status),\n        )\n      ) {\n        return cachedStatuses;\n      }\n      throw error;\n    }\n  }\n\n  /**\n   * Clears all compliance data from state.\n   */\n  clearComplianceState(): void {\n    this.update((draftState) => {\n      draftState.walletComplianceStatusMap = {};\n      draftState.lastCheckedAt = null;\n    });\n  }\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceService-method-action-types.cjs","sourceRoot":"","sources":["../src/ComplianceService-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { ComplianceService } from './ComplianceService.js';\n\n/**\n * Checks compliance status for a single wallet address.\n *\n * @param address - The wallet address to check.\n * @returns The compliance status of the wallet.\n */\nexport type ComplianceServiceCheckWalletComplianceAction = {\n  type: `ComplianceService:checkWalletCompliance`;\n  handler: ComplianceService['checkWalletCompliance'];\n};\n\n/**\n * Checks compliance status for multiple wallet addresses in a single request.\n *\n * @param addresses - The wallet addresses to check.\n * @returns The compliance statuses of the wallets.\n */\nexport type ComplianceServiceCheckWalletsComplianceAction = {\n  type: `ComplianceService:checkWalletsCompliance`;\n  handler: ComplianceService['checkWalletsCompliance'];\n};\n\n/**\n * Union of all ComplianceService action types.\n */\nexport type ComplianceServiceMethodActions =\n  | ComplianceServiceCheckWalletComplianceAction\n  | ComplianceServiceCheckWalletsComplianceAction;\n"]}

package/dist/{ComplianceService-method-action-types.d.ts → ComplianceService-method-action-types.d.cts}

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { ComplianceService } from './ComplianceService.js';
+import type { ComplianceService } from "./ComplianceService.cjs";
 /**
  * Checks compliance status for a single wallet address.
  *
@@ -27,4 +27,4 @@ export type ComplianceServiceCheckWalletsComplianceAction = {
  * Union of all ComplianceService action types.
  */
 export type ComplianceServiceMethodActions = ComplianceServiceCheckWalletComplianceAction | ComplianceServiceCheckWalletsComplianceAction;
-//# sourceMappingURL=ComplianceService-method-action-types.d.ts.map
+//# sourceMappingURL=ComplianceService-method-action-types.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceService-method-action-types.d.cts","sourceRoot":"","sources":["../src/ComplianceService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA+B;AAEhE;;;;;GAKG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,iBAAiB,CAAC,wBAAwB,CAAC,CAAC;CACtD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACtC,4CAA4C,GAC5C,6CAA6C,CAAC"}

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

@@ -0,0 +1,30 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { ComplianceService } from "./ComplianceService.mjs";
+/**
+ * Checks compliance status for a single wallet address.
+ *
+ * @param address - The wallet address to check.
+ * @returns The compliance status of the wallet.
+ */
+export type ComplianceServiceCheckWalletComplianceAction = {
+    type: `ComplianceService:checkWalletCompliance`;
+    handler: ComplianceService['checkWalletCompliance'];
+};
+/**
+ * Checks compliance status for multiple wallet addresses in a single request.
+ *
+ * @param addresses - The wallet addresses to check.
+ * @returns The compliance statuses of the wallets.
+ */
+export type ComplianceServiceCheckWalletsComplianceAction = {
+    type: `ComplianceService:checkWalletsCompliance`;
+    handler: ComplianceService['checkWalletsCompliance'];
+};
+/**
+ * Union of all ComplianceService action types.
+ */
+export type ComplianceServiceMethodActions = ComplianceServiceCheckWalletComplianceAction | ComplianceServiceCheckWalletsComplianceAction;
+//# sourceMappingURL=ComplianceService-method-action-types.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceService-method-action-types.d.mts","sourceRoot":"","sources":["../src/ComplianceService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA+B;AAEhE;;;;;GAKG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,iBAAiB,CAAC,wBAAwB,CAAC,CAAC;CACtD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACtC,4CAA4C,GAC5C,6CAA6C,CAAC"}

package/dist/{ComplianceService-method-action-types.js → ComplianceService-method-action-types.mjs}

@@ -3,4 +3,4 @@
  * Do not edit manually.
  */
 export {};
-//# sourceMappingURL=ComplianceService-method-action-types.js.map
+//# sourceMappingURL=ComplianceService-method-action-types.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceService-method-action-types.mjs","sourceRoot":"","sources":["../src/ComplianceService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { ComplianceService } from './ComplianceService.js';\n\n/**\n * Checks compliance status for a single wallet address.\n *\n * @param address - The wallet address to check.\n * @returns The compliance status of the wallet.\n */\nexport type ComplianceServiceCheckWalletComplianceAction = {\n  type: `ComplianceService:checkWalletCompliance`;\n  handler: ComplianceService['checkWalletCompliance'];\n};\n\n/**\n * Checks compliance status for multiple wallet addresses in a single request.\n *\n * @param addresses - The wallet addresses to check.\n * @returns The compliance statuses of the wallets.\n */\nexport type ComplianceServiceCheckWalletsComplianceAction = {\n  type: `ComplianceService:checkWalletsCompliance`;\n  handler: ComplianceService['checkWalletsCompliance'];\n};\n\n/**\n * Union of all ComplianceService action types.\n */\nexport type ComplianceServiceMethodActions =\n  | ComplianceServiceCheckWalletComplianceAction\n  | ComplianceServiceCheckWalletsComplianceAction;\n"]}