@opendatalabs/vana-sdk 0.1.0-alpha.f54fafd → 0.1.0-alpha.f732fa2

package/dist/types/relayer.d.ts

@@ -0,0 +1,516 @@
+/**
+ * Defines types for gasless transaction relayers and server operations.
+ *
+ * @remarks
+ * This module provides comprehensive type definitions for interacting with
+ * relayer services that enable gasless transactions and auxiliary operations.
+ * It includes both legacy v1 types and the simplified v2 unified interface.
+ *
+ * @category Types
+ * @module types/relayer
+ */
+import type { Hash, Address } from "viem";
+import type { GrantFile, PermissionGrantTypedData, GenericTypedData } from "./permissions";
+/**
+ * Represents the response from storing grant files via relayer.
+ *
+ * @remarks
+ * Contains storage location, metadata, and error information for
+ * grant file upload operations.
+ *
+ * @category Advanced
+ */
+export interface RelayerStorageResponse {
+    /** The IPFS URL where the grant file is stored */
+    grantUrl: string;
+    /** Success status */
+    success: boolean;
+    /** Optional error message */
+    error?: string;
+    /** Storage metadata */
+    metadata?: {
+        /** IPFS hash */
+        ipfsHash: string;
+        /** File size in bytes */
+        size: number;
+        /** Upload timestamp */
+        timestamp: number;
+    };
+}
+/**
+ * Represents the response from submitting transactions via relayer.
+ *
+ * @remarks
+ * Contains transaction hash, status, and metadata for gasless
+ * transaction submissions.
+ *
+ * @category Advanced
+ */
+export interface RelayerTransactionResponse {
+    /** The transaction hash of the submitted transaction */
+    transactionHash: Hash;
+    /** Success status */
+    success: boolean;
+    /** Optional error message */
+    error?: string;
+    /** Transaction metadata */
+    metadata?: {
+        /** Gas used */
+        gasUsed?: bigint;
+        /** Gas price */
+        gasPrice?: bigint;
+        /** Block number */
+        blockNumber?: bigint;
+        /** Transaction status */
+        status?: "pending" | "confirmed" | "failed";
+    };
+}
+/**
+ * Specifies parameters for storing grant files via relayer.
+ *
+ * @remarks
+ * Includes the grant file and optional storage configuration
+ * such as encryption and pinning duration.
+ *
+ * @category Advanced
+ */
+export interface RelayerStoreParams {
+    /** The grant file to store */
+    grantFile: GrantFile;
+    /** Optional storage options */
+    options?: {
+        /** IPFS pin duration in seconds */
+        pinDuration?: number;
+        /** Whether to use encryption */
+        encrypt?: boolean;
+        /** Custom metadata */
+        metadata?: Record<string, unknown>;
+    };
+}
+/**
+ * Specifies parameters for submitting gasless transactions.
+ *
+ * @remarks
+ * Contains signed typed data and transaction configuration options
+ * for relayer submission.
+ *
+ * @category Advanced
+ */
+export interface RelayerSubmitParams {
+    /** The signed typed data */
+    typedData: PermissionGrantTypedData;
+    /** The signature */
+    signature: string;
+    /** Optional transaction options */
+    options?: {
+        /** Gas limit */
+        gasLimit?: bigint;
+        /** Priority level */
+        priority?: "low" | "medium" | "high";
+        /** Whether to wait for confirmation */
+        waitForConfirmation?: boolean;
+    };
+}
+/**
+ * Represents the current status and capabilities of a relayer service.
+ *
+ * @remarks
+ * Provides information about supported chains, rate limits, and
+ * current operational status for monitoring and decision-making.
+ *
+ * @category Advanced
+ */
+export interface RelayerStatus {
+    /** Whether the relayer is online */
+    online: boolean;
+    /** Service version */
+    version: string;
+    /** Supported chains */
+    supportedChains: number[];
+    /** Current chain status */
+    chainStatus: Record<number, {
+        /** Whether the chain is supported */
+        supported: boolean;
+        /** Current block number */
+        currentBlock: bigint;
+        /** Gas price estimation */
+        gasPrice: bigint;
+        /** Queue size */
+        queueSize: number;
+    }>;
+    /** Rate limit information */
+    rateLimits: {
+        /** Requests per minute */
+        requestsPerMinute: number;
+        /** Storage requests per hour */
+        storageRequestsPerHour: number;
+        /** Transaction requests per hour */
+        transactionRequestsPerHour: number;
+    };
+}
+/**
+ * Configures behavior for relayer requests.
+ *
+ * @remarks
+ * Controls timeout, retry logic, headers, and priority for
+ * relayer operation requests.
+ *
+ * @category Advanced
+ */
+export interface RelayerRequestOptions {
+    /** Request timeout in milliseconds */
+    timeout?: number;
+    /** Whether to retry on failure */
+    retry?: boolean;
+    /** Custom headers */
+    headers?: Record<string, string>;
+    /** Request priority */
+    priority?: "low" | "medium" | "high";
+}
+/**
+ * Represents an error response from the relayer service.
+ *
+ * @remarks
+ * Provides structured error information including codes, messages,
+ * and debugging details for error handling and recovery.
+ *
+ * @category Advanced
+ */
+export interface RelayerErrorResponse {
+    /** Error code */
+    code: string;
+    /** Error message */
+    message: string;
+    /** Additional error details */
+    details?: Record<string, unknown>;
+    /** Request ID for debugging */
+    requestId?: string;
+    /** Timestamp of error */
+    timestamp: number;
+}
+/**
+ * Provides information about the relayer's processing queue.
+ *
+ * @remarks
+ * Includes queue size, position, estimated processing time, and
+ * performance statistics for queue monitoring.
+ *
+ * @category Advanced
+ */
+export interface RelayerQueueInfo {
+    /** Current queue size */
+    size: number;
+    /** Estimated processing time in seconds */
+    estimatedProcessingTime: number;
+    /** Queue position for a specific request */
+    position?: number;
+    /** Processing statistics */
+    stats: {
+        /** Average processing time in seconds */
+        averageProcessingTime: number;
+        /** Requests processed in last hour */
+        requestsProcessedHour: number;
+        /** Success rate percentage */
+        successRate: number;
+    };
+}
+/**
+ * Tracks the status of a transaction submitted via relayer.
+ *
+ * @remarks
+ * Provides detailed tracking information including confirmation status,
+ * gas usage, and historical status checks.
+ *
+ * @category Advanced
+ */
+export interface RelayerTransactionStatus {
+    /** Transaction hash */
+    transactionHash: Hash;
+    /** Current status */
+    status: "pending" | "confirmed" | "failed";
+    /** Block number if confirmed */
+    blockNumber?: bigint;
+    /** Gas used */
+    gasUsed?: bigint;
+    /** Error message if failed */
+    error?: string;
+    /** Status checks performed */
+    checks: Array<{
+        /** Check timestamp */
+        timestamp: number;
+        /** Status at time of check */
+        status: string;
+        /** Block number at time of check */
+        blockNumber: bigint;
+    }>;
+}
+/**
+ * Provides performance metrics for the relayer service.
+ *
+ * @remarks
+ * Includes transaction statistics, success rates, processing times,
+ * and uptime information for monitoring and optimization.
+ *
+ * @category Advanced
+ */
+export interface RelayerMetrics {
+    /** Total transactions processed */
+    totalTransactions: number;
+    /** Successful transactions */
+    successfulTransactions: number;
+    /** Failed transactions */
+    failedTransactions: number;
+    /** Average processing time in seconds */
+    averageProcessingTime: number;
+    /** Current queue size */
+    queueSize: number;
+    /** Uptime percentage */
+    uptime: number;
+    /** Last 24 hour statistics */
+    last24Hours: {
+        /** Transactions processed */
+        transactions: number;
+        /** Success rate */
+        successRate: number;
+        /** Average response time */
+        averageResponseTime: number;
+    };
+}
+/**
+ * Configures webhook notifications for relayer events.
+ *
+ * @remarks
+ * Enables asynchronous notifications for transaction confirmations,
+ * failures, and storage completions.
+ *
+ * @category Advanced
+ */
+export interface RelayerWebhookConfig {
+    /** Webhook URL */
+    url: string;
+    /** Events to subscribe to */
+    events: Array<"transaction_confirmed" | "transaction_failed" | "storage_complete">;
+    /** Webhook secret for signature verification */
+    secret?: string;
+    /** Whether webhook is active */
+    active: boolean;
+}
+/**
+ * Represents a webhook event payload from the relayer.
+ *
+ * @remarks
+ * Contains event data, timestamp, and signature for verification
+ * of webhook authenticity.
+ *
+ * @category Advanced
+ */
+export interface RelayerWebhookPayload {
+    /** Event type */
+    event: string;
+    /** Event data */
+    data: Record<string, unknown>;
+    /** Timestamp */
+    timestamp: number;
+    /** Webhook ID */
+    webhookId: string;
+    /** Signature for verification */
+    signature: string;
+}
+/**
+ * Handles both EIP-712 signed operations and direct server operations through a single interface.
+ *
+ * @remarks
+ * This discriminated union provides type safety through TypeScript's narrowing.
+ * The `type` field determines which operation variant is being used.
+ * Signed operations require blockchain transactions, while direct operations
+ * handle auxiliary tasks like file storage.
+ *
+ * @category Relayer
+ * @see {@link https://docs.vana.org/docs/gasless-transactions | Gasless Transactions Guide}
+ */
+export type UnifiedRelayerRequest = SignedRelayerRequest | DirectRelayerRequest;
+/**
+ * Represents an EIP-712 signed operation for gasless transaction submission.
+ *
+ * @remarks
+ * Signed requests contain typed data and signatures that are verified
+ * on-chain by smart contracts. The relayer pays gas fees on behalf of users.
+ *
+ * @category Relayer
+ */
+export interface SignedRelayerRequest {
+    /** Discriminator field identifying this as a signed operation */
+    type: "signed";
+    /** Operation identifier for routing (e.g., 'submitAddPermission') */
+    operation: SignedOperationType;
+    /** EIP-712 typed data structure for the operation */
+    typedData: GenericTypedData;
+    /** User's signature of the typed data */
+    signature: Hash;
+    /** Optional address for additional signer verification */
+    expectedUserAddress?: Address;
+}
+/**
+ * Enumerates supported EIP-712 signed operation types.
+ *
+ * @remarks
+ * Each operation type corresponds to a specific smart contract
+ * function that accepts gasless transactions.
+ *
+ * @category Relayer
+ */
+export type SignedOperationType = "submitAddPermission" | "submitPermissionRevoke" | "submitTrustServer" | "submitAddAndTrustServer" | "submitUntrustServer" | "submitAddServerFilesAndPermissions";
+/**
+ * Represents direct server operations that don't require blockchain signatures.
+ *
+ * @remarks
+ * Direct requests handle auxiliary operations like file uploads and grant storage.
+ * These operations may still result in blockchain transactions but don't require
+ * user signatures for gasless submission.
+ *
+ * @category Relayer
+ */
+export type DirectRelayerRequest = {
+    type: "direct";
+    operation: "submitFileAddition";
+    params: {
+        url: string;
+        userAddress: Address;
+    };
+} | {
+    type: "direct";
+    operation: "submitFileAdditionWithPermissions";
+    params: {
+        url: string;
+        userAddress: Address;
+        permissions: Array<{
+            account: Address;
+            key: string;
+        }>;
+    };
+} | {
+    type: "direct";
+    operation: "submitFileAdditionComplete";
+    params: {
+        url: string;
+        userAddress: Address;
+        permissions: Array<{
+            account: Address;
+            key: string;
+        }>;
+        schemaId: number;
+        ownerAddress?: Address;
+    };
+} | {
+    type: "direct";
+    operation: "storeGrantFile";
+    params: GrantFile;
+} | {
+    type: "direct";
+    operation: "submitRegisterGrantee";
+    params: {
+        owner: Address;
+        granteeAddress: Address;
+        publicKey: string;
+    };
+};
+/**
+ * Provides type-safe responses for all relayer operations.
+ *
+ * @remarks
+ * The discriminated union ensures proper error handling and result typing.
+ * Check the `type` field to determine success or failure before accessing results.
+ *
+ * @category Relayer
+ */
+export type UnifiedRelayerResponse = {
+    type: "signed";
+    hash: Hash;
+} | {
+    type: "direct";
+    result: {
+        fileId: number;
+        transactionHash: Hash;
+    } | {
+        url: string;
+    } | any;
+} | {
+    type: "error";
+    error: string;
+};
+/**
+ * Simplified relayer configuration.
+ * Can be a URL string for convenience, or a callback for full control.
+ *
+ * @category Configuration
+ * @example
+ * ```typescript
+ * // Option 1: Simple URL (SDK handles the transport)
+ * const vana = Vana({
+ *   walletClient,
+ *   relayer: '/api/relay'
+ * });
+ *
+ * // Option 2: Full control with callback
+ * const vana = Vana({
+ *   walletClient,
+ *   relayer: async (request) => {
+ *     const response = await fetch('/api/relay', {
+ *       method: 'POST',
+ *       body: JSON.stringify(request)
+ *     });
+ *     return response.json();
+ *   }
+ * });
+ * ```
+ */
+export type RelayerConfig = string | ((request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>);
+/**
+ * Simplified relayer callbacks interface (v2).
+ * A single callback handles all relayer operations.
+ *
+ * @category Configuration
+ * @example
+ * ```typescript
+ * const relayerCallbacks: RelayerCallbacksV2 = {
+ *   submit: async (request) => {
+ *     // Send to your server endpoint
+ *     const response = await fetch('/api/relay', {
+ *       method: 'POST',
+ *       headers: { 'Content-Type': 'application/json' },
+ *       body: JSON.stringify(request)
+ *     });
+ *     return response.json();
+ *   }
+ * };
+ * ```
+ */
+export interface RelayerCallbacksV2 {
+    /**
+     * Submits any relayer operation to the server.
+     *
+     * @remarks
+     * This single callback handles all operations:
+     * - EIP-712 signed operations (permissions, server trust, etc.)
+     * - Direct operations (file additions, grant storage)
+     *
+     * On your server, pass the entire request object to the SDK's
+     * `handleRelayerOperation` helper function.
+     *
+     * @param request - The unified request object.
+     *   Check `type` field to determine operation variant.
+     * @returns Promise resolving to operation-specific response
+     *
+     * @example
+     * ```typescript
+     * async submit(request) {
+     *   const response = await fetch('/api/relay', {
+     *     method: 'POST',
+     *     body: JSON.stringify(request)
+     *   });
+     *   return response.json();
+     * }
+     * ```
+     */
+    submit: (request: UnifiedRelayerRequest) => Promise<UnifiedRelayerResponse>;
+}

package/dist/types/relayer.js

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

package/dist/types/relayer.js.map

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

package/dist/types/storage.cjs

@@ -0,0 +1,39 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var storage_exports = {};
+__export(storage_exports, {
+  StorageError: () => StorageError
+});
+module.exports = __toCommonJS(storage_exports);
+class StorageError extends Error {
+  code;
+  provider;
+  // The 'cause' property is now inherited from the base Error class
+  constructor(message, code, provider, options) {
+    super(message, options);
+    this.name = "StorageError";
+    this.code = code;
+    this.provider = provider;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  StorageError
+});
+//# sourceMappingURL=storage.cjs.map

package/dist/types/storage.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/storage.ts"],"sourcesContent":["/**\n * Defines interface for storage provider implementations.\n *\n * @remarks\n * Abstracts storage backends (IPFS, Google Drive, Pinata) behind\n * common interface for encrypted file operations.\n *\n * @category Storage\n * @example\n * ```typescript\n * class MyStorage implements StorageProvider {\n *   async upload(file: Blob): Promise<StorageUploadResult> {\n *     const url = await uploadToService(file);\n *     return { url, size: file.size, contentType: file.type };\n *   }\n *\n *   async download(url: string): Promise<Blob> {\n *     return fetch(url).then(r => r.blob());\n *   }\n * }\n * ```\n */\nexport interface StorageProvider {\n  /**\n   * Upload a file to the storage provider\n   *\n   * @param file - The file to upload\n   * @param filename - Optional custom filename\n   * @returns Promise with storage URL and metadata\n   */\n  upload(file: Blob, filename?: string): Promise<StorageUploadResult>;\n\n  /**\n   * Download a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with file blob\n   */\n  download(url: string): Promise<Blob>;\n\n  /**\n   * List files from the storage provider\n   *\n   * @param options - Optional filtering and pagination\n   * @returns Promise with file list\n   */\n  list(options?: StorageListOptions): Promise<StorageFile[]>;\n\n  /**\n   * Delete a file from the storage provider\n   *\n   * @param url - The storage URL\n   * @returns Promise with success status\n   */\n  delete(url: string): Promise<boolean>;\n\n  /**\n   * Get provider-specific configuration\n   *\n   * @returns Provider configuration object\n   */\n  getConfig(): StorageProviderConfig;\n}\n\nexport interface StorageUploadResult {\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageFile {\n  /** File identifier */\n  id: string;\n  /** File name */\n  name: string;\n  /** Public URL to access the file */\n  url: string;\n  /** File size in bytes */\n  size: number;\n  /** Content type/MIME type */\n  contentType: string;\n  /** Upload timestamp */\n  createdAt: Date;\n  /** Provider-specific metadata */\n  metadata?: Record<string, unknown>;\n}\n\nexport interface StorageListOptions {\n  /** Maximum number of files to return */\n  limit?: number;\n  /** Pagination cursor/offset */\n  offset?: string | number;\n  /** Filter by file name pattern */\n  namePattern?: string;\n  /** Filter by content type */\n  contentType?: string;\n}\n\nexport interface StorageProviderConfig {\n  /** Provider name */\n  name: string;\n  /** Provider type */\n  type: string;\n  /** Whether authentication is required */\n  requiresAuth: boolean;\n  /** Supported features */\n  features: {\n    upload: boolean;\n    download: boolean;\n    list: boolean;\n    delete: boolean;\n  };\n}\n\nexport class StorageError extends Error {\n  public readonly code: string;\n  public readonly provider: string;\n  // The 'cause' property is now inherited from the base Error class\n\n  constructor(\n    message: string,\n    code: string,\n    provider: string,\n    options?: { cause?: Error },\n  ) {\n    // Pass the options object with 'cause' to the super constructor\n    super(message, options);\n    this.name = \"StorageError\";\n    this.code = code;\n    this.provider = provider;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAuHO,MAAM,qBAAqB,MAAM;AAAA,EACtB;AAAA,EACA;AAAA;AAAA,EAGhB,YACE,SACA,MACA,UACA,SACA;AAEA,UAAM,SAAS,OAAO;AACtB,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,WAAW;AAAA,EAClB;AACF;","names":[]}

package/dist/types/storage.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Defines interface for storage provider implementations.
+ *
+ * @remarks
+ * Abstracts storage backends (IPFS, Google Drive, Pinata) behind
+ * common interface for encrypted file operations.
+ *
+ * @category Storage
+ * @example
+ * ```typescript
+ * class MyStorage implements StorageProvider {
+ *   async upload(file: Blob): Promise<StorageUploadResult> {
+ *     const url = await uploadToService(file);
+ *     return { url, size: file.size, contentType: file.type };
+ *   }
+ *
+ *   async download(url: string): Promise<Blob> {
+ *     return fetch(url).then(r => r.blob());
+ *   }
+ * }
+ * ```
+ */
+export interface StorageProvider {
+    /**
+     * Upload a file to the storage provider
+     *
+     * @param file - The file to upload
+     * @param filename - Optional custom filename
+     * @returns Promise with storage URL and metadata
+     */
+    upload(file: Blob, filename?: string): Promise<StorageUploadResult>;
+    /**
+     * Download a file from the storage provider
+     *
+     * @param url - The storage URL
+     * @returns Promise with file blob
+     */
+    download(url: string): Promise<Blob>;
+    /**
+     * List files from the storage provider
+     *
+     * @param options - Optional filtering and pagination
+     * @returns Promise with file list
+     */
+    list(options?: StorageListOptions): Promise<StorageFile[]>;
+    /**
+     * Delete a file from the storage provider
+     *
+     * @param url - The storage URL
+     * @returns Promise with success status
+     */
+    delete(url: string): Promise<boolean>;
+    /**
+     * Get provider-specific configuration
+     *
+     * @returns Provider configuration object
+     */
+    getConfig(): StorageProviderConfig;
+}
+export interface StorageUploadResult {
+    /** Public URL to access the file */
+    url: string;
+    /** File size in bytes */
+    size: number;
+    /** Content type/MIME type */
+    contentType: string;
+    /** Provider-specific metadata */
+    metadata?: Record<string, unknown>;
+}
+export interface StorageFile {
+    /** File identifier */
+    id: string;
+    /** File name */
+    name: string;
+    /** Public URL to access the file */
+    url: string;
+    /** File size in bytes */
+    size: number;
+    /** Content type/MIME type */
+    contentType: string;
+    /** Upload timestamp */
+    createdAt: Date;
+    /** Provider-specific metadata */
+    metadata?: Record<string, unknown>;
+}
+export interface StorageListOptions {
+    /** Maximum number of files to return */
+    limit?: number;
+    /** Pagination cursor/offset */
+    offset?: string | number;
+    /** Filter by file name pattern */
+    namePattern?: string;
+    /** Filter by content type */
+    contentType?: string;
+}
+export interface StorageProviderConfig {
+    /** Provider name */
+    name: string;
+    /** Provider type */
+    type: string;
+    /** Whether authentication is required */
+    requiresAuth: boolean;
+    /** Supported features */
+    features: {
+        upload: boolean;
+        download: boolean;
+        list: boolean;
+        delete: boolean;
+    };
+}
+export declare class StorageError extends Error {
+    readonly code: string;
+    readonly provider: string;
+    constructor(message: string, code: string, provider: string, options?: {
+        cause?: Error;
+    });
+}

package/dist/types/storage.js

@@ -0,0 +1,15 @@
+class StorageError extends Error {
+  code;
+  provider;
+  // The 'cause' property is now inherited from the base Error class
+  constructor(message, code, provider, options) {
+    super(message, options);
+    this.name = "StorageError";
+    this.code = code;
+    this.provider = provider;
+  }
+}
+export {
+  StorageError
+};
+//# sourceMappingURL=storage.js.map