@opendatalabs/vana-sdk 0.1.0-alpha.8eb4e46 → 0.1.0-alpha.a145c3c

package/dist/platform.browser.d.ts

@@ -3,6 +3,15 @@
  *
  * This interface abstracts all environment-specific dependencies to ensure
  * the SDK works seamlessly across Node.js and browser/SSR environments.
+ *
+ * **Implementation Context:**
+ * - Node.js: Uses native crypto modules and full OpenPGP support
+ * - Browser: Uses Web Crypto API and browser-compatible libraries
+ * - SSR: Automatically selects appropriate implementation based on runtime
+ *
+ * **Usage Notes:**
+ * Platform adapters are automatically selected by the SDK. Direct usage is only
+ * needed for custom implementations or testing.
  */
 /**
  * Platform type identifier
@@ -15,6 +24,11 @@ interface VanaCryptoAdapter {
     /**
      * Encrypt data with a public key using asymmetric cryptography
      *
+     * **Usage Context:**
+     * - Used internally for file encryption before storage
+     * - Public key format: Armored PGP public key string
+     * - Returns base64-encoded encrypted data
+     *
      * @param data The data to encrypt
      * @param publicKey The public key for encryption
      * @returns Promise resolving to encrypted data
@@ -41,6 +55,11 @@ interface VanaCryptoAdapter {
      * Encrypt data with a wallet's public key using ECDH cryptography
      * Uses platform-appropriate ECDH implementation (eccrypto vs eccrypto-js)
      *
+     * **Usage Context:**
+     * - Used for sharing encryption keys with permission recipients
+     * - Public key format: Compressed or uncompressed secp256k1 hex string
+     * - Compatible with Ethereum wallet public keys
+     *
      * @param data The data to encrypt (string)
      * @param publicKey The wallet's public key (secp256k1)
      * @returns Promise resolving to encrypted data as hex string
@@ -127,6 +146,22 @@ interface VanaHttpAdapter {
 }
 /**
  * Main platform adapter interface that combines all platform-specific functionality
+ *
+ * **Implementation Guidelines:**
+ * 1. All methods must maintain consistent behavior across platforms
+ * 2. Error types and messages should be unified
+ * 3. Data formats (encoding, serialization) must be identical
+ * 4. Performance characteristics can vary but API must be consistent
+ *
+ * **Custom Implementation Example:**
+ * ```typescript
+ * class CustomPlatformAdapter implements VanaPlatformAdapter {
+ *   crypto = new CustomCryptoAdapter();
+ *   pgp = new CustomPGPAdapter();
+ *   http = new CustomHttpAdapter();
+ *   platform = 'browser' as const;
+ * }
+ * ```
  */
 interface VanaPlatformAdapter {
     /**

package/dist/platform.node.d.cts

@@ -3,6 +3,15 @@
  *
  * This interface abstracts all environment-specific dependencies to ensure
  * the SDK works seamlessly across Node.js and browser/SSR environments.
+ *
+ * **Implementation Context:**
+ * - Node.js: Uses native crypto modules and full OpenPGP support
+ * - Browser: Uses Web Crypto API and browser-compatible libraries
+ * - SSR: Automatically selects appropriate implementation based on runtime
+ *
+ * **Usage Notes:**
+ * Platform adapters are automatically selected by the SDK. Direct usage is only
+ * needed for custom implementations or testing.
  */
 /**
  * Platform type identifier
@@ -15,6 +24,11 @@ interface VanaCryptoAdapter {
     /**
      * Encrypt data with a public key using asymmetric cryptography
      *
+     * **Usage Context:**
+     * - Used internally for file encryption before storage
+     * - Public key format: Armored PGP public key string
+     * - Returns base64-encoded encrypted data
+     *
      * @param data The data to encrypt
      * @param publicKey The public key for encryption
      * @returns Promise resolving to encrypted data
@@ -41,6 +55,11 @@ interface VanaCryptoAdapter {
      * Encrypt data with a wallet's public key using ECDH cryptography
      * Uses platform-appropriate ECDH implementation (eccrypto vs eccrypto-js)
      *
+     * **Usage Context:**
+     * - Used for sharing encryption keys with permission recipients
+     * - Public key format: Compressed or uncompressed secp256k1 hex string
+     * - Compatible with Ethereum wallet public keys
+     *
      * @param data The data to encrypt (string)
      * @param publicKey The wallet's public key (secp256k1)
      * @returns Promise resolving to encrypted data as hex string
@@ -127,6 +146,22 @@ interface VanaHttpAdapter {
 }
 /**
  * Main platform adapter interface that combines all platform-specific functionality
+ *
+ * **Implementation Guidelines:**
+ * 1. All methods must maintain consistent behavior across platforms
+ * 2. Error types and messages should be unified
+ * 3. Data formats (encoding, serialization) must be identical
+ * 4. Performance characteristics can vary but API must be consistent
+ *
+ * **Custom Implementation Example:**
+ * ```typescript
+ * class CustomPlatformAdapter implements VanaPlatformAdapter {
+ *   crypto = new CustomCryptoAdapter();
+ *   pgp = new CustomPGPAdapter();
+ *   http = new CustomHttpAdapter();
+ *   platform = 'browser' as const;
+ * }
+ * ```
  */
 interface VanaPlatformAdapter {
     /**

package/dist/platform.node.d.ts

@@ -3,6 +3,15 @@
  *
  * This interface abstracts all environment-specific dependencies to ensure
  * the SDK works seamlessly across Node.js and browser/SSR environments.
+ *
+ * **Implementation Context:**
+ * - Node.js: Uses native crypto modules and full OpenPGP support
+ * - Browser: Uses Web Crypto API and browser-compatible libraries
+ * - SSR: Automatically selects appropriate implementation based on runtime
+ *
+ * **Usage Notes:**
+ * Platform adapters are automatically selected by the SDK. Direct usage is only
+ * needed for custom implementations or testing.
  */
 /**
  * Platform type identifier
@@ -15,6 +24,11 @@ interface VanaCryptoAdapter {
     /**
      * Encrypt data with a public key using asymmetric cryptography
      *
+     * **Usage Context:**
+     * - Used internally for file encryption before storage
+     * - Public key format: Armored PGP public key string
+     * - Returns base64-encoded encrypted data
+     *
      * @param data The data to encrypt
      * @param publicKey The public key for encryption
      * @returns Promise resolving to encrypted data
@@ -41,6 +55,11 @@ interface VanaCryptoAdapter {
      * Encrypt data with a wallet's public key using ECDH cryptography
      * Uses platform-appropriate ECDH implementation (eccrypto vs eccrypto-js)
      *
+     * **Usage Context:**
+     * - Used for sharing encryption keys with permission recipients
+     * - Public key format: Compressed or uncompressed secp256k1 hex string
+     * - Compatible with Ethereum wallet public keys
+     *
      * @param data The data to encrypt (string)
      * @param publicKey The wallet's public key (secp256k1)
      * @returns Promise resolving to encrypted data as hex string
@@ -127,6 +146,22 @@ interface VanaHttpAdapter {
 }
 /**
  * Main platform adapter interface that combines all platform-specific functionality
+ *
+ * **Implementation Guidelines:**
+ * 1. All methods must maintain consistent behavior across platforms
+ * 2. Error types and messages should be unified
+ * 3. Data formats (encoding, serialization) must be identical
+ * 4. Performance characteristics can vary but API must be consistent
+ *
+ * **Custom Implementation Example:**
+ * ```typescript
+ * class CustomPlatformAdapter implements VanaPlatformAdapter {
+ *   crypto = new CustomCryptoAdapter();
+ *   pgp = new CustomPGPAdapter();
+ *   http = new CustomHttpAdapter();
+ *   platform = 'browser' as const;
+ * }
+ * ```
  */
 interface VanaPlatformAdapter {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opendatalabs/vana-sdk",
-  "version": "0.1.0-alpha.8eb4e46",
+  "version": "0.1.0-alpha.a145c3c",
   "description": "A TypeScript library for interacting with Vana Network smart contracts.",
   "publishConfig": {
     "access": "public"