refactor!: enforce that scopes contains CAIP-2 chain IDs

packages/keyring-api/src/api/account.test.ts

@@ -52,7 +52,7 @@ describe('api', () => {
         scopes: [scope],
       };
       expect(() => assert(account, KeyringAccountStruct)).toThrow(
-        `At path: scopes.0 -- Expected the value to satisfy a union of \`string | string\`, but received: "${scope}"`,
+        `At path: scopes.0 -- Expected a string matching \`/^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})$/\` but received "${scope}"`,
       );
     });
   });

packages/keyring-api/src/api/account.ts

@@ -1,18 +1,7 @@
 import { AccountIdStruct, object } from '@metamask/keyring-utils';
 import type { Infer } from '@metamask/superstruct';
-import {
-  nonempty,
-  array,
-  enums,
-  record,
-  string,
-  union,
-} from '@metamask/superstruct';
-import {
-  CaipChainIdStruct,
-  CaipNamespaceStruct,
-  JsonStruct,
-} from '@metamask/utils';
+import { nonempty, array, enums, record, string } from '@metamask/superstruct';
+import { CaipChainIdStruct, JsonStruct } from '@metamask/utils';
 
 /**
  * Supported Ethereum account types.
@@ -74,9 +63,9 @@ export const KeyringAccountStruct = object({
   address: string(),
 
   /**
-   * Account supported scopes (CAIP-2 chain IDs or CAIP-2 namespaces).
+   * Account supported scopes (CAIP-2 chain IDs).
    */
-  scopes: nonempty(array(union([CaipNamespaceStruct, CaipChainIdStruct]))),
+  scopes: nonempty(array(CaipChainIdStruct)),
 
   /**
    * Account options.

packages/keyring-api/src/btc/constants.ts

@@ -4,7 +4,6 @@
  * Scopes for Bitcoin account type. See {@link KeyringAccount.scopes}.
  */
 export enum BtcScope {
-  Namespace = 'bip122',
   Mainnet = 'bip122:000000000019d6689c085ae165831e93',
   Testnet = 'bip122:000000000933ea01ad0ee984209779ba',
   Testnet4 = 'bip122:00000000da84f2bafbbc53dee25a72ae',

packages/keyring-api/src/eth/constants.ts

@@ -4,7 +4,7 @@
  * Scopes for EVM account type. See {@link KeyringAccount.scopes}.
  */
 export enum EthScope {
-  Namespace = 'eip155',
+  Eoa = 'eip155:0',
   Mainnet = 'eip155:1',
   Testnet = 'eip155:11155111',
 }

packages/keyring-api/src/eth/types.ts

@@ -49,9 +49,9 @@ export const EthEoaAccountStruct = object({
   type: literal(`${EthAccountType.Eoa}`),
 
   /**
-   * Account scopes (must be ['eip155']).
+   * Account scopes (must be ['eip155:0']).
    */
-  scopes: nonempty(array(literal(EthScope.Namespace))),
+  scopes: nonempty(array(literal(EthScope.Eoa))),
 
   /**
    * Account supported methods.

packages/keyring-api/src/events.test.ts

@@ -22,7 +22,7 @@ describe('events', () => {
             address: '0x0123',
             methods: [],
             options: {},
-            scopes: [EthScope.Namespace],
+            scopes: [EthScope.Eoa],
             type: EthAccountType.Eoa,
           },
         },
@@ -40,7 +40,7 @@ describe('events', () => {
             address: '0x0123',
             methods: [],
             options: {},
-            scopes: [EthScope.Namespace],
+            scopes: [EthScope.Eoa],
             type: EthAccountType.Eoa,
           },
         },
@@ -58,7 +58,7 @@ describe('events', () => {
             address: '0x0123',
             methods: [],
             options: {},
-            scopes: [EthScope.Namespace],
+            scopes: [EthScope.Eoa],
             type: EthAccountType.Eoa,
           },
           displayConfirmation: true,
@@ -79,7 +79,7 @@ describe('events', () => {
             address: '0x0123',
             methods: [],
             options: {},
-            scopes: [EthScope.Namespace],
+            scopes: [EthScope.Eoa],
             type: EthAccountType.Eoa,
           },
         },
@@ -97,7 +97,7 @@ describe('events', () => {
             address: '0x0123',
             methods: [],
             options: {},
-            scopes: [EthScope.Namespace],
+            scopes: [EthScope.Eoa],
             type: EthAccountType.Eoa,
           },
         },

packages/keyring-api/src/sol/constants.ts

@@ -4,7 +4,6 @@
  * Scopes for Solana account type. See {@link KeyringAccount.scopes}.
  */
 export enum SolScope {
-  Namespace = 'solana',
   Devnet = 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1',
   Mainnet = 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp',
   Testnet = 'solana:4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z',

packages/keyring-internal-api/src/types.test.ts

@@ -5,7 +5,7 @@ import { InternalAccountStruct } from '.';
 
 describe('InternalAccount', () => {
   it.each([
-    { type: 'eip155:eoa', address: '0x000', scopes: ['eip155'] },
+    { type: 'eip155:eoa', address: '0x000', scopes: ['eip155:0'] },
     {
       type: 'bip122:p2wpkh',
       address: 'bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4',
@@ -37,7 +37,7 @@ describe('InternalAccount', () => {
       address: '0x000',
       options: {},
       methods: [],
-      scopes: ['eip155'],
+      scopes: ['eip155:0'],
       type: 'eip155:eoa',
       metadata: {
         keyring: {},
@@ -57,7 +57,7 @@ describe('InternalAccount', () => {
       address: '0x000',
       options: {},
       methods: [],
-      scopes: ['eip155'],
+      scopes: ['eip155:0'],
       type: 'eip155:eoa',
       metadata: {
         name: 'Account 1',
@@ -76,7 +76,7 @@ describe('InternalAccount', () => {
       address: '0x000',
       options: {},
       methods: [],
-      scopes: ['eip155'],
+      scopes: ['eip155:0'],
       type: 'eip155:eoa',
     };
 
@@ -105,7 +105,7 @@ describe('InternalAccount', () => {
       address: '0x000',
       options: {},
       methods: [],
-      scopes: ['eip155'],
+      scopes: ['eip155:0'],
       type: 'eip155:eoa',
       metadata: {
         keyring: {
@@ -129,7 +129,7 @@ describe('InternalAccount', () => {
       options: {},
       methods: [],
       type: 'eip155:eoa',
-      scopes: ['eip155'],
+      scopes: ['eip155:0'],
       metadata: {
         keyring: {
           type: 'Test Keyring',
@@ -155,7 +155,7 @@ describe('InternalAccount', () => {
         address: '0x000',
         options: {},
         methods: [],
-        scopes: ['eip155'],
+        scopes: ['eip155:0'],
         type: 'eip155:eoa',
         metadata: {
           keyring: {

packages/keyring-internal-snap-client/src/KeyringInternalSnapClient.test.ts

@@ -15,7 +15,7 @@ describe('KeyringInternalSnapClient', () => {
       address: '0xE9A74AACd7df8112911ca93260fC5a046f8a64Ae',
       options: {},
       methods: [],
-      scopes: ['eip155'],
+      scopes: ['eip155:0'],
       type: 'eip155:eoa',
     },
   ];

packages/keyring-snap-bridge/src/SnapKeyring.test.ts

@@ -24,7 +24,7 @@ import {
   SolScope,
 } from '@metamask/keyring-api';
 import type { SnapId } from '@metamask/snaps-sdk';
-import { toCaipChainId } from '@metamask/utils';
+import { KnownCaipNamespace, toCaipChainId } from '@metamask/utils';
 
 import type { KeyringState } from '.';
 import { SnapKeyring } from '.';
@@ -104,23 +104,23 @@ describe('SnapKeyring', () => {
     address: '0xC728514Df8A7F9271f4B7a4dd2Aa6d2D723d3eE3'.toLowerCase(),
     options: {},
     methods: ETH_EOA_METHODS,
-    scopes: [EthScope.Namespace],
+    scopes: [EthScope.Eoa],
     type: EthAccountType.Eoa,
   };
   const ethEoaAccount2 = {
     id: '33c96b60-2237-488e-a7bb-233576f3d22f',
     address: '0x34b13912eAc00152bE0Cb409A301Ab8E55739e63'.toLowerCase(),
     options: {},
     methods: ETH_EOA_METHODS,
-    scopes: [EthScope.Namespace],
+    scopes: [EthScope.Eoa],
     type: EthAccountType.Eoa,
   };
   const ethEoaAccount3 = {
     id: 'c6697bcf-5710-4751-a1cb-340e4b50617a',
     address: '0xf7bDe8609231033c69E502C08f85153f8A1548F2'.toLowerCase(),
     options: {},
     methods: ETH_EOA_METHODS,
-    scopes: [EthScope.Namespace],
+    scopes: [EthScope.Eoa],
     type: EthAccountType.Eoa,
   };
   const ethErc4337Account = {
@@ -162,7 +162,7 @@ describe('SnapKeyring', () => {
     methods: [],
     // For unknown accounts, we consider them as EVM EOA for now, so just re-use the
     // same scopes.
-    scopes: [EthScope.Namespace],
+    scopes: [EthScope.Eoa],
     // This should not be really possible to create such account, but since we potentially
     // migrate data upon the Snap keyring initialization, we want to cover edge-cases
     // like this one to avoid crashing and blocking everything...
@@ -237,7 +237,7 @@ describe('SnapKeyring', () => {
           id: 'b05d918a-b37c-497a-bb28-3d15c0d56b7a',
           options: {},
           methods: ETH_EOA_METHODS,
-          scopes: [EthScope.Namespace],
+          scopes: [EthScope.Eoa],
           type: EthAccountType.Eoa,
           // Even checksummed address will be lower-cased by the bridge.
           address: '0x6431726EEE67570BF6f0Cf892aE0a3988F03903F',
@@ -429,7 +429,7 @@ describe('SnapKeyring', () => {
           metadata: expect.any(Object),
           // By default, new EVM accounts will have this scopes if it not provided
           // during the account creation flow.
-          scopes: [EthScope.Namespace],
+          scopes: [EthScope.Eoa],
         });
       });
 
@@ -707,7 +707,7 @@ describe('SnapKeyring', () => {
 
         const keyringAccounts = keyring.listAccounts();
         expect(keyringAccounts.length).toBeGreaterThan(0);
-        expect(keyringAccounts[0]?.scopes).toStrictEqual([EthScope.Namespace]);
+        expect(keyringAccounts[0]?.scopes).toStrictEqual([EthScope.Eoa]);
       });
 
       it('updates a ERC4337 account with the no scope will throw an error', async () => {
@@ -1044,7 +1044,7 @@ describe('SnapKeyring', () => {
 
     it('unknown v1 accounts scopes defaults to EOA scopes', () => {
       expect(getScopesForAccountV1(unknownAccount)).toStrictEqual([
-        EthScope.Namespace,
+        EthScope.Eoa,
       ]);
     });
   });
@@ -1472,7 +1472,10 @@ describe('SnapKeyring', () => {
           method: 'keyring_submitRequest',
           params: {
             id: expect.any(String),
-            scope: toCaipChainId(EthScope.Namespace, executionContext.chainId),
+            scope: toCaipChainId(
+              KnownCaipNamespace.Eip155,
+              executionContext.chainId,
+            ),
             account: ethErc4337Account.id,
             request: {
               method: 'eth_prepareUserOperation',
@@ -1525,7 +1528,10 @@ describe('SnapKeyring', () => {
           method: 'keyring_submitRequest',
           params: {
             id: expect.any(String),
-            scope: toCaipChainId(EthScope.Namespace, executionContext.chainId),
+            scope: toCaipChainId(
+              KnownCaipNamespace.Eip155,
+              executionContext.chainId,
+            ),
             account: ethErc4337Account.id,
             request: {
               method: 'eth_patchUserOperation',
@@ -1574,7 +1580,10 @@ describe('SnapKeyring', () => {
           method: 'keyring_submitRequest',
           params: {
             id: expect.any(String),
-            scope: toCaipChainId(EthScope.Namespace, executionContext.chainId),
+            scope: toCaipChainId(
+              KnownCaipNamespace.Eip155,
+              executionContext.chainId,
+            ),
             account: ethErc4337Account.id,
             request: {
               method: 'eth_signUserOperation',
@@ -1799,7 +1808,10 @@ describe('SnapKeyring', () => {
           method: 'keyring_submitRequest',
           params: {
             id: expect.any(String),
-            scope: toCaipChainId(EthScope.Namespace, executionContext.chainId),
+            scope: toCaipChainId(
+              KnownCaipNamespace.Eip155,
+              executionContext.chainId,
+            ),
             account: ethErc4337Account.id,
             request: {
               method: 'eth_prepareUserOperation',
@@ -1866,7 +1878,10 @@ describe('SnapKeyring', () => {
           method: 'keyring_submitRequest',
           params: {
             id: expect.any(String),
-            scope: toCaipChainId(EthScope.Namespace, executionContext.chainId),
+            scope: toCaipChainId(
+              KnownCaipNamespace.Eip155,
+              executionContext.chainId,
+            ),
             account: ethErc4337Account.id,
             request: {
               method: 'eth_patchUserOperation',

packages/keyring-snap-bridge/src/migrations/v1.ts

@@ -9,6 +9,7 @@ import {
 } from '@metamask/keyring-api';
 import { isBtcMainnetAddress } from '@metamask/keyring-utils';
 import { is } from '@metamask/superstruct';
+import type { CaipChainId } from '@metamask/utils';
 
 import {
   assertKeyringAccount,
@@ -35,12 +36,16 @@ export function isAccountV1(
  * @param accountV1 - A v1 account.
  * @returns The list of scopes for that accounts.
  */
-export function getScopesForAccountV1(accountV1: KeyringAccountV1): string[] {
+export function getScopesForAccountV1(
+  accountV1: KeyringAccountV1,
+): CaipChainId[] {
   switch (accountV1.type) {
     case EthAccountType.Eoa: {
-      // EVM EOA account are compatible with any EVM networks, and we use CAIP-2
-      // namespaces when the scope relates to ALL chains (from that namespace).
-      return [EthScope.Namespace];
+      // EVM EOA account are compatible with any EVM networks, we use the
+      // 'eip155:0' scope as defined in the EVM CAIP-10 namespaces.
+      //
+      // See: https://namespaces.chainagnostic.org/eip155/caip10
+      return [EthScope.Eoa];
     }
     case EthAccountType.Erc4337: {
       // EVM Erc4337 account
@@ -64,7 +69,7 @@ export function getScopesForAccountV1(accountV1: KeyringAccountV1): string[] {
     }
     default:
       // We re-use EOA scopes if we don't know what to do for now.
-      return [EthScope.Namespace];
+      return [EthScope.Eoa];
   }
 }