@metamask-previews/claims-controller 0.0.0-preview-1f85e85a

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Added new `@metamask/claims-controller` package to handle shield subscription claims logics. ([#7072](https://github.com/MetaMask/core/pull/7072))
+- Implementation of `ClaimsController`. ([#7072](https://github.com/MetaMask/core/pull/7072))
+  - `getSubmitClaimConfig`: Generate configurations required for the claim submission.
+  - `generateClaimSignature`: Generate signature for the claim submission.
+- Implementation of Data-Service, `ClaimsService`. ([#7072](https://github.com/MetaMask/core/pull/7072))
+  - `getClaims`: fetch list of users' claims from the backend.
+  - `getClaimById`: fetch single claim by id.
+  - `generateMessageForClaimSignature`: generate message to sign for the claim signature.
+  - `verifyClaimSignature`: verify claim signature produced by user.
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

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

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/claims-controller`
+
+Controller handling shield subscription claims logic
+
+## Installation
+
+`yarn add @metamask/claims-controller`
+
+or
+
+`npm install @metamask/claims-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/ClaimsController.cjs

@@ -0,0 +1,134 @@
+"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 constants_1 = require("./constants.cjs");
+const ClaimsControllerStateMetadata = {
+    claims: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+};
+/**
+ * Get an initial default state for the controller.
+ *
+ * @returns The initial default controller state.
+ */
+function getDefaultClaimsControllerState() {
+    return {
+        claims: [],
+    };
+}
+exports.getDefaultClaimsControllerState = getDefaultClaimsControllerState;
+class ClaimsController extends base_controller_1.BaseController {
+    constructor({ messenger, state }) {
+        super({
+            messenger,
+            metadata: ClaimsControllerStateMetadata,
+            name: constants_1.CONTROLLER_NAME,
+            state: { ...getDefaultClaimsControllerState(), ...state },
+        });
+        _ClaimsController_instances.add(this);
+    }
+    /**
+     * 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_1.SERVICE_NAME}:getRequestHeaders`, constants_1.HttpContentTypeHeader.MULTIPART_FORM_DATA);
+        const baseUrl = this.messenger.call(`${constants_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_1.SERVICE_NAME}:generateMessageForClaimSignature`, chainId, walletAddress);
+        console.log('message', message);
+        // generate and parse the SIWE message
+        const messageHex = textToHex(message);
+        const siwe = (0, controller_utils_1.detectSIWE)({ data: messageHex });
+        if (!siwe.isSIWEMessage) {
+            throw new Error('Invalid Signature message');
+        }
+        // sign the message
+        const signature = await this.messenger.call('KeyringController:signPersonalMessage', {
+            data: message,
+            from: walletAddress,
+            siwe,
+        });
+        console.log('signature', signature);
+        // verify the signature
+        const isSignatureValid = await this.messenger.call(`${constants_1.SERVICE_NAME}:verifyClaimSignature`, signature, walletAddress, message);
+        if (!isSignatureValid) {
+            throw new Error('Invalid signature');
+        }
+        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_1.SERVICE_NAME}:getClaims`);
+        this.update((state) => {
+            state.claims = claims;
+        });
+        return claims;
+    }
+}
+exports.ClaimsController = ClaimsController;
+_ClaimsController_instances = new WeakSet(), _ClaimsController_validateSubmitClaimRequest = function _ClaimsController_validateSubmitClaimRequest(claim) {
+    const { claims: existingClaims } = this.state;
+    const isClaimAlreadySubmitted = existingClaims.some((existingClaim) => existingClaim.email === claim.email &&
+        existingClaim.impactedTxHash === claim.impactedTxHash);
+    if (isClaimAlreadySubmitted) {
+        throw new Error('Claim already submitted');
+    }
+};
+/**
+ * Converts a text string to its hexadecimal representation.
+ *
+ * @param text - The input string.
+ * @returns The hexadecimal representation of the string's UTF-8 bytes.
+ */
+function textToHex(text) {
+    // 1. Encode the string into a Uint8Array (UTF-8 bytes)
+    const encoder = new TextEncoder();
+    const utf8Bytes = encoder.encode(text);
+    // 2. Convert bytes to hex string
+    let hexString = '';
+    for (const byte of utf8Bytes) {
+        // Convert the byte (a number 0-255) to a hexadecimal string
+        const hex = byte.toString(16);
+        // Ensure the hex value is always two characters long by padding with a leading zero
+        hexString += hex.padStart(2, '0');
+    }
+    return `0x${hexString}`;
+}
+//# 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,iEAAwD;AAaxD,+CAIqB;AAyCrB,MAAM,6BAA6B,GAAyC;IAC1E,MAAM,EAAE;QACN,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF;;;;GAIG;AACH,SAAgB,+BAA+B;IAC7C,OAAO;QACL,MAAM,EAAE,EAAE;KACX,CAAC;AACJ,CAAC;AAJD,0EAIC;AAED,MAAa,gBAAiB,SAAQ,gCAIrC;IACC,YAAY,EAAE,SAAS,EAAE,KAAK,EAA2B;QACvD,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,6BAA6B;YACvC,IAAI,EAAE,2BAAe;YACrB,KAAK,EAAE,EAAE,GAAG,+BAA+B,EAAE,EAAE,GAAG,KAAK,EAAE;SAC1D,CAAC,CAAC;;IACL,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,wBAAY,oBAAoB,EACnC,iCAAqB,CAAC,mBAAmB,CAC1C,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,wBAAY,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,wBAAY,mCAAmC,EAClD,OAAO,EACP,aAAa,CACd,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAEhC,sCAAsC;QACtC,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,IAAA,6BAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;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;QACF,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAEpC,uBAAuB;QACvB,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAChD,GAAG,wBAAY,uBAAuB,EACtC,SAAgB,EAChB,aAAa,EACb,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,gBAAgB,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SACtC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,wBAAY,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;CAmBF;AA3HD,4CA2HC;kJAZ6B,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,CAChB,aAAa,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;QACnC,aAAa,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,CAExD,CAAC;IACF,IAAI,uBAAuB,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;AACH,CAAC;AAGH;;;;;GAKG;AACH,SAAS,SAAS,CAAC,IAAY;IAC7B,uDAAuD;IACvD,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEvC,iCAAiC;IACjC,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE;QAC5B,4DAA4D;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAE9B,oFAAoF;QACpF,SAAS,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;KACnC;IAED,OAAO,KAAK,SAAS,EAAE,CAAC;AAC1B,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { detectSIWE } from '@metamask/controller-utils';\nimport type { KeyringControllerSignPersonalMessageAction } from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport type { Hex } from '@metamask/utils';\n\nimport type {\n  ClaimsServiceGenerateMessageForClaimSignatureAction,\n  ClaimsServiceGetClaimByIdAction,\n  ClaimsServiceGetClaimsAction,\n  ClaimsServiceGetClaimsApiUrlAction,\n  ClaimsServiceGetRequestHeadersAction,\n  ClaimsServiceVerifyClaimSignatureAction,\n} from './ClaimsService';\nimport {\n  CONTROLLER_NAME,\n  HttpContentTypeHeader,\n  SERVICE_NAME,\n} from './constants';\nimport type {\n  Claim,\n  ClaimsControllerState,\n  CreateClaimRequest,\n  SubmitClaimConfig,\n} from './types';\n\nexport type ClaimsControllerGetStateAction = ControllerGetStateAction<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerState\n>;\n\nexport type ClaimsControllerActions = ClaimsControllerGetStateAction;\n\nexport type AllowedActions =\n  | ClaimsServiceGetClaimsAction\n  | ClaimsServiceGetClaimByIdAction\n  | ClaimsServiceGetRequestHeadersAction\n  | ClaimsServiceGetClaimsApiUrlAction\n  | ClaimsServiceGenerateMessageForClaimSignatureAction\n  | ClaimsServiceVerifyClaimSignatureAction\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: true,\n    persist: true,\n    includeInDebugSnapshot: true,\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    claims: [],\n  };\n}\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\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      HttpContentTypeHeader.MULTIPART_FORM_DATA,\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    console.log('message', message);\n\n    // generate and parse the SIWE message\n    const messageHex = textToHex(message);\n    const siwe = detectSIWE({ data: messageHex });\n    if (!siwe.isSIWEMessage) {\n      throw new Error('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    console.log('signature', signature);\n\n    // verify the signature\n    const isSignatureValid = await this.messenger.call(\n      `${SERVICE_NAME}:verifyClaimSignature`,\n      signature as Hex,\n      walletAddress,\n      message,\n    );\n\n    if (!isSignatureValid) {\n      throw new Error('Invalid signature');\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   * 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) =>\n        existingClaim.email === claim.email &&\n        existingClaim.impactedTxHash === claim.impactedTxHash,\n      // Question: should we allow users to submit the rejected claim again?\n    );\n    if (isClaimAlreadySubmitted) {\n      throw new Error('Claim already submitted');\n    }\n  }\n}\n\n/**\n * Converts a text string to its hexadecimal representation.\n *\n * @param text - The input string.\n * @returns The hexadecimal representation of the string's UTF-8 bytes.\n */\nfunction textToHex(text: string): Hex {\n  // 1. Encode the string into a Uint8Array (UTF-8 bytes)\n  const encoder = new TextEncoder();\n  const utf8Bytes = encoder.encode(text);\n\n  // 2. Convert bytes to hex string\n  let hexString = '';\n  for (const byte of utf8Bytes) {\n    // Convert the byte (a number 0-255) to a hexadecimal string\n    const hex = byte.toString(16);\n\n    // Ensure the hex value is always two characters long by padding with a leading zero\n    hexString += hex.padStart(2, '0');\n  }\n\n  return `0x${hexString}`;\n}\n"]}

package/dist/ClaimsController.d.cts

@@ -0,0 +1,48 @@
+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 { ClaimsServiceGenerateMessageForClaimSignatureAction, ClaimsServiceGetClaimByIdAction, ClaimsServiceGetClaimsAction, ClaimsServiceGetClaimsApiUrlAction, ClaimsServiceGetRequestHeadersAction, ClaimsServiceVerifyClaimSignatureAction } from "./ClaimsService.cjs";
+import { CONTROLLER_NAME } from "./constants.cjs";
+import type { Claim, ClaimsControllerState, CreateClaimRequest, SubmitClaimConfig } from "./types.cjs";
+export type ClaimsControllerGetStateAction = ControllerGetStateAction<typeof CONTROLLER_NAME, ClaimsControllerState>;
+export type ClaimsControllerActions = ClaimsControllerGetStateAction;
+export type AllowedActions = ClaimsServiceGetClaimsAction | ClaimsServiceGetClaimByIdAction | ClaimsServiceGetRequestHeadersAction | ClaimsServiceGetClaimsApiUrlAction | ClaimsServiceGenerateMessageForClaimSignatureAction | ClaimsServiceVerifyClaimSignatureAction | 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);
+    /**
+     * 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[]>;
+}
+//# 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,EACV,mDAAmD,EACnD,+BAA+B,EAC/B,4BAA4B,EAC5B,kCAAkC,EAClC,oCAAoC,EACpC,uCAAuC,EACxC,4BAAwB;AACzB,OAAO,EACL,eAAe,EAGhB,wBAAoB;AACrB,OAAO,KAAK,EACV,KAAK,EACL,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EAClB,oBAAgB;AAEjB,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,eAAe,EACtB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,8BAA8B,CAAC;AAErE,MAAM,MAAM,cAAc,GACtB,4BAA4B,GAC5B,+BAA+B,GAC/B,oCAAoC,GACpC,kCAAkC,GAClC,mDAAmD,GACnD,uCAAuC,GACvC,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;AAWF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAIvE;AAED,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,eAAe,EACtB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBACa,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,uBAAuB;IASzD;;;;;OAKG;IACG,oBAAoB,CACxB,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAmB7B;;;;;;OAMG;IACG,sBAAsB,CAC1B,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,KAAK,MAAM,EAAE,GAC3B,OAAO,CAAC,MAAM,CAAC;IA0ClB;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;CAyBpC"}

package/dist/ClaimsController.d.mts

@@ -0,0 +1,48 @@
+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 { ClaimsServiceGenerateMessageForClaimSignatureAction, ClaimsServiceGetClaimByIdAction, ClaimsServiceGetClaimsAction, ClaimsServiceGetClaimsApiUrlAction, ClaimsServiceGetRequestHeadersAction, ClaimsServiceVerifyClaimSignatureAction } from "./ClaimsService.mjs";
+import { CONTROLLER_NAME } from "./constants.mjs";
+import type { Claim, ClaimsControllerState, CreateClaimRequest, SubmitClaimConfig } from "./types.mjs";
+export type ClaimsControllerGetStateAction = ControllerGetStateAction<typeof CONTROLLER_NAME, ClaimsControllerState>;
+export type ClaimsControllerActions = ClaimsControllerGetStateAction;
+export type AllowedActions = ClaimsServiceGetClaimsAction | ClaimsServiceGetClaimByIdAction | ClaimsServiceGetRequestHeadersAction | ClaimsServiceGetClaimsApiUrlAction | ClaimsServiceGenerateMessageForClaimSignatureAction | ClaimsServiceVerifyClaimSignatureAction | 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);
+    /**
+     * 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[]>;
+}
+//# 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,EACV,mDAAmD,EACnD,+BAA+B,EAC/B,4BAA4B,EAC5B,kCAAkC,EAClC,oCAAoC,EACpC,uCAAuC,EACxC,4BAAwB;AACzB,OAAO,EACL,eAAe,EAGhB,wBAAoB;AACrB,OAAO,KAAK,EACV,KAAK,EACL,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EAClB,oBAAgB;AAEjB,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,eAAe,EACtB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,8BAA8B,CAAC;AAErE,MAAM,MAAM,cAAc,GACtB,4BAA4B,GAC5B,+BAA+B,GAC/B,oCAAoC,GACpC,kCAAkC,GAClC,mDAAmD,GACnD,uCAAuC,GACvC,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;AAWF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAIvE;AAED,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,eAAe,EACtB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBACa,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,uBAAuB;IASzD;;;;;OAKG;IACG,oBAAoB,CACxB,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAmB7B;;;;;;OAMG;IACG,sBAAsB,CAC1B,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,KAAK,MAAM,EAAE,GAC3B,OAAO,CAAC,MAAM,CAAC;IA0ClB;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;CAyBpC"}

package/dist/ClaimsController.mjs

@@ -0,0 +1,129 @@
+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;
+import { BaseController } from "@metamask/base-controller";
+import { detectSIWE } from "@metamask/controller-utils";
+import { CONTROLLER_NAME, HttpContentTypeHeader, SERVICE_NAME } from "./constants.mjs";
+const ClaimsControllerStateMetadata = {
+    claims: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+};
+/**
+ * Get an initial default state for the controller.
+ *
+ * @returns The initial default controller state.
+ */
+export function getDefaultClaimsControllerState() {
+    return {
+        claims: [],
+    };
+}
+export class ClaimsController extends BaseController {
+    constructor({ messenger, state }) {
+        super({
+            messenger,
+            metadata: ClaimsControllerStateMetadata,
+            name: CONTROLLER_NAME,
+            state: { ...getDefaultClaimsControllerState(), ...state },
+        });
+        _ClaimsController_instances.add(this);
+    }
+    /**
+     * 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(`${SERVICE_NAME}:getRequestHeaders`, HttpContentTypeHeader.MULTIPART_FORM_DATA);
+        const baseUrl = this.messenger.call(`${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(`${SERVICE_NAME}:generateMessageForClaimSignature`, chainId, walletAddress);
+        console.log('message', message);
+        // generate and parse the SIWE message
+        const messageHex = textToHex(message);
+        const siwe = detectSIWE({ data: messageHex });
+        if (!siwe.isSIWEMessage) {
+            throw new Error('Invalid Signature message');
+        }
+        // sign the message
+        const signature = await this.messenger.call('KeyringController:signPersonalMessage', {
+            data: message,
+            from: walletAddress,
+            siwe,
+        });
+        console.log('signature', signature);
+        // verify the signature
+        const isSignatureValid = await this.messenger.call(`${SERVICE_NAME}:verifyClaimSignature`, signature, walletAddress, message);
+        if (!isSignatureValid) {
+            throw new Error('Invalid signature');
+        }
+        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(`${SERVICE_NAME}:getClaims`);
+        this.update((state) => {
+            state.claims = claims;
+        });
+        return claims;
+    }
+}
+_ClaimsController_instances = new WeakSet(), _ClaimsController_validateSubmitClaimRequest = function _ClaimsController_validateSubmitClaimRequest(claim) {
+    const { claims: existingClaims } = this.state;
+    const isClaimAlreadySubmitted = existingClaims.some((existingClaim) => existingClaim.email === claim.email &&
+        existingClaim.impactedTxHash === claim.impactedTxHash);
+    if (isClaimAlreadySubmitted) {
+        throw new Error('Claim already submitted');
+    }
+};
+/**
+ * Converts a text string to its hexadecimal representation.
+ *
+ * @param text - The input string.
+ * @returns The hexadecimal representation of the string's UTF-8 bytes.
+ */
+function textToHex(text) {
+    // 1. Encode the string into a Uint8Array (UTF-8 bytes)
+    const encoder = new TextEncoder();
+    const utf8Bytes = encoder.encode(text);
+    // 2. Convert bytes to hex string
+    let hexString = '';
+    for (const byte of utf8Bytes) {
+        // Convert the byte (a number 0-255) to a hexadecimal string
+        const hex = byte.toString(16);
+        // Ensure the hex value is always two characters long by padding with a leading zero
+        hexString += hex.padStart(2, '0');
+    }
+    return `0x${hexString}`;
+}
+//# 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,mCAAmC;AAaxD,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,YAAY,EACb,wBAAoB;AAyCrB,MAAM,6BAA6B,GAAyC;IAC1E,MAAM,EAAE;QACN,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,+BAA+B;IAC7C,OAAO;QACL,MAAM,EAAE,EAAE;KACX,CAAC;AACJ,CAAC;AAED,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;;IACL,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,EACnC,qBAAqB,CAAC,mBAAmB,CAC1C,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;QACF,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAEhC,sCAAsC;QACtC,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;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;QACF,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAEpC,uBAAuB;QACvB,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAChD,GAAG,YAAY,uBAAuB,EACtC,SAAgB,EAChB,aAAa,EACb,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,gBAAgB,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SACtC;QAED,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;CAmBF;kJAZ6B,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,CAChB,aAAa,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;QACnC,aAAa,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,CAExD,CAAC;IACF,IAAI,uBAAuB,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;AACH,CAAC;AAGH;;;;;GAKG;AACH,SAAS,SAAS,CAAC,IAAY;IAC7B,uDAAuD;IACvD,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEvC,iCAAiC;IACjC,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE;QAC5B,4DAA4D;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAE9B,oFAAoF;QACpF,SAAS,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;KACnC;IAED,OAAO,KAAK,SAAS,EAAE,CAAC;AAC1B,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { detectSIWE } from '@metamask/controller-utils';\nimport type { KeyringControllerSignPersonalMessageAction } from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport type { Hex } from '@metamask/utils';\n\nimport type {\n  ClaimsServiceGenerateMessageForClaimSignatureAction,\n  ClaimsServiceGetClaimByIdAction,\n  ClaimsServiceGetClaimsAction,\n  ClaimsServiceGetClaimsApiUrlAction,\n  ClaimsServiceGetRequestHeadersAction,\n  ClaimsServiceVerifyClaimSignatureAction,\n} from './ClaimsService';\nimport {\n  CONTROLLER_NAME,\n  HttpContentTypeHeader,\n  SERVICE_NAME,\n} from './constants';\nimport type {\n  Claim,\n  ClaimsControllerState,\n  CreateClaimRequest,\n  SubmitClaimConfig,\n} from './types';\n\nexport type ClaimsControllerGetStateAction = ControllerGetStateAction<\n  typeof CONTROLLER_NAME,\n  ClaimsControllerState\n>;\n\nexport type ClaimsControllerActions = ClaimsControllerGetStateAction;\n\nexport type AllowedActions =\n  | ClaimsServiceGetClaimsAction\n  | ClaimsServiceGetClaimByIdAction\n  | ClaimsServiceGetRequestHeadersAction\n  | ClaimsServiceGetClaimsApiUrlAction\n  | ClaimsServiceGenerateMessageForClaimSignatureAction\n  | ClaimsServiceVerifyClaimSignatureAction\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: true,\n    persist: true,\n    includeInDebugSnapshot: true,\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    claims: [],\n  };\n}\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\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      HttpContentTypeHeader.MULTIPART_FORM_DATA,\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    console.log('message', message);\n\n    // generate and parse the SIWE message\n    const messageHex = textToHex(message);\n    const siwe = detectSIWE({ data: messageHex });\n    if (!siwe.isSIWEMessage) {\n      throw new Error('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    console.log('signature', signature);\n\n    // verify the signature\n    const isSignatureValid = await this.messenger.call(\n      `${SERVICE_NAME}:verifyClaimSignature`,\n      signature as Hex,\n      walletAddress,\n      message,\n    );\n\n    if (!isSignatureValid) {\n      throw new Error('Invalid signature');\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   * 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) =>\n        existingClaim.email === claim.email &&\n        existingClaim.impactedTxHash === claim.impactedTxHash,\n      // Question: should we allow users to submit the rejected claim again?\n    );\n    if (isClaimAlreadySubmitted) {\n      throw new Error('Claim already submitted');\n    }\n  }\n}\n\n/**\n * Converts a text string to its hexadecimal representation.\n *\n * @param text - The input string.\n * @returns The hexadecimal representation of the string's UTF-8 bytes.\n */\nfunction textToHex(text: string): Hex {\n  // 1. Encode the string into a Uint8Array (UTF-8 bytes)\n  const encoder = new TextEncoder();\n  const utf8Bytes = encoder.encode(text);\n\n  // 2. Convert bytes to hex string\n  let hexString = '';\n  for (const byte of utf8Bytes) {\n    // Convert the byte (a number 0-255) to a hexadecimal string\n    const hex = byte.toString(16);\n\n    // Ensure the hex value is always two characters long by padding with a leading zero\n    hexString += hex.padStart(2, '0');\n  }\n\n  return `0x${hexString}`;\n}\n"]}

package/dist/ClaimsService.cjs

@@ -0,0 +1,142 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ClaimsService_env, _ClaimsService_fetch, _ClaimsService_messenger;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClaimsService = void 0;
+const constants_1 = require("./constants.cjs");
+class ClaimsService {
+    constructor({ env, messenger, fetchFunction }) {
+        this.name = constants_1.SERVICE_NAME; // required for Modular Initialization
+        _ClaimsService_env.set(this, void 0);
+        _ClaimsService_fetch.set(this, void 0);
+        _ClaimsService_messenger.set(this, void 0);
+        __classPrivateFieldSet(this, _ClaimsService_env, env, "f");
+        __classPrivateFieldSet(this, _ClaimsService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _ClaimsService_fetch, fetchFunction, "f");
+        __classPrivateFieldGet(this, _ClaimsService_messenger, "f").registerActionHandler(`${constants_1.SERVICE_NAME}:getClaims`, this.getClaims.bind(this));
+        __classPrivateFieldGet(this, _ClaimsService_messenger, "f").registerActionHandler(`${constants_1.SERVICE_NAME}:getClaimById`, this.getClaimById.bind(this));
+        __classPrivateFieldGet(this, _ClaimsService_messenger, "f").registerActionHandler(`${constants_1.SERVICE_NAME}:getRequestHeaders`, this.getRequestHeaders.bind(this));
+        __classPrivateFieldGet(this, _ClaimsService_messenger, "f").registerActionHandler(`${constants_1.SERVICE_NAME}:getClaimsApiUrl`, this.getClaimsApiUrl.bind(this));
+        __classPrivateFieldGet(this, _ClaimsService_messenger, "f").registerActionHandler(`${constants_1.SERVICE_NAME}:generateMessageForClaimSignature`, this.generateMessageForClaimSignature.bind(this));
+        __classPrivateFieldGet(this, _ClaimsService_messenger, "f").registerActionHandler(`${constants_1.SERVICE_NAME}:verifyClaimSignature`, this.verifyClaimSignature.bind(this));
+    }
+    /**
+     * Get the claims for the current user.
+     *
+     * @returns The claims for the current user.
+     */
+    async getClaims() {
+        const headers = await this.getRequestHeaders();
+        const url = `${this.getClaimsApiUrl()}/claims`;
+        const response = await __classPrivateFieldGet(this, _ClaimsService_fetch, "f").call(this, url, {
+            headers,
+        });
+        if (!response.ok) {
+            throw new Error('Failed to get claims');
+        }
+        const claims = await response.json();
+        return claims;
+    }
+    /**
+     * Get the claim by id.
+     *
+     * @param id - The id of the claim to get.
+     * @returns The claim by id.
+     */
+    async getClaimById(id) {
+        const headers = await this.getRequestHeaders();
+        const url = `${this.getClaimsApiUrl()}/claims/byId/${id}`;
+        const response = await __classPrivateFieldGet(this, _ClaimsService_fetch, "f").call(this, url, {
+            headers,
+        });
+        if (!response.ok) {
+            throw new Error('Failed to get claim by id');
+        }
+        const claim = await response.json();
+        return claim;
+    }
+    /**
+     * Generate a message to be signed by the user for the claim request.
+     *
+     * @param chainId - The chain id of the claim.
+     * @param walletAddress - The impacted wallet address of the claim.
+     * @returns The message for the claim signature.
+     */
+    async generateMessageForClaimSignature(chainId, walletAddress) {
+        const headers = await this.getRequestHeaders();
+        const url = `${this.getClaimsApiUrl()}/signature/generateMessage`;
+        const response = await __classPrivateFieldGet(this, _ClaimsService_fetch, "f").call(this, url, {
+            headers,
+            method: 'POST',
+            body: JSON.stringify({
+                chainId,
+                walletAddress,
+            }),
+        });
+        if (!response.ok) {
+            throw new Error('Failed to generate message for claim signature');
+        }
+        const message = await response.json();
+        return message;
+    }
+    /**
+     * Verify a claim signature.
+     *
+     * @param signature - The signature which is signed upon the message.
+     * @param walletAddress - The impacted wallet address of the claim.
+     * @param message - The message which was signed to generate the signature.
+     * @returns The result of the signature verification.
+     */
+    async verifyClaimSignature(signature, walletAddress, message) {
+        const headers = await this.getRequestHeaders();
+        const url = `${this.getClaimsApiUrl()}/signature/verify`;
+        const response = await __classPrivateFieldGet(this, _ClaimsService_fetch, "f").call(this, url, {
+            headers,
+            method: 'POST',
+            body: JSON.stringify({
+                signature,
+                walletAddress,
+                message,
+            }),
+        });
+        if (!response.ok) {
+            throw new Error('Failed to verify claim signature');
+        }
+        const result = await response.json();
+        return Boolean(result.success);
+    }
+    /**
+     * Create the headers for the current request.
+     *
+     * @param contentType - The content type of the request. Defaults to 'application/json'.
+     * @returns The headers for the current request.
+     */
+    async getRequestHeaders(contentType = constants_1.HttpContentTypeHeader.APPLICATION_JSON) {
+        const bearerToken = await __classPrivateFieldGet(this, _ClaimsService_messenger, "f").call('AuthenticationController:getBearerToken');
+        return {
+            Authorization: `Bearer ${bearerToken}`,
+            'Content-Type': contentType,
+        };
+    }
+    /**
+     * Get the URL for the claims API for the current environment.
+     *
+     * @returns The URL for the claims API for the current environment.
+     */
+    getClaimsApiUrl() {
+        return `${constants_1.CLAIMS_API_URL[__classPrivateFieldGet(this, _ClaimsService_env, "f")]}`;
+    }
+}
+exports.ClaimsService = ClaimsService;
+_ClaimsService_env = new WeakMap(), _ClaimsService_fetch = new WeakMap(), _ClaimsService_messenger = new WeakMap();
+//# sourceMappingURL=ClaimsService.cjs.map

package/dist/ClaimsService.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClaimsService.cjs","sourceRoot":"","sources":["../src/ClaimsService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIA,+CAKqB;AAyDrB,MAAa,aAAa;IASxB,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,EAAuB;QARlE,SAAI,GAAG,wBAAY,CAAC,CAAC,sCAAsC;QAElD,qCAAU;QAEV,uCAAqB;QAErB,2CAAmC;QAG1C,uBAAA,IAAI,sBAAQ,GAAG,MAAA,CAAC;QAChB,uBAAA,IAAI,4BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,wBAAU,aAAa,MAAA,CAAC;QAE5B,uBAAA,IAAI,gCAAW,CAAC,qBAAqB,CACnC,GAAG,wBAAY,YAAY,EAC3B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1B,CAAC;QACF,uBAAA,IAAI,gCAAW,CAAC,qBAAqB,CACnC,GAAG,wBAAY,eAAe,EAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;QACF,uBAAA,IAAI,gCAAW,CAAC,qBAAqB,CACnC,GAAG,wBAAY,oBAAoB,EACnC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;QACF,uBAAA,IAAI,gCAAW,CAAC,qBAAqB,CACnC,GAAG,wBAAY,kBAAkB,EACjC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAChC,CAAC;QACF,uBAAA,IAAI,gCAAW,CAAC,qBAAqB,CACnC,GAAG,wBAAY,mCAAmC,EAClD,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,IAAI,CAAC,CACjD,CAAC;QACF,uBAAA,IAAI,gCAAW,CAAC,qBAAqB,CACnC,GAAG,wBAAY,uBAAuB,EACtC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC;QAC/C,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,4BAAO,MAAX,IAAI,EAAQ,GAAG,EAAE;YACtC,OAAO;SACR,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACzC;QAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,EAAU;QAC3B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,gBAAgB,EAAE,EAAE,CAAC;QAC1D,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,4BAAO,MAAX,IAAI,EAAQ,GAAG,EAAE;YACtC,OAAO;SACR,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QAED,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gCAAgC,CACpC,OAAe,EACf,aAAkB;QAElB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,4BAA4B,CAAC;QAClE,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,4BAAO,MAAX,IAAI,EAAQ,GAAG,EAAE;YACtC,OAAO;YACP,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,OAAO;gBACP,aAAa;aACd,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACnE;QAED,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oBAAoB,CACxB,SAAwB,EACxB,aAA4B,EAC5B,OAAe;QAEf,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC;QACzD,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,4BAAO,MAAX,IAAI,EAAQ,GAAG,EAAE;YACtC,OAAO;YACP,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,SAAS;gBACT,aAAa;gBACb,OAAO;aACR,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACrD;QAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,cAAqC,iCAAqB,CAAC,gBAAgB;QAE3E,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,gCAAW,CAAC,IAAI,CAC5C,yCAAyC,CAC1C,CAAC;QACF,OAAO;YACL,aAAa,EAAE,UAAU,WAAW,EAAE;YACtC,cAAc,EAAE,WAAW;SAC5B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,eAAe;QACb,OAAO,GAAG,0BAAc,CAAC,uBAAA,IAAI,0BAAK,CAAC,EAAE,CAAC;IACxC,CAAC;CACF;AA1KD,sCA0KC","sourcesContent":["import type { Messenger } from '@metamask/messenger';\nimport type { AuthenticationController } from '@metamask/profile-sync-controller';\nimport type { Hex } from '@metamask/utils';\n\nimport {\n  CLAIMS_API_URL,\n  type Env,\n  HttpContentTypeHeader,\n  SERVICE_NAME,\n} from './constants';\nimport type { Claim, GenerateSignatureMessageResponse } from './types';\n\nexport type ClaimsServiceGetClaimsAction = {\n  type: `${typeof SERVICE_NAME}:getClaims`;\n  handler: ClaimsService['getClaims'];\n};\n\nexport type ClaimsServiceGetClaimByIdAction = {\n  type: `${typeof SERVICE_NAME}:getClaimById`;\n  handler: ClaimsService['getClaimById'];\n};\n\nexport type ClaimsServiceGetRequestHeadersAction = {\n  type: `${typeof SERVICE_NAME}:getRequestHeaders`;\n  handler: ClaimsService['getRequestHeaders'];\n};\n\nexport type ClaimsServiceGetClaimsApiUrlAction = {\n  type: `${typeof SERVICE_NAME}:getClaimsApiUrl`;\n  handler: ClaimsService['getClaimsApiUrl'];\n};\n\nexport type ClaimsServiceGenerateMessageForClaimSignatureAction = {\n  type: `${typeof SERVICE_NAME}:generateMessageForClaimSignature`;\n  handler: ClaimsService['generateMessageForClaimSignature'];\n};\n\nexport type ClaimsServiceVerifyClaimSignatureAction = {\n  type: `${typeof SERVICE_NAME}:verifyClaimSignature`;\n  handler: ClaimsService['verifyClaimSignature'];\n};\n\nexport type ClaimsServiceActions =\n  | ClaimsServiceGetClaimsAction\n  | ClaimsServiceGetClaimByIdAction\n  | ClaimsServiceGetRequestHeadersAction\n  | ClaimsServiceGetClaimsApiUrlAction\n  | ClaimsServiceGenerateMessageForClaimSignatureAction\n  | ClaimsServiceVerifyClaimSignatureAction;\n\nexport type AllowedActions =\n  AuthenticationController.AuthenticationControllerGetBearerToken;\n\nexport type ClaimsServiceEvents = never;\n\nexport type ClaimsServiceMessenger = Messenger<\n  typeof SERVICE_NAME,\n  ClaimsServiceActions | AllowedActions\n>;\n\nexport type ClaimsServiceConfig = {\n  env: Env;\n  messenger: ClaimsServiceMessenger;\n  fetchFunction: typeof fetch;\n};\n\nexport class ClaimsService {\n  name = SERVICE_NAME; // required for Modular Initialization\n\n  readonly #env: Env;\n\n  readonly #fetch: typeof fetch;\n\n  readonly #messenger: ClaimsServiceMessenger;\n\n  constructor({ env, messenger, fetchFunction }: ClaimsServiceConfig) {\n    this.#env = env;\n    this.#messenger = messenger;\n    this.#fetch = fetchFunction;\n\n    this.#messenger.registerActionHandler(\n      `${SERVICE_NAME}:getClaims`,\n      this.getClaims.bind(this),\n    );\n    this.#messenger.registerActionHandler(\n      `${SERVICE_NAME}:getClaimById`,\n      this.getClaimById.bind(this),\n    );\n    this.#messenger.registerActionHandler(\n      `${SERVICE_NAME}:getRequestHeaders`,\n      this.getRequestHeaders.bind(this),\n    );\n    this.#messenger.registerActionHandler(\n      `${SERVICE_NAME}:getClaimsApiUrl`,\n      this.getClaimsApiUrl.bind(this),\n    );\n    this.#messenger.registerActionHandler(\n      `${SERVICE_NAME}:generateMessageForClaimSignature`,\n      this.generateMessageForClaimSignature.bind(this),\n    );\n    this.#messenger.registerActionHandler(\n      `${SERVICE_NAME}:verifyClaimSignature`,\n      this.verifyClaimSignature.bind(this),\n    );\n  }\n\n  /**\n   * Get the claims for the current user.\n   *\n   * @returns The claims for the current user.\n   */\n  async getClaims(): Promise<Claim[]> {\n    const headers = await this.getRequestHeaders();\n    const url = `${this.getClaimsApiUrl()}/claims`;\n    const response = await this.#fetch(url, {\n      headers,\n    });\n\n    if (!response.ok) {\n      throw new Error('Failed to get claims');\n    }\n\n    const claims = await response.json();\n    return claims;\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   */\n  async getClaimById(id: string): Promise<Claim> {\n    const headers = await this.getRequestHeaders();\n    const url = `${this.getClaimsApiUrl()}/claims/byId/${id}`;\n    const response = await this.#fetch(url, {\n      headers,\n    });\n\n    if (!response.ok) {\n      throw new Error('Failed to get claim by id');\n    }\n\n    const claim = await response.json();\n    return claim;\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   */\n  async generateMessageForClaimSignature(\n    chainId: number,\n    walletAddress: Hex,\n  ): Promise<GenerateSignatureMessageResponse> {\n    const headers = await this.getRequestHeaders();\n    const url = `${this.getClaimsApiUrl()}/signature/generateMessage`;\n    const response = await this.#fetch(url, {\n      headers,\n      method: 'POST',\n      body: JSON.stringify({\n        chainId,\n        walletAddress,\n      }),\n    });\n\n    if (!response.ok) {\n      throw new Error('Failed to generate message for claim signature');\n    }\n\n    const message = await response.json();\n    return message;\n  }\n\n  /**\n   * Verify a claim signature.\n   *\n   * @param signature - The signature which is signed upon the message.\n   * @param walletAddress - The impacted wallet address of the claim.\n   * @param message - The message which was signed to generate the signature.\n   * @returns The result of the signature verification.\n   */\n  async verifyClaimSignature(\n    signature: `0x${string}`,\n    walletAddress: `0x${string}`,\n    message: string,\n  ): Promise<boolean> {\n    const headers = await this.getRequestHeaders();\n    const url = `${this.getClaimsApiUrl()}/signature/verify`;\n    const response = await this.#fetch(url, {\n      headers,\n      method: 'POST',\n      body: JSON.stringify({\n        signature,\n        walletAddress,\n        message,\n      }),\n    });\n\n    if (!response.ok) {\n      throw new Error('Failed to verify claim signature');\n    }\n\n    const result = await response.json();\n    return Boolean(result.success);\n  }\n\n  /**\n   * Create the headers for the current request.\n   *\n   * @param contentType - The content type of the request. Defaults to 'application/json'.\n   * @returns The headers for the current request.\n   */\n  async getRequestHeaders(\n    contentType: HttpContentTypeHeader = HttpContentTypeHeader.APPLICATION_JSON,\n  ): Promise<Record<string, string>> {\n    const bearerToken = await this.#messenger.call(\n      'AuthenticationController:getBearerToken',\n    );\n    return {\n      Authorization: `Bearer ${bearerToken}`,\n      'Content-Type': contentType,\n    };\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   */\n  getClaimsApiUrl(): string {\n    return `${CLAIMS_API_URL[this.#env]}`;\n  }\n}\n"]}