@metamask-previews/account-tree-controller 7.6.1-preview-e57e5c3dc → 7.6.1-preview-c449b8da8

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,qBAAoB;AACvD,YAAY,EAAE,kBAAkB,EAAE,oBAAmB;AACrD,OAAO,EAAE,wBAAwB,EAAE,oBAAmB;AAEtD,OAAO,EACL,+BAA+B,EAC/B,gCAAgC,GACjC,qDAAoD;AAErD,YAAY,EACV,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,qCAAqC,EACrC,2CAA2C,EAC3C,oDAAoD,EACpD,6CAA6C,EAC7C,6CAA6C,EAC7C,6CAA6C,EAC7C,2BAA2B,EAC3B,8BAA8B,GAC/B,oBAAmB;AAEpB,YAAY,EACV,iDAAiD,EACjD,kDAAkD,EAClD,8DAA8D,EAC9D,6DAA6D,EAC7D,gDAAgD,EAChD,4CAA4C,EAC5C,kDAAkD,EAClD,kDAAkD,EAClD,6DAA6D,EAC7D,8CAA8C,EAC9C,+CAA+C,EAC/C,gDAAgD,EAChD,gDAAgD,EAChD,qCAAqC,EACrC,8CAA8C,EAC9C,yDAAyD,EACzD,+BAA+B,EAC/B,iCAAiC,GAClC,wDAAuD;AAExD,YAAY,EAAE,cAAc,EAAE,oCAAmC;AAEjE,OAAO,EACL,qBAAqB,EACrB,oCAAoC,GACrC,oCAAmC"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,qBAAoB;AACvD,YAAY,EAAE,kBAAkB,EAAE,oBAAmB;AACrD,OAAO,EAAE,wBAAwB,EAAE,oBAAmB;AAEtD,OAAO,EACL,+BAA+B,EAC/B,gCAAgC,GACjC,qDAAoD;AAErD,YAAY,EACV,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,qCAAqC,EACrC,2CAA2C,EAC3C,oDAAoD,EACpD,6CAA6C,EAC7C,6CAA6C,EAC7C,6CAA6C,EAC7C,2BAA2B,EAC3B,8BAA8B,GAC/B,oBAAmB;AAEpB,YAAY,EACV,iDAAiD,EACjD,kDAAkD,EAClD,8DAA8D,EAC9D,6DAA6D,EAC7D,gDAAgD,EAChD,4CAA4C,EAC5C,kDAAkD,EAClD,kDAAkD,EAClD,6DAA6D,EAC7D,8CAA8C,EAC9C,+CAA+C,EAC/C,gDAAgD,EAChD,gDAAgD,EAChD,qCAAqC,EACrC,8CAA8C,EAC9C,yDAAyD,EACzD,+BAA+B,EAC/B,iCAAiC,EACjC,sCAAsC,EACtC,sCAAsC,GACvC,wDAAuD;AAExD,YAAY,EAAE,cAAc,EAAE,oCAAmC;AAEjE,OAAO,EACL,qBAAqB,EACrB,oCAAoC,GACrC,oCAAmC;AAEpC,YAAY,EACV,kBAAkB,EAClB,4BAA4B,EAC5B,4BAA4B,EAC5B,8BAA8B,EAC9B,+BAA+B,EAC/B,iCAAiC,EACjC,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,GACnB,4BAA2B;AAE5B,OAAO,EACL,wBAAwB,EACxB,+BAA+B,EAC/B,wBAAwB,EACxB,wBAAwB,GACzB,4BAA2B;AAE5B,OAAO,EAAE,mBAAmB,EAAE,6BAA4B;AAC1D,OAAO,EAAE,KAAK,EAAE,2BAA0B"}

package/dist/index.d.mts

@@ -3,7 +3,11 @@ export type { AccountGroupObject } from "./group.mjs";
 export { isAccountGroupNameUnique } from "./group.mjs";
 export { USER_STORAGE_GROUPS_FEATURE_KEY, USER_STORAGE_WALLETS_FEATURE_KEY, } from "./backup-and-sync/user-storage/constants.mjs";
 export type { AccountTreeControllerState, AccountTreeControllerGetStateAction, AccountTreeControllerActions, AccountTreeControllerStateChangeEvent, AccountTreeControllerAccountTreeChangeEvent, AccountTreeControllerSelectedAccountGroupChangeEvent, AccountTreeControllerAccountGroupCreatedEvent, AccountTreeControllerAccountGroupUpdatedEvent, AccountTreeControllerAccountGroupRemovedEvent, AccountTreeControllerEvents, AccountTreeControllerMessenger, } from "./types.mjs";
-export type { AccountTreeControllerGetAccountWalletObjectAction, AccountTreeControllerGetAccountWalletObjectsAction, AccountTreeControllerGetAccountsFromSelectedAccountGroupAction, AccountTreeControllerGetAccountFromSelectedAccountGroupAction, AccountTreeControllerGetAccountGroupObjectAction, AccountTreeControllerGetAccountContextAction, AccountTreeControllerGetSelectedAccountGroupAction, AccountTreeControllerSetSelectedAccountGroupAction, AccountTreeControllerSetSelectedAccountGroupByAccountIdAction, AccountTreeControllerSetAccountGroupNameAction, AccountTreeControllerSetAccountWalletNameAction, AccountTreeControllerSetAccountGroupPinnedAction, AccountTreeControllerSetAccountGroupHiddenAction, AccountTreeControllerClearStateAction, AccountTreeControllerSyncWithUserStorageAction, AccountTreeControllerSyncWithUserStorageAtLeastOnceAction, AccountTreeControllerInitAction, AccountTreeControllerReinitAction, } from "./AccountTreeController-method-action-types.mjs";
+export type { AccountTreeControllerGetAccountWalletObjectAction, AccountTreeControllerGetAccountWalletObjectsAction, AccountTreeControllerGetAccountsFromSelectedAccountGroupAction, AccountTreeControllerGetAccountFromSelectedAccountGroupAction, AccountTreeControllerGetAccountGroupObjectAction, AccountTreeControllerGetAccountContextAction, AccountTreeControllerGetSelectedAccountGroupAction, AccountTreeControllerSetSelectedAccountGroupAction, AccountTreeControllerSetSelectedAccountGroupByAccountIdAction, AccountTreeControllerSetAccountGroupNameAction, AccountTreeControllerSetAccountWalletNameAction, AccountTreeControllerSetAccountGroupPinnedAction, AccountTreeControllerSetAccountGroupHiddenAction, AccountTreeControllerClearStateAction, AccountTreeControllerSyncWithUserStorageAction, AccountTreeControllerSyncWithUserStorageAtLeastOnceAction, AccountTreeControllerInitAction, AccountTreeControllerReinitAction, AccountTreeControllerExportStateAction, AccountTreeControllerImportStateAction, } from "./AccountTreeController-method-action-types.mjs";
 export type { AccountContext } from "./AccountTreeController.mjs";
 export { AccountTreeController, getDefaultAccountTreeControllerState, } from "./AccountTreeController.mjs";
+export type { AccountTreePayload, AccountTreePayloadStructType, AccountWalletMnemonicPayload, AccountWalletPrivateKeyPayload, AccountWalletMnemonicGroupEntry, AccountWalletPrivateKeyGroupEntry, AccountWalletPayloadId, AccountGroupPayloadId, AccountTreeSnapshotWallet, AccountTreeSnapshotGroup, ExportStateOptions, } from "./state/payload.mjs";
+export { AccountWalletPayloadType, AccountWalletPrivateKeyEncoding, AccountTreePayloadStruct, assertAccountTreePayload, } from "./state/payload.mjs";
+export { AccountTreeSnapshot } from "./state/snapshot.mjs";
+export { IdMap } from "./state/id-map.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,qBAAoB;AACvD,YAAY,EAAE,kBAAkB,EAAE,oBAAmB;AACrD,OAAO,EAAE,wBAAwB,EAAE,oBAAmB;AAEtD,OAAO,EACL,+BAA+B,EAC/B,gCAAgC,GACjC,qDAAoD;AAErD,YAAY,EACV,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,qCAAqC,EACrC,2CAA2C,EAC3C,oDAAoD,EACpD,6CAA6C,EAC7C,6CAA6C,EAC7C,6CAA6C,EAC7C,2BAA2B,EAC3B,8BAA8B,GAC/B,oBAAmB;AAEpB,YAAY,EACV,iDAAiD,EACjD,kDAAkD,EAClD,8DAA8D,EAC9D,6DAA6D,EAC7D,gDAAgD,EAChD,4CAA4C,EAC5C,kDAAkD,EAClD,kDAAkD,EAClD,6DAA6D,EAC7D,8CAA8C,EAC9C,+CAA+C,EAC/C,gDAAgD,EAChD,gDAAgD,EAChD,qCAAqC,EACrC,8CAA8C,EAC9C,yDAAyD,EACzD,+BAA+B,EAC/B,iCAAiC,GAClC,wDAAuD;AAExD,YAAY,EAAE,cAAc,EAAE,oCAAmC;AAEjE,OAAO,EACL,qBAAqB,EACrB,oCAAoC,GACrC,oCAAmC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,qBAAoB;AACvD,YAAY,EAAE,kBAAkB,EAAE,oBAAmB;AACrD,OAAO,EAAE,wBAAwB,EAAE,oBAAmB;AAEtD,OAAO,EACL,+BAA+B,EAC/B,gCAAgC,GACjC,qDAAoD;AAErD,YAAY,EACV,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,qCAAqC,EACrC,2CAA2C,EAC3C,oDAAoD,EACpD,6CAA6C,EAC7C,6CAA6C,EAC7C,6CAA6C,EAC7C,2BAA2B,EAC3B,8BAA8B,GAC/B,oBAAmB;AAEpB,YAAY,EACV,iDAAiD,EACjD,kDAAkD,EAClD,8DAA8D,EAC9D,6DAA6D,EAC7D,gDAAgD,EAChD,4CAA4C,EAC5C,kDAAkD,EAClD,kDAAkD,EAClD,6DAA6D,EAC7D,8CAA8C,EAC9C,+CAA+C,EAC/C,gDAAgD,EAChD,gDAAgD,EAChD,qCAAqC,EACrC,8CAA8C,EAC9C,yDAAyD,EACzD,+BAA+B,EAC/B,iCAAiC,EACjC,sCAAsC,EACtC,sCAAsC,GACvC,wDAAuD;AAExD,YAAY,EAAE,cAAc,EAAE,oCAAmC;AAEjE,OAAO,EACL,qBAAqB,EACrB,oCAAoC,GACrC,oCAAmC;AAEpC,YAAY,EACV,kBAAkB,EAClB,4BAA4B,EAC5B,4BAA4B,EAC5B,8BAA8B,EAC9B,+BAA+B,EAC/B,iCAAiC,EACjC,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,GACnB,4BAA2B;AAE5B,OAAO,EACL,wBAAwB,EACxB,+BAA+B,EAC/B,wBAAwB,EACxB,wBAAwB,GACzB,4BAA2B;AAE5B,OAAO,EAAE,mBAAmB,EAAE,6BAA4B;AAC1D,OAAO,EAAE,KAAK,EAAE,2BAA0B"}

package/dist/index.mjs

@@ -1,4 +1,7 @@
 export { isAccountGroupNameUnique } from "./group.mjs";
 export { USER_STORAGE_GROUPS_FEATURE_KEY, USER_STORAGE_WALLETS_FEATURE_KEY } from "./backup-and-sync/user-storage/constants.mjs";
 export { AccountTreeController, getDefaultAccountTreeControllerState } from "./AccountTreeController.mjs";
+export { AccountWalletPayloadType, AccountWalletPrivateKeyEncoding, AccountTreePayloadStruct, assertAccountTreePayload } from "./state/payload.mjs";
+export { AccountTreeSnapshot } from "./state/snapshot.mjs";
+export { IdMap } from "./state/id-map.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,oBAAmB;AAEtD,OAAO,EACL,+BAA+B,EAC/B,gCAAgC,EACjC,qDAAoD;AAuCrD,OAAO,EACL,qBAAqB,EACrB,oCAAoC,EACrC,oCAAmC","sourcesContent":["export type { AccountWalletObject } from './wallet.js';\nexport type { AccountGroupObject } from './group.js';\nexport { isAccountGroupNameUnique } from './group.js';\n\nexport {\n  USER_STORAGE_GROUPS_FEATURE_KEY,\n  USER_STORAGE_WALLETS_FEATURE_KEY,\n} from './backup-and-sync/user-storage/constants.js';\n\nexport type {\n  AccountTreeControllerState,\n  AccountTreeControllerGetStateAction,\n  AccountTreeControllerActions,\n  AccountTreeControllerStateChangeEvent,\n  AccountTreeControllerAccountTreeChangeEvent,\n  AccountTreeControllerSelectedAccountGroupChangeEvent,\n  AccountTreeControllerAccountGroupCreatedEvent,\n  AccountTreeControllerAccountGroupUpdatedEvent,\n  AccountTreeControllerAccountGroupRemovedEvent,\n  AccountTreeControllerEvents,\n  AccountTreeControllerMessenger,\n} from './types.js';\n\nexport type {\n  AccountTreeControllerGetAccountWalletObjectAction,\n  AccountTreeControllerGetAccountWalletObjectsAction,\n  AccountTreeControllerGetAccountsFromSelectedAccountGroupAction,\n  AccountTreeControllerGetAccountFromSelectedAccountGroupAction,\n  AccountTreeControllerGetAccountGroupObjectAction,\n  AccountTreeControllerGetAccountContextAction,\n  AccountTreeControllerGetSelectedAccountGroupAction,\n  AccountTreeControllerSetSelectedAccountGroupAction,\n  AccountTreeControllerSetSelectedAccountGroupByAccountIdAction,\n  AccountTreeControllerSetAccountGroupNameAction,\n  AccountTreeControllerSetAccountWalletNameAction,\n  AccountTreeControllerSetAccountGroupPinnedAction,\n  AccountTreeControllerSetAccountGroupHiddenAction,\n  AccountTreeControllerClearStateAction,\n  AccountTreeControllerSyncWithUserStorageAction,\n  AccountTreeControllerSyncWithUserStorageAtLeastOnceAction,\n  AccountTreeControllerInitAction,\n  AccountTreeControllerReinitAction,\n} from './AccountTreeController-method-action-types.js';\n\nexport type { AccountContext } from './AccountTreeController.js';\n\nexport {\n  AccountTreeController,\n  getDefaultAccountTreeControllerState,\n} from './AccountTreeController.js';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,oBAAmB;AAEtD,OAAO,EACL,+BAA+B,EAC/B,gCAAgC,EACjC,qDAAoD;AAyCrD,OAAO,EACL,qBAAqB,EACrB,oCAAoC,EACrC,oCAAmC;AAgBpC,OAAO,EACL,wBAAwB,EACxB,+BAA+B,EAC/B,wBAAwB,EACxB,wBAAwB,EACzB,4BAA2B;AAE5B,OAAO,EAAE,mBAAmB,EAAE,6BAA4B;AAC1D,OAAO,EAAE,KAAK,EAAE,2BAA0B","sourcesContent":["export type { AccountWalletObject } from './wallet.js';\nexport type { AccountGroupObject } from './group.js';\nexport { isAccountGroupNameUnique } from './group.js';\n\nexport {\n  USER_STORAGE_GROUPS_FEATURE_KEY,\n  USER_STORAGE_WALLETS_FEATURE_KEY,\n} from './backup-and-sync/user-storage/constants.js';\n\nexport type {\n  AccountTreeControllerState,\n  AccountTreeControllerGetStateAction,\n  AccountTreeControllerActions,\n  AccountTreeControllerStateChangeEvent,\n  AccountTreeControllerAccountTreeChangeEvent,\n  AccountTreeControllerSelectedAccountGroupChangeEvent,\n  AccountTreeControllerAccountGroupCreatedEvent,\n  AccountTreeControllerAccountGroupUpdatedEvent,\n  AccountTreeControllerAccountGroupRemovedEvent,\n  AccountTreeControllerEvents,\n  AccountTreeControllerMessenger,\n} from './types.js';\n\nexport type {\n  AccountTreeControllerGetAccountWalletObjectAction,\n  AccountTreeControllerGetAccountWalletObjectsAction,\n  AccountTreeControllerGetAccountsFromSelectedAccountGroupAction,\n  AccountTreeControllerGetAccountFromSelectedAccountGroupAction,\n  AccountTreeControllerGetAccountGroupObjectAction,\n  AccountTreeControllerGetAccountContextAction,\n  AccountTreeControllerGetSelectedAccountGroupAction,\n  AccountTreeControllerSetSelectedAccountGroupAction,\n  AccountTreeControllerSetSelectedAccountGroupByAccountIdAction,\n  AccountTreeControllerSetAccountGroupNameAction,\n  AccountTreeControllerSetAccountWalletNameAction,\n  AccountTreeControllerSetAccountGroupPinnedAction,\n  AccountTreeControllerSetAccountGroupHiddenAction,\n  AccountTreeControllerClearStateAction,\n  AccountTreeControllerSyncWithUserStorageAction,\n  AccountTreeControllerSyncWithUserStorageAtLeastOnceAction,\n  AccountTreeControllerInitAction,\n  AccountTreeControllerReinitAction,\n  AccountTreeControllerExportStateAction,\n  AccountTreeControllerImportStateAction,\n} from './AccountTreeController-method-action-types.js';\n\nexport type { AccountContext } from './AccountTreeController.js';\n\nexport {\n  AccountTreeController,\n  getDefaultAccountTreeControllerState,\n} from './AccountTreeController.js';\n\nexport type {\n  AccountTreePayload,\n  AccountTreePayloadStructType,\n  AccountWalletMnemonicPayload,\n  AccountWalletPrivateKeyPayload,\n  AccountWalletMnemonicGroupEntry,\n  AccountWalletPrivateKeyGroupEntry,\n  AccountWalletPayloadId,\n  AccountGroupPayloadId,\n  AccountTreeSnapshotWallet,\n  AccountTreeSnapshotGroup,\n  ExportStateOptions,\n} from './state/payload.js';\n\nexport {\n  AccountWalletPayloadType,\n  AccountWalletPrivateKeyEncoding,\n  AccountTreePayloadStruct,\n  assertAccountTreePayload,\n} from './state/payload.js';\n\nexport { AccountTreeSnapshot } from './state/snapshot.js';\nexport { IdMap } from './state/id-map.js';\n"]}

package/dist/state/export.cjs

@@ -0,0 +1,214 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportState = exports.isPrivateKeyWalletObject = exports.isMnemonicWalletObject = void 0;
+const account_api_1 = require("@metamask/account-api");
+const v2_1 = require("@metamask/eth-hd-keyring/v2");
+const keyring_api_1 = require("@metamask/keyring-api");
+const keyring_controller_1 = require("@metamask/keyring-controller");
+const id_map_js_1 = require("./id-map.cjs");
+const payload_js_1 = require("./payload.cjs");
+const snapshot_js_1 = require("./snapshot.cjs");
+const utils_js_1 = require("./utils.cjs");
+/**
+ * Returns `true` if `wallet` is an HD entropy wallet ({@link AccountWalletEntropyObject}).
+ *
+ * @param wallet - The wallet object to test.
+ * @returns Type predicate narrowing to {@link AccountWalletEntropyObject}.
+ */
+function isMnemonicWalletObject(wallet) {
+    return wallet.type === account_api_1.AccountWalletType.Entropy;
+}
+exports.isMnemonicWalletObject = isMnemonicWalletObject;
+/**
+ * Returns `true` if `wallet` is an imported private-key wallet
+ * ({@link AccountWalletKeyringObject} with keyring type {@link KeyringTypes.simple}).
+ *
+ * @param wallet - The wallet object to test.
+ * @returns Type predicate narrowing to {@link AccountWalletKeyringObject}.
+ */
+function isPrivateKeyWalletObject(wallet) {
+    return (wallet.type === account_api_1.AccountWalletType.Keyring &&
+        wallet.metadata.keyring.type === keyring_controller_1.KeyringTypes.simple);
+}
+exports.isPrivateKeyWalletObject = isPrivateKeyWalletObject;
+/**
+ * Exports a single entropy (HD) wallet object as an {@link AccountWalletMnemonicPayload}.
+ *
+ * Calls `KeyringController:withKeyringV2Unsafe` to derive the stable entropy source ID
+ * via {@link HdKeyring.toEntropySourceId} and, when `includeSecrets` is `true`, to read
+ * the raw mnemonic bytes.
+ *
+ * @param context - Export context.
+ * @param walletObj - The local entropy wallet to export.
+ * @param includeSecrets - When `true`, the BIP-39 mnemonic is included in the payload.
+ * @param idMap - ID map to populate with local↔payload ID pairs for this wallet and its groups.
+ * @returns The mnemonic wallet payload entry.
+ * @throws If `includeSecrets` is `true` but the mnemonic cannot be read from the keyring.
+ */
+async function exportMnemonicWalletObject(context, walletObj, includeSecrets, idMap) {
+    const result = await context.messenger.call('KeyringController:withKeyringV2Unsafe', 
+    // The local wallet entropy ID is the keyring ID.
+    { id: walletObj.metadata.entropy.id }, async ({ keyring }) => {
+        const hdKeyring = keyring;
+        const includeMnemonic = includeSecrets &&
+            hdKeyring.mnemonic !== null &&
+            hdKeyring.mnemonic !== undefined;
+        return {
+            // Compute the stable entropy source ID from the keyring's mnemonic (BIP-39 seed).
+            entropySourceId: await hdKeyring.toEntropySourceId(),
+            // No need to include the mnemonic here if we're not exporting secrets.
+            mnemonic: includeMnemonic ? hdKeyring.mnemonic : undefined,
+        };
+    });
+    const { entropySourceId, mnemonic } = result;
+    // We use the stable entropy source ID as the payload wallet ID, rather than the local wallet ID, to
+    // ensure that the exported snapshot is stable across different installations and sessions.
+    const wallet = {
+        type: payload_js_1.AccountWalletPayloadType.Mnemonic,
+        id: (0, payload_js_1.toWalletPayloadId)(entropySourceId),
+        metadata: { name: walletObj.metadata.name },
+        groups: [],
+    };
+    idMap.add(walletObj.id, wallet.id);
+    for (const groupObj of Object.values(walletObj.groups)) {
+        const { groupIndex } = groupObj.metadata.entropy;
+        const group = {
+            id: (0, payload_js_1.toGroupPayloadId)(wallet.id, groupIndex),
+            groupIndex,
+            metadata: {
+                name: groupObj.metadata.name,
+                pinned: groupObj.metadata.pinned,
+                hidden: groupObj.metadata.hidden,
+            },
+        };
+        idMap.add(groupObj.id, group.id);
+        wallet.groups.push(group);
+    }
+    // Sort the groups by their `groupIndex` to ensure a stable order in the exported payload.
+    wallet.groups.sort((group, otherGroup) => group.groupIndex - otherGroup.groupIndex);
+    // This should never happen, but we check just in case.
+    if (includeSecrets) {
+        if (mnemonic === undefined) {
+            throw new Error(`Failed to export mnemonic for wallet ${wallet.id}`);
+        }
+        wallet.value = (0, utils_js_1.encodeBytes)(mnemonic);
+    }
+    return wallet;
+}
+/**
+ * Exports a single simple-keyring wallet object as an {@link AccountWalletPrivateKeyPayload}.
+ *
+ * All groups from the wallet are merged into the `'private-key'` singleton payload entry.
+ * When `includeSecrets` is `true`, each group's private key is exported via
+ * `KeyringController:withKeyringV2`.
+ *
+ * @param context - Export context.
+ * @param walletObj - The local simple-keyring wallet to export.
+ * @param includeSecrets - When `true`, private keys are included in the payload.
+ * @param idMap - ID map to populate with local↔payload ID pairs for this wallet and its groups.
+ * @returns The private-key wallet payload entry.
+ * @throws If `includeSecrets` is `true` but a private key cannot be exported for an account.
+ */
+async function exportPrivateKeyWalletObject(context, walletObj, includeSecrets, idMap) {
+    // We use a singleton wallet ID for private keys.
+    const wallet = {
+        type: payload_js_1.AccountWalletPayloadType.PrivateKey,
+        id: (0, payload_js_1.toWalletPayloadId)(payload_js_1.AccountWalletPayloadType.PrivateKey),
+        metadata: { name: walletObj.metadata.name },
+        groups: [],
+    };
+    for (const groupObj of Object.values(walletObj.groups)) {
+        const accountId = groupObj.accounts[0];
+        if (!accountId) {
+            continue;
+        }
+        const account = context.messenger.call('AccountsController:getAccount', accountId);
+        if (!account) {
+            continue;
+        }
+        const { address } = account;
+        let exported;
+        if (includeSecrets) {
+            const result = await context.messenger.call('KeyringController:withKeyringV2', { address }, async ({ keyring }) => {
+                if (!keyring.exportAccount) {
+                    throw new Error(`Keyring for account ${accountId} does not support exportAccount`);
+                }
+                return keyring.exportAccount(accountId, {
+                    type: 'private-key',
+                    encoding: payload_js_1.AccountWalletPrivateKeyEncoding.Hexadecimal,
+                });
+            });
+            exported = result;
+        }
+        const group = {
+            id: (0, payload_js_1.toGroupPayloadId)(wallet.id, address),
+            metadata: {
+                name: groupObj.metadata.name,
+                pinned: groupObj.metadata.pinned,
+                hidden: groupObj.metadata.hidden,
+            },
+        };
+        if (includeSecrets) {
+            if (!exported) {
+                throw new Error(`Failed to export private key for account ${accountId}`);
+            }
+            group.value = {
+                privateKey: (0, utils_js_1.encodeBytes)(new TextEncoder().encode(exported.privateKey)),
+                encoding: exported.encoding,
+                type: keyring_api_1.EthAccountType.Eoa,
+            };
+        }
+        idMap.add(groupObj.id, group.id);
+        wallet.groups.push(group);
+    }
+    return wallet;
+}
+/**
+ * Builds an {@link AccountTreeSnapshot} from the current controller state.
+ *
+ * Iterates over all wallets in the tree:
+ * - {@link AccountWalletType.Entropy} (HD) wallets -> `'mnemonic'` payload entries.
+ * - {@link AccountWalletType.Keyring} wallets of type `simple` -> `'private-key'` payload entries.
+ * - Snap wallets and hardware keyrings are skipped in v1.
+ *
+ * @param context - Export context providing state and messenger access.
+ * @param options - Export options.
+ * @returns A promise that resolves to the built snapshot.
+ * @throws If `options.includeSecrets` is `true` and the vault is locked.
+ */
+async function exportState(context, options = {}) {
+    const state = context.getState();
+    const includeSecrets = options.includeSecrets ?? false;
+    const { isUnlocked } = context.messenger.call('KeyringController:getState');
+    if (includeSecrets && !isUnlocked) {
+        throw new Error('Cannot include secrets in export when vault is locked');
+    }
+    const idMap = new id_map_js_1.IdMap();
+    const entries = [];
+    let privateKeyWallet;
+    for (const walletObj of Object.values(state.accountTree.wallets)) {
+        if (isMnemonicWalletObject(walletObj)) {
+            entries.push(await exportMnemonicWalletObject(context, walletObj, includeSecrets, idMap));
+        }
+        else if (isPrivateKeyWalletObject(walletObj)) {
+            const exported = await exportPrivateKeyWalletObject(context, walletObj, includeSecrets, idMap);
+            if (privateKeyWallet) {
+                privateKeyWallet.groups.push(...exported.groups);
+            }
+            else {
+                privateKeyWallet = exported;
+                // Register only once, since all private keys are exported into the same wallet entry.
+                idMap.add(walletObj.id, exported.id);
+            }
+        }
+        else {
+            // AccountWalletType.Snap and hardware keyrings: skipped for now.
+        }
+    }
+    if (privateKeyWallet) {
+        entries.push(privateKeyWallet);
+    }
+    return new snapshot_js_1.AccountTreeSnapshot(entries, idMap);
+}
+exports.exportState = exportState;
+//# sourceMappingURL=export.cjs.map

package/dist/state/export.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.cjs","sourceRoot":"","sources":["../../src/state/export.ts"],"names":[],"mappings":";;;AAAA,uDAA0D;AAC1D,oDAAwD;AACxD,uDAAuD;AAEvD,qEAA4D;AAW5D,4CAAoC;AASpC,8CAKsB;AACtB,gDAAoD;AACpD,0CAAyC;AAEzC;;;;;GAKG;AACH,SAAgB,sBAAsB,CACpC,MAA2B;IAE3B,OAAO,MAAM,CAAC,IAAI,KAAK,+BAAiB,CAAC,OAAO,CAAC;AACnD,CAAC;AAJD,wDAIC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CACtC,MAA2B;IAE3B,OAAO,CACL,MAAM,CAAC,IAAI,KAAK,+BAAiB,CAAC,OAAO;QACzC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,iCAAY,CAAC,MAAM,CACrD,CAAC;AACJ,CAAC;AAPD,4DAOC;AAQD;;;;;;;;;;;;;GAaG;AACH,KAAK,UAAU,0BAA0B,CACvC,OAAsB,EACtB,SAAqC,EACrC,cAAuB,EACvB,KAAY;IAEZ,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,CACzC,uCAAuC;IACvC,iDAAiD;IACjD,EAAE,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,EACrC,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACpB,MAAM,SAAS,GAAG,OAAoB,CAAC;QACvC,MAAM,eAAe,GACnB,cAAc;YACd,SAAS,CAAC,QAAQ,KAAK,IAAI;YAC3B,SAAS,CAAC,QAAQ,KAAK,SAAS,CAAC;QAEnC,OAAO;YACL,kFAAkF;YAClF,eAAe,EAAE,MAAM,SAAS,CAAC,iBAAiB,EAAE;YACpD,uEAAuE;YACvE,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;SAC3D,CAAC;IACJ,CAAC,CACF,CAAC;IACF,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,GAAG,MAGrC,CAAC;IAEF,oGAAoG;IACpG,2FAA2F;IAC3F,MAAM,MAAM,GAAiC;QAC3C,IAAI,EAAE,qCAAwB,CAAC,QAAQ;QACvC,EAAE,EAAE,IAAA,8BAAiB,EAAC,eAAe,CAAC;QACtC,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE;QAC3C,MAAM,EAAE,EAAE;KACX,CAAC;IAEF,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAEnC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACvD,MAAM,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QAEjD,MAAM,KAAK,GAAoC;YAC7C,EAAE,EAAE,IAAA,6BAAgB,EAAC,MAAM,CAAC,EAAE,EAAE,UAAU,CAAC;YAC3C,UAAU;YACV,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI;gBAC5B,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM;gBAChC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM;aACjC;SACF,CAAC;QAEF,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QAEjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,0FAA0F;IAC1F,MAAM,CAAC,MAAM,CAAC,IAAI,CAChB,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAChE,CAAC;IAEF,uDAAuD;IACvD,IAAI,cAAc,EAAE,CAAC;QACnB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,wCAAwC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,CAAC,KAAK,GAAG,IAAA,sBAAW,EAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,KAAK,UAAU,4BAA4B,CACzC,OAAsB,EACtB,SAAqC,EACrC,cAAuB,EACvB,KAAY;IAEZ,iDAAiD;IACjD,MAAM,MAAM,GAAmC;QAC7C,IAAI,EAAE,qCAAwB,CAAC,UAAU;QACzC,EAAE,EAAE,IAAA,8BAAiB,EAAC,qCAAwB,CAAC,UAAU,CAAC;QAC1D,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE;QAC3C,MAAM,EAAE,EAAE;KACX,CAAC;IAEF,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACvD,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CACpC,+BAA+B,EAC/B,SAAS,CACV,CAAC;QACF,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,SAAS;QACX,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAE5B,IAAI,QAA+C,CAAC;QACpD,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,CACzC,iCAAiC,EACjC,EAAE,OAAO,EAAE,EACX,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CACb,uBAAuB,SAAS,iCAAiC,CAClE,CAAC;gBACJ,CAAC;gBAED,OAAO,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE;oBACtC,IAAI,EAAE,aAAa;oBACnB,QAAQ,EAAE,4CAA+B,CAAC,WAAW;iBACtD,CAAC,CAAC;YACL,CAAC,CACF,CAAC;YAEF,QAAQ,GAAG,MAAmC,CAAC;QACjD,CAAC;QAED,MAAM,KAAK,GAAsC;YAC/C,EAAE,EAAE,IAAA,6BAAgB,EAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC;YACxC,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI;gBAC5B,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM;gBAChC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM;aACjC;SACF,CAAC;QAEF,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CACb,4CAA4C,SAAS,EAAE,CACxD,CAAC;YACJ,CAAC;YACD,KAAK,CAAC,KAAK,GAAG;gBACZ,UAAU,EAAE,IAAA,sBAAW,EAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACtE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,IAAI,EAAE,4BAAc,CAAC,GAAG;aACzB,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QAEjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAsB,EACtB,UAA8B,EAAE;IAEhC,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAEjC,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC;IACvD,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAC5E,IAAI,cAAc,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,iBAAK,EAAE,CAAC;IAC1B,MAAM,OAAO,GAA6B,EAAE,CAAC;IAC7C,IAAI,gBAA4D,CAAC;IAEjE,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;QACjE,IAAI,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC;YACtC,OAAO,CAAC,IAAI,CACV,MAAM,0BAA0B,CAC9B,OAAO,EACP,SAAS,EACT,cAAc,EACd,KAAK,CACN,CACF,CAAC;QACJ,CAAC;aAAM,IAAI,wBAAwB,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,MAAM,4BAA4B,CACjD,OAAO,EACP,SAAS,EACT,cAAc,EACd,KAAK,CACN,CAAC;YAEF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,gBAAgB,GAAG,QAAQ,CAAC;gBAE5B,sFAAsF;gBACtF,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,iEAAiE;QACnE,CAAC;IACH,CAAC;IAED,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,IAAI,iCAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACjD,CAAC;AApDD,kCAoDC","sourcesContent":["import { AccountWalletType } from '@metamask/account-api';\nimport { HdKeyring } from '@metamask/eth-hd-keyring/v2';\nimport { EthAccountType } from '@metamask/keyring-api';\nimport { PrivateKeyExportedAccount } from '@metamask/keyring-api/v2';\nimport { KeyringTypes } from '@metamask/keyring-controller';\n\nimport type {\n  AccountTreeControllerMessenger,\n  AccountTreeControllerState,\n} from '../types.js';\nimport type { AccountWalletObject } from '../wallet.js';\nimport {\n  AccountWalletEntropyObject,\n  AccountWalletKeyringObject,\n} from '../wallet.js';\nimport { IdMap } from './id-map.js';\nimport type {\n  AccountTreeWalletEntry,\n  AccountWalletMnemonicGroupEntry,\n  AccountWalletMnemonicPayload,\n  AccountWalletPrivateKeyGroupEntry,\n  AccountWalletPrivateKeyPayload,\n  ExportStateOptions,\n} from './payload.js';\nimport {\n  AccountWalletPayloadType,\n  AccountWalletPrivateKeyEncoding,\n  toWalletPayloadId,\n  toGroupPayloadId,\n} from './payload.js';\nimport { AccountTreeSnapshot } from './snapshot.js';\nimport { encodeBytes } from './utils.js';\n\n/**\n * Returns `true` if `wallet` is an HD entropy wallet ({@link AccountWalletEntropyObject}).\n *\n * @param wallet - The wallet object to test.\n * @returns Type predicate narrowing to {@link AccountWalletEntropyObject}.\n */\nexport function isMnemonicWalletObject(\n  wallet: AccountWalletObject,\n): wallet is AccountWalletEntropyObject {\n  return wallet.type === AccountWalletType.Entropy;\n}\n\n/**\n * Returns `true` if `wallet` is an imported private-key wallet\n * ({@link AccountWalletKeyringObject} with keyring type {@link KeyringTypes.simple}).\n *\n * @param wallet - The wallet object to test.\n * @returns Type predicate narrowing to {@link AccountWalletKeyringObject}.\n */\nexport function isPrivateKeyWalletObject(\n  wallet: AccountWalletObject,\n): wallet is AccountWalletKeyringObject {\n  return (\n    wallet.type === AccountWalletType.Keyring &&\n    wallet.metadata.keyring.type === KeyringTypes.simple\n  );\n}\n\n/** Context required by {@link exportState}. */\nexport type ExportContext = {\n  getState: () => AccountTreeControllerState;\n  messenger: AccountTreeControllerMessenger;\n};\n\n/**\n * Exports a single entropy (HD) wallet object as an {@link AccountWalletMnemonicPayload}.\n *\n * Calls `KeyringController:withKeyringV2Unsafe` to derive the stable entropy source ID\n * via {@link HdKeyring.toEntropySourceId} and, when `includeSecrets` is `true`, to read\n * the raw mnemonic bytes.\n *\n * @param context - Export context.\n * @param walletObj - The local entropy wallet to export.\n * @param includeSecrets - When `true`, the BIP-39 mnemonic is included in the payload.\n * @param idMap - ID map to populate with local↔payload ID pairs for this wallet and its groups.\n * @returns The mnemonic wallet payload entry.\n * @throws If `includeSecrets` is `true` but the mnemonic cannot be read from the keyring.\n */\nasync function exportMnemonicWalletObject(\n  context: ExportContext,\n  walletObj: AccountWalletEntropyObject,\n  includeSecrets: boolean,\n  idMap: IdMap,\n): Promise<AccountWalletMnemonicPayload> {\n  const result = await context.messenger.call(\n    'KeyringController:withKeyringV2Unsafe',\n    // The local wallet entropy ID is the keyring ID.\n    { id: walletObj.metadata.entropy.id },\n    async ({ keyring }) => {\n      const hdKeyring = keyring as HdKeyring;\n      const includeMnemonic =\n        includeSecrets &&\n        hdKeyring.mnemonic !== null &&\n        hdKeyring.mnemonic !== undefined;\n\n      return {\n        // Compute the stable entropy source ID from the keyring's mnemonic (BIP-39 seed).\n        entropySourceId: await hdKeyring.toEntropySourceId(),\n        // No need to include the mnemonic here if we're not exporting secrets.\n        mnemonic: includeMnemonic ? hdKeyring.mnemonic : undefined,\n      };\n    },\n  );\n  const { entropySourceId, mnemonic } = result as {\n    entropySourceId: string;\n    mnemonic?: Uint8Array;\n  };\n\n  // We use the stable entropy source ID as the payload wallet ID, rather than the local wallet ID, to\n  // ensure that the exported snapshot is stable across different installations and sessions.\n  const wallet: AccountWalletMnemonicPayload = {\n    type: AccountWalletPayloadType.Mnemonic,\n    id: toWalletPayloadId(entropySourceId),\n    metadata: { name: walletObj.metadata.name },\n    groups: [],\n  };\n\n  idMap.add(walletObj.id, wallet.id);\n\n  for (const groupObj of Object.values(walletObj.groups)) {\n    const { groupIndex } = groupObj.metadata.entropy;\n\n    const group: AccountWalletMnemonicGroupEntry = {\n      id: toGroupPayloadId(wallet.id, groupIndex),\n      groupIndex,\n      metadata: {\n        name: groupObj.metadata.name,\n        pinned: groupObj.metadata.pinned,\n        hidden: groupObj.metadata.hidden,\n      },\n    };\n\n    idMap.add(groupObj.id, group.id);\n\n    wallet.groups.push(group);\n  }\n\n  // Sort the groups by their `groupIndex` to ensure a stable order in the exported payload.\n  wallet.groups.sort(\n    (group, otherGroup) => group.groupIndex - otherGroup.groupIndex,\n  );\n\n  // This should never happen, but we check just in case.\n  if (includeSecrets) {\n    if (mnemonic === undefined) {\n      throw new Error(`Failed to export mnemonic for wallet ${wallet.id}`);\n    }\n\n    wallet.value = encodeBytes(mnemonic);\n  }\n\n  return wallet;\n}\n\n/**\n * Exports a single simple-keyring wallet object as an {@link AccountWalletPrivateKeyPayload}.\n *\n * All groups from the wallet are merged into the `'private-key'` singleton payload entry.\n * When `includeSecrets` is `true`, each group's private key is exported via\n * `KeyringController:withKeyringV2`.\n *\n * @param context - Export context.\n * @param walletObj - The local simple-keyring wallet to export.\n * @param includeSecrets - When `true`, private keys are included in the payload.\n * @param idMap - ID map to populate with local↔payload ID pairs for this wallet and its groups.\n * @returns The private-key wallet payload entry.\n * @throws If `includeSecrets` is `true` but a private key cannot be exported for an account.\n */\nasync function exportPrivateKeyWalletObject(\n  context: ExportContext,\n  walletObj: AccountWalletKeyringObject,\n  includeSecrets: boolean,\n  idMap: IdMap,\n): Promise<AccountWalletPrivateKeyPayload> {\n  // We use a singleton wallet ID for private keys.\n  const wallet: AccountWalletPrivateKeyPayload = {\n    type: AccountWalletPayloadType.PrivateKey,\n    id: toWalletPayloadId(AccountWalletPayloadType.PrivateKey),\n    metadata: { name: walletObj.metadata.name },\n    groups: [],\n  };\n\n  for (const groupObj of Object.values(walletObj.groups)) {\n    const accountId = groupObj.accounts[0];\n    if (!accountId) {\n      continue;\n    }\n    const account = context.messenger.call(\n      'AccountsController:getAccount',\n      accountId,\n    );\n    if (!account) {\n      continue;\n    }\n\n    const { address } = account;\n\n    let exported: PrivateKeyExportedAccount | undefined;\n    if (includeSecrets) {\n      const result = await context.messenger.call(\n        'KeyringController:withKeyringV2',\n        { address },\n        async ({ keyring }) => {\n          if (!keyring.exportAccount) {\n            throw new Error(\n              `Keyring for account ${accountId} does not support exportAccount`,\n            );\n          }\n\n          return keyring.exportAccount(accountId, {\n            type: 'private-key',\n            encoding: AccountWalletPrivateKeyEncoding.Hexadecimal,\n          });\n        },\n      );\n\n      exported = result as PrivateKeyExportedAccount;\n    }\n\n    const group: AccountWalletPrivateKeyGroupEntry = {\n      id: toGroupPayloadId(wallet.id, address),\n      metadata: {\n        name: groupObj.metadata.name,\n        pinned: groupObj.metadata.pinned,\n        hidden: groupObj.metadata.hidden,\n      },\n    };\n\n    if (includeSecrets) {\n      if (!exported) {\n        throw new Error(\n          `Failed to export private key for account ${accountId}`,\n        );\n      }\n      group.value = {\n        privateKey: encodeBytes(new TextEncoder().encode(exported.privateKey)),\n        encoding: exported.encoding,\n        type: EthAccountType.Eoa,\n      };\n    }\n\n    idMap.add(groupObj.id, group.id);\n\n    wallet.groups.push(group);\n  }\n\n  return wallet;\n}\n\n/**\n * Builds an {@link AccountTreeSnapshot} from the current controller state.\n *\n * Iterates over all wallets in the tree:\n * - {@link AccountWalletType.Entropy} (HD) wallets -> `'mnemonic'` payload entries.\n * - {@link AccountWalletType.Keyring} wallets of type `simple` -> `'private-key'` payload entries.\n * - Snap wallets and hardware keyrings are skipped in v1.\n *\n * @param context - Export context providing state and messenger access.\n * @param options - Export options.\n * @returns A promise that resolves to the built snapshot.\n * @throws If `options.includeSecrets` is `true` and the vault is locked.\n */\nexport async function exportState(\n  context: ExportContext,\n  options: ExportStateOptions = {},\n): Promise<AccountTreeSnapshot> {\n  const state = context.getState();\n\n  const includeSecrets = options.includeSecrets ?? false;\n  const { isUnlocked } = context.messenger.call('KeyringController:getState');\n  if (includeSecrets && !isUnlocked) {\n    throw new Error('Cannot include secrets in export when vault is locked');\n  }\n\n  const idMap = new IdMap();\n  const entries: AccountTreeWalletEntry[] = [];\n  let privateKeyWallet: AccountWalletPrivateKeyPayload | undefined;\n\n  for (const walletObj of Object.values(state.accountTree.wallets)) {\n    if (isMnemonicWalletObject(walletObj)) {\n      entries.push(\n        await exportMnemonicWalletObject(\n          context,\n          walletObj,\n          includeSecrets,\n          idMap,\n        ),\n      );\n    } else if (isPrivateKeyWalletObject(walletObj)) {\n      const exported = await exportPrivateKeyWalletObject(\n        context,\n        walletObj,\n        includeSecrets,\n        idMap,\n      );\n\n      if (privateKeyWallet) {\n        privateKeyWallet.groups.push(...exported.groups);\n      } else {\n        privateKeyWallet = exported;\n\n        // Register only once, since all private keys are exported into the same wallet entry.\n        idMap.add(walletObj.id, exported.id);\n      }\n    } else {\n      // AccountWalletType.Snap and hardware keyrings: skipped for now.\n    }\n  }\n\n  if (privateKeyWallet) {\n    entries.push(privateKeyWallet);\n  }\n\n  return new AccountTreeSnapshot(entries, idMap);\n}\n"]}

package/dist/state/export.d.cts

@@ -0,0 +1,40 @@
+import type { AccountTreeControllerMessenger, AccountTreeControllerState } from "../types.cjs";
+import type { AccountWalletObject } from "../wallet.cjs";
+import { AccountWalletEntropyObject, AccountWalletKeyringObject } from "../wallet.cjs";
+import type { ExportStateOptions } from "./payload.cjs";
+import { AccountTreeSnapshot } from "./snapshot.cjs";
+/**
+ * Returns `true` if `wallet` is an HD entropy wallet ({@link AccountWalletEntropyObject}).
+ *
+ * @param wallet - The wallet object to test.
+ * @returns Type predicate narrowing to {@link AccountWalletEntropyObject}.
+ */
+export declare function isMnemonicWalletObject(wallet: AccountWalletObject): wallet is AccountWalletEntropyObject;
+/**
+ * Returns `true` if `wallet` is an imported private-key wallet
+ * ({@link AccountWalletKeyringObject} with keyring type {@link KeyringTypes.simple}).
+ *
+ * @param wallet - The wallet object to test.
+ * @returns Type predicate narrowing to {@link AccountWalletKeyringObject}.
+ */
+export declare function isPrivateKeyWalletObject(wallet: AccountWalletObject): wallet is AccountWalletKeyringObject;
+/** Context required by {@link exportState}. */
+export type ExportContext = {
+    getState: () => AccountTreeControllerState;
+    messenger: AccountTreeControllerMessenger;
+};
+/**
+ * Builds an {@link AccountTreeSnapshot} from the current controller state.
+ *
+ * Iterates over all wallets in the tree:
+ * - {@link AccountWalletType.Entropy} (HD) wallets -> `'mnemonic'` payload entries.
+ * - {@link AccountWalletType.Keyring} wallets of type `simple` -> `'private-key'` payload entries.
+ * - Snap wallets and hardware keyrings are skipped in v1.
+ *
+ * @param context - Export context providing state and messenger access.
+ * @param options - Export options.
+ * @returns A promise that resolves to the built snapshot.
+ * @throws If `options.includeSecrets` is `true` and the vault is locked.
+ */
+export declare function exportState(context: ExportContext, options?: ExportStateOptions): Promise<AccountTreeSnapshot>;
+//# sourceMappingURL=export.d.cts.map

package/dist/state/export.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.d.cts","sourceRoot":"","sources":["../../src/state/export.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,8BAA8B,EAC9B,0BAA0B,EAC3B,qBAAoB;AACrB,OAAO,KAAK,EAAE,mBAAmB,EAAE,sBAAqB;AACxD,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,EAC3B,sBAAqB;AAEtB,OAAO,KAAK,EAMV,kBAAkB,EACnB,sBAAqB;AAOtB,OAAO,EAAE,mBAAmB,EAAE,uBAAsB;AAGpD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,mBAAmB,GAC1B,MAAM,IAAI,0BAA0B,CAEtC;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,mBAAmB,GAC1B,MAAM,IAAI,0BAA0B,CAKtC;AAED,+CAA+C;AAC/C,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,MAAM,0BAA0B,CAAC;IAC3C,SAAS,EAAE,8BAA8B,CAAC;CAC3C,CAAC;AA2LF;;;;;;;;;;;;GAYG;AACH,wBAAsB,WAAW,CAC/B,OAAO,EAAE,aAAa,EACtB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,mBAAmB,CAAC,CAiD9B"}

package/dist/state/export.d.mts

@@ -0,0 +1,40 @@
+import type { AccountTreeControllerMessenger, AccountTreeControllerState } from "../types.mjs";
+import type { AccountWalletObject } from "../wallet.mjs";
+import { AccountWalletEntropyObject, AccountWalletKeyringObject } from "../wallet.mjs";
+import type { ExportStateOptions } from "./payload.mjs";
+import { AccountTreeSnapshot } from "./snapshot.mjs";
+/**
+ * Returns `true` if `wallet` is an HD entropy wallet ({@link AccountWalletEntropyObject}).
+ *
+ * @param wallet - The wallet object to test.
+ * @returns Type predicate narrowing to {@link AccountWalletEntropyObject}.
+ */
+export declare function isMnemonicWalletObject(wallet: AccountWalletObject): wallet is AccountWalletEntropyObject;
+/**
+ * Returns `true` if `wallet` is an imported private-key wallet
+ * ({@link AccountWalletKeyringObject} with keyring type {@link KeyringTypes.simple}).
+ *
+ * @param wallet - The wallet object to test.
+ * @returns Type predicate narrowing to {@link AccountWalletKeyringObject}.
+ */
+export declare function isPrivateKeyWalletObject(wallet: AccountWalletObject): wallet is AccountWalletKeyringObject;
+/** Context required by {@link exportState}. */
+export type ExportContext = {
+    getState: () => AccountTreeControllerState;
+    messenger: AccountTreeControllerMessenger;
+};
+/**
+ * Builds an {@link AccountTreeSnapshot} from the current controller state.
+ *
+ * Iterates over all wallets in the tree:
+ * - {@link AccountWalletType.Entropy} (HD) wallets -> `'mnemonic'` payload entries.
+ * - {@link AccountWalletType.Keyring} wallets of type `simple` -> `'private-key'` payload entries.
+ * - Snap wallets and hardware keyrings are skipped in v1.
+ *
+ * @param context - Export context providing state and messenger access.
+ * @param options - Export options.
+ * @returns A promise that resolves to the built snapshot.
+ * @throws If `options.includeSecrets` is `true` and the vault is locked.
+ */
+export declare function exportState(context: ExportContext, options?: ExportStateOptions): Promise<AccountTreeSnapshot>;
+//# sourceMappingURL=export.d.mts.map

package/dist/state/export.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.d.mts","sourceRoot":"","sources":["../../src/state/export.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,8BAA8B,EAC9B,0BAA0B,EAC3B,qBAAoB;AACrB,OAAO,KAAK,EAAE,mBAAmB,EAAE,sBAAqB;AACxD,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,EAC3B,sBAAqB;AAEtB,OAAO,KAAK,EAMV,kBAAkB,EACnB,sBAAqB;AAOtB,OAAO,EAAE,mBAAmB,EAAE,uBAAsB;AAGpD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,mBAAmB,GAC1B,MAAM,IAAI,0BAA0B,CAEtC;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,mBAAmB,GAC1B,MAAM,IAAI,0BAA0B,CAKtC;AAED,+CAA+C;AAC/C,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,MAAM,0BAA0B,CAAC;IAC3C,SAAS,EAAE,8BAA8B,CAAC;CAC3C,CAAC;AA2LF;;;;;;;;;;;;GAYG;AACH,wBAAsB,WAAW,CAC/B,OAAO,EAAE,aAAa,EACtB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,mBAAmB,CAAC,CAiD9B"}

package/dist/state/export.mjs

@@ -0,0 +1,208 @@
+import { AccountWalletType } from "@metamask/account-api";
+import { HdKeyring } from "@metamask/eth-hd-keyring/v2";
+import { EthAccountType } from "@metamask/keyring-api";
+import { KeyringTypes } from "@metamask/keyring-controller";
+import { IdMap } from "./id-map.mjs";
+import { AccountWalletPayloadType, AccountWalletPrivateKeyEncoding, toWalletPayloadId, toGroupPayloadId } from "./payload.mjs";
+import { AccountTreeSnapshot } from "./snapshot.mjs";
+import { encodeBytes } from "./utils.mjs";
+/**
+ * Returns `true` if `wallet` is an HD entropy wallet ({@link AccountWalletEntropyObject}).
+ *
+ * @param wallet - The wallet object to test.
+ * @returns Type predicate narrowing to {@link AccountWalletEntropyObject}.
+ */
+export function isMnemonicWalletObject(wallet) {
+    return wallet.type === AccountWalletType.Entropy;
+}
+/**
+ * Returns `true` if `wallet` is an imported private-key wallet
+ * ({@link AccountWalletKeyringObject} with keyring type {@link KeyringTypes.simple}).
+ *
+ * @param wallet - The wallet object to test.
+ * @returns Type predicate narrowing to {@link AccountWalletKeyringObject}.
+ */
+export function isPrivateKeyWalletObject(wallet) {
+    return (wallet.type === AccountWalletType.Keyring &&
+        wallet.metadata.keyring.type === KeyringTypes.simple);
+}
+/**
+ * Exports a single entropy (HD) wallet object as an {@link AccountWalletMnemonicPayload}.
+ *
+ * Calls `KeyringController:withKeyringV2Unsafe` to derive the stable entropy source ID
+ * via {@link HdKeyring.toEntropySourceId} and, when `includeSecrets` is `true`, to read
+ * the raw mnemonic bytes.
+ *
+ * @param context - Export context.
+ * @param walletObj - The local entropy wallet to export.
+ * @param includeSecrets - When `true`, the BIP-39 mnemonic is included in the payload.
+ * @param idMap - ID map to populate with local↔payload ID pairs for this wallet and its groups.
+ * @returns The mnemonic wallet payload entry.
+ * @throws If `includeSecrets` is `true` but the mnemonic cannot be read from the keyring.
+ */
+async function exportMnemonicWalletObject(context, walletObj, includeSecrets, idMap) {
+    const result = await context.messenger.call('KeyringController:withKeyringV2Unsafe', 
+    // The local wallet entropy ID is the keyring ID.
+    { id: walletObj.metadata.entropy.id }, async ({ keyring }) => {
+        const hdKeyring = keyring;
+        const includeMnemonic = includeSecrets &&
+            hdKeyring.mnemonic !== null &&
+            hdKeyring.mnemonic !== undefined;
+        return {
+            // Compute the stable entropy source ID from the keyring's mnemonic (BIP-39 seed).
+            entropySourceId: await hdKeyring.toEntropySourceId(),
+            // No need to include the mnemonic here if we're not exporting secrets.
+            mnemonic: includeMnemonic ? hdKeyring.mnemonic : undefined,
+        };
+    });
+    const { entropySourceId, mnemonic } = result;
+    // We use the stable entropy source ID as the payload wallet ID, rather than the local wallet ID, to
+    // ensure that the exported snapshot is stable across different installations and sessions.
+    const wallet = {
+        type: AccountWalletPayloadType.Mnemonic,
+        id: toWalletPayloadId(entropySourceId),
+        metadata: { name: walletObj.metadata.name },
+        groups: [],
+    };
+    idMap.add(walletObj.id, wallet.id);
+    for (const groupObj of Object.values(walletObj.groups)) {
+        const { groupIndex } = groupObj.metadata.entropy;
+        const group = {
+            id: toGroupPayloadId(wallet.id, groupIndex),
+            groupIndex,
+            metadata: {
+                name: groupObj.metadata.name,
+                pinned: groupObj.metadata.pinned,
+                hidden: groupObj.metadata.hidden,
+            },
+        };
+        idMap.add(groupObj.id, group.id);
+        wallet.groups.push(group);
+    }
+    // Sort the groups by their `groupIndex` to ensure a stable order in the exported payload.
+    wallet.groups.sort((group, otherGroup) => group.groupIndex - otherGroup.groupIndex);
+    // This should never happen, but we check just in case.
+    if (includeSecrets) {
+        if (mnemonic === undefined) {
+            throw new Error(`Failed to export mnemonic for wallet ${wallet.id}`);
+        }
+        wallet.value = encodeBytes(mnemonic);
+    }
+    return wallet;
+}
+/**
+ * Exports a single simple-keyring wallet object as an {@link AccountWalletPrivateKeyPayload}.
+ *
+ * All groups from the wallet are merged into the `'private-key'` singleton payload entry.
+ * When `includeSecrets` is `true`, each group's private key is exported via
+ * `KeyringController:withKeyringV2`.
+ *
+ * @param context - Export context.
+ * @param walletObj - The local simple-keyring wallet to export.
+ * @param includeSecrets - When `true`, private keys are included in the payload.
+ * @param idMap - ID map to populate with local↔payload ID pairs for this wallet and its groups.
+ * @returns The private-key wallet payload entry.
+ * @throws If `includeSecrets` is `true` but a private key cannot be exported for an account.
+ */
+async function exportPrivateKeyWalletObject(context, walletObj, includeSecrets, idMap) {
+    // We use a singleton wallet ID for private keys.
+    const wallet = {
+        type: AccountWalletPayloadType.PrivateKey,
+        id: toWalletPayloadId(AccountWalletPayloadType.PrivateKey),
+        metadata: { name: walletObj.metadata.name },
+        groups: [],
+    };
+    for (const groupObj of Object.values(walletObj.groups)) {
+        const accountId = groupObj.accounts[0];
+        if (!accountId) {
+            continue;
+        }
+        const account = context.messenger.call('AccountsController:getAccount', accountId);
+        if (!account) {
+            continue;
+        }
+        const { address } = account;
+        let exported;
+        if (includeSecrets) {
+            const result = await context.messenger.call('KeyringController:withKeyringV2', { address }, async ({ keyring }) => {
+                if (!keyring.exportAccount) {
+                    throw new Error(`Keyring for account ${accountId} does not support exportAccount`);
+                }
+                return keyring.exportAccount(accountId, {
+                    type: 'private-key',
+                    encoding: AccountWalletPrivateKeyEncoding.Hexadecimal,
+                });
+            });
+            exported = result;
+        }
+        const group = {
+            id: toGroupPayloadId(wallet.id, address),
+            metadata: {
+                name: groupObj.metadata.name,
+                pinned: groupObj.metadata.pinned,
+                hidden: groupObj.metadata.hidden,
+            },
+        };
+        if (includeSecrets) {
+            if (!exported) {
+                throw new Error(`Failed to export private key for account ${accountId}`);
+            }
+            group.value = {
+                privateKey: encodeBytes(new TextEncoder().encode(exported.privateKey)),
+                encoding: exported.encoding,
+                type: EthAccountType.Eoa,
+            };
+        }
+        idMap.add(groupObj.id, group.id);
+        wallet.groups.push(group);
+    }
+    return wallet;
+}
+/**
+ * Builds an {@link AccountTreeSnapshot} from the current controller state.
+ *
+ * Iterates over all wallets in the tree:
+ * - {@link AccountWalletType.Entropy} (HD) wallets -> `'mnemonic'` payload entries.
+ * - {@link AccountWalletType.Keyring} wallets of type `simple` -> `'private-key'` payload entries.
+ * - Snap wallets and hardware keyrings are skipped in v1.
+ *
+ * @param context - Export context providing state and messenger access.
+ * @param options - Export options.
+ * @returns A promise that resolves to the built snapshot.
+ * @throws If `options.includeSecrets` is `true` and the vault is locked.
+ */
+export async function exportState(context, options = {}) {
+    const state = context.getState();
+    const includeSecrets = options.includeSecrets ?? false;
+    const { isUnlocked } = context.messenger.call('KeyringController:getState');
+    if (includeSecrets && !isUnlocked) {
+        throw new Error('Cannot include secrets in export when vault is locked');
+    }
+    const idMap = new IdMap();
+    const entries = [];
+    let privateKeyWallet;
+    for (const walletObj of Object.values(state.accountTree.wallets)) {
+        if (isMnemonicWalletObject(walletObj)) {
+            entries.push(await exportMnemonicWalletObject(context, walletObj, includeSecrets, idMap));
+        }
+        else if (isPrivateKeyWalletObject(walletObj)) {
+            const exported = await exportPrivateKeyWalletObject(context, walletObj, includeSecrets, idMap);
+            if (privateKeyWallet) {
+                privateKeyWallet.groups.push(...exported.groups);
+            }
+            else {
+                privateKeyWallet = exported;
+                // Register only once, since all private keys are exported into the same wallet entry.
+                idMap.add(walletObj.id, exported.id);
+            }
+        }
+        else {
+            // AccountWalletType.Snap and hardware keyrings: skipped for now.
+        }
+    }
+    if (privateKeyWallet) {
+        entries.push(privateKeyWallet);
+    }
+    return new AccountTreeSnapshot(entries, idMap);
+}
+//# sourceMappingURL=export.mjs.map