@opendatalabs/vana-sdk 0.1.0-alpha.a6b60fc → 0.1.0-alpha.a78ce5c

package/dist/controllers/data.d.ts

@@ -1,9 +1,10 @@
 import type { Address } from "viem";
+import type { TransactionOptions, TransactionResult } from "../types/operations";
 import type { StorageUploadResult } from "../types/storage";
 import type { UserFile, UploadParams, UploadResult, UploadEncryptedFileResult, Refiner, AddRefinerParams, AddRefinerResult, UpdateSchemaIdParams, UpdateSchemaIdResult, TrustedServer, GetUserTrustedServersParams, EncryptedUploadParams, UnencryptedUploadParams, EncryptFileOptions, EncryptFileResult, DecryptFileOptions, UploadFileWithPermissionsParams, AddFilePermissionParams, DecryptFileWithPermissionOptions } from "../types/index";
-import type { TransactionResult } from "../types/operations";
 import type { ControllerContext } from "./permissions";
 import { BaseController } from "./base";
+import type { ConsistencyOptions, PaginationOptions } from "../types/options";
 import { type DataSchema } from "../utils/schemaValidation";
 /**
  * Manages encrypted user data files and blockchain registration on the Vana network.
@@ -84,6 +85,12 @@ export declare class DataController extends BaseController {
      * - File permissions (here): Decryption access only
      * - Operation permissions: Use `vana.permissions.grant()` separately
      *
+     * **Owner/Encryption Constraint:**
+     * When encryption is enabled (default), the `owner` parameter must match
+     * the connected wallet address. This ensures only the wallet that performs
+     * encryption can decrypt the file. For delegation scenarios where the owner
+     * differs from the connected wallet, set `encrypt: false`.
+     *
      * @param params - Upload configuration object
      * @param params.content - Data to upload (string, object, or Blob)
      * @param params.filename - Name for the uploaded file
@@ -91,13 +98,17 @@ export declare class DataController extends BaseController {
      *   Each requires `account` and `publicKey` for encryption.
      * @param params.schemaId - Schema for validation.
      *   Obtain via `vana.schemas.list()`.
-     * @param params.owner - Owner address for delegation scenarios.
+     * @param params.owner - Owner address for blockchain registration.
+     *   Must match connected wallet when encryption is enabled.
+     *   For delegation scenarios, disable encryption with `encrypt: false`.
      *   Defaults to connected wallet address.
      * @param params.encrypt - Enable encryption (default: `true`)
      * @param params.providerName - Storage provider override
      *
      * @returns Upload result with file ID, URL, and transaction hash
      *
+     * @throws {InvalidConfigurationError} When encryption is enabled and owner differs from wallet.
+     *   Set `encrypt: false` for delegation scenarios, or omit `owner` to use connected wallet.
      * @throws {Error} Storage not configured.
      *   Configure storage providers in `VanaConfig`.
      * @throws {Error} No wallet addresses available.
@@ -147,15 +158,12 @@ export declare class DataController extends BaseController {
      *   encrypt: false
      * } as const);  // 'as const' ensures TypeScript infers encrypt: false literally
      *
-     * // Upload on behalf of another user (delegation)
+     * // Upload on behalf of another user (delegation without encryption)
      * const result = await vana.data.upload({
      *   content: "User's data",
      *   filename: "delegated.txt",
-     *   owner: "0x5678...", // Different from connected wallet
-     *   permissions: [{
-     *     account: "0x1234...",   // Address that can decrypt
-     *     publicKey: "0x04..."    // Their public key for encryption
-     *   }]
+     *   owner: "0x5678...",  // Different from connected wallet
+     *   encrypt: false        // Required when owner differs from wallet
      * });
      * ```
      */
@@ -300,7 +308,7 @@ export declare class DataController extends BaseController {
     getUserFiles(params: {
         owner: Address;
         subgraphUrl?: string;
-    }): Promise<UserFile[]>;
+    }, options?: ConsistencyOptions & PaginationOptions): Promise<UserFile[]>;
     /**
      * Fetches proof data for multiple files from the subgraph.
      *
@@ -341,6 +349,8 @@ export declare class DataController extends BaseController {
      */
     getDLP(dlpId: number, options?: {
         subgraphUrl?: string;
+        minBlock?: number;
+        waitForSync?: number;
     }): Promise<{
         id: number;
         name: string;
@@ -401,7 +411,7 @@ export declare class DataController extends BaseController {
     getUserPermissions(params: {
         user: Address;
         subgraphUrl?: string;
-    }): Promise<Array<{
+    }, options?: ConsistencyOptions & PaginationOptions): Promise<Array<{
         id: string;
         grant: string;
         nonce: bigint;
@@ -464,7 +474,7 @@ export declare class DataController extends BaseController {
      * });
      * ```
      */
-    getUserTrustedServers(params: GetUserTrustedServersParams): Promise<TrustedServer[]>;
+    getUserTrustedServers(params: GetUserTrustedServersParams, options?: ConsistencyOptions & PaginationOptions): Promise<TrustedServer[]>;
     /**
      * Internal method: Query trusted servers via subgraph
      *
@@ -560,7 +570,7 @@ export declare class DataController extends BaseController {
      * console.log(`File ${fileId} registered with schema in tx ${transactionHash}`);
      * ```
      */
-    registerFileWithSchema(url: string, schemaId: number): Promise<TransactionResult<"DataRegistry", "addFileWithSchema">>;
+    registerFileWithSchema(url: string, schemaId: number, options?: TransactionOptions): Promise<TransactionResult<"DataRegistry", "addFileWithSchema">>;
     /**
      * Gets the user's address from the wallet client.
      *
@@ -586,7 +596,7 @@ export declare class DataController extends BaseController {
     addFileWithPermissions(url: string, ownerAddress: Address, permissions?: Array<{
         account: Address;
         key: string;
-    }>): Promise<TransactionResult<"DataRegistry", "addFileWithPermissions">>;
+    }>, options?: TransactionOptions): Promise<TransactionResult<"DataRegistry", "addFileWithPermissions">>;
     /**
      * Adds a file to the registry with permissions and schema.
      * This combines the functionality of addFileWithPermissions and schema validation.
@@ -629,7 +639,7 @@ export declare class DataController extends BaseController {
     addFileWithPermissionsAndSchema(url: string, ownerAddress: Address, permissions?: Array<{
         account: Address;
         publicKey: string;
-    }>, schemaId?: number): Promise<TransactionResult<"DataRegistry", "addFileWithPermissionsAndSchema">>;
+    }>, schemaId?: number, options?: TransactionOptions): Promise<TransactionResult<"DataRegistry", "addFileWithPermissionsAndSchema">>;
     /**
      * Adds a file with pre-encrypted permissions and schema to the DataRegistry.
      *
@@ -671,7 +681,7 @@ export declare class DataController extends BaseController {
     addFileWithEncryptedPermissionsAndSchema(url: string, ownerAddress: Address, permissions?: Array<{
         account: Address;
         key: string;
-    }>, schemaId?: number): Promise<TransactionResult<"DataRegistry", "addFileWithPermissionsAndSchema">>;
+    }>, schemaId?: number, options?: TransactionOptions): Promise<TransactionResult<"DataRegistry", "addFileWithPermissionsAndSchema">>;
     /**
      * Registers a data refiner for processing templates.
      *
@@ -704,7 +714,7 @@ export declare class DataController extends BaseController {
      * console.log(`Refiner ${result.refinerId} created`);
      * ```
      */
-    addRefiner(params: AddRefinerParams): Promise<AddRefinerResult>;
+    addRefiner(params: AddRefinerParams, options?: TransactionOptions): Promise<AddRefinerResult>;
     /**
      * Retrieves refiner configuration by ID.
      *
@@ -795,7 +805,7 @@ export declare class DataController extends BaseController {
      * console.log(`Schema updated in tx ${result.transactionHash}`);
      * ```
      */
-    updateSchemaId(params: UpdateSchemaIdParams): Promise<UpdateSchemaIdResult>;
+    updateSchemaId(params: UpdateSchemaIdParams, options?: TransactionOptions): Promise<UpdateSchemaIdResult>;
     /**
      * Uploads an encrypted file and grants permission to a party with a public key.
      *
@@ -852,7 +862,7 @@ export declare class DataController extends BaseController {
      * console.log(`Transaction: ${result.transactionHash}`);
      * ```
      */
-    addPermissionToFile(params: AddFilePermissionParams): Promise<TransactionResult<"DataRegistry", "addFilePermission">>;
+    addPermissionToFile(params: AddFilePermissionParams, options?: TransactionOptions): Promise<TransactionResult<"DataRegistry", "addFilePermission">>;
     /**
      * Submits a file permission transaction to the blockchain.
      *
@@ -881,7 +891,7 @@ export declare class DataController extends BaseController {
      * console.log(`Permission granted with ID: ${result.permissionId}`);
      * ```
      */
-    submitFilePermission(fileId: number, account: Address, publicKey: string): Promise<TransactionResult<"DataRegistry", "addFilePermission">>;
+    submitFilePermission(fileId: number, account: Address, publicKey: string, options?: TransactionOptions): Promise<TransactionResult<"DataRegistry", "addFilePermission">>;
     /**
      * Gets the encrypted key for a specific account's permission to access a file.
      *
@@ -1049,4 +1059,9 @@ export declare class DataController extends BaseController {
      * ```
      */
     fetchAndValidateSchema(url: string): Promise<DataSchema>;
+    /**
+     * Polls for confirmation of a relayer operation.
+     * @internal
+     */
+    private pollRelayerForConfirmation;
 }