@metamask-previews/seedless-onboarding-controller 0.0.0-preview-8a04e037 → 0.0.0-preview-c4b7ea2e

package/CHANGELOG.md

@@ -9,12 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Initial implementation of the seedless onboarding controller. ([#5671](https://github.com/MetaMask/core/pull/5671))
+- Initial implementation of the seedless onboarding controller. ([#5874](https://github.com/MetaMask/core/pull/5874))
   - 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
+- Support multi SRP sync using social login. ([#5875](https://github.com/MetaMask/core/pull/5875))
+  - Update Metadata to support multiple types of secrets (SRP, PrivateKey).
+  - Add `Controller Lock` which will sync with `Keyring Lock`.
+  - Updated `VaultEncryptor` type in constructor args and is compulsory to provided relevant encryptor to constructor.
+  - Added new non-persisted states, `encryptionKey` and `encryptionSalt` to decrypt the vault when password is not available.
+  - Update `password` param in `fetchAllSeedPhrases` method to optional. If password is not provided, `cached EncryptionKey` will be used.
 
 [Unreleased]: https://github.com/MetaMask/core/

package/dist/SecretMetadata.cjs

@@ -0,0 +1,185 @@
+"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 _SecretMetadata_data, _SecretMetadata_timestamp, _SecretMetadata_type, _SecretMetadata_version;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecretMetadata = void 0;
+const utils_1 = require("@metamask/utils");
+const constants_1 = require("./constants.cjs");
+/**
+ * SecretMetadata is a class that adds metadata to the secret.
+ *
+ * It contains the secret and the timestamp when it was created.
+ * It is used to store the secret in the metadata store.
+ *
+ * @example
+ * ```ts
+ * const secretMetadata = new SecretMetadata(secret);
+ * ```
+ */
+class SecretMetadata {
+    /**
+     * Create a new SecretMetadata instance.
+     *
+     * @param data - The secret to add metadata to.
+     * @param options - The options for the secret metadata.
+     * @param options.timestamp - The timestamp when the secret was created.
+     * @param options.type - The type of the secret.
+     */
+    constructor(data, options) {
+        _SecretMetadata_data.set(this, void 0);
+        _SecretMetadata_timestamp.set(this, void 0);
+        _SecretMetadata_type.set(this, void 0);
+        _SecretMetadata_version.set(this, void 0);
+        __classPrivateFieldSet(this, _SecretMetadata_data, data, "f");
+        __classPrivateFieldSet(this, _SecretMetadata_timestamp, options?.timestamp ?? Date.now(), "f");
+        __classPrivateFieldSet(this, _SecretMetadata_type, options?.type ?? constants_1.SecretType.Mnemonic, "f");
+        __classPrivateFieldSet(this, _SecretMetadata_version, options?.version ?? constants_1.SecretMetadataVersion.V1, "f");
+    }
+    /**
+     * Create an Array of SecretMetadata instances from an array of secrets.
+     *
+     * To respect the order of the secrets, we add the index to the timestamp
+     * so that the first secret backup will have the oldest timestamp
+     * and the last secret backup will have the newest timestamp.
+     *
+     * @param data - The data to add metadata to.
+     * @param data.value - The SeedPhrase/PrivateKey to add metadata to.
+     * @param data.options - The options for the seed phrase metadata.
+     * @returns The SecretMetadata instances.
+     */
+    static fromBatch(data) {
+        const timestamp = Date.now();
+        return data.map((d, 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 = d.options?.timestamp ?? timestamp + index * 5;
+            return new SecretMetadata(d.value, {
+                timestamp: backupCreatedAt,
+                type: d.options?.type,
+            });
+        });
+    }
+    /**
+     * 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 assertIsValidSecretMetadataJson(value) {
+        if (typeof value !== 'object' ||
+            !value ||
+            !('data' in value) ||
+            typeof value.data !== 'string' ||
+            !('timestamp' in value) ||
+            typeof value.timestamp !== 'number') {
+            throw new Error(constants_1.SeedlessOnboardingControllerErrorMessage.InvalidSecretMetadata);
+        }
+    }
+    /**
+     * Parse the SecretMetadata from the metadata store and return the array of SecretMetadata instances.
+     *
+     * This method also sorts the secrets by timestamp in ascending order, i.e. the oldest secret will be the first element in the array.
+     *
+     * @param secretMetadataArr - The array of SecretMetadata from the metadata store.
+     * @param filterType - The type of the secret to filter.
+     * @returns The array of SecretMetadata instances.
+     */
+    static parseSecretsFromMetadataStore(secretMetadataArr, filterType) {
+        const parsedSecertMetadata = secretMetadataArr.map((metadata) => SecretMetadata.fromRawMetadata(metadata));
+        const secrets = SecretMetadata.sort(parsedSecertMetadata);
+        if (filterType) {
+            return secrets.filter((secret) => secret.type === filterType);
+        }
+        return secrets;
+    }
+    /**
+     * Parse and create the SecretMetadata instance from the raw metadata bytes.
+     *
+     * @param rawMetadata - The raw metadata.
+     * @returns The parsed secret metadata.
+     */
+    static fromRawMetadata(rawMetadata) {
+        const serializedMetadata = (0, utils_1.bytesToString)(rawMetadata);
+        const parsedMetadata = JSON.parse(serializedMetadata);
+        SecretMetadata.assertIsValidSecretMetadataJson(parsedMetadata);
+        // if the type is not provided, we default to Mnemonic for the backwards compatibility
+        const type = parsedMetadata.type ?? constants_1.SecretType.Mnemonic;
+        const version = parsedMetadata.version ?? constants_1.SecretMetadataVersion.V1;
+        let data;
+        try {
+            data = (0, utils_1.base64ToBytes)(parsedMetadata.data);
+        }
+        catch {
+            data = parsedMetadata.data;
+        }
+        return new SecretMetadata(data, {
+            timestamp: parsedMetadata.timestamp,
+            type,
+            version,
+        });
+    }
+    /**
+     * Sort the seed phrases by timestamp.
+     *
+     * @param data - The secret metadata array to sort.
+     * @param order - The order to sort the seed phrases. Default is `desc`.
+     *
+     * @returns The sorted secret metadata array.
+     */
+    static sort(data, order = 'asc') {
+        return data.sort((a, b) => {
+            if (order === 'asc') {
+                return a.timestamp - b.timestamp;
+            }
+            return b.timestamp - a.timestamp;
+        });
+    }
+    get data() {
+        return __classPrivateFieldGet(this, _SecretMetadata_data, "f");
+    }
+    get timestamp() {
+        return __classPrivateFieldGet(this, _SecretMetadata_timestamp, "f");
+    }
+    get type() {
+        return __classPrivateFieldGet(this, _SecretMetadata_type, "f");
+    }
+    get version() {
+        return __classPrivateFieldGet(this, _SecretMetadata_version, "f");
+    }
+    /**
+     * Serialize the secret metadata and convert it to a Uint8Array.
+     *
+     * @returns The serialized SecretMetadata value in bytes.
+     */
+    toBytes() {
+        let _data = __classPrivateFieldGet(this, _SecretMetadata_data, "f");
+        if (__classPrivateFieldGet(this, _SecretMetadata_data, "f") instanceof Uint8Array) {
+            // encode the raw secret to base64 encoded string
+            // to create more compacted metadata
+            _data = (0, utils_1.bytesToBase64)(__classPrivateFieldGet(this, _SecretMetadata_data, "f"));
+        }
+        // serialize the metadata to a JSON string
+        const serializedMetadata = JSON.stringify({
+            data: _data,
+            timestamp: __classPrivateFieldGet(this, _SecretMetadata_timestamp, "f"),
+            type: __classPrivateFieldGet(this, _SecretMetadata_type, "f"),
+            version: __classPrivateFieldGet(this, _SecretMetadata_version, "f"),
+        });
+        // convert the serialized metadata to bytes(Uint8Array)
+        return (0, utils_1.stringToBytes)(serializedMetadata);
+    }
+}
+exports.SecretMetadata = SecretMetadata;
+_SecretMetadata_data = new WeakMap(), _SecretMetadata_timestamp = new WeakMap(), _SecretMetadata_type = new WeakMap(), _SecretMetadata_version = new WeakMap();
+//# sourceMappingURL=SecretMetadata.cjs.map

package/dist/SecretMetadata.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecretMetadata.cjs","sourceRoot":"","sources":["../src/SecretMetadata.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAKyB;AAEzB,+CAIqB;AAuBrB;;;;;;;;;;GAUG;AACH,MAAa,cAAc;IAWzB;;;;;;;OAOG;IACH,YAAY,IAAc,EAAE,OAAwC;QAhB3D,uCAAgB;QAEhB,4CAAmB;QAEnB,uCAAkB;QAElB,0CAAgC;QAWvC,uBAAA,IAAI,wBAAS,IAAI,MAAA,CAAC;QAClB,uBAAA,IAAI,6BAAc,OAAO,EAAE,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,MAAA,CAAC;QACnD,uBAAA,IAAI,wBAAS,OAAO,EAAE,IAAI,IAAI,sBAAU,CAAC,QAAQ,MAAA,CAAC;QAClD,uBAAA,IAAI,2BAAY,OAAO,EAAE,OAAO,IAAI,iCAAqB,CAAC,EAAE,MAAA,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,CACd,IAGG;QAEH,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;YAC3B,8EAA8E;YAC9E,sEAAsE;YACtE,iEAAiE;YACjE,MAAM,eAAe,GAAG,CAAC,CAAC,OAAO,EAAE,SAAS,IAAI,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;YACtE,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,EAAE;gBACjC,SAAS,EAAE,eAAe;gBAC1B,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,IAAI;aACtB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,+BAA+B,CAEpC,KAAc;QACd,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,KAAK;YACN,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC;YAClB,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;YAC9B,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC;YACvB,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EACnC;YACA,MAAM,IAAI,KAAK,CACb,oDAAwC,CAAC,qBAAqB,CAC/D,CAAC;SACH;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,6BAA6B,CAGlC,iBAA+B,EAC/B,UAAuB;QAEvB,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC9D,cAAc,CAAC,eAAe,CAAW,QAAQ,CAAC,CACnD,CAAC;QAEF,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE1D,IAAI,UAAU,EAAE;YACd,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;SAC/D;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CACpB,WAAuB;QAEvB,MAAM,kBAAkB,GAAG,IAAA,qBAAa,EAAC,WAAW,CAAC,CAAC;QACtD,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAEtD,cAAc,CAAC,+BAA+B,CAAW,cAAc,CAAC,CAAC;QAEzE,sFAAsF;QACtF,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,IAAI,sBAAU,CAAC,QAAQ,CAAC;QACxD,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,IAAI,iCAAqB,CAAC,EAAE,CAAC;QAEnE,IAAI,IAAc,CAAC;QACnB,IAAI;YACF,IAAI,GAAG,IAAA,qBAAa,EAAC,cAAc,CAAC,IAAI,CAAa,CAAC;SACvD;QAAC,MAAM;YACN,IAAI,GAAG,cAAc,CAAC,IAAgB,CAAC;SACxC;QAED,OAAO,IAAI,cAAc,CAAW,IAAI,EAAE;YACxC,SAAS,EAAE,cAAc,CAAC,SAAS;YACnC,IAAI;YACJ,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,IAAgC,EAChC,QAAwB,KAAK;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACxB,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,IAAI;QACN,OAAO,uBAAA,IAAI,4BAAM,CAAC;IACpB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,uBAAA,IAAI,iCAAW,CAAC;IACzB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,4BAAM,CAAC;IACpB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,+BAAS,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,IAAI,KAAK,GAAY,uBAAA,IAAI,4BAAM,CAAC;QAChC,IAAI,uBAAA,IAAI,4BAAM,YAAY,UAAU,EAAE;YACpC,iDAAiD;YACjD,oCAAoC;YACpC,KAAK,GAAG,IAAA,qBAAa,EAAC,uBAAA,IAAI,4BAAM,CAAC,CAAC;SACnC;QAED,0CAA0C;QAC1C,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC;YACxC,IAAI,EAAE,KAAK;YACX,SAAS,EAAE,uBAAA,IAAI,iCAAW;YAC1B,IAAI,EAAE,uBAAA,IAAI,4BAAM;YAChB,OAAO,EAAE,uBAAA,IAAI,+BAAS;SACvB,CAAC,CAAC;QAEH,uDAAuD;QACvD,OAAO,IAAA,qBAAa,EAAC,kBAAkB,CAAC,CAAC;IAC3C,CAAC;CACF;AAxMD,wCAwMC","sourcesContent":["import {\n  base64ToBytes,\n  bytesToBase64,\n  stringToBytes,\n  bytesToString,\n} from '@metamask/utils';\n\nimport {\n  SeedlessOnboardingControllerErrorMessage,\n  SecretType,\n  SecretMetadataVersion,\n} from './constants';\nimport type { SecretDataType, SecretMetadataOptions } from './types';\n\ntype ISecretMetadata<DataType extends SecretDataType = Uint8Array> = {\n  data: DataType;\n  timestamp: number;\n  type: SecretType;\n  version: SecretMetadataVersion;\n  toBytes: () => Uint8Array;\n};\n\n/**\n * This is like `SecretMetadata`, but without the `data` and `toBytes`\n * methods in which the data is `base64` encoded for more compacted\n * metadata.\n */\ntype SecretMetadataJson<DataType extends SecretDataType> = Omit<\n  ISecretMetadata<DataType>,\n  'data' | 'toBytes'\n> & {\n  data: string; // base64 encoded string\n};\n\n/**\n * SecretMetadata is a class that adds metadata to the secret.\n *\n * It contains the secret and the timestamp when it was created.\n * It is used to store the secret in the metadata store.\n *\n * @example\n * ```ts\n * const secretMetadata = new SecretMetadata(secret);\n * ```\n */\nexport class SecretMetadata<DataType extends SecretDataType = Uint8Array>\n  implements ISecretMetadata<DataType>\n{\n  readonly #data: DataType;\n\n  readonly #timestamp: number;\n\n  readonly #type: SecretType;\n\n  readonly #version: SecretMetadataVersion;\n\n  /**\n   * Create a new SecretMetadata instance.\n   *\n   * @param data - The secret to add metadata to.\n   * @param options - The options for the secret metadata.\n   * @param options.timestamp - The timestamp when the secret was created.\n   * @param options.type - The type of the secret.\n   */\n  constructor(data: DataType, options?: Partial<SecretMetadataOptions>) {\n    this.#data = data;\n    this.#timestamp = options?.timestamp ?? Date.now();\n    this.#type = options?.type ?? SecretType.Mnemonic;\n    this.#version = options?.version ?? SecretMetadataVersion.V1;\n  }\n\n  /**\n   * Create an Array of SecretMetadata instances from an array of secrets.\n   *\n   * To respect the order of the secrets, we add the index to the timestamp\n   * so that the first secret backup will have the oldest timestamp\n   * and the last secret backup will have the newest timestamp.\n   *\n   * @param data - The data to add metadata to.\n   * @param data.value - The SeedPhrase/PrivateKey to add metadata to.\n   * @param data.options - The options for the seed phrase metadata.\n   * @returns The SecretMetadata instances.\n   */\n  static fromBatch<DataType extends SecretDataType = Uint8Array>(\n    data: {\n      value: DataType;\n      options?: Partial<SecretMetadataOptions>;\n    }[],\n  ): SecretMetadata<DataType>[] {\n    const timestamp = Date.now();\n    return data.map((d, 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 = d.options?.timestamp ?? timestamp + index * 5;\n      return new SecretMetadata(d.value, {\n        timestamp: backupCreatedAt,\n        type: d.options?.type,\n      });\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 assertIsValidSecretMetadataJson<\n    DataType extends SecretDataType = Uint8Array,\n  >(value: unknown): asserts value is SecretMetadataJson<DataType> {\n    if (\n      typeof value !== 'object' ||\n      !value ||\n      !('data' in value) ||\n      typeof value.data !== 'string' ||\n      !('timestamp' in value) ||\n      typeof value.timestamp !== 'number'\n    ) {\n      throw new Error(\n        SeedlessOnboardingControllerErrorMessage.InvalidSecretMetadata,\n      );\n    }\n  }\n\n  /**\n   * Parse the SecretMetadata from the metadata store and return the array of SecretMetadata instances.\n   *\n   * This method also sorts the secrets by timestamp in ascending order, i.e. the oldest secret will be the first element in the array.\n   *\n   * @param secretMetadataArr - The array of SecretMetadata from the metadata store.\n   * @param filterType - The type of the secret to filter.\n   * @returns The array of SecretMetadata instances.\n   */\n  static parseSecretsFromMetadataStore<\n    DataType extends SecretDataType = Uint8Array,\n  >(\n    secretMetadataArr: Uint8Array[],\n    filterType?: SecretType,\n  ): SecretMetadata<DataType>[] {\n    const parsedSecertMetadata = secretMetadataArr.map((metadata) =>\n      SecretMetadata.fromRawMetadata<DataType>(metadata),\n    );\n\n    const secrets = SecretMetadata.sort(parsedSecertMetadata);\n\n    if (filterType) {\n      return secrets.filter((secret) => secret.type === filterType);\n    }\n\n    return secrets;\n  }\n\n  /**\n   * Parse and create the SecretMetadata instance from the raw metadata bytes.\n   *\n   * @param rawMetadata - The raw metadata.\n   * @returns The parsed secret metadata.\n   */\n  static fromRawMetadata<DataType extends SecretDataType>(\n    rawMetadata: Uint8Array,\n  ): SecretMetadata<DataType> {\n    const serializedMetadata = bytesToString(rawMetadata);\n    const parsedMetadata = JSON.parse(serializedMetadata);\n\n    SecretMetadata.assertIsValidSecretMetadataJson<DataType>(parsedMetadata);\n\n    // if the type is not provided, we default to Mnemonic for the backwards compatibility\n    const type = parsedMetadata.type ?? SecretType.Mnemonic;\n    const version = parsedMetadata.version ?? SecretMetadataVersion.V1;\n\n    let data: DataType;\n    try {\n      data = base64ToBytes(parsedMetadata.data) as DataType;\n    } catch {\n      data = parsedMetadata.data as DataType;\n    }\n\n    return new SecretMetadata<DataType>(data, {\n      timestamp: parsedMetadata.timestamp,\n      type,\n      version,\n    });\n  }\n\n  /**\n   * Sort the seed phrases by timestamp.\n   *\n   * @param data - The secret metadata array to sort.\n   * @param order - The order to sort the seed phrases. Default is `desc`.\n   *\n   * @returns The sorted secret metadata array.\n   */\n  static sort<DataType extends SecretDataType = Uint8Array>(\n    data: SecretMetadata<DataType>[],\n    order: 'asc' | 'desc' = 'asc',\n  ): SecretMetadata<DataType>[] {\n    return data.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 data(): DataType {\n    return this.#data;\n  }\n\n  get timestamp() {\n    return this.#timestamp;\n  }\n\n  get type() {\n    return this.#type;\n  }\n\n  get version() {\n    return this.#version;\n  }\n\n  /**\n   * Serialize the secret metadata and convert it to a Uint8Array.\n   *\n   * @returns The serialized SecretMetadata value in bytes.\n   */\n  toBytes(): Uint8Array {\n    let _data: unknown = this.#data;\n    if (this.#data instanceof Uint8Array) {\n      // encode the raw secret to base64 encoded string\n      // to create more compacted metadata\n      _data = bytesToBase64(this.#data);\n    }\n\n    // serialize the metadata to a JSON string\n    const serializedMetadata = JSON.stringify({\n      data: _data,\n      timestamp: this.#timestamp,\n      type: this.#type,\n      version: this.#version,\n    });\n\n    // convert the serialized metadata to bytes(Uint8Array)\n    return stringToBytes(serializedMetadata);\n  }\n}\n"]}

package/dist/SecretMetadata.d.cts

@@ -0,0 +1,101 @@
+import { SecretType, SecretMetadataVersion } from "./constants.cjs";
+import type { SecretDataType, SecretMetadataOptions } from "./types.cjs";
+type ISecretMetadata<DataType extends SecretDataType = Uint8Array> = {
+    data: DataType;
+    timestamp: number;
+    type: SecretType;
+    version: SecretMetadataVersion;
+    toBytes: () => Uint8Array;
+};
+/**
+ * This is like `SecretMetadata`, but without the `data` and `toBytes`
+ * methods in which the data is `base64` encoded for more compacted
+ * metadata.
+ */
+type SecretMetadataJson<DataType extends SecretDataType> = Omit<ISecretMetadata<DataType>, 'data' | 'toBytes'> & {
+    data: string;
+};
+/**
+ * SecretMetadata is a class that adds metadata to the secret.
+ *
+ * It contains the secret and the timestamp when it was created.
+ * It is used to store the secret in the metadata store.
+ *
+ * @example
+ * ```ts
+ * const secretMetadata = new SecretMetadata(secret);
+ * ```
+ */
+export declare class SecretMetadata<DataType extends SecretDataType = Uint8Array> implements ISecretMetadata<DataType> {
+    #private;
+    /**
+     * Create a new SecretMetadata instance.
+     *
+     * @param data - The secret to add metadata to.
+     * @param options - The options for the secret metadata.
+     * @param options.timestamp - The timestamp when the secret was created.
+     * @param options.type - The type of the secret.
+     */
+    constructor(data: DataType, options?: Partial<SecretMetadataOptions>);
+    /**
+     * Create an Array of SecretMetadata instances from an array of secrets.
+     *
+     * To respect the order of the secrets, we add the index to the timestamp
+     * so that the first secret backup will have the oldest timestamp
+     * and the last secret backup will have the newest timestamp.
+     *
+     * @param data - The data to add metadata to.
+     * @param data.value - The SeedPhrase/PrivateKey to add metadata to.
+     * @param data.options - The options for the seed phrase metadata.
+     * @returns The SecretMetadata instances.
+     */
+    static fromBatch<DataType extends SecretDataType = Uint8Array>(data: {
+        value: DataType;
+        options?: Partial<SecretMetadataOptions>;
+    }[]): SecretMetadata<DataType>[];
+    /**
+     * 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 assertIsValidSecretMetadataJson<DataType extends SecretDataType = Uint8Array>(value: unknown): asserts value is SecretMetadataJson<DataType>;
+    /**
+     * Parse the SecretMetadata from the metadata store and return the array of SecretMetadata instances.
+     *
+     * This method also sorts the secrets by timestamp in ascending order, i.e. the oldest secret will be the first element in the array.
+     *
+     * @param secretMetadataArr - The array of SecretMetadata from the metadata store.
+     * @param filterType - The type of the secret to filter.
+     * @returns The array of SecretMetadata instances.
+     */
+    static parseSecretsFromMetadataStore<DataType extends SecretDataType = Uint8Array>(secretMetadataArr: Uint8Array[], filterType?: SecretType): SecretMetadata<DataType>[];
+    /**
+     * Parse and create the SecretMetadata instance from the raw metadata bytes.
+     *
+     * @param rawMetadata - The raw metadata.
+     * @returns The parsed secret metadata.
+     */
+    static fromRawMetadata<DataType extends SecretDataType>(rawMetadata: Uint8Array): SecretMetadata<DataType>;
+    /**
+     * Sort the seed phrases by timestamp.
+     *
+     * @param data - The secret metadata array to sort.
+     * @param order - The order to sort the seed phrases. Default is `desc`.
+     *
+     * @returns The sorted secret metadata array.
+     */
+    static sort<DataType extends SecretDataType = Uint8Array>(data: SecretMetadata<DataType>[], order?: 'asc' | 'desc'): SecretMetadata<DataType>[];
+    get data(): DataType;
+    get timestamp(): number;
+    get type(): SecretType;
+    get version(): SecretMetadataVersion;
+    /**
+     * Serialize the secret metadata and convert it to a Uint8Array.
+     *
+     * @returns The serialized SecretMetadata value in bytes.
+     */
+    toBytes(): Uint8Array;
+}
+export {};
+//# sourceMappingURL=SecretMetadata.d.cts.map

package/dist/SecretMetadata.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecretMetadata.d.cts","sourceRoot":"","sources":["../src/SecretMetadata.ts"],"names":[],"mappings":"AAOA,OAAO,EAEL,UAAU,EACV,qBAAqB,EACtB,wBAAoB;AACrB,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,oBAAgB;AAErE,KAAK,eAAe,CAAC,QAAQ,SAAS,cAAc,GAAG,UAAU,IAAI;IACnE,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,qBAAqB,CAAC;IAC/B,OAAO,EAAE,MAAM,UAAU,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,KAAK,kBAAkB,CAAC,QAAQ,SAAS,cAAc,IAAI,IAAI,CAC7D,eAAe,CAAC,QAAQ,CAAC,EACzB,MAAM,GAAG,SAAS,CACnB,GAAG;IACF,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,cAAc,CAAC,QAAQ,SAAS,cAAc,GAAG,UAAU,CACtE,YAAW,eAAe,CAAC,QAAQ,CAAC;;IAUpC;;;;;;;OAOG;gBACS,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAOpE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,CAAC,QAAQ,SAAS,cAAc,GAAG,UAAU,EAC3D,IAAI,EAAE;QACJ,KAAK,EAAE,QAAQ,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;KAC1C,EAAE,GACF,cAAc,CAAC,QAAQ,CAAC,EAAE;IAc7B;;;;;OAKG;IACH,MAAM,CAAC,+BAA+B,CACpC,QAAQ,SAAS,cAAc,GAAG,UAAU,EAC5C,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAAC,QAAQ,CAAC;IAehE;;;;;;;;OAQG;IACH,MAAM,CAAC,6BAA6B,CAClC,QAAQ,SAAS,cAAc,GAAG,UAAU,EAE5C,iBAAiB,EAAE,UAAU,EAAE,EAC/B,UAAU,CAAC,EAAE,UAAU,GACtB,cAAc,CAAC,QAAQ,CAAC,EAAE;IAc7B;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,QAAQ,SAAS,cAAc,EACpD,WAAW,EAAE,UAAU,GACtB,cAAc,CAAC,QAAQ,CAAC;IAwB3B;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,QAAQ,SAAS,cAAc,GAAG,UAAU,EACtD,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,EAChC,KAAK,GAAE,KAAK,GAAG,MAAc,GAC5B,cAAc,CAAC,QAAQ,CAAC,EAAE;IAS7B,IAAI,IAAI,IAAI,QAAQ,CAEnB;IAED,IAAI,SAAS,WAEZ;IAED,IAAI,IAAI,eAEP;IAED,IAAI,OAAO,0BAEV;IAED;;;;OAIG;IACH,OAAO,IAAI,UAAU;CAmBtB"}

package/dist/SecretMetadata.d.mts

@@ -0,0 +1,101 @@
+import { SecretType, SecretMetadataVersion } from "./constants.mjs";
+import type { SecretDataType, SecretMetadataOptions } from "./types.mjs";
+type ISecretMetadata<DataType extends SecretDataType = Uint8Array> = {
+    data: DataType;
+    timestamp: number;
+    type: SecretType;
+    version: SecretMetadataVersion;
+    toBytes: () => Uint8Array;
+};
+/**
+ * This is like `SecretMetadata`, but without the `data` and `toBytes`
+ * methods in which the data is `base64` encoded for more compacted
+ * metadata.
+ */
+type SecretMetadataJson<DataType extends SecretDataType> = Omit<ISecretMetadata<DataType>, 'data' | 'toBytes'> & {
+    data: string;
+};
+/**
+ * SecretMetadata is a class that adds metadata to the secret.
+ *
+ * It contains the secret and the timestamp when it was created.
+ * It is used to store the secret in the metadata store.
+ *
+ * @example
+ * ```ts
+ * const secretMetadata = new SecretMetadata(secret);
+ * ```
+ */
+export declare class SecretMetadata<DataType extends SecretDataType = Uint8Array> implements ISecretMetadata<DataType> {
+    #private;
+    /**
+     * Create a new SecretMetadata instance.
+     *
+     * @param data - The secret to add metadata to.
+     * @param options - The options for the secret metadata.
+     * @param options.timestamp - The timestamp when the secret was created.
+     * @param options.type - The type of the secret.
+     */
+    constructor(data: DataType, options?: Partial<SecretMetadataOptions>);
+    /**
+     * Create an Array of SecretMetadata instances from an array of secrets.
+     *
+     * To respect the order of the secrets, we add the index to the timestamp
+     * so that the first secret backup will have the oldest timestamp
+     * and the last secret backup will have the newest timestamp.
+     *
+     * @param data - The data to add metadata to.
+     * @param data.value - The SeedPhrase/PrivateKey to add metadata to.
+     * @param data.options - The options for the seed phrase metadata.
+     * @returns The SecretMetadata instances.
+     */
+    static fromBatch<DataType extends SecretDataType = Uint8Array>(data: {
+        value: DataType;
+        options?: Partial<SecretMetadataOptions>;
+    }[]): SecretMetadata<DataType>[];
+    /**
+     * 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 assertIsValidSecretMetadataJson<DataType extends SecretDataType = Uint8Array>(value: unknown): asserts value is SecretMetadataJson<DataType>;
+    /**
+     * Parse the SecretMetadata from the metadata store and return the array of SecretMetadata instances.
+     *
+     * This method also sorts the secrets by timestamp in ascending order, i.e. the oldest secret will be the first element in the array.
+     *
+     * @param secretMetadataArr - The array of SecretMetadata from the metadata store.
+     * @param filterType - The type of the secret to filter.
+     * @returns The array of SecretMetadata instances.
+     */
+    static parseSecretsFromMetadataStore<DataType extends SecretDataType = Uint8Array>(secretMetadataArr: Uint8Array[], filterType?: SecretType): SecretMetadata<DataType>[];
+    /**
+     * Parse and create the SecretMetadata instance from the raw metadata bytes.
+     *
+     * @param rawMetadata - The raw metadata.
+     * @returns The parsed secret metadata.
+     */
+    static fromRawMetadata<DataType extends SecretDataType>(rawMetadata: Uint8Array): SecretMetadata<DataType>;
+    /**
+     * Sort the seed phrases by timestamp.
+     *
+     * @param data - The secret metadata array to sort.
+     * @param order - The order to sort the seed phrases. Default is `desc`.
+     *
+     * @returns The sorted secret metadata array.
+     */
+    static sort<DataType extends SecretDataType = Uint8Array>(data: SecretMetadata<DataType>[], order?: 'asc' | 'desc'): SecretMetadata<DataType>[];
+    get data(): DataType;
+    get timestamp(): number;
+    get type(): SecretType;
+    get version(): SecretMetadataVersion;
+    /**
+     * Serialize the secret metadata and convert it to a Uint8Array.
+     *
+     * @returns The serialized SecretMetadata value in bytes.
+     */
+    toBytes(): Uint8Array;
+}
+export {};
+//# sourceMappingURL=SecretMetadata.d.mts.map

package/dist/SecretMetadata.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecretMetadata.d.mts","sourceRoot":"","sources":["../src/SecretMetadata.ts"],"names":[],"mappings":"AAOA,OAAO,EAEL,UAAU,EACV,qBAAqB,EACtB,wBAAoB;AACrB,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,oBAAgB;AAErE,KAAK,eAAe,CAAC,QAAQ,SAAS,cAAc,GAAG,UAAU,IAAI;IACnE,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,qBAAqB,CAAC;IAC/B,OAAO,EAAE,MAAM,UAAU,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,KAAK,kBAAkB,CAAC,QAAQ,SAAS,cAAc,IAAI,IAAI,CAC7D,eAAe,CAAC,QAAQ,CAAC,EACzB,MAAM,GAAG,SAAS,CACnB,GAAG;IACF,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,cAAc,CAAC,QAAQ,SAAS,cAAc,GAAG,UAAU,CACtE,YAAW,eAAe,CAAC,QAAQ,CAAC;;IAUpC;;;;;;;OAOG;gBACS,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAOpE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,CAAC,QAAQ,SAAS,cAAc,GAAG,UAAU,EAC3D,IAAI,EAAE;QACJ,KAAK,EAAE,QAAQ,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;KAC1C,EAAE,GACF,cAAc,CAAC,QAAQ,CAAC,EAAE;IAc7B;;;;;OAKG;IACH,MAAM,CAAC,+BAA+B,CACpC,QAAQ,SAAS,cAAc,GAAG,UAAU,EAC5C,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAAC,QAAQ,CAAC;IAehE;;;;;;;;OAQG;IACH,MAAM,CAAC,6BAA6B,CAClC,QAAQ,SAAS,cAAc,GAAG,UAAU,EAE5C,iBAAiB,EAAE,UAAU,EAAE,EAC/B,UAAU,CAAC,EAAE,UAAU,GACtB,cAAc,CAAC,QAAQ,CAAC,EAAE;IAc7B;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,QAAQ,SAAS,cAAc,EACpD,WAAW,EAAE,UAAU,GACtB,cAAc,CAAC,QAAQ,CAAC;IAwB3B;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,QAAQ,SAAS,cAAc,GAAG,UAAU,EACtD,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,EAChC,KAAK,GAAE,KAAK,GAAG,MAAc,GAC5B,cAAc,CAAC,QAAQ,CAAC,EAAE;IAS7B,IAAI,IAAI,IAAI,QAAQ,CAEnB;IAED,IAAI,SAAS,WAEZ;IAED,IAAI,IAAI,eAEP;IAED,IAAI,OAAO,0BAEV;IAED;;;;OAIG;IACH,OAAO,IAAI,UAAU;CAmBtB"}

package/dist/SecretMetadata.mjs

@@ -0,0 +1,181 @@
+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 _SecretMetadata_data, _SecretMetadata_timestamp, _SecretMetadata_type, _SecretMetadata_version;
+import { base64ToBytes, bytesToBase64, stringToBytes, bytesToString } from "@metamask/utils";
+import { SeedlessOnboardingControllerErrorMessage, SecretType, SecretMetadataVersion } from "./constants.mjs";
+/**
+ * SecretMetadata is a class that adds metadata to the secret.
+ *
+ * It contains the secret and the timestamp when it was created.
+ * It is used to store the secret in the metadata store.
+ *
+ * @example
+ * ```ts
+ * const secretMetadata = new SecretMetadata(secret);
+ * ```
+ */
+export class SecretMetadata {
+    /**
+     * Create a new SecretMetadata instance.
+     *
+     * @param data - The secret to add metadata to.
+     * @param options - The options for the secret metadata.
+     * @param options.timestamp - The timestamp when the secret was created.
+     * @param options.type - The type of the secret.
+     */
+    constructor(data, options) {
+        _SecretMetadata_data.set(this, void 0);
+        _SecretMetadata_timestamp.set(this, void 0);
+        _SecretMetadata_type.set(this, void 0);
+        _SecretMetadata_version.set(this, void 0);
+        __classPrivateFieldSet(this, _SecretMetadata_data, data, "f");
+        __classPrivateFieldSet(this, _SecretMetadata_timestamp, options?.timestamp ?? Date.now(), "f");
+        __classPrivateFieldSet(this, _SecretMetadata_type, options?.type ?? SecretType.Mnemonic, "f");
+        __classPrivateFieldSet(this, _SecretMetadata_version, options?.version ?? SecretMetadataVersion.V1, "f");
+    }
+    /**
+     * Create an Array of SecretMetadata instances from an array of secrets.
+     *
+     * To respect the order of the secrets, we add the index to the timestamp
+     * so that the first secret backup will have the oldest timestamp
+     * and the last secret backup will have the newest timestamp.
+     *
+     * @param data - The data to add metadata to.
+     * @param data.value - The SeedPhrase/PrivateKey to add metadata to.
+     * @param data.options - The options for the seed phrase metadata.
+     * @returns The SecretMetadata instances.
+     */
+    static fromBatch(data) {
+        const timestamp = Date.now();
+        return data.map((d, 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 = d.options?.timestamp ?? timestamp + index * 5;
+            return new SecretMetadata(d.value, {
+                timestamp: backupCreatedAt,
+                type: d.options?.type,
+            });
+        });
+    }
+    /**
+     * 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 assertIsValidSecretMetadataJson(value) {
+        if (typeof value !== 'object' ||
+            !value ||
+            !('data' in value) ||
+            typeof value.data !== 'string' ||
+            !('timestamp' in value) ||
+            typeof value.timestamp !== 'number') {
+            throw new Error(SeedlessOnboardingControllerErrorMessage.InvalidSecretMetadata);
+        }
+    }
+    /**
+     * Parse the SecretMetadata from the metadata store and return the array of SecretMetadata instances.
+     *
+     * This method also sorts the secrets by timestamp in ascending order, i.e. the oldest secret will be the first element in the array.
+     *
+     * @param secretMetadataArr - The array of SecretMetadata from the metadata store.
+     * @param filterType - The type of the secret to filter.
+     * @returns The array of SecretMetadata instances.
+     */
+    static parseSecretsFromMetadataStore(secretMetadataArr, filterType) {
+        const parsedSecertMetadata = secretMetadataArr.map((metadata) => SecretMetadata.fromRawMetadata(metadata));
+        const secrets = SecretMetadata.sort(parsedSecertMetadata);
+        if (filterType) {
+            return secrets.filter((secret) => secret.type === filterType);
+        }
+        return secrets;
+    }
+    /**
+     * Parse and create the SecretMetadata instance from the raw metadata bytes.
+     *
+     * @param rawMetadata - The raw metadata.
+     * @returns The parsed secret metadata.
+     */
+    static fromRawMetadata(rawMetadata) {
+        const serializedMetadata = bytesToString(rawMetadata);
+        const parsedMetadata = JSON.parse(serializedMetadata);
+        SecretMetadata.assertIsValidSecretMetadataJson(parsedMetadata);
+        // if the type is not provided, we default to Mnemonic for the backwards compatibility
+        const type = parsedMetadata.type ?? SecretType.Mnemonic;
+        const version = parsedMetadata.version ?? SecretMetadataVersion.V1;
+        let data;
+        try {
+            data = base64ToBytes(parsedMetadata.data);
+        }
+        catch {
+            data = parsedMetadata.data;
+        }
+        return new SecretMetadata(data, {
+            timestamp: parsedMetadata.timestamp,
+            type,
+            version,
+        });
+    }
+    /**
+     * Sort the seed phrases by timestamp.
+     *
+     * @param data - The secret metadata array to sort.
+     * @param order - The order to sort the seed phrases. Default is `desc`.
+     *
+     * @returns The sorted secret metadata array.
+     */
+    static sort(data, order = 'asc') {
+        return data.sort((a, b) => {
+            if (order === 'asc') {
+                return a.timestamp - b.timestamp;
+            }
+            return b.timestamp - a.timestamp;
+        });
+    }
+    get data() {
+        return __classPrivateFieldGet(this, _SecretMetadata_data, "f");
+    }
+    get timestamp() {
+        return __classPrivateFieldGet(this, _SecretMetadata_timestamp, "f");
+    }
+    get type() {
+        return __classPrivateFieldGet(this, _SecretMetadata_type, "f");
+    }
+    get version() {
+        return __classPrivateFieldGet(this, _SecretMetadata_version, "f");
+    }
+    /**
+     * Serialize the secret metadata and convert it to a Uint8Array.
+     *
+     * @returns The serialized SecretMetadata value in bytes.
+     */
+    toBytes() {
+        let _data = __classPrivateFieldGet(this, _SecretMetadata_data, "f");
+        if (__classPrivateFieldGet(this, _SecretMetadata_data, "f") instanceof Uint8Array) {
+            // encode the raw secret to base64 encoded string
+            // to create more compacted metadata
+            _data = bytesToBase64(__classPrivateFieldGet(this, _SecretMetadata_data, "f"));
+        }
+        // serialize the metadata to a JSON string
+        const serializedMetadata = JSON.stringify({
+            data: _data,
+            timestamp: __classPrivateFieldGet(this, _SecretMetadata_timestamp, "f"),
+            type: __classPrivateFieldGet(this, _SecretMetadata_type, "f"),
+            version: __classPrivateFieldGet(this, _SecretMetadata_version, "f"),
+        });
+        // convert the serialized metadata to bytes(Uint8Array)
+        return stringToBytes(serializedMetadata);
+    }
+}
+_SecretMetadata_data = new WeakMap(), _SecretMetadata_timestamp = new WeakMap(), _SecretMetadata_type = new WeakMap(), _SecretMetadata_version = new WeakMap();
+//# sourceMappingURL=SecretMetadata.mjs.map

package/dist/SecretMetadata.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecretMetadata.mjs","sourceRoot":"","sources":["../src/SecretMetadata.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,aAAa,EACb,aAAa,EACb,aAAa,EACb,aAAa,EACd,wBAAwB;AAEzB,OAAO,EACL,wCAAwC,EACxC,UAAU,EACV,qBAAqB,EACtB,wBAAoB;AAuBrB;;;;;;;;;;GAUG;AACH,MAAM,OAAO,cAAc;IAWzB;;;;;;;OAOG;IACH,YAAY,IAAc,EAAE,OAAwC;QAhB3D,uCAAgB;QAEhB,4CAAmB;QAEnB,uCAAkB;QAElB,0CAAgC;QAWvC,uBAAA,IAAI,wBAAS,IAAI,MAAA,CAAC;QAClB,uBAAA,IAAI,6BAAc,OAAO,EAAE,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,MAAA,CAAC;QACnD,uBAAA,IAAI,wBAAS,OAAO,EAAE,IAAI,IAAI,UAAU,CAAC,QAAQ,MAAA,CAAC;QAClD,uBAAA,IAAI,2BAAY,OAAO,EAAE,OAAO,IAAI,qBAAqB,CAAC,EAAE,MAAA,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,CACd,IAGG;QAEH,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;YAC3B,8EAA8E;YAC9E,sEAAsE;YACtE,iEAAiE;YACjE,MAAM,eAAe,GAAG,CAAC,CAAC,OAAO,EAAE,SAAS,IAAI,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;YACtE,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,EAAE;gBACjC,SAAS,EAAE,eAAe;gBAC1B,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,IAAI;aACtB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,+BAA+B,CAEpC,KAAc;QACd,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,KAAK;YACN,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC;YAClB,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;YAC9B,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC;YACvB,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EACnC;YACA,MAAM,IAAI,KAAK,CACb,wCAAwC,CAAC,qBAAqB,CAC/D,CAAC;SACH;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,6BAA6B,CAGlC,iBAA+B,EAC/B,UAAuB;QAEvB,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC9D,cAAc,CAAC,eAAe,CAAW,QAAQ,CAAC,CACnD,CAAC;QAEF,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE1D,IAAI,UAAU,EAAE;YACd,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;SAC/D;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CACpB,WAAuB;QAEvB,MAAM,kBAAkB,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAEtD,cAAc,CAAC,+BAA+B,CAAW,cAAc,CAAC,CAAC;QAEzE,sFAAsF;QACtF,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,IAAI,UAAU,CAAC,QAAQ,CAAC;QACxD,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,IAAI,qBAAqB,CAAC,EAAE,CAAC;QAEnE,IAAI,IAAc,CAAC;QACnB,IAAI;YACF,IAAI,GAAG,aAAa,CAAC,cAAc,CAAC,IAAI,CAAa,CAAC;SACvD;QAAC,MAAM;YACN,IAAI,GAAG,cAAc,CAAC,IAAgB,CAAC;SACxC;QAED,OAAO,IAAI,cAAc,CAAW,IAAI,EAAE;YACxC,SAAS,EAAE,cAAc,CAAC,SAAS;YACnC,IAAI;YACJ,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,IAAgC,EAChC,QAAwB,KAAK;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACxB,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,IAAI;QACN,OAAO,uBAAA,IAAI,4BAAM,CAAC;IACpB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,uBAAA,IAAI,iCAAW,CAAC;IACzB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,4BAAM,CAAC;IACpB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,+BAAS,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,IAAI,KAAK,GAAY,uBAAA,IAAI,4BAAM,CAAC;QAChC,IAAI,uBAAA,IAAI,4BAAM,YAAY,UAAU,EAAE;YACpC,iDAAiD;YACjD,oCAAoC;YACpC,KAAK,GAAG,aAAa,CAAC,uBAAA,IAAI,4BAAM,CAAC,CAAC;SACnC;QAED,0CAA0C;QAC1C,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC;YACxC,IAAI,EAAE,KAAK;YACX,SAAS,EAAE,uBAAA,IAAI,iCAAW;YAC1B,IAAI,EAAE,uBAAA,IAAI,4BAAM;YAChB,OAAO,EAAE,uBAAA,IAAI,+BAAS;SACvB,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 {\n  SeedlessOnboardingControllerErrorMessage,\n  SecretType,\n  SecretMetadataVersion,\n} from './constants';\nimport type { SecretDataType, SecretMetadataOptions } from './types';\n\ntype ISecretMetadata<DataType extends SecretDataType = Uint8Array> = {\n  data: DataType;\n  timestamp: number;\n  type: SecretType;\n  version: SecretMetadataVersion;\n  toBytes: () => Uint8Array;\n};\n\n/**\n * This is like `SecretMetadata`, but without the `data` and `toBytes`\n * methods in which the data is `base64` encoded for more compacted\n * metadata.\n */\ntype SecretMetadataJson<DataType extends SecretDataType> = Omit<\n  ISecretMetadata<DataType>,\n  'data' | 'toBytes'\n> & {\n  data: string; // base64 encoded string\n};\n\n/**\n * SecretMetadata is a class that adds metadata to the secret.\n *\n * It contains the secret and the timestamp when it was created.\n * It is used to store the secret in the metadata store.\n *\n * @example\n * ```ts\n * const secretMetadata = new SecretMetadata(secret);\n * ```\n */\nexport class SecretMetadata<DataType extends SecretDataType = Uint8Array>\n  implements ISecretMetadata<DataType>\n{\n  readonly #data: DataType;\n\n  readonly #timestamp: number;\n\n  readonly #type: SecretType;\n\n  readonly #version: SecretMetadataVersion;\n\n  /**\n   * Create a new SecretMetadata instance.\n   *\n   * @param data - The secret to add metadata to.\n   * @param options - The options for the secret metadata.\n   * @param options.timestamp - The timestamp when the secret was created.\n   * @param options.type - The type of the secret.\n   */\n  constructor(data: DataType, options?: Partial<SecretMetadataOptions>) {\n    this.#data = data;\n    this.#timestamp = options?.timestamp ?? Date.now();\n    this.#type = options?.type ?? SecretType.Mnemonic;\n    this.#version = options?.version ?? SecretMetadataVersion.V1;\n  }\n\n  /**\n   * Create an Array of SecretMetadata instances from an array of secrets.\n   *\n   * To respect the order of the secrets, we add the index to the timestamp\n   * so that the first secret backup will have the oldest timestamp\n   * and the last secret backup will have the newest timestamp.\n   *\n   * @param data - The data to add metadata to.\n   * @param data.value - The SeedPhrase/PrivateKey to add metadata to.\n   * @param data.options - The options for the seed phrase metadata.\n   * @returns The SecretMetadata instances.\n   */\n  static fromBatch<DataType extends SecretDataType = Uint8Array>(\n    data: {\n      value: DataType;\n      options?: Partial<SecretMetadataOptions>;\n    }[],\n  ): SecretMetadata<DataType>[] {\n    const timestamp = Date.now();\n    return data.map((d, 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 = d.options?.timestamp ?? timestamp + index * 5;\n      return new SecretMetadata(d.value, {\n        timestamp: backupCreatedAt,\n        type: d.options?.type,\n      });\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 assertIsValidSecretMetadataJson<\n    DataType extends SecretDataType = Uint8Array,\n  >(value: unknown): asserts value is SecretMetadataJson<DataType> {\n    if (\n      typeof value !== 'object' ||\n      !value ||\n      !('data' in value) ||\n      typeof value.data !== 'string' ||\n      !('timestamp' in value) ||\n      typeof value.timestamp !== 'number'\n    ) {\n      throw new Error(\n        SeedlessOnboardingControllerErrorMessage.InvalidSecretMetadata,\n      );\n    }\n  }\n\n  /**\n   * Parse the SecretMetadata from the metadata store and return the array of SecretMetadata instances.\n   *\n   * This method also sorts the secrets by timestamp in ascending order, i.e. the oldest secret will be the first element in the array.\n   *\n   * @param secretMetadataArr - The array of SecretMetadata from the metadata store.\n   * @param filterType - The type of the secret to filter.\n   * @returns The array of SecretMetadata instances.\n   */\n  static parseSecretsFromMetadataStore<\n    DataType extends SecretDataType = Uint8Array,\n  >(\n    secretMetadataArr: Uint8Array[],\n    filterType?: SecretType,\n  ): SecretMetadata<DataType>[] {\n    const parsedSecertMetadata = secretMetadataArr.map((metadata) =>\n      SecretMetadata.fromRawMetadata<DataType>(metadata),\n    );\n\n    const secrets = SecretMetadata.sort(parsedSecertMetadata);\n\n    if (filterType) {\n      return secrets.filter((secret) => secret.type === filterType);\n    }\n\n    return secrets;\n  }\n\n  /**\n   * Parse and create the SecretMetadata instance from the raw metadata bytes.\n   *\n   * @param rawMetadata - The raw metadata.\n   * @returns The parsed secret metadata.\n   */\n  static fromRawMetadata<DataType extends SecretDataType>(\n    rawMetadata: Uint8Array,\n  ): SecretMetadata<DataType> {\n    const serializedMetadata = bytesToString(rawMetadata);\n    const parsedMetadata = JSON.parse(serializedMetadata);\n\n    SecretMetadata.assertIsValidSecretMetadataJson<DataType>(parsedMetadata);\n\n    // if the type is not provided, we default to Mnemonic for the backwards compatibility\n    const type = parsedMetadata.type ?? SecretType.Mnemonic;\n    const version = parsedMetadata.version ?? SecretMetadataVersion.V1;\n\n    let data: DataType;\n    try {\n      data = base64ToBytes(parsedMetadata.data) as DataType;\n    } catch {\n      data = parsedMetadata.data as DataType;\n    }\n\n    return new SecretMetadata<DataType>(data, {\n      timestamp: parsedMetadata.timestamp,\n      type,\n      version,\n    });\n  }\n\n  /**\n   * Sort the seed phrases by timestamp.\n   *\n   * @param data - The secret metadata array to sort.\n   * @param order - The order to sort the seed phrases. Default is `desc`.\n   *\n   * @returns The sorted secret metadata array.\n   */\n  static sort<DataType extends SecretDataType = Uint8Array>(\n    data: SecretMetadata<DataType>[],\n    order: 'asc' | 'desc' = 'asc',\n  ): SecretMetadata<DataType>[] {\n    return data.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 data(): DataType {\n    return this.#data;\n  }\n\n  get timestamp() {\n    return this.#timestamp;\n  }\n\n  get type() {\n    return this.#type;\n  }\n\n  get version() {\n    return this.#version;\n  }\n\n  /**\n   * Serialize the secret metadata and convert it to a Uint8Array.\n   *\n   * @returns The serialized SecretMetadata value in bytes.\n   */\n  toBytes(): Uint8Array {\n    let _data: unknown = this.#data;\n    if (this.#data instanceof Uint8Array) {\n      // encode the raw secret to base64 encoded string\n      // to create more compacted metadata\n      _data = bytesToBase64(this.#data);\n    }\n\n    // serialize the metadata to a JSON string\n    const serializedMetadata = JSON.stringify({\n      data: _data,\n      timestamp: this.#timestamp,\n      type: this.#type,\n      version: this.#version,\n    });\n\n    // convert the serialized metadata to bytes(Uint8Array)\n    return stringToBytes(serializedMetadata);\n  }\n}\n"]}