@opendatalabs/vana-sdk 0.1.0-alpha.5f8458e → 0.1.0-alpha.606fa2d

package/README.md

@@ -28,12 +28,19 @@ npm install viem@^2.31.7
 
 ## Quick Start
 
-The Vana SDK supports both browser and Node.js environments with explicit entry points:
+The Vana SDK provides optimized builds for different environments:
 
-### Browser Applications (React, Vue, etc.)
+| Build          | Use Case                          | Crypto Implementation              | Configuration     |
+| -------------- | --------------------------------- | ---------------------------------- | ----------------- |
+| **`/browser`** | Browser apps (React, Vue)         | Pure JavaScript (@noble/secp256k1) | **Zero config** ✓ |
+| **`/node`**    | Server-side (Node.js, API routes) | Native bindings (secp256k1)        | Zero config ✓     |
+
+### Browser Applications
+
+The browser build uses pure JavaScript cryptography and requires **no special configuration**:
 
 ```typescript
-// For browser-based applications (React, Vue, etc.)
+// Browser build - works out of the box with any bundler
 import { Vana, mokshaTestnet } from "@opendatalabs/vana-sdk/browser";
 import { createWalletClient, http } from "viem";
 import { privateKeyToAccount } from "viem/accounts";
@@ -53,7 +60,9 @@ const vana = Vana({
 });
 ```
 
-### Server-side Applications (Next.js API routes, Express)
+### Server-side Applications (Node.js)
+
+The Node.js build uses native secp256k1 bindings for optimal performance:
 
 ```typescript
 // For server-side applications (Next.js API routes, Express)
@@ -360,6 +369,48 @@ vana.data.validateDataAgainstSchema(data: unknown, schema: DataSchema): void
 - **Issues**: [GitHub Issues](https://github.com/vana-com/vana-sdk/issues)
 - **Discord**: [Join our community](https://discord.gg/vanabuilders)
 
+## Generated Code
+
+The SDK includes automatically generated code from various sources to provide type-safe interfaces. All generated files are located in `src/generated/` and should **never be edited manually**.
+
+### Code Generation Scripts
+
+| Script                       | Purpose                                | Generated Files             |
+| ---------------------------- | -------------------------------------- | --------------------------- |
+| `npm run fetch-abis`         | Smart contract ABIs from blockchain    | `src/generated/abi/*.ts`    |
+| `npm run fetch-server-types` | Personal server API types from OpenAPI | `src/generated/server/*.ts` |
+| `npm run codegen:subgraph`   | GraphQL types from subgraph schema     | `src/generated/subgraph.ts` |
+
+### Network-Specific Generation
+
+Some generation scripts support different networks:
+
+```bash
+# Generate subgraph types for different networks
+npm run codegen:subgraph:moksha   # Moksha testnet (default)
+npm run codegen:subgraph:mainnet  # Vana mainnet
+
+# Generate ABIs for different networks
+npm run fetch-abis moksha         # Moksha testnet (default)
+npm run fetch-abis mainnet        # Vana mainnet
+```
+
+### Development Workflow
+
+When working with the SDK:
+
+1. **Never edit generated files** - They are overwritten on regeneration
+2. **Regenerate after schema changes** - Run generation scripts when external schemas change
+3. **Generated files are committed** - They're included in version control for consistency
+4. **ESLint ignores generated code** - Style rules don't apply to generated files
+
+```bash
+# Regenerate all code after schema updates
+npm run fetch-abis
+npm run fetch-server-types
+npm run codegen:subgraph
+```
+
 ## Development
 
 ```bash

package/dist/{browser-cRpdLQ3-.d.ts → browser-Bb8gLWHp.d.ts}

@@ -216,22 +216,73 @@ interface VanaPlatformAdapter {
 }
 
 /**
- * Browser implementation of the Vana Platform Adapter
+ * Browser implementation of the Vana Platform Adapter using Uint8Array
  *
- * This implementation uses browser-compatible libraries and configurations
- * to provide crypto, PGP, and HTTP functionality without Node.js dependencies.
+ * This implementation uses browser-compatible libraries and native APIs
+ * without requiring Buffer or other Node.js polyfills.
  */
 
 /**
- * Complete browser platform adapter implementation
+ * Browser implementation of crypto operations using Uint8Array
+ */
+declare class BrowserCryptoAdapter implements VanaCryptoAdapter {
+    private eciesProvider;
+    private walletKeyEncryptionService;
+    encryptWithPublicKey(data: string, publicKeyHex: string): Promise<string>;
+    decryptWithPrivateKey(encryptedData: string, privateKeyHex: string): Promise<string>;
+    encryptWithWalletPublicKey(data: string, publicKey: string): Promise<string>;
+    decryptWithWalletPrivateKey(encryptedData: string, privateKey: string): Promise<string>;
+    generateKeyPair(): Promise<{
+        privateKey: string;
+        publicKey: string;
+    }>;
+    encryptWithPassword(data: Uint8Array, password: string): Promise<Uint8Array>;
+    decryptWithPassword(encryptedData: Uint8Array, password: string): Promise<Uint8Array>;
+}
+/**
+ * Browser implementation of PGP operations
+ */
+declare class BrowserPGPAdapter implements VanaPGPAdapter {
+    encrypt(data: string, publicKeyArmored: string): Promise<string>;
+    decrypt(encryptedData: string, privateKeyArmored: string): Promise<string>;
+    generateKeyPair(options?: {
+        name?: string;
+        email?: string;
+        passphrase?: string;
+    }): Promise<{
+        publicKey: string;
+        privateKey: string;
+    }>;
+}
+/**
+ * Browser implementation of HTTP operations using Fetch API
+ */
+declare class BrowserHttpAdapter implements VanaHttpAdapter {
+    fetch(url: string, options?: RequestInit): Promise<Response>;
+}
+/**
+ * Browser implementation of caching using sessionStorage for security
+ * SessionStorage is cleared when the tab closes, making it more secure for signature caching
+ */
+declare class BrowserCacheAdapter implements VanaCacheAdapter {
+    private readonly prefix;
+    get(key: string): string | null;
+    set(key: string, value: string): void;
+    delete(key: string): void;
+    clear(): void;
+}
+/**
+ * Browser implementation of the Vana Platform Adapter
+ *
+ * This adapter provides all platform-specific functionality for browser environments
+ * without requiring any Node.js polyfills.
  */
 declare class BrowserPlatformAdapter implements VanaPlatformAdapter {
-    crypto: VanaCryptoAdapter;
-    pgp: VanaPGPAdapter;
-    http: VanaHttpAdapter;
-    cache: VanaCacheAdapter;
-    platform: "browser";
-    constructor();
+    readonly crypto: BrowserCryptoAdapter;
+    readonly pgp: BrowserPGPAdapter;
+    readonly http: BrowserHttpAdapter;
+    readonly cache: BrowserCacheAdapter;
+    readonly platform: "browser";
 }
 
 export { BrowserPlatformAdapter as B, type PlatformType as P, type VanaPlatformAdapter as V };

package/dist/browser.d.ts

@@ -1 +1 @@
-export { B as BrowserPlatformAdapter } from './browser-cRpdLQ3-.js';
+export { B as BrowserPlatformAdapter } from './browser-Bb8gLWHp.js';