@metamask-previews/account-tree-controller 0.6.0-preview-ed2a2e6 → 0.6.0-preview-b3ea3f86

package/dist/AccountTreeGroup.cjs

@@ -10,65 +10,49 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _AccountTreeGroup_instances, _AccountTreeGroup_messenger, _AccountTreeGroup_group, _AccountTreeGroup_wallet, _AccountTreeGroup_getAccount;
+var _MutableAccountTreeGroup_accounts;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AccountTreeGroup = exports.DEFAULT_ACCOUNT_GROUP_NAME = void 0;
+exports.MutableAccountTreeGroup = exports.DEFAULT_ACCOUNT_GROUP_NAME = void 0;
+const account_api_1 = require("@metamask/account-api");
 exports.DEFAULT_ACCOUNT_GROUP_NAME = 'Default';
-/**
- * Account group coming from the {@link AccountTreeController}.
- */
-class AccountTreeGroup {
-    constructor({ messenger, wallet, group, }) {
-        _AccountTreeGroup_instances.add(this);
-        _AccountTreeGroup_messenger.set(this, void 0);
-        _AccountTreeGroup_group.set(this, void 0);
-        _AccountTreeGroup_wallet.set(this, void 0);
-        __classPrivateFieldSet(this, _AccountTreeGroup_messenger, messenger, "f");
-        __classPrivateFieldSet(this, _AccountTreeGroup_group, group, "f");
-        __classPrivateFieldSet(this, _AccountTreeGroup_wallet, wallet, "f");
-    }
-    get id() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_group, "f").id;
-    }
-    get wallet() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_wallet, "f");
-    }
-    get name() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_group, "f").metadata.name;
+// This class is meant to be used internally by every rules. It exposes mutable operations
+// which should not leak outside of this package.
+class MutableAccountTreeGroup {
+    constructor(messenger, wallet, id) {
+        _MutableAccountTreeGroup_accounts.set(this, void 0);
+        this.id = (0, account_api_1.toAccountGroupId)(wallet.id, id);
+        this.wallet = wallet;
+        this.messenger = messenger;
+        __classPrivateFieldSet(this, _MutableAccountTreeGroup_accounts, new Set(), "f");
     }
     getAccountIds() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_group, "f").accounts;
-    }
-    getAccount(id) {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_messenger, "f").call('AccountsController:getAccount', id);
+        return Array.from(__classPrivateFieldGet(this, _MutableAccountTreeGroup_accounts, "f")); // FIXME: Should we force the copy here?
     }
     getAccounts() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_group, "f").accounts.map((id) => __classPrivateFieldGet(this, _AccountTreeGroup_instances, "m", _AccountTreeGroup_getAccount).call(this, id));
-    }
-    getAnyAccount() {
-        const accountIds = this.getAccountIds();
-        if (accountIds.length === 0) {
-            throw new Error('Group contains no account');
+        const accounts = [];
+        for (const id of __classPrivateFieldGet(this, _MutableAccountTreeGroup_accounts, "f")) {
+            const account = this.getAccount(id);
+            // FIXME: I'm really not sure we should skip those but... We could be
+            // "de-sync" with the AccountsController and might have some dangling
+            // account IDs.
+            if (!account) {
+                console.warn(`! Unable to get account: "${id}"`);
+                continue;
+            }
+            accounts.push(account);
         }
-        return __classPrivateFieldGet(this, _AccountTreeGroup_instances, "m", _AccountTreeGroup_getAccount).call(this, accountIds[0]);
+        return accounts;
     }
-    getOnlyAccount() {
-        const accountIds = this.getAccountIds();
-        if (accountIds.length === 0) {
-            throw new Error('Group contains no account');
-        }
-        if (accountIds.length > 1) {
-            throw new Error('Group contains more than 1 account');
-        }
-        return __classPrivateFieldGet(this, _AccountTreeGroup_instances, "m", _AccountTreeGroup_getAccount).call(this, accountIds[0]);
+    getAccount(id) {
+        return this.messenger.call('AccountsController:getAccount', id);
     }
-}
-exports.AccountTreeGroup = AccountTreeGroup;
-_AccountTreeGroup_messenger = new WeakMap(), _AccountTreeGroup_group = new WeakMap(), _AccountTreeGroup_wallet = new WeakMap(), _AccountTreeGroup_instances = new WeakSet(), _AccountTreeGroup_getAccount = function _AccountTreeGroup_getAccount(id) {
-    const account = this.getAccount(id);
-    if (!account) {
-        throw new Error(`Unable to get account with ID: "${id}"`);
+    addAccount(account) {
+        __classPrivateFieldGet(this, _MutableAccountTreeGroup_accounts, "f").add(account.id);
     }
-    return account;
-};
+    getDefaultName() {
+        return exports.DEFAULT_ACCOUNT_GROUP_NAME;
+    }
+}
+exports.MutableAccountTreeGroup = MutableAccountTreeGroup;
+_MutableAccountTreeGroup_accounts = new WeakMap();
 //# sourceMappingURL=AccountTreeGroup.cjs.map

package/dist/AccountTreeGroup.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"AccountTreeGroup.cjs","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAQa,QAAA,0BAA0B,GAAW,SAAS,CAAC;AAE5D;;GAEG;AACH,MAAa,gBAAgB;IAO3B,YAAY,EACV,SAAS,EACT,MAAM,EACN,KAAK,GAKN;;QAdQ,8CAA2C;QAE3C,0CAA2B;QAE3B,2CAA2B;QAWlC,uBAAA,IAAI,+BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,2BAAU,KAAK,MAAA,CAAC;QACpB,uBAAA,IAAI,4BAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,uBAAA,IAAI,+BAAO,CAAC,EAAE,CAAC;IACxB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,uBAAA,IAAI,gCAAQ,CAAC;IACtB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,+BAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;IACnC,CAAC;IAED,aAAa;QACX,OAAO,uBAAA,IAAI,+BAAO,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,UAAU,CAAC,EAAU;QACnB,OAAO,uBAAA,IAAI,mCAAW,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;IACnE,CAAC;IAWD,WAAW;QACT,OAAO,uBAAA,IAAI,+BAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,uBAAA,IAAI,iEAAY,MAAhB,IAAI,EAAa,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,aAAa;QACX,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAExC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QAED,OAAO,uBAAA,IAAI,iEAAY,MAAhB,IAAI,EAAa,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,cAAc;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAExC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QACD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QAED,OAAO,uBAAA,IAAI,iEAAY,MAAhB,IAAI,EAAa,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;CACF;AA5ED,4CA4EC;kPAnCa,EAAU;IACpB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAEpC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,CAAC;KAC3D;IACD,OAAO,OAAO,CAAC;AACjB,CAAC","sourcesContent":["import { type AccountGroup, type AccountGroupId } from '@metamask/account-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type {\n  AccountGroupObject,\n  AccountTreeControllerMessenger,\n  AccountTreeWallet,\n} from 'src';\n\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\n/**\n * Account group coming from the {@link AccountTreeController}.\n */\nexport class AccountTreeGroup implements AccountGroup<InternalAccount> {\n  readonly #messenger: AccountTreeControllerMessenger;\n\n  readonly #group: AccountGroupObject;\n\n  readonly #wallet: AccountTreeWallet;\n\n  constructor({\n    messenger,\n    wallet,\n    group,\n  }: {\n    messenger: AccountTreeControllerMessenger;\n    wallet: AccountTreeWallet;\n    group: AccountGroupObject;\n  }) {\n    this.#messenger = messenger;\n    this.#group = group;\n    this.#wallet = wallet;\n  }\n\n  get id(): AccountGroupId {\n    return this.#group.id;\n  }\n\n  get wallet(): AccountTreeWallet {\n    return this.#wallet;\n  }\n\n  get name(): string {\n    return this.#group.metadata.name;\n  }\n\n  getAccountIds(): InternalAccount['id'][] {\n    return this.#group.accounts;\n  }\n\n  getAccount(id: string): InternalAccount | undefined {\n    return this.#messenger.call('AccountsController:getAccount', id);\n  }\n\n  #getAccount(id: string): InternalAccount {\n    const account = this.getAccount(id);\n\n    if (!account) {\n      throw new Error(`Unable to get account with ID: \"${id}\"`);\n    }\n    return account;\n  }\n\n  getAccounts(): InternalAccount[] {\n    return this.#group.accounts.map((id) => this.#getAccount(id));\n  }\n\n  getAnyAccount(): InternalAccount {\n    const accountIds = this.getAccountIds();\n\n    if (accountIds.length === 0) {\n      throw new Error('Group contains no account');\n    }\n\n    return this.#getAccount(accountIds[0]);\n  }\n\n  getOnlyAccount(): InternalAccount {\n    const accountIds = this.getAccountIds();\n\n    if (accountIds.length === 0) {\n      throw new Error('Group contains no account');\n    }\n    if (accountIds.length > 1) {\n      throw new Error('Group contains more than 1 account');\n    }\n\n    return this.#getAccount(accountIds[0]);\n  }\n}\n"]}
+{"version":3,"file":"AccountTreeGroup.cjs","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAK+B;AAKlB,QAAA,0BAA0B,GAAW,SAAS,CAAC;AAiB5D,0FAA0F;AAC1F,iDAAiD;AACjD,MAAa,uBAAuB;IASlC,YACE,SAAyC,EACzC,MAAsC,EACtC,EAAU;QALH,oDAA0B;QAOjC,IAAI,CAAC,EAAE,GAAG,IAAA,8BAAgB,EAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,qCAAa,IAAI,GAAG,EAAE,MAAA,CAAC;IAC7B,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,yCAAU,CAAC,CAAC,CAAC,wCAAwC;IAC7E,CAAC;IAED,WAAW;QACT,MAAM,QAAQ,GAAG,EAAE,CAAC;QAEpB,KAAK,MAAM,EAAE,IAAI,uBAAA,IAAI,yCAAU,EAAE;YAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAEpC,qEAAqE;YACrE,qEAAqE;YACrE,eAAe;YACf,IAAI,CAAC,OAAO,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;gBACjD,SAAS;aACV;YACD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,UAAU,CAAC,EAAa;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,UAAU,CAAC,OAAwB;QACjC,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,cAAc;QACZ,OAAO,kCAA0B,CAAC;IACpC,CAAC;CACF;AAtDD,0DAsDC","sourcesContent":["import {\n  toAccountGroupId,\n  type AccountGroup,\n  type AccountGroupId,\n  type AccountWallet,\n} from '@metamask/account-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { AccountId } from '@metamask/keyring-utils';\nimport type { AccountTreeControllerMessenger } from 'src';\n\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\n/**\n * Account group coming from the {@link AccountTreeController}.\n */\nexport type AccountTreeGroup = {\n  /**\n   * Account IDs for that account group.\n   */\n  getAccountIds(): AccountId[];\n\n  /**\n   * Gets the default name for that account group.\n   */\n  getDefaultName(): string;\n} & AccountGroup<InternalAccount>;\n\n// This class is meant to be used internally by every rules. It exposes mutable operations\n// which should not leak outside of this package.\nexport class MutableAccountTreeGroup implements AccountTreeGroup {\n  readonly id: AccountGroupId;\n\n  readonly wallet: AccountWallet<InternalAccount>;\n\n  readonly messenger: AccountTreeControllerMessenger;\n\n  readonly #accounts: Set<AccountId>;\n\n  constructor(\n    messenger: AccountTreeControllerMessenger,\n    wallet: AccountWallet<InternalAccount>,\n    id: string,\n  ) {\n    this.id = toAccountGroupId(wallet.id, id);\n    this.wallet = wallet;\n    this.messenger = messenger;\n\n    this.#accounts = new Set();\n  }\n\n  getAccountIds(): AccountId[] {\n    return Array.from(this.#accounts); // FIXME: Should we force the copy here?\n  }\n\n  getAccounts(): InternalAccount[] {\n    const accounts = [];\n\n    for (const id of this.#accounts) {\n      const account = this.getAccount(id);\n\n      // FIXME: I'm really not sure we should skip those but... We could be\n      // \"de-sync\" with the AccountsController and might have some dangling\n      // account IDs.\n      if (!account) {\n        console.warn(`! Unable to get account: \"${id}\"`);\n        continue;\n      }\n      accounts.push(account);\n    }\n    return accounts;\n  }\n\n  getAccount(id: AccountId): InternalAccount | undefined {\n    return this.messenger.call('AccountsController:getAccount', id);\n  }\n\n  addAccount(account: InternalAccount) {\n    this.#accounts.add(account.id);\n  }\n\n  getDefaultName(): string {\n    return DEFAULT_ACCOUNT_GROUP_NAME;\n  }\n}\n"]}

package/dist/AccountTreeGroup.d.cts

@@ -1,24 +1,31 @@
-import { type AccountGroup, type AccountGroupId } from "@metamask/account-api";
+import { type AccountGroup, type AccountGroupId, type AccountWallet } from "@metamask/account-api";
 import type { InternalAccount } from "@metamask/keyring-internal-api";
-import type { AccountGroupObject, AccountTreeControllerMessenger, AccountTreeWallet } from "src";
+import type { AccountId } from "@metamask/keyring-utils";
+import type { AccountTreeControllerMessenger } from "src";
 export declare const DEFAULT_ACCOUNT_GROUP_NAME: string;
 /**
  * Account group coming from the {@link AccountTreeController}.
  */
-export declare class AccountTreeGroup implements AccountGroup<InternalAccount> {
+export type AccountTreeGroup = {
+    /**
+     * Account IDs for that account group.
+     */
+    getAccountIds(): AccountId[];
+    /**
+     * Gets the default name for that account group.
+     */
+    getDefaultName(): string;
+} & AccountGroup<InternalAccount>;
+export declare class MutableAccountTreeGroup implements AccountTreeGroup {
     #private;
-    constructor({ messenger, wallet, group, }: {
-        messenger: AccountTreeControllerMessenger;
-        wallet: AccountTreeWallet;
-        group: AccountGroupObject;
-    });
-    get id(): AccountGroupId;
-    get wallet(): AccountTreeWallet;
-    get name(): string;
-    getAccountIds(): InternalAccount['id'][];
-    getAccount(id: string): InternalAccount | undefined;
+    readonly id: AccountGroupId;
+    readonly wallet: AccountWallet<InternalAccount>;
+    readonly messenger: AccountTreeControllerMessenger;
+    constructor(messenger: AccountTreeControllerMessenger, wallet: AccountWallet<InternalAccount>, id: string);
+    getAccountIds(): AccountId[];
     getAccounts(): InternalAccount[];
-    getAnyAccount(): InternalAccount;
-    getOnlyAccount(): InternalAccount;
+    getAccount(id: AccountId): InternalAccount | undefined;
+    addAccount(account: InternalAccount): void;
+    getDefaultName(): string;
 }
 //# sourceMappingURL=AccountTreeGroup.d.cts.map

package/dist/AccountTreeGroup.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"AccountTreeGroup.d.cts","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,cAAc,EAAE,8BAA8B;AAC/E,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EACV,kBAAkB,EAClB,8BAA8B,EAC9B,iBAAiB,EAClB,YAAY;AAEb,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D;;GAEG;AACH,qBAAa,gBAAiB,YAAW,YAAY,CAAC,eAAe,CAAC;;gBAOxD,EACV,SAAS,EACT,MAAM,EACN,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,MAAM,EAAE,iBAAiB,CAAC;QAC1B,KAAK,EAAE,kBAAkB,CAAC;KAC3B;IAMD,IAAI,EAAE,IAAI,cAAc,CAEvB;IAED,IAAI,MAAM,IAAI,iBAAiB,CAE9B;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,aAAa,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE;IAIxC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAanD,WAAW,IAAI,eAAe,EAAE;IAIhC,aAAa,IAAI,eAAe;IAUhC,cAAc,IAAI,eAAe;CAYlC"}
+{"version":3,"file":"AccountTreeGroup.d.cts","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,aAAa,EACnB,8BAA8B;AAC/B,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AACzD,OAAO,KAAK,EAAE,8BAA8B,EAAE,YAAY;AAE1D,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,aAAa,IAAI,SAAS,EAAE,CAAC;IAE7B;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;CAC1B,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;AAIlC,qBAAa,uBAAwB,YAAW,gBAAgB;;IAC9D,QAAQ,CAAC,EAAE,EAAE,cAAc,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAEhD,QAAQ,CAAC,SAAS,EAAE,8BAA8B,CAAC;gBAKjD,SAAS,EAAE,8BAA8B,EACzC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,EACtC,EAAE,EAAE,MAAM;IASZ,aAAa,IAAI,SAAS,EAAE;IAI5B,WAAW,IAAI,eAAe,EAAE;IAkBhC,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,eAAe,GAAG,SAAS;IAItD,UAAU,CAAC,OAAO,EAAE,eAAe;IAInC,cAAc,IAAI,MAAM;CAGzB"}

package/dist/AccountTreeGroup.d.mts

@@ -1,24 +1,31 @@
-import { type AccountGroup, type AccountGroupId } from "@metamask/account-api";
+import { type AccountGroup, type AccountGroupId, type AccountWallet } from "@metamask/account-api";
 import type { InternalAccount } from "@metamask/keyring-internal-api";
-import type { AccountGroupObject, AccountTreeControllerMessenger, AccountTreeWallet } from "src";
+import type { AccountId } from "@metamask/keyring-utils";
+import type { AccountTreeControllerMessenger } from "src";
 export declare const DEFAULT_ACCOUNT_GROUP_NAME: string;
 /**
  * Account group coming from the {@link AccountTreeController}.
  */
-export declare class AccountTreeGroup implements AccountGroup<InternalAccount> {
+export type AccountTreeGroup = {
+    /**
+     * Account IDs for that account group.
+     */
+    getAccountIds(): AccountId[];
+    /**
+     * Gets the default name for that account group.
+     */
+    getDefaultName(): string;
+} & AccountGroup<InternalAccount>;
+export declare class MutableAccountTreeGroup implements AccountTreeGroup {
     #private;
-    constructor({ messenger, wallet, group, }: {
-        messenger: AccountTreeControllerMessenger;
-        wallet: AccountTreeWallet;
-        group: AccountGroupObject;
-    });
-    get id(): AccountGroupId;
-    get wallet(): AccountTreeWallet;
-    get name(): string;
-    getAccountIds(): InternalAccount['id'][];
-    getAccount(id: string): InternalAccount | undefined;
+    readonly id: AccountGroupId;
+    readonly wallet: AccountWallet<InternalAccount>;
+    readonly messenger: AccountTreeControllerMessenger;
+    constructor(messenger: AccountTreeControllerMessenger, wallet: AccountWallet<InternalAccount>, id: string);
+    getAccountIds(): AccountId[];
     getAccounts(): InternalAccount[];
-    getAnyAccount(): InternalAccount;
-    getOnlyAccount(): InternalAccount;
+    getAccount(id: AccountId): InternalAccount | undefined;
+    addAccount(account: InternalAccount): void;
+    getDefaultName(): string;
 }
 //# sourceMappingURL=AccountTreeGroup.d.mts.map

package/dist/AccountTreeGroup.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"AccountTreeGroup.d.mts","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,cAAc,EAAE,8BAA8B;AAC/E,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EACV,kBAAkB,EAClB,8BAA8B,EAC9B,iBAAiB,EAClB,YAAY;AAEb,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D;;GAEG;AACH,qBAAa,gBAAiB,YAAW,YAAY,CAAC,eAAe,CAAC;;gBAOxD,EACV,SAAS,EACT,MAAM,EACN,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,MAAM,EAAE,iBAAiB,CAAC;QAC1B,KAAK,EAAE,kBAAkB,CAAC;KAC3B;IAMD,IAAI,EAAE,IAAI,cAAc,CAEvB;IAED,IAAI,MAAM,IAAI,iBAAiB,CAE9B;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,aAAa,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE;IAIxC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAanD,WAAW,IAAI,eAAe,EAAE;IAIhC,aAAa,IAAI,eAAe;IAUhC,cAAc,IAAI,eAAe;CAYlC"}
+{"version":3,"file":"AccountTreeGroup.d.mts","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,aAAa,EACnB,8BAA8B;AAC/B,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AACzD,OAAO,KAAK,EAAE,8BAA8B,EAAE,YAAY;AAE1D,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,aAAa,IAAI,SAAS,EAAE,CAAC;IAE7B;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;CAC1B,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;AAIlC,qBAAa,uBAAwB,YAAW,gBAAgB;;IAC9D,QAAQ,CAAC,EAAE,EAAE,cAAc,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAEhD,QAAQ,CAAC,SAAS,EAAE,8BAA8B,CAAC;gBAKjD,SAAS,EAAE,8BAA8B,EACzC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,EACtC,EAAE,EAAE,MAAM;IASZ,aAAa,IAAI,SAAS,EAAE;IAI5B,WAAW,IAAI,eAAe,EAAE;IAkBhC,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,eAAe,GAAG,SAAS;IAItD,UAAU,CAAC,OAAO,EAAE,eAAe;IAInC,cAAc,IAAI,MAAM;CAGzB"}

package/dist/AccountTreeGroup.mjs

@@ -9,62 +9,46 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _AccountTreeGroup_instances, _AccountTreeGroup_messenger, _AccountTreeGroup_group, _AccountTreeGroup_wallet, _AccountTreeGroup_getAccount;
+var _MutableAccountTreeGroup_accounts;
+import { toAccountGroupId } from "@metamask/account-api";
 export const DEFAULT_ACCOUNT_GROUP_NAME = 'Default';
-/**
- * Account group coming from the {@link AccountTreeController}.
- */
-export class AccountTreeGroup {
-    constructor({ messenger, wallet, group, }) {
-        _AccountTreeGroup_instances.add(this);
-        _AccountTreeGroup_messenger.set(this, void 0);
-        _AccountTreeGroup_group.set(this, void 0);
-        _AccountTreeGroup_wallet.set(this, void 0);
-        __classPrivateFieldSet(this, _AccountTreeGroup_messenger, messenger, "f");
-        __classPrivateFieldSet(this, _AccountTreeGroup_group, group, "f");
-        __classPrivateFieldSet(this, _AccountTreeGroup_wallet, wallet, "f");
-    }
-    get id() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_group, "f").id;
-    }
-    get wallet() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_wallet, "f");
-    }
-    get name() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_group, "f").metadata.name;
+// This class is meant to be used internally by every rules. It exposes mutable operations
+// which should not leak outside of this package.
+export class MutableAccountTreeGroup {
+    constructor(messenger, wallet, id) {
+        _MutableAccountTreeGroup_accounts.set(this, void 0);
+        this.id = toAccountGroupId(wallet.id, id);
+        this.wallet = wallet;
+        this.messenger = messenger;
+        __classPrivateFieldSet(this, _MutableAccountTreeGroup_accounts, new Set(), "f");
     }
     getAccountIds() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_group, "f").accounts;
-    }
-    getAccount(id) {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_messenger, "f").call('AccountsController:getAccount', id);
+        return Array.from(__classPrivateFieldGet(this, _MutableAccountTreeGroup_accounts, "f")); // FIXME: Should we force the copy here?
     }
     getAccounts() {
-        return __classPrivateFieldGet(this, _AccountTreeGroup_group, "f").accounts.map((id) => __classPrivateFieldGet(this, _AccountTreeGroup_instances, "m", _AccountTreeGroup_getAccount).call(this, id));
-    }
-    getAnyAccount() {
-        const accountIds = this.getAccountIds();
-        if (accountIds.length === 0) {
-            throw new Error('Group contains no account');
+        const accounts = [];
+        for (const id of __classPrivateFieldGet(this, _MutableAccountTreeGroup_accounts, "f")) {
+            const account = this.getAccount(id);
+            // FIXME: I'm really not sure we should skip those but... We could be
+            // "de-sync" with the AccountsController and might have some dangling
+            // account IDs.
+            if (!account) {
+                console.warn(`! Unable to get account: "${id}"`);
+                continue;
+            }
+            accounts.push(account);
         }
-        return __classPrivateFieldGet(this, _AccountTreeGroup_instances, "m", _AccountTreeGroup_getAccount).call(this, accountIds[0]);
+        return accounts;
     }
-    getOnlyAccount() {
-        const accountIds = this.getAccountIds();
-        if (accountIds.length === 0) {
-            throw new Error('Group contains no account');
-        }
-        if (accountIds.length > 1) {
-            throw new Error('Group contains more than 1 account');
-        }
-        return __classPrivateFieldGet(this, _AccountTreeGroup_instances, "m", _AccountTreeGroup_getAccount).call(this, accountIds[0]);
+    getAccount(id) {
+        return this.messenger.call('AccountsController:getAccount', id);
     }
-}
-_AccountTreeGroup_messenger = new WeakMap(), _AccountTreeGroup_group = new WeakMap(), _AccountTreeGroup_wallet = new WeakMap(), _AccountTreeGroup_instances = new WeakSet(), _AccountTreeGroup_getAccount = function _AccountTreeGroup_getAccount(id) {
-    const account = this.getAccount(id);
-    if (!account) {
-        throw new Error(`Unable to get account with ID: "${id}"`);
+    addAccount(account) {
+        __classPrivateFieldGet(this, _MutableAccountTreeGroup_accounts, "f").add(account.id);
     }
-    return account;
-};
+    getDefaultName() {
+        return DEFAULT_ACCOUNT_GROUP_NAME;
+    }
+}
+_MutableAccountTreeGroup_accounts = new WeakMap();
 //# sourceMappingURL=AccountTreeGroup.mjs.map

package/dist/AccountTreeGroup.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"AccountTreeGroup.mjs","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":";;;;;;;;;;;;AAQA,MAAM,CAAC,MAAM,0BAA0B,GAAW,SAAS,CAAC;AAE5D;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAO3B,YAAY,EACV,SAAS,EACT,MAAM,EACN,KAAK,GAKN;;QAdQ,8CAA2C;QAE3C,0CAA2B;QAE3B,2CAA2B;QAWlC,uBAAA,IAAI,+BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,2BAAU,KAAK,MAAA,CAAC;QACpB,uBAAA,IAAI,4BAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,uBAAA,IAAI,+BAAO,CAAC,EAAE,CAAC;IACxB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,uBAAA,IAAI,gCAAQ,CAAC;IACtB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,+BAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;IACnC,CAAC;IAED,aAAa;QACX,OAAO,uBAAA,IAAI,+BAAO,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,UAAU,CAAC,EAAU;QACnB,OAAO,uBAAA,IAAI,mCAAW,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;IACnE,CAAC;IAWD,WAAW;QACT,OAAO,uBAAA,IAAI,+BAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,uBAAA,IAAI,iEAAY,MAAhB,IAAI,EAAa,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,aAAa;QACX,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAExC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QAED,OAAO,uBAAA,IAAI,iEAAY,MAAhB,IAAI,EAAa,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,cAAc;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAExC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QACD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QAED,OAAO,uBAAA,IAAI,iEAAY,MAAhB,IAAI,EAAa,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;CACF;kPAnCa,EAAU;IACpB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAEpC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,CAAC;KAC3D;IACD,OAAO,OAAO,CAAC;AACjB,CAAC","sourcesContent":["import { type AccountGroup, type AccountGroupId } from '@metamask/account-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type {\n  AccountGroupObject,\n  AccountTreeControllerMessenger,\n  AccountTreeWallet,\n} from 'src';\n\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\n/**\n * Account group coming from the {@link AccountTreeController}.\n */\nexport class AccountTreeGroup implements AccountGroup<InternalAccount> {\n  readonly #messenger: AccountTreeControllerMessenger;\n\n  readonly #group: AccountGroupObject;\n\n  readonly #wallet: AccountTreeWallet;\n\n  constructor({\n    messenger,\n    wallet,\n    group,\n  }: {\n    messenger: AccountTreeControllerMessenger;\n    wallet: AccountTreeWallet;\n    group: AccountGroupObject;\n  }) {\n    this.#messenger = messenger;\n    this.#group = group;\n    this.#wallet = wallet;\n  }\n\n  get id(): AccountGroupId {\n    return this.#group.id;\n  }\n\n  get wallet(): AccountTreeWallet {\n    return this.#wallet;\n  }\n\n  get name(): string {\n    return this.#group.metadata.name;\n  }\n\n  getAccountIds(): InternalAccount['id'][] {\n    return this.#group.accounts;\n  }\n\n  getAccount(id: string): InternalAccount | undefined {\n    return this.#messenger.call('AccountsController:getAccount', id);\n  }\n\n  #getAccount(id: string): InternalAccount {\n    const account = this.getAccount(id);\n\n    if (!account) {\n      throw new Error(`Unable to get account with ID: \"${id}\"`);\n    }\n    return account;\n  }\n\n  getAccounts(): InternalAccount[] {\n    return this.#group.accounts.map((id) => this.#getAccount(id));\n  }\n\n  getAnyAccount(): InternalAccount {\n    const accountIds = this.getAccountIds();\n\n    if (accountIds.length === 0) {\n      throw new Error('Group contains no account');\n    }\n\n    return this.#getAccount(accountIds[0]);\n  }\n\n  getOnlyAccount(): InternalAccount {\n    const accountIds = this.getAccountIds();\n\n    if (accountIds.length === 0) {\n      throw new Error('Group contains no account');\n    }\n    if (accountIds.length > 1) {\n      throw new Error('Group contains more than 1 account');\n    }\n\n    return this.#getAccount(accountIds[0]);\n  }\n}\n"]}
+{"version":3,"file":"AccountTreeGroup.mjs","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,gBAAgB,EAIjB,8BAA8B;AAK/B,MAAM,CAAC,MAAM,0BAA0B,GAAW,SAAS,CAAC;AAiB5D,0FAA0F;AAC1F,iDAAiD;AACjD,MAAM,OAAO,uBAAuB;IASlC,YACE,SAAyC,EACzC,MAAsC,EACtC,EAAU;QALH,oDAA0B;QAOjC,IAAI,CAAC,EAAE,GAAG,gBAAgB,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,qCAAa,IAAI,GAAG,EAAE,MAAA,CAAC;IAC7B,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,yCAAU,CAAC,CAAC,CAAC,wCAAwC;IAC7E,CAAC;IAED,WAAW;QACT,MAAM,QAAQ,GAAG,EAAE,CAAC;QAEpB,KAAK,MAAM,EAAE,IAAI,uBAAA,IAAI,yCAAU,EAAE;YAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAEpC,qEAAqE;YACrE,qEAAqE;YACrE,eAAe;YACf,IAAI,CAAC,OAAO,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;gBACjD,SAAS;aACV;YACD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,UAAU,CAAC,EAAa;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,UAAU,CAAC,OAAwB;QACjC,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,cAAc;QACZ,OAAO,0BAA0B,CAAC;IACpC,CAAC;CACF","sourcesContent":["import {\n  toAccountGroupId,\n  type AccountGroup,\n  type AccountGroupId,\n  type AccountWallet,\n} from '@metamask/account-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { AccountId } from '@metamask/keyring-utils';\nimport type { AccountTreeControllerMessenger } from 'src';\n\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\n/**\n * Account group coming from the {@link AccountTreeController}.\n */\nexport type AccountTreeGroup = {\n  /**\n   * Account IDs for that account group.\n   */\n  getAccountIds(): AccountId[];\n\n  /**\n   * Gets the default name for that account group.\n   */\n  getDefaultName(): string;\n} & AccountGroup<InternalAccount>;\n\n// This class is meant to be used internally by every rules. It exposes mutable operations\n// which should not leak outside of this package.\nexport class MutableAccountTreeGroup implements AccountTreeGroup {\n  readonly id: AccountGroupId;\n\n  readonly wallet: AccountWallet<InternalAccount>;\n\n  readonly messenger: AccountTreeControllerMessenger;\n\n  readonly #accounts: Set<AccountId>;\n\n  constructor(\n    messenger: AccountTreeControllerMessenger,\n    wallet: AccountWallet<InternalAccount>,\n    id: string,\n  ) {\n    this.id = toAccountGroupId(wallet.id, id);\n    this.wallet = wallet;\n    this.messenger = messenger;\n\n    this.#accounts = new Set();\n  }\n\n  getAccountIds(): AccountId[] {\n    return Array.from(this.#accounts); // FIXME: Should we force the copy here?\n  }\n\n  getAccounts(): InternalAccount[] {\n    const accounts = [];\n\n    for (const id of this.#accounts) {\n      const account = this.getAccount(id);\n\n      // FIXME: I'm really not sure we should skip those but... We could be\n      // \"de-sync\" with the AccountsController and might have some dangling\n      // account IDs.\n      if (!account) {\n        console.warn(`! Unable to get account: \"${id}\"`);\n        continue;\n      }\n      accounts.push(account);\n    }\n    return accounts;\n  }\n\n  getAccount(id: AccountId): InternalAccount | undefined {\n    return this.messenger.call('AccountsController:getAccount', id);\n  }\n\n  addAccount(account: InternalAccount) {\n    this.#accounts.add(account.id);\n  }\n\n  getDefaultName(): string {\n    return DEFAULT_ACCOUNT_GROUP_NAME;\n  }\n}\n"]}

package/dist/AccountTreeWallet.cjs

@@ -10,75 +10,41 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _AccountTreeWallet_messenger, _AccountTreeWallet_wallet, _AccountTreeWallet_groups;
+var _MutableAccountTreeWallet_groups;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AccountTreeWallet = void 0;
+exports.MutableAccountTreeWallet = void 0;
+const account_api_1 = require("@metamask/account-api");
 const AccountTreeGroup_1 = require("./AccountTreeGroup.cjs");
-/**
- * Account wallet coming from the {@link AccountTreeController}.
- */
-class AccountTreeWallet {
-    constructor({ messenger, wallet, }) {
-        _AccountTreeWallet_messenger.set(this, void 0);
-        _AccountTreeWallet_wallet.set(this, void 0);
-        _AccountTreeWallet_groups.set(this, void 0);
-        __classPrivateFieldSet(this, _AccountTreeWallet_messenger, messenger, "f");
-        __classPrivateFieldSet(this, _AccountTreeWallet_wallet, wallet, "f");
-        __classPrivateFieldSet(this, _AccountTreeWallet_groups, new Map(), "f");
-        for (const [groupId, group] of Object.entries(__classPrivateFieldGet(this, _AccountTreeWallet_wallet, "f").groups)) {
-            __classPrivateFieldGet(this, _AccountTreeWallet_groups, "f").set(groupId, new AccountTreeGroup_1.AccountTreeGroup({
-                messenger: __classPrivateFieldGet(this, _AccountTreeWallet_messenger, "f"),
-                wallet: this,
-                group,
-            }));
-        }
-    }
-    get id() {
-        return __classPrivateFieldGet(this, _AccountTreeWallet_wallet, "f").id;
-    }
-    get category() {
-        return __classPrivateFieldGet(this, _AccountTreeWallet_wallet, "f").category;
-    }
-    get name() {
-        return __classPrivateFieldGet(this, _AccountTreeWallet_wallet, "f").metadata.name;
+// This class is meant to be used internally by every rules. It exposes mutable operations
+// which should not leak outside of this package.
+class MutableAccountTreeWallet {
+    constructor(messenger, category, id) {
+        _MutableAccountTreeWallet_groups.set(this, void 0);
+        this.id = (0, account_api_1.toAccountWalletId)(category, id);
+        this.category = category;
+        this.messenger = messenger;
+        __classPrivateFieldSet(this, _MutableAccountTreeWallet_groups, new Map(), "f");
     }
-    /**
-     * Gets account tree group for a given ID.
-     *
-     * @param groupId - Group ID.
-     * @returns Account tree group.
-     */
     getAccountGroup(groupId) {
-        return __classPrivateFieldGet(this, _AccountTreeWallet_groups, "f").get(groupId);
+        return __classPrivateFieldGet(this, _MutableAccountTreeWallet_groups, "f").get(groupId);
     }
-    /**
-     * Gets all account tree groups.
-     *
-     * @returns Account tree groups.
-     */
     getAccountGroups() {
-        return Array.from(__classPrivateFieldGet(this, _AccountTreeWallet_groups, "f").values());
+        return Array.from(__classPrivateFieldGet(this, _MutableAccountTreeWallet_groups, "f").values()); // TODO: Should we avoid the copy here?
     }
-    /**
-     * Gets any underlying account.
-     *
-     * This can be useful if the accounts from this wallet have been grouped some
-     * common criteria, so you expect some commonly defined information on any of
-     * those accounts.
-     *
-     * @throws If the wallet has no account group (which should not be possible).
-     * @returns Any account that share the same information based on the grouping
-     * rule that has been used.
-     */
-    getAnyAccount() {
-        if (__classPrivateFieldGet(this, _AccountTreeWallet_groups, "f").size === 0) {
-            throw new Error('Wallet contains no account group');
+    // NOTE: This method SHOULD BE overriden if a rule need to group things differently.
+    addAccount(account) {
+        const id = account_api_1.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID;
+        // Use a single-group by default.
+        let group = __classPrivateFieldGet(this, _MutableAccountTreeWallet_groups, "f").get((0, account_api_1.toAccountGroupId)(this.id, id));
+        if (!group) {
+            // We create the account group and attach it to this wallet.
+            group = new AccountTreeGroup_1.MutableAccountTreeGroup(this.messenger, this, id);
+            __classPrivateFieldGet(this, _MutableAccountTreeWallet_groups, "f").set(group.id, group);
         }
-        // It cannot be `undefined`, we checked the size before.
-        const group = __classPrivateFieldGet(this, _AccountTreeWallet_groups, "f").values().next().value;
-        return group.getAnyAccount();
+        group.addAccount(account);
+        return group;
     }
 }
-exports.AccountTreeWallet = AccountTreeWallet;
-_AccountTreeWallet_messenger = new WeakMap(), _AccountTreeWallet_wallet = new WeakMap(), _AccountTreeWallet_groups = new WeakMap();
+exports.MutableAccountTreeWallet = MutableAccountTreeWallet;
+_MutableAccountTreeWallet_groups = new WeakMap();
 //# sourceMappingURL=AccountTreeWallet.cjs.map

package/dist/AccountTreeWallet.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"AccountTreeWallet.cjs","sourceRoot":"","sources":["../src/AccountTreeWallet.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AASA,6DAAsD;AAEtD;;GAEG;AACH,MAAa,iBAAiB;IAO5B,YAAY,EACV,SAAS,EACT,MAAM,GAIP;QAZQ,+CAA2C;QAE3C,4CAA6B;QAE7B,4CAA+C;QAStD,uBAAA,IAAI,gCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,6BAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,6BAAW,IAAI,GAAG,EAAE,MAAA,CAAC;QAEzB,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,uBAAA,IAAI,iCAAQ,CAAC,MAAM,CAAC,EAAE;YAClE,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CACd,OAAyB,EACzB,IAAI,mCAAgB,CAAC;gBACnB,SAAS,EAAE,uBAAA,IAAI,oCAAW;gBAC1B,MAAM,EAAE,IAAI;gBACZ,KAAK;aACN,CAAC,CACH,CAAC;SACH;IACH,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,uBAAA,IAAI,iCAAQ,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,uBAAA,IAAI,iCAAQ,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,iCAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,OAAuB;QACrC,OAAO,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,iCAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa;QACX,IAAI,uBAAA,IAAI,iCAAQ,CAAC,IAAI,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACrD;QAED,wDAAwD;QACxD,MAAM,KAAK,GAAG,uBAAA,IAAI,iCAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAyB,CAAC;QACrE,OAAO,KAAK,CAAC,aAAa,EAAE,CAAC;IAC/B,CAAC;CACF;AAjFD,8CAiFC","sourcesContent":["import type {\n  AccountWalletCategory,\n  AccountWalletId,\n} from '@metamask/account-api';\nimport { type AccountGroupId, type AccountWallet } from '@metamask/account-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport type { AccountWalletObject } from './AccountTreeController';\nimport { type AccountTreeControllerMessenger } from './AccountTreeController';\nimport { AccountTreeGroup } from './AccountTreeGroup';\n\n/**\n * Account wallet coming from the {@link AccountTreeController}.\n */\nexport class AccountTreeWallet implements AccountWallet<InternalAccount> {\n  readonly #messenger: AccountTreeControllerMessenger;\n\n  readonly #wallet: AccountWalletObject;\n\n  readonly #groups: Map<AccountGroupId, AccountTreeGroup>;\n\n  constructor({\n    messenger,\n    wallet,\n  }: {\n    messenger: AccountTreeControllerMessenger;\n    wallet: AccountWalletObject;\n  }) {\n    this.#messenger = messenger;\n    this.#wallet = wallet;\n    this.#groups = new Map();\n\n    for (const [groupId, group] of Object.entries(this.#wallet.groups)) {\n      this.#groups.set(\n        groupId as AccountGroupId,\n        new AccountTreeGroup({\n          messenger: this.#messenger,\n          wallet: this,\n          group,\n        }),\n      );\n    }\n  }\n\n  get id(): AccountWalletId {\n    return this.#wallet.id;\n  }\n\n  get category(): AccountWalletCategory {\n    return this.#wallet.category;\n  }\n\n  get name(): string {\n    return this.#wallet.metadata.name;\n  }\n\n  /**\n   * Gets account tree group for a given ID.\n   *\n   * @param groupId - Group ID.\n   * @returns Account tree group.\n   */\n  getAccountGroup(groupId: AccountGroupId): AccountTreeGroup | undefined {\n    return this.#groups.get(groupId);\n  }\n\n  /**\n   * Gets all account tree groups.\n   *\n   * @returns Account tree groups.\n   */\n  getAccountGroups(): AccountTreeGroup[] {\n    return Array.from(this.#groups.values());\n  }\n\n  /**\n   * Gets any underlying account.\n   *\n   * This can be useful if the accounts from this wallet have been grouped some\n   * common criteria, so you expect some commonly defined information on any of\n   * those accounts.\n   *\n   * @throws If the wallet has no account group (which should not be possible).\n   * @returns Any account that share the same information based on the grouping\n   * rule that has been used.\n   */\n  getAnyAccount(): InternalAccount {\n    if (this.#groups.size === 0) {\n      throw new Error('Wallet contains no account group');\n    }\n\n    // It cannot be `undefined`, we checked the size before.\n    const group = this.#groups.values().next().value as AccountTreeGroup;\n    return group.getAnyAccount();\n  }\n}\n"]}
+{"version":3,"file":"AccountTreeWallet.cjs","sourceRoot":"","sources":["../src/AccountTreeWallet.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAQ+B;AAK/B,6DAA6D;AA0B7D,0FAA0F;AAC1F,iDAAiD;AACjD,MAAsB,wBAAwB;IAS5C,YACE,SAAyC,EACzC,QAA+B,EAC/B,EAAU;QALH,mDAAsD;QAO7D,IAAI,CAAC,EAAE,GAAG,IAAA,+BAAiB,EAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,oCAAW,IAAI,GAAG,EAAE,MAAA,CAAC;IAC3B,CAAC;IAED,eAAe,CAAC,OAAuB;QACrC,OAAO,uBAAA,IAAI,wCAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,gBAAgB;QACd,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,wCAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,uCAAuC;IACnF,CAAC;IAED,oFAAoF;IACpF,UAAU,CAAC,OAAwB;QACjC,MAAM,EAAE,GAAG,6CAA+B,CAAC;QAE3C,iCAAiC;QACjC,IAAI,KAAK,GAAG,uBAAA,IAAI,wCAAQ,CAAC,GAAG,CAAC,IAAA,8BAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,EAAE;YACV,4DAA4D;YAC5D,KAAK,GAAG,IAAI,0CAAuB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YAC9D,uBAAA,IAAI,wCAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACnC;QAED,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE1B,OAAO,KAAK,CAAC;IACf,CAAC;CAGF;AA/CD,4DA+CC","sourcesContent":["import {\n  toAccountGroupId,\n  toAccountWalletId,\n  DEFAULT_ACCOUNT_GROUP_UNIQUE_ID,\n  type AccountGroupId,\n  type AccountWallet,\n  type AccountWalletCategory,\n  type AccountWalletId,\n} from '@metamask/account-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport { type AccountTreeControllerMessenger } from './AccountTreeController';\nimport type { AccountTreeGroup } from './AccountTreeGroup';\nimport { MutableAccountTreeGroup } from './AccountTreeGroup';\n\n/**\n * Account wallet coming from the {@link AccountTreeController}.\n */\nexport type AccountTreeWallet = {\n  /**\n   * Gets account tree group for a given ID.\n   *\n   * @returns Account tree group.\n   */\n  getAccountGroup(groupId: AccountGroupId): AccountTreeGroup | undefined;\n\n  /**\n   * Gets all account tree groups.\n   *\n   * @returns Account tree groups.\n   */\n  getAccountGroups(): AccountTreeGroup[];\n\n  /**\n   * Gets the default name for that account wallet.\n   */\n  getDefaultName(): string;\n} & AccountWallet<InternalAccount>;\n\n// This class is meant to be used internally by every rules. It exposes mutable operations\n// which should not leak outside of this package.\nexport abstract class MutableAccountTreeWallet implements AccountTreeWallet {\n  readonly id: AccountWalletId;\n\n  readonly category: AccountWalletCategory;\n\n  readonly messenger: AccountTreeControllerMessenger;\n\n  readonly #groups: Map<AccountGroupId, MutableAccountTreeGroup>;\n\n  constructor(\n    messenger: AccountTreeControllerMessenger,\n    category: AccountWalletCategory,\n    id: string,\n  ) {\n    this.id = toAccountWalletId(category, id);\n    this.category = category;\n    this.messenger = messenger;\n\n    this.#groups = new Map();\n  }\n\n  getAccountGroup(groupId: AccountGroupId): AccountTreeGroup | undefined {\n    return this.#groups.get(groupId);\n  }\n\n  getAccountGroups(): AccountTreeGroup[] {\n    return Array.from(this.#groups.values()); // TODO: Should we avoid the copy here?\n  }\n\n  // NOTE: This method SHOULD BE overriden if a rule need to group things differently.\n  addAccount(account: InternalAccount): MutableAccountTreeGroup {\n    const id = DEFAULT_ACCOUNT_GROUP_UNIQUE_ID;\n\n    // Use a single-group by default.\n    let group = this.#groups.get(toAccountGroupId(this.id, id));\n    if (!group) {\n      // We create the account group and attach it to this wallet.\n      group = new MutableAccountTreeGroup(this.messenger, this, id);\n      this.#groups.set(group.id, group);\n    }\n\n    group.addAccount(account);\n\n    return group;\n  }\n\n  abstract getDefaultName(): string;\n}\n"]}

package/dist/AccountTreeWallet.d.cts

@@ -1,25 +1,15 @@
-import type { AccountWalletCategory, AccountWalletId } from "@metamask/account-api";
-import { type AccountGroupId, type AccountWallet } from "@metamask/account-api";
+import { type AccountGroupId, type AccountWallet, type AccountWalletCategory, type AccountWalletId } from "@metamask/account-api";
 import type { InternalAccount } from "@metamask/keyring-internal-api";
-import type { AccountWalletObject } from "./AccountTreeController.cjs";
 import { type AccountTreeControllerMessenger } from "./AccountTreeController.cjs";
-import { AccountTreeGroup } from "./AccountTreeGroup.cjs";
+import type { AccountTreeGroup } from "./AccountTreeGroup.cjs";
+import { MutableAccountTreeGroup } from "./AccountTreeGroup.cjs";
 /**
  * Account wallet coming from the {@link AccountTreeController}.
  */
-export declare class AccountTreeWallet implements AccountWallet<InternalAccount> {
-    #private;
-    constructor({ messenger, wallet, }: {
-        messenger: AccountTreeControllerMessenger;
-        wallet: AccountWalletObject;
-    });
-    get id(): AccountWalletId;
-    get category(): AccountWalletCategory;
-    get name(): string;
+export type AccountTreeWallet = {
     /**
      * Gets account tree group for a given ID.
      *
-     * @param groupId - Group ID.
      * @returns Account tree group.
      */
     getAccountGroup(groupId: AccountGroupId): AccountTreeGroup | undefined;
@@ -30,16 +20,19 @@ export declare class AccountTreeWallet implements AccountWallet<InternalAccount>
      */
     getAccountGroups(): AccountTreeGroup[];
     /**
-     * Gets any underlying account.
-     *
-     * This can be useful if the accounts from this wallet have been grouped some
-     * common criteria, so you expect some commonly defined information on any of
-     * those accounts.
-     *
-     * @throws If the wallet has no account group (which should not be possible).
-     * @returns Any account that share the same information based on the grouping
-     * rule that has been used.
+     * Gets the default name for that account wallet.
      */
-    getAnyAccount(): InternalAccount;
+    getDefaultName(): string;
+} & AccountWallet<InternalAccount>;
+export declare abstract class MutableAccountTreeWallet implements AccountTreeWallet {
+    #private;
+    readonly id: AccountWalletId;
+    readonly category: AccountWalletCategory;
+    readonly messenger: AccountTreeControllerMessenger;
+    constructor(messenger: AccountTreeControllerMessenger, category: AccountWalletCategory, id: string);
+    getAccountGroup(groupId: AccountGroupId): AccountTreeGroup | undefined;
+    getAccountGroups(): AccountTreeGroup[];
+    addAccount(account: InternalAccount): MutableAccountTreeGroup;
+    abstract getDefaultName(): string;
 }
 //# sourceMappingURL=AccountTreeWallet.d.cts.map

package/dist/AccountTreeWallet.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"AccountTreeWallet.d.cts","sourceRoot":"","sources":["../src/AccountTreeWallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,eAAe,EAChB,8BAA8B;AAC/B,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAChF,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAEtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAgC;AACnE,OAAO,EAAE,KAAK,8BAA8B,EAAE,oCAAgC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,+BAA2B;AAEtD;;GAEG;AACH,qBAAa,iBAAkB,YAAW,aAAa,CAAC,eAAe,CAAC;;gBAO1D,EACV,SAAS,EACT,MAAM,GACP,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,MAAM,EAAE,mBAAmB,CAAC;KAC7B;IAiBD,IAAI,EAAE,IAAI,eAAe,CAExB;IAED,IAAI,QAAQ,IAAI,qBAAqB,CAEpC;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACH,eAAe,CAAC,OAAO,EAAE,cAAc,GAAG,gBAAgB,GAAG,SAAS;IAItE;;;;OAIG;IACH,gBAAgB,IAAI,gBAAgB,EAAE;IAItC;;;;;;;;;;OAUG;IACH,aAAa,IAAI,eAAe;CASjC"}
+{"version":3,"file":"AccountTreeWallet.d.cts","sourceRoot":"","sources":["../src/AccountTreeWallet.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACrB,8BAA8B;AAC/B,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAEtE,OAAO,EAAE,KAAK,8BAA8B,EAAE,oCAAgC;AAC9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA2B;AAC3D,OAAO,EAAE,uBAAuB,EAAE,+BAA2B;AAE7D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,cAAc,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;IAEvC;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;CAC1B,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC;AAInC,8BAAsB,wBAAyB,YAAW,iBAAiB;;IACzE,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAC;IAE7B,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAAC;IAEzC,QAAQ,CAAC,SAAS,EAAE,8BAA8B,CAAC;gBAKjD,SAAS,EAAE,8BAA8B,EACzC,QAAQ,EAAE,qBAAqB,EAC/B,EAAE,EAAE,MAAM;IASZ,eAAe,CAAC,OAAO,EAAE,cAAc,GAAG,gBAAgB,GAAG,SAAS;IAItE,gBAAgB,IAAI,gBAAgB,EAAE;IAKtC,UAAU,CAAC,OAAO,EAAE,eAAe,GAAG,uBAAuB;IAgB7D,QAAQ,CAAC,cAAc,IAAI,MAAM;CAClC"}