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

package/dist/types/relayer.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/relayer.ts"],"sourcesContent":["import type { Hash } from \"viem\";\nimport type { GrantFile, PermissionGrantTypedData } from \"./permissions\";\n\n/**\n * Response from the relayer service for grant file storage\n *\n * @category Advanced\n */\nexport interface RelayerStorageResponse {\n  /** The IPFS URL where the grant file is stored */\n  grantUrl: string;\n  /** Success status */\n  success: boolean;\n  /** Optional error message */\n  error?: string;\n  /** Storage metadata */\n  metadata?: {\n    /** IPFS hash */\n    ipfsHash: string;\n    /** File size in bytes */\n    size: number;\n    /** Upload timestamp */\n    timestamp: number;\n  };\n}\n\n/**\n * Response from the relayer service for transaction submission\n *\n * @category Advanced\n */\nexport interface RelayerTransactionResponse {\n  /** The transaction hash of the submitted transaction */\n  transactionHash: Hash;\n  /** Success status */\n  success: boolean;\n  /** Optional error message */\n  error?: string;\n  /** Transaction metadata */\n  metadata?: {\n    /** Gas used */\n    gasUsed?: bigint;\n    /** Gas price */\n    gasPrice?: bigint;\n    /** Block number */\n    blockNumber?: bigint;\n    /** Transaction status */\n    status?: \"pending\" | \"confirmed\" | \"failed\";\n  };\n}\n\n/**\n * Parameters for storing a grant file via relayer\n *\n * @category Advanced\n */\nexport interface RelayerStoreParams {\n  /** The grant file to store */\n  grantFile: GrantFile;\n  /** Optional storage options */\n  options?: {\n    /** IPFS pin duration in seconds */\n    pinDuration?: number;\n    /** Whether to use encryption */\n    encrypt?: boolean;\n    /** Custom metadata */\n    metadata?: Record<string, unknown>;\n  };\n}\n\n/**\n * Parameters for submitting a transaction via relayer\n *\n * @category Advanced\n */\nexport interface RelayerSubmitParams {\n  /** The signed typed data */\n  typedData: PermissionGrantTypedData;\n  /** The signature */\n  signature: string;\n  /** Optional transaction options */\n  options?: {\n    /** Gas limit */\n    gasLimit?: bigint;\n    /** Priority level */\n    priority?: \"low\" | \"medium\" | \"high\";\n    /** Whether to wait for confirmation */\n    waitForConfirmation?: boolean;\n  };\n}\n\n/**\n * Relayer service status\n *\n * @category Advanced\n */\nexport interface RelayerStatus {\n  /** Whether the relayer is online */\n  online: boolean;\n  /** Service version */\n  version: string;\n  /** Supported chains */\n  supportedChains: number[];\n  /** Current chain status */\n  chainStatus: Record<\n    number,\n    {\n      /** Whether the chain is supported */\n      supported: boolean;\n      /** Current block number */\n      currentBlock: bigint;\n      /** Gas price estimation */\n      gasPrice: bigint;\n      /** Queue size */\n      queueSize: number;\n    }\n  >;\n  /** Rate limit information */\n  rateLimits: {\n    /** Requests per minute */\n    requestsPerMinute: number;\n    /** Storage requests per hour */\n    storageRequestsPerHour: number;\n    /** Transaction requests per hour */\n    transactionRequestsPerHour: number;\n  };\n}\n\n/**\n * Relayer configuration\n *\n * @category Advanced\n */\nexport interface RelayerConfig {\n  /** Relayer service URL */\n  url: string;\n  /** API key for authentication */\n  apiKey?: string;\n  /** Timeout for requests in milliseconds */\n  timeout?: number;\n  /** Retry configuration */\n  retry?: {\n    /** Number of retry attempts */\n    attempts: number;\n    /** Delay between retries in milliseconds */\n    delay: number;\n  };\n  /** Whether to use HTTPS */\n  useHttps?: boolean;\n}\n\n/**\n * Relayer request options\n *\n * @category Advanced\n */\nexport interface RelayerRequestOptions {\n  /** Request timeout in milliseconds */\n  timeout?: number;\n  /** Whether to retry on failure */\n  retry?: boolean;\n  /** Custom headers */\n  headers?: Record<string, string>;\n  /** Request priority */\n  priority?: \"low\" | \"medium\" | \"high\";\n}\n\n/**\n * Relayer error response\n *\n * @category Advanced\n */\nexport interface RelayerErrorResponse {\n  /** Error code */\n  code: string;\n  /** Error message */\n  message: string;\n  /** Additional error details */\n  details?: Record<string, unknown>;\n  /** Request ID for debugging */\n  requestId?: string;\n  /** Timestamp of error */\n  timestamp: number;\n}\n\n/**\n * Relayer queue information\n *\n * @category Advanced\n */\nexport interface RelayerQueueInfo {\n  /** Current queue size */\n  size: number;\n  /** Estimated processing time in seconds */\n  estimatedProcessingTime: number;\n  /** Queue position for a specific request */\n  position?: number;\n  /** Processing statistics */\n  stats: {\n    /** Average processing time in seconds */\n    averageProcessingTime: number;\n    /** Requests processed in last hour */\n    requestsProcessedHour: number;\n    /** Success rate percentage */\n    successRate: number;\n  };\n}\n\n/**\n * Relayer transaction status\n *\n * @category Advanced\n */\nexport interface RelayerTransactionStatus {\n  /** Transaction hash */\n  transactionHash: Hash;\n  /** Current status */\n  status: \"pending\" | \"confirmed\" | \"failed\";\n  /** Block number if confirmed */\n  blockNumber?: bigint;\n  /** Gas used */\n  gasUsed?: bigint;\n  /** Error message if failed */\n  error?: string;\n  /** Status checks performed */\n  checks: Array<{\n    /** Check timestamp */\n    timestamp: number;\n    /** Status at time of check */\n    status: string;\n    /** Block number at time of check */\n    blockNumber: bigint;\n  }>;\n}\n\n/**\n * Relayer metrics\n *\n * @category Advanced\n */\nexport interface RelayerMetrics {\n  /** Total transactions processed */\n  totalTransactions: number;\n  /** Successful transactions */\n  successfulTransactions: number;\n  /** Failed transactions */\n  failedTransactions: number;\n  /** Average processing time in seconds */\n  averageProcessingTime: number;\n  /** Current queue size */\n  queueSize: number;\n  /** Uptime percentage */\n  uptime: number;\n  /** Last 24 hour statistics */\n  last24Hours: {\n    /** Transactions processed */\n    transactions: number;\n    /** Success rate */\n    successRate: number;\n    /** Average response time */\n    averageResponseTime: number;\n  };\n}\n\n/**\n * Relayer webhook configuration\n *\n * @category Advanced\n */\nexport interface RelayerWebhookConfig {\n  /** Webhook URL */\n  url: string;\n  /** Events to subscribe to */\n  events: Array<\n    \"transaction_confirmed\" | \"transaction_failed\" | \"storage_complete\"\n  >;\n  /** Webhook secret for signature verification */\n  secret?: string;\n  /** Whether webhook is active */\n  active: boolean;\n}\n\n/**\n * Relayer webhook payload\n *\n * @category Advanced\n */\nexport interface RelayerWebhookPayload {\n  /** Event type */\n  event: string;\n  /** Event data */\n  data: Record<string, unknown>;\n  /** Timestamp */\n  timestamp: number;\n  /** Webhook ID */\n  webhookId: string;\n  /** Signature for verification */\n  signature: string;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/relayer.ts"],"sourcesContent":["/**\n * Defines types for gasless transaction relayers and server operations.\n *\n * @remarks\n * This module provides comprehensive type definitions for interacting with\n * relayer services that enable gasless transactions and auxiliary operations.\n * It includes both legacy v1 types and the simplified v2 unified interface.\n *\n * @category Types\n * @module types/relayer\n */\n\nimport type { Hash, Address } from \"viem\";\nimport type {\n  GrantFile,\n  PermissionGrantTypedData,\n  GenericTypedData,\n} from \"./permissions\";\n\n/**\n * Represents the response from storing grant files via relayer.\n *\n * @remarks\n * Contains storage location, metadata, and error information for\n * grant file upload operations.\n *\n * @category Advanced\n */\nexport interface RelayerStorageResponse {\n  /** The IPFS URL where the grant file is stored */\n  grantUrl: string;\n  /** Success status */\n  success: boolean;\n  /** Optional error message */\n  error?: string;\n  /** Storage metadata */\n  metadata?: {\n    /** IPFS hash */\n    ipfsHash: string;\n    /** File size in bytes */\n    size: number;\n    /** Upload timestamp */\n    timestamp: number;\n  };\n}\n\n/**\n * Represents the response from submitting transactions via relayer.\n *\n * @remarks\n * Contains transaction hash, status, and metadata for gasless\n * transaction submissions.\n *\n * @category Advanced\n */\nexport interface RelayerTransactionResponse {\n  /** The transaction hash of the submitted transaction */\n  transactionHash: Hash;\n  /** Success status */\n  success: boolean;\n  /** Optional error message */\n  error?: string;\n  /** Transaction metadata */\n  metadata?: {\n    /** Gas used */\n    gasUsed?: bigint;\n    /** Gas price */\n    gasPrice?: bigint;\n    /** Block number */\n    blockNumber?: bigint;\n    /** Transaction status */\n    status?: \"pending\" | \"confirmed\" | \"failed\";\n  };\n}\n\n/**\n * Specifies parameters for storing grant files via relayer.\n *\n * @remarks\n * Includes the grant file and optional storage configuration\n * such as encryption and pinning duration.\n *\n * @category Advanced\n */\nexport interface RelayerStoreParams {\n  /** The grant file to store */\n  grantFile: GrantFile;\n  /** Optional storage options */\n  options?: {\n    /** IPFS pin duration in seconds */\n    pinDuration?: number;\n    /** Whether to use encryption */\n    encrypt?: boolean;\n    /** Custom metadata */\n    metadata?: Record<string, unknown>;\n  };\n}\n\n/**\n * Specifies parameters for submitting gasless transactions.\n *\n * @remarks\n * Contains signed typed data and transaction configuration options\n * for relayer submission.\n *\n * @category Advanced\n */\nexport interface RelayerSubmitParams {\n  /** The signed typed data */\n  typedData: PermissionGrantTypedData;\n  /** The signature */\n  signature: string;\n  /** Optional transaction options */\n  options?: {\n    /** Gas limit */\n    gasLimit?: bigint;\n    /** Priority level */\n    priority?: \"low\" | \"medium\" | \"high\";\n    /** Whether to wait for confirmation */\n    waitForConfirmation?: boolean;\n  };\n}\n\n/**\n * Represents the current status and capabilities of a relayer service.\n *\n * @remarks\n * Provides information about supported chains, rate limits, and\n * current operational status for monitoring and decision-making.\n *\n * @category Advanced\n */\nexport interface RelayerStatus {\n  /** Whether the relayer is online */\n  online: boolean;\n  /** Service version */\n  version: string;\n  /** Supported chains */\n  supportedChains: number[];\n  /** Current chain status */\n  chainStatus: Record<\n    number,\n    {\n      /** Whether the chain is supported */\n      supported: boolean;\n      /** Current block number */\n      currentBlock: bigint;\n      /** Gas price estimation */\n      gasPrice: bigint;\n      /** Queue size */\n      queueSize: number;\n    }\n  >;\n  /** Rate limit information */\n  rateLimits: {\n    /** Requests per minute */\n    requestsPerMinute: number;\n    /** Storage requests per hour */\n    storageRequestsPerHour: number;\n    /** Transaction requests per hour */\n    transactionRequestsPerHour: number;\n  };\n}\n\n/**\n * Configures behavior for relayer requests.\n *\n * @remarks\n * Controls timeout, retry logic, headers, and priority for\n * relayer operation requests.\n *\n * @category Advanced\n */\nexport interface RelayerRequestOptions {\n  /** Request timeout in milliseconds */\n  timeout?: number;\n  /** Whether to retry on failure */\n  retry?: boolean;\n  /** Custom headers */\n  headers?: Record<string, string>;\n  /** Request priority */\n  priority?: \"low\" | \"medium\" | \"high\";\n}\n\n/**\n * Represents an error response from the relayer service.\n *\n * @remarks\n * Provides structured error information including codes, messages,\n * and debugging details for error handling and recovery.\n *\n * @category Advanced\n */\nexport interface RelayerErrorResponse {\n  /** Error code */\n  code: string;\n  /** Error message */\n  message: string;\n  /** Additional error details */\n  details?: Record<string, unknown>;\n  /** Request ID for debugging */\n  requestId?: string;\n  /** Timestamp of error */\n  timestamp: number;\n}\n\n/**\n * Provides information about the relayer's processing queue.\n *\n * @remarks\n * Includes queue size, position, estimated processing time, and\n * performance statistics for queue monitoring.\n *\n * @category Advanced\n */\nexport interface RelayerQueueInfo {\n  /** Current queue size */\n  size: number;\n  /** Estimated processing time in seconds */\n  estimatedProcessingTime: number;\n  /** Queue position for a specific request */\n  position?: number;\n  /** Processing statistics */\n  stats: {\n    /** Average processing time in seconds */\n    averageProcessingTime: number;\n    /** Requests processed in last hour */\n    requestsProcessedHour: number;\n    /** Success rate percentage */\n    successRate: number;\n  };\n}\n\n/**\n * Tracks the status of a transaction submitted via relayer.\n *\n * @remarks\n * Provides detailed tracking information including confirmation status,\n * gas usage, and historical status checks.\n *\n * @category Advanced\n */\nexport interface RelayerTransactionStatus {\n  /** Transaction hash */\n  transactionHash: Hash;\n  /** Current status */\n  status: \"pending\" | \"confirmed\" | \"failed\";\n  /** Block number if confirmed */\n  blockNumber?: bigint;\n  /** Gas used */\n  gasUsed?: bigint;\n  /** Error message if failed */\n  error?: string;\n  /** Status checks performed */\n  checks: Array<{\n    /** Check timestamp */\n    timestamp: number;\n    /** Status at time of check */\n    status: string;\n    /** Block number at time of check */\n    blockNumber: bigint;\n  }>;\n}\n\n/**\n * Provides performance metrics for the relayer service.\n *\n * @remarks\n * Includes transaction statistics, success rates, processing times,\n * and uptime information for monitoring and optimization.\n *\n * @category Advanced\n */\nexport interface RelayerMetrics {\n  /** Total transactions processed */\n  totalTransactions: number;\n  /** Successful transactions */\n  successfulTransactions: number;\n  /** Failed transactions */\n  failedTransactions: number;\n  /** Average processing time in seconds */\n  averageProcessingTime: number;\n  /** Current queue size */\n  queueSize: number;\n  /** Uptime percentage */\n  uptime: number;\n  /** Last 24 hour statistics */\n  last24Hours: {\n    /** Transactions processed */\n    transactions: number;\n    /** Success rate */\n    successRate: number;\n    /** Average response time */\n    averageResponseTime: number;\n  };\n}\n\n/**\n * Configures webhook notifications for relayer events.\n *\n * @remarks\n * Enables asynchronous notifications for transaction confirmations,\n * failures, and storage completions.\n *\n * @category Advanced\n */\nexport interface RelayerWebhookConfig {\n  /** Webhook URL */\n  url: string;\n  /** Events to subscribe to */\n  events: Array<\n    \"transaction_confirmed\" | \"transaction_failed\" | \"storage_complete\"\n  >;\n  /** Webhook secret for signature verification */\n  secret?: string;\n  /** Whether webhook is active */\n  active: boolean;\n}\n\n/**\n * Represents a webhook event payload from the relayer.\n *\n * @remarks\n * Contains event data, timestamp, and signature for verification\n * of webhook authenticity.\n *\n * @category Advanced\n */\nexport interface RelayerWebhookPayload {\n  /** Event type */\n  event: string;\n  /** Event data */\n  data: Record<string, unknown>;\n  /** Timestamp */\n  timestamp: number;\n  /** Webhook ID */\n  webhookId: string;\n  /** Signature for verification */\n  signature: string;\n}\n\n// ===== NEW SIMPLIFIED RELAYER TYPES (v2) =====\n\n/**\n * Handles both EIP-712 signed operations and direct server operations through a single interface.\n *\n * @remarks\n * This discriminated union provides type safety through TypeScript's narrowing.\n * The `type` field determines which operation variant is being used.\n * Signed operations require blockchain transactions, while direct operations\n * handle auxiliary tasks like file storage.\n *\n * @category Relayer\n * @see {@link https://docs.vana.org/docs/gasless-transactions | Gasless Transactions Guide}\n */\nexport type UnifiedRelayerRequest = SignedRelayerRequest | DirectRelayerRequest;\n\n/**\n * Represents an EIP-712 signed operation for gasless transaction submission.\n *\n * @remarks\n * Signed requests contain typed data and signatures that are verified\n * on-chain by smart contracts. The relayer pays gas fees on behalf of users.\n *\n * @category Relayer\n */\nexport interface SignedRelayerRequest {\n  /** Discriminator field identifying this as a signed operation */\n  type: \"signed\";\n  /** Operation identifier for routing (e.g., 'submitAddPermission') */\n  operation: SignedOperationType;\n  /** EIP-712 typed data structure for the operation */\n  typedData: GenericTypedData;\n  /** User's signature of the typed data */\n  signature: Hash;\n  /** Optional address for additional signer verification */\n  expectedUserAddress?: Address;\n}\n\n/**\n * Enumerates supported EIP-712 signed operation types.\n *\n * @remarks\n * Each operation type corresponds to a specific smart contract\n * function that accepts gasless transactions.\n *\n * @category Relayer\n */\nexport type SignedOperationType =\n  | \"submitAddPermission\"\n  | \"submitPermissionRevoke\"\n  | \"submitTrustServer\"\n  | \"submitAddAndTrustServer\"\n  | \"submitUntrustServer\"\n  | \"submitAddServerFilesAndPermissions\"\n  | \"submitRegisterGrantee\";\n\n/**\n * Represents direct server operations that don't require blockchain signatures.\n *\n * @remarks\n * Direct requests handle auxiliary operations like file uploads and grant storage.\n * These operations may still result in blockchain transactions but don't require\n * user signatures for gasless submission.\n *\n * @category Relayer\n */\nexport type DirectRelayerRequest =\n  | {\n      type: \"direct\";\n      operation: \"submitFileAddition\";\n      params: {\n        url: string;\n        userAddress: Address;\n      };\n    }\n  | {\n      type: \"direct\";\n      operation: \"submitFileAdditionWithPermissions\";\n      params: {\n        url: string;\n        userAddress: Address;\n        permissions: Array<{ account: Address; key: string }>;\n      };\n    }\n  | {\n      type: \"direct\";\n      operation: \"submitFileAdditionComplete\";\n      params: {\n        url: string;\n        userAddress: Address;\n        permissions: Array<{ account: Address; key: string }>;\n        schemaId: number;\n        ownerAddress?: Address;\n      };\n    }\n  | {\n      type: \"direct\";\n      operation: \"storeGrantFile\";\n      params: GrantFile;\n    };\n\n/**\n * Provides type-safe responses for all relayer operations.\n *\n * @remarks\n * The discriminated union ensures proper error handling and result typing.\n * Check the `type` field to determine success or failure before accessing results.\n *\n * @category Relayer\n */\nexport type UnifiedRelayerResponse =\n  | {\n      type: \"signed\";\n      hash: Hash;\n    }\n  | {\n      type: \"direct\";\n      result: { fileId: number; transactionHash: Hash } | { url: string } | any;\n    }\n  | {\n      type: \"error\";\n      error: string;\n    };\n\n/**\n * Simplified relayer configuration.\n * Can be a URL string for convenience, or a callback for full control.\n *\n * @category Configuration\n * @example\n * ```typescript\n * // Option 1: Simple URL (SDK handles the transport)\n * const vana = Vana({\n *   walletClient,\n *   relayer: '/api/relay'\n * });\n *\n * // Option 2: Full control with callback\n * const vana = Vana({\n *   walletClient,\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 */\nexport type RelayerConfig =\n  | string\n  | ((request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>);\n\n/**\n * Simplified relayer callbacks interface (v2).\n * A single callback handles all relayer operations.\n *\n * @category Configuration\n * @example\n * ```typescript\n * const relayerCallbacks: RelayerCallbacksV2 = {\n *   submit: async (request) => {\n *     // Send to your server endpoint\n *     const response = await fetch('/api/relay', {\n *       method: 'POST',\n *       headers: { 'Content-Type': 'application/json' },\n *       body: JSON.stringify(request)\n *     });\n *     return response.json();\n *   }\n * };\n * ```\n */\nexport interface RelayerCallbacksV2 {\n  /**\n   * Submits any relayer operation to the server.\n   *\n   * @remarks\n   * This single callback handles all operations:\n   * - EIP-712 signed operations (permissions, server trust, etc.)\n   * - Direct operations (file additions, grant storage)\n   *\n   * On your server, pass the entire request object to the SDK's\n   * `handleRelayerOperation` helper function.\n   *\n   * @param request - The unified request object.\n   *   Check `type` field to determine operation variant.\n   * @returns Promise resolving to operation-specific response\n   *\n   * @example\n   * ```typescript\n   * async submit(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  submit: (request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/relayer.d.ts

@@ -1,7 +1,22 @@
-import type { Hash } from "viem";
-import type { GrantFile, PermissionGrantTypedData } from "./permissions";
 /**
- * Response from the relayer service for grant file storage
+ * Defines types for gasless transaction relayers and server operations.
+ *
+ * @remarks
+ * This module provides comprehensive type definitions for interacting with
+ * relayer services that enable gasless transactions and auxiliary operations.
+ * It includes both legacy v1 types and the simplified v2 unified interface.
+ *
+ * @category Types
+ * @module types/relayer
+ */
+import type { Hash, Address } from "viem";
+import type { GrantFile, PermissionGrantTypedData, GenericTypedData } from "./permissions";
+/**
+ * Represents the response from storing grant files via relayer.
+ *
+ * @remarks
+ * Contains storage location, metadata, and error information for
+ * grant file upload operations.
  *
  * @category Advanced
  */
@@ -23,7 +38,11 @@ export interface RelayerStorageResponse {
     };
 }
 /**
- * Response from the relayer service for transaction submission
+ * Represents the response from submitting transactions via relayer.
+ *
+ * @remarks
+ * Contains transaction hash, status, and metadata for gasless
+ * transaction submissions.
  *
  * @category Advanced
  */
@@ -47,7 +66,11 @@ export interface RelayerTransactionResponse {
     };
 }
 /**
- * Parameters for storing a grant file via relayer
+ * Specifies parameters for storing grant files via relayer.
+ *
+ * @remarks
+ * Includes the grant file and optional storage configuration
+ * such as encryption and pinning duration.
  *
  * @category Advanced
  */
@@ -65,7 +88,11 @@ export interface RelayerStoreParams {
     };
 }
 /**
- * Parameters for submitting a transaction via relayer
+ * Specifies parameters for submitting gasless transactions.
+ *
+ * @remarks
+ * Contains signed typed data and transaction configuration options
+ * for relayer submission.
  *
  * @category Advanced
  */
@@ -85,7 +112,11 @@ export interface RelayerSubmitParams {
     };
 }
 /**
- * Relayer service status
+ * Represents the current status and capabilities of a relayer service.
+ *
+ * @remarks
+ * Provides information about supported chains, rate limits, and
+ * current operational status for monitoring and decision-making.
  *
  * @category Advanced
  */
@@ -118,29 +149,11 @@ export interface RelayerStatus {
     };
 }
 /**
- * Relayer configuration
+ * Configures behavior for relayer requests.
  *
- * @category Advanced
- */
-export interface RelayerConfig {
-    /** Relayer service URL */
-    url: string;
-    /** API key for authentication */
-    apiKey?: string;
-    /** Timeout for requests in milliseconds */
-    timeout?: number;
-    /** Retry configuration */
-    retry?: {
-        /** Number of retry attempts */
-        attempts: number;
-        /** Delay between retries in milliseconds */
-        delay: number;
-    };
-    /** Whether to use HTTPS */
-    useHttps?: boolean;
-}
-/**
- * Relayer request options
+ * @remarks
+ * Controls timeout, retry logic, headers, and priority for
+ * relayer operation requests.
  *
  * @category Advanced
  */
@@ -155,7 +168,11 @@ export interface RelayerRequestOptions {
     priority?: "low" | "medium" | "high";
 }
 /**
- * Relayer error response
+ * Represents an error response from the relayer service.
+ *
+ * @remarks
+ * Provides structured error information including codes, messages,
+ * and debugging details for error handling and recovery.
  *
  * @category Advanced
  */
@@ -172,7 +189,11 @@ export interface RelayerErrorResponse {
     timestamp: number;
 }
 /**
- * Relayer queue information
+ * Provides information about the relayer's processing queue.
+ *
+ * @remarks
+ * Includes queue size, position, estimated processing time, and
+ * performance statistics for queue monitoring.
  *
  * @category Advanced
  */
@@ -194,7 +215,11 @@ export interface RelayerQueueInfo {
     };
 }
 /**
- * Relayer transaction status
+ * Tracks the status of a transaction submitted via relayer.
+ *
+ * @remarks
+ * Provides detailed tracking information including confirmation status,
+ * gas usage, and historical status checks.
  *
  * @category Advanced
  */
@@ -220,7 +245,11 @@ export interface RelayerTransactionStatus {
     }>;
 }
 /**
- * Relayer metrics
+ * Provides performance metrics for the relayer service.
+ *
+ * @remarks
+ * Includes transaction statistics, success rates, processing times,
+ * and uptime information for monitoring and optimization.
  *
  * @category Advanced
  */
@@ -248,7 +277,11 @@ export interface RelayerMetrics {
     };
 }
 /**
- * Relayer webhook configuration
+ * Configures webhook notifications for relayer events.
+ *
+ * @remarks
+ * Enables asynchronous notifications for transaction confirmations,
+ * failures, and storage completions.
  *
  * @category Advanced
  */
@@ -263,7 +296,11 @@ export interface RelayerWebhookConfig {
     active: boolean;
 }
 /**
- * Relayer webhook payload
+ * Represents a webhook event payload from the relayer.
+ *
+ * @remarks
+ * Contains event data, timestamp, and signature for verification
+ * of webhook authenticity.
  *
  * @category Advanced
  */
@@ -279,3 +316,193 @@ export interface RelayerWebhookPayload {
     /** Signature for verification */
     signature: string;
 }
+/**
+ * Handles both EIP-712 signed operations and direct server operations through a single interface.
+ *
+ * @remarks
+ * This discriminated union provides type safety through TypeScript's narrowing.
+ * The `type` field determines which operation variant is being used.
+ * Signed operations require blockchain transactions, while direct operations
+ * handle auxiliary tasks like file storage.
+ *
+ * @category Relayer
+ * @see {@link https://docs.vana.org/docs/gasless-transactions | Gasless Transactions Guide}
+ */
+export type UnifiedRelayerRequest = SignedRelayerRequest | DirectRelayerRequest;
+/**
+ * Represents an EIP-712 signed operation for gasless transaction submission.
+ *
+ * @remarks
+ * Signed requests contain typed data and signatures that are verified
+ * on-chain by smart contracts. The relayer pays gas fees on behalf of users.
+ *
+ * @category Relayer
+ */
+export interface SignedRelayerRequest {
+    /** Discriminator field identifying this as a signed operation */
+    type: "signed";
+    /** Operation identifier for routing (e.g., 'submitAddPermission') */
+    operation: SignedOperationType;
+    /** EIP-712 typed data structure for the operation */
+    typedData: GenericTypedData;
+    /** User's signature of the typed data */
+    signature: Hash;
+    /** Optional address for additional signer verification */
+    expectedUserAddress?: Address;
+}
+/**
+ * Enumerates supported EIP-712 signed operation types.
+ *
+ * @remarks
+ * Each operation type corresponds to a specific smart contract
+ * function that accepts gasless transactions.
+ *
+ * @category Relayer
+ */
+export type SignedOperationType = "submitAddPermission" | "submitPermissionRevoke" | "submitTrustServer" | "submitAddAndTrustServer" | "submitUntrustServer" | "submitAddServerFilesAndPermissions" | "submitRegisterGrantee";
+/**
+ * Represents direct server operations that don't require blockchain signatures.
+ *
+ * @remarks
+ * Direct requests handle auxiliary operations like file uploads and grant storage.
+ * These operations may still result in blockchain transactions but don't require
+ * user signatures for gasless submission.
+ *
+ * @category Relayer
+ */
+export type DirectRelayerRequest = {
+    type: "direct";
+    operation: "submitFileAddition";
+    params: {
+        url: string;
+        userAddress: Address;
+    };
+} | {
+    type: "direct";
+    operation: "submitFileAdditionWithPermissions";
+    params: {
+        url: string;
+        userAddress: Address;
+        permissions: Array<{
+            account: Address;
+            key: string;
+        }>;
+    };
+} | {
+    type: "direct";
+    operation: "submitFileAdditionComplete";
+    params: {
+        url: string;
+        userAddress: Address;
+        permissions: Array<{
+            account: Address;
+            key: string;
+        }>;
+        schemaId: number;
+        ownerAddress?: Address;
+    };
+} | {
+    type: "direct";
+    operation: "storeGrantFile";
+    params: GrantFile;
+};
+/**
+ * Provides type-safe responses for all relayer operations.
+ *
+ * @remarks
+ * The discriminated union ensures proper error handling and result typing.
+ * Check the `type` field to determine success or failure before accessing results.
+ *
+ * @category Relayer
+ */
+export type UnifiedRelayerResponse = {
+    type: "signed";
+    hash: Hash;
+} | {
+    type: "direct";
+    result: {
+        fileId: number;
+        transactionHash: Hash;
+    } | {
+        url: string;
+    } | any;
+} | {
+    type: "error";
+    error: string;
+};
+/**
+ * Simplified relayer configuration.
+ * Can be a URL string for convenience, or a callback for full control.
+ *
+ * @category Configuration
+ * @example
+ * ```typescript
+ * // Option 1: Simple URL (SDK handles the transport)
+ * const vana = Vana({
+ *   walletClient,
+ *   relayer: '/api/relay'
+ * });
+ *
+ * // Option 2: Full control with callback
+ * const vana = Vana({
+ *   walletClient,
+ *   relayer: async (request) => {
+ *     const response = await fetch('/api/relay', {
+ *       method: 'POST',
+ *       body: JSON.stringify(request)
+ *     });
+ *     return response.json();
+ *   }
+ * });
+ * ```
+ */
+export type RelayerConfig = string | ((request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>);
+/**
+ * Simplified relayer callbacks interface (v2).
+ * A single callback handles all relayer operations.
+ *
+ * @category Configuration
+ * @example
+ * ```typescript
+ * const relayerCallbacks: RelayerCallbacksV2 = {
+ *   submit: async (request) => {
+ *     // Send to your server endpoint
+ *     const response = await fetch('/api/relay', {
+ *       method: 'POST',
+ *       headers: { 'Content-Type': 'application/json' },
+ *       body: JSON.stringify(request)
+ *     });
+ *     return response.json();
+ *   }
+ * };
+ * ```
+ */
+export interface RelayerCallbacksV2 {
+    /**
+     * Submits any relayer operation to the server.
+     *
+     * @remarks
+     * This single callback handles all operations:
+     * - EIP-712 signed operations (permissions, server trust, etc.)
+     * - Direct operations (file additions, grant storage)
+     *
+     * On your server, pass the entire request object to the SDK's
+     * `handleRelayerOperation` helper function.
+     *
+     * @param request - The unified request object.
+     *   Check `type` field to determine operation variant.
+     * @returns Promise resolving to operation-specific response
+     *
+     * @example
+     * ```typescript
+     * async submit(request) {
+     *   const response = await fetch('/api/relay', {
+     *     method: 'POST',
+     *     body: JSON.stringify(request)
+     *   });
+     *   return response.json();
+     * }
+     * ```
+     */
+    submit: (request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>;
+}

package/dist/types/storage.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/storage.ts"],"sourcesContent":["/**\n * Interface for storage providers that handle file upload, download, and management operations.\n *\n * Storage providers abstract different storage backends (IPFS, Google Drive, Pinata, etc.)\n * behind a common interface. The SDK uses these providers to store encrypted user data\n * and permission grants in a decentralized manner.\n *\n * @category Storage\n * @example\n * ```typescript\n * // Implement a custom storage provider\n * class MyStorageProvider implements StorageProvider {\n *   async upload(file: Blob, filename?: string): Promise<StorageUploadResult> {\n *     // Custom upload logic\n *     return { url: 'https://my-storage.com/file.dat', size: file.size };\n *   }\n *\n *   async download(url: string): Promise<Blob> {\n *     // Custom download logic\n *     const response = await fetch(url);\n *     return response.blob();\n *   }\n *\n *   async list(options?: StorageListOptions): Promise<StorageFile[]> {\n *     // Return list of files\n *     return [];\n *   }\n *\n *   async delete(url: string): Promise<void> {\n *     // Delete file implementation\n *   }\n * }\n * ```\n */\nexport interface StorageProvider {\n  /**\n   * Upload a file to the storage provider\n   *\n   * @param file - The file to upload\n   * @param filename - Optional custom filename\n   * @returns Promise with storage URL and metadata\n   */\n  upload(file: Blob, filename?: string): Promise<StorageUploadResult>;\n\n  /**\n   * Download a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with file blob\n   */\n  download(url: string): Promise<Blob>;\n\n  /**\n   * List files from the storage provider\n   *\n   * @param options - Optional filtering and pagination\n   * @returns Promise with file list\n   */\n  list(options?: StorageListOptions): Promise<StorageFile[]>;\n\n  /**\n   * Delete a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with success status\n   */\n  delete(url: string): Promise<boolean>;\n\n  /**\n   * Get provider-specific configuration\n   *\n   * @returns Provider configuration object\n   */\n  getConfig(): StorageProviderConfig;\n}\n\nexport interface StorageUploadResult {\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageFile {\n  /** File identifier */\n  id: string;\n  /** File name */\n  name: string;\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Upload timestamp */\n  createdAt: Date;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageListOptions {\n  /** Maximum number of files to return */\n  limit?: number;\n  /** Pagination cursor/offset */\n  offset?: string | number;\n  /** Filter by file name pattern */\n  namePattern?: string;\n  /** Filter by content type */\n  contentType?: string;\n}\n\nexport interface StorageProviderConfig {\n  /** Provider name */\n  name: string;\n  /** Provider type */\n  type: string;\n  /** Whether authentication is required */\n  requiresAuth: boolean;\n  /** Supported features */\n  features: {\n    upload: boolean;\n    download: boolean;\n    list: boolean;\n    delete: boolean;\n  };\n}\n\nexport class StorageError extends Error {\n  public readonly code: string;\n  public readonly provider: string;\n  // The 'cause' property is now inherited from the base Error class\n\n  constructor(\n    message: string,\n    code: string,\n    provider: string,\n    options?: { cause?: Error },\n  ) {\n    // Pass the options object with 'cause' to the super constructor\n    super(message, options);\n    this.name = \"StorageError\";\n    this.code = code;\n    this.provider = provider;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAmIO,MAAM,qBAAqB,MAAM;AAAA,EACtB;AAAA,EACA;AAAA;AAAA,EAGhB,YACE,SACA,MACA,UACA,SACA;AAEA,UAAM,SAAS,OAAO;AACtB,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,WAAW;AAAA,EAClB;AACF;","names":[]}
+{"version":3,"sources":["../../src/types/storage.ts"],"sourcesContent":["/**\n * Defines interface for storage provider implementations.\n *\n * @remarks\n * Abstracts storage backends (IPFS, Google Drive, Pinata) behind\n * common interface for encrypted file operations.\n *\n * @category Storage\n * @example\n * ```typescript\n * class MyStorage implements StorageProvider {\n *   async upload(file: Blob): Promise<StorageUploadResult> {\n *     const url = await uploadToService(file);\n *     return { url, size: file.size, contentType: file.type };\n *   }\n *\n *   async download(url: string): Promise<Blob> {\n *     return fetch(url).then(r => r.blob());\n *   }\n * }\n * ```\n */\nexport interface StorageProvider {\n  /**\n   * Upload a file to the storage provider\n   *\n   * @param file - The file to upload\n   * @param filename - Optional custom filename\n   * @returns Promise with storage URL and metadata\n   */\n  upload(file: Blob, filename?: string): Promise<StorageUploadResult>;\n\n  /**\n   * Download a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with file blob\n   */\n  download(url: string): Promise<Blob>;\n\n  /**\n   * List files from the storage provider\n   *\n   * @param options - Optional filtering and pagination\n   * @returns Promise with file list\n   */\n  list(options?: StorageListOptions): Promise<StorageFile[]>;\n\n  /**\n   * Delete a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with success status\n   */\n  delete(url: string): Promise<boolean>;\n\n  /**\n   * Get provider-specific configuration\n   *\n   * @returns Provider configuration object\n   */\n  getConfig(): StorageProviderConfig;\n}\n\nexport interface StorageUploadResult {\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageFile {\n  /** File identifier */\n  id: string;\n  /** File name */\n  name: string;\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Upload timestamp */\n  createdAt: Date;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageListOptions {\n  /** Maximum number of files to return */\n  limit?: number;\n  /** Pagination cursor/offset */\n  offset?: string | number;\n  /** Filter by file name pattern */\n  namePattern?: string;\n  /** Filter by content type */\n  contentType?: string;\n}\n\nexport interface StorageProviderConfig {\n  /** Provider name */\n  name: string;\n  /** Provider type */\n  type: string;\n  /** Whether authentication is required */\n  requiresAuth: boolean;\n  /** Supported features */\n  features: {\n    upload: boolean;\n    download: boolean;\n    list: boolean;\n    delete: boolean;\n  };\n}\n\nexport class StorageError extends Error {\n  public readonly code: string;\n  public readonly provider: string;\n  // The 'cause' property is now inherited from the base Error class\n\n  constructor(\n    message: string,\n    code: string,\n    provider: string,\n    options?: { cause?: Error },\n  ) {\n    // Pass the options object with 'cause' to the super constructor\n    super(message, options);\n    this.name = \"StorageError\";\n    this.code = code;\n    this.provider = provider;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAuHO,MAAM,qBAAqB,MAAM;AAAA,EACtB;AAAA,EACA;AAAA;AAAA,EAGhB,YACE,SACA,MACA,UACA,SACA;AAEA,UAAM,SAAS,OAAO;AACtB,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,WAAW;AAAA,EAClB;AACF;","names":[]}

package/dist/types/storage.d.ts

@@ -1,33 +1,21 @@
 /**
- * Interface for storage providers that handle file upload, download, and management operations.
+ * Defines interface for storage provider implementations.
  *
- * Storage providers abstract different storage backends (IPFS, Google Drive, Pinata, etc.)
- * behind a common interface. The SDK uses these providers to store encrypted user data
- * and permission grants in a decentralized manner.
+ * @remarks
+ * Abstracts storage backends (IPFS, Google Drive, Pinata) behind
+ * common interface for encrypted file operations.
  *
  * @category Storage
  * @example
  * ```typescript
- * // Implement a custom storage provider
- * class MyStorageProvider implements StorageProvider {
- *   async upload(file: Blob, filename?: string): Promise<StorageUploadResult> {
- *     // Custom upload logic
- *     return { url: 'https://my-storage.com/file.dat', size: file.size };
+ * class MyStorage implements StorageProvider {
+ *   async upload(file: Blob): Promise<StorageUploadResult> {
+ *     const url = await uploadToService(file);
+ *     return { url, size: file.size, contentType: file.type };
  *   }
  *
  *   async download(url: string): Promise<Blob> {
- *     // Custom download logic
- *     const response = await fetch(url);
- *     return response.blob();
- *   }
- *
- *   async list(options?: StorageListOptions): Promise<StorageFile[]> {
- *     // Return list of files
- *     return [];
- *   }
- *
- *   async delete(url: string): Promise<void> {
- *     // Delete file implementation
+ *     return fetch(url).then(r => r.blob());
  *   }
  * }
  * ```

package/dist/types/storage.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/storage.ts"],"sourcesContent":["/**\n * Interface for storage providers that handle file upload, download, and management operations.\n *\n * Storage providers abstract different storage backends (IPFS, Google Drive, Pinata, etc.)\n * behind a common interface. The SDK uses these providers to store encrypted user data\n * and permission grants in a decentralized manner.\n *\n * @category Storage\n * @example\n * ```typescript\n * // Implement a custom storage provider\n * class MyStorageProvider implements StorageProvider {\n *   async upload(file: Blob, filename?: string): Promise<StorageUploadResult> {\n *     // Custom upload logic\n *     return { url: 'https://my-storage.com/file.dat', size: file.size };\n *   }\n *\n *   async download(url: string): Promise<Blob> {\n *     // Custom download logic\n *     const response = await fetch(url);\n *     return response.blob();\n *   }\n *\n *   async list(options?: StorageListOptions): Promise<StorageFile[]> {\n *     // Return list of files\n *     return [];\n *   }\n *\n *   async delete(url: string): Promise<void> {\n *     // Delete file implementation\n *   }\n * }\n * ```\n */\nexport interface StorageProvider {\n  /**\n   * Upload a file to the storage provider\n   *\n   * @param file - The file to upload\n   * @param filename - Optional custom filename\n   * @returns Promise with storage URL and metadata\n   */\n  upload(file: Blob, filename?: string): Promise<StorageUploadResult>;\n\n  /**\n   * Download a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with file blob\n   */\n  download(url: string): Promise<Blob>;\n\n  /**\n   * List files from the storage provider\n   *\n   * @param options - Optional filtering and pagination\n   * @returns Promise with file list\n   */\n  list(options?: StorageListOptions): Promise<StorageFile[]>;\n\n  /**\n   * Delete a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with success status\n   */\n  delete(url: string): Promise<boolean>;\n\n  /**\n   * Get provider-specific configuration\n   *\n   * @returns Provider configuration object\n   */\n  getConfig(): StorageProviderConfig;\n}\n\nexport interface StorageUploadResult {\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageFile {\n  /** File identifier */\n  id: string;\n  /** File name */\n  name: string;\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Upload timestamp */\n  createdAt: Date;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageListOptions {\n  /** Maximum number of files to return */\n  limit?: number;\n  /** Pagination cursor/offset */\n  offset?: string | number;\n  /** Filter by file name pattern */\n  namePattern?: string;\n  /** Filter by content type */\n  contentType?: string;\n}\n\nexport interface StorageProviderConfig {\n  /** Provider name */\n  name: string;\n  /** Provider type */\n  type: string;\n  /** Whether authentication is required */\n  requiresAuth: boolean;\n  /** Supported features */\n  features: {\n    upload: boolean;\n    download: boolean;\n    list: boolean;\n    delete: boolean;\n  };\n}\n\nexport class StorageError extends Error {\n  public readonly code: string;\n  public readonly provider: string;\n  // The 'cause' property is now inherited from the base Error class\n\n  constructor(\n    message: string,\n    code: string,\n    provider: string,\n    options?: { cause?: Error },\n  ) {\n    // Pass the options object with 'cause' to the super constructor\n    super(message, options);\n    this.name = \"StorageError\";\n    this.code = code;\n    this.provider = provider;\n  }\n}\n"],"mappings":"AAmIO,MAAM,qBAAqB,MAAM;AAAA,EACtB;AAAA,EACA;AAAA;AAAA,EAGhB,YACE,SACA,MACA,UACA,SACA;AAEA,UAAM,SAAS,OAAO;AACtB,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,WAAW;AAAA,EAClB;AACF;","names":[]}
+{"version":3,"sources":["../../src/types/storage.ts"],"sourcesContent":["/**\n * Defines interface for storage provider implementations.\n *\n * @remarks\n * Abstracts storage backends (IPFS, Google Drive, Pinata) behind\n * common interface for encrypted file operations.\n *\n * @category Storage\n * @example\n * ```typescript\n * class MyStorage implements StorageProvider {\n *   async upload(file: Blob): Promise<StorageUploadResult> {\n *     const url = await uploadToService(file);\n *     return { url, size: file.size, contentType: file.type };\n *   }\n *\n *   async download(url: string): Promise<Blob> {\n *     return fetch(url).then(r => r.blob());\n *   }\n * }\n * ```\n */\nexport interface StorageProvider {\n  /**\n   * Upload a file to the storage provider\n   *\n   * @param file - The file to upload\n   * @param filename - Optional custom filename\n   * @returns Promise with storage URL and metadata\n   */\n  upload(file: Blob, filename?: string): Promise<StorageUploadResult>;\n\n  /**\n   * Download a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with file blob\n   */\n  download(url: string): Promise<Blob>;\n\n  /**\n   * List files from the storage provider\n   *\n   * @param options - Optional filtering and pagination\n   * @returns Promise with file list\n   */\n  list(options?: StorageListOptions): Promise<StorageFile[]>;\n\n  /**\n   * Delete a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with success status\n   */\n  delete(url: string): Promise<boolean>;\n\n  /**\n   * Get provider-specific configuration\n   *\n   * @returns Provider configuration object\n   */\n  getConfig(): StorageProviderConfig;\n}\n\nexport interface StorageUploadResult {\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageFile {\n  /** File identifier */\n  id: string;\n  /** File name */\n  name: string;\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Upload timestamp */\n  createdAt: Date;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageListOptions {\n  /** Maximum number of files to return */\n  limit?: number;\n  /** Pagination cursor/offset */\n  offset?: string | number;\n  /** Filter by file name pattern */\n  namePattern?: string;\n  /** Filter by content type */\n  contentType?: string;\n}\n\nexport interface StorageProviderConfig {\n  /** Provider name */\n  name: string;\n  /** Provider type */\n  type: string;\n  /** Whether authentication is required */\n  requiresAuth: boolean;\n  /** Supported features */\n  features: {\n    upload: boolean;\n    download: boolean;\n    list: boolean;\n    delete: boolean;\n  };\n}\n\nexport class StorageError extends Error {\n  public readonly code: string;\n  public readonly provider: string;\n  // The 'cause' property is now inherited from the base Error class\n\n  constructor(\n    message: string,\n    code: string,\n    provider: string,\n    options?: { cause?: Error },\n  ) {\n    // Pass the options object with 'cause' to the super constructor\n    super(message, options);\n    this.name = \"StorageError\";\n    this.code = code;\n    this.provider = provider;\n  }\n}\n"],"mappings":"AAuHO,MAAM,qBAAqB,MAAM;AAAA,EACtB;AAAA,EACA;AAAA;AAAA,EAGhB,YACE,SACA,MACA,UACA,SACA;AAEA,UAAM,SAAS,OAAO;AACtB,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,WAAW;AAAA,EAClB;AACF;","names":[]}

package/dist/utils/grantFiles.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/grantFiles.ts"],"sourcesContent":["import { keccak256, toHex } from \"viem\";\nimport type { GrantFile, GrantPermissionParams } from \"../types/permissions\";\nimport { SerializationError, NetworkError } from \"../errors\";\n\ninterface GrantFileStorageResponse {\n  success: boolean;\n  error?: string;\n  url?: string;\n}\n\n/**\n * Creates a grant file structure from permission parameters.\n *\n * @remarks\n * This function constructs the JSON structure that represents a permission grant\n * in the Vana protocol. The grant file contains all necessary information for\n * a grantee to perform operations on behalf of the grantor.\n *\n * @param params - The permission parameters to create the grant file from\n * @returns The constructed grant file object\n * @example\n * ```typescript\n * const grantFile = createGrantFile({\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',\n *   operation: 'llm_inference',\n *   parameters: {\n *     model: 'gpt-4',\n *     maxTokens: 1000\n *   },\n *   expiresAt: Date.now() + 86400000 // 24 hours\n * });\n *\n * console.log(grantFile);\n * // {\n * //   grantee: '0x742d...',\n * //   operation: 'llm_inference',\n * //   parameters: { model: 'gpt-4', maxTokens: 1000 },\n * //   expires: 1234567890\n * // }\n * ```\n */\nexport function createGrantFile(params: GrantPermissionParams): GrantFile {\n  const grantFile: GrantFile = {\n    grantee: params.grantee,\n    operation: params.operation,\n    parameters: params.parameters,\n  };\n\n  // Add expiration if provided\n  if (params.expiresAt) {\n    grantFile.expires = params.expiresAt;\n  }\n\n  return grantFile;\n}\n\n/**\n * Stores a grant file in IPFS via the relayer service.\n *\n * @remarks\n * This function uploads the grant file to IPFS through the relayer's upload endpoint.\n * The returned URL can be stored on-chain as part of the permission grant, allowing\n * anyone to retrieve the detailed permission parameters later.\n *\n * @param grantFile - The grant file to store\n * @param relayerUrl - URL of the relayer service\n * @returns Promise resolving to the IPFS URL\n * @throws {NetworkError} When the upload fails or relayer is unavailable\n * @example\n * ```typescript\n * const grantFile = createGrantFile(params);\n *\n * try {\n *   const ipfsUrl = await storeGrantFile(grantFile, 'https://relayer.vana.com');\n *   console.log(`Grant file stored at: ${ipfsUrl}`);\n *   // ipfsUrl: \"ipfs://QmHash123...\"\n * } catch (error) {\n *   console.error('Failed to store grant file:', error);\n * }\n * ```\n */\nexport async function storeGrantFile(\n  grantFile: GrantFile,\n  relayerUrl: string,\n): Promise<string> {\n  try {\n    // Convert grant file to blob and use IPFS upload endpoint\n    const grantFileBlob = new Blob([JSON.stringify(grantFile, null, 2)], {\n      type: \"application/json\",\n    });\n\n    const formData = new FormData();\n    formData.append(\"file\", grantFileBlob, \"grant-file.json\");\n\n    const response = await fetch(`${relayerUrl}/api/ipfs/upload`, {\n      method: \"POST\",\n      body: formData,\n    });\n\n    if (!response.ok) {\n      throw new NetworkError(\n        `Failed to store grant file: ${response.statusText}`,\n        new Error(`HTTP ${response.status}`),\n      );\n    }\n\n    const responseData: unknown = await response.json();\n    const data = responseData as GrantFileStorageResponse;\n\n    if (!data.success) {\n      throw new NetworkError(data.error ?? \"Failed to store grant file\");\n    }\n\n    if (!data.url) {\n      throw new NetworkError(\"Upload succeeded but no URL was returned\");\n    }\n    return data.url; // The IPFS URL from the upload response\n  } catch (error) {\n    if (error instanceof NetworkError) {\n      throw error;\n    }\n    throw new NetworkError(\n      `Network error while storing grant file: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n      error as Error,\n    );\n  }\n}\n\n/**\n * Retrieves detailed grant file data from IPFS or HTTP storage.\n *\n * @remarks\n * **This is Step 2 of the performant two-step permission API.**\n *\n * Use this method to resolve detailed permission data (operation, parameters, etc.)\n * for specific grants after first getting the fast on-chain data using\n * `getUserPermissionGrantsOnChain()`. This design eliminates N+1 query problems\n * by allowing selective lazy-loading of expensive off-chain data.\n *\n * **Performance**: Single network request per grant file (typically 100-500ms).\n * **Reliability**: Tries multiple IPFS gateways as fallbacks if primary URL fails.\n *\n * @param grantUrl - The grant file URL from OnChainPermissionGrant.grantUrl\n * @param _relayerUrl - URL of the relayer service (optional, unused)\n * @param downloadRelayer - Optional download relayer for proxying CORS-restricted downloads\n * @param downloadRelayer.proxyDownload - Function to proxy download requests through application server\n * @returns Promise resolving to the complete grant file with operation details\n * @throws {NetworkError} When all retrieval attempts fail\n * @throws {SerializationError} When grant file format is invalid\n * @example\n * ```typescript\n * // Step 1: Fast on-chain data (no N+1 queries)\n * const grants = await vana.permissions.getUserPermissionGrantsOnChain();\n *\n * // Step 2: Lazy-load details for specific grant when needed\n * const grantFile = await retrieveGrantFile(grants[0].grantUrl);\n *\n * console.log(`Operation: ${grantFile.operation}`);\n * console.log(`Grantee: ${grantFile.grantee}`);\n * console.log(`Parameters:`, grantFile.parameters);\n *\n * // Only fetch details for grants user actually wants to see\n * for (const grant of selectedGrants) {\n *   const details = await retrieveGrantFile(grant.grantUrl);\n *   displayGrantDetails(details);\n * }\n * ```\n */\nexport async function retrieveGrantFile(\n  grantUrl: string,\n  _relayerUrl?: string,\n  downloadRelayer?: { proxyDownload: (url: string) => Promise<Blob> },\n): Promise<GrantFile> {\n  try {\n    // Check if the URL is a gateway URL instead of ipfs:// protocol\n    if (grantUrl.startsWith(\"http\") && grantUrl.includes(\"/ipfs/\")) {\n      console.warn(\n        `⚠️  Grant URL uses HTTP gateway format instead of ipfs:// protocol. ` +\n          `Found: ${grantUrl}. ` +\n          `Consider using ipfs:// format for better protocol-agnostic storage.`,\n      );\n    }\n\n    // Use the unified download utility\n    const { universalFetch } = await import(\"./download\");\n    const response = await universalFetch(grantUrl, downloadRelayer);\n\n    if (!response.ok) {\n      throw new NetworkError(\n        `Failed to retrieve grant file: HTTP ${response.status}`,\n      );\n    }\n\n    const text = await response.text();\n    const grantFile = JSON.parse(text);\n\n    if (!validateGrantFile(grantFile)) {\n      throw new NetworkError(`Invalid grant file format from ${grantUrl}`);\n    }\n\n    return grantFile;\n  } catch (error) {\n    if (error instanceof NetworkError) {\n      throw error;\n    }\n    throw new NetworkError(\n      `Error retrieving grant file: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n      error as Error,\n    );\n  }\n}\n\n/**\n * Generates a content hash for a grant file.\n * This can be used for integrity verification.\n *\n * @remarks\n * Creates a deterministic keccak256 hash of the grant file by first sorting\n * all object keys recursively to ensure consistent hashing regardless of\n * property order. This hash can be used to verify grant file integrity\n * or as a unique identifier.\n *\n * @param grantFile - The grant file to generate a hash for\n * @returns The keccak256 hash of the grant file as a hex string\n * @throws {SerializationError} When the grant file cannot be serialized\n * @example\n * ```typescript\n * const grantFile = {\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',\n *   operation: 'read',\n *   parameters: { version: '1.0', mode: 'full' }\n * };\n *\n * const hash = getGrantFileHash(grantFile);\n * console.log(`Grant file hash: ${hash}`);\n * // \"0x1234567890abcdef...\"\n *\n * // Same grant file with different property order produces same hash\n * const grantFile2 = {\n *   operation: 'read',\n *   parameters: { mode: 'full', version: '1.0' },\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36'\n * };\n *\n * const hash2 = getGrantFileHash(grantFile2);\n * console.log(hash === hash2); // true\n * ```\n */\nexport function getGrantFileHash(grantFile: GrantFile): string {\n  try {\n    // Create a stable JSON representation\n    const sortedFile: GrantFile = {\n      grantee: grantFile.grantee,\n      operation: grantFile.operation,\n      parameters: sortObjectKeys(grantFile.parameters) as Record<\n        string,\n        unknown\n      >,\n    };\n\n    // Add expires if present\n    if (grantFile.expires !== undefined) {\n      sortedFile.expires = grantFile.expires;\n    }\n\n    const jsonString = JSON.stringify(sortedFile);\n    console.info(`Hash: ${keccak256(toHex(jsonString))}`);\n    return keccak256(toHex(jsonString));\n  } catch (error) {\n    throw new SerializationError(\n      `Failed to generate grant file hash: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n    );\n  }\n}\n\n/**\n * Recursively sorts object keys for stable serialization.\n *\n * @param obj - The object to sort keys recursively\n * @returns The object with all keys sorted recursively\n */\nfunction sortObjectKeys(obj: unknown): unknown {\n  if (obj === null || typeof obj !== \"object\") {\n    return obj;\n  }\n\n  if (Array.isArray(obj)) {\n    return obj.map((item) => sortObjectKeys(item));\n  }\n\n  const sortedObj: Record<string, unknown> = {};\n  Object.keys(obj as Record<string, unknown>)\n    .sort()\n    .forEach((key) => {\n      sortedObj[key] = sortObjectKeys((obj as Record<string, unknown>)[key]);\n    });\n\n  return sortedObj;\n}\n\n/**\n * Validates that a grant file has the required structure.\n *\n * @remarks\n * Performs runtime validation to ensure data conforms to the GrantFile interface.\n * Checks for required fields (grantee, operation, parameters) and validates their\n * types and formats. This is a type guard function that enables TypeScript to\n * narrow the type when it returns true.\n *\n * @param data - The data to validate as a grant file\n * @returns True if the data is a valid grant file, false otherwise\n * @example\n * ```typescript\n * const unknownData = await fetch(url).then(r => r.json());\n *\n * if (validateGrantFile(unknownData)) {\n *   // TypeScript now knows unknownData is a GrantFile\n *   console.log(`Grant for operation: ${unknownData.operation}`);\n *   console.log(`Grantee: ${unknownData.grantee}`);\n * } else {\n *   throw new Error('Invalid grant file format');\n * }\n *\n * // Validation examples:\n * validateGrantFile({\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',\n *   operation: 'read',\n *   parameters: {}\n * }); // true\n *\n * validateGrantFile({\n *   grantee: 'invalid-address',\n *   operation: 'read',\n *   parameters: {}\n * }); // false (invalid address format)\n *\n * validateGrantFile({\n *   operation: 'read',\n *   parameters: {}\n * }); // false (missing grantee)\n * ```\n */\nexport function validateGrantFile(data: unknown): data is GrantFile {\n  if (!data || typeof data !== \"object\") {\n    return false;\n  }\n\n  const obj = data as Record<string, unknown>;\n\n  // Validate required fields\n  // Validate grantee address\n  if (\n    typeof obj.grantee !== \"string\" ||\n    !obj.grantee.match(/^0x[a-fA-F0-9]{40}$/)\n  ) {\n    return false;\n  }\n\n  if (typeof obj.operation !== \"string\" || obj.operation.length === 0) {\n    return false;\n  }\n\n  // Files are no longer stored in grant files - they're tracked in the contract\n\n  if (!obj.parameters || typeof obj.parameters !== \"object\") {\n    return false;\n  }\n\n  // Validate optional expires field\n  if (obj.expires !== undefined) {\n    if (\n      typeof obj.expires !== \"number\" ||\n      obj.expires < 0 ||\n      !Number.isInteger(obj.expires)\n    ) {\n      return false;\n    }\n  }\n\n  return true;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiC;AAEjC,oBAAiD;AAuC1C,SAAS,gBAAgB,QAA0C;AACxE,QAAM,YAAuB;AAAA,IAC3B,SAAS,OAAO;AAAA,IAChB,WAAW,OAAO;AAAA,IAClB,YAAY,OAAO;AAAA,EACrB;AAGA,MAAI,OAAO,WAAW;AACpB,cAAU,UAAU,OAAO;AAAA,EAC7B;AAEA,SAAO;AACT;AA2BA,eAAsB,eACpB,WACA,YACiB;AACjB,MAAI;AAEF,UAAM,gBAAgB,IAAI,KAAK,CAAC,KAAK,UAAU,WAAW,MAAM,CAAC,CAAC,GAAG;AAAA,MACnE,MAAM;AAAA,IACR,CAAC;AAED,UAAM,WAAW,IAAI,SAAS;AAC9B,aAAS,OAAO,QAAQ,eAAe,iBAAiB;AAExD,UAAM,WAAW,MAAM,MAAM,GAAG,UAAU,oBAAoB;AAAA,MAC5D,QAAQ;AAAA,MACR,MAAM;AAAA,IACR,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI;AAAA,QACR,+BAA+B,SAAS,UAAU;AAAA,QAClD,IAAI,MAAM,QAAQ,SAAS,MAAM,EAAE;AAAA,MACrC;AAAA,IACF;AAEA,UAAM,eAAwB,MAAM,SAAS,KAAK;AAClD,UAAM,OAAO;AAEb,QAAI,CAAC,KAAK,SAAS;AACjB,YAAM,IAAI,2BAAa,KAAK,SAAS,4BAA4B;AAAA,IACnE;AAEA,QAAI,CAAC,KAAK,KAAK;AACb,YAAM,IAAI,2BAAa,0CAA0C;AAAA,IACnE;AACA,WAAO,KAAK;AAAA,EACd,SAAS,OAAO;AACd,QAAI,iBAAiB,4BAAc;AACjC,YAAM;AAAA,IACR;AACA,UAAM,IAAI;AAAA,MACR,2CAA2C,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,MACnG;AAAA,IACF;AAAA,EACF;AACF;AA0CA,eAAsB,kBACpB,UACA,aACA,iBACoB;AACpB,MAAI;AAEF,QAAI,SAAS,WAAW,MAAM,KAAK,SAAS,SAAS,QAAQ,GAAG;AAC9D,cAAQ;AAAA,QACN,wFACY,QAAQ;AAAA,MAEtB;AAAA,IACF;AAGA,UAAM,EAAE,eAAe,IAAI,MAAM,OAAO,YAAY;AACpD,UAAM,WAAW,MAAM,eAAe,UAAU,eAAe;AAE/D,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI;AAAA,QACR,uCAAuC,SAAS,MAAM;AAAA,MACxD;AAAA,IACF;AAEA,UAAM,OAAO,MAAM,SAAS,KAAK;AACjC,UAAM,YAAY,KAAK,MAAM,IAAI;AAEjC,QAAI,CAAC,kBAAkB,SAAS,GAAG;AACjC,YAAM,IAAI,2BAAa,kCAAkC,QAAQ,EAAE;AAAA,IACrE;AAEA,WAAO;AAAA,EACT,SAAS,OAAO;AACd,QAAI,iBAAiB,4BAAc;AACjC,YAAM;AAAA,IACR;AACA,UAAM,IAAI;AAAA,MACR,gCAAgC,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,MACxF;AAAA,IACF;AAAA,EACF;AACF;AAsCO,SAAS,iBAAiB,WAA8B;AAC7D,MAAI;AAEF,UAAM,aAAwB;AAAA,MAC5B,SAAS,UAAU;AAAA,MACnB,WAAW,UAAU;AAAA,MACrB,YAAY,eAAe,UAAU,UAAU;AAAA,IAIjD;AAGA,QAAI,UAAU,YAAY,QAAW;AACnC,iBAAW,UAAU,UAAU;AAAA,IACjC;AAEA,UAAM,aAAa,KAAK,UAAU,UAAU;AAC5C,YAAQ,KAAK,aAAS,2BAAU,mBAAM,UAAU,CAAC,CAAC,EAAE;AACpD,eAAO,2BAAU,mBAAM,UAAU,CAAC;AAAA,EACpC,SAAS,OAAO;AACd,UAAM,IAAI;AAAA,MACR,uCAAuC,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,IACjG;AAAA,EACF;AACF;AAQA,SAAS,eAAe,KAAuB;AAC7C,MAAI,QAAQ,QAAQ,OAAO,QAAQ,UAAU;AAC3C,WAAO;AAAA,EACT;AAEA,MAAI,MAAM,QAAQ,GAAG,GAAG;AACtB,WAAO,IAAI,IAAI,CAAC,SAAS,eAAe,IAAI,CAAC;AAAA,EAC/C;AAEA,QAAM,YAAqC,CAAC;AAC5C,SAAO,KAAK,GAA8B,EACvC,KAAK,EACL,QAAQ,CAAC,QAAQ;AAChB,cAAU,GAAG,IAAI,eAAgB,IAAgC,GAAG,CAAC;AAAA,EACvE,CAAC;AAEH,SAAO;AACT;AA4CO,SAAS,kBAAkB,MAAkC;AAClE,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,QAAM,MAAM;AAIZ,MACE,OAAO,IAAI,YAAY,YACvB,CAAC,IAAI,QAAQ,MAAM,qBAAqB,GACxC;AACA,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,IAAI,cAAc,YAAY,IAAI,UAAU,WAAW,GAAG;AACnE,WAAO;AAAA,EACT;AAIA,MAAI,CAAC,IAAI,cAAc,OAAO,IAAI,eAAe,UAAU;AACzD,WAAO;AAAA,EACT;AAGA,MAAI,IAAI,YAAY,QAAW;AAC7B,QACE,OAAO,IAAI,YAAY,YACvB,IAAI,UAAU,KACd,CAAC,OAAO,UAAU,IAAI,OAAO,GAC7B;AACA,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../../src/utils/grantFiles.ts"],"sourcesContent":["import { keccak256, toHex } from \"viem\";\nimport type { GrantFile, GrantPermissionParams } from \"../types/permissions\";\nimport { SerializationError, NetworkError } from \"../errors\";\n\ninterface GrantFileStorageResponse {\n  success: boolean;\n  error?: string;\n  url?: string;\n}\n\n/**\n * Creates grant file structure for permission storage.\n *\n * @remarks\n * Constructs JSON structure that represents a permission grant\n * in the Vana protocol. The grant file contains all necessary information\n * for a grantee to perform operations on behalf of the grantor.\n *\n * @param params - Permission parameters to create the grant file from\n * @returns Grant file object for IPFS storage\n *\n * @example\n * ```typescript\n * const grant = createGrantFile({\n *   grantee: '0x742d35Cc...',\n *   operation: 'llm_inference',\n *   parameters: { model: 'gpt-4' },\n *   expiresAt: Date.now() + 86400000 // 24 hours\n * });\n * ```\n */\nexport function createGrantFile(params: GrantPermissionParams): GrantFile {\n  const grantFile: GrantFile = {\n    grantee: params.grantee,\n    operation: params.operation,\n    parameters: params.parameters,\n  };\n\n  // Add expiration if provided\n  if (params.expiresAt) {\n    grantFile.expires = params.expiresAt;\n  }\n\n  return grantFile;\n}\n\n/**\n * Stores a grant file in IPFS via the relayer service.\n *\n * @remarks\n * This function uploads the grant file to IPFS through the relayer's upload endpoint.\n * The returned URL can be stored on-chain as part of the permission grant, allowing\n * anyone to retrieve the detailed permission parameters later.\n *\n * @param grantFile - The grant file to store\n * @param relayerUrl - URL of the relayer service\n * @returns Promise resolving to the IPFS URL\n * @throws {NetworkError} When the upload fails or relayer is unavailable\n * @example\n * ```typescript\n * const grantFile = createGrantFile(params);\n *\n * try {\n *   const ipfsUrl = await storeGrantFile(grantFile, 'https://relayer.vana.com');\n *   console.log(`Grant file stored at: ${ipfsUrl}`);\n *   // ipfsUrl: \"ipfs://QmHash123...\"\n * } catch (error) {\n *   console.error('Failed to store grant file:', error);\n * }\n * ```\n */\nexport async function storeGrantFile(\n  grantFile: GrantFile,\n  relayerUrl: string,\n): Promise<string> {\n  try {\n    // Convert grant file to blob and use IPFS upload endpoint\n    const grantFileBlob = new Blob([JSON.stringify(grantFile, null, 2)], {\n      type: \"application/json\",\n    });\n\n    const formData = new FormData();\n    formData.append(\"file\", grantFileBlob, \"grant-file.json\");\n\n    const response = await fetch(`${relayerUrl}/api/ipfs/upload`, {\n      method: \"POST\",\n      body: formData,\n    });\n\n    if (!response.ok) {\n      throw new NetworkError(\n        `Failed to store grant file: ${response.statusText}`,\n        new Error(`HTTP ${response.status}`),\n      );\n    }\n\n    const responseData: unknown = await response.json();\n    const data = responseData as GrantFileStorageResponse;\n\n    if (!data.success) {\n      throw new NetworkError(data.error ?? \"Failed to store grant file\");\n    }\n\n    if (!data.url) {\n      throw new NetworkError(\"Upload succeeded but no URL was returned\");\n    }\n    return data.url; // The IPFS URL from the upload response\n  } catch (error) {\n    if (error instanceof NetworkError) {\n      throw error;\n    }\n    throw new NetworkError(\n      `Network error while storing grant file: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n      error as Error,\n    );\n  }\n}\n\n/**\n * Retrieves detailed grant file data from IPFS or HTTP storage.\n *\n * @remarks\n * **This is Step 2 of the performant two-step permission API.**\n *\n * Use this method to resolve detailed permission data (operation, parameters, etc.)\n * for specific grants after first getting the fast on-chain data using\n * `getUserPermissionGrantsOnChain()`. This design eliminates N+1 query problems\n * by allowing selective lazy-loading of expensive off-chain data.\n *\n * **Performance**: Single network request per grant file (typically 100-500ms).\n * **Reliability**: Tries multiple IPFS gateways as fallbacks if primary URL fails.\n *\n * @param grantUrl - The grant file URL from OnChainPermissionGrant.grantUrl\n * @param _relayerUrl - URL of the relayer service (optional, unused)\n * @param downloadRelayer - Optional download relayer for proxying CORS-restricted downloads\n * @param downloadRelayer.proxyDownload - Function to proxy download requests through application server\n * @returns Promise resolving to the complete grant file with operation details\n * @throws {NetworkError} When all retrieval attempts fail\n * @throws {SerializationError} When grant file format is invalid\n * @example\n * ```typescript\n * // Step 1: Fast on-chain data (no N+1 queries)\n * const grants = await vana.permissions.getUserPermissionGrantsOnChain();\n *\n * // Step 2: Lazy-load details for specific grant when needed\n * const grantFile = await retrieveGrantFile(grants[0].grantUrl);\n *\n * console.log(`Operation: ${grantFile.operation}`);\n * console.log(`Grantee: ${grantFile.grantee}`);\n * console.log(`Parameters:`, grantFile.parameters);\n *\n * // Only fetch details for grants user actually wants to see\n * for (const grant of selectedGrants) {\n *   const details = await retrieveGrantFile(grant.grantUrl);\n *   displayGrantDetails(details);\n * }\n * ```\n */\nexport async function retrieveGrantFile(\n  grantUrl: string,\n  _relayerUrl?: string,\n  downloadRelayer?: { proxyDownload: (url: string) => Promise<Blob> },\n): Promise<GrantFile> {\n  try {\n    // Check if the URL is a gateway URL instead of ipfs:// protocol\n    if (grantUrl.startsWith(\"http\") && grantUrl.includes(\"/ipfs/\")) {\n      console.warn(\n        `⚠️  Grant URL uses HTTP gateway format instead of ipfs:// protocol. ` +\n          `Found: ${grantUrl}. ` +\n          `Consider using ipfs:// format for better protocol-agnostic storage.`,\n      );\n    }\n\n    // Use the unified download utility\n    const { universalFetch } = await import(\"./download\");\n    const response = await universalFetch(grantUrl, downloadRelayer);\n\n    if (!response.ok) {\n      throw new NetworkError(\n        `Failed to retrieve grant file: HTTP ${response.status}`,\n      );\n    }\n\n    const text = await response.text();\n    const grantFile = JSON.parse(text);\n\n    if (!validateGrantFile(grantFile)) {\n      throw new NetworkError(`Invalid grant file format from ${grantUrl}`);\n    }\n\n    return grantFile;\n  } catch (error) {\n    if (error instanceof NetworkError) {\n      throw error;\n    }\n    throw new NetworkError(\n      `Error retrieving grant file: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n      error as Error,\n    );\n  }\n}\n\n/**\n * Generates a content hash for a grant file.\n * This can be used for integrity verification.\n *\n * @remarks\n * Creates a deterministic keccak256 hash of the grant file by first sorting\n * all object keys recursively to ensure consistent hashing regardless of\n * property order. This hash can be used to verify grant file integrity\n * or as a unique identifier.\n *\n * @param grantFile - The grant file to generate a hash for\n * @returns The keccak256 hash of the grant file as a hex string\n * @throws {SerializationError} When the grant file cannot be serialized\n * @example\n * ```typescript\n * const grantFile = {\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',\n *   operation: 'read',\n *   parameters: { version: '1.0', mode: 'full' }\n * };\n *\n * const hash = getGrantFileHash(grantFile);\n * console.log(`Grant file hash: ${hash}`);\n * // \"0x1234567890abcdef...\"\n *\n * // Same grant file with different property order produces same hash\n * const grantFile2 = {\n *   operation: 'read',\n *   parameters: { mode: 'full', version: '1.0' },\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36'\n * };\n *\n * const hash2 = getGrantFileHash(grantFile2);\n * console.log(hash === hash2); // true\n * ```\n */\nexport function getGrantFileHash(grantFile: GrantFile): string {\n  try {\n    // Create a stable JSON representation\n    const sortedFile: GrantFile = {\n      grantee: grantFile.grantee,\n      operation: grantFile.operation,\n      parameters: sortObjectKeys(grantFile.parameters) as Record<\n        string,\n        unknown\n      >,\n    };\n\n    // Add expires if present\n    if (grantFile.expires !== undefined) {\n      sortedFile.expires = grantFile.expires;\n    }\n\n    const jsonString = JSON.stringify(sortedFile);\n    console.info(`Hash: ${keccak256(toHex(jsonString))}`);\n    return keccak256(toHex(jsonString));\n  } catch (error) {\n    throw new SerializationError(\n      `Failed to generate grant file hash: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n    );\n  }\n}\n\n/**\n * Recursively sorts object keys for stable serialization.\n *\n * @param obj - The object to sort keys recursively\n * @returns The object with all keys sorted recursively\n */\nfunction sortObjectKeys(obj: unknown): unknown {\n  if (obj === null || typeof obj !== \"object\") {\n    return obj;\n  }\n\n  if (Array.isArray(obj)) {\n    return obj.map((item) => sortObjectKeys(item));\n  }\n\n  const sortedObj: Record<string, unknown> = {};\n  Object.keys(obj as Record<string, unknown>)\n    .sort()\n    .forEach((key) => {\n      sortedObj[key] = sortObjectKeys((obj as Record<string, unknown>)[key]);\n    });\n\n  return sortedObj;\n}\n\n/**\n * Validates that a grant file has the required structure.\n *\n * @remarks\n * Performs runtime validation to ensure data conforms to the GrantFile interface.\n * Checks for required fields (grantee, operation, parameters) and validates their\n * types and formats. This is a type guard function that enables TypeScript to\n * narrow the type when it returns true.\n *\n * @param data - The data to validate as a grant file\n * @returns True if the data is a valid grant file, false otherwise\n * @example\n * ```typescript\n * const unknownData = await fetch(url).then(r => r.json());\n *\n * if (validateGrantFile(unknownData)) {\n *   // TypeScript now knows unknownData is a GrantFile\n *   console.log(`Grant for operation: ${unknownData.operation}`);\n *   console.log(`Grantee: ${unknownData.grantee}`);\n * } else {\n *   throw new Error('Invalid grant file format');\n * }\n *\n * // Validation examples:\n * validateGrantFile({\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',\n *   operation: 'read',\n *   parameters: {}\n * }); // true\n *\n * validateGrantFile({\n *   grantee: 'invalid-address',\n *   operation: 'read',\n *   parameters: {}\n * }); // false (invalid address format)\n *\n * validateGrantFile({\n *   operation: 'read',\n *   parameters: {}\n * }); // false (missing grantee)\n * ```\n */\nexport function validateGrantFile(data: unknown): data is GrantFile {\n  if (!data || typeof data !== \"object\") {\n    return false;\n  }\n\n  const obj = data as Record<string, unknown>;\n\n  // Validate required fields\n  // Validate grantee address\n  if (\n    typeof obj.grantee !== \"string\" ||\n    !obj.grantee.match(/^0x[a-fA-F0-9]{40}$/)\n  ) {\n    return false;\n  }\n\n  if (typeof obj.operation !== \"string\" || obj.operation.length === 0) {\n    return false;\n  }\n\n  // Files are no longer stored in grant files - they're tracked in the contract\n\n  if (!obj.parameters || typeof obj.parameters !== \"object\") {\n    return false;\n  }\n\n  // Validate optional expires field\n  if (obj.expires !== undefined) {\n    if (\n      typeof obj.expires !== \"number\" ||\n      obj.expires < 0 ||\n      !Number.isInteger(obj.expires)\n    ) {\n      return false;\n    }\n  }\n\n  return true;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiC;AAEjC,oBAAiD;AA6B1C,SAAS,gBAAgB,QAA0C;AACxE,QAAM,YAAuB;AAAA,IAC3B,SAAS,OAAO;AAAA,IAChB,WAAW,OAAO;AAAA,IAClB,YAAY,OAAO;AAAA,EACrB;AAGA,MAAI,OAAO,WAAW;AACpB,cAAU,UAAU,OAAO;AAAA,EAC7B;AAEA,SAAO;AACT;AA2BA,eAAsB,eACpB,WACA,YACiB;AACjB,MAAI;AAEF,UAAM,gBAAgB,IAAI,KAAK,CAAC,KAAK,UAAU,WAAW,MAAM,CAAC,CAAC,GAAG;AAAA,MACnE,MAAM;AAAA,IACR,CAAC;AAED,UAAM,WAAW,IAAI,SAAS;AAC9B,aAAS,OAAO,QAAQ,eAAe,iBAAiB;AAExD,UAAM,WAAW,MAAM,MAAM,GAAG,UAAU,oBAAoB;AAAA,MAC5D,QAAQ;AAAA,MACR,MAAM;AAAA,IACR,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI;AAAA,QACR,+BAA+B,SAAS,UAAU;AAAA,QAClD,IAAI,MAAM,QAAQ,SAAS,MAAM,EAAE;AAAA,MACrC;AAAA,IACF;AAEA,UAAM,eAAwB,MAAM,SAAS,KAAK;AAClD,UAAM,OAAO;AAEb,QAAI,CAAC,KAAK,SAAS;AACjB,YAAM,IAAI,2BAAa,KAAK,SAAS,4BAA4B;AAAA,IACnE;AAEA,QAAI,CAAC,KAAK,KAAK;AACb,YAAM,IAAI,2BAAa,0CAA0C;AAAA,IACnE;AACA,WAAO,KAAK;AAAA,EACd,SAAS,OAAO;AACd,QAAI,iBAAiB,4BAAc;AACjC,YAAM;AAAA,IACR;AACA,UAAM,IAAI;AAAA,MACR,2CAA2C,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,MACnG;AAAA,IACF;AAAA,EACF;AACF;AA0CA,eAAsB,kBACpB,UACA,aACA,iBACoB;AACpB,MAAI;AAEF,QAAI,SAAS,WAAW,MAAM,KAAK,SAAS,SAAS,QAAQ,GAAG;AAC9D,cAAQ;AAAA,QACN,wFACY,QAAQ;AAAA,MAEtB;AAAA,IACF;AAGA,UAAM,EAAE,eAAe,IAAI,MAAM,OAAO,YAAY;AACpD,UAAM,WAAW,MAAM,eAAe,UAAU,eAAe;AAE/D,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI;AAAA,QACR,uCAAuC,SAAS,MAAM;AAAA,MACxD;AAAA,IACF;AAEA,UAAM,OAAO,MAAM,SAAS,KAAK;AACjC,UAAM,YAAY,KAAK,MAAM,IAAI;AAEjC,QAAI,CAAC,kBAAkB,SAAS,GAAG;AACjC,YAAM,IAAI,2BAAa,kCAAkC,QAAQ,EAAE;AAAA,IACrE;AAEA,WAAO;AAAA,EACT,SAAS,OAAO;AACd,QAAI,iBAAiB,4BAAc;AACjC,YAAM;AAAA,IACR;AACA,UAAM,IAAI;AAAA,MACR,gCAAgC,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,MACxF;AAAA,IACF;AAAA,EACF;AACF;AAsCO,SAAS,iBAAiB,WAA8B;AAC7D,MAAI;AAEF,UAAM,aAAwB;AAAA,MAC5B,SAAS,UAAU;AAAA,MACnB,WAAW,UAAU;AAAA,MACrB,YAAY,eAAe,UAAU,UAAU;AAAA,IAIjD;AAGA,QAAI,UAAU,YAAY,QAAW;AACnC,iBAAW,UAAU,UAAU;AAAA,IACjC;AAEA,UAAM,aAAa,KAAK,UAAU,UAAU;AAC5C,YAAQ,KAAK,aAAS,2BAAU,mBAAM,UAAU,CAAC,CAAC,EAAE;AACpD,eAAO,2BAAU,mBAAM,UAAU,CAAC;AAAA,EACpC,SAAS,OAAO;AACd,UAAM,IAAI;AAAA,MACR,uCAAuC,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,IACjG;AAAA,EACF;AACF;AAQA,SAAS,eAAe,KAAuB;AAC7C,MAAI,QAAQ,QAAQ,OAAO,QAAQ,UAAU;AAC3C,WAAO;AAAA,EACT;AAEA,MAAI,MAAM,QAAQ,GAAG,GAAG;AACtB,WAAO,IAAI,IAAI,CAAC,SAAS,eAAe,IAAI,CAAC;AAAA,EAC/C;AAEA,QAAM,YAAqC,CAAC;AAC5C,SAAO,KAAK,GAA8B,EACvC,KAAK,EACL,QAAQ,CAAC,QAAQ;AAChB,cAAU,GAAG,IAAI,eAAgB,IAAgC,GAAG,CAAC;AAAA,EACvE,CAAC;AAEH,SAAO;AACT;AA4CO,SAAS,kBAAkB,MAAkC;AAClE,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,QAAM,MAAM;AAIZ,MACE,OAAO,IAAI,YAAY,YACvB,CAAC,IAAI,QAAQ,MAAM,qBAAqB,GACxC;AACA,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,IAAI,cAAc,YAAY,IAAI,UAAU,WAAW,GAAG;AACnE,WAAO;AAAA,EACT;AAIA,MAAI,CAAC,IAAI,cAAc,OAAO,IAAI,eAAe,UAAU;AACzD,WAAO;AAAA,EACT;AAGA,MAAI,IAAI,YAAY,QAAW;AAC7B,QACE,OAAO,IAAI,YAAY,YACvB,IAAI,UAAU,KACd,CAAC,OAAO,UAAU,IAAI,OAAO,GAC7B;AACA,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}

package/dist/utils/grantFiles.d.ts

@@ -1,33 +1,23 @@
 import type { GrantFile, GrantPermissionParams } from "../types/permissions";
 /**
- * Creates a grant file structure from permission parameters.
+ * Creates grant file structure for permission storage.
  *
  * @remarks
- * This function constructs the JSON structure that represents a permission grant
- * in the Vana protocol. The grant file contains all necessary information for
- * a grantee to perform operations on behalf of the grantor.
+ * Constructs JSON structure that represents a permission grant
+ * in the Vana protocol. The grant file contains all necessary information
+ * for a grantee to perform operations on behalf of the grantor.
+ *
+ * @param params - Permission parameters to create the grant file from
+ * @returns Grant file object for IPFS storage
  *
- * @param params - The permission parameters to create the grant file from
- * @returns The constructed grant file object
  * @example
  * ```typescript
- * const grantFile = createGrantFile({
- *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',
+ * const grant = createGrantFile({
+ *   grantee: '0x742d35Cc...',
  *   operation: 'llm_inference',
- *   parameters: {
- *     model: 'gpt-4',
- *     maxTokens: 1000
- *   },
+ *   parameters: { model: 'gpt-4' },
  *   expiresAt: Date.now() + 86400000 // 24 hours
  * });
- *
- * console.log(grantFile);
- * // {
- * //   grantee: '0x742d...',
- * //   operation: 'llm_inference',
- * //   parameters: { model: 'gpt-4', maxTokens: 1000 },
- * //   expires: 1234567890
- * // }
  * ```
  */
 export declare function createGrantFile(params: GrantPermissionParams): GrantFile;