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

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

@@ -0,0 +1,83 @@
+import { type EntropySourceId, type KeyringAccount } from "@metamask/keyring-api";
+import { MultichainAccount } from "./account.mjs";
+import type { AccountGroupId } from "../group.mjs";
+import type { AccountGroupProvider } from "../provider.mjs";
+import type { AccountWallet } from "../wallet.mjs";
+import { AccountWalletCategory } from "../wallet.mjs";
+/**
+ * Multichain account wallet ID.
+ */
+export type MultichainAccountWalletId = `${AccountWalletCategory.Entropy}:${EntropySourceId}`;
+/**
+ * A multichain account wallet that holds multiple multichain accounts (one multichain account per
+ * group index).
+ */
+export declare class MultichainAccountWallet<Account extends KeyringAccount> implements AccountWallet<Account> {
+    #private;
+    constructor({ providers, entropySource, }: {
+        providers: AccountGroupProvider<Account>[];
+        entropySource: EntropySourceId;
+    });
+    /**
+     * Gets the highest group index from multiple account providers for a given
+     * entropy source.
+     *
+     * @param providers - Account providers.
+     * @param entropySource - Entropy source to filter on.
+     * @returns The highest group index for a given entropy source.
+     */
+    static getHighestGroupIndexFrom<Account extends KeyringAccount>(providers: AccountGroupProvider<Account>[], entropySource: EntropySourceId): number;
+    /**
+     * Gets the multichain account wallet ID.
+     *
+     * @returns The multichain account wallet ID.
+     */
+    get id(): MultichainAccountWalletId;
+    /**
+     * Gets the multichain account wallet category, which is always {@link AccountWalletCategory.Entropy}.
+     *
+     * @returns The multichain account wallet category.
+     */
+    get category(): AccountWalletCategory.Entropy;
+    /**
+     * Gets the multichain account wallet entropy source.
+     *
+     * @returns The multichain account wallet entropy source.
+     */
+    get entropySource(): EntropySourceId;
+    /**
+     * Gets multichain account for a given ID.
+     * The default group ID will default to the multichain account with index 0.
+     *
+     * @param id - Account group ID.
+     * @returns Account group.
+     */
+    getAccountGroup(id: AccountGroupId): MultichainAccount<Account> | undefined;
+    /**
+     * Gets all multichain accounts. Similar to {@link MultichainAccountWallet.getMultichainAccounts}.
+     *
+     * @returns The multichain accounts.
+     */
+    getAccountGroups(): MultichainAccount<Account>[];
+    /**
+     * Gets multichain account for a given index.
+     *
+     * @param groupIndex - Multichain account index.
+     * @returns The multichain account associated with the given index.
+     */
+    getMultichainAccount(groupIndex: number): MultichainAccount<Account> | undefined;
+    /**
+     * Gets all multichain accounts.
+     *
+     * @returns The multichain accounts.
+     */
+    getMultichainAccounts(): MultichainAccount<Account>[];
+}
+/**
+ * Gets the multichain account wallet ID from its entropy source.
+ *
+ * @param entropySource - Entropy source ID of that wallet.
+ * @returns The multichain account wallet ID.
+ */
+export declare function toMultichainAccountWalletId(entropySource: EntropySourceId): MultichainAccountWalletId;
+//# sourceMappingURL=wallet.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.d.mts","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,8BAA8B;AAE/B,OAAO,EAGL,iBAAiB,EAClB,sBAAkB;AACnB,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAiB;AAE/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAoB;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,sBAAkB;AAC/C,OAAO,EAAE,qBAAqB,EAAE,sBAAkB;AAElD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACnC,GAAG,qBAAqB,CAAC,OAAO,IAAI,eAAe,EAAE,CAAC;AAExD;;;GAGG;AACH,qBAAa,uBAAuB,CAAC,OAAO,SAAS,cAAc,CACjE,YAAW,aAAa,CAAC,OAAO,CAAC;;gBAUrB,EACV,SAAS,EACT,aAAa,GACd,EAAE;QACD,SAAS,EAAE,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,aAAa,EAAE,eAAe,CAAC;KAChC;IAgCD;;;;;;;OAOG;IACH,MAAM,CAAC,wBAAwB,CAAC,OAAO,SAAS,cAAc,EAC5D,SAAS,EAAE,oBAAoB,CAAC,OAAO,CAAC,EAAE,EAC1C,aAAa,EAAE,eAAe,GAC7B,MAAM;IAmBT;;;;OAIG;IACH,IAAI,EAAE,IAAI,yBAAyB,CAElC;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,qBAAqB,CAAC,OAAO,CAE5C;IAED;;;;OAIG;IACH,IAAI,aAAa,IAAI,eAAe,CAEnC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,iBAAiB,CAAC,OAAO,CAAC,GAAG,SAAS;IAgB3E;;;;OAIG;IACH,gBAAgB,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE;IAIhD;;;;;OAKG;IACH,oBAAoB,CAClB,UAAU,EAAE,MAAM,GACjB,iBAAiB,CAAC,OAAO,CAAC,GAAG,SAAS;IAIzC;;;;OAIG;IACH,qBAAqB,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE;CAGtD;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,eAAe,GAC7B,yBAAyB,CAE3B"}

package/dist/api/multichain/wallet.mjs

@@ -0,0 +1,153 @@
+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 _MultichainAccountWallet_id, _MultichainAccountWallet_providers, _MultichainAccountWallet_entropySource, _MultichainAccountWallet_accounts;
+import { KeyringAccountEntropyTypeOption } from "@metamask/keyring-api";
+import { getGroupIndexFromMultichainAccountId, isMultichainAccountId, MultichainAccount } from "./account.mjs";
+import { toDefaultAccountGroupId } from "../group.mjs";
+import { AccountWalletCategory } from "../wallet.mjs";
+/**
+ * A multichain account wallet that holds multiple multichain accounts (one multichain account per
+ * group index).
+ */
+export class MultichainAccountWallet {
+    constructor({ providers, entropySource, }) {
+        _MultichainAccountWallet_id.set(this, void 0);
+        _MultichainAccountWallet_providers.set(this, void 0);
+        _MultichainAccountWallet_entropySource.set(this, void 0);
+        _MultichainAccountWallet_accounts.set(this, void 0);
+        __classPrivateFieldSet(this, _MultichainAccountWallet_id, toMultichainAccountWalletId(entropySource), "f");
+        __classPrivateFieldSet(this, _MultichainAccountWallet_providers, providers, "f");
+        __classPrivateFieldSet(this, _MultichainAccountWallet_entropySource, entropySource, "f");
+        __classPrivateFieldSet(this, _MultichainAccountWallet_accounts, new Map(), "f");
+        // NOTE: This will traverse all accounts to compute the max index. We could try
+        // to minimize the number of filtering we're doing on each providers if this
+        // becomes too costly.
+        const maxGroupIndex = MultichainAccountWallet.getHighestGroupIndexFrom(providers, entropySource);
+        // NOTE: We could have some gap for now, until we fully implement the
+        // gap/aligment mechanisms to backfill all "missing accounts".
+        for (let groupIndex = 0; groupIndex <= maxGroupIndex; groupIndex++) {
+            // Use "lower or equal", since we need to "include" the max index (which
+            // can also be 0)
+            const multichainAccount = new MultichainAccount({
+                groupIndex,
+                wallet: this,
+                providers: __classPrivateFieldGet(this, _MultichainAccountWallet_providers, "f"),
+            });
+            // We only add multichain account that has underlying accounts.
+            if (multichainAccount.hasAccounts()) {
+                __classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").set(groupIndex, multichainAccount);
+            }
+        }
+    }
+    /**
+     * Gets the highest group index from multiple account providers for a given
+     * entropy source.
+     *
+     * @param providers - Account providers.
+     * @param entropySource - Entropy source to filter on.
+     * @returns The highest group index for a given entropy source.
+     */
+    static getHighestGroupIndexFrom(providers, entropySource) {
+        let max = -1;
+        for (const provider of providers) {
+            for (const account of provider.getAccounts()) {
+                if (account.options.entropy &&
+                    account.options.entropy.type ===
+                        KeyringAccountEntropyTypeOption.Mnemonic &&
+                    account.options.entropy.id === entropySource) {
+                    max = Math.max(max, account.options.entropy.groupIndex);
+                }
+            }
+        }
+        return max;
+    }
+    /**
+     * Gets the multichain account wallet ID.
+     *
+     * @returns The multichain account wallet ID.
+     */
+    get id() {
+        return __classPrivateFieldGet(this, _MultichainAccountWallet_id, "f");
+    }
+    /**
+     * Gets the multichain account wallet category, which is always {@link AccountWalletCategory.Entropy}.
+     *
+     * @returns The multichain account wallet category.
+     */
+    get category() {
+        return AccountWalletCategory.Entropy;
+    }
+    /**
+     * Gets the multichain account wallet entropy source.
+     *
+     * @returns The multichain account wallet entropy source.
+     */
+    get entropySource() {
+        return __classPrivateFieldGet(this, _MultichainAccountWallet_entropySource, "f");
+    }
+    /**
+     * Gets multichain account for a given ID.
+     * The default group ID will default to the multichain account with index 0.
+     *
+     * @param id - Account group ID.
+     * @returns Account group.
+     */
+    getAccountGroup(id) {
+        // We consider the "default case" to be mapped to index 0.
+        if (id === toDefaultAccountGroupId(this.id)) {
+            return __classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").get(0);
+        }
+        // If it is not a valid ID, we cannot extract the group index
+        // from it, so we fail fast.
+        if (!isMultichainAccountId(id)) {
+            return undefined;
+        }
+        const groupIndex = getGroupIndexFromMultichainAccountId(id);
+        return __classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").get(groupIndex);
+    }
+    /**
+     * Gets all multichain accounts. Similar to {@link MultichainAccountWallet.getMultichainAccounts}.
+     *
+     * @returns The multichain accounts.
+     */
+    getAccountGroups() {
+        return this.getMultichainAccounts();
+    }
+    /**
+     * Gets multichain account for a given index.
+     *
+     * @param groupIndex - Multichain account index.
+     * @returns The multichain account associated with the given index.
+     */
+    getMultichainAccount(groupIndex) {
+        return __classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").get(groupIndex);
+    }
+    /**
+     * Gets all multichain accounts.
+     *
+     * @returns The multichain accounts.
+     */
+    getMultichainAccounts() {
+        return Array.from(__classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").values()); // TODO: Prevent copy here.
+    }
+}
+_MultichainAccountWallet_id = new WeakMap(), _MultichainAccountWallet_providers = new WeakMap(), _MultichainAccountWallet_entropySource = new WeakMap(), _MultichainAccountWallet_accounts = new WeakMap();
+/**
+ * Gets the multichain account wallet ID from its entropy source.
+ *
+ * @param entropySource - Entropy source ID of that wallet.
+ * @returns The multichain account wallet ID.
+ */
+export function toMultichainAccountWalletId(entropySource) {
+    return `${AccountWalletCategory.Entropy}:${entropySource}`;
+}
+//# sourceMappingURL=wallet.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.mjs","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,+BAA+B,EAGhC,8BAA8B;AAE/B,OAAO,EACL,oCAAoC,EACpC,qBAAqB,EACrB,iBAAiB,EAClB,sBAAkB;AAEnB,OAAO,EAAE,uBAAuB,EAAE,qBAAiB;AAGnD,OAAO,EAAE,qBAAqB,EAAE,sBAAkB;AAQlD;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IAWlC,YAAY,EACV,SAAS,EACT,aAAa,GAId;QAdQ,8CAA+B;QAE/B,qDAA4C;QAE5C,yDAAgC;QAEhC,oDAAmD;QAS1D,uBAAA,IAAI,+BAAO,2BAA2B,CAAC,aAAa,CAAC,MAAA,CAAC;QACtD,uBAAA,IAAI,sCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,0CAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,qCAAa,IAAI,GAAG,EAAE,MAAA,CAAC;QAE3B,+EAA+E;QAC/E,4EAA4E;QAC5E,sBAAsB;QACtB,MAAM,aAAa,GAAG,uBAAuB,CAAC,wBAAwB,CACpE,SAAS,EACT,aAAa,CACd,CAAC;QAEF,qEAAqE;QACrE,8DAA8D;QAC9D,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,IAAI,aAAa,EAAE,UAAU,EAAE,EAAE,CAAC;YACnE,wEAAwE;YACxE,iBAAiB;YACjB,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAU;gBACvD,UAAU;gBACV,MAAM,EAAE,IAAI;gBACZ,SAAS,EAAE,uBAAA,IAAI,0CAAW;aAC3B,CAAC,CAAC;YAEH,+DAA+D;YAC/D,IAAI,iBAAiB,CAAC,WAAW,EAAE,EAAE,CAAC;gBACpC,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,wBAAwB,CAC7B,SAA0C,EAC1C,aAA8B;QAE9B,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC;QAEb,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC7C,IACE,OAAO,CAAC,OAAO,CAAC,OAAO;oBACvB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI;wBAC1B,+BAA+B,CAAC,QAAQ;oBAC1C,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,aAAa,EAC5C,CAAC;oBACD,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE;QACJ,OAAO,uBAAA,IAAI,mCAAI,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ;QACV,OAAO,qBAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa;QACf,OAAO,uBAAA,IAAI,8CAAe,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,EAAkB;QAChC,0DAA0D;QAC1D,IAAI,EAAE,KAAK,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YAC5C,OAAO,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;QAED,6DAA6D;QAC7D,4BAA4B;QAC5B,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,EAAE,CAAC;YAC/B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,UAAU,GAAG,oCAAoC,CAAC,EAAE,CAAC,CAAC;QAC5D,OAAO,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAClB,UAAkB;QAElB,OAAO,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,qBAAqB;QACnB,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,yCAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,2BAA2B;IACzE,CAAC;CACF;;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,aAA8B;IAE9B,OAAO,GAAG,qBAAqB,CAAC,OAAO,IAAI,aAAa,EAAE,CAAC;AAC7D,CAAC","sourcesContent":["import {\n  KeyringAccountEntropyTypeOption,\n  type EntropySourceId,\n  type KeyringAccount,\n} from '@metamask/keyring-api';\n\nimport {\n  getGroupIndexFromMultichainAccountId,\n  isMultichainAccountId,\n  MultichainAccount,\n} from './account';\nimport type { AccountGroupId } from '../group';\nimport { toDefaultAccountGroupId } from '../group';\nimport type { AccountGroupProvider } from '../provider';\nimport type { AccountWallet } from '../wallet';\nimport { AccountWalletCategory } from '../wallet';\n\n/**\n * Multichain account wallet ID.\n */\nexport type MultichainAccountWalletId =\n  `${AccountWalletCategory.Entropy}:${EntropySourceId}`;\n\n/**\n * A multichain account wallet that holds multiple multichain accounts (one multichain account per\n * group index).\n */\nexport class MultichainAccountWallet<Account extends KeyringAccount>\n  implements AccountWallet<Account>\n{\n  readonly #id: MultichainAccountWalletId;\n\n  readonly #providers: AccountGroupProvider<Account>[];\n\n  readonly #entropySource: EntropySourceId;\n\n  readonly #accounts: Map<number, MultichainAccount<Account>>;\n\n  constructor({\n    providers,\n    entropySource,\n  }: {\n    providers: AccountGroupProvider<Account>[];\n    entropySource: EntropySourceId;\n  }) {\n    this.#id = toMultichainAccountWalletId(entropySource);\n    this.#providers = providers;\n    this.#entropySource = entropySource;\n    this.#accounts = new Map();\n\n    // NOTE: This will traverse all accounts to compute the max index. We could try\n    // to minimize the number of filtering we're doing on each providers if this\n    // becomes too costly.\n    const maxGroupIndex = MultichainAccountWallet.getHighestGroupIndexFrom(\n      providers,\n      entropySource,\n    );\n\n    // NOTE: We could have some gap for now, until we fully implement the\n    // gap/aligment mechanisms to backfill all \"missing accounts\".\n    for (let groupIndex = 0; groupIndex <= maxGroupIndex; groupIndex++) {\n      // Use \"lower or equal\", since we need to \"include\" the max index (which\n      // can also be 0)\n      const multichainAccount = new MultichainAccount<Account>({\n        groupIndex,\n        wallet: this,\n        providers: this.#providers,\n      });\n\n      // We only add multichain account that has underlying accounts.\n      if (multichainAccount.hasAccounts()) {\n        this.#accounts.set(groupIndex, multichainAccount);\n      }\n    }\n  }\n\n  /**\n   * Gets the highest group index from multiple account providers for a given\n   * entropy source.\n   *\n   * @param providers - Account providers.\n   * @param entropySource - Entropy source to filter on.\n   * @returns The highest group index for a given entropy source.\n   */\n  static getHighestGroupIndexFrom<Account extends KeyringAccount>(\n    providers: AccountGroupProvider<Account>[],\n    entropySource: EntropySourceId,\n  ): number {\n    let max = -1;\n\n    for (const provider of providers) {\n      for (const account of provider.getAccounts()) {\n        if (\n          account.options.entropy &&\n          account.options.entropy.type ===\n            KeyringAccountEntropyTypeOption.Mnemonic &&\n          account.options.entropy.id === entropySource\n        ) {\n          max = Math.max(max, account.options.entropy.groupIndex);\n        }\n      }\n    }\n\n    return max;\n  }\n\n  /**\n   * Gets the multichain account wallet ID.\n   *\n   * @returns The multichain account wallet ID.\n   */\n  get id(): MultichainAccountWalletId {\n    return this.#id;\n  }\n\n  /**\n   * Gets the multichain account wallet category, which is always {@link AccountWalletCategory.Entropy}.\n   *\n   * @returns The multichain account wallet category.\n   */\n  get category(): AccountWalletCategory.Entropy {\n    return AccountWalletCategory.Entropy;\n  }\n\n  /**\n   * Gets the multichain account wallet entropy source.\n   *\n   * @returns The multichain account wallet entropy source.\n   */\n  get entropySource(): EntropySourceId {\n    return this.#entropySource;\n  }\n\n  /**\n   * Gets multichain account for a given ID.\n   * The default group ID will default to the multichain account with index 0.\n   *\n   * @param id - Account group ID.\n   * @returns Account group.\n   */\n  getAccountGroup(id: AccountGroupId): MultichainAccount<Account> | undefined {\n    // We consider the \"default case\" to be mapped to index 0.\n    if (id === toDefaultAccountGroupId(this.id)) {\n      return this.#accounts.get(0);\n    }\n\n    // If it is not a valid ID, we cannot extract the group index\n    // from it, so we fail fast.\n    if (!isMultichainAccountId(id)) {\n      return undefined;\n    }\n\n    const groupIndex = getGroupIndexFromMultichainAccountId(id);\n    return this.#accounts.get(groupIndex);\n  }\n\n  /**\n   * Gets all multichain accounts. Similar to {@link MultichainAccountWallet.getMultichainAccounts}.\n   *\n   * @returns The multichain accounts.\n   */\n  getAccountGroups(): MultichainAccount<Account>[] {\n    return this.getMultichainAccounts();\n  }\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  getMultichainAccount(\n    groupIndex: number,\n  ): MultichainAccount<Account> | undefined {\n    return this.#accounts.get(groupIndex);\n  }\n\n  /**\n   * Gets all multichain accounts.\n   *\n   * @returns The multichain accounts.\n   */\n  getMultichainAccounts(): MultichainAccount<Account>[] {\n    return Array.from(this.#accounts.values()); // TODO: Prevent copy here.\n  }\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 `${AccountWalletCategory.Entropy}:${entropySource}`;\n}\n"]}

package/dist/api/provider.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=provider.cjs.map

package/dist/api/provider.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.cjs","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n/**\n * An account provider is reponsible of providing accounts to an account group.\n */\nexport type AccountGroupProvider<Account extends KeyringAccount> = {\n  /**\n   * Gets all accounts for a given entropy source and group index.\n   *\n   * @returns A list of all account for this provider.\n   */\n  getAccounts: () => Account[];\n};\n"]}

package/dist/api/provider.d.cts

@@ -0,0 +1,13 @@
+import type { KeyringAccount } from "@metamask/keyring-api";
+/**
+ * An account provider is reponsible of providing accounts to an account group.
+ */
+export type AccountGroupProvider<Account extends KeyringAccount> = {
+    /**
+     * Gets all accounts for a given entropy source and group index.
+     *
+     * @returns A list of all account for this provider.
+     */
+    getAccounts: () => Account[];
+};
+//# sourceMappingURL=provider.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.cts","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAE5D;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,cAAc,IAAI;IACjE;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,EAAE,CAAC;CAC9B,CAAC"}

package/dist/api/provider.d.mts

@@ -0,0 +1,13 @@
+import type { KeyringAccount } from "@metamask/keyring-api";
+/**
+ * An account provider is reponsible of providing accounts to an account group.
+ */
+export type AccountGroupProvider<Account extends KeyringAccount> = {
+    /**
+     * Gets all accounts for a given entropy source and group index.
+     *
+     * @returns A list of all account for this provider.
+     */
+    getAccounts: () => Account[];
+};
+//# sourceMappingURL=provider.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.mts","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAE5D;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,cAAc,IAAI;IACjE;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,EAAE,CAAC;CAC9B,CAAC"}

package/dist/api/provider.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=provider.mjs.map

package/dist/api/provider.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.mjs","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n/**\n * An account provider is reponsible of providing accounts to an account group.\n */\nexport type AccountGroupProvider<Account extends KeyringAccount> = {\n  /**\n   * Gets all accounts for a given entropy source and group index.\n   *\n   * @returns A list of all account for this provider.\n   */\n  getAccounts: () => Account[];\n};\n"]}

package/dist/api/wallet.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.cjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":";;;AAkEA,8CAKC;AAlED,IAAY,qBAkBX;AAlBD,WAAY,qBAAqB;IAC/B;;;OAGG;IACH,4CAAmB,CAAA;IAEnB;;;OAGG;IACH,4CAAmB,CAAA;IAEnB;;;OAGG;IACH,sCAAa,CAAA;AACf,CAAC,EAlBW,qBAAqB,qCAArB,qBAAqB,QAkBhC;AAoCD;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,QAA+B,EAC/B,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,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\nexport enum AccountWalletCategory {\n  /**\n   * Category for wallets that group accounts based on their\n   * entropy source.\n   */\n  Entropy = 'entropy',\n\n  /**\n   * Category for wallets that group accounts based on their\n   * keyring's type.\n   */\n  Keyring = 'keyring',\n\n  /**\n   * Category for wallets that group accounts associated with an\n   * account management Snap.\n   */\n  Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletCategory}:${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 category.\n   */\n  get category(): AccountWalletCategory;\n\n  /**\n   * Gets account group for a given ID.\n   *\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 * Convert a unique ID to a wallet ID for a given category.\n *\n * @param category - A wallet category.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId(\n  category: AccountWalletCategory,\n  id: string,\n): AccountWalletId {\n  return `${category}:${id}`;\n}\n"]}
+{"version":3,"file":"wallet.cjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":";;;AAmEA,8CAKC;AAnED,IAAY,qBAkBX;AAlBD,WAAY,qBAAqB;IAC/B;;;OAGG;IACH,4CAAmB,CAAA;IAEnB;;;OAGG;IACH,4CAAmB,CAAA;IAEnB;;;OAGG;IACH,sCAAa,CAAA;AACf,CAAC,EAlBW,qBAAqB,qCAArB,qBAAqB,QAkBhC;AAqCD;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,QAA+B,EAC/B,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,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\nexport enum AccountWalletCategory {\n  /**\n   * Category for wallets that group accounts based on their\n   * entropy source.\n   */\n  Entropy = 'entropy',\n\n  /**\n   * Category for wallets that group accounts based on their\n   * keyring's type.\n   */\n  Keyring = 'keyring',\n\n  /**\n   * Category for wallets that group accounts associated with an\n   * account management Snap.\n   */\n  Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletCategory}:${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 category.\n   */\n  get category(): AccountWalletCategory;\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 * Convert a unique ID to a wallet ID for a given category.\n *\n * @param category - A wallet category.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId(\n  category: AccountWalletCategory,\n  id: string,\n): AccountWalletId {\n  return `${category}:${id}`;\n}\n"]}

package/dist/api/wallet.d.cts

@@ -36,6 +36,7 @@ export type AccountWallet<Account extends KeyringAccount> = {
     /**
      * Gets account group for a given ID.
      *
+     * @param id - Account group ID.
      * @returns Account group.
      */
     getAccountGroup(id: AccountGroupId): AccountGroup<Account> | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"wallet.d.cts","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAE5D,oBAAY,qBAAqB;IAC/B;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,qBAAqB,IAAI,MAAM,EAAE,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,cAAc,IAAI;IAC1D;;OAEG;IACH,IAAI,EAAE,IAAI,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,QAAQ,IAAI,qBAAqB,CAAC;IAEtC;;;;OAIG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,qBAAqB,EAC/B,EAAE,EAAE,MAAM,GACT,eAAe,CAEjB"}
+{"version":3,"file":"wallet.d.cts","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAE5D,oBAAY,qBAAqB;IAC/B;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,qBAAqB,IAAI,MAAM,EAAE,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,cAAc,IAAI;IAC1D;;OAEG;IACH,IAAI,EAAE,IAAI,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,QAAQ,IAAI,qBAAqB,CAAC;IAEtC;;;;;OAKG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,qBAAqB,EAC/B,EAAE,EAAE,MAAM,GACT,eAAe,CAEjB"}

package/dist/api/wallet.d.mts

@@ -36,6 +36,7 @@ export type AccountWallet<Account extends KeyringAccount> = {
     /**
      * Gets account group for a given ID.
      *
+     * @param id - Account group ID.
      * @returns Account group.
      */
     getAccountGroup(id: AccountGroupId): AccountGroup<Account> | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"wallet.d.mts","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAE5D,oBAAY,qBAAqB;IAC/B;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,qBAAqB,IAAI,MAAM,EAAE,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,cAAc,IAAI;IAC1D;;OAEG;IACH,IAAI,EAAE,IAAI,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,QAAQ,IAAI,qBAAqB,CAAC;IAEtC;;;;OAIG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,qBAAqB,EAC/B,EAAE,EAAE,MAAM,GACT,eAAe,CAEjB"}
+{"version":3,"file":"wallet.d.mts","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAE5D,oBAAY,qBAAqB;IAC/B;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,qBAAqB,IAAI,MAAM,EAAE,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,cAAc,IAAI;IAC1D;;OAEG;IACH,IAAI,EAAE,IAAI,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,QAAQ,IAAI,qBAAqB,CAAC;IAEtC;;;;;OAKG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,qBAAqB,EAC/B,EAAE,EAAE,MAAM,GACT,eAAe,CAEjB"}

package/dist/api/wallet.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.mjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAKA,MAAM,CAAN,IAAY,qBAkBX;AAlBD,WAAY,qBAAqB;IAC/B;;;OAGG;IACH,4CAAmB,CAAA;IAEnB;;;OAGG;IACH,4CAAmB,CAAA;IAEnB;;;OAGG;IACH,sCAAa,CAAA;AACf,CAAC,EAlBW,qBAAqB,KAArB,qBAAqB,QAkBhC;AAoCD;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAA+B,EAC/B,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,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\nexport enum AccountWalletCategory {\n  /**\n   * Category for wallets that group accounts based on their\n   * entropy source.\n   */\n  Entropy = 'entropy',\n\n  /**\n   * Category for wallets that group accounts based on their\n   * keyring's type.\n   */\n  Keyring = 'keyring',\n\n  /**\n   * Category for wallets that group accounts associated with an\n   * account management Snap.\n   */\n  Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletCategory}:${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 category.\n   */\n  get category(): AccountWalletCategory;\n\n  /**\n   * Gets account group for a given ID.\n   *\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 * Convert a unique ID to a wallet ID for a given category.\n *\n * @param category - A wallet category.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId(\n  category: AccountWalletCategory,\n  id: string,\n): AccountWalletId {\n  return `${category}:${id}`;\n}\n"]}
+{"version":3,"file":"wallet.mjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAKA,MAAM,CAAN,IAAY,qBAkBX;AAlBD,WAAY,qBAAqB;IAC/B;;;OAGG;IACH,4CAAmB,CAAA;IAEnB;;;OAGG;IACH,4CAAmB,CAAA;IAEnB;;;OAGG;IACH,sCAAa,CAAA;AACf,CAAC,EAlBW,qBAAqB,KAArB,qBAAqB,QAkBhC;AAqCD;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAA+B,EAC/B,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,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\nexport enum AccountWalletCategory {\n  /**\n   * Category for wallets that group accounts based on their\n   * entropy source.\n   */\n  Entropy = 'entropy',\n\n  /**\n   * Category for wallets that group accounts based on their\n   * keyring's type.\n   */\n  Keyring = 'keyring',\n\n  /**\n   * Category for wallets that group accounts associated with an\n   * account management Snap.\n   */\n  Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletCategory}:${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 category.\n   */\n  get category(): AccountWalletCategory;\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 * Convert a unique ID to a wallet ID for a given category.\n *\n * @param category - A wallet category.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId(\n  category: AccountWalletCategory,\n  id: string,\n): AccountWalletId {\n  return `${category}:${id}`;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/account-api",
-  "version": "0.0.0-dff9202",
+  "version": "0.1.0-32becbf",
   "description": "MetaMask Account API",
   "keywords": [
     "metamask",
@@ -53,9 +53,11 @@
     "@lavamoat/allow-scripts": "^3.2.1",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/keyring-internal-api": "6.2.0",
     "@ts-bridge/cli": "^0.6.3",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.12.12",
+    "@types/uuid": "^9.0.8",
     "deepmerge": "^4.2.2",
     "depcheck": "^1.4.7",
     "jest": "^29.5.0",
@@ -65,7 +67,8 @@
     "ts-node": "^10.9.2",
     "tsd": "^0.31.0",
     "typedoc": "^0.25.13",
-    "typescript": "~5.6.3"
+    "typescript": "~5.6.3",
+    "uuid": "^9.0.1"
   },
   "engines": {
     "node": "^18.18 || >=20"