Reduce usage of @metamask/delegation-toolkit and viem (#107)

* Initial pass at removing @metamask/delegation-toolkit. Dependency remains for SmartContractAccountManager.

Fix erc20PeriodicTransfer

* Add unit formatting utils. Rename balance utils to value utils.

* Remove viem Abi coding, remove viem assertions

* Add chainMetadata, resolve lint errors

* Fix bug where invalid caveat was added to native token stream permission

* Minor improvements:
- use string concatenation to produce storage key in profile sync
- introduce ZERO_ADDRESS constant that is shared between consumers in gator snap

* Fix bug in value parsing where empty part resulted in error.
Improve type alignment in SmartAccountController (although the types _were_ identical, it was slightly confusing).

Author: jeffsmale90

packages/gator-permissions-snap/package.json

@@ -47,6 +47,8 @@
     "test": "jest"
   },
   "dependencies": {
+    "@metamask/abi-utils": "^3.0.0",
+    "@metamask/delegation-core": "0.1.0",
     "@metamask/delegation-toolkit": "0.10.2",
     "@metamask/profile-sync-controller": "^12.0.0",
     "@metamask/snaps-sdk": "^6.17.1",

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

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "tmWf9Cs6ZEvAWQ3dATmdBU8nIH8BjJsUHuJfaRcnsZs=",
+    "shasum": "e/MzuAeBepqg3OfGRH9GUTee7E1tvxWrwDIs9xKk+78=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

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

@@ -1,30 +1,15 @@
 import { logger } from '@metamask/7715-permissions-shared/utils';
-import { CHAIN_ID as ChainsWithDelegatorDeployed } from '@metamask/delegation-toolkit';
 import type { SnapsProvider } from '@metamask/snaps-sdk';
-import * as chains from 'viem/chains';
 
-export type SupportedChains =
-  (typeof chains)[keyof typeof ChainsWithDelegatorDeployed &
-    keyof typeof chains][];
-
-// all of the chainIds that have delegator contracts deployed
-type SupportedChainId = SupportedChains[number]['id'];
+import { getChainMetadata } from '../core/chainMetadata';
 
 /**
  * Base class for account controllers that provides common functionality.
  */
 export abstract class BaseAccountController {
   readonly #snapsProvider: SnapsProvider;
 
-  protected supportedChains: SupportedChains;
-
-  // the intersection between chains supported by viem, and chains supported by the delegator contracts
-  // chains is asserted to any here due to the inability to infer the namespace of the global import
-  static #allSupportedChains = Object.keys(chains)
-    .filter((name) => name in ChainsWithDelegatorDeployed)
-    .map(
-      (name) => (chains as any)[name as keyof typeof chains],
-    ) as SupportedChains;
+  protected supportedChains: readonly number[];
 
   /**
    * Initializes a new BaseAccountController instance.
@@ -35,16 +20,12 @@ export abstract class BaseAccountController {
    */
   constructor(config: {
     snapsProvider: SnapsProvider;
-    supportedChains?: SupportedChains;
+    supportedChains: readonly number[];
   }) {
-    // only validate if supportedChains is specified, as it will default to #allSupportedChains
-    if (config.supportedChains) {
-      this.#validateSupportedChains(config.supportedChains);
-    }
+    this.#validateSupportedChains(config.supportedChains);
 
     this.#snapsProvider = config.snapsProvider;
-    this.supportedChains =
-      config.supportedChains ?? BaseAccountController.#allSupportedChains;
+    this.supportedChains = config.supportedChains;
   }
 
   /**
@@ -53,35 +34,22 @@ export abstract class BaseAccountController {
    * @param supportedChains - The chains to validate.
    * @throws If no chains are specified or if any chain is not supported.
    */
-  #validateSupportedChains(supportedChains: SupportedChains) {
+  #validateSupportedChains(supportedChains: readonly number[]) {
     if (supportedChains.length === 0) {
       logger.error('No supported chains specified');
       throw new Error('No supported chains specified');
     }
 
-    // Get chain names from config and check if they're supported by delegator
-    const configuredChains = Object.keys(chains)
-      .filter((name) => {
-        // assert chains to any here due to the inability to infer the namespace of the global import
-        const chain = (chains as any)[name as keyof typeof chains];
-        return supportedChains.some(
-          (supportedChain) => supportedChain.id === chain.id,
-        );
-      })
-      .map((name) => name.toLowerCase());
-
-    const chainsWithDelegatorDeployed = Object.keys(
-      ChainsWithDelegatorDeployed,
-    ).map((name) => name.toLowerCase());
-
-    const unsupportedChains = configuredChains.filter(
-      (chain) => !chainsWithDelegatorDeployed.includes(chain),
-    );
-
-    if (unsupportedChains.length > 0) {
-      logger.error('Unsupported chains specified', unsupportedChains);
+    // ensure that there is chain metadata for all specified chains
+    try {
+      supportedChains.map((chainId) => getChainMetadata({ chainId }));
+    } catch (error) {
+      logger.error('Unsupported chains specified', {
+        supportedChains,
+        error,
+      });
       throw new Error(
-        `Unsupported chains specified: ${unsupportedChains.join(', ')}`,
+        `Unsupported chains specified: ${supportedChains.join(', ')}`,
       );
     }
   }
@@ -92,10 +60,8 @@ export abstract class BaseAccountController {
    * @param chainId - The chain ID to validate.
    * @throws If the chain ID is not supported.
    */
-  protected assertIsSupportedChainId(
-    chainId: number,
-  ): asserts chainId is SupportedChainId {
-    if (!this.supportedChains.some((chain) => chain.id === chainId)) {
+  protected assertIsSupportedChainId(chainId: number) {
+    if (!this.supportedChains.includes(chainId)) {
       logger.error(
         'accountController:assertIsSupportedChainId() - unsupported chainId',
         {
@@ -112,9 +78,7 @@ export abstract class BaseAccountController {
    * @param chainId - The chain ID for the provider.
    * @returns A provider object with a request method.
    */
-  protected createExperimentalProviderRequestProvider(
-    chainId: SupportedChainId,
-  ) {
+  protected createExperimentalProviderRequestProvider(chainId: number) {
     return {
       request: async (request: { method: string; params?: unknown[] }) => {
         logger.debug(

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

@@ -1,14 +1,8 @@
 import { logger } from '@metamask/7715-permissions-shared/utils';
-import {
-  getDeleGatorEnvironment,
-  type Delegation,
-  type DeleGatorEnvironment,
-} from '@metamask/delegation-toolkit';
+import { type Hex, type Delegation } from '@metamask/delegation-core';
 import type { SnapsEthereumProvider, SnapsProvider } from '@metamask/snaps-sdk';
-import type { Hex } from 'viem';
-import { type Address } from 'viem';
 
-import type { SupportedChains } from './baseAccountController';
+import { getChainMetadata } from '../core/chainMetadata';
 import { BaseAccountController } from './baseAccountController';
 import type {
   AccountController,
@@ -24,7 +18,7 @@ export class EoaAccountController
   extends BaseAccountController
   implements AccountController
 {
-  #accountAddress: Address | null = null;
+  #accountAddress: Hex | null = null;
 
   #ethereumProvider: SnapsEthereumProvider;
 
@@ -38,7 +32,7 @@ export class EoaAccountController
   constructor(config: {
     snapsProvider: SnapsProvider;
     ethereumProvider: SnapsEthereumProvider;
-    supportedChains?: SupportedChains;
+    supportedChains: readonly number[];
   }) {
     super(config);
 
@@ -49,7 +43,7 @@ export class EoaAccountController
    * Gets the connected account address, requesting access if needed.
    * @returns The account address.
    */
-  async #getAccountAddress(): Promise<Address> {
+  async #getAccountAddress(): Promise<Hex> {
     logger.debug('eoaAccountController:#getAccountAddress()');
 
     if (this.#accountAddress) {
@@ -64,7 +58,8 @@ export class EoaAccountController
       throw new Error('No accounts found');
     }
 
-    this.#accountAddress = accounts[0] as Address;
+    this.#accountAddress = accounts[0] as Hex;
+
     return this.#accountAddress;
   }
 
@@ -76,7 +71,7 @@ export class EoaAccountController
    */
   public async getAccountAddress({
     chainId,
-  }: AccountOptionsBase): Promise<Address> {
+  }: AccountOptionsBase): Promise<Hex> {
     logger.debug('eoaAccountController:getAccountAddress()');
 
     this.assertIsSupportedChainId(chainId);
@@ -109,7 +104,10 @@ export class EoaAccountController
       throw new Error('Selected chain does not match the requested chain');
     }
 
-    const delegationManager = await this.getDelegationManager(options);
+    const {
+      contracts: { delegationManager },
+    } = getChainMetadata({ chainId });
+
     const signArgs = this.#getSignDelegationArgs({
       chainId,
       delegationManager,
@@ -137,7 +135,7 @@ export class EoaAccountController
     delegation,
   }: {
     chainId: number;
-    delegationManager: Address;
+    delegationManager: Hex;
     delegation: Omit<Delegation, 'signature'>;
   }) {
     logger.debug('eoaAccountController:#getSignDelegationArgs()');
@@ -195,37 +193,4 @@ export class EoaAccountController
       factoryData: undefined,
     };
   }
-
-  /**
-   * Retrieves the delegation manager address.
-   * @param options - The options object containing chain information.
-   * @returns The delegation manager address.
-   */
-  public async getDelegationManager(
-    options: AccountOptionsBase,
-  ): Promise<Address> {
-    logger.debug('eoaAccountController:getDelegationManager()');
-
-    const { DelegationManager } = await this.getEnvironment(options);
-
-    return DelegationManager;
-  }
-
-  /**
-   * Retrieves the environment for the current account.
-   * @param options0 - The options object containing chain information.
-   * @param options0.chainId - The ID of the blockchain chain.
-   * @returns The DeleGator environment configuration.
-   */
-  public async getEnvironment({
-    chainId,
-  }: AccountOptionsBase): Promise<DeleGatorEnvironment> {
-    logger.debug('eoaAccountController:getEnvironment()');
-
-    this.assertIsSupportedChainId(chainId);
-
-    const environment = getDeleGatorEnvironment(chainId);
-
-    return environment;
-  }
 }