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

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 } 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":[]}

package/dist/types/relayer.d.ts

@@ -0,0 +1,281 @@
+import type { Hash } from "viem";
+import type { GrantFile, PermissionGrantTypedData } 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 configuration
+ *
+ * @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
+ *
+ * @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;
+}

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":[]}

package/dist/types/storage.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Interface for storage providers that handle file upload, download, and management operations.
+ *
+ * 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.
+ *
+ * @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 };
+ *   }
+ *
+ *   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
+ *   }
+ * }
+ * ```
+ */
+export interface StorageProvider {
+    /**
+     * Upload a file to the storage provider
+     *
+     * @param file - The file to upload
+     * @param filename - Optional custom filename
+     * @returns Promise with storage URL and metadata
+     */
+    upload(file: Blob, filename?: string): Promise<StorageUploadResult>;
+    /**
+     * Download a file from the storage provider
+     *
+     * @param url - The storage URL
+     * @returns Promise with file blob
+     */
+    download(url: string): Promise<Blob>;
+    /**
+     * List files from the storage provider
+     *
+     * @param options - Optional filtering and pagination
+     * @returns Promise with file list
+     */
+    list(options?: StorageListOptions): Promise<StorageFile[]>;
+    /**
+     * Delete a file from the storage provider
+     *
+     * @param url - The storage URL
+     * @returns Promise with success status
+     */
+    delete(url: string): Promise<boolean>;
+    /**
+     * Get provider-specific configuration
+     *
+     * @returns Provider configuration object
+     */
+    getConfig(): StorageProviderConfig;
+}
+export interface StorageUploadResult {
+    /** Public URL to access the file */
+    url: string;
+    /** File size in bytes */
+    size: number;
+    /** Content type/MIME type */
+    contentType: string;
+    /** Provider-specific metadata */
+    metadata?: Record<string, unknown>;
+}
+export interface StorageFile {
+    /** File identifier */
+    id: string;
+    /** File name */
+    name: string;
+    /** Public URL to access the file */
+    url: string;
+    /** File size in bytes */
+    size: number;
+    /** Content type/MIME type */
+    contentType: string;
+    /** Upload timestamp */
+    createdAt: Date;
+    /** Provider-specific metadata */
+    metadata?: Record<string, unknown>;
+}
+export interface StorageListOptions {
+    /** Maximum number of files to return */
+    limit?: number;
+    /** Pagination cursor/offset */
+    offset?: string | number;
+    /** Filter by file name pattern */
+    namePattern?: string;
+    /** Filter by content type */
+    contentType?: string;
+}
+export interface StorageProviderConfig {
+    /** Provider name */
+    name: string;
+    /** Provider type */
+    type: string;
+    /** Whether authentication is required */
+    requiresAuth: boolean;
+    /** Supported features */
+    features: {
+        upload: boolean;
+        download: boolean;
+        list: boolean;
+        delete: boolean;
+    };
+}
+export declare class StorageError extends Error {
+    readonly code: string;
+    readonly provider: string;
+    constructor(message: string, code: string, provider: string, options?: {
+        cause?: Error;
+    });
+}

package/dist/types/storage.js

@@ -0,0 +1,15 @@
+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;
+  }
+}
+export {
+  StorageError
+};
+//# sourceMappingURL=storage.js.map

package/dist/types/storage.js.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":"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":[]}

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

package/dist/types/transactionResults.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/transactionResults.ts"],"sourcesContent":["import type { Address } from \"viem\";\n// BaseTransactionResult will be replaced once migration is complete\ninterface BaseTransactionResult {\n  transactionHash: `0x${string}`;\n  blockNumber: bigint;\n  gasUsed: bigint;\n}\n\n/**\n * Transaction result types for all SDK operations.\n * These interfaces define the structure of data returned by enhanced\n * transaction methods that parse blockchain events automatically.\n */\n\n// =============================================================================\n// PERMISSION OPERATIONS\n// =============================================================================\n\n/**\n * Result of a successful permission grant operation.\n * Contains data from the PermissionAdded blockchain event.\n */\nexport interface PermissionGrantResult extends BaseTransactionResult {\n  /** Unique permission ID for this grant */\n  permissionId: bigint;\n  /** Address of the user who granted the permission */\n  user: Address;\n  /** URL where the grant file is stored (IPFS/CDN) */\n  grant: string;\n  /** Array of file IDs covered by this permission */\n  fileIds: readonly bigint[];\n}\n\n/**\n * Result of a successful permission revocation operation.\n * Contains data from the PermissionRevoked blockchain event.\n */\nexport interface PermissionRevokeResult extends BaseTransactionResult {\n  /** ID of the permission that was revoked */\n  permissionId: bigint;\n}\n\n/**\n * Result of a successful server trust operation.\n * Contains data from the ServerTrusted blockchain event.\n */\nexport interface ServerTrustResult extends BaseTransactionResult {\n  /** Address of the user who trusted the server (from event) */\n  user: Address;\n  /** Numeric ID of the trusted server (from event) */\n  serverId: bigint;\n  /** Address of the trusted server (from params/derived) */\n  serverAddress?: Address;\n  /** URL of the trusted server (from params/provided) */\n  serverUrl?: string;\n}\n\n/**\n * Result of a successful server untrust operation.\n * Contains data from the ServerUntrusted blockchain event.\n */\nexport interface ServerUntrustResult extends BaseTransactionResult {\n  /** Address of the user who untrusted the server */\n  user: Address;\n  /** Address/ID of the untrusted server */\n  serverId: Address;\n}\n\n/**\n * Result of a successful server registration operation.\n * Contains data from the ServerRegistered blockchain event.\n */\nexport interface ServerRegisterResult extends BaseTransactionResult {\n  /** Unique server ID assigned by the registry */\n  serverId: bigint;\n  /** URL of the registered server */\n  url: string;\n  /** Owner address of the server */\n  owner: Address;\n}\n\n/**\n * Result of a successful server update operation.\n * Contains data from the ServerUpdated blockchain event.\n */\nexport interface ServerUpdateResult extends BaseTransactionResult {\n  /** ID of the server that was updated */\n  serverId: bigint;\n  /** New URL of the server */\n  url: string;\n}\n\n/**\n * Result of a successful grantee registration operation.\n * Contains data from the GranteeRegistered blockchain event.\n */\nexport interface GranteeRegisterResult extends BaseTransactionResult {\n  /** Unique grantee ID assigned by the registry */\n  granteeId: bigint;\n  /** Address of the registered grantee */\n  granteeAddress: Address;\n  /** Display name of the grantee */\n  name: string;\n}\n\n// =============================================================================\n// DATA REGISTRY OPERATIONS\n// =============================================================================\n\n/**\n * Result of a successful file addition operation.\n * Contains data from the FileAddedV2 blockchain event.\n */\nexport interface FileAddedResult extends BaseTransactionResult {\n  /** Unique file ID assigned by the registry */\n  fileId: bigint;\n  /** Address of the file owner */\n  ownerAddress: Address;\n  /** URL where the file is stored */\n  url: string;\n  /** Schema ID associated with the file (0 for no schema) */\n  schemaId: bigint;\n}\n\n/**\n * Result of a successful schema addition operation.\n * Contains data from the SchemaAdded blockchain event.\n */\nexport interface SchemaAddedResult extends BaseTransactionResult {\n  /** Unique schema ID assigned by the registry */\n  schemaId: bigint;\n  /** Human-readable name of the schema */\n  name: string;\n  /** Schema dialect (e.g., \"jsonschema\") */\n  dialect: string;\n  /** URL where the schema definition is stored */\n  definitionUrl: string;\n}\n\n/**\n * Result of a successful refiner addition operation.\n * Contains data from the RefinerAdded blockchain event.\n */\nexport interface RefinerAddedResult extends BaseTransactionResult {\n  /** Unique refiner ID assigned by the registry */\n  refinerId: bigint;\n  /** DLP ID this refiner belongs to */\n  dlpId: bigint;\n  /** Human-readable name of the refiner */\n  name: string;\n  /** Schema ID this refiner uses */\n  schemaId: bigint;\n  /** URL where the schema definition is stored */\n  schemaDefinitionUrl: string;\n  /** URL with refiner processing instructions */\n  refinementInstructionUrl: string;\n}\n\n/**\n * Result of a successful schema ID update operation.\n * Contains data from the RefinerSchemaUpdated blockchain event.\n */\nexport interface SchemaUpdateResult extends BaseTransactionResult {\n  /** ID of the refiner that was updated */\n  refinerId: bigint;\n  /** New schema ID */\n  schemaId: bigint;\n  /** URL of the new schema definition */\n  schemaDefinitionUrl: string;\n}\n\n/**\n * Result of a successful file permission addition operation.\n * Contains data from the FilePermissionAdded blockchain event.\n */\nexport interface FilePermissionResult extends BaseTransactionResult {\n  /** File ID the permission was added to */\n  fileId: bigint;\n  /** Account that was granted permission */\n  account: Address;\n  /** Encrypted key for file access */\n  encryptedKey: string;\n}\n\n// =============================================================================\n// UNION TYPES FOR GENERIC OPERATIONS\n// =============================================================================\n\n/**\n * Union type of all possible transaction result types.\n * Useful for generic functions that handle multiple operation types.\n */\nexport type AnyTransactionResult =\n  | PermissionGrantResult\n  | PermissionRevokeResult\n  | ServerTrustResult\n  | ServerUntrustResult\n  | ServerRegisterResult\n  | ServerUpdateResult\n  | GranteeRegisterResult\n  | FileAddedResult\n  | SchemaAddedResult\n  | RefinerAddedResult\n  | SchemaUpdateResult\n  | FilePermissionResult;\n\n// =============================================================================\n// TYPE UTILITIES\n// =============================================================================\n\n/**\n * Maps transaction operation names to their result types.\n * Used for type inference in generic transaction parsing functions.\n */\nexport interface TransactionResultMap {\n  grant: PermissionGrantResult;\n  revoke: PermissionRevokeResult;\n  revokePermission: PermissionRevokeResult;\n  addServerFilesAndPermissions: PermissionGrantResult;\n  trustServer: ServerTrustResult;\n  untrustServer: ServerUntrustResult;\n  registerServer: ServerRegisterResult;\n  updateServer: ServerUpdateResult;\n  addAndTrustServer: ServerTrustResult;\n  registerGrantee: GranteeRegisterResult;\n  addFile: FileAddedResult;\n  addFileWithPermissionsAndSchema: FileAddedResult;\n  addFileWithSchema: FileAddedResult;\n  addFileWithPermissions: FileAddedResult;\n  addRefinement: RefinerAddedResult;\n  addRefiner: RefinerAddedResult;\n  updateSchemaId: SchemaUpdateResult;\n  addSchema: SchemaAddedResult;\n  updateRefinement: SchemaUpdateResult;\n  addFilePermission: FilePermissionResult;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}