feat: wire ClaimsService and ClaimsController initialization

.github/CODEOWNERS

@@ -150,6 +150,8 @@
 /packages/wallet/src/initialization/instances/accounts-controller/               @MetaMask/accounts-engineers
 /packages/wallet/src/initialization/instances/address-book-controller/           @MetaMask/confirmations
 /packages/wallet/src/initialization/instances/approval-controller/               @MetaMask/confirmations
+/packages/wallet/src/initialization/instances/claims-controller/                 @MetaMask/web3auth
+/packages/wallet/src/initialization/instances/claims-service/                    @MetaMask/web3auth
 /packages/wallet/src/initialization/instances/connectivity-controller/           @MetaMask/core-platform
 /packages/wallet/src/initialization/instances/gas-fee-controller/                @MetaMask/confirmations
 /packages/wallet/src/initialization/instances/keyring-controller/                @MetaMask/accounts-engineers @MetaMask/core-platform

README.md

@@ -345,6 +345,7 @@ linkStyle default opacity:0.5
   chomp_api_service --> controller_utils;
   chomp_api_service --> messenger;
   claims_controller --> base_controller;
+  claims_controller --> base_data_service;
   claims_controller --> controller_utils;
   claims_controller --> keyring_controller;
   claims_controller --> messenger;
@@ -655,6 +656,7 @@ linkStyle default opacity:0.5
   wallet --> address_book_controller;
   wallet --> approval_controller;
   wallet --> base_controller;
+  wallet --> claims_controller;
   wallet --> connectivity_controller;
   wallet --> controller_utils;
   wallet --> gas_fee_controller;

codeowners.ts

@@ -98,6 +98,11 @@ const PACKAGES: Record<string, PackageInfo> = {
   },
   'claims-controller': {
     teams: ['@MetaMask/web3auth'],
+    initializationPath: 'claims-controller',
+  },
+  'claims-service': {
+    teams: ['@MetaMask/web3auth'],
+    initializationPath: 'claims-service',
   },
   'client-controller': {
     teams: [

packages/claims-controller/CHANGELOG.md

@@ -7,8 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Export `ClaimsControllerOptions` and `ClaimsServiceConfig` types ([#9588](https://github.com/MetaMask/core/pull/9588))
+- Add `ClaimsService-method-action-types.ts` with generated method action types for `ClaimsService` ([#9588](https://github.com/MetaMask/core/pull/9588))
+- Add `ClaimsService:invalidateQueries` action and `ClaimsService:cacheUpdated` events via `BaseDataService` ([#9588](https://github.com/MetaMask/core/pull/9588))
+
 ### Changed
 
+- Migrate `ClaimsService` to `BaseDataService` with TanStack Query caching, circuit-breaker policy support, and response validation ([#9588](https://github.com/MetaMask/core/pull/9588))
+- Add `@metamask/base-data-service` `^0.1.3`, `@metamask/superstruct` `^3.1.0`, and `@tanstack/query-core` `^4.43.0` as dependencies ([#9588](https://github.com/MetaMask/core/pull/9588))
 - Bump `@metamask/utils` from `^11.9.0` to `^11.11.0` ([#9074](https://github.com/MetaMask/core/pull/9074))
 - Bump `@metamask/controller-utils` from `^12.1.1` to `^12.3.0` ([#9083](https://github.com/MetaMask/core/pull/9083), [#9218](https://github.com/MetaMask/core/pull/9218))
 - Bump `@metamask/profile-sync-controller` from `^28.1.1` to `^28.3.0` ([#9119](https://github.com/MetaMask/core/pull/9119), [#9463](https://github.com/MetaMask/core/pull/9463))

packages/claims-controller/package.json

@@ -56,11 +56,14 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^9.1.0",
+    "@metamask/base-data-service": "^0.1.3",
     "@metamask/controller-utils": "^12.3.0",
     "@metamask/keyring-controller": "^27.1.0",
     "@metamask/messenger": "^2.0.0",
     "@metamask/profile-sync-controller": "^28.3.0",
-    "@metamask/utils": "^11.11.0"
+    "@metamask/superstruct": "^3.1.0",
+    "@metamask/utils": "^11.11.0",
+    "@tanstack/query-core": "^4.43.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",

packages/claims-controller/src/ClaimsController.ts

@@ -17,7 +17,7 @@ import type {
   ClaimsServiceGetClaimsAction,
   ClaimsServiceGetClaimsApiUrlAction,
   ClaimsServiceGetRequestHeadersAction,
-} from './ClaimsService.js';
+} from './ClaimsService-method-action-types.js';
 import {
   ClaimsControllerErrorMessages,
   CONTROLLER_NAME,

packages/claims-controller/src/ClaimsService-method-action-types.ts

@@ -0,0 +1,80 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+
+import type { ClaimsService } from './ClaimsService.js';
+
+/**
+ * Fetch required configurations for the claims service.
+ *
+ * @returns The required configurations for the claims service.
+ */
+export type ClaimsServiceFetchClaimsConfigurationsAction = {
+  type: `ClaimsService:fetchClaimsConfigurations`;
+  handler: ClaimsService['fetchClaimsConfigurations'];
+};
+
+/**
+ * Get the claims for the current user.
+ *
+ * @returns The claims for the current user.
+ */
+export type ClaimsServiceGetClaimsAction = {
+  type: `ClaimsService:getClaims`;
+  handler: ClaimsService['getClaims'];
+};
+
+/**
+ * Get the claim by id.
+ *
+ * @param id - The id of the claim to get.
+ * @returns The claim by id.
+ */
+export type ClaimsServiceGetClaimByIdAction = {
+  type: `ClaimsService:getClaimById`;
+  handler: ClaimsService['getClaimById'];
+};
+
+/**
+ * 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.
+ */
+export type ClaimsServiceGenerateMessageForClaimSignatureAction = {
+  type: `ClaimsService:generateMessageForClaimSignature`;
+  handler: ClaimsService['generateMessageForClaimSignature'];
+};
+
+/**
+ * Create the headers for the current request.
+ *
+ * @returns The headers for the current request.
+ */
+export type ClaimsServiceGetRequestHeadersAction = {
+  type: `ClaimsService:getRequestHeaders`;
+  handler: ClaimsService['getRequestHeaders'];
+};
+
+/**
+ * Get the URL for the claims API for the current environment.
+ *
+ * @returns The URL for the claims API for the current environment.
+ */
+export type ClaimsServiceGetClaimsApiUrlAction = {
+  type: `ClaimsService:getClaimsApiUrl`;
+  handler: ClaimsService['getClaimsApiUrl'];
+};
+
+/**
+ * Union of all ClaimsService action types.
+ */
+export type ClaimsServiceMethodActions =
+  | ClaimsServiceFetchClaimsConfigurationsAction
+  | ClaimsServiceGetClaimsAction
+  | ClaimsServiceGetClaimByIdAction
+  | ClaimsServiceGenerateMessageForClaimSignatureAction
+  | ClaimsServiceGetRequestHeadersAction
+  | ClaimsServiceGetClaimsApiUrlAction;

packages/claims-controller/src/ClaimsService-structs.ts

@@ -0,0 +1,45 @@
+import {
+  array,
+  enums,
+  integer,
+  object,
+  optional,
+  string,
+} from '@metamask/superstruct';
+
+import { ClaimStatusEnum } from './constants.js';
+
+const HexStringStruct = string();
+
+const AttachmentStruct = object({
+  publicUrl: string(),
+  contentType: string(),
+  originalname: string(),
+});
+
+export const ClaimStruct = object({
+  id: string(),
+  shortId: string(),
+  chainId: string(),
+  email: string(),
+  impactedWalletAddress: HexStringStruct,
+  impactedTxHash: HexStringStruct,
+  reimbursementWalletAddress: HexStringStruct,
+  description: string(),
+  signature: HexStringStruct,
+  attachments: optional(array(AttachmentStruct)),
+  status: enums(Object.values(ClaimStatusEnum)),
+  createdAt: string(),
+  updatedAt: string(),
+  intercomId: optional(string()),
+});
+
+export const ClaimsConfigurationsResponseStruct = object({
+  validSubmissionWindowDays: integer(),
+  networks: array(integer()),
+});
+
+export const GenerateSignatureMessageResponseStruct = object({
+  message: string(),
+  nonce: string(),
+});