@metamask/accounts-controller 31.0.0 → 32.0.1

package/dist/utils.cjs

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDerivationPathForIndex = exports.isHdKeyringType = exports.isNormalKeyringType = exports.getUUIDFromAddressOfNormalAccount = exports.getUUIDOptionsFromAddressOfNormalAccount = exports.keyringTypeToName = void 0;
+exports.isHdSnapKeyringAccount = exports.HdSnapKeyringAccountOptionsStruct = exports.getEvmGroupIndexFromAddressIndex = exports.getEvmDerivationPathForIndex = exports.isHdKeyringType = exports.isSimpleKeyringType = exports.isSnapKeyringType = exports.isNormalKeyringType = exports.getUUIDFromAddressOfNormalAccount = exports.getUUIDOptionsFromAddressOfNormalAccount = exports.keyringTypeToName = void 0;
 const keyring_controller_1 = require("@metamask/keyring-controller");
+const superstruct_1 = require("@metamask/superstruct");
 const utils_1 = require("@metamask/utils");
 const sha256_1 = require("ethereum-cryptography/sha256");
 const uuid_1 = require("uuid");
@@ -78,6 +79,26 @@ function isNormalKeyringType(keyringType) {
     return keyringType !== keyring_controller_1.KeyringTypes.snap;
 }
 exports.isNormalKeyringType = isNormalKeyringType;
+/**
+ * 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 isSnapKeyringType(keyringType) {
+    return keyringType === keyring_controller_1.KeyringTypes.snap;
+}
+exports.isSnapKeyringType = isSnapKeyringType;
+/**
+ * Check if a keyring type is a simple keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is considered a simple keyring, false otherwise.
+ */
+function isSimpleKeyringType(keyringType) {
+    return keyringType === keyring_controller_1.KeyringTypes.simple;
+}
+exports.isSimpleKeyringType = isSimpleKeyringType;
 /**
  * Check if a keyring is a HD keyring.
  *
@@ -89,13 +110,70 @@ function isHdKeyringType(keyringType) {
 }
 exports.isHdKeyringType = isHdKeyringType;
 /**
- * Get the derivation path for the index of an account within a HD keyring.
+ * Get the derivation path for the index of an account within a EVM HD keyring.
  *
  * @param index - The account index.
  * @returns The derivation path.
  */
-function getDerivationPathForIndex(index) {
-    return `m/44'/60'/0'/0/${index}`;
+function getEvmDerivationPathForIndex(index) {
+    const purpose = '44';
+    const coinType = '60'; // Ethereum.
+    return `m/${purpose}'/${coinType}'/0'/0/${index}`;
+}
+exports.getEvmDerivationPathForIndex = getEvmDerivationPathForIndex;
+/**
+ * Get the group index from a keyring object (EVM HD keyring only) and an address.
+ *
+ * @param keyring - The keyring object.
+ * @param address - The address to match.
+ * @returns The group index for that address, undefined if not able to match the address.
+ */
+function getEvmGroupIndexFromAddressIndex(keyring, address) {
+    // TODO: Remove this function once EVM HD keyrings start using the new unified
+    // keyring API.
+    // NOTE: We mostly put that logic in a separate function so we can easily add coverage
+    // for (supposedly) unreachable code path.
+    if (!isHdKeyringType(keyring.type)) {
+        // We cannot extract the group index from non-HD keyrings.
+        return undefined;
+    }
+    // We need to find the account index from its HD keyring. We assume those
+    // accounts are ordered, thus we can use their index to compute their
+    // derivation path and group index.
+    const groupIndex = keyring.accounts.findIndex(
+    // NOTE: This is ok to use `toLowerCase` here, since we're only dealing
+    // with EVM addresses.
+    (accountAddress) => accountAddress.toLowerCase() === address.toLowerCase());
+    // If for some reason, we cannot find this address, then the caller made a mistake
+    // and it did not use the proper keyring object. For now, we do not fail and just
+    // consider this account as "simple account".
+    if (groupIndex === -1) {
+        console.warn(`! Unable to get group index for HD account: "${address}"`);
+        return undefined;
+    }
+    return groupIndex;
+}
+exports.getEvmGroupIndexFromAddressIndex = getEvmGroupIndexFromAddressIndex;
+/**
+ * HD keyring account for Snap accounts that handles non-EVM HD accounts. (e.g the
+ * Solana Snap).
+ *
+ * NOTE: We use `superstruct.type` here `superstruct.object` since it allows
+ * extra-properties than a Snap might add in its `options`.
+ */
+exports.HdSnapKeyringAccountOptionsStruct = (0, superstruct_1.type)({
+    entropySource: (0, superstruct_1.string)(),
+    index: (0, superstruct_1.number)(),
+    derivationPath: (0, superstruct_1.string)(),
+});
+/**
+ * Check if an account is an HD Snap keyring account.
+ *
+ * @param account - Snap keyring account.
+ * @returns True if valid, false otherwise.
+ */
+function isHdSnapKeyringAccount(account) {
+    return (0, superstruct_1.is)(account.options, exports.HdSnapKeyringAccountOptionsStruct);
 }
-exports.getDerivationPathForIndex = getDerivationPathForIndex;
+exports.isHdSnapKeyringAccount = isHdSnapKeyringAccount;
 //# sourceMappingURL=utils.cjs.map

package/dist/utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,qEAA4D;AAC5D,2CAA6C;AAC7C,yDAAsD;AAEtD,+BAAkC;AAElC;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,WAAmB;IACnD,QAAQ,WAAW,EAAE;QACnB,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,iCAAY,CAAC,OAAO,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;SACb;QACD,KAAK,iCAAY,CAAC,IAAI,CAAC,CAAC;YACtB,OAAO,cAAc,CAAC;SACvB;QACD,OAAO,CAAC,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;SACnD;KACF;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,CAAC,WAAyB;IAC3D,gFAAgF;IAChF,oDAAoD;IACpD,OAAO,WAAW,KAAK,iCAAY,CAAC,IAAI,CAAC;AAC3C,CAAC;AAJD,kDAIC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,WAAyB;IACvD,OAAO,WAAW,KAAK,iCAAY,CAAC,EAAE,CAAC;AACzC,CAAC;AAFD,0CAEC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAC,KAAa;IACrD,OAAO,kBAAkB,KAAK,EAAE,CAAC;AACnC,CAAC;AAFD,8DAEC","sourcesContent":["import { KeyringTypes } from '@metamask/keyring-controller';\nimport { hexToBytes } from '@metamask/utils';\nimport { sha256 } from 'ethereum-cryptography/sha256';\nimport type { V4Options } from 'uuid';\nimport { v4 as uuid } from 'uuid';\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(keyringType: KeyringTypes): 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;\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): boolean {\n  return keyringType === KeyringTypes.hd;\n}\n\n/**\n * Get the derivation path for the index of an account within a HD keyring.\n *\n * @param index - The account index.\n * @returns The derivation path.\n */\nexport function getDerivationPathForIndex(index: number): string {\n  return `m/44'/60'/0'/0/${index}`;\n}\n"]}
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AACA,qEAA4D;AAG5D,uDAAiE;AACjE,2CAA6C;AAC7C,yDAAsD;AAEtD,+BAAkC;AAElC;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,WAAmB;IACnD,QAAQ,WAAW,EAAE;QACnB,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,iCAAY,CAAC,OAAO,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;SACb;QACD,KAAK,iCAAY,CAAC,IAAI,CAAC,CAAC;YACtB,OAAO,cAAc,CAAC;SACvB;QACD,OAAO,CAAC,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;SACnD;KACF;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;QAClC,0DAA0D;QAC1D,OAAO,SAAS,CAAC;KAClB;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;QACrB,OAAO,CAAC,IAAI,CAAC,gDAAgD,OAAO,GAAG,CAAC,CAAC;QACzE,OAAO,SAAS,CAAC;KAClB;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","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\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"]}

package/dist/utils.d.cts

@@ -1,4 +1,7 @@
+import type { KeyringObject } from "@metamask/keyring-controller";
 import { KeyringTypes } from "@metamask/keyring-controller";
+import type { InternalAccount } from "@metamask/keyring-internal-api";
+import type { Infer } from "@metamask/superstruct";
 import type { V4Options } from "uuid";
 /**
  * Returns the name of the keyring type.
@@ -27,19 +30,71 @@ export declare function getUUIDFromAddressOfNormalAccount(address: string): stri
  * @param keyringType - The account's keyring type.
  * @returns True if the keyring type is considered a "normal" keyring, false otherwise.
  */
-export declare function isNormalKeyringType(keyringType: KeyringTypes): boolean;
+export declare function isNormalKeyringType(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 isSnapKeyringType(keyringType: KeyringTypes | string): boolean;
+/**
+ * Check if a keyring type is a simple keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is considered a simple keyring, false otherwise.
+ */
+export declare function isSimpleKeyringType(keyringType: KeyringTypes | string): boolean;
 /**
  * Check if a keyring is a HD keyring.
  *
  * @param keyringType - The account's keyring type.
  * @returns True if the keyring is a HD keyring, false otherwise.
  */
-export declare function isHdKeyringType(keyringType: KeyringTypes): boolean;
+export declare function isHdKeyringType(keyringType: KeyringTypes | string): boolean;
 /**
- * Get the derivation path for the index of an account within a HD keyring.
+ * Get the derivation path for the index of an account within a EVM HD keyring.
  *
  * @param index - The account index.
  * @returns The derivation path.
  */
-export declare function getDerivationPathForIndex(index: number): string;
+export declare function getEvmDerivationPathForIndex(index: number): string;
+/**
+ * Get the group index from a keyring object (EVM HD keyring only) and an address.
+ *
+ * @param keyring - The keyring object.
+ * @param address - The address to match.
+ * @returns The group index for that address, undefined if not able to match the address.
+ */
+export declare function getEvmGroupIndexFromAddressIndex(keyring: KeyringObject, address: string): number | undefined;
+/**
+ * HD keyring account for Snap accounts that handles non-EVM HD accounts. (e.g the
+ * Solana Snap).
+ *
+ * NOTE: We use `superstruct.type` here `superstruct.object` since it allows
+ * extra-properties than a Snap might add in its `options`.
+ */
+export declare const HdSnapKeyringAccountOptionsStruct: import("@metamask/superstruct").Struct<{
+    entropySource: string;
+    index: number;
+    derivationPath: string;
+}, {
+    entropySource: import("@metamask/superstruct").Struct<string, null>;
+    index: import("@metamask/superstruct").Struct<number, null>;
+    derivationPath: import("@metamask/superstruct").Struct<string, null>;
+}>;
+export type HdSnapKeyringAccountOptions = Infer<typeof HdSnapKeyringAccountOptionsStruct>;
+/**
+ * HD keyring account for Snap accounts that handles non-EVM HD accounts.
+ */
+export type HdSnapKeyringAccount = InternalAccount & {
+    options: InternalAccount['options'] & HdSnapKeyringAccountOptions;
+};
+/**
+ * Check if an account is an HD Snap keyring account.
+ *
+ * @param account - Snap keyring account.
+ * @returns True if valid, false otherwise.
+ */
+export declare function isHdSnapKeyringAccount(account: InternalAccount): account is HdSnapKeyringAccount;
 //# sourceMappingURL=utils.d.cts.map

package/dist/utils.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAG5D,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa;AAGtC;;;;;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,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAItE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAElE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/D"}
+{"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;;;;;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"}

package/dist/utils.d.mts

@@ -1,4 +1,7 @@
+import type { KeyringObject } from "@metamask/keyring-controller";
 import { KeyringTypes } from "@metamask/keyring-controller";
+import type { InternalAccount } from "@metamask/keyring-internal-api";
+import type { Infer } from "@metamask/superstruct";
 import type { V4Options } from "uuid";
 /**
  * Returns the name of the keyring type.
@@ -27,19 +30,71 @@ export declare function getUUIDFromAddressOfNormalAccount(address: string): stri
  * @param keyringType - The account's keyring type.
  * @returns True if the keyring type is considered a "normal" keyring, false otherwise.
  */
-export declare function isNormalKeyringType(keyringType: KeyringTypes): boolean;
+export declare function isNormalKeyringType(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 isSnapKeyringType(keyringType: KeyringTypes | string): boolean;
+/**
+ * Check if a keyring type is a simple keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is considered a simple keyring, false otherwise.
+ */
+export declare function isSimpleKeyringType(keyringType: KeyringTypes | string): boolean;
 /**
  * Check if a keyring is a HD keyring.
  *
  * @param keyringType - The account's keyring type.
  * @returns True if the keyring is a HD keyring, false otherwise.
  */
-export declare function isHdKeyringType(keyringType: KeyringTypes): boolean;
+export declare function isHdKeyringType(keyringType: KeyringTypes | string): boolean;
 /**
- * Get the derivation path for the index of an account within a HD keyring.
+ * Get the derivation path for the index of an account within a EVM HD keyring.
  *
  * @param index - The account index.
  * @returns The derivation path.
  */
-export declare function getDerivationPathForIndex(index: number): string;
+export declare function getEvmDerivationPathForIndex(index: number): string;
+/**
+ * Get the group index from a keyring object (EVM HD keyring only) and an address.
+ *
+ * @param keyring - The keyring object.
+ * @param address - The address to match.
+ * @returns The group index for that address, undefined if not able to match the address.
+ */
+export declare function getEvmGroupIndexFromAddressIndex(keyring: KeyringObject, address: string): number | undefined;
+/**
+ * HD keyring account for Snap accounts that handles non-EVM HD accounts. (e.g the
+ * Solana Snap).
+ *
+ * NOTE: We use `superstruct.type` here `superstruct.object` since it allows
+ * extra-properties than a Snap might add in its `options`.
+ */
+export declare const HdSnapKeyringAccountOptionsStruct: import("@metamask/superstruct").Struct<{
+    entropySource: string;
+    index: number;
+    derivationPath: string;
+}, {
+    entropySource: import("@metamask/superstruct").Struct<string, null>;
+    index: import("@metamask/superstruct").Struct<number, null>;
+    derivationPath: import("@metamask/superstruct").Struct<string, null>;
+}>;
+export type HdSnapKeyringAccountOptions = Infer<typeof HdSnapKeyringAccountOptionsStruct>;
+/**
+ * HD keyring account for Snap accounts that handles non-EVM HD accounts.
+ */
+export type HdSnapKeyringAccount = InternalAccount & {
+    options: InternalAccount['options'] & HdSnapKeyringAccountOptions;
+};
+/**
+ * Check if an account is an HD Snap keyring account.
+ *
+ * @param account - Snap keyring account.
+ * @returns True if valid, false otherwise.
+ */
+export declare function isHdSnapKeyringAccount(account: InternalAccount): account is HdSnapKeyringAccount;
 //# sourceMappingURL=utils.d.mts.map

package/dist/utils.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAG5D,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa;AAGtC;;;;;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,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAItE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAElE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/D"}
+{"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;;;;;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"}

package/dist/utils.mjs

@@ -1,4 +1,5 @@
 import { KeyringTypes } from "@metamask/keyring-controller";
+import { is, number, string, type } from "@metamask/superstruct";
 import { hexToBytes } from "@metamask/utils";
 import { sha256 } from "ethereum-cryptography/sha256";
 import { v4 as uuid } from "uuid";
@@ -71,6 +72,24 @@ export function isNormalKeyringType(keyringType) {
     // adapted later on if we have new kind of keyrings!
     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 isSnapKeyringType(keyringType) {
+    return keyringType === KeyringTypes.snap;
+}
+/**
+ * Check if a keyring type is a simple keyring.
+ *
+ * @param keyringType - The account's keyring type.
+ * @returns True if the keyring type is considered a simple keyring, false otherwise.
+ */
+export function isSimpleKeyringType(keyringType) {
+    return keyringType === KeyringTypes.simple;
+}
 /**
  * Check if a keyring is a HD keyring.
  *
@@ -81,12 +100,67 @@ export function isHdKeyringType(keyringType) {
     return keyringType === KeyringTypes.hd;
 }
 /**
- * Get the derivation path for the index of an account within a HD keyring.
+ * Get the derivation path for the index of an account within a EVM HD keyring.
  *
  * @param index - The account index.
  * @returns The derivation path.
  */
-export function getDerivationPathForIndex(index) {
-    return `m/44'/60'/0'/0/${index}`;
+export function getEvmDerivationPathForIndex(index) {
+    const purpose = '44';
+    const coinType = '60'; // Ethereum.
+    return `m/${purpose}'/${coinType}'/0'/0/${index}`;
+}
+/**
+ * Get the group index from a keyring object (EVM HD keyring only) and an address.
+ *
+ * @param keyring - The keyring object.
+ * @param address - The address to match.
+ * @returns The group index for that address, undefined if not able to match the address.
+ */
+export function getEvmGroupIndexFromAddressIndex(keyring, address) {
+    // TODO: Remove this function once EVM HD keyrings start using the new unified
+    // keyring API.
+    // NOTE: We mostly put that logic in a separate function so we can easily add coverage
+    // for (supposedly) unreachable code path.
+    if (!isHdKeyringType(keyring.type)) {
+        // We cannot extract the group index from non-HD keyrings.
+        return undefined;
+    }
+    // We need to find the account index from its HD keyring. We assume those
+    // accounts are ordered, thus we can use their index to compute their
+    // derivation path and group index.
+    const groupIndex = keyring.accounts.findIndex(
+    // NOTE: This is ok to use `toLowerCase` here, since we're only dealing
+    // with EVM addresses.
+    (accountAddress) => accountAddress.toLowerCase() === address.toLowerCase());
+    // If for some reason, we cannot find this address, then the caller made a mistake
+    // and it did not use the proper keyring object. For now, we do not fail and just
+    // consider this account as "simple account".
+    if (groupIndex === -1) {
+        console.warn(`! Unable to get group index for HD account: "${address}"`);
+        return undefined;
+    }
+    return groupIndex;
+}
+/**
+ * HD keyring account for Snap accounts that handles non-EVM HD accounts. (e.g the
+ * Solana Snap).
+ *
+ * NOTE: We use `superstruct.type` here `superstruct.object` since it allows
+ * extra-properties than a Snap might add in its `options`.
+ */
+export const HdSnapKeyringAccountOptionsStruct = type({
+    entropySource: string(),
+    index: number(),
+    derivationPath: string(),
+});
+/**
+ * Check if an account is an HD Snap keyring account.
+ *
+ * @param account - Snap keyring account.
+ * @returns True if valid, false otherwise.
+ */
+export function isHdSnapKeyringAccount(account) {
+    return is(account.options, HdSnapKeyringAccountOptionsStruct);
 }
 //# sourceMappingURL=utils.mjs.map

package/dist/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAC5D,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAC7C,OAAO,EAAE,MAAM,EAAE,qCAAqC;AAEtD,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,aAAa;AAElC;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAmB;IACnD,QAAQ,WAAW,EAAE;QACnB,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;SACb;QACD,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;YACtB,OAAO,cAAc,CAAC;SACvB;QACD,OAAO,CAAC,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;SACnD;KACF;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,CAAC,WAAyB;IAC3D,gFAAgF;IAChF,oDAAoD;IACpD,OAAO,WAAW,KAAK,YAAY,CAAC,IAAI,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,WAAyB;IACvD,OAAO,WAAW,KAAK,YAAY,CAAC,EAAE,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAa;IACrD,OAAO,kBAAkB,KAAK,EAAE,CAAC;AACnC,CAAC","sourcesContent":["import { KeyringTypes } from '@metamask/keyring-controller';\nimport { hexToBytes } from '@metamask/utils';\nimport { sha256 } from 'ethereum-cryptography/sha256';\nimport type { V4Options } from 'uuid';\nimport { v4 as uuid } from 'uuid';\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(keyringType: KeyringTypes): 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;\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): boolean {\n  return keyringType === KeyringTypes.hd;\n}\n\n/**\n * Get the derivation path for the index of an account within a HD keyring.\n *\n * @param index - The account index.\n * @returns The derivation path.\n */\nexport function getDerivationPathForIndex(index: number): string {\n  return `m/44'/60'/0'/0/${index}`;\n}\n"]}
+{"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;AAElC;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAmB;IACnD,QAAQ,WAAW,EAAE;QACnB,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;SACb;QACD,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;YACtB,OAAO,cAAc,CAAC;SACvB;QACD,OAAO,CAAC,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,EAAE,CAAC,CAAC;SACnD;KACF;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;QAClC,0DAA0D;QAC1D,OAAO,SAAS,CAAC;KAClB;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;QACrB,OAAO,CAAC,IAAI,CAAC,gDAAgD,OAAO,GAAG,CAAC,CAAC;QACzE,OAAO,SAAS,CAAC;KAClB;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","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\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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/accounts-controller",
-  "version": "31.0.0",
+  "version": "32.0.1",
   "description": "Manages internal accounts",
   "keywords": [
     "MetaMask",
@@ -49,24 +49,27 @@
   "dependencies": {
     "@ethereumjs/util": "^9.1.0",
     "@metamask/base-controller": "^8.0.1",
-    "@metamask/eth-snap-keyring": "^13.0.0",
-    "@metamask/keyring-api": "^18.0.0",
-    "@metamask/keyring-internal-api": "^6.2.0",
-    "@metamask/keyring-utils": "^3.0.0",
-    "@metamask/snaps-sdk": "^7.1.0",
-    "@metamask/snaps-utils": "^9.4.0",
-    "@metamask/utils": "^11.2.0",
+    "@metamask/eth-snap-keyring": "^14.0.0",
+    "@metamask/keyring-api": "^19.0.0",
+    "@metamask/keyring-internal-api": "^7.0.0",
+    "@metamask/keyring-utils": "^3.1.0",
+    "@metamask/snaps-sdk": "^9.0.0",
+    "@metamask/snaps-utils": "^11.0.0",
+    "@metamask/superstruct": "^3.1.0",
+    "@metamask/utils": "^11.4.2",
     "deepmerge": "^4.2.2",
     "ethereum-cryptography": "^2.1.2",
     "immer": "^9.0.6",
+    "lodash": "^4.17.21",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/keyring-controller": "^22.0.2",
-    "@metamask/network-controller": "^24.0.0",
+    "@metamask/controller-utils": "^11.11.0",
+    "@metamask/keyring-controller": "^22.1.0",
+    "@metamask/network-controller": "^24.0.1",
     "@metamask/providers": "^22.1.0",
-    "@metamask/snaps-controllers": "^12.3.1",
+    "@metamask/snaps-controllers": "^14.0.1",
     "@types/jest": "^27.4.1",
     "@types/readable-stream": "^2.3.0",
     "jest": "^27.5.1",
@@ -80,7 +83,7 @@
     "@metamask/keyring-controller": "^22.0.0",
     "@metamask/network-controller": "^24.0.0",
     "@metamask/providers": "^22.0.0",
-    "@metamask/snaps-controllers": "^12.0.0",
+    "@metamask/snaps-controllers": "^14.0.0",
     "webextension-polyfill": "^0.10.0 || ^0.11.0 || ^0.12.0"
   },
   "engines": {