@opendatalabs/vana-sdk 2.2.3 → 3.0.0

package/dist/types/blockchain.d.ts

@@ -1,85 +0,0 @@
-/**
- * Defines core blockchain interaction types.
- *
- * @remarks
- * This module provides fundamental types for blockchain transactions,
- * including transaction requests, confirmation options, and results.
- * These types form the basis for all blockchain interactions in the SDK.
- *
- * @category Types
- * @module types/blockchain
- */
-import type { Hash, Address } from "viem";
-/**
- * Represents a submitted blockchain transaction awaiting confirmation.
- *
- * @remarks
- * Returned immediately after transaction submission, before confirmation.
- * Use `waitForTransactionEvents` to wait for confirmation and retrieve events.
- *
- * @category Blockchain
- */
-export interface TransactionRequest {
-    /** Transaction hash */
-    hash: Hash;
-    /** Account that initiated the transaction */
-    from: Address;
-    /** Contract that was called */
-    contractName: string;
-    /** Function that was called */
-    functionName: string;
-    /** Function arguments (for debugging/logging) */
-    args?: readonly unknown[];
-}
-/**
- * Configures transaction confirmation waiting behavior.
- *
- * @remarks
- * Controls how long and how often to check for transaction confirmation.
- * Adjust based on network congestion and application requirements.
- *
- * @category Blockchain
- */
-export interface TransactionWaitOptions {
-    /** Number of confirmations to wait for (default: 1) */
-    confirmations?: number;
-    /** Timeout in milliseconds (default: 30000) */
-    timeout?: number;
-    /** Polling interval in milliseconds (default: 4000) */
-    pollingInterval?: number;
-}
-/**
- * Represents a confirmed blockchain transaction with metadata.
- *
- * @remarks
- * Contains essential transaction information after confirmation including
- * gas usage, block number, and function details. Extended by specific
- * result types with parsed events.
- *
- * @category Blockchain
- */
-export interface TransactionResult {
-    /** Transaction hash */
-    transactionHash: Hash;
-    /** Block number where transaction was included */
-    blockNumber: bigint;
-    /** Gas used by the transaction */
-    gasUsed: bigint;
-    /** Account that initiated the transaction */
-    from: Address;
-    /** Contract that was called */
-    contractName: string;
-    /** Function that was called */
-    functionName: string;
-}
-/**
- * @remarks
- * Event typing strategy:
- * - Event arguments are dynamically typed based on contract mappings
- * - `parseTransaction` returns `expectedEvents` with typed args for mapped functions
- * - `allEvents` contains all parsed events from the transaction
- * - This approach lets the mapping file drive types rather than requiring
- *   specific result interfaces per event type
- *
- * @internal
- */

package/dist/types/blockchain.js

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

package/dist/types/blockchain.js.map

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

package/dist/types/controller-context.cjs

@@ -1,17 +0,0 @@
-"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 controller_context_exports = {};
-module.exports = __toCommonJS(controller_context_exports);
-//# sourceMappingURL=controller-context.cjs.map

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

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

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

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

package/dist/types/controller-context.js

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

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

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

package/dist/types/data.cjs

@@ -1,17 +0,0 @@
-"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 data_exports = {};
-module.exports = __toCommonJS(data_exports);
-//# sourceMappingURL=data.cjs.map

package/dist/types/data.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/types/data.ts"],"sourcesContent":["import type { Address, Hash } from \"viem\";\n\n/**\n * Represents a file registered on the Vana blockchain.\n *\n * @remarks\n * Contains complete metadata for files uploaded to storage and registered\n * on-chain. Each file has a unique ID, owner address, and storage URL.\n * Used throughout SDK for file operations and permission management.\n *\n * @category Data Management\n */\nexport interface UserFile {\n  /** Unique identifier assigned by the Data Registry contract. */\n  id: number;\n  /** Storage URL where the encrypted file content is hosted. */\n  url: string;\n  /** Wallet address of the user who owns this file. */\n  ownerAddress: Address;\n  /** Block number when this file was registered on-chain. */\n  addedAtBlock: bigint;\n  /**\n   * Schema identifier for data validation and structure definition.\n   * Obtain schema IDs from `vana.schemas.list()` or when creating schemas via `vana.schemas.create()`.\n   */\n  schemaId?: number;\n  /** Unix timestamp when the file was registered on-chain. */\n  addedAtTimestamp?: bigint;\n  /** Transaction hash of the on-chain file registration. */\n  transactionHash?: Address;\n  /** Additional file properties and custom application data. */\n  metadata?: FileMetadata;\n  /**\n   * Array of DLP IDs that have submitted proofs for this file.\n   * Each proof represents verification or processing by a Data Liquidity Pool.\n   * Obtain DLP details via `vana.data.getDLP(dlpId)`.\n   */\n  dlpIds?: number[];\n}\n\n/**\n * Provides optional metadata for uploaded files and content description.\n *\n * @remarks\n * This interface contains descriptive information about uploaded files, including\n * file properties and custom application-specific data that can be used for\n * organization, validation, and display purposes.\n * @category Data Management\n */\nexport interface FileMetadata {\n  /** Original filename as provided by the user or application. */\n  name?: string;\n  /** Total file size in bytes for storage tracking. */\n  size?: number;\n  /** MIME type identifier for content type recognition. */\n  mimeType?: string;\n  /** Hash value for file integrity verification. */\n  checksum?: string;\n  /** ISO 8601 timestamp when the file was uploaded. */\n  uploadedAt?: string;\n  /** Application-specific metadata for custom use cases. */\n  custom?: Record<string, unknown>;\n}\n\n/**\n * High-level parameters for uploading user data with automatic encryption and blockchain registration.\n *\n * @remarks\n * This is the primary interface for uploading user data through the simplified `vana.data.upload()` method.\n * It handles the complete workflow including encryption, storage, and blockchain registration.\n *\n * When using permissions with encryption enabled (default), you must provide the public key\n * for each permission recipient.\n *\n * @example\n * ```typescript\n * // Basic file upload\n * const result = await vana.data.upload({\n *   content: \"My personal data\",\n *   filename: \"diary.txt\"\n * });\n *\n * // Upload with schema validation\n * const result = await vana.data.upload({\n *   content: { name: \"John\", age: 30 },\n *   filename: \"profile.json\",\n *   schemaId: 1\n * });\n *\n * // Upload with permissions for an app (encrypted - requires publicKey)\n * const result = await vana.data.upload({\n *   content: \"Data for AI analysis\",\n *   filename: \"analysis.txt\",\n *   permissions: [{\n *     grantee: \"0x1234...\",\n *     operation: \"llm_inference\",\n *     parameters: { model: \"gpt-4\" },\n *     publicKey: \"0x04...\" // Required when encrypt is true (default)\n *   }]\n * });\n *\n * // Upload without encryption (publicKey optional)\n * const result = await vana.data.upload({\n *   content: \"Public data\",\n *   filename: \"public.txt\",\n *   encrypt: false,\n *   permissions: [{\n *     grantee: \"0x1234...\",\n *     operation: \"read\",\n *     parameters: {}\n *   }]\n * });\n * ```\n * @category Data Management\n */\nexport interface UploadParams {\n  /** Raw file data as string, Blob, or Buffer. */\n  content: string | Blob | Buffer;\n  /** Optional filename for the uploaded file. */\n  filename?: string;\n  /** Optional schema ID for data validation. */\n  schemaId?: number;\n  /** Optional file permissions to grant decryption access during upload. */\n  permissions?: FilePermissionParams[];\n  /** Whether to encrypt the data (defaults to true). */\n  encrypt?: boolean;\n  /** Optional storage provider name. */\n  providerName?: string;\n  /** Optional owner address (defaults to current wallet address). */\n  owner?: Address;\n  /**\n   * Schema validation mode when schemaId is provided:\n   * - 'strict': Throw error on validation failure (default)\n   * - 'warn': Log warning and continue on validation failure\n   * - 'skip': Skip validation entirely\n   */\n  schemaValidation?: \"strict\" | \"warn\" | \"skip\";\n}\n\n/**\n * Upload parameters with encryption enabled.\n *\n * @remarks\n * This interface ensures type safety when using encrypted uploads with permissions.\n * When encrypt is true, any permissions must include public keys for encryption.\n * @category Data Management\n */\nexport interface EncryptedUploadParams\n  extends Omit<UploadParams, \"permissions\" | \"encrypt\"> {\n  /** File permissions with required public keys for encrypted data sharing. */\n  permissions?: FilePermissionParams[];\n  /** Encryption is enabled. */\n  encrypt: true;\n}\n\n/**\n * Upload parameters with encryption disabled.\n *\n * @remarks\n * This interface is used when uploading unencrypted data.\n * @category Data Management\n */\nexport interface UnencryptedUploadParams extends Omit<UploadParams, \"encrypt\"> {\n  /** Encryption is disabled. */\n  encrypt: false;\n}\n\n/**\n * Parameters for granting file decryption access during upload.\n *\n * @remarks\n * This interface is used to grant decryption access to specific accounts when uploading\n * encrypted files. It only handles encryption key sharing, not operation permissions.\n *\n * For granting operation permissions (like \"llm_inference\"), use the separate\n * `vana.permissions.grant()` method after uploading.\n *\n * @example\n * ```typescript\n * // Upload with decryption permission\n * const result = await vana.data.upload({\n *   content: \"data\",\n *   permissions: [{\n *     account: \"0xServerAddress...\",\n *     publicKey: \"0x04...\" // Server's public key\n *   }]\n * });\n * ```\n * @category Data Management\n */\nexport interface FilePermissionParams {\n  /** The account address that will be able to decrypt this file. */\n  account: Address;\n  /** The public key to encrypt the file's encryption key with. */\n  publicKey: string;\n}\n\n/**\n * Permission parameters for granting data access.\n *\n * @remarks\n * This interface defines parameters for granting permissions to access data.\n * It's used in the permissions system but kept here for compatibility.\n *\n * @category Data Management\n */\nexport interface PermissionParams {\n  /** The address of the application to grant permission to. */\n  grantee: Address;\n  /** The operation type (e.g., \"llm_inference\", \"data_analysis\", \"compute_task\"). */\n  operation: string;\n  /** Additional parameters for the permission (operation-specific configuration). */\n  parameters: Record<string, unknown>;\n  /** Optional nonce for the permission (auto-generated if not provided). */\n  nonce?: bigint;\n  /** Optional expiration timestamp (Unix seconds, no expiration if not provided). */\n  expiresAt?: number;\n  /**\n   * Public key of the recipient to encrypt the data key for (required for upload with permissions).\n   * Obtain via `vana.server.getIdentity(recipientAddress).public_key` for personal servers.\n   */\n  publicKey?: string;\n}\n\n/**\n * Legacy permission parameters that conflated file encryption and data access grants.\n *\n * @remarks\n * This interface was removed because it conflated two different concepts:\n * 1. File encryption permissions (handled during upload)\n * 2. Data access grants (operation permissions)\n *\n * For file uploads, use FilePermissionParams instead.\n * For data access grants, use vana.permissions.grant() after uploading.\n *\n * @deprecated Removed in v2.0.0. Use FilePermissionParams for uploads.\n * @category Data Management\n */\nexport interface LegacyPermissionParams {\n  grantee: Address;\n  operation: string;\n  parameters: Record<string, unknown>;\n  nonce?: bigint;\n  expiresAt?: number;\n  publicKey?: string;\n}\n\n/**\n * Result of the high-level upload operation.\n *\n * @remarks\n * Returned by the `vana.data.upload()` method after successful upload and blockchain registration.\n * @category Data Management\n */\nexport interface UploadResult {\n  /** The file ID assigned by the DataRegistry contract. */\n  fileId: number;\n  /** The storage URL where the file is hosted. */\n  url: string;\n  /** The transaction hash of the blockchain registration. */\n  transactionHash: Hash;\n  /** The actual file size in bytes. */\n  size: number;\n  /** Whether the data passed schema validation (if applicable). */\n  isValid?: boolean;\n  /** Validation errors if schema validation failed. */\n  validationErrors?: string[];\n  /** Permission IDs if permissions were granted during upload. */\n  permissionIds?: bigint[];\n}\n\n/**\n * Defines parameters for uploading files to storage providers with encryption options.\n *\n * @remarks\n * Used with DataController upload methods and storage operations. Supports multiple\n * content formats, optional encryption, and custom storage provider selection with\n * comprehensive metadata tracking.\n * @deprecated Use UploadParams with vana.data.upload() instead for the high-level API\n * @example\n * ```typescript\n * const uploadParams: UploadFileParams = {\n *   content: new TextEncoder().encode(JSON.stringify(userData)),\n *   metadata: {\n *     name: \"personal-profile.json\",\n *     mimeType: \"application/json\",\n *     size: 2048,\n *   },\n *   storageProvider: \"ipfs\",\n *   encrypt: true,\n * };\n *\n * const result = await vana.data.uploadFile(uploadParams);\n * ```\n * @category Data Management\n */\nexport interface UploadFileParams {\n  /** Raw file data in bytes, buffer, or string format. */\n  content: Uint8Array | Buffer | string;\n  /** Descriptive metadata for file organization and tracking. */\n  metadata?: FileMetadata;\n  /** Storage provider name (\"ipfs\" or custom provider, uses configured default if unspecified). */\n  storageProvider?: string;\n  /** Enables automatic encryption before upload to storage (defaults to false). */\n  encrypt?: boolean;\n  /** Custom encryption key (auto-generated if encryption enabled and not provided). */\n  encryptionKey?: string;\n}\n\n/**\n * Contains the result of a successful file upload operation.\n *\n * @remarks\n * This interface provides the essential information returned after uploading\n * a file to a storage provider, including access URL, size verification,\n * and encryption details when applicable.\n * @category Data Management\n */\nexport interface UploadFileResult {\n  /** Public URL where the uploaded file can be accessed. */\n  url: string;\n  /** Actual file size in bytes after upload processing. */\n  size: number;\n  /** Hash value for verifying file integrity after upload. */\n  checksum?: string;\n  /** Encryption metadata when file was encrypted before storage. */\n  encryption?: EncryptionInfo;\n}\n\n/**\n * Result of uploading an encrypted file to storage and blockchain\n *\n * @category Data Management\n */\nexport interface UploadEncryptedFileResult extends UploadFileResult {\n  /** The new file ID assigned by the DataRegistry */\n  fileId: number;\n  /** Transaction hash of the file registration */\n  transactionHash?: Hash;\n}\n\n/**\n * Encryption information for a file\n *\n * @category Data Management\n */\nexport interface EncryptionInfo {\n  /** Encryption algorithm used */\n  algorithm: string;\n  /** Key derivation function */\n  kdf?: string;\n  /** Initialization vector */\n  iv?: string;\n  /** Salt used for key derivation */\n  salt?: string;\n  /** Key identifier */\n  keyId?: string;\n}\n\n/**\n * Parameters for getting user files\n *\n * @category Data Management\n */\nexport interface GetUserFilesParams {\n  /** Owner address to filter by */\n  owner?: Address;\n  /** Starting block number for filtering */\n  fromBlock?: bigint;\n  /** Ending block number for filtering */\n  toBlock?: bigint;\n  /** Maximum number of files to return */\n  limit?: number;\n  /** Offset for pagination */\n  offset?: number;\n}\n\n/**\n * Parameters for getting a specific file\n *\n * @category Data Management\n */\nexport interface GetFileParams {\n  /** File ID to retrieve */\n  fileId: number;\n  /** Whether to include metadata */\n  includeMetadata?: boolean;\n}\n\n/**\n * Parameters for downloading a file\n *\n * @category Data Management\n */\nexport interface DownloadFileParams {\n  /** File URL or ID to download */\n  file: string | number;\n  /** Storage provider to use */\n  storageProvider?: string;\n  /** Decryption key if file is encrypted */\n  decryptionKey?: string;\n}\n\n/**\n * Result of downloading a file\n *\n * @category Data Management\n */\nexport interface DownloadFileResult {\n  /** File content */\n  content: Uint8Array;\n  /** File metadata */\n  metadata?: FileMetadata;\n  /** Whether the file was encrypted */\n  wasEncrypted?: boolean;\n}\n\n/**\n * Parameters for deleting a file\n *\n * @category Data Management\n */\nexport interface DeleteFileParams {\n  /** File ID to delete */\n  fileId: number;\n  /** Whether to also delete from storage */\n  deleteFromStorage?: boolean;\n  /** Storage provider to delete from */\n  storageProvider?: string;\n}\n\n/**\n * Result of deleting a file\n *\n * @category Data Management\n */\nexport interface DeleteFileResult {\n  /** Whether the file was successfully deleted from the registry */\n  registryDeleted: boolean;\n  /** Whether the file was successfully deleted from storage */\n  storageDeleted?: boolean;\n  /** Transaction hash of the deletion */\n  transactionHash?: Hash;\n}\n\n/**\n * Options for encrypting a file\n *\n * @category Data Management\n */\nexport interface EncryptFileOptions {\n  /** Encryption seed for key derivation. Defaults to DEFAULT_ENCRYPTION_SEED */\n  seed?: string;\n  /** MIME type for the encrypted blob if input is not already a Blob */\n  mimeType?: string;\n}\n\n/**\n * Result of encrypting a file\n *\n * @category Data Management\n */\nexport interface EncryptFileResult {\n  /** The encrypted data as a Blob */\n  encryptedData: Blob;\n  /** The encryption key used (derived from wallet) */\n  encryptionKey: string;\n}\n\n/**\n * Options for decrypting a file\n *\n * @category Data Management\n */\nexport interface DecryptFileOptions {\n  /** Encryption seed for key derivation. Defaults to DEFAULT_ENCRYPTION_SEED */\n  seed?: string;\n}\n\n/**\n * Parameters for uploading a file with permissions\n *\n * @category Data Management\n */\nexport interface UploadFileWithPermissionsParams {\n  /** The file data to encrypt and upload */\n  data: Blob;\n  /** Array of permissions to grant, each with account address and public key */\n  permissions: Array<{ account: Address; publicKey: string }>;\n  /** Optional filename for the upload */\n  filename?: string;\n  /** Optional storage provider to use */\n  providerName?: string;\n}\n\n/**\n * Parameters for adding permission to a file\n *\n * @category Data Management\n */\nexport interface AddFilePermissionParams {\n  /** The file ID to grant permission for */\n  fileId: number;\n  /** The account to grant permission to */\n  account: Address;\n  /** The public key of the account for encryption */\n  publicKey: string;\n}\n\n/**\n * Options for decrypting a file with permission\n *\n * @category Data Management\n */\nexport interface DecryptFileWithPermissionOptions {\n  /** Optional account address to verify permission against */\n  account?: Address;\n}\n\n/**\n * File access permissions\n *\n * @category Data Management\n */\nexport interface FileAccessPermissions {\n  /** Whether the file can be read */\n  read: boolean;\n  /** Whether the file can be written */\n  write: boolean;\n  /** Whether the file can be deleted */\n  delete: boolean;\n  /** Whether the file can be shared */\n  share: boolean;\n}\n\n/**\n * File sharing configuration\n *\n * @category Data Management\n */\nexport interface FileSharingConfig {\n  /** Addresses that can access the file */\n  allowedAddresses?: Address[];\n  /** Expiration time for shared access */\n  expiresAt?: Date;\n  /** Required permissions for shared access */\n  permissions: FileAccessPermissions;\n}\n\n/**\n * Batch upload parameters\n *\n * @category Data Management\n */\nexport interface BatchUploadParams {\n  /** Array of files to upload */\n  files: UploadFileParams[];\n  /** Storage provider to use for all files */\n  storageProvider?: string;\n  /** Whether to encrypt all files */\n  encrypt?: boolean;\n  /** Encryption key for all files */\n  encryptionKey?: string;\n}\n\n/**\n * Batch upload result\n *\n * @category Data Management\n */\nexport interface BatchUploadResult {\n  /** Results for each uploaded file */\n  results: UploadEncryptedFileResult[];\n  /** Overall success status */\n  success: boolean;\n  /** Any errors that occurred */\n  errors?: string[];\n}\n\n/**\n * Schema metadata from the blockchain (without fetched definition).\n *\n * This represents the on-chain schema registration data before the\n * definition has been fetched from the storage URL.\n *\n * @category Data Management\n */\nexport interface SchemaMetadata {\n  /** Schema ID */\n  id: number;\n  /** Schema name */\n  name: string;\n  /** Schema dialect ('json' or 'sqlite') */\n  dialect: \"json\" | \"sqlite\";\n  /** URL containing the schema definition */\n  definitionUrl: string;\n}\n\n/**\n * Complete schema with all definition fields populated.\n * This is what schemas.get() returns - a schema with the definition fetched.\n */\nexport interface CompleteSchema extends SchemaMetadata {\n  /** Version of the schema */\n  version: string;\n  /** Optional description of the schema */\n  description?: string;\n  /** Optional version of the dialect */\n  dialectVersion?: string;\n  /** The actual schema - JSON Schema object for 'json' dialect, DDL string for 'sqlite' */\n  schema: object | string;\n}\n\n/**\n * Schema with optional definition fields.\n *\n * Schemas define the structure and validation rules for user data processed by refiners.\n * They ensure data quality and consistency across the Vana network by specifying how\n * raw user data should be formatted, validated, and processed.\n *\n * When the definition has been fetched (via schemas.get() or schemas.list() with includeDefinitions),\n * the version and schema fields will be populated. Otherwise, only the metadata fields are present.\n *\n * @category Data Management\n * @example\n * ```typescript\n * // Complete schema from schemas.get()\n * const completeSchema: Schema = {\n *   id: 5,\n *   name: 'Social Media Profile',\n *   dialect: 'json',\n *   definitionUrl: 'ipfs://QmSchema...',\n *   version: '1.0.0',\n *   description: 'Schema for validating social media profile data',\n *   schema: { // JSON Schema object\n *     type: 'object',\n *     properties: {\n *       username: { type: 'string' }\n *     }\n *   }\n * };\n *\n * // Metadata-only schema from schemas.list() without includeDefinitions\n * const metadataSchema: Schema = {\n *   id: 5,\n *   name: 'Social Media Profile',\n *   dialect: 'json',\n *   definitionUrl: 'ipfs://QmSchema...'\n * };\n * ```\n */\nexport interface Schema extends SchemaMetadata {\n  /** Version of the schema (present when definition is fetched) */\n  version?: string;\n  /** Optional description of the schema */\n  description?: string;\n  /** Optional version of the dialect */\n  dialectVersion?: string;\n  /** The actual schema - JSON Schema object for 'json' dialect, DDL string for 'sqlite' (present when definition is fetched) */\n  schema?: object | string;\n}\n\n/**\n * Represents a refiner with schema information\n *\n * @category Data Management\n */\nexport interface Refiner {\n  /** Refiner ID */\n  id: number;\n  /** DLP ID this refiner belongs to */\n  dlpId: number;\n  /** Owner address */\n  owner: Address;\n  /** Refiner name */\n  name: string;\n  /** Schema ID associated with this refiner */\n  schemaId: number;\n  /** URL containing refinement instructions */\n  refinementInstructionUrl: string;\n}\n\n/**\n * Parameters for adding a new schema\n *\n * @category Data Management\n */\nexport interface AddSchemaParams {\n  /** Schema name */\n  name: string;\n  /** Schema dialect */\n  dialect: string;\n  /** URL containing the schema definition */\n  definitionUrl: string;\n}\n\n/**\n * Result of adding a schema\n *\n * @category Data Management\n */\nexport interface AddSchemaResult {\n  /** The new schema ID assigned by the contract */\n  schemaId: number;\n  /** Transaction hash of the schema registration */\n  transactionHash: Hash;\n}\n\n/**\n * Parameters for registering a new data refiner in the Vana network.\n *\n * Refiners are processors that transform and validate user data according to specific\n * schemas and instructions. They enable applications to work with structured, verified\n * user data while maintaining privacy and user control.\n *\n * @category Data Management\n * @example\n * ```typescript\n * const refinerParams: AddRefinerParams = {\n *   dlpId: 1, // Data Liquidity Pool ID\n *   name: 'Social Media Refiner',\n *   schemaId: 5, // Pre-defined schema for social media data\n *   refinementInstructionUrl: 'ipfs://Qm...' // Instructions for data processing\n * };\n * ```\n */\nexport interface AddRefinerParams {\n  /** DLP ID this refiner belongs to */\n  dlpId: number;\n  /** Refiner name */\n  name: string;\n  /** Schema ID to associate with this refiner */\n  schemaId: number;\n  /** URL containing refinement instructions */\n  refinementInstructionUrl: string;\n}\n\n/**\n * Result of adding a refiner\n *\n * @category Data Management\n */\nexport interface AddRefinerResult {\n  /** The new refiner ID assigned by the contract */\n  refinerId: number;\n  /** Transaction hash of the refiner registration */\n  transactionHash: Hash;\n}\n\n/**\n * Parameters for updating a refiner's schema ID\n *\n * @category Data Management\n */\nexport interface UpdateSchemaIdParams {\n  /** Refiner ID to update */\n  refinerId: number;\n  /** New schema ID to associate with the refiner */\n  newSchemaId: number;\n}\n\n/**\n * Result of updating a refiner's schema ID\n *\n * @category Data Management\n */\nexport interface UpdateSchemaIdResult {\n  /** Transaction hash of the update */\n  transactionHash: Hash;\n}\n\n/**\n * Trusted server data structure\n *\n * @category Data Management\n */\nexport interface TrustedServer {\n  /** Unique identifier for the trusted server relationship */\n  id: string;\n  /** Server address (EVM address) */\n  serverAddress: Address;\n  /** Server URL */\n  serverUrl: string;\n  /** Timestamp when server was trusted */\n  trustedAt: bigint;\n  /** User who trusted the server */\n  user: Address;\n  /** Index in user's trusted server list (only available in RPC mode) */\n  trustIndex?: number;\n}\n\n/**\n * Parameters for getUserTrustedServers method\n *\n * @category Data Management\n */\nexport interface GetUserTrustedServersParams {\n  /** User address to query trusted servers for */\n  user: Address;\n  /** Optional subgraph URL to override default */\n  subgraphUrl?: string;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}