Fetch token metadata (#99)

* Add accountApiClient and corresponding tests to fetch account balance and metadata

* Use accountApiClient within AccountController to fetch token metadata and balance

- Introduce 'getTokenBalanceAndMetadata' to account controllers
- Add placeholder icons for missing network/token SVGs
- Replace hardcoded ETH token details in UI with dynamic values

* 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

* Update native-token-periodic permission

* Fix linting problems

* Minor tidy ups to metadata client implementation

- Introduce ACCOUNT_API_BASE_URL to snap config and enforce presence
- Rename tokenMetadataClient to blockchainMetadataClient
- Improve dynamic chain handling and call encoding in token metadata client
- Add tests for BlockchainTokenMetadataClient

* Remove errant console.logs from debugging

* Update build-lint-test action
- Add ACCOUNT_API_BASE_URL
- Move configuration out of individual steps to avoid duplication

* Ignore iconUrl received from AccountAPI

* Decompose token balance and metadata out of account controller into TokenMetadataService.

* Fix linting problems in tests

Author: jeffsmale90

.github/workflows/build-lint-test.yml

@@ -3,15 +3,17 @@ name: Build, Lint, and Test
 on:
   workflow_call:
 
+env:
+  SNAP_ENV: ${{ vars.SNAP_ENV }}
+  PRICE_API_BASE_URL: ${{ vars.PRICE_API_BASE_URL }}
+  STORE_PERMISSIONS_ENABLED: ${{ vars.STORE_PERMISSIONS_ENABLED }}
+  USE_EOA_ACCOUNT: ${{ vars.USE_EOA_ACCOUNT }}
+  ACCOUNT_API_BASE_URL: ${{ vars.ACCOUNT_API_BASE_URL }}
+
 jobs:
   prepare:
     name: Prepare
     runs-on: ubuntu-latest
-    env:
-      SNAP_ENV: ${{ vars.SNAP_ENV }}
-      PRICE_API_BASE_URL: ${{ vars.PRICE_API_BASE_URL }}
-      STORE_PERMISSIONS_ENABLED: ${{ vars.STORE_PERMISSIONS_ENABLED }}
-      USE_EOA_ACCOUNT: ${{ vars.USE_EOA_ACCOUNT }}
     strategy:
       matrix:
         node-version: [21.x]
@@ -32,11 +34,6 @@ jobs:
   validate-changelog:
     name: Validate changelog
     runs-on: ubuntu-latest
-    env:
-      SNAP_ENV: ${{ vars.SNAP_ENV }}
-      PRICE_API_BASE_URL: ${{ vars.PRICE_API_BASE_URL }}
-      STORE_PERMISSIONS_ENABLED: ${{ vars.STORE_PERMISSIONS_ENABLED }}
-      USE_EOA_ACCOUNT: ${{ vars.USE_EOA_ACCOUNT }}
     needs:
       - prepare
     strategy:
@@ -59,11 +56,6 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
-    env:
-      SNAP_ENV: ${{ vars.SNAP_ENV }}
-      PRICE_API_BASE_URL: ${{ vars.PRICE_API_BASE_URL }}
-      STORE_PERMISSIONS_ENABLED: ${{ vars.STORE_PERMISSIONS_ENABLED }}
-      USE_EOA_ACCOUNT: ${{ vars.USE_EOA_ACCOUNT }}
     needs:
       - prepare
     strategy:
@@ -96,10 +88,6 @@ jobs:
   lint:
     name: Lint
     runs-on: ubuntu-latest
-    env:
-      SNAP_ENV: ${{ vars.SNAP_ENV }}
-      PRICE_API_BASE_URL: ${{ vars.PRICE_API_BASE_URL }}
-      STORE_PERMISSIONS_ENABLED: ${{ vars.STORE_PERMISSIONS_ENABLED }}
     needs:
       - prepare
     strategy:
@@ -122,11 +110,6 @@ jobs:
   test:
     name: Test
     runs-on: ubuntu-latest
-    env:
-      SNAP_ENV: ${{ vars.SNAP_ENV }}
-      PRICE_API_BASE_URL: ${{ vars.PRICE_API_BASE_URL }}
-      STORE_PERMISSIONS_ENABLED: ${{ vars.STORE_PERMISSIONS_ENABLED }}
-      USE_EOA_ACCOUNT: ${{ vars.USE_EOA_ACCOUNT }}
     needs:
       - prepare
       - build

packages/gator-permissions-snap/.env.example

@@ -15,4 +15,5 @@ USE_EOA_ACCOUNT=false
 # Prod
 SNAP_ENV=production
 STORE_PERMISSIONS_ENABLED=false
-PRICE_API_BASE_URL=https://price.api.cx.metamask.io
+PRICE_API_BASE_URL=https://price.api.cx.metamask.io
+ACCOUNT_API_BASE_URL=https://account.api.cx.metamask.io

packages/gator-permissions-snap/snap.config.ts

@@ -10,6 +10,7 @@ const {
   PRICE_API_BASE_URL,
   STORE_PERMISSIONS_ENABLED,
   USE_EOA_ACCOUNT,
+  ACCOUNT_API_BASE_URL,
 } = process.env;
 
 if (!SNAP_ENV) {
@@ -36,9 +37,7 @@ if (
 }
 
 if (!USE_EOA_ACCOUNT) {
-  throw new Error(
-    'STORE_PERMISSIONS_ENABLED must be set as an environment variable.',
-  );
+  throw new Error('USE_EOA_ACCOUNT must be set as an environment variable.');
 }
 
 if (USE_EOA_ACCOUNT !== 'true' && USE_EOA_ACCOUNT !== 'false') {
@@ -47,6 +46,12 @@ if (USE_EOA_ACCOUNT !== 'true' && USE_EOA_ACCOUNT !== 'false') {
   );
 }
 
+if (!ACCOUNT_API_BASE_URL) {
+  throw new Error(
+    'ACCOUNT_API_BASE_URL must be set as an environment variable.',
+  );
+}
+
 const config: SnapConfig = {
   bundler: 'webpack',
   input: resolve(__dirname, 'src/index.ts'),
@@ -62,6 +67,7 @@ const config: SnapConfig = {
     PRICE_API_BASE_URL,
     STORE_PERMISSIONS_ENABLED,
     USE_EOA_ACCOUNT,
+    ACCOUNT_API_BASE_URL,
   },
 };
 

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

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "B/45l1lyLyqYX2GkYxvKAmCCWOCSu030Do+IEMdQV+c=",
+    "shasum": "daaQiXVVVvJGgI2PHBl9UFJmPMxoie2tGD1TOxPIQmE=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

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

@@ -14,7 +14,7 @@ type SupportedChainId = SupportedChains[number]['id'];
  * Base class for account controllers that provides common functionality.
  */
 export abstract class BaseAccountController {
-  #snapsProvider: SnapsProvider;
+  readonly #snapsProvider: SnapsProvider;
 
   protected supportedChains: SupportedChains;
 
@@ -37,7 +37,7 @@ export abstract class BaseAccountController {
     snapsProvider: SnapsProvider;
     supportedChains?: SupportedChains;
   }) {
-    // only validate if supportedChains is specified, as it will default to ALL_SUPPORTED_CHAINS
+    // only validate if supportedChains is specified, as it will default to #allSupportedChains
     if (config.supportedChains) {
       this.#validateSupportedChains(config.supportedChains);
     }

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

@@ -4,8 +4,9 @@ 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 type { Hex } from 'viem';
+import { type Address } from 'viem';
 
 import type { SupportedChains } from './baseAccountController';
 import { BaseAccountController } from './baseAccountController';
@@ -16,10 +17,6 @@ import type {
   FactoryArgs,
 } from './types';
 
-export type EthereumProvider = {
-  request: (args: { method: string; params?: any[] }) => Promise<any>;
-};
-
 /**
  * Controls EOA account operations including address retrieval, delegation signing, and balance queries.
  */
@@ -29,7 +26,7 @@ export class EoaAccountController
 {
   #accountAddress: Address | null = null;
 
-  #ethereumProvider: EthereumProvider;
+  #ethereumProvider: SnapsEthereumProvider;
 
   /**
    * Initializes a new EoaAccountController instance.
@@ -40,10 +37,11 @@ export class EoaAccountController
    */
   constructor(config: {
     snapsProvider: SnapsProvider;
-    ethereumProvider: EthereumProvider;
+    ethereumProvider: SnapsEthereumProvider;
     supportedChains?: SupportedChains;
   }) {
     super(config);
+
     this.#ethereumProvider = config.ethereumProvider;
   }
 
@@ -58,7 +56,7 @@ export class EoaAccountController
       return this.#accountAddress;
     }
 
-    const accounts = await this.#ethereumProvider.request({
+    const accounts = await this.#ethereumProvider.request<Hex[]>({
       method: 'eth_requestAccounts',
     });
 
@@ -102,7 +100,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: [],
     });
@@ -118,7 +116,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],
     });
@@ -198,30 +196,6 @@ export class EoaAccountController
     };
   }
 
-  /**
-   * Retrieves the balance of the EOA account.
-   * @param options - The options object containing chain information.
-   * @returns The account balance in hex format.
-   */
-  public async getAccountBalance(options: AccountOptionsBase): Promise<Hex> {
-    logger.debug('eoaAccountController:getAccountBalance()');
-
-    this.assertIsSupportedChainId(options.chainId);
-
-    const address = await this.#getAccountAddress();
-
-    const provider = this.createExperimentalProviderRequestProvider(
-      options.chainId,
-    );
-
-    const balance = await provider.request({
-      method: 'eth_getBalance',
-      params: [address, 'latest'],
-    });
-
-    return balance as Hex;
-  }
-
   /**
    * Retrieves the delegation manager address.
    * @param options - The options object containing chain information.

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

@@ -207,40 +207,24 @@ export class SmartAccountController
   }
 
   /**
-   * Retrieves the balance of the smart account.
+   * Retrieves the environment for the current account.
    *
    * @param options - The base account options including chainId.
-   * @returns A promise resolving to the account balance as a hex string.
+   * @returns A promise resolving to a DeleGatorEnvironment.
    */
-  public async getAccountBalance(options: AccountOptionsBase): Promise<Hex> {
-    logger.debug('accountController:getAccountBalance()');
-
-    const { chainId } = options;
+  public async getEnvironment(
+    options: AccountOptionsBase,
+  ): Promise<DeleGatorEnvironment> {
+    logger.debug('accountController:getEnvironment()');
 
     const smartAccount = await this.#getMetaMaskSmartAccount(options);
 
     logger.debug(
-      'accountController:getAccountBalance() - smartAccount resolved',
+      'accountController:getEnvironment() - smartAccount resolved',
       smartAccount,
     );
 
-    this.assertIsSupportedChainId(chainId);
-
-    const provider = this.createExperimentalProviderRequestProvider(chainId);
-
-    const accountAddress = await smartAccount.getAddress();
-
-    const balance = await provider.request({
-      method: 'eth_getBalance',
-      params: [accountAddress, 'latest'],
-    });
-
-    logger.debug(
-      'accountController:getAccountBalance() - balance resolved',
-      balance,
-    );
-
-    return balance as Hex;
+    return smartAccount.environment;
   }
 
   /**
@@ -272,25 +256,4 @@ export class SmartAccountController
 
     return { ...delegation, signature };
   }
-
-  /**
-   * Retrieves the environment for the current account.
-   *
-   * @param options - The base account options including chainId.
-   * @returns A promise resolving to a DeleGatorEnvironment.
-   */
-  public async getEnvironment(
-    options: AccountOptionsBase,
-  ): Promise<DeleGatorEnvironment> {
-    logger.debug('accountController:getEnvironment()');
-
-    const smartAccount = await this.#getMetaMaskSmartAccount(options);
-
-    logger.debug(
-      'accountController:getEnvironment() - smartAccount resolved',
-      smartAccount,
-    );
-
-    return smartAccount.environment;
-  }
 }

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

@@ -46,11 +46,6 @@ export type AccountController = {
    */
   getAccountMetadata(options: AccountOptionsBase): Promise<FactoryArgs>;
 
-  /**
-   * Retrieves the balance of the smart account.
-   */
-  getAccountBalance(options: AccountOptionsBase): Promise<Hex>;
-
   /**
    * Retrieves the delegation manager address for the current account.
    */