cilantro-sdk 0.0.4 → 0.0.6

package/README.md

@@ -83,6 +83,73 @@ configure({ apiKey: 'your-api-key' });
 const result = await sendSOL('wallet-id', { ... });
 ```
 
+## Helpers Module (Device Keys & Signer Management)
+
+The SDK includes a comprehensive helpers module for device key management and signer operations with automatic caching. This simplifies working with email/phone signers and eliminates manual key management.
+
+### Quick Example
+
+```typescript
+import { 
+  createEmailSignerHelper,
+  getEmailSignerKeypair,
+  createLocalStorageAdapter 
+} from 'cilantro-sdk/helpers';
+
+// Create storage for device keys
+const storage = createLocalStorageAdapter();
+
+// Create email signer (device key generated automatically)
+const signer = await createEmailSignerHelper('wallet-id', {
+  email: 'user@example.com',
+  deviceKeyManager: storage
+});
+
+// Get keypair (automatically cached)
+const keypair = await getEmailSignerKeypair(
+  'wallet-id',
+  signer.signerId,
+  { deviceKeyManager: storage }
+);
+```
+
+### Key Features
+
+- ✅ **Unified API** - Single interface for all key and signer operations
+- ✅ **Automatic Caching** - Keypair derivation is cached to avoid redundant operations
+- ✅ **Cross-Platform** - Works in browser and Node.js
+- ✅ **Storage Adapters** - localStorage, filesystem, or memory storage
+- ✅ **Type-Safe** - Full TypeScript support
+- ✅ **Functional** - No classes, pure functions
+
+### Available Helpers
+
+**Device Key Management:**
+- `getDevicePublicKey()` - Get or create device key with caching
+- `generateDeviceKeyPair()` - Generate new device key pair
+- `rotateDeviceKey()` - Rotate device keys
+- `clearDeviceKeyCache()` - Clear cache
+
+**Email Signer Helpers:**
+- `createEmailSignerHelper()` - Create email signer with auto key management
+- `getEmailSignerKeypair()` - Get keypair with caching
+- `signWithEmailSigner()` - Sign messages
+- `clearEmailSignerCache()` - Clear cache
+
+**Phone Signer Helpers:**
+- `createPhoneSignerHelper()` - Create phone signer with auto key management
+- `getPhoneSignerKeypair()` - Get keypair with caching
+- `signWithPhoneSigner()` - Sign messages
+- `clearPhoneSignerCache()` - Clear cache
+
+**Storage Adapters:**
+- `createLocalStorageAdapter()` - Browser localStorage
+- `createFileSystemAdapter(path)` - Node.js filesystem
+- `createMemoryAdapter()` - In-memory (temporary)
+- `getDefaultStorageAdapter()` - Auto-detect environment
+
+For complete documentation, see [HELPERS_README.md](./HELPERS_README.md).
+
 ## Configuration
 
 ### SDK Configuration Functions