@opendatalabs/vana-sdk 0.1.0-alpha.f35bb9c → 0.1.0-alpha.f48b66e

package/dist/controllers/data.js

@@ -3,13 +3,26 @@ import { BaseController } from "./base";
 import { getContractAddress } from "../config/addresses";
 import { getAbi } from "../generated/abi";
 import {
-  GetUserFilesDocument,
+  GetUserFilesPaginatedDocument,
   GetFileProofsDocument,
   GetDlpDocument,
-  GetUserPermissionsDocument,
-  GetUserTrustedServersDocument
+  GetUserPermissionsPaginatedDocument,
+  GetUserTrustedServersPaginatedDocument
 } from "../generated/subgraph";
 import { print } from "graphql";
+import {
+  checkSubgraphConsistency,
+  fetchSubgraphMeta
+} from "../utils/subgraphConsistency";
+import {
+  executePaginatedQuery,
+  mapOrderByToEnum,
+  mapOrderDirection
+} from "../utils/subgraphPagination";
+import {
+  getUserFilesFromChain,
+  determineDataSource
+} from "../utils/chainQuery";
 import {
   generateEncryptionKey,
   decryptBlobWithSignedKey,
@@ -124,7 +137,7 @@ class DataController extends BaseController {
         if (response.type === "error") {
           throw new Error(response.error);
         }
-        if (response.type !== "direct" || !("fileId" in response.result)) {
+        if (response.type !== "direct" || typeof response.result !== "object" || response.result === null || !("fileId" in response.result)) {
           throw new Error("Invalid response from relayer");
         }
         result = response.result;
@@ -419,67 +432,91 @@ class DataController extends BaseController {
    * });
    * ```
    */
-  async getUserFiles(params) {
+  async getUserFiles(params, options) {
     const { owner, subgraphUrl } = params;
+    let dataSource = options?.source === "chain" ? "chain" : "subgraph";
+    if (options?.source === "auto" || !options?.source && options?.minBlock) {
+      const endpoint2 = subgraphUrl ?? this.context.subgraphUrl;
+      const currentBlock = await this.context.publicClient.getBlockNumber();
+      let subgraphBlock;
+      if (endpoint2) {
+        try {
+          const meta = await fetchSubgraphMeta(endpoint2);
+          subgraphBlock = meta.blockNumber;
+        } catch {
+          subgraphBlock = void 0;
+        }
+      }
+      dataSource = determineDataSource(
+        options?.source,
+        options?.minBlock,
+        currentBlock,
+        subgraphBlock
+      );
+    }
+    if (dataSource === "chain") {
+      const publicClient = this.context.publicClient;
+      const chainId = await publicClient.getChainId();
+      const contractAddress = getContractAddress(chainId, "DataRegistry");
+      const files = await getUserFilesFromChain(
+        publicClient,
+        contractAddress,
+        owner,
+        options?.minBlock ? BigInt(options.minBlock) : void 0
+      );
+      const limit = options?.fetchAll ? files.length : options?.limit ?? 100;
+      const offset = options?.offset ?? 0;
+      return files.slice(offset, offset + limit);
+    }
     const endpoint = subgraphUrl ?? this.context.subgraphUrl;
     if (!endpoint) {
       throw new Error(
         "subgraphUrl is required. Please provide a valid subgraph endpoint or configure it in Vana constructor."
       );
     }
+    if (options?.minBlock || options?.waitForSync) {
+      await checkSubgraphConsistency(endpoint, options);
+    }
     try {
-      const response = await fetch(endpoint, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json"
+      const orderByMap = {
+        id: "id",
+        addedAtBlock: "addedAtBlock",
+        addedAtTimestamp: "addedAtTimestamp",
+        url: "url",
+        schemaId: "schemaId"
+      };
+      const allFiles = await executePaginatedQuery({
+        endpoint,
+        document: GetUserFilesPaginatedDocument,
+        baseVariables: {
+          userId: owner.toLowerCase(),
+          // Subgraph requires lowercase addresses
+          orderBy: mapOrderByToEnum(
+            options?.orderBy,
+            orderByMap,
+            "addedAtBlock"
+          ),
+          orderDirection: mapOrderDirection(
+            options?.orderDirection,
+            "asc",
+            "desc"
+          )
         },
-        body: JSON.stringify({
-          query: print(GetUserFilesDocument),
-          variables: {
-            userId: owner.toLowerCase()
-            // Subgraph requires lowercase addresses
-          }
-        })
-      });
-      if (!response.ok) {
-        throw new Error(
-          `Subgraph request failed: ${response.status} ${response.statusText}`
-        );
-      }
-      const result = await response.json();
-      if (result.errors) {
-        throw new Error(
-          `Subgraph errors: ${result.errors.map((e) => e.message).join(", ")}`
-        );
-      }
-      const user = result.data?.user;
-      if (!user?.files?.length) {
-        console.warn("No files found for user:", owner);
-        return [];
-      }
-      const fileMap = /* @__PURE__ */ new Map();
-      user.files.forEach((file) => {
-        const fileId = parseInt(file.id);
-        const userFile = {
-          id: fileId,
+        options,
+        extractItems: (data) => data?.user?.files,
+        transformItem: (file) => ({
+          id: parseInt(file.id),
           url: file.url,
           ownerAddress: file.owner.id,
           addedAtBlock: BigInt(file.addedAtBlock),
           schemaId: parseInt(file.schemaId),
           addedAtTimestamp: BigInt(file.addedAtTimestamp),
           transactionHash: file.transactionHash
-        };
-        const existing = fileMap.get(fileId);
-        if (!existing || userFile.addedAtTimestamp && existing.addedAtTimestamp && userFile.addedAtTimestamp > existing.addedAtTimestamp) {
-          fileMap.set(fileId, userFile);
-        }
+        })
       });
-      const userFiles = Array.from(fileMap.values()).sort(
-        (a, b) => Number((b.addedAtTimestamp ?? 0n) - (a.addedAtTimestamp ?? 0n))
-      );
-      if (userFiles.length > 0) {
+      if (allFiles.length > 0) {
         try {
-          const fileIds = userFiles.map((f) => f.id);
+          const fileIds = allFiles.map((f) => f.id);
           let proofMap;
           try {
             proofMap = await this._fetchProofsFromSubgraph(fileIds, endpoint);
@@ -490,7 +527,7 @@ class DataController extends BaseController {
             );
             proofMap = await this._fetchProofsFromChain(fileIds);
           }
-          for (const file of userFiles) {
+          for (const file of allFiles) {
             const dlpIds = proofMap.get(file.id);
             if (dlpIds && dlpIds.length > 0) {
               file.dlpIds = dlpIds;
@@ -500,7 +537,7 @@ class DataController extends BaseController {
           console.warn("Failed to fetch proof data for files:", error);
         }
       }
-      return userFiles;
+      return allFiles;
     } catch (error) {
       console.error("Failed to fetch user files from subgraph:", error);
       throw new Error(
@@ -626,6 +663,9 @@ class DataController extends BaseController {
    */
   async getDLP(dlpId, options = {}) {
     const subgraphUrl = options.subgraphUrl ?? this.context.subgraphUrl;
+    if (subgraphUrl && (options.minBlock || options.waitForSync)) {
+      await checkSubgraphConsistency(subgraphUrl, options);
+    }
     if (subgraphUrl) {
       try {
         const response = await fetch(subgraphUrl, {
@@ -844,21 +884,33 @@ class DataController extends BaseController {
    * @returns Promise resolving to an array of permission objects
    * @throws Error if both subgraph and RPC queries fail
    */
-  async getUserPermissions(params) {
+  async getUserPermissions(params, options) {
     const { user, subgraphUrl } = params;
     const endpoint = subgraphUrl ?? this.context.subgraphUrl;
+    if (endpoint && (options?.minBlock || options?.waitForSync)) {
+      await checkSubgraphConsistency(endpoint, options);
+    }
     if (endpoint) {
       try {
-        const permissions = await this._getUserPermissionsViaSubgraph({
-          user,
-          subgraphUrl: endpoint
-        });
+        const permissions = await this._getUserPermissionsViaSubgraph(
+          {
+            user,
+            subgraphUrl: endpoint
+          },
+          options
+        );
         return permissions;
       } catch (error) {
         console.warn("Subgraph query failed, falling back to RPC:", error);
       }
     }
-    return await this._getUserPermissionsViaRpc({ user });
+    const allPermissions = await this._getUserPermissionsViaRpc({ user });
+    if (options && !options.fetchAll) {
+      const limit = options.limit ?? 100;
+      const offset = options.offset ?? 0;
+      return allPermissions.slice(offset, offset + limit);
+    }
+    return allPermissions;
   }
   /**
    * Internal method: Query user permissions via subgraph
@@ -868,46 +920,48 @@ class DataController extends BaseController {
    * @param params.subgraphUrl - The subgraph URL endpoint to query
    * @returns Promise resolving to an array of permission objects
    */
-  async _getUserPermissionsViaSubgraph(params) {
+  async _getUserPermissionsViaSubgraph(params, options) {
     const { user, subgraphUrl } = params;
     try {
-      const response = await fetch(subgraphUrl, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json"
+      const orderByMap = {
+        id: "id",
+        addedAtBlock: "addedAtBlock",
+        addedAtTimestamp: "addedAtTimestamp",
+        grant: "grant",
+        nonce: "nonce",
+        startBlock: "startBlock",
+        endBlock: "endBlock"
+      };
+      const permissions = await executePaginatedQuery({
+        endpoint: subgraphUrl,
+        document: GetUserPermissionsPaginatedDocument,
+        baseVariables: {
+          userId: user.toLowerCase(),
+          orderBy: mapOrderByToEnum(
+            options?.orderBy,
+            orderByMap,
+            "addedAtTimestamp"
+          ),
+          orderDirection: mapOrderDirection(
+            options?.orderDirection,
+            "desc",
+            "asc"
+          )
         },
-        body: JSON.stringify({
-          query: print(GetUserPermissionsDocument),
-          variables: {
-            userId: user.toLowerCase()
-          }
+        options,
+        extractItems: (data) => data?.user?.permissions,
+        transformItem: (permission) => ({
+          id: permission.id,
+          grant: permission.grant,
+          nonce: BigInt(permission.nonce),
+          signature: permission.signature,
+          addedAtBlock: BigInt(permission.addedAtBlock),
+          addedAtTimestamp: BigInt(permission.addedAtTimestamp),
+          transactionHash: permission.transactionHash,
+          user
         })
       });
-      if (!response.ok) {
-        throw new Error(
-          `Subgraph request failed: ${response.status} ${response.statusText}`
-        );
-      }
-      const result = await response.json();
-      if (result.errors) {
-        throw new Error(
-          `Subgraph query errors: ${result.errors.map((e) => e.message).join(", ")}`
-        );
-      }
-      const userData = result.data?.user;
-      if (!userData?.permissions?.length) {
-        return [];
-      }
-      return userData.permissions.map((permission) => ({
-        id: permission.id,
-        grant: permission.grant,
-        nonce: BigInt(permission.nonce),
-        signature: permission.signature,
-        addedAtBlock: BigInt(permission.addedAtBlock),
-        addedAtTimestamp: BigInt(permission.addedAtTimestamp),
-        transactionHash: permission.transactionHash,
-        user
-      })).sort((a, b) => Number(b.addedAtTimestamp - a.addedAtTimestamp));
+      return permissions;
     } catch (error) {
       console.error("Failed to query user permissions from subgraph:", error);
       throw error;
@@ -1040,20 +1094,28 @@ class DataController extends BaseController {
    * });
    * ```
    */
-  async getUserTrustedServers(params) {
-    const { user, limit = 50, offset = 0 } = params;
+  async getUserTrustedServers(params, options) {
+    const { user } = params;
     const subgraphUrl = params.subgraphUrl ?? this.context.subgraphUrl;
+    if (subgraphUrl && (options?.minBlock || options?.waitForSync)) {
+      await checkSubgraphConsistency(subgraphUrl, options);
+    }
     if (subgraphUrl) {
       try {
-        const servers = await this._getUserTrustedServersViaSubgraph({
-          user,
-          subgraphUrl
-        });
-        return limit ? servers.slice(offset, offset + limit) : servers;
+        const servers = await this._getUserTrustedServersViaSubgraph(
+          {
+            user,
+            subgraphUrl
+          },
+          options
+        );
+        return servers;
       } catch (error) {
         console.warn("Subgraph query failed, falling back to RPC:", error);
       }
     }
+    const limit = options?.fetchAll ? Number.MAX_SAFE_INTEGER : options?.limit ?? 100;
+    const offset = options?.offset ?? 0;
     const rpcResult = await this._getUserTrustedServersViaRpc({
       user,
       limit,
@@ -1069,7 +1131,7 @@ class DataController extends BaseController {
    * @param params.subgraphUrl - The subgraph URL endpoint to query
    * @returns Promise resolving to an array of trusted server objects
    */
-  async _getUserTrustedServersViaSubgraph(params) {
+  async _getUserTrustedServersViaSubgraph(params, options) {
     const { user, subgraphUrl } = params;
     const graphqlEndpoint = subgraphUrl;
     if (!graphqlEndpoint) {
@@ -1078,42 +1140,46 @@ class DataController extends BaseController {
       );
     }
     try {
-      const response = await fetch(graphqlEndpoint, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json"
+      const orderByMap = {
+        id: "id",
+        trustedAt: "trustedAt",
+        trustedAtBlock: "trustedAtBlock",
+        server: "server",
+        user: "user"
+      };
+      const serverTrusts = await executePaginatedQuery({
+        endpoint: graphqlEndpoint,
+        document: GetUserTrustedServersPaginatedDocument,
+        baseVariables: {
+          userId: user.toLowerCase(),
+          // Subgraph requires lowercase addresses
+          orderBy: mapOrderByToEnum(
+            options?.orderBy,
+            orderByMap,
+            "trustedAtBlock"
+          ),
+          orderDirection: mapOrderDirection(
+            options?.orderDirection,
+            "desc",
+            "asc"
+          )
         },
-        body: JSON.stringify({
-          query: print(GetUserTrustedServersDocument),
-          variables: {
-            userId: user.toLowerCase()
-            // Subgraph requires lowercase addresses
-          }
+        options,
+        extractItems: (data) => {
+          const trusts = data?.user?.serverTrusts ?? [];
+          return trusts.filter((trust) => !trust.untrustedAtBlock);
+        },
+        transformItem: (trust) => ({
+          id: trust.server.id,
+          serverAddress: trust.server.serverAddress,
+          serverUrl: trust.server.url,
+          trustedAt: BigInt(trust.trustedAt),
+          user,
+          name: ""
+          // Not available in new schema, will be empty
         })
       });
-      if (!response.ok) {
-        throw new Error(
-          `Subgraph request failed: ${response.status} ${response.statusText}`
-        );
-      }
-      const result = await response.json();
-      if (result.errors) {
-        throw new Error(
-          `Subgraph query errors: ${result.errors.map((e) => e.message).join(", ")}`
-        );
-      }
-      if (!result.data?.user) {
-        return [];
-      }
-      return (result.data.user.serverTrusts ?? []).filter((trust) => !trust.untrustedAtBlock).map((trust) => ({
-        id: trust.server.id,
-        serverAddress: trust.server.serverAddress,
-        serverUrl: trust.server.url,
-        trustedAt: BigInt(trust.trustedAt),
-        user,
-        name: ""
-        // Not available in new schema, will be empty
-      }));
+      return serverTrusts;
     } catch (error) {
       console.error("Failed to query trusted servers from subgraph:", error);
       throw error;
@@ -1357,7 +1423,7 @@ class DataController extends BaseController {
    * console.log(`File ${fileId} registered with schema in tx ${transactionHash}`);
    * ```
    */
-  async registerFileWithSchema(url, schemaId) {
+  async registerFileWithSchema(url, schemaId, options) {
     this.assertWallet();
     try {
       const chainId = this.context.publicClient.chain?.id;
@@ -1375,7 +1441,8 @@ class DataController extends BaseController {
         functionName: "addFileWithSchema",
         args: [url, BigInt(schemaId)],
         account,
-        chain: this.context.walletClient.chain ?? null
+        chain: this.context.walletClient.chain ?? null,
+        ...this.spreadTransactionOptions(options)
       });
       const { tx } = await import("../utils/transactionHelpers");
       return tx({
@@ -1413,7 +1480,7 @@ class DataController extends BaseController {
    * with specific permissions on the DataRegistry contract. It can be used
    * by both direct transactions and relayer services.
    */
-  async addFileWithPermissions(url, ownerAddress, permissions = []) {
+  async addFileWithPermissions(url, ownerAddress, permissions = [], options) {
     this.assertWallet();
     try {
       const chainId = this.context.publicClient.chain?.id;
@@ -1431,7 +1498,8 @@ class DataController extends BaseController {
         functionName: "addFileWithPermissions",
         args: [url, ownerAddress, permissions],
         account,
-        chain: this.context.walletClient.chain ?? null
+        chain: this.context.walletClient.chain ?? null,
+        ...this.spreadTransactionOptions(options)
       });
       const { tx } = await import("../utils/transactionHelpers");
       return tx({
@@ -1486,7 +1554,7 @@ class DataController extends BaseController {
    * console.log(`File ${result.fileId} registered in tx ${result.hash}`);
    * ```
    */
-  async addFileWithPermissionsAndSchema(url, ownerAddress, permissions = [], schemaId = 0) {
+  async addFileWithPermissionsAndSchema(url, ownerAddress, permissions = [], schemaId = 0, options) {
     this.assertWallet();
     try {
       let encryptedPermissions = [];
@@ -1520,7 +1588,8 @@ class DataController extends BaseController {
         url,
         ownerAddress,
         encryptedPermissions,
-        schemaId
+        schemaId,
+        options
       );
     } catch (error) {
       console.error("Failed to add file with permissions and schema:", error);
@@ -1567,7 +1636,7 @@ class DataController extends BaseController {
    * console.log(`File registered in tx ${result.hash}`);
    * ```
    */
-  async addFileWithEncryptedPermissionsAndSchema(url, ownerAddress, permissions = [], schemaId = 0) {
+  async addFileWithEncryptedPermissionsAndSchema(url, ownerAddress, permissions = [], schemaId = 0, options) {
     try {
       const chainId = this.context.publicClient.chain?.id;
       if (!chainId) {
@@ -1584,7 +1653,8 @@ class DataController extends BaseController {
         functionName: "addFileWithPermissionsAndSchema",
         args: [url, ownerAddress, permissions, BigInt(schemaId)],
         account,
-        chain: this.context.walletClient.chain ?? null
+        chain: this.context.walletClient.chain ?? null,
+        ...this.spreadTransactionOptions(options)
       });
       const { tx } = await import("../utils/transactionHelpers");
       return tx({
@@ -1632,7 +1702,7 @@ class DataController extends BaseController {
    * console.log(`Refiner ${result.refinerId} created`);
    * ```
    */
-  async addRefiner(params) {
+  async addRefiner(params, options) {
     this.assertWallet();
     try {
       const chainId = this.context.publicClient.chain?.id;
@@ -1658,7 +1728,8 @@ class DataController extends BaseController {
           params.refinementInstructionUrl
         ],
         account,
-        chain: this.context.walletClient.chain ?? null
+        chain: this.context.walletClient.chain ?? null,
+        ...this.spreadTransactionOptions(options)
       });
       const { tx } = await import("../utils/transactionHelpers");
       const txResult = tx({
@@ -1858,7 +1929,7 @@ class DataController extends BaseController {
    * console.log(`Schema updated in tx ${result.transactionHash}`);
    * ```
    */
-  async updateSchemaId(params) {
+  async updateSchemaId(params, options) {
     this.assertWallet();
     try {
       const chainId = this.context.publicClient.chain?.id;
@@ -1878,7 +1949,8 @@ class DataController extends BaseController {
         functionName: "updateSchemaId",
         args: [BigInt(params.refinerId), BigInt(params.newSchemaId)],
         account,
-        chain: this.context.walletClient.chain ?? null
+        chain: this.context.walletClient.chain ?? null,
+        ...this.spreadTransactionOptions(options)
       });
       await this.context.publicClient.waitForTransactionReceipt({ hash });
       return {
@@ -1947,7 +2019,7 @@ class DataController extends BaseController {
         if (response.type === "error") {
           throw new Error(response.error);
         }
-        if (response.type !== "direct" || !("fileId" in response.result)) {
+        if (response.type !== "direct" || typeof response.result !== "object" || response.result === null || !("fileId" in response.result)) {
           throw new Error("Invalid response from relayer");
         }
         const result = response.result;
@@ -2039,7 +2111,7 @@ class DataController extends BaseController {
           );
         }
       }
-      const finalFilename = filename ?? encrypt ? `upload-${Date.now()}.enc` : `upload-${Date.now()}.dat`;
+      const finalFilename = filename ?? `upload-${Date.now()}.dat`;
       const uploadResult = await this.context.storageManager.upload(
         finalBlob,
         finalFilename,
@@ -2084,10 +2156,10 @@ class DataController extends BaseController {
    * console.log(`Transaction: ${result.transactionHash}`);
    * ```
    */
-  async addPermissionToFile(params) {
+  async addPermissionToFile(params, options) {
     this.assertWallet();
     const { fileId, account, publicKey } = params;
-    return await this.submitFilePermission(fileId, account, publicKey);
+    return await this.submitFilePermission(fileId, account, publicKey, options);
   }
   /**
    * Submits a file permission transaction to the blockchain.
@@ -2117,7 +2189,7 @@ class DataController extends BaseController {
    * console.log(`Permission granted with ID: ${result.permissionId}`);
    * ```
    */
-  async submitFilePermission(fileId, account, publicKey) {
+  async submitFilePermission(fileId, account, publicKey, options) {
     this.assertWallet();
     try {
       const userEncryptionKey = await generateEncryptionKey(
@@ -2144,7 +2216,8 @@ class DataController extends BaseController {
         functionName: "addFilePermission",
         args: [BigInt(fileId), account, encryptedKey],
         account: walletAccount,
-        chain: this.context.walletClient.chain ?? null
+        chain: this.context.walletClient.chain ?? null,
+        ...this.spreadTransactionOptions(options)
       });
       const { tx } = await import("../utils/transactionHelpers");
       return tx({