@opendatalabs/vana-sdk 0.1.0-alpha.db07fe1 → 0.1.0-alpha.dba79a3

package/dist/index.browser.d.ts

@@ -0,0 +1,153 @@
+/**
+ * @module Browser
+ * Browser-specific implementation of the Vana SDK
+ */
+import { VanaCore } from "./core";
+import type { VanaConfig, VanaConfigWithStorage, StorageRequiredMarker } from "./types";
+/**
+ * Internal implementation class for browser environments.
+ * This class is not exported directly - use the Vana factory function instead.
+ */
+declare class VanaBrowserImpl extends VanaCore {
+    constructor(config: VanaConfig);
+}
+/**
+ * Creates a new Vana SDK instance configured for browser environments.
+ *
+ * @remarks
+ * This is the primary entry point for browser applications using the Vana SDK. The function
+ * automatically detects your configuration type and provides compile-time type safety:
+ * - **With storage configured**: All methods including file upload/download are available
+ * - **Without storage**: Storage-dependent methods throw runtime errors and are excluded from TypeScript
+ *
+ * The SDK supports multiple wallet configurations (direct WalletClient or chain config),
+ * various storage providers (IPFS, Pinata, Google Drive), and gasless transactions via relayers.
+ * All operations are optimized for browser environments with proper bundle size optimization.
+ *
+ * @param config - Configuration object containing wallet, storage, and relayer settings
+ * @returns A fully configured Vana SDK instance for browser use
+ * @throws {InvalidConfigurationError} When configuration parameters are invalid or missing
+ * @example
+ * ```typescript
+ * import { Vana } from '@opendatalabs/vana-sdk/browser';
+ * import { createWalletClient, custom } from 'viem';
+ * import { IPFSStorage } from '@opendatalabs/vana-sdk/browser';
+ *
+ * // Complete setup with storage and wallet
+ * const walletClient = createWalletClient({
+ *   chain: mokshaTestnet,
+ *   transport: custom(window.ethereum)
+ * });
+ *
+ * const vana = Vana({
+ *   walletClient,
+ *   storage: {
+ *     providers: {
+ *       ipfs: new IPFSStorage({ gateway: 'https://gateway.pinata.cloud' }),
+ *       pinata: new PinataStorage({ apiKey: process.env.PINATA_KEY })
+ *     },
+ *     defaultProvider: 'ipfs'
+ *   },
+ *   relayerCallbacks: {
+ *     async submitPermissionGrant(typedData, signature) {
+ *       const response = await fetch('/api/relay/grant', {
+ *         method: 'POST',
+ *         body: JSON.stringify({ typedData, signature })
+ *       });
+ *       return (await response.json()).transactionHash;
+ *     }
+ *   }
+ * });
+ *
+ * // All operations now available
+ * const files = await vana.data.getUserFiles();
+ * const permissions = await vana.permissions.getUserPermissions();
+ * await vana.data.upload({ content: 'My data', filename: 'data.txt' });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Minimal setup without storage (read-only operations)
+ * const vanaReadOnly = Vana({ walletClient });
+ *
+ * // These work without storage
+ * const files = await vanaReadOnly.data.getUserFiles();
+ * const permissions = await vanaReadOnly.permissions.getUserPermissions();
+ *
+ * // This would throw a runtime error
+ * // await vanaReadOnly.data.upload(params); // ❌ InvalidConfigurationError
+ *
+ * // Safe runtime check
+ * if (vanaReadOnly.isStorageEnabled()) {
+ *   await vanaReadOnly.data.upload(params); // ✅ TypeScript allows this
+ * } else {
+ *   console.log('Storage not configured - upload unavailable');
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using chain configuration instead of wallet client
+ * const vana = Vana({
+ *   chainId: 14800, // Moksha testnet
+ *   account: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',
+ *   rpcUrl: 'https://rpc.moksha.vana.org',
+ *   storage: {
+ *     providers: { ipfs: new IPFSStorage() },
+ *     defaultProvider: 'ipfs'
+ *   }
+ * });
+ * ```
+ *
+ * @see {@link https://docs.vana.org/docs/sdk/getting-started | Getting Started Guide} for setup tutorials
+ * @see {@link VanaCore} for the underlying implementation details
+ * @category Core SDK
+ */
+export declare function Vana(config: VanaConfigWithStorage): VanaBrowserImpl & StorageRequiredMarker;
+export declare function Vana(config: VanaConfig): VanaBrowserImpl;
+/**
+ * The type of a Vana SDK instance in browser environments.
+ * Uses InstanceType to properly expose all public methods from the class hierarchy.
+ *
+ * @see {@link Vana}
+ */
+export type VanaInstance = InstanceType<typeof VanaBrowserImpl>;
+export default Vana;
+export { VanaCore, VanaCoreFactory } from "./core";
+export type * from "./types";
+export { isReplicateAPIResponse, isAPIResponse, safeParseJSON, parseReplicateOutput, } from "./types/external-apis";
+export type { VanaContract } from "./generated/abi";
+export * from "./errors";
+export { PermissionsController } from "./controllers/permissions";
+export { DataController } from "./controllers/data";
+export { ServerController } from "./controllers/server";
+export { ProtocolController } from "./controllers/protocol";
+export { SchemaController } from "./controllers/schemas";
+export { OperationsController } from "./controllers/operations";
+export * from "./contracts/contractController";
+export * from "./utils/encryption";
+export * from "./utils/formatters";
+export * from "./utils/grantFiles";
+export * from "./utils/grantValidation";
+export * from "./utils/grants";
+export * from "./utils/ipfs";
+export * from "./utils/schemaValidation";
+export * from "./utils/signatureCache";
+export type { Operation, TransactionResult, TransactionReceipt, PollingOptions, TransactionWaitOptions, } from "./types/operations";
+export * from "./storage";
+export { getContractAddress } from "./config/addresses";
+export { chains } from "./config/chains";
+export { type ServiceEndpoints, mainnetServices, mokshaServices, getServiceEndpoints, getDefaultPersonalServerUrl, } from "./config/default-services";
+export { vanaMainnet, mokshaTestnet, moksha, type VanaChainConfig, getChainConfig, getAllChains, } from "./chains";
+export * from "./chains";
+export { getAbi } from "./generated/abi";
+export type { VanaContract as VanaContractAbi } from "./generated/abi";
+export { BaseController, RetryUtility, RateLimiter, MemoryCache, EventEmitter, MiddlewarePipeline, AsyncQueue, CircuitBreaker, } from "./core/generics";
+export { BrowserPlatformAdapter } from "./platform/browser";
+export { BrowserECIESUint8Provider as BrowserECIESProvider } from "./crypto/ecies/browser";
+export type { VanaPlatformAdapter } from "./platform/interface";
+export { createBrowserPlatformAdapter, createPlatformAdapterSafe, } from "./platform/browser-only";
+export { detectPlatform, isPlatformSupported, getPlatformCapabilities, } from "./platform/utils";
+export { ApiClient } from "./core/apiClient";
+export type { ApiClientConfig, HttpMethod, RequestOptions, } from "./core/apiClient";
+export { VanaBrowserImpl };

package/dist/index.browser.js

@@ -0,0 +1,120 @@
+import { BrowserPlatformAdapter } from "./platform/browser";
+import { VanaCore } from "./core";
+class VanaBrowserImpl extends VanaCore {
+  constructor(config) {
+    super(new BrowserPlatformAdapter(), config);
+  }
+}
+function Vana(config) {
+  return new VanaBrowserImpl(config);
+}
+var index_browser_default = Vana;
+import { VanaCore as VanaCore2, VanaCoreFactory } from "./core";
+import {
+  isReplicateAPIResponse,
+  isAPIResponse,
+  safeParseJSON,
+  parseReplicateOutput
+} from "./types/external-apis";
+export * from "./errors";
+import { PermissionsController } from "./controllers/permissions";
+import { DataController } from "./controllers/data";
+import { ServerController } from "./controllers/server";
+import { ProtocolController } from "./controllers/protocol";
+import { SchemaController } from "./controllers/schemas";
+import { OperationsController } from "./controllers/operations";
+export * from "./contracts/contractController";
+export * from "./utils/encryption";
+export * from "./utils/formatters";
+export * from "./utils/grantFiles";
+export * from "./utils/grantValidation";
+export * from "./utils/grants";
+export * from "./utils/ipfs";
+export * from "./utils/schemaValidation";
+export * from "./utils/signatureCache";
+export * from "./storage";
+import { getContractAddress } from "./config/addresses";
+import { chains } from "./config/chains";
+import {
+  mainnetServices,
+  mokshaServices,
+  getServiceEndpoints,
+  getDefaultPersonalServerUrl
+} from "./config/default-services";
+import {
+  vanaMainnet,
+  mokshaTestnet,
+  moksha,
+  getChainConfig,
+  getAllChains
+} from "./chains";
+export * from "./chains";
+import { getAbi } from "./generated/abi";
+import {
+  BaseController,
+  RetryUtility,
+  RateLimiter,
+  MemoryCache,
+  EventEmitter,
+  MiddlewarePipeline,
+  AsyncQueue,
+  CircuitBreaker
+} from "./core/generics";
+import { BrowserPlatformAdapter as BrowserPlatformAdapter2 } from "./platform/browser";
+import { BrowserECIESUint8Provider } from "./crypto/ecies/browser";
+import {
+  createBrowserPlatformAdapter,
+  createPlatformAdapterSafe
+} from "./platform/browser-only";
+import {
+  detectPlatform,
+  isPlatformSupported,
+  getPlatformCapabilities
+} from "./platform/utils";
+import { ApiClient } from "./core/apiClient";
+export {
+  ApiClient,
+  AsyncQueue,
+  BaseController,
+  BrowserECIESUint8Provider as BrowserECIESProvider,
+  BrowserPlatformAdapter2 as BrowserPlatformAdapter,
+  CircuitBreaker,
+  DataController,
+  EventEmitter,
+  MemoryCache,
+  MiddlewarePipeline,
+  OperationsController,
+  PermissionsController,
+  ProtocolController,
+  RateLimiter,
+  RetryUtility,
+  SchemaController,
+  ServerController,
+  Vana,
+  VanaBrowserImpl,
+  VanaCore2 as VanaCore,
+  VanaCoreFactory,
+  chains,
+  createBrowserPlatformAdapter,
+  createPlatformAdapterSafe,
+  index_browser_default as default,
+  detectPlatform,
+  getAbi,
+  getAllChains,
+  getChainConfig,
+  getContractAddress,
+  getDefaultPersonalServerUrl,
+  getPlatformCapabilities,
+  getServiceEndpoints,
+  isAPIResponse,
+  isPlatformSupported,
+  isReplicateAPIResponse,
+  mainnetServices,
+  moksha,
+  mokshaServices,
+  mokshaTestnet,
+  parseReplicateOutput,
+  safeParseJSON,
+  vanaMainnet
+};
+//# sourceMappingURL=index.browser.js.map

package/dist/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.browser.ts"],"sourcesContent":["/**\n * @module Browser\n * Browser-specific implementation of the Vana SDK\n */\n\nimport { BrowserPlatformAdapter } from \"./platform/browser\";\nimport { VanaCore } from \"./core\";\nimport type {\n  VanaConfig,\n  VanaConfigWithStorage,\n  StorageRequiredMarker,\n} from \"./types\";\n\n/**\n * Internal implementation class for browser environments.\n * This class is not exported directly - use the Vana factory function instead.\n */\nclass VanaBrowserImpl extends VanaCore {\n  constructor(config: VanaConfig) {\n    super(new BrowserPlatformAdapter(), config);\n  }\n}\n\n/**\n * Creates a new Vana SDK instance configured for browser environments.\n *\n * @remarks\n * This is the primary entry point for browser applications using the Vana SDK. The function\n * automatically detects your configuration type and provides compile-time type safety:\n * - **With storage configured**: All methods including file upload/download are available\n * - **Without storage**: Storage-dependent methods throw runtime errors and are excluded from TypeScript\n *\n * The SDK supports multiple wallet configurations (direct WalletClient or chain config),\n * various storage providers (IPFS, Pinata, Google Drive), and gasless transactions via relayers.\n * All operations are optimized for browser environments with proper bundle size optimization.\n *\n * @param config - Configuration object containing wallet, storage, and relayer settings\n * @returns A fully configured Vana SDK instance for browser use\n * @throws {InvalidConfigurationError} When configuration parameters are invalid or missing\n * @example\n * ```typescript\n * import { Vana } from '@opendatalabs/vana-sdk/browser';\n * import { createWalletClient, custom } from 'viem';\n * import { IPFSStorage } from '@opendatalabs/vana-sdk/browser';\n *\n * // Complete setup with storage and wallet\n * const walletClient = createWalletClient({\n *   chain: mokshaTestnet,\n *   transport: custom(window.ethereum)\n * });\n *\n * const vana = Vana({\n *   walletClient,\n *   storage: {\n *     providers: {\n *       ipfs: new IPFSStorage({ gateway: 'https://gateway.pinata.cloud' }),\n *       pinata: new PinataStorage({ apiKey: process.env.PINATA_KEY })\n *     },\n *     defaultProvider: 'ipfs'\n *   },\n *   relayerCallbacks: {\n *     async submitPermissionGrant(typedData, signature) {\n *       const response = await fetch('/api/relay/grant', {\n *         method: 'POST',\n *         body: JSON.stringify({ typedData, signature })\n *       });\n *       return (await response.json()).transactionHash;\n *     }\n *   }\n * });\n *\n * // All operations now available\n * const files = await vana.data.getUserFiles();\n * const permissions = await vana.permissions.getUserPermissions();\n * await vana.data.upload({ content: 'My data', filename: 'data.txt' });\n * ```\n *\n * @example\n * ```typescript\n * // Minimal setup without storage (read-only operations)\n * const vanaReadOnly = Vana({ walletClient });\n *\n * // These work without storage\n * const files = await vanaReadOnly.data.getUserFiles();\n * const permissions = await vanaReadOnly.permissions.getUserPermissions();\n *\n * // This would throw a runtime error\n * // await vanaReadOnly.data.upload(params); // ❌ InvalidConfigurationError\n *\n * // Safe runtime check\n * if (vanaReadOnly.isStorageEnabled()) {\n *   await vanaReadOnly.data.upload(params); // ✅ TypeScript allows this\n * } else {\n *   console.log('Storage not configured - upload unavailable');\n * }\n * ```\n *\n * @example\n * ```typescript\n * // Using chain configuration instead of wallet client\n * const vana = Vana({\n *   chainId: 14800, // Moksha testnet\n *   account: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',\n *   rpcUrl: 'https://rpc.moksha.vana.org',\n *   storage: {\n *     providers: { ipfs: new IPFSStorage() },\n *     defaultProvider: 'ipfs'\n *   }\n * });\n * ```\n *\n * @see {@link https://docs.vana.org/docs/sdk/getting-started | Getting Started Guide} for setup tutorials\n * @see {@link VanaCore} for the underlying implementation details\n * @category Core SDK\n */\nexport function Vana(\n  config: VanaConfigWithStorage,\n): VanaBrowserImpl & StorageRequiredMarker;\nexport function Vana(config: VanaConfig): VanaBrowserImpl;\n/**\n * Creates a new Vana SDK instance.\n *\n * @param config - The configuration for the Vana SDK\n * @returns A new Vana SDK instance\n */\nexport function Vana(config: VanaConfig) {\n  return new VanaBrowserImpl(config);\n}\n\n/**\n * The type of a Vana SDK instance in browser environments.\n * Uses InstanceType to properly expose all public methods from the class hierarchy.\n *\n * @see {@link Vana}\n */\nexport type VanaInstance = InstanceType<typeof VanaBrowserImpl>;\n\n// Export as default export\nexport default Vana;\n\n// Re-export everything that was in index.ts (avoiding circular dependency)\n// Core class and factory\nexport { VanaCore, VanaCoreFactory } from \"./core\";\n\n// Types - modular exports\nexport type * from \"./types\";\n\n// Type guards and utilities\nexport {\n  isReplicateAPIResponse,\n  isAPIResponse,\n  safeParseJSON,\n  parseReplicateOutput,\n} from \"./types/external-apis\";\n\n// VanaContract is exported from abi to avoid circular dependencies\nexport type { VanaContract } from \"./generated/abi\";\n\n// Error classes\nexport * from \"./errors\";\n\n// Controllers\nexport { PermissionsController } from \"./controllers/permissions\";\nexport { DataController } from \"./controllers/data\";\nexport { ServerController } from \"./controllers/server\";\nexport { ProtocolController } from \"./controllers/protocol\";\nexport { SchemaController } from \"./controllers/schemas\";\nexport { OperationsController } from \"./controllers/operations\";\n\n// Contract controller\nexport * from \"./contracts/contractController\";\n\n// Utilities\nexport * from \"./utils/encryption\";\nexport * from \"./utils/formatters\";\nexport * from \"./utils/grantFiles\";\nexport * from \"./utils/grantValidation\";\nexport * from \"./utils/grants\";\nexport * from \"./utils/ipfs\";\nexport * from \"./utils/schemaValidation\";\nexport * from \"./utils/signatureCache\";\n// TransactionHandle removed - using POJOs instead\nexport type {\n  Operation,\n  TransactionResult,\n  TransactionReceipt,\n  PollingOptions,\n  TransactionWaitOptions,\n} from \"./types/operations\";\n\n// Storage API\nexport * from \"./storage\";\n\n// Configuration\nexport { getContractAddress } from \"./config/addresses\";\nexport { chains } from \"./config/chains\";\nexport {\n  type ServiceEndpoints,\n  mainnetServices,\n  mokshaServices,\n  getServiceEndpoints,\n  getDefaultPersonalServerUrl,\n} from \"./config/default-services\";\n\n// Chain configurations with subgraph URLs - explicit exports for better DX\nexport {\n  vanaMainnet,\n  mokshaTestnet,\n  moksha,\n  type VanaChainConfig,\n  getChainConfig,\n  getAllChains,\n} from \"./chains\";\nexport * from \"./chains\";\n\n// ABIs\nexport { getAbi } from \"./generated/abi\";\nexport type { VanaContract as VanaContractAbi } from \"./generated/abi\";\n\n// Generic utilities for extensibility\nexport {\n  BaseController,\n  RetryUtility,\n  RateLimiter,\n  MemoryCache,\n  EventEmitter,\n  MiddlewarePipeline,\n  AsyncQueue,\n  CircuitBreaker,\n} from \"./core/generics\";\n\n// Platform adapters - browser-safe exports\nexport { BrowserPlatformAdapter } from \"./platform/browser\";\nexport { BrowserECIESUint8Provider as BrowserECIESProvider } from \"./crypto/ecies/browser\";\nexport type { VanaPlatformAdapter } from \"./platform/interface\";\n\n// Browser-only platform adapter utilities\nexport {\n  createBrowserPlatformAdapter,\n  createPlatformAdapterSafe,\n} from \"./platform/browser-only\";\n\n// Note: createNodePlatformAdapter is not exported in browser bundle to avoid Node.js dependencies\n\n// NodePlatformAdapter is available through dynamic import to avoid bundling Node.js dependencies\n// Use createNodePlatformAdapter() for dynamic import\n\n// Platform utilities - browser-safe only\nexport {\n  detectPlatform,\n  isPlatformSupported,\n  getPlatformCapabilities,\n} from \"./platform/utils\";\n\nexport { ApiClient } from \"./core/apiClient\";\n\nexport type {\n  ApiClientConfig,\n  HttpMethod,\n  RequestOptions,\n} from \"./core/apiClient\";\n\n// Note: Default export is already handled above with the Vana factory function\n\n// For testing purposes, we also export the implementation class\nexport { VanaBrowserImpl };\n"],"mappings":"AAKA,SAAS,8BAA8B;AACvC,SAAS,gBAAgB;AAWzB,MAAM,wBAAwB,SAAS;AAAA,EACrC,YAAY,QAAoB;AAC9B,UAAM,IAAI,uBAAuB,GAAG,MAAM;AAAA,EAC5C;AACF;AAwGO,SAAS,KAAK,QAAoB;AACvC,SAAO,IAAI,gBAAgB,MAAM;AACnC;AAWA,IAAO,wBAAQ;AAIf,SAAS,YAAAA,WAAU,uBAAuB;AAM1C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAMP,cAAc;AAGd,SAAS,6BAA6B;AACtC,SAAS,sBAAsB;AAC/B,SAAS,wBAAwB;AACjC,SAAS,0BAA0B;AACnC,SAAS,wBAAwB;AACjC,SAAS,4BAA4B;AAGrC,cAAc;AAGd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AAWd,cAAc;AAGd,SAAS,0BAA0B;AACnC,SAAS,cAAc;AACvB;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAGP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EAEA;AAAA,EACA;AAAA,OACK;AACP,cAAc;AAGd,SAAS,cAAc;AAIvB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAGP,SAAS,0BAAAC,+BAA8B;AACvC,SAAsC,iCAA4B;AAIlE;AAAA,EACE;AAAA,EACA;AAAA,OACK;AAQP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,iBAAiB;","names":["VanaCore","BrowserPlatformAdapter"]}

package/dist/index.cjs

@@ -0,0 +1,5 @@
+"use strict";
+throw new Error(
+  'Import from "@opendatalabs/vana-sdk/browser" or "@opendatalabs/vana-sdk/node" instead of the root entry point.'
+);
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * Main entry point for the Vana SDK.\n *\n * @remarks\n * This module prevents accidental imports from the root package path and\n * ensures developers explicitly choose the correct platform-specific build.\n * The SDK requires platform-specific implementations for cryptography,\n * storage, and networking operations.\n *\n * **DO NOT import from this module directly.**\n *\n * Instead, use one of the platform-specific entry points:\n * - `@opendatalabs/vana-sdk/browser` for web applications\n * - `@opendatalabs/vana-sdk/node` for Node.js applications\n *\n * @example\n * ```typescript\n * // ❌ WRONG - This will throw an error\n * import { something } from '@opendatalabs/vana-sdk';\n *\n * // ✅ CORRECT - For browser/web applications\n * import { BrowserPlatformAdapter } from '@opendatalabs/vana-sdk/browser';\n *\n * // ✅ CORRECT - For Node.js applications\n * import { NodePlatformAdapter } from '@opendatalabs/vana-sdk/node';\n * ```\n *\n * @throws {Error} Always throws an error directing to use platform-specific imports\n *\n * @category Core\n * @module index\n */\nthrow new Error(\n  'Import from \"@opendatalabs/vana-sdk/browser\" or \"@opendatalabs/vana-sdk/node\" instead of the root entry point.',\n);\n"],"mappings":";AAgCA,MAAM,IAAI;AAAA,EACR;AACF;","names":[]}

package/dist/index.js

@@ -0,0 +1,4 @@
+throw new Error(
+  'Import from "@opendatalabs/vana-sdk/browser" or "@opendatalabs/vana-sdk/node" instead of the root entry point.'
+);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * Main entry point for the Vana SDK.\n *\n * @remarks\n * This module prevents accidental imports from the root package path and\n * ensures developers explicitly choose the correct platform-specific build.\n * The SDK requires platform-specific implementations for cryptography,\n * storage, and networking operations.\n *\n * **DO NOT import from this module directly.**\n *\n * Instead, use one of the platform-specific entry points:\n * - `@opendatalabs/vana-sdk/browser` for web applications\n * - `@opendatalabs/vana-sdk/node` for Node.js applications\n *\n * @example\n * ```typescript\n * // ❌ WRONG - This will throw an error\n * import { something } from '@opendatalabs/vana-sdk';\n *\n * // ✅ CORRECT - For browser/web applications\n * import { BrowserPlatformAdapter } from '@opendatalabs/vana-sdk/browser';\n *\n * // ✅ CORRECT - For Node.js applications\n * import { NodePlatformAdapter } from '@opendatalabs/vana-sdk/node';\n * ```\n *\n * @throws {Error} Always throws an error directing to use platform-specific imports\n *\n * @category Core\n * @module index\n */\nthrow new Error(\n  'Import from \"@opendatalabs/vana-sdk/browser\" or \"@opendatalabs/vana-sdk/node\" instead of the root entry point.',\n);\n"],"mappings":"AAgCA,MAAM,IAAI;AAAA,EACR;AACF;","names":[]}

package/dist/index.node.cjs

@@ -0,0 +1,191 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var index_node_exports = {};
+__export(index_node_exports, {
+  ApiClient: () => import_apiClient.ApiClient,
+  AsyncQueue: () => import_generics.AsyncQueue,
+  BaseController: () => import_generics.BaseController,
+  BrowserPlatformAdapter: () => import_browser.BrowserPlatformAdapter,
+  CircuitBreaker: () => import_generics.CircuitBreaker,
+  DataController: () => import_data.DataController,
+  DistributedNonceManager: () => import_nonceManager.DistributedNonceManager,
+  EventEmitter: () => import_generics.EventEmitter,
+  InMemoryNonceManager: () => import_inMemoryNonceManager.InMemoryNonceManager,
+  MemoryCache: () => import_generics.MemoryCache,
+  MiddlewarePipeline: () => import_generics.MiddlewarePipeline,
+  NodePlatformAdapter: () => import_node2.NodePlatformAdapter,
+  OperationsController: () => import_operations.OperationsController,
+  PermissionsController: () => import_permissions.PermissionsController,
+  ProtocolController: () => import_protocol.ProtocolController,
+  RateLimiter: () => import_generics.RateLimiter,
+  RedisAtomicStore: () => import_redisAtomicStore.RedisAtomicStore,
+  RetryUtility: () => import_generics.RetryUtility,
+  SchemaController: () => import_schemas.SchemaController,
+  ServerController: () => import_server.ServerController,
+  SystemHealthChecker: () => import_health.SystemHealthChecker,
+  Vana: () => Vana,
+  VanaCore: () => import_core2.VanaCore,
+  VanaCoreFactory: () => import_core2.VanaCoreFactory,
+  VanaNodeImpl: () => VanaNodeImpl,
+  chains: () => import_chains.chains,
+  createBrowserPlatformAdapter: () => import_browser_safe.createBrowserPlatformAdapter,
+  createNodePlatformAdapter: () => import_browser_safe.createNodePlatformAdapter,
+  createPlatformAdapter: () => import_utils.createPlatformAdapter,
+  createPlatformAdapterFor: () => import_utils.createPlatformAdapterFor,
+  createPlatformAdapterSafe: () => import_browser_safe.createPlatformAdapterSafe,
+  default: () => index_node_default,
+  detectPlatform: () => import_utils.detectPlatform,
+  getAbi: () => import_abi.getAbi,
+  getAllChains: () => import_chains2.getAllChains,
+  getChainConfig: () => import_chains2.getChainConfig,
+  getContractAddress: () => import_addresses.getContractAddress,
+  getDefaultPersonalServerUrl: () => import_default_services.getDefaultPersonalServerUrl,
+  getPlatformCapabilities: () => import_utils.getPlatformCapabilities,
+  getServiceEndpoints: () => import_default_services.getServiceEndpoints,
+  handleRelayerOperation: () => import_relayerHandler.handleRelayerOperation,
+  isAPIResponse: () => import_external_apis.isAPIResponse,
+  isPlatformSupported: () => import_utils.isPlatformSupported,
+  isReplicateAPIResponse: () => import_external_apis.isReplicateAPIResponse,
+  mainnetServices: () => import_default_services.mainnetServices,
+  moksha: () => import_chains2.moksha,
+  mokshaServices: () => import_default_services.mokshaServices,
+  mokshaTestnet: () => import_chains2.mokshaTestnet,
+  parseReplicateOutput: () => import_external_apis.parseReplicateOutput,
+  safeParseJSON: () => import_external_apis.safeParseJSON,
+  vanaMainnet: () => import_chains2.vanaMainnet
+});
+module.exports = __toCommonJS(index_node_exports);
+var import_node = require("./platform/node");
+var import_core = require("./core");
+var import_core2 = require("./core");
+var import_nonceManager = require("./core/nonceManager");
+var import_inMemoryNonceManager = require("./core/inMemoryNonceManager");
+var import_health = require("./core/health");
+var import_redisAtomicStore = require("./lib/redisAtomicStore");
+var import_external_apis = require("./types/external-apis");
+__reExport(index_node_exports, require("./errors"), module.exports);
+var import_permissions = require("./controllers/permissions");
+var import_data = require("./controllers/data");
+var import_server = require("./controllers/server");
+var import_protocol = require("./controllers/protocol");
+var import_schemas = require("./controllers/schemas");
+var import_operations = require("./controllers/operations");
+__reExport(index_node_exports, require("./contracts/contractController"), module.exports);
+__reExport(index_node_exports, require("./utils/encryption"), module.exports);
+__reExport(index_node_exports, require("./utils/formatters"), module.exports);
+__reExport(index_node_exports, require("./utils/grantFiles"), module.exports);
+__reExport(index_node_exports, require("./utils/grantValidation"), module.exports);
+__reExport(index_node_exports, require("./utils/grants"), module.exports);
+__reExport(index_node_exports, require("./utils/ipfs"), module.exports);
+__reExport(index_node_exports, require("./utils/schemaValidation"), module.exports);
+__reExport(index_node_exports, require("./utils/signatureCache"), module.exports);
+__reExport(index_node_exports, require("./storage"), module.exports);
+var import_addresses = require("./config/addresses");
+var import_chains = require("./config/chains");
+var import_default_services = require("./config/default-services");
+var import_chains2 = require("./chains");
+__reExport(index_node_exports, require("./chains"), module.exports);
+var import_abi = require("./generated/abi");
+var import_generics = require("./core/generics");
+var import_relayerHandler = require("./server/relayerHandler");
+var import_node2 = require("./platform/node");
+var import_browser = require("./platform/browser");
+var import_utils = require("./platform/utils");
+var import_browser_safe = require("./platform/browser-safe");
+var import_apiClient = require("./core/apiClient");
+class VanaNodeImpl extends import_core.VanaCore {
+  operationStore;
+  atomicStore;
+  constructor(config) {
+    super(new import_node.NodePlatformAdapter(), config);
+    this.operationStore = config.operationStore;
+    this.atomicStore = config.atomicStore;
+  }
+}
+function Vana(config) {
+  return new VanaNodeImpl(config);
+}
+var index_node_default = Vana;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ApiClient,
+  AsyncQueue,
+  BaseController,
+  BrowserPlatformAdapter,
+  CircuitBreaker,
+  DataController,
+  DistributedNonceManager,
+  EventEmitter,
+  InMemoryNonceManager,
+  MemoryCache,
+  MiddlewarePipeline,
+  NodePlatformAdapter,
+  OperationsController,
+  PermissionsController,
+  ProtocolController,
+  RateLimiter,
+  RedisAtomicStore,
+  RetryUtility,
+  SchemaController,
+  ServerController,
+  SystemHealthChecker,
+  Vana,
+  VanaCore,
+  VanaCoreFactory,
+  VanaNodeImpl,
+  chains,
+  createBrowserPlatformAdapter,
+  createNodePlatformAdapter,
+  createPlatformAdapter,
+  createPlatformAdapterFor,
+  createPlatformAdapterSafe,
+  detectPlatform,
+  getAbi,
+  getAllChains,
+  getChainConfig,
+  getContractAddress,
+  getDefaultPersonalServerUrl,
+  getPlatformCapabilities,
+  getServiceEndpoints,
+  handleRelayerOperation,
+  isAPIResponse,
+  isPlatformSupported,
+  isReplicateAPIResponse,
+  mainnetServices,
+  moksha,
+  mokshaServices,
+  mokshaTestnet,
+  parseReplicateOutput,
+  safeParseJSON,
+  vanaMainnet,
+  ...require("./errors"),
+  ...require("./contracts/contractController"),
+  ...require("./utils/encryption"),
+  ...require("./utils/formatters"),
+  ...require("./utils/grantFiles"),
+  ...require("./utils/grantValidation"),
+  ...require("./utils/grants"),
+  ...require("./utils/ipfs"),
+  ...require("./utils/schemaValidation"),
+  ...require("./utils/signatureCache"),
+  ...require("./storage"),
+  ...require("./chains")
+});
+//# sourceMappingURL=index.node.cjs.map

package/dist/index.node.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.node.ts"],"sourcesContent":["/**\n * @module Node\n * Node.js-specific implementation of the Vana SDK\n */\n\nimport { NodePlatformAdapter } from \"./platform/node\";\nimport { VanaCore } from \"./core\";\nimport type {\n  VanaConfig,\n  VanaConfigWithStorage,\n  StorageRequiredMarker,\n  RelayerRequiredMarker,\n} from \"./types\";\nimport type {\n  IOperationStore,\n  IRelayerStateStore,\n} from \"./types/operationStore\";\nimport type { IAtomicStore } from \"./types/atomicStore\";\nimport type { PublicClient } from \"viem\";\n\n/**\n * Node.js-specific configuration interface with operation store support\n *\n * @category Configuration\n */\nexport type VanaNodeConfig = VanaConfig & {\n  operationStore?: IOperationStore | IRelayerStateStore; // Can be either type\n  atomicStore?: IAtomicStore;\n};\n\n/**\n * Node.js configuration with storage requirements\n *\n * @category Configuration\n */\nexport type VanaNodeConfigWithStorage = VanaConfigWithStorage & {\n  operationStore?: IOperationStore | IRelayerStateStore; // Can be either type\n  atomicStore?: IAtomicStore;\n};\n\n/**\n * Internal implementation class for Node.js environments.\n * This class is not exported directly - use the Vana factory function instead.\n */\nclass VanaNodeImpl extends VanaCore {\n  override readonly operationStore?: IOperationStore | IRelayerStateStore;\n  override readonly atomicStore?: IAtomicStore;\n\n  constructor(config: VanaNodeConfig) {\n    super(new NodePlatformAdapter(), config);\n    this.operationStore = config.operationStore;\n    this.atomicStore = config.atomicStore;\n  }\n}\n\n/**\n * Creates a new Vana SDK instance configured for Node.js environments.\n *\n * @remarks\n * This is the primary entry point for Node.js applications using the Vana SDK. The function\n * automatically detects your configuration type and provides compile-time type safety:\n * - **With storage configured**: All methods including file upload/download are available\n * - **Without storage**: Storage-dependent methods throw runtime errors and are excluded from TypeScript\n *\n * The Node.js version provides enhanced capabilities including native file system access,\n * server-side cryptographic operations, and support for personal server deployment.\n * It includes all browser capabilities plus Node.js-specific optimizations and utilities.\n *\n * @param config - Configuration object containing wallet, storage, and relayer settings\n * @returns A fully configured Vana SDK instance for Node.js use\n * @throws {InvalidConfigurationError} When configuration parameters are invalid or missing\n * @example\n * ```typescript\n * import { Vana } from '@opendatalabs/vana-sdk/node';\n * import { createWalletClient, http } from 'viem';\n * import { privateKeyToAccount } from 'viem/accounts';\n * import { IPFSStorage, PinataStorage } from '@opendatalabs/vana-sdk/node';\n * import { mokshaTestnet } from '@opendatalabs/vana-sdk/node';\n *\n * // Server setup with private key\n * const account = privateKeyToAccount('0x...');\n * const walletClient = createWalletClient({\n *   account,\n *   chain: mokshaTestnet,\n *   transport: http('https://rpc.moksha.vana.org')\n * });\n *\n * const vana = Vana({\n *   walletClient,\n *   storage: {\n *     providers: {\n *       ipfs: new IPFSStorage({\n *         gateway: 'https://gateway.pinata.cloud',\n *         timeout: 30000\n *       }),\n *       pinata: new PinataStorage({\n *         apiKey: process.env.PINATA_KEY,\n *         secretKey: process.env.PINATA_SECRET\n *       })\n *     },\n *     defaultProvider: 'pinata'\n *   },\n *   relayerCallbacks: {\n *     async submitPermissionGrant(typedData, signature) {\n *       // Server-side relayer implementation\n *       return await submitToCustomRelayer(typedData, signature);\n *     }\n *   }\n * });\n *\n * // Server operations\n * const uploadResult = await vana.data.upload({\n *   content: await fs.readFile('./user-data.json'),\n *   filename: 'user-data.json',\n *   schemaId: 1\n * });\n *\n * // Personal server setup\n * await vana.server.setupPersonalServer({\n *   serverUrl: 'https://my-server.example.com',\n *   capabilities: ['data_processing', 'ml_inference']\n * });\n * ```\n *\n * @example\n * ```typescript\n * // CLI tool or script usage\n * const vana = Vana({\n *   chainId: 14800, // Moksha testnet\n *   account: privateKeyToAccount(process.env.PRIVATE_KEY),\n *   rpcUrl: process.env.RPC_URL,\n *   storage: {\n *     providers: { ipfs: new IPFSStorage() },\n *     defaultProvider: 'ipfs'\n *   }\n * });\n *\n * // Batch operations for data processing\n * const userFiles = await vana.data.getUserFiles({\n *   owner: process.env.USER_ADDRESS\n * });\n *\n * for (const file of userFiles) {\n *   const decrypted = await vana.data.decryptFile(file);\n *   // Process file data...\n * }\n * ```\n *\n * @example\n * ```typescript\n * // Express.js server integration\n * import express from 'express';\n * import { handleRelayerOperation } from '@opendatalabs/vana-sdk/node';\n *\n * const app = express();\n *\n * app.post('/api/relay', async (req, res) => {\n *   try {\n *     const result = await handleRelayerOperation(\n *       vana,\n *       req.body\n *     );\n *     res.json(result);\n *   } catch (error) {\n *     res.status(500).json({ error: error.message });\n *   }\n * });\n * ```\n *\n * @see {@link https://docs.vana.org/docs/sdk/server-setup | Server Setup Guide} for Node.js-specific features\n * @see {@link VanaCore} for the underlying implementation details\n * @category Core SDK\n */\n// Overload 1: For configurations that include both storage and operation store\nexport function Vana(\n  config: VanaNodeConfigWithStorage & { operationStore: IOperationStore },\n): VanaNodeImpl & StorageRequiredMarker & RelayerRequiredMarker;\n\n// Overload 2: For configurations that include only the operation store\nexport function Vana(\n  config: VanaNodeConfig & { operationStore: IOperationStore },\n): VanaNodeImpl & RelayerRequiredMarker;\n\n// Overload 3: For configurations with storage but no operation store\nexport function Vana(\n  config: VanaNodeConfigWithStorage,\n): VanaNodeImpl & StorageRequiredMarker;\n\n// Overload 4: Base configuration without special requirements\nexport function Vana(config: VanaNodeConfig): VanaNodeImpl;\n\n// Implementation\nexport function Vana(config: VanaNodeConfig) {\n  return new VanaNodeImpl(config);\n}\n\n/**\n * The type of a Vana SDK instance in Node.js environments.\n * Uses InstanceType to properly expose all public methods from the class hierarchy.\n *\n * @see {@link Vana}\n */\nexport type VanaInstance = InstanceType<typeof VanaNodeImpl>;\n\n// Export as default export\nexport default Vana;\n\n// Re-export everything that was in index.ts (avoiding circular dependency)\n// Core class and factory\nexport { VanaCore, VanaCoreFactory } from \"./core\";\nexport { DistributedNonceManager } from \"./core/nonceManager\";\nexport { InMemoryNonceManager } from \"./core/inMemoryNonceManager\";\nexport { SystemHealthChecker } from \"./core/health\";\nexport type {\n  SystemHealthCheckerConfig,\n  HealthStatus,\n  ComponentHealth,\n  NonceHealth,\n  QueueHealth,\n} from \"./core/health\";\n\n// Storage implementations\nexport { RedisAtomicStore } from \"./lib/redisAtomicStore\";\nexport type { RedisAtomicStoreConfig } from \"./lib/redisAtomicStore\";\n\n// Types - modular exports\nexport type * from \"./types\";\nexport type { IAtomicStore } from \"./types/atomicStore\";\nexport type {\n  IOperationStore,\n  StoredOperation,\n  IRelayerStateStore,\n  OperationState,\n} from \"./types/operationStore\";\n\n// Type guards and utilities\nexport {\n  isReplicateAPIResponse,\n  isAPIResponse,\n  safeParseJSON,\n  parseReplicateOutput,\n} from \"./types/external-apis\";\n\n// VanaContract is exported from abi to avoid circular dependencies\nexport type { VanaContract } from \"./generated/abi\";\n\n// Error classes\nexport * from \"./errors\";\n\n// Controllers\nexport { PermissionsController } from \"./controllers/permissions\";\nexport { DataController } from \"./controllers/data\";\nexport { ServerController } from \"./controllers/server\";\nexport { ProtocolController } from \"./controllers/protocol\";\nexport { SchemaController } from \"./controllers/schemas\";\nexport { OperationsController } from \"./controllers/operations\";\n\n// Contract controller\nexport * from \"./contracts/contractController\";\n\n// Utilities\nexport * from \"./utils/encryption\";\nexport * from \"./utils/formatters\";\nexport * from \"./utils/grantFiles\";\nexport * from \"./utils/grantValidation\";\nexport * from \"./utils/grants\";\nexport * from \"./utils/ipfs\";\nexport * from \"./utils/schemaValidation\";\nexport * from \"./utils/signatureCache\";\n\n// Storage API\nexport * from \"./storage\";\n\n// Configuration\nexport { getContractAddress } from \"./config/addresses\";\nexport { chains } from \"./config/chains\";\nexport {\n  type ServiceEndpoints,\n  mainnetServices,\n  mokshaServices,\n  getServiceEndpoints,\n  getDefaultPersonalServerUrl,\n} from \"./config/default-services\";\n\n// Chain configurations with subgraph URLs - explicit exports for better DX\nexport {\n  vanaMainnet,\n  mokshaTestnet,\n  moksha,\n  type VanaChainConfig,\n  getChainConfig,\n  getAllChains,\n} from \"./chains\";\nexport * from \"./chains\";\n\n// ABIs\nexport { getAbi } from \"./generated/abi\";\nexport type { VanaContract as VanaContractAbi } from \"./generated/abi\";\n\n// Generic utilities for extensibility\nexport {\n  BaseController,\n  RetryUtility,\n  RateLimiter,\n  MemoryCache,\n  EventEmitter,\n  MiddlewarePipeline,\n  AsyncQueue,\n  CircuitBreaker,\n} from \"./core/generics\";\n\n// Server-side utilities\nexport {\n  handleRelayerOperation,\n  type RelayerOperationOptions,\n} from \"./server/relayerHandler\";\nexport type {\n  UnifiedRelayerRequest,\n  UnifiedRelayerResponse,\n} from \"./types/relayer\";\n// TransactionHandle removed - using POJOs instead\nexport type {\n  Operation,\n  TransactionResult,\n  TransactionReceipt,\n  PollingOptions,\n  TransactionWaitOptions,\n} from \"./types/operations\";\n\n// Platform adapters\nexport { NodePlatformAdapter } from \"./platform/node\";\nexport { BrowserPlatformAdapter } from \"./platform/browser\";\nexport type { VanaPlatformAdapter } from \"./platform/interface\";\n\n// Platform utilities\nexport {\n  detectPlatform,\n  createPlatformAdapter,\n  createPlatformAdapterFor,\n  isPlatformSupported,\n  getPlatformCapabilities,\n} from \"./platform/utils\";\n\n// Browser-safe platform utilities\nexport {\n  createNodePlatformAdapter,\n  createBrowserPlatformAdapter,\n  createPlatformAdapterSafe,\n} from \"./platform/browser-safe\";\n\nexport { ApiClient } from \"./core/apiClient\";\n\nexport type {\n  ApiClientConfig,\n  HttpMethod,\n  RequestOptions,\n} from \"./core/apiClient\";\n\n// Note: Default export is already handled above with the Vana factory function\n// For testing purposes, we also export the implementation class\nexport { VanaNodeImpl };\n\n// Server-specific interface for accessing stores\nexport interface VanaWithStores {\n  readonly operationStore?: IOperationStore | IRelayerStateStore;\n  readonly atomicStore?: IAtomicStore;\n  readonly publicClient: PublicClient;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,kBAAoC;AACpC,kBAAyB;AA2MzB,IAAAA,eAA0C;AAC1C,0BAAwC;AACxC,kCAAqC;AACrC,oBAAoC;AAUpC,8BAAiC;AAcjC,2BAKO;AAMP,+BAAc,qBAvPd;AA0PA,yBAAsC;AACtC,kBAA+B;AAC/B,oBAAiC;AACjC,sBAAmC;AACnC,qBAAiC;AACjC,wBAAqC;AAGrC,+BAAc,2CAlQd;AAqQA,+BAAc,+BArQd;AAsQA,+BAAc,+BAtQd;AAuQA,+BAAc,+BAvQd;AAwQA,+BAAc,oCAxQd;AAyQA,+BAAc,2BAzQd;AA0QA,+BAAc,yBA1Qd;AA2QA,+BAAc,qCA3Qd;AA4QA,+BAAc,mCA5Qd;AA+QA,+BAAc,sBA/Qd;AAkRA,uBAAmC;AACnC,oBAAuB;AACvB,8BAMO;AAGP,IAAAC,iBAOO;AACP,+BAAc,qBArSd;AAwSA,iBAAuB;AAIvB,sBASO;AAGP,4BAGO;AAeP,IAAAC,eAAoC;AACpC,qBAAuC;AAIvC,mBAMO;AAGP,0BAIO;AAEP,uBAA0B;AAlT1B,MAAM,qBAAqB,qBAAS;AAAA,EAChB;AAAA,EACA;AAAA,EAElB,YAAY,QAAwB;AAClC,UAAM,IAAI,gCAAoB,GAAG,MAAM;AACvC,SAAK,iBAAiB,OAAO;AAC7B,SAAK,cAAc,OAAO;AAAA,EAC5B;AACF;AA2IO,SAAS,KAAK,QAAwB;AAC3C,SAAO,IAAI,aAAa,MAAM;AAChC;AAWA,IAAO,qBAAQ;","names":["import_core","import_chains","import_node"]}