@metamask-previews/seedless-onboarding-controller 0.0.0-preview-ddbcf048

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial implementation of the seedless onboarding controller. ([#5671](https://github.com/MetaMask/core/pull/5671))
+  - Authenticate OAuth user using the seedless onboarding flow and determine if the user is already registered or not
+  - Create a new Toprf key and backup seed phrase
+  - Add a new seed phrase backup to the metadata store
+  - Add array of new seed phrase backups to the metadata store in batch (useful in multi-srp flow)
+  - Fetch seed phrase metadata from the metadata store
+  - Update the password of the seedless onboarding flow
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

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

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/seedless-onboarding-controller`
+
+Backup and rehydrate SRP(s) using social login and password
+
+## Installation
+
+`yarn add @metamask/seedless-onboarding-controller`
+
+or
+
+`npm install @metamask/seedless-onboarding-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/SeedPhraseMetadata.cjs

@@ -0,0 +1,146 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SeedPhraseMetadata_seedPhrase, _SeedPhraseMetadata_timestamp;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeedPhraseMetadata = void 0;
+const utils_1 = require("@metamask/utils");
+const constants_1 = require("./constants.cjs");
+/**
+ * SeedPhraseMetadata is a class that adds metadata to the seed phrase.
+ *
+ * It contains the seed phrase and the timestamp when it was created.
+ * It is used to store the seed phrase in the metadata store.
+ *
+ * @example
+ * ```ts
+ * const seedPhraseMetadata = new SeedPhraseMetadata(seedPhrase);
+ * ```
+ */
+class SeedPhraseMetadata {
+    /**
+     * Create a new SeedPhraseMetadata instance.
+     *
+     * @param seedPhrase - The seed phrase to add metadata to.
+     * @param timestamp - The timestamp when the seed phrase was created.
+     */
+    constructor(seedPhrase, timestamp = Date.now()) {
+        _SeedPhraseMetadata_seedPhrase.set(this, void 0);
+        _SeedPhraseMetadata_timestamp.set(this, void 0);
+        __classPrivateFieldSet(this, _SeedPhraseMetadata_seedPhrase, seedPhrase, "f");
+        __classPrivateFieldSet(this, _SeedPhraseMetadata_timestamp, timestamp, "f");
+    }
+    /**
+     * Create an Array of SeedPhraseMetadata instances from an array of seed phrases.
+     *
+     * To respect the order of the seed phrases, we add the index to the timestamp
+     * so that the first seed phrase backup will have the oldest timestamp
+     * and the last seed phrase backup will have the newest timestamp.
+     *
+     * @param seedPhrases - The seed phrases to add metadata to.
+     * @returns The SeedPhraseMetadata instances.
+     */
+    static fromBatchSeedPhrases(seedPhrases) {
+        const timestamp = Date.now();
+        return seedPhrases.map((seedPhrase, index) => {
+            // To respect the order of the seed phrases, we add the index to the timestamp
+            // so that the first seed phrase backup will have the oldest timestamp
+            // and the last seed phrase backup will have the newest timestamp
+            const backupCreatedAt = timestamp + index * 5;
+            return new SeedPhraseMetadata(seedPhrase, backupCreatedAt);
+        });
+    }
+    /**
+     * Assert that the provided value is a valid seed phrase metadata.
+     *
+     * @param value - The value to check.
+     * @throws If the value is not a valid seed phrase metadata.
+     */
+    static assertIsBase64SeedphraseMetadata(value) {
+        if (typeof value !== 'object' ||
+            !value ||
+            !('seedPhrase' in value) ||
+            typeof value.seedPhrase !== 'string' ||
+            !('timestamp' in value) ||
+            typeof value.timestamp !== 'number') {
+            throw new Error(constants_1.SeedlessOnboardingControllerError.InvalidSeedPhraseMetadata);
+        }
+    }
+    /**
+     * Parse the seed phrase metadata from the metadata store and return the array of raw seed phrases.
+     *
+     * This method also sorts the seed phrases by timestamp in descending order, i.e. the newest seed phrase will be the first element in the array.
+     *
+     * @param seedPhraseMetadataArr - The array of SeedPhrase Metadata from the metadata store.
+     * @returns The array of raw seed phrases.
+     */
+    static parseSeedPhraseFromMetadataStore(seedPhraseMetadataArr) {
+        const parsedSeedPhraseMetadata = seedPhraseMetadataArr.map((metadata) => SeedPhraseMetadata.fromRawMetadata(metadata));
+        const seedPhrases = SeedPhraseMetadata.sort(parsedSeedPhraseMetadata);
+        return seedPhrases.map((seedPhraseMetadata) => seedPhraseMetadata.seedPhrase);
+    }
+    /**
+     * Parse and create the SeedPhraseMetadata instance from the raw metadata.
+     *
+     * @param rawMetadata - The raw metadata.
+     * @returns The parsed seed phrase metadata.
+     */
+    static fromRawMetadata(rawMetadata) {
+        const serializedMetadata = (0, utils_1.bytesToString)(rawMetadata);
+        const parsedMetadata = JSON.parse(serializedMetadata);
+        SeedPhraseMetadata.assertIsBase64SeedphraseMetadata(parsedMetadata);
+        const seedPhraseBytes = (0, utils_1.base64ToBytes)(parsedMetadata.seedPhrase);
+        return new SeedPhraseMetadata(seedPhraseBytes, parsedMetadata.timestamp);
+    }
+    /**
+     * Sort the seed phrases by timestamp.
+     *
+     * @param seedPhrases - The seed phrases to sort.
+     * @param order - The order to sort the seed phrases. Default is `desc`.
+     *
+     * @returns The sorted seed phrases.
+     */
+    static sort(seedPhrases, order = 'desc') {
+        return seedPhrases.sort((a, b) => {
+            if (order === 'asc') {
+                return a.timestamp - b.timestamp;
+            }
+            return b.timestamp - a.timestamp;
+        });
+    }
+    get seedPhrase() {
+        return __classPrivateFieldGet(this, _SeedPhraseMetadata_seedPhrase, "f");
+    }
+    get timestamp() {
+        return __classPrivateFieldGet(this, _SeedPhraseMetadata_timestamp, "f");
+    }
+    /**
+     * Serialize the seed phrase metadata and convert it to a Uint8Array.
+     *
+     * @returns The serialized SeedPhraseMetadata value in bytes.
+     */
+    toBytes() {
+        // encode the raw SeedPhrase to base64 encoded string
+        // to create more compacted metadata
+        const b64SeedPhrase = (0, utils_1.bytesToBase64)(__classPrivateFieldGet(this, _SeedPhraseMetadata_seedPhrase, "f"));
+        // serialize the metadata to a JSON string
+        const serializedMetadata = JSON.stringify({
+            seedPhrase: b64SeedPhrase,
+            timestamp: __classPrivateFieldGet(this, _SeedPhraseMetadata_timestamp, "f"),
+        });
+        // convert the serialized metadata to bytes(Uint8Array)
+        return (0, utils_1.stringToBytes)(serializedMetadata);
+    }
+}
+exports.SeedPhraseMetadata = SeedPhraseMetadata;
+_SeedPhraseMetadata_seedPhrase = new WeakMap(), _SeedPhraseMetadata_timestamp = new WeakMap();
+//# sourceMappingURL=SeedPhraseMetadata.cjs.map

package/dist/SeedPhraseMetadata.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SeedPhraseMetadata.cjs","sourceRoot":"","sources":["../src/SeedPhraseMetadata.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAKyB;AAEzB,+CAAgE;AAiBhE;;;;;;;;;;GAUG;AACH,MAAa,kBAAkB;IAK7B;;;;;OAKG;IACH,YAAY,UAAsB,EAAE,YAAoB,IAAI,CAAC,GAAG,EAAE;QAVzD,iDAAwB;QAExB,gDAAmB;QAS1B,uBAAA,IAAI,kCAAe,UAAU,MAAA,CAAC;QAC9B,uBAAA,IAAI,iCAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,CAAC,WAAyB;QACnD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;YAC3C,8EAA8E;YAC9E,sEAAsE;YACtE,iEAAiE;YACjE,MAAM,eAAe,GAAG,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;YAC9C,OAAO,IAAI,kBAAkB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,gCAAgC,CACrC,KAAc;QAEd,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,KAAK;YACN,CAAC,CAAC,YAAY,IAAI,KAAK,CAAC;YACxB,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ;YACpC,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC;YACvB,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EACnC;YACA,MAAM,IAAI,KAAK,CACb,6CAAiC,CAAC,yBAAyB,CAC5D,CAAC;SACH;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,gCAAgC,CACrC,qBAAmC;QAEnC,MAAM,wBAAwB,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACtE,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC,CAC7C,CAAC;QAEF,MAAM,WAAW,GAAG,kBAAkB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAEtE,OAAO,WAAW,CAAC,GAAG,CACpB,CAAC,kBAAkB,EAAE,EAAE,CAAC,kBAAkB,CAAC,UAAU,CACtD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,WAAuB;QAC5C,MAAM,kBAAkB,GAAG,IAAA,qBAAa,EAAC,WAAW,CAAC,CAAC;QACtD,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAEtD,kBAAkB,CAAC,gCAAgC,CAAC,cAAc,CAAC,CAAC;QAEpE,MAAM,eAAe,GAAG,IAAA,qBAAa,EAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACjE,OAAO,IAAI,kBAAkB,CAAC,eAAe,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAiC,EACjC,QAAwB,MAAM;QAE9B,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC/B,IAAI,KAAK,KAAK,KAAK,EAAE;gBACnB,OAAO,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC;aAClC;YACD,OAAO,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,uBAAA,IAAI,sCAAY,CAAC;IAC1B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,uBAAA,IAAI,qCAAW,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,qDAAqD;QACrD,oCAAoC;QACpC,MAAM,aAAa,GAAG,IAAA,qBAAa,EAAC,uBAAA,IAAI,sCAAY,CAAC,CAAC;QAEtD,0CAA0C;QAC1C,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC;YACxC,UAAU,EAAE,aAAa;YACzB,SAAS,EAAE,uBAAA,IAAI,qCAAW;SAC3B,CAAC,CAAC;QAEH,uDAAuD;QACvD,OAAO,IAAA,qBAAa,EAAC,kBAAkB,CAAC,CAAC;IAC3C,CAAC;CACF;AAjJD,gDAiJC","sourcesContent":["import {\n  base64ToBytes,\n  bytesToBase64,\n  stringToBytes,\n  bytesToString,\n} from '@metamask/utils';\n\nimport { SeedlessOnboardingControllerError } from './constants';\n\ntype ISeedPhraseMetadata = {\n  seedPhrase: Uint8Array;\n  timestamp: number;\n  toBytes: () => Uint8Array;\n};\n\n// SeedPhraseMetadata type without the seedPhrase and toBytes methods\n// in which the seedPhrase is base64 encoded for more compacted metadata\ntype IBase64SeedPhraseMetadata = Omit<\n  ISeedPhraseMetadata,\n  'seedPhrase' | 'toBytes'\n> & {\n  seedPhrase: string; // base64 encoded string\n};\n\n/**\n * SeedPhraseMetadata is a class that adds metadata to the seed phrase.\n *\n * It contains the seed phrase and the timestamp when it was created.\n * It is used to store the seed phrase in the metadata store.\n *\n * @example\n * ```ts\n * const seedPhraseMetadata = new SeedPhraseMetadata(seedPhrase);\n * ```\n */\nexport class SeedPhraseMetadata implements ISeedPhraseMetadata {\n  readonly #seedPhrase: Uint8Array;\n\n  readonly #timestamp: number;\n\n  /**\n   * Create a new SeedPhraseMetadata instance.\n   *\n   * @param seedPhrase - The seed phrase to add metadata to.\n   * @param timestamp - The timestamp when the seed phrase was created.\n   */\n  constructor(seedPhrase: Uint8Array, timestamp: number = Date.now()) {\n    this.#seedPhrase = seedPhrase;\n    this.#timestamp = timestamp;\n  }\n\n  /**\n   * Create an Array of SeedPhraseMetadata instances from an array of seed phrases.\n   *\n   * To respect the order of the seed phrases, we add the index to the timestamp\n   * so that the first seed phrase backup will have the oldest timestamp\n   * and the last seed phrase backup will have the newest timestamp.\n   *\n   * @param seedPhrases - The seed phrases to add metadata to.\n   * @returns The SeedPhraseMetadata instances.\n   */\n  static fromBatchSeedPhrases(seedPhrases: Uint8Array[]): SeedPhraseMetadata[] {\n    const timestamp = Date.now();\n    return seedPhrases.map((seedPhrase, index) => {\n      // To respect the order of the seed phrases, we add the index to the timestamp\n      // so that the first seed phrase backup will have the oldest timestamp\n      // and the last seed phrase backup will have the newest timestamp\n      const backupCreatedAt = timestamp + index * 5;\n      return new SeedPhraseMetadata(seedPhrase, backupCreatedAt);\n    });\n  }\n\n  /**\n   * Assert that the provided value is a valid seed phrase metadata.\n   *\n   * @param value - The value to check.\n   * @throws If the value is not a valid seed phrase metadata.\n   */\n  static assertIsBase64SeedphraseMetadata(\n    value: unknown,\n  ): asserts value is IBase64SeedPhraseMetadata {\n    if (\n      typeof value !== 'object' ||\n      !value ||\n      !('seedPhrase' in value) ||\n      typeof value.seedPhrase !== 'string' ||\n      !('timestamp' in value) ||\n      typeof value.timestamp !== 'number'\n    ) {\n      throw new Error(\n        SeedlessOnboardingControllerError.InvalidSeedPhraseMetadata,\n      );\n    }\n  }\n\n  /**\n   * Parse the seed phrase metadata from the metadata store and return the array of raw seed phrases.\n   *\n   * This method also sorts the seed phrases by timestamp in descending order, i.e. the newest seed phrase will be the first element in the array.\n   *\n   * @param seedPhraseMetadataArr - The array of SeedPhrase Metadata from the metadata store.\n   * @returns The array of raw seed phrases.\n   */\n  static parseSeedPhraseFromMetadataStore(\n    seedPhraseMetadataArr: Uint8Array[],\n  ): Uint8Array[] {\n    const parsedSeedPhraseMetadata = seedPhraseMetadataArr.map((metadata) =>\n      SeedPhraseMetadata.fromRawMetadata(metadata),\n    );\n\n    const seedPhrases = SeedPhraseMetadata.sort(parsedSeedPhraseMetadata);\n\n    return seedPhrases.map(\n      (seedPhraseMetadata) => seedPhraseMetadata.seedPhrase,\n    );\n  }\n\n  /**\n   * Parse and create the SeedPhraseMetadata instance from the raw metadata.\n   *\n   * @param rawMetadata - The raw metadata.\n   * @returns The parsed seed phrase metadata.\n   */\n  static fromRawMetadata(rawMetadata: Uint8Array): SeedPhraseMetadata {\n    const serializedMetadata = bytesToString(rawMetadata);\n    const parsedMetadata = JSON.parse(serializedMetadata);\n\n    SeedPhraseMetadata.assertIsBase64SeedphraseMetadata(parsedMetadata);\n\n    const seedPhraseBytes = base64ToBytes(parsedMetadata.seedPhrase);\n    return new SeedPhraseMetadata(seedPhraseBytes, parsedMetadata.timestamp);\n  }\n\n  /**\n   * Sort the seed phrases by timestamp.\n   *\n   * @param seedPhrases - The seed phrases to sort.\n   * @param order - The order to sort the seed phrases. Default is `desc`.\n   *\n   * @returns The sorted seed phrases.\n   */\n  static sort(\n    seedPhrases: SeedPhraseMetadata[],\n    order: 'asc' | 'desc' = 'desc',\n  ): SeedPhraseMetadata[] {\n    return seedPhrases.sort((a, b) => {\n      if (order === 'asc') {\n        return a.timestamp - b.timestamp;\n      }\n      return b.timestamp - a.timestamp;\n    });\n  }\n\n  get seedPhrase() {\n    return this.#seedPhrase;\n  }\n\n  get timestamp() {\n    return this.#timestamp;\n  }\n\n  /**\n   * Serialize the seed phrase metadata and convert it to a Uint8Array.\n   *\n   * @returns The serialized SeedPhraseMetadata value in bytes.\n   */\n  toBytes(): Uint8Array {\n    // encode the raw SeedPhrase to base64 encoded string\n    // to create more compacted metadata\n    const b64SeedPhrase = bytesToBase64(this.#seedPhrase);\n\n    // serialize the metadata to a JSON string\n    const serializedMetadata = JSON.stringify({\n      seedPhrase: b64SeedPhrase,\n      timestamp: this.#timestamp,\n    });\n\n    // convert the serialized metadata to bytes(Uint8Array)\n    return stringToBytes(serializedMetadata);\n  }\n}\n"]}

package/dist/SeedPhraseMetadata.d.cts

@@ -0,0 +1,82 @@
+type ISeedPhraseMetadata = {
+    seedPhrase: Uint8Array;
+    timestamp: number;
+    toBytes: () => Uint8Array;
+};
+type IBase64SeedPhraseMetadata = Omit<ISeedPhraseMetadata, 'seedPhrase' | 'toBytes'> & {
+    seedPhrase: string;
+};
+/**
+ * SeedPhraseMetadata is a class that adds metadata to the seed phrase.
+ *
+ * It contains the seed phrase and the timestamp when it was created.
+ * It is used to store the seed phrase in the metadata store.
+ *
+ * @example
+ * ```ts
+ * const seedPhraseMetadata = new SeedPhraseMetadata(seedPhrase);
+ * ```
+ */
+export declare class SeedPhraseMetadata implements ISeedPhraseMetadata {
+    #private;
+    /**
+     * Create a new SeedPhraseMetadata instance.
+     *
+     * @param seedPhrase - The seed phrase to add metadata to.
+     * @param timestamp - The timestamp when the seed phrase was created.
+     */
+    constructor(seedPhrase: Uint8Array, timestamp?: number);
+    /**
+     * Create an Array of SeedPhraseMetadata instances from an array of seed phrases.
+     *
+     * To respect the order of the seed phrases, we add the index to the timestamp
+     * so that the first seed phrase backup will have the oldest timestamp
+     * and the last seed phrase backup will have the newest timestamp.
+     *
+     * @param seedPhrases - The seed phrases to add metadata to.
+     * @returns The SeedPhraseMetadata instances.
+     */
+    static fromBatchSeedPhrases(seedPhrases: Uint8Array[]): SeedPhraseMetadata[];
+    /**
+     * Assert that the provided value is a valid seed phrase metadata.
+     *
+     * @param value - The value to check.
+     * @throws If the value is not a valid seed phrase metadata.
+     */
+    static assertIsBase64SeedphraseMetadata(value: unknown): asserts value is IBase64SeedPhraseMetadata;
+    /**
+     * Parse the seed phrase metadata from the metadata store and return the array of raw seed phrases.
+     *
+     * This method also sorts the seed phrases by timestamp in descending order, i.e. the newest seed phrase will be the first element in the array.
+     *
+     * @param seedPhraseMetadataArr - The array of SeedPhrase Metadata from the metadata store.
+     * @returns The array of raw seed phrases.
+     */
+    static parseSeedPhraseFromMetadataStore(seedPhraseMetadataArr: Uint8Array[]): Uint8Array[];
+    /**
+     * Parse and create the SeedPhraseMetadata instance from the raw metadata.
+     *
+     * @param rawMetadata - The raw metadata.
+     * @returns The parsed seed phrase metadata.
+     */
+    static fromRawMetadata(rawMetadata: Uint8Array): SeedPhraseMetadata;
+    /**
+     * Sort the seed phrases by timestamp.
+     *
+     * @param seedPhrases - The seed phrases to sort.
+     * @param order - The order to sort the seed phrases. Default is `desc`.
+     *
+     * @returns The sorted seed phrases.
+     */
+    static sort(seedPhrases: SeedPhraseMetadata[], order?: 'asc' | 'desc'): SeedPhraseMetadata[];
+    get seedPhrase(): Uint8Array;
+    get timestamp(): number;
+    /**
+     * Serialize the seed phrase metadata and convert it to a Uint8Array.
+     *
+     * @returns The serialized SeedPhraseMetadata value in bytes.
+     */
+    toBytes(): Uint8Array;
+}
+export {};
+//# sourceMappingURL=SeedPhraseMetadata.d.cts.map

package/dist/SeedPhraseMetadata.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SeedPhraseMetadata.d.cts","sourceRoot":"","sources":["../src/SeedPhraseMetadata.ts"],"names":[],"mappings":"AASA,KAAK,mBAAmB,GAAG;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,UAAU,CAAC;CAC3B,CAAC;AAIF,KAAK,yBAAyB,GAAG,IAAI,CACnC,mBAAmB,EACnB,YAAY,GAAG,SAAS,CACzB,GAAG;IACF,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,kBAAmB,YAAW,mBAAmB;;IAK5D;;;;;OAKG;gBACS,UAAU,EAAE,UAAU,EAAE,SAAS,GAAE,MAAmB;IAKlE;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,kBAAkB,EAAE;IAW5E;;;;;OAKG;IACH,MAAM,CAAC,gCAAgC,CACrC,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,yBAAyB;IAe7C;;;;;;;OAOG;IACH,MAAM,CAAC,gCAAgC,CACrC,qBAAqB,EAAE,UAAU,EAAE,GAClC,UAAU,EAAE;IAYf;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,UAAU,GAAG,kBAAkB;IAUnE;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAW,EAAE,kBAAkB,EAAE,EACjC,KAAK,GAAE,KAAK,GAAG,MAAe,GAC7B,kBAAkB,EAAE;IASvB,IAAI,UAAU,eAEb;IAED,IAAI,SAAS,WAEZ;IAED;;;;OAIG;IACH,OAAO,IAAI,UAAU;CActB"}

package/dist/SeedPhraseMetadata.d.mts

@@ -0,0 +1,82 @@
+type ISeedPhraseMetadata = {
+    seedPhrase: Uint8Array;
+    timestamp: number;
+    toBytes: () => Uint8Array;
+};
+type IBase64SeedPhraseMetadata = Omit<ISeedPhraseMetadata, 'seedPhrase' | 'toBytes'> & {
+    seedPhrase: string;
+};
+/**
+ * SeedPhraseMetadata is a class that adds metadata to the seed phrase.
+ *
+ * It contains the seed phrase and the timestamp when it was created.
+ * It is used to store the seed phrase in the metadata store.
+ *
+ * @example
+ * ```ts
+ * const seedPhraseMetadata = new SeedPhraseMetadata(seedPhrase);
+ * ```
+ */
+export declare class SeedPhraseMetadata implements ISeedPhraseMetadata {
+    #private;
+    /**
+     * Create a new SeedPhraseMetadata instance.
+     *
+     * @param seedPhrase - The seed phrase to add metadata to.
+     * @param timestamp - The timestamp when the seed phrase was created.
+     */
+    constructor(seedPhrase: Uint8Array, timestamp?: number);
+    /**
+     * Create an Array of SeedPhraseMetadata instances from an array of seed phrases.
+     *
+     * To respect the order of the seed phrases, we add the index to the timestamp
+     * so that the first seed phrase backup will have the oldest timestamp
+     * and the last seed phrase backup will have the newest timestamp.
+     *
+     * @param seedPhrases - The seed phrases to add metadata to.
+     * @returns The SeedPhraseMetadata instances.
+     */
+    static fromBatchSeedPhrases(seedPhrases: Uint8Array[]): SeedPhraseMetadata[];
+    /**
+     * Assert that the provided value is a valid seed phrase metadata.
+     *
+     * @param value - The value to check.
+     * @throws If the value is not a valid seed phrase metadata.
+     */
+    static assertIsBase64SeedphraseMetadata(value: unknown): asserts value is IBase64SeedPhraseMetadata;
+    /**
+     * Parse the seed phrase metadata from the metadata store and return the array of raw seed phrases.
+     *
+     * This method also sorts the seed phrases by timestamp in descending order, i.e. the newest seed phrase will be the first element in the array.
+     *
+     * @param seedPhraseMetadataArr - The array of SeedPhrase Metadata from the metadata store.
+     * @returns The array of raw seed phrases.
+     */
+    static parseSeedPhraseFromMetadataStore(seedPhraseMetadataArr: Uint8Array[]): Uint8Array[];
+    /**
+     * Parse and create the SeedPhraseMetadata instance from the raw metadata.
+     *
+     * @param rawMetadata - The raw metadata.
+     * @returns The parsed seed phrase metadata.
+     */
+    static fromRawMetadata(rawMetadata: Uint8Array): SeedPhraseMetadata;
+    /**
+     * Sort the seed phrases by timestamp.
+     *
+     * @param seedPhrases - The seed phrases to sort.
+     * @param order - The order to sort the seed phrases. Default is `desc`.
+     *
+     * @returns The sorted seed phrases.
+     */
+    static sort(seedPhrases: SeedPhraseMetadata[], order?: 'asc' | 'desc'): SeedPhraseMetadata[];
+    get seedPhrase(): Uint8Array;
+    get timestamp(): number;
+    /**
+     * Serialize the seed phrase metadata and convert it to a Uint8Array.
+     *
+     * @returns The serialized SeedPhraseMetadata value in bytes.
+     */
+    toBytes(): Uint8Array;
+}
+export {};
+//# sourceMappingURL=SeedPhraseMetadata.d.mts.map

package/dist/SeedPhraseMetadata.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SeedPhraseMetadata.d.mts","sourceRoot":"","sources":["../src/SeedPhraseMetadata.ts"],"names":[],"mappings":"AASA,KAAK,mBAAmB,GAAG;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,UAAU,CAAC;CAC3B,CAAC;AAIF,KAAK,yBAAyB,GAAG,IAAI,CACnC,mBAAmB,EACnB,YAAY,GAAG,SAAS,CACzB,GAAG;IACF,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,kBAAmB,YAAW,mBAAmB;;IAK5D;;;;;OAKG;gBACS,UAAU,EAAE,UAAU,EAAE,SAAS,GAAE,MAAmB;IAKlE;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,kBAAkB,EAAE;IAW5E;;;;;OAKG;IACH,MAAM,CAAC,gCAAgC,CACrC,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,yBAAyB;IAe7C;;;;;;;OAOG;IACH,MAAM,CAAC,gCAAgC,CACrC,qBAAqB,EAAE,UAAU,EAAE,GAClC,UAAU,EAAE;IAYf;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,UAAU,GAAG,kBAAkB;IAUnE;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAW,EAAE,kBAAkB,EAAE,EACjC,KAAK,GAAE,KAAK,GAAG,MAAe,GAC7B,kBAAkB,EAAE;IASvB,IAAI,UAAU,eAEb;IAED,IAAI,SAAS,WAEZ;IAED;;;;OAIG;IACH,OAAO,IAAI,UAAU;CActB"}

package/dist/SeedPhraseMetadata.mjs

@@ -0,0 +1,142 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SeedPhraseMetadata_seedPhrase, _SeedPhraseMetadata_timestamp;
+import { base64ToBytes, bytesToBase64, stringToBytes, bytesToString } from "@metamask/utils";
+import { SeedlessOnboardingControllerError } from "./constants.mjs";
+/**
+ * SeedPhraseMetadata is a class that adds metadata to the seed phrase.
+ *
+ * It contains the seed phrase and the timestamp when it was created.
+ * It is used to store the seed phrase in the metadata store.
+ *
+ * @example
+ * ```ts
+ * const seedPhraseMetadata = new SeedPhraseMetadata(seedPhrase);
+ * ```
+ */
+export class SeedPhraseMetadata {
+    /**
+     * Create a new SeedPhraseMetadata instance.
+     *
+     * @param seedPhrase - The seed phrase to add metadata to.
+     * @param timestamp - The timestamp when the seed phrase was created.
+     */
+    constructor(seedPhrase, timestamp = Date.now()) {
+        _SeedPhraseMetadata_seedPhrase.set(this, void 0);
+        _SeedPhraseMetadata_timestamp.set(this, void 0);
+        __classPrivateFieldSet(this, _SeedPhraseMetadata_seedPhrase, seedPhrase, "f");
+        __classPrivateFieldSet(this, _SeedPhraseMetadata_timestamp, timestamp, "f");
+    }
+    /**
+     * Create an Array of SeedPhraseMetadata instances from an array of seed phrases.
+     *
+     * To respect the order of the seed phrases, we add the index to the timestamp
+     * so that the first seed phrase backup will have the oldest timestamp
+     * and the last seed phrase backup will have the newest timestamp.
+     *
+     * @param seedPhrases - The seed phrases to add metadata to.
+     * @returns The SeedPhraseMetadata instances.
+     */
+    static fromBatchSeedPhrases(seedPhrases) {
+        const timestamp = Date.now();
+        return seedPhrases.map((seedPhrase, index) => {
+            // To respect the order of the seed phrases, we add the index to the timestamp
+            // so that the first seed phrase backup will have the oldest timestamp
+            // and the last seed phrase backup will have the newest timestamp
+            const backupCreatedAt = timestamp + index * 5;
+            return new SeedPhraseMetadata(seedPhrase, backupCreatedAt);
+        });
+    }
+    /**
+     * Assert that the provided value is a valid seed phrase metadata.
+     *
+     * @param value - The value to check.
+     * @throws If the value is not a valid seed phrase metadata.
+     */
+    static assertIsBase64SeedphraseMetadata(value) {
+        if (typeof value !== 'object' ||
+            !value ||
+            !('seedPhrase' in value) ||
+            typeof value.seedPhrase !== 'string' ||
+            !('timestamp' in value) ||
+            typeof value.timestamp !== 'number') {
+            throw new Error(SeedlessOnboardingControllerError.InvalidSeedPhraseMetadata);
+        }
+    }
+    /**
+     * Parse the seed phrase metadata from the metadata store and return the array of raw seed phrases.
+     *
+     * This method also sorts the seed phrases by timestamp in descending order, i.e. the newest seed phrase will be the first element in the array.
+     *
+     * @param seedPhraseMetadataArr - The array of SeedPhrase Metadata from the metadata store.
+     * @returns The array of raw seed phrases.
+     */
+    static parseSeedPhraseFromMetadataStore(seedPhraseMetadataArr) {
+        const parsedSeedPhraseMetadata = seedPhraseMetadataArr.map((metadata) => SeedPhraseMetadata.fromRawMetadata(metadata));
+        const seedPhrases = SeedPhraseMetadata.sort(parsedSeedPhraseMetadata);
+        return seedPhrases.map((seedPhraseMetadata) => seedPhraseMetadata.seedPhrase);
+    }
+    /**
+     * Parse and create the SeedPhraseMetadata instance from the raw metadata.
+     *
+     * @param rawMetadata - The raw metadata.
+     * @returns The parsed seed phrase metadata.
+     */
+    static fromRawMetadata(rawMetadata) {
+        const serializedMetadata = bytesToString(rawMetadata);
+        const parsedMetadata = JSON.parse(serializedMetadata);
+        SeedPhraseMetadata.assertIsBase64SeedphraseMetadata(parsedMetadata);
+        const seedPhraseBytes = base64ToBytes(parsedMetadata.seedPhrase);
+        return new SeedPhraseMetadata(seedPhraseBytes, parsedMetadata.timestamp);
+    }
+    /**
+     * Sort the seed phrases by timestamp.
+     *
+     * @param seedPhrases - The seed phrases to sort.
+     * @param order - The order to sort the seed phrases. Default is `desc`.
+     *
+     * @returns The sorted seed phrases.
+     */
+    static sort(seedPhrases, order = 'desc') {
+        return seedPhrases.sort((a, b) => {
+            if (order === 'asc') {
+                return a.timestamp - b.timestamp;
+            }
+            return b.timestamp - a.timestamp;
+        });
+    }
+    get seedPhrase() {
+        return __classPrivateFieldGet(this, _SeedPhraseMetadata_seedPhrase, "f");
+    }
+    get timestamp() {
+        return __classPrivateFieldGet(this, _SeedPhraseMetadata_timestamp, "f");
+    }
+    /**
+     * Serialize the seed phrase metadata and convert it to a Uint8Array.
+     *
+     * @returns The serialized SeedPhraseMetadata value in bytes.
+     */
+    toBytes() {
+        // encode the raw SeedPhrase to base64 encoded string
+        // to create more compacted metadata
+        const b64SeedPhrase = bytesToBase64(__classPrivateFieldGet(this, _SeedPhraseMetadata_seedPhrase, "f"));
+        // serialize the metadata to a JSON string
+        const serializedMetadata = JSON.stringify({
+            seedPhrase: b64SeedPhrase,
+            timestamp: __classPrivateFieldGet(this, _SeedPhraseMetadata_timestamp, "f"),
+        });
+        // convert the serialized metadata to bytes(Uint8Array)
+        return stringToBytes(serializedMetadata);
+    }
+}
+_SeedPhraseMetadata_seedPhrase = new WeakMap(), _SeedPhraseMetadata_timestamp = new WeakMap();
+//# sourceMappingURL=SeedPhraseMetadata.mjs.map

package/dist/SeedPhraseMetadata.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SeedPhraseMetadata.mjs","sourceRoot":"","sources":["../src/SeedPhraseMetadata.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,aAAa,EACb,aAAa,EACb,aAAa,EACb,aAAa,EACd,wBAAwB;AAEzB,OAAO,EAAE,iCAAiC,EAAE,wBAAoB;AAiBhE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,kBAAkB;IAK7B;;;;;OAKG;IACH,YAAY,UAAsB,EAAE,YAAoB,IAAI,CAAC,GAAG,EAAE;QAVzD,iDAAwB;QAExB,gDAAmB;QAS1B,uBAAA,IAAI,kCAAe,UAAU,MAAA,CAAC;QAC9B,uBAAA,IAAI,iCAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,CAAC,WAAyB;QACnD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;YAC3C,8EAA8E;YAC9E,sEAAsE;YACtE,iEAAiE;YACjE,MAAM,eAAe,GAAG,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;YAC9C,OAAO,IAAI,kBAAkB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,gCAAgC,CACrC,KAAc;QAEd,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,KAAK;YACN,CAAC,CAAC,YAAY,IAAI,KAAK,CAAC;YACxB,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ;YACpC,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC;YACvB,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EACnC;YACA,MAAM,IAAI,KAAK,CACb,iCAAiC,CAAC,yBAAyB,CAC5D,CAAC;SACH;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,gCAAgC,CACrC,qBAAmC;QAEnC,MAAM,wBAAwB,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACtE,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC,CAC7C,CAAC;QAEF,MAAM,WAAW,GAAG,kBAAkB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAEtE,OAAO,WAAW,CAAC,GAAG,CACpB,CAAC,kBAAkB,EAAE,EAAE,CAAC,kBAAkB,CAAC,UAAU,CACtD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,WAAuB;QAC5C,MAAM,kBAAkB,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAEtD,kBAAkB,CAAC,gCAAgC,CAAC,cAAc,CAAC,CAAC;QAEpE,MAAM,eAAe,GAAG,aAAa,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACjE,OAAO,IAAI,kBAAkB,CAAC,eAAe,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,WAAiC,EACjC,QAAwB,MAAM;QAE9B,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC/B,IAAI,KAAK,KAAK,KAAK,EAAE;gBACnB,OAAO,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC;aAClC;YACD,OAAO,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,uBAAA,IAAI,sCAAY,CAAC;IAC1B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,uBAAA,IAAI,qCAAW,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,qDAAqD;QACrD,oCAAoC;QACpC,MAAM,aAAa,GAAG,aAAa,CAAC,uBAAA,IAAI,sCAAY,CAAC,CAAC;QAEtD,0CAA0C;QAC1C,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC;YACxC,UAAU,EAAE,aAAa;YACzB,SAAS,EAAE,uBAAA,IAAI,qCAAW;SAC3B,CAAC,CAAC;QAEH,uDAAuD;QACvD,OAAO,aAAa,CAAC,kBAAkB,CAAC,CAAC;IAC3C,CAAC;CACF","sourcesContent":["import {\n  base64ToBytes,\n  bytesToBase64,\n  stringToBytes,\n  bytesToString,\n} from '@metamask/utils';\n\nimport { SeedlessOnboardingControllerError } from './constants';\n\ntype ISeedPhraseMetadata = {\n  seedPhrase: Uint8Array;\n  timestamp: number;\n  toBytes: () => Uint8Array;\n};\n\n// SeedPhraseMetadata type without the seedPhrase and toBytes methods\n// in which the seedPhrase is base64 encoded for more compacted metadata\ntype IBase64SeedPhraseMetadata = Omit<\n  ISeedPhraseMetadata,\n  'seedPhrase' | 'toBytes'\n> & {\n  seedPhrase: string; // base64 encoded string\n};\n\n/**\n * SeedPhraseMetadata is a class that adds metadata to the seed phrase.\n *\n * It contains the seed phrase and the timestamp when it was created.\n * It is used to store the seed phrase in the metadata store.\n *\n * @example\n * ```ts\n * const seedPhraseMetadata = new SeedPhraseMetadata(seedPhrase);\n * ```\n */\nexport class SeedPhraseMetadata implements ISeedPhraseMetadata {\n  readonly #seedPhrase: Uint8Array;\n\n  readonly #timestamp: number;\n\n  /**\n   * Create a new SeedPhraseMetadata instance.\n   *\n   * @param seedPhrase - The seed phrase to add metadata to.\n   * @param timestamp - The timestamp when the seed phrase was created.\n   */\n  constructor(seedPhrase: Uint8Array, timestamp: number = Date.now()) {\n    this.#seedPhrase = seedPhrase;\n    this.#timestamp = timestamp;\n  }\n\n  /**\n   * Create an Array of SeedPhraseMetadata instances from an array of seed phrases.\n   *\n   * To respect the order of the seed phrases, we add the index to the timestamp\n   * so that the first seed phrase backup will have the oldest timestamp\n   * and the last seed phrase backup will have the newest timestamp.\n   *\n   * @param seedPhrases - The seed phrases to add metadata to.\n   * @returns The SeedPhraseMetadata instances.\n   */\n  static fromBatchSeedPhrases(seedPhrases: Uint8Array[]): SeedPhraseMetadata[] {\n    const timestamp = Date.now();\n    return seedPhrases.map((seedPhrase, index) => {\n      // To respect the order of the seed phrases, we add the index to the timestamp\n      // so that the first seed phrase backup will have the oldest timestamp\n      // and the last seed phrase backup will have the newest timestamp\n      const backupCreatedAt = timestamp + index * 5;\n      return new SeedPhraseMetadata(seedPhrase, backupCreatedAt);\n    });\n  }\n\n  /**\n   * Assert that the provided value is a valid seed phrase metadata.\n   *\n   * @param value - The value to check.\n   * @throws If the value is not a valid seed phrase metadata.\n   */\n  static assertIsBase64SeedphraseMetadata(\n    value: unknown,\n  ): asserts value is IBase64SeedPhraseMetadata {\n    if (\n      typeof value !== 'object' ||\n      !value ||\n      !('seedPhrase' in value) ||\n      typeof value.seedPhrase !== 'string' ||\n      !('timestamp' in value) ||\n      typeof value.timestamp !== 'number'\n    ) {\n      throw new Error(\n        SeedlessOnboardingControllerError.InvalidSeedPhraseMetadata,\n      );\n    }\n  }\n\n  /**\n   * Parse the seed phrase metadata from the metadata store and return the array of raw seed phrases.\n   *\n   * This method also sorts the seed phrases by timestamp in descending order, i.e. the newest seed phrase will be the first element in the array.\n   *\n   * @param seedPhraseMetadataArr - The array of SeedPhrase Metadata from the metadata store.\n   * @returns The array of raw seed phrases.\n   */\n  static parseSeedPhraseFromMetadataStore(\n    seedPhraseMetadataArr: Uint8Array[],\n  ): Uint8Array[] {\n    const parsedSeedPhraseMetadata = seedPhraseMetadataArr.map((metadata) =>\n      SeedPhraseMetadata.fromRawMetadata(metadata),\n    );\n\n    const seedPhrases = SeedPhraseMetadata.sort(parsedSeedPhraseMetadata);\n\n    return seedPhrases.map(\n      (seedPhraseMetadata) => seedPhraseMetadata.seedPhrase,\n    );\n  }\n\n  /**\n   * Parse and create the SeedPhraseMetadata instance from the raw metadata.\n   *\n   * @param rawMetadata - The raw metadata.\n   * @returns The parsed seed phrase metadata.\n   */\n  static fromRawMetadata(rawMetadata: Uint8Array): SeedPhraseMetadata {\n    const serializedMetadata = bytesToString(rawMetadata);\n    const parsedMetadata = JSON.parse(serializedMetadata);\n\n    SeedPhraseMetadata.assertIsBase64SeedphraseMetadata(parsedMetadata);\n\n    const seedPhraseBytes = base64ToBytes(parsedMetadata.seedPhrase);\n    return new SeedPhraseMetadata(seedPhraseBytes, parsedMetadata.timestamp);\n  }\n\n  /**\n   * Sort the seed phrases by timestamp.\n   *\n   * @param seedPhrases - The seed phrases to sort.\n   * @param order - The order to sort the seed phrases. Default is `desc`.\n   *\n   * @returns The sorted seed phrases.\n   */\n  static sort(\n    seedPhrases: SeedPhraseMetadata[],\n    order: 'asc' | 'desc' = 'desc',\n  ): SeedPhraseMetadata[] {\n    return seedPhrases.sort((a, b) => {\n      if (order === 'asc') {\n        return a.timestamp - b.timestamp;\n      }\n      return b.timestamp - a.timestamp;\n    });\n  }\n\n  get seedPhrase() {\n    return this.#seedPhrase;\n  }\n\n  get timestamp() {\n    return this.#timestamp;\n  }\n\n  /**\n   * Serialize the seed phrase metadata and convert it to a Uint8Array.\n   *\n   * @returns The serialized SeedPhraseMetadata value in bytes.\n   */\n  toBytes(): Uint8Array {\n    // encode the raw SeedPhrase to base64 encoded string\n    // to create more compacted metadata\n    const b64SeedPhrase = bytesToBase64(this.#seedPhrase);\n\n    // serialize the metadata to a JSON string\n    const serializedMetadata = JSON.stringify({\n      seedPhrase: b64SeedPhrase,\n      timestamp: this.#timestamp,\n    });\n\n    // convert the serialized metadata to bytes(Uint8Array)\n    return stringToBytes(serializedMetadata);\n  }\n}\n"]}