w3pk 0.7.0 → 0.7.2

package/README.md

@@ -19,8 +19,8 @@ import { createWeb3Passkey } from 'w3pk'
 const w3pk = createWeb3Passkey()
 
 // Register (auto-generates wallet and stores it securely)
-const { mnemonic } = await w3pk.register({ username: 'alice' })
-console.log('⚠️  Save this recovery phrase:', mnemonic)
+const { address, username } = await w3pk.register({ username: 'alice' })
+console.log('✅ Registered:', username, 'with address:', address)
 
 // Login (for subsequent sessions)
 await w3pk.login()
@@ -46,26 +46,22 @@ const rpcUrl = endpoints[0]
 - 🌱 HD wallet generation (BIP39/BIP44)
 - 🔢 Multi-address derivation
 - 🥷 ERC-5564 stealth addresses (privacy-preserving transactions with view tags)
+- 🧮 ZK primitives (zero-knowledge proof generation and verification)
 - 🔗 Chainlist support (2390+ networks, auto-filtered RPC endpoints)
 - ⚡ EIP-7702 network detection (329+ supported networks)
-
-**Optional: Zero-Knowledge Proofs**
-
-Requires additional dependencies (~70MB):
-```bash
-npm install snarkjs circomlibjs
-```
-
-See [ZK Integration Guide](./docs/ZK_INTEGRATION_GUIDE.md) to get started.
+- 🛡️ Three-layer backup & recovery system
+  - Passkey auto-sync (iCloud/Google/Microsoft)
+  - Encrypted backups (ZIP/QR with password protection)
+  - Social recovery (Shamir Secret Sharing)
 
 ## API
 
 ### Authentication Flow
 
 ```typescript
-// Register (auto-stores wallet)
-const { mnemonic } = await w3pk.register({ username: 'alice' })
-// Returns: { mnemonic } - SAVE THIS!
+// Register (generates and stores wallet securely)
+const { address, username } = await w3pk.register({ username: 'alice' })
+// Returns: { address, username } 
 
 // Subsequent sessions: just login
 await w3pk.login()
@@ -78,12 +74,15 @@ w3pk.isAuthenticated
 w3pk.user
 ```
 
-**Advanced: Pre-generate wallet (optional)**
+**Important: Backup your wallet!**
 ```typescript
-// If you want to see the wallet before registering:
-const { mnemonic } = await w3pk.generateWallet()
-const { mnemonic } = await w3pk.register({ username: 'alice' })
-// register() will use the pre-generated wallet
+// After registration, users can create a backup
+const mnemonic = await w3pk.exportMnemonic({ requireAuth: true })
+console.log('⚠️  Save this recovery phrase:', mnemonic)
+
+// Or create encrypted backups:
+const zipBackup = await w3pk.createZipBackup('strong-password')
+const qrBackup = await w3pk.createQRBackup('optional-password')
 ```
 
 ### Wallet Operations
@@ -218,6 +217,63 @@ if (result.isForUser) {
 const myPayments = await w3pk.stealth?.scanAnnouncements(announcements)
 ```
 
+### Backup & Recovery
+
+```typescript
+import { isStrongPassword } from 'w3pk'
+
+// Validate password strength before creating backups
+const password = 'MyS3cur3!Password@2042'
+if (!isStrongPassword(password)) {
+  throw new Error('Password does not meet security requirements')
+}
+// Requirements: 12+ chars, uppercase, lowercase, number, special char, not common
+
+// Get backup status
+const status = await w3pk.getBackupStatus()
+console.log('Security Score:', status.securityScore.score) // 0-100
+
+// Create encrypted ZIP backup
+const blob = await w3pk.createZipBackup(password)
+// Save blob to file system
+
+// Create QR backup
+const { qrCodeDataURL } = await w3pk.createQRBackup('password')
+// Display QR code or save as image
+
+// Setup social recovery (3-of-5 guardians)
+await w3pk.setupSocialRecovery(
+  [
+    { name: 'Alice', email: 'alice@example.com' },
+    { name: 'Bob', phone: '+1234567890' },
+    { name: 'Charlie' }
+  ],
+  3 // threshold
+)
+
+// Generate guardian invite
+const invite = await w3pk.generateGuardianInvite(guardianId)
+// Share invite.qrCode or invite.shareCode with guardian
+
+// Recover from guardian shares
+const { mnemonic } = await w3pk.recoverFromGuardians([
+  share1, share2, share3
+])
+
+// Restore from backup
+await w3pk.restoreFromBackup(encryptedData, password)
+
+// Simulate recovery scenarios for testing
+const result = await w3pk.simulateRecoveryScenario({
+  type: 'lost-device',
+  hasBackup: true,
+  hasSocialRecovery: true
+})
+console.log('Can recover:', result.canRecover)
+```
+
+See [Recovery Guide](./docs/RECOVERY.md) for complete documentation.
+
 ## Browser Compatibility
 
 **Supported (95%+ of users):**
@@ -233,6 +289,7 @@ const myPayments = await w3pk.stealth?.scanAnnouncements(announcements)
 ## Documentation
 
 - [Quick Start Guide](./docs/QUICK_START.md) - Get started in 5 minutes
+- [Recovery & Backup System](./docs/RECOVERY.md) - Three-layer backup architecture
 - [Browser Compatibility](./docs/BROWSER_COMPATIBILITY.md) - Supported browsers, devices, and OS versions
 - [Security Architecture](./docs/SECURITY.md) - Integration best practices
 - [ERC-5564 Stealth Addresses](./docs/ERC5564_STEALTH_ADDRESSES.md) - Complete guide with examples