add account handling

Author: GuillaumeRx

packages/snaps-controllers/coverage.json

@@ -1,6 +1,6 @@
 {
-  "branches": 93.36,
-  "functions": 97.06,
+  "branches": 93.37,
+  "functions": 97.08,
   "lines": 98.26,
-  "statements": 97.99
+  "statements": 98
 }

packages/snaps-controllers/package.json

@@ -84,6 +84,7 @@
     "@metamask/json-rpc-engine": "^10.0.2",
     "@metamask/json-rpc-middleware-stream": "^8.0.7",
     "@metamask/key-tree": "^10.0.2",
+    "@metamask/keyring-internal-api": "^6.0.0",
     "@metamask/object-multiplex": "^2.1.0",
     "@metamask/permission-controller": "^11.0.6",
     "@metamask/phishing-controller": "^12.3.2",

packages/snaps-controllers/src/interface/SnapInterfaceController.test.tsx

@@ -185,7 +185,7 @@ describe('SnapInterfaceController', () => {
       );
 
       expect(rootMessenger.call).toHaveBeenNthCalledWith(
-        3,
+        4,
         'MultichainAssetsController:getState',
       );
     });
@@ -443,6 +443,66 @@ describe('SnapInterfaceController', () => {
       );
     });
 
+    it('throws if an address passed to an asset selector is not available in the client', async () => {
+      const rootMessenger = getRootSnapInterfaceControllerMessenger();
+      const controllerMessenger = getRestrictedSnapInterfaceControllerMessenger(
+        rootMessenger,
+        false,
+      );
+
+      rootMessenger.registerActionHandler(
+        'PhishingController:maybeUpdateState',
+        jest.fn(),
+      );
+
+      rootMessenger.registerActionHandler(
+        'PhishingController:testOrigin',
+        () => ({ result: true, type: 'all' }),
+      );
+
+      rootMessenger.registerActionHandler(
+        'MultichainAssetsController:getState',
+        () => ({
+          assetsMetadata: {},
+          accountsAssets: {},
+        }),
+      );
+
+      rootMessenger.registerActionHandler(
+        'AccountsController:getAccountByAddress',
+        () => undefined,
+      );
+
+      // eslint-disable-next-line no-new
+      new SnapInterfaceController({
+        messenger: controllerMessenger,
+      });
+
+      const element = (
+        <Box>
+          <AssetSelector
+            name="foo"
+            addresses={['eip155:1:0x1234567890123456789012345678901234567890']}
+          />
+        </Box>
+      );
+
+      await expect(
+        rootMessenger.call(
+          'SnapInterfaceController:createInterface',
+          MOCK_SNAP_ID,
+          element,
+        ),
+      ).rejects.toThrow(
+        'Could not find account for address: eip155:1:0x1234567890123456789012345678901234567890',
+      );
+
+      expect(rootMessenger.call).toHaveBeenNthCalledWith(
+        3,
+        'AccountsController:getAccountByAddress',
+        '0x1234567890123456789012345678901234567890',
+      );
+    });
     it('throws if UI content is too large', async () => {
       const rootMessenger = getRootSnapInterfaceControllerMessenger();
       const controllerMessenger = getRestrictedSnapInterfaceControllerMessenger(

packages/snaps-controllers/src/interface/SnapInterfaceController.ts

@@ -8,6 +8,7 @@ import type {
   ControllerStateChangeEvent,
 } from '@metamask/base-controller';
 import { BaseController } from '@metamask/base-controller';
+import type { InternalAccount } from '@metamask/keyring-internal-api';
 import type {
   MaybeUpdateState,
   TestOrigin,
@@ -22,14 +23,15 @@ import type {
 import { ContentType } from '@metamask/snaps-sdk';
 import type { JSXElement } from '@metamask/snaps-sdk/jsx';
 import { getJsonSizeUnsafe, validateJsxLinks } from '@metamask/snaps-utils';
-import type { CaipAssetType, Json } from '@metamask/utils';
-import { assert, hasProperty } from '@metamask/utils';
+import type { CaipAccountId, CaipAssetType, Json } from '@metamask/utils';
+import { assert, hasProperty, parseCaipAccountId } from '@metamask/utils';
 import { castDraft } from 'immer';
 import { nanoid } from 'nanoid';
 
 import {
   constructState,
   getJsxInterface,
+  validateAssetSelector,
   validateInterfaceContext,
 } from './utils';
 import type { GetSnap } from '../snaps';
@@ -68,6 +70,11 @@ export type ResolveInterface = {
   handler: SnapInterfaceController['resolveInterface'];
 };
 
+type AccountsControllerGetAccountByAddressAction = {
+  type: `AccountsController:getAccountByAddress`;
+  handler: (address: string) => InternalAccount | undefined;
+};
+
 export type SnapInterfaceControllerGetStateAction = ControllerGetStateAction<
   typeof controllerName,
   SnapInterfaceControllerState
@@ -89,7 +96,8 @@ export type SnapInterfaceControllerAllowedActions =
   | HasApprovalRequest
   | AcceptRequest
   | GetSnap
-  | MultichainAssetsControllerGetStateAction;
+  | MultichainAssetsControllerGetStateAction
+  | AccountsControllerGetAccountByAddressAction;
 
 export type SnapInterfaceControllerActions =
   | CreateInterface
@@ -442,6 +450,27 @@ export class SnapInterfaceController extends BaseController<
     );
   }
 
+  /**
+   * Get an account by its address.
+   *
+   * @param address - The account address.
+   * @returns The account or undefined if not found.
+   */
+  #getAccountByAddress(address: CaipAccountId) {
+    const { address: parsedAddress } = parseCaipAccountId(address);
+
+    return this.messagingSystem.call(
+      'AccountsController:getAccountByAddress',
+      parsedAddress,
+    );
+  }
+
+  /**
+   * Get the asset metadata for a given asset ID.
+   *
+   * @param assetId - The asset ID.
+   * @returns The asset metadata or undefined if not found.
+   */
   #getAssetMetadata(assetId: CaipAssetType) {
     // TODO: Introduce an action in MultichainAssetsController to get a specific asset metadata.
     const assets = this.messagingSystem.call(
@@ -472,6 +501,8 @@ export class SnapInterfaceController extends BaseController<
       this.#checkPhishingList.bind(this),
       (id: string) => this.messagingSystem.call('SnapController:get', id),
     );
+
+    validateAssetSelector(element, this.#getAccountByAddress.bind(this));
   }
 
   #onNotificationsListUpdated(notificationsList: Notification[]) {

packages/snaps-controllers/src/interface/utils.test.tsx

@@ -23,6 +23,7 @@ import {
   constructState,
   getAssetSelectorStateValue,
   getJsxInterface,
+  validateAssetSelector,
 } from './utils';
 
 describe('getJsxInterface', () => {
@@ -885,3 +886,37 @@ describe('getAssetSelectorStateValue', () => {
     ).toBeNull();
   });
 });
+
+describe('validateAssetSelector', () => {
+  it('passes if the address is available in the client', () => {
+    const getAccountByAddress = jest.fn().mockReturnValue({
+      id: 'foo',
+    });
+
+    expect(
+      validateAssetSelector(
+        <AssetSelector
+          name="foo"
+          addresses={['eip155:0:0x1234567890123456789012345678901234567890']}
+        />,
+        getAccountByAddress,
+      ),
+    ).toBeUndefined();
+  });
+
+  it('throws if the address is not available in the client', () => {
+    const getAccountByAddress = jest.fn().mockReturnValue(undefined);
+
+    expect(() =>
+      validateAssetSelector(
+        <AssetSelector
+          name="foo"
+          addresses={['eip155:0:0x1234567890123456789012345678901234567890']}
+        />,
+        getAccountByAddress,
+      ),
+    ).toThrow(
+      `Could not find account for address: eip155:0:0x1234567890123456789012345678901234567890`,
+    );
+  });
+});

packages/snaps-controllers/src/interface/utils.ts

@@ -1,3 +1,4 @@
+import type { InternalAccount } from '@metamask/keyring-internal-api';
 import { assert } from '@metamask/snaps-sdk';
 import type {
   FormState,
@@ -28,11 +29,10 @@ import {
   getJsxElementFromComponent,
   walkJsx,
 } from '@metamask/snaps-utils';
-import type { CaipAssetType } from '@metamask/utils';
+import { type CaipAssetType, type CaipAccountId } from '@metamask/utils';
 
 /**
  * A function to get asset metadata.
- * This is used to get the metadata of an asset by its ID.
  *
  * @param assetId - The asset ID.
  * @returns The asset metadata or undefined if not found.
@@ -41,6 +41,16 @@ type GetAssetMetadata = (
   assetId: CaipAssetType,
 ) => FungibleAssetMetadata | undefined;
 
+/**
+ * A function to get an account by its address.
+ *
+ * @param address - The account address.
+ * @returns The account or undefined if not found.
+ */
+type GetAccountByAddress = (
+  address: CaipAccountId,
+) => InternalAccount | undefined;
+
 /**
  * Data getters for elements.
  * This is used to get data from elements that is not directly accessible from the element itself.
@@ -80,6 +90,33 @@ export function assertNameIsUnique(state: InterfaceState, name: string) {
   );
 }
 
+/**
+ * Validate the asset selector component.
+ *
+ * @param node - The JSX node to validate.
+ * @param getAccountByAddress - A function to get an account by its address.
+ *
+ * @throws If the asset selector is invalid.
+ */
+export function validateAssetSelector(
+  node: JSXElement,
+  getAccountByAddress: GetAccountByAddress,
+) {
+  walkJsx(node, (childNode) => {
+    if (childNode.type !== 'AssetSelector') {
+      return;
+    }
+
+    // We can assume that the addresses are the same for all CAIP account IDs
+    const account = getAccountByAddress(childNode.props.addresses[0]);
+
+    assert(
+      account,
+      `Could not find account for address: ${childNode.props.addresses[0]}`,
+    );
+  });
+}
+
 /**
  * Construct default state for a component.
  *

packages/snaps-controllers/src/test-utils/controller.ts

@@ -780,6 +780,7 @@ export const getRestrictedSnapInterfaceControllerMessenger = (
       'ApprovalController:hasRequest',
       'ApprovalController:acceptRequest',
       'MultichainAssetsController:getState',
+      'AccountsController:getAccountByAddress',
     ],
     allowedEvents: [
       'NotificationServicesController:notificationsListUpdated',
@@ -805,6 +806,16 @@ export const getRestrictedSnapInterfaceControllerMessenger = (
         accountsAssets: {},
       }),
     );
+
+    messenger.registerActionHandler(
+      'AccountsController:getAccountByAddress',
+      // @ts-expect-error partial mock
+      (address: string) => ({
+        address,
+        id: 'foo',
+        scopes: ['eip155:0'],
+      }),
+    );
   }
 
   return snapInterfaceControllerMessenger;