@metamask-previews/account-tree-controller 0.0.0-preview-d9a49231

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/account-tree-controller`
+
+Manages account wallets according to pre-defined grouping rules (entropy source, Snap IDs, keyring types) and organize wallets/groups of accounts in a tree structure.
+
+## Installation
+
+`yarn add @metamask/account-tree-controller`
+
+or
+
+`npm install @metamask/account-tree-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/AccountTreeController.cjs

@@ -0,0 +1,258 @@
+"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 _AccountTreeController_instances, _AccountTreeController_reverse, _AccountTreeController_rules, _AccountTreeController_handleAccountAdded, _AccountTreeController_handleAccountRemoved, _AccountTreeController_hasKeyringType, _AccountTreeController_matchGroupByEntropySource, _AccountTreeController_matchGroupBySnapId, _AccountTreeController_matchGroupByKeyringType, _AccountTreeController_getSnapName, _AccountTreeController_getEntropySourceName, _AccountTreeController_insert, _AccountTreeController_listAccounts;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountTreeController = exports.toDefaultAccountGroupId = exports.toAccountGroupId = exports.toAccountGroupRootId = exports.DEFAULT_ACCOUNT_GROUP_NAME = exports.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = exports.getDefaultAccountTreeControllerState = exports.AccountGroupRootCategory = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const keyring_controller_1 = require("@metamask/keyring-controller");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const names_1 = require("./names.cjs");
+const controllerName = 'AccountTreeController';
+var AccountGroupRootCategory;
+(function (AccountGroupRootCategory) {
+    AccountGroupRootCategory["Entropy"] = "entropy";
+    AccountGroupRootCategory["Snap"] = "snap";
+    AccountGroupRootCategory["Keyring"] = "keyring";
+    AccountGroupRootCategory["Default"] = "default";
+})(AccountGroupRootCategory || (exports.AccountGroupRootCategory = AccountGroupRootCategory = {}));
+const accountTreeControllerMetadata = {
+    accountTrees: {
+        persist: false,
+        anonymous: false,
+    },
+};
+/**
+ * Gets default state of the `AccountTreeController`.
+ *
+ * @returns The default state of the `AccountTreeController`.
+ */
+function getDefaultAccountTreeControllerState() {
+    return {
+        accountTrees: {
+            roots: {},
+        },
+    };
+}
+exports.getDefaultAccountTreeControllerState = getDefaultAccountTreeControllerState;
+// TODO: For now we use this for the 2nd-level of the tree until we implements proper multichain accounts.
+exports.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = 'default'; // This might need to be re-evaluated based on new structure
+exports.DEFAULT_ACCOUNT_GROUP_NAME = 'Default';
+/**
+ * Convert a unique ID to a group root ID for a given category.
+ *
+ * @param category - The category of the account group root.
+ * @param id - The unique ID.
+ * @returns The group root ID.
+ */
+function toAccountGroupRootId(category, id) {
+    return `${category}:${id}`;
+}
+exports.toAccountGroupRootId = toAccountGroupRootId;
+/**
+ * Convert a group root ID and a unique ID to a group ID.
+ *
+ * @param groupRootId - The group root ID.
+ * @param id - The unique ID.
+ * @returns The group ID.
+ */
+function toAccountGroupId(groupRootId, id) {
+    return `${groupRootId}:${id}`;
+}
+exports.toAccountGroupId = toAccountGroupId;
+/**
+ * Convert a group root ID to the default group ID.
+ *
+ * @param groupRootId - The group root ID.
+ * @returns The default group ID.
+ */
+function toDefaultAccountGroupId(groupRootId) {
+    return toAccountGroupId(groupRootId, exports.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID);
+}
+exports.toDefaultAccountGroupId = toDefaultAccountGroupId;
+class AccountTreeController extends base_controller_1.BaseController {
+    /**
+     * Constructor for AccountTreeController.
+     *
+     * @param options - The controller options.
+     * @param options.messenger - The messenger object.
+     * @param options.state - Initial state to set on this controller
+     */
+    constructor({ messenger, state, }) {
+        super({
+            messenger,
+            name: controllerName,
+            metadata: accountTreeControllerMetadata,
+            state: {
+                ...getDefaultAccountTreeControllerState(),
+                ...state,
+            },
+        });
+        _AccountTreeController_instances.add(this);
+        _AccountTreeController_reverse.set(this, void 0);
+        _AccountTreeController_rules.set(this, void 0);
+        // Reverse map to allow fast node access from an account ID.
+        __classPrivateFieldSet(this, _AccountTreeController_reverse, new Map(), "f");
+        // Rules to apply to construct the wallets tree.
+        __classPrivateFieldSet(this, _AccountTreeController_rules, [
+            // 1. We group by entropy-source
+            (account) => __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_matchGroupByEntropySource).call(this, account),
+            // 2. We group by Snap ID
+            (account) => __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_matchGroupBySnapId).call(this, account),
+            // 3. We group by wallet type (this rule cannot fail and will group all non-matching accounts)
+            (account) => __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_matchGroupByKeyringType).call(this, account),
+        ], "f");
+        this.messagingSystem.subscribe('AccountsController:accountAdded', (account) => {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleAccountAdded).call(this, account);
+        });
+        this.messagingSystem.subscribe('AccountsController:accountRemoved', (accountId) => {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleAccountRemoved).call(this, accountId);
+        });
+    }
+    init() {
+        const roots = {};
+        // For now, we always re-compute all wallets, we do not re-use the existing state.
+        for (const account of __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_listAccounts).call(this)) {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insert).call(this, roots, account);
+        }
+        this.update((state) => {
+            state.accountTrees.roots = roots;
+        });
+    }
+}
+exports.AccountTreeController = AccountTreeController;
+_AccountTreeController_reverse = new WeakMap(), _AccountTreeController_rules = new WeakMap(), _AccountTreeController_instances = new WeakSet(), _AccountTreeController_handleAccountAdded = function _AccountTreeController_handleAccountAdded(account) {
+    this.update((state) => {
+        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insert).call(this, state.accountTrees.roots, account);
+    });
+}, _AccountTreeController_handleAccountRemoved = function _AccountTreeController_handleAccountRemoved(accountId) {
+    const found = __classPrivateFieldGet(this, _AccountTreeController_reverse, "f").get(accountId);
+    if (found) {
+        const { walletId, groupId } = found;
+        this.update((state) => {
+            const { accounts } = state.accountTrees.roots[walletId].groups[groupId];
+            const index = accounts.indexOf(accountId);
+            if (index !== -1) {
+                accounts.splice(index, 1);
+            }
+        });
+    }
+}, _AccountTreeController_hasKeyringType = function _AccountTreeController_hasKeyringType(account, type) {
+    return account.metadata.keyring.type === type;
+}, _AccountTreeController_matchGroupByEntropySource = function _AccountTreeController_matchGroupByEntropySource(account) {
+    let entropySource;
+    if (__classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_hasKeyringType).call(this, account, keyring_controller_1.KeyringTypes.hd)) {
+        // TODO: Maybe use superstruct to validate the structure of HD account since they are not strongly-typed for now?
+        if (!account.options.entropySource) {
+            console.warn("! Found an HD account with no entropy source: account won't be associated to its wallet");
+            return undefined;
+        }
+        entropySource = account.options.entropySource;
+    }
+    // TODO: For now, we're not checking if the Snap is a preinstalled one, and we probably should...
+    if (__classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_hasKeyringType).call(this, account, keyring_controller_1.KeyringTypes.snap) &&
+        account.metadata.snap?.enabled) {
+        // Not all Snaps have an entropy-source and options are not typed yet, so we have to check manually here.
+        if (account.options.entropySource) {
+            // We blindly trust the `entropySource` for now, but it could be wrong since it comes from a Snap.
+            entropySource = account.options.entropySource;
+        }
+    }
+    if (!entropySource) {
+        return undefined;
+    }
+    // We check if we can get the name for that entropy source, if not this means this entropy does not match
+    // any HD keyrings, thus, is invalid (this account will be grouped by another rule).
+    const entropySourceName = __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getEntropySourceName).call(this, entropySource);
+    if (!entropySourceName) {
+        console.warn('! Tried to name a wallet using an unknown entropy, this should not be possible.');
+        return undefined;
+    }
+    return {
+        category: AccountGroupRootCategory.Entropy,
+        id: toAccountGroupRootId(AccountGroupRootCategory.Entropy, entropySource),
+        name: entropySourceName,
+    };
+}, _AccountTreeController_matchGroupBySnapId = function _AccountTreeController_matchGroupBySnapId(account) {
+    if (__classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_hasKeyringType).call(this, account, keyring_controller_1.KeyringTypes.snap) &&
+        account.metadata.snap &&
+        account.metadata.snap.enabled) {
+        const { id } = account.metadata.snap;
+        return {
+            category: AccountGroupRootCategory.Snap,
+            id: toAccountGroupRootId(AccountGroupRootCategory.Snap, id),
+            name: __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getSnapName).call(this, id),
+        };
+    }
+    return undefined;
+}, _AccountTreeController_matchGroupByKeyringType = function _AccountTreeController_matchGroupByKeyringType(account) {
+    const { type } = account.metadata.keyring;
+    return {
+        category: AccountGroupRootCategory.Keyring,
+        id: toAccountGroupRootId(AccountGroupRootCategory.Keyring, type),
+        name: (0, names_1.getAccountGroupRootNameFromKeyringType)(type),
+    };
+}, _AccountTreeController_getSnapName = function _AccountTreeController_getSnapName(snapId) {
+    const snap = this.messagingSystem.call('SnapController:get', snapId);
+    const snapName = snap
+        ? // TODO: Handle localization here, but that's a "client thing", so we don't have a `core` controller
+            // to refer too.
+            snap.manifest.proposedName
+        : (0, snaps_utils_1.stripSnapPrefix)(snapId);
+    return `Snap: ${snapName}`;
+}, _AccountTreeController_getEntropySourceName = function _AccountTreeController_getEntropySourceName(entropySource) {
+    const { keyrings } = this.messagingSystem.call('KeyringController:getState');
+    const index = keyrings
+        .filter((keyring) => keyring.type === keyring_controller_1.KeyringTypes.hd)
+        .findIndex((keyring) => keyring.metadata.id === entropySource);
+    if (index === -1) {
+        return undefined;
+    }
+    return `Wallet ${index + 1}`; // Use human indexing.
+}, _AccountTreeController_insert = function _AccountTreeController_insert(roots, account) {
+    for (const rule of __classPrivateFieldGet(this, _AccountTreeController_rules, "f")) {
+        const match = rule(account);
+        if (!match) {
+            // No match for that rule, we go to the next one.
+            continue;
+        }
+        const walletId = match.id;
+        const walletName = match.name;
+        const groupId = toDefaultAccountGroupId(walletId); // Use a single-group for now until multichain accounts is supported.
+        const groupName = exports.DEFAULT_ACCOUNT_GROUP_NAME;
+        if (!roots[walletId]) {
+            roots[walletId] = {
+                id: walletId,
+                groups: {
+                    [groupId]: {
+                        id: groupId,
+                        accounts: [],
+                        metadata: { name: groupName },
+                    },
+                },
+                metadata: {
+                    name: walletName,
+                },
+            };
+        }
+        roots[walletId].groups[groupId].accounts.push(account.id);
+        // Update the reverse mapping for this account.
+        __classPrivateFieldGet(this, _AccountTreeController_reverse, "f").set(account.id, {
+            walletId,
+            groupId,
+        });
+        return;
+    }
+}, _AccountTreeController_listAccounts = function _AccountTreeController_listAccounts() {
+    return this.messagingSystem.call('AccountsController:listMultichainAccounts');
+};
+//# sourceMappingURL=AccountTreeController.cjs.map

package/dist/AccountTreeController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeController.cjs","sourceRoot":"","sources":["../src/AccountTreeController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAOA,+DAKmC;AAEnC,qEAA4D;AAI5D,uDAAwD;AAExD,uCAAiE;AAEjE,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAE/C,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,+CAAmB,CAAA;IACnB,yCAAa,CAAA;IACb,+CAAmB,CAAA;IACnB,+CAAmB,CAAA;AACrB,CAAC,EALW,wBAAwB,wCAAxB,wBAAwB,QAKnC;AAqFD,MAAM,6BAA6B,GACjC;IACE,YAAY,EAAE;QACZ,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AAEJ;;;;GAIG;AACH,SAAgB,oCAAoC;IAClD,OAAO;QACL,YAAY,EAAE;YACZ,KAAK,EAAE,EAAE;SACV;KACF,CAAC;AACJ,CAAC;AAND,oFAMC;AAED,0GAA0G;AAC7F,QAAA,+BAA+B,GAAW,SAAS,CAAC,CAAC,4DAA4D;AACjH,QAAA,0BAA0B,GAAW,SAAS,CAAC;AAE5D;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAClC,QAAkC,EAClC,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,CAAC;AALD,oDAKC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,WAA+B,EAC/B,EAAU;IAEV,OAAO,GAAG,WAAW,IAAI,EAAE,EAAE,CAAC;AAChC,CAAC;AALD,4CAKC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,WAA+B;IAE/B,OAAO,gBAAgB,CAAC,WAAW,EAAE,uCAA+B,CAAC,CAAC;AACxE,CAAC;AAJD,0DAIC;AAED,MAAa,qBAAsB,SAAQ,gCAI1C;IAKC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,6BAA6B;YACvC,KAAK,EAAE;gBACL,GAAG,oCAAoC,EAAE;gBACzC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA1BI,iDAAgD;QAEhD,+CAAuC;QA0B9C,4DAA4D;QAC5D,uBAAA,IAAI,kCAAY,IAAI,GAAG,EAAE,MAAA,CAAC;QAE1B,gDAAgD;QAChD,uBAAA,IAAI,gCAAU;YACZ,gCAAgC;YAChC,CAAC,OAAwB,EAAE,EAAE,CAAC,uBAAA,IAAI,0FAA2B,MAA/B,IAAI,EAA4B,OAAO,CAAC;YACtE,yBAAyB;YACzB,CAAC,OAAwB,EAAE,EAAE,CAAC,uBAAA,IAAI,mFAAoB,MAAxB,IAAI,EAAqB,OAAO,CAAC;YAC/D,8FAA8F;YAC9F,CAAC,OAAwB,EAAE,EAAE,CAAC,uBAAA,IAAI,wFAAyB,MAA7B,IAAI,EAA0B,OAAO,CAAC;SACrE,MAAA,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,CAAC,OAAO,EAAE,EAAE;YACV,uBAAA,IAAI,mFAAoB,MAAxB,IAAI,EAAqB,OAAO,CAAC,CAAC;QACpC,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAC,SAAS,EAAE,EAAE;YACZ,uBAAA,IAAI,qFAAsB,MAA1B,IAAI,EAAuB,SAAS,CAAC,CAAC;QACxC,CAAC,CACF,CAAC;IACJ,CAAC;IAED,IAAI;QACF,MAAM,KAAK,GAAG,EAAE,CAAC;QAEjB,kFAAkF;QAClF,KAAK,MAAM,OAAO,IAAI,uBAAA,IAAI,6EAAc,MAAlB,IAAI,CAAgB,EAAE;YAC1C,uBAAA,IAAI,uEAAQ,MAAZ,IAAI,EAAS,KAAK,EAAE,OAAO,CAAC,CAAC;SAC9B;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;CA0LF;AAlQD,sDAkQC;+OAxLqB,OAAwB;IAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,uBAAA,IAAI,uEAAQ,MAAZ,IAAI,EAAS,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACL,CAAC,qGAEqB,SAAoB;IACxC,MAAM,KAAK,GAAG,uBAAA,IAAI,sCAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAE3C,IAAI,KAAK,EAAE;QACT,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAExE,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC1C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gBAChB,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;KACJ;AACH,CAAC,yFAEe,OAAwB,EAAE,IAAkB;IAC1D,OAAO,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAM,IAAe,CAAC;AAC5D,CAAC,+GAGC,OAAwB;IAExB,IAAI,aAAiC,CAAC;IAEtC,IAAI,uBAAA,IAAI,+EAAgB,MAApB,IAAI,EAAiB,OAAO,EAAE,iCAAY,CAAC,EAAE,CAAC,EAAE;QAClD,iHAAiH;QACjH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;YAClC,OAAO,CAAC,IAAI,CACV,yFAAyF,CAC1F,CAAC;YACF,OAAO,SAAS,CAAC;SAClB;QAED,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,aAAuB,CAAC;KACzD;IAED,iGAAiG;IACjG,IACE,uBAAA,IAAI,+EAAgB,MAApB,IAAI,EAAiB,OAAO,EAAE,iCAAY,CAAC,IAAI,CAAC;QAChD,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAC9B;QACA,yGAAyG;QACzG,IAAI,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;YACjC,kGAAkG;YAClG,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,aAAuB,CAAC;SACzD;KACF;IAED,IAAI,CAAC,aAAa,EAAE;QAClB,OAAO,SAAS,CAAC;KAClB;IAED,yGAAyG;IACzG,oFAAoF;IACpF,MAAM,iBAAiB,GAAG,uBAAA,IAAI,qFAAsB,MAA1B,IAAI,EAAuB,aAAa,CAAC,CAAC;IACpE,IAAI,CAAC,iBAAiB,EAAE;QACtB,OAAO,CAAC,IAAI,CACV,iFAAiF,CAClF,CAAC;QACF,OAAO,SAAS,CAAC;KAClB;IAED,OAAO;QACL,QAAQ,EAAE,wBAAwB,CAAC,OAAO;QAC1C,EAAE,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,OAAO,EAAE,aAAa,CAAC;QACzE,IAAI,EAAE,iBAAiB;KACxB,CAAC;AACJ,CAAC,iGAGC,OAAwB;IAExB,IACE,uBAAA,IAAI,+EAAgB,MAApB,IAAI,EAAiB,OAAO,EAAE,iCAAY,CAAC,IAAI,CAAC;QAChD,OAAO,CAAC,QAAQ,CAAC,IAAI;QACrB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAC7B;QACA,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;QAErC,OAAO;YACL,QAAQ,EAAE,wBAAwB,CAAC,IAAI;YACvC,EAAE,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,IAAI,EAAE,EAAE,CAAC;YAC3D,IAAI,EAAE,uBAAA,IAAI,4EAAa,MAAjB,IAAI,EAAc,EAAY,CAAC;SACtC,CAAC;KACH;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,2GAGC,OAAwB;IAExB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAE1C,OAAO;QACL,QAAQ,EAAE,wBAAwB,CAAC,OAAO;QAC1C,EAAE,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,OAAO,EAAE,IAAI,CAAC;QAChE,IAAI,EAAE,IAAA,8CAAsC,EAAC,IAAoB,CAAC;KACnE,CAAC;AACJ,CAAC,mFAEY,MAAc;IACzB,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,IAAI;QACnB,CAAC,CAAC,oGAAoG;YACpG,gBAAgB;YAChB,IAAI,CAAC,QAAQ,CAAC,YAAY;QAC5B,CAAC,CAAC,IAAA,6BAAe,EAAC,MAAM,CAAC,CAAC;IAE5B,OAAO,SAAS,QAAQ,EAAE,CAAC;AAC7B,CAAC,qGAEqB,aAAqB;IACzC,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC5C,4BAA4B,CAC7B,CAAC;IAEF,MAAM,KAAK,GAAG,QAAQ;SACnB,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAM,iCAAY,CAAC,EAAa,CAAC;SACjE,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,aAAa,CAAC,CAAC;IAEjE,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;QAChB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,UAAU,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,sBAAsB;AACtD,CAAC,yEAGC,KAAqE,EACrE,OAAwB;IAExB,KAAK,MAAM,IAAI,IAAI,uBAAA,IAAI,oCAAO,EAAE;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5B,IAAI,CAAC,KAAK,EAAE;YACV,iDAAiD;YACjD,SAAS;SACV;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC;QAC9B,MAAM,OAAO,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,qEAAqE;QACxH,MAAM,SAAS,GAAG,kCAA0B,CAAC;QAE7C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;YACpB,KAAK,CAAC,QAAQ,CAAC,GAAG;gBAChB,EAAE,EAAE,QAAQ;gBACZ,MAAM,EAAE;oBACN,CAAC,OAAO,CAAC,EAAE;wBACT,EAAE,EAAE,OAAO;wBACX,QAAQ,EAAE,EAAE;wBACZ,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;qBAC9B;iBACF;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,UAAU;iBACjB;aACF,CAAC;SACH;QACD,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE1D,+CAA+C;QAC/C,uBAAA,IAAI,sCAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE;YAC5B,QAAQ;YACR,OAAO;SACR,CAAC,CAAC;QAEH,OAAO;KACR;AACH,CAAC;IAGC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,2CAA2C,CACvB,CAAC;AACzB,CAAC","sourcesContent":["import type {\n  AccountId,\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerListMultichainAccountsAction,\n} from '@metamask/accounts-controller';\nimport type { StateMetadata } from '@metamask/base-controller';\nimport {\n  type ControllerGetStateAction,\n  type ControllerStateChangeEvent,\n  type RestrictedMessenger,\n  BaseController,\n} from '@metamask/base-controller';\nimport type { KeyringControllerGetStateAction } from '@metamask/keyring-controller';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { GetSnap as SnapControllerGetSnap } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { stripSnapPrefix } from '@metamask/snaps-utils';\n\nimport { getAccountGroupRootNameFromKeyringType } from './names';\n\nconst controllerName = 'AccountTreeController';\n\nexport enum AccountGroupRootCategory {\n  Entropy = 'entropy',\n  Snap = 'snap',\n  Keyring = 'keyring',\n  Default = 'default', // TODO: Remove `default` once we have multichain accounts.\n}\n\ntype AccountTreeRuleMatch = {\n  category: AccountGroupRootCategory;\n  id: AccountGroupRootId;\n  name: string;\n};\n\ntype AccountReverseMapping = {\n  walletId: AccountGroupRootId;\n  groupId: AccountGroupId;\n};\n\ntype AccountGroupRootRuleFunction = (\n  account: InternalAccount,\n) => AccountTreeRuleMatch | undefined;\n\nexport type AccountGroupRootId = `${AccountGroupRootCategory}:${string}`;\nexport type AccountGroupId = `${AccountGroupRootId}:${string}`;\n\n// Do not export this one, we just use it to have a common type interface between group and wallet metadata.\ntype Metadata = {\n  name: string;\n};\n\nexport type AccountGroupRootMetadata = Metadata;\n\nexport type AccountGroupMetadata = Metadata;\n\nexport type AccountGroup = {\n  id: AccountGroupId;\n  // Blockchain Accounts:\n  accounts: AccountId[];\n  metadata: AccountGroupMetadata;\n};\n\nexport type AccountGroupRoot = {\n  id: AccountGroupRootId;\n  // Account groups OR Multichain accounts (once available).\n  groups: {\n    [accountGroup: AccountGroupId]: AccountGroup;\n  };\n  metadata: AccountGroupMetadata; // Assuming Metadata is a defined type\n};\n\nexport type AccountTreeControllerState = {\n  accountTrees: {\n    roots: {\n      // Wallets:\n      [accountGroupRoot: AccountGroupRootId]: AccountGroupRoot;\n    },\n  };\n};\n\nexport type AccountTreeControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AccountTreeControllerState\n>;\n\nexport type AllowedActions =\n  | AccountsControllerListMultichainAccountsAction\n  | KeyringControllerGetStateAction\n  | SnapControllerGetSnap;\n\nexport type AccountTreeControllerActions = never;\n\nexport type AccountTreeControllerChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AccountTreeControllerState\n>;\n\nexport type AllowedEvents =\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent;\n\nexport type AccountTreeControllerEvents = never;\n\nexport type AccountTreeControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  AccountTreeControllerActions | AllowedActions,\n  AccountTreeControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\nconst accountTreeControllerMetadata: StateMetadata<AccountTreeControllerState> =\n  {\n    accountTrees: {\n      persist: false, // We do re-recompute this state everytime.\n      anonymous: false,\n    },\n  };\n\n/**\n * Gets default state of the `AccountTreeController`.\n *\n * @returns The default state of the `AccountTreeController`.\n */\nexport function getDefaultAccountTreeControllerState(): AccountTreeControllerState {\n  return {\n    accountTrees: {\n      roots: {},\n    },\n  };\n}\n\n// TODO: For now we use this for the 2nd-level of the tree until we implements proper multichain accounts.\nexport const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string = 'default'; // This might need to be re-evaluated based on new structure\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\n/**\n * Convert a unique ID to a group root ID for a given category.\n *\n * @param category - The category of the account group root.\n * @param id - The unique ID.\n * @returns The group root ID.\n */\nexport function toAccountGroupRootId(\n  category: AccountGroupRootCategory,\n  id: string,\n): AccountGroupRootId {\n  return `${category}:${id}`;\n}\n\n/**\n * Convert a group root ID and a unique ID to a group ID.\n *\n * @param groupRootId - The group root ID.\n * @param id - The unique ID.\n * @returns The group ID.\n */\nexport function toAccountGroupId(\n  groupRootId: AccountGroupRootId,\n  id: string,\n): AccountGroupId {\n  return `${groupRootId}:${id}`;\n}\n\n/**\n * Convert a group root ID to the default group ID.\n *\n * @param groupRootId - The group root ID.\n * @returns The default group ID.\n */\nexport function toDefaultAccountGroupId(\n  groupRootId: AccountGroupRootId,\n): AccountGroupId {\n  return toAccountGroupId(groupRootId, DEFAULT_ACCOUNT_GROUP_UNIQUE_ID);\n}\n\nexport class AccountTreeController extends BaseController<\n  typeof controllerName,\n  AccountTreeControllerState,\n  AccountTreeControllerMessenger\n> {\n  readonly #reverse: Map<AccountId, AccountReverseMapping>;\n\n  readonly #rules: AccountGroupRootRuleFunction[];\n\n  /**\n   * Constructor for AccountTreeController.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The messenger object.\n   * @param options.state - Initial state to set on this controller\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: AccountTreeControllerMessenger;\n    state?: Partial<AccountTreeControllerState>;\n  }) {\n    super({\n      messenger,\n      name: controllerName,\n      metadata: accountTreeControllerMetadata,\n      state: {\n        ...getDefaultAccountTreeControllerState(),\n        ...state,\n      },\n    });\n\n    // Reverse map to allow fast node access from an account ID.\n    this.#reverse = new Map();\n\n    // Rules to apply to construct the wallets tree.\n    this.#rules = [\n      // 1. We group by entropy-source\n      (account: InternalAccount) => this.#matchGroupByEntropySource(account),\n      // 2. We group by Snap ID\n      (account: InternalAccount) => this.#matchGroupBySnapId(account),\n      // 3. We group by wallet type (this rule cannot fail and will group all non-matching accounts)\n      (account: InternalAccount) => this.#matchGroupByKeyringType(account),\n    ];\n\n    this.messagingSystem.subscribe(\n      'AccountsController:accountAdded',\n      (account) => {\n        this.#handleAccountAdded(account);\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      'AccountsController:accountRemoved',\n      (accountId) => {\n        this.#handleAccountRemoved(accountId);\n      },\n    );\n  }\n\n  init() {\n    const roots = {};\n\n    // For now, we always re-compute all wallets, we do not re-use the existing state.\n    for (const account of this.#listAccounts()) {\n      this.#insert(roots, account);\n    }\n\n    this.update((state) => {\n      state.accountTrees.roots = roots;\n    });\n  }\n\n  #handleAccountAdded(account: InternalAccount) {\n    this.update((state) => {\n      this.#insert(state.accountTrees.roots, account);\n    });\n  }\n\n  #handleAccountRemoved(accountId: AccountId) {\n    const found = this.#reverse.get(accountId);\n\n    if (found) {\n      const { walletId, groupId } = found;\n      this.update((state) => {\n        const { accounts } = state.accountTrees.roots[walletId].groups[groupId];\n\n        const index = accounts.indexOf(accountId);\n        if (index !== -1) {\n          accounts.splice(index, 1);\n        }\n      });\n    }\n  }\n\n  #hasKeyringType(account: InternalAccount, type: KeyringTypes): boolean {\n    return account.metadata.keyring.type === (type as string);\n  }\n\n  #matchGroupByEntropySource(\n    account: InternalAccount,\n  ): AccountTreeRuleMatch | undefined {\n    let entropySource: string | undefined;\n\n    if (this.#hasKeyringType(account, KeyringTypes.hd)) {\n      // TODO: Maybe use superstruct to validate the structure of HD account since they are not strongly-typed for now?\n      if (!account.options.entropySource) {\n        console.warn(\n          \"! Found an HD account with no entropy source: account won't be associated to its wallet\",\n        );\n        return undefined;\n      }\n\n      entropySource = account.options.entropySource as string;\n    }\n\n    // TODO: For now, we're not checking if the Snap is a preinstalled one, and we probably should...\n    if (\n      this.#hasKeyringType(account, KeyringTypes.snap) &&\n      account.metadata.snap?.enabled\n    ) {\n      // Not all Snaps have an entropy-source and options are not typed yet, so we have to check manually here.\n      if (account.options.entropySource) {\n        // We blindly trust the `entropySource` for now, but it could be wrong since it comes from a Snap.\n        entropySource = account.options.entropySource as string;\n      }\n    }\n\n    if (!entropySource) {\n      return undefined;\n    }\n\n    // We check if we can get the name for that entropy source, if not this means this entropy does not match\n    // any HD keyrings, thus, is invalid (this account will be grouped by another rule).\n    const entropySourceName = this.#getEntropySourceName(entropySource);\n    if (!entropySourceName) {\n      console.warn(\n        '! Tried to name a wallet using an unknown entropy, this should not be possible.',\n      );\n      return undefined;\n    }\n\n    return {\n      category: AccountGroupRootCategory.Entropy,\n      id: toAccountGroupRootId(AccountGroupRootCategory.Entropy, entropySource),\n      name: entropySourceName,\n    };\n  }\n\n  #matchGroupBySnapId(\n    account: InternalAccount,\n  ): AccountTreeRuleMatch | undefined {\n    if (\n      this.#hasKeyringType(account, KeyringTypes.snap) &&\n      account.metadata.snap &&\n      account.metadata.snap.enabled\n    ) {\n      const { id } = account.metadata.snap;\n\n      return {\n        category: AccountGroupRootCategory.Snap,\n        id: toAccountGroupRootId(AccountGroupRootCategory.Snap, id),\n        name: this.#getSnapName(id as SnapId),\n      };\n    }\n\n    return undefined;\n  }\n\n  #matchGroupByKeyringType(\n    account: InternalAccount,\n  ): AccountTreeRuleMatch | undefined {\n    const { type } = account.metadata.keyring;\n\n    return {\n      category: AccountGroupRootCategory.Keyring,\n      id: toAccountGroupRootId(AccountGroupRootCategory.Keyring, type),\n      name: getAccountGroupRootNameFromKeyringType(type as KeyringTypes),\n    };\n  }\n\n  #getSnapName(snapId: SnapId): string {\n    const snap = this.messagingSystem.call('SnapController:get', snapId);\n    const snapName = snap\n      ? // TODO: Handle localization here, but that's a \"client thing\", so we don't have a `core` controller\n        // to refer too.\n        snap.manifest.proposedName\n      : stripSnapPrefix(snapId);\n\n    return `Snap: ${snapName}`;\n  }\n\n  #getEntropySourceName(entropySource: string): string | undefined {\n    const { keyrings } = this.messagingSystem.call(\n      'KeyringController:getState',\n    );\n\n    const index = keyrings\n      .filter((keyring) => keyring.type === (KeyringTypes.hd as string))\n      .findIndex((keyring) => keyring.metadata.id === entropySource);\n\n    if (index === -1) {\n      return undefined;\n    }\n\n    return `Wallet ${index + 1}`; // Use human indexing.\n  }\n\n  #insert(\n    roots: { [accountGroupRootId: AccountGroupRootId]: AccountGroupRoot },\n    account: InternalAccount,\n  ) {\n    for (const rule of this.#rules) {\n      const match = rule(account);\n\n      if (!match) {\n        // No match for that rule, we go to the next one.\n        continue;\n      }\n\n      const walletId = match.id;\n      const walletName = match.name;\n      const groupId = toDefaultAccountGroupId(walletId); // Use a single-group for now until multichain accounts is supported.\n      const groupName = DEFAULT_ACCOUNT_GROUP_NAME;\n\n      if (!roots[walletId]) {\n        roots[walletId] = {\n          id: walletId,\n          groups: {\n            [groupId]: {\n              id: groupId,\n              accounts: [],\n              metadata: { name: groupName },\n            },\n          },\n          metadata: {\n            name: walletName,\n          },\n        };\n      }\n      roots[walletId].groups[groupId].accounts.push(account.id);\n\n      // Update the reverse mapping for this account.\n      this.#reverse.set(account.id, {\n        walletId,\n        groupId,\n      });\n\n      return;\n    }\n  }\n\n  #listAccounts(): InternalAccount[] {\n    return this.messagingSystem.call(\n      'AccountsController:listMultichainAccounts',\n    ) as InternalAccount[];\n  }\n}\n"]}

package/dist/AccountTreeController.d.cts

@@ -0,0 +1,92 @@
+import type { AccountId, AccountsControllerAccountAddedEvent, AccountsControllerAccountRemovedEvent, AccountsControllerListMultichainAccountsAction } from "@metamask/accounts-controller";
+import { type ControllerGetStateAction, type ControllerStateChangeEvent, type RestrictedMessenger, BaseController } from "@metamask/base-controller";
+import type { KeyringControllerGetStateAction } from "@metamask/keyring-controller";
+import type { GetSnap as SnapControllerGetSnap } from "@metamask/snaps-controllers";
+declare const controllerName = "AccountTreeController";
+export declare enum AccountGroupRootCategory {
+    Entropy = "entropy",
+    Snap = "snap",
+    Keyring = "keyring",
+    Default = "default"
+}
+export type AccountGroupRootId = `${AccountGroupRootCategory}:${string}`;
+export type AccountGroupId = `${AccountGroupRootId}:${string}`;
+type Metadata = {
+    name: string;
+};
+export type AccountGroupRootMetadata = Metadata;
+export type AccountGroupMetadata = Metadata;
+export type AccountGroup = {
+    id: AccountGroupId;
+    accounts: AccountId[];
+    metadata: AccountGroupMetadata;
+};
+export type AccountGroupRoot = {
+    id: AccountGroupRootId;
+    groups: {
+        [accountGroup: AccountGroupId]: AccountGroup;
+    };
+    metadata: AccountGroupMetadata;
+};
+export type AccountTreeControllerState = {
+    accountTrees: {
+        roots: {
+            [accountGroupRoot: AccountGroupRootId]: AccountGroupRoot;
+        };
+    };
+};
+export type AccountTreeControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AccountTreeControllerState>;
+export type AllowedActions = AccountsControllerListMultichainAccountsAction | KeyringControllerGetStateAction | SnapControllerGetSnap;
+export type AccountTreeControllerActions = never;
+export type AccountTreeControllerChangeEvent = ControllerStateChangeEvent<typeof controllerName, AccountTreeControllerState>;
+export type AllowedEvents = AccountsControllerAccountAddedEvent | AccountsControllerAccountRemovedEvent;
+export type AccountTreeControllerEvents = never;
+export type AccountTreeControllerMessenger = RestrictedMessenger<typeof controllerName, AccountTreeControllerActions | AllowedActions, AccountTreeControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Gets default state of the `AccountTreeController`.
+ *
+ * @returns The default state of the `AccountTreeController`.
+ */
+export declare function getDefaultAccountTreeControllerState(): AccountTreeControllerState;
+export declare const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string;
+export declare const DEFAULT_ACCOUNT_GROUP_NAME: string;
+/**
+ * Convert a unique ID to a group root ID for a given category.
+ *
+ * @param category - The category of the account group root.
+ * @param id - The unique ID.
+ * @returns The group root ID.
+ */
+export declare function toAccountGroupRootId(category: AccountGroupRootCategory, id: string): AccountGroupRootId;
+/**
+ * Convert a group root ID and a unique ID to a group ID.
+ *
+ * @param groupRootId - The group root ID.
+ * @param id - The unique ID.
+ * @returns The group ID.
+ */
+export declare function toAccountGroupId(groupRootId: AccountGroupRootId, id: string): AccountGroupId;
+/**
+ * Convert a group root ID to the default group ID.
+ *
+ * @param groupRootId - The group root ID.
+ * @returns The default group ID.
+ */
+export declare function toDefaultAccountGroupId(groupRootId: AccountGroupRootId): AccountGroupId;
+export declare class AccountTreeController extends BaseController<typeof controllerName, AccountTreeControllerState, AccountTreeControllerMessenger> {
+    #private;
+    /**
+     * Constructor for AccountTreeController.
+     *
+     * @param options - The controller options.
+     * @param options.messenger - The messenger object.
+     * @param options.state - Initial state to set on this controller
+     */
+    constructor({ messenger, state, }: {
+        messenger: AccountTreeControllerMessenger;
+        state?: Partial<AccountTreeControllerState>;
+    });
+    init(): void;
+}
+export {};
+//# sourceMappingURL=AccountTreeController.d.cts.map

package/dist/AccountTreeController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeController.d.cts","sourceRoot":"","sources":["../src/AccountTreeController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,mCAAmC,EACnC,qCAAqC,EACrC,8CAA8C,EAC/C,sCAAsC;AAEvC,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,mBAAmB,EACxB,cAAc,EACf,kCAAkC;AACnC,OAAO,KAAK,EAAE,+BAA+B,EAAE,qCAAqC;AAGpF,OAAO,KAAK,EAAE,OAAO,IAAI,qBAAqB,EAAE,oCAAoC;AAMpF,QAAA,MAAM,cAAc,0BAA0B,CAAC;AAE/C,oBAAY,wBAAwB;IAClC,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAiBD,MAAM,MAAM,kBAAkB,GAAG,GAAG,wBAAwB,IAAI,MAAM,EAAE,CAAC;AACzE,MAAM,MAAM,cAAc,GAAG,GAAG,kBAAkB,IAAI,MAAM,EAAE,CAAC;AAG/D,KAAK,QAAQ,GAAG;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC;AAEhD,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAE5C,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,cAAc,CAAC;IAEnB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,QAAQ,EAAE,oBAAoB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,kBAAkB,CAAC;IAEvB,MAAM,EAAE;QACN,CAAC,YAAY,EAAE,cAAc,GAAG,YAAY,CAAC;KAC9C,CAAC;IACF,QAAQ,EAAE,oBAAoB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,YAAY,EAAE;QACZ,KAAK,EAAE;YAEL,CAAC,gBAAgB,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;SAC1D,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF,MAAM,MAAM,cAAc,GACtB,8CAA8C,GAC9C,+BAA+B,GAC/B,qBAAqB,CAAC;AAE1B,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAAC;AAEjD,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF,MAAM,MAAM,aAAa,GACrB,mCAAmC,GACnC,qCAAqC,CAAC;AAE1C,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC;AAEhD,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,CAC9D,OAAO,cAAc,EACrB,4BAA4B,GAAG,cAAc,EAC7C,2BAA2B,GAAG,aAAa,EAC3C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAUF;;;;GAIG;AACH,wBAAgB,oCAAoC,IAAI,0BAA0B,CAMjF;AAGD,eAAO,MAAM,+BAA+B,EAAE,MAAkB,CAAC;AACjE,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,wBAAwB,EAClC,EAAE,EAAE,MAAM,GACT,kBAAkB,CAEpB;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,kBAAkB,EAC/B,EAAE,EAAE,MAAM,GACT,cAAc,CAEhB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,kBAAkB,GAC9B,cAAc,CAEhB;AAED,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;;IAKC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;KAC7C;IAuCD,IAAI;CAqML"}

package/dist/AccountTreeController.d.mts

@@ -0,0 +1,92 @@
+import type { AccountId, AccountsControllerAccountAddedEvent, AccountsControllerAccountRemovedEvent, AccountsControllerListMultichainAccountsAction } from "@metamask/accounts-controller";
+import { type ControllerGetStateAction, type ControllerStateChangeEvent, type RestrictedMessenger, BaseController } from "@metamask/base-controller";
+import type { KeyringControllerGetStateAction } from "@metamask/keyring-controller";
+import type { GetSnap as SnapControllerGetSnap } from "@metamask/snaps-controllers";
+declare const controllerName = "AccountTreeController";
+export declare enum AccountGroupRootCategory {
+    Entropy = "entropy",
+    Snap = "snap",
+    Keyring = "keyring",
+    Default = "default"
+}
+export type AccountGroupRootId = `${AccountGroupRootCategory}:${string}`;
+export type AccountGroupId = `${AccountGroupRootId}:${string}`;
+type Metadata = {
+    name: string;
+};
+export type AccountGroupRootMetadata = Metadata;
+export type AccountGroupMetadata = Metadata;
+export type AccountGroup = {
+    id: AccountGroupId;
+    accounts: AccountId[];
+    metadata: AccountGroupMetadata;
+};
+export type AccountGroupRoot = {
+    id: AccountGroupRootId;
+    groups: {
+        [accountGroup: AccountGroupId]: AccountGroup;
+    };
+    metadata: AccountGroupMetadata;
+};
+export type AccountTreeControllerState = {
+    accountTrees: {
+        roots: {
+            [accountGroupRoot: AccountGroupRootId]: AccountGroupRoot;
+        };
+    };
+};
+export type AccountTreeControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AccountTreeControllerState>;
+export type AllowedActions = AccountsControllerListMultichainAccountsAction | KeyringControllerGetStateAction | SnapControllerGetSnap;
+export type AccountTreeControllerActions = never;
+export type AccountTreeControllerChangeEvent = ControllerStateChangeEvent<typeof controllerName, AccountTreeControllerState>;
+export type AllowedEvents = AccountsControllerAccountAddedEvent | AccountsControllerAccountRemovedEvent;
+export type AccountTreeControllerEvents = never;
+export type AccountTreeControllerMessenger = RestrictedMessenger<typeof controllerName, AccountTreeControllerActions | AllowedActions, AccountTreeControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Gets default state of the `AccountTreeController`.
+ *
+ * @returns The default state of the `AccountTreeController`.
+ */
+export declare function getDefaultAccountTreeControllerState(): AccountTreeControllerState;
+export declare const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string;
+export declare const DEFAULT_ACCOUNT_GROUP_NAME: string;
+/**
+ * Convert a unique ID to a group root ID for a given category.
+ *
+ * @param category - The category of the account group root.
+ * @param id - The unique ID.
+ * @returns The group root ID.
+ */
+export declare function toAccountGroupRootId(category: AccountGroupRootCategory, id: string): AccountGroupRootId;
+/**
+ * Convert a group root ID and a unique ID to a group ID.
+ *
+ * @param groupRootId - The group root ID.
+ * @param id - The unique ID.
+ * @returns The group ID.
+ */
+export declare function toAccountGroupId(groupRootId: AccountGroupRootId, id: string): AccountGroupId;
+/**
+ * Convert a group root ID to the default group ID.
+ *
+ * @param groupRootId - The group root ID.
+ * @returns The default group ID.
+ */
+export declare function toDefaultAccountGroupId(groupRootId: AccountGroupRootId): AccountGroupId;
+export declare class AccountTreeController extends BaseController<typeof controllerName, AccountTreeControllerState, AccountTreeControllerMessenger> {
+    #private;
+    /**
+     * Constructor for AccountTreeController.
+     *
+     * @param options - The controller options.
+     * @param options.messenger - The messenger object.
+     * @param options.state - Initial state to set on this controller
+     */
+    constructor({ messenger, state, }: {
+        messenger: AccountTreeControllerMessenger;
+        state?: Partial<AccountTreeControllerState>;
+    });
+    init(): void;
+}
+export {};
+//# sourceMappingURL=AccountTreeController.d.mts.map

package/dist/AccountTreeController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeController.d.mts","sourceRoot":"","sources":["../src/AccountTreeController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,mCAAmC,EACnC,qCAAqC,EACrC,8CAA8C,EAC/C,sCAAsC;AAEvC,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,mBAAmB,EACxB,cAAc,EACf,kCAAkC;AACnC,OAAO,KAAK,EAAE,+BAA+B,EAAE,qCAAqC;AAGpF,OAAO,KAAK,EAAE,OAAO,IAAI,qBAAqB,EAAE,oCAAoC;AAMpF,QAAA,MAAM,cAAc,0BAA0B,CAAC;AAE/C,oBAAY,wBAAwB;IAClC,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAiBD,MAAM,MAAM,kBAAkB,GAAG,GAAG,wBAAwB,IAAI,MAAM,EAAE,CAAC;AACzE,MAAM,MAAM,cAAc,GAAG,GAAG,kBAAkB,IAAI,MAAM,EAAE,CAAC;AAG/D,KAAK,QAAQ,GAAG;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC;AAEhD,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAE5C,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,cAAc,CAAC;IAEnB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,QAAQ,EAAE,oBAAoB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,kBAAkB,CAAC;IAEvB,MAAM,EAAE;QACN,CAAC,YAAY,EAAE,cAAc,GAAG,YAAY,CAAC;KAC9C,CAAC;IACF,QAAQ,EAAE,oBAAoB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,YAAY,EAAE;QACZ,KAAK,EAAE;YAEL,CAAC,gBAAgB,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;SAC1D,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF,MAAM,MAAM,cAAc,GACtB,8CAA8C,GAC9C,+BAA+B,GAC/B,qBAAqB,CAAC;AAE1B,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAAC;AAEjD,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF,MAAM,MAAM,aAAa,GACrB,mCAAmC,GACnC,qCAAqC,CAAC;AAE1C,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC;AAEhD,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,CAC9D,OAAO,cAAc,EACrB,4BAA4B,GAAG,cAAc,EAC7C,2BAA2B,GAAG,aAAa,EAC3C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAUF;;;;GAIG;AACH,wBAAgB,oCAAoC,IAAI,0BAA0B,CAMjF;AAGD,eAAO,MAAM,+BAA+B,EAAE,MAAkB,CAAC;AACjE,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,wBAAwB,EAClC,EAAE,EAAE,MAAM,GACT,kBAAkB,CAEpB;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,kBAAkB,EAC/B,EAAE,EAAE,MAAM,GACT,cAAc,CAEhB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,kBAAkB,GAC9B,cAAc,CAEhB;AAED,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;;IAKC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;KAC7C;IAuCD,IAAI;CAqML"}

package/dist/AccountTreeController.mjs

@@ -0,0 +1,250 @@
+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 _AccountTreeController_instances, _AccountTreeController_reverse, _AccountTreeController_rules, _AccountTreeController_handleAccountAdded, _AccountTreeController_handleAccountRemoved, _AccountTreeController_hasKeyringType, _AccountTreeController_matchGroupByEntropySource, _AccountTreeController_matchGroupBySnapId, _AccountTreeController_matchGroupByKeyringType, _AccountTreeController_getSnapName, _AccountTreeController_getEntropySourceName, _AccountTreeController_insert, _AccountTreeController_listAccounts;
+import { BaseController } from "@metamask/base-controller";
+import { KeyringTypes } from "@metamask/keyring-controller";
+import { stripSnapPrefix } from "@metamask/snaps-utils";
+import { getAccountGroupRootNameFromKeyringType } from "./names.mjs";
+const controllerName = 'AccountTreeController';
+export var AccountGroupRootCategory;
+(function (AccountGroupRootCategory) {
+    AccountGroupRootCategory["Entropy"] = "entropy";
+    AccountGroupRootCategory["Snap"] = "snap";
+    AccountGroupRootCategory["Keyring"] = "keyring";
+    AccountGroupRootCategory["Default"] = "default";
+})(AccountGroupRootCategory || (AccountGroupRootCategory = {}));
+const accountTreeControllerMetadata = {
+    accountTrees: {
+        persist: false,
+        anonymous: false,
+    },
+};
+/**
+ * Gets default state of the `AccountTreeController`.
+ *
+ * @returns The default state of the `AccountTreeController`.
+ */
+export function getDefaultAccountTreeControllerState() {
+    return {
+        accountTrees: {
+            roots: {},
+        },
+    };
+}
+// TODO: For now we use this for the 2nd-level of the tree until we implements proper multichain accounts.
+export const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID = 'default'; // This might need to be re-evaluated based on new structure
+export const DEFAULT_ACCOUNT_GROUP_NAME = 'Default';
+/**
+ * Convert a unique ID to a group root ID for a given category.
+ *
+ * @param category - The category of the account group root.
+ * @param id - The unique ID.
+ * @returns The group root ID.
+ */
+export function toAccountGroupRootId(category, id) {
+    return `${category}:${id}`;
+}
+/**
+ * Convert a group root ID and a unique ID to a group ID.
+ *
+ * @param groupRootId - The group root ID.
+ * @param id - The unique ID.
+ * @returns The group ID.
+ */
+export function toAccountGroupId(groupRootId, id) {
+    return `${groupRootId}:${id}`;
+}
+/**
+ * Convert a group root ID to the default group ID.
+ *
+ * @param groupRootId - The group root ID.
+ * @returns The default group ID.
+ */
+export function toDefaultAccountGroupId(groupRootId) {
+    return toAccountGroupId(groupRootId, DEFAULT_ACCOUNT_GROUP_UNIQUE_ID);
+}
+export class AccountTreeController extends BaseController {
+    /**
+     * Constructor for AccountTreeController.
+     *
+     * @param options - The controller options.
+     * @param options.messenger - The messenger object.
+     * @param options.state - Initial state to set on this controller
+     */
+    constructor({ messenger, state, }) {
+        super({
+            messenger,
+            name: controllerName,
+            metadata: accountTreeControllerMetadata,
+            state: {
+                ...getDefaultAccountTreeControllerState(),
+                ...state,
+            },
+        });
+        _AccountTreeController_instances.add(this);
+        _AccountTreeController_reverse.set(this, void 0);
+        _AccountTreeController_rules.set(this, void 0);
+        // Reverse map to allow fast node access from an account ID.
+        __classPrivateFieldSet(this, _AccountTreeController_reverse, new Map(), "f");
+        // Rules to apply to construct the wallets tree.
+        __classPrivateFieldSet(this, _AccountTreeController_rules, [
+            // 1. We group by entropy-source
+            (account) => __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_matchGroupByEntropySource).call(this, account),
+            // 2. We group by Snap ID
+            (account) => __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_matchGroupBySnapId).call(this, account),
+            // 3. We group by wallet type (this rule cannot fail and will group all non-matching accounts)
+            (account) => __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_matchGroupByKeyringType).call(this, account),
+        ], "f");
+        this.messagingSystem.subscribe('AccountsController:accountAdded', (account) => {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleAccountAdded).call(this, account);
+        });
+        this.messagingSystem.subscribe('AccountsController:accountRemoved', (accountId) => {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleAccountRemoved).call(this, accountId);
+        });
+    }
+    init() {
+        const roots = {};
+        // For now, we always re-compute all wallets, we do not re-use the existing state.
+        for (const account of __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_listAccounts).call(this)) {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insert).call(this, roots, account);
+        }
+        this.update((state) => {
+            state.accountTrees.roots = roots;
+        });
+    }
+}
+_AccountTreeController_reverse = new WeakMap(), _AccountTreeController_rules = new WeakMap(), _AccountTreeController_instances = new WeakSet(), _AccountTreeController_handleAccountAdded = function _AccountTreeController_handleAccountAdded(account) {
+    this.update((state) => {
+        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insert).call(this, state.accountTrees.roots, account);
+    });
+}, _AccountTreeController_handleAccountRemoved = function _AccountTreeController_handleAccountRemoved(accountId) {
+    const found = __classPrivateFieldGet(this, _AccountTreeController_reverse, "f").get(accountId);
+    if (found) {
+        const { walletId, groupId } = found;
+        this.update((state) => {
+            const { accounts } = state.accountTrees.roots[walletId].groups[groupId];
+            const index = accounts.indexOf(accountId);
+            if (index !== -1) {
+                accounts.splice(index, 1);
+            }
+        });
+    }
+}, _AccountTreeController_hasKeyringType = function _AccountTreeController_hasKeyringType(account, type) {
+    return account.metadata.keyring.type === type;
+}, _AccountTreeController_matchGroupByEntropySource = function _AccountTreeController_matchGroupByEntropySource(account) {
+    let entropySource;
+    if (__classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_hasKeyringType).call(this, account, KeyringTypes.hd)) {
+        // TODO: Maybe use superstruct to validate the structure of HD account since they are not strongly-typed for now?
+        if (!account.options.entropySource) {
+            console.warn("! Found an HD account with no entropy source: account won't be associated to its wallet");
+            return undefined;
+        }
+        entropySource = account.options.entropySource;
+    }
+    // TODO: For now, we're not checking if the Snap is a preinstalled one, and we probably should...
+    if (__classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_hasKeyringType).call(this, account, KeyringTypes.snap) &&
+        account.metadata.snap?.enabled) {
+        // Not all Snaps have an entropy-source and options are not typed yet, so we have to check manually here.
+        if (account.options.entropySource) {
+            // We blindly trust the `entropySource` for now, but it could be wrong since it comes from a Snap.
+            entropySource = account.options.entropySource;
+        }
+    }
+    if (!entropySource) {
+        return undefined;
+    }
+    // We check if we can get the name for that entropy source, if not this means this entropy does not match
+    // any HD keyrings, thus, is invalid (this account will be grouped by another rule).
+    const entropySourceName = __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getEntropySourceName).call(this, entropySource);
+    if (!entropySourceName) {
+        console.warn('! Tried to name a wallet using an unknown entropy, this should not be possible.');
+        return undefined;
+    }
+    return {
+        category: AccountGroupRootCategory.Entropy,
+        id: toAccountGroupRootId(AccountGroupRootCategory.Entropy, entropySource),
+        name: entropySourceName,
+    };
+}, _AccountTreeController_matchGroupBySnapId = function _AccountTreeController_matchGroupBySnapId(account) {
+    if (__classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_hasKeyringType).call(this, account, KeyringTypes.snap) &&
+        account.metadata.snap &&
+        account.metadata.snap.enabled) {
+        const { id } = account.metadata.snap;
+        return {
+            category: AccountGroupRootCategory.Snap,
+            id: toAccountGroupRootId(AccountGroupRootCategory.Snap, id),
+            name: __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getSnapName).call(this, id),
+        };
+    }
+    return undefined;
+}, _AccountTreeController_matchGroupByKeyringType = function _AccountTreeController_matchGroupByKeyringType(account) {
+    const { type } = account.metadata.keyring;
+    return {
+        category: AccountGroupRootCategory.Keyring,
+        id: toAccountGroupRootId(AccountGroupRootCategory.Keyring, type),
+        name: getAccountGroupRootNameFromKeyringType(type),
+    };
+}, _AccountTreeController_getSnapName = function _AccountTreeController_getSnapName(snapId) {
+    const snap = this.messagingSystem.call('SnapController:get', snapId);
+    const snapName = snap
+        ? // TODO: Handle localization here, but that's a "client thing", so we don't have a `core` controller
+            // to refer too.
+            snap.manifest.proposedName
+        : stripSnapPrefix(snapId);
+    return `Snap: ${snapName}`;
+}, _AccountTreeController_getEntropySourceName = function _AccountTreeController_getEntropySourceName(entropySource) {
+    const { keyrings } = this.messagingSystem.call('KeyringController:getState');
+    const index = keyrings
+        .filter((keyring) => keyring.type === KeyringTypes.hd)
+        .findIndex((keyring) => keyring.metadata.id === entropySource);
+    if (index === -1) {
+        return undefined;
+    }
+    return `Wallet ${index + 1}`; // Use human indexing.
+}, _AccountTreeController_insert = function _AccountTreeController_insert(roots, account) {
+    for (const rule of __classPrivateFieldGet(this, _AccountTreeController_rules, "f")) {
+        const match = rule(account);
+        if (!match) {
+            // No match for that rule, we go to the next one.
+            continue;
+        }
+        const walletId = match.id;
+        const walletName = match.name;
+        const groupId = toDefaultAccountGroupId(walletId); // Use a single-group for now until multichain accounts is supported.
+        const groupName = DEFAULT_ACCOUNT_GROUP_NAME;
+        if (!roots[walletId]) {
+            roots[walletId] = {
+                id: walletId,
+                groups: {
+                    [groupId]: {
+                        id: groupId,
+                        accounts: [],
+                        metadata: { name: groupName },
+                    },
+                },
+                metadata: {
+                    name: walletName,
+                },
+            };
+        }
+        roots[walletId].groups[groupId].accounts.push(account.id);
+        // Update the reverse mapping for this account.
+        __classPrivateFieldGet(this, _AccountTreeController_reverse, "f").set(account.id, {
+            walletId,
+            groupId,
+        });
+        return;
+    }
+}, _AccountTreeController_listAccounts = function _AccountTreeController_listAccounts() {
+    return this.messagingSystem.call('AccountsController:listMultichainAccounts');
+};
+//# sourceMappingURL=AccountTreeController.mjs.map

package/dist/AccountTreeController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeController.mjs","sourceRoot":"","sources":["../src/AccountTreeController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAOA,OAAO,EAIL,cAAc,EACf,kCAAkC;AAEnC,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAI5D,OAAO,EAAE,eAAe,EAAE,8BAA8B;AAExD,OAAO,EAAE,sCAAsC,EAAE,oBAAgB;AAEjE,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAE/C,MAAM,CAAN,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,+CAAmB,CAAA;IACnB,yCAAa,CAAA;IACb,+CAAmB,CAAA;IACnB,+CAAmB,CAAA;AACrB,CAAC,EALW,wBAAwB,KAAxB,wBAAwB,QAKnC;AAqFD,MAAM,6BAA6B,GACjC;IACE,YAAY,EAAE;QACZ,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AAEJ;;;;GAIG;AACH,MAAM,UAAU,oCAAoC;IAClD,OAAO;QACL,YAAY,EAAE;YACZ,KAAK,EAAE,EAAE;SACV;KACF,CAAC;AACJ,CAAC;AAED,0GAA0G;AAC1G,MAAM,CAAC,MAAM,+BAA+B,GAAW,SAAS,CAAC,CAAC,4DAA4D;AAC9H,MAAM,CAAC,MAAM,0BAA0B,GAAW,SAAS,CAAC;AAE5D;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAkC,EAClC,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,WAA+B,EAC/B,EAAU;IAEV,OAAO,GAAG,WAAW,IAAI,EAAE,EAAE,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,WAA+B;IAE/B,OAAO,gBAAgB,CAAC,WAAW,EAAE,+BAA+B,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,OAAO,qBAAsB,SAAQ,cAI1C;IAKC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,6BAA6B;YACvC,KAAK,EAAE;gBACL,GAAG,oCAAoC,EAAE;gBACzC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA1BI,iDAAgD;QAEhD,+CAAuC;QA0B9C,4DAA4D;QAC5D,uBAAA,IAAI,kCAAY,IAAI,GAAG,EAAE,MAAA,CAAC;QAE1B,gDAAgD;QAChD,uBAAA,IAAI,gCAAU;YACZ,gCAAgC;YAChC,CAAC,OAAwB,EAAE,EAAE,CAAC,uBAAA,IAAI,0FAA2B,MAA/B,IAAI,EAA4B,OAAO,CAAC;YACtE,yBAAyB;YACzB,CAAC,OAAwB,EAAE,EAAE,CAAC,uBAAA,IAAI,mFAAoB,MAAxB,IAAI,EAAqB,OAAO,CAAC;YAC/D,8FAA8F;YAC9F,CAAC,OAAwB,EAAE,EAAE,CAAC,uBAAA,IAAI,wFAAyB,MAA7B,IAAI,EAA0B,OAAO,CAAC;SACrE,MAAA,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,CAAC,OAAO,EAAE,EAAE;YACV,uBAAA,IAAI,mFAAoB,MAAxB,IAAI,EAAqB,OAAO,CAAC,CAAC;QACpC,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAC,SAAS,EAAE,EAAE;YACZ,uBAAA,IAAI,qFAAsB,MAA1B,IAAI,EAAuB,SAAS,CAAC,CAAC;QACxC,CAAC,CACF,CAAC;IACJ,CAAC;IAED,IAAI;QACF,MAAM,KAAK,GAAG,EAAE,CAAC;QAEjB,kFAAkF;QAClF,KAAK,MAAM,OAAO,IAAI,uBAAA,IAAI,6EAAc,MAAlB,IAAI,CAAgB,EAAE;YAC1C,uBAAA,IAAI,uEAAQ,MAAZ,IAAI,EAAS,KAAK,EAAE,OAAO,CAAC,CAAC;SAC9B;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;CA0LF;+OAxLqB,OAAwB;IAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,uBAAA,IAAI,uEAAQ,MAAZ,IAAI,EAAS,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACL,CAAC,qGAEqB,SAAoB;IACxC,MAAM,KAAK,GAAG,uBAAA,IAAI,sCAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAE3C,IAAI,KAAK,EAAE;QACT,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAExE,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC1C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gBAChB,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;KACJ;AACH,CAAC,yFAEe,OAAwB,EAAE,IAAkB;IAC1D,OAAO,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAM,IAAe,CAAC;AAC5D,CAAC,+GAGC,OAAwB;IAExB,IAAI,aAAiC,CAAC;IAEtC,IAAI,uBAAA,IAAI,+EAAgB,MAApB,IAAI,EAAiB,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE;QAClD,iHAAiH;QACjH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;YAClC,OAAO,CAAC,IAAI,CACV,yFAAyF,CAC1F,CAAC;YACF,OAAO,SAAS,CAAC;SAClB;QAED,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,aAAuB,CAAC;KACzD;IAED,iGAAiG;IACjG,IACE,uBAAA,IAAI,+EAAgB,MAApB,IAAI,EAAiB,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC;QAChD,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAC9B;QACA,yGAAyG;QACzG,IAAI,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;YACjC,kGAAkG;YAClG,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,aAAuB,CAAC;SACzD;KACF;IAED,IAAI,CAAC,aAAa,EAAE;QAClB,OAAO,SAAS,CAAC;KAClB;IAED,yGAAyG;IACzG,oFAAoF;IACpF,MAAM,iBAAiB,GAAG,uBAAA,IAAI,qFAAsB,MAA1B,IAAI,EAAuB,aAAa,CAAC,CAAC;IACpE,IAAI,CAAC,iBAAiB,EAAE;QACtB,OAAO,CAAC,IAAI,CACV,iFAAiF,CAClF,CAAC;QACF,OAAO,SAAS,CAAC;KAClB;IAED,OAAO;QACL,QAAQ,EAAE,wBAAwB,CAAC,OAAO;QAC1C,EAAE,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,OAAO,EAAE,aAAa,CAAC;QACzE,IAAI,EAAE,iBAAiB;KACxB,CAAC;AACJ,CAAC,iGAGC,OAAwB;IAExB,IACE,uBAAA,IAAI,+EAAgB,MAApB,IAAI,EAAiB,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC;QAChD,OAAO,CAAC,QAAQ,CAAC,IAAI;QACrB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAC7B;QACA,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;QAErC,OAAO;YACL,QAAQ,EAAE,wBAAwB,CAAC,IAAI;YACvC,EAAE,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,IAAI,EAAE,EAAE,CAAC;YAC3D,IAAI,EAAE,uBAAA,IAAI,4EAAa,MAAjB,IAAI,EAAc,EAAY,CAAC;SACtC,CAAC;KACH;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,2GAGC,OAAwB;IAExB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAE1C,OAAO;QACL,QAAQ,EAAE,wBAAwB,CAAC,OAAO;QAC1C,EAAE,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,OAAO,EAAE,IAAI,CAAC;QAChE,IAAI,EAAE,sCAAsC,CAAC,IAAoB,CAAC;KACnE,CAAC;AACJ,CAAC,mFAEY,MAAc;IACzB,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,IAAI;QACnB,CAAC,CAAC,oGAAoG;YACpG,gBAAgB;YAChB,IAAI,CAAC,QAAQ,CAAC,YAAY;QAC5B,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAE5B,OAAO,SAAS,QAAQ,EAAE,CAAC;AAC7B,CAAC,qGAEqB,aAAqB;IACzC,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC5C,4BAA4B,CAC7B,CAAC;IAEF,MAAM,KAAK,GAAG,QAAQ;SACnB,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAM,YAAY,CAAC,EAAa,CAAC;SACjE,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,aAAa,CAAC,CAAC;IAEjE,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;QAChB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,UAAU,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,sBAAsB;AACtD,CAAC,yEAGC,KAAqE,EACrE,OAAwB;IAExB,KAAK,MAAM,IAAI,IAAI,uBAAA,IAAI,oCAAO,EAAE;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5B,IAAI,CAAC,KAAK,EAAE;YACV,iDAAiD;YACjD,SAAS;SACV;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC;QAC9B,MAAM,OAAO,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,qEAAqE;QACxH,MAAM,SAAS,GAAG,0BAA0B,CAAC;QAE7C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;YACpB,KAAK,CAAC,QAAQ,CAAC,GAAG;gBAChB,EAAE,EAAE,QAAQ;gBACZ,MAAM,EAAE;oBACN,CAAC,OAAO,CAAC,EAAE;wBACT,EAAE,EAAE,OAAO;wBACX,QAAQ,EAAE,EAAE;wBACZ,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;qBAC9B;iBACF;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,UAAU;iBACjB;aACF,CAAC;SACH;QACD,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE1D,+CAA+C;QAC/C,uBAAA,IAAI,sCAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE;YAC5B,QAAQ;YACR,OAAO;SACR,CAAC,CAAC;QAEH,OAAO;KACR;AACH,CAAC;IAGC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,2CAA2C,CACvB,CAAC;AACzB,CAAC","sourcesContent":["import type {\n  AccountId,\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerListMultichainAccountsAction,\n} from '@metamask/accounts-controller';\nimport type { StateMetadata } from '@metamask/base-controller';\nimport {\n  type ControllerGetStateAction,\n  type ControllerStateChangeEvent,\n  type RestrictedMessenger,\n  BaseController,\n} from '@metamask/base-controller';\nimport type { KeyringControllerGetStateAction } from '@metamask/keyring-controller';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { GetSnap as SnapControllerGetSnap } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { stripSnapPrefix } from '@metamask/snaps-utils';\n\nimport { getAccountGroupRootNameFromKeyringType } from './names';\n\nconst controllerName = 'AccountTreeController';\n\nexport enum AccountGroupRootCategory {\n  Entropy = 'entropy',\n  Snap = 'snap',\n  Keyring = 'keyring',\n  Default = 'default', // TODO: Remove `default` once we have multichain accounts.\n}\n\ntype AccountTreeRuleMatch = {\n  category: AccountGroupRootCategory;\n  id: AccountGroupRootId;\n  name: string;\n};\n\ntype AccountReverseMapping = {\n  walletId: AccountGroupRootId;\n  groupId: AccountGroupId;\n};\n\ntype AccountGroupRootRuleFunction = (\n  account: InternalAccount,\n) => AccountTreeRuleMatch | undefined;\n\nexport type AccountGroupRootId = `${AccountGroupRootCategory}:${string}`;\nexport type AccountGroupId = `${AccountGroupRootId}:${string}`;\n\n// Do not export this one, we just use it to have a common type interface between group and wallet metadata.\ntype Metadata = {\n  name: string;\n};\n\nexport type AccountGroupRootMetadata = Metadata;\n\nexport type AccountGroupMetadata = Metadata;\n\nexport type AccountGroup = {\n  id: AccountGroupId;\n  // Blockchain Accounts:\n  accounts: AccountId[];\n  metadata: AccountGroupMetadata;\n};\n\nexport type AccountGroupRoot = {\n  id: AccountGroupRootId;\n  // Account groups OR Multichain accounts (once available).\n  groups: {\n    [accountGroup: AccountGroupId]: AccountGroup;\n  };\n  metadata: AccountGroupMetadata; // Assuming Metadata is a defined type\n};\n\nexport type AccountTreeControllerState = {\n  accountTrees: {\n    roots: {\n      // Wallets:\n      [accountGroupRoot: AccountGroupRootId]: AccountGroupRoot;\n    },\n  };\n};\n\nexport type AccountTreeControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AccountTreeControllerState\n>;\n\nexport type AllowedActions =\n  | AccountsControllerListMultichainAccountsAction\n  | KeyringControllerGetStateAction\n  | SnapControllerGetSnap;\n\nexport type AccountTreeControllerActions = never;\n\nexport type AccountTreeControllerChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AccountTreeControllerState\n>;\n\nexport type AllowedEvents =\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent;\n\nexport type AccountTreeControllerEvents = never;\n\nexport type AccountTreeControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  AccountTreeControllerActions | AllowedActions,\n  AccountTreeControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\nconst accountTreeControllerMetadata: StateMetadata<AccountTreeControllerState> =\n  {\n    accountTrees: {\n      persist: false, // We do re-recompute this state everytime.\n      anonymous: false,\n    },\n  };\n\n/**\n * Gets default state of the `AccountTreeController`.\n *\n * @returns The default state of the `AccountTreeController`.\n */\nexport function getDefaultAccountTreeControllerState(): AccountTreeControllerState {\n  return {\n    accountTrees: {\n      roots: {},\n    },\n  };\n}\n\n// TODO: For now we use this for the 2nd-level of the tree until we implements proper multichain accounts.\nexport const DEFAULT_ACCOUNT_GROUP_UNIQUE_ID: string = 'default'; // This might need to be re-evaluated based on new structure\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\n/**\n * Convert a unique ID to a group root ID for a given category.\n *\n * @param category - The category of the account group root.\n * @param id - The unique ID.\n * @returns The group root ID.\n */\nexport function toAccountGroupRootId(\n  category: AccountGroupRootCategory,\n  id: string,\n): AccountGroupRootId {\n  return `${category}:${id}`;\n}\n\n/**\n * Convert a group root ID and a unique ID to a group ID.\n *\n * @param groupRootId - The group root ID.\n * @param id - The unique ID.\n * @returns The group ID.\n */\nexport function toAccountGroupId(\n  groupRootId: AccountGroupRootId,\n  id: string,\n): AccountGroupId {\n  return `${groupRootId}:${id}`;\n}\n\n/**\n * Convert a group root ID to the default group ID.\n *\n * @param groupRootId - The group root ID.\n * @returns The default group ID.\n */\nexport function toDefaultAccountGroupId(\n  groupRootId: AccountGroupRootId,\n): AccountGroupId {\n  return toAccountGroupId(groupRootId, DEFAULT_ACCOUNT_GROUP_UNIQUE_ID);\n}\n\nexport class AccountTreeController extends BaseController<\n  typeof controllerName,\n  AccountTreeControllerState,\n  AccountTreeControllerMessenger\n> {\n  readonly #reverse: Map<AccountId, AccountReverseMapping>;\n\n  readonly #rules: AccountGroupRootRuleFunction[];\n\n  /**\n   * Constructor for AccountTreeController.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The messenger object.\n   * @param options.state - Initial state to set on this controller\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: AccountTreeControllerMessenger;\n    state?: Partial<AccountTreeControllerState>;\n  }) {\n    super({\n      messenger,\n      name: controllerName,\n      metadata: accountTreeControllerMetadata,\n      state: {\n        ...getDefaultAccountTreeControllerState(),\n        ...state,\n      },\n    });\n\n    // Reverse map to allow fast node access from an account ID.\n    this.#reverse = new Map();\n\n    // Rules to apply to construct the wallets tree.\n    this.#rules = [\n      // 1. We group by entropy-source\n      (account: InternalAccount) => this.#matchGroupByEntropySource(account),\n      // 2. We group by Snap ID\n      (account: InternalAccount) => this.#matchGroupBySnapId(account),\n      // 3. We group by wallet type (this rule cannot fail and will group all non-matching accounts)\n      (account: InternalAccount) => this.#matchGroupByKeyringType(account),\n    ];\n\n    this.messagingSystem.subscribe(\n      'AccountsController:accountAdded',\n      (account) => {\n        this.#handleAccountAdded(account);\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      'AccountsController:accountRemoved',\n      (accountId) => {\n        this.#handleAccountRemoved(accountId);\n      },\n    );\n  }\n\n  init() {\n    const roots = {};\n\n    // For now, we always re-compute all wallets, we do not re-use the existing state.\n    for (const account of this.#listAccounts()) {\n      this.#insert(roots, account);\n    }\n\n    this.update((state) => {\n      state.accountTrees.roots = roots;\n    });\n  }\n\n  #handleAccountAdded(account: InternalAccount) {\n    this.update((state) => {\n      this.#insert(state.accountTrees.roots, account);\n    });\n  }\n\n  #handleAccountRemoved(accountId: AccountId) {\n    const found = this.#reverse.get(accountId);\n\n    if (found) {\n      const { walletId, groupId } = found;\n      this.update((state) => {\n        const { accounts } = state.accountTrees.roots[walletId].groups[groupId];\n\n        const index = accounts.indexOf(accountId);\n        if (index !== -1) {\n          accounts.splice(index, 1);\n        }\n      });\n    }\n  }\n\n  #hasKeyringType(account: InternalAccount, type: KeyringTypes): boolean {\n    return account.metadata.keyring.type === (type as string);\n  }\n\n  #matchGroupByEntropySource(\n    account: InternalAccount,\n  ): AccountTreeRuleMatch | undefined {\n    let entropySource: string | undefined;\n\n    if (this.#hasKeyringType(account, KeyringTypes.hd)) {\n      // TODO: Maybe use superstruct to validate the structure of HD account since they are not strongly-typed for now?\n      if (!account.options.entropySource) {\n        console.warn(\n          \"! Found an HD account with no entropy source: account won't be associated to its wallet\",\n        );\n        return undefined;\n      }\n\n      entropySource = account.options.entropySource as string;\n    }\n\n    // TODO: For now, we're not checking if the Snap is a preinstalled one, and we probably should...\n    if (\n      this.#hasKeyringType(account, KeyringTypes.snap) &&\n      account.metadata.snap?.enabled\n    ) {\n      // Not all Snaps have an entropy-source and options are not typed yet, so we have to check manually here.\n      if (account.options.entropySource) {\n        // We blindly trust the `entropySource` for now, but it could be wrong since it comes from a Snap.\n        entropySource = account.options.entropySource as string;\n      }\n    }\n\n    if (!entropySource) {\n      return undefined;\n    }\n\n    // We check if we can get the name for that entropy source, if not this means this entropy does not match\n    // any HD keyrings, thus, is invalid (this account will be grouped by another rule).\n    const entropySourceName = this.#getEntropySourceName(entropySource);\n    if (!entropySourceName) {\n      console.warn(\n        '! Tried to name a wallet using an unknown entropy, this should not be possible.',\n      );\n      return undefined;\n    }\n\n    return {\n      category: AccountGroupRootCategory.Entropy,\n      id: toAccountGroupRootId(AccountGroupRootCategory.Entropy, entropySource),\n      name: entropySourceName,\n    };\n  }\n\n  #matchGroupBySnapId(\n    account: InternalAccount,\n  ): AccountTreeRuleMatch | undefined {\n    if (\n      this.#hasKeyringType(account, KeyringTypes.snap) &&\n      account.metadata.snap &&\n      account.metadata.snap.enabled\n    ) {\n      const { id } = account.metadata.snap;\n\n      return {\n        category: AccountGroupRootCategory.Snap,\n        id: toAccountGroupRootId(AccountGroupRootCategory.Snap, id),\n        name: this.#getSnapName(id as SnapId),\n      };\n    }\n\n    return undefined;\n  }\n\n  #matchGroupByKeyringType(\n    account: InternalAccount,\n  ): AccountTreeRuleMatch | undefined {\n    const { type } = account.metadata.keyring;\n\n    return {\n      category: AccountGroupRootCategory.Keyring,\n      id: toAccountGroupRootId(AccountGroupRootCategory.Keyring, type),\n      name: getAccountGroupRootNameFromKeyringType(type as KeyringTypes),\n    };\n  }\n\n  #getSnapName(snapId: SnapId): string {\n    const snap = this.messagingSystem.call('SnapController:get', snapId);\n    const snapName = snap\n      ? // TODO: Handle localization here, but that's a \"client thing\", so we don't have a `core` controller\n        // to refer too.\n        snap.manifest.proposedName\n      : stripSnapPrefix(snapId);\n\n    return `Snap: ${snapName}`;\n  }\n\n  #getEntropySourceName(entropySource: string): string | undefined {\n    const { keyrings } = this.messagingSystem.call(\n      'KeyringController:getState',\n    );\n\n    const index = keyrings\n      .filter((keyring) => keyring.type === (KeyringTypes.hd as string))\n      .findIndex((keyring) => keyring.metadata.id === entropySource);\n\n    if (index === -1) {\n      return undefined;\n    }\n\n    return `Wallet ${index + 1}`; // Use human indexing.\n  }\n\n  #insert(\n    roots: { [accountGroupRootId: AccountGroupRootId]: AccountGroupRoot },\n    account: InternalAccount,\n  ) {\n    for (const rule of this.#rules) {\n      const match = rule(account);\n\n      if (!match) {\n        // No match for that rule, we go to the next one.\n        continue;\n      }\n\n      const walletId = match.id;\n      const walletName = match.name;\n      const groupId = toDefaultAccountGroupId(walletId); // Use a single-group for now until multichain accounts is supported.\n      const groupName = DEFAULT_ACCOUNT_GROUP_NAME;\n\n      if (!roots[walletId]) {\n        roots[walletId] = {\n          id: walletId,\n          groups: {\n            [groupId]: {\n              id: groupId,\n              accounts: [],\n              metadata: { name: groupName },\n            },\n          },\n          metadata: {\n            name: walletName,\n          },\n        };\n      }\n      roots[walletId].groups[groupId].accounts.push(account.id);\n\n      // Update the reverse mapping for this account.\n      this.#reverse.set(account.id, {\n        walletId,\n        groupId,\n      });\n\n      return;\n    }\n  }\n\n  #listAccounts(): InternalAccount[] {\n    return this.messagingSystem.call(\n      'AccountsController:listMultichainAccounts',\n    ) as InternalAccount[];\n  }\n}\n"]}

package/dist/index.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountTreeController = void 0;
+var AccountTreeController_1 = require("./AccountTreeController.cjs");
+Object.defineProperty(exports, "AccountTreeController", { enumerable: true, get: function () { return AccountTreeController_1.AccountTreeController; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAcA,qEAAgE;AAAvD,8HAAA,qBAAqB,OAAA","sourcesContent":["export type {\n  AccountGroupRoot as AccountTree,\n  AccountGroupRootId as AccountTreeId,\n  AccountGroupRootMetadata as AccountTreeMetadata,\n  AccountTreeControllerState,\n  AccountTreeControllerGetStateAction,\n  AccountTreeControllerActions,\n  AccountTreeControllerChangeEvent,\n  AccountTreeControllerEvents,\n  AccountTreeControllerMessenger,\n  AccountGroup,\n  AccountGroupId,\n  AccountGroupMetadata,\n} from './AccountTreeController';\nexport { AccountTreeController } from './AccountTreeController';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+export type { AccountGroupRoot as AccountTree, AccountGroupRootId as AccountTreeId, AccountGroupRootMetadata as AccountTreeMetadata, AccountTreeControllerState, AccountTreeControllerGetStateAction, AccountTreeControllerActions, AccountTreeControllerChangeEvent, AccountTreeControllerEvents, AccountTreeControllerMessenger, AccountGroup, AccountGroupId, AccountGroupMetadata, } from "./AccountTreeController.cjs";
+export { AccountTreeController } from "./AccountTreeController.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gBAAgB,IAAI,WAAW,EAC/B,kBAAkB,IAAI,aAAa,EACnC,wBAAwB,IAAI,mBAAmB,EAC/C,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,gCAAgC,EAChC,2BAA2B,EAC3B,8BAA8B,EAC9B,YAAY,EACZ,cAAc,EACd,oBAAoB,GACrB,oCAAgC;AACjC,OAAO,EAAE,qBAAqB,EAAE,oCAAgC"}

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+export type { AccountGroupRoot as AccountTree, AccountGroupRootId as AccountTreeId, AccountGroupRootMetadata as AccountTreeMetadata, AccountTreeControllerState, AccountTreeControllerGetStateAction, AccountTreeControllerActions, AccountTreeControllerChangeEvent, AccountTreeControllerEvents, AccountTreeControllerMessenger, AccountGroup, AccountGroupId, AccountGroupMetadata, } from "./AccountTreeController.mjs";
+export { AccountTreeController } from "./AccountTreeController.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gBAAgB,IAAI,WAAW,EAC/B,kBAAkB,IAAI,aAAa,EACnC,wBAAwB,IAAI,mBAAmB,EAC/C,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,gCAAgC,EAChC,2BAA2B,EAC3B,8BAA8B,EAC9B,YAAY,EACZ,cAAc,EACd,oBAAoB,GACrB,oCAAgC;AACjC,OAAO,EAAE,qBAAqB,EAAE,oCAAgC"}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+export { AccountTreeController } from "./AccountTreeController.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,qBAAqB,EAAE,oCAAgC","sourcesContent":["export type {\n  AccountGroupRoot as AccountTree,\n  AccountGroupRootId as AccountTreeId,\n  AccountGroupRootMetadata as AccountTreeMetadata,\n  AccountTreeControllerState,\n  AccountTreeControllerGetStateAction,\n  AccountTreeControllerActions,\n  AccountTreeControllerChangeEvent,\n  AccountTreeControllerEvents,\n  AccountTreeControllerMessenger,\n  AccountGroup,\n  AccountGroupId,\n  AccountGroupMetadata,\n} from './AccountTreeController';\nexport { AccountTreeController } from './AccountTreeController';\n"]}

package/dist/names.cjs

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAccountGroupRootNameFromKeyringType = void 0;
+const keyring_controller_1 = require("@metamask/keyring-controller");
+/**
+ * Get wallet name from a keyring type.
+ *
+ * @param type - Keyring's type.
+ * @returns Wallet name.
+ */
+function getAccountGroupRootNameFromKeyringType(type) {
+    switch (type) {
+        case keyring_controller_1.KeyringTypes.simple: {
+            return 'Private Keys';
+        }
+        case keyring_controller_1.KeyringTypes.hd: {
+            return 'HD Wallet';
+        }
+        case keyring_controller_1.KeyringTypes.trezor: {
+            return 'Trezor';
+        }
+        case keyring_controller_1.KeyringTypes.oneKey: {
+            return 'OneKey';
+        }
+        case keyring_controller_1.KeyringTypes.ledger: {
+            return 'Ledger';
+        }
+        case keyring_controller_1.KeyringTypes.lattice: {
+            return 'Lattice';
+        }
+        case keyring_controller_1.KeyringTypes.qr: {
+            return 'QR';
+        }
+        case keyring_controller_1.KeyringTypes.snap: {
+            return 'Snap Wallet';
+        }
+        default: {
+            return 'Unknown';
+        }
+    }
+}
+exports.getAccountGroupRootNameFromKeyringType = getAccountGroupRootNameFromKeyringType;
+//# sourceMappingURL=names.cjs.map

package/dist/names.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"names.cjs","sourceRoot":"","sources":["../src/names.ts"],"names":[],"mappings":";;;AAAA,qEAA4D;AAE5D;;;;;GAKG;AACH,SAAgB,sCAAsC,CAAC,IAAkB;IACvE,QAAQ,IAAI,EAAE;QACZ,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,cAAc,CAAC;SACvB;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,WAAW,CAAC;SACpB;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,iCAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,iCAAY,CAAC,OAAO,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,iCAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;SACb;QACD,KAAK,iCAAY,CAAC,IAAI,CAAC,CAAC;YACtB,OAAO,aAAa,CAAC;SACtB;QACD,OAAO,CAAC,CAAC;YACP,OAAO,SAAS,CAAC;SAClB;KACF;AACH,CAAC;AA9BD,wFA8BC","sourcesContent":["import { KeyringTypes } from '@metamask/keyring-controller';\n\n/**\n * Get wallet name from a keyring type.\n *\n * @param type - Keyring's type.\n * @returns Wallet name.\n */\nexport function getAccountGroupRootNameFromKeyringType(type: KeyringTypes) {\n  switch (type) {\n    case KeyringTypes.simple: {\n      return 'Private Keys';\n    }\n    case KeyringTypes.hd: {\n      return 'HD Wallet';\n    }\n    case KeyringTypes.trezor: {\n      return 'Trezor';\n    }\n    case KeyringTypes.oneKey: {\n      return 'OneKey';\n    }\n    case KeyringTypes.ledger: {\n      return 'Ledger';\n    }\n    case KeyringTypes.lattice: {\n      return 'Lattice';\n    }\n    case KeyringTypes.qr: {\n      return 'QR';\n    }\n    case KeyringTypes.snap: {\n      return 'Snap Wallet';\n    }\n    default: {\n      return 'Unknown';\n    }\n  }\n}\n"]}

package/dist/names.d.cts

@@ -0,0 +1,9 @@
+import { KeyringTypes } from "@metamask/keyring-controller";
+/**
+ * Get wallet name from a keyring type.
+ *
+ * @param type - Keyring's type.
+ * @returns Wallet name.
+ */
+export declare function getAccountGroupRootNameFromKeyringType(type: KeyringTypes): "Private Keys" | "HD Wallet" | "Trezor" | "OneKey" | "Ledger" | "Lattice" | "QR" | "Snap Wallet" | "Unknown";
+//# sourceMappingURL=names.d.cts.map

package/dist/names.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"names.d.cts","sourceRoot":"","sources":["../src/names.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAE5D;;;;;GAKG;AACH,wBAAgB,sCAAsC,CAAC,IAAI,EAAE,YAAY,gHA8BxE"}

package/dist/names.d.mts

@@ -0,0 +1,9 @@
+import { KeyringTypes } from "@metamask/keyring-controller";
+/**
+ * Get wallet name from a keyring type.
+ *
+ * @param type - Keyring's type.
+ * @returns Wallet name.
+ */
+export declare function getAccountGroupRootNameFromKeyringType(type: KeyringTypes): "Private Keys" | "HD Wallet" | "Trezor" | "OneKey" | "Ledger" | "Lattice" | "QR" | "Snap Wallet" | "Unknown";
+//# sourceMappingURL=names.d.mts.map

package/dist/names.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"names.d.mts","sourceRoot":"","sources":["../src/names.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAE5D;;;;;GAKG;AACH,wBAAgB,sCAAsC,CAAC,IAAI,EAAE,YAAY,gHA8BxE"}

package/dist/names.mjs

@@ -0,0 +1,39 @@
+import { KeyringTypes } from "@metamask/keyring-controller";
+/**
+ * Get wallet name from a keyring type.
+ *
+ * @param type - Keyring's type.
+ * @returns Wallet name.
+ */
+export function getAccountGroupRootNameFromKeyringType(type) {
+    switch (type) {
+        case KeyringTypes.simple: {
+            return 'Private Keys';
+        }
+        case KeyringTypes.hd: {
+            return 'HD Wallet';
+        }
+        case KeyringTypes.trezor: {
+            return 'Trezor';
+        }
+        case KeyringTypes.oneKey: {
+            return 'OneKey';
+        }
+        case KeyringTypes.ledger: {
+            return 'Ledger';
+        }
+        case KeyringTypes.lattice: {
+            return 'Lattice';
+        }
+        case KeyringTypes.qr: {
+            return 'QR';
+        }
+        case KeyringTypes.snap: {
+            return 'Snap Wallet';
+        }
+        default: {
+            return 'Unknown';
+        }
+    }
+}
+//# sourceMappingURL=names.mjs.map

package/dist/names.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"names.mjs","sourceRoot":"","sources":["../src/names.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAE5D;;;;;GAKG;AACH,MAAM,UAAU,sCAAsC,CAAC,IAAkB;IACvE,QAAQ,IAAI,EAAE;QACZ,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,cAAc,CAAC;SACvB;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,WAAW,CAAC;SACpB;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,QAAQ,CAAC;SACjB;QACD,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;SAClB;QACD,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;SACb;QACD,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;YACtB,OAAO,aAAa,CAAC;SACtB;QACD,OAAO,CAAC,CAAC;YACP,OAAO,SAAS,CAAC;SAClB;KACF;AACH,CAAC","sourcesContent":["import { KeyringTypes } from '@metamask/keyring-controller';\n\n/**\n * Get wallet name from a keyring type.\n *\n * @param type - Keyring's type.\n * @returns Wallet name.\n */\nexport function getAccountGroupRootNameFromKeyringType(type: KeyringTypes) {\n  switch (type) {\n    case KeyringTypes.simple: {\n      return 'Private Keys';\n    }\n    case KeyringTypes.hd: {\n      return 'HD Wallet';\n    }\n    case KeyringTypes.trezor: {\n      return 'Trezor';\n    }\n    case KeyringTypes.oneKey: {\n      return 'OneKey';\n    }\n    case KeyringTypes.ledger: {\n      return 'Ledger';\n    }\n    case KeyringTypes.lattice: {\n      return 'Lattice';\n    }\n    case KeyringTypes.qr: {\n      return 'QR';\n    }\n    case KeyringTypes.snap: {\n      return 'Snap Wallet';\n    }\n    default: {\n      return 'Unknown';\n    }\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@metamask-previews/account-tree-controller",
+  "version": "0.0.0-preview-d9a49231",
+  "description": "Controller to group account together based on some pre-defined rules",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/account-tree-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/account-tree-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/account-tree-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^8.0.1",
+    "@metamask/snaps-sdk": "^6.22.0",
+    "@metamask/snaps-utils": "^9.2.0",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@metamask/accounts-controller": "^29.0.0",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/keyring-api": "^17.4.0",
+    "@metamask/keyring-controller": "^22.0.0",
+    "@metamask/providers": "^21.0.0",
+    "@metamask/snaps-controllers": "^11.2.1",
+    "@types/jest": "^27.4.1",
+    "@types/lodash": "^4.14.191",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2",
+    "webextension-polyfill": "^0.12.0"
+  },
+  "peerDependencies": {
+    "@metamask/accounts-controller": "^29.0.0",
+    "@metamask/keyring-controller": "^22.0.0",
+    "@metamask/providers": "^21.0.0",
+    "@metamask/snaps-controllers": "^11.0.0",
+    "webextension-polyfill": "^0.10.0 || ^0.11.0 || ^0.12.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}