@opendatalabs/vana-sdk 0.1.0-alpha.eebb656 → 0.1.0-alpha.ef15099

package/dist/types/personal.d.ts

@@ -1,38 +1,174 @@
 /**
- * Parameters for the `vana.personal.postRequest` method.
+ * Defines parameters for posting data requests to personal servers.
+ *
+ * @remarks
+ * Used to initiate data access requests that require user permission.
+ * The permission ID references a previously granted permission that
+ * authorizes the requester to access specific user data.
+ *
+ * @example
+ * ```typescript
+ * const params: PostRequestParams = {
+ *   permissionId: 123
+ * };
+ *
+ * const response = await vana.personal.postRequest(params);
+ * console.log('Request posted:', response.requestId);
+ * ```
+ *
+ * @category Personal Server
  */
 export interface PostRequestParams {
-    /** The permission ID */
+    /**
+     * References a granted permission authorizing data access.
+     * Obtain via permission granting flow or query existing permissions.
+     * @throws {PermissionNotFoundError} If permission ID is invalid.
+     */
     permissionId: number;
 }
 /**
- * Parameters for the `vana.server.createOperation` method.
+ * Defines parameters for creating server-side operations.
+ *
+ * @remarks
+ * Initiates asynchronous operations on the personal server that
+ * process user data according to granted permissions. Operations
+ * run in the background and can be monitored via their operation ID.
+ *
+ * @example
+ * ```typescript
+ * const params: CreateOperationParams = {
+ *   permissionId: 456
+ * };
+ *
+ * const operation = await vana.server.createOperation(params);
+ * // Monitor operation status
+ * const status = await vana.server.getOperationStatus(operation.id);
+ * ```
+ *
+ * @category Personal Server
  */
 export interface CreateOperationParams {
-    /** The permission ID */
+    /**
+     * References the permission scope for this operation.
+     * Determines what data and actions are allowed.
+     * @throws {InsufficientPermissionsError} If permission scope is inadequate.
+     */
     permissionId: number;
 }
 /**
- * Parameters for personal server operations.
+ * Parameters for downloading an artifact from a server operation.
+ *
+ * @remarks
+ * Artifacts are files generated during operations like Gemini agent analysis.
+ * The download requires authentication using the application's signature.
+ *
+ * @category Personal Server
+ */
+export interface DownloadArtifactParams {
+    /**
+     * The operation ID that generated the artifact.
+     */
+    operationId: string;
+    /**
+     * The path to the artifact file to download.
+     */
+    artifactPath: string;
+}
+/**
+ * Defines parameters for initializing personal server connections.
+ *
+ * @remarks
+ * Establishes secure communication channels with a user's personal
+ * data server. The server manages encrypted user data and enforces
+ * permission-based access control. Initialization includes key exchange
+ * and session establishment.
+ *
+ * @example
+ * ```typescript
+ * const params: InitPersonalServerParams = {
+ *   userAddress: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36'
+ * };
+ *
+ * const server = await vana.personal.initServer(params);
+ * console.log('Connected to server:', server.baseUrl);
+ * ```
+ *
+ * @category Personal Server
  */
 export interface InitPersonalServerParams {
-    /** The user's wallet address */
+    /**
+     * Identifies the user whose personal server to connect to.
+     * Must be a valid Ethereum address in hex format.
+     * @example '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36'
+     */
     userAddress: string;
 }
 /**
- * Extended personal server identity information including connection details.
- * This combines the base PersonalServerModel with additional metadata
- * needed for client connections.
+ * Represents comprehensive personal server identity and connection information.
+ *
+ * @remarks
+ * Combines core server identity with connection metadata required for
+ * establishing secure communication. Personal servers are user-controlled
+ * nodes that store and serve encrypted personal data according to
+ * user-defined permissions. This interface provides all necessary
+ * information to connect to and interact with a personal server.
+ *
+ * @example
+ * ```typescript
+ * const identity: PersonalServerIdentity = {
+ *   kind: 'PersonalServer',
+ *   address: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',
+ *   publicKey: '0x04...', // 65-byte uncompressed public key
+ *   baseUrl: 'https://ps.user.vana.com',
+ *   name: 'User Personal Server #1'
+ * };
+ *
+ * // Use identity to establish encrypted connection
+ * const encrypted = await crypto.encrypt(data, identity.publicKey);
+ * const response = await fetch(`${identity.baseUrl}/api/data`, {
+ *   method: 'POST',
+ *   body: encrypted
+ * });
+ * ```
+ *
+ * @category Personal Server
  */
 export interface PersonalServerIdentity {
-    /** Resource type identifier */
+    /**
+     * Identifies the resource type for API disambiguation.
+     * Always 'PersonalServer' for personal server instances.
+     */
     kind: string;
-    /** The server's Ethereum address */
+    /**
+     * Uniquely identifies the server on the blockchain.
+     * Used for permission verification and identity proofs.
+     * @example '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36'
+     */
     address: string;
-    /** The server's public key for encryption */
+    /**
+     * Enables end-to-end encryption for data transmission.
+     * Must be in uncompressed format (65 bytes with 0x04 prefix).
+     * @example '0x04...' (130 hex characters)
+     */
     publicKey: string;
-    /** The base URL for connecting to this server */
+    /**
+     * Provides the HTTPS endpoint for server API requests.
+     * Should not include trailing slashes or API paths.
+     * @example 'https://ps.user.vana.com'
+     */
     baseUrl: string;
-    /** Human-readable name for this server */
+    /**
+     * Displays a user-friendly identifier for the server.
+     * Used in UI components and logging for clarity.
+     * @example 'Primary Data Server'
+     */
     name: string;
 }
+/**
+ * @remarks
+ * Additional server response types are auto-generated from the OpenAPI
+ * specification and available in the server-exports module. Import those
+ * types directly when working with server API responses.
+ *
+ * @see {@link ../types/server-exports | Server Export Types}
+ */

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, TransactionReceipt } from \"viem\";\nimport type {\n  GrantFile,\n  PermissionGrantTypedData,\n  GenericTypedData,\n} from \"./permissions\";\nimport type { RuntimeGrantFile } from \"./runtimePermissions\";\nimport type { Contract, Fn } from \"../generated/event-types\";\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 =\n  | SignedRelayerRequest\n  | DirectRelayerRequest\n  | {\n      type: \"status_check\";\n      operationId: string;\n    };\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\"; // TODO: Add when contract supports registerGranteeWithSignature\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 | RuntimeGrantFile;\n    }\n  | {\n      type: \"direct\";\n      operation: \"submitRegisterGrantee\";\n      params: {\n        owner: Address;\n        granteeAddress: Address;\n        publicKey: string;\n      };\n    };\n\n/**\n * Context for transaction operations to enable proper event parsing.\n *\n * @remarks\n * This context is preserved in relayer responses to enable client-side\n * event parsing without requiring manual reconstruction of transaction details.\n *\n * @category Relayer\n */\nexport interface TransactionContext {\n  /** The contract that was called */\n  contract: Contract;\n  /** The function that was called on the contract */\n  fn: Fn<Contract>;\n  /** The address that initiated the transaction */\n  from: Address;\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 * The new async pattern returns pending operations with operationIds for polling.\n *\n * Transaction responses include optional context to enable client-side event parsing\n * through the enhanced response pattern.\n *\n * @category Relayer\n */\nexport type UnifiedRelayerResponse =\n  | {\n      type: \"pending\";\n      operationId: string;\n    }\n  | {\n      type: \"submitted\";\n      hash: Hash;\n      /** Optional context for client-side event parsing and enhanced responses */\n      context?: TransactionContext;\n    }\n  | {\n      type: \"confirmed\";\n      hash: Hash;\n      // Receipt is optional; a performance hint for the client SDK's polling logic.\n      receipt?: TransactionReceipt;\n    }\n  | {\n      type: \"signed\";\n      hash: Hash;\n      /** Optional context for client-side event parsing and enhanced responses */\n      context?: TransactionContext;\n    }\n  | {\n      /** Non-transactional operations that complete immediately (e.g., IPFS uploads, file info) */\n      type: \"direct\";\n      /** The result data from the operation, structure depends on the specific operation */\n      result: unknown;\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,24 @@
-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, TransactionReceipt } from "viem";
+import type { GrantFile, PermissionGrantTypedData, GenericTypedData } from "./permissions";
+import type { RuntimeGrantFile } from "./runtimePermissions";
+import type { Contract, Fn } from "../generated/event-types";
+/**
+ * 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 +40,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 +68,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 +90,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 +114,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 +151,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 +170,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 +191,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 +217,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 +247,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 +279,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 +298,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 +318,236 @@ 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 | {
+    type: "status_check";
+    operationId: string;
+};
+/**
+ * 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";
+/**
+ * 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 | RuntimeGrantFile;
+} | {
+    type: "direct";
+    operation: "submitRegisterGrantee";
+    params: {
+        owner: Address;
+        granteeAddress: Address;
+        publicKey: string;
+    };
+};
+/**
+ * Context for transaction operations to enable proper event parsing.
+ *
+ * @remarks
+ * This context is preserved in relayer responses to enable client-side
+ * event parsing without requiring manual reconstruction of transaction details.
+ *
+ * @category Relayer
+ */
+export interface TransactionContext {
+    /** The contract that was called */
+    contract: Contract;
+    /** The function that was called on the contract */
+    fn: Fn<Contract>;
+    /** The address that initiated the transaction */
+    from: Address;
+}
+/**
+ * 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.
+ * The new async pattern returns pending operations with operationIds for polling.
+ *
+ * Transaction responses include optional context to enable client-side event parsing
+ * through the enhanced response pattern.
+ *
+ * @category Relayer
+ */
+export type UnifiedRelayerResponse = {
+    type: "pending";
+    operationId: string;
+} | {
+    type: "submitted";
+    hash: Hash;
+    /** Optional context for client-side event parsing and enhanced responses */
+    context?: TransactionContext;
+} | {
+    type: "confirmed";
+    hash: Hash;
+    receipt?: TransactionReceipt;
+} | {
+    type: "signed";
+    hash: Hash;
+    /** Optional context for client-side event parsing and enhanced responses */
+    context?: TransactionContext;
+} | {
+    /** Non-transactional operations that complete immediately (e.g., IPFS uploads, file info) */
+    type: "direct";
+    /** The result data from the operation, structure depends on the specific operation */
+    result: unknown;
+} | {
+    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/runtimePermissions.cjs

@@ -0,0 +1,17 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var runtimePermissions_exports = {};
+module.exports = __toCommonJS(runtimePermissions_exports);
+//# sourceMappingURL=runtimePermissions.cjs.map