@opendatalabs/vana-sdk 0.1.0-alpha.7e4db82 → 0.1.0-alpha.7ee7635

package/dist/utils/formatters.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Format a bigint or BigNumber to a regular number
+ *
+ * @remarks
+ * This function converts blockchain-specific large number types to standard JavaScript
+ * numbers. Use with caution for values that may exceed safe integer range.
+ *
+ * **Edge Cases:**
+ * - Values exceeding JavaScript's MAX_SAFE_INTEGER (2^53-1) lose precision
+ * - Negative values are supported
+ * - String values must be valid numeric strings or will return NaN
+ *
+ * @param value BigInt, BigNumber or numeric string to convert
+ * @returns Regular JavaScript number
+ * @example
+ * ```typescript
+ * formatNumber(1000000000000000000n) // Returns: 1000000000000000000
+ * formatNumber("123456789") // Returns: 123456789
+ * formatNumber(-100n) // Returns: -100
+ *
+ * // Precision loss example:
+ * const bigValue = 9007199254740993n; // MAX_SAFE_INTEGER + 2
+ * formatNumber(bigValue) // Returns: 9007199254740992 (lost precision)
+ * ```
+ */
+declare function formatNumber(value: bigint | string | number): number;
+/**
+ * Format wei value to ETH with specified decimal places
+ *
+ * @remarks
+ * Converts wei (smallest ETH unit) to human-readable ETH format.
+ * 1 ETH = 10^18 wei. The function truncates rather than rounds
+ * to ensure predictable display in financial contexts.
+ *
+ * **Edge Cases:**
+ * - Truncates (not rounds) to specified decimal places
+ * - Negative values are supported
+ * - Zero values return "0.0000" (based on decimals)
+ * - Very small values may display as "0.0000" due to truncation
+ *
+ * @param wei Value in wei (as bigint, string, or number)
+ * @param decimals Number of decimal places to display (default: 4)
+ * @returns Formatted ETH value as string
+ * @example
+ * ```typescript
+ * // Standard conversions
+ * formatEth(1000000000000000000n) // Returns: "1.0000"
+ * formatEth(1500000000000000000n, 2) // Returns: "1.50"
+ * formatEth("2000000000000000000") // Returns: "2.0000"
+ *
+ * // Edge cases
+ * formatEth(1000000000000000n) // Returns: "0.0010" (0.001 ETH)
+ * formatEth(100000000000000n) // Returns: "0.0001"
+ * formatEth(10000000000000n) // Returns: "0.0000" (truncated)
+ * formatEth(-1000000000000000000n) // Returns: "-1.000"
+ * ```
+ */
+declare function formatEth(wei: bigint | string | number, decimals?: number): string;
+/**
+ * Format a token amount based on its decimals
+ *
+ * @remarks
+ * Generic token formatter that handles any ERC20-style token with
+ * configurable decimal places. Most tokens use 18 decimals like ETH,
+ * but some use different values (e.g., USDC uses 6).
+ *
+ * @param amount Raw token amount
+ * @param decimals Token decimals (default: 18)
+ * @param displayDecimals Decimals to show in formatted output (default: 4)
+ * @returns Formatted token amount as string
+ * @example
+ * ```typescript
+ * // 18 decimal token (like ETH)
+ * formatToken(1000000000000000000n) // Returns: "1.0000"
+ * formatToken(1500000000000000000n, 18, 2) // Returns: "1.50"
+ *
+ * // 6 decimal token (like USDC)
+ * formatToken(1000000n, 6) // Returns: "1.0000"
+ * formatToken(1500000n, 6, 2) // Returns: "1.50"
+ *
+ * // Whole numbers
+ * formatToken(5000000000000000000n) // Returns: "5"
+ * formatToken(5123456789000000000n, 18, 6) // Returns: "5.123456"
+ * ```
+ */
+declare function formatToken(amount: bigint | string | number, decimals?: number, displayDecimals?: number): string;
+/**
+ * Format an address for display (showing first 6 and last 4 characters)
+ *
+ * @remarks
+ * Creates a human-readable abbreviated version of Ethereum addresses
+ * for UI display. Preserves enough characters to maintain uniqueness
+ * while saving screen space. Does not validate address format.
+ *
+ * **Edge Cases:**
+ * - Addresses shorter than 10 characters are returned unchanged
+ * - Works with both checksummed and lowercase addresses
+ * - Does not validate address format
+ *
+ * @param address EVM address
+ * @returns Shortened address string
+ * @example
+ * ```typescript
+ * // Standard addresses
+ * shortenAddress("0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36")
+ * // Returns: "0x742d...Bd36"
+ *
+ * // Checksummed address
+ * shortenAddress("0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36")
+ * // Returns: "0x742d...Bd36"
+ *
+ * // Edge cases
+ * shortenAddress("0x123") // Returns: "0x123" (too short)
+ * shortenAddress("") // Returns: ""
+ * shortenAddress("not-an-address") // Returns: "not-an...ress"
+ * ```
+ */
+declare function shortenAddress(address: string): string;
+
+export { formatEth, formatNumber, formatToken, shortenAddress };

package/dist/utils/formatters.js

@@ -0,0 +1,26 @@
+import { formatEther, formatUnits } from "viem";
+function formatNumber(value) {
+  return Number(value);
+}
+function formatEth(wei, decimals = 4) {
+  return formatEther(BigInt(wei.toString())).slice(0, decimals + 2);
+}
+function formatToken(amount, decimals = 18, displayDecimals = 4) {
+  const value = formatUnits(BigInt(amount.toString()), decimals);
+  const parts = value.split(".");
+  if (parts.length === 1) {
+    return parts[0];
+  }
+  return `${parts[0]}.${parts[1].slice(0, displayDecimals)}`;
+}
+function shortenAddress(address) {
+  if (!address || address.length < 10) return address;
+  return `${address.slice(0, 6)}...${address.slice(-4)}`;
+}
+export {
+  formatEth,
+  formatNumber,
+  formatToken,
+  shortenAddress
+};
+//# sourceMappingURL=formatters.js.map

package/dist/utils/formatters.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/formatters.ts"],"sourcesContent":["import { formatEther, formatUnits } from \"viem\";\n\n/**\n * Format a bigint or BigNumber to a regular number\n *\n * @remarks\n * This function converts blockchain-specific large number types to standard JavaScript\n * numbers. Use with caution for values that may exceed safe integer range.\n *\n * **Edge Cases:**\n * - Values exceeding JavaScript's MAX_SAFE_INTEGER (2^53-1) lose precision\n * - Negative values are supported\n * - String values must be valid numeric strings or will return NaN\n *\n * @param value BigInt, BigNumber or numeric string to convert\n * @returns Regular JavaScript number\n * @example\n * ```typescript\n * formatNumber(1000000000000000000n) // Returns: 1000000000000000000\n * formatNumber(\"123456789\") // Returns: 123456789\n * formatNumber(-100n) // Returns: -100\n *\n * // Precision loss example:\n * const bigValue = 9007199254740993n; // MAX_SAFE_INTEGER + 2\n * formatNumber(bigValue) // Returns: 9007199254740992 (lost precision)\n * ```\n */\nexport function formatNumber(value: bigint | string | number): number {\n  return Number(value);\n}\n\n/**\n * Format wei value to ETH with specified decimal places\n *\n * @remarks\n * Converts wei (smallest ETH unit) to human-readable ETH format.\n * 1 ETH = 10^18 wei. The function truncates rather than rounds\n * to ensure predictable display in financial contexts.\n *\n * **Edge Cases:**\n * - Truncates (not rounds) to specified decimal places\n * - Negative values are supported\n * - Zero values return \"0.0000\" (based on decimals)\n * - Very small values may display as \"0.0000\" due to truncation\n *\n * @param wei Value in wei (as bigint, string, or number)\n * @param decimals Number of decimal places to display (default: 4)\n * @returns Formatted ETH value as string\n * @example\n * ```typescript\n * // Standard conversions\n * formatEth(1000000000000000000n) // Returns: \"1.0000\"\n * formatEth(1500000000000000000n, 2) // Returns: \"1.50\"\n * formatEth(\"2000000000000000000\") // Returns: \"2.0000\"\n *\n * // Edge cases\n * formatEth(1000000000000000n) // Returns: \"0.0010\" (0.001 ETH)\n * formatEth(100000000000000n) // Returns: \"0.0001\"\n * formatEth(10000000000000n) // Returns: \"0.0000\" (truncated)\n * formatEth(-1000000000000000000n) // Returns: \"-1.000\"\n * ```\n */\nexport function formatEth(wei: bigint | string | number, decimals = 4): string {\n  return formatEther(BigInt(wei.toString())).slice(0, decimals + 2);\n}\n\n/**\n * Format a token amount based on its decimals\n *\n * @remarks\n * Generic token formatter that handles any ERC20-style token with\n * configurable decimal places. Most tokens use 18 decimals like ETH,\n * but some use different values (e.g., USDC uses 6).\n *\n * @param amount Raw token amount\n * @param decimals Token decimals (default: 18)\n * @param displayDecimals Decimals to show in formatted output (default: 4)\n * @returns Formatted token amount as string\n * @example\n * ```typescript\n * // 18 decimal token (like ETH)\n * formatToken(1000000000000000000n) // Returns: \"1.0000\"\n * formatToken(1500000000000000000n, 18, 2) // Returns: \"1.50\"\n *\n * // 6 decimal token (like USDC)\n * formatToken(1000000n, 6) // Returns: \"1.0000\"\n * formatToken(1500000n, 6, 2) // Returns: \"1.50\"\n *\n * // Whole numbers\n * formatToken(5000000000000000000n) // Returns: \"5\"\n * formatToken(5123456789000000000n, 18, 6) // Returns: \"5.123456\"\n * ```\n */\nexport function formatToken(\n  amount: bigint | string | number,\n  decimals = 18,\n  displayDecimals = 4,\n): string {\n  const value = formatUnits(BigInt(amount.toString()), decimals);\n  const parts = value.split(\".\");\n\n  if (parts.length === 1) {\n    return parts[0];\n  }\n\n  return `${parts[0]}.${parts[1].slice(0, displayDecimals)}`;\n}\n\n/**\n * Format an address for display (showing first 6 and last 4 characters)\n *\n * @remarks\n * Creates a human-readable abbreviated version of Ethereum addresses\n * for UI display. Preserves enough characters to maintain uniqueness\n * while saving screen space. Does not validate address format.\n *\n * **Edge Cases:**\n * - Addresses shorter than 10 characters are returned unchanged\n * - Works with both checksummed and lowercase addresses\n * - Does not validate address format\n *\n * @param address EVM address\n * @returns Shortened address string\n * @example\n * ```typescript\n * // Standard addresses\n * shortenAddress(\"0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36\")\n * // Returns: \"0x742d...Bd36\"\n *\n * // Checksummed address\n * shortenAddress(\"0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36\")\n * // Returns: \"0x742d...Bd36\"\n *\n * // Edge cases\n * shortenAddress(\"0x123\") // Returns: \"0x123\" (too short)\n * shortenAddress(\"\") // Returns: \"\"\n * shortenAddress(\"not-an-address\") // Returns: \"not-an...ress\"\n * ```\n */\nexport function shortenAddress(address: string): string {\n  if (!address || address.length < 10) return address;\n  return `${address.slice(0, 6)}...${address.slice(-4)}`;\n}\n"],"mappings":"AAAA,SAAS,aAAa,mBAAmB;AA2BlC,SAAS,aAAa,OAAyC;AACpE,SAAO,OAAO,KAAK;AACrB;AAiCO,SAAS,UAAU,KAA+B,WAAW,GAAW;AAC7E,SAAO,YAAY,OAAO,IAAI,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;AAClE;AA6BO,SAAS,YACd,QACA,WAAW,IACX,kBAAkB,GACV;AACR,QAAM,QAAQ,YAAY,OAAO,OAAO,SAAS,CAAC,GAAG,QAAQ;AAC7D,QAAM,QAAQ,MAAM,MAAM,GAAG;AAE7B,MAAI,MAAM,WAAW,GAAG;AACtB,WAAO,MAAM,CAAC;AAAA,EAChB;AAEA,SAAO,GAAG,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,EAAE,MAAM,GAAG,eAAe,CAAC;AAC1D;AAiCO,SAAS,eAAe,SAAyB;AACtD,MAAI,CAAC,WAAW,QAAQ,SAAS,GAAI,QAAO;AAC5C,SAAO,GAAG,QAAQ,MAAM,GAAG,CAAC,CAAC,MAAM,QAAQ,MAAM,EAAE,CAAC;AACtD;","names":[]}

package/dist/utils/grantFiles.cjs

@@ -0,0 +1,175 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var grantFiles_exports = {};
+__export(grantFiles_exports, {
+  createGrantFile: () => createGrantFile,
+  getGrantFileHash: () => getGrantFileHash,
+  retrieveGrantFile: () => retrieveGrantFile,
+  storeGrantFile: () => storeGrantFile,
+  validateGrantFile: () => validateGrantFile
+});
+module.exports = __toCommonJS(grantFiles_exports);
+var import_viem = require("viem");
+var import_errors = require("../errors");
+function createGrantFile(params) {
+  const grantFile = {
+    grantee: params.grantee,
+    operation: params.operation,
+    parameters: params.parameters
+  };
+  if (params.expiresAt) {
+    grantFile.expires = params.expiresAt;
+  }
+  return grantFile;
+}
+async function storeGrantFile(grantFile, relayerUrl) {
+  try {
+    const grantFileBlob = new Blob([JSON.stringify(grantFile, null, 2)], {
+      type: "application/json"
+    });
+    const formData = new FormData();
+    formData.append("file", grantFileBlob, "grant-file.json");
+    const response = await fetch(`${relayerUrl}/api/ipfs/upload`, {
+      method: "POST",
+      body: formData
+    });
+    if (!response.ok) {
+      throw new import_errors.NetworkError(
+        `Failed to store grant file: ${response.statusText}`,
+        new Error(`HTTP ${response.status}`)
+      );
+    }
+    const responseData = await response.json();
+    const data = responseData;
+    if (!data.success) {
+      throw new import_errors.NetworkError(data.error || "Failed to store grant file");
+    }
+    return data.url || "";
+  } catch (error) {
+    if (error instanceof import_errors.NetworkError) {
+      throw error;
+    }
+    throw new import_errors.NetworkError(
+      `Network error while storing grant file: ${error instanceof Error ? error.message : "Unknown error"}`,
+      error
+    );
+  }
+}
+async function retrieveGrantFile(grantUrl, _relayerUrl, downloadRelayer) {
+  try {
+    if (grantUrl.startsWith("http") && grantUrl.includes("/ipfs/")) {
+      console.warn(
+        `\u26A0\uFE0F  Grant URL uses HTTP gateway format instead of ipfs:// protocol. Found: ${grantUrl}. Consider using ipfs:// format for better protocol-agnostic storage.`
+      );
+    }
+    const { fetchWithRelayer } = await import("./download");
+    const response = await fetchWithRelayer(grantUrl, downloadRelayer);
+    if (!response.ok) {
+      throw new import_errors.NetworkError(
+        `Failed to retrieve grant file: HTTP ${response.status}`
+      );
+    }
+    const text = await response.text();
+    const grantFile = JSON.parse(text);
+    if (!validateGrantFile(grantFile)) {
+      throw new import_errors.NetworkError(`Invalid grant file format from ${grantUrl}`);
+    }
+    return grantFile;
+  } catch (error) {
+    if (error instanceof import_errors.NetworkError) {
+      throw error;
+    }
+    throw new import_errors.NetworkError(
+      `Error retrieving grant file: ${error instanceof Error ? error.message : "Unknown error"}`,
+      error
+    );
+  }
+}
+function getGrantFileHash(grantFile) {
+  try {
+    const sortedFile = {
+      grantee: grantFile.grantee,
+      operation: grantFile.operation,
+      parameters: sortObjectKeys(grantFile.parameters)
+    };
+    if (grantFile.expires !== void 0) {
+      sortedFile.expires = grantFile.expires;
+    }
+    const jsonString = JSON.stringify(sortedFile);
+    console.info(`Hash: ${(0, import_viem.keccak256)((0, import_viem.toHex)(jsonString))}`);
+    return (0, import_viem.keccak256)((0, import_viem.toHex)(jsonString));
+  } catch (error) {
+    throw new import_errors.SerializationError(
+      `Failed to generate grant file hash: ${error instanceof Error ? error.message : "Unknown error"}`
+    );
+  }
+}
+function sortObjectKeys(obj) {
+  if (obj === null || typeof obj !== "object") {
+    return obj;
+  }
+  if (Array.isArray(obj)) {
+    return obj.map((item) => sortObjectKeys(item));
+  }
+  const sortedObj = {};
+  Object.keys(obj).sort().forEach((key) => {
+    sortedObj[key] = sortObjectKeys(obj[key]);
+  });
+  return sortedObj;
+}
+function validateGrantFile(data) {
+  if (!data || typeof data !== "object") {
+    return false;
+  }
+  const obj = data;
+  if (typeof obj.grantee !== "string" || !obj.grantee.match(/^0x[a-fA-F0-9]{40}$/)) {
+    return false;
+  }
+  if (typeof obj.operation !== "string" || obj.operation.length === 0) {
+    return false;
+  }
+  if (!obj.parameters || typeof obj.parameters !== "object") {
+    return false;
+  }
+  if (obj.expires !== void 0) {
+    if (typeof obj.expires !== "number" || obj.expires < 0 || !Number.isInteger(obj.expires)) {
+      return false;
+    }
+  }
+  return true;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createGrantFile,
+  getGrantFileHash,
+  retrieveGrantFile,
+  storeGrantFile,
+  validateGrantFile
+});
+//# sourceMappingURL=grantFiles.cjs.map

package/dist/utils/grantFiles.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/grantFiles.ts"],"sourcesContent":["import { keccak256, toHex } from \"viem\";\nimport type { GrantFile, GrantPermissionParams } from \"../types/permissions\";\nimport { SerializationError, NetworkError } from \"../errors\";\n\ninterface GrantFileStorageResponse {\n  success: boolean;\n  error?: string;\n  url?: string;\n}\n\n/**\n * Creates a grant file structure from permission parameters.\n *\n * @remarks\n * This function constructs the JSON structure that represents a permission grant\n * in the Vana protocol. The grant file contains all necessary information for\n * a grantee to perform operations on behalf of the grantor.\n *\n * @param params - The permission parameters to create the grant file from\n * @returns The constructed grant file object\n * @example\n * ```typescript\n * const grantFile = createGrantFile({\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',\n *   operation: 'llm_inference',\n *   parameters: {\n *     model: 'gpt-4',\n *     maxTokens: 1000\n *   },\n *   expiresAt: Date.now() + 86400000 // 24 hours\n * });\n *\n * console.log(grantFile);\n * // {\n * //   grantee: '0x742d...',\n * //   operation: 'llm_inference',\n * //   parameters: { model: 'gpt-4', maxTokens: 1000 },\n * //   expires: 1234567890\n * // }\n * ```\n */\nexport function createGrantFile(params: GrantPermissionParams): GrantFile {\n  const grantFile: GrantFile = {\n    grantee: params.grantee,\n    operation: params.operation,\n    parameters: params.parameters,\n  };\n\n  // Add expiration if provided\n  if (params.expiresAt) {\n    grantFile.expires = params.expiresAt;\n  }\n\n  return grantFile;\n}\n\n/**\n * Stores a grant file in IPFS via the relayer service.\n *\n * @remarks\n * This function uploads the grant file to IPFS through the relayer's upload endpoint.\n * The returned URL can be stored on-chain as part of the permission grant, allowing\n * anyone to retrieve the detailed permission parameters later.\n *\n * @param grantFile - The grant file to store\n * @param relayerUrl - URL of the relayer service\n * @returns Promise resolving to the IPFS URL\n * @throws {NetworkError} When the upload fails or relayer is unavailable\n * @example\n * ```typescript\n * const grantFile = createGrantFile(params);\n *\n * try {\n *   const ipfsUrl = await storeGrantFile(grantFile, 'https://relayer.vana.com');\n *   console.log(`Grant file stored at: ${ipfsUrl}`);\n *   // ipfsUrl: \"ipfs://QmHash123...\"\n * } catch (error) {\n *   console.error('Failed to store grant file:', error);\n * }\n * ```\n */\nexport async function storeGrantFile(\n  grantFile: GrantFile,\n  relayerUrl: string,\n): Promise<string> {\n  try {\n    // Convert grant file to blob and use IPFS upload endpoint\n    const grantFileBlob = new Blob([JSON.stringify(grantFile, null, 2)], {\n      type: \"application/json\",\n    });\n\n    const formData = new FormData();\n    formData.append(\"file\", grantFileBlob, \"grant-file.json\");\n\n    const response = await fetch(`${relayerUrl}/api/ipfs/upload`, {\n      method: \"POST\",\n      body: formData,\n    });\n\n    if (!response.ok) {\n      throw new NetworkError(\n        `Failed to store grant file: ${response.statusText}`,\n        new Error(`HTTP ${response.status}`),\n      );\n    }\n\n    const responseData: unknown = await response.json();\n    const data = responseData as GrantFileStorageResponse;\n\n    if (!data.success) {\n      throw new NetworkError(data.error || \"Failed to store grant file\");\n    }\n\n    return data.url || \"\"; // The IPFS URL from the upload response\n  } catch (error) {\n    if (error instanceof NetworkError) {\n      throw error;\n    }\n    throw new NetworkError(\n      `Network error while storing grant file: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n      error as Error,\n    );\n  }\n}\n\n/**\n * Retrieves detailed grant file data from IPFS or HTTP storage.\n *\n * @remarks\n * **This is Step 2 of the performant two-step permission API.**\n *\n * Use this method to resolve detailed permission data (operation, parameters, etc.)\n * for specific grants after first getting the fast on-chain data using\n * `getUserPermissionGrantsOnChain()`. This design eliminates N+1 query problems\n * by allowing selective lazy-loading of expensive off-chain data.\n *\n * **Performance**: Single network request per grant file (typically 100-500ms).\n * **Reliability**: Tries multiple IPFS gateways as fallbacks if primary URL fails.\n *\n * @param grantUrl - The grant file URL from OnChainPermissionGrant.grantUrl\n * @param _relayerUrl - URL of the relayer service (optional, unused)\n * @param downloadRelayer - Optional download relayer for proxying CORS-restricted downloads\n * @param downloadRelayer.proxyDownload - Function to proxy download requests through application server\n * @returns Promise resolving to the complete grant file with operation details\n * @throws {NetworkError} When all retrieval attempts fail\n * @throws {SerializationError} When grant file format is invalid\n * @example\n * ```typescript\n * // Step 1: Fast on-chain data (no N+1 queries)\n * const grants = await vana.permissions.getUserPermissionGrantsOnChain();\n *\n * // Step 2: Lazy-load details for specific grant when needed\n * const grantFile = await retrieveGrantFile(grants[0].grantUrl);\n *\n * console.log(`Operation: ${grantFile.operation}`);\n * console.log(`Grantee: ${grantFile.grantee}`);\n * console.log(`Parameters:`, grantFile.parameters);\n *\n * // Only fetch details for grants user actually wants to see\n * for (const grant of selectedGrants) {\n *   const details = await retrieveGrantFile(grant.grantUrl);\n *   displayGrantDetails(details);\n * }\n * ```\n */\nexport async function retrieveGrantFile(\n  grantUrl: string,\n  _relayerUrl?: string,\n  downloadRelayer?: { proxyDownload: (url: string) => Promise<Blob> },\n): Promise<GrantFile> {\n  try {\n    // Check if the URL is a gateway URL instead of ipfs:// protocol\n    if (grantUrl.startsWith(\"http\") && grantUrl.includes(\"/ipfs/\")) {\n      console.warn(\n        `⚠️  Grant URL uses HTTP gateway format instead of ipfs:// protocol. ` +\n          `Found: ${grantUrl}. ` +\n          `Consider using ipfs:// format for better protocol-agnostic storage.`,\n      );\n    }\n\n    // Use the unified download utility\n    const { fetchWithRelayer } = await import(\"./download\");\n    const response = await fetchWithRelayer(grantUrl, downloadRelayer);\n\n    if (!response.ok) {\n      throw new NetworkError(\n        `Failed to retrieve grant file: HTTP ${response.status}`,\n      );\n    }\n\n    const text = await response.text();\n    const grantFile = JSON.parse(text);\n\n    if (!validateGrantFile(grantFile)) {\n      throw new NetworkError(`Invalid grant file format from ${grantUrl}`);\n    }\n\n    return grantFile;\n  } catch (error) {\n    if (error instanceof NetworkError) {\n      throw error;\n    }\n    throw new NetworkError(\n      `Error retrieving grant file: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n      error as Error,\n    );\n  }\n}\n\n/**\n * Generates a content hash for a grant file.\n * This can be used for integrity verification.\n *\n * @remarks\n * Creates a deterministic keccak256 hash of the grant file by first sorting\n * all object keys recursively to ensure consistent hashing regardless of\n * property order. This hash can be used to verify grant file integrity\n * or as a unique identifier.\n *\n * @param grantFile - The grant file to generate a hash for\n * @returns The keccak256 hash of the grant file as a hex string\n * @throws {SerializationError} When the grant file cannot be serialized\n * @example\n * ```typescript\n * const grantFile = {\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',\n *   operation: 'read',\n *   parameters: { version: '1.0', mode: 'full' }\n * };\n *\n * const hash = getGrantFileHash(grantFile);\n * console.log(`Grant file hash: ${hash}`);\n * // \"0x1234567890abcdef...\"\n *\n * // Same grant file with different property order produces same hash\n * const grantFile2 = {\n *   operation: 'read',\n *   parameters: { mode: 'full', version: '1.0' },\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36'\n * };\n *\n * const hash2 = getGrantFileHash(grantFile2);\n * console.log(hash === hash2); // true\n * ```\n */\nexport function getGrantFileHash(grantFile: GrantFile): string {\n  try {\n    // Create a stable JSON representation\n    const sortedFile: GrantFile = {\n      grantee: grantFile.grantee,\n      operation: grantFile.operation,\n      parameters: sortObjectKeys(grantFile.parameters) as Record<\n        string,\n        unknown\n      >,\n    };\n\n    // Add expires if present\n    if (grantFile.expires !== undefined) {\n      sortedFile.expires = grantFile.expires;\n    }\n\n    const jsonString = JSON.stringify(sortedFile);\n    console.info(`Hash: ${keccak256(toHex(jsonString))}`);\n    return keccak256(toHex(jsonString));\n  } catch (error) {\n    throw new SerializationError(\n      `Failed to generate grant file hash: ${error instanceof Error ? error.message : \"Unknown error\"}`,\n    );\n  }\n}\n\n/**\n * Recursively sorts object keys for stable serialization.\n *\n * @param obj - The object to sort keys recursively\n * @returns The object with all keys sorted recursively\n */\nfunction sortObjectKeys(obj: unknown): unknown {\n  if (obj === null || typeof obj !== \"object\") {\n    return obj;\n  }\n\n  if (Array.isArray(obj)) {\n    return obj.map((item) => sortObjectKeys(item));\n  }\n\n  const sortedObj: Record<string, unknown> = {};\n  Object.keys(obj as Record<string, unknown>)\n    .sort()\n    .forEach((key) => {\n      sortedObj[key] = sortObjectKeys((obj as Record<string, unknown>)[key]);\n    });\n\n  return sortedObj;\n}\n\n/**\n * Validates that a grant file has the required structure.\n *\n * @remarks\n * Performs runtime validation to ensure data conforms to the GrantFile interface.\n * Checks for required fields (grantee, operation, parameters) and validates their\n * types and formats. This is a type guard function that enables TypeScript to\n * narrow the type when it returns true.\n *\n * @param data - The data to validate as a grant file\n * @returns True if the data is a valid grant file, false otherwise\n * @example\n * ```typescript\n * const unknownData = await fetch(url).then(r => r.json());\n *\n * if (validateGrantFile(unknownData)) {\n *   // TypeScript now knows unknownData is a GrantFile\n *   console.log(`Grant for operation: ${unknownData.operation}`);\n *   console.log(`Grantee: ${unknownData.grantee}`);\n * } else {\n *   throw new Error('Invalid grant file format');\n * }\n *\n * // Validation examples:\n * validateGrantFile({\n *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',\n *   operation: 'read',\n *   parameters: {}\n * }); // true\n *\n * validateGrantFile({\n *   grantee: 'invalid-address',\n *   operation: 'read',\n *   parameters: {}\n * }); // false (invalid address format)\n *\n * validateGrantFile({\n *   operation: 'read',\n *   parameters: {}\n * }); // false (missing grantee)\n * ```\n */\nexport function validateGrantFile(data: unknown): data is GrantFile {\n  if (!data || typeof data !== \"object\") {\n    return false;\n  }\n\n  const obj = data as Record<string, unknown>;\n\n  // Validate required fields\n  // Validate grantee address\n  if (\n    typeof obj.grantee !== \"string\" ||\n    !obj.grantee.match(/^0x[a-fA-F0-9]{40}$/)\n  ) {\n    return false;\n  }\n\n  if (typeof obj.operation !== \"string\" || obj.operation.length === 0) {\n    return false;\n  }\n\n  // Files are no longer stored in grant files - they're tracked in the contract\n\n  if (!obj.parameters || typeof obj.parameters !== \"object\") {\n    return false;\n  }\n\n  // Validate optional expires field\n  if (obj.expires !== undefined) {\n    if (\n      typeof obj.expires !== \"number\" ||\n      obj.expires < 0 ||\n      !Number.isInteger(obj.expires)\n    ) {\n      return false;\n    }\n  }\n\n  return true;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiC;AAEjC,oBAAiD;AAuC1C,SAAS,gBAAgB,QAA0C;AACxE,QAAM,YAAuB;AAAA,IAC3B,SAAS,OAAO;AAAA,IAChB,WAAW,OAAO;AAAA,IAClB,YAAY,OAAO;AAAA,EACrB;AAGA,MAAI,OAAO,WAAW;AACpB,cAAU,UAAU,OAAO;AAAA,EAC7B;AAEA,SAAO;AACT;AA2BA,eAAsB,eACpB,WACA,YACiB;AACjB,MAAI;AAEF,UAAM,gBAAgB,IAAI,KAAK,CAAC,KAAK,UAAU,WAAW,MAAM,CAAC,CAAC,GAAG;AAAA,MACnE,MAAM;AAAA,IACR,CAAC;AAED,UAAM,WAAW,IAAI,SAAS;AAC9B,aAAS,OAAO,QAAQ,eAAe,iBAAiB;AAExD,UAAM,WAAW,MAAM,MAAM,GAAG,UAAU,oBAAoB;AAAA,MAC5D,QAAQ;AAAA,MACR,MAAM;AAAA,IACR,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI;AAAA,QACR,+BAA+B,SAAS,UAAU;AAAA,QAClD,IAAI,MAAM,QAAQ,SAAS,MAAM,EAAE;AAAA,MACrC;AAAA,IACF;AAEA,UAAM,eAAwB,MAAM,SAAS,KAAK;AAClD,UAAM,OAAO;AAEb,QAAI,CAAC,KAAK,SAAS;AACjB,YAAM,IAAI,2BAAa,KAAK,SAAS,4BAA4B;AAAA,IACnE;AAEA,WAAO,KAAK,OAAO;AAAA,EACrB,SAAS,OAAO;AACd,QAAI,iBAAiB,4BAAc;AACjC,YAAM;AAAA,IACR;AACA,UAAM,IAAI;AAAA,MACR,2CAA2C,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,MACnG;AAAA,IACF;AAAA,EACF;AACF;AA0CA,eAAsB,kBACpB,UACA,aACA,iBACoB;AACpB,MAAI;AAEF,QAAI,SAAS,WAAW,MAAM,KAAK,SAAS,SAAS,QAAQ,GAAG;AAC9D,cAAQ;AAAA,QACN,wFACY,QAAQ;AAAA,MAEtB;AAAA,IACF;AAGA,UAAM,EAAE,iBAAiB,IAAI,MAAM,OAAO,YAAY;AACtD,UAAM,WAAW,MAAM,iBAAiB,UAAU,eAAe;AAEjE,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI;AAAA,QACR,uCAAuC,SAAS,MAAM;AAAA,MACxD;AAAA,IACF;AAEA,UAAM,OAAO,MAAM,SAAS,KAAK;AACjC,UAAM,YAAY,KAAK,MAAM,IAAI;AAEjC,QAAI,CAAC,kBAAkB,SAAS,GAAG;AACjC,YAAM,IAAI,2BAAa,kCAAkC,QAAQ,EAAE;AAAA,IACrE;AAEA,WAAO;AAAA,EACT,SAAS,OAAO;AACd,QAAI,iBAAiB,4BAAc;AACjC,YAAM;AAAA,IACR;AACA,UAAM,IAAI;AAAA,MACR,gCAAgC,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,MACxF;AAAA,IACF;AAAA,EACF;AACF;AAsCO,SAAS,iBAAiB,WAA8B;AAC7D,MAAI;AAEF,UAAM,aAAwB;AAAA,MAC5B,SAAS,UAAU;AAAA,MACnB,WAAW,UAAU;AAAA,MACrB,YAAY,eAAe,UAAU,UAAU;AAAA,IAIjD;AAGA,QAAI,UAAU,YAAY,QAAW;AACnC,iBAAW,UAAU,UAAU;AAAA,IACjC;AAEA,UAAM,aAAa,KAAK,UAAU,UAAU;AAC5C,YAAQ,KAAK,aAAS,2BAAU,mBAAM,UAAU,CAAC,CAAC,EAAE;AACpD,eAAO,2BAAU,mBAAM,UAAU,CAAC;AAAA,EACpC,SAAS,OAAO;AACd,UAAM,IAAI;AAAA,MACR,uCAAuC,iBAAiB,QAAQ,MAAM,UAAU,eAAe;AAAA,IACjG;AAAA,EACF;AACF;AAQA,SAAS,eAAe,KAAuB;AAC7C,MAAI,QAAQ,QAAQ,OAAO,QAAQ,UAAU;AAC3C,WAAO;AAAA,EACT;AAEA,MAAI,MAAM,QAAQ,GAAG,GAAG;AACtB,WAAO,IAAI,IAAI,CAAC,SAAS,eAAe,IAAI,CAAC;AAAA,EAC/C;AAEA,QAAM,YAAqC,CAAC;AAC5C,SAAO,KAAK,GAA8B,EACvC,KAAK,EACL,QAAQ,CAAC,QAAQ;AAChB,cAAU,GAAG,IAAI,eAAgB,IAAgC,GAAG,CAAC;AAAA,EACvE,CAAC;AAEH,SAAO;AACT;AA4CO,SAAS,kBAAkB,MAAkC;AAClE,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,QAAM,MAAM;AAIZ,MACE,OAAO,IAAI,YAAY,YACvB,CAAC,IAAI,QAAQ,MAAM,qBAAqB,GACxC;AACA,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,IAAI,cAAc,YAAY,IAAI,UAAU,WAAW,GAAG;AACnE,WAAO;AAAA,EACT;AAIA,MAAI,CAAC,IAAI,cAAc,OAAO,IAAI,eAAe,UAAU;AACzD,WAAO;AAAA,EACT;AAGA,MAAI,IAAI,YAAY,QAAW;AAC7B,QACE,OAAO,IAAI,YAAY,YACvB,IAAI,UAAU,KACd,CAAC,OAAO,UAAU,IAAI,OAAO,GAC7B;AACA,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}

package/dist/utils/grantFiles.d.cts

@@ -0,0 +1,186 @@
+import { GrantPermissionParams, GrantFile } from '../types/permissions.cjs';
+import 'viem';
+
+/**
+ * Creates a grant file structure from permission parameters.
+ *
+ * @remarks
+ * This function constructs the JSON structure that represents a permission grant
+ * in the Vana protocol. The grant file contains all necessary information for
+ * a grantee to perform operations on behalf of the grantor.
+ *
+ * @param params - The permission parameters to create the grant file from
+ * @returns The constructed grant file object
+ * @example
+ * ```typescript
+ * const grantFile = createGrantFile({
+ *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',
+ *   operation: 'llm_inference',
+ *   parameters: {
+ *     model: 'gpt-4',
+ *     maxTokens: 1000
+ *   },
+ *   expiresAt: Date.now() + 86400000 // 24 hours
+ * });
+ *
+ * console.log(grantFile);
+ * // {
+ * //   grantee: '0x742d...',
+ * //   operation: 'llm_inference',
+ * //   parameters: { model: 'gpt-4', maxTokens: 1000 },
+ * //   expires: 1234567890
+ * // }
+ * ```
+ */
+declare function createGrantFile(params: GrantPermissionParams): GrantFile;
+/**
+ * Stores a grant file in IPFS via the relayer service.
+ *
+ * @remarks
+ * This function uploads the grant file to IPFS through the relayer's upload endpoint.
+ * The returned URL can be stored on-chain as part of the permission grant, allowing
+ * anyone to retrieve the detailed permission parameters later.
+ *
+ * @param grantFile - The grant file to store
+ * @param relayerUrl - URL of the relayer service
+ * @returns Promise resolving to the IPFS URL
+ * @throws {NetworkError} When the upload fails or relayer is unavailable
+ * @example
+ * ```typescript
+ * const grantFile = createGrantFile(params);
+ *
+ * try {
+ *   const ipfsUrl = await storeGrantFile(grantFile, 'https://relayer.vana.com');
+ *   console.log(`Grant file stored at: ${ipfsUrl}`);
+ *   // ipfsUrl: "ipfs://QmHash123..."
+ * } catch (error) {
+ *   console.error('Failed to store grant file:', error);
+ * }
+ * ```
+ */
+declare function storeGrantFile(grantFile: GrantFile, relayerUrl: string): Promise<string>;
+/**
+ * Retrieves detailed grant file data from IPFS or HTTP storage.
+ *
+ * @remarks
+ * **This is Step 2 of the performant two-step permission API.**
+ *
+ * Use this method to resolve detailed permission data (operation, parameters, etc.)
+ * for specific grants after first getting the fast on-chain data using
+ * `getUserPermissionGrantsOnChain()`. This design eliminates N+1 query problems
+ * by allowing selective lazy-loading of expensive off-chain data.
+ *
+ * **Performance**: Single network request per grant file (typically 100-500ms).
+ * **Reliability**: Tries multiple IPFS gateways as fallbacks if primary URL fails.
+ *
+ * @param grantUrl - The grant file URL from OnChainPermissionGrant.grantUrl
+ * @param _relayerUrl - URL of the relayer service (optional, unused)
+ * @param downloadRelayer - Optional download relayer for proxying CORS-restricted downloads
+ * @param downloadRelayer.proxyDownload - Function to proxy download requests through application server
+ * @returns Promise resolving to the complete grant file with operation details
+ * @throws {NetworkError} When all retrieval attempts fail
+ * @throws {SerializationError} When grant file format is invalid
+ * @example
+ * ```typescript
+ * // Step 1: Fast on-chain data (no N+1 queries)
+ * const grants = await vana.permissions.getUserPermissionGrantsOnChain();
+ *
+ * // Step 2: Lazy-load details for specific grant when needed
+ * const grantFile = await retrieveGrantFile(grants[0].grantUrl);
+ *
+ * console.log(`Operation: ${grantFile.operation}`);
+ * console.log(`Grantee: ${grantFile.grantee}`);
+ * console.log(`Parameters:`, grantFile.parameters);
+ *
+ * // Only fetch details for grants user actually wants to see
+ * for (const grant of selectedGrants) {
+ *   const details = await retrieveGrantFile(grant.grantUrl);
+ *   displayGrantDetails(details);
+ * }
+ * ```
+ */
+declare function retrieveGrantFile(grantUrl: string, _relayerUrl?: string, downloadRelayer?: {
+    proxyDownload: (url: string) => Promise<Blob>;
+}): Promise<GrantFile>;
+/**
+ * Generates a content hash for a grant file.
+ * This can be used for integrity verification.
+ *
+ * @remarks
+ * Creates a deterministic keccak256 hash of the grant file by first sorting
+ * all object keys recursively to ensure consistent hashing regardless of
+ * property order. This hash can be used to verify grant file integrity
+ * or as a unique identifier.
+ *
+ * @param grantFile - The grant file to generate a hash for
+ * @returns The keccak256 hash of the grant file as a hex string
+ * @throws {SerializationError} When the grant file cannot be serialized
+ * @example
+ * ```typescript
+ * const grantFile = {
+ *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',
+ *   operation: 'read',
+ *   parameters: { version: '1.0', mode: 'full' }
+ * };
+ *
+ * const hash = getGrantFileHash(grantFile);
+ * console.log(`Grant file hash: ${hash}`);
+ * // "0x1234567890abcdef..."
+ *
+ * // Same grant file with different property order produces same hash
+ * const grantFile2 = {
+ *   operation: 'read',
+ *   parameters: { mode: 'full', version: '1.0' },
+ *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36'
+ * };
+ *
+ * const hash2 = getGrantFileHash(grantFile2);
+ * console.log(hash === hash2); // true
+ * ```
+ */
+declare function getGrantFileHash(grantFile: GrantFile): string;
+/**
+ * Validates that a grant file has the required structure.
+ *
+ * @remarks
+ * Performs runtime validation to ensure data conforms to the GrantFile interface.
+ * Checks for required fields (grantee, operation, parameters) and validates their
+ * types and formats. This is a type guard function that enables TypeScript to
+ * narrow the type when it returns true.
+ *
+ * @param data - The data to validate as a grant file
+ * @returns True if the data is a valid grant file, false otherwise
+ * @example
+ * ```typescript
+ * const unknownData = await fetch(url).then(r => r.json());
+ *
+ * if (validateGrantFile(unknownData)) {
+ *   // TypeScript now knows unknownData is a GrantFile
+ *   console.log(`Grant for operation: ${unknownData.operation}`);
+ *   console.log(`Grantee: ${unknownData.grantee}`);
+ * } else {
+ *   throw new Error('Invalid grant file format');
+ * }
+ *
+ * // Validation examples:
+ * validateGrantFile({
+ *   grantee: '0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36',
+ *   operation: 'read',
+ *   parameters: {}
+ * }); // true
+ *
+ * validateGrantFile({
+ *   grantee: 'invalid-address',
+ *   operation: 'read',
+ *   parameters: {}
+ * }); // false (invalid address format)
+ *
+ * validateGrantFile({
+ *   operation: 'read',
+ *   parameters: {}
+ * }); // false (missing grantee)
+ * ```
+ */
+declare function validateGrantFile(data: unknown): data is GrantFile;
+
+export { createGrantFile, getGrantFileHash, retrieveGrantFile, storeGrantFile, validateGrantFile };