refactor: rename wallet category to type

Author: ccharly

packages/account-api/src/api/multichain/account.ts

@@ -9,10 +9,10 @@ import type { Bip44Account } from '../bip44';
 import type { AccountGroup } from '../group';
 import type { AccountProvider } from '../provider';
 import type { AccountSelector } from '../selector';
-import { AccountWalletCategory } from '../wallet';
+import { AccountWalletType } from '../wallet';
 
 const MULTICHAIN_ACCOUNT_ID_REGEX = new RegExp(
-  `^${AccountWalletCategory.Entropy}:.*/(?<groupIndex>\\d+)$`,
+  `^${AccountWalletType.Entropy}:.*/(?<groupIndex>\\d+)$`,
   'u',
 );
 

packages/account-api/src/api/multichain/wallet.ts

@@ -13,13 +13,13 @@ import type { AccountGroupId } from '../group';
 import { toDefaultAccountGroupId } from '../group';
 import type { AccountProvider } from '../provider';
 import type { AccountWallet } from '../wallet';
-import { AccountWalletCategory } from '../wallet';
+import { AccountWalletType } from '../wallet';
 
 /**
  * Multichain account wallet ID.
  */
 export type MultichainAccountWalletId =
-  `${AccountWalletCategory.Entropy}:${EntropySourceId}`;
+  `${AccountWalletType.Entropy}:${EntropySourceId}`;
 
 /**
  * A multichain account wallet that holds multiple multichain accounts (one multichain account per
@@ -104,12 +104,12 @@ export class MultichainAccountWallet<
   }
 
   /**
-   * Gets the multichain account wallet category, which is always {@link AccountWalletCategory.Entropy}.
+   * Gets the multichain account wallet type, which is always {@link AccountWalletType.Entropy}.
    *
-   * @returns The multichain account wallet category.
+   * @returns The multichain account wallet type.
    */
-  get category(): AccountWalletCategory.Entropy {
-    return AccountWalletCategory.Entropy;
+  get type(): AccountWalletType.Entropy {
+    return AccountWalletType.Entropy;
   }
 
   /**
@@ -184,5 +184,5 @@ export class MultichainAccountWallet<
 export function toMultichainAccountWalletId(
   entropySource: EntropySourceId,
 ): MultichainAccountWalletId {
-  return `${AccountWalletCategory.Entropy}:${entropySource}`;
+  return `${AccountWalletType.Entropy}:${entropySource}`;
 }

packages/account-api/src/api/wallet.ts

@@ -3,30 +3,32 @@ import type { KeyringAccount } from '@metamask/keyring-api';
 // Circular import are allowed when using `import type`.
 import type { AccountGroup, AccountGroupId } from './group';
 
-export enum AccountWalletCategory {
+/**
+ * Wallet type.
+ *
+ * Each wallet types groups accounts using different criterias.
+ */
+export enum AccountWalletType {
   /**
-   * Category for wallets that group accounts based on their
-   * entropy source.
+   * Wallet grouping accounts based on their entropy source.
    */
   Entropy = 'entropy',
 
   /**
-   * Category for wallets that group accounts based on their
-   * keyring's type.
+   * Wallet grouping accounts based on their keyring's type.
    */
   Keyring = 'keyring',
 
   /**
-   * Category for wallets that group accounts associated with an
-   * account management Snap.
+   * Wallet grouping accounts associated with an account management Snap.
    */
   Snap = 'snap',
 }
 
 /**
  * Account wallet ID.
  */
-export type AccountWalletId = `${AccountWalletCategory}:${string}`;
+export type AccountWalletId = `${AccountWalletType}:${string}`;
 
 /**
  * Account wallet that can hold multiple account groups.
@@ -38,9 +40,9 @@ export type AccountWallet<Account extends KeyringAccount> = {
   get id(): AccountWalletId;
 
   /**
-   * Account wallet category.
+   * Account wallet type.
    */
-  get category(): AccountWalletCategory;
+  get type(): AccountWalletType;
 
   /**
    * Gets account group for a given ID.
@@ -59,15 +61,15 @@ export type AccountWallet<Account extends KeyringAccount> = {
 };
 
 /**
- * Convert a unique ID to a wallet ID for a given category.
+ * Convert a unique ID to a wallet ID for a given type.
  *
- * @param category - A wallet category.
+ * @param type - A wallet type.
  * @param id - A unique ID.
  * @returns A wallet ID.
  */
 export function toAccountWalletId(
-  category: AccountWalletCategory,
+  type: AccountWalletType,
   id: string,
 ): AccountWalletId {
-  return `${category}:${id}`;
+  return `${type}:${id}`;
 }

packages/account-api/src/index.test.ts

@@ -29,7 +29,7 @@ import type {
   Bip44Account,
 } from './api';
 import {
-  AccountWalletCategory,
+  AccountWalletType,
   toAccountGroupId,
   toAccountWalletId,
   toDefaultAccountGroupId,
@@ -688,7 +688,7 @@ describe('index', () => {
         await setupMultichainAccountWallet();
 
       const groupId: AccountGroupId = toAccountGroupId(
-        toAccountWalletId(AccountWalletCategory.Keyring, 'bad-keyring-id'),
+        toAccountWalletId(AccountWalletType.Keyring, 'bad-keyring-id'),
         'bad-index',
       );
       const group: AccountGroup<MockedAccount> | undefined =
@@ -711,16 +711,16 @@ describe('index', () => {
       // test AccountGroup too!
       const wallet = await setupMultichainAccountWallet();
 
-      expect(wallet.category).toBe(AccountWalletCategory.Entropy);
+      expect(wallet.type).toBe(AccountWalletType.Entropy);
       expect(wallet.id).toStrictEqual(
-        toAccountWalletId(AccountWalletCategory.Entropy, wallet.entropySource),
+        toAccountWalletId(AccountWalletType.Entropy, wallet.entropySource),
       );
     });
   });
 
   describe('toAccountGroupId', () => {
     it('converts an account wallet id and a unique id to a group id', () => {
-      const walletId = toAccountWalletId(AccountWalletCategory.Keyring, 'test');
+      const walletId = toAccountWalletId(AccountWalletType.Keyring, 'test');
       const groupId = toAccountGroupId(walletId, 'test');
 
       expect(groupId.startsWith(walletId)).toBe(true);
@@ -729,7 +729,7 @@ describe('index', () => {
 
   describe('toDefaultAccountGroupId', () => {
     it('converts an account wallet id and to the default group id', () => {
-      const walletId = toAccountWalletId(AccountWalletCategory.Keyring, 'test');
+      const walletId = toAccountWalletId(AccountWalletType.Keyring, 'test');
       const groupId = toDefaultAccountGroupId(walletId);
 
       expect(groupId.startsWith(walletId)).toBe(true);
@@ -738,7 +738,7 @@ describe('index', () => {
 
   describe('getGroupIndexFromMultichainAccountId', () => {
     it('throws if it cannot extract group index', () => {
-      const walletId = toAccountWalletId(AccountWalletCategory.Keyring, 'test');
+      const walletId = toAccountWalletId(AccountWalletType.Keyring, 'test');
       const groupId = toAccountGroupId(walletId, 'test');
 
       expect(() =>