feat(keyring-sdk): add generateId to KeyringAccountRegistry (#503)

Add a new option to be able to customize the `KeyringAccountRegistry` ID
generation.

I'll follow-up with other PRs to make the `EthKeyringWrapper` class to
use deterministic IDs similarly to what we do today for EVM account IDs.

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk: change is additive and localized to `KeyringAccountRegistry`
ID creation, with default behavior preserved; primary risk is downstream
assumptions about UUID formatting if consumers supply non-UUID IDs.
> 
> **Overview**
> Adds a `KeyringAccountRegistryOptions.generateId` hook and wires
`register(address)` to call it when creating new IDs, while keeping
UUIDv4 as the default.
> 
> Updates tests to cover default UUIDv4 behavior and custom generator
usage, and notes the addition in the `keyring-sdk` changelog.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
19a95c6. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: ccharly

packages/keyring-sdk/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `generateId` option to `KeyringAccountRegistry` ([#503](https://github.com/MetaMask/accounts/pull/503))
+
 ## [1.1.0]
 
 ### Added

packages/keyring-sdk/src/keyring-account-registry.test.ts

@@ -1,7 +1,10 @@
 import type { KeyringAccount } from '@metamask/keyring-api';
 import type { AccountId } from '@metamask/keyring-utils';
 
-import { KeyringAccountRegistry } from './keyring-account-registry';
+import {
+  KeyringAccountRegistry,
+  type KeyringAccountRegistryOptions,
+} from './keyring-account-registry';
 
 /**
  * Creates a mock KeyringAccount for testing.
@@ -22,6 +25,29 @@ function createMockAccount(id: AccountId, address: string): KeyringAccount {
 }
 
 describe('KeyringAccountRegistry', () => {
+  describe('constructor', () => {
+    it('uses uuidv4 by default', () => {
+      const registry = new KeyringAccountRegistry();
+      const id = registry.register('0xaBc');
+
+      expect(id).toMatch(
+        /^[\da-f]{8}-[\da-f]{4}-4[\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}$/u,
+      );
+    });
+
+    it('uses the provided generateId callback', () => {
+      const generateId = jest
+        .fn<AccountId, [string]>()
+        .mockReturnValue('custom-id' as AccountId);
+      const options: KeyringAccountRegistryOptions = { generateId };
+      const registry = new KeyringAccountRegistry(options);
+      const id = registry.register('0xaBc');
+
+      expect(generateId).toHaveBeenCalledWith('0xaBc');
+      expect(id).toBe('custom-id');
+    });
+  });
+
   describe('register', () => {
     it('registers an address and returns an account ID', () => {
       const registry = new KeyringAccountRegistry();

packages/keyring-sdk/src/keyring-account-registry.ts

@@ -2,6 +2,19 @@ import type { KeyringAccount } from '@metamask/keyring-api';
 import type { AccountId } from '@metamask/keyring-utils';
 import { v4 as uuidv4 } from 'uuid';
 
+export type KeyringAccountRegistryOptions = {
+  /**
+   * Custom ID generator invoked when registering a new address.
+   *
+   * Receives the address being registered and must return a unique account ID.
+   * Defaults to a random UUID v4 when not provided.
+   *
+   * @param address - The address for which to generate an account ID.
+   * @returns A unique account ID string.
+   */
+  generateId?: (address: string) => AccountId;
+};
+
 /**
  * In-memory registry for KeyringAccount objects.
  *
@@ -15,6 +28,18 @@ export class KeyringAccountRegistry<
 
   readonly #idByAddress = new Map<string, AccountId>();
 
+  readonly #generateId: (address: string) => AccountId;
+
+  /**
+   * Create a new KeyringAccountRegistry.
+   *
+   * @param options - Optional configuration.
+   * @param options.generateId - Custom ID generator. Defaults to `uuidv4`.
+   */
+  constructor(options?: KeyringAccountRegistryOptions) {
+    this.#generateId = options?.generateId ?? ((): AccountId => uuidv4());
+  }
+
   /**
    * Get an account by its account ID.
    *
@@ -57,7 +82,7 @@ export class KeyringAccountRegistry<
     if (existing) {
       return existing;
     }
-    const id = uuidv4();
+    const id = this.#generateId(address);
     this.#idByAddress.set(address, id);
     return id;
   }