feat(core-backend): add AccountActivity and Websocket for TokenBalancesController

.metamaskrc.dist

@@ -10,6 +10,10 @@ SEEDLESS_ONBOARDING_ENABLED='false'
 ; Set this to `true` to enable Metamask Shield
 METAMASK_SHIELD_ENABLED='false'
 
+; Backend WebSocket URL
+; Uses production API endpoint by default (same as builds.yml)
+;MM_BACKEND_WEBSOCKET_URL='wss://gateway.api.cx.metamask.io/v1'
+
 ; These variables are required for OAuth Service
 GOOGLE_CLIENT_ID=
 APPLE_CLIENT_ID=

app/scripts/controller-init/controller-list.ts

@@ -76,6 +76,10 @@ import {
 } from '@metamask/message-manager';
 import { SignatureController } from '@metamask/signature-controller';
 import { UserOperationController } from '@metamask/user-operation-controller';
+import {
+  AccountActivityService,
+  BackendWebSocketService,
+} from '@metamask/core-backend';
 import OnboardingController from '../controllers/onboarding';
 import { PreferencesController } from '../controllers/preferences-controller';
 import SwapsController from '../controllers/swaps';
@@ -181,6 +185,8 @@ export type Controller =
   | AssetsContractController
   | AccountTreeController
   | WebSocketService
+  | BackendWebSocketService
+  | AccountActivityService
   | MultichainAccountService
   | NetworkEnablementController;
 

app/scripts/controller-init/core-backend/account-activity-service-init.test.ts

@@ -0,0 +1,61 @@
+import {
+  AccountActivityService,
+  AccountActivityServiceMessenger,
+} from '@metamask/core-backend';
+import { Messenger } from '@metamask/base-controller';
+import { ControllerInitRequest } from '../types';
+import { buildControllerInitRequestMock } from '../test/utils';
+import { getAccountActivityServiceMessenger } from '../messengers/core-backend';
+import { AccountActivityServiceInit } from './account-activity-service-init';
+
+jest.mock('@metamask/core-backend');
+jest.mock('../../../../shared/lib/trace');
+
+function getInitRequestMock(): jest.Mocked<
+  ControllerInitRequest<AccountActivityServiceMessenger>
+> {
+  const baseMessenger = new Messenger<never, never>();
+
+  const requestMock = {
+    ...buildControllerInitRequestMock(),
+    controllerMessenger: getAccountActivityServiceMessenger(baseMessenger),
+    initMessenger: undefined,
+  };
+
+  return requestMock;
+}
+
+describe('AccountActivityServiceInit', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('initializes the controller', () => {
+    const { controller } = AccountActivityServiceInit(getInitRequestMock());
+    expect(controller).toBeInstanceOf(AccountActivityService);
+  });
+
+  it('passes the messenger and traceFn to the controller', () => {
+    AccountActivityServiceInit(getInitRequestMock());
+
+    const controllerMock = jest.mocked(AccountActivityService);
+    expect(controllerMock).toHaveBeenCalledWith({
+      messenger: expect.any(Object),
+      traceFn: expect.any(Function),
+    });
+  });
+
+  it('returns null for both state keys', () => {
+    const result = AccountActivityServiceInit(getInitRequestMock());
+
+    expect(result.memStateKey).toBeNull();
+    expect(result.persistedStateKey).toBeNull();
+  });
+
+  it('returns the controller instance', () => {
+    const { controller } = AccountActivityServiceInit(getInitRequestMock());
+
+    expect(controller).toBeDefined();
+    expect(controller).toBeInstanceOf(AccountActivityService);
+  });
+});

app/scripts/controller-init/core-backend/account-activity-service-init.ts

@@ -0,0 +1,30 @@
+import {
+  AccountActivityService,
+  AccountActivityServiceMessenger,
+} from '@metamask/core-backend';
+import { trace } from '../../../../shared/lib/trace';
+import { ControllerInitFunction } from '../types';
+
+/**
+ * Initialize the Account Activity service.
+ *
+ * @param request - The request object.
+ * @param request.controllerMessenger - The messenger to use for the service.
+ * @returns The initialized service.
+ */
+export const AccountActivityServiceInit: ControllerInitFunction<
+  AccountActivityService,
+  AccountActivityServiceMessenger
+> = ({ controllerMessenger }) => {
+  const controller = new AccountActivityService({
+    messenger: controllerMessenger,
+    // @ts-expect-error: Types of `TraceRequest` are not the same.
+    traceFn: trace,
+  });
+
+  return {
+    memStateKey: null,
+    persistedStateKey: null,
+    controller,
+  };
+};