Add fallback to onchain metadata for any chain other than mainnet. Don't even try to return iconUrl, because we can't do anything with it anyways

Author: jeffsmale90

packages/gator-permissions-snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "8RuzV/zrJlK0VNzSDBoQQ8t1ecofnqNn8WL7MwNKfAE=",
+    "shasum": "lDkiV/mNq1vl4SG72M9dcOe2EuQQGhrmR+8QEsDeD9E=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/gator-permissions-snap/src/accountController/baseAccountController.ts

@@ -4,10 +4,11 @@ import type { SnapsProvider } from '@metamask/snaps-sdk';
 import * as chains from 'viem/chains';
 import type { Address } from 'viem';
 
+import type { AccountApiClient } from '../clients/accountApiClient';
 import type {
-  AccountApiClient,
+  TokenMetadataClient,
   TokenBalanceAndMetadata,
-} from '../clients/accountApiClient';
+} from '../core/types';
 import type {
   AccountOptionsBase,
   GetTokenBalanceAndMetadataOptions,
@@ -28,6 +29,8 @@ export abstract class BaseAccountController {
 
   readonly #accountApiClient: AccountApiClient;
 
+  readonly #tokenMetadataClient: TokenMetadataClient;
+
   protected supportedChains: SupportedChains;
 
   // the intersection between chains supported by viem, and chains supported by the delegator contracts
@@ -45,11 +48,13 @@ export abstract class BaseAccountController {
    * @param config.snapsProvider - The provider for interacting with snaps.
    * @param config.supportedChains - The supported blockchain chains.
    * @param config.accountApiClient - The client for interacting with the account API.
+   * @param config.tokenMetadataClient - The client for interacting with the token metadata.
    */
   constructor(config: {
     snapsProvider: SnapsProvider;
     supportedChains?: SupportedChains;
     accountApiClient: AccountApiClient;
+    tokenMetadataClient: TokenMetadataClient;
   }) {
     // only validate if supportedChains is specified, as it will default to ALL_SUPPORTED_CHAINS
     if (config.supportedChains) {
@@ -58,6 +63,7 @@ export abstract class BaseAccountController {
 
     this.#snapsProvider = config.snapsProvider;
     this.#accountApiClient = config.accountApiClient;
+    this.#tokenMetadataClient = config.tokenMetadataClient;
     this.supportedChains =
       config.supportedChains ?? BaseAccountController.#allSupportedChains;
   }
@@ -173,6 +179,26 @@ export abstract class BaseAccountController {
     options: AccountOptionsBase,
   ): Promise<Address>;
 
+  /**
+   * Gets the appropriate token metadata client for the given chain ID.
+   * Uses the account API client for mainnet (chain ID 1) and the blockchain client for other chains.
+   *
+   * @param params - The parameters object
+   * @param params.chainId - The chain ID to get the client for
+   * @returns The appropriate token metadata client
+   */
+  #getTokenMetadataClientForChainId({
+    chainId,
+  }: {
+    chainId: number;
+  }): TokenMetadataClient {
+    if (this.#accountApiClient.isChainIdSupported({ chainId })) {
+      return this.#accountApiClient;
+    }
+
+    return this.#tokenMetadataClient;
+  }
+
   /**
    * Retrieves the token balance and metadata for the account.
    *
@@ -190,12 +216,13 @@ export abstract class BaseAccountController {
 
     const account = await this.getAccountAddress({ chainId });
 
-    const balanceAndMetadata =
-      await this.#accountApiClient.getTokenBalanceAndMetadata({
-        chainId,
-        account,
-        assetAddress,
-      });
+    const client = this.#getTokenMetadataClientForChainId({ chainId });
+
+    const balanceAndMetadata = await client.getTokenBalanceAndMetadata({
+      chainId,
+      account,
+      assetAddress,
+    });
 
     logger.debug(
       'accountController:getTokenBalanceAndMetadata() - balance and metadata resolved',

packages/gator-permissions-snap/src/accountController/eoaAccountController.ts

@@ -4,8 +4,8 @@ import {
   type Delegation,
   type DeleGatorEnvironment,
 } from '@metamask/delegation-toolkit';
-import type { SnapsProvider } from '@metamask/snaps-sdk';
-import { type Address, type Hex } from 'viem';
+import type { SnapsEthereumProvider, SnapsProvider } from '@metamask/snaps-sdk';
+import { Hex, type Address } from 'viem';
 
 import { AccountApiClient } from '../clients/accountApiClient';
 import type { SupportedChains } from './baseAccountController';
@@ -16,10 +16,7 @@ import type {
   SignDelegationOptions,
   FactoryArgs,
 } from './types';
-
-export type EthereumProvider = {
-  request: (args: { method: string; params?: any[] }) => Promise<any>;
-};
+import type { TokenMetadataClient } from '../core/types';
 
 /**
  * Controls EOA account operations including address retrieval, delegation signing, and balance queries.
@@ -30,7 +27,7 @@ export class EoaAccountController
 {
   #accountAddress: Address | null = null;
 
-  #ethereumProvider: EthereumProvider;
+  #ethereumProvider: SnapsEthereumProvider;
 
   /**
    * Initializes a new EoaAccountController instance.
@@ -42,11 +39,13 @@ export class EoaAccountController
    */
   constructor(config: {
     snapsProvider: SnapsProvider;
-    ethereumProvider: EthereumProvider;
+    ethereumProvider: SnapsEthereumProvider;
     supportedChains?: SupportedChains;
+    tokenMetadataClient: TokenMetadataClient;
     accountApiClient: AccountApiClient;
   }) {
     super(config);
+
     this.#ethereumProvider = config.ethereumProvider;
   }
 
@@ -61,7 +60,7 @@ export class EoaAccountController
       return this.#accountAddress;
     }
 
-    const accounts = await this.#ethereumProvider.request({
+    const accounts = await this.#ethereumProvider.request<Hex[]>({
       method: 'eth_requestAccounts',
     });
 
@@ -105,7 +104,7 @@ export class EoaAccountController
 
     const address = await this.#getAccountAddress();
 
-    const selectedChain = await this.#ethereumProvider.request({
+    const selectedChain = await this.#ethereumProvider.request<Hex>({
       method: 'eth_chainId',
       params: [],
     });
@@ -121,7 +120,7 @@ export class EoaAccountController
       delegation,
     });
 
-    const signature = await this.#ethereumProvider.request({
+    const signature = await this.#ethereumProvider.request<Hex>({
       method: 'eth_signTypedData_v4',
       params: [address, signArgs],
     });

packages/gator-permissions-snap/src/accountController/smartAccountController.ts

@@ -25,6 +25,7 @@ import type {
   SignDelegationOptions,
   FactoryArgs,
 } from './types';
+import { TokenMetadataClient } from 'src/core/types';
 
 const GET_ENTROPY_SALT = '7715_permissions_provider_snap';
 const MULTISIG_THRESHOLD = 1n;
@@ -60,6 +61,7 @@ export class SmartAccountController
     snapsProvider: SnapsProvider;
     supportedChains?: SupportedChains;
     deploymentSalt: Hex;
+    tokenMetadataClient: TokenMetadataClient;
     accountApiClient: AccountApiClient;
   }) {
     super(config);

packages/gator-permissions-snap/src/accountController/types.ts

@@ -3,7 +3,7 @@ import type {
   DeleGatorEnvironment,
 } from '@metamask/delegation-toolkit';
 import type { Address, Hex } from 'viem';
-import type { TokenBalanceAndMetadata } from '../clients/accountApiClient';
+import type { TokenBalanceAndMetadata } from '../core/types';
 
 /**
  * Base options required for account operations.

packages/gator-permissions-snap/src/clients/accountApiClient.ts

@@ -1,6 +1,6 @@
 import { logger } from '@metamask/7715-permissions-shared/utils';
-import { IconUrls } from '../ui/iconConstant';
 import { isAddressEqual, zeroAddress, type Address } from 'viem';
+import type { TokenBalanceAndMetadata } from '../core/types';
 
 /**
  * Response type for token balance data
@@ -28,13 +28,6 @@ type TokenBalanceResponse = {
   }[];
 };
 
-export type TokenBalanceAndMetadata = {
-  balance: bigint;
-  decimals: number;
-  symbol: string;
-  iconUrl: string;
-};
-
 /**
  * Class responsible for fetching account data from the Account API.
  */
@@ -45,14 +38,29 @@ export class AccountApiClient {
 
   readonly #baseUrl: string;
 
-  constructor(
-    baseUrl: string,
-    fetch: typeof globalThis.fetch = globalThis.fetch,
-  ) {
+  constructor({
+    baseUrl,
+    fetch = globalThis.fetch,
+  }: {
+    baseUrl: string;
+    fetch?: typeof globalThis.fetch;
+  }) {
     this.#fetch = fetch;
     this.#baseUrl = baseUrl.replace(/\/+$/u, ''); // Remove trailing slashes
   }
 
+  /**
+   * Checks if a chain ID is supported by the account API.
+   * Currently only mainnet (chain ID 1) is supported.
+   *
+   * @param params - The parameters object
+   * @param params.chainId - The chain ID to check
+   * @returns True if the chain ID is supported, false otherwise
+   */
+  public isChainIdSupported({ chainId }: { chainId: number }): boolean {
+    return chainId === 1;
+  }
+
   /**
    * Fetch the token balance and metadata for a given account and token.
    *
@@ -128,21 +136,10 @@ export class AccountApiClient {
       throw new Error(message);
     }
 
-    // this is an awkward workaround. We cannot actually use the iconUrl from
-    // the response, because we must have an SVG literal. The service returns a
-    // png, and we cannot even fetch it due to CORs if it were svg.
-    const iconUrl = ICON_URLS[balanceData.iconUrl] ?? IconUrls.notFound.token;
-
     return {
       balance: BigInt(accountData.rawBalance),
       decimals: balanceData.decimals,
       symbol: balanceData.symbol,
-      iconUrl,
     };
   }
 }
-
-const ICON_URLS: Record<string, string> = {
-  'https://dev-static.cx.metamask.io/api/v1/tokenIcons/1/0x0000000000000000000000000000000000000000.png':
-    IconUrls.ethereum.token,
-};