feat: add getMoneyAccount method to the money service

Author: Jwhiles

packages/money-account-service/src/MoneyAccountService-method-action-types.ts

@@ -5,5 +5,11 @@ export type MoneyAccountServiceCreateMoneyAccountAction = {
   handler: MoneyAccountService['createMoneyAccount'];
 };
 
+export type MoneyAccountServiceGetMoneyAccountAction = {
+  type: `MoneyAccountService:getMoneyAccount`;
+  handler: MoneyAccountService['getMoneyAccount'];
+};
+
 export type MoneyAccountServiceMethodActions =
-  MoneyAccountServiceCreateMoneyAccountAction;
+  | MoneyAccountServiceCreateMoneyAccountAction
+  | MoneyAccountServiceGetMoneyAccountAction;

packages/money-account-service/src/MoneyAccountService.test.ts

@@ -199,4 +199,79 @@ describe('MoneyAccountService', () => {
       );
     });
   });
+
+  describe('getMoneyAccount', () => {
+    it('returns the money keyring metadata if one exists', async () => {
+      const { service, mocks } = setup();
+      const MOCK_MONEY_METADATA = { id: 'existing-money-keyring-id', name: '' };
+
+      mocks.withKeyring.mockImplementation(async (selector, operation) => {
+        if ('type' in selector && selector.type === KeyringTypes.money) {
+          return operation({
+            keyring: {},
+            metadata: MOCK_MONEY_METADATA,
+          });
+        }
+        return operation({
+          keyring: {
+            type: 'HD Key Tree',
+            mnemonic: MOCK_MNEMONIC,
+          } as unknown as HdKeyring,
+          metadata: { id: MOCK_ENTROPY_SOURCE, name: '' },
+        });
+      });
+
+      const result = await service.getMoneyAccount();
+
+      expect(result).toStrictEqual(MOCK_MONEY_METADATA);
+    });
+
+    it('returns null if no money account exists', async () => {
+      const { service } = setup();
+
+      const result = await service.getMoneyAccount();
+
+      expect(result).toBeNull();
+    });
+
+    it('is callable via the messenger', async () => {
+      const { rootMessenger, mocks } = setup();
+      const MOCK_MONEY_METADATA = { id: 'existing-money-keyring-id', name: '' };
+
+      mocks.withKeyring.mockImplementation(async (selector, operation) => {
+        if ('type' in selector && selector.type === KeyringTypes.money) {
+          return operation({
+            keyring: {},
+            metadata: MOCK_MONEY_METADATA,
+          });
+        }
+        return operation({
+          keyring: {
+            type: 'HD Key Tree',
+            mnemonic: MOCK_MNEMONIC,
+          } as unknown as HdKeyring,
+          metadata: { id: MOCK_ENTROPY_SOURCE, name: '' },
+        });
+      });
+
+      const result = await rootMessenger.call(
+        'MoneyAccountService:getMoneyAccount',
+      );
+
+      expect(result).toStrictEqual(MOCK_MONEY_METADATA);
+    });
+
+    it('re-throws errors other than KeyringNotFound', async () => {
+      const { service, mocks } = setup();
+      const unexpectedError = new KeyringControllerError('Unexpected error');
+
+      mocks.withKeyring.mockImplementation(async (selector) => {
+        if ('type' in selector && selector.type === KeyringTypes.money) {
+          throw unexpectedError;
+        }
+      });
+
+      await expect(service.getMoneyAccount()).rejects.toThrow(unexpectedError);
+    });
+  });
 });

packages/money-account-service/src/MoneyAccountService.ts

@@ -10,7 +10,10 @@ import type { MoneyAccountServiceMessenger } from './types';
 
 export const serviceName = 'MoneyAccountService';
 
-const MESSENGER_EXPOSED_METHODS = ['createMoneyAccount'] as const;
+const MESSENGER_EXPOSED_METHODS = [
+  'createMoneyAccount',
+  'getMoneyAccount',
+] as const;
 
 export class MoneyAccountService {
   readonly #messenger: MoneyAccountServiceMessenger;
@@ -84,4 +87,27 @@ export class MoneyAccountService {
       { mnemonic },
     );
   }
+
+  /**
+   * Returns the Money keyring metadata if one exists, otherwise null.
+   *
+   * @returns The metadata of the Money keyring, or null if none exists.
+   */
+  async getMoneyAccount(): Promise<KeyringMetadata | null> {
+    return (await this.#messenger
+      .call(
+        'KeyringController:withKeyring',
+        { type: KeyringTypes.money },
+        async ({ metadata }) => metadata,
+      )
+      .catch((error: unknown) => {
+        if (
+          error instanceof KeyringControllerError &&
+          error.message === KeyringControllerErrorMessage.KeyringNotFound
+        ) {
+          return null;
+        }
+        throw error;
+      })) as KeyringMetadata | null;
+  }
 }