@metamask-previews/claims-controller 0.6.1-preview-4f4c98e → 0.6.1-preview-eb263b0ee

package/CHANGELOG.md

@@ -11,7 +11,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 `@tanstack/query-core` from `^4.43.0` to `^5.62.16` ([#9712](https://github.com/MetaMask/core/pull/9712))
 - Bump `@metamask/base-data-service` from `^0.1.3` to `^1.0.0` ([#9972](https://github.com/MetaMask/core/pull/9972))
 

package/dist/ClaimsController-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=ClaimsController-method-action-types.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsController-method-action-types.cjs","sourceRoot":"","sources":["../src/ClaimsController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { ClaimsController } from './ClaimsController.js';\n\n/**\n * Fetch the required configurations for the claims service.\n *\n * @returns The required configurations for the claims service.\n */\nexport type ClaimsControllerFetchClaimsConfigurationsAction = {\n  type: `ClaimsController:fetchClaimsConfigurations`;\n  handler: ClaimsController['fetchClaimsConfigurations'];\n};\n\n/**\n * Get required config for submitting a claim.\n *\n * @param claim - The claim request to get the required config for.\n * @returns The required config for submitting the claim.\n */\nexport type ClaimsControllerGetSubmitClaimConfigAction = {\n  type: `ClaimsController:getSubmitClaimConfig`;\n  handler: ClaimsController['getSubmitClaimConfig'];\n};\n\n/**\n * Generate a signature for a claim.\n *\n * @param chainId - The chain id of the claim.\n * @param walletAddress - The impacted wallet address of the claim.\n * @returns The signature for the claim.\n */\nexport type ClaimsControllerGenerateClaimSignatureAction = {\n  type: `ClaimsController:generateClaimSignature`;\n  handler: ClaimsController['generateClaimSignature'];\n};\n\n/**\n * Get the list of claims for the current user.\n *\n * @returns The list of claims for the current user.\n */\nexport type ClaimsControllerGetClaimsAction = {\n  type: `ClaimsController:getClaims`;\n  handler: ClaimsController['getClaims'];\n};\n\n/**\n * Save a claim draft to the state.\n * If the draft name is not provided, a default name will be generated.\n * If the draft with the same id already exists, it will be updated.\n *\n * @param draft - The draft to save.\n * @returns The saved draft.\n */\nexport type ClaimsControllerSaveOrUpdateClaimDraftAction = {\n  type: `ClaimsController:saveOrUpdateClaimDraft`;\n  handler: ClaimsController['saveOrUpdateClaimDraft'];\n};\n\n/**\n * Get the list of claim drafts.\n *\n * @returns The list of claim drafts.\n */\nexport type ClaimsControllerGetClaimDraftsAction = {\n  type: `ClaimsController:getClaimDrafts`;\n  handler: ClaimsController['getClaimDrafts'];\n};\n\n/**\n * Delete a claim draft from the state.\n *\n * @param draftId - The ID of the draft to delete.\n */\nexport type ClaimsControllerDeleteClaimDraftAction = {\n  type: `ClaimsController:deleteClaimDraft`;\n  handler: ClaimsController['deleteClaimDraft'];\n};\n\n/**\n * Delete all claim drafts from the state.\n */\nexport type ClaimsControllerDeleteAllClaimDraftsAction = {\n  type: `ClaimsController:deleteAllClaimDrafts`;\n  handler: ClaimsController['deleteAllClaimDrafts'];\n};\n\n/**\n * Clears the claims state and resets to default values.\n */\nexport type ClaimsControllerClearStateAction = {\n  type: `ClaimsController:clearState`;\n  handler: ClaimsController['clearState'];\n};\n\n/**\n * Union of all ClaimsController action types.\n */\nexport type ClaimsControllerMethodActions =\n  | ClaimsControllerFetchClaimsConfigurationsAction\n  | ClaimsControllerGetSubmitClaimConfigAction\n  | ClaimsControllerGenerateClaimSignatureAction\n  | ClaimsControllerGetClaimsAction\n  | ClaimsControllerSaveOrUpdateClaimDraftAction\n  | ClaimsControllerGetClaimDraftsAction\n  | ClaimsControllerDeleteClaimDraftAction\n  | ClaimsControllerDeleteAllClaimDraftsAction\n  | ClaimsControllerClearStateAction;\n"]}

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

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { ClaimsController } from './ClaimsController.js';
+import type { ClaimsController } from "./ClaimsController.cjs";
 /**
  * Fetch the required configurations for the claims service.
  *
@@ -90,4 +90,4 @@ export type ClaimsControllerClearStateAction = {
  * Union of all ClaimsController action types.
  */
 export type ClaimsControllerMethodActions = ClaimsControllerFetchClaimsConfigurationsAction | ClaimsControllerGetSubmitClaimConfigAction | ClaimsControllerGenerateClaimSignatureAction | ClaimsControllerGetClaimsAction | ClaimsControllerSaveOrUpdateClaimDraftAction | ClaimsControllerGetClaimDraftsAction | ClaimsControllerDeleteClaimDraftAction | ClaimsControllerDeleteAllClaimDraftsAction | ClaimsControllerClearStateAction;
-//# sourceMappingURL=ClaimsController-method-action-types.d.ts.map
+//# sourceMappingURL=ClaimsController-method-action-types.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsController-method-action-types.d.cts","sourceRoot":"","sources":["../src/ClaimsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA8B;AAE9D;;;;GAIG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,gBAAgB,CAAC,2BAA2B,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;CACxC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,+CAA+C,GAC/C,0CAA0C,GAC1C,4CAA4C,GAC5C,+BAA+B,GAC/B,4CAA4C,GAC5C,oCAAoC,GACpC,sCAAsC,GACtC,0CAA0C,GAC1C,gCAAgC,CAAC"}

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

@@ -0,0 +1,93 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { ClaimsController } from "./ClaimsController.mjs";
+/**
+ * Fetch the required configurations for the claims service.
+ *
+ * @returns The required configurations for the claims service.
+ */
+export type ClaimsControllerFetchClaimsConfigurationsAction = {
+    type: `ClaimsController:fetchClaimsConfigurations`;
+    handler: ClaimsController['fetchClaimsConfigurations'];
+};
+/**
+ * Get required config for submitting a claim.
+ *
+ * @param claim - The claim request to get the required config for.
+ * @returns The required config for submitting the claim.
+ */
+export type ClaimsControllerGetSubmitClaimConfigAction = {
+    type: `ClaimsController:getSubmitClaimConfig`;
+    handler: ClaimsController['getSubmitClaimConfig'];
+};
+/**
+ * Generate a signature for a claim.
+ *
+ * @param chainId - The chain id of the claim.
+ * @param walletAddress - The impacted wallet address of the claim.
+ * @returns The signature for the claim.
+ */
+export type ClaimsControllerGenerateClaimSignatureAction = {
+    type: `ClaimsController:generateClaimSignature`;
+    handler: ClaimsController['generateClaimSignature'];
+};
+/**
+ * Get the list of claims for the current user.
+ *
+ * @returns The list of claims for the current user.
+ */
+export type ClaimsControllerGetClaimsAction = {
+    type: `ClaimsController:getClaims`;
+    handler: ClaimsController['getClaims'];
+};
+/**
+ * Save a claim draft to the state.
+ * If the draft name is not provided, a default name will be generated.
+ * If the draft with the same id already exists, it will be updated.
+ *
+ * @param draft - The draft to save.
+ * @returns The saved draft.
+ */
+export type ClaimsControllerSaveOrUpdateClaimDraftAction = {
+    type: `ClaimsController:saveOrUpdateClaimDraft`;
+    handler: ClaimsController['saveOrUpdateClaimDraft'];
+};
+/**
+ * Get the list of claim drafts.
+ *
+ * @returns The list of claim drafts.
+ */
+export type ClaimsControllerGetClaimDraftsAction = {
+    type: `ClaimsController:getClaimDrafts`;
+    handler: ClaimsController['getClaimDrafts'];
+};
+/**
+ * Delete a claim draft from the state.
+ *
+ * @param draftId - The ID of the draft to delete.
+ */
+export type ClaimsControllerDeleteClaimDraftAction = {
+    type: `ClaimsController:deleteClaimDraft`;
+    handler: ClaimsController['deleteClaimDraft'];
+};
+/**
+ * Delete all claim drafts from the state.
+ */
+export type ClaimsControllerDeleteAllClaimDraftsAction = {
+    type: `ClaimsController:deleteAllClaimDrafts`;
+    handler: ClaimsController['deleteAllClaimDrafts'];
+};
+/**
+ * Clears the claims state and resets to default values.
+ */
+export type ClaimsControllerClearStateAction = {
+    type: `ClaimsController:clearState`;
+    handler: ClaimsController['clearState'];
+};
+/**
+ * Union of all ClaimsController action types.
+ */
+export type ClaimsControllerMethodActions = ClaimsControllerFetchClaimsConfigurationsAction | ClaimsControllerGetSubmitClaimConfigAction | ClaimsControllerGenerateClaimSignatureAction | ClaimsControllerGetClaimsAction | ClaimsControllerSaveOrUpdateClaimDraftAction | ClaimsControllerGetClaimDraftsAction | ClaimsControllerDeleteClaimDraftAction | ClaimsControllerDeleteAllClaimDraftsAction | ClaimsControllerClearStateAction;
+//# sourceMappingURL=ClaimsController-method-action-types.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsController-method-action-types.d.mts","sourceRoot":"","sources":["../src/ClaimsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA8B;AAE9D;;;;GAIG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,gBAAgB,CAAC,2BAA2B,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;CACxC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,+CAA+C,GAC/C,0CAA0C,GAC1C,4CAA4C,GAC5C,+BAA+B,GAC/B,4CAA4C,GAC5C,oCAAoC,GACpC,sCAAsC,GACtC,0CAA0C,GAC1C,gCAAgC,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsController-method-action-types.mjs","sourceRoot":"","sources":["../src/ClaimsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { ClaimsController } from './ClaimsController.js';\n\n/**\n * Fetch the required configurations for the claims service.\n *\n * @returns The required configurations for the claims service.\n */\nexport type ClaimsControllerFetchClaimsConfigurationsAction = {\n  type: `ClaimsController:fetchClaimsConfigurations`;\n  handler: ClaimsController['fetchClaimsConfigurations'];\n};\n\n/**\n * Get required config for submitting a claim.\n *\n * @param claim - The claim request to get the required config for.\n * @returns The required config for submitting the claim.\n */\nexport type ClaimsControllerGetSubmitClaimConfigAction = {\n  type: `ClaimsController:getSubmitClaimConfig`;\n  handler: ClaimsController['getSubmitClaimConfig'];\n};\n\n/**\n * Generate a signature for a claim.\n *\n * @param chainId - The chain id of the claim.\n * @param walletAddress - The impacted wallet address of the claim.\n * @returns The signature for the claim.\n */\nexport type ClaimsControllerGenerateClaimSignatureAction = {\n  type: `ClaimsController:generateClaimSignature`;\n  handler: ClaimsController['generateClaimSignature'];\n};\n\n/**\n * Get the list of claims for the current user.\n *\n * @returns The list of claims for the current user.\n */\nexport type ClaimsControllerGetClaimsAction = {\n  type: `ClaimsController:getClaims`;\n  handler: ClaimsController['getClaims'];\n};\n\n/**\n * Save a claim draft to the state.\n * If the draft name is not provided, a default name will be generated.\n * If the draft with the same id already exists, it will be updated.\n *\n * @param draft - The draft to save.\n * @returns The saved draft.\n */\nexport type ClaimsControllerSaveOrUpdateClaimDraftAction = {\n  type: `ClaimsController:saveOrUpdateClaimDraft`;\n  handler: ClaimsController['saveOrUpdateClaimDraft'];\n};\n\n/**\n * Get the list of claim drafts.\n *\n * @returns The list of claim drafts.\n */\nexport type ClaimsControllerGetClaimDraftsAction = {\n  type: `ClaimsController:getClaimDrafts`;\n  handler: ClaimsController['getClaimDrafts'];\n};\n\n/**\n * Delete a claim draft from the state.\n *\n * @param draftId - The ID of the draft to delete.\n */\nexport type ClaimsControllerDeleteClaimDraftAction = {\n  type: `ClaimsController:deleteClaimDraft`;\n  handler: ClaimsController['deleteClaimDraft'];\n};\n\n/**\n * Delete all claim drafts from the state.\n */\nexport type ClaimsControllerDeleteAllClaimDraftsAction = {\n  type: `ClaimsController:deleteAllClaimDrafts`;\n  handler: ClaimsController['deleteAllClaimDrafts'];\n};\n\n/**\n * Clears the claims state and resets to default values.\n */\nexport type ClaimsControllerClearStateAction = {\n  type: `ClaimsController:clearState`;\n  handler: ClaimsController['clearState'];\n};\n\n/**\n * Union of all ClaimsController action types.\n */\nexport type ClaimsControllerMethodActions =\n  | ClaimsControllerFetchClaimsConfigurationsAction\n  | ClaimsControllerGetSubmitClaimConfigAction\n  | ClaimsControllerGenerateClaimSignatureAction\n  | ClaimsControllerGetClaimsAction\n  | ClaimsControllerSaveOrUpdateClaimDraftAction\n  | ClaimsControllerGetClaimDraftsAction\n  | ClaimsControllerDeleteClaimDraftAction\n  | ClaimsControllerDeleteAllClaimDraftsAction\n  | ClaimsControllerClearStateAction;\n"]}

package/dist/ClaimsController.cjs

@@ -0,0 +1,221 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ClaimsController_instances, _ClaimsController_validateSubmitClaimRequest;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClaimsController = exports.getDefaultClaimsControllerState = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const utils_1 = require("@metamask/utils");
+const constants_js_1 = require("./constants.cjs");
+const ClaimsControllerStateMetadata = {
+    claims: {
+        includeInStateLogs: false,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
+    claimsConfigurations: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+    drafts: {
+        includeInStateLogs: false,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
+};
+/**
+ * Get an initial default state for the controller.
+ *
+ * @returns The initial default controller state.
+ */
+function getDefaultClaimsControllerState() {
+    return {
+        claimsConfigurations: constants_js_1.DEFAULT_CLAIMS_CONFIGURATIONS,
+        claims: [],
+        drafts: [],
+    };
+}
+exports.getDefaultClaimsControllerState = getDefaultClaimsControllerState;
+const MESSENGER_EXPOSED_METHODS = [
+    'fetchClaimsConfigurations',
+    'getSubmitClaimConfig',
+    'generateClaimSignature',
+    'getClaims',
+    'saveOrUpdateClaimDraft',
+    'getClaimDrafts',
+    'deleteClaimDraft',
+    'deleteAllClaimDrafts',
+    'clearState',
+];
+class ClaimsController extends base_controller_1.BaseController {
+    constructor({ messenger, state }) {
+        super({
+            messenger,
+            metadata: ClaimsControllerStateMetadata,
+            name: constants_js_1.CONTROLLER_NAME,
+            state: { ...getDefaultClaimsControllerState(), ...state },
+        });
+        _ClaimsController_instances.add(this);
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Fetch the required configurations for the claims service.
+     *
+     * @returns The required configurations for the claims service.
+     */
+    async fetchClaimsConfigurations() {
+        const configurations = await this.messenger.call(`${constants_js_1.SERVICE_NAME}:fetchClaimsConfigurations`);
+        const supportedNetworks = configurations.networks.map((network) => (0, controller_utils_1.toHex)(network));
+        const claimsConfigurations = {
+            validSubmissionWindowDays: configurations.validSubmissionWindowDays,
+            supportedNetworks,
+        };
+        this.update((state) => {
+            state.claimsConfigurations = claimsConfigurations;
+        });
+        return claimsConfigurations;
+    }
+    /**
+     * Get required config for submitting a claim.
+     *
+     * @param claim - The claim request to get the required config for.
+     * @returns The required config for submitting the claim.
+     */
+    async getSubmitClaimConfig(claim) {
+        // Validate the claim before submitting it.
+        __classPrivateFieldGet(this, _ClaimsController_instances, "m", _ClaimsController_validateSubmitClaimRequest).call(this, claim);
+        const headers = await this.messenger.call(`${constants_js_1.SERVICE_NAME}:getRequestHeaders`);
+        const baseUrl = this.messenger.call(`${constants_js_1.SERVICE_NAME}:getClaimsApiUrl`);
+        const url = `${baseUrl}/claims`;
+        return {
+            data: claim,
+            headers,
+            method: 'POST',
+            url,
+        };
+    }
+    /**
+     * Generate a signature for a claim.
+     *
+     * @param chainId - The chain id of the claim.
+     * @param walletAddress - The impacted wallet address of the claim.
+     * @returns The signature for the claim.
+     */
+    async generateClaimSignature(chainId, walletAddress) {
+        // generate the message to be signed
+        const { message } = await this.messenger.call(`${constants_js_1.SERVICE_NAME}:generateMessageForClaimSignature`, chainId, walletAddress);
+        // generate and parse the SIWE message
+        const messageBytes = (0, utils_1.stringToBytes)(message);
+        const messageHex = (0, utils_1.bytesToHex)(messageBytes);
+        const siwe = (0, controller_utils_1.detectSIWE)({ data: messageHex });
+        if (!siwe.isSIWEMessage) {
+            throw new Error(constants_js_1.ClaimsControllerErrorMessages.INVALID_SIGNATURE_MESSAGE);
+        }
+        // sign the message
+        const signature = await this.messenger.call('KeyringController:signPersonalMessage', {
+            data: message,
+            from: walletAddress,
+            siwe,
+        });
+        return signature;
+    }
+    /**
+     * Get the list of claims for the current user.
+     *
+     * @returns The list of claims for the current user.
+     */
+    async getClaims() {
+        const claims = await this.messenger.call(`${constants_js_1.SERVICE_NAME}:getClaims`);
+        this.update((state) => {
+            state.claims = claims;
+        });
+        return claims;
+    }
+    /**
+     * Save a claim draft to the state.
+     * If the draft name is not provided, a default name will be generated.
+     * If the draft with the same id already exists, it will be updated.
+     *
+     * @param draft - The draft to save.
+     * @returns The saved draft.
+     */
+    saveOrUpdateClaimDraft(draft) {
+        const { drafts } = this.state;
+        const isExistingDraft = drafts.some((existingDraft) => draft.draftId && existingDraft.draftId === draft.draftId);
+        if (isExistingDraft) {
+            const updatedAt = new Date().toISOString();
+            this.update((state) => {
+                state.drafts = state.drafts.map((existingDraft) => existingDraft.draftId === draft.draftId
+                    ? {
+                        ...existingDraft,
+                        ...draft,
+                        updatedAt,
+                    }
+                    : existingDraft);
+            });
+            return { ...draft, updatedAt };
+        }
+        // generate a new draft id, name and add it to the state
+        const draftId = `draft-${Date.now()}`;
+        const newDraft = {
+            ...draft,
+            draftId,
+            updatedAt: new Date().toISOString(),
+        };
+        this.update((state) => {
+            state.drafts.push(newDraft);
+        });
+        return newDraft;
+    }
+    /**
+     * Get the list of claim drafts.
+     *
+     * @returns The list of claim drafts.
+     */
+    getClaimDrafts() {
+        return this.state.drafts;
+    }
+    /**
+     * Delete a claim draft from the state.
+     *
+     * @param draftId - The ID of the draft to delete.
+     */
+    deleteClaimDraft(draftId) {
+        this.update((state) => {
+            state.drafts = state.drafts.filter((draft) => draft.draftId !== draftId);
+        });
+    }
+    /**
+     * Delete all claim drafts from the state.
+     */
+    deleteAllClaimDrafts() {
+        this.update((state) => {
+            state.drafts = [];
+        });
+    }
+    /**
+     * Clears the claims state and resets to default values.
+     */
+    clearState() {
+        this.update(() => {
+            return getDefaultClaimsControllerState();
+        });
+    }
+}
+exports.ClaimsController = ClaimsController;
+_ClaimsController_instances = new WeakSet(), _ClaimsController_validateSubmitClaimRequest = function _ClaimsController_validateSubmitClaimRequest(claim) {
+    const { claims: existingClaims } = this.state;
+    const isClaimAlreadySubmitted = existingClaims.some((existingClaim) => existingClaim.impactedTxHash === claim.impactedTxHash);
+    if (isClaimAlreadySubmitted) {
+        throw new Error(constants_js_1.ClaimsControllerErrorMessages.CLAIM_ALREADY_SUBMITTED);
+    }
+};
+//# sourceMappingURL=ClaimsController.cjs.map

package/dist/ClaimsController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsController.cjs","sourceRoot":"","sources":["../src/ClaimsController.ts"],"names":[],"mappings":";;;;;;;;;AAKA,+DAA2D;AAC3D,iEAA+D;AAG/D,2CAA4D;AAW5D,kDAKwB;AA6CxB,MAAM,6BAA6B,GAAyC;IAC1E,MAAM,EAAE;QACN,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;IACD,oBAAoB,EAAE;QACpB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,MAAM,EAAE;QACN,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF;;;;GAIG;AACH,SAAgB,+BAA+B;IAC7C,OAAO;QACL,oBAAoB,EAAE,4CAA6B;QACnD,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,EAAE;KACX,CAAC;AACJ,CAAC;AAND,0EAMC;AAED,MAAM,yBAAyB,GAAG;IAChC,2BAA2B;IAC3B,sBAAsB;IACtB,wBAAwB;IACxB,WAAW;IACX,wBAAwB;IACxB,gBAAgB;IAChB,kBAAkB;IAClB,sBAAsB;IACtB,YAAY;CACJ,CAAC;AAEX,MAAa,gBAAiB,SAAQ,gCAIrC;IACC,YAAY,EAAE,SAAS,EAAE,KAAK,EAA2B;QACvD,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,6BAA6B;YACvC,IAAI,EAAE,8BAAe;YACrB,KAAK,EAAE,EAAE,GAAG,+BAA+B,EAAE,EAAE,GAAG,KAAK,EAAE;SAC1D,CAAC,CAAC;;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,yBAAyB;QAC7B,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9C,GAAG,2BAAY,4BAA4B,CAC5C,CAAC;QAEF,MAAM,iBAAiB,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAChE,IAAA,wBAAK,EAAC,OAAO,CAAC,CACf,CAAC;QACF,MAAM,oBAAoB,GAAG;YAC3B,yBAAyB,EAAE,cAAc,CAAC,yBAAyB;YACnE,iBAAiB;SAClB,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,KAAyB;QAEzB,2CAA2C;QAC3C,uBAAA,IAAI,iFAA4B,MAAhC,IAAI,EAA6B,KAAK,CAAC,CAAC;QAExC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACvC,GAAG,2BAAY,oBAAoB,CACpC,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,2BAAY,kBAAkB,CAAC,CAAC;QACvE,MAAM,GAAG,GAAG,GAAG,OAAO,SAAS,CAAC;QAEhC,OAAO;YACL,IAAI,EAAE,KAAK;YACX,OAAO;YACP,MAAM,EAAE,MAAM;YACd,GAAG;SACJ,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAe,EACf,aAA4B;QAE5B,oCAAoC;QACpC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC3C,GAAG,2BAAY,mCAAmC,EAClD,OAAO,EACP,aAAa,CACd,CAAC;QAEF,sCAAsC;QACtC,MAAM,YAAY,GAAG,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAA,kBAAU,EAAC,YAAY,CAAC,CAAC;QAC5C,MAAM,IAAI,GAAG,IAAA,6BAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,4CAA6B,CAAC,yBAAyB,CAAC,CAAC;QAC3E,CAAC;QAED,mBAAmB;QACnB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACzC,uCAAuC,EACvC;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,aAAa;YACnB,IAAI;SACL,CACF,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,2BAAY,YAAY,CAAC,CAAC;QACtE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CAAC,KAA0B;QAC/C,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAE9B,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CACjC,CAAC,aAAa,EAAE,EAAE,CAChB,KAAK,CAAC,OAAO,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAC3D,CAAC;QAEF,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAChD,aAAa,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;oBACrC,CAAC,CAAC;wBACE,GAAG,aAAa;wBAChB,GAAG,KAAK;wBACR,SAAS;qBACV;oBACH,CAAC,CAAC,aAAa,CAClB,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,OAAO,EAAE,GAAG,KAAK,EAAE,SAAS,EAAgB,CAAC;QAC/C,CAAC;QAED,wDAAwD;QACxD,MAAM,OAAO,GAAG,SAAS,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QAEtC,MAAM,QAAQ,GAAe;YAC3B,GAAG,KAAK;YACR,OAAO;YACP,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;SACpC,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,OAAe;QAC9B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,OAAO,+BAA+B,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;CAgBF;AA7ND,4CA6NC;kJAT6B,KAAyB;IACnD,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;IAC9C,MAAM,uBAAuB,GAAG,cAAc,CAAC,IAAI,CACjD,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,CACzE,CAAC;IACF,IAAI,uBAAuB,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,4CAA6B,CAAC,uBAAuB,CAAC,CAAC;IACzE,CAAC;AACH,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { detectSIWE, toHex } from '@metamask/controller-utils';\nimport type { KeyringControllerSignPersonalMessageAction } from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { bytesToHex, stringToBytes } from '@metamask/utils';\n\nimport type { ClaimsControllerMethodActions } from './ClaimsController-method-action-types.js';\nimport type {\n  ClaimsServiceFetchClaimsConfigurationsAction,\n  ClaimsServiceGenerateMessageForClaimSignatureAction,\n  ClaimsServiceGetClaimByIdAction,\n  ClaimsServiceGetClaimsAction,\n  ClaimsServiceGetClaimsApiUrlAction,\n  ClaimsServiceGetRequestHeadersAction,\n} from './ClaimsService-method-action-types.js';\nimport {\n  ClaimsControllerErrorMessages,\n  CONTROLLER_NAME,\n  DEFAULT_CLAIMS_CONFIGURATIONS,\n  SERVICE_NAME,\n} from './constants.js';\nimport type {\n  Claim,\n  ClaimDraft,\n  ClaimsConfigurations,\n  ClaimsControllerState,\n  CreateClaimRequest,\n  SubmitClaimConfig,\n} from './types.js';\n\nexport type ClaimsControllerGetStateAction = ControllerGetStateAction<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerState\n>;\n\nexport type ClaimsControllerActions =\n  | ClaimsControllerGetStateAction\n  | ClaimsControllerMethodActions;\n\nexport type AllowedActions =\n  | ClaimsServiceFetchClaimsConfigurationsAction\n  | ClaimsServiceGetClaimsAction\n  | ClaimsServiceGetClaimByIdAction\n  | ClaimsServiceGetRequestHeadersAction\n  | ClaimsServiceGetClaimsApiUrlAction\n  | ClaimsServiceGenerateMessageForClaimSignatureAction\n  | ClaimsServiceGetClaimsAction\n  | KeyringControllerSignPersonalMessageAction;\n\nexport type ClaimsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerState\n>;\n\nexport type ClaimsControllerMessenger = Messenger<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerActions | AllowedActions,\n  ClaimsControllerStateChangeEvent\n>;\n\nexport type ClaimsControllerOptions = {\n  messenger: ClaimsControllerMessenger;\n  state?: Partial<ClaimsControllerState>;\n};\n\nconst ClaimsControllerStateMetadata: StateMetadata<ClaimsControllerState> = {\n  claims: {\n    includeInStateLogs: false,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n  claimsConfigurations: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  drafts: {\n    includeInStateLogs: false,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n};\n\n/**\n * Get an initial default state for the controller.\n *\n * @returns The initial default controller state.\n */\nexport function getDefaultClaimsControllerState(): ClaimsControllerState {\n  return {\n    claimsConfigurations: DEFAULT_CLAIMS_CONFIGURATIONS,\n    claims: [],\n    drafts: [],\n  };\n}\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'fetchClaimsConfigurations',\n  'getSubmitClaimConfig',\n  'generateClaimSignature',\n  'getClaims',\n  'saveOrUpdateClaimDraft',\n  'getClaimDrafts',\n  'deleteClaimDraft',\n  'deleteAllClaimDrafts',\n  'clearState',\n] as const;\n\nexport class ClaimsController extends BaseController<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerState,\n  ClaimsControllerMessenger\n> {\n  constructor({ messenger, state }: ClaimsControllerOptions) {\n    super({\n      messenger,\n      metadata: ClaimsControllerStateMetadata,\n      name: CONTROLLER_NAME,\n      state: { ...getDefaultClaimsControllerState(), ...state },\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Fetch the required configurations for the claims service.\n   *\n   * @returns The required configurations for the claims service.\n   */\n  async fetchClaimsConfigurations(): Promise<ClaimsConfigurations> {\n    const configurations = await this.messenger.call(\n      `${SERVICE_NAME}:fetchClaimsConfigurations`,\n    );\n\n    const supportedNetworks = configurations.networks.map((network) =>\n      toHex(network),\n    );\n    const claimsConfigurations = {\n      validSubmissionWindowDays: configurations.validSubmissionWindowDays,\n      supportedNetworks,\n    };\n\n    this.update((state) => {\n      state.claimsConfigurations = claimsConfigurations;\n    });\n    return claimsConfigurations;\n  }\n\n  /**\n   * Get required config for submitting a claim.\n   *\n   * @param claim - The claim request to get the required config for.\n   * @returns The required config for submitting the claim.\n   */\n  async getSubmitClaimConfig(\n    claim: CreateClaimRequest,\n  ): Promise<SubmitClaimConfig> {\n    // Validate the claim before submitting it.\n    this.#validateSubmitClaimRequest(claim);\n\n    const headers = await this.messenger.call(\n      `${SERVICE_NAME}:getRequestHeaders`,\n    );\n    const baseUrl = this.messenger.call(`${SERVICE_NAME}:getClaimsApiUrl`);\n    const url = `${baseUrl}/claims`;\n\n    return {\n      data: claim,\n      headers,\n      method: 'POST',\n      url,\n    };\n  }\n\n  /**\n   * Generate a signature for a claim.\n   *\n   * @param chainId - The chain id of the claim.\n   * @param walletAddress - The impacted wallet address of the claim.\n   * @returns The signature for the claim.\n   */\n  async generateClaimSignature(\n    chainId: number,\n    walletAddress: `0x${string}`,\n  ): Promise<string> {\n    // generate the message to be signed\n    const { message } = await this.messenger.call(\n      `${SERVICE_NAME}:generateMessageForClaimSignature`,\n      chainId,\n      walletAddress,\n    );\n\n    // generate and parse the SIWE message\n    const messageBytes = stringToBytes(message);\n    const messageHex = bytesToHex(messageBytes);\n    const siwe = detectSIWE({ data: messageHex });\n    if (!siwe.isSIWEMessage) {\n      throw new Error(ClaimsControllerErrorMessages.INVALID_SIGNATURE_MESSAGE);\n    }\n\n    // sign the message\n    const signature = await this.messenger.call(\n      'KeyringController:signPersonalMessage',\n      {\n        data: message,\n        from: walletAddress,\n        siwe,\n      },\n    );\n\n    return signature;\n  }\n\n  /**\n   * Get the list of claims for the current user.\n   *\n   * @returns The list of claims for the current user.\n   */\n  async getClaims(): Promise<Claim[]> {\n    const claims = await this.messenger.call(`${SERVICE_NAME}:getClaims`);\n    this.update((state) => {\n      state.claims = claims;\n    });\n    return claims;\n  }\n\n  /**\n   * Save a claim draft to the state.\n   * If the draft name is not provided, a default name will be generated.\n   * If the draft with the same id already exists, it will be updated.\n   *\n   * @param draft - The draft to save.\n   * @returns The saved draft.\n   */\n  saveOrUpdateClaimDraft(draft: Partial<ClaimDraft>): ClaimDraft {\n    const { drafts } = this.state;\n\n    const isExistingDraft = drafts.some(\n      (existingDraft) =>\n        draft.draftId && existingDraft.draftId === draft.draftId,\n    );\n\n    if (isExistingDraft) {\n      const updatedAt = new Date().toISOString();\n      this.update((state) => {\n        state.drafts = state.drafts.map((existingDraft) =>\n          existingDraft.draftId === draft.draftId\n            ? {\n                ...existingDraft,\n                ...draft,\n                updatedAt,\n              }\n            : existingDraft,\n        );\n      });\n      return { ...draft, updatedAt } as ClaimDraft;\n    }\n\n    // generate a new draft id, name and add it to the state\n    const draftId = `draft-${Date.now()}`;\n\n    const newDraft: ClaimDraft = {\n      ...draft,\n      draftId,\n      updatedAt: new Date().toISOString(),\n    };\n\n    this.update((state) => {\n      state.drafts.push(newDraft);\n    });\n\n    return newDraft;\n  }\n\n  /**\n   * Get the list of claim drafts.\n   *\n   * @returns The list of claim drafts.\n   */\n  getClaimDrafts(): ClaimDraft[] {\n    return this.state.drafts;\n  }\n\n  /**\n   * Delete a claim draft from the state.\n   *\n   * @param draftId - The ID of the draft to delete.\n   */\n  deleteClaimDraft(draftId: string): void {\n    this.update((state) => {\n      state.drafts = state.drafts.filter((draft) => draft.draftId !== draftId);\n    });\n  }\n\n  /**\n   * Delete all claim drafts from the state.\n   */\n  deleteAllClaimDrafts(): void {\n    this.update((state) => {\n      state.drafts = [];\n    });\n  }\n\n  /**\n   * Clears the claims state and resets to default values.\n   */\n  clearState(): void {\n    this.update(() => {\n      return getDefaultClaimsControllerState();\n    });\n  }\n\n  /**\n   * Validate the claim before submitting it.\n   *\n   * @param claim - The claim to validate.\n   */\n  #validateSubmitClaimRequest(claim: CreateClaimRequest): void {\n    const { claims: existingClaims } = this.state;\n    const isClaimAlreadySubmitted = existingClaims.some(\n      (existingClaim) => existingClaim.impactedTxHash === claim.impactedTxHash,\n    );\n    if (isClaimAlreadySubmitted) {\n      throw new Error(ClaimsControllerErrorMessages.CLAIM_ALREADY_SUBMITTED);\n    }\n  }\n}\n"]}

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

@@ -1,11 +1,11 @@
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
-import type { KeyringControllerSignPersonalMessageAction } from '@metamask/keyring-controller';
-import type { Messenger } from '@metamask/messenger';
-import type { ClaimsControllerMethodActions } from './ClaimsController-method-action-types.js';
-import type { ClaimsServiceFetchClaimsConfigurationsAction, ClaimsServiceGenerateMessageForClaimSignatureAction, ClaimsServiceGetClaimByIdAction, ClaimsServiceGetClaimsAction, ClaimsServiceGetClaimsApiUrlAction, ClaimsServiceGetRequestHeadersAction } from './ClaimsService-method-action-types.js';
-import { CONTROLLER_NAME } from './constants.js';
-import type { Claim, ClaimDraft, ClaimsConfigurations, ClaimsControllerState, CreateClaimRequest, SubmitClaimConfig } from './types.js';
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { KeyringControllerSignPersonalMessageAction } from "@metamask/keyring-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { ClaimsControllerMethodActions } from "./ClaimsController-method-action-types.cjs";
+import type { ClaimsServiceFetchClaimsConfigurationsAction, ClaimsServiceGenerateMessageForClaimSignatureAction, ClaimsServiceGetClaimByIdAction, ClaimsServiceGetClaimsAction, ClaimsServiceGetClaimsApiUrlAction, ClaimsServiceGetRequestHeadersAction } from "./ClaimsService-method-action-types.cjs";
+import { CONTROLLER_NAME } from "./constants.cjs";
+import type { Claim, ClaimDraft, ClaimsConfigurations, ClaimsControllerState, CreateClaimRequest, SubmitClaimConfig } from "./types.cjs";
 export type ClaimsControllerGetStateAction = ControllerGetStateAction<typeof CONTROLLER_NAME, ClaimsControllerState>;
 export type ClaimsControllerActions = ClaimsControllerGetStateAction | ClaimsControllerMethodActions;
 export type AllowedActions = ClaimsServiceFetchClaimsConfigurationsAction | ClaimsServiceGetClaimsAction | ClaimsServiceGetClaimByIdAction | ClaimsServiceGetRequestHeadersAction | ClaimsServiceGetClaimsApiUrlAction | ClaimsServiceGenerateMessageForClaimSignatureAction | ClaimsServiceGetClaimsAction | KeyringControllerSignPersonalMessageAction;
@@ -81,4 +81,4 @@ export declare class ClaimsController extends BaseController<typeof CONTROLLER_N
      */
     clearState(): void;
 }
-//# sourceMappingURL=ClaimsController.d.ts.map
+//# sourceMappingURL=ClaimsController.d.cts.map

package/dist/ClaimsController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsController.d.cts","sourceRoot":"","sources":["../src/ClaimsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,0CAA0C,EAAE,qCAAqC;AAC/F,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EAAE,6BAA6B,EAAE,mDAAkD;AAC/F,OAAO,KAAK,EACV,4CAA4C,EAC5C,mDAAmD,EACnD,+BAA+B,EAC/B,4BAA4B,EAC5B,kCAAkC,EAClC,oCAAoC,EACrC,gDAA+C;AAChD,OAAO,EAEL,eAAe,EAGhB,wBAAuB;AACxB,OAAO,KAAK,EACV,KAAK,EACL,UAAU,EACV,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EAClB,oBAAmB;AAEpB,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,eAAe,EACtB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,8BAA8B,GAC9B,6BAA6B,CAAC;AAElC,MAAM,MAAM,cAAc,GACtB,4CAA4C,GAC5C,4BAA4B,GAC5B,+BAA+B,GAC/B,oCAAoC,GACpC,kCAAkC,GAClC,mDAAmD,GACnD,4BAA4B,GAC5B,0CAA0C,CAAC;AAE/C,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,eAAe,EACtB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,OAAO,eAAe,EACtB,uBAAuB,GAAG,cAAc,EACxC,gCAAgC,CACjC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACxC,CAAC;AAuBF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAMvE;AAcD,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,eAAe,EACtB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBACa,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,uBAAuB;IAczD;;;;OAIG;IACG,yBAAyB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAmBhE;;;;;OAKG;IACG,oBAAoB,CACxB,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAkB7B;;;;;;OAMG;IACG,sBAAsB,CAC1B,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,KAAK,MAAM,EAAE,GAC3B,OAAO,CAAC,MAAM,CAAC;IA6BlB;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAQnC;;;;;;;OAOG;IACH,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU;IAwC9D;;;;OAIG;IACH,cAAc,IAAI,UAAU,EAAE;IAI9B;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMvC;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAM5B;;OAEG;IACH,UAAU,IAAI,IAAI;CAoBnB"}

package/dist/ClaimsController.d.mts

@@ -0,0 +1,84 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { KeyringControllerSignPersonalMessageAction } from "@metamask/keyring-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { ClaimsControllerMethodActions } from "./ClaimsController-method-action-types.mjs";
+import type { ClaimsServiceFetchClaimsConfigurationsAction, ClaimsServiceGenerateMessageForClaimSignatureAction, ClaimsServiceGetClaimByIdAction, ClaimsServiceGetClaimsAction, ClaimsServiceGetClaimsApiUrlAction, ClaimsServiceGetRequestHeadersAction } from "./ClaimsService-method-action-types.mjs";
+import { CONTROLLER_NAME } from "./constants.mjs";
+import type { Claim, ClaimDraft, ClaimsConfigurations, ClaimsControllerState, CreateClaimRequest, SubmitClaimConfig } from "./types.mjs";
+export type ClaimsControllerGetStateAction = ControllerGetStateAction<typeof CONTROLLER_NAME, ClaimsControllerState>;
+export type ClaimsControllerActions = ClaimsControllerGetStateAction | ClaimsControllerMethodActions;
+export type AllowedActions = ClaimsServiceFetchClaimsConfigurationsAction | ClaimsServiceGetClaimsAction | ClaimsServiceGetClaimByIdAction | ClaimsServiceGetRequestHeadersAction | ClaimsServiceGetClaimsApiUrlAction | ClaimsServiceGenerateMessageForClaimSignatureAction | ClaimsServiceGetClaimsAction | KeyringControllerSignPersonalMessageAction;
+export type ClaimsControllerStateChangeEvent = ControllerStateChangeEvent<typeof CONTROLLER_NAME, ClaimsControllerState>;
+export type ClaimsControllerMessenger = Messenger<typeof CONTROLLER_NAME, ClaimsControllerActions | AllowedActions, ClaimsControllerStateChangeEvent>;
+export type ClaimsControllerOptions = {
+    messenger: ClaimsControllerMessenger;
+    state?: Partial<ClaimsControllerState>;
+};
+/**
+ * Get an initial default state for the controller.
+ *
+ * @returns The initial default controller state.
+ */
+export declare function getDefaultClaimsControllerState(): ClaimsControllerState;
+export declare class ClaimsController extends BaseController<typeof CONTROLLER_NAME, ClaimsControllerState, ClaimsControllerMessenger> {
+    #private;
+    constructor({ messenger, state }: ClaimsControllerOptions);
+    /**
+     * Fetch the required configurations for the claims service.
+     *
+     * @returns The required configurations for the claims service.
+     */
+    fetchClaimsConfigurations(): Promise<ClaimsConfigurations>;
+    /**
+     * Get required config for submitting a claim.
+     *
+     * @param claim - The claim request to get the required config for.
+     * @returns The required config for submitting the claim.
+     */
+    getSubmitClaimConfig(claim: CreateClaimRequest): Promise<SubmitClaimConfig>;
+    /**
+     * Generate a signature for a claim.
+     *
+     * @param chainId - The chain id of the claim.
+     * @param walletAddress - The impacted wallet address of the claim.
+     * @returns The signature for the claim.
+     */
+    generateClaimSignature(chainId: number, walletAddress: `0x${string}`): Promise<string>;
+    /**
+     * Get the list of claims for the current user.
+     *
+     * @returns The list of claims for the current user.
+     */
+    getClaims(): Promise<Claim[]>;
+    /**
+     * Save a claim draft to the state.
+     * If the draft name is not provided, a default name will be generated.
+     * If the draft with the same id already exists, it will be updated.
+     *
+     * @param draft - The draft to save.
+     * @returns The saved draft.
+     */
+    saveOrUpdateClaimDraft(draft: Partial<ClaimDraft>): ClaimDraft;
+    /**
+     * Get the list of claim drafts.
+     *
+     * @returns The list of claim drafts.
+     */
+    getClaimDrafts(): ClaimDraft[];
+    /**
+     * Delete a claim draft from the state.
+     *
+     * @param draftId - The ID of the draft to delete.
+     */
+    deleteClaimDraft(draftId: string): void;
+    /**
+     * Delete all claim drafts from the state.
+     */
+    deleteAllClaimDrafts(): void;
+    /**
+     * Clears the claims state and resets to default values.
+     */
+    clearState(): void;
+}
+//# sourceMappingURL=ClaimsController.d.mts.map

package/dist/ClaimsController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsController.d.mts","sourceRoot":"","sources":["../src/ClaimsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,0CAA0C,EAAE,qCAAqC;AAC/F,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EAAE,6BAA6B,EAAE,mDAAkD;AAC/F,OAAO,KAAK,EACV,4CAA4C,EAC5C,mDAAmD,EACnD,+BAA+B,EAC/B,4BAA4B,EAC5B,kCAAkC,EAClC,oCAAoC,EACrC,gDAA+C;AAChD,OAAO,EAEL,eAAe,EAGhB,wBAAuB;AACxB,OAAO,KAAK,EACV,KAAK,EACL,UAAU,EACV,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EAClB,oBAAmB;AAEpB,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,eAAe,EACtB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,8BAA8B,GAC9B,6BAA6B,CAAC;AAElC,MAAM,MAAM,cAAc,GACtB,4CAA4C,GAC5C,4BAA4B,GAC5B,+BAA+B,GAC/B,oCAAoC,GACpC,kCAAkC,GAClC,mDAAmD,GACnD,4BAA4B,GAC5B,0CAA0C,CAAC;AAE/C,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,eAAe,EACtB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,OAAO,eAAe,EACtB,uBAAuB,GAAG,cAAc,EACxC,gCAAgC,CACjC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACxC,CAAC;AAuBF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAMvE;AAcD,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,eAAe,EACtB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBACa,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,uBAAuB;IAczD;;;;OAIG;IACG,yBAAyB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAmBhE;;;;;OAKG;IACG,oBAAoB,CACxB,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAkB7B;;;;;;OAMG;IACG,sBAAsB,CAC1B,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,KAAK,MAAM,EAAE,GAC3B,OAAO,CAAC,MAAM,CAAC;IA6BlB;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAQnC;;;;;;;OAOG;IACH,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU;IAwC9D;;;;OAIG;IACH,cAAc,IAAI,UAAU,EAAE;IAI9B;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMvC;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAM5B;;OAEG;IACH,UAAU,IAAI,IAAI;CAoBnB"}

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

@@ -4,10 +4,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ClaimsController_instances, _ClaimsController_validateSubmitClaimRequest;
-import { BaseController } from '@metamask/base-controller';
-import { detectSIWE, toHex } from '@metamask/controller-utils';
-import { bytesToHex, stringToBytes } from '@metamask/utils';
-import { ClaimsControllerErrorMessages, CONTROLLER_NAME, DEFAULT_CLAIMS_CONFIGURATIONS, SERVICE_NAME, } from './constants.js';
+import { BaseController } from "@metamask/base-controller";
+import { detectSIWE, toHex } from "@metamask/controller-utils";
+import { bytesToHex, stringToBytes } from "@metamask/utils";
+import { ClaimsControllerErrorMessages, CONTROLLER_NAME, DEFAULT_CLAIMS_CONFIGURATIONS, SERVICE_NAME } from "./constants.mjs";
 const ClaimsControllerStateMetadata = {
     claims: {
         includeInStateLogs: false,
@@ -213,4 +213,4 @@ _ClaimsController_instances = new WeakSet(), _ClaimsController_validateSubmitCla
         throw new Error(ClaimsControllerErrorMessages.CLAIM_ALREADY_SUBMITTED);
     }
 };
-//# sourceMappingURL=ClaimsController.js.map
+//# sourceMappingURL=ClaimsController.mjs.map

package/dist/ClaimsController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsController.mjs","sourceRoot":"","sources":["../src/ClaimsController.ts"],"names":[],"mappings":";;;;;;AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,mCAAmC;AAG/D,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,wBAAwB;AAW5D,OAAO,EACL,6BAA6B,EAC7B,eAAe,EACf,6BAA6B,EAC7B,YAAY,EACb,wBAAuB;AA6CxB,MAAM,6BAA6B,GAAyC;IAC1E,MAAM,EAAE;QACN,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;IACD,oBAAoB,EAAE;QACpB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,MAAM,EAAE;QACN,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,+BAA+B;IAC7C,OAAO;QACL,oBAAoB,EAAE,6BAA6B;QACnD,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,EAAE;KACX,CAAC;AACJ,CAAC;AAED,MAAM,yBAAyB,GAAG;IAChC,2BAA2B;IAC3B,sBAAsB;IACtB,wBAAwB;IACxB,WAAW;IACX,wBAAwB;IACxB,gBAAgB;IAChB,kBAAkB;IAClB,sBAAsB;IACtB,YAAY;CACJ,CAAC;AAEX,MAAM,OAAO,gBAAiB,SAAQ,cAIrC;IACC,YAAY,EAAE,SAAS,EAAE,KAAK,EAA2B;QACvD,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,6BAA6B;YACvC,IAAI,EAAE,eAAe;YACrB,KAAK,EAAE,EAAE,GAAG,+BAA+B,EAAE,EAAE,GAAG,KAAK,EAAE;SAC1D,CAAC,CAAC;;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,yBAAyB;QAC7B,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9C,GAAG,YAAY,4BAA4B,CAC5C,CAAC;QAEF,MAAM,iBAAiB,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAChE,KAAK,CAAC,OAAO,CAAC,CACf,CAAC;QACF,MAAM,oBAAoB,GAAG;YAC3B,yBAAyB,EAAE,cAAc,CAAC,yBAAyB;YACnE,iBAAiB;SAClB,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,KAAyB;QAEzB,2CAA2C;QAC3C,uBAAA,IAAI,iFAA4B,MAAhC,IAAI,EAA6B,KAAK,CAAC,CAAC;QAExC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACvC,GAAG,YAAY,oBAAoB,CACpC,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,YAAY,kBAAkB,CAAC,CAAC;QACvE,MAAM,GAAG,GAAG,GAAG,OAAO,SAAS,CAAC;QAEhC,OAAO;YACL,IAAI,EAAE,KAAK;YACX,OAAO;YACP,MAAM,EAAE,MAAM;YACd,GAAG;SACJ,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAe,EACf,aAA4B;QAE5B,oCAAoC;QACpC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC3C,GAAG,YAAY,mCAAmC,EAClD,OAAO,EACP,aAAa,CACd,CAAC;QAEF,sCAAsC;QACtC,MAAM,YAAY,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;QAC5C,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,yBAAyB,CAAC,CAAC;QAC3E,CAAC;QAED,mBAAmB;QACnB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACzC,uCAAuC,EACvC;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,aAAa;YACnB,IAAI;SACL,CACF,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,YAAY,YAAY,CAAC,CAAC;QACtE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CAAC,KAA0B;QAC/C,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAE9B,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CACjC,CAAC,aAAa,EAAE,EAAE,CAChB,KAAK,CAAC,OAAO,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAC3D,CAAC;QAEF,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAChD,aAAa,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;oBACrC,CAAC,CAAC;wBACE,GAAG,aAAa;wBAChB,GAAG,KAAK;wBACR,SAAS;qBACV;oBACH,CAAC,CAAC,aAAa,CAClB,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,OAAO,EAAE,GAAG,KAAK,EAAE,SAAS,EAAgB,CAAC;QAC/C,CAAC;QAED,wDAAwD;QACxD,MAAM,OAAO,GAAG,SAAS,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QAEtC,MAAM,QAAQ,GAAe;YAC3B,GAAG,KAAK;YACR,OAAO;YACP,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;SACpC,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,OAAe;QAC9B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,OAAO,+BAA+B,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;CAgBF;kJAT6B,KAAyB;IACnD,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;IAC9C,MAAM,uBAAuB,GAAG,cAAc,CAAC,IAAI,CACjD,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,CACzE,CAAC;IACF,IAAI,uBAAuB,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,uBAAuB,CAAC,CAAC;IACzE,CAAC;AACH,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { detectSIWE, toHex } from '@metamask/controller-utils';\nimport type { KeyringControllerSignPersonalMessageAction } from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { bytesToHex, stringToBytes } from '@metamask/utils';\n\nimport type { ClaimsControllerMethodActions } from './ClaimsController-method-action-types.js';\nimport type {\n  ClaimsServiceFetchClaimsConfigurationsAction,\n  ClaimsServiceGenerateMessageForClaimSignatureAction,\n  ClaimsServiceGetClaimByIdAction,\n  ClaimsServiceGetClaimsAction,\n  ClaimsServiceGetClaimsApiUrlAction,\n  ClaimsServiceGetRequestHeadersAction,\n} from './ClaimsService-method-action-types.js';\nimport {\n  ClaimsControllerErrorMessages,\n  CONTROLLER_NAME,\n  DEFAULT_CLAIMS_CONFIGURATIONS,\n  SERVICE_NAME,\n} from './constants.js';\nimport type {\n  Claim,\n  ClaimDraft,\n  ClaimsConfigurations,\n  ClaimsControllerState,\n  CreateClaimRequest,\n  SubmitClaimConfig,\n} from './types.js';\n\nexport type ClaimsControllerGetStateAction = ControllerGetStateAction<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerState\n>;\n\nexport type ClaimsControllerActions =\n  | ClaimsControllerGetStateAction\n  | ClaimsControllerMethodActions;\n\nexport type AllowedActions =\n  | ClaimsServiceFetchClaimsConfigurationsAction\n  | ClaimsServiceGetClaimsAction\n  | ClaimsServiceGetClaimByIdAction\n  | ClaimsServiceGetRequestHeadersAction\n  | ClaimsServiceGetClaimsApiUrlAction\n  | ClaimsServiceGenerateMessageForClaimSignatureAction\n  | ClaimsServiceGetClaimsAction\n  | KeyringControllerSignPersonalMessageAction;\n\nexport type ClaimsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerState\n>;\n\nexport type ClaimsControllerMessenger = Messenger<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerActions | AllowedActions,\n  ClaimsControllerStateChangeEvent\n>;\n\nexport type ClaimsControllerOptions = {\n  messenger: ClaimsControllerMessenger;\n  state?: Partial<ClaimsControllerState>;\n};\n\nconst ClaimsControllerStateMetadata: StateMetadata<ClaimsControllerState> = {\n  claims: {\n    includeInStateLogs: false,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n  claimsConfigurations: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  drafts: {\n    includeInStateLogs: false,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n};\n\n/**\n * Get an initial default state for the controller.\n *\n * @returns The initial default controller state.\n */\nexport function getDefaultClaimsControllerState(): ClaimsControllerState {\n  return {\n    claimsConfigurations: DEFAULT_CLAIMS_CONFIGURATIONS,\n    claims: [],\n    drafts: [],\n  };\n}\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'fetchClaimsConfigurations',\n  'getSubmitClaimConfig',\n  'generateClaimSignature',\n  'getClaims',\n  'saveOrUpdateClaimDraft',\n  'getClaimDrafts',\n  'deleteClaimDraft',\n  'deleteAllClaimDrafts',\n  'clearState',\n] as const;\n\nexport class ClaimsController extends BaseController<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerState,\n  ClaimsControllerMessenger\n> {\n  constructor({ messenger, state }: ClaimsControllerOptions) {\n    super({\n      messenger,\n      metadata: ClaimsControllerStateMetadata,\n      name: CONTROLLER_NAME,\n      state: { ...getDefaultClaimsControllerState(), ...state },\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Fetch the required configurations for the claims service.\n   *\n   * @returns The required configurations for the claims service.\n   */\n  async fetchClaimsConfigurations(): Promise<ClaimsConfigurations> {\n    const configurations = await this.messenger.call(\n      `${SERVICE_NAME}:fetchClaimsConfigurations`,\n    );\n\n    const supportedNetworks = configurations.networks.map((network) =>\n      toHex(network),\n    );\n    const claimsConfigurations = {\n      validSubmissionWindowDays: configurations.validSubmissionWindowDays,\n      supportedNetworks,\n    };\n\n    this.update((state) => {\n      state.claimsConfigurations = claimsConfigurations;\n    });\n    return claimsConfigurations;\n  }\n\n  /**\n   * Get required config for submitting a claim.\n   *\n   * @param claim - The claim request to get the required config for.\n   * @returns The required config for submitting the claim.\n   */\n  async getSubmitClaimConfig(\n    claim: CreateClaimRequest,\n  ): Promise<SubmitClaimConfig> {\n    // Validate the claim before submitting it.\n    this.#validateSubmitClaimRequest(claim);\n\n    const headers = await this.messenger.call(\n      `${SERVICE_NAME}:getRequestHeaders`,\n    );\n    const baseUrl = this.messenger.call(`${SERVICE_NAME}:getClaimsApiUrl`);\n    const url = `${baseUrl}/claims`;\n\n    return {\n      data: claim,\n      headers,\n      method: 'POST',\n      url,\n    };\n  }\n\n  /**\n   * Generate a signature for a claim.\n   *\n   * @param chainId - The chain id of the claim.\n   * @param walletAddress - The impacted wallet address of the claim.\n   * @returns The signature for the claim.\n   */\n  async generateClaimSignature(\n    chainId: number,\n    walletAddress: `0x${string}`,\n  ): Promise<string> {\n    // generate the message to be signed\n    const { message } = await this.messenger.call(\n      `${SERVICE_NAME}:generateMessageForClaimSignature`,\n      chainId,\n      walletAddress,\n    );\n\n    // generate and parse the SIWE message\n    const messageBytes = stringToBytes(message);\n    const messageHex = bytesToHex(messageBytes);\n    const siwe = detectSIWE({ data: messageHex });\n    if (!siwe.isSIWEMessage) {\n      throw new Error(ClaimsControllerErrorMessages.INVALID_SIGNATURE_MESSAGE);\n    }\n\n    // sign the message\n    const signature = await this.messenger.call(\n      'KeyringController:signPersonalMessage',\n      {\n        data: message,\n        from: walletAddress,\n        siwe,\n      },\n    );\n\n    return signature;\n  }\n\n  /**\n   * Get the list of claims for the current user.\n   *\n   * @returns The list of claims for the current user.\n   */\n  async getClaims(): Promise<Claim[]> {\n    const claims = await this.messenger.call(`${SERVICE_NAME}:getClaims`);\n    this.update((state) => {\n      state.claims = claims;\n    });\n    return claims;\n  }\n\n  /**\n   * Save a claim draft to the state.\n   * If the draft name is not provided, a default name will be generated.\n   * If the draft with the same id already exists, it will be updated.\n   *\n   * @param draft - The draft to save.\n   * @returns The saved draft.\n   */\n  saveOrUpdateClaimDraft(draft: Partial<ClaimDraft>): ClaimDraft {\n    const { drafts } = this.state;\n\n    const isExistingDraft = drafts.some(\n      (existingDraft) =>\n        draft.draftId && existingDraft.draftId === draft.draftId,\n    );\n\n    if (isExistingDraft) {\n      const updatedAt = new Date().toISOString();\n      this.update((state) => {\n        state.drafts = state.drafts.map((existingDraft) =>\n          existingDraft.draftId === draft.draftId\n            ? {\n                ...existingDraft,\n                ...draft,\n                updatedAt,\n              }\n            : existingDraft,\n        );\n      });\n      return { ...draft, updatedAt } as ClaimDraft;\n    }\n\n    // generate a new draft id, name and add it to the state\n    const draftId = `draft-${Date.now()}`;\n\n    const newDraft: ClaimDraft = {\n      ...draft,\n      draftId,\n      updatedAt: new Date().toISOString(),\n    };\n\n    this.update((state) => {\n      state.drafts.push(newDraft);\n    });\n\n    return newDraft;\n  }\n\n  /**\n   * Get the list of claim drafts.\n   *\n   * @returns The list of claim drafts.\n   */\n  getClaimDrafts(): ClaimDraft[] {\n    return this.state.drafts;\n  }\n\n  /**\n   * Delete a claim draft from the state.\n   *\n   * @param draftId - The ID of the draft to delete.\n   */\n  deleteClaimDraft(draftId: string): void {\n    this.update((state) => {\n      state.drafts = state.drafts.filter((draft) => draft.draftId !== draftId);\n    });\n  }\n\n  /**\n   * Delete all claim drafts from the state.\n   */\n  deleteAllClaimDrafts(): void {\n    this.update((state) => {\n      state.drafts = [];\n    });\n  }\n\n  /**\n   * Clears the claims state and resets to default values.\n   */\n  clearState(): void {\n    this.update(() => {\n      return getDefaultClaimsControllerState();\n    });\n  }\n\n  /**\n   * Validate the claim before submitting it.\n   *\n   * @param claim - The claim to validate.\n   */\n  #validateSubmitClaimRequest(claim: CreateClaimRequest): void {\n    const { claims: existingClaims } = this.state;\n    const isClaimAlreadySubmitted = existingClaims.some(\n      (existingClaim) => existingClaim.impactedTxHash === claim.impactedTxHash,\n    );\n    if (isClaimAlreadySubmitted) {\n      throw new Error(ClaimsControllerErrorMessages.CLAIM_ALREADY_SUBMITTED);\n    }\n  }\n}\n"]}

package/dist/ClaimsService-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=ClaimsService-method-action-types.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsService-method-action-types.cjs","sourceRoot":"","sources":["../src/ClaimsService-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { ClaimsService } from './ClaimsService.js';\n\n/**\n * Fetch required configurations for the claims service.\n *\n * @returns The required configurations for the claims service.\n */\nexport type ClaimsServiceFetchClaimsConfigurationsAction = {\n  type: `ClaimsService:fetchClaimsConfigurations`;\n  handler: ClaimsService['fetchClaimsConfigurations'];\n};\n\n/**\n * Get the claims for the current user.\n *\n * @returns The claims for the current user.\n */\nexport type ClaimsServiceGetClaimsAction = {\n  type: `ClaimsService:getClaims`;\n  handler: ClaimsService['getClaims'];\n};\n\n/**\n * Get the claim by id.\n *\n * @param id - The id of the claim to get.\n * @returns The claim by id.\n */\nexport type ClaimsServiceGetClaimByIdAction = {\n  type: `ClaimsService:getClaimById`;\n  handler: ClaimsService['getClaimById'];\n};\n\n/**\n * Generate a message to be signed by the user for the claim request.\n *\n * @param chainId - The chain id of the claim.\n * @param walletAddress - The impacted wallet address of the claim.\n * @returns The message for the claim signature.\n */\nexport type ClaimsServiceGenerateMessageForClaimSignatureAction = {\n  type: `ClaimsService:generateMessageForClaimSignature`;\n  handler: ClaimsService['generateMessageForClaimSignature'];\n};\n\n/**\n * Create the headers for the current request.\n *\n * @returns The headers for the current request.\n */\nexport type ClaimsServiceGetRequestHeadersAction = {\n  type: `ClaimsService:getRequestHeaders`;\n  handler: ClaimsService['getRequestHeaders'];\n};\n\n/**\n * Get the URL for the claims API for the current environment.\n *\n * @returns The URL for the claims API for the current environment.\n */\nexport type ClaimsServiceGetClaimsApiUrlAction = {\n  type: `ClaimsService:getClaimsApiUrl`;\n  handler: ClaimsService['getClaimsApiUrl'];\n};\n\n/**\n * Union of all ClaimsService action types.\n */\nexport type ClaimsServiceMethodActions =\n  | ClaimsServiceFetchClaimsConfigurationsAction\n  | ClaimsServiceGetClaimsAction\n  | ClaimsServiceGetClaimByIdAction\n  | ClaimsServiceGenerateMessageForClaimSignatureAction\n  | ClaimsServiceGetRequestHeadersAction\n  | ClaimsServiceGetClaimsApiUrlAction;\n"]}

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

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { ClaimsService } from './ClaimsService.js';
+import type { ClaimsService } from "./ClaimsService.cjs";
 /**
  * Fetch required configurations for the claims service.
  *
@@ -64,4 +64,4 @@ export type ClaimsServiceGetClaimsApiUrlAction = {
  * Union of all ClaimsService action types.
  */
 export type ClaimsServiceMethodActions = ClaimsServiceFetchClaimsConfigurationsAction | ClaimsServiceGetClaimsAction | ClaimsServiceGetClaimByIdAction | ClaimsServiceGenerateMessageForClaimSignatureAction | ClaimsServiceGetRequestHeadersAction | ClaimsServiceGetClaimsApiUrlAction;
-//# sourceMappingURL=ClaimsService-method-action-types.d.ts.map
+//# sourceMappingURL=ClaimsService-method-action-types.d.cts.map