@opendatalabs/vana-sdk 0.1.0-alpha.4dd34d4 → 0.1.0-alpha.4fc2c2f

package/dist/types/permissions.js

@@ -0,0 +1 @@
+//# sourceMappingURL=permissions.js.map

package/dist/types/permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/personal.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 personal_exports = {};
+module.exports = __toCommonJS(personal_exports);
+//# sourceMappingURL=personal.cjs.map

package/dist/types/personal.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/personal.ts"],"sourcesContent":["/**\n * Parameters for the `vana.personal.postRequest` method.\n */\nexport interface PostRequestParams {\n  /** The permission ID */\n  permissionId: number;\n}\n\n/**\n * Parameters for the `vana.server.createOperation` method.\n */\nexport interface CreateOperationParams {\n  /** The permission ID */\n  permissionId: number;\n}\n\n/**\n * Parameters for personal server operations.\n */\nexport interface InitPersonalServerParams {\n  /** The user's wallet address */\n  userAddress: string;\n}\n\n/**\n * Extended personal server identity information including connection details.\n * This combines the base PersonalServerModel with additional metadata\n * needed for client connections.\n */\nexport interface PersonalServerIdentity {\n  /** Resource type identifier */\n  kind: string;\n  /** The server's Ethereum address */\n  address: string;\n  /** The server's public key for encryption */\n  publicKey: string;\n  /** The base URL for connecting to this server */\n  baseUrl: string;\n  /** Human-readable name for this server */\n  name: string;\n}\n\n// Server response types are now auto-generated from OpenAPI spec in server.ts\n// Import types from ../types/server-exports for easy usage\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/personal.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Parameters for the `vana.personal.postRequest` method.
+ */
+export interface PostRequestParams {
+    /** The permission ID */
+    permissionId: number;
+}
+/**
+ * Parameters for the `vana.server.createOperation` method.
+ */
+export interface CreateOperationParams {
+    /** The permission ID */
+    permissionId: number;
+}
+/**
+ * Parameters for personal server operations.
+ */
+export interface InitPersonalServerParams {
+    /** The user's wallet address */
+    userAddress: string;
+}
+/**
+ * Extended personal server identity information including connection details.
+ * This combines the base PersonalServerModel with additional metadata
+ * needed for client connections.
+ */
+export interface PersonalServerIdentity {
+    /** Resource type identifier */
+    kind: string;
+    /** The server's Ethereum address */
+    address: string;
+    /** The server's public key for encryption */
+    publicKey: string;
+    /** The base URL for connecting to this server */
+    baseUrl: string;
+    /** Human-readable name for this server */
+    name: string;
+}

package/dist/types/personal.js

@@ -0,0 +1 @@
+//# sourceMappingURL=personal.js.map

package/dist/types/personal.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/relayer.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 relayer_exports = {};
+module.exports = __toCommonJS(relayer_exports);
+//# sourceMappingURL=relayer.cjs.map

package/dist/types/relayer.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/relayer.ts"],"sourcesContent":["import type { Hash, Address } from \"viem\";\nimport type {\n  GrantFile,\n  PermissionGrantTypedData,\n  GenericTypedData,\n} 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 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\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 * Supported signed operation types.\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   * Submit any relayer operation.\n   *\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   * @returns Promise resolving to operation-specific response\n   */\n  submit: (request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/relayer.d.ts

@@ -0,0 +1,431 @@
+import type { Hash, Address } from "viem";
+import type { GrantFile, PermissionGrantTypedData, GenericTypedData } from "./permissions";
+/**
+ * Response from the relayer service for grant file storage
+ *
+ * @category Advanced
+ */
+export interface RelayerStorageResponse {
+    /** The IPFS URL where the grant file is stored */
+    grantUrl: string;
+    /** Success status */
+    success: boolean;
+    /** Optional error message */
+    error?: string;
+    /** Storage metadata */
+    metadata?: {
+        /** IPFS hash */
+        ipfsHash: string;
+        /** File size in bytes */
+        size: number;
+        /** Upload timestamp */
+        timestamp: number;
+    };
+}
+/**
+ * Response from the relayer service for transaction submission
+ *
+ * @category Advanced
+ */
+export interface RelayerTransactionResponse {
+    /** The transaction hash of the submitted transaction */
+    transactionHash: Hash;
+    /** Success status */
+    success: boolean;
+    /** Optional error message */
+    error?: string;
+    /** Transaction metadata */
+    metadata?: {
+        /** Gas used */
+        gasUsed?: bigint;
+        /** Gas price */
+        gasPrice?: bigint;
+        /** Block number */
+        blockNumber?: bigint;
+        /** Transaction status */
+        status?: "pending" | "confirmed" | "failed";
+    };
+}
+/**
+ * Parameters for storing a grant file via relayer
+ *
+ * @category Advanced
+ */
+export interface RelayerStoreParams {
+    /** The grant file to store */
+    grantFile: GrantFile;
+    /** Optional storage options */
+    options?: {
+        /** IPFS pin duration in seconds */
+        pinDuration?: number;
+        /** Whether to use encryption */
+        encrypt?: boolean;
+        /** Custom metadata */
+        metadata?: Record<string, unknown>;
+    };
+}
+/**
+ * Parameters for submitting a transaction via relayer
+ *
+ * @category Advanced
+ */
+export interface RelayerSubmitParams {
+    /** The signed typed data */
+    typedData: PermissionGrantTypedData;
+    /** The signature */
+    signature: string;
+    /** Optional transaction options */
+    options?: {
+        /** Gas limit */
+        gasLimit?: bigint;
+        /** Priority level */
+        priority?: "low" | "medium" | "high";
+        /** Whether to wait for confirmation */
+        waitForConfirmation?: boolean;
+    };
+}
+/**
+ * Relayer service status
+ *
+ * @category Advanced
+ */
+export interface RelayerStatus {
+    /** Whether the relayer is online */
+    online: boolean;
+    /** Service version */
+    version: string;
+    /** Supported chains */
+    supportedChains: number[];
+    /** Current chain status */
+    chainStatus: Record<number, {
+        /** Whether the chain is supported */
+        supported: boolean;
+        /** Current block number */
+        currentBlock: bigint;
+        /** Gas price estimation */
+        gasPrice: bigint;
+        /** Queue size */
+        queueSize: number;
+    }>;
+    /** Rate limit information */
+    rateLimits: {
+        /** Requests per minute */
+        requestsPerMinute: number;
+        /** Storage requests per hour */
+        storageRequestsPerHour: number;
+        /** Transaction requests per hour */
+        transactionRequestsPerHour: number;
+    };
+}
+/**
+ * Relayer request options
+ *
+ * @category Advanced
+ */
+export interface RelayerRequestOptions {
+    /** Request timeout in milliseconds */
+    timeout?: number;
+    /** Whether to retry on failure */
+    retry?: boolean;
+    /** Custom headers */
+    headers?: Record<string, string>;
+    /** Request priority */
+    priority?: "low" | "medium" | "high";
+}
+/**
+ * Relayer error response
+ *
+ * @category Advanced
+ */
+export interface RelayerErrorResponse {
+    /** Error code */
+    code: string;
+    /** Error message */
+    message: string;
+    /** Additional error details */
+    details?: Record<string, unknown>;
+    /** Request ID for debugging */
+    requestId?: string;
+    /** Timestamp of error */
+    timestamp: number;
+}
+/**
+ * Relayer queue information
+ *
+ * @category Advanced
+ */
+export interface RelayerQueueInfo {
+    /** Current queue size */
+    size: number;
+    /** Estimated processing time in seconds */
+    estimatedProcessingTime: number;
+    /** Queue position for a specific request */
+    position?: number;
+    /** Processing statistics */
+    stats: {
+        /** Average processing time in seconds */
+        averageProcessingTime: number;
+        /** Requests processed in last hour */
+        requestsProcessedHour: number;
+        /** Success rate percentage */
+        successRate: number;
+    };
+}
+/**
+ * Relayer transaction status
+ *
+ * @category Advanced
+ */
+export interface RelayerTransactionStatus {
+    /** Transaction hash */
+    transactionHash: Hash;
+    /** Current status */
+    status: "pending" | "confirmed" | "failed";
+    /** Block number if confirmed */
+    blockNumber?: bigint;
+    /** Gas used */
+    gasUsed?: bigint;
+    /** Error message if failed */
+    error?: string;
+    /** Status checks performed */
+    checks: Array<{
+        /** Check timestamp */
+        timestamp: number;
+        /** Status at time of check */
+        status: string;
+        /** Block number at time of check */
+        blockNumber: bigint;
+    }>;
+}
+/**
+ * Relayer metrics
+ *
+ * @category Advanced
+ */
+export interface RelayerMetrics {
+    /** Total transactions processed */
+    totalTransactions: number;
+    /** Successful transactions */
+    successfulTransactions: number;
+    /** Failed transactions */
+    failedTransactions: number;
+    /** Average processing time in seconds */
+    averageProcessingTime: number;
+    /** Current queue size */
+    queueSize: number;
+    /** Uptime percentage */
+    uptime: number;
+    /** Last 24 hour statistics */
+    last24Hours: {
+        /** Transactions processed */
+        transactions: number;
+        /** Success rate */
+        successRate: number;
+        /** Average response time */
+        averageResponseTime: number;
+    };
+}
+/**
+ * Relayer webhook configuration
+ *
+ * @category Advanced
+ */
+export interface RelayerWebhookConfig {
+    /** Webhook URL */
+    url: string;
+    /** Events to subscribe to */
+    events: Array<"transaction_confirmed" | "transaction_failed" | "storage_complete">;
+    /** Webhook secret for signature verification */
+    secret?: string;
+    /** Whether webhook is active */
+    active: boolean;
+}
+/**
+ * Relayer webhook payload
+ *
+ * @category Advanced
+ */
+export interface RelayerWebhookPayload {
+    /** Event type */
+    event: string;
+    /** Event data */
+    data: Record<string, unknown>;
+    /** Timestamp */
+    timestamp: number;
+    /** Webhook ID */
+    webhookId: string;
+    /** 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;
+}
+/**
+ * Supported signed operation types.
+ * @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 {
+    /**
+     * Submit any relayer operation.
+     *
+     * 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
+     * @returns Promise resolving to operation-specific response
+     */
+    submit: (request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>;
+}

package/dist/types/relayer.js

@@ -0,0 +1 @@
+//# sourceMappingURL=relayer.js.map

package/dist/types/relayer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/storage.cjs

@@ -0,0 +1,39 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var storage_exports = {};
+__export(storage_exports, {
+  StorageError: () => StorageError
+});
+module.exports = __toCommonJS(storage_exports);
+class StorageError extends Error {
+  code;
+  provider;
+  // The 'cause' property is now inherited from the base Error class
+  constructor(message, code, provider, options) {
+    super(message, options);
+    this.name = "StorageError";
+    this.code = code;
+    this.provider = provider;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  StorageError
+});
+//# sourceMappingURL=storage.cjs.map

package/dist/types/storage.cjs.map

@@ -0,0 +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":[]}