@opendatalabs/vana-sdk 0.1.0-alpha.f2de4f7 → 0.1.0-alpha.f35bb9c

package/dist/types/config.d.ts

@@ -1,7 +1,7 @@
-import type { WalletClient, PublicClient, Account, Hash, Address, Chain } from "viem";
+import type { WalletClient, PublicClient, Account, Address, Chain } from "viem";
 import type { VanaChainId, VanaChain } from "./chains";
 import type { StorageProvider, StorageUploadResult, StorageListOptions } from "./storage";
-import type { PermissionGrantTypedData, TrustServerTypedData, UntrustServerTypedData, AddAndTrustServerTypedData, GenericTypedData, GrantFile, ServerFilesAndPermissionTypedData } from "./permissions";
+import type { RelayerConfig } from "./relayer";
 /**
  * Marker interface to indicate that a Vana instance has storage configured.
  * Used for compile-time type safety to ensure storage-dependent methods
@@ -13,10 +13,12 @@ export interface StorageRequiredMarker {
     readonly __storageRequired: true;
 }
 /**
- * Configuration for storage providers used by the SDK.
+ * Configures storage providers for SDK file operations.
  *
- * Allows you to configure multiple storage backends (IPFS, Pinata, Google Drive, etc.)
- * and specify which one to use by default for file operations.
+ * @remarks
+ * Supports multiple backends with automatic fallback.
+ * IPFS for decentralization, Pinata for reliability,
+ * Google Drive for development, custom for flexibility.
  *
  * **Provider Selection:**
  * - IPFS: Decentralized, permanent storage ideal for production
@@ -30,7 +32,7 @@ export interface StorageRequiredMarker {
  * const storage: StorageConfig = {
  *   providers: {
  *     ipfs: new IPFSStorage({ gateway: 'https://gateway.pinata.cloud' }),
- *     pinata: new PinataStorage({ apiKey: 'your-key', secretKey: 'your-secret' })
+ *     pinata: new PinataStorage({ apiKey: 'key', secretKey: 'secret' })
  *   },
  *   defaultProvider: 'ipfs'
  * };
@@ -128,183 +130,6 @@ export interface DownloadRelayerCallbacks {
      */
     proxyDownload: (url: string) => Promise<Blob>;
 }
-/**
- * Relayer callback functions for handling gasless transactions.
- *
- * Instead of hardcoding HTTP/REST API calls, users can provide custom callback
- * functions to handle transaction relay in any way they choose (HTTP, WebSocket,
- * direct blockchain submission, etc.).
- *
- * @category Configuration
- * @example
- * ```typescript
- * const relayerCallbacks: RelayerCallbacks = {
- *   async submitPermissionGrant(typedData, signature) {
- *     // Custom implementation - could be HTTP, WebSocket, etc.
- *     const response = await fetch('https://my-relayer.com/api/grant', {
- *       method: 'POST',
- *       headers: { 'Content-Type': 'application/json' },
- *       body: JSON.stringify({ typedData, signature })
- *     });
- *     const result = await response.json();
- *     return result.transactionHash;
- *   },
- *
- *   async submitFileAddition(url, userAddress) {
- *     // Custom relay implementation
- *     return await myCustomRelayer.addFile(url, userAddress);
- *   }
- * };
- * ```
- */
-export interface RelayerCallbacks {
-    /**
-     * Submit a signed permission grant transaction for relay
-     *
-     * @param typedData - The EIP-712 typed data that was signed
-     * @param signature - The user's signature
-     * @returns Promise resolving to the transaction hash
-     */
-    submitPermissionGrant?: (typedData: PermissionGrantTypedData, signature: Hash) => Promise<Hash>;
-    /**
-     * Submit a signed permission revocation transaction for relay
-     *
-     * @param typedData - The EIP-712 typed data that was signed
-     * @param signature - The user's signature
-     * @returns Promise resolving to the transaction hash
-     */
-    submitPermissionRevoke?: (typedData: GenericTypedData, signature: Hash) => Promise<Hash>;
-    /**
-     * Submit a signed trust server transaction for relay
-     *
-     * @param typedData - The EIP-712 typed data that was signed
-     * @param signature - The user's signature
-     * @returns Promise resolving to the transaction hash
-     */
-    submitTrustServer?: (typedData: TrustServerTypedData, signature: Hash) => Promise<Hash>;
-    /**
-     * Submit a signed untrust server transaction for relay
-     *
-     * @param typedData - The EIP-712 typed data that was signed
-     * @param signature - The user's signature
-     * @returns Promise resolving to the transaction hash
-     */
-    submitUntrustServer?: (typedData: UntrustServerTypedData, signature: Hash) => Promise<Hash>;
-    /**
-     * Submit a signed add and trust server transaction for relay
-     *
-     * @param typedData - The EIP-712 typed data that was signed
-     * @param signature - The user's signature
-     * @returns Promise resolving to the transaction hash
-     */
-    submitAddAndTrustServer?: (typedData: AddAndTrustServerTypedData, signature: Hash) => Promise<Hash>;
-    /**
-     * Submit a signed permission addition transaction for relay
-     *
-     * @param typedData - The EIP-712 typed data that was signed
-     * @param signature - The user's signature
-     * @returns Promise resolving to the transaction hash
-     */
-    submitAddPermission?: (typedData: GenericTypedData, signature: Hash) => Promise<Hash>;
-    /**
-     * Submit a signed server files and permissions transaction for relay
-     *
-     * @param typedData - The EIP-712 typed data that was signed
-     * @param signature - The user's signature
-     * @returns Promise resolving to the transaction hash
-     */
-    submitAddServerFilesAndPermissions?: (typedData: ServerFilesAndPermissionTypedData, signature: Hash) => Promise<Hash>;
-    /**
-     * Submit a file addition for relay
-     *
-     * @deprecated Since v2.0.0 - Use submitFileAdditionComplete() instead for full support.
-     * Will be removed in v3.0.0.
-     *
-     * Migration guide:
-     * ```typescript
-     * // Old:
-     * await submitFileAddition(url, userAddress);
-     *
-     * // New:
-     * await submitFileAdditionComplete({
-     *   url,
-     *   userAddress,
-     *   permissions: [] // Optional
-     * });
-     * ```
-     * @param url - The file URL to register
-     * @param userAddress - The user's address
-     * @returns Promise resolving to object with fileId and transactionHash
-     */
-    submitFileAddition?: (url: string, userAddress: string) => Promise<{
-        fileId: number;
-        transactionHash: Hash;
-    }>;
-    /**
-     * Submit a file addition with permissions for relay
-     *
-     * @deprecated Since v2.0.0 - Use submitFileAdditionComplete() instead for full support.
-     * Will be removed in v3.0.0.
-     *
-     * Migration guide:
-     * ```typescript
-     * // Old:
-     * await submitFileAdditionWithPermissions(url, userAddress, permissions);
-     *
-     * // New:
-     * await submitFileAdditionComplete({
-     *   url,
-     *   userAddress,
-     *   permissions
-     * });
-     * ```
-     * @param url - The file URL to register
-     * @param userAddress - The user's address
-     * @param permissions - Array of encrypted permissions
-     * @returns Promise resolving to object with fileId and transactionHash
-     */
-    submitFileAdditionWithPermissions?: (url: string, userAddress: string, permissions: Array<{
-        account: string;
-        key: string;
-    }>) => Promise<{
-        fileId: number;
-        transactionHash: Hash;
-    }>;
-    /**
-     * Submit a comprehensive file addition with optional schema and permissions for relay
-     *
-     * This is the preferred callback that supports all file addition scenarios.
-     * It can handle files with schemas, permissions, or both.
-     *
-     * @param params - Complete parameters for file addition
-     * @param params.url - The file URL to register
-     * @param params.userAddress - The user's address (defaults to connected wallet if not specified)
-     * @param params.permissions - Array of encrypted permissions (empty array if none)
-     * @param params.schemaId - Schema ID for validation (0 if none)
-     * @param params.ownerAddress - Optional owner address (defaults to userAddress if not specified)
-     * @returns Promise resolving to object with fileId and transactionHash
-     */
-    submitFileAdditionComplete?: (params: {
-        url: string;
-        userAddress: Address;
-        permissions: Array<{
-            account: Address;
-            key: string;
-        }>;
-        schemaId: number;
-        ownerAddress?: Address;
-    }) => Promise<{
-        fileId: number;
-        transactionHash: Hash;
-    }>;
-    /**
-     * Store a grant file for relay (e.g., upload to IPFS)
-     *
-     * @param grantData - The grant file data
-     * @returns Promise resolving to the storage URL
-     */
-    storeGrantFile?: (grantData: GrantFile) => Promise<string>;
-}
 /**
  * Storage callback functions for flexible storage operations.
  *
@@ -427,10 +252,25 @@ export interface StorageListResult {
  */
 export interface BaseConfig {
     /**
-     * Optional relayer callback functions for handling gasless transactions.
-     * Provides flexible relay mechanism - can use HTTP, WebSocket, or any custom implementation.
+     * Optional relayer configuration for handling gasless transactions.
+     * Can be a URL string for convenience, or a callback for full control.
+     *
+     * @example
+     * ```typescript
+     * // Simple URL (SDK handles transport)
+     * relayer: '/api/relay'
+     *
+     * // Full control with callback
+     * relayer: async (request) => {
+     *   const response = await fetch('/api/relay', {
+     *     method: 'POST',
+     *     body: JSON.stringify(request)
+     *   });
+     *   return response.json();
+     * }
+     * ```
      */
-    relayerCallbacks?: RelayerCallbacks;
+    relayer?: RelayerConfig;
     /**
      * Optional download relayer for proxying CORS-restricted downloads.
      * Provides a proxy mechanism for files stored on servers with CORS restrictions.
@@ -473,10 +313,25 @@ export interface BaseConfig {
  */
 export interface BaseConfigWithStorage {
     /**
-     * Optional relayer callback functions for handling gasless transactions.
-     * Provides flexible relay mechanism - can use HTTP, WebSocket, or any custom implementation.
+     * Optional relayer configuration for handling gasless transactions.
+     * Can be a URL string for convenience, or a callback for full control.
+     *
+     * @example
+     * ```typescript
+     * // Simple URL (SDK handles transport)
+     * relayer: '/api/relay'
+     *
+     * // Full control with callback
+     * relayer: async (request) => {
+     *   const response = await fetch('/api/relay', {
+     *     method: 'POST',
+     *     body: JSON.stringify(request)
+     *   });
+     *   return response.json();
+     * }
+     * ```
      */
-    relayerCallbacks?: RelayerCallbacks;
+    relayer?: RelayerConfig;
     /**
      * Optional download relayer for proxying CORS-restricted downloads.
      * Provides a proxy mechanism for files stored on servers with CORS restrictions.
@@ -729,8 +584,8 @@ export interface RuntimeConfig {
     storageProviders: string[];
     /** Default storage provider */
     defaultStorageProvider?: string;
-    /** Current relayer callbacks configuration */
-    relayerCallbacks?: RelayerCallbacks;
+    /** Current relayer configuration */
+    relayerConfig?: RelayerConfig;
 }
 /**
  * Validates whether a configuration object has a wallet client (any wallet-based config).

package/dist/types/config.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/config.ts"],"sourcesContent":["import type {\n  WalletClient,\n  PublicClient,\n  Account,\n  Hash,\n  Address,\n  Chain,\n} from \"viem\";\nimport type { VanaChainId, VanaChain } from \"./chains\";\nimport type {\n  StorageProvider,\n  StorageUploadResult,\n  StorageListOptions,\n} from \"./storage\";\nimport type {\n  PermissionGrantTypedData,\n  TrustServerTypedData,\n  UntrustServerTypedData,\n  AddAndTrustServerTypedData,\n  GenericTypedData,\n  GrantFile,\n  ServerFilesAndPermissionTypedData,\n} from \"./permissions\";\n\n/**\n * Marker interface to indicate that a Vana instance has storage configured.\n * Used for compile-time type safety to ensure storage-dependent methods\n * are only called on properly configured instances.\n *\n * @category Configuration\n */\nexport interface StorageRequiredMarker {\n  readonly __storageRequired: true;\n}\n\n/**\n * Configuration for storage providers used by the SDK.\n *\n * Allows you to configure multiple storage backends (IPFS, Pinata, Google Drive, etc.)\n * and specify which one to use by default for file operations.\n *\n * **Provider Selection:**\n * - IPFS: Decentralized, permanent storage ideal for production\n * - Pinata: Managed IPFS with guaranteed availability\n * - Google Drive: Centralized, suitable for development/testing\n * - Custom providers: Implement StorageProvider interface\n *\n * @category Configuration\n * @example\n * ```typescript\n * const storage: StorageConfig = {\n *   providers: {\n *     ipfs: new IPFSStorage({ gateway: 'https://gateway.pinata.cloud' }),\n *     pinata: new PinataStorage({ apiKey: 'your-key', secretKey: 'your-secret' })\n *   },\n *   defaultProvider: 'ipfs'\n * };\n * ```\n */\nexport interface StorageConfig {\n  /**\n   * Map of provider name to storage provider instance.\n   *   Common provider names: \"ipfs\", \"pinata\", \"googledrive\", \"s3\".\n   *   Custom names allowed for custom provider implementations.\n   */\n  providers: Record<string, StorageProvider>;\n  /**\n   * Default provider name to use when none specified.\n   *   Must match a key in the providers map. Falls back to first provider if not specified.\n   */\n  defaultProvider?: string;\n}\n\n/**\n * Download relayer callbacks for proxying CORS-restricted downloads.\n *\n * Provides a callback to proxy download requests through your application server\n * when direct browser access fails due to CORS restrictions (e.g., Google Drive).\n *\n * IMPORTANT SECURITY REQUIREMENTS for your proxy endpoint:\n * 1. MUST block requests to private/internal IPs (SSRF protection)\n * 2. SHOULD NOT restrict domains (files can be hosted anywhere)\n *\n * @category Configuration\n * @example Client-side implementation:\n * ```typescript\n * const downloadRelayer: DownloadRelayerCallbacks = {\n *   async proxyDownload(url) {\n *     const response = await fetch('/api/proxy', {\n *       method: 'POST',\n *       headers: { 'Content-Type': 'application/json' },\n *       body: JSON.stringify({ url })\n *     });\n *     return response.blob();\n *   }\n * };\n * ```\n *\n * @example Server-side proxy endpoint (Next.js):\n * ```typescript\n * // /api/proxy/route.ts\n * import { promises as dns } from 'dns';\n * import { isIPv4 } from 'net';\n *\n * async function handleProxy(url: string) {\n *   const { hostname } = new URL(url);\n *\n *   // Resolve hostname to IP (handle localhost specially)\n *   const ip = hostname === 'localhost' ? '127.0.0.1' :\n *              isIPv4(hostname) ? hostname :\n *              await dns.lookup(hostname).then(r => r.address);\n *\n *   // SSRF Protection: Block private/internal IPs\n *   if (isIPv4(ip)) {\n *     const [a, b] = ip.split('.').map(Number);\n *     if (a === 10 || a === 127 || a === 0 ||\n *         (a === 172 && b >= 16 && b <= 31) ||\n *         (a === 192 && b === 168) ||\n *         (a === 169 && b === 254) ||\n *         a >= 224) { // Also block multicast/reserved\n *       return new Response('Private/internal addresses not allowed', { status: 403 });\n *     }\n *   }\n *\n *   // Proxy the request\n *   const response = await fetch(url, { redirect: 'manual' });\n *\n *   // Handle redirects (with recursion limit)\n *   if (response.status >= 301 && response.status <= 308) {\n *     const location = response.headers.get('location');\n *     if (location) return handleProxy(new URL(location, url).href);\n *   }\n *\n *   const data = await response.arrayBuffer();\n *   return new Response(data, {\n *     headers: {\n *       'Content-Type': response.headers.get('content-type') || 'application/octet-stream',\n *       'Access-Control-Allow-Origin': '*'\n *     }\n *   });\n * }\n * ```\n */\nexport interface DownloadRelayerCallbacks {\n  /**\n   * Proxy a download request through your application server\n   *\n   * @param url - The URL to download from\n   * @returns Promise resolving to the downloaded content as a Blob\n   */\n  proxyDownload: (url: string) => Promise<Blob>;\n}\n\n/**\n * Relayer callback functions for handling gasless transactions.\n *\n * Instead of hardcoding HTTP/REST API calls, users can provide custom callback\n * functions to handle transaction relay in any way they choose (HTTP, WebSocket,\n * direct blockchain submission, etc.).\n *\n * @category Configuration\n * @example\n * ```typescript\n * const relayerCallbacks: RelayerCallbacks = {\n *   async submitPermissionGrant(typedData, signature) {\n *     // Custom implementation - could be HTTP, WebSocket, etc.\n *     const response = await fetch('https://my-relayer.com/api/grant', {\n *       method: 'POST',\n *       headers: { 'Content-Type': 'application/json' },\n *       body: JSON.stringify({ typedData, signature })\n *     });\n *     const result = await response.json();\n *     return result.transactionHash;\n *   },\n *\n *   async submitFileAddition(url, userAddress) {\n *     // Custom relay implementation\n *     return await myCustomRelayer.addFile(url, userAddress);\n *   }\n * };\n * ```\n */\nexport interface RelayerCallbacks {\n  /**\n   * Submit a signed permission grant transaction for relay\n   *\n   * @param typedData - The EIP-712 typed data that was signed\n   * @param signature - The user's signature\n   * @returns Promise resolving to the transaction hash\n   */\n  submitPermissionGrant?: (\n    typedData: PermissionGrantTypedData,\n    signature: Hash,\n  ) => Promise<Hash>;\n\n  /**\n   * Submit a signed permission revocation transaction for relay\n   *\n   * @param typedData - The EIP-712 typed data that was signed\n   * @param signature - The user's signature\n   * @returns Promise resolving to the transaction hash\n   */\n  submitPermissionRevoke?: (\n    typedData: GenericTypedData,\n    signature: Hash,\n  ) => Promise<Hash>;\n\n  /**\n   * Submit a signed trust server transaction for relay\n   *\n   * @param typedData - The EIP-712 typed data that was signed\n   * @param signature - The user's signature\n   * @returns Promise resolving to the transaction hash\n   */\n  submitTrustServer?: (\n    typedData: TrustServerTypedData,\n    signature: Hash,\n  ) => Promise<Hash>;\n\n  /**\n   * Submit a signed untrust server transaction for relay\n   *\n   * @param typedData - The EIP-712 typed data that was signed\n   * @param signature - The user's signature\n   * @returns Promise resolving to the transaction hash\n   */\n  submitUntrustServer?: (\n    typedData: UntrustServerTypedData,\n    signature: Hash,\n  ) => Promise<Hash>;\n\n  /**\n   * Submit a signed add and trust server transaction for relay\n   *\n   * @param typedData - The EIP-712 typed data that was signed\n   * @param signature - The user's signature\n   * @returns Promise resolving to the transaction hash\n   */\n  submitAddAndTrustServer?: (\n    typedData: AddAndTrustServerTypedData,\n    signature: Hash,\n  ) => Promise<Hash>;\n\n  /**\n   * Submit a signed permission addition transaction for relay\n   *\n   * @param typedData - The EIP-712 typed data that was signed\n   * @param signature - The user's signature\n   * @returns Promise resolving to the transaction hash\n   */\n  submitAddPermission?: (\n    typedData: GenericTypedData,\n    signature: Hash,\n  ) => Promise<Hash>;\n\n  /**\n   * Submit a signed server files and permissions transaction for relay\n   *\n   * @param typedData - The EIP-712 typed data that was signed\n   * @param signature - The user's signature\n   * @returns Promise resolving to the transaction hash\n   */\n  submitAddServerFilesAndPermissions?: (\n    typedData: ServerFilesAndPermissionTypedData,\n    signature: Hash,\n  ) => Promise<Hash>;\n\n  /**\n   * Submit a file addition for relay\n   *\n   * @deprecated Since v2.0.0 - Use submitFileAdditionComplete() instead for full support.\n   * Will be removed in v3.0.0.\n   *\n   * Migration guide:\n   * ```typescript\n   * // Old:\n   * await submitFileAddition(url, userAddress);\n   *\n   * // New:\n   * await submitFileAdditionComplete({\n   *   url,\n   *   userAddress,\n   *   permissions: [] // Optional\n   * });\n   * ```\n   * @param url - The file URL to register\n   * @param userAddress - The user's address\n   * @returns Promise resolving to object with fileId and transactionHash\n   */\n  submitFileAddition?: (\n    url: string,\n    userAddress: string,\n  ) => Promise<{ fileId: number; transactionHash: Hash }>;\n\n  /**\n   * Submit a file addition with permissions for relay\n   *\n   * @deprecated Since v2.0.0 - Use submitFileAdditionComplete() instead for full support.\n   * Will be removed in v3.0.0.\n   *\n   * Migration guide:\n   * ```typescript\n   * // Old:\n   * await submitFileAdditionWithPermissions(url, userAddress, permissions);\n   *\n   * // New:\n   * await submitFileAdditionComplete({\n   *   url,\n   *   userAddress,\n   *   permissions\n   * });\n   * ```\n   * @param url - The file URL to register\n   * @param userAddress - The user's address\n   * @param permissions - Array of encrypted permissions\n   * @returns Promise resolving to object with fileId and transactionHash\n   */\n  submitFileAdditionWithPermissions?: (\n    url: string,\n    userAddress: string,\n    permissions: Array<{ account: string; key: string }>,\n  ) => Promise<{ fileId: number; transactionHash: Hash }>;\n\n  /**\n   * Submit a comprehensive file addition with optional schema and permissions for relay\n   *\n   * This is the preferred callback that supports all file addition scenarios.\n   * It can handle files with schemas, permissions, or both.\n   *\n   * @param params - Complete parameters for file addition\n   * @param params.url - The file URL to register\n   * @param params.userAddress - The user's address (defaults to connected wallet if not specified)\n   * @param params.permissions - Array of encrypted permissions (empty array if none)\n   * @param params.schemaId - Schema ID for validation (0 if none)\n   * @param params.ownerAddress - Optional owner address (defaults to userAddress if not specified)\n   * @returns Promise resolving to object with fileId and transactionHash\n   */\n  submitFileAdditionComplete?: (params: {\n    url: string;\n    userAddress: Address;\n    permissions: Array<{ account: Address; key: string }>;\n    schemaId: number;\n    ownerAddress?: Address;\n  }) => Promise<{ fileId: number; transactionHash: Hash }>;\n\n  /**\n   * Store a grant file for relay (e.g., upload to IPFS)\n   *\n   * @param grantData - The grant file data\n   * @returns Promise resolving to the storage URL\n   */\n  storeGrantFile?: (grantData: GrantFile) => Promise<string>;\n}\n\n/**\n * Storage callback functions for flexible storage operations.\n *\n * Instead of hardcoding storage behavior (HTTP endpoints, etc.), users can provide\n * custom callback functions to handle storage operations in any way they choose.\n * This pattern matches the relayer callbacks approach, providing maximum flexibility.\n *\n * @category Configuration\n * @example\n * ```typescript\n * const storageCallbacks: StorageCallbacks = {\n *   async upload(blob, filename, metadata) {\n *     // Custom implementation - could be HTTP, S3, local filesystem, etc.\n *     const formData = new FormData();\n *     formData.append('file', blob, filename);\n *     const response = await fetch('/api/storage/upload', {\n *       method: 'POST',\n *       body: formData\n *     });\n *     const data = await response.json();\n *     return {\n *       url: data.url,\n *       size: blob.size,\n *       contentType: blob.type,\n *       metadata: data.metadata\n *     };\n *   },\n *\n *   async download(identifier) {\n *     const response = await fetch(`/api/storage/download/${identifier}`);\n *     return response.blob();\n *   }\n * };\n * ```\n */\nexport interface StorageCallbacks {\n  /**\n   * Upload a blob to storage\n   *\n   * @param blob - The data to upload\n   * @param filename - Optional filename hint\n   * @param metadata - Optional metadata for the upload\n   * @returns Upload result with identifier and metadata\n   */\n  upload: (\n    blob: Blob,\n    filename?: string,\n    metadata?: Record<string, unknown>,\n  ) => Promise<StorageUploadResult>;\n\n  /**\n   * Download data from storage\n   *\n   * @param identifier - The storage identifier (could be URL, hash, path, or any unique ID)\n   * @param options - Optional download options\n   * @returns The downloaded data as a Blob\n   */\n  download: (\n    identifier: string,\n    options?: StorageDownloadOptions,\n  ) => Promise<Blob>;\n\n  /**\n   * List stored items (optional)\n   *\n   * @param prefix - Optional prefix to filter results\n   * @param options - Optional listing options\n   * @returns Array of storage items with metadata\n   */\n  list?: (\n    prefix?: string,\n    options?: StorageListOptions,\n  ) => Promise<StorageListResult>;\n\n  /**\n   * Delete a stored item (optional)\n   *\n   * @param identifier - The storage identifier to delete\n   * @returns Promise that resolves to true if deletion succeeded\n   */\n  delete?: (identifier: string) => Promise<boolean>;\n\n  /**\n   * Extract identifier from a URL or return as-is (optional)\n   * Used for backward compatibility with URL-based systems\n   *\n   * @param url - The URL to extract from\n   * @returns The extracted identifier\n   */\n  extractIdentifier?: (url: string) => string;\n}\n\n/**\n * Options for storage download operations\n *\n * @category Configuration\n */\nexport interface StorageDownloadOptions {\n  /** Optional HTTP headers */\n  headers?: Record<string, string>;\n  /** Optional abort signal for cancellation */\n  signal?: AbortSignal;\n  /** Optional byte range for partial downloads */\n  range?: { start?: number; end?: number };\n}\n\n/**\n * Result from storage list operations\n *\n * @category Configuration\n */\nexport interface StorageListResult {\n  /** Array of storage items */\n  items: Array<{\n    /** Item identifier */\n    identifier: string;\n    /** Item size in bytes */\n    size?: number;\n    /** Last modified timestamp */\n    lastModified?: Date;\n    /** Item metadata */\n    metadata?: Record<string, unknown>;\n  }>;\n  /** Continuation token for pagination */\n  continuationToken?: string;\n  /** Whether more results are available */\n  hasMore?: boolean;\n}\n\n/**\n * Base configuration interface without storage requirements\n *\n * @category Configuration\n */\nexport interface BaseConfig {\n  /**\n   * Optional relayer callback functions for handling gasless transactions.\n   * Provides flexible relay mechanism - can use HTTP, WebSocket, or any custom implementation.\n   */\n  relayerCallbacks?: RelayerCallbacks;\n\n  /**\n   * Optional download relayer for proxying CORS-restricted downloads.\n   * Provides a proxy mechanism for files stored on servers with CORS restrictions.\n   */\n  downloadRelayer?: DownloadRelayerCallbacks;\n\n  /**\n   * Optional storage providers configuration for file upload/download.\n   *   Required for: upload(), grant() without pre-stored URLs, schema operations.\n   *   See StorageConfig for provider selection guidance.\n   */\n  storage?: StorageConfig;\n  /**\n   * Optional subgraph URL for querying user files and permissions.\n   * If not provided, defaults to the built-in subgraph URL for the current chain.\n   * Can be overridden per method call if needed.\n   * Obtain chain-specific URLs from Vana documentation or deployment info.\n   */\n  subgraphUrl?: string;\n  /**\n   * Optional default IPFS gateways to use for fetching files.\n   * These gateways will be used by default in fetchFromIPFS unless overridden per-call.\n   * If not provided, the SDK will use public gateways.\n   * Order matters: first successful gateway is used.\n   *\n   * @example ['https://gateway.pinata.cloud', 'https://ipfs.io']\n   */\n  ipfsGateways?: string[];\n  /**\n   * Default personal server base URL for server operations.\n   * Required for ServerController methods like getIdentity(), createOperation(), etc.\n   *\n   * @example 'https://my-personal-server.example.com'\n   */\n  defaultPersonalServerUrl?: string;\n}\n\n/**\n * Base configuration interface that requires storage for storage-dependent operations\n *\n * @category Configuration\n */\nexport interface BaseConfigWithStorage {\n  /**\n   * Optional relayer callback functions for handling gasless transactions.\n   * Provides flexible relay mechanism - can use HTTP, WebSocket, or any custom implementation.\n   */\n  relayerCallbacks?: RelayerCallbacks;\n\n  /**\n   * Optional download relayer for proxying CORS-restricted downloads.\n   * Provides a proxy mechanism for files stored on servers with CORS restrictions.\n   */\n  downloadRelayer?: DownloadRelayerCallbacks;\n\n  /** Required storage providers configuration for file upload/download */\n  storage: StorageConfig;\n  /**\n   * Optional subgraph URL for querying user files and permissions.\n   * If not provided, defaults to the built-in subgraph URL for the current chain.\n   * Can be overridden per method call if needed.\n   */\n  subgraphUrl?: string;\n  /**\n   * Optional default IPFS gateways to use for fetching files.\n   * These gateways will be used by default in fetchFromIPFS unless overridden per-call.\n   * If not provided, the SDK will use public gateways.\n   *\n   * @example ['https://gateway.pinata.cloud', 'https://ipfs.io']\n   */\n  ipfsGateways?: string[];\n  /**\n   * Default personal server base URL for server operations.\n   * Required for ServerController methods like getIdentity(), createOperation(), etc.\n   *\n   * @example 'https://my-personal-server.example.com'\n   */\n  defaultPersonalServerUrl?: string;\n}\n\n/**\n * Configuration with wallet client\n *\n * @category Configuration\n */\nexport interface WalletConfig extends BaseConfig {\n  /** The viem WalletClient instance used for signing transactions */\n  walletClient: WalletClient & {\n    chain: VanaChain;\n  };\n}\n\n/**\n * Configuration with wallet client that requires storage\n *\n * @category Configuration\n */\nexport interface WalletConfigWithStorage extends BaseConfigWithStorage {\n  /** The viem WalletClient instance used for signing transactions */\n  walletClient: WalletClient & {\n    chain: VanaChain;\n  };\n}\n\n/**\n * Configuration with chain and account details\n *\n * @category Configuration\n */\nexport interface ChainConfig extends BaseConfig {\n  /**\n   * The chain ID for Vana network.\n   *   Supported: 14800 (Vana Mainnet), 14801 (Moksha Testnet), 31337 (Local Development).\n   *   Use chain constants from '@vana/sdk' for type safety.\n   */\n  chainId: VanaChainId;\n  /**\n   * RPC URL for the chain (optional, will use default for the chain if not provided).\n   *   Default URLs: mainnet (https://rpc.vana.org), testnet (https://rpc.moksha.vana.org).\n   *   Override for custom nodes or local development.\n   */\n  rpcUrl?: string;\n  /**\n   * Optional account for signing transactions.\n   *   Can be: privateKeyToAccount(), mnemonicToAccount(), or custom Account implementation.\n   *   Required for write operations; read-only operations work without account.\n   */\n  account?: Account;\n}\n\n/**\n * Configuration with chain and account details that requires storage\n *\n * @category Configuration\n */\nexport interface ChainConfigWithStorage extends BaseConfigWithStorage {\n  /** The chain ID for Vana network */\n  chainId: VanaChainId;\n  /** RPC URL for the chain (optional, will use default for the chain if not provided) */\n  rpcUrl?: string;\n  /** Optional account for signing transactions */\n  account?: Account;\n}\n\n/**\n * Configuration with wallet client and optional public client\n *\n * @category Configuration\n */\nexport interface VanaConfigWithWallet extends BaseConfig {\n  /** The viem WalletClient instance used for signing transactions */\n  walletClient: WalletClient;\n  /** Optional PublicClient for read operations (derived from wallet if not provided) */\n  publicClient?: PublicClient;\n}\n\n/**\n * Configuration for read-only operations with public client and address\n *\n * @category Configuration\n */\nexport interface VanaConfigReadOnly extends BaseConfig {\n  /** The viem PublicClient instance for read operations */\n  publicClient: PublicClient;\n  /** The user's address for read operations */\n  address: Address;\n}\n\n/**\n * Configuration for minimal read-only operations with just an address\n *\n * @category Configuration\n */\nexport interface VanaConfigAddressOnly extends BaseConfig {\n  /** The user's address for read operations */\n  address: Address;\n  /** Optional chain configuration (will use default if not provided) */\n  chain?: Chain;\n}\n\n/**\n * Configuration with wallet client and optional public client that requires storage\n *\n * @category Configuration\n */\nexport interface VanaConfigWithWalletWithStorage extends BaseConfigWithStorage {\n  /** The viem WalletClient instance used for signing transactions */\n  walletClient: WalletClient;\n  /** Optional PublicClient for read operations (derived from wallet if not provided) */\n  publicClient?: PublicClient;\n}\n\n/**\n * Configuration for read-only operations with public client and address that requires storage\n *\n * @category Configuration\n */\nexport interface VanaConfigReadOnlyWithStorage extends BaseConfigWithStorage {\n  /** The viem PublicClient instance for read operations */\n  publicClient: PublicClient;\n  /** The user's address for read operations */\n  address: Address;\n}\n\n/**\n * Configuration for minimal read-only operations with just an address that requires storage\n *\n * @category Configuration\n */\nexport interface VanaConfigAddressOnlyWithStorage\n  extends BaseConfigWithStorage {\n  /** The user's address for read operations */\n  address: Address;\n  /** Optional chain configuration (will use default if not provided) */\n  chain?: Chain;\n}\n\n/**\n * Main configuration interface for initializing the Vana SDK.\n *\n * The SDK supports three initialization modes:\n * 1. Full mode with wallet client for signing transactions\n * 2. Read-only mode with public client and address for read operations\n * 3. Minimal mode with just an address and optional chain\n *\n * @category Configuration\n * @example\n * ```typescript\n * // Mode 1: Full configuration with wallet client\n * const configWithWallet: VanaConfig = {\n *   walletClient: createWalletClient({\n *     account: privateKeyToAccount('0x...'),\n *     chain: moksha,\n *     transport: http()\n *   }),\n *   publicClient: createPublicClient({\n *     chain: moksha,\n *     transport: http()\n *   })\n * };\n *\n * // Mode 2: Read-only with public client and address\n * const configReadOnly: VanaConfig = {\n *   publicClient: createPublicClient({\n *     chain: moksha,\n *     transport: http()\n *   }),\n *   address: '0x1234...'\n * };\n *\n * // Mode 3: Minimal with just address\n * const configMinimal: VanaConfig = {\n *   address: '0x1234...',\n *   chain: moksha // optional\n * };\n * ```\n */\nexport type VanaConfig =\n  | VanaConfigWithWallet\n  | VanaConfigReadOnly\n  | VanaConfigAddressOnly\n  | WalletConfig\n  | ChainConfig;\n\n/**\n * Configuration interface for Vana SDK that requires storage providers.\n *\n * Use this type when you need to ensure storage is configured for operations\n * like file uploads, permission grants without pre-stored URLs, or schema creation.\n * Supports all three initialization modes with required storage.\n *\n * @category Configuration\n * @example\n * ```typescript\n * // Full configuration with wallet client and storage\n * const configWithWallet: VanaConfigWithStorage = {\n *   walletClient: createWalletClient({\n *     account: privateKeyToAccount('0x...'),\n *     chain: moksha,\n *     transport: http()\n *   }),\n *   storage: {\n *     providers: {\n *       ipfs: new IPFSStorage({ gateway: 'https://gateway.pinata.cloud' })\n *     },\n *     defaultProvider: 'ipfs'\n *   }\n * };\n *\n * // Read-only configuration with storage\n * const configReadOnly: VanaConfigWithStorage = {\n *   publicClient: createPublicClient({\n *     chain: moksha,\n *     transport: http()\n *   }),\n *   address: '0x1234...',\n *   storage: {\n *     providers: {\n *       ipfs: new IPFSStorage({ gateway: 'https://gateway.pinata.cloud' })\n *     },\n *     defaultProvider: 'ipfs'\n *   }\n * };\n * ```\n */\nexport type VanaConfigWithStorage =\n  | VanaConfigWithWalletWithStorage\n  | VanaConfigReadOnlyWithStorage\n  | VanaConfigAddressOnlyWithStorage\n  | WalletConfigWithStorage\n  | ChainConfigWithStorage;\n\n/**\n * Runtime configuration information\n *\n * @category Configuration\n */\nexport interface RuntimeConfig {\n  /** Current chain ID */\n  chainId: VanaChainId;\n  /** Current chain name */\n  chainName: string;\n  /** Available storage providers */\n  storageProviders: string[];\n  /** Default storage provider */\n  defaultStorageProvider?: string;\n  /** Current relayer callbacks configuration */\n  relayerCallbacks?: RelayerCallbacks;\n}\n\n/**\n * Validates whether a configuration object has a wallet client (any wallet-based config).\n *\n * @param config - The configuration object to check\n * @returns True if the config contains a walletClient\n * @example\n * ```typescript\n * if (isWalletConfig(config)) {\n *   console.log('Using wallet client:', config.walletClient.account?.address);\n * } else {\n *   console.log('Read-only or chain config');\n * }\n * ```\n */\nexport function isWalletConfig(\n  config: VanaConfig,\n): config is VanaConfigWithWallet | WalletConfig {\n  return \"walletClient\" in config;\n}\n\n/**\n * Validates whether a configuration object is a read-only config with public client.\n *\n * @param config - The configuration object to check\n * @returns True if the config has publicClient and address but no walletClient\n * @example\n * ```typescript\n * if (isReadOnlyConfig(config)) {\n *   console.log('Read-only mode with address:', config.address);\n * }\n * ```\n */\nexport function isReadOnlyConfig(\n  config: VanaConfig,\n): config is VanaConfigReadOnly {\n  return (\n    \"publicClient\" in config &&\n    \"address\" in config &&\n    !(\"walletClient\" in config)\n  );\n}\n\n/**\n * Validates whether a configuration object is an address-only config.\n *\n * @param config - The configuration object to check\n * @returns True if the config has only address (and optionally chain) but no clients\n * @example\n * ```typescript\n * if (isAddressOnlyConfig(config)) {\n *   console.log('Address-only mode:', config.address);\n * }\n * ```\n */\nexport function isAddressOnlyConfig(\n  config: VanaConfig,\n): config is VanaConfigAddressOnly {\n  return (\n    \"address\" in config &&\n    !(\"publicClient\" in config) &&\n    !(\"walletClient\" in config) &&\n    !(\"chainId\" in config)\n  );\n}\n\n/**\n * Validates whether a configuration object is a ChainConfig.\n *\n * @param config - The configuration object to check\n * @returns True if the config is a ChainConfig (contains chainId but not walletClient)\n * @example\n * ```typescript\n * if (isChainConfig(config)) {\n *   console.log('Chain ID:', config.chainId);\n *   console.log('RPC URL:', config.rpcUrl);\n * } else {\n *   console.log('Using pre-configured wallet client');\n * }\n * ```\n */\nexport function isChainConfig(config: VanaConfig): config is ChainConfig {\n  return \"chainId\" in config && !(\"walletClient\" in config);\n}\n\n/**\n * Validates whether a configuration has required storage providers.\n *\n * @param config - The configuration object to check\n * @returns True if the config has storage providers configured\n * @example\n * ```typescript\n * if (hasStorageConfig(config)) {\n *   // Safe to use storage-dependent operations\n *   await vana.data.uploadFile(file);\n * } else {\n *   console.log('Storage not configured - some operations may fail');\n * }\n * ```\n */\nexport function hasStorageConfig(\n  config: VanaConfig,\n): config is VanaConfigWithStorage {\n  return (\n    config.storage?.providers !== undefined &&\n    Object.keys(config.storage.providers).length > 0\n  );\n}\n\n/**\n * Configuration validation options\n *\n * @category Configuration\n */\nexport interface ConfigValidationOptions {\n  /** Whether to validate storage providers */\n  validateStorage?: boolean;\n  /** Whether to validate relayer URL */\n  validateRelayer?: boolean;\n  /** Whether to validate chain configuration */\n  validateChain?: boolean;\n}\n\n/**\n * Configuration validation result\n *\n * @category Configuration\n */\nexport interface ConfigValidationResult {\n  /** Whether the configuration is valid */\n  valid: boolean;\n  /** List of validation errors */\n  errors: string[];\n  /** List of validation warnings */\n  warnings: string[];\n}\n"],"mappings":"AAu0BO,SAAS,eACd,QAC+C;AAC/C,SAAO,kBAAkB;AAC3B;AAcO,SAAS,iBACd,QAC8B;AAC9B,SACE,kBAAkB,UAClB,aAAa,UACb,EAAE,kBAAkB;AAExB;AAcO,SAAS,oBACd,QACiC;AACjC,SACE,aAAa,UACb,EAAE,kBAAkB,WACpB,EAAE,kBAAkB,WACpB,EAAE,aAAa;AAEnB;AAiBO,SAAS,cAAc,QAA2C;AACvE,SAAO,aAAa,UAAU,EAAE,kBAAkB;AACpD;AAiBO,SAAS,iBACd,QACiC;AACjC,SACE,OAAO,SAAS,cAAc,UAC9B,OAAO,KAAK,OAAO,QAAQ,SAAS,EAAE,SAAS;AAEnD;","names":[]}
+{"version":3,"sources":["../../src/types/config.ts"],"sourcesContent":["import type { WalletClient, PublicClient, Account, Address, Chain } from \"viem\";\nimport type { VanaChainId, VanaChain } from \"./chains\";\nimport type {\n  StorageProvider,\n  StorageUploadResult,\n  StorageListOptions,\n} from \"./storage\";\n\nimport type { RelayerConfig } from \"./relayer\";\n\n/**\n * Marker interface to indicate that a Vana instance has storage configured.\n * Used for compile-time type safety to ensure storage-dependent methods\n * are only called on properly configured instances.\n *\n * @category Configuration\n */\nexport interface StorageRequiredMarker {\n  readonly __storageRequired: true;\n}\n\n/**\n * Configures storage providers for SDK file operations.\n *\n * @remarks\n * Supports multiple backends with automatic fallback.\n * IPFS for decentralization, Pinata for reliability,\n * Google Drive for development, custom for flexibility.\n *\n * **Provider Selection:**\n * - IPFS: Decentralized, permanent storage ideal for production\n * - Pinata: Managed IPFS with guaranteed availability\n * - Google Drive: Centralized, suitable for development/testing\n * - Custom providers: Implement StorageProvider interface\n *\n * @category Configuration\n * @example\n * ```typescript\n * const storage: StorageConfig = {\n *   providers: {\n *     ipfs: new IPFSStorage({ gateway: 'https://gateway.pinata.cloud' }),\n *     pinata: new PinataStorage({ apiKey: 'key', secretKey: 'secret' })\n *   },\n *   defaultProvider: 'ipfs'\n * };\n * ```\n */\nexport interface StorageConfig {\n  /**\n   * Map of provider name to storage provider instance.\n   *   Common provider names: \"ipfs\", \"pinata\", \"googledrive\", \"s3\".\n   *   Custom names allowed for custom provider implementations.\n   */\n  providers: Record<string, StorageProvider>;\n  /**\n   * Default provider name to use when none specified.\n   *   Must match a key in the providers map. Falls back to first provider if not specified.\n   */\n  defaultProvider?: string;\n}\n\n/**\n * Download relayer callbacks for proxying CORS-restricted downloads.\n *\n * Provides a callback to proxy download requests through your application server\n * when direct browser access fails due to CORS restrictions (e.g., Google Drive).\n *\n * IMPORTANT SECURITY REQUIREMENTS for your proxy endpoint:\n * 1. MUST block requests to private/internal IPs (SSRF protection)\n * 2. SHOULD NOT restrict domains (files can be hosted anywhere)\n *\n * @category Configuration\n * @example Client-side implementation:\n * ```typescript\n * const downloadRelayer: DownloadRelayerCallbacks = {\n *   async proxyDownload(url) {\n *     const response = await fetch('/api/proxy', {\n *       method: 'POST',\n *       headers: { 'Content-Type': 'application/json' },\n *       body: JSON.stringify({ url })\n *     });\n *     return response.blob();\n *   }\n * };\n * ```\n *\n * @example Server-side proxy endpoint (Next.js):\n * ```typescript\n * // /api/proxy/route.ts\n * import { promises as dns } from 'dns';\n * import { isIPv4 } from 'net';\n *\n * async function handleProxy(url: string) {\n *   const { hostname } = new URL(url);\n *\n *   // Resolve hostname to IP (handle localhost specially)\n *   const ip = hostname === 'localhost' ? '127.0.0.1' :\n *              isIPv4(hostname) ? hostname :\n *              await dns.lookup(hostname).then(r => r.address);\n *\n *   // SSRF Protection: Block private/internal IPs\n *   if (isIPv4(ip)) {\n *     const [a, b] = ip.split('.').map(Number);\n *     if (a === 10 || a === 127 || a === 0 ||\n *         (a === 172 && b >= 16 && b <= 31) ||\n *         (a === 192 && b === 168) ||\n *         (a === 169 && b === 254) ||\n *         a >= 224) { // Also block multicast/reserved\n *       return new Response('Private/internal addresses not allowed', { status: 403 });\n *     }\n *   }\n *\n *   // Proxy the request\n *   const response = await fetch(url, { redirect: 'manual' });\n *\n *   // Handle redirects (with recursion limit)\n *   if (response.status >= 301 && response.status <= 308) {\n *     const location = response.headers.get('location');\n *     if (location) return handleProxy(new URL(location, url).href);\n *   }\n *\n *   const data = await response.arrayBuffer();\n *   return new Response(data, {\n *     headers: {\n *       'Content-Type': response.headers.get('content-type') || 'application/octet-stream',\n *       'Access-Control-Allow-Origin': '*'\n *     }\n *   });\n * }\n * ```\n */\nexport interface DownloadRelayerCallbacks {\n  /**\n   * Proxy a download request through your application server\n   *\n   * @param url - The URL to download from\n   * @returns Promise resolving to the downloaded content as a Blob\n   */\n  proxyDownload: (url: string) => Promise<Blob>;\n}\n\n/**\n * Storage callback functions for flexible storage operations.\n *\n * Instead of hardcoding storage behavior (HTTP endpoints, etc.), users can provide\n * custom callback functions to handle storage operations in any way they choose.\n * This pattern matches the relayer callbacks approach, providing maximum flexibility.\n *\n * @category Configuration\n * @example\n * ```typescript\n * const storageCallbacks: StorageCallbacks = {\n *   async upload(blob, filename, metadata) {\n *     // Custom implementation - could be HTTP, S3, local filesystem, etc.\n *     const formData = new FormData();\n *     formData.append('file', blob, filename);\n *     const response = await fetch('/api/storage/upload', {\n *       method: 'POST',\n *       body: formData\n *     });\n *     const data = await response.json();\n *     return {\n *       url: data.url,\n *       size: blob.size,\n *       contentType: blob.type,\n *       metadata: data.metadata\n *     };\n *   },\n *\n *   async download(identifier) {\n *     const response = await fetch(`/api/storage/download/${identifier}`);\n *     return response.blob();\n *   }\n * };\n * ```\n */\nexport interface StorageCallbacks {\n  /**\n   * Upload a blob to storage\n   *\n   * @param blob - The data to upload\n   * @param filename - Optional filename hint\n   * @param metadata - Optional metadata for the upload\n   * @returns Upload result with identifier and metadata\n   */\n  upload: (\n    blob: Blob,\n    filename?: string,\n    metadata?: Record<string, unknown>,\n  ) => Promise<StorageUploadResult>;\n\n  /**\n   * Download data from storage\n   *\n   * @param identifier - The storage identifier (could be URL, hash, path, or any unique ID)\n   * @param options - Optional download options\n   * @returns The downloaded data as a Blob\n   */\n  download: (\n    identifier: string,\n    options?: StorageDownloadOptions,\n  ) => Promise<Blob>;\n\n  /**\n   * List stored items (optional)\n   *\n   * @param prefix - Optional prefix to filter results\n   * @param options - Optional listing options\n   * @returns Array of storage items with metadata\n   */\n  list?: (\n    prefix?: string,\n    options?: StorageListOptions,\n  ) => Promise<StorageListResult>;\n\n  /**\n   * Delete a stored item (optional)\n   *\n   * @param identifier - The storage identifier to delete\n   * @returns Promise that resolves to true if deletion succeeded\n   */\n  delete?: (identifier: string) => Promise<boolean>;\n\n  /**\n   * Extract identifier from a URL or return as-is (optional)\n   * Used for backward compatibility with URL-based systems\n   *\n   * @param url - The URL to extract from\n   * @returns The extracted identifier\n   */\n  extractIdentifier?: (url: string) => string;\n}\n\n/**\n * Options for storage download operations\n *\n * @category Configuration\n */\nexport interface StorageDownloadOptions {\n  /** Optional HTTP headers */\n  headers?: Record<string, string>;\n  /** Optional abort signal for cancellation */\n  signal?: AbortSignal;\n  /** Optional byte range for partial downloads */\n  range?: { start?: number; end?: number };\n}\n\n/**\n * Result from storage list operations\n *\n * @category Configuration\n */\nexport interface StorageListResult {\n  /** Array of storage items */\n  items: Array<{\n    /** Item identifier */\n    identifier: string;\n    /** Item size in bytes */\n    size?: number;\n    /** Last modified timestamp */\n    lastModified?: Date;\n    /** Item metadata */\n    metadata?: Record<string, unknown>;\n  }>;\n  /** Continuation token for pagination */\n  continuationToken?: string;\n  /** Whether more results are available */\n  hasMore?: boolean;\n}\n\n/**\n * Base configuration interface without storage requirements\n *\n * @category Configuration\n */\nexport interface BaseConfig {\n  /**\n   * Optional relayer configuration for handling gasless transactions.\n   * Can be a URL string for convenience, or a callback for full control.\n   *\n   * @example\n   * ```typescript\n   * // Simple URL (SDK handles transport)\n   * relayer: '/api/relay'\n   *\n   * // Full control with callback\n   * relayer: async (request) => {\n   *   const response = await fetch('/api/relay', {\n   *     method: 'POST',\n   *     body: JSON.stringify(request)\n   *   });\n   *   return response.json();\n   * }\n   * ```\n   */\n  relayer?: RelayerConfig;\n\n  /**\n   * Optional download relayer for proxying CORS-restricted downloads.\n   * Provides a proxy mechanism for files stored on servers with CORS restrictions.\n   */\n  downloadRelayer?: DownloadRelayerCallbacks;\n\n  /**\n   * Optional storage providers configuration for file upload/download.\n   *   Required for: upload(), grant() without pre-stored URLs, schema operations.\n   *   See StorageConfig for provider selection guidance.\n   */\n  storage?: StorageConfig;\n  /**\n   * Optional subgraph URL for querying user files and permissions.\n   * If not provided, defaults to the built-in subgraph URL for the current chain.\n   * Can be overridden per method call if needed.\n   * Obtain chain-specific URLs from Vana documentation or deployment info.\n   */\n  subgraphUrl?: string;\n  /**\n   * Optional default IPFS gateways to use for fetching files.\n   * These gateways will be used by default in fetchFromIPFS unless overridden per-call.\n   * If not provided, the SDK will use public gateways.\n   * Order matters: first successful gateway is used.\n   *\n   * @example ['https://gateway.pinata.cloud', 'https://ipfs.io']\n   */\n  ipfsGateways?: string[];\n  /**\n   * Default personal server base URL for server operations.\n   * Required for ServerController methods like getIdentity(), createOperation(), etc.\n   *\n   * @example 'https://my-personal-server.example.com'\n   */\n  defaultPersonalServerUrl?: string;\n}\n\n/**\n * Base configuration interface that requires storage for storage-dependent operations\n *\n * @category Configuration\n */\nexport interface BaseConfigWithStorage {\n  /**\n   * Optional relayer configuration for handling gasless transactions.\n   * Can be a URL string for convenience, or a callback for full control.\n   *\n   * @example\n   * ```typescript\n   * // Simple URL (SDK handles transport)\n   * relayer: '/api/relay'\n   *\n   * // Full control with callback\n   * relayer: async (request) => {\n   *   const response = await fetch('/api/relay', {\n   *     method: 'POST',\n   *     body: JSON.stringify(request)\n   *   });\n   *   return response.json();\n   * }\n   * ```\n   */\n  relayer?: RelayerConfig;\n\n  /**\n   * Optional download relayer for proxying CORS-restricted downloads.\n   * Provides a proxy mechanism for files stored on servers with CORS restrictions.\n   */\n  downloadRelayer?: DownloadRelayerCallbacks;\n\n  /** Required storage providers configuration for file upload/download */\n  storage: StorageConfig;\n  /**\n   * Optional subgraph URL for querying user files and permissions.\n   * If not provided, defaults to the built-in subgraph URL for the current chain.\n   * Can be overridden per method call if needed.\n   */\n  subgraphUrl?: string;\n  /**\n   * Optional default IPFS gateways to use for fetching files.\n   * These gateways will be used by default in fetchFromIPFS unless overridden per-call.\n   * If not provided, the SDK will use public gateways.\n   *\n   * @example ['https://gateway.pinata.cloud', 'https://ipfs.io']\n   */\n  ipfsGateways?: string[];\n  /**\n   * Default personal server base URL for server operations.\n   * Required for ServerController methods like getIdentity(), createOperation(), etc.\n   *\n   * @example 'https://my-personal-server.example.com'\n   */\n  defaultPersonalServerUrl?: string;\n}\n\n/**\n * Configuration with wallet client\n *\n * @category Configuration\n */\nexport interface WalletConfig extends BaseConfig {\n  /** The viem WalletClient instance used for signing transactions */\n  walletClient: WalletClient & {\n    chain: VanaChain;\n  };\n}\n\n/**\n * Configuration with wallet client that requires storage\n *\n * @category Configuration\n */\nexport interface WalletConfigWithStorage extends BaseConfigWithStorage {\n  /** The viem WalletClient instance used for signing transactions */\n  walletClient: WalletClient & {\n    chain: VanaChain;\n  };\n}\n\n/**\n * Configuration with chain and account details\n *\n * @category Configuration\n */\nexport interface ChainConfig extends BaseConfig {\n  /**\n   * The chain ID for Vana network.\n   *   Supported: 14800 (Vana Mainnet), 14801 (Moksha Testnet), 31337 (Local Development).\n   *   Use chain constants from '@vana/sdk' for type safety.\n   */\n  chainId: VanaChainId;\n  /**\n   * RPC URL for the chain (optional, will use default for the chain if not provided).\n   *   Default URLs: mainnet (https://rpc.vana.org), testnet (https://rpc.moksha.vana.org).\n   *   Override for custom nodes or local development.\n   */\n  rpcUrl?: string;\n  /**\n   * Optional account for signing transactions.\n   *   Can be: privateKeyToAccount(), mnemonicToAccount(), or custom Account implementation.\n   *   Required for write operations; read-only operations work without account.\n   */\n  account?: Account;\n}\n\n/**\n * Configuration with chain and account details that requires storage\n *\n * @category Configuration\n */\nexport interface ChainConfigWithStorage extends BaseConfigWithStorage {\n  /** The chain ID for Vana network */\n  chainId: VanaChainId;\n  /** RPC URL for the chain (optional, will use default for the chain if not provided) */\n  rpcUrl?: string;\n  /** Optional account for signing transactions */\n  account?: Account;\n}\n\n/**\n * Configuration with wallet client and optional public client\n *\n * @category Configuration\n */\nexport interface VanaConfigWithWallet extends BaseConfig {\n  /** The viem WalletClient instance used for signing transactions */\n  walletClient: WalletClient;\n  /** Optional PublicClient for read operations (derived from wallet if not provided) */\n  publicClient?: PublicClient;\n}\n\n/**\n * Configuration for read-only operations with public client and address\n *\n * @category Configuration\n */\nexport interface VanaConfigReadOnly extends BaseConfig {\n  /** The viem PublicClient instance for read operations */\n  publicClient: PublicClient;\n  /** The user's address for read operations */\n  address: Address;\n}\n\n/**\n * Configuration for minimal read-only operations with just an address\n *\n * @category Configuration\n */\nexport interface VanaConfigAddressOnly extends BaseConfig {\n  /** The user's address for read operations */\n  address: Address;\n  /** Optional chain configuration (will use default if not provided) */\n  chain?: Chain;\n}\n\n/**\n * Configuration with wallet client and optional public client that requires storage\n *\n * @category Configuration\n */\nexport interface VanaConfigWithWalletWithStorage extends BaseConfigWithStorage {\n  /** The viem WalletClient instance used for signing transactions */\n  walletClient: WalletClient;\n  /** Optional PublicClient for read operations (derived from wallet if not provided) */\n  publicClient?: PublicClient;\n}\n\n/**\n * Configuration for read-only operations with public client and address that requires storage\n *\n * @category Configuration\n */\nexport interface VanaConfigReadOnlyWithStorage extends BaseConfigWithStorage {\n  /** The viem PublicClient instance for read operations */\n  publicClient: PublicClient;\n  /** The user's address for read operations */\n  address: Address;\n}\n\n/**\n * Configuration for minimal read-only operations with just an address that requires storage\n *\n * @category Configuration\n */\nexport interface VanaConfigAddressOnlyWithStorage\n  extends BaseConfigWithStorage {\n  /** The user's address for read operations */\n  address: Address;\n  /** Optional chain configuration (will use default if not provided) */\n  chain?: Chain;\n}\n\n/**\n * Main configuration interface for initializing the Vana SDK.\n *\n * The SDK supports three initialization modes:\n * 1. Full mode with wallet client for signing transactions\n * 2. Read-only mode with public client and address for read operations\n * 3. Minimal mode with just an address and optional chain\n *\n * @category Configuration\n * @example\n * ```typescript\n * // Mode 1: Full configuration with wallet client\n * const configWithWallet: VanaConfig = {\n *   walletClient: createWalletClient({\n *     account: privateKeyToAccount('0x...'),\n *     chain: moksha,\n *     transport: http()\n *   }),\n *   publicClient: createPublicClient({\n *     chain: moksha,\n *     transport: http()\n *   })\n * };\n *\n * // Mode 2: Read-only with public client and address\n * const configReadOnly: VanaConfig = {\n *   publicClient: createPublicClient({\n *     chain: moksha,\n *     transport: http()\n *   }),\n *   address: '0x1234...'\n * };\n *\n * // Mode 3: Minimal with just address\n * const configMinimal: VanaConfig = {\n *   address: '0x1234...',\n *   chain: moksha // optional\n * };\n * ```\n */\nexport type VanaConfig =\n  | VanaConfigWithWallet\n  | VanaConfigReadOnly\n  | VanaConfigAddressOnly\n  | WalletConfig\n  | ChainConfig;\n\n/**\n * Configuration interface for Vana SDK that requires storage providers.\n *\n * Use this type when you need to ensure storage is configured for operations\n * like file uploads, permission grants without pre-stored URLs, or schema creation.\n * Supports all three initialization modes with required storage.\n *\n * @category Configuration\n * @example\n * ```typescript\n * // Full configuration with wallet client and storage\n * const configWithWallet: VanaConfigWithStorage = {\n *   walletClient: createWalletClient({\n *     account: privateKeyToAccount('0x...'),\n *     chain: moksha,\n *     transport: http()\n *   }),\n *   storage: {\n *     providers: {\n *       ipfs: new IPFSStorage({ gateway: 'https://gateway.pinata.cloud' })\n *     },\n *     defaultProvider: 'ipfs'\n *   }\n * };\n *\n * // Read-only configuration with storage\n * const configReadOnly: VanaConfigWithStorage = {\n *   publicClient: createPublicClient({\n *     chain: moksha,\n *     transport: http()\n *   }),\n *   address: '0x1234...',\n *   storage: {\n *     providers: {\n *       ipfs: new IPFSStorage({ gateway: 'https://gateway.pinata.cloud' })\n *     },\n *     defaultProvider: 'ipfs'\n *   }\n * };\n * ```\n */\nexport type VanaConfigWithStorage =\n  | VanaConfigWithWalletWithStorage\n  | VanaConfigReadOnlyWithStorage\n  | VanaConfigAddressOnlyWithStorage\n  | WalletConfigWithStorage\n  | ChainConfigWithStorage;\n\n/**\n * Runtime configuration information\n *\n * @category Configuration\n */\nexport interface RuntimeConfig {\n  /** Current chain ID */\n  chainId: VanaChainId;\n  /** Current chain name */\n  chainName: string;\n  /** Available storage providers */\n  storageProviders: string[];\n  /** Default storage provider */\n  defaultStorageProvider?: string;\n  /** Current relayer configuration */\n  relayerConfig?: RelayerConfig;\n}\n\n/**\n * Validates whether a configuration object has a wallet client (any wallet-based config).\n *\n * @param config - The configuration object to check\n * @returns True if the config contains a walletClient\n * @example\n * ```typescript\n * if (isWalletConfig(config)) {\n *   console.log('Using wallet client:', config.walletClient.account?.address);\n * } else {\n *   console.log('Read-only or chain config');\n * }\n * ```\n */\nexport function isWalletConfig(\n  config: VanaConfig,\n): config is VanaConfigWithWallet | WalletConfig {\n  return \"walletClient\" in config;\n}\n\n/**\n * Validates whether a configuration object is a read-only config with public client.\n *\n * @param config - The configuration object to check\n * @returns True if the config has publicClient and address but no walletClient\n * @example\n * ```typescript\n * if (isReadOnlyConfig(config)) {\n *   console.log('Read-only mode with address:', config.address);\n * }\n * ```\n */\nexport function isReadOnlyConfig(\n  config: VanaConfig,\n): config is VanaConfigReadOnly {\n  return (\n    \"publicClient\" in config &&\n    \"address\" in config &&\n    !(\"walletClient\" in config)\n  );\n}\n\n/**\n * Validates whether a configuration object is an address-only config.\n *\n * @param config - The configuration object to check\n * @returns True if the config has only address (and optionally chain) but no clients\n * @example\n * ```typescript\n * if (isAddressOnlyConfig(config)) {\n *   console.log('Address-only mode:', config.address);\n * }\n * ```\n */\nexport function isAddressOnlyConfig(\n  config: VanaConfig,\n): config is VanaConfigAddressOnly {\n  return (\n    \"address\" in config &&\n    !(\"publicClient\" in config) &&\n    !(\"walletClient\" in config) &&\n    !(\"chainId\" in config)\n  );\n}\n\n/**\n * Validates whether a configuration object is a ChainConfig.\n *\n * @param config - The configuration object to check\n * @returns True if the config is a ChainConfig (contains chainId but not walletClient)\n * @example\n * ```typescript\n * if (isChainConfig(config)) {\n *   console.log('Chain ID:', config.chainId);\n *   console.log('RPC URL:', config.rpcUrl);\n * } else {\n *   console.log('Using pre-configured wallet client');\n * }\n * ```\n */\nexport function isChainConfig(config: VanaConfig): config is ChainConfig {\n  return \"chainId\" in config && !(\"walletClient\" in config);\n}\n\n/**\n * Validates whether a configuration has required storage providers.\n *\n * @param config - The configuration object to check\n * @returns True if the config has storage providers configured\n * @example\n * ```typescript\n * if (hasStorageConfig(config)) {\n *   // Safe to use storage-dependent operations\n *   await vana.data.uploadFile(file);\n * } else {\n *   console.log('Storage not configured - some operations may fail');\n * }\n * ```\n */\nexport function hasStorageConfig(\n  config: VanaConfig,\n): config is VanaConfigWithStorage {\n  return (\n    config.storage?.providers !== undefined &&\n    Object.keys(config.storage.providers).length > 0\n  );\n}\n\n/**\n * Configuration validation options\n *\n * @category Configuration\n */\nexport interface ConfigValidationOptions {\n  /** Whether to validate storage providers */\n  validateStorage?: boolean;\n  /** Whether to validate relayer URL */\n  validateRelayer?: boolean;\n  /** Whether to validate chain configuration */\n  validateChain?: boolean;\n}\n\n/**\n * Configuration validation result\n *\n * @category Configuration\n */\nexport interface ConfigValidationResult {\n  /** Whether the configuration is valid */\n  valid: boolean;\n  /** List of validation errors */\n  errors: string[];\n  /** List of validation warnings */\n  warnings: string[];\n}\n"],"mappings":"AAgpBO,SAAS,eACd,QAC+C;AAC/C,SAAO,kBAAkB;AAC3B;AAcO,SAAS,iBACd,QAC8B;AAC9B,SACE,kBAAkB,UAClB,aAAa,UACb,EAAE,kBAAkB;AAExB;AAcO,SAAS,oBACd,QACiC;AACjC,SACE,aAAa,UACb,EAAE,kBAAkB,WACpB,EAAE,kBAAkB,WACpB,EAAE,aAAa;AAEnB;AAiBO,SAAS,cAAc,QAA2C;AACvE,SAAO,aAAa,UAAU,EAAE,kBAAkB;AACpD;AAiBO,SAAS,iBACd,QACiC;AACjC,SACE,OAAO,SAAS,cAAc,UAC9B,OAAO,KAAK,OAAO,QAAQ,SAAS,EAAE,SAAS;AAEnD;","names":[]}

package/dist/types/contracts.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/contracts.ts"],"sourcesContent":["import type { Abi, Address, Hash, GetContractReturnType } from \"viem\";\n\n/**\n * Union type of all canonical Vana contract names\n */\nexport type VanaContractName =\n  | \"DataPortabilityPermissions\"\n  | \"DataPortabilityServers\"\n  | \"DataPortabilityGrantees\"\n  | \"DataRegistry\"\n  | \"TeePool\"\n  | \"ComputeEngine\"\n  | \"TeePoolPhala\"\n  | \"DataRefinerRegistry\"\n  | \"QueryEngine\"\n  | \"ComputeInstructionRegistry\"\n  | \"TeePoolEphemeralStandard\"\n  | \"TeePoolPersistentStandard\"\n  | \"TeePoolPersistentGpu\"\n  | \"TeePoolDedicatedStandard\"\n  | \"TeePoolDedicatedGpu\"\n  | \"VanaEpoch\"\n  | \"DLPRegistry\"\n  | \"DLPRegistryTreasury\"\n  | \"DLPPerformance\"\n  | \"DLPRewardDeployer\"\n  | \"DLPRewardDeployerTreasury\"\n  | \"DLPRewardSwap\"\n  | \"SwapHelper\"\n  | \"VanaPoolStaking\"\n  | \"VanaPoolEntity\"\n  | \"VanaPoolTreasury\"\n  | \"DAT\"\n  | \"DATFactory\"\n  | \"DATPausable\"\n  | \"DATVotes\"\n  | \"DataLiquidityPool\"\n  | \"DLPRoot\";\n\n/**\n * Contract information with typed address and ABI\n */\nexport interface ContractInfo<TAbi extends Abi = Abi> {\n  /** The contract's deployed address */\n  address: Address;\n  /** The contract's ABI */\n  abi: TAbi;\n}\n\n/**\n * Contract deployment information\n */\nexport interface ContractDeployment {\n  /** The contract's deployed address */\n  address: Address;\n  /** Block number where contract was deployed */\n  blockNumber: bigint;\n  /** Transaction hash of deployment */\n  transactionHash: Hash;\n}\n\n/**\n * Typed contract instance\n */\nexport type VanaContractInstance<TAbi extends Abi = Abi> =\n  GetContractReturnType<TAbi>;\n\n/**\n * Contract addresses mapping by chain and contract name\n */\nexport type ContractAddresses = {\n  [chainId: number]: {\n    [contractName in VanaContractName]?: Address;\n  };\n};\n\n/**\n * Contract method parameters for typed interactions\n */\nexport type ContractMethodParams<\n  TAbi extends Abi,\n  TFunctionName extends string,\n> = TAbi extends readonly unknown[]\n  ? TAbi[number] extends {\n      name: TFunctionName;\n      type: \"function\";\n      inputs: infer TInputs;\n    }\n    ? TInputs extends readonly unknown[]\n      ? {\n          [K in keyof TInputs]: TInputs[K] extends {\n            name: infer TName;\n            type: infer TType;\n          }\n            ? TName extends string\n              ? TType extends \"address\"\n                ? Address\n                : TType extends \"uint256\"\n                  ? bigint\n                  : TType extends \"string\"\n                    ? string\n                    : TType extends \"bool\"\n                      ? boolean\n                      : TType extends \"bytes32\"\n                        ? Hash\n                        : unknown\n              : never\n            : never;\n        }\n      : never\n    : never\n  : never;\n\n/**\n * Contract method return type for typed interactions\n */\nexport type ContractMethodReturnType<\n  TAbi extends Abi,\n  TFunctionName extends string,\n> = TAbi extends readonly unknown[]\n  ? TAbi[number] extends {\n      name: TFunctionName;\n      type: \"function\";\n      outputs: infer TOutputs;\n    }\n    ? TOutputs extends readonly unknown[]\n      ? TOutputs[\"length\"] extends 1\n        ? TOutputs[0] extends { type: infer TType }\n          ? TType extends \"address\"\n            ? Address\n            : TType extends \"uint256\"\n              ? bigint\n              : TType extends \"string\"\n                ? string\n                : TType extends \"bool\"\n                  ? boolean\n                  : TType extends \"bytes32\"\n                    ? Hash\n                    : unknown\n          : unknown\n        : {\n            [K in keyof TOutputs]: TOutputs[K] extends {\n              name: infer TName;\n              type: infer TType;\n            }\n              ? TName extends string\n                ? TType extends \"address\"\n                  ? Address\n                  : TType extends \"uint256\"\n                    ? bigint\n                    : TType extends \"string\"\n                      ? string\n                      : TType extends \"bool\"\n                        ? boolean\n                        : TType extends \"bytes32\"\n                          ? Hash\n                          : unknown\n                : never\n              : never;\n          }\n      : never\n    : never\n  : never;\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/contracts.ts"],"sourcesContent":["/**\n * Defines types for smart contract interactions.\n *\n * @remarks\n * This module provides comprehensive type definitions for Vana protocol\n * smart contracts including contract names, deployment information, and\n * advanced TypeScript utility types for type-safe contract interactions.\n *\n * @category Types\n * @module types/contracts\n */\n\nimport type { Abi, Address, Hash, GetContractReturnType } from \"viem\";\n\n/**\n * Enumerates all supported Vana protocol contract names.\n *\n * @remarks\n * Use these names with `getContractController()` to get typed contract\n * instances. Each name corresponds to a specific protocol contract with\n * its own ABI and functionality.\n *\n * @category Contracts\n */\nexport type VanaContractName =\n  | \"DataPortabilityPermissions\"\n  | \"DataPortabilityServers\"\n  | \"DataPortabilityGrantees\"\n  | \"DataRegistry\"\n  | \"TeePool\"\n  | \"ComputeEngine\"\n  | \"TeePoolPhala\"\n  | \"DataRefinerRegistry\"\n  | \"QueryEngine\"\n  | \"ComputeInstructionRegistry\"\n  | \"TeePoolEphemeralStandard\"\n  | \"TeePoolPersistentStandard\"\n  | \"TeePoolPersistentGpu\"\n  | \"TeePoolDedicatedStandard\"\n  | \"TeePoolDedicatedGpu\"\n  | \"VanaEpoch\"\n  | \"DLPRegistry\"\n  | \"DLPRegistryTreasury\"\n  | \"DLPPerformance\"\n  | \"DLPRewardDeployer\"\n  | \"DLPRewardDeployerTreasury\"\n  | \"DLPRewardSwap\"\n  | \"SwapHelper\"\n  | \"VanaPoolStaking\"\n  | \"VanaPoolEntity\"\n  | \"VanaPoolTreasury\"\n  | \"DAT\"\n  | \"DATFactory\"\n  | \"DATPausable\"\n  | \"DATVotes\"\n  | \"DataLiquidityPool\"\n  | \"DLPRoot\";\n\n/**\n * Provides contract deployment information with typed ABI.\n *\n * @remarks\n * Contains the minimum information needed to interact with a\n * deployed contract: its address and ABI.\n *\n * @typeParam TAbi - The contract's ABI type for full type safety\n *\n * @category Contracts\n */\nexport interface ContractInfo<TAbi extends Abi = Abi> {\n  /** The contract's deployed address */\n  address: Address;\n  /** The contract's ABI */\n  abi: TAbi;\n}\n\n/**\n * Tracks contract deployment metadata.\n *\n * @remarks\n * Records when and how a contract was deployed to the blockchain,\n * useful for verification and debugging.\n *\n * @category Contracts\n */\nexport interface ContractDeployment {\n  /** The contract's deployed address */\n  address: Address;\n  /** Block number where contract was deployed */\n  blockNumber: bigint;\n  /** Transaction hash of deployment */\n  transactionHash: Hash;\n}\n\n/**\n * Represents a fully typed contract instance.\n *\n * @remarks\n * Alias for viem's GetContractReturnType, providing a contract\n * instance with all methods fully typed based on the ABI.\n *\n * @typeParam TAbi - The contract's ABI type\n *\n * @category Contracts\n */\nexport type VanaContractInstance<TAbi extends Abi = Abi> =\n  GetContractReturnType<TAbi>;\n\n/**\n * Maps contract addresses by chain ID and contract name.\n *\n * @remarks\n * Hierarchical mapping structure for multi-chain contract deployments.\n * Used internally for address resolution across different networks.\n *\n * @category Contracts\n */\nexport type ContractAddresses = {\n  [chainId: number]: {\n    [contractName in VanaContractName]?: Address;\n  };\n};\n\n/**\n * Extracts typed parameters for a contract method from its ABI.\n *\n * @remarks\n * Advanced utility type that provides type-safe parameter extraction\n * from contract ABIs. Maps Solidity types to TypeScript types automatically.\n *\n * @typeParam TAbi - The contract's ABI type\n * @typeParam TFunctionName - The name of the function to extract parameters for\n *\n * @internal\n */\nexport type ContractMethodParams<\n  TAbi extends Abi,\n  TFunctionName extends string,\n> = TAbi extends readonly unknown[]\n  ? TAbi[number] extends {\n      name: TFunctionName;\n      type: \"function\";\n      inputs: infer TInputs;\n    }\n    ? TInputs extends readonly unknown[]\n      ? {\n          [K in keyof TInputs]: TInputs[K] extends {\n            name: infer TName;\n            type: infer TType;\n          }\n            ? TName extends string\n              ? TType extends \"address\"\n                ? Address\n                : TType extends \"uint256\"\n                  ? bigint\n                  : TType extends \"string\"\n                    ? string\n                    : TType extends \"bool\"\n                      ? boolean\n                      : TType extends \"bytes32\"\n                        ? Hash\n                        : unknown\n              : never\n            : never;\n        }\n      : never\n    : never\n  : never;\n\n/**\n * Extracts typed return values for a contract method from its ABI.\n *\n * @remarks\n * Advanced utility type that provides type-safe return type extraction\n * from contract ABIs. Handles single values and tuples appropriately.\n *\n * @typeParam TAbi - The contract's ABI type\n * @typeParam TFunctionName - The name of the function to extract return type for\n *\n * @internal\n */\nexport type ContractMethodReturnType<\n  TAbi extends Abi,\n  TFunctionName extends string,\n> = TAbi extends readonly unknown[]\n  ? TAbi[number] extends {\n      name: TFunctionName;\n      type: \"function\";\n      outputs: infer TOutputs;\n    }\n    ? TOutputs extends readonly unknown[]\n      ? TOutputs[\"length\"] extends 1\n        ? TOutputs[0] extends { type: infer TType }\n          ? TType extends \"address\"\n            ? Address\n            : TType extends \"uint256\"\n              ? bigint\n              : TType extends \"string\"\n                ? string\n                : TType extends \"bool\"\n                  ? boolean\n                  : TType extends \"bytes32\"\n                    ? Hash\n                    : unknown\n          : unknown\n        : {\n            [K in keyof TOutputs]: TOutputs[K] extends {\n              name: infer TName;\n              type: infer TType;\n            }\n              ? TName extends string\n                ? TType extends \"address\"\n                  ? Address\n                  : TType extends \"uint256\"\n                    ? bigint\n                    : TType extends \"string\"\n                      ? string\n                      : TType extends \"bool\"\n                        ? boolean\n                        : TType extends \"bytes32\"\n                          ? Hash\n                          : unknown\n                : never\n              : never;\n          }\n      : never\n    : never\n  : never;\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/contracts.d.ts

@@ -1,10 +1,36 @@
+/**
+ * Defines types for smart contract interactions.
+ *
+ * @remarks
+ * This module provides comprehensive type definitions for Vana protocol
+ * smart contracts including contract names, deployment information, and
+ * advanced TypeScript utility types for type-safe contract interactions.
+ *
+ * @category Types
+ * @module types/contracts
+ */
 import type { Abi, Address, Hash, GetContractReturnType } from "viem";
 /**
- * Union type of all canonical Vana contract names
+ * Enumerates all supported Vana protocol contract names.
+ *
+ * @remarks
+ * Use these names with `getContractController()` to get typed contract
+ * instances. Each name corresponds to a specific protocol contract with
+ * its own ABI and functionality.
+ *
+ * @category Contracts
  */
 export type VanaContractName = "DataPortabilityPermissions" | "DataPortabilityServers" | "DataPortabilityGrantees" | "DataRegistry" | "TeePool" | "ComputeEngine" | "TeePoolPhala" | "DataRefinerRegistry" | "QueryEngine" | "ComputeInstructionRegistry" | "TeePoolEphemeralStandard" | "TeePoolPersistentStandard" | "TeePoolPersistentGpu" | "TeePoolDedicatedStandard" | "TeePoolDedicatedGpu" | "VanaEpoch" | "DLPRegistry" | "DLPRegistryTreasury" | "DLPPerformance" | "DLPRewardDeployer" | "DLPRewardDeployerTreasury" | "DLPRewardSwap" | "SwapHelper" | "VanaPoolStaking" | "VanaPoolEntity" | "VanaPoolTreasury" | "DAT" | "DATFactory" | "DATPausable" | "DATVotes" | "DataLiquidityPool" | "DLPRoot";
 /**
- * Contract information with typed address and ABI
+ * Provides contract deployment information with typed ABI.
+ *
+ * @remarks
+ * Contains the minimum information needed to interact with a
+ * deployed contract: its address and ABI.
+ *
+ * @typeParam TAbi - The contract's ABI type for full type safety
+ *
+ * @category Contracts
  */
 export interface ContractInfo<TAbi extends Abi = Abi> {
     /** The contract's deployed address */
@@ -13,7 +39,13 @@ export interface ContractInfo<TAbi extends Abi = Abi> {
     abi: TAbi;
 }
 /**
- * Contract deployment information
+ * Tracks contract deployment metadata.
+ *
+ * @remarks
+ * Records when and how a contract was deployed to the blockchain,
+ * useful for verification and debugging.
+ *
+ * @category Contracts
  */
 export interface ContractDeployment {
     /** The contract's deployed address */
@@ -24,11 +56,25 @@ export interface ContractDeployment {
     transactionHash: Hash;
 }
 /**
- * Typed contract instance
+ * Represents a fully typed contract instance.
+ *
+ * @remarks
+ * Alias for viem's GetContractReturnType, providing a contract
+ * instance with all methods fully typed based on the ABI.
+ *
+ * @typeParam TAbi - The contract's ABI type
+ *
+ * @category Contracts
  */
 export type VanaContractInstance<TAbi extends Abi = Abi> = GetContractReturnType<TAbi>;
 /**
- * Contract addresses mapping by chain and contract name
+ * Maps contract addresses by chain ID and contract name.
+ *
+ * @remarks
+ * Hierarchical mapping structure for multi-chain contract deployments.
+ * Used internally for address resolution across different networks.
+ *
+ * @category Contracts
  */
 export type ContractAddresses = {
     [chainId: number]: {
@@ -36,7 +82,16 @@ export type ContractAddresses = {
     };
 };
 /**
- * Contract method parameters for typed interactions
+ * Extracts typed parameters for a contract method from its ABI.
+ *
+ * @remarks
+ * Advanced utility type that provides type-safe parameter extraction
+ * from contract ABIs. Maps Solidity types to TypeScript types automatically.
+ *
+ * @typeParam TAbi - The contract's ABI type
+ * @typeParam TFunctionName - The name of the function to extract parameters for
+ *
+ * @internal
  */
 export type ContractMethodParams<TAbi extends Abi, TFunctionName extends string> = TAbi extends readonly unknown[] ? TAbi[number] extends {
     name: TFunctionName;
@@ -49,7 +104,16 @@ export type ContractMethodParams<TAbi extends Abi, TFunctionName extends string>
     } ? TName extends string ? TType extends "address" ? Address : TType extends "uint256" ? bigint : TType extends "string" ? string : TType extends "bool" ? boolean : TType extends "bytes32" ? Hash : unknown : never : never;
 } : never : never : never;
 /**
- * Contract method return type for typed interactions
+ * Extracts typed return values for a contract method from its ABI.
+ *
+ * @remarks
+ * Advanced utility type that provides type-safe return type extraction
+ * from contract ABIs. Handles single values and tuples appropriately.
+ *
+ * @typeParam TAbi - The contract's ABI type
+ * @typeParam TFunctionName - The name of the function to extract return type for
+ *
+ * @internal
  */
 export type ContractMethodReturnType<TAbi extends Abi, TFunctionName extends string> = TAbi extends readonly unknown[] ? TAbi[number] extends {
     name: TFunctionName;

package/dist/types/controller-context.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/controller-context.ts"],"sourcesContent":["/**\n * Shared type definitions for controller contexts.\n *\n * @remarks\n * These types ensure consistency across all controllers and prevent drift.\n * Single source of truth following Rich Hickey's principles.\n */\n\nimport type { WalletClient, PublicClient, Address } from \"viem\";\nimport type { VanaPlatformAdapter } from \"../platform/interface\";\nimport type { StorageManager } from \"../storage\";\nimport type { RelayerCallbacks, DownloadRelayerCallbacks } from \"./config\";\nimport type {\n  TransactionResult,\n  TransactionWaitOptions,\n  Operation,\n  PollingOptions,\n} from \"./operations\";\nimport type {\n  Contract,\n  Fn,\n  TypedTransactionResult,\n} from \"../generated/event-types\";\n\n/**\n * Type definition for waitForTransactionEvents function.\n *\n * @remarks\n * This is THE single definition used everywhere to prevent drift.\n * If you need to change the signature, change it here.\n */\nexport type WaitForTransactionEventsFn = <C extends Contract, F extends Fn<C>>(\n  transaction: TransactionResult<C, F>,\n  options?: TransactionWaitOptions,\n) => Promise<TypedTransactionResult<C, F>>;\n\n/**\n * Type definition for waitForOperation function.\n */\nexport type WaitForOperationFn = <T = unknown>(\n  opOrId: Operation<T> | string,\n  options?: PollingOptions,\n) => Promise<Operation<T>>;\n\n/**\n * Shared controller context interface.\n *\n * @remarks\n * This is the contract that all controllers depend on.\n * Changing this interface is a breaking change.\n */\nexport interface ControllerContext {\n  /** Signs transactions and messages using the user's private key. Optional to support read-only mode. */\n  walletClient?: WalletClient;\n  /** Queries blockchain state and smart contracts without signing. */\n  publicClient: PublicClient;\n  /** Address of the user for operations requiring user identification in read-only mode. */\n  userAddress: Address;\n  /** Signs application-specific operations when different from primary wallet. */\n  applicationClient?: WalletClient;\n  /** Handles gasless transaction submission through relayer services. */\n  relayerCallbacks?: RelayerCallbacks;\n  /** Proxies CORS-restricted downloads through application server. */\n  downloadRelayer?: DownloadRelayerCallbacks;\n  /** Manages file upload and download operations across storage providers. */\n  storageManager?: StorageManager;\n  /** Provides subgraph endpoint for querying indexed blockchain data. */\n  subgraphUrl?: string;\n  /** Adapts SDK functionality to the current runtime environment. */\n  platform: VanaPlatformAdapter;\n  /** Validates that storage is available for storage-dependent operations. */\n  validateStorageRequired?: () => void;\n  /** Checks whether storage is configured without throwing an error. */\n  hasStorage?: () => boolean;\n  /** Default IPFS gateways to use for fetching files. */\n  ipfsGateways?: string[];\n  /** Default personal server base URL for server operations. */\n  defaultPersonalServerUrl?: string;\n  /** Waits for transaction confirmation and parses typed events. */\n  waitForTransactionEvents?: WaitForTransactionEventsFn;\n  /** Waits for an operation to complete with polling. */\n  waitForOperation?: WaitForOperationFn;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/controller-context.ts"],"sourcesContent":["/**\n * Shared type definitions for controller contexts.\n *\n * @remarks\n * These types ensure consistency across all controllers and prevent drift.\n * Single source of truth following Rich Hickey's principles.\n */\n\nimport type { WalletClient, PublicClient, Address } from \"viem\";\nimport type { VanaPlatformAdapter } from \"../platform/interface\";\nimport type { StorageManager } from \"../storage\";\nimport type { DownloadRelayerCallbacks } from \"./config\";\nimport type { UnifiedRelayerRequest, UnifiedRelayerResponse } from \"./relayer\";\nimport type {\n  TransactionResult,\n  TransactionWaitOptions,\n  Operation,\n  PollingOptions,\n} from \"./operations\";\nimport type {\n  Contract,\n  Fn,\n  TypedTransactionResult,\n} from \"../generated/event-types\";\n\n/**\n * Type definition for waitForTransactionEvents function.\n *\n * @remarks\n * This is THE single definition used everywhere to prevent drift.\n * If you need to change the signature, change it here.\n */\nexport type WaitForTransactionEventsFn = <C extends Contract, F extends Fn<C>>(\n  transaction: TransactionResult<C, F>,\n  options?: TransactionWaitOptions,\n) => Promise<TypedTransactionResult<C, F>>;\n\n/**\n * Type definition for waitForOperation function.\n */\nexport type WaitForOperationFn = <T = unknown>(\n  opOrId: Operation<T> | string,\n  options?: PollingOptions,\n) => Promise<Operation<T>>;\n\n/**\n * Shared controller context interface.\n *\n * @remarks\n * This is the contract that all controllers depend on.\n * Changing this interface is a breaking change.\n */\nexport interface ControllerContext {\n  /** Signs transactions and messages using the user's private key. Optional to support read-only mode. */\n  walletClient?: WalletClient;\n  /** Queries blockchain state and smart contracts without signing. */\n  publicClient: PublicClient;\n  /** Address of the user for operations requiring user identification in read-only mode. */\n  userAddress: Address;\n  /** Signs application-specific operations when different from primary wallet. */\n  applicationClient?: WalletClient;\n  /** Handles gasless transaction submission through relayer services. */\n  relayer?: (request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>;\n  /** Proxies CORS-restricted downloads through application server. */\n  downloadRelayer?: DownloadRelayerCallbacks;\n  /** Manages file upload and download operations across storage providers. */\n  storageManager?: StorageManager;\n  /** Provides subgraph endpoint for querying indexed blockchain data. */\n  subgraphUrl?: string;\n  /** Adapts SDK functionality to the current runtime environment. */\n  platform: VanaPlatformAdapter;\n  /** Validates that storage is available for storage-dependent operations. */\n  validateStorageRequired?: () => void;\n  /** Checks whether storage is configured without throwing an error. */\n  hasStorage?: () => boolean;\n  /** Default IPFS gateways to use for fetching files. */\n  ipfsGateways?: string[];\n  /** Default personal server base URL for server operations. */\n  defaultPersonalServerUrl?: string;\n  /** Waits for transaction confirmation and parses typed events. */\n  waitForTransactionEvents?: WaitForTransactionEventsFn;\n  /** Waits for an operation to complete with polling. */\n  waitForOperation?: WaitForOperationFn;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/controller-context.d.ts

@@ -8,7 +8,8 @@
 import type { WalletClient, PublicClient, Address } from "viem";
 import type { VanaPlatformAdapter } from "../platform/interface";
 import type { StorageManager } from "../storage";
-import type { RelayerCallbacks, DownloadRelayerCallbacks } from "./config";
+import type { DownloadRelayerCallbacks } from "./config";
+import type { UnifiedRelayerRequest, UnifiedRelayerResponse } from "./relayer";
 import type { TransactionResult, TransactionWaitOptions, Operation, PollingOptions } from "./operations";
 import type { Contract, Fn, TypedTransactionResult } from "../generated/event-types";
 /**
@@ -40,7 +41,7 @@ export interface ControllerContext {
     /** Signs application-specific operations when different from primary wallet. */
     applicationClient?: WalletClient;
     /** Handles gasless transaction submission through relayer services. */
-    relayerCallbacks?: RelayerCallbacks;
+    relayer?: (request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>;
     /** Proxies CORS-restricted downloads through application server. */
     downloadRelayer?: DownloadRelayerCallbacks;
     /** Manages file upload and download operations across storage providers. */