@metamask-previews/account-api 0.2.0-e017e7a → 0.5.0-0e28ac0

package/CHANGELOG.md

@@ -7,8 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0]
+
+### Added
+
+- Add `Account{Wallet,Group}IdOf` type utility ([#331](https://github.com/MetaMask/accounts/pull/331))
+
+### Changed
+
+- Use generic type for `toAccount{Wallet,Group}Id` ([#331](https://github.com/MetaMask/accounts/pull/331))
+
+## [0.4.0]
+
+### Added
+
+- Add `AccountGroupType` + `AccountGroup.type` ([#329](https://github.com/MetaMask/accounts/pull/329))
+
+### Changed
+
+- **BREAKING:** Rename `AccountWalletCategory` to `AccountWalletType` + `category` to `type` ([#328](https://github.com/MetaMask/accounts/pull/328))
+  - This name better reflects other patterns we already have in place elsewhere.
+
+## [0.3.0]
+
 ### Added
 
+- Add `Bip44Account<Account>` type + `isBip44Account` helper ([#319](https://github.com/MetaMask/accounts/pull/319))
 - Add `MultichainAccountWallet.sync` method ([#321](https://github.com/MetaMask/accounts/pull/321))
   - This can be used to force wallet synchronization if new accounts are available on the account providers.
 
@@ -35,6 +59,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add `AccountGroup` and `AccountWallet` ([#307](https://github.com/MetaMask/accounts/pull/307))
 
-[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@0.2.0...HEAD
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@0.5.0...HEAD
+[0.5.0]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@0.4.0...@metamask/account-api@0.5.0
+[0.4.0]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@0.3.0...@metamask/account-api@0.4.0
+[0.3.0]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@0.2.0...@metamask/account-api@0.3.0
 [0.2.0]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@0.1.0...@metamask/account-api@0.2.0
 [0.1.0]: https://github.com/MetaMask/accounts/releases/tag/@metamask/account-api@0.1.0

package/dist/api/group.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = void 0;
+exports.AccountGroupType = exports.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = void 0;
 exports.toAccountGroupId = toAccountGroupId;
 exports.toDefaultAccountGroupId = toDefaultAccountGroupId;
 /**
@@ -10,6 +10,18 @@ exports.toDefaultAccountGroupId = toDefaultAccountGroupId;
  * an account wallet.
  */
 exports.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = 'default';
+/**
+ * Account group object.
+ *
+ * Each group types groups accounts using different criterias.
+ */
+var AccountGroupType;
+(function (AccountGroupType) {
+    /** Group that represents a multichain account. */
+    AccountGroupType["MultichainAccount"] = "multichain-account";
+    /** Group that represents a single account. */
+    AccountGroupType["SingleAccount"] = "single-account";
+})(AccountGroupType || (exports.AccountGroupType = AccountGroupType = {}));
 /**
  * Convert a wallet ID and a unique ID, to a group ID.
  *

package/dist/api/group.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"group.cjs","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":";;;AAuDA,4CAKC;AAQD,0DAIC;AAnED;;;;;GAKG;AACU,QAAA,+BAA+B,GAAW,SAAS,CAAC;AAqCjE;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,QAAyB,EACzB,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,QAAyB;IAEzB,OAAO,gBAAgB,CAAC,QAAQ,EAAE,uCAA+B,CAAC,CAAC;AACrE,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type { AccountWallet, AccountWalletId } from './wallet';\n\n/**\n * Default account group unique ID.\n *\n * This constant can be used to reference the \"default\" group from\n * an account wallet.\n */\nexport const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string = 'default';\n\n/**\n * Account group ID.\n */\nexport type AccountGroupId = `${AccountWalletId}/${string}`;\n\n/**\n * Account group that can hold multiple accounts.\n */\nexport type AccountGroup<Account extends KeyringAccount> = {\n  /**\n   * Account group ID.\n   */\n  get id(): AccountGroupId;\n\n  /**\n   * Account wallet (parent).\n   */\n  get wallet(): AccountWallet<Account>;\n\n  /**\n   * Gets the accounts for this account group.\n   *\n   * @returns The accounts.\n   */\n  getAccounts(): Account[];\n\n  /**\n   * Gets the account for a given account ID.\n   *\n   * @param id - Account ID.\n   * @returns The account or undefined if not found.\n   */\n  getAccount(id: Account['id']): Account | undefined;\n};\n\n/**\n * Convert a wallet ID and a unique ID, to a group ID.\n *\n * @param walletId - A wallet ID.\n * @param id - A unique ID.\n * @returns A group ID.\n */\nexport function toAccountGroupId(\n  walletId: AccountWalletId,\n  id: string,\n): AccountGroupId {\n  return `${walletId}/${id}`;\n}\n\n/**\n * Convert a wallet ID to the default group ID.\n *\n * @param walletId - A wallet ID.\n * @returns The default group ID.\n */\nexport function toDefaultAccountGroupId(\n  walletId: AccountWalletId,\n): AccountGroupId {\n  return toAccountGroupId(walletId, DEFAULT_ACCOUNT_GROUP_UNIQUE_ID);\n}\n"]}
+{"version":3,"file":"group.cjs","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":";;;AAqFA,4CAKC;AAQD,0DAOC;AA/FD;;;;;GAKG;AACU,QAAA,+BAA+B,GAAW,SAAS,CAAC;AAEjE;;;;GAIG;AACH,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,kDAAkD;IAClD,4DAAwC,CAAA;IAExC,8CAA8C;IAC9C,oDAAgC,CAAA;AAClC,CAAC,EANW,gBAAgB,gCAAhB,gBAAgB,QAM3B;AAiDD;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,QAAuC,EACvC,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,QAAuC;IAEvC,OAAO,gBAAgB,CACrB,QAAQ,EACR,uCAA+B,CAChC,CAAC;AACJ,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type {\n  AccountWallet,\n  AccountWalletId,\n  AccountWalletIdOf,\n  AccountWalletType,\n} from './wallet';\n\n/**\n * Default account group unique ID.\n *\n * This constant can be used to reference the \"default\" group from\n * an account wallet.\n */\nexport const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string = 'default';\n\n/**\n * Account group object.\n *\n * Each group types groups accounts using different criterias.\n */\nexport enum AccountGroupType {\n  /** Group that represents a multichain account. */\n  MultichainAccount = 'multichain-account',\n\n  /** Group that represents a single account. */\n  SingleAccount = 'single-account',\n}\n\n/**\n * Account group ID.\n */\nexport type AccountGroupId = `${AccountWalletId}/${string}`;\n\n/**\n * Account group that can hold multiple accounts.\n */\nexport type AccountGroup<Account extends KeyringAccount> = {\n  /**\n   * Account group ID.\n   */\n  get id(): AccountGroupId;\n\n  /**\n   * Account group type.\n   */\n  get type(): AccountGroupType;\n\n  /**\n   * Account wallet (parent).\n   */\n  get wallet(): AccountWallet<Account>;\n\n  /**\n   * Gets the accounts for this account group.\n   *\n   * @returns The accounts.\n   */\n  getAccounts(): Account[];\n\n  /**\n   * Gets the account for a given account ID.\n   *\n   * @param id - Account ID.\n   * @returns The account or undefined if not found.\n   */\n  getAccount(id: Account['id']): Account | undefined;\n};\n\n/**\n * Type utility to compute a constrained {@link AccountGroupId} type given a\n * specifc {@link AccountWalletType}.\n */\nexport type AccountGroupIdOf<WalletType extends AccountWalletType> =\n  `${AccountWalletIdOf<WalletType>}/${string}`;\n\n/**\n * Convert a wallet ID and a unique ID, to a group ID.\n *\n * @param walletId - A wallet ID.\n * @param id - A unique ID.\n * @returns A group ID.\n */\nexport function toAccountGroupId<WalletType extends AccountWalletType>(\n  walletId: AccountWalletIdOf<WalletType>,\n  id: string,\n): AccountGroupIdOf<WalletType> {\n  return `${walletId}/${id}`;\n}\n\n/**\n * Convert a wallet ID to the default group ID.\n *\n * @param walletId - A wallet ID.\n * @returns The default group ID.\n */\nexport function toDefaultAccountGroupId<WalletType extends AccountWalletType>(\n  walletId: AccountWalletIdOf<WalletType>,\n): AccountGroupIdOf<WalletType> {\n  return toAccountGroupId<WalletType>(\n    walletId,\n    DEFAULT_ACCOUNT_GROUP_UNIQUE_ID,\n  );\n}\n"]}

package/dist/api/group.d.cts

@@ -1,5 +1,5 @@
 import type { KeyringAccount } from "@metamask/keyring-api";
-import type { AccountWallet, AccountWalletId } from "./wallet.cjs";
+import type { AccountWallet, AccountWalletId, AccountWalletIdOf, AccountWalletType } from "./wallet.cjs";
 /**
  * Default account group unique ID.
  *
@@ -7,6 +7,17 @@ import type { AccountWallet, AccountWalletId } from "./wallet.cjs";
  * an account wallet.
  */
 export declare const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string;
+/**
+ * Account group object.
+ *
+ * Each group types groups accounts using different criterias.
+ */
+export declare enum AccountGroupType {
+    /** Group that represents a multichain account. */
+    MultichainAccount = "multichain-account",
+    /** Group that represents a single account. */
+    SingleAccount = "single-account"
+}
 /**
  * Account group ID.
  */
@@ -19,6 +30,10 @@ export type AccountGroup<Account extends KeyringAccount> = {
      * Account group ID.
      */
     get id(): AccountGroupId;
+    /**
+     * Account group type.
+     */
+    get type(): AccountGroupType;
     /**
      * Account wallet (parent).
      */
@@ -37,6 +52,11 @@ export type AccountGroup<Account extends KeyringAccount> = {
      */
     getAccount(id: Account['id']): Account | undefined;
 };
+/**
+ * Type utility to compute a constrained {@link AccountGroupId} type given a
+ * specifc {@link AccountWalletType}.
+ */
+export type AccountGroupIdOf<WalletType extends AccountWalletType> = `${AccountWalletIdOf<WalletType>}/${string}`;
 /**
  * Convert a wallet ID and a unique ID, to a group ID.
  *
@@ -44,12 +64,12 @@ export type AccountGroup<Account extends KeyringAccount> = {
  * @param id - A unique ID.
  * @returns A group ID.
  */
-export declare function toAccountGroupId(walletId: AccountWalletId, id: string): AccountGroupId;
+export declare function toAccountGroupId<WalletType extends AccountWalletType>(walletId: AccountWalletIdOf<WalletType>, id: string): AccountGroupIdOf<WalletType>;
 /**
  * Convert a wallet ID to the default group ID.
  *
  * @param walletId - A wallet ID.
  * @returns The default group ID.
  */
-export declare function toDefaultAccountGroupId(walletId: AccountWalletId): AccountGroupId;
+export declare function toDefaultAccountGroupId<WalletType extends AccountWalletType>(walletId: AccountWalletIdOf<WalletType>): AccountGroupIdOf<WalletType>;
 //# sourceMappingURL=group.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"group.d.cts","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,qBAAiB;AAE/D;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B,EAAE,MAAkB,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,cAAc,IAAI;IACzD;;OAEG;IACH,IAAI,EAAE,IAAI,cAAc,CAAC;IAEzB;;OAEG;IACH,IAAI,MAAM,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IAErC;;;;OAIG;IACH,WAAW,IAAI,OAAO,EAAE,CAAC;IAEzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC;CACpD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,eAAe,EACzB,EAAE,EAAE,MAAM,GACT,cAAc,CAEhB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,eAAe,GACxB,cAAc,CAEhB"}
+{"version":3,"file":"group.d.cts","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EAClB,qBAAiB;AAElB;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B,EAAE,MAAkB,CAAC;AAEjE;;;;GAIG;AACH,oBAAY,gBAAgB;IAC1B,kDAAkD;IAClD,iBAAiB,uBAAuB;IAExC,8CAA8C;IAC9C,aAAa,mBAAmB;CACjC;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,cAAc,IAAI;IACzD;;OAEG;IACH,IAAI,EAAE,IAAI,cAAc,CAAC;IAEzB;;OAEG;IACH,IAAI,IAAI,IAAI,gBAAgB,CAAC;IAE7B;;OAEG;IACH,IAAI,MAAM,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IAErC;;;;OAIG;IACH,WAAW,IAAI,OAAO,EAAE,CAAC;IAEzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC;CACpD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,iBAAiB,IAC/D,GAAG,iBAAiB,CAAC,UAAU,CAAC,IAAI,MAAM,EAAE,CAAC;AAE/C;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,iBAAiB,EACnE,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,EACvC,EAAE,EAAE,MAAM,GACT,gBAAgB,CAAC,UAAU,CAAC,CAE9B;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,SAAS,iBAAiB,EAC1E,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,GACtC,gBAAgB,CAAC,UAAU,CAAC,CAK9B"}

package/dist/api/group.d.mts

@@ -1,5 +1,5 @@
 import type { KeyringAccount } from "@metamask/keyring-api";
-import type { AccountWallet, AccountWalletId } from "./wallet.mjs";
+import type { AccountWallet, AccountWalletId, AccountWalletIdOf, AccountWalletType } from "./wallet.mjs";
 /**
  * Default account group unique ID.
  *
@@ -7,6 +7,17 @@ import type { AccountWallet, AccountWalletId } from "./wallet.mjs";
  * an account wallet.
  */
 export declare const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string;
+/**
+ * Account group object.
+ *
+ * Each group types groups accounts using different criterias.
+ */
+export declare enum AccountGroupType {
+    /** Group that represents a multichain account. */
+    MultichainAccount = "multichain-account",
+    /** Group that represents a single account. */
+    SingleAccount = "single-account"
+}
 /**
  * Account group ID.
  */
@@ -19,6 +30,10 @@ export type AccountGroup<Account extends KeyringAccount> = {
      * Account group ID.
      */
     get id(): AccountGroupId;
+    /**
+     * Account group type.
+     */
+    get type(): AccountGroupType;
     /**
      * Account wallet (parent).
      */
@@ -37,6 +52,11 @@ export type AccountGroup<Account extends KeyringAccount> = {
      */
     getAccount(id: Account['id']): Account | undefined;
 };
+/**
+ * Type utility to compute a constrained {@link AccountGroupId} type given a
+ * specifc {@link AccountWalletType}.
+ */
+export type AccountGroupIdOf<WalletType extends AccountWalletType> = `${AccountWalletIdOf<WalletType>}/${string}`;
 /**
  * Convert a wallet ID and a unique ID, to a group ID.
  *
@@ -44,12 +64,12 @@ export type AccountGroup<Account extends KeyringAccount> = {
  * @param id - A unique ID.
  * @returns A group ID.
  */
-export declare function toAccountGroupId(walletId: AccountWalletId, id: string): AccountGroupId;
+export declare function toAccountGroupId<WalletType extends AccountWalletType>(walletId: AccountWalletIdOf<WalletType>, id: string): AccountGroupIdOf<WalletType>;
 /**
  * Convert a wallet ID to the default group ID.
  *
  * @param walletId - A wallet ID.
  * @returns The default group ID.
  */
-export declare function toDefaultAccountGroupId(walletId: AccountWalletId): AccountGroupId;
+export declare function toDefaultAccountGroupId<WalletType extends AccountWalletType>(walletId: AccountWalletIdOf<WalletType>): AccountGroupIdOf<WalletType>;
 //# sourceMappingURL=group.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"group.d.mts","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,qBAAiB;AAE/D;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B,EAAE,MAAkB,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,cAAc,IAAI;IACzD;;OAEG;IACH,IAAI,EAAE,IAAI,cAAc,CAAC;IAEzB;;OAEG;IACH,IAAI,MAAM,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IAErC;;;;OAIG;IACH,WAAW,IAAI,OAAO,EAAE,CAAC;IAEzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC;CACpD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,eAAe,EACzB,EAAE,EAAE,MAAM,GACT,cAAc,CAEhB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,eAAe,GACxB,cAAc,CAEhB"}
+{"version":3,"file":"group.d.mts","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EAClB,qBAAiB;AAElB;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B,EAAE,MAAkB,CAAC;AAEjE;;;;GAIG;AACH,oBAAY,gBAAgB;IAC1B,kDAAkD;IAClD,iBAAiB,uBAAuB;IAExC,8CAA8C;IAC9C,aAAa,mBAAmB;CACjC;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,cAAc,IAAI;IACzD;;OAEG;IACH,IAAI,EAAE,IAAI,cAAc,CAAC;IAEzB;;OAEG;IACH,IAAI,IAAI,IAAI,gBAAgB,CAAC;IAE7B;;OAEG;IACH,IAAI,MAAM,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IAErC;;;;OAIG;IACH,WAAW,IAAI,OAAO,EAAE,CAAC;IAEzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC;CACpD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,iBAAiB,IAC/D,GAAG,iBAAiB,CAAC,UAAU,CAAC,IAAI,MAAM,EAAE,CAAC;AAE/C;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,iBAAiB,EACnE,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,EACvC,EAAE,EAAE,MAAM,GACT,gBAAgB,CAAC,UAAU,CAAC,CAE9B;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,SAAS,iBAAiB,EAC1E,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,GACtC,gBAAgB,CAAC,UAAU,CAAC,CAK9B"}

package/dist/api/group.mjs

@@ -5,6 +5,18 @@
  * an account wallet.
  */
 export const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = 'default';
+/**
+ * Account group object.
+ *
+ * Each group types groups accounts using different criterias.
+ */
+export var AccountGroupType;
+(function (AccountGroupType) {
+    /** Group that represents a multichain account. */
+    AccountGroupType["MultichainAccount"] = "multichain-account";
+    /** Group that represents a single account. */
+    AccountGroupType["SingleAccount"] = "single-account";
+})(AccountGroupType || (AccountGroupType = {}));
 /**
  * Convert a wallet ID and a unique ID, to a group ID.
  *

package/dist/api/group.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"group.mjs","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAW,SAAS,CAAC;AAqCjE;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAyB,EACzB,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAAyB;IAEzB,OAAO,gBAAgB,CAAC,QAAQ,EAAE,+BAA+B,CAAC,CAAC;AACrE,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type { AccountWallet, AccountWalletId } from './wallet';\n\n/**\n * Default account group unique ID.\n *\n * This constant can be used to reference the \"default\" group from\n * an account wallet.\n */\nexport const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string = 'default';\n\n/**\n * Account group ID.\n */\nexport type AccountGroupId = `${AccountWalletId}/${string}`;\n\n/**\n * Account group that can hold multiple accounts.\n */\nexport type AccountGroup<Account extends KeyringAccount> = {\n  /**\n   * Account group ID.\n   */\n  get id(): AccountGroupId;\n\n  /**\n   * Account wallet (parent).\n   */\n  get wallet(): AccountWallet<Account>;\n\n  /**\n   * Gets the accounts for this account group.\n   *\n   * @returns The accounts.\n   */\n  getAccounts(): Account[];\n\n  /**\n   * Gets the account for a given account ID.\n   *\n   * @param id - Account ID.\n   * @returns The account or undefined if not found.\n   */\n  getAccount(id: Account['id']): Account | undefined;\n};\n\n/**\n * Convert a wallet ID and a unique ID, to a group ID.\n *\n * @param walletId - A wallet ID.\n * @param id - A unique ID.\n * @returns A group ID.\n */\nexport function toAccountGroupId(\n  walletId: AccountWalletId,\n  id: string,\n): AccountGroupId {\n  return `${walletId}/${id}`;\n}\n\n/**\n * Convert a wallet ID to the default group ID.\n *\n * @param walletId - A wallet ID.\n * @returns The default group ID.\n */\nexport function toDefaultAccountGroupId(\n  walletId: AccountWalletId,\n): AccountGroupId {\n  return toAccountGroupId(walletId, DEFAULT_ACCOUNT_GROUP_UNIQUE_ID);\n}\n"]}
+{"version":3,"file":"group.mjs","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":"AAUA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAW,SAAS,CAAC;AAEjE;;;;GAIG;AACH,MAAM,CAAN,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,kDAAkD;IAClD,4DAAwC,CAAA;IAExC,8CAA8C;IAC9C,oDAAgC,CAAA;AAClC,CAAC,EANW,gBAAgB,KAAhB,gBAAgB,QAM3B;AAiDD;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAuC,EACvC,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAAuC;IAEvC,OAAO,gBAAgB,CACrB,QAAQ,EACR,+BAA+B,CAChC,CAAC;AACJ,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type {\n  AccountWallet,\n  AccountWalletId,\n  AccountWalletIdOf,\n  AccountWalletType,\n} from './wallet';\n\n/**\n * Default account group unique ID.\n *\n * This constant can be used to reference the \"default\" group from\n * an account wallet.\n */\nexport const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string = 'default';\n\n/**\n * Account group object.\n *\n * Each group types groups accounts using different criterias.\n */\nexport enum AccountGroupType {\n  /** Group that represents a multichain account. */\n  MultichainAccount = 'multichain-account',\n\n  /** Group that represents a single account. */\n  SingleAccount = 'single-account',\n}\n\n/**\n * Account group ID.\n */\nexport type AccountGroupId = `${AccountWalletId}/${string}`;\n\n/**\n * Account group that can hold multiple accounts.\n */\nexport type AccountGroup<Account extends KeyringAccount> = {\n  /**\n   * Account group ID.\n   */\n  get id(): AccountGroupId;\n\n  /**\n   * Account group type.\n   */\n  get type(): AccountGroupType;\n\n  /**\n   * Account wallet (parent).\n   */\n  get wallet(): AccountWallet<Account>;\n\n  /**\n   * Gets the accounts for this account group.\n   *\n   * @returns The accounts.\n   */\n  getAccounts(): Account[];\n\n  /**\n   * Gets the account for a given account ID.\n   *\n   * @param id - Account ID.\n   * @returns The account or undefined if not found.\n   */\n  getAccount(id: Account['id']): Account | undefined;\n};\n\n/**\n * Type utility to compute a constrained {@link AccountGroupId} type given a\n * specifc {@link AccountWalletType}.\n */\nexport type AccountGroupIdOf<WalletType extends AccountWalletType> =\n  `${AccountWalletIdOf<WalletType>}/${string}`;\n\n/**\n * Convert a wallet ID and a unique ID, to a group ID.\n *\n * @param walletId - A wallet ID.\n * @param id - A unique ID.\n * @returns A group ID.\n */\nexport function toAccountGroupId<WalletType extends AccountWalletType>(\n  walletId: AccountWalletIdOf<WalletType>,\n  id: string,\n): AccountGroupIdOf<WalletType> {\n  return `${walletId}/${id}`;\n}\n\n/**\n * Convert a wallet ID to the default group ID.\n *\n * @param walletId - A wallet ID.\n * @returns The default group ID.\n */\nexport function toDefaultAccountGroupId<WalletType extends AccountWalletType>(\n  walletId: AccountWalletIdOf<WalletType>,\n): AccountGroupIdOf<WalletType> {\n  return toAccountGroupId<WalletType>(\n    walletId,\n    DEFAULT_ACCOUNT_GROUP_UNIQUE_ID,\n  );\n}\n"]}

package/dist/api/multichain/group.cjs

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toMultichainAccountGroupId = toMultichainAccountGroupId;
+exports.isMultichainAccountGroupId = isMultichainAccountGroupId;
+exports.getGroupIndexFromMultichainAccountId = getGroupIndexFromMultichainAccountId;
+const wallet_1 = require("../wallet.cjs");
+const MULTICHAIN_ACCOUNT_GROUP_ID_REGEX = new RegExp(`^${wallet_1.AccountWalletType.Entropy}:.*/(?<groupIndex>\\d+)$`, 'u');
+/**
+ * Gets the multichain account group ID from its multichain account wallet ID and its index.
+ *
+ * @param walletId - Multichain account wallet ID.
+ * @param groupIndex - Index of that multichain account.
+ * @returns The multichain account ID.
+ */
+function toMultichainAccountGroupId(walletId, groupIndex) {
+    return `${walletId}/${groupIndex}`;
+}
+/**
+ * Checks if the given value is {@link MultichainAccountGroupId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountGroupId}.
+ */
+function isMultichainAccountGroupId(value) {
+    return MULTICHAIN_ACCOUNT_GROUP_ID_REGEX.test(value);
+}
+/**
+ * Gets the multichain account index from an account group ID.
+ *
+ * @param id - Multichain account ID.
+ * @returns The multichain account index if extractable, undefined otherwise.
+ */
+function getGroupIndexFromMultichainAccountId(id) {
+    const matched = id.match(MULTICHAIN_ACCOUNT_GROUP_ID_REGEX);
+    if (matched?.groups?.groupIndex === undefined) {
+        // Unable to extract group index, even though, type wise, this should not
+        // be possible!
+        throw new Error('Unable to extract group index');
+    }
+    return Number(matched.groups.groupIndex);
+}
+//# sourceMappingURL=group.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"group.cjs","sourceRoot":"","sources":["../../../src/api/multichain/group.ts"],"names":[],"mappings":";;AAwEA,gEAKC;AAQD,gEAIC;AAQD,oFAWC;AAnGD,0CAA8C;AAE9C,MAAM,iCAAiC,GAAG,IAAI,MAAM,CAClD,IAAI,0BAAiB,CAAC,OAAO,0BAA0B,EACvD,GAAG,CACJ,CAAC;AAmDF;;;;;;GAMG;AACH,SAAgB,0BAA0B,CACxC,QAAmC,EACnC,UAAkB;IAElB,OAAO,GAAG,QAAQ,IAAI,UAAU,EAAE,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,0BAA0B,CACxC,KAAa;IAEb,OAAO,iCAAiC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oCAAoC,CAClD,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 type { AccountSelector } from '../selector';\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 index(): number;\n\n  /**\n   * Query an account matching the selector.\n   *\n   * @param selector - Query selector.\n   * @returns The account matching the selector or undefined if not matching.\n   * @throws If multiple accounts match the selector.\n   */\n  get(selector: AccountSelector<Account>): Account | undefined;\n\n  /**\n   * Query accounts matching the selector.\n   *\n   * @param selector - Query selector.\n   * @returns The accounts matching the selector.\n   */\n  select(selector: AccountSelector<Account>): Account[];\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 getGroupIndexFromMultichainAccountId(\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"]}

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

@@ -0,0 +1,68 @@
+import { type KeyringAccount } from "@metamask/keyring-api";
+import type { MultichainAccountWallet, MultichainAccountWalletId } from "./wallet.cjs";
+import type { Bip44Account } from "../bip44.cjs";
+import type { AccountGroup, AccountGroupType } from "../group.cjs";
+import type { AccountSelector } from "../selector.cjs";
+/**
+ * Multichain account ID.
+ */
+export type MultichainAccountGroupId = `${MultichainAccountWalletId}/${number}`;
+/**
+ * A multichain account that holds multiple accounts.
+ */
+export type MultichainAccountGroup<Account extends Bip44Account<KeyringAccount>> = AccountGroup<Account> & {
+    /**
+     * Multichain account group ID.
+     */
+    get id(): MultichainAccountGroupId;
+    /**
+     * Multichain account type.
+     */
+    get type(): AccountGroupType.MultichainAccount;
+    /**
+     * Multichain account's wallet reference (parent).
+     */
+    get wallet(): MultichainAccountWallet<Account>;
+    /**
+     * Multichain account group index.
+     */
+    get index(): number;
+    /**
+     * Query an account matching the selector.
+     *
+     * @param selector - Query selector.
+     * @returns The account matching the selector or undefined if not matching.
+     * @throws If multiple accounts match the selector.
+     */
+    get(selector: AccountSelector<Account>): Account | undefined;
+    /**
+     * Query accounts matching the selector.
+     *
+     * @param selector - Query selector.
+     * @returns The accounts matching the selector.
+     */
+    select(selector: AccountSelector<Account>): Account[];
+};
+/**
+ * Gets the multichain account group ID from its multichain account wallet ID and its index.
+ *
+ * @param walletId - Multichain account wallet ID.
+ * @param groupIndex - Index of that multichain account.
+ * @returns The multichain account ID.
+ */
+export declare function toMultichainAccountGroupId(walletId: MultichainAccountWalletId, groupIndex: number): MultichainAccountGroupId;
+/**
+ * Checks if the given value is {@link MultichainAccountGroupId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountGroupId}.
+ */
+export declare function isMultichainAccountGroupId(value: string): value is MultichainAccountGroupId;
+/**
+ * Gets the multichain account index from an account group ID.
+ *
+ * @param id - Multichain account ID.
+ * @returns The multichain account index if extractable, undefined otherwise.
+ */
+export declare function getGroupIndexFromMultichainAccountId(id: MultichainAccountGroupId): number;
+//# sourceMappingURL=group.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"group.d.cts","sourceRoot":"","sources":["../../../src/api/multichain/group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,8BAA8B;AAE5D,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,qBAAiB;AAClB,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,qBAAiB;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAoB;AAQnD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,GAAG,yBAAyB,IAAI,MAAM,EAAE,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAChC,OAAO,SAAS,YAAY,CAAC,cAAc,CAAC,IAC1C,YAAY,CAAC,OAAO,CAAC,GAAG;IAC1B;;OAEG;IACH,IAAI,EAAE,IAAI,wBAAwB,CAAC;IAEnC;;OAEG;IACH,IAAI,IAAI,IAAI,gBAAgB,CAAC,iBAAiB,CAAC;IAE/C;;OAEG;IACH,IAAI,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE/C;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC;IAE7D;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,OAAO,EAAE,CAAC;CACvD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,yBAAyB,EACnC,UAAU,EAAE,MAAM,GACjB,wBAAwB,CAE1B;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,MAAM,GACZ,KAAK,IAAI,wBAAwB,CAEnC;AAED;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAClD,EAAE,EAAE,wBAAwB,GAC3B,MAAM,CASR"}

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

@@ -0,0 +1,68 @@
+import { type KeyringAccount } from "@metamask/keyring-api";
+import type { MultichainAccountWallet, MultichainAccountWalletId } from "./wallet.mjs";
+import type { Bip44Account } from "../bip44.mjs";
+import type { AccountGroup, AccountGroupType } from "../group.mjs";
+import type { AccountSelector } from "../selector.mjs";
+/**
+ * Multichain account ID.
+ */
+export type MultichainAccountGroupId = `${MultichainAccountWalletId}/${number}`;
+/**
+ * A multichain account that holds multiple accounts.
+ */
+export type MultichainAccountGroup<Account extends Bip44Account<KeyringAccount>> = AccountGroup<Account> & {
+    /**
+     * Multichain account group ID.
+     */
+    get id(): MultichainAccountGroupId;
+    /**
+     * Multichain account type.
+     */
+    get type(): AccountGroupType.MultichainAccount;
+    /**
+     * Multichain account's wallet reference (parent).
+     */
+    get wallet(): MultichainAccountWallet<Account>;
+    /**
+     * Multichain account group index.
+     */
+    get index(): number;
+    /**
+     * Query an account matching the selector.
+     *
+     * @param selector - Query selector.
+     * @returns The account matching the selector or undefined if not matching.
+     * @throws If multiple accounts match the selector.
+     */
+    get(selector: AccountSelector<Account>): Account | undefined;
+    /**
+     * Query accounts matching the selector.
+     *
+     * @param selector - Query selector.
+     * @returns The accounts matching the selector.
+     */
+    select(selector: AccountSelector<Account>): Account[];
+};
+/**
+ * Gets the multichain account group ID from its multichain account wallet ID and its index.
+ *
+ * @param walletId - Multichain account wallet ID.
+ * @param groupIndex - Index of that multichain account.
+ * @returns The multichain account ID.
+ */
+export declare function toMultichainAccountGroupId(walletId: MultichainAccountWalletId, groupIndex: number): MultichainAccountGroupId;
+/**
+ * Checks if the given value is {@link MultichainAccountGroupId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountGroupId}.
+ */
+export declare function isMultichainAccountGroupId(value: string): value is MultichainAccountGroupId;
+/**
+ * Gets the multichain account index from an account group ID.
+ *
+ * @param id - Multichain account ID.
+ * @returns The multichain account index if extractable, undefined otherwise.
+ */
+export declare function getGroupIndexFromMultichainAccountId(id: MultichainAccountGroupId): number;
+//# sourceMappingURL=group.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"group.d.mts","sourceRoot":"","sources":["../../../src/api/multichain/group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,8BAA8B;AAE5D,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,qBAAiB;AAClB,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,qBAAiB;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAoB;AAQnD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,GAAG,yBAAyB,IAAI,MAAM,EAAE,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAChC,OAAO,SAAS,YAAY,CAAC,cAAc,CAAC,IAC1C,YAAY,CAAC,OAAO,CAAC,GAAG;IAC1B;;OAEG;IACH,IAAI,EAAE,IAAI,wBAAwB,CAAC;IAEnC;;OAEG;IACH,IAAI,IAAI,IAAI,gBAAgB,CAAC,iBAAiB,CAAC;IAE/C;;OAEG;IACH,IAAI,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAE/C;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC;IAE7D;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,OAAO,EAAE,CAAC;CACvD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,yBAAyB,EACnC,UAAU,EAAE,MAAM,GACjB,wBAAwB,CAE1B;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,MAAM,GACZ,KAAK,IAAI,wBAAwB,CAEnC;AAED;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAClD,EAAE,EAAE,wBAAwB,GAC3B,MAAM,CASR"}

package/dist/api/multichain/group.mjs

@@ -0,0 +1,37 @@
+import { AccountWalletType } from "../wallet.mjs";
+const MULTICHAIN_ACCOUNT_GROUP_ID_REGEX = new RegExp(`^${AccountWalletType.Entropy}:.*/(?<groupIndex>\\d+)$`, 'u');
+/**
+ * Gets the multichain account group ID from its multichain account wallet ID and its index.
+ *
+ * @param walletId - Multichain account wallet ID.
+ * @param groupIndex - Index of that multichain account.
+ * @returns The multichain account ID.
+ */
+export function toMultichainAccountGroupId(walletId, groupIndex) {
+    return `${walletId}/${groupIndex}`;
+}
+/**
+ * Checks if the given value is {@link MultichainAccountGroupId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountGroupId}.
+ */
+export function isMultichainAccountGroupId(value) {
+    return MULTICHAIN_ACCOUNT_GROUP_ID_REGEX.test(value);
+}
+/**
+ * Gets the multichain account index from an account group ID.
+ *
+ * @param id - Multichain account ID.
+ * @returns The multichain account index if extractable, undefined otherwise.
+ */
+export function getGroupIndexFromMultichainAccountId(id) {
+    const matched = id.match(MULTICHAIN_ACCOUNT_GROUP_ID_REGEX);
+    if (matched?.groups?.groupIndex === undefined) {
+        // Unable to extract group index, even though, type wise, this should not
+        // be possible!
+        throw new Error('Unable to extract group index');
+    }
+    return Number(matched.groups.groupIndex);
+}
+//# sourceMappingURL=group.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"group.mjs","sourceRoot":"","sources":["../../../src/api/multichain/group.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,iBAAiB,EAAE,sBAAkB;AAE9C,MAAM,iCAAiC,GAAG,IAAI,MAAM,CAClD,IAAI,iBAAiB,CAAC,OAAO,0BAA0B,EACvD,GAAG,CACJ,CAAC;AAmDF;;;;;;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,oCAAoC,CAClD,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 type { AccountSelector } from '../selector';\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 index(): number;\n\n  /**\n   * Query an account matching the selector.\n   *\n   * @param selector - Query selector.\n   * @returns The account matching the selector or undefined if not matching.\n   * @throws If multiple accounts match the selector.\n   */\n  get(selector: AccountSelector<Account>): Account | undefined;\n\n  /**\n   * Query accounts matching the selector.\n   *\n   * @param selector - Query selector.\n   * @returns The accounts matching the selector.\n   */\n  select(selector: AccountSelector<Account>): Account[];\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 getGroupIndexFromMultichainAccountId(\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"]}

package/dist/api/multichain/index.cjs

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./account.cjs"), exports);
+__exportStar(require("./group.cjs"), exports);
 __exportStar(require("./wallet.cjs"), exports);
 //# sourceMappingURL=index.cjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA0B;AAC1B,+CAAyB","sourcesContent":["export * from './account';\nexport * from './wallet';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAAwB;AACxB,+CAAyB","sourcesContent":["export * from './group';\nexport * from './wallet';\n"]}

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

@@ -1,3 +1,3 @@
-export * from "./account.cjs";
+export * from "./group.cjs";
 export * from "./wallet.cjs";
 //# sourceMappingURL=index.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,6BAAyB"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,6BAAyB"}

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

@@ -1,3 +1,3 @@
-export * from "./account.mjs";
+export * from "./group.mjs";
 export * from "./wallet.mjs";
 //# sourceMappingURL=index.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,6BAAyB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,6BAAyB"}

package/dist/api/multichain/index.mjs

@@ -1,3 +1,3 @@
-export * from "./account.mjs";
+export * from "./group.mjs";
 export * from "./wallet.mjs";
 //# sourceMappingURL=index.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,6BAAyB","sourcesContent":["export * from './account';\nexport * from './wallet';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,6BAAyB","sourcesContent":["export * from './group';\nexport * from './wallet';\n"]}