@metamask/accounts-controller 37.1.1 → 38.0.0

package/dist/utils.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.constructAccountIdByAddress = exports.isHdSnapKeyringAccount = exports.HdSnapKeyringAccountOptionsStruct = exports.getEvmGroupIndexFromAddressIndex = exports.getEvmDerivationPathForIndex = exports.isHdKeyringType = exports.isSimpleKeyringType = exports.isSnapKeyringType = exports.isNormalKeyringType = exports.getUUIDFromAddressOfNormalAccount = exports.getUUIDOptionsFromAddressOfNormalAccount = exports.keyringTypeToName = void 0;
+exports.constructAccountIdByAddress = exports.isHdSnapKeyringAccount = exports.HdSnapKeyringAccountOptionsStruct = exports.getEvmGroupIndexFromAddressIndex = exports.getEvmDerivationPathForIndex = exports.isMoneyKeyringType = exports.isHdKeyringType = exports.isSimpleKeyringType = exports.isSnapKeyringV2Type = exports.isSnapKeyringType = exports.isNormalKeyringType = exports.getUUIDFromAddressOfNormalAccount = exports.getUUIDOptionsFromAddressOfNormalAccount = exports.keyringTypeToName = void 0;
+const v2_1 = require("@metamask/keyring-api/v2");
 const keyring_controller_1 = require("@metamask/keyring-controller");
 const superstruct_1 = require("@metamask/superstruct");
 const utils_1 = require("@metamask/utils");
@@ -35,9 +36,17 @@ function keyringTypeToName(keyringType) {
         case keyring_controller_1.KeyringTypes.qr: {
             return 'QR';
         }
+        case v2_1.KeyringType.Snap:
         case keyring_controller_1.KeyringTypes.snap: {
             return 'Snap Account';
         }
+        case keyring_controller_1.KeyringTypes.money: {
+            // NOTE: We don't use Money keyring/accounts within this controller. However, since this
+            // function only use the keyring type to return a name, we still support it here in case
+            // clients need it.
+            // FIXME: This should probably live in the `KeyringController` package instead.
+            return 'Money';
+        }
         default: {
             throw new Error(`Unknown keyring ${keyringType}`);
         }
@@ -74,9 +83,9 @@ exports.getUUIDFromAddressOfNormalAccount = getUUIDFromAddressOfNormalAccount;
  * @returns True if the keyring type is considered a "normal" keyring, false otherwise.
  */
 function isNormalKeyringType(keyringType) {
-    // Right now, we only have to "exclude" Snap accounts, but this might need to be
-    // adapted later on if we have new kind of keyrings!
-    return keyringType !== keyring_controller_1.KeyringTypes.snap;
+    return (!isSnapKeyringType(keyringType) &&
+        !isSnapKeyringV2Type(keyringType) &&
+        !isMoneyKeyringType(keyringType));
 }
 exports.isNormalKeyringType = isNormalKeyringType;
 /**
@@ -89,6 +98,16 @@ function isSnapKeyringType(keyringType) {
     return keyringType === keyring_controller_1.KeyringTypes.snap;
 }
 exports.isSnapKeyringType = isSnapKeyringType;
+/**
+ * Check if a keyring type is a Snap keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is considered a Snap keyring, false otherwise.
+ */
+function isSnapKeyringV2Type(keyringType) {
+    return keyringType === v2_1.KeyringType.Snap;
+}
+exports.isSnapKeyringV2Type = isSnapKeyringV2Type;
 /**
  * Check if a keyring type is a simple keyring.
  *
@@ -109,6 +128,16 @@ function isHdKeyringType(keyringType) {
     return keyringType === keyring_controller_1.KeyringTypes.hd;
 }
 exports.isHdKeyringType = isHdKeyringType;
+/**
+ * Check if a keyring type is a Money keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is a Money keyring, false otherwise.
+ */
+function isMoneyKeyringType(keyringType) {
+    return keyringType === keyring_controller_1.KeyringTypes.money;
+}
+exports.isMoneyKeyringType = isMoneyKeyringType;
 /**
  * Get the derivation path for the index of an account within a EVM HD keyring.
  *

package/dist/utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AACA,qEAA4D;AAG5D,uDAAiE;AACjE,2CAA6C;AAC7C,yDAAsD;AAEtD,+BAAkC;AAIlC;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,WAAmB;IACnD,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,iCAAY,CAAC,OAAO,CAAC,CAAC,CAAC;YAC1B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,KAAK,iCAAY,CAAC,IAAI,CAAC,CAAC,CAAC;YACvB,OAAO,cAAc,CAAC;QACxB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC;AA9BD,8CA8BC;AAED;;;;;GAKG;AACH,SAAgB,wCAAwC,CACtD,OAAe;IAEf,MAAM,SAAS,GAAG;QAChB,MAAM,EAAE,IAAA,eAAM,EAAC,IAAA,kBAAU,EAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;KACjD,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AARD,4FAQC;AAED;;;;;GAKG;AACH,SAAgB,iCAAiC,CAAC,OAAe;IAC/D,OAAO,IAAA,SAAI,EAAC,wCAAwC,CAAC,OAAO,CAAC,CAAC,CAAC;AACjE,CAAC;AAFD,8EAEC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,WAAkC;IAElC,gFAAgF;IAChF,oDAAoD;IACpD,OAAO,WAAW,KAAM,iCAAY,CAAC,IAAe,CAAC;AACvD,CAAC;AAND,kDAMC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,WAAkC;IAClE,OAAO,WAAW,KAAM,iCAAY,CAAC,IAAe,CAAC;AACvD,CAAC;AAFD,8CAEC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,WAAkC;IAElC,OAAO,WAAW,KAAM,iCAAY,CAAC,MAAiB,CAAC;AACzD,CAAC;AAJD,kDAIC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,WAAkC;IAChE,OAAO,WAAW,KAAM,iCAAY,CAAC,EAAa,CAAC;AACrD,CAAC;AAFD,0CAEC;AAED;;;;;GAKG;AACH,SAAgB,4BAA4B,CAAC,KAAa;IACxD,MAAM,OAAO,GAAG,IAAI,CAAC;IACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,YAAY;IACnC,OAAO,KAAK,OAAO,KAAK,QAAQ,UAAU,KAAK,EAAE,CAAC;AACpD,CAAC;AAJD,oEAIC;AAED;;;;;;GAMG;AACH,SAAgB,gCAAgC,CAC9C,OAAsB,EACtB,OAAe;IAEf,8EAA8E;IAC9E,eAAe;IAEf,sFAAsF;IACtF,0CAA0C;IAE1C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,0DAA0D;QAC1D,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,yEAAyE;IACzE,qEAAqE;IACrE,mCAAmC;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC3C,uEAAuE;IACvE,sBAAsB;IACtB,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAC3E,CAAC;IAEF,kFAAkF;IAClF,iFAAiF;IACjF,6CAA6C;IAC7C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,gDAAgD,OAAO,GAAG,CAAC,CAAC;QACzE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAjCD,4EAiCC;AAED;;;;;;GAMG;AACU,QAAA,iCAAiC,GAAG,IAAA,kBAAI,EAAC;IACpD,aAAa,EAAE,IAAA,oBAAM,GAAE;IACvB,KAAK,EAAE,IAAA,oBAAM,GAAE;IACf,cAAc,EAAE,IAAA,oBAAM,GAAE;CACzB,CAAC,CAAC;AAYH;;;;;GAKG;AACH,SAAgB,sBAAsB,CACpC,OAAwB;IAExB,OAAO,IAAA,gBAAE,EAAC,OAAO,CAAC,OAAO,EAAE,yCAAiC,CAAC,CAAC;AAChE,CAAC;AAJD,wDAIC;AAED,SAAgB,2BAA2B,CACzC,WAA+C;IAE/C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC5C,OAAO,QAAQ,CAAC,MAAM,CAA4B,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;QACjE,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC;QAClC,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AARD,kEAQC","sourcesContent":["import type { KeyringObject } from '@metamask/keyring-controller';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { Infer } from '@metamask/superstruct';\nimport { is, number, string, type } from '@metamask/superstruct';\nimport { hexToBytes } from '@metamask/utils';\nimport { sha256 } from 'ethereum-cryptography/sha256';\nimport type { V4Options } from 'uuid';\nimport { v4 as uuid } from 'uuid';\n\nimport type { AccountId } from './AccountsController';\n\n/**\n * Returns the name of the keyring type.\n *\n * @param keyringType - The type of the keyring.\n * @returns The name of the keyring type.\n */\nexport function keyringTypeToName(keyringType: string): string {\n  switch (keyringType) {\n    case KeyringTypes.simple: {\n      return 'Account';\n    }\n    case KeyringTypes.hd: {\n      return 'Account';\n    }\n    case KeyringTypes.trezor: {\n      return 'Trezor';\n    }\n    case KeyringTypes.oneKey: {\n      return 'OneKey';\n    }\n    case KeyringTypes.ledger: {\n      return 'Ledger';\n    }\n    case KeyringTypes.lattice: {\n      return 'Lattice';\n    }\n    case KeyringTypes.qr: {\n      return 'QR';\n    }\n    case KeyringTypes.snap: {\n      return 'Snap Account';\n    }\n    default: {\n      throw new Error(`Unknown keyring ${keyringType}`);\n    }\n  }\n}\n\n/**\n * Generates a UUID v4 options from a given Ethereum address.\n *\n * @param address - The Ethereum address to generate the UUID from.\n * @returns The UUID v4 options.\n */\nexport function getUUIDOptionsFromAddressOfNormalAccount(\n  address: string,\n): V4Options {\n  const v4options = {\n    random: sha256(hexToBytes(address)).slice(0, 16),\n  };\n\n  return v4options;\n}\n\n/**\n * Generates a UUID from a given Ethereum address.\n *\n * @param address - The Ethereum address to generate the UUID from.\n * @returns The generated UUID.\n */\nexport function getUUIDFromAddressOfNormalAccount(address: string): string {\n  return uuid(getUUIDOptionsFromAddressOfNormalAccount(address));\n}\n\n/**\n * Check if a keyring type is considered a \"normal\" keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a \"normal\" keyring, false otherwise.\n */\nexport function isNormalKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  // Right now, we only have to \"exclude\" Snap accounts, but this might need to be\n  // adapted later on if we have new kind of keyrings!\n  return keyringType !== (KeyringTypes.snap as string);\n}\n\n/**\n * Check if a keyring type is a Snap keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a Snap keyring, false otherwise.\n */\nexport function isSnapKeyringType(keyringType: KeyringTypes | string): boolean {\n  return keyringType === (KeyringTypes.snap as string);\n}\n\n/**\n * Check if a keyring type is a simple keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a simple keyring, false otherwise.\n */\nexport function isSimpleKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  return keyringType === (KeyringTypes.simple as string);\n}\n\n/**\n * Check if a keyring is a HD keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring is a HD keyring, false otherwise.\n */\nexport function isHdKeyringType(keyringType: KeyringTypes | string): boolean {\n  return keyringType === (KeyringTypes.hd as string);\n}\n\n/**\n * Get the derivation path for the index of an account within a EVM HD keyring.\n *\n * @param index - The account index.\n * @returns The derivation path.\n */\nexport function getEvmDerivationPathForIndex(index: number): string {\n  const purpose = '44';\n  const coinType = '60'; // Ethereum.\n  return `m/${purpose}'/${coinType}'/0'/0/${index}`;\n}\n\n/**\n * Get the group index from a keyring object (EVM HD keyring only) and an address.\n *\n * @param keyring - The keyring object.\n * @param address - The address to match.\n * @returns The group index for that address, undefined if not able to match the address.\n */\nexport function getEvmGroupIndexFromAddressIndex(\n  keyring: KeyringObject,\n  address: string,\n): number | undefined {\n  // TODO: Remove this function once EVM HD keyrings start using the new unified\n  // keyring API.\n\n  // NOTE: We mostly put that logic in a separate function so we can easily add coverage\n  // for (supposedly) unreachable code path.\n\n  if (!isHdKeyringType(keyring.type)) {\n    // We cannot extract the group index from non-HD keyrings.\n    return undefined;\n  }\n\n  // We need to find the account index from its HD keyring. We assume those\n  // accounts are ordered, thus we can use their index to compute their\n  // derivation path and group index.\n  const groupIndex = keyring.accounts.findIndex(\n    // NOTE: This is ok to use `toLowerCase` here, since we're only dealing\n    // with EVM addresses.\n    (accountAddress) => accountAddress.toLowerCase() === address.toLowerCase(),\n  );\n\n  // If for some reason, we cannot find this address, then the caller made a mistake\n  // and it did not use the proper keyring object. For now, we do not fail and just\n  // consider this account as \"simple account\".\n  if (groupIndex === -1) {\n    console.warn(`! Unable to get group index for HD account: \"${address}\"`);\n    return undefined;\n  }\n\n  return groupIndex;\n}\n\n/**\n * HD keyring account for Snap accounts that handles non-EVM HD accounts. (e.g the\n * Solana Snap).\n *\n * NOTE: We use `superstruct.type` here `superstruct.object` since it allows\n * extra-properties than a Snap might add in its `options`.\n */\nexport const HdSnapKeyringAccountOptionsStruct = type({\n  entropySource: string(),\n  index: number(),\n  derivationPath: string(),\n});\nexport type HdSnapKeyringAccountOptions = Infer<\n  typeof HdSnapKeyringAccountOptionsStruct\n>;\n\n/**\n * HD keyring account for Snap accounts that handles non-EVM HD accounts.\n */\nexport type HdSnapKeyringAccount = InternalAccount & {\n  options: InternalAccount['options'] & HdSnapKeyringAccountOptions;\n};\n\n/**\n * Check if an account is an HD Snap keyring account.\n *\n * @param account - Snap keyring account.\n * @returns True if valid, false otherwise.\n */\nexport function isHdSnapKeyringAccount(\n  account: InternalAccount,\n): account is HdSnapKeyringAccount {\n  return is(account.options, HdSnapKeyringAccountOptionsStruct);\n}\n\nexport function constructAccountIdByAddress(\n  accountsMap: Record<AccountId, InternalAccount>,\n): Record<string, AccountId> {\n  const accounts = Object.values(accountsMap);\n  return accounts.reduce<Record<string, AccountId>>((acc, account) => {\n    acc[account.address] = account.id;\n    return acc;\n  }, {});\n}\n"]}
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,iDAAuD;AAEvD,qEAA4D;AAG5D,uDAAiE;AACjE,2CAA6C;AAC7C,yDAAsD;AAEtD,+BAAkC;AAIlC;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,WAAmB;IACnD,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,iCAAY,CAAC,OAAO,CAAC,CAAC,CAAC;YAC1B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,KAAK,gBAAW,CAAC,IAAI,CAAC;QACtB,KAAK,iCAAY,CAAC,IAAI,CAAC,CAAC,CAAC;YACvB,OAAO,cAAc,CAAC;QACxB,CAAC;QACD,KAAK,iCAAY,CAAC,KAAK,CAAC,CAAC,CAAC;YACxB,wFAAwF;YACxF,wFAAwF;YACxF,mBAAmB;YACnB,+EAA+E;YAC/E,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC;AAtCD,8CAsCC;AAED;;;;;GAKG;AACH,SAAgB,wCAAwC,CACtD,OAAe;IAEf,MAAM,SAAS,GAAG;QAChB,MAAM,EAAE,IAAA,eAAM,EAAC,IAAA,kBAAU,EAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;KACjD,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AARD,4FAQC;AAED;;;;;GAKG;AACH,SAAgB,iCAAiC,CAAC,OAAe;IAC/D,OAAO,IAAA,SAAI,EAAC,wCAAwC,CAAC,OAAO,CAAC,CAAC,CAAC;AACjE,CAAC;AAFD,8EAEC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,WAAkC;IAElC,OAAO,CACL,CAAC,iBAAiB,CAAC,WAAW,CAAC;QAC/B,CAAC,mBAAmB,CAAC,WAAW,CAAC;QACjC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CACjC,CAAC;AACJ,CAAC;AARD,kDAQC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,WAAkC;IAClE,OAAO,WAAW,KAAM,iCAAY,CAAC,IAAe,CAAC;AACvD,CAAC;AAFD,8CAEC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,WAAgD;IAEhD,OAAO,WAAW,KAAM,gBAAW,CAAC,IAAe,CAAC;AACtD,CAAC;AAJD,kDAIC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,WAAkC;IAElC,OAAO,WAAW,KAAM,iCAAY,CAAC,MAAiB,CAAC;AACzD,CAAC;AAJD,kDAIC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,WAAkC;IAChE,OAAO,WAAW,KAAM,iCAAY,CAAC,EAAa,CAAC;AACrD,CAAC;AAFD,0CAEC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,WAAkC;IAElC,OAAO,WAAW,KAAM,iCAAY,CAAC,KAAgB,CAAC;AACxD,CAAC;AAJD,gDAIC;AAED;;;;;GAKG;AACH,SAAgB,4BAA4B,CAAC,KAAa;IACxD,MAAM,OAAO,GAAG,IAAI,CAAC;IACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,YAAY;IACnC,OAAO,KAAK,OAAO,KAAK,QAAQ,UAAU,KAAK,EAAE,CAAC;AACpD,CAAC;AAJD,oEAIC;AAED;;;;;;GAMG;AACH,SAAgB,gCAAgC,CAC9C,OAAsB,EACtB,OAAe;IAEf,8EAA8E;IAC9E,eAAe;IAEf,sFAAsF;IACtF,0CAA0C;IAE1C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,0DAA0D;QAC1D,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,yEAAyE;IACzE,qEAAqE;IACrE,mCAAmC;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC3C,uEAAuE;IACvE,sBAAsB;IACtB,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAC3E,CAAC;IAEF,kFAAkF;IAClF,iFAAiF;IACjF,6CAA6C;IAC7C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,gDAAgD,OAAO,GAAG,CAAC,CAAC;QACzE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAjCD,4EAiCC;AAED;;;;;;GAMG;AACU,QAAA,iCAAiC,GAAG,IAAA,kBAAI,EAAC;IACpD,aAAa,EAAE,IAAA,oBAAM,GAAE;IACvB,KAAK,EAAE,IAAA,oBAAM,GAAE;IACf,cAAc,EAAE,IAAA,oBAAM,GAAE;CACzB,CAAC,CAAC;AAYH;;;;;GAKG;AACH,SAAgB,sBAAsB,CACpC,OAAwB;IAExB,OAAO,IAAA,gBAAE,EAAC,OAAO,CAAC,OAAO,EAAE,yCAAiC,CAAC,CAAC;AAChE,CAAC;AAJD,wDAIC;AAED,SAAgB,2BAA2B,CACzC,WAA+C;IAE/C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC5C,OAAO,QAAQ,CAAC,MAAM,CAA4B,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;QACjE,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC;QAClC,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AARD,kEAQC","sourcesContent":["import { KeyringType } from '@metamask/keyring-api/v2';\nimport type { KeyringObject } from '@metamask/keyring-controller';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { Infer } from '@metamask/superstruct';\nimport { is, number, string, type } from '@metamask/superstruct';\nimport { hexToBytes } from '@metamask/utils';\nimport { sha256 } from 'ethereum-cryptography/sha256';\nimport type { V4Options } from 'uuid';\nimport { v4 as uuid } from 'uuid';\n\nimport type { AccountId } from './AccountsController';\n\n/**\n * Returns the name of the keyring type.\n *\n * @param keyringType - The type of the keyring.\n * @returns The name of the keyring type.\n */\nexport function keyringTypeToName(keyringType: string): string {\n  switch (keyringType) {\n    case KeyringTypes.simple: {\n      return 'Account';\n    }\n    case KeyringTypes.hd: {\n      return 'Account';\n    }\n    case KeyringTypes.trezor: {\n      return 'Trezor';\n    }\n    case KeyringTypes.oneKey: {\n      return 'OneKey';\n    }\n    case KeyringTypes.ledger: {\n      return 'Ledger';\n    }\n    case KeyringTypes.lattice: {\n      return 'Lattice';\n    }\n    case KeyringTypes.qr: {\n      return 'QR';\n    }\n    case KeyringType.Snap:\n    case KeyringTypes.snap: {\n      return 'Snap Account';\n    }\n    case KeyringTypes.money: {\n      // NOTE: We don't use Money keyring/accounts within this controller. However, since this\n      // function only use the keyring type to return a name, we still support it here in case\n      // clients need it.\n      // FIXME: This should probably live in the `KeyringController` package instead.\n      return 'Money';\n    }\n    default: {\n      throw new Error(`Unknown keyring ${keyringType}`);\n    }\n  }\n}\n\n/**\n * Generates a UUID v4 options from a given Ethereum address.\n *\n * @param address - The Ethereum address to generate the UUID from.\n * @returns The UUID v4 options.\n */\nexport function getUUIDOptionsFromAddressOfNormalAccount(\n  address: string,\n): V4Options {\n  const v4options = {\n    random: sha256(hexToBytes(address)).slice(0, 16),\n  };\n\n  return v4options;\n}\n\n/**\n * Generates a UUID from a given Ethereum address.\n *\n * @param address - The Ethereum address to generate the UUID from.\n * @returns The generated UUID.\n */\nexport function getUUIDFromAddressOfNormalAccount(address: string): string {\n  return uuid(getUUIDOptionsFromAddressOfNormalAccount(address));\n}\n\n/**\n * Check if a keyring type is considered a \"normal\" keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a \"normal\" keyring, false otherwise.\n */\nexport function isNormalKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  return (\n    !isSnapKeyringType(keyringType) &&\n    !isSnapKeyringV2Type(keyringType) &&\n    !isMoneyKeyringType(keyringType)\n  );\n}\n\n/**\n * Check if a keyring type is a Snap keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a Snap keyring, false otherwise.\n */\nexport function isSnapKeyringType(keyringType: KeyringTypes | string): boolean {\n  return keyringType === (KeyringTypes.snap as string);\n}\n\n/**\n * Check if a keyring type is a Snap keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a Snap keyring, false otherwise.\n */\nexport function isSnapKeyringV2Type(\n  keyringType: KeyringTypes | KeyringType | string,\n): boolean {\n  return keyringType === (KeyringType.Snap as string);\n}\n\n/**\n * Check if a keyring type is a simple keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a simple keyring, false otherwise.\n */\nexport function isSimpleKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  return keyringType === (KeyringTypes.simple as string);\n}\n\n/**\n * Check if a keyring is a HD keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring is a HD keyring, false otherwise.\n */\nexport function isHdKeyringType(keyringType: KeyringTypes | string): boolean {\n  return keyringType === (KeyringTypes.hd as string);\n}\n\n/**\n * Check if a keyring type is a Money keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is a Money keyring, false otherwise.\n */\nexport function isMoneyKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  return keyringType === (KeyringTypes.money as string);\n}\n\n/**\n * Get the derivation path for the index of an account within a EVM HD keyring.\n *\n * @param index - The account index.\n * @returns The derivation path.\n */\nexport function getEvmDerivationPathForIndex(index: number): string {\n  const purpose = '44';\n  const coinType = '60'; // Ethereum.\n  return `m/${purpose}'/${coinType}'/0'/0/${index}`;\n}\n\n/**\n * Get the group index from a keyring object (EVM HD keyring only) and an address.\n *\n * @param keyring - The keyring object.\n * @param address - The address to match.\n * @returns The group index for that address, undefined if not able to match the address.\n */\nexport function getEvmGroupIndexFromAddressIndex(\n  keyring: KeyringObject,\n  address: string,\n): number | undefined {\n  // TODO: Remove this function once EVM HD keyrings start using the new unified\n  // keyring API.\n\n  // NOTE: We mostly put that logic in a separate function so we can easily add coverage\n  // for (supposedly) unreachable code path.\n\n  if (!isHdKeyringType(keyring.type)) {\n    // We cannot extract the group index from non-HD keyrings.\n    return undefined;\n  }\n\n  // We need to find the account index from its HD keyring. We assume those\n  // accounts are ordered, thus we can use their index to compute their\n  // derivation path and group index.\n  const groupIndex = keyring.accounts.findIndex(\n    // NOTE: This is ok to use `toLowerCase` here, since we're only dealing\n    // with EVM addresses.\n    (accountAddress) => accountAddress.toLowerCase() === address.toLowerCase(),\n  );\n\n  // If for some reason, we cannot find this address, then the caller made a mistake\n  // and it did not use the proper keyring object. For now, we do not fail and just\n  // consider this account as \"simple account\".\n  if (groupIndex === -1) {\n    console.warn(`! Unable to get group index for HD account: \"${address}\"`);\n    return undefined;\n  }\n\n  return groupIndex;\n}\n\n/**\n * HD keyring account for Snap accounts that handles non-EVM HD accounts. (e.g the\n * Solana Snap).\n *\n * NOTE: We use `superstruct.type` here `superstruct.object` since it allows\n * extra-properties than a Snap might add in its `options`.\n */\nexport const HdSnapKeyringAccountOptionsStruct = type({\n  entropySource: string(),\n  index: number(),\n  derivationPath: string(),\n});\nexport type HdSnapKeyringAccountOptions = Infer<\n  typeof HdSnapKeyringAccountOptionsStruct\n>;\n\n/**\n * HD keyring account for Snap accounts that handles non-EVM HD accounts.\n */\nexport type HdSnapKeyringAccount = InternalAccount & {\n  options: InternalAccount['options'] & HdSnapKeyringAccountOptions;\n};\n\n/**\n * Check if an account is an HD Snap keyring account.\n *\n * @param account - Snap keyring account.\n * @returns True if valid, false otherwise.\n */\nexport function isHdSnapKeyringAccount(\n  account: InternalAccount,\n): account is HdSnapKeyringAccount {\n  return is(account.options, HdSnapKeyringAccountOptionsStruct);\n}\n\nexport function constructAccountIdByAddress(\n  accountsMap: Record<AccountId, InternalAccount>,\n): Record<string, AccountId> {\n  const accounts = Object.values(accountsMap);\n  return accounts.reduce<Record<string, AccountId>>((acc, account) => {\n    acc[account.address] = account.id;\n    return acc;\n  }, {});\n}\n"]}

package/dist/utils.d.cts

@@ -1,3 +1,4 @@
+import { KeyringType } from "@metamask/keyring-api/v2";
 import type { KeyringObject } from "@metamask/keyring-controller";
 import { KeyringTypes } from "@metamask/keyring-controller";
 import type { InternalAccount } from "@metamask/keyring-internal-api";
@@ -39,6 +40,13 @@ export declare function isNormalKeyringType(keyringType: KeyringTypes | string):
  * @returns True if the keyring type is considered a Snap keyring, false otherwise.
  */
 export declare function isSnapKeyringType(keyringType: KeyringTypes | string): boolean;
+/**
+ * Check if a keyring type is a Snap keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is considered a Snap keyring, false otherwise.
+ */
+export declare function isSnapKeyringV2Type(keyringType: KeyringTypes | KeyringType | string): boolean;
 /**
  * Check if a keyring type is a simple keyring.
  *
@@ -53,6 +61,13 @@ export declare function isSimpleKeyringType(keyringType: KeyringTypes | string):
  * @returns True if the keyring is a HD keyring, false otherwise.
  */
 export declare function isHdKeyringType(keyringType: KeyringTypes | string): boolean;
+/**
+ * Check if a keyring type is a Money keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is a Money keyring, false otherwise.
+ */
+export declare function isMoneyKeyringType(keyringType: KeyringTypes | string): boolean;
 /**
  * Get the derivation path for the index of an account within a EVM HD keyring.
  *

package/dist/utils.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,qCAAqC;AAClE,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa;AAGtC,OAAO,KAAK,EAAE,SAAS,EAAE,iCAA6B;AAEtD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CA8B7D;AAED;;;;;GAKG;AACH,wBAAgB,wCAAwC,CACtD,OAAO,EAAE,MAAM,GACd,SAAS,CAMX;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAIT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,YAAY,GAAG,MAAM,GAAG,OAAO,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,YAAY,GAAG,MAAM,GAAG,OAAO,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIlE;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,GACd,MAAM,GAAG,SAAS,CA8BpB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;EAI5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,eAAe,GAAG;IACnD,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,GAAG,2BAA2B,CAAC;CACnE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,eAAe,GACvB,OAAO,IAAI,oBAAoB,CAEjC;AAED,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,GAC9C,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAM3B"}
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iCAAiC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,qCAAqC;AAClE,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa;AAGtC,OAAO,KAAK,EAAE,SAAS,EAAE,iCAA6B;AAEtD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAsC7D;AAED;;;;;GAKG;AACH,wBAAgB,wCAAwC,CACtD,OAAO,EAAE,MAAM,GACd,SAAS,CAMX;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAMT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,YAAY,GAAG,MAAM,GAAG,OAAO,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,MAAM,GAC/C,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,YAAY,GAAG,MAAM,GAAG,OAAO,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIlE;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,GACd,MAAM,GAAG,SAAS,CA8BpB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;EAI5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,eAAe,GAAG;IACnD,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,GAAG,2BAA2B,CAAC;CACnE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,eAAe,GACvB,OAAO,IAAI,oBAAoB,CAEjC;AAED,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,GAC9C,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAM3B"}

package/dist/utils.d.mts

@@ -1,3 +1,4 @@
+import { KeyringType } from "@metamask/keyring-api/v2";
 import type { KeyringObject } from "@metamask/keyring-controller";
 import { KeyringTypes } from "@metamask/keyring-controller";
 import type { InternalAccount } from "@metamask/keyring-internal-api";
@@ -39,6 +40,13 @@ export declare function isNormalKeyringType(keyringType: KeyringTypes | string):
  * @returns True if the keyring type is considered a Snap keyring, false otherwise.
  */
 export declare function isSnapKeyringType(keyringType: KeyringTypes | string): boolean;
+/**
+ * Check if a keyring type is a Snap keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is considered a Snap keyring, false otherwise.
+ */
+export declare function isSnapKeyringV2Type(keyringType: KeyringTypes | KeyringType | string): boolean;
 /**
  * Check if a keyring type is a simple keyring.
  *
@@ -53,6 +61,13 @@ export declare function isSimpleKeyringType(keyringType: KeyringTypes | string):
  * @returns True if the keyring is a HD keyring, false otherwise.
  */
 export declare function isHdKeyringType(keyringType: KeyringTypes | string): boolean;
+/**
+ * Check if a keyring type is a Money keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is a Money keyring, false otherwise.
+ */
+export declare function isMoneyKeyringType(keyringType: KeyringTypes | string): boolean;
 /**
  * Get the derivation path for the index of an account within a EVM HD keyring.
  *

package/dist/utils.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,qCAAqC;AAClE,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa;AAGtC,OAAO,KAAK,EAAE,SAAS,EAAE,iCAA6B;AAEtD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CA8B7D;AAED;;;;;GAKG;AACH,wBAAgB,wCAAwC,CACtD,OAAO,EAAE,MAAM,GACd,SAAS,CAMX;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAIT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,YAAY,GAAG,MAAM,GAAG,OAAO,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,YAAY,GAAG,MAAM,GAAG,OAAO,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIlE;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,GACd,MAAM,GAAG,SAAS,CA8BpB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;EAI5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,eAAe,GAAG;IACnD,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,GAAG,2BAA2B,CAAC;CACnE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,eAAe,GACvB,OAAO,IAAI,oBAAoB,CAEjC;AAED,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,GAC9C,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAM3B"}
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iCAAiC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,qCAAqC;AAClE,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa;AAGtC,OAAO,KAAK,EAAE,SAAS,EAAE,iCAA6B;AAEtD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAsC7D;AAED;;;;;GAKG;AACH,wBAAgB,wCAAwC,CACtD,OAAO,EAAE,MAAM,GACd,SAAS,CAMX;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAMT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,YAAY,GAAG,MAAM,GAAG,OAAO,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,MAAM,GAC/C,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,YAAY,GAAG,MAAM,GAAG,OAAO,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,YAAY,GAAG,MAAM,GACjC,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIlE;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,GACd,MAAM,GAAG,SAAS,CA8BpB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;EAI5C,CAAC;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,eAAe,GAAG;IACnD,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,GAAG,2BAA2B,CAAC;CACnE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,eAAe,GACvB,OAAO,IAAI,oBAAoB,CAEjC;AAED,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,GAC9C,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAM3B"}

package/dist/utils.mjs

@@ -1,3 +1,4 @@
+import { KeyringType } from "@metamask/keyring-api/v2";
 import { KeyringTypes } from "@metamask/keyring-controller";
 import { is, number, string, type } from "@metamask/superstruct";
 import { hexToBytes } from "@metamask/utils";
@@ -32,9 +33,17 @@ export function keyringTypeToName(keyringType) {
         case KeyringTypes.qr: {
             return 'QR';
         }
+        case KeyringType.Snap:
         case KeyringTypes.snap: {
             return 'Snap Account';
         }
+        case KeyringTypes.money: {
+            // NOTE: We don't use Money keyring/accounts within this controller. However, since this
+            // function only use the keyring type to return a name, we still support it here in case
+            // clients need it.
+            // FIXME: This should probably live in the `KeyringController` package instead.
+            return 'Money';
+        }
         default: {
             throw new Error(`Unknown keyring ${keyringType}`);
         }
@@ -68,9 +77,9 @@ export function getUUIDFromAddressOfNormalAccount(address) {
  * @returns True if the keyring type is considered a "normal" keyring, false otherwise.
  */
 export function isNormalKeyringType(keyringType) {
-    // Right now, we only have to "exclude" Snap accounts, but this might need to be
-    // adapted later on if we have new kind of keyrings!
-    return keyringType !== KeyringTypes.snap;
+    return (!isSnapKeyringType(keyringType) &&
+        !isSnapKeyringV2Type(keyringType) &&
+        !isMoneyKeyringType(keyringType));
 }
 /**
  * Check if a keyring type is a Snap keyring.
@@ -81,6 +90,15 @@ export function isNormalKeyringType(keyringType) {
 export function isSnapKeyringType(keyringType) {
     return keyringType === KeyringTypes.snap;
 }
+/**
+ * Check if a keyring type is a Snap keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is considered a Snap keyring, false otherwise.
+ */
+export function isSnapKeyringV2Type(keyringType) {
+    return keyringType === KeyringType.Snap;
+}
 /**
  * Check if a keyring type is a simple keyring.
  *
@@ -99,6 +117,15 @@ export function isSimpleKeyringType(keyringType) {
 export function isHdKeyringType(keyringType) {
     return keyringType === KeyringTypes.hd;
 }
+/**
+ * Check if a keyring type is a Money keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is a Money keyring, false otherwise.
+ */
+export function isMoneyKeyringType(keyringType) {
+    return keyringType === KeyringTypes.money;
+}
 /**
  * Get the derivation path for the index of an account within a EVM HD keyring.
  *

package/dist/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAG5D,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B;AACjE,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAC7C,OAAO,EAAE,MAAM,EAAE,qCAAqC;AAEtD,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,aAAa;AAIlC;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAmB;IACnD,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;YAC1B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;YACvB,OAAO,cAAc,CAAC;QACxB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wCAAwC,CACtD,OAAe;IAEf,MAAM,SAAS,GAAG;QAChB,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;KACjD,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iCAAiC,CAAC,OAAe;IAC/D,OAAO,IAAI,CAAC,wCAAwC,CAAC,OAAO,CAAC,CAAC,CAAC;AACjE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,WAAkC;IAElC,gFAAgF;IAChF,oDAAoD;IACpD,OAAO,WAAW,KAAM,YAAY,CAAC,IAAe,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAkC;IAClE,OAAO,WAAW,KAAM,YAAY,CAAC,IAAe,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,WAAkC;IAElC,OAAO,WAAW,KAAM,YAAY,CAAC,MAAiB,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,WAAkC;IAChE,OAAO,WAAW,KAAM,YAAY,CAAC,EAAa,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAa;IACxD,MAAM,OAAO,GAAG,IAAI,CAAC;IACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,YAAY;IACnC,OAAO,KAAK,OAAO,KAAK,QAAQ,UAAU,KAAK,EAAE,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gCAAgC,CAC9C,OAAsB,EACtB,OAAe;IAEf,8EAA8E;IAC9E,eAAe;IAEf,sFAAsF;IACtF,0CAA0C;IAE1C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,0DAA0D;QAC1D,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,yEAAyE;IACzE,qEAAqE;IACrE,mCAAmC;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC3C,uEAAuE;IACvE,sBAAsB;IACtB,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAC3E,CAAC;IAEF,kFAAkF;IAClF,iFAAiF;IACjF,6CAA6C;IAC7C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,gDAAgD,OAAO,GAAG,CAAC,CAAC;QACzE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,IAAI,CAAC;IACpD,aAAa,EAAE,MAAM,EAAE;IACvB,KAAK,EAAE,MAAM,EAAE;IACf,cAAc,EAAE,MAAM,EAAE;CACzB,CAAC,CAAC;AAYH;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAwB;IAExB,OAAO,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,iCAAiC,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,WAA+C;IAE/C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC5C,OAAO,QAAQ,CAAC,MAAM,CAA4B,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;QACjE,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC;QAClC,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC","sourcesContent":["import type { KeyringObject } from '@metamask/keyring-controller';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { Infer } from '@metamask/superstruct';\nimport { is, number, string, type } from '@metamask/superstruct';\nimport { hexToBytes } from '@metamask/utils';\nimport { sha256 } from 'ethereum-cryptography/sha256';\nimport type { V4Options } from 'uuid';\nimport { v4 as uuid } from 'uuid';\n\nimport type { AccountId } from './AccountsController';\n\n/**\n * Returns the name of the keyring type.\n *\n * @param keyringType - The type of the keyring.\n * @returns The name of the keyring type.\n */\nexport function keyringTypeToName(keyringType: string): string {\n  switch (keyringType) {\n    case KeyringTypes.simple: {\n      return 'Account';\n    }\n    case KeyringTypes.hd: {\n      return 'Account';\n    }\n    case KeyringTypes.trezor: {\n      return 'Trezor';\n    }\n    case KeyringTypes.oneKey: {\n      return 'OneKey';\n    }\n    case KeyringTypes.ledger: {\n      return 'Ledger';\n    }\n    case KeyringTypes.lattice: {\n      return 'Lattice';\n    }\n    case KeyringTypes.qr: {\n      return 'QR';\n    }\n    case KeyringTypes.snap: {\n      return 'Snap Account';\n    }\n    default: {\n      throw new Error(`Unknown keyring ${keyringType}`);\n    }\n  }\n}\n\n/**\n * Generates a UUID v4 options from a given Ethereum address.\n *\n * @param address - The Ethereum address to generate the UUID from.\n * @returns The UUID v4 options.\n */\nexport function getUUIDOptionsFromAddressOfNormalAccount(\n  address: string,\n): V4Options {\n  const v4options = {\n    random: sha256(hexToBytes(address)).slice(0, 16),\n  };\n\n  return v4options;\n}\n\n/**\n * Generates a UUID from a given Ethereum address.\n *\n * @param address - The Ethereum address to generate the UUID from.\n * @returns The generated UUID.\n */\nexport function getUUIDFromAddressOfNormalAccount(address: string): string {\n  return uuid(getUUIDOptionsFromAddressOfNormalAccount(address));\n}\n\n/**\n * Check if a keyring type is considered a \"normal\" keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a \"normal\" keyring, false otherwise.\n */\nexport function isNormalKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  // Right now, we only have to \"exclude\" Snap accounts, but this might need to be\n  // adapted later on if we have new kind of keyrings!\n  return keyringType !== (KeyringTypes.snap as string);\n}\n\n/**\n * Check if a keyring type is a Snap keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a Snap keyring, false otherwise.\n */\nexport function isSnapKeyringType(keyringType: KeyringTypes | string): boolean {\n  return keyringType === (KeyringTypes.snap as string);\n}\n\n/**\n * Check if a keyring type is a simple keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a simple keyring, false otherwise.\n */\nexport function isSimpleKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  return keyringType === (KeyringTypes.simple as string);\n}\n\n/**\n * Check if a keyring is a HD keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring is a HD keyring, false otherwise.\n */\nexport function isHdKeyringType(keyringType: KeyringTypes | string): boolean {\n  return keyringType === (KeyringTypes.hd as string);\n}\n\n/**\n * Get the derivation path for the index of an account within a EVM HD keyring.\n *\n * @param index - The account index.\n * @returns The derivation path.\n */\nexport function getEvmDerivationPathForIndex(index: number): string {\n  const purpose = '44';\n  const coinType = '60'; // Ethereum.\n  return `m/${purpose}'/${coinType}'/0'/0/${index}`;\n}\n\n/**\n * Get the group index from a keyring object (EVM HD keyring only) and an address.\n *\n * @param keyring - The keyring object.\n * @param address - The address to match.\n * @returns The group index for that address, undefined if not able to match the address.\n */\nexport function getEvmGroupIndexFromAddressIndex(\n  keyring: KeyringObject,\n  address: string,\n): number | undefined {\n  // TODO: Remove this function once EVM HD keyrings start using the new unified\n  // keyring API.\n\n  // NOTE: We mostly put that logic in a separate function so we can easily add coverage\n  // for (supposedly) unreachable code path.\n\n  if (!isHdKeyringType(keyring.type)) {\n    // We cannot extract the group index from non-HD keyrings.\n    return undefined;\n  }\n\n  // We need to find the account index from its HD keyring. We assume those\n  // accounts are ordered, thus we can use their index to compute their\n  // derivation path and group index.\n  const groupIndex = keyring.accounts.findIndex(\n    // NOTE: This is ok to use `toLowerCase` here, since we're only dealing\n    // with EVM addresses.\n    (accountAddress) => accountAddress.toLowerCase() === address.toLowerCase(),\n  );\n\n  // If for some reason, we cannot find this address, then the caller made a mistake\n  // and it did not use the proper keyring object. For now, we do not fail and just\n  // consider this account as \"simple account\".\n  if (groupIndex === -1) {\n    console.warn(`! Unable to get group index for HD account: \"${address}\"`);\n    return undefined;\n  }\n\n  return groupIndex;\n}\n\n/**\n * HD keyring account for Snap accounts that handles non-EVM HD accounts. (e.g the\n * Solana Snap).\n *\n * NOTE: We use `superstruct.type` here `superstruct.object` since it allows\n * extra-properties than a Snap might add in its `options`.\n */\nexport const HdSnapKeyringAccountOptionsStruct = type({\n  entropySource: string(),\n  index: number(),\n  derivationPath: string(),\n});\nexport type HdSnapKeyringAccountOptions = Infer<\n  typeof HdSnapKeyringAccountOptionsStruct\n>;\n\n/**\n * HD keyring account for Snap accounts that handles non-EVM HD accounts.\n */\nexport type HdSnapKeyringAccount = InternalAccount & {\n  options: InternalAccount['options'] & HdSnapKeyringAccountOptions;\n};\n\n/**\n * Check if an account is an HD Snap keyring account.\n *\n * @param account - Snap keyring account.\n * @returns True if valid, false otherwise.\n */\nexport function isHdSnapKeyringAccount(\n  account: InternalAccount,\n): account is HdSnapKeyringAccount {\n  return is(account.options, HdSnapKeyringAccountOptionsStruct);\n}\n\nexport function constructAccountIdByAddress(\n  accountsMap: Record<AccountId, InternalAccount>,\n): Record<string, AccountId> {\n  const accounts = Object.values(accountsMap);\n  return accounts.reduce<Record<string, AccountId>>((acc, account) => {\n    acc[account.address] = account.id;\n    return acc;\n  }, {});\n}\n"]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iCAAiC;AAEvD,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAG5D,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B;AACjE,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAC7C,OAAO,EAAE,MAAM,EAAE,qCAAqC;AAEtD,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,aAAa;AAIlC;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAmB;IACnD,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;YAC1B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,KAAK,WAAW,CAAC,IAAI,CAAC;QACtB,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;YACvB,OAAO,cAAc,CAAC;QACxB,CAAC;QACD,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;YACxB,wFAAwF;YACxF,wFAAwF;YACxF,mBAAmB;YACnB,+EAA+E;YAC/E,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wCAAwC,CACtD,OAAe;IAEf,MAAM,SAAS,GAAG;QAChB,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;KACjD,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iCAAiC,CAAC,OAAe;IAC/D,OAAO,IAAI,CAAC,wCAAwC,CAAC,OAAO,CAAC,CAAC,CAAC;AACjE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,WAAkC;IAElC,OAAO,CACL,CAAC,iBAAiB,CAAC,WAAW,CAAC;QAC/B,CAAC,mBAAmB,CAAC,WAAW,CAAC;QACjC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CACjC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAkC;IAClE,OAAO,WAAW,KAAM,YAAY,CAAC,IAAe,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,WAAgD;IAEhD,OAAO,WAAW,KAAM,WAAW,CAAC,IAAe,CAAC;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,WAAkC;IAElC,OAAO,WAAW,KAAM,YAAY,CAAC,MAAiB,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,WAAkC;IAChE,OAAO,WAAW,KAAM,YAAY,CAAC,EAAa,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,WAAkC;IAElC,OAAO,WAAW,KAAM,YAAY,CAAC,KAAgB,CAAC;AACxD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAa;IACxD,MAAM,OAAO,GAAG,IAAI,CAAC;IACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,YAAY;IACnC,OAAO,KAAK,OAAO,KAAK,QAAQ,UAAU,KAAK,EAAE,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gCAAgC,CAC9C,OAAsB,EACtB,OAAe;IAEf,8EAA8E;IAC9E,eAAe;IAEf,sFAAsF;IACtF,0CAA0C;IAE1C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,0DAA0D;QAC1D,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,yEAAyE;IACzE,qEAAqE;IACrE,mCAAmC;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC3C,uEAAuE;IACvE,sBAAsB;IACtB,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAC3E,CAAC;IAEF,kFAAkF;IAClF,iFAAiF;IACjF,6CAA6C;IAC7C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,gDAAgD,OAAO,GAAG,CAAC,CAAC;QACzE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,IAAI,CAAC;IACpD,aAAa,EAAE,MAAM,EAAE;IACvB,KAAK,EAAE,MAAM,EAAE;IACf,cAAc,EAAE,MAAM,EAAE;CACzB,CAAC,CAAC;AAYH;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAwB;IAExB,OAAO,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,iCAAiC,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,WAA+C;IAE/C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC5C,OAAO,QAAQ,CAAC,MAAM,CAA4B,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;QACjE,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC;QAClC,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC","sourcesContent":["import { KeyringType } from '@metamask/keyring-api/v2';\nimport type { KeyringObject } from '@metamask/keyring-controller';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { Infer } from '@metamask/superstruct';\nimport { is, number, string, type } from '@metamask/superstruct';\nimport { hexToBytes } from '@metamask/utils';\nimport { sha256 } from 'ethereum-cryptography/sha256';\nimport type { V4Options } from 'uuid';\nimport { v4 as uuid } from 'uuid';\n\nimport type { AccountId } from './AccountsController';\n\n/**\n * Returns the name of the keyring type.\n *\n * @param keyringType - The type of the keyring.\n * @returns The name of the keyring type.\n */\nexport function keyringTypeToName(keyringType: string): string {\n  switch (keyringType) {\n    case KeyringTypes.simple: {\n      return 'Account';\n    }\n    case KeyringTypes.hd: {\n      return 'Account';\n    }\n    case KeyringTypes.trezor: {\n      return 'Trezor';\n    }\n    case KeyringTypes.oneKey: {\n      return 'OneKey';\n    }\n    case KeyringTypes.ledger: {\n      return 'Ledger';\n    }\n    case KeyringTypes.lattice: {\n      return 'Lattice';\n    }\n    case KeyringTypes.qr: {\n      return 'QR';\n    }\n    case KeyringType.Snap:\n    case KeyringTypes.snap: {\n      return 'Snap Account';\n    }\n    case KeyringTypes.money: {\n      // NOTE: We don't use Money keyring/accounts within this controller. However, since this\n      // function only use the keyring type to return a name, we still support it here in case\n      // clients need it.\n      // FIXME: This should probably live in the `KeyringController` package instead.\n      return 'Money';\n    }\n    default: {\n      throw new Error(`Unknown keyring ${keyringType}`);\n    }\n  }\n}\n\n/**\n * Generates a UUID v4 options from a given Ethereum address.\n *\n * @param address - The Ethereum address to generate the UUID from.\n * @returns The UUID v4 options.\n */\nexport function getUUIDOptionsFromAddressOfNormalAccount(\n  address: string,\n): V4Options {\n  const v4options = {\n    random: sha256(hexToBytes(address)).slice(0, 16),\n  };\n\n  return v4options;\n}\n\n/**\n * Generates a UUID from a given Ethereum address.\n *\n * @param address - The Ethereum address to generate the UUID from.\n * @returns The generated UUID.\n */\nexport function getUUIDFromAddressOfNormalAccount(address: string): string {\n  return uuid(getUUIDOptionsFromAddressOfNormalAccount(address));\n}\n\n/**\n * Check if a keyring type is considered a \"normal\" keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a \"normal\" keyring, false otherwise.\n */\nexport function isNormalKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  return (\n    !isSnapKeyringType(keyringType) &&\n    !isSnapKeyringV2Type(keyringType) &&\n    !isMoneyKeyringType(keyringType)\n  );\n}\n\n/**\n * Check if a keyring type is a Snap keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a Snap keyring, false otherwise.\n */\nexport function isSnapKeyringType(keyringType: KeyringTypes | string): boolean {\n  return keyringType === (KeyringTypes.snap as string);\n}\n\n/**\n * Check if a keyring type is a Snap keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a Snap keyring, false otherwise.\n */\nexport function isSnapKeyringV2Type(\n  keyringType: KeyringTypes | KeyringType | string,\n): boolean {\n  return keyringType === (KeyringType.Snap as string);\n}\n\n/**\n * Check if a keyring type is a simple keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is considered a simple keyring, false otherwise.\n */\nexport function isSimpleKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  return keyringType === (KeyringTypes.simple as string);\n}\n\n/**\n * Check if a keyring is a HD keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring is a HD keyring, false otherwise.\n */\nexport function isHdKeyringType(keyringType: KeyringTypes | string): boolean {\n  return keyringType === (KeyringTypes.hd as string);\n}\n\n/**\n * Check if a keyring type is a Money keyring.\n *\n * @param keyringType - The account's keyring type.\n * @returns True if the keyring type is a Money keyring, false otherwise.\n */\nexport function isMoneyKeyringType(\n  keyringType: KeyringTypes | string,\n): boolean {\n  return keyringType === (KeyringTypes.money as string);\n}\n\n/**\n * Get the derivation path for the index of an account within a EVM HD keyring.\n *\n * @param index - The account index.\n * @returns The derivation path.\n */\nexport function getEvmDerivationPathForIndex(index: number): string {\n  const purpose = '44';\n  const coinType = '60'; // Ethereum.\n  return `m/${purpose}'/${coinType}'/0'/0/${index}`;\n}\n\n/**\n * Get the group index from a keyring object (EVM HD keyring only) and an address.\n *\n * @param keyring - The keyring object.\n * @param address - The address to match.\n * @returns The group index for that address, undefined if not able to match the address.\n */\nexport function getEvmGroupIndexFromAddressIndex(\n  keyring: KeyringObject,\n  address: string,\n): number | undefined {\n  // TODO: Remove this function once EVM HD keyrings start using the new unified\n  // keyring API.\n\n  // NOTE: We mostly put that logic in a separate function so we can easily add coverage\n  // for (supposedly) unreachable code path.\n\n  if (!isHdKeyringType(keyring.type)) {\n    // We cannot extract the group index from non-HD keyrings.\n    return undefined;\n  }\n\n  // We need to find the account index from its HD keyring. We assume those\n  // accounts are ordered, thus we can use their index to compute their\n  // derivation path and group index.\n  const groupIndex = keyring.accounts.findIndex(\n    // NOTE: This is ok to use `toLowerCase` here, since we're only dealing\n    // with EVM addresses.\n    (accountAddress) => accountAddress.toLowerCase() === address.toLowerCase(),\n  );\n\n  // If for some reason, we cannot find this address, then the caller made a mistake\n  // and it did not use the proper keyring object. For now, we do not fail and just\n  // consider this account as \"simple account\".\n  if (groupIndex === -1) {\n    console.warn(`! Unable to get group index for HD account: \"${address}\"`);\n    return undefined;\n  }\n\n  return groupIndex;\n}\n\n/**\n * HD keyring account for Snap accounts that handles non-EVM HD accounts. (e.g the\n * Solana Snap).\n *\n * NOTE: We use `superstruct.type` here `superstruct.object` since it allows\n * extra-properties than a Snap might add in its `options`.\n */\nexport const HdSnapKeyringAccountOptionsStruct = type({\n  entropySource: string(),\n  index: number(),\n  derivationPath: string(),\n});\nexport type HdSnapKeyringAccountOptions = Infer<\n  typeof HdSnapKeyringAccountOptionsStruct\n>;\n\n/**\n * HD keyring account for Snap accounts that handles non-EVM HD accounts.\n */\nexport type HdSnapKeyringAccount = InternalAccount & {\n  options: InternalAccount['options'] & HdSnapKeyringAccountOptions;\n};\n\n/**\n * Check if an account is an HD Snap keyring account.\n *\n * @param account - Snap keyring account.\n * @returns True if valid, false otherwise.\n */\nexport function isHdSnapKeyringAccount(\n  account: InternalAccount,\n): account is HdSnapKeyringAccount {\n  return is(account.options, HdSnapKeyringAccountOptionsStruct);\n}\n\nexport function constructAccountIdByAddress(\n  accountsMap: Record<AccountId, InternalAccount>,\n): Record<string, AccountId> {\n  const accounts = Object.values(accountsMap);\n  return accounts.reduce<Record<string, AccountId>>((acc, account) => {\n    acc[account.address] = account.id;\n    return acc;\n  }, {});\n}\n"]}

package/package.json

@@ -1,21 +1,26 @@
 {
   "name": "@metamask/accounts-controller",
-  "version": "37.1.1",
+  "version": "38.0.0",
   "description": "Manages internal accounts",
   "keywords": [
-    "MetaMask",
-    "Ethereum"
+    "Ethereum",
+    "MetaMask"
   ],
   "homepage": "https://github.com/MetaMask/core/tree/main/packages/accounts-controller#readme",
   "bugs": {
     "url": "https://github.com/MetaMask/core/issues"
   },
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/core.git"
   },
-  "license": "MIT",
+  "files": [
+    "dist/"
+  ],
   "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
       "import": {
@@ -29,18 +34,18 @@
     },
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.cts",
-  "files": [
-    "dist/"
-  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "scripts": {
     "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
     "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
     "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/accounts-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/accounts-controller",
-    "generate-method-action-types": "tsx ../../scripts/generate-method-action-types.ts",
+    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --check",
+    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --generate",
     "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
     "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
@@ -49,17 +54,14 @@
   },
   "dependencies": {
     "@ethereumjs/util": "^9.1.0",
-    "@metamask/base-controller": "^9.0.1",
-    "@metamask/eth-snap-keyring": "^19.0.0",
-    "@metamask/keyring-api": "^21.6.0",
-    "@metamask/keyring-controller": "^25.1.1",
-    "@metamask/keyring-internal-api": "^10.0.0",
+    "@metamask/base-controller": "^9.1.0",
+    "@metamask/eth-snap-keyring": "^22.0.1",
+    "@metamask/keyring-api": "^23.1.0",
+    "@metamask/keyring-controller": "^25.4.0",
+    "@metamask/keyring-internal-api": "^11.0.1",
     "@metamask/keyring-utils": "^3.1.0",
-    "@metamask/messenger": "^1.0.0",
-    "@metamask/network-controller": "^30.0.1",
-    "@metamask/snaps-controllers": "^19.0.0",
-    "@metamask/snaps-sdk": "^11.0.0",
-    "@metamask/snaps-utils": "^12.1.2",
+    "@metamask/messenger": "^1.2.0",
+    "@metamask/network-controller": "^30.1.0",
     "@metamask/superstruct": "^3.1.0",
     "@metamask/utils": "^11.9.0",
     "deepmerge": "^4.2.2",
@@ -69,8 +71,8 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/controller-utils": "^11.19.0",
+    "@metamask/auto-changelog": "^6.1.0",
+    "@metamask/controller-utils": "^11.20.0",
     "@metamask/providers": "^22.1.0",
     "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^29.5.14",
@@ -89,9 +91,5 @@
   },
   "engines": {
     "node": "^18.18 || >=20"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
   }
 }