@metamask-previews/account-api 0.9.0-a621908 → 0.10.0-9fbf2ff

package/dist/api/multichain/group.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"group.mjs","sourceRoot":"","sources":["../../../src/api/multichain/group.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,iBAAiB,EAAE,sBAAkB;AAE9C,MAAM,iCAAiC,GAAG,IAAI,MAAM,CAClD,IAAI,iBAAiB,CAAC,OAAO,0BAA0B,EACvD,GAAG,CACJ,CAAC;AAkCF;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,QAAmC,EACnC,UAAkB;IAElB,OAAO,GAAG,QAAQ,IAAI,UAAU,EAAE,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CACxC,KAAa;IAEb,OAAO,iCAAiC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yCAAyC,CACvD,EAA4B;IAE5B,MAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAC5D,IAAI,OAAO,EAAE,MAAM,EAAE,UAAU,KAAK,SAAS,EAAE,CAAC;QAC9C,yEAAyE;QACzE,eAAe;QACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAC3C,CAAC","sourcesContent":["import { type KeyringAccount } from '@metamask/keyring-api';\n\nimport type {\n  MultichainAccountWallet,\n  MultichainAccountWalletId,\n} from './wallet';\nimport type { Bip44Account } from '../bip44';\nimport type { AccountGroup, AccountGroupType } from '../group';\nimport { AccountWalletType } from '../wallet';\n\nconst MULTICHAIN_ACCOUNT_GROUP_ID_REGEX = new RegExp(\n  `^${AccountWalletType.Entropy}:.*/(?<groupIndex>\\\\d+)$`,\n  'u',\n);\n\n/**\n * Multichain account ID.\n */\nexport type MultichainAccountGroupId = `${MultichainAccountWalletId}/${number}`; // Use number for the account group index.\n\n/**\n * A multichain account that holds multiple accounts.\n */\nexport type MultichainAccountGroup<\n  Account extends Bip44Account<KeyringAccount>,\n> = AccountGroup<Account> & {\n  /**\n   * Multichain account group ID.\n   */\n  get id(): MultichainAccountGroupId;\n\n  /**\n   * Multichain account type.\n   */\n  get type(): AccountGroupType.MultichainAccount;\n\n  /**\n   * Multichain account's wallet reference (parent).\n   */\n  get wallet(): MultichainAccountWallet<Account>;\n\n  /**\n   * Multichain account group index.\n   */\n  get groupIndex(): number;\n};\n\n/**\n * Gets the multichain account group ID from its multichain account wallet ID and its index.\n *\n * @param walletId - Multichain account wallet ID.\n * @param groupIndex - Index of that multichain account.\n * @returns The multichain account ID.\n */\nexport function toMultichainAccountGroupId(\n  walletId: MultichainAccountWalletId,\n  groupIndex: number,\n): MultichainAccountGroupId {\n  return `${walletId}/${groupIndex}`;\n}\n\n/**\n * Checks if the given value is {@link MultichainAccountGroupId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link MultichainAccountGroupId}.\n */\nexport function isMultichainAccountGroupId(\n  value: string,\n): value is MultichainAccountGroupId {\n  return MULTICHAIN_ACCOUNT_GROUP_ID_REGEX.test(value);\n}\n\n/**\n * Gets the multichain account index from an account group ID.\n *\n * @param id - Multichain account ID.\n * @returns The multichain account index if extractable, undefined otherwise.\n */\nexport function getGroupIndexFromMultichainAccountGroupId(\n  id: MultichainAccountGroupId,\n): number {\n  const matched = id.match(MULTICHAIN_ACCOUNT_GROUP_ID_REGEX);\n  if (matched?.groups?.groupIndex === undefined) {\n    // Unable to extract group index, even though, type wise, this should not\n    // be possible!\n    throw new Error('Unable to extract group index');\n  }\n\n  return Number(matched.groups.groupIndex);\n}\n"]}
+{"version":3,"file":"group.mjs","sourceRoot":"","sources":["../../../src/api/multichain/group.ts"],"names":[],"mappings":"AAeA;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAC5C,kFAAkF,CAAC;AAyCrF;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,QAAmC,EACnC,UAAkB;IAElB,OAAO,GAAG,QAAQ,IAAI,UAAU,EAAE,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CACxC,KAAa;IAEb,OAAO,iCAAiC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,6BAA6B,CAC3C,OAAe;IAEf,MAAM,KAAK,GAAG,iCAAiC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9D,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,yCAAyC,OAAO,GAAG,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,QAAqC,CAAC;IACpE,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAuC,CAAC;IACxE,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,WAAqB,CAAC;IAEvD,OAAO;QACL,MAAM,EAAE;YACN,EAAE,EAAE,QAAQ;YACZ,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,WAAW;SACnB;QACD,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;KAC5C,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,yCAAyC,CACvD,EAA4B;IAE5B,OAAO,6BAA6B,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC;AACtD,CAAC","sourcesContent":["import { type KeyringAccount } from '@metamask/keyring-api';\n\nimport type {\n  MultichainAccountWallet,\n  MultichainAccountWalletId,\n} from './wallet';\nimport type { Bip44Account } from '../bip44';\nimport type { AccountGroup, AccountGroupType } from '../group';\nimport type { AccountWalletType } from '../wallet';\n\n/**\n * Multichain account ID.\n */\nexport type MultichainAccountGroupId = `${MultichainAccountWalletId}/${number}`; // Use number for the account group index.\n\n/**\n * Regex to validate a valid multichain account group ID.\n */\nexport const MULTICHAIN_ACCOUNT_GROUP_ID_REGEX =\n  /^(?<walletId>(?<walletType>entropy):(?<walletSubId>.+))\\/(?<groupIndex>[0-9]+)$/u;\n\n/**\n * Parsed account group ID with its parsed wallet component and its sub-ID.\n */\nexport type ParsedMultichainAccountGroupId = {\n  wallet: {\n    id: MultichainAccountWalletId;\n    type: AccountWalletType.Entropy;\n    subId: string;\n  };\n  groupIndex: number;\n};\n\n/**\n * A multichain account that holds multiple accounts.\n */\nexport type MultichainAccountGroup<\n  Account extends Bip44Account<KeyringAccount>,\n> = AccountGroup<Account> & {\n  /**\n   * Multichain account group ID.\n   */\n  get id(): MultichainAccountGroupId;\n\n  /**\n   * Multichain account type.\n   */\n  get type(): AccountGroupType.MultichainAccount;\n\n  /**\n   * Multichain account's wallet reference (parent).\n   */\n  get wallet(): MultichainAccountWallet<Account>;\n\n  /**\n   * Multichain account group index.\n   */\n  get groupIndex(): number;\n};\n\n/**\n * Gets the multichain account group ID from its multichain account wallet ID and its index.\n *\n * @param walletId - Multichain account wallet ID.\n * @param groupIndex - Index of that multichain account.\n * @returns The multichain account ID.\n */\nexport function toMultichainAccountGroupId(\n  walletId: MultichainAccountWalletId,\n  groupIndex: number,\n): MultichainAccountGroupId {\n  return `${walletId}/${groupIndex}`;\n}\n\n/**\n * Checks if the given value is {@link MultichainAccountGroupId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link MultichainAccountGroupId}.\n */\nexport function isMultichainAccountGroupId(\n  value: string,\n): value is MultichainAccountGroupId {\n  return MULTICHAIN_ACCOUNT_GROUP_ID_REGEX.test(value);\n}\n\n/**\n * Parse a multichain account group ID to an object containing a multichain\n * wallet ID information (wallet type and wallet sub-ID), as well as\n * multichain account group ID information (group index).\n *\n * @param groupId - The multichain account group ID to validate and parse.\n * @returns The parsed multichain account group ID.\n * @throws When the group ID format is invalid.\n */\nexport function parseMultichainAccountGroupId(\n  groupId: string,\n): ParsedMultichainAccountGroupId {\n  const match = MULTICHAIN_ACCOUNT_GROUP_ID_REGEX.exec(groupId);\n  if (!match?.groups) {\n    throw new Error(`Invalid multichain account group ID: \"${groupId}\"`);\n  }\n\n  const walletId = match.groups.walletId as MultichainAccountWalletId;\n  const walletType = match.groups.walletType as AccountWalletType.Entropy;\n  const walletSubId = match.groups.walletSubId as string;\n\n  return {\n    wallet: {\n      id: walletId,\n      type: walletType,\n      subId: walletSubId,\n    },\n    groupIndex: Number(match.groups.groupIndex),\n  };\n}\n\n/**\n * Gets the multichain account index from an account group ID.\n *\n * @param id - Multichain account ID.\n * @returns The multichain account index if extractable, undefined otherwise.\n * @throws When the group ID format is invalid.\n */\nexport function getGroupIndexFromMultichainAccountGroupId(\n  id: MultichainAccountGroupId,\n): number {\n  return parseMultichainAccountGroupId(id).groupIndex;\n}\n"]}

package/dist/api/multichain/wallet.cjs

@@ -1,7 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MULTICHAIN_ACCOUNT_WALLET_ID_REGEX = void 0;
 exports.toMultichainAccountWalletId = toMultichainAccountWalletId;
+exports.isMultichainAccountWalletId = isMultichainAccountWalletId;
+exports.parseMultichainAccountWalletId = parseMultichainAccountWalletId;
 const wallet_1 = require("../wallet.cjs");
+/**
+ * Regex to validate a valid multichain account wallet ID.
+ */
+exports.MULTICHAIN_ACCOUNT_WALLET_ID_REGEX = /^(?<walletId>(?<walletType>entropy):(?<walletSubId>.+))$/u;
 /**
  * Gets the multichain account wallet ID from its entropy source.
  *
@@ -11,4 +18,31 @@ const wallet_1 = require("../wallet.cjs");
 function toMultichainAccountWalletId(entropySource) {
     return `${wallet_1.AccountWalletType.Entropy}:${entropySource}`;
 }
+/**
+ * Checks if the given value is {@link MultichainAccountWalletId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountWalletId}.
+ */
+function isMultichainAccountWalletId(value) {
+    return exports.MULTICHAIN_ACCOUNT_WALLET_ID_REGEX.test(value);
+}
+/**
+ * Parse a multichain account wallet ID to an object containing wallet ID
+ * information (wallet type and sub-ID).
+ *
+ * @param walletId - The account wallet ID to validate and parse.
+ * @returns The parsed account wallet ID.
+ * @throws When the wallet ID format is invalid.
+ */
+function parseMultichainAccountWalletId(walletId) {
+    const match = exports.MULTICHAIN_ACCOUNT_WALLET_ID_REGEX.exec(walletId);
+    if (!match?.groups) {
+        throw new Error(`Invalid multichain account wallet ID: "${walletId}"`);
+    }
+    return {
+        type: match.groups.walletType,
+        subId: match.groups.walletSubId,
+    };
+}
 //# sourceMappingURL=wallet.cjs.map

package/dist/api/multichain/wallet.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.cjs","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":";;AA8DA,kEAIC;AA1DD,0CAA8C;AAgD9C;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,aAA8B;IAE9B,OAAO,GAAG,0BAAiB,CAAC,OAAO,IAAI,aAAa,EAAE,CAAC;AACzD,CAAC","sourcesContent":["import {\n  type EntropySourceId,\n  type KeyringAccount,\n} from '@metamask/keyring-api';\n\nimport type { MultichainAccountGroup } from './group';\nimport type { Bip44Account } from '../bip44';\nimport type { AccountWallet } from '../wallet';\nimport { AccountWalletType } from '../wallet';\n\n/**\n * Multichain account wallet ID.\n */\nexport type MultichainAccountWalletId =\n  `${AccountWalletType.Entropy}:${EntropySourceId}`;\n\n/**\n * A multichain account wallet that holds multiple multichain accounts (one multichain account per\n * group index).\n */\nexport type MultichainAccountWallet<\n  Account extends Bip44Account<KeyringAccount>,\n> = AccountWallet<Account> & {\n  /**\n   * Multichain account wallet ID.\n   */\n  get id(): MultichainAccountWalletId;\n\n  /**\n   * Multichain account wallet type, which is always {@link AccountWalletType.Entropy}.\n   */\n  get type(): AccountWalletType.Entropy;\n\n  /**\n   * Multichain account wallet entropy source.\n   */\n  get entropySource(): EntropySourceId;\n\n  /**\n   * Gets multichain account for a given index.\n   *\n   * @param groupIndex - Multichain account index.\n   * @returns The multichain account associated with the given index.\n   */\n  getMultichainAccountGroup(\n    groupIndex: number,\n  ): MultichainAccountGroup<Account> | undefined;\n\n  /**\n   * Gets all multichain accounts.\n   *\n   * @returns The multichain accounts.\n   */\n  getMultichainAccountGroups(): MultichainAccountGroup<Account>[];\n};\n\n/**\n * Gets the multichain account wallet ID from its entropy source.\n *\n * @param entropySource - Entropy source ID of that wallet.\n * @returns The multichain account wallet ID.\n */\nexport function toMultichainAccountWalletId(\n  entropySource: EntropySourceId,\n): MultichainAccountWalletId {\n  return `${AccountWalletType.Entropy}:${entropySource}`;\n}\n"]}
+{"version":3,"file":"wallet.cjs","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":";;;AA2GA,kEAIC;AAQD,kEAIC;AAUD,wEAYC;AAzID,0CAA8C;AAQ9C;;GAEG;AACU,QAAA,kCAAkC,GAC7C,2DAA2D,CAAC;AAiF9D;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,aAA8B;IAE9B,OAAO,GAAG,0BAAiB,CAAC,OAAO,IAAI,aAAa,EAAE,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,KAAa;IAEb,OAAO,0CAAkC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,8BAA8B,CAC5C,QAAgB;IAEhB,MAAM,KAAK,GAAG,0CAAkC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,0CAA0C,QAAQ,GAAG,CAAC,CAAC;IACzE,CAAC;IAED,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,UAAuC;QAC1D,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,WAAqB;KAC1C,CAAC;AACJ,CAAC","sourcesContent":["import {\n  type EntropySourceId,\n  type KeyringAccount,\n} from '@metamask/keyring-api';\n\nimport type { MultichainAccountGroup } from './group';\nimport type { Bip44Account } from '../bip44';\nimport type { AccountWalletStatus, BaseAccountWallet } from '../wallet';\nimport { AccountWalletType } from '../wallet';\n\n/**\n * Multichain account wallet ID.\n */\nexport type MultichainAccountWalletId =\n  `${AccountWalletType.Entropy}:${EntropySourceId}`;\n\n/**\n * Regex to validate a valid multichain account wallet ID.\n */\nexport const MULTICHAIN_ACCOUNT_WALLET_ID_REGEX =\n  /^(?<walletId>(?<walletType>entropy):(?<walletSubId>.+))$/u;\n\n/**\n * Parsed multichain account wallet ID with its wallet type and sub-ID.\n */\nexport type ParsedMultichainAccountWalletId = {\n  type: AccountWalletType.Entropy;\n  subId: string;\n};\n\n/**\n * Wallet status.\n *\n * Those status are used to report in which \"state\" the wallet is currently\n * in. All of those operations cannot run concurrently, thus, the wallet\n * cannot have multiple status at once.\n */\nexport type MultichainAccountWalletStatus =\n  | AccountWalletStatus\n  /**\n   * Discovery is in progress for this wallet. New account groups will be\n   * automatically added based on the account provider discovery result.\n   */\n  | 'in-progress:discovery'\n  /**\n   * Alignment is in progress for this wallet. Account groups will be\n   * automatically updated based on the active account providers.\n   */\n  | 'in-progress:alignment'\n  /**\n   * An on-going operation (creating/deleting) is in progress for this\n   * wallet. Account groups will either be created or deleted during\n   * this operation.\n   */\n  | 'in-progress:operation';\n\n/**\n * A multichain account wallet that holds multiple multichain accounts (one multichain account per\n * group index).\n */\nexport type MultichainAccountWallet<\n  Account extends Bip44Account<KeyringAccount>,\n> = BaseAccountWallet<Account> & {\n  /**\n   * Multichain account wallet ID.\n   */\n  get id(): MultichainAccountWalletId;\n\n  /**\n   * Multichain account wallet type, which is always {@link AccountWalletType.Entropy}.\n   */\n  get type(): AccountWalletType.Entropy;\n\n  /**\n   * Multichain account wallet entropy source.\n   */\n  get entropySource(): EntropySourceId;\n\n  /**\n   * Multichain account wallet status.\n   */\n  get status(): MultichainAccountWalletStatus;\n\n  /**\n   * Gets multichain account for a given index.\n   *\n   * @param groupIndex - Multichain account index.\n   * @returns The multichain account associated with the given index.\n   */\n  getMultichainAccountGroup(\n    groupIndex: number,\n  ): MultichainAccountGroup<Account> | undefined;\n\n  /**\n   * Gets all multichain accounts.\n   *\n   * @returns The multichain accounts.\n   */\n  getMultichainAccountGroups(): MultichainAccountGroup<Account>[];\n};\n\n/**\n * Gets the multichain account wallet ID from its entropy source.\n *\n * @param entropySource - Entropy source ID of that wallet.\n * @returns The multichain account wallet ID.\n */\nexport function toMultichainAccountWalletId(\n  entropySource: EntropySourceId,\n): MultichainAccountWalletId {\n  return `${AccountWalletType.Entropy}:${entropySource}`;\n}\n\n/**\n * Checks if the given value is {@link MultichainAccountWalletId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link MultichainAccountWalletId}.\n */\nexport function isMultichainAccountWalletId(\n  value: string,\n): value is MultichainAccountWalletId {\n  return MULTICHAIN_ACCOUNT_WALLET_ID_REGEX.test(value);\n}\n\n/**\n * Parse a multichain account wallet ID to an object containing wallet ID\n * information (wallet type and sub-ID).\n *\n * @param walletId - The account wallet ID to validate and parse.\n * @returns The parsed account wallet ID.\n * @throws When the wallet ID format is invalid.\n */\nexport function parseMultichainAccountWalletId(\n  walletId: string,\n): ParsedMultichainAccountWalletId {\n  const match = MULTICHAIN_ACCOUNT_WALLET_ID_REGEX.exec(walletId);\n  if (!match?.groups) {\n    throw new Error(`Invalid multichain account wallet ID: \"${walletId}\"`);\n  }\n\n  return {\n    type: match.groups.walletType as AccountWalletType.Entropy,\n    subId: match.groups.walletSubId as string,\n  };\n}\n"]}

package/dist/api/multichain/wallet.d.cts

@@ -1,17 +1,52 @@
 import { type EntropySourceId, type KeyringAccount } from "@metamask/keyring-api";
 import type { MultichainAccountGroup } from "./group.cjs";
 import type { Bip44Account } from "../bip44.cjs";
-import type { AccountWallet } from "../wallet.cjs";
+import type { AccountWalletStatus, BaseAccountWallet } from "../wallet.cjs";
 import { AccountWalletType } from "../wallet.cjs";
 /**
  * Multichain account wallet ID.
  */
 export type MultichainAccountWalletId = `${AccountWalletType.Entropy}:${EntropySourceId}`;
+/**
+ * Regex to validate a valid multichain account wallet ID.
+ */
+export declare const MULTICHAIN_ACCOUNT_WALLET_ID_REGEX: RegExp;
+/**
+ * Parsed multichain account wallet ID with its wallet type and sub-ID.
+ */
+export type ParsedMultichainAccountWalletId = {
+    type: AccountWalletType.Entropy;
+    subId: string;
+};
+/**
+ * Wallet status.
+ *
+ * Those status are used to report in which "state" the wallet is currently
+ * in. All of those operations cannot run concurrently, thus, the wallet
+ * cannot have multiple status at once.
+ */
+export type MultichainAccountWalletStatus = AccountWalletStatus
+/**
+ * Discovery is in progress for this wallet. New account groups will be
+ * automatically added based on the account provider discovery result.
+ */
+ | 'in-progress:discovery'
+/**
+ * Alignment is in progress for this wallet. Account groups will be
+ * automatically updated based on the active account providers.
+ */
+ | 'in-progress:alignment'
+/**
+ * An on-going operation (creating/deleting) is in progress for this
+ * wallet. Account groups will either be created or deleted during
+ * this operation.
+ */
+ | 'in-progress:operation';
 /**
  * A multichain account wallet that holds multiple multichain accounts (one multichain account per
  * group index).
  */
-export type MultichainAccountWallet<Account extends Bip44Account<KeyringAccount>> = AccountWallet<Account> & {
+export type MultichainAccountWallet<Account extends Bip44Account<KeyringAccount>> = BaseAccountWallet<Account> & {
     /**
      * Multichain account wallet ID.
      */
@@ -24,6 +59,10 @@ export type MultichainAccountWallet<Account extends Bip44Account<KeyringAccount>
      * Multichain account wallet entropy source.
      */
     get entropySource(): EntropySourceId;
+    /**
+     * Multichain account wallet status.
+     */
+    get status(): MultichainAccountWalletStatus;
     /**
      * Gets multichain account for a given index.
      *
@@ -45,4 +84,20 @@ export type MultichainAccountWallet<Account extends Bip44Account<KeyringAccount>
  * @returns The multichain account wallet ID.
  */
 export declare function toMultichainAccountWalletId(entropySource: EntropySourceId): MultichainAccountWalletId;
+/**
+ * Checks if the given value is {@link MultichainAccountWalletId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountWalletId}.
+ */
+export declare function isMultichainAccountWalletId(value: string): value is MultichainAccountWalletId;
+/**
+ * Parse a multichain account wallet ID to an object containing wallet ID
+ * information (wallet type and sub-ID).
+ *
+ * @param walletId - The account wallet ID to validate and parse.
+ * @returns The parsed account wallet ID.
+ * @throws When the wallet ID format is invalid.
+ */
+export declare function parseMultichainAccountWalletId(walletId: string): ParsedMultichainAccountWalletId;
 //# sourceMappingURL=wallet.d.cts.map

package/dist/api/multichain/wallet.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.d.cts","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,8BAA8B;AAE/B,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAgB;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAE,sBAAkB;AAC/C,OAAO,EAAE,iBAAiB,EAAE,sBAAkB;AAE9C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACnC,GAAG,iBAAiB,CAAC,OAAO,IAAI,eAAe,EAAE,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CACjC,OAAO,SAAS,YAAY,CAAC,cAAc,CAAC,IAC1C,aAAa,CAAC,OAAO,CAAC,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,IAAI,yBAAyB,CAAC;IAEpC;;OAEG;IACH,IAAI,IAAI,IAAI,iBAAiB,CAAC,OAAO,CAAC;IAEtC;;OAEG;IACH,IAAI,aAAa,IAAI,eAAe,CAAC;IAErC;;;;;OAKG;IACH,yBAAyB,CACvB,UAAU,EAAE,MAAM,GACjB,sBAAsB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAE/C;;;;OAIG;IACH,0BAA0B,IAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;CACjE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,eAAe,GAC7B,yBAAyB,CAE3B"}
+{"version":3,"file":"wallet.d.cts","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,8BAA8B;AAE/B,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAgB;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAkB;AACxE,OAAO,EAAE,iBAAiB,EAAE,sBAAkB;AAE9C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACnC,GAAG,iBAAiB,CAAC,OAAO,IAAI,eAAe,EAAE,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,kCAAkC,QACc,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,6BAA6B,GACrC,mBAAmB;AACrB;;;GAGG;GACD,uBAAuB;AACzB;;;GAGG;GACD,uBAAuB;AACzB;;;;GAIG;GACD,uBAAuB,CAAC;AAE5B;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CACjC,OAAO,SAAS,YAAY,CAAC,cAAc,CAAC,IAC1C,iBAAiB,CAAC,OAAO,CAAC,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,IAAI,yBAAyB,CAAC;IAEpC;;OAEG;IACH,IAAI,IAAI,IAAI,iBAAiB,CAAC,OAAO,CAAC;IAEtC;;OAEG;IACH,IAAI,aAAa,IAAI,eAAe,CAAC;IAErC;;OAEG;IACH,IAAI,MAAM,IAAI,6BAA6B,CAAC;IAE5C;;;;;OAKG;IACH,yBAAyB,CACvB,UAAU,EAAE,MAAM,GACjB,sBAAsB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAE/C;;;;OAIG;IACH,0BAA0B,IAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;CACjE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,eAAe,GAC7B,yBAAyB,CAE3B;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,MAAM,GACZ,KAAK,IAAI,yBAAyB,CAEpC;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,MAAM,GACf,+BAA+B,CAUjC"}

package/dist/api/multichain/wallet.d.mts

@@ -1,17 +1,52 @@
 import { type EntropySourceId, type KeyringAccount } from "@metamask/keyring-api";
 import type { MultichainAccountGroup } from "./group.mjs";
 import type { Bip44Account } from "../bip44.mjs";
-import type { AccountWallet } from "../wallet.mjs";
+import type { AccountWalletStatus, BaseAccountWallet } from "../wallet.mjs";
 import { AccountWalletType } from "../wallet.mjs";
 /**
  * Multichain account wallet ID.
  */
 export type MultichainAccountWalletId = `${AccountWalletType.Entropy}:${EntropySourceId}`;
+/**
+ * Regex to validate a valid multichain account wallet ID.
+ */
+export declare const MULTICHAIN_ACCOUNT_WALLET_ID_REGEX: RegExp;
+/**
+ * Parsed multichain account wallet ID with its wallet type and sub-ID.
+ */
+export type ParsedMultichainAccountWalletId = {
+    type: AccountWalletType.Entropy;
+    subId: string;
+};
+/**
+ * Wallet status.
+ *
+ * Those status are used to report in which "state" the wallet is currently
+ * in. All of those operations cannot run concurrently, thus, the wallet
+ * cannot have multiple status at once.
+ */
+export type MultichainAccountWalletStatus = AccountWalletStatus
+/**
+ * Discovery is in progress for this wallet. New account groups will be
+ * automatically added based on the account provider discovery result.
+ */
+ | 'in-progress:discovery'
+/**
+ * Alignment is in progress for this wallet. Account groups will be
+ * automatically updated based on the active account providers.
+ */
+ | 'in-progress:alignment'
+/**
+ * An on-going operation (creating/deleting) is in progress for this
+ * wallet. Account groups will either be created or deleted during
+ * this operation.
+ */
+ | 'in-progress:operation';
 /**
  * A multichain account wallet that holds multiple multichain accounts (one multichain account per
  * group index).
  */
-export type MultichainAccountWallet<Account extends Bip44Account<KeyringAccount>> = AccountWallet<Account> & {
+export type MultichainAccountWallet<Account extends Bip44Account<KeyringAccount>> = BaseAccountWallet<Account> & {
     /**
      * Multichain account wallet ID.
      */
@@ -24,6 +59,10 @@ export type MultichainAccountWallet<Account extends Bip44Account<KeyringAccount>
      * Multichain account wallet entropy source.
      */
     get entropySource(): EntropySourceId;
+    /**
+     * Multichain account wallet status.
+     */
+    get status(): MultichainAccountWalletStatus;
     /**
      * Gets multichain account for a given index.
      *
@@ -45,4 +84,20 @@ export type MultichainAccountWallet<Account extends Bip44Account<KeyringAccount>
  * @returns The multichain account wallet ID.
  */
 export declare function toMultichainAccountWalletId(entropySource: EntropySourceId): MultichainAccountWalletId;
+/**
+ * Checks if the given value is {@link MultichainAccountWalletId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountWalletId}.
+ */
+export declare function isMultichainAccountWalletId(value: string): value is MultichainAccountWalletId;
+/**
+ * Parse a multichain account wallet ID to an object containing wallet ID
+ * information (wallet type and sub-ID).
+ *
+ * @param walletId - The account wallet ID to validate and parse.
+ * @returns The parsed account wallet ID.
+ * @throws When the wallet ID format is invalid.
+ */
+export declare function parseMultichainAccountWalletId(walletId: string): ParsedMultichainAccountWalletId;
 //# sourceMappingURL=wallet.d.mts.map

package/dist/api/multichain/wallet.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.d.mts","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,8BAA8B;AAE/B,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAgB;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAE,sBAAkB;AAC/C,OAAO,EAAE,iBAAiB,EAAE,sBAAkB;AAE9C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACnC,GAAG,iBAAiB,CAAC,OAAO,IAAI,eAAe,EAAE,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CACjC,OAAO,SAAS,YAAY,CAAC,cAAc,CAAC,IAC1C,aAAa,CAAC,OAAO,CAAC,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,IAAI,yBAAyB,CAAC;IAEpC;;OAEG;IACH,IAAI,IAAI,IAAI,iBAAiB,CAAC,OAAO,CAAC;IAEtC;;OAEG;IACH,IAAI,aAAa,IAAI,eAAe,CAAC;IAErC;;;;;OAKG;IACH,yBAAyB,CACvB,UAAU,EAAE,MAAM,GACjB,sBAAsB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAE/C;;;;OAIG;IACH,0BAA0B,IAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;CACjE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,eAAe,GAC7B,yBAAyB,CAE3B"}
+{"version":3,"file":"wallet.d.mts","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,8BAA8B;AAE/B,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAgB;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAkB;AACxE,OAAO,EAAE,iBAAiB,EAAE,sBAAkB;AAE9C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACnC,GAAG,iBAAiB,CAAC,OAAO,IAAI,eAAe,EAAE,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,kCAAkC,QACc,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,6BAA6B,GACrC,mBAAmB;AACrB;;;GAGG;GACD,uBAAuB;AACzB;;;GAGG;GACD,uBAAuB;AACzB;;;;GAIG;GACD,uBAAuB,CAAC;AAE5B;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CACjC,OAAO,SAAS,YAAY,CAAC,cAAc,CAAC,IAC1C,iBAAiB,CAAC,OAAO,CAAC,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,IAAI,yBAAyB,CAAC;IAEpC;;OAEG;IACH,IAAI,IAAI,IAAI,iBAAiB,CAAC,OAAO,CAAC;IAEtC;;OAEG;IACH,IAAI,aAAa,IAAI,eAAe,CAAC;IAErC;;OAEG;IACH,IAAI,MAAM,IAAI,6BAA6B,CAAC;IAE5C;;;;;OAKG;IACH,yBAAyB,CACvB,UAAU,EAAE,MAAM,GACjB,sBAAsB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAE/C;;;;OAIG;IACH,0BAA0B,IAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;CACjE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,eAAe,GAC7B,yBAAyB,CAE3B;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,MAAM,GACZ,KAAK,IAAI,yBAAyB,CAEpC;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,MAAM,GACf,+BAA+B,CAUjC"}

package/dist/api/multichain/wallet.mjs

@@ -1,4 +1,8 @@
 import { AccountWalletType } from "../wallet.mjs";
+/**
+ * Regex to validate a valid multichain account wallet ID.
+ */
+export const MULTICHAIN_ACCOUNT_WALLET_ID_REGEX = /^(?<walletId>(?<walletType>entropy):(?<walletSubId>.+))$/u;
 /**
  * Gets the multichain account wallet ID from its entropy source.
  *
@@ -8,4 +12,31 @@ import { AccountWalletType } from "../wallet.mjs";
 export function toMultichainAccountWalletId(entropySource) {
     return `${AccountWalletType.Entropy}:${entropySource}`;
 }
+/**
+ * Checks if the given value is {@link MultichainAccountWalletId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountWalletId}.
+ */
+export function isMultichainAccountWalletId(value) {
+    return MULTICHAIN_ACCOUNT_WALLET_ID_REGEX.test(value);
+}
+/**
+ * Parse a multichain account wallet ID to an object containing wallet ID
+ * information (wallet type and sub-ID).
+ *
+ * @param walletId - The account wallet ID to validate and parse.
+ * @returns The parsed account wallet ID.
+ * @throws When the wallet ID format is invalid.
+ */
+export function parseMultichainAccountWalletId(walletId) {
+    const match = MULTICHAIN_ACCOUNT_WALLET_ID_REGEX.exec(walletId);
+    if (!match?.groups) {
+        throw new Error(`Invalid multichain account wallet ID: "${walletId}"`);
+    }
+    return {
+        type: match.groups.walletType,
+        subId: match.groups.walletSubId,
+    };
+}
 //# sourceMappingURL=wallet.mjs.map

package/dist/api/multichain/wallet.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.mjs","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,iBAAiB,EAAE,sBAAkB;AAgD9C;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,aAA8B;IAE9B,OAAO,GAAG,iBAAiB,CAAC,OAAO,IAAI,aAAa,EAAE,CAAC;AACzD,CAAC","sourcesContent":["import {\n  type EntropySourceId,\n  type KeyringAccount,\n} from '@metamask/keyring-api';\n\nimport type { MultichainAccountGroup } from './group';\nimport type { Bip44Account } from '../bip44';\nimport type { AccountWallet } from '../wallet';\nimport { AccountWalletType } from '../wallet';\n\n/**\n * Multichain account wallet ID.\n */\nexport type MultichainAccountWalletId =\n  `${AccountWalletType.Entropy}:${EntropySourceId}`;\n\n/**\n * A multichain account wallet that holds multiple multichain accounts (one multichain account per\n * group index).\n */\nexport type MultichainAccountWallet<\n  Account extends Bip44Account<KeyringAccount>,\n> = AccountWallet<Account> & {\n  /**\n   * Multichain account wallet ID.\n   */\n  get id(): MultichainAccountWalletId;\n\n  /**\n   * Multichain account wallet type, which is always {@link AccountWalletType.Entropy}.\n   */\n  get type(): AccountWalletType.Entropy;\n\n  /**\n   * Multichain account wallet entropy source.\n   */\n  get entropySource(): EntropySourceId;\n\n  /**\n   * Gets multichain account for a given index.\n   *\n   * @param groupIndex - Multichain account index.\n   * @returns The multichain account associated with the given index.\n   */\n  getMultichainAccountGroup(\n    groupIndex: number,\n  ): MultichainAccountGroup<Account> | undefined;\n\n  /**\n   * Gets all multichain accounts.\n   *\n   * @returns The multichain accounts.\n   */\n  getMultichainAccountGroups(): MultichainAccountGroup<Account>[];\n};\n\n/**\n * Gets the multichain account wallet ID from its entropy source.\n *\n * @param entropySource - Entropy source ID of that wallet.\n * @returns The multichain account wallet ID.\n */\nexport function toMultichainAccountWalletId(\n  entropySource: EntropySourceId,\n): MultichainAccountWalletId {\n  return `${AccountWalletType.Entropy}:${entropySource}`;\n}\n"]}
+{"version":3,"file":"wallet.mjs","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,iBAAiB,EAAE,sBAAkB;AAQ9C;;GAEG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAC7C,2DAA2D,CAAC;AAiF9D;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,aAA8B;IAE9B,OAAO,GAAG,iBAAiB,CAAC,OAAO,IAAI,aAAa,EAAE,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,KAAa;IAEb,OAAO,kCAAkC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,8BAA8B,CAC5C,QAAgB;IAEhB,MAAM,KAAK,GAAG,kCAAkC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,0CAA0C,QAAQ,GAAG,CAAC,CAAC;IACzE,CAAC;IAED,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,UAAuC;QAC1D,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,WAAqB;KAC1C,CAAC;AACJ,CAAC","sourcesContent":["import {\n  type EntropySourceId,\n  type KeyringAccount,\n} from '@metamask/keyring-api';\n\nimport type { MultichainAccountGroup } from './group';\nimport type { Bip44Account } from '../bip44';\nimport type { AccountWalletStatus, BaseAccountWallet } from '../wallet';\nimport { AccountWalletType } from '../wallet';\n\n/**\n * Multichain account wallet ID.\n */\nexport type MultichainAccountWalletId =\n  `${AccountWalletType.Entropy}:${EntropySourceId}`;\n\n/**\n * Regex to validate a valid multichain account wallet ID.\n */\nexport const MULTICHAIN_ACCOUNT_WALLET_ID_REGEX =\n  /^(?<walletId>(?<walletType>entropy):(?<walletSubId>.+))$/u;\n\n/**\n * Parsed multichain account wallet ID with its wallet type and sub-ID.\n */\nexport type ParsedMultichainAccountWalletId = {\n  type: AccountWalletType.Entropy;\n  subId: string;\n};\n\n/**\n * Wallet status.\n *\n * Those status are used to report in which \"state\" the wallet is currently\n * in. All of those operations cannot run concurrently, thus, the wallet\n * cannot have multiple status at once.\n */\nexport type MultichainAccountWalletStatus =\n  | AccountWalletStatus\n  /**\n   * Discovery is in progress for this wallet. New account groups will be\n   * automatically added based on the account provider discovery result.\n   */\n  | 'in-progress:discovery'\n  /**\n   * Alignment is in progress for this wallet. Account groups will be\n   * automatically updated based on the active account providers.\n   */\n  | 'in-progress:alignment'\n  /**\n   * An on-going operation (creating/deleting) is in progress for this\n   * wallet. Account groups will either be created or deleted during\n   * this operation.\n   */\n  | 'in-progress:operation';\n\n/**\n * A multichain account wallet that holds multiple multichain accounts (one multichain account per\n * group index).\n */\nexport type MultichainAccountWallet<\n  Account extends Bip44Account<KeyringAccount>,\n> = BaseAccountWallet<Account> & {\n  /**\n   * Multichain account wallet ID.\n   */\n  get id(): MultichainAccountWalletId;\n\n  /**\n   * Multichain account wallet type, which is always {@link AccountWalletType.Entropy}.\n   */\n  get type(): AccountWalletType.Entropy;\n\n  /**\n   * Multichain account wallet entropy source.\n   */\n  get entropySource(): EntropySourceId;\n\n  /**\n   * Multichain account wallet status.\n   */\n  get status(): MultichainAccountWalletStatus;\n\n  /**\n   * Gets multichain account for a given index.\n   *\n   * @param groupIndex - Multichain account index.\n   * @returns The multichain account associated with the given index.\n   */\n  getMultichainAccountGroup(\n    groupIndex: number,\n  ): MultichainAccountGroup<Account> | undefined;\n\n  /**\n   * Gets all multichain accounts.\n   *\n   * @returns The multichain accounts.\n   */\n  getMultichainAccountGroups(): MultichainAccountGroup<Account>[];\n};\n\n/**\n * Gets the multichain account wallet ID from its entropy source.\n *\n * @param entropySource - Entropy source ID of that wallet.\n * @returns The multichain account wallet ID.\n */\nexport function toMultichainAccountWalletId(\n  entropySource: EntropySourceId,\n): MultichainAccountWalletId {\n  return `${AccountWalletType.Entropy}:${entropySource}`;\n}\n\n/**\n * Checks if the given value is {@link MultichainAccountWalletId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link MultichainAccountWalletId}.\n */\nexport function isMultichainAccountWalletId(\n  value: string,\n): value is MultichainAccountWalletId {\n  return MULTICHAIN_ACCOUNT_WALLET_ID_REGEX.test(value);\n}\n\n/**\n * Parse a multichain account wallet ID to an object containing wallet ID\n * information (wallet type and sub-ID).\n *\n * @param walletId - The account wallet ID to validate and parse.\n * @returns The parsed account wallet ID.\n * @throws When the wallet ID format is invalid.\n */\nexport function parseMultichainAccountWalletId(\n  walletId: string,\n): ParsedMultichainAccountWalletId {\n  const match = MULTICHAIN_ACCOUNT_WALLET_ID_REGEX.exec(walletId);\n  if (!match?.groups) {\n    throw new Error(`Invalid multichain account wallet ID: \"${walletId}\"`);\n  }\n\n  return {\n    type: match.groups.walletType as AccountWalletType.Entropy,\n    subId: match.groups.walletSubId as string,\n  };\n}\n"]}

package/dist/api/provider.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"provider.cjs","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"","sourcesContent":["import type { EntropySourceId, KeyringAccount } from '@metamask/keyring-api';\n\n/**\n * An account provider is reponsible of providing accounts to an account group.\n */\nexport type AccountProvider<Account extends KeyringAccount> = {\n  /**\n   * Gets an account for a given ID.\n   *\n   * @returns An account, or undefined if not found.\n   */\n  getAccount: (id: Account['id']) => Account | undefined;\n\n  /**\n   * Gets all accounts for this provider.\n   *\n   * @returns A list of all account for this provider.\n   */\n  getAccounts: () => Account[];\n\n  /**\n   * Creates accounts for a given entropy source and a given group\n   * index.\n   *\n   * @param options - Options.\n   * @param options.entropySource - Entropy source to use.\n   * @param options.groupIndex - Group index to use.\n   * @returns The list of created accounts.\n   */\n  createAccounts: (options: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }) => Promise<Account[]>;\n\n  /**\n   * Discover accounts for a given entropy source and a given group\n   * index.\n   *\n   * NOTE: This method needs to also create the discovered accounts.\n   *\n   * @param options - Options.\n   * @param options.entropySource - Entropy source to use.\n   * @param options.groupIndex - Group index to use.\n   * @returns The list of discovered and created accounts.\n   */\n  discoverAndCreateAccounts: (options: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }) => Promise<Account[]>;\n};\n"]}
+{"version":3,"file":"provider.cjs","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"","sourcesContent":["import type { EntropySourceId, KeyringAccount } from '@metamask/keyring-api';\n\nimport type { Bip44Account } from './bip44';\n\n/**\n * An account provider is reponsible of providing accounts to an account group.\n */\nexport type AccountProvider<Account extends KeyringAccount> = {\n  /**\n   * Gets an account for a given ID.\n   *\n   * @returns An account, or undefined if not found.\n   */\n  getAccount: (id: Account['id']) => Account | undefined;\n\n  /**\n   * Gets all accounts for this provider.\n   *\n   * @returns A list of all account for this provider.\n   */\n  getAccounts: () => Account[];\n\n  /**\n   * Creates accounts for a given entropy source and a given group\n   * index.\n   *\n   * @param options - Options.\n   * @param options.entropySource - Entropy source to use.\n   * @param options.groupIndex - Group index to use.\n   * @returns The list of created accounts.\n   */\n  createAccounts: (options: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }) => Promise<Account[]>;\n\n  /**\n   * Discover accounts for a given entropy source and a given group\n   * index.\n   *\n   * NOTE: This method needs to also create the discovered accounts.\n   *\n   * @param options - Options.\n   * @param options.entropySource - Entropy source to use.\n   * @param options.groupIndex - Group index to use.\n   * @returns The list of discovered and created accounts.\n   */\n  discoverAndCreateAccounts: (options: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }) => Promise<Account[]>;\n};\n\n/**\n * A BIP-44 provider is a provider that can provide BIP-44 compatible accounts.\n *\n * Note: This is an alias for the `AccountProvider` type, but with a more specific\n * type for the account.\n */\nexport type Bip44AccountProvider = AccountProvider<\n  Bip44Account<KeyringAccount>\n>;\n"]}

package/dist/api/provider.d.cts

@@ -1,4 +1,5 @@
 import type { EntropySourceId, KeyringAccount } from "@metamask/keyring-api";
+import type { Bip44Account } from "./bip44.cjs";
 /**
  * An account provider is reponsible of providing accounts to an account group.
  */
@@ -44,4 +45,11 @@ export type AccountProvider<Account extends KeyringAccount> = {
         groupIndex: number;
     }) => Promise<Account[]>;
 };
+/**
+ * A BIP-44 provider is a provider that can provide BIP-44 compatible accounts.
+ *
+ * Note: This is an alias for the `AccountProvider` type, but with a more specific
+ * type for the account.
+ */
+export type Bip44AccountProvider = AccountProvider<Bip44Account<KeyringAccount>>;
 //# sourceMappingURL=provider.d.cts.map

package/dist/api/provider.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.cts","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,8BAA8B;AAE7E;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,cAAc,IAAI;IAC5D;;;;OAIG;IACH,UAAU,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,GAAG,SAAS,CAAC;IAEvD;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,EAAE,CAAC;IAE7B;;;;;;;;OAQG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE;QACxB,aAAa,EAAE,eAAe,CAAC;QAC/B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEzB;;;;;;;;;;OAUG;IACH,yBAAyB,EAAE,CAAC,OAAO,EAAE;QACnC,aAAa,EAAE,eAAe,CAAC;QAC/B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"provider.d.cts","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,8BAA8B;AAE7E,OAAO,KAAK,EAAE,YAAY,EAAE,oBAAgB;AAE5C;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,cAAc,IAAI;IAC5D;;;;OAIG;IACH,UAAU,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,GAAG,SAAS,CAAC;IAEvD;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,EAAE,CAAC;IAE7B;;;;;;;;OAQG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE;QACxB,aAAa,EAAE,eAAe,CAAC;QAC/B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEzB;;;;;;;;;;OAUG;IACH,yBAAyB,EAAE,CAAC,OAAO,EAAE;QACnC,aAAa,EAAE,eAAe,CAAC;QAC/B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CAC1B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,eAAe,CAChD,YAAY,CAAC,cAAc,CAAC,CAC7B,CAAC"}

package/dist/api/provider.d.mts

@@ -1,4 +1,5 @@
 import type { EntropySourceId, KeyringAccount } from "@metamask/keyring-api";
+import type { Bip44Account } from "./bip44.mjs";
 /**
  * An account provider is reponsible of providing accounts to an account group.
  */
@@ -44,4 +45,11 @@ export type AccountProvider<Account extends KeyringAccount> = {
         groupIndex: number;
     }) => Promise<Account[]>;
 };
+/**
+ * A BIP-44 provider is a provider that can provide BIP-44 compatible accounts.
+ *
+ * Note: This is an alias for the `AccountProvider` type, but with a more specific
+ * type for the account.
+ */
+export type Bip44AccountProvider = AccountProvider<Bip44Account<KeyringAccount>>;
 //# sourceMappingURL=provider.d.mts.map

package/dist/api/provider.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.mts","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,8BAA8B;AAE7E;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,cAAc,IAAI;IAC5D;;;;OAIG;IACH,UAAU,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,GAAG,SAAS,CAAC;IAEvD;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,EAAE,CAAC;IAE7B;;;;;;;;OAQG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE;QACxB,aAAa,EAAE,eAAe,CAAC;QAC/B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEzB;;;;;;;;;;OAUG;IACH,yBAAyB,EAAE,CAAC,OAAO,EAAE;QACnC,aAAa,EAAE,eAAe,CAAC;QAC/B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"provider.d.mts","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,8BAA8B;AAE7E,OAAO,KAAK,EAAE,YAAY,EAAE,oBAAgB;AAE5C;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,cAAc,IAAI;IAC5D;;;;OAIG;IACH,UAAU,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,GAAG,SAAS,CAAC;IAEvD;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,EAAE,CAAC;IAE7B;;;;;;;;OAQG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE;QACxB,aAAa,EAAE,eAAe,CAAC;QAC/B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEzB;;;;;;;;;;OAUG;IACH,yBAAyB,EAAE,CAAC,OAAO,EAAE;QACnC,aAAa,EAAE,eAAe,CAAC;QAC/B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CAC1B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,eAAe,CAChD,YAAY,CAAC,cAAc,CAAC,CAC7B,CAAC"}

package/dist/api/provider.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"provider.mjs","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"","sourcesContent":["import type { EntropySourceId, KeyringAccount } from '@metamask/keyring-api';\n\n/**\n * An account provider is reponsible of providing accounts to an account group.\n */\nexport type AccountProvider<Account extends KeyringAccount> = {\n  /**\n   * Gets an account for a given ID.\n   *\n   * @returns An account, or undefined if not found.\n   */\n  getAccount: (id: Account['id']) => Account | undefined;\n\n  /**\n   * Gets all accounts for this provider.\n   *\n   * @returns A list of all account for this provider.\n   */\n  getAccounts: () => Account[];\n\n  /**\n   * Creates accounts for a given entropy source and a given group\n   * index.\n   *\n   * @param options - Options.\n   * @param options.entropySource - Entropy source to use.\n   * @param options.groupIndex - Group index to use.\n   * @returns The list of created accounts.\n   */\n  createAccounts: (options: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }) => Promise<Account[]>;\n\n  /**\n   * Discover accounts for a given entropy source and a given group\n   * index.\n   *\n   * NOTE: This method needs to also create the discovered accounts.\n   *\n   * @param options - Options.\n   * @param options.entropySource - Entropy source to use.\n   * @param options.groupIndex - Group index to use.\n   * @returns The list of discovered and created accounts.\n   */\n  discoverAndCreateAccounts: (options: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }) => Promise<Account[]>;\n};\n"]}
+{"version":3,"file":"provider.mjs","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"","sourcesContent":["import type { EntropySourceId, KeyringAccount } from '@metamask/keyring-api';\n\nimport type { Bip44Account } from './bip44';\n\n/**\n * An account provider is reponsible of providing accounts to an account group.\n */\nexport type AccountProvider<Account extends KeyringAccount> = {\n  /**\n   * Gets an account for a given ID.\n   *\n   * @returns An account, or undefined if not found.\n   */\n  getAccount: (id: Account['id']) => Account | undefined;\n\n  /**\n   * Gets all accounts for this provider.\n   *\n   * @returns A list of all account for this provider.\n   */\n  getAccounts: () => Account[];\n\n  /**\n   * Creates accounts for a given entropy source and a given group\n   * index.\n   *\n   * @param options - Options.\n   * @param options.entropySource - Entropy source to use.\n   * @param options.groupIndex - Group index to use.\n   * @returns The list of created accounts.\n   */\n  createAccounts: (options: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }) => Promise<Account[]>;\n\n  /**\n   * Discover accounts for a given entropy source and a given group\n   * index.\n   *\n   * NOTE: This method needs to also create the discovered accounts.\n   *\n   * @param options - Options.\n   * @param options.entropySource - Entropy source to use.\n   * @param options.groupIndex - Group index to use.\n   * @returns The list of discovered and created accounts.\n   */\n  discoverAndCreateAccounts: (options: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }) => Promise<Account[]>;\n};\n\n/**\n * A BIP-44 provider is a provider that can provide BIP-44 compatible accounts.\n *\n * Note: This is an alias for the `AccountProvider` type, but with a more specific\n * type for the account.\n */\nexport type Bip44AccountProvider = AccountProvider<\n  Bip44Account<KeyringAccount>\n>;\n"]}

package/dist/api/wallet.cjs

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AccountWalletType = void 0;
+exports.ACCOUNT_WALLET_ID_REGEX = exports.AccountWalletType = void 0;
 exports.toAccountWalletId = toAccountWalletId;
+exports.isAccountWalletId = isAccountWalletId;
+exports.parseAccountWalletId = parseAccountWalletId;
+exports.stripAccountWalletType = stripAccountWalletType;
 /**
  * Wallet type.
  *
@@ -16,6 +19,10 @@ var AccountWalletType;
     /** Wallet grouping accounts associated with an account management Snap. */
     AccountWalletType["Snap"] = "snap";
 })(AccountWalletType || (exports.AccountWalletType = AccountWalletType = {}));
+/**
+ * Regex to validate an account wallet ID.
+ */
+exports.ACCOUNT_WALLET_ID_REGEX = /^(?<walletType>entropy|keyring|snap):(?<walletSubId>.+)$/u;
 /**
  * Convert a unique ID to a wallet ID for a given type.
  *
@@ -26,4 +33,41 @@ var AccountWalletType;
 function toAccountWalletId(type, id) {
     return `${type}:${id}`;
 }
+/**
+ * Checks if the given value is {@link AccountWalletId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link AccountWalletId}.
+ */
+function isAccountWalletId(value) {
+    return exports.ACCOUNT_WALLET_ID_REGEX.test(value);
+}
+/**
+ * Parse an account wallet ID to an object containing a wallet ID information
+ * (wallet type and wallet sub-ID).
+ *
+ * @param walletId - The account wallet ID to validate and parse.
+ * @returns The parsed account wallet ID.
+ * @throws When the wallet ID format is invalid.
+ */
+function parseAccountWalletId(walletId) {
+    const match = exports.ACCOUNT_WALLET_ID_REGEX.exec(walletId);
+    if (!match?.groups) {
+        throw new Error(`Invalid account wallet ID: "${walletId}"`);
+    }
+    return {
+        type: match.groups.walletType,
+        subId: match.groups.walletSubId,
+    };
+}
+/**
+ * Strip the account wallet type from an account wallet ID.
+ *
+ * @param walletId - Account wallet ID.
+ * @returns Account wallet sub-ID.
+ * @throws When the wallet ID format is invalid.
+ */
+function stripAccountWalletType(walletId) {
+    return parseAccountWalletId(walletId).subId;
+}
 //# sourceMappingURL=wallet.cjs.map

package/dist/api/wallet.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.cjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":";;;AAsEA,8CAKC;AAtED;;;;GAIG;AACH,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,8DAA8D;IAC9D,wCAAmB,CAAA;IAEnB,8DAA8D;IAC9D,wCAAmB,CAAA;IAEnB,2EAA2E;IAC3E,kCAAa,CAAA;AACf,CAAC,EATW,iBAAiB,iCAAjB,iBAAiB,QAS5B;AA4CD;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,IAAgB,EAChB,EAAU;IAEV,OAAO,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;AACzB,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type { AccountGroup, AccountGroupId } from './group';\n\n/**\n * Wallet type.\n *\n * Each wallet types groups accounts using different criterias.\n */\nexport enum AccountWalletType {\n  /** Wallet grouping accounts based on their entropy source. */\n  Entropy = 'entropy',\n\n  /** Wallet grouping accounts based on their keyring's type. */\n  Keyring = 'keyring',\n\n  /** Wallet grouping accounts associated with an account management Snap. */\n  Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletType}:${string}`;\n\n/**\n * Account wallet that can hold multiple account groups.\n */\nexport type AccountWallet<Account extends KeyringAccount> = {\n  /**\n   * Account wallet ID.\n   */\n  get id(): AccountWalletId;\n\n  /**\n   * Account wallet type.\n   */\n  get type(): AccountWalletType;\n\n  /**\n   * Gets account group for a given ID.\n   *\n   * @param id - Account group ID.\n   * @returns Account group.\n   */\n  getAccountGroup(id: AccountGroupId): AccountGroup<Account> | undefined;\n\n  /**\n   * Gets all account groups.\n   *\n   * @returns Account groups.\n   */\n  getAccountGroups(): AccountGroup<Account>[];\n};\n\n/**\n * Type utility to compute a constrained {@link AccountWalletId} type given a\n * specifc {@link AccountWalletType}.\n */\nexport type AccountWalletIdOf<WalletType extends AccountWalletType> =\n  `${WalletType}:${string}`;\n\n/**\n * Convert a unique ID to a wallet ID for a given type.\n *\n * @param type - A wallet type.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId<WalletType extends AccountWalletType>(\n  type: WalletType,\n  id: string,\n): AccountWalletIdOf<WalletType> {\n  return `${type}:${id}`;\n}\n"]}
+{"version":3,"file":"wallet.cjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":";;;AAwJA,8CAKC;AAQD,8CAEC;AAUD,oDAUC;AASD,wDAEC;AA/LD;;;;GAIG;AACH,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,8DAA8D;IAC9D,wCAAmB,CAAA;IAEnB,8DAA8D;IAC9D,wCAAmB,CAAA;IAEnB,2EAA2E;IAC3E,kCAAa,CAAA;AACf,CAAC,EATW,iBAAiB,iCAAjB,iBAAiB,QAS5B;AAOD;;GAEG;AACU,QAAA,uBAAuB,GAClC,2DAA2D,CAAC;AAiH9D;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,IAAgB,EAChB,EAAU;IAEV,OAAO,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,OAAO,+BAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAAC,QAAgB;IACnD,MAAM,KAAK,GAAG,+BAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,GAAG,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,UAA+B;QAClD,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,WAAqB;KAC1C,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,QAAgB;IACrD,OAAO,oBAAoB,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC;AAC9C,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type { Bip44Account } from './bip44';\nimport type { AccountGroup, AccountGroupId } from './group';\nimport type { MultichainAccountWallet } from './multichain';\n\n/**\n * Wallet type.\n *\n * Each wallet types groups accounts using different criterias.\n */\nexport enum AccountWalletType {\n  /** Wallet grouping accounts based on their entropy source. */\n  Entropy = 'entropy',\n\n  /** Wallet grouping accounts based on their keyring's type. */\n  Keyring = 'keyring',\n\n  /** Wallet grouping accounts associated with an account management Snap. */\n  Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletType}:${string}`;\n\n/**\n * Regex to validate an account wallet ID.\n */\nexport const ACCOUNT_WALLET_ID_REGEX =\n  /^(?<walletType>entropy|keyring|snap):(?<walletSubId>.+)$/u;\n\n/**\n * Wallet status.\n *\n * Those status are used to report in which \"state\" the wallet is currently\n * in. All of those operations cannot run concurrently, thus, the wallet\n * cannot have multiple status at once.\n */\nexport type AccountWalletStatus =\n  /**\n   * The wallet is not initialized yet.\n   */\n  | 'uninitialized'\n  /**\n   * The wallet is ready to run any operation.\n   */\n  | 'ready';\n\n/**\n * Parsed account wallet ID with its wallet type and sub-ID.\n */\nexport type ParsedAccountWalletId = {\n  type: AccountWalletType;\n  subId: string;\n};\n\n/**\n * Keyring account wallet that can hold multiple account groups.\n */\nexport type BaseAccountWallet<Account extends KeyringAccount> = {\n  /**\n   * Account wallet ID.\n   */\n  get id(): AccountWalletId;\n\n  /**\n   * Keyring account wallet type.\n   */\n  get type(): AccountWalletType;\n\n  /**\n   * Account wallet status.\n   */\n  get status(): AccountWalletStatus;\n\n  /**\n   * Gets account group for a given ID.\n   *\n   * @param id - Account group ID.\n   * @returns Account group.\n   */\n  getAccountGroup(id: AccountGroupId): AccountGroup<Account> | undefined;\n\n  /**\n   * Gets all account groups.\n   *\n   * @returns Account groups.\n   */\n  getAccountGroups(): AccountGroup<Account>[];\n};\n\n/**\n * Keyring account wallet that can hold multiple account groups.\n */\nexport type KeyringAccountWallet<Account extends KeyringAccount> =\n  BaseAccountWallet<Account> & {\n    /**\n     * Keyring account wallet type.\n     */\n    get type(): AccountWalletType.Keyring;\n  };\n\n/**\n * Snap keyring account wallet that can hold multiple account groups.\n */\nexport type SnapAccountWallet<Account extends KeyringAccount> =\n  BaseAccountWallet<Account> & {\n    /**\n     * Snap account wallet type.\n     */\n    get type(): AccountWalletType.Snap;\n  };\n\n/**\n * Type constraint for a {@link AccountGroupObject}. If one of its union-members\n * does not match this contraint, {@link AccountGroupObject} will resolve\n * to `never`.\n */\ntype IsAccountWallet<\n  Wallet extends BaseAccountWallet<Account> & {\n    get type(): AccountWalletType;\n  },\n  Account extends KeyringAccount,\n> = Wallet;\n\n/**\n * Account wallet that can hold multiple account groups.\n */\nexport type AccountWallet<Account extends KeyringAccount> = IsAccountWallet<\n  | KeyringAccountWallet<Account>\n  | SnapAccountWallet<Account>\n  | MultichainAccountWallet<Bip44Account<Account>>,\n  Account\n>;\n\n/**\n * Type utility to compute a constrained {@link AccountWalletId} type given a\n * specifc {@link AccountWalletType}.\n */\nexport type AccountWalletIdOf<WalletType extends AccountWalletType> =\n  `${WalletType}:${string}`;\n\n/**\n * Convert a unique ID to a wallet ID for a given type.\n *\n * @param type - A wallet type.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId<WalletType extends AccountWalletType>(\n  type: WalletType,\n  id: string,\n): AccountWalletIdOf<WalletType> {\n  return `${type}:${id}`;\n}\n\n/**\n * Checks if the given value is {@link AccountWalletId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link AccountWalletId}.\n */\nexport function isAccountWalletId(value: string): value is AccountWalletId {\n  return ACCOUNT_WALLET_ID_REGEX.test(value);\n}\n\n/**\n * Parse an account wallet ID to an object containing a wallet ID information\n * (wallet type and wallet sub-ID).\n *\n * @param walletId - The account wallet ID to validate and parse.\n * @returns The parsed account wallet ID.\n * @throws When the wallet ID format is invalid.\n */\nexport function parseAccountWalletId(walletId: string): ParsedAccountWalletId {\n  const match = ACCOUNT_WALLET_ID_REGEX.exec(walletId);\n  if (!match?.groups) {\n    throw new Error(`Invalid account wallet ID: \"${walletId}\"`);\n  }\n\n  return {\n    type: match.groups.walletType as AccountWalletType,\n    subId: match.groups.walletSubId as string,\n  };\n}\n\n/**\n * Strip the account wallet type from an account wallet ID.\n *\n * @param walletId - Account wallet ID.\n * @returns Account wallet sub-ID.\n * @throws When the wallet ID format is invalid.\n */\nexport function stripAccountWalletType(walletId: string): string {\n  return parseAccountWalletId(walletId).subId;\n}\n"]}

package/dist/api/wallet.d.cts

@@ -1,5 +1,7 @@
 import type { KeyringAccount } from "@metamask/keyring-api";
+import type { Bip44Account } from "./bip44.cjs";
 import type { AccountGroup, AccountGroupId } from "./group.cjs";
+import type { MultichainAccountWallet } from "./multichain/index.cjs";
 /**
  * Wallet type.
  *
@@ -18,17 +20,48 @@ export declare enum AccountWalletType {
  */
 export type AccountWalletId = `${AccountWalletType}:${string}`;
 /**
- * Account wallet that can hold multiple account groups.
+ * Regex to validate an account wallet ID.
+ */
+export declare const ACCOUNT_WALLET_ID_REGEX: RegExp;
+/**
+ * Wallet status.
+ *
+ * Those status are used to report in which "state" the wallet is currently
+ * in. All of those operations cannot run concurrently, thus, the wallet
+ * cannot have multiple status at once.
+ */
+export type AccountWalletStatus = 
+/**
+ * The wallet is not initialized yet.
+ */
+'uninitialized'
+/**
+ * The wallet is ready to run any operation.
+ */
+ | 'ready';
+/**
+ * Parsed account wallet ID with its wallet type and sub-ID.
  */
-export type AccountWallet<Account extends KeyringAccount> = {
+export type ParsedAccountWalletId = {
+    type: AccountWalletType;
+    subId: string;
+};
+/**
+ * Keyring account wallet that can hold multiple account groups.
+ */
+export type BaseAccountWallet<Account extends KeyringAccount> = {
     /**
      * Account wallet ID.
      */
     get id(): AccountWalletId;
     /**
-     * Account wallet type.
+     * Keyring account wallet type.
      */
     get type(): AccountWalletType;
+    /**
+     * Account wallet status.
+     */
+    get status(): AccountWalletStatus;
     /**
      * Gets account group for a given ID.
      *
@@ -43,6 +76,36 @@ export type AccountWallet<Account extends KeyringAccount> = {
      */
     getAccountGroups(): AccountGroup<Account>[];
 };
+/**
+ * Keyring account wallet that can hold multiple account groups.
+ */
+export type KeyringAccountWallet<Account extends KeyringAccount> = BaseAccountWallet<Account> & {
+    /**
+     * Keyring account wallet type.
+     */
+    get type(): AccountWalletType.Keyring;
+};
+/**
+ * Snap keyring account wallet that can hold multiple account groups.
+ */
+export type SnapAccountWallet<Account extends KeyringAccount> = BaseAccountWallet<Account> & {
+    /**
+     * Snap account wallet type.
+     */
+    get type(): AccountWalletType.Snap;
+};
+/**
+ * Type constraint for a {@link AccountGroupObject}. If one of its union-members
+ * does not match this contraint, {@link AccountGroupObject} will resolve
+ * to `never`.
+ */
+type IsAccountWallet<Wallet extends BaseAccountWallet<Account> & {
+    get type(): AccountWalletType;
+}, Account extends KeyringAccount> = Wallet;
+/**
+ * Account wallet that can hold multiple account groups.
+ */
+export type AccountWallet<Account extends KeyringAccount> = IsAccountWallet<KeyringAccountWallet<Account> | SnapAccountWallet<Account> | MultichainAccountWallet<Bip44Account<Account>>, Account>;
 /**
  * Type utility to compute a constrained {@link AccountWalletId} type given a
  * specifc {@link AccountWalletType}.
@@ -56,4 +119,29 @@ export type AccountWalletIdOf<WalletType extends AccountWalletType> = `${WalletT
  * @returns A wallet ID.
  */
 export declare function toAccountWalletId<WalletType extends AccountWalletType>(type: WalletType, id: string): AccountWalletIdOf<WalletType>;
+/**
+ * Checks if the given value is {@link AccountWalletId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link AccountWalletId}.
+ */
+export declare function isAccountWalletId(value: string): value is AccountWalletId;
+/**
+ * Parse an account wallet ID to an object containing a wallet ID information
+ * (wallet type and wallet sub-ID).
+ *
+ * @param walletId - The account wallet ID to validate and parse.
+ * @returns The parsed account wallet ID.
+ * @throws When the wallet ID format is invalid.
+ */
+export declare function parseAccountWalletId(walletId: string): ParsedAccountWalletId;
+/**
+ * Strip the account wallet type from an account wallet ID.
+ *
+ * @param walletId - Account wallet ID.
+ * @returns Account wallet sub-ID.
+ * @throws When the wallet ID format is invalid.
+ */
+export declare function stripAccountWalletType(walletId: string): string;
+export {};
 //# sourceMappingURL=wallet.d.cts.map