@lumiapassport/core 1.0.0

package/LICENSE

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

package/README.md

@@ -0,0 +1,112 @@
+# @lumiapassport/core
+
+Framework-agnostic core SDK for Lumia Passport smart accounts.
+
+## Features
+
+- ✅ **Zero React dependencies** - Works in Node.js, browser, and edge functions
+- ✅ **TypeScript-first** - Full type safety
+- ✅ **Modular** - Import only what you need
+- ✅ **Storage abstraction** - Works with localStorage, Redis, memory, or custom storage
+- ✅ **Account Abstraction** - Full ERC-4337 support
+- ✅ **MPC/TSS** - Secure key management
+
+## Installation
+
+```bash
+npm install @lumiapassport/core viem
+# or
+pnpm add @lumiapassport/core viem
+# or
+yarn add @lumiapassport/core viem
+```
+
+## Usage
+
+### Backend (Node.js)
+
+```typescript
+import { createLumiaPassportCore, MemoryStorage } from '@lumiapassport/core';
+
+const core = createLumiaPassportCore({
+  tssUrl: process.env.LUMIA_TSS_URL,
+  bundlerUrl: process.env.LUMIA_BUNDLER_URL,
+  chainId: 2030232745,
+  tokenStorage: new MemoryStorage(),
+  keyshareStorage: new MemoryStorage(),
+});
+
+// Create server wallet
+const account = await core.account.createAccountSession({
+  mpcUserId: 'server-wallet-001',
+  usePaymaster: true,
+});
+
+// Send transaction
+const hash = await core.account.sendUserOperation(
+  account,
+  '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+  '1000000000000000000' // 1 ETH in wei
+);
+```
+
+### Frontend (Browser)
+
+```typescript
+import { createLumiaPassportCore, LocalStorageAdapter } from '@lumiapassport/core';
+
+const core = createLumiaPassportCore({
+  tssUrl: import.meta.env.VITE_LUMIA_TSS_URL,
+  bundlerUrl: import.meta.env.VITE_LUMIA_BUNDLER_URL,
+  tokenStorage: new LocalStorageAdapter(),
+  keyshareStorage: new LocalStorageAdapter(),
+});
+
+// Prepare UserOperation
+const signedOp = await core.bundler.prepareUserOperation(params);
+
+// Send to backend
+await fetch('/api/submit', {
+  method: 'POST',
+  body: JSON.stringify({ userOp: signedOp }),
+});
+```
+
+### JWT Verification
+
+```typescript
+import { createLumiaPassportCore } from '@lumiapassport/core';
+
+const core = createLumiaPassportCore({ tssUrl: process.env.LUMIA_TSS_URL });
+
+// Verify token
+const verification = await core.auth.verifyToken(token);
+
+if (verification.valid) {
+  console.log('User ID:', verification.userId);
+}
+```
+
+## API
+
+### Modules
+
+- **bundler** - UserOperation management
+- **auth** - JWT token management and verification
+- **clients** - HTTP clients and account management
+- **mpc** - MPC/TSS operations
+- **utils** - Helper utilities
+
+### Storage Adapters
+
+- `MemoryStorage` - In-memory storage (server)
+- `LocalStorageAdapter` - Browser localStorage
+- Custom adapters via `TokenStorage` interface
+
+## Examples
+
+See [USAGE_EXAMPLES.md](../../USAGE_EXAMPLES.md) for comprehensive examples.
+
+## License
+
+MIT