@opendatalabs/vana-sdk 0.1.0-alpha.793d5ba → 0.1.0-alpha.adc188d

package/dist/index.browser.d.ts

@@ -804,6 +804,7 @@ interface RelayerCallbacks {
     /**
      * Submit a file addition for relay
      *
+     * @deprecated Use submitFileAdditionComplete for full support.
      * @param url - The file URL to register
      * @param userAddress - The user's address
      * @returns Promise resolving to object with fileId and transactionHash
@@ -815,6 +816,7 @@ interface RelayerCallbacks {
     /**
      * Submit a file addition with permissions for relay
      *
+     * @deprecated Use submitFileAdditionComplete for full support.
      * @param url - The file URL to register
      * @param userAddress - The user's address
      * @param permissions - Array of encrypted permissions
@@ -827,6 +829,31 @@ interface RelayerCallbacks {
         fileId: number;
         transactionHash: Hash;
     }>;
+    /**
+     * Submit a comprehensive file addition with optional schema and permissions for relay
+     *
+     * This is the preferred callback that supports all file addition scenarios.
+     * It can handle files with schemas, permissions, or both.
+     *
+     * @param params - Complete parameters for file addition
+     * @param params.url - The file URL to register
+     * @param params.userAddress - The user's address
+     * @param params.permissions - Array of encrypted permissions (empty array if none)
+     * @param params.schemaId - Schema ID for validation (0 if none)
+     * @returns Promise resolving to object with fileId and transactionHash
+     */
+    submitFileAdditionComplete?: (params: {
+        url: string;
+        userAddress: Address;
+        permissions: Array<{
+            account: Address;
+            key: string;
+        }>;
+        schemaId: number;
+    }) => Promise<{
+        fileId: number;
+        transactionHash: Hash;
+    }>;
     /**
      * Store a grant file for relay (e.g., upload to IPFS)
      *
@@ -1177,6 +1204,8 @@ interface PermissionParams {
     nonce?: bigint;
     /** Optional expiration timestamp. */
     expiresAt?: number;
+    /** Public key of the recipient to encrypt the data key for (required for upload with permissions). */
+    publicKey?: string;
 }
 /**
  * Result of the high-level upload operation.
@@ -5407,6 +5436,23 @@ declare class DataController {
         fileId: number;
         transactionHash: string;
     }>;
+    /**
+     * Adds a file to the registry with permissions and schema.
+     * This combines the functionality of addFileWithPermissions and schema validation.
+     *
+     * @param url - The URL of the file to register
+     * @param ownerAddress - The address of the file owner
+     * @param permissions - Array of permissions to grant (account and encrypted key)
+     * @param schemaId - The schema ID to associate with the file (0 for no schema)
+     * @returns Promise resolving to object with fileId and transactionHash
+     */
+    addFileWithPermissionsAndSchema(url: string, ownerAddress: Address, permissions?: Array<{
+        account: Address;
+        key: string;
+    }>, schemaId?: number): Promise<{
+        fileId: number;
+        transactionHash: string;
+    }>;
     /**
      * Adds a new schema to the DataRefinerRegistry.
      *
@@ -9839,6 +9885,11 @@ declare const contractAbis: {
             readonly internalType: "uint256";
             readonly name: "schemaId";
             readonly type: "uint256";
+        }, {
+            readonly indexed: false;
+            readonly internalType: "string";
+            readonly name: "schemaDefinitionUrl";
+            readonly type: "string";
         }, {
             readonly indexed: false;
             readonly internalType: "string";
@@ -9922,7 +9973,7 @@ declare const contractAbis: {
         }, {
             readonly indexed: false;
             readonly internalType: "string";
-            readonly name: "typ";
+            readonly name: "dialect";
             readonly type: "string";
         }, {
             readonly indexed: false;
@@ -9996,6 +10047,32 @@ declare const contractAbis: {
         readonly outputs: readonly [];
         readonly stateMutability: "nonpayable";
         readonly type: "function";
+    }, {
+        readonly inputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "dlpId";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "string";
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly internalType: "string";
+            readonly name: "schemaDefinitionUrl";
+            readonly type: "string";
+        }, {
+            readonly internalType: "string";
+            readonly name: "refinementInstructionUrl";
+            readonly type: "string";
+        }];
+        readonly name: "addRefiner";
+        readonly outputs: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "nonpayable";
+        readonly type: "function";
     }, {
         readonly inputs: readonly [{
             readonly internalType: "uint256";
@@ -10014,7 +10091,7 @@ declare const contractAbis: {
             readonly name: "refinementInstructionUrl";
             readonly type: "string";
         }];
-        readonly name: "addRefiner";
+        readonly name: "addRefinerWithSchemaId";
         readonly outputs: readonly [{
             readonly internalType: "uint256";
             readonly name: "";
@@ -10029,7 +10106,7 @@ declare const contractAbis: {
             readonly type: "string";
         }, {
             readonly internalType: "string";
-            readonly name: "typ";
+            readonly name: "dialect";
             readonly type: "string";
         }, {
             readonly internalType: "string";
@@ -10305,7 +10382,7 @@ declare const contractAbis: {
                 readonly type: "string";
             }, {
                 readonly internalType: "string";
-                readonly name: "typ";
+                readonly name: "dialect";
                 readonly type: "string";
             }, {
                 readonly internalType: "string";

package/dist/index.browser.js

@@ -7820,6 +7820,12 @@ var DataRefinerRegistryABI = [
         name: "schemaId",
         type: "uint256"
       },
+      {
+        indexed: false,
+        internalType: "string",
+        name: "schemaDefinitionUrl",
+        type: "string"
+      },
       {
         indexed: false,
         internalType: "string",
@@ -7923,7 +7929,7 @@ var DataRefinerRegistryABI = [
       {
         indexed: false,
         internalType: "string",
-        name: "typ",
+        name: "dialect",
         type: "string"
       },
       {
@@ -8019,6 +8025,40 @@ var DataRefinerRegistryABI = [
     stateMutability: "nonpayable",
     type: "function"
   },
+  {
+    inputs: [
+      {
+        internalType: "uint256",
+        name: "dlpId",
+        type: "uint256"
+      },
+      {
+        internalType: "string",
+        name: "name",
+        type: "string"
+      },
+      {
+        internalType: "string",
+        name: "schemaDefinitionUrl",
+        type: "string"
+      },
+      {
+        internalType: "string",
+        name: "refinementInstructionUrl",
+        type: "string"
+      }
+    ],
+    name: "addRefiner",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "",
+        type: "uint256"
+      }
+    ],
+    stateMutability: "nonpayable",
+    type: "function"
+  },
   {
     inputs: [
       {
@@ -8042,7 +8082,7 @@ var DataRefinerRegistryABI = [
         type: "string"
       }
     ],
-    name: "addRefiner",
+    name: "addRefinerWithSchemaId",
     outputs: [
       {
         internalType: "uint256",
@@ -8062,7 +8102,7 @@ var DataRefinerRegistryABI = [
       },
       {
         internalType: "string",
-        name: "typ",
+        name: "dialect",
         type: "string"
       },
       {
@@ -8425,7 +8465,7 @@ var DataRefinerRegistryABI = [
           },
           {
             internalType: "string",
-            name: "typ",
+            name: "dialect",
             type: "string"
           },
           {
@@ -35481,68 +35521,66 @@ var DataController = class {
         filename,
         providerName
       );
-      let blockchainResult;
       const userAddress = await this.getUserAddress();
-      if (permissions.length > 0) {
-        throw new Error(
-          "Upload with permissions is not yet implemented in the high-level API"
+      let encryptedPermissions = [];
+      if (permissions.length > 0 && encrypt2) {
+        const userEncryptionKey = await generateEncryptionKey(
+          this.context.walletClient,
+          DEFAULT_ENCRYPTION_SEED
         );
-      } else {
-        const chainId = this.context.walletClient.chain?.id;
-        if (!chainId) {
-          throw new Error("Chain ID not available");
-        }
-        const dataRegistryAddress = getContractAddress(chainId, "DataRegistry");
-        const dataRegistryAbi = getAbi("DataRegistry");
-        let txHash;
-        if (schemaId !== void 0) {
-          txHash = await this.context.walletClient.writeContract({
-            address: dataRegistryAddress,
-            abi: dataRegistryAbi,
-            functionName: "addFileWithSchema",
-            args: [uploadResult.url, BigInt(schemaId)],
-            account: this.context.walletClient.account || userAddress,
-            chain: this.context.walletClient.chain || null
-          });
-        } else {
-          txHash = await this.context.walletClient.writeContract({
-            address: dataRegistryAddress,
-            abi: dataRegistryAbi,
-            functionName: "addFile",
-            args: [uploadResult.url],
-            account: this.context.walletClient.account || userAddress,
-            chain: this.context.walletClient.chain || null
-          });
-        }
-        const receipt = await this.context.publicClient.waitForTransactionReceipt({
-          hash: txHash,
-          timeout: 3e4
-          // 30 seconds timeout
-        });
-        let fileId = 0;
-        for (const log of receipt.logs) {
-          try {
-            const decoded = decodeEventLog({
-              abi: dataRegistryAbi,
-              data: log.data,
-              topics: log.topics
-            });
-            if (decoded.eventName === "FileAdded") {
-              fileId = Number(decoded.args.fileId);
-              break;
+        encryptedPermissions = await Promise.all(
+          permissions.map(async (permission) => {
+            const publicKey = permission.publicKey;
+            if (!publicKey) {
+              throw new Error(
+                `Public key required for permission to ${permission.to}`
+              );
             }
-          } catch {
+            const encryptedKey = await encryptWithWalletPublicKey(
+              userEncryptionKey,
+              publicKey,
+              this.context.platform
+            );
+            return {
+              account: permission.to,
+              key: encryptedKey
+            };
+          })
+        );
+      }
+      let result;
+      if (this.context.relayerCallbacks?.submitFileAdditionComplete) {
+        result = await this.context.relayerCallbacks.submitFileAdditionComplete(
+          {
+            url: uploadResult.url,
+            userAddress,
+            permissions: encryptedPermissions,
+            schemaId: schemaId || 0
           }
+        );
+      } else if (this.context.relayerCallbacks?.submitFileAddition) {
+        const needsComplexRegistration = schemaId !== void 0 || encryptedPermissions.length > 0;
+        if (needsComplexRegistration) {
+          throw new Error(
+            "The configured relay callback does not support schemas or permissions. Please update your relay server implementation to provide the `submitFileAdditionComplete` callback."
+          );
         }
-        blockchainResult = {
-          fileId,
-          transactionHash: txHash
-        };
+        result = await this.context.relayerCallbacks.submitFileAddition(
+          uploadResult.url,
+          userAddress
+        );
+      } else {
+        result = await this.addFileWithPermissionsAndSchema(
+          uploadResult.url,
+          userAddress,
+          encryptedPermissions,
+          schemaId || 0
+        );
       }
       return {
-        fileId: blockchainResult.fileId,
+        fileId: result.fileId,
         url: uploadResult.url,
-        transactionHash: blockchainResult.transactionHash,
+        transactionHash: result.transactionHash,
         size: uploadResult.size,
         isValid,
         validationErrors: validationErrors.length > 0 ? validationErrors : void 0
@@ -36532,6 +36570,66 @@ var DataController = class {
       );
     }
   }
+  /**
+   * Adds a file to the registry with permissions and schema.
+   * This combines the functionality of addFileWithPermissions and schema validation.
+   *
+   * @param url - The URL of the file to register
+   * @param ownerAddress - The address of the file owner
+   * @param permissions - Array of permissions to grant (account and encrypted key)
+   * @param schemaId - The schema ID to associate with the file (0 for no schema)
+   * @returns Promise resolving to object with fileId and transactionHash
+   */
+  async addFileWithPermissionsAndSchema(url, ownerAddress, permissions = [], schemaId = 0) {
+    try {
+      const chainId = this.context.walletClient.chain?.id;
+      if (!chainId) {
+        throw new Error("Chain ID not available");
+      }
+      const dataRegistryAddress = getContractAddress(chainId, "DataRegistry");
+      const dataRegistryAbi = getAbi("DataRegistry");
+      const txHash = await this.context.walletClient.writeContract({
+        address: dataRegistryAddress,
+        abi: dataRegistryAbi,
+        functionName: "addFileWithPermissionsAndSchema",
+        args: [url, ownerAddress, permissions, BigInt(schemaId)],
+        account: this.context.walletClient.account || ownerAddress,
+        chain: this.context.walletClient.chain || null
+      });
+      const receipt = await this.context.publicClient.waitForTransactionReceipt(
+        {
+          hash: txHash,
+          timeout: 3e4
+          // 30 seconds timeout
+        }
+      );
+      let fileId = 0;
+      for (const log of receipt.logs) {
+        try {
+          const decoded = decodeEventLog({
+            abi: dataRegistryAbi,
+            data: log.data,
+            topics: log.topics
+          });
+          if (decoded.eventName === "FileAdded") {
+            fileId = Number(decoded.args.fileId);
+            break;
+          }
+        } catch {
+          continue;
+        }
+      }
+      return {
+        fileId,
+        transactionHash: txHash
+      };
+    } catch (error) {
+      console.error("Failed to add file with permissions and schema:", error);
+      throw new Error(
+        `Failed to add file with permissions and schema: ${error instanceof Error ? error.message : "Unknown error"}`
+      );
+    }
+  }
   /**
    * Adds a new schema to the DataRefinerRegistry.
    *
@@ -36686,7 +36784,7 @@ var DataController = class {
       const txHash = await this.context.walletClient.writeContract({
         address: dataRefinerRegistryAddress,
         abi: dataRefinerRegistryAbi,
-        functionName: "addRefiner",
+        functionName: "addRefinerWithSchemaId",
         args: [
           BigInt(params.dlpId),
           params.name,