@metamask-previews/account-tree-controller 0.4.0-preview-d90711c → 0.4.0-preview-ea7474e2

package/dist/AccountTreeController.mjs

@@ -9,18 +9,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _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;
+var _AccountTreeController_instances, _AccountTreeController_reverse, _AccountTreeController_rules, _AccountTreeController_wallets, _AccountTreeController_handleAccountAdded, _AccountTreeController_handleAccountRemoved, _AccountTreeController_insert, _AccountTreeController_listAccounts;
 import { BaseController } from "@metamask/base-controller";
-import { KeyringTypes } from "@metamask/keyring-controller";
-import { stripSnapPrefix } from "@metamask/snaps-utils";
-import { getAccountWalletNameFromKeyringType } from "./names.mjs";
+import { EntropySourceWalletRule, SnapWalletRule, KeyringWalletRule } from "./rules/index.mjs";
 const controllerName = 'AccountTreeController';
-export var AccountWalletCategory;
-(function (AccountWalletCategory) {
-    AccountWalletCategory["Entropy"] = "entropy";
-    AccountWalletCategory["Keyring"] = "keyring";
-    AccountWalletCategory["Snap"] = "snap";
-})(AccountWalletCategory || (AccountWalletCategory = {}));
 const accountTreeControllerMetadata = {
     accountTree: {
         persist: false,
@@ -39,38 +31,6 @@ export function getDefaultAccountTreeControllerState() {
         },
     };
 }
-// 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 wallet ID for a given category.
- *
- * @param category - A wallet category.
- * @param id - A unique ID.
- * @returns A wallet ID.
- */
-export function toAccountWalletId(category, id) {
-    return `${category}:${id}`;
-}
-/**
- * Convert a wallet ID and a unique ID, to a group ID.
- *
- * @param walletId - A wallet ID.
- * @param id - A unique ID.
- * @returns A group ID.
- */
-export function toAccountGroupId(walletId, id) {
-    return `${walletId}:${id}`;
-}
-/**
- * Convert a wallet ID to the default group ID.
- *
- * @param walletId - A wallet ID.
- * @returns The default group ID.
- */
-export function toDefaultAccountGroupId(walletId) {
-    return toAccountGroupId(walletId, DEFAULT_ACCOUNT_GROUP_UNIQUE_ID);
-}
 export class AccountTreeController extends BaseController {
     /**
      * Constructor for AccountTreeController.
@@ -92,16 +52,18 @@ export class AccountTreeController extends BaseController {
         _AccountTreeController_instances.add(this);
         _AccountTreeController_reverse.set(this, void 0);
         _AccountTreeController_rules.set(this, void 0);
+        _AccountTreeController_wallets.set(this, void 0);
+        __classPrivateFieldSet(this, _AccountTreeController_wallets, new Map(), "f");
         // 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),
+            new EntropySourceWalletRule(this.messagingSystem),
             // 2. We group by Snap ID
-            (account) => __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_matchGroupBySnapId).call(this, account),
+            new SnapWalletRule(this.messagingSystem),
             // 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),
+            new KeyringWalletRule(this.messagingSystem),
         ], "f");
         this.messagingSystem.subscribe('AccountsController:accountAdded', (account) => {
             __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleAccountAdded).call(this, account);
@@ -120,8 +82,14 @@ export class AccountTreeController extends BaseController {
             state.accountTree.wallets = wallets;
         });
     }
+    getWallet(id) {
+        return __classPrivateFieldGet(this, _AccountTreeController_wallets, "f").get(id);
+    }
+    getWallets() {
+        return Array.from(__classPrivateFieldGet(this, _AccountTreeController_wallets, "f").values());
+    }
 }
-_AccountTreeController_reverse = new WeakMap(), _AccountTreeController_rules = new WeakMap(), _AccountTreeController_instances = new WeakSet(), _AccountTreeController_handleAccountAdded = function _AccountTreeController_handleAccountAdded(account) {
+_AccountTreeController_reverse = new WeakMap(), _AccountTreeController_rules = new WeakMap(), _AccountTreeController_wallets = 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.accountTree.wallets, account);
     });
@@ -137,109 +105,37 @@ _AccountTreeController_reverse = new WeakMap(), _AccountTreeController_rules = n
             }
         });
     }
-}, _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: AccountWalletCategory.Entropy,
-        id: toAccountWalletId(AccountWalletCategory.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: AccountWalletCategory.Snap,
-            id: toAccountWalletId(AccountWalletCategory.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: AccountWalletCategory.Keyring,
-        id: toAccountWalletId(AccountWalletCategory.Keyring, type),
-        name: getAccountWalletNameFromKeyringType(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 to.
-            snap.manifest.proposedName
-        : stripSnapPrefix(snapId);
-    return 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(wallets, account) {
     for (const rule of __classPrivateFieldGet(this, _AccountTreeController_rules, "f")) {
-        const match = rule(account);
+        const match = rule.match(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 (!wallets[walletId]) {
-            wallets[walletId] = {
-                id: walletId,
+        const { wallet, group } = match;
+        // Update in-memory wallet/group instances.
+        __classPrivateFieldGet(this, _AccountTreeController_wallets, "f").set(wallet.id, wallet);
+        // Update controller's state.
+        if (!wallets[wallet.id]) {
+            wallets[wallet.id] = {
+                id: wallet.id,
                 groups: {
-                    [groupId]: {
-                        id: groupId,
+                    [group.id]: {
+                        id: group.id,
                         accounts: [],
-                        metadata: { name: groupName },
+                        metadata: { name: group.getDefaultName() },
                     },
                 },
                 metadata: {
-                    name: walletName,
+                    name: wallet.getDefaultName(),
                 },
             };
         }
-        wallets[walletId].groups[groupId].accounts.push(account.id);
+        wallets[wallet.id].groups[group.id].accounts.push(account.id);
         // Update the reverse mapping for this account.
         __classPrivateFieldGet(this, _AccountTreeController_reverse, "f").set(account.id, {
-            walletId,
-            groupId,
+            walletId: wallet.id,
+            groupId: group.id,
         });
         return;
     }

package/dist/AccountTreeController.mjs.map

@@ -1 +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,mCAAmC,EAAE,oBAAgB;AAE9D,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAE/C,MAAM,CAAN,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,4CAAmB,CAAA;IACnB,4CAAmB,CAAA;IACnB,sCAAa,CAAA;AACf,CAAC,EAJW,qBAAqB,KAArB,qBAAqB,QAIhC;AAqFD,MAAM,6BAA6B,GACjC;IACE,WAAW,EAAE;QACX,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AAEJ;;;;GAIG;AACH,MAAM,UAAU,oCAAoC;IAClD,OAAO;QACL,WAAW,EAAE;YACX,OAAO,EAAE,EAAE;SACZ;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,iBAAiB,CAC/B,QAA+B,EAC/B,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAyB,EACzB,EAAU;IAEV,OAAO,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAAyB;IAEzB,OAAO,gBAAgB,CAAC,QAAQ,EAAE,+BAA+B,CAAC,CAAC;AACrE,CAAC;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,+CAAkC;QA0BzC,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,OAAO,GAAG,EAAE,CAAC;QAEnB,kFAAkF;QAClF,KAAK,MAAM,OAAO,IAAI,uBAAA,IAAI,6EAAc,MAAlB,IAAI,CAAgB,EAAE;YAC1C,uBAAA,IAAI,uEAAQ,MAAZ,IAAI,EAAS,OAAO,EAAE,OAAO,CAAC,CAAC;SAChC;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC;CA2LF;+OAzLqB,OAAwB;IAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,uBAAA,IAAI,uEAAQ,MAAZ,IAAI,EAAS,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACnD,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,GAChB,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAEtD,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,qBAAqB,CAAC,OAAO;QACvC,EAAE,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,OAAO,EAAE,aAAa,CAAC;QACnE,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,qBAAqB,CAAC,IAAI;YACpC,EAAE,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,IAAI,EAAE,EAAE,CAAC;YACrD,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,qBAAqB,CAAC,OAAO;QACvC,EAAE,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC;QAC1D,IAAI,EAAE,mCAAmC,CAAC,IAAoB,CAAC;KAChE,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,eAAe;YACf,IAAI,CAAC,QAAQ,CAAC,YAAY;QAC5B,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAE5B,OAAO,QAAQ,CAAC;AAClB,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,OAAuD,EACvD,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,OAAO,CAAC,QAAQ,CAAC,EAAE;YACtB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBAClB,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,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE5D,+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,CAC5C,CAAC;AACJ,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 { getAccountWalletNameFromKeyringType } from './names';\n\nconst controllerName = 'AccountTreeController';\n\nexport enum AccountWalletCategory {\n  Entropy = 'entropy',\n  Keyring = 'keyring',\n  Snap = 'snap',\n}\n\ntype AccountTreeRuleMatch = {\n  category: AccountWalletCategory;\n  id: AccountWalletId;\n  name: string;\n};\n\ntype AccountTreeRuleFunction = (\n  account: InternalAccount,\n) => AccountTreeRuleMatch | undefined;\n\ntype AccountReverseMapping = {\n  walletId: AccountWalletId;\n  groupId: AccountGroupId;\n};\n\nexport type AccountWalletId = `${AccountWalletCategory}:${string}`;\nexport type AccountGroupId = `${AccountWalletId}:${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 AccountWalletMetadata = 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 AccountWallet = {\n  id: AccountWalletId;\n  // Account groups OR Multichain accounts (once available).\n  groups: {\n    [groupId: AccountGroupId]: AccountGroup;\n  };\n  metadata: AccountWalletMetadata;\n};\n\nexport type AccountTreeControllerState = {\n  accountTree: {\n    wallets: {\n      // Wallets:\n      [walletId: AccountWalletId]: AccountWallet;\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 AccountTreeControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AccountTreeControllerState\n>;\n\nexport type AllowedEvents =\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent;\n\nexport type AccountTreeControllerEvents = AccountTreeControllerStateChangeEvent;\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    accountTree: {\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    accountTree: {\n      wallets: {},\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 wallet ID for a given category.\n *\n * @param category - A wallet category.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId(\n  category: AccountWalletCategory,\n  id: string,\n): AccountWalletId {\n  return `${category}:${id}`;\n}\n\n/**\n * Convert a wallet ID and a unique ID, to a group ID.\n *\n * @param walletId - A wallet ID.\n * @param id - A unique ID.\n * @returns A group ID.\n */\nexport function toAccountGroupId(\n  walletId: AccountWalletId,\n  id: string,\n): AccountGroupId {\n  return `${walletId}:${id}`;\n}\n\n/**\n * Convert a wallet ID to the default group ID.\n *\n * @param walletId - A wallet ID.\n * @returns The default group ID.\n */\nexport function toDefaultAccountGroupId(\n  walletId: AccountWalletId,\n): AccountGroupId {\n  return toAccountGroupId(walletId, DEFAULT_ACCOUNT_GROUP_UNIQUE_ID);\n}\n\nexport class AccountTreeController extends BaseController<\n  typeof controllerName,\n  AccountTreeControllerState,\n  AccountTreeControllerMessenger\n> {\n  readonly #reverse: Map<AccountId, AccountReverseMapping>;\n\n  readonly #rules: AccountTreeRuleFunction[];\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 wallets = {};\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(wallets, account);\n    }\n\n    this.update((state) => {\n      state.accountTree.wallets = wallets;\n    });\n  }\n\n  #handleAccountAdded(account: InternalAccount) {\n    this.update((state) => {\n      this.#insert(state.accountTree.wallets, 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 } =\n          state.accountTree.wallets[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: AccountWalletCategory.Entropy,\n      id: toAccountWalletId(AccountWalletCategory.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: AccountWalletCategory.Snap,\n        id: toAccountWalletId(AccountWalletCategory.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: AccountWalletCategory.Keyring,\n      id: toAccountWalletId(AccountWalletCategory.Keyring, type),\n      name: getAccountWalletNameFromKeyringType(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 to.\n        snap.manifest.proposedName\n      : stripSnapPrefix(snapId);\n\n    return 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    wallets: { [walletId: AccountWalletId]: AccountWallet },\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 (!wallets[walletId]) {\n        wallets[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      wallets[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    );\n  }\n}\n"]}
+{"version":3,"file":"AccountTreeController.mjs","sourceRoot":"","sources":["../src/AccountTreeController.ts"],"names":[],"mappings":";;;;;;;;;;;;AASA,OAAO,EAIL,cAAc,EACf,kCAAkC;AAOnC,OAAO,EACL,uBAAuB,EACvB,cAAc,EACd,iBAAiB,EAClB,0BAAgB;AAEjB,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAyE/C,MAAM,6BAA6B,GACjC;IACE,WAAW,EAAE;QACX,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AAEJ;;;;GAIG;AACH,MAAM,UAAU,oCAAoC;IAClD,OAAO;QACL,WAAW,EAAE;YACX,OAAO,EAAE,EAAE;SACZ;KACF,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,qBAAsB,SAAQ,cAI1C;IAOC;;;;;;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;;QA5BI,iDAAgD;QAEhD,+CAAqB;QAErB,iDAAkD;QAyBzD,uBAAA,IAAI,kCAAY,IAAI,GAAG,EAAE,MAAA,CAAC;QAE1B,4DAA4D;QAC5D,uBAAA,IAAI,kCAAY,IAAI,GAAG,EAAE,MAAA,CAAC;QAE1B,gDAAgD;QAChD,uBAAA,IAAI,gCAAU;YACZ,gCAAgC;YAChC,IAAI,uBAAuB,CAAC,IAAI,CAAC,eAAe,CAAC;YACjD,yBAAyB;YACzB,IAAI,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC;YACxC,8FAA8F;YAC9F,IAAI,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC;SAC5C,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,OAAO,GAAG,EAAE,CAAC;QAEnB,kFAAkF;QAClF,KAAK,MAAM,OAAO,IAAI,uBAAA,IAAI,6EAAc,MAAlB,IAAI,CAAgB,EAAE;YAC1C,uBAAA,IAAI,uEAAQ,MAAZ,IAAI,EAAS,OAAO,EAAE,OAAO,CAAC,CAAC;SAChC;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,SAAS,CAAC,EAAmB;QAC3B,OAAO,uBAAA,IAAI,sCAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,sCAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5C,CAAC;CA2EF;+RAzEqB,OAAwB;IAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,uBAAA,IAAI,uEAAQ,MAAZ,IAAI,EAAS,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACnD,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,GAChB,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAEtD,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,yEAGC,OAA6D,EAC7D,OAAwB;IAExB,KAAK,MAAM,IAAI,IAAI,uBAAA,IAAI,oCAAO,EAAE;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK,EAAE;YACV,iDAAiD;YACjD,SAAS;SACV;QAED,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;QAEhC,2CAA2C;QAC3C,uBAAA,IAAI,sCAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAErC,6BAA6B;QAC7B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;YACvB,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG;gBACnB,EAAE,EAAE,MAAM,CAAC,EAAE;gBACb,MAAM,EAAE;oBACN,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE;wBACV,EAAE,EAAE,KAAK,CAAC,EAAE;wBACZ,QAAQ,EAAE,EAAE;wBACZ,QAAQ,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,cAAc,EAAE,EAAE;qBAC3C;iBACF;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM,CAAC,cAAc,EAAE;iBAC9B;aACF,CAAC;SACH;QACD,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE9D,+CAA+C;QAC/C,uBAAA,IAAI,sCAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE;YAC5B,QAAQ,EAAE,MAAM,CAAC,EAAE;YACnB,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CAAC,CAAC;QAEH,OAAO;KACR;AACH,CAAC;IAGC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,2CAA2C,CAC5C,CAAC;AACJ,CAAC","sourcesContent":["import type { AccountGroupId, AccountWalletId } from '@metamask/account-api';\nimport type {\n  AccountId,\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerGetAccountAction,\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 type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { GetSnap as SnapControllerGetSnap } from '@metamask/snaps-controllers';\n\nimport type { AccountTreeWallet } from './AccountTreeWallet';\nimport type { WalletRule } from './rules';\nimport {\n  EntropySourceWalletRule,\n  SnapWalletRule,\n  KeyringWalletRule,\n} from './rules';\n\nconst controllerName = 'AccountTreeController';\n\ntype AccountReverseMapping = {\n  walletId: AccountWalletId;\n  groupId: AccountGroupId;\n};\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 AccountWalletMetadata = Metadata;\n\nexport type AccountGroupMetadata = Metadata;\n\nexport type AccountGroupObject = {\n  id: AccountGroupId;\n  // Blockchain Accounts:\n  accounts: AccountId[];\n  metadata: AccountGroupMetadata;\n};\n\nexport type AccountWalletObject = {\n  id: AccountWalletId;\n  // Account groups OR Multichain accounts (once available).\n  groups: {\n    [groupId: AccountGroupId]: AccountGroupObject;\n  };\n  metadata: AccountWalletMetadata;\n};\n\nexport type AccountTreeControllerState = {\n  accountTree: {\n    wallets: {\n      // Wallets:\n      [walletId: AccountWalletId]: AccountWalletObject;\n    };\n  };\n};\n\nexport type AccountTreeControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AccountTreeControllerState\n>;\n\nexport type AllowedActions =\n  | AccountsControllerGetAccountAction\n  | AccountsControllerListMultichainAccountsAction\n  | KeyringControllerGetStateAction\n  | SnapControllerGetSnap;\n\nexport type AccountTreeControllerActions = never;\n\nexport type AccountTreeControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AccountTreeControllerState\n>;\n\nexport type AllowedEvents =\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent;\n\nexport type AccountTreeControllerEvents = AccountTreeControllerStateChangeEvent;\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    accountTree: {\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    accountTree: {\n      wallets: {},\n    },\n  };\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: WalletRule[];\n\n  readonly #wallets: Map<AccountWalletId, AccountTreeWallet>;\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    this.#wallets = new Map();\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      new EntropySourceWalletRule(this.messagingSystem),\n      // 2. We group by Snap ID\n      new SnapWalletRule(this.messagingSystem),\n      // 3. We group by wallet type (this rule cannot fail and will group all non-matching accounts)\n      new KeyringWalletRule(this.messagingSystem),\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 wallets = {};\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(wallets, account);\n    }\n\n    this.update((state) => {\n      state.accountTree.wallets = wallets;\n    });\n  }\n\n  getWallet(id: AccountWalletId): AccountTreeWallet | undefined {\n    return this.#wallets.get(id);\n  }\n\n  getWallets(): AccountTreeWallet[] {\n    return Array.from(this.#wallets.values());\n  }\n\n  #handleAccountAdded(account: InternalAccount) {\n    this.update((state) => {\n      this.#insert(state.accountTree.wallets, 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 } =\n          state.accountTree.wallets[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  #insert(\n    wallets: { [walletId: AccountWalletId]: AccountWalletObject },\n    account: InternalAccount,\n  ) {\n    for (const rule of this.#rules) {\n      const match = rule.match(account);\n\n      if (!match) {\n        // No match for that rule, we go to the next one.\n        continue;\n      }\n\n      const { wallet, group } = match;\n\n      // Update in-memory wallet/group instances.\n      this.#wallets.set(wallet.id, wallet);\n\n      // Update controller's state.\n      if (!wallets[wallet.id]) {\n        wallets[wallet.id] = {\n          id: wallet.id,\n          groups: {\n            [group.id]: {\n              id: group.id,\n              accounts: [],\n              metadata: { name: group.getDefaultName() },\n            },\n          },\n          metadata: {\n            name: wallet.getDefaultName(),\n          },\n        };\n      }\n      wallets[wallet.id].groups[group.id].accounts.push(account.id);\n\n      // Update the reverse mapping for this account.\n      this.#reverse.set(account.id, {\n        walletId: wallet.id,\n        groupId: group.id,\n      });\n\n      return;\n    }\n  }\n\n  #listAccounts(): InternalAccount[] {\n    return this.messagingSystem.call(\n      'AccountsController:listMultichainAccounts',\n    );\n  }\n}\n"]}

package/dist/AccountTreeGroup.cjs

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

package/dist/AccountTreeGroup.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeGroup.cjs","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAK+B;AAKlB,QAAA,0BAA0B,GAAW,SAAS,CAAC;AAiB5D,0FAA0F;AAC1F,iDAAiD;AACjD,MAAa,uBAAuB;IASlC,YACE,SAAyC,EACzC,MAAsC,EACtC,EAAU;QALH,oDAA0B;QAOjC,IAAI,CAAC,EAAE,GAAG,IAAA,8BAAgB,EAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,qCAAa,IAAI,GAAG,EAAE,MAAA,CAAC;IAC7B,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,yCAAU,CAAC,CAAC,CAAC,wCAAwC;IAC7E,CAAC;IAED,WAAW;QACT,MAAM,QAAQ,GAAG,EAAE,CAAC;QAEpB,KAAK,MAAM,EAAE,IAAI,uBAAA,IAAI,yCAAU,EAAE;YAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAEpC,qEAAqE;YACrE,qEAAqE;YACrE,eAAe;YACf,IAAI,CAAC,OAAO,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;gBACjD,SAAS;aACV;YACD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,UAAU,CAAC,EAAa;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,UAAU,CAAC,OAAwB;QACjC,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,cAAc;QACZ,OAAO,kCAA0B,CAAC;IACpC,CAAC;CACF;AAtDD,0DAsDC","sourcesContent":["import {\n  toAccountGroupId,\n  type AccountGroup,\n  type AccountGroupId,\n  type AccountWallet,\n} from '@metamask/account-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { AccountId } from '@metamask/keyring-utils';\nimport type { AccountTreeControllerMessenger } from 'src';\n\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\n/**\n * Account group coming from the {@link AccountTreeController}.\n */\nexport type AccountTreeGroup = {\n  /**\n   * Account IDs for that account group.\n   */\n  getAccountIds(): AccountId[];\n\n  /**\n   * Gets the default name for that account group.\n   */\n  getDefaultName(): string;\n} & AccountGroup<InternalAccount>;\n\n// This class is meant to be used internally by every rules. It exposes mutable operations\n// which should not leak outside of this package.\nexport class MutableAccountTreeGroup implements AccountTreeGroup {\n  readonly id: AccountGroupId;\n\n  readonly wallet: AccountWallet<InternalAccount>;\n\n  readonly messenger: AccountTreeControllerMessenger;\n\n  readonly #accounts: Set<AccountId>;\n\n  constructor(\n    messenger: AccountTreeControllerMessenger,\n    wallet: AccountWallet<InternalAccount>,\n    id: string,\n  ) {\n    this.id = toAccountGroupId(wallet.id, id);\n    this.wallet = wallet;\n    this.messenger = messenger;\n\n    this.#accounts = new Set();\n  }\n\n  getAccountIds(): AccountId[] {\n    return Array.from(this.#accounts); // FIXME: Should we force the copy here?\n  }\n\n  getAccounts(): InternalAccount[] {\n    const accounts = [];\n\n    for (const id of this.#accounts) {\n      const account = this.getAccount(id);\n\n      // FIXME: I'm really not sure we should skip those but... We could be\n      // \"de-sync\" with the AccountsController and might have some dangling\n      // account IDs.\n      if (!account) {\n        console.warn(`! Unable to get account: \"${id}\"`);\n        continue;\n      }\n      accounts.push(account);\n    }\n    return accounts;\n  }\n\n  getAccount(id: AccountId): InternalAccount | undefined {\n    return this.messenger.call('AccountsController:getAccount', id);\n  }\n\n  addAccount(account: InternalAccount) {\n    this.#accounts.add(account.id);\n  }\n\n  getDefaultName(): string {\n    return DEFAULT_ACCOUNT_GROUP_NAME;\n  }\n}\n"]}

package/dist/AccountTreeGroup.d.cts

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

package/dist/AccountTreeGroup.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeGroup.d.cts","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,aAAa,EACnB,8BAA8B;AAC/B,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AACzD,OAAO,KAAK,EAAE,8BAA8B,EAAE,YAAY;AAE1D,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,aAAa,IAAI,SAAS,EAAE,CAAC;IAE7B;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;CAC1B,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;AAIlC,qBAAa,uBAAwB,YAAW,gBAAgB;;IAC9D,QAAQ,CAAC,EAAE,EAAE,cAAc,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAEhD,QAAQ,CAAC,SAAS,EAAE,8BAA8B,CAAC;gBAKjD,SAAS,EAAE,8BAA8B,EACzC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,EACtC,EAAE,EAAE,MAAM;IASZ,aAAa,IAAI,SAAS,EAAE;IAI5B,WAAW,IAAI,eAAe,EAAE;IAkBhC,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,eAAe,GAAG,SAAS;IAItD,UAAU,CAAC,OAAO,EAAE,eAAe;IAInC,cAAc,IAAI,MAAM;CAGzB"}

package/dist/AccountTreeGroup.d.mts

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

package/dist/AccountTreeGroup.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeGroup.d.mts","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,aAAa,EACnB,8BAA8B;AAC/B,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AACzD,OAAO,KAAK,EAAE,8BAA8B,EAAE,YAAY;AAE1D,eAAO,MAAM,0BAA0B,EAAE,MAAkB,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,aAAa,IAAI,SAAS,EAAE,CAAC;IAE7B;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;CAC1B,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;AAIlC,qBAAa,uBAAwB,YAAW,gBAAgB;;IAC9D,QAAQ,CAAC,EAAE,EAAE,cAAc,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAEhD,QAAQ,CAAC,SAAS,EAAE,8BAA8B,CAAC;gBAKjD,SAAS,EAAE,8BAA8B,EACzC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,EACtC,EAAE,EAAE,MAAM;IASZ,aAAa,IAAI,SAAS,EAAE;IAI5B,WAAW,IAAI,eAAe,EAAE;IAkBhC,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,eAAe,GAAG,SAAS;IAItD,UAAU,CAAC,OAAO,EAAE,eAAe;IAInC,cAAc,IAAI,MAAM;CAGzB"}

package/dist/AccountTreeGroup.mjs

@@ -0,0 +1,54 @@
+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 _MutableAccountTreeGroup_accounts;
+import { toAccountGroupId } from "@metamask/account-api";
+export const DEFAULT_ACCOUNT_GROUP_NAME = 'Default';
+// This class is meant to be used internally by every rules. It exposes mutable operations
+// which should not leak outside of this package.
+export class MutableAccountTreeGroup {
+    constructor(messenger, wallet, id) {
+        _MutableAccountTreeGroup_accounts.set(this, void 0);
+        this.id = toAccountGroupId(wallet.id, id);
+        this.wallet = wallet;
+        this.messenger = messenger;
+        __classPrivateFieldSet(this, _MutableAccountTreeGroup_accounts, new Set(), "f");
+    }
+    getAccountIds() {
+        return Array.from(__classPrivateFieldGet(this, _MutableAccountTreeGroup_accounts, "f")); // FIXME: Should we force the copy here?
+    }
+    getAccounts() {
+        const accounts = [];
+        for (const id of __classPrivateFieldGet(this, _MutableAccountTreeGroup_accounts, "f")) {
+            const account = this.getAccount(id);
+            // FIXME: I'm really not sure we should skip those but... We could be
+            // "de-sync" with the AccountsController and might have some dangling
+            // account IDs.
+            if (!account) {
+                console.warn(`! Unable to get account: "${id}"`);
+                continue;
+            }
+            accounts.push(account);
+        }
+        return accounts;
+    }
+    getAccount(id) {
+        return this.messenger.call('AccountsController:getAccount', id);
+    }
+    addAccount(account) {
+        __classPrivateFieldGet(this, _MutableAccountTreeGroup_accounts, "f").add(account.id);
+    }
+    getDefaultName() {
+        return DEFAULT_ACCOUNT_GROUP_NAME;
+    }
+}
+_MutableAccountTreeGroup_accounts = new WeakMap();
+//# sourceMappingURL=AccountTreeGroup.mjs.map

package/dist/AccountTreeGroup.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeGroup.mjs","sourceRoot":"","sources":["../src/AccountTreeGroup.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,gBAAgB,EAIjB,8BAA8B;AAK/B,MAAM,CAAC,MAAM,0BAA0B,GAAW,SAAS,CAAC;AAiB5D,0FAA0F;AAC1F,iDAAiD;AACjD,MAAM,OAAO,uBAAuB;IASlC,YACE,SAAyC,EACzC,MAAsC,EACtC,EAAU;QALH,oDAA0B;QAOjC,IAAI,CAAC,EAAE,GAAG,gBAAgB,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,qCAAa,IAAI,GAAG,EAAE,MAAA,CAAC;IAC7B,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,yCAAU,CAAC,CAAC,CAAC,wCAAwC;IAC7E,CAAC;IAED,WAAW;QACT,MAAM,QAAQ,GAAG,EAAE,CAAC;QAEpB,KAAK,MAAM,EAAE,IAAI,uBAAA,IAAI,yCAAU,EAAE;YAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAEpC,qEAAqE;YACrE,qEAAqE;YACrE,eAAe;YACf,IAAI,CAAC,OAAO,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;gBACjD,SAAS;aACV;YACD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,UAAU,CAAC,EAAa;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,UAAU,CAAC,OAAwB;QACjC,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,cAAc;QACZ,OAAO,0BAA0B,CAAC;IACpC,CAAC;CACF","sourcesContent":["import {\n  toAccountGroupId,\n  type AccountGroup,\n  type AccountGroupId,\n  type AccountWallet,\n} from '@metamask/account-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { AccountId } from '@metamask/keyring-utils';\nimport type { AccountTreeControllerMessenger } from 'src';\n\nexport const DEFAULT_ACCOUNT_GROUP_NAME: string = 'Default';\n\n/**\n * Account group coming from the {@link AccountTreeController}.\n */\nexport type AccountTreeGroup = {\n  /**\n   * Account IDs for that account group.\n   */\n  getAccountIds(): AccountId[];\n\n  /**\n   * Gets the default name for that account group.\n   */\n  getDefaultName(): string;\n} & AccountGroup<InternalAccount>;\n\n// This class is meant to be used internally by every rules. It exposes mutable operations\n// which should not leak outside of this package.\nexport class MutableAccountTreeGroup implements AccountTreeGroup {\n  readonly id: AccountGroupId;\n\n  readonly wallet: AccountWallet<InternalAccount>;\n\n  readonly messenger: AccountTreeControllerMessenger;\n\n  readonly #accounts: Set<AccountId>;\n\n  constructor(\n    messenger: AccountTreeControllerMessenger,\n    wallet: AccountWallet<InternalAccount>,\n    id: string,\n  ) {\n    this.id = toAccountGroupId(wallet.id, id);\n    this.wallet = wallet;\n    this.messenger = messenger;\n\n    this.#accounts = new Set();\n  }\n\n  getAccountIds(): AccountId[] {\n    return Array.from(this.#accounts); // FIXME: Should we force the copy here?\n  }\n\n  getAccounts(): InternalAccount[] {\n    const accounts = [];\n\n    for (const id of this.#accounts) {\n      const account = this.getAccount(id);\n\n      // FIXME: I'm really not sure we should skip those but... We could be\n      // \"de-sync\" with the AccountsController and might have some dangling\n      // account IDs.\n      if (!account) {\n        console.warn(`! Unable to get account: \"${id}\"`);\n        continue;\n      }\n      accounts.push(account);\n    }\n    return accounts;\n  }\n\n  getAccount(id: AccountId): InternalAccount | undefined {\n    return this.messenger.call('AccountsController:getAccount', id);\n  }\n\n  addAccount(account: InternalAccount) {\n    this.#accounts.add(account.id);\n  }\n\n  getDefaultName(): string {\n    return DEFAULT_ACCOUNT_GROUP_NAME;\n  }\n}\n"]}

package/dist/AccountTreeWallet.cjs

@@ -0,0 +1,50 @@
+"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 _MutableAccountTreeWallet_groups;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MutableAccountTreeWallet = void 0;
+const account_api_1 = require("@metamask/account-api");
+const AccountTreeGroup_1 = require("./AccountTreeGroup.cjs");
+// This class is meant to be used internally by every rules. It exposes mutable operations
+// which should not leak outside of this package.
+class MutableAccountTreeWallet {
+    constructor(messenger, category, id) {
+        _MutableAccountTreeWallet_groups.set(this, void 0);
+        this.id = (0, account_api_1.toAccountWalletId)(category, id);
+        this.category = category;
+        this.messenger = messenger;
+        __classPrivateFieldSet(this, _MutableAccountTreeWallet_groups, new Map(), "f");
+    }
+    getAccountGroup(groupId) {
+        return __classPrivateFieldGet(this, _MutableAccountTreeWallet_groups, "f").get(groupId);
+    }
+    getAccountGroups() {
+        return Array.from(__classPrivateFieldGet(this, _MutableAccountTreeWallet_groups, "f").values()); // TODO: Should we avoid the copy here?
+    }
+    // NOTE: This method SHOULD BE overriden if a rule need to group things differently.
+    addAccount(account) {
+        const id = account_api_1.DEFAULT_ACCOUNT_GROUP_UNIQUE_ID;
+        // Use a single-group by default.
+        let group = __classPrivateFieldGet(this, _MutableAccountTreeWallet_groups, "f").get((0, account_api_1.toAccountGroupId)(this.id, id));
+        if (!group) {
+            // We create the account group and attach it to this wallet.
+            group = new AccountTreeGroup_1.MutableAccountTreeGroup(this.messenger, this, id);
+            __classPrivateFieldGet(this, _MutableAccountTreeWallet_groups, "f").set(group.id, group);
+        }
+        group.addAccount(account);
+        return group;
+    }
+}
+exports.MutableAccountTreeWallet = MutableAccountTreeWallet;
+_MutableAccountTreeWallet_groups = new WeakMap();
+//# sourceMappingURL=AccountTreeWallet.cjs.map

package/dist/AccountTreeWallet.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeWallet.cjs","sourceRoot":"","sources":["../src/AccountTreeWallet.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAQ+B;AAK/B,6DAA6D;AA0B7D,0FAA0F;AAC1F,iDAAiD;AACjD,MAAsB,wBAAwB;IAS5C,YACE,SAAyC,EACzC,QAA+B,EAC/B,EAAU;QALH,mDAAsD;QAO7D,IAAI,CAAC,EAAE,GAAG,IAAA,+BAAiB,EAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,oCAAW,IAAI,GAAG,EAAE,MAAA,CAAC;IAC3B,CAAC;IAED,eAAe,CAAC,OAAuB;QACrC,OAAO,uBAAA,IAAI,wCAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,gBAAgB;QACd,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,wCAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,uCAAuC;IACnF,CAAC;IAED,oFAAoF;IACpF,UAAU,CAAC,OAAwB;QACjC,MAAM,EAAE,GAAG,6CAA+B,CAAC;QAE3C,iCAAiC;QACjC,IAAI,KAAK,GAAG,uBAAA,IAAI,wCAAQ,CAAC,GAAG,CAAC,IAAA,8BAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,EAAE;YACV,4DAA4D;YAC5D,KAAK,GAAG,IAAI,0CAAuB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YAC9D,uBAAA,IAAI,wCAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACnC;QAED,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE1B,OAAO,KAAK,CAAC;IACf,CAAC;CAGF;AA/CD,4DA+CC","sourcesContent":["import {\n  toAccountGroupId,\n  toAccountWalletId,\n  DEFAULT_ACCOUNT_GROUP_UNIQUE_ID,\n  type AccountGroupId,\n  type AccountWallet,\n  type AccountWalletCategory,\n  type AccountWalletId,\n} from '@metamask/account-api';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\n\nimport { type AccountTreeControllerMessenger } from './AccountTreeController';\nimport type { AccountTreeGroup } from './AccountTreeGroup';\nimport { MutableAccountTreeGroup } from './AccountTreeGroup';\n\n/**\n * Account wallet coming from the {@link AccountTreeController}.\n */\nexport type AccountTreeWallet = {\n  /**\n   * Gets account tree group for a given ID.\n   *\n   * @returns Account tree group.\n   */\n  getAccountGroup(groupId: AccountGroupId): AccountTreeGroup | undefined;\n\n  /**\n   * Gets all account tree groups.\n   *\n   * @returns Account tree groups.\n   */\n  getAccountGroups(): AccountTreeGroup[];\n\n  /**\n   * Gets the default name for that account wallet.\n   */\n  getDefaultName(): string;\n} & AccountWallet<InternalAccount>;\n\n// This class is meant to be used internally by every rules. It exposes mutable operations\n// which should not leak outside of this package.\nexport abstract class MutableAccountTreeWallet implements AccountTreeWallet {\n  readonly id: AccountWalletId;\n\n  readonly category: AccountWalletCategory;\n\n  readonly messenger: AccountTreeControllerMessenger;\n\n  readonly #groups: Map<AccountGroupId, MutableAccountTreeGroup>;\n\n  constructor(\n    messenger: AccountTreeControllerMessenger,\n    category: AccountWalletCategory,\n    id: string,\n  ) {\n    this.id = toAccountWalletId(category, id);\n    this.category = category;\n    this.messenger = messenger;\n\n    this.#groups = new Map();\n  }\n\n  getAccountGroup(groupId: AccountGroupId): AccountTreeGroup | undefined {\n    return this.#groups.get(groupId);\n  }\n\n  getAccountGroups(): AccountTreeGroup[] {\n    return Array.from(this.#groups.values()); // TODO: Should we avoid the copy here?\n  }\n\n  // NOTE: This method SHOULD BE overriden if a rule need to group things differently.\n  addAccount(account: InternalAccount): MutableAccountTreeGroup {\n    const id = DEFAULT_ACCOUNT_GROUP_UNIQUE_ID;\n\n    // Use a single-group by default.\n    let group = this.#groups.get(toAccountGroupId(this.id, id));\n    if (!group) {\n      // We create the account group and attach it to this wallet.\n      group = new MutableAccountTreeGroup(this.messenger, this, id);\n      this.#groups.set(group.id, group);\n    }\n\n    group.addAccount(account);\n\n    return group;\n  }\n\n  abstract getDefaultName(): string;\n}\n"]}

package/dist/AccountTreeWallet.d.cts

@@ -0,0 +1,38 @@
+import { type AccountGroupId, type AccountWallet, type AccountWalletCategory, type AccountWalletId } from "@metamask/account-api";
+import type { InternalAccount } from "@metamask/keyring-internal-api";
+import { type AccountTreeControllerMessenger } from "./AccountTreeController.cjs";
+import type { AccountTreeGroup } from "./AccountTreeGroup.cjs";
+import { MutableAccountTreeGroup } from "./AccountTreeGroup.cjs";
+/**
+ * Account wallet coming from the {@link AccountTreeController}.
+ */
+export type AccountTreeWallet = {
+    /**
+     * Gets account tree group for a given ID.
+     *
+     * @returns Account tree group.
+     */
+    getAccountGroup(groupId: AccountGroupId): AccountTreeGroup | undefined;
+    /**
+     * Gets all account tree groups.
+     *
+     * @returns Account tree groups.
+     */
+    getAccountGroups(): AccountTreeGroup[];
+    /**
+     * Gets the default name for that account wallet.
+     */
+    getDefaultName(): string;
+} & AccountWallet<InternalAccount>;
+export declare abstract class MutableAccountTreeWallet implements AccountTreeWallet {
+    #private;
+    readonly id: AccountWalletId;
+    readonly category: AccountWalletCategory;
+    readonly messenger: AccountTreeControllerMessenger;
+    constructor(messenger: AccountTreeControllerMessenger, category: AccountWalletCategory, id: string);
+    getAccountGroup(groupId: AccountGroupId): AccountTreeGroup | undefined;
+    getAccountGroups(): AccountTreeGroup[];
+    addAccount(account: InternalAccount): MutableAccountTreeGroup;
+    abstract getDefaultName(): string;
+}
+//# sourceMappingURL=AccountTreeWallet.d.cts.map

package/dist/AccountTreeWallet.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTreeWallet.d.cts","sourceRoot":"","sources":["../src/AccountTreeWallet.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACrB,8BAA8B;AAC/B,OAAO,KAAK,EAAE,eAAe,EAAE,uCAAuC;AAEtE,OAAO,EAAE,KAAK,8BAA8B,EAAE,oCAAgC;AAC9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA2B;AAC3D,OAAO,EAAE,uBAAuB,EAAE,+BAA2B;AAE7D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,cAAc,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;IAEvC;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;CAC1B,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC;AAInC,8BAAsB,wBAAyB,YAAW,iBAAiB;;IACzE,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAC;IAE7B,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAAC;IAEzC,QAAQ,CAAC,SAAS,EAAE,8BAA8B,CAAC;gBAKjD,SAAS,EAAE,8BAA8B,EACzC,QAAQ,EAAE,qBAAqB,EAC/B,EAAE,EAAE,MAAM;IASZ,eAAe,CAAC,OAAO,EAAE,cAAc,GAAG,gBAAgB,GAAG,SAAS;IAItE,gBAAgB,IAAI,gBAAgB,EAAE;IAKtC,UAAU,CAAC,OAAO,EAAE,eAAe,GAAG,uBAAuB;IAgB7D,QAAQ,CAAC,cAAc,IAAI,MAAM;CAClC"}