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

package/dist/types/personal.d.cts

@@ -1,40 +0,0 @@
-/**
- * Parameters for the `vana.personal.postRequest` method.
- */
-interface PostRequestParams {
-    /** The permission ID */
-    permissionId: number;
-}
-/**
- * Parameters for the `vana.server.createOperation` method.
- */
-interface CreateOperationParams {
-    /** The permission ID */
-    permissionId: number;
-}
-/**
- * Parameters for personal server operations.
- */
-interface InitPersonalServerParams {
-    /** The user's wallet address */
-    userAddress: string;
-}
-/**
- * Extended personal server identity information including connection details.
- * This combines the base PersonalServerModel with additional metadata
- * needed for client connections.
- */
-interface PersonalServerIdentity {
-    /** Resource type identifier */
-    kind: string;
-    /** The server's Ethereum address */
-    address: string;
-    /** The server's public key for encryption */
-    public_key: string;
-    /** The base URL for connecting to this server */
-    base_url: string;
-    /** Human-readable name for this server */
-    name: string;
-}
-
-export type { CreateOperationParams, InitPersonalServerParams, PersonalServerIdentity, PostRequestParams };

package/dist/types/relayer.d.cts

@@ -1,284 +0,0 @@
-import { Hash } from 'viem';
-import { GrantFile, PermissionGrantTypedData } from './permissions.cjs';
-
-/**
- * Response from the relayer service for grant file storage
- *
- * @category Advanced
- */
-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;
-    };
-}
-/**
- * Response from the relayer service for transaction submission
- *
- * @category Advanced
- */
-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";
-    };
-}
-/**
- * Parameters for storing a grant file via relayer
- *
- * @category Advanced
- */
-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>;
-    };
-}
-/**
- * Parameters for submitting a transaction via relayer
- *
- * @category Advanced
- */
-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;
-    };
-}
-/**
- * Relayer service status
- *
- * @category Advanced
- */
-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;
-    };
-}
-/**
- * Relayer configuration
- *
- * @category Advanced
- */
-interface RelayerConfig {
-    /** Relayer service URL */
-    url: string;
-    /** API key for authentication */
-    apiKey?: string;
-    /** Timeout for requests in milliseconds */
-    timeout?: number;
-    /** Retry configuration */
-    retry?: {
-        /** Number of retry attempts */
-        attempts: number;
-        /** Delay between retries in milliseconds */
-        delay: number;
-    };
-    /** Whether to use HTTPS */
-    useHttps?: boolean;
-}
-/**
- * Relayer request options
- *
- * @category Advanced
- */
-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";
-}
-/**
- * Relayer error response
- *
- * @category Advanced
- */
-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;
-}
-/**
- * Relayer queue information
- *
- * @category Advanced
- */
-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;
-    };
-}
-/**
- * Relayer transaction status
- *
- * @category Advanced
- */
-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;
-    }>;
-}
-/**
- * Relayer metrics
- *
- * @category Advanced
- */
-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;
-    };
-}
-/**
- * Relayer webhook configuration
- *
- * @category Advanced
- */
-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;
-}
-/**
- * Relayer webhook payload
- *
- * @category Advanced
- */
-interface RelayerWebhookPayload {
-    /** Event type */
-    event: string;
-    /** Event data */
-    data: Record<string, unknown>;
-    /** Timestamp */
-    timestamp: number;
-    /** Webhook ID */
-    webhookId: string;
-    /** Signature for verification */
-    signature: string;
-}
-
-export type { RelayerConfig, RelayerErrorResponse, RelayerMetrics, RelayerQueueInfo, RelayerRequestOptions, RelayerStatus, RelayerStorageResponse, RelayerStoreParams, RelayerSubmitParams, RelayerTransactionResponse, RelayerTransactionStatus, RelayerWebhookConfig, RelayerWebhookPayload };

package/dist/types/storage.d.cts

@@ -1,131 +0,0 @@
-/**
- * Interface for storage providers that handle file upload, download, and management operations.
- *
- * Storage providers abstract different storage backends (IPFS, Google Drive, Pinata, etc.)
- * behind a common interface. The SDK uses these providers to store encrypted user data
- * and permission grants in a decentralized manner.
- *
- * @category Storage
- * @example
- * ```typescript
- * // Implement a custom storage provider
- * class MyStorageProvider implements StorageProvider {
- *   async upload(file: Blob, filename?: string): Promise<StorageUploadResult> {
- *     // Custom upload logic
- *     return { url: 'https://my-storage.com/file.dat', size: file.size };
- *   }
- *
- *   async download(url: string): Promise<Blob> {
- *     // Custom download logic
- *     const response = await fetch(url);
- *     return response.blob();
- *   }
- *
- *   async list(options?: StorageListOptions): Promise<StorageFile[]> {
- *     // Return list of files
- *     return [];
- *   }
- *
- *   async delete(url: string): Promise<void> {
- *     // Delete file implementation
- *   }
- * }
- * ```
- */
-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;
-}
-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>;
-}
-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>;
-}
-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;
-}
-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;
-    };
-}
-declare class StorageError extends Error {
-    readonly code: string;
-    readonly provider: string;
-    constructor(message: string, code: string, provider: string, options?: {
-        cause?: Error;
-    });
-}
-
-export { StorageError, type StorageFile, type StorageListOptions, type StorageProvider, type StorageProviderConfig, type StorageUploadResult };

package/dist/types/transactionResults.d.cts

@@ -1,195 +0,0 @@
-import { Address } from 'viem';
-
-interface BaseTransactionResult {
-    transactionHash: `0x${string}`;
-    blockNumber: bigint;
-    gasUsed: bigint;
-}
-/**
- * Transaction result types for all SDK operations.
- * These interfaces define the structure of data returned by enhanced
- * transaction methods that parse blockchain events automatically.
- */
-/**
- * Result of a successful permission grant operation.
- * Contains data from the PermissionAdded blockchain event.
- */
-interface PermissionGrantResult extends BaseTransactionResult {
-    /** Unique permission ID for this grant */
-    permissionId: bigint;
-    /** Address of the user who granted the permission */
-    user: Address;
-    /** URL where the grant file is stored (IPFS/CDN) */
-    grant: string;
-    /** Array of file IDs covered by this permission */
-    fileIds: readonly bigint[];
-}
-/**
- * Result of a successful permission revocation operation.
- * Contains data from the PermissionRevoked blockchain event.
- */
-interface PermissionRevokeResult extends BaseTransactionResult {
-    /** ID of the permission that was revoked */
-    permissionId: bigint;
-}
-/**
- * Result of a successful server trust operation.
- * Contains data from the ServerTrusted blockchain event.
- */
-interface ServerTrustResult extends BaseTransactionResult {
-    /** Address of the user who trusted the server (from event) */
-    user: Address;
-    /** Numeric ID of the trusted server (from event) */
-    serverId: bigint;
-    /** Address of the trusted server (from params/derived) */
-    serverAddress?: Address;
-    /** URL of the trusted server (from params/provided) */
-    serverUrl?: string;
-}
-/**
- * Result of a successful server untrust operation.
- * Contains data from the ServerUntrusted blockchain event.
- */
-interface ServerUntrustResult extends BaseTransactionResult {
-    /** Address of the user who untrusted the server */
-    user: Address;
-    /** Address/ID of the untrusted server */
-    serverId: Address;
-}
-/**
- * Result of a successful server registration operation.
- * Contains data from the ServerRegistered blockchain event.
- */
-interface ServerRegisterResult extends BaseTransactionResult {
-    /** Unique server ID assigned by the registry */
-    serverId: bigint;
-    /** URL of the registered server */
-    url: string;
-    /** Owner address of the server */
-    owner: Address;
-}
-/**
- * Result of a successful server update operation.
- * Contains data from the ServerUpdated blockchain event.
- */
-interface ServerUpdateResult extends BaseTransactionResult {
-    /** ID of the server that was updated */
-    serverId: bigint;
-    /** New URL of the server */
-    url: string;
-}
-/**
- * Result of a successful grantee registration operation.
- * Contains data from the GranteeRegistered blockchain event.
- */
-interface GranteeRegisterResult extends BaseTransactionResult {
-    /** Unique grantee ID assigned by the registry */
-    granteeId: bigint;
-    /** Address of the registered grantee */
-    granteeAddress: Address;
-    /** Display name of the grantee */
-    name: string;
-}
-/**
- * Result of a successful file addition operation.
- * Contains data from the FileAddedV2 blockchain event.
- */
-interface FileAddedResult extends BaseTransactionResult {
-    /** Unique file ID assigned by the registry */
-    fileId: bigint;
-    /** Address of the file owner */
-    ownerAddress: Address;
-    /** URL where the file is stored */
-    url: string;
-    /** Schema ID associated with the file (0 for no schema) */
-    schemaId: bigint;
-}
-/**
- * Result of a successful schema addition operation.
- * Contains data from the SchemaAdded blockchain event.
- */
-interface SchemaAddedResult extends BaseTransactionResult {
-    /** Unique schema ID assigned by the registry */
-    schemaId: bigint;
-    /** Human-readable name of the schema */
-    name: string;
-    /** Schema dialect (e.g., "jsonschema") */
-    dialect: string;
-    /** URL where the schema definition is stored */
-    definitionUrl: string;
-}
-/**
- * Result of a successful refiner addition operation.
- * Contains data from the RefinerAdded blockchain event.
- */
-interface RefinerAddedResult extends BaseTransactionResult {
-    /** Unique refiner ID assigned by the registry */
-    refinerId: bigint;
-    /** DLP ID this refiner belongs to */
-    dlpId: bigint;
-    /** Human-readable name of the refiner */
-    name: string;
-    /** Schema ID this refiner uses */
-    schemaId: bigint;
-    /** URL where the schema definition is stored */
-    schemaDefinitionUrl: string;
-    /** URL with refiner processing instructions */
-    refinementInstructionUrl: string;
-}
-/**
- * Result of a successful schema ID update operation.
- * Contains data from the RefinerSchemaUpdated blockchain event.
- */
-interface SchemaUpdateResult extends BaseTransactionResult {
-    /** ID of the refiner that was updated */
-    refinerId: bigint;
-    /** New schema ID */
-    schemaId: bigint;
-    /** URL of the new schema definition */
-    schemaDefinitionUrl: string;
-}
-/**
- * Result of a successful file permission addition operation.
- * Contains data from the FilePermissionAdded blockchain event.
- */
-interface FilePermissionResult extends BaseTransactionResult {
-    /** File ID the permission was added to */
-    fileId: bigint;
-    /** Account that was granted permission */
-    account: Address;
-    /** Encrypted key for file access */
-    encryptedKey: string;
-}
-/**
- * Union type of all possible transaction result types.
- * Useful for generic functions that handle multiple operation types.
- */
-type AnyTransactionResult = PermissionGrantResult | PermissionRevokeResult | ServerTrustResult | ServerUntrustResult | ServerRegisterResult | ServerUpdateResult | GranteeRegisterResult | FileAddedResult | SchemaAddedResult | RefinerAddedResult | SchemaUpdateResult | FilePermissionResult;
-/**
- * Maps transaction operation names to their result types.
- * Used for type inference in generic transaction parsing functions.
- */
-interface TransactionResultMap {
-    grant: PermissionGrantResult;
-    revoke: PermissionRevokeResult;
-    revokePermission: PermissionRevokeResult;
-    addServerFilesAndPermissions: PermissionGrantResult;
-    trustServer: ServerTrustResult;
-    untrustServer: ServerUntrustResult;
-    registerServer: ServerRegisterResult;
-    updateServer: ServerUpdateResult;
-    addAndTrustServer: ServerTrustResult;
-    registerGrantee: GranteeRegisterResult;
-    addFile: FileAddedResult;
-    addFileWithPermissionsAndSchema: FileAddedResult;
-    addFileWithSchema: FileAddedResult;
-    addFileWithPermissions: FileAddedResult;
-    addRefinement: RefinerAddedResult;
-    addRefiner: RefinerAddedResult;
-    updateSchemaId: SchemaUpdateResult;
-    addSchema: SchemaAddedResult;
-    updateRefinement: SchemaUpdateResult;
-    addFilePermission: FilePermissionResult;
-}
-
-export type { AnyTransactionResult, FileAddedResult, FilePermissionResult, GranteeRegisterResult, PermissionGrantResult, PermissionRevokeResult, RefinerAddedResult, SchemaAddedResult, SchemaUpdateResult, ServerRegisterResult, ServerTrustResult, ServerUntrustResult, ServerUpdateResult, TransactionResultMap };