@metamask-previews/account-api 0.0.0-586437b → 0.1.0-32becbf

package/CHANGELOG.md

@@ -7,4 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/MetaMask/accounts/
+## [0.1.0]
+
+### Added
+
+- Add `AccountGroup` and `AccountWallet` ([#307](https://github.com/MetaMask/accounts/pull/307))
+
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/account-api@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/accounts/releases/tag/@metamask/account-api@0.1.0

package/README.md

@@ -1,6 +1,6 @@
-# MetaMask Keyring utils
+# MetaMask Account API
 
-Various JavaScript/TypeScript utilities required by Keyrings.
+API for the MetaMask account model.
 
 ## Installation
 

package/dist/api/group.cjs

@@ -1,10 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_ACCOUNT_GROUP_NAME = exports.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = void 0;
+exports.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = void 0;
 exports.toAccountGroupId = toAccountGroupId;
 exports.toDefaultAccountGroupId = toDefaultAccountGroupId;
+/**
+ * Default account group unique ID.
+ *
+ * This constant can be used to reference the "default" group from
+ * an account wallet.
+ */
 exports.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = 'default';
-exports.DEFAULT_ACCOUNT_GROUP_NAME = 'Default';
 /**
  * Convert a wallet ID and a unique ID, to a group ID.
  *
@@ -13,7 +18,7 @@ exports.DEFAULT_ACCOUNT_GROUP_NAME = 'Default';
  * @returns A group ID.
  */
 function toAccountGroupId(walletId, id) {
-    return `${walletId}:${id}`;
+    return `${walletId}/${id}`;
 }
 /**
  * Convert a wallet ID to the default group ID.

package/dist/api/group.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"group.cjs","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":";;;AAuCA,4CAKC;AAQD,0DAIC;AAnDY,QAAA,+BAA+B,GAAW,SAAS,CAAC;AACpD,QAAA,0BAA0B,GAAW,SAAS,CAAC;AA0B5D;;;;;;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';\nimport type { AccountId } from '@metamask/keyring-utils';\n\nimport type { AccountWalletId } from './wallet';\n\nexport const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string = 'default';\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\nexport type AccountGroupId = `${AccountWalletId}:${string}`;\n\nexport type AccountGroup<Account extends KeyringAccount> = {\n  get id(): AccountGroupId;\n\n  get index(): number;\n\n  /**\n   * Gets the \"blockchain\" accounts for this multichain account.\n   *\n   * @param id - Account ID.\n   * @returns The \"blockchain\" accounts.\n   */\n  getAccounts(): Account[];\n\n  /**\n   * Gets the \"blockchain\" account for a given account ID.\n   *\n   * @param id - Account ID.\n   * @returns The \"blockchain\" account or undefined if not found.\n   */\n  getAccount(id: AccountId): 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":";;;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"]}

package/dist/api/group.d.cts

@@ -1,26 +1,41 @@
 import type { KeyringAccount } from "@metamask/keyring-api";
-import type { AccountId } from "@metamask/keyring-utils";
-import type { AccountWalletId } from "./wallet.cjs";
+import type { AccountWallet, AccountWalletId } from "./wallet.cjs";
+/**
+ * Default account group unique ID.
+ *
+ * This constant can be used to reference the "default" group from
+ * an account wallet.
+ */
 export declare const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string;
-export declare const DEFAULT_ACCOUNT_GROUP_NAME: string;
-export type AccountGroupId = `${AccountWalletId}:${string}`;
+/**
+ * Account group ID.
+ */
+export type AccountGroupId = `${AccountWalletId}/${string}`;
+/**
+ * Account group that can hold multiple accounts.
+ */
 export type AccountGroup<Account extends KeyringAccount> = {
+    /**
+     * Account group ID.
+     */
     get id(): AccountGroupId;
-    get index(): number;
     /**
-     * Gets the "blockchain" accounts for this multichain account.
+     * Account wallet (parent).
+     */
+    get wallet(): AccountWallet<Account>;
+    /**
+     * Gets the accounts for this account group.
      *
-     * @param id - Account ID.
-     * @returns The "blockchain" accounts.
+     * @returns The accounts.
      */
     getAccounts(): Account[];
     /**
-     * Gets the "blockchain" account for a given account ID.
+     * Gets the account for a given account ID.
      *
      * @param id - Account ID.
-     * @returns The "blockchain" account or undefined if not found.
+     * @returns The account or undefined if not found.
      */
-    getAccount(id: AccountId): Account | undefined;
+    getAccount(id: Account['id']): Account | undefined;
 };
 /**
  * Convert a wallet ID and a unique ID, to a group ID.

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;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AAEzD,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAiB;AAEhD,eAAO,MAAM,+BAA+B,EAAE,MAAkB,CAAC;AACjE,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D,MAAM,MAAM,cAAc,GAAG,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;AAE5D,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,cAAc,IAAI;IACzD,IAAI,EAAE,IAAI,cAAc,CAAC;IAEzB,IAAI,KAAK,IAAI,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,WAAW,IAAI,OAAO,EAAE,CAAC;IAEzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;CAChD,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,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"}

package/dist/api/group.d.mts

@@ -1,26 +1,41 @@
 import type { KeyringAccount } from "@metamask/keyring-api";
-import type { AccountId } from "@metamask/keyring-utils";
-import type { AccountWalletId } from "./wallet.mjs";
+import type { AccountWallet, AccountWalletId } from "./wallet.mjs";
+/**
+ * Default account group unique ID.
+ *
+ * This constant can be used to reference the "default" group from
+ * an account wallet.
+ */
 export declare const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string;
-export declare const DEFAULT_ACCOUNT_GROUP_NAME: string;
-export type AccountGroupId = `${AccountWalletId}:${string}`;
+/**
+ * Account group ID.
+ */
+export type AccountGroupId = `${AccountWalletId}/${string}`;
+/**
+ * Account group that can hold multiple accounts.
+ */
 export type AccountGroup<Account extends KeyringAccount> = {
+    /**
+     * Account group ID.
+     */
     get id(): AccountGroupId;
-    get index(): number;
     /**
-     * Gets the "blockchain" accounts for this multichain account.
+     * Account wallet (parent).
+     */
+    get wallet(): AccountWallet<Account>;
+    /**
+     * Gets the accounts for this account group.
      *
-     * @param id - Account ID.
-     * @returns The "blockchain" accounts.
+     * @returns The accounts.
      */
     getAccounts(): Account[];
     /**
-     * Gets the "blockchain" account for a given account ID.
+     * Gets the account for a given account ID.
      *
      * @param id - Account ID.
-     * @returns The "blockchain" account or undefined if not found.
+     * @returns The account or undefined if not found.
      */
-    getAccount(id: AccountId): Account | undefined;
+    getAccount(id: Account['id']): Account | undefined;
 };
 /**
  * Convert a wallet ID and a unique ID, to a group ID.

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;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AAEzD,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAiB;AAEhD,eAAO,MAAM,+BAA+B,EAAE,MAAkB,CAAC;AACjE,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D,MAAM,MAAM,cAAc,GAAG,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;AAE5D,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,cAAc,IAAI;IACzD,IAAI,EAAE,IAAI,cAAc,CAAC;IAEzB,IAAI,KAAK,IAAI,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,WAAW,IAAI,OAAO,EAAE,CAAC;IAEzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;CAChD,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,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"}

package/dist/api/group.mjs

@@ -1,5 +1,10 @@
+/**
+ * Default account group unique ID.
+ *
+ * This constant can be used to reference the "default" group from
+ * an account wallet.
+ */
 export const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = 'default';
-export const DEFAULT_ACCOUNT_GROUP_NAME = 'Default';
 /**
  * Convert a wallet ID and a unique ID, to a group ID.
  *
@@ -8,7 +13,7 @@ export const DEFAULT_ACCOUNT_GROUP_NAME = 'Default';
  * @returns A group ID.
  */
 export function toAccountGroupId(walletId, id) {
-    return `${walletId}:${id}`;
+    return `${walletId}/${id}`;
 }
 /**
  * Convert a wallet ID to the default group ID.

package/dist/api/group.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"group.mjs","sourceRoot":"","sources":["../../src/api/group.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,+BAA+B,GAAW,SAAS,CAAC;AACjE,MAAM,CAAC,MAAM,0BAA0B,GAAW,SAAS,CAAC;AA0B5D;;;;;;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';\nimport type { AccountId } from '@metamask/keyring-utils';\n\nimport type { AccountWalletId } from './wallet';\n\nexport const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string = 'default';\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\nexport type AccountGroupId = `${AccountWalletId}:${string}`;\n\nexport type AccountGroup<Account extends KeyringAccount> = {\n  get id(): AccountGroupId;\n\n  get index(): number;\n\n  /**\n   * Gets the \"blockchain\" accounts for this multichain account.\n   *\n   * @param id - Account ID.\n   * @returns The \"blockchain\" accounts.\n   */\n  getAccounts(): Account[];\n\n  /**\n   * Gets the \"blockchain\" account for a given account ID.\n   *\n   * @param id - Account ID.\n   * @returns The \"blockchain\" account or undefined if not found.\n   */\n  getAccount(id: AccountId): 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":"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"]}

package/dist/api/index.cjs.map

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

package/dist/api/index.d.cts

@@ -1,4 +1,5 @@
 export * from "./group.cjs";
 export * from "./wallet.cjs";
+export type * from "./provider.cjs";
 export * from "./multichain/index.cjs";
 //# sourceMappingURL=index.d.cts.map

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

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

package/dist/api/index.d.mts

@@ -1,4 +1,5 @@
 export * from "./group.mjs";
 export * from "./wallet.mjs";
+export type * from "./provider.mjs";
 export * from "./multichain/index.mjs";
 //# sourceMappingURL=index.d.mts.map

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

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

package/dist/api/index.mjs.map

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

package/dist/api/multichain/account.cjs

@@ -0,0 +1,186 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _MultichainAccount_id, _MultichainAccount_wallet, _MultichainAccount_index, _MultichainAccount_providers;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultichainAccount = void 0;
+exports.toMultichainAccountId = toMultichainAccountId;
+exports.isMultichainAccountId = isMultichainAccountId;
+exports.getGroupIndexFromMultichainAccountId = getGroupIndexFromMultichainAccountId;
+const keyring_api_1 = require("@metamask/keyring-api");
+const keyring_utils_1 = require("@metamask/keyring-utils");
+const wallet_1 = require("../wallet.cjs");
+const MULTICHAIN_ACCOUNT_ID_REGEX = new RegExp(`^${wallet_1.AccountWalletCategory.Entropy}:.*/(?<groupIndex>\\d+)$`, 'u');
+/**
+ * A multichain account that holds multiple accounts.
+ */
+class MultichainAccount {
+    constructor({ groupIndex, wallet, providers, }) {
+        _MultichainAccount_id.set(this, void 0);
+        _MultichainAccount_wallet.set(this, void 0);
+        _MultichainAccount_index.set(this, void 0);
+        _MultichainAccount_providers.set(this, void 0);
+        __classPrivateFieldSet(this, _MultichainAccount_id, toMultichainAccountId(wallet.id, groupIndex), "f");
+        __classPrivateFieldSet(this, _MultichainAccount_index, groupIndex, "f");
+        __classPrivateFieldSet(this, _MultichainAccount_wallet, wallet, "f");
+        __classPrivateFieldSet(this, _MultichainAccount_providers, providers, "f");
+    }
+    /**
+     * Gets the multichain account ID.
+     *
+     * @returns The multichain account ID.
+     */
+    get id() {
+        return __classPrivateFieldGet(this, _MultichainAccount_id, "f");
+    }
+    /**
+     * Gets the multichain account's wallet reference (parent).
+     *
+     * @returns The multichain account's wallet.
+     */
+    get wallet() {
+        return __classPrivateFieldGet(this, _MultichainAccount_wallet, "f");
+    }
+    /**
+     * Gets the multichain account group index.
+     *
+     * @returns The multichain account group index.
+     */
+    get index() {
+        return __classPrivateFieldGet(this, _MultichainAccount_index, "f");
+    }
+    /**
+     * Checks if there's any underlying accounts for this multichain accounts.
+     *
+     * @returns True if there's any underlying accounts, false otherwise.
+     */
+    hasAccounts() {
+        return this.getAccounts().length > 0;
+    }
+    /**
+     * Gets the accounts for this multichain account.
+     *
+     * @returns The accounts.
+     */
+    getAccounts() {
+        let allAccounts = [];
+        for (const provider of __classPrivateFieldGet(this, _MultichainAccount_providers, "f")) {
+            allAccounts = allAccounts.concat(provider.getAccounts().filter(
+            // NOTE: For now we always query the providers to get the latest
+            // account list. If this becomes too "heavy" in terms of computation
+            // we might wanna consider adding a state to that object and store
+            // the list of account IDs here.
+            (account) => account.options.entropy &&
+                account.options.entropy.type ===
+                    keyring_api_1.KeyringAccountEntropyTypeOption.Mnemonic &&
+                account.options.entropy.id === this.wallet.entropySource &&
+                account.options.entropy.groupIndex === this.index));
+        }
+        return allAccounts;
+    }
+    /**
+     * Gets the account for a given account ID.
+     *
+     * @param id - Account ID.
+     * @returns The account or undefined if not found.
+     */
+    getAccount(id) {
+        // NOTE: Same remark here. We could keep a state to make this operation
+        // faster.
+        return this.getAccounts().find((account) => account.id === id);
+    }
+    /**
+     * 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) {
+        const accounts = this.select(selector);
+        if (accounts.length > 1) {
+            throw new Error(`Too many account candidates, expected 1, got: ${accounts.length}`);
+        }
+        if (accounts.length === 0) {
+            return undefined;
+        }
+        return accounts[0]; // This is safe, see checks above.
+    }
+    /**
+     * Query accounts matching the selector.
+     *
+     * @param selector - Query selector.
+     * @returns The accounts matching the selector.
+     */
+    select(selector) {
+        return this.getAccounts().filter((account) => {
+            let selected = true;
+            if (selector.id) {
+                selected && (selected = account.id === selector.id);
+            }
+            if (selector.address) {
+                selected && (selected = account.address === selector.address);
+            }
+            if (selector.type) {
+                selected && (selected = account.type === selector.type);
+            }
+            if (selector.methods !== undefined) {
+                selected && (selected = selector.methods.some((method) => account.methods.includes(method)));
+            }
+            if (selector.scopes !== undefined) {
+                selected && (selected = selector.scopes.some((scope) => {
+                    return (
+                    // This will cover specific EVM EOA scopes as well.
+                    (0, keyring_utils_1.isScopeEqualToAny)(scope, account.scopes));
+                }));
+            }
+            return selected;
+        });
+    }
+}
+exports.MultichainAccount = MultichainAccount;
+_MultichainAccount_id = new WeakMap(), _MultichainAccount_wallet = new WeakMap(), _MultichainAccount_index = new WeakMap(), _MultichainAccount_providers = new WeakMap();
+/**
+ * Gets the multichain account 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 toMultichainAccountId(walletId, groupIndex) {
+    return `${walletId}/${groupIndex}`;
+}
+/**
+ * Checks if the given value is {@link MultichainAccountId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountId}.
+ */
+function isMultichainAccountId(value) {
+    return MULTICHAIN_ACCOUNT_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_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=account.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"account.cjs","sourceRoot":"","sources":["../../../src/api/multichain/account.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAmOA,sDAKC;AAQD,sDAIC;AAQD,oFAWC;AAvQD,uDAG+B;AAC/B,2DAA4D;AAQ5D,0CAAkD;AAElD,MAAM,2BAA2B,GAAG,IAAI,MAAM,CAC5C,IAAI,8BAAqB,CAAC,OAAO,0BAA0B,EAC3D,GAAG,CACJ,CAAC;AAqCF;;GAEG;AACH,MAAa,iBAAiB;IAW5B,YAAY,EACV,UAAU,EACV,MAAM,EACN,SAAS,GAKV;QAhBQ,wCAAyB;QAEzB,4CAA0C;QAE1C,2CAAe;QAEf,+CAA4C;QAWnD,uBAAA,IAAI,yBAAO,qBAAqB,CAAC,MAAM,CAAC,EAAE,EAAE,UAAU,CAAC,MAAA,CAAC;QACxD,uBAAA,IAAI,4BAAU,UAAU,MAAA,CAAC;QACzB,uBAAA,IAAI,6BAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,gCAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE;QACJ,OAAO,uBAAA,IAAI,6BAAI,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,uBAAA,IAAI,iCAAQ,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,gCAAO,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,IAAI,WAAW,GAAc,EAAE,CAAC;QAEhC,KAAK,MAAM,QAAQ,IAAI,uBAAA,IAAI,oCAAW,EAAE,CAAC;YACvC,WAAW,GAAG,WAAW,CAAC,MAAM,CAC9B,QAAQ,CAAC,WAAW,EAAE,CAAC,MAAM;YAC3B,gEAAgE;YAChE,oEAAoE;YACpE,kEAAkE;YAClE,gCAAgC;YAChC,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,OAAO,CAAC,OAAO;gBACvB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI;oBAC1B,6CAA+B,CAAC,QAAQ;gBAC1C,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa;gBACxD,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,KAAK,CACpD,CACF,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,EAAiB;QAC1B,uEAAuE;QACvE,UAAU;QACV,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,QAA4C;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,iDAAiD,QAAQ,CAAC,MAAM,EAAE,CACnE,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,kCAAkC;IACxD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAA4C;QACjD,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3C,IAAI,QAAQ,GAAG,IAAI,CAAC;YAEpB,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;gBAChB,QAAQ,KAAR,QAAQ,GAAK,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC,EAAE,EAAC;YAC1C,CAAC;YACD,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;gBACrB,QAAQ,KAAR,QAAQ,GAAK,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,OAAO,EAAC;YACpD,CAAC;YACD,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAClB,QAAQ,KAAR,QAAQ,GAAK,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAC;YAC9C,CAAC;YACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBACnC,QAAQ,KAAR,QAAQ,GAAK,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAC5C,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CACjC,EAAC;YACJ,CAAC;YACD,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAClC,QAAQ,KAAR,QAAQ,GAAK,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC1C,OAAO;oBACL,mDAAmD;oBACnD,IAAA,iCAAiB,EAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CACzC,CAAC;gBACJ,CAAC,CAAC,EAAC;YACL,CAAC;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAjKD,8CAiKC;;AAED;;;;;;GAMG;AACH,SAAgB,qBAAqB,CACnC,QAAmC,EACnC,UAAkB;IAElB,OAAO,GAAG,QAAQ,IAAI,UAAU,EAAE,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,KAAa;IAEb,OAAO,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oCAAoC,CAClD,EAAuB;IAEvB,MAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACtD,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 {\n  KeyringAccountEntropyTypeOption,\n  type KeyringAccount,\n} from '@metamask/keyring-api';\nimport { isScopeEqualToAny } from '@metamask/keyring-utils';\n\nimport type {\n  MultichainAccountWallet,\n  MultichainAccountWalletId,\n} from './wallet';\nimport type { AccountGroup } from '../group';\nimport type { AccountGroupProvider } from '../provider';\nimport { AccountWalletCategory } from '../wallet';\n\nconst MULTICHAIN_ACCOUNT_ID_REGEX = new RegExp(\n  `^${AccountWalletCategory.Entropy}:.*/(?<groupIndex>\\\\d+)$`,\n  'u',\n);\n\n/**\n * Selector to query a specific account based on some criteria.\n */\nexport type MultichainAccountSelector<Account extends KeyringAccount> = {\n  /**\n   * Query by account ID.\n   */\n  id?: Account['id'];\n\n  /**\n   * Query by account address.\n   */\n  address?: Account['address'];\n\n  /**\n   * Query by account type.\n   */\n  type?: Account['type'];\n\n  /**\n   * Query by account methods.\n   */\n  methods?: Account['methods'];\n\n  /**\n   * Query by account scopes.\n   */\n  scopes?: Account['scopes'];\n};\n\n/**\n * Multichain account ID.\n */\nexport type MultichainAccountId = `${MultichainAccountWalletId}/${number}`; // Use number for the account group index.\n\n/**\n * A multichain account that holds multiple accounts.\n */\nexport class MultichainAccount<Account extends KeyringAccount>\n  implements AccountGroup<Account>\n{\n  readonly #id: MultichainAccountId;\n\n  readonly #wallet: MultichainAccountWallet<Account>;\n\n  readonly #index: number;\n\n  readonly #providers: AccountGroupProvider<Account>[];\n\n  constructor({\n    groupIndex,\n    wallet,\n    providers,\n  }: {\n    groupIndex: number;\n    wallet: MultichainAccountWallet<Account>;\n    providers: AccountGroupProvider<Account>[];\n  }) {\n    this.#id = toMultichainAccountId(wallet.id, groupIndex);\n    this.#index = groupIndex;\n    this.#wallet = wallet;\n    this.#providers = providers;\n  }\n\n  /**\n   * Gets the multichain account ID.\n   *\n   * @returns The multichain account ID.\n   */\n  get id(): MultichainAccountId {\n    return this.#id;\n  }\n\n  /**\n   * Gets the multichain account's wallet reference (parent).\n   *\n   * @returns The multichain account's wallet.\n   */\n  get wallet(): MultichainAccountWallet<Account> {\n    return this.#wallet;\n  }\n\n  /**\n   * Gets the multichain account group index.\n   *\n   * @returns The multichain account group index.\n   */\n  get index(): number {\n    return this.#index;\n  }\n\n  /**\n   * Checks if there's any underlying accounts for this multichain accounts.\n   *\n   * @returns True if there's any underlying accounts, false otherwise.\n   */\n  hasAccounts(): boolean {\n    return this.getAccounts().length > 0;\n  }\n\n  /**\n   * Gets the accounts for this multichain account.\n   *\n   * @returns The accounts.\n   */\n  getAccounts(): Account[] {\n    let allAccounts: Account[] = [];\n\n    for (const provider of this.#providers) {\n      allAccounts = allAccounts.concat(\n        provider.getAccounts().filter(\n          // NOTE: For now we always query the providers to get the latest\n          // account list. If this becomes too \"heavy\" in terms of computation\n          // we might wanna consider adding a state to that object and store\n          // the list of account IDs here.\n          (account) =>\n            account.options.entropy &&\n            account.options.entropy.type ===\n              KeyringAccountEntropyTypeOption.Mnemonic &&\n            account.options.entropy.id === this.wallet.entropySource &&\n            account.options.entropy.groupIndex === this.index,\n        ),\n      );\n    }\n\n    return allAccounts;\n  }\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    // NOTE: Same remark here. We could keep a state to make this operation\n    // faster.\n    return this.getAccounts().find((account) => account.id === id);\n  }\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: MultichainAccountSelector<Account>): Account | undefined {\n    const accounts = this.select(selector);\n\n    if (accounts.length > 1) {\n      throw new Error(\n        `Too many account candidates, expected 1, got: ${accounts.length}`,\n      );\n    }\n\n    if (accounts.length === 0) {\n      return undefined;\n    }\n\n    return accounts[0]; // This is safe, see checks above.\n  }\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: MultichainAccountSelector<Account>): Account[] {\n    return this.getAccounts().filter((account) => {\n      let selected = true;\n\n      if (selector.id) {\n        selected &&= account.id === selector.id;\n      }\n      if (selector.address) {\n        selected &&= account.address === selector.address;\n      }\n      if (selector.type) {\n        selected &&= account.type === selector.type;\n      }\n      if (selector.methods !== undefined) {\n        selected &&= selector.methods.some((method) =>\n          account.methods.includes(method),\n        );\n      }\n      if (selector.scopes !== undefined) {\n        selected &&= selector.scopes.some((scope) => {\n          return (\n            // This will cover specific EVM EOA scopes as well.\n            isScopeEqualToAny(scope, account.scopes)\n          );\n        });\n      }\n\n      return selected;\n    });\n  }\n}\n\n/**\n * Gets the multichain account 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 toMultichainAccountId(\n  walletId: MultichainAccountWalletId,\n  groupIndex: number,\n): MultichainAccountId {\n  return `${walletId}/${groupIndex}`;\n}\n\n/**\n * Checks if the given value is {@link MultichainAccountId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link MultichainAccountId}.\n */\nexport function isMultichainAccountId(\n  value: string,\n): value is MultichainAccountId {\n  return MULTICHAIN_ACCOUNT_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: MultichainAccountId,\n): number {\n  const matched = id.match(MULTICHAIN_ACCOUNT_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/account.d.cts

@@ -0,0 +1,119 @@
+import { type KeyringAccount } from "@metamask/keyring-api";
+import type { MultichainAccountWallet, MultichainAccountWalletId } from "./wallet.cjs";
+import type { AccountGroup } from "../group.cjs";
+import type { AccountGroupProvider } from "../provider.cjs";
+/**
+ * Selector to query a specific account based on some criteria.
+ */
+export type MultichainAccountSelector<Account extends KeyringAccount> = {
+    /**
+     * Query by account ID.
+     */
+    id?: Account['id'];
+    /**
+     * Query by account address.
+     */
+    address?: Account['address'];
+    /**
+     * Query by account type.
+     */
+    type?: Account['type'];
+    /**
+     * Query by account methods.
+     */
+    methods?: Account['methods'];
+    /**
+     * Query by account scopes.
+     */
+    scopes?: Account['scopes'];
+};
+/**
+ * Multichain account ID.
+ */
+export type MultichainAccountId = `${MultichainAccountWalletId}/${number}`;
+/**
+ * A multichain account that holds multiple accounts.
+ */
+export declare class MultichainAccount<Account extends KeyringAccount> implements AccountGroup<Account> {
+    #private;
+    constructor({ groupIndex, wallet, providers, }: {
+        groupIndex: number;
+        wallet: MultichainAccountWallet<Account>;
+        providers: AccountGroupProvider<Account>[];
+    });
+    /**
+     * Gets the multichain account ID.
+     *
+     * @returns The multichain account ID.
+     */
+    get id(): MultichainAccountId;
+    /**
+     * Gets the multichain account's wallet reference (parent).
+     *
+     * @returns The multichain account's wallet.
+     */
+    get wallet(): MultichainAccountWallet<Account>;
+    /**
+     * Gets the multichain account group index.
+     *
+     * @returns The multichain account group index.
+     */
+    get index(): number;
+    /**
+     * Checks if there's any underlying accounts for this multichain accounts.
+     *
+     * @returns True if there's any underlying accounts, false otherwise.
+     */
+    hasAccounts(): boolean;
+    /**
+     * Gets the accounts for this multichain account.
+     *
+     * @returns The accounts.
+     */
+    getAccounts(): Account[];
+    /**
+     * Gets the account for a given account ID.
+     *
+     * @param id - Account ID.
+     * @returns The account or undefined if not found.
+     */
+    getAccount(id: Account['id']): Account | undefined;
+    /**
+     * 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: MultichainAccountSelector<Account>): Account | undefined;
+    /**
+     * Query accounts matching the selector.
+     *
+     * @param selector - Query selector.
+     * @returns The accounts matching the selector.
+     */
+    select(selector: MultichainAccountSelector<Account>): Account[];
+}
+/**
+ * Gets the multichain account 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 toMultichainAccountId(walletId: MultichainAccountWalletId, groupIndex: number): MultichainAccountId;
+/**
+ * Checks if the given value is {@link MultichainAccountId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link MultichainAccountId}.
+ */
+export declare function isMultichainAccountId(value: string): value is MultichainAccountId;
+/**
+ * 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: MultichainAccountId): number;
+//# sourceMappingURL=account.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"account.d.cts","sourceRoot":"","sources":["../../../src/api/multichain/account.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EACpB,8BAA8B;AAG/B,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,qBAAiB;AAClB,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAoB;AAQxD;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,OAAO,SAAS,cAAc,IAAI;IACtE;;OAEG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,GAAG,yBAAyB,IAAI,MAAM,EAAE,CAAC;AAE3E;;GAEG;AACH,qBAAa,iBAAiB,CAAC,OAAO,SAAS,cAAc,CAC3D,YAAW,YAAY,CAAC,OAAO,CAAC;;gBAUpB,EACV,UAAU,EACV,MAAM,EACN,SAAS,GACV,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC;QACzC,SAAS,EAAE,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC;KAC5C;IAOD;;;;OAIG;IACH,IAAI,EAAE,IAAI,mBAAmB,CAE5B;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAE7C;IAED;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,WAAW,IAAI,OAAO;IAItB;;;;OAIG;IACH,WAAW,IAAI,OAAO,EAAE;IAuBxB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,SAAS;IAMlD;;;;;;OAMG;IACH,GAAG,CAAC,QAAQ,EAAE,yBAAyB,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,SAAS;IAgBtE;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,yBAAyB,CAAC,OAAO,CAAC,GAAG,OAAO,EAAE;CA8BhE;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,yBAAyB,EACnC,UAAU,EAAE,MAAM,GACjB,mBAAmB,CAErB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,GACZ,KAAK,IAAI,mBAAmB,CAE9B;AAED;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAClD,EAAE,EAAE,mBAAmB,GACtB,MAAM,CASR"}