@universal-everything/sdk-core-backup 1.0.0-dev.04bf615

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 LUKSO Blockchain GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,59 @@
+# @universal-everything/sdk-core-backup
+
+Encode / decode the LUKSO **V2 backup-file format** (PBKDF2-SHA256 +
+AES-256-GCM). Round-trips with the official LUKSO browser extension
+and first-party mobile app — share backup files across apps or write
+your own restore tool.
+
+## Install
+
+```bash
+pnpm add @universal-everything/sdk-core-backup
+```
+
+## Quick start — encrypt a wallet to a file
+
+```ts
+import { encodeBackup, type WalletData } from "@universal-everything/sdk-core-backup";
+
+const wallet: WalletData = {
+  address: "0x1234…",
+  privateKey: "0xabcd…", // 32-byte hex
+  label: "main",
+};
+
+const fileBytes = await encodeBackup(wallet, {
+  password: "user-chosen-password",
+});
+
+// Save fileBytes to disk, upload to iCloud, etc.
+```
+
+## Quick start — restore from a file
+
+```ts
+import { decodeBackup } from "@universal-everything/sdk-core-backup";
+
+const wallet = await decodeBackup(fileBytes, {
+  password: "user-chosen-password",
+});
+// -> { address, privateKey, label }
+```
+
+## Format details
+
+- **Key derivation**: PBKDF2-SHA256, configurable iterations (default
+  matches the LUKSO extension's current setting), 16-byte random salt.
+- **Cipher**: AES-256-GCM with a 12-byte random IV, 16-byte auth tag.
+- **Version byte** up front so future format changes stay
+  backwards-compatible on decode.
+
+Wrong passwords fail at the AES-GCM auth-tag check — `decodeBackup`
+throws with a typed error so you can distinguish "bad password" from
+"file corrupted".
+
+## Compatibility
+
+- ✅ LUKSO browser extension V2 backups
+- ✅ First-party LUKSO mobile app V2 backups
+- ❌ V1 backup format (legacy, not supported here; use the old tooling)

package/dist/index.d.ts

@@ -0,0 +1,224 @@
+/**
+ * V2 backup file format for LUKSO wallets.
+ *
+ * **Interop contract**: this format is what the LUKSO browser extension
+ * and first-party mobile app read and write. When our SDK gets embedded
+ * inside those clients (or when users move keys across them), this is
+ * the wire format. Preserve round-trip compatibility over minimalism.
+ *
+ * Ported from service-auth-simple/packages/passkey-auth/src/backup.ts
+ * with two deliberate changes:
+ *
+ * 1. **READ side is full-fat**: `BackupFile` keeps every optional field
+ *    the extension emits (accounts with networks, LSP23CrossChainDeployment,
+ *    legacy `encryptedSecrets` V1). `validateBackup` / `importBackup` /
+ *    `extractWalletData` work on all of them.
+ *
+ * 2. **WRITE side is simplified**: our `exportBackup` takes a single
+ *    `{ privateKey, address, password? }` (plus optional profile/chain
+ *    metadata) because that's what our Privy-backed SDK has. No
+ *    `derivedKeys`/`usedKeyIndices` — those presume an HD wallet that
+ *    Privy doesn't expose. No `LSP23CrossChainDeployment` — that lives
+ *    in the Envio GraphQL indexer now; callers that need it in a file
+ *    re-fetch and attach it at write time.
+ *
+ * The output still goes through the `type: "privateKey"` path in the
+ * extension's `extractWalletData` fallback (embedded-wallet case), so
+ * backups our SDK writes are readable by the extension.
+ */
+type BackupFile = {
+    version?: number;
+    backupDate?: string;
+    accounts?: BackupAccountV2[];
+    /** LUKSO LSP-23 cross-chain deployment payload emitted by the extension. */
+    LSP23CrossChainDeployment?: LSP23DeploymentData[];
+    secrets?: BackupSecrets;
+    /** V1 legacy shape. Readers accept, writers never emit. */
+    encryptedSecrets?: {
+        encryptionType: string;
+        secrets: {
+            data: string;
+            iv: string;
+            salt: string;
+        };
+    };
+};
+type BackupAccountV2 = {
+    type: "LSP0-ERC725Account";
+    name?: string;
+    address: string;
+    networks: BackupNetwork[];
+};
+type BackupNetwork = {
+    chainID: number;
+    name: string;
+    controllers: LegacyBackupController[];
+};
+type LegacyBackupController = {
+    address: string;
+    type: "UniversalReceiver" | "Device" | "LSP0-ERC725Account";
+    name: string;
+    privateKeyIndex?: number;
+};
+type LSP23DeploymentData = {
+    profileAddress: string;
+    initialChainID: number;
+    factoryAddress: string;
+    deploymentCalldata: string;
+    initialControllers: BackupController[];
+};
+type BackupController = {
+    address: string;
+    privateKeyIndex?: number;
+    addressPermissions: BackupAddressPermissions;
+};
+type BackupAddressPermissions = {
+    permissions: string;
+    decodedPermissions: Record<string, boolean>;
+    allowedCalls: string;
+    allowedERC725YDataKeys: string;
+};
+type BackupSecrets = {
+    encrypted: boolean;
+    passwordHint?: string;
+    encryptionType?: string;
+    data: BackupSecretsData | EncryptedSecretsData;
+};
+type BackupSecretEntry = {
+    type: "privateKey" | "mnemonic";
+    index: number;
+    address: string;
+    secret: string;
+    /** Which mnemonic this key was derived from (null = standalone; undefined = legacy). */
+    mnemonicIndex?: number | null;
+    mnemonic?: string;
+    entropy?: string;
+    derivationPath?: string;
+};
+type BackupSecretsData = BackupSecretEntry[];
+type EncryptedSecretsData = {
+    /** base64 ciphertext of the JSON-serialized `BackupSecretsData` array. */
+    secret: string;
+    iv: string;
+    salt: string;
+};
+/** What `extractWalletData` / `importBackup` yield on success. */
+type WalletData = {
+    /** Optional — embedded-wallet exports don't carry a recovery phrase. */
+    mnemonic: string;
+    entropy: string;
+    privateKey: string;
+    address: string;
+    metadata?: {
+        createdAt: string;
+        network: string;
+        derivationPath?: string;
+    };
+};
+/**
+ * Structural validation of an arbitrary value against V2 (or legacy V1)
+ * shape. Throws a descriptive error; returns `true` as a type-narrowing
+ * assertion for use in TypeScript code paths.
+ */
+declare function validateBackup(backup: unknown): backup is BackupFile;
+/**
+ * Pulls the primary wallet (private key + address + optional
+ * mnemonic/entropy/derivationPath) out of an *unencrypted* backup.
+ *
+ * Tries in order:
+ *
+ * 1. Mnemonic-style entry (or index-0 entry carrying mnemonic/entropy).
+ * 2. privateKey entry with a `mnemonicIndex` pointer → walk to the
+ *    referenced mnemonic entry.
+ * 3. **Embedded-wallet fallback** (when `isImport=true`): standalone
+ *    privateKey entries with no mnemonic reference — take the first.
+ *    This is the path our own SDK's `exportBackup` output goes through
+ *    on the receiving end.
+ */
+declare function extractWalletData(backup: BackupFile, isImport?: boolean): WalletData;
+type ExportBackupOptions = {
+    /** 0x-prefixed 32-byte hex. */
+    privateKey: string;
+    /** 0x-prefixed 20-byte EIP-55-cased address. */
+    address: string;
+    /** When present, secrets are PBKDF2+AES-GCM encrypted. */
+    password?: string;
+    /**
+     * Optional profile address the key controls. When provided, an empty
+     * `accounts` entry is emitted so extension readers can link the key to
+     * the profile. LSP23 deployment metadata (factoryAddress,
+     * deploymentCalldata, etc.) is *not* written — it lives in the Envio
+     * GraphQL indexer; callers that need it in a file re-fetch and attach
+     * post-hoc.
+     */
+    profileAddress?: string;
+    /** Chain id the profile lives on. Only meaningful alongside `profileAddress`. */
+    chainId?: number;
+    /** Optional human-readable profile name. */
+    profileName?: string;
+};
+/**
+ * Produce a minimal V2 backup file from a single (Privy-exported) key.
+ * Readable by the LUKSO browser extension and first-party mobile app via
+ * their embedded-wallet fallback path.
+ */
+declare function exportBackup(options: ExportBackupOptions): Promise<BackupFile>;
+/** Stable filename convention: `lukso-wallet-backup-<ISO>[-plaintext].json`. */
+declare function backupFilename(backup: BackupFile): string;
+/**
+ * Triggers a browser download of the backup JSON. Skipped gracefully
+ * with a clear error when called outside a browser environment so test
+ * runs don't need to stub `document`.
+ */
+declare function downloadBackup(backup: BackupFile, filename?: string): void;
+/** Parse + validate a JSON string. Node-safe (no File/FileReader). */
+declare function parseBackup(json: string): BackupFile;
+/** Browser helper that reads an uploaded File into a validated `BackupFile`. */
+declare function readBackupFile(file: File): Promise<BackupFile>;
+/**
+ * Decrypt (if needed) + extract the primary wallet from a backup.
+ * `isImport=true` enables the embedded-wallet fallback path.
+ */
+declare function importBackup(backup: BackupFile, password?: string, isImport?: boolean): Promise<WalletData>;
+
+/**
+ * PBKDF2 (SHA-256, 100k iterations) + AES-256-GCM over the Web Crypto API.
+ * Ported from service-auth-simple/packages/passkey-auth/src/encryption.ts
+ * unchanged — parameters are the interop contract with the LUKSO browser
+ * extension and first-party mobile app, so tweaking them silently
+ * breaks round-trip compatibility.
+ */
+type EncryptionResult = {
+    /** base64 ciphertext (includes GCM auth tag at the end). */
+    ciphertext: string;
+    /** base64 salt used for PBKDF2 derivation. */
+    salt: string;
+    /** base64 12-byte IV used for AES-GCM. */
+    iv: string;
+};
+type DecryptionOptions = {
+    ciphertext: string;
+    salt: string;
+    iv: string;
+    password: string;
+};
+declare function deriveKey(password: string, salt: Uint8Array, iterations?: number): Promise<CryptoKey>;
+declare function encrypt(plaintext: string, password: string): Promise<EncryptionResult>;
+declare function decrypt(options: DecryptionOptions): Promise<string>;
+declare function encryptBackupData(data: unknown, password: string): Promise<{
+    secret: string;
+    iv: string;
+    salt: string;
+}>;
+declare function decryptBackupData(encrypted: {
+    secret?: string;
+    data?: string;
+    iv: string;
+    salt: string;
+}, password: string): Promise<unknown>;
+declare function validatePasswordStrength(password: string): {
+    valid: boolean;
+    message?: string;
+};
+
+export { type BackupAccountV2, type BackupAddressPermissions, type BackupController, type BackupFile, type BackupNetwork, type BackupSecretEntry, type BackupSecrets, type BackupSecretsData, type DecryptionOptions, type EncryptedSecretsData, type EncryptionResult, type ExportBackupOptions, type LSP23DeploymentData, type LegacyBackupController, type WalletData, backupFilename, decrypt, decryptBackupData, deriveKey, downloadBackup, encrypt, encryptBackupData, exportBackup, extractWalletData, importBackup, parseBackup, readBackupFile, validateBackup, validatePasswordStrength };

package/dist/index.js

@@ -0,0 +1,467 @@
+// src/encryption.ts
+var PBKDF2_ITERATIONS = 1e5;
+var SALT_LENGTH = 16;
+var IV_LENGTH = 12;
+var KEY_LENGTH = 256;
+function arrayBufferToBase64(buffer) {
+  const bytes = new Uint8Array(buffer);
+  let binary = "";
+  for (let i = 0; i < bytes.length; i++) {
+    binary += String.fromCharCode(bytes[i]);
+  }
+  return btoa(binary);
+}
+function base64ToArrayBuffer(base64) {
+  const binary = atob(base64);
+  const bytes = new Uint8Array(binary.length);
+  for (let i = 0; i < binary.length; i++) {
+    bytes[i] = binary.charCodeAt(i);
+  }
+  return bytes.buffer;
+}
+function generateSalt() {
+  return crypto.getRandomValues(new Uint8Array(SALT_LENGTH));
+}
+function generateIV() {
+  return crypto.getRandomValues(new Uint8Array(IV_LENGTH));
+}
+async function deriveKey(password, salt, iterations = PBKDF2_ITERATIONS) {
+  const passwordBuffer = new TextEncoder().encode(password);
+  const keyMaterial = await crypto.subtle.importKey(
+    "raw",
+    passwordBuffer,
+    "PBKDF2",
+    false,
+    ["deriveBits", "deriveKey"]
+  );
+  return crypto.subtle.deriveKey(
+    {
+      name: "PBKDF2",
+      salt,
+      iterations,
+      hash: "SHA-256"
+    },
+    keyMaterial,
+    { name: "AES-GCM", length: KEY_LENGTH },
+    false,
+    ["encrypt", "decrypt"]
+  );
+}
+async function encrypt(plaintext, password) {
+  const salt = generateSalt();
+  const iv = generateIV();
+  const key = await deriveKey(password, salt);
+  const ciphertextBuffer = await crypto.subtle.encrypt(
+    { name: "AES-GCM", iv },
+    key,
+    new TextEncoder().encode(plaintext)
+  );
+  return {
+    ciphertext: arrayBufferToBase64(ciphertextBuffer),
+    salt: arrayBufferToBase64(salt.buffer),
+    iv: arrayBufferToBase64(iv.buffer)
+  };
+}
+async function decrypt(options) {
+  const { ciphertext, salt, iv, password } = options;
+  const saltBuffer = new Uint8Array(base64ToArrayBuffer(salt));
+  const ivBuffer = new Uint8Array(base64ToArrayBuffer(iv));
+  const ciphertextBuffer = base64ToArrayBuffer(ciphertext);
+  const key = await deriveKey(password, saltBuffer);
+  try {
+    const plaintextBuffer = await crypto.subtle.decrypt(
+      { name: "AES-GCM", iv: ivBuffer },
+      key,
+      ciphertextBuffer
+    );
+    return new TextDecoder().decode(plaintextBuffer);
+  } catch {
+    throw new Error("Decryption failed: incorrect password or corrupted data");
+  }
+}
+async function encryptBackupData(data, password) {
+  const plaintext = JSON.stringify(data);
+  const result = await encrypt(plaintext, password);
+  return { secret: result.ciphertext, iv: result.iv, salt: result.salt };
+}
+async function decryptBackupData(encrypted, password) {
+  const ciphertext = encrypted.secret ?? encrypted.data;
+  if (!ciphertext) {
+    throw new Error(
+      'Missing encrypted data: expected either "secret" or "data" field'
+    );
+  }
+  const plaintext = await decrypt({
+    ciphertext,
+    salt: encrypted.salt,
+    iv: encrypted.iv,
+    password
+  });
+  return JSON.parse(plaintext);
+}
+function validatePasswordStrength(password) {
+  if (password.length < 8) {
+    return {
+      valid: false,
+      message: "Password must be at least 8 characters long"
+    };
+  }
+  if (password.length > 128) {
+    return {
+      valid: false,
+      message: "Password must be less than 128 characters long"
+    };
+  }
+  if (!/\d/.test(password)) {
+    return {
+      valid: false,
+      message: "Password must contain at least one number"
+    };
+  }
+  if (!/[a-zA-Z]/.test(password)) {
+    return {
+      valid: false,
+      message: "Password must contain at least one letter"
+    };
+  }
+  return { valid: true };
+}
+
+// src/backup.ts
+function validateBackup(backup) {
+  if (!backup || typeof backup !== "object") {
+    throw new Error("Invalid backup file: not an object");
+  }
+  const b = backup;
+  if (typeof b.version !== "number") {
+    throw new Error("Invalid backup file: missing or invalid version");
+  }
+  if (b.version !== 2) {
+    throw new Error(
+      `Unsupported backup version: ${b.version}. Only version 2 is supported.`
+    );
+  }
+  if (typeof b.backupDate !== "string") {
+    throw new Error("Invalid backup file: missing or invalid backupDate");
+  }
+  if (!Array.isArray(b.accounts)) {
+    throw new Error("Invalid backup file: accounts must be an array");
+  }
+  for (const account of b.accounts) {
+    if (account?.type && account.type !== "LSP0-ERC725Account") {
+      throw new Error(
+        "Invalid backup file: account must be of type LSP0-ERC725Account"
+      );
+    }
+    if (account?.type && "networks" in account && account.networks) {
+      if (!account.address || typeof account.address !== "string") {
+        throw new Error("Invalid backup file: account missing address");
+      }
+      if (!Array.isArray(account.networks)) {
+        throw new Error(
+          "Invalid backup file: account.networks must be an array"
+        );
+      }
+    }
+  }
+  if (b.LSP23CrossChainDeployment) {
+    if (!Array.isArray(b.LSP23CrossChainDeployment)) {
+      throw new Error(
+        "Invalid backup file: LSP23CrossChainDeployment must be an array"
+      );
+    }
+    for (const d of b.LSP23CrossChainDeployment) {
+      if (!d.profileAddress || typeof d.profileAddress !== "string") {
+        throw new Error("Invalid LSP23 deployment: missing profileAddress");
+      }
+      if (typeof d.initialChainID !== "number") {
+        throw new Error("Invalid LSP23 deployment: missing initialChainID");
+      }
+      if (!d.factoryAddress || typeof d.factoryAddress !== "string") {
+        throw new Error("Invalid LSP23 deployment: missing factoryAddress");
+      }
+      if (!d.deploymentCalldata || typeof d.deploymentCalldata !== "string") {
+        throw new Error("Invalid LSP23 deployment: missing deploymentCalldata");
+      }
+      if (!Array.isArray(d.initialControllers)) {
+        throw new Error(
+          "Invalid LSP23 deployment: initialControllers must be an array"
+        );
+      }
+    }
+  }
+  const hasCurrent = b.secrets && typeof b.secrets === "object";
+  const hasLegacy = b.encryptedSecrets && typeof b.encryptedSecrets === "object";
+  if (!hasCurrent && !hasLegacy) {
+    throw new Error(
+      "Invalid backup file: missing secrets or encryptedSecrets section"
+    );
+  }
+  if (hasCurrent && hasLegacy) {
+    throw new Error(
+      "Invalid backup file: contains both secrets and encryptedSecrets sections"
+    );
+  }
+  if (hasCurrent && b.secrets?.encrypted) {
+    const d = b.secrets.data;
+    if (!d.secret || !d.iv || !d.salt) {
+      throw new Error(
+        "Invalid backup file: encrypted secrets missing required fields"
+      );
+    }
+  }
+  if (hasLegacy) {
+    const e = b.encryptedSecrets;
+    if (!e?.secrets || typeof e.secrets !== "object") {
+      throw new Error(
+        "Invalid backup file: encryptedSecrets.secrets is required"
+      );
+    }
+    if (!e.secrets.data)
+      throw new Error(
+        "Invalid backup file: encryptedSecrets.secrets.data is required"
+      );
+    if (!e.secrets.iv)
+      throw new Error(
+        "Invalid backup file: encryptedSecrets.secrets.iv is required"
+      );
+    if (!e.secrets.salt)
+      throw new Error(
+        "Invalid backup file: encryptedSecrets.secrets.salt is required"
+      );
+  }
+  return true;
+}
+function extractWalletData(backup, isImport = false) {
+  if (backup.encryptedSecrets) {
+    throw new Error(
+      "Cannot extract wallet data from legacy encrypted backup. Decrypt first."
+    );
+  }
+  if (!backup.secrets || backup.secrets.encrypted) {
+    throw new Error(
+      "Cannot extract wallet data from encrypted backup. Decrypt first."
+    );
+  }
+  const secretsData = backup.secrets.data;
+  if (!Array.isArray(secretsData) || secretsData.length === 0) {
+    throw new Error(
+      "This backup file appears to be empty or corrupted. No wallet data was found."
+    );
+  }
+  let mnemonicSecret = secretsData.find(
+    (s) => s.type === "mnemonic" || s.index === 0 && (s.mnemonic || s.entropy) || s.mnemonicIndex === 0 && (s.mnemonic || s.entropy)
+  );
+  if (!mnemonicSecret) {
+    const privateKeyWithMnemonicIndex = secretsData.find(
+      (s) => s.type === "privateKey" && s.mnemonicIndex !== void 0
+    );
+    if (privateKeyWithMnemonicIndex) {
+      mnemonicSecret = secretsData.find(
+        (s) => s.index === privateKeyWithMnemonicIndex.mnemonicIndex && (s.mnemonic || s.entropy)
+      );
+    }
+  }
+  if (!mnemonicSecret) {
+    const hasPrivateKeys = secretsData.some(
+      (s) => s.type === "privateKey" && s.secret && s.address
+    );
+    const hasReferencesToMnemonic = secretsData.some(
+      (s) => s.mnemonicIndex !== void 0
+    );
+    if (hasPrivateKeys && !hasReferencesToMnemonic && isImport) {
+      const firstPrivateKey = secretsData.find(
+        (s) => s.type === "privateKey" && s.secret && s.address
+      );
+      if (firstPrivateKey) {
+        return {
+          mnemonic: "",
+          entropy: "",
+          privateKey: firstPrivateKey.secret,
+          address: firstPrivateKey.address,
+          metadata: {
+            createdAt: backup.backupDate ?? (/* @__PURE__ */ new Date()).toISOString(),
+            network: "mainnet",
+            derivationPath: firstPrivateKey.derivationPath
+          }
+        };
+      }
+    }
+    const context = isImport ? "import into existing wallet" : "restore as new wallet";
+    const requirement = isImport ? "For imports, use backup files with mnemonic/entropy or contact support." : "For wallet restore, a mnemonic or entropy is required.";
+    throw new Error(
+      `This backup file cannot be used to ${context}. The wallet recovery information (mnemonic or entropy) is missing. ${requirement}`
+    );
+  }
+  if (!mnemonicSecret.secret || !mnemonicSecret.address) {
+    throw new Error(
+      "This backup file is missing critical wallet information. The file may be corrupted or incomplete."
+    );
+  }
+  const { mnemonic, entropy } = mnemonicSecret;
+  if (!mnemonic && !entropy) {
+    throw new Error(
+      "This backup file is not compatible with this application. The wallet recovery information (mnemonic or entropy) is missing."
+    );
+  }
+  if (!mnemonic || !entropy) {
+    throw new Error(
+      "This backup file is missing either mnemonic or entropy. Both should be present in the backup."
+    );
+  }
+  return {
+    mnemonic,
+    entropy,
+    privateKey: mnemonicSecret.secret,
+    address: mnemonicSecret.address,
+    metadata: {
+      createdAt: backup.backupDate ?? (/* @__PURE__ */ new Date()).toISOString(),
+      network: "mainnet",
+      derivationPath: mnemonicSecret.derivationPath
+    }
+  };
+}
+async function exportBackup(options) {
+  const {
+    privateKey,
+    address,
+    password,
+    profileAddress,
+    chainId,
+    profileName
+  } = options;
+  const secretEntry = {
+    type: "privateKey",
+    index: 0,
+    address,
+    secret: privateKey
+    // mnemonicIndex intentionally omitted — this is a standalone key,
+    // not derived from a mnemonic we hold.
+  };
+  let secrets;
+  if (password) {
+    const encrypted = await encryptBackupData([secretEntry], password);
+    secrets = {
+      encrypted: true,
+      encryptionType: "Key from PBKDF2. Encrypted with AES-GCM.",
+      data: encrypted
+    };
+  } else {
+    secrets = { encrypted: false, data: [secretEntry] };
+  }
+  const accounts = [];
+  if (profileAddress && chainId !== void 0) {
+    accounts.push({
+      type: "LSP0-ERC725Account",
+      name: profileName,
+      address: profileAddress,
+      networks: [
+        { chainID: chainId, name: `chain-${chainId}`, controllers: [] }
+      ]
+    });
+  }
+  return {
+    version: 2,
+    backupDate: (/* @__PURE__ */ new Date()).toISOString(),
+    accounts,
+    secrets
+  };
+}
+function backupFilename(backup) {
+  const timestamp = (/* @__PURE__ */ new Date()).toISOString().replace(/[:.]/g, "-").slice(0, -5);
+  return backup.secrets?.encrypted ? `lukso-wallet-backup-${timestamp}.json` : `lukso-wallet-backup-${timestamp}-plaintext.json`;
+}
+function downloadBackup(backup, filename) {
+  if (typeof document === "undefined" || typeof URL === "undefined") {
+    throw new Error(
+      "downloadBackup: requires a browser environment (document + URL)."
+    );
+  }
+  const json = JSON.stringify(backup, null, 2);
+  const blob = new Blob([json], { type: "application/json" });
+  const url = URL.createObjectURL(blob);
+  const a = document.createElement("a");
+  a.href = url;
+  a.download = filename ?? backupFilename(backup);
+  document.body.appendChild(a);
+  a.click();
+  document.body.removeChild(a);
+  URL.revokeObjectURL(url);
+}
+function parseBackup(json) {
+  let parsed;
+  try {
+    parsed = JSON.parse(json);
+  } catch (err) {
+    throw new Error(
+      `Failed to parse backup file: ${err instanceof Error ? err.message : String(err)}`
+    );
+  }
+  validateBackup(parsed);
+  return parsed;
+}
+async function readBackupFile(file) {
+  return new Promise((resolve, reject) => {
+    const reader = new FileReader();
+    reader.onload = (event) => {
+      try {
+        const text = event.target?.result;
+        resolve(parseBackup(text));
+      } catch (err) {
+        reject(
+          err instanceof Error ? err : new Error(`Failed to parse backup file: ${String(err)}`)
+        );
+      }
+    };
+    reader.onerror = () => reject(new Error("Failed to read backup file"));
+    reader.readAsText(file);
+  });
+}
+async function importBackup(backup, password, isImport = false) {
+  validateBackup(backup);
+  let decryptedSecretsData;
+  if (backup.encryptedSecrets) {
+    if (!password) throw new Error("Password required for encrypted backup");
+    decryptedSecretsData = await decryptBackupData(
+      {
+        secret: backup.encryptedSecrets.secrets.data,
+        iv: backup.encryptedSecrets.secrets.iv,
+        salt: backup.encryptedSecrets.secrets.salt
+      },
+      password
+    );
+  } else if (backup.secrets) {
+    if (backup.secrets.encrypted) {
+      if (!password) throw new Error("Password required for encrypted backup");
+      decryptedSecretsData = await decryptBackupData(
+        backup.secrets.data,
+        password
+      );
+    } else {
+      decryptedSecretsData = backup.secrets.data;
+    }
+  } else {
+    throw new Error("Invalid backup format: no secrets found");
+  }
+  const tempBackup = {
+    ...backup,
+    secrets: { encrypted: false, data: decryptedSecretsData }
+  };
+  return extractWalletData(tempBackup, isImport);
+}
+export {
+  backupFilename,
+  decrypt,
+  decryptBackupData,
+  deriveKey,
+  downloadBackup,
+  encrypt,
+  encryptBackupData,
+  exportBackup,
+  extractWalletData,
+  importBackup,
+  parseBackup,
+  readBackupFile,
+  validateBackup,
+  validatePasswordStrength
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@universal-everything/sdk-core-backup",
+  "version": "1.0.0-dev.04bf615",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/universal-everything/universal-relayer.git",
+    "directory": "packages/sdk-core-backup"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^26.2.0",
+    "typescript": "^5.7.0",
+    "vitest": "^4.1.10",
+    "tsup": "^8.5.0"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "build": "tsup"
+  }
+}