@metamask-previews/account-tree-controller 7.6.1-preview-58a4a8b71 → 7.6.1-preview-4c8a5dfcb

package/dist/state/payload.cjs

@@ -1,159 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.migrate = exports.ACCOUNT_TREE_PAYLOAD_CURRENT_VERSION = exports.migrations = exports.assertValidAccountTreePayload = exports.AccountTreePayloadStruct = exports.toWalletPayloadId = exports.parsePayloadGroupId = void 0;
-const keyring_sdk_1 = require("@metamask/keyring-sdk");
-const superstruct_1 = require("@metamask/superstruct");
-const PAYLOAD_GROUP_ID_REGEX = /^(?<walletId>wallet:[^/]+)\/(?<subId>.+)$/u;
-/**
- * Parses a payload group ID into its wallet ID and group sub-ID components.
- *
- * @param groupId - The payload group ID to parse.
- * @returns The parsed wallet ID and group sub-ID.
- * @throws If the group ID format is invalid.
- */
-function parsePayloadGroupId(groupId) {
-    const match = PAYLOAD_GROUP_ID_REGEX.exec(groupId);
-    if (!match?.groups) {
-        throw new Error(`Invalid payload group ID: "${groupId}"`);
-    }
-    return {
-        walletId: match.groups.walletId,
-        subId: match.groups.subId,
-    };
-}
-exports.parsePayloadGroupId = parsePayloadGroupId;
-/**
- * Constructs an {@link AccountWalletPayloadId} from an entropy source ID.
- *
- * @param entropySourceId - Stable entropy source ID returned by `HdKeyring.toEntropySourceId()`.
- * @returns The portable wallet payload ID.
- */
-function toWalletPayloadId(entropySourceId) {
-    return `wallet:${entropySourceId}`;
-}
-exports.toWalletPayloadId = toWalletPayloadId;
-const AccountWalletPayloadIdStruct = (0, superstruct_1.define)('AccountWalletPayloadId', (value) => typeof value === 'string' && value.startsWith('wallet:')
-    ? true
-    : 'Expected a wallet payload ID starting with "wallet:"');
-const AccountGroupPayloadIdStruct = (0, superstruct_1.define)('AccountGroupPayloadId', (value) => typeof value === 'string' && PAYLOAD_GROUP_ID_REGEX.test(value)
-    ? true
-    : 'Expected a group payload ID in the form "wallet:<id>/<subId>"');
-const AccountWalletPayloadMetadataStruct = (0, superstruct_1.object)({
-    name: (0, superstruct_1.string)(),
-});
-const AccountWalletGroupPayloadMetadataStruct = (0, superstruct_1.object)({
-    name: (0, superstruct_1.string)(),
-    pinned: (0, superstruct_1.boolean)(),
-    hidden: (0, superstruct_1.boolean)(),
-});
-const AccountWalletPrivateKeyValueStruct = (0, superstruct_1.object)({
-    privateKey: (0, superstruct_1.sensitive)((0, superstruct_1.string)()),
-    encoding: (0, superstruct_1.enums)(['hexadecimal', 'base58', 'base32']),
-    type: (0, superstruct_1.exactOptional)((0, superstruct_1.string)()),
-});
-const AccountWalletMnemonicGroupEntryStruct = (0, superstruct_1.object)({
-    id: AccountGroupPayloadIdStruct,
-    groupIndex: (0, superstruct_1.integer)(),
-    metadata: AccountWalletGroupPayloadMetadataStruct,
-});
-const AccountWalletPrivateKeyGroupEntryStruct = (0, superstruct_1.object)({
-    id: AccountGroupPayloadIdStruct,
-    value: (0, superstruct_1.exactOptional)(AccountWalletPrivateKeyValueStruct),
-    metadata: AccountWalletGroupPayloadMetadataStruct,
-});
-const AccountWalletMnemonicPayloadStruct = (0, superstruct_1.object)({
-    id: AccountWalletPayloadIdStruct,
-    type: (0, superstruct_1.literal)('mnemonic'),
-    value: (0, superstruct_1.exactOptional)((0, superstruct_1.sensitive)((0, superstruct_1.string)())),
-    metadata: AccountWalletPayloadMetadataStruct,
-    groups: (0, superstruct_1.array)(AccountWalletMnemonicGroupEntryStruct),
-});
-const AccountWalletPrivateKeyPayloadStruct = (0, superstruct_1.object)({
-    id: AccountWalletPayloadIdStruct,
-    type: (0, superstruct_1.literal)('private-key'),
-    metadata: AccountWalletPayloadMetadataStruct,
-    groups: (0, superstruct_1.array)(AccountWalletPrivateKeyGroupEntryStruct),
-});
-const AccountTreeWalletEntryStruct = (0, superstruct_1.union)([
-    AccountWalletMnemonicPayloadStruct,
-    AccountWalletPrivateKeyPayloadStruct,
-]);
-/**
- * Superstruct schema for an {@link AccountTreePayload} (inner data, without version envelope).
- *
- * Validates v1 wallet entries (`'mnemonic'` and `'private-key'` only) and
- * rejects unsupported wallet types. Secret fields (`value`, `privateKey`) use
- * the Superstruct `sensitive()` wrapper so validation failures redact secrets
- * from error output.
- */
-exports.AccountTreePayloadStruct = (0, superstruct_1.object)({
-    wallets: (0, superstruct_1.array)(AccountTreeWalletEntryStruct),
-});
-/**
- * Formats Superstruct validation failures into a single error message string.
- *
- * @param error - The StructError thrown during payload validation.
- * @returns A comma-separated list of `[path] message` entries.
- */
-const formatValidationErrorMessages = (error) => error
-    .failures()
-    .map(({ path, message }) => `[${path.join('.')}] ${message}`)
-    .join(', ');
-/**
- * Asserts that `value` conforms to the v1 {@link AccountTreePayload} schema.
- *
- * Prefer {@link AccountTreeSnapshot.deserialize} at transport boundaries so
- * validation stays paired with snapshot construction. Use this helper when you
- * already hold a parsed object and need to assert its shape before further
- * processing.
- *
- * @param value - Value to validate.
- * @throws If `value` is not a valid v1 payload, including unsupported wallet types.
- */
-function assertValidAccountTreePayload(value) {
-    try {
-        (0, superstruct_1.assert)(value, exports.AccountTreePayloadStruct);
-    }
-    catch (error) {
-        if (error instanceof superstruct_1.StructError) {
-            throw new Error(`Invalid AccountTreePayload: ${formatValidationErrorMessages(error)}`);
-        }
-        /* istanbul ignore next */
-        throw error;
-    }
-}
-exports.assertValidAccountTreePayload = assertValidAccountTreePayload;
-/**
- * Migration chain for {@link AccountTreePayload}.
- *
- * Each `.add()` call appends a step; `migrations.version` equals the number of
- * steps and serves as the canonical current version written by
- * {@link AccountTreeSnapshot.serialize}.
- *
- * **v1** — validates and returns the v1 payload structure `{ wallets: [...] }`.
- */
-exports.migrations = (0, keyring_sdk_1.createMigrations)().add({
-    migrate(data) {
-        assertValidAccountTreePayload(data);
-        return data;
-    },
-});
-/** Current version of the {@link AccountTreePayload} format, derived from the migration chain. */
-exports.ACCOUNT_TREE_PAYLOAD_CURRENT_VERSION = exports.migrations.version;
-/**
- * Validates a raw value as an `AccountTreePayload` and runs any necessary version migrations.
- *
- * This is the low-level entry point used by {@link AccountTreeSnapshot.deserialize}.
- * Callers receiving untrusted wire data should prefer `deserialize`, which returns
- * an immutable {@link AccountTreeSnapshot} ready for filtering and import.
- *
- * @param raw - Unknown value to validate.
- * @returns A fully migrated `AccountTreePayload`.
- * @throws If `raw` is not a valid payload, its version is unsupported, or any wallet type is unrecognized.
- */
-async function migrate(raw) {
-    const { data } = await exports.migrations.apply(raw);
-    return data;
-}
-exports.migrate = migrate;
-//# sourceMappingURL=payload.cjs.map

package/dist/state/payload.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"payload.cjs","sourceRoot":"","sources":["../../src/state/payload.ts"],"names":[],"mappings":";;;AAEA,uDAAyD;AACzD,uDAc+B;AAoB/B,MAAM,sBAAsB,GAAG,4CAA4C,CAAC;AAE5E;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,OAA8B;IAE9B,MAAM,KAAK,GAAG,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnD,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,8BAA8B,OAAO,GAAG,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO;QACL,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAkC;QACzD,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK;KAC1B,CAAC;AACJ,CAAC;AAXD,kDAWC;AAkHD;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,eAAuB;IAEvB,OAAO,UAAU,eAAe,EAAE,CAAC;AACrC,CAAC;AAJD,8CAIC;AAQD,MAAM,4BAA4B,GAAG,IAAA,oBAAM,EACzC,wBAAwB,EACxB,CAAC,KAAK,EAAE,EAAE,CACR,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC;IACtD,CAAC,CAAC,IAAI;IACN,CAAC,CAAC,sDAAsD,CAC7D,CAAC;AAEF,MAAM,2BAA2B,GAAG,IAAA,oBAAM,EACxC,uBAAuB,EACvB,CAAC,KAAK,EAAE,EAAE,CACR,OAAO,KAAK,KAAK,QAAQ,IAAI,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC;IAC7D,CAAC,CAAC,IAAI;IACN,CAAC,CAAC,+DAA+D,CACtE,CAAC;AAEF,MAAM,kCAAkC,GAAG,IAAA,oBAAM,EAAC;IAChD,IAAI,EAAE,IAAA,oBAAM,GAAE;CACf,CAAC,CAAC;AAEH,MAAM,uCAAuC,GAAG,IAAA,oBAAM,EAAC;IACrD,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,MAAM,EAAE,IAAA,qBAAO,GAAE;IACjB,MAAM,EAAE,IAAA,qBAAO,GAAE;CAClB,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,IAAA,oBAAM,EAAC;IAChD,UAAU,EAAE,IAAA,uBAAS,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC/B,QAAQ,EAAE,IAAA,mBAAK,EAAC,CAAC,aAAa,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACpD,IAAI,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;CAC9B,CAAC,CAAC;AAEH,MAAM,qCAAqC,GAAG,IAAA,oBAAM,EAAC;IACnD,EAAE,EAAE,2BAA2B;IAC/B,UAAU,EAAE,IAAA,qBAAO,GAAE;IACrB,QAAQ,EAAE,uCAAuC;CAClD,CAAC,CAAC;AAEH,MAAM,uCAAuC,GAAG,IAAA,oBAAM,EAAC;IACrD,EAAE,EAAE,2BAA2B;IAC/B,KAAK,EAAE,IAAA,2BAAa,EAAC,kCAAkC,CAAC;IACxD,QAAQ,EAAE,uCAAuC;CAClD,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,IAAA,oBAAM,EAAC;IAChD,EAAE,EAAE,4BAA4B;IAChC,IAAI,EAAE,IAAA,qBAAO,EAAC,UAAU,CAAC;IACzB,KAAK,EAAE,IAAA,2BAAa,EAAC,IAAA,uBAAS,EAAC,IAAA,oBAAM,GAAE,CAAC,CAAC;IACzC,QAAQ,EAAE,kCAAkC;IAC5C,MAAM,EAAE,IAAA,mBAAK,EAAC,qCAAqC,CAAC;CACrD,CAAC,CAAC;AAEH,MAAM,oCAAoC,GAAG,IAAA,oBAAM,EAAC;IAClD,EAAE,EAAE,4BAA4B;IAChC,IAAI,EAAE,IAAA,qBAAO,EAAC,aAAa,CAAC;IAC5B,QAAQ,EAAE,kCAAkC;IAC5C,MAAM,EAAE,IAAA,mBAAK,EAAC,uCAAuC,CAAC;CACvD,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAAG,IAAA,mBAAK,EAAC;IACzC,kCAAkC;IAClC,oCAAoC;CACrC,CAAC,CAAC;AAEH;;;;;;;GAOG;AACU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC;IAC7C,OAAO,EAAE,IAAA,mBAAK,EAAC,4BAA4B,CAAC;CAC7C,CAAC,CAAC;AAOH;;;;;GAKG;AACH,MAAM,6BAA6B,GAAG,CAAC,KAAkB,EAAU,EAAE,CACnE,KAAK;KACF,QAAQ,EAAE;KACV,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;KAC5D,IAAI,CAAC,IAAI,CAAC,CAAC;AAEhB;;;;;;;;;;GAUG;AACH,SAAgB,6BAA6B,CAC3C,KAAc;IAEd,IAAI,CAAC;QACH,IAAA,oBAAM,EAAC,KAAK,EAAE,gCAAwB,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CACb,+BAA+B,6BAA6B,CAAC,KAAK,CAAC,EAAE,CACtE,CAAC;QACJ,CAAC;QACD,0BAA0B;QAC1B,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAdD,sEAcC;AAED;;;;;;;;GAQG;AACU,QAAA,UAAU,GACrB,IAAA,8BAAgB,GAAE,CAAC,GAAG,CAAC;IACrB,OAAO,CAAC,IAAU;QAChB,6BAA6B,CAAC,IAAI,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC,CAAC;AAEL,kGAAkG;AACrF,QAAA,oCAAoC,GAAG,kBAAU,CAAC,OAAO,CAAC;AAEvE;;;;;;;;;;GAUG;AACI,KAAK,UAAU,OAAO,CAAC,GAAY;IACxC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,kBAAU,CAAC,KAAK,CAAC,GAAW,CAAC,CAAC;IACrD,OAAO,IAAI,CAAC;AACd,CAAC;AAHD,0BAGC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\nimport type { MigrationChain } from '@metamask/keyring-sdk';\nimport { createMigrations } from '@metamask/keyring-sdk';\nimport {\n  assert,\n  array,\n  boolean,\n  define,\n  enums,\n  integer,\n  literal,\n  object,\n  exactOptional,\n  sensitive,\n  string,\n  StructError,\n  union,\n} from '@metamask/superstruct';\nimport type { Infer } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\n\n/** Stable cross-device wallet identifier. Format: `wallet:<entropySourceId>`. */\nexport type AccountWalletPayloadId = `wallet:${string}`;\n\n/** Stable cross-device group identifier. Format: `wallet:<entropySourceId>/<groupSubId>`. */\nexport type AccountGroupPayloadId = `wallet:${string}/${string}`;\n\n/**\n * Parsed representation of an {@link AccountGroupPayloadId}.\n */\nexport type ParsedPayloadGroupId = {\n  /** The wallet portion of the group ID. */\n  walletId: AccountWalletPayloadId;\n  /** The group-specific sub-ID (e.g. group index for mnemonic wallets, address for private-key wallets). */\n  subId: string;\n};\n\nconst PAYLOAD_GROUP_ID_REGEX = /^(?<walletId>wallet:[^/]+)\\/(?<subId>.+)$/u;\n\n/**\n * Parses a payload group ID into its wallet ID and group sub-ID components.\n *\n * @param groupId - The payload group ID to parse.\n * @returns The parsed wallet ID and group sub-ID.\n * @throws If the group ID format is invalid.\n */\nexport function parsePayloadGroupId(\n  groupId: AccountGroupPayloadId,\n): ParsedPayloadGroupId {\n  const match = PAYLOAD_GROUP_ID_REGEX.exec(groupId);\n  if (!match?.groups) {\n    throw new Error(`Invalid payload group ID: \"${groupId}\"`);\n  }\n  return {\n    walletId: match.groups.walletId as AccountWalletPayloadId,\n    subId: match.groups.subId,\n  };\n}\n\n/** Wallet-level metadata carried in every payload wallet entry. */\nexport type AccountWalletPayloadMetadata = { name: string };\n\n/** Group-level metadata carried in every payload group entry. */\nexport type AccountWalletGroupPayloadMetadata = {\n  name: string;\n  pinned: boolean;\n  hidden: boolean;\n};\n\n/** A single group entry inside an {@link AccountWalletMnemonicPayload}. */\nexport type AccountWalletMnemonicGroupEntry = {\n  /** Stable group payload ID. Format: `<walletPayloadId>/<groupIndex>`. */\n  id: AccountGroupPayloadId;\n  /** BIP-44 account index this group was derived at. */\n  groupIndex: number;\n  metadata: AccountWalletGroupPayloadMetadata;\n};\n\n/** A single group entry inside an {@link AccountWalletPrivateKeyPayload}. */\nexport type AccountWalletPrivateKeyGroupEntry = {\n  /** Stable group payload ID. Format: `wallet:private-key/<address>`. */\n  id: AccountGroupPayloadId;\n  /**\n   * Private key material. Shape matches `ExportedAccount` from `@metamask/keyring-api/v2`\n   * so the importer knows how to decode the key without additional out-of-band information.\n   * Absent in metadata-only exports.\n   */\n  value?: {\n    privateKey: string;\n    encoding: 'hexadecimal' | 'base58' | 'base32';\n    /**\n     * Account type from `KeyringAccountType` (e.g. `'eip155:eoa'`, `'bip122:p2wpkh'`).\n     * Absent for EVM accounts -- import via `SimpleKeyring`.\n     * Present for non-EVM accounts -- routing to the BIP-44 Snap handling this type is not yet implemented.\n     */\n    type?: KeyringAccount['type'];\n  };\n  metadata: AccountWalletGroupPayloadMetadata;\n};\n\n/** Payload entry for an HD (entropy) wallet and its derived account groups. */\nexport type AccountWalletMnemonicPayload = {\n  id: AccountWalletPayloadId;\n  type: 'mnemonic';\n  /** BIP-39 mnemonic phrase. Absent in metadata-only exports. */\n  value?: string;\n  metadata: AccountWalletPayloadMetadata;\n  groups: AccountWalletMnemonicGroupEntry[];\n};\n\n/**\n * Payload entry for all imported private-key accounts.\n *\n * All local simple-keyring wallets are merged into this single entry;\n * each account is represented as a separate group entry keyed by address.\n */\nexport type AccountWalletPrivateKeyPayload = {\n  id: AccountWalletPayloadId;\n  type: 'private-key';\n  metadata: AccountWalletPayloadMetadata;\n  groups: AccountWalletPrivateKeyGroupEntry[];\n};\n\n/** Union of all wallet entry types that can appear in an {@link AccountTreePayload}. */\nexport type AccountTreeWalletEntry =\n  | AccountWalletMnemonicPayload\n  | AccountWalletPrivateKeyPayload;\n\n/** Portable snapshot of the full account tree state (inner data, without version envelope). */\nexport type AccountTreePayload = {\n  wallets: AccountTreeWalletEntry[];\n};\n\n/**\n * Recursively readonly view of `T` used by snapshot filtering predicate types.\n *\n * @typeParam T - The mutable source type to expose as deeply read-only.\n */\nexport type DeepReadonly<T> = T extends readonly (infer Item)[]\n  ? readonly DeepReadonly<Item>[]\n  : T extends object\n    ? { readonly [Key in keyof T]: DeepReadonly<T[Key]> }\n    : T;\n\n/**\n * Deeply read-only wallet view passed to {@link AccountTreeSnapshot.filterWallets}\n * and {@link AccountTreeSnapshot.filterAllGroups} predicates.\n *\n * Entries are deep-cloned and deep-frozen when a snapshot is constructed, so\n * callers cannot mutate wallet IDs, types, secrets, metadata, or groups.\n */\nexport type AccountTreeSnapshotWallet = DeepReadonly<\n  AccountWalletMnemonicPayload | AccountWalletPrivateKeyPayload\n>;\n\n/**\n * Deeply read-only group view passed to {@link AccountTreeSnapshot.filterGroups}\n * and {@link AccountTreeSnapshot.filterAllGroups} predicates.\n *\n * Entries are deep-cloned and deep-frozen when a snapshot is constructed, so\n * callers cannot mutate group IDs, secrets, metadata, or parent wallet references.\n */\nexport type AccountTreeSnapshotGroup = DeepReadonly<\n  AccountWalletMnemonicGroupEntry | AccountWalletPrivateKeyGroupEntry\n>;\n\n/**\n * @deprecated Use {@link AccountTreeSnapshotWallet} instead.\n */\nexport type AccountTreeSnapshotEntry = AccountTreeSnapshotWallet;\n\n/**\n * Constructs an {@link AccountWalletPayloadId} from an entropy source ID.\n *\n * @param entropySourceId - Stable entropy source ID returned by `HdKeyring.toEntropySourceId()`.\n * @returns The portable wallet payload ID.\n */\nexport function toWalletPayloadId(\n  entropySourceId: string,\n): AccountWalletPayloadId {\n  return `wallet:${entropySourceId}`;\n}\n\n/** Options accepted by {@link AccountTreeController.exportState}. */\nexport type ExportStateOptions = {\n  /** When `true`, secrets (mnemonic / private keys) are included. Requires the vault to be unlocked. */\n  includeSecrets?: boolean;\n};\n\nconst AccountWalletPayloadIdStruct = define<AccountWalletPayloadId>(\n  'AccountWalletPayloadId',\n  (value) =>\n    typeof value === 'string' && value.startsWith('wallet:')\n      ? true\n      : 'Expected a wallet payload ID starting with \"wallet:\"',\n);\n\nconst AccountGroupPayloadIdStruct = define<AccountGroupPayloadId>(\n  'AccountGroupPayloadId',\n  (value) =>\n    typeof value === 'string' && PAYLOAD_GROUP_ID_REGEX.test(value)\n      ? true\n      : 'Expected a group payload ID in the form \"wallet:<id>/<subId>\"',\n);\n\nconst AccountWalletPayloadMetadataStruct = object({\n  name: string(),\n});\n\nconst AccountWalletGroupPayloadMetadataStruct = object({\n  name: string(),\n  pinned: boolean(),\n  hidden: boolean(),\n});\n\nconst AccountWalletPrivateKeyValueStruct = object({\n  privateKey: sensitive(string()),\n  encoding: enums(['hexadecimal', 'base58', 'base32']),\n  type: exactOptional(string()),\n});\n\nconst AccountWalletMnemonicGroupEntryStruct = object({\n  id: AccountGroupPayloadIdStruct,\n  groupIndex: integer(),\n  metadata: AccountWalletGroupPayloadMetadataStruct,\n});\n\nconst AccountWalletPrivateKeyGroupEntryStruct = object({\n  id: AccountGroupPayloadIdStruct,\n  value: exactOptional(AccountWalletPrivateKeyValueStruct),\n  metadata: AccountWalletGroupPayloadMetadataStruct,\n});\n\nconst AccountWalletMnemonicPayloadStruct = object({\n  id: AccountWalletPayloadIdStruct,\n  type: literal('mnemonic'),\n  value: exactOptional(sensitive(string())),\n  metadata: AccountWalletPayloadMetadataStruct,\n  groups: array(AccountWalletMnemonicGroupEntryStruct),\n});\n\nconst AccountWalletPrivateKeyPayloadStruct = object({\n  id: AccountWalletPayloadIdStruct,\n  type: literal('private-key'),\n  metadata: AccountWalletPayloadMetadataStruct,\n  groups: array(AccountWalletPrivateKeyGroupEntryStruct),\n});\n\nconst AccountTreeWalletEntryStruct = union([\n  AccountWalletMnemonicPayloadStruct,\n  AccountWalletPrivateKeyPayloadStruct,\n]);\n\n/**\n * Superstruct schema for an {@link AccountTreePayload} (inner data, without version envelope).\n *\n * Validates v1 wallet entries (`'mnemonic'` and `'private-key'` only) and\n * rejects unsupported wallet types. Secret fields (`value`, `privateKey`) use\n * the Superstruct `sensitive()` wrapper so validation failures redact secrets\n * from error output.\n */\nexport const AccountTreePayloadStruct = object({\n  wallets: array(AccountTreeWalletEntryStruct),\n});\n\n/** Inferred TypeScript type for a value matching {@link AccountTreePayloadStruct}. */\nexport type AccountTreePayloadStructType = Infer<\n  typeof AccountTreePayloadStruct\n>;\n\n/**\n * Formats Superstruct validation failures into a single error message string.\n *\n * @param error - The StructError thrown during payload validation.\n * @returns A comma-separated list of `[path] message` entries.\n */\nconst formatValidationErrorMessages = (error: StructError): string =>\n  error\n    .failures()\n    .map(({ path, message }) => `[${path.join('.')}] ${message}`)\n    .join(', ');\n\n/**\n * Asserts that `value` conforms to the v1 {@link AccountTreePayload} schema.\n *\n * Prefer {@link AccountTreeSnapshot.deserialize} at transport boundaries so\n * validation stays paired with snapshot construction. Use this helper when you\n * already hold a parsed object and need to assert its shape before further\n * processing.\n *\n * @param value - Value to validate.\n * @throws If `value` is not a valid v1 payload, including unsupported wallet types.\n */\nexport function assertValidAccountTreePayload(\n  value: unknown,\n): asserts value is AccountTreePayload {\n  try {\n    assert(value, AccountTreePayloadStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw new Error(\n        `Invalid AccountTreePayload: ${formatValidationErrorMessages(error)}`,\n      );\n    }\n    /* istanbul ignore next */\n    throw error;\n  }\n}\n\n/**\n * Migration chain for {@link AccountTreePayload}.\n *\n * Each `.add()` call appends a step; `migrations.version` equals the number of\n * steps and serves as the canonical current version written by\n * {@link AccountTreeSnapshot.serialize}.\n *\n * **v1** — validates and returns the v1 payload structure `{ wallets: [...] }`.\n */\nexport const migrations: MigrationChain<AccountTreePayload> =\n  createMigrations().add({\n    migrate(data: Json): AccountTreePayload {\n      assertValidAccountTreePayload(data);\n      return data;\n    },\n  });\n\n/** Current version of the {@link AccountTreePayload} format, derived from the migration chain. */\nexport const ACCOUNT_TREE_PAYLOAD_CURRENT_VERSION = migrations.version;\n\n/**\n * Validates a raw value as an `AccountTreePayload` and runs any necessary version migrations.\n *\n * This is the low-level entry point used by {@link AccountTreeSnapshot.deserialize}.\n * Callers receiving untrusted wire data should prefer `deserialize`, which returns\n * an immutable {@link AccountTreeSnapshot} ready for filtering and import.\n *\n * @param raw - Unknown value to validate.\n * @returns A fully migrated `AccountTreePayload`.\n * @throws If `raw` is not a valid payload, its version is unsupported, or any wallet type is unrecognized.\n */\nexport async function migrate(raw: unknown): Promise<AccountTreePayload> {\n  const { data } = await migrations.apply(raw as Json);\n  return data;\n}\n"]}

package/dist/state/payload.d.cts

@@ -1,287 +0,0 @@
-import type { KeyringAccount } from "@metamask/keyring-api";
-import type { MigrationChain } from "@metamask/keyring-sdk";
-import type { Infer } from "@metamask/superstruct";
-/** Stable cross-device wallet identifier. Format: `wallet:<entropySourceId>`. */
-export type AccountWalletPayloadId = `wallet:${string}`;
-/** Stable cross-device group identifier. Format: `wallet:<entropySourceId>/<groupSubId>`. */
-export type AccountGroupPayloadId = `wallet:${string}/${string}`;
-/**
- * Parsed representation of an {@link AccountGroupPayloadId}.
- */
-export type ParsedPayloadGroupId = {
-    /** The wallet portion of the group ID. */
-    walletId: AccountWalletPayloadId;
-    /** The group-specific sub-ID (e.g. group index for mnemonic wallets, address for private-key wallets). */
-    subId: string;
-};
-/**
- * Parses a payload group ID into its wallet ID and group sub-ID components.
- *
- * @param groupId - The payload group ID to parse.
- * @returns The parsed wallet ID and group sub-ID.
- * @throws If the group ID format is invalid.
- */
-export declare function parsePayloadGroupId(groupId: AccountGroupPayloadId): ParsedPayloadGroupId;
-/** Wallet-level metadata carried in every payload wallet entry. */
-export type AccountWalletPayloadMetadata = {
-    name: string;
-};
-/** Group-level metadata carried in every payload group entry. */
-export type AccountWalletGroupPayloadMetadata = {
-    name: string;
-    pinned: boolean;
-    hidden: boolean;
-};
-/** A single group entry inside an {@link AccountWalletMnemonicPayload}. */
-export type AccountWalletMnemonicGroupEntry = {
-    /** Stable group payload ID. Format: `<walletPayloadId>/<groupIndex>`. */
-    id: AccountGroupPayloadId;
-    /** BIP-44 account index this group was derived at. */
-    groupIndex: number;
-    metadata: AccountWalletGroupPayloadMetadata;
-};
-/** A single group entry inside an {@link AccountWalletPrivateKeyPayload}. */
-export type AccountWalletPrivateKeyGroupEntry = {
-    /** Stable group payload ID. Format: `wallet:private-key/<address>`. */
-    id: AccountGroupPayloadId;
-    /**
-     * Private key material. Shape matches `ExportedAccount` from `@metamask/keyring-api/v2`
-     * so the importer knows how to decode the key without additional out-of-band information.
-     * Absent in metadata-only exports.
-     */
-    value?: {
-        privateKey: string;
-        encoding: 'hexadecimal' | 'base58' | 'base32';
-        /**
-         * Account type from `KeyringAccountType` (e.g. `'eip155:eoa'`, `'bip122:p2wpkh'`).
-         * Absent for EVM accounts -- import via `SimpleKeyring`.
-         * Present for non-EVM accounts -- routing to the BIP-44 Snap handling this type is not yet implemented.
-         */
-        type?: KeyringAccount['type'];
-    };
-    metadata: AccountWalletGroupPayloadMetadata;
-};
-/** Payload entry for an HD (entropy) wallet and its derived account groups. */
-export type AccountWalletMnemonicPayload = {
-    id: AccountWalletPayloadId;
-    type: 'mnemonic';
-    /** BIP-39 mnemonic phrase. Absent in metadata-only exports. */
-    value?: string;
-    metadata: AccountWalletPayloadMetadata;
-    groups: AccountWalletMnemonicGroupEntry[];
-};
-/**
- * Payload entry for all imported private-key accounts.
- *
- * All local simple-keyring wallets are merged into this single entry;
- * each account is represented as a separate group entry keyed by address.
- */
-export type AccountWalletPrivateKeyPayload = {
-    id: AccountWalletPayloadId;
-    type: 'private-key';
-    metadata: AccountWalletPayloadMetadata;
-    groups: AccountWalletPrivateKeyGroupEntry[];
-};
-/** Union of all wallet entry types that can appear in an {@link AccountTreePayload}. */
-export type AccountTreeWalletEntry = AccountWalletMnemonicPayload | AccountWalletPrivateKeyPayload;
-/** Portable snapshot of the full account tree state (inner data, without version envelope). */
-export type AccountTreePayload = {
-    wallets: AccountTreeWalletEntry[];
-};
-/**
- * Recursively readonly view of `T` used by snapshot filtering predicate types.
- *
- * @typeParam T - The mutable source type to expose as deeply read-only.
- */
-export type DeepReadonly<T> = T extends readonly (infer Item)[] ? readonly DeepReadonly<Item>[] : T extends object ? {
-    readonly [Key in keyof T]: DeepReadonly<T[Key]>;
-} : T;
-/**
- * Deeply read-only wallet view passed to {@link AccountTreeSnapshot.filterWallets}
- * and {@link AccountTreeSnapshot.filterAllGroups} predicates.
- *
- * Entries are deep-cloned and deep-frozen when a snapshot is constructed, so
- * callers cannot mutate wallet IDs, types, secrets, metadata, or groups.
- */
-export type AccountTreeSnapshotWallet = DeepReadonly<AccountWalletMnemonicPayload | AccountWalletPrivateKeyPayload>;
-/**
- * Deeply read-only group view passed to {@link AccountTreeSnapshot.filterGroups}
- * and {@link AccountTreeSnapshot.filterAllGroups} predicates.
- *
- * Entries are deep-cloned and deep-frozen when a snapshot is constructed, so
- * callers cannot mutate group IDs, secrets, metadata, or parent wallet references.
- */
-export type AccountTreeSnapshotGroup = DeepReadonly<AccountWalletMnemonicGroupEntry | AccountWalletPrivateKeyGroupEntry>;
-/**
- * @deprecated Use {@link AccountTreeSnapshotWallet} instead.
- */
-export type AccountTreeSnapshotEntry = AccountTreeSnapshotWallet;
-/**
- * Constructs an {@link AccountWalletPayloadId} from an entropy source ID.
- *
- * @param entropySourceId - Stable entropy source ID returned by `HdKeyring.toEntropySourceId()`.
- * @returns The portable wallet payload ID.
- */
-export declare function toWalletPayloadId(entropySourceId: string): AccountWalletPayloadId;
-/** Options accepted by {@link AccountTreeController.exportState}. */
-export type ExportStateOptions = {
-    /** When `true`, secrets (mnemonic / private keys) are included. Requires the vault to be unlocked. */
-    includeSecrets?: boolean;
-};
-/**
- * Superstruct schema for an {@link AccountTreePayload} (inner data, without version envelope).
- *
- * Validates v1 wallet entries (`'mnemonic'` and `'private-key'` only) and
- * rejects unsupported wallet types. Secret fields (`value`, `privateKey`) use
- * the Superstruct `sensitive()` wrapper so validation failures redact secrets
- * from error output.
- */
-export declare const AccountTreePayloadStruct: import("@metamask/superstruct").Struct<{
-    wallets: ({
-        id: `wallet:${string}`;
-        type: "mnemonic";
-        metadata: {
-            name: string;
-        };
-        groups: {
-            id: `wallet:${string}/${string}`;
-            metadata: {
-                name: string;
-                pinned: boolean;
-                hidden: boolean;
-            };
-            groupIndex: number;
-        }[];
-        value?: string | undefined;
-    } | {
-        id: `wallet:${string}`;
-        type: "private-key";
-        metadata: {
-            name: string;
-        };
-        groups: {
-            id: `wallet:${string}/${string}`;
-            metadata: {
-                name: string;
-                pinned: boolean;
-                hidden: boolean;
-            };
-            value?: {
-                privateKey: string;
-                encoding: "hexadecimal" | "base58" | "base32";
-                type?: string | undefined;
-            } | undefined;
-        }[];
-    })[];
-}, {
-    wallets: import("@metamask/superstruct").Struct<({
-        id: `wallet:${string}`;
-        type: "mnemonic";
-        metadata: {
-            name: string;
-        };
-        groups: {
-            id: `wallet:${string}/${string}`;
-            metadata: {
-                name: string;
-                pinned: boolean;
-                hidden: boolean;
-            };
-            groupIndex: number;
-        }[];
-        value?: string | undefined;
-    } | {
-        id: `wallet:${string}`;
-        type: "private-key";
-        metadata: {
-            name: string;
-        };
-        groups: {
-            id: `wallet:${string}/${string}`;
-            metadata: {
-                name: string;
-                pinned: boolean;
-                hidden: boolean;
-            };
-            value?: {
-                privateKey: string;
-                encoding: "hexadecimal" | "base58" | "base32";
-                type?: string | undefined;
-            } | undefined;
-        }[];
-    })[], import("@metamask/superstruct").Struct<{
-        id: `wallet:${string}`;
-        type: "mnemonic";
-        metadata: {
-            name: string;
-        };
-        groups: {
-            id: `wallet:${string}/${string}`;
-            metadata: {
-                name: string;
-                pinned: boolean;
-                hidden: boolean;
-            };
-            groupIndex: number;
-        }[];
-        value?: string | undefined;
-    } | {
-        id: `wallet:${string}`;
-        type: "private-key";
-        metadata: {
-            name: string;
-        };
-        groups: {
-            id: `wallet:${string}/${string}`;
-            metadata: {
-                name: string;
-                pinned: boolean;
-                hidden: boolean;
-            };
-            value?: {
-                privateKey: string;
-                encoding: "hexadecimal" | "base58" | "base32";
-                type?: string | undefined;
-            } | undefined;
-        }[];
-    }, null>>;
-}>;
-/** Inferred TypeScript type for a value matching {@link AccountTreePayloadStruct}. */
-export type AccountTreePayloadStructType = Infer<typeof AccountTreePayloadStruct>;
-/**
- * Asserts that `value` conforms to the v1 {@link AccountTreePayload} schema.
- *
- * Prefer {@link AccountTreeSnapshot.deserialize} at transport boundaries so
- * validation stays paired with snapshot construction. Use this helper when you
- * already hold a parsed object and need to assert its shape before further
- * processing.
- *
- * @param value - Value to validate.
- * @throws If `value` is not a valid v1 payload, including unsupported wallet types.
- */
-export declare function assertValidAccountTreePayload(value: unknown): asserts value is AccountTreePayload;
-/**
- * Migration chain for {@link AccountTreePayload}.
- *
- * Each `.add()` call appends a step; `migrations.version` equals the number of
- * steps and serves as the canonical current version written by
- * {@link AccountTreeSnapshot.serialize}.
- *
- * **v1** — validates and returns the v1 payload structure `{ wallets: [...] }`.
- */
-export declare const migrations: MigrationChain<AccountTreePayload>;
-/** Current version of the {@link AccountTreePayload} format, derived from the migration chain. */
-export declare const ACCOUNT_TREE_PAYLOAD_CURRENT_VERSION: number;
-/**
- * Validates a raw value as an `AccountTreePayload` and runs any necessary version migrations.
- *
- * This is the low-level entry point used by {@link AccountTreeSnapshot.deserialize}.
- * Callers receiving untrusted wire data should prefer `deserialize`, which returns
- * an immutable {@link AccountTreeSnapshot} ready for filtering and import.
- *
- * @param raw - Unknown value to validate.
- * @returns A fully migrated `AccountTreePayload`.
- * @throws If `raw` is not a valid payload, its version is unsupported, or any wallet type is unrecognized.
- */
-export declare function migrate(raw: unknown): Promise<AccountTreePayload>;
-//# sourceMappingURL=payload.d.cts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"payload.d.cts","sourceRoot":"","sources":["../../src/state/payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAiB5D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAGnD,iFAAiF;AACjF,MAAM,MAAM,sBAAsB,GAAG,UAAU,MAAM,EAAE,CAAC;AAExD,6FAA6F;AAC7F,MAAM,MAAM,qBAAqB,GAAG,UAAU,MAAM,IAAI,MAAM,EAAE,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,0CAA0C;IAC1C,QAAQ,EAAE,sBAAsB,CAAC;IACjC,0GAA0G;IAC1G,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAIF;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,qBAAqB,GAC7B,oBAAoB,CAStB;AAED,mEAAmE;AACnE,MAAM,MAAM,4BAA4B,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5D,iEAAiE;AACjE,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,2EAA2E;AAC3E,MAAM,MAAM,+BAA+B,GAAG;IAC5C,yEAAyE;IACzE,EAAE,EAAE,qBAAqB,CAAC;IAC1B,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,iCAAiC,CAAC;CAC7C,CAAC;AAEF,6EAA6E;AAC7E,MAAM,MAAM,iCAAiC,GAAG;IAC9C,uEAAuE;IACvE,EAAE,EAAE,qBAAqB,CAAC;IAC1B;;;;OAIG;IACH,KAAK,CAAC,EAAE;QACN,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,aAAa,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAC9C;;;;WAIG;QACH,IAAI,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;KAC/B,CAAC;IACF,QAAQ,EAAE,iCAAiC,CAAC;CAC7C,CAAC;AAEF,+EAA+E;AAC/E,MAAM,MAAM,4BAA4B,GAAG;IACzC,EAAE,EAAE,sBAAsB,CAAC;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,4BAA4B,CAAC;IACvC,MAAM,EAAE,+BAA+B,EAAE,CAAC;CAC3C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,EAAE,EAAE,sBAAsB,CAAC;IAC3B,IAAI,EAAE,aAAa,CAAC;IACpB,QAAQ,EAAE,4BAA4B,CAAC;IACvC,MAAM,EAAE,iCAAiC,EAAE,CAAC;CAC7C,CAAC;AAEF,wFAAwF;AACxF,MAAM,MAAM,sBAAsB,GAC9B,4BAA4B,GAC5B,8BAA8B,CAAC;AAEnC,+FAA+F;AAC/F,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,sBAAsB,EAAE,CAAC;CACnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,GAC3D,SAAS,YAAY,CAAC,IAAI,CAAC,EAAE,GAC7B,CAAC,SAAS,MAAM,GACd;IAAE,QAAQ,EAAE,GAAG,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CAAE,GACnD,CAAC,CAAC;AAER;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG,YAAY,CAClD,4BAA4B,GAAG,8BAA8B,CAC9D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG,YAAY,CACjD,+BAA+B,GAAG,iCAAiC,CACpE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,yBAAyB,CAAC;AAEjE;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,eAAe,EAAE,MAAM,GACtB,sBAAsB,CAExB;AAED,qEAAqE;AACrE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,sGAAsG;IACtG,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAkEF;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEnC,CAAC;AAEH,sFAAsF;AACtF,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,wBAAwB,CAChC,CAAC;AAcF;;;;;;;;;;GAUG;AACH,wBAAgB,6BAA6B,CAC3C,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAYrC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,EAAE,cAAc,CAAC,kBAAkB,CAMtD,CAAC;AAEL,kGAAkG;AAClG,eAAO,MAAM,oCAAoC,QAAqB,CAAC;AAEvE;;;;;;;;;;GAUG;AACH,wBAAsB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAGvE"}