@opendatalabs/vana-sdk 0.1.0-alpha.eebb656 → 0.1.0-alpha.ef15099

package/dist/types/generics.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/generics.ts"],"sourcesContent":["import type { Address, Hash } from \"viem\";\n\n/**\n * Generic request pattern for all SDK operations\n *\n * @category Reference\n */\nexport interface GenericRequest<TParams = unknown, TOptions = unknown> {\n  /** Request parameters */\n  params: TParams;\n  /** Additional request options */\n  options?: TOptions;\n}\n\n/**\n * Generic response pattern for all SDK operations\n *\n * @category Reference\n */\nexport interface GenericResponse<TData = unknown, TMeta = unknown> {\n  /** Response data */\n  data: TData;\n  /** Response metadata */\n  meta?: TMeta;\n  /** Success status */\n  success: boolean;\n  /** Error information if not successful */\n  error?: {\n    code: string;\n    message: string;\n    details?: unknown;\n  };\n}\n\n/**\n * Generic async operation result\n *\n * @category Reference\n */\nexport interface AsyncResult<T> {\n  /** Operation result */\n  result: T;\n  /** Transaction hash if applicable */\n  transactionHash?: Hash;\n  /** Block number if applicable */\n  blockNumber?: bigint;\n  /** Gas used if applicable */\n  gasUsed?: bigint;\n}\n\n/**\n * Generic contract interaction parameters\n *\n * @category Reference\n */\nexport interface ContractCall<\n  TArgs extends readonly unknown[] = readonly unknown[],\n> {\n  /** Contract method name */\n  method: string;\n  /** Method arguments */\n  args: TArgs;\n  /** Call options */\n  options?: {\n    /** Gas limit */\n    gasLimit?: bigint;\n    /** Gas price */\n    gasPrice?: bigint;\n    /** Value to send */\n    value?: bigint;\n  };\n}\n\n/**\n * Generic contract event filter\n *\n * @category Reference\n */\nexport interface EventFilter<TEventArgs = unknown> {\n  /** Event name */\n  event: string;\n  /** Event arguments filter */\n  args?: TEventArgs;\n  /** From block */\n  fromBlock?: bigint;\n  /** To block */\n  toBlock?: bigint;\n  /** Address filter */\n  address?: Address | Address[];\n}\n\n/**\n * Generic event log\n *\n * @category Reference\n */\nexport interface EventLog<TArgs = unknown> {\n  /** Event name */\n  event: string;\n  /** Event arguments */\n  args: TArgs;\n  /** Block number */\n  blockNumber: bigint;\n  /** Transaction hash */\n  transactionHash: Hash;\n  /** Log index */\n  logIndex: number;\n  /** Transaction index */\n  transactionIndex: number;\n  /** Contract address */\n  address: Address;\n}\n\n/**\n * Generic controller context for dependency injection\n *\n * @category Reference\n */\nexport interface ControllerContext<TClient = unknown, TConfig = unknown> {\n  /** Client instance */\n  client: TClient;\n  /** Configuration */\n  config?: TConfig;\n  /** Additional context */\n  [key: string]: unknown;\n}\n\n/**\n * Generic controller interface\n *\n * @category Reference\n */\nexport interface Controller<TContext = unknown> {\n  /** Controller context */\n  readonly context: TContext;\n}\n\n/**\n * Generic storage provider interface\n *\n * @category Reference\n */\nexport interface StorageProvider<TConfig = unknown, TOptions = unknown> {\n  /** Provider name */\n  readonly name: string;\n  /** Provider configuration */\n  readonly config: TConfig;\n\n  /** Upload data */\n  upload(\n    data: Uint8Array,\n    options?: TOptions,\n  ): Promise<{\n    url: string;\n    size: number;\n    checksum?: string;\n  }>;\n\n  /** Download data */\n  download(\n    url: string,\n    options?: TOptions,\n  ): Promise<{\n    data: Uint8Array;\n    size: number;\n    checksum?: string;\n  }>;\n\n  /** Delete data */\n  delete?(url: string, options?: TOptions): Promise<boolean>;\n\n  /** Check if data exists */\n  exists?(url: string, options?: TOptions): Promise<boolean>;\n}\n\n/**\n * Generic cache interface\n *\n * @category Reference\n */\nexport interface Cache<TKey = string, TValue = unknown> {\n  /** Get value from cache */\n  get(key: TKey): Promise<TValue | undefined>;\n\n  /** Set value in cache */\n  set(key: TKey, value: TValue, ttl?: number): Promise<void>;\n\n  /** Delete value from cache */\n  delete(key: TKey): Promise<boolean>;\n\n  /** Clear all cache */\n  clear(): Promise<void>;\n\n  /** Check if key exists */\n  has(key: TKey): Promise<boolean>;\n}\n\n/**\n * Generic retry configuration\n *\n * @category Reference\n */\nexport interface RetryConfig<TError = Error> {\n  /** Maximum retry attempts */\n  maxAttempts: number;\n  /** Base delay in milliseconds */\n  baseDelay: number;\n  /** Backoff multiplier */\n  backoffMultiplier?: number;\n  /** Maximum delay */\n  maxDelay?: number;\n  /** Jitter factor */\n  jitter?: number;\n  /** Retry condition */\n  shouldRetry?: (error: TError, attempt: number) => boolean;\n}\n\n/**\n * Generic rate limiter configuration\n *\n * @category Reference\n */\nexport interface RateLimiterConfig {\n  /** Requests per time window */\n  requestsPerWindow: number;\n  /** Time window in milliseconds */\n  windowMs: number;\n  /** Burst allowance */\n  burstLimit?: number;\n}\n\n/**\n * Generic middleware interface\n *\n * @category Reference\n */\nexport interface Middleware<TRequest = unknown, TResponse = unknown> {\n  /** Middleware name */\n  readonly name: string;\n\n  /** Process request */\n  request?(req: TRequest): Promise<TRequest>;\n\n  /** Process response */\n  response?(res: TResponse): Promise<TResponse>;\n\n  /** Handle errors */\n  error?(error: Error, req: TRequest): Promise<TResponse | void>;\n}\n\n/**\n * Generic plugin interface\n *\n * @category Reference\n */\nexport interface Plugin<TConfig = unknown> {\n  /** Plugin name */\n  readonly name: string;\n  /** Plugin version */\n  readonly version: string;\n  /** Plugin configuration */\n  readonly config: TConfig;\n\n  /** Initialize plugin */\n  init?(): Promise<void>;\n\n  /** Cleanup plugin */\n  cleanup?(): Promise<void>;\n}\n\n/**\n * Generic factory interface\n *\n * @category Reference\n */\nexport interface Factory<T, TParams = unknown> {\n  /** Create instance */\n  create(params: TParams): T;\n\n  /** Create multiple instances */\n  createMany?(params: TParams[]): T[];\n\n  /** Validate parameters */\n  validate?(params: TParams): boolean;\n}\n\n/**\n * Generic repository interface for data access\n *\n * @category Reference\n */\nexport interface Repository<TEntity, TKey = string | number> {\n  /** Find by ID */\n  findById(id: TKey): Promise<TEntity | undefined>;\n\n  /** Find all entities */\n  findAll(options?: {\n    limit?: number;\n    offset?: number;\n    filter?: Partial<TEntity>;\n    sort?: Array<{ field: keyof TEntity; direction: \"asc\" | \"desc\" }>;\n  }): Promise<{\n    entities: TEntity[];\n    total: number;\n    hasMore: boolean;\n  }>;\n\n  /** Create entity */\n  create(entity: Omit<TEntity, \"id\">): Promise<TEntity>;\n\n  /** Update entity */\n  update(id: TKey, updates: Partial<TEntity>): Promise<TEntity>;\n\n  /** Delete entity */\n  delete(id: TKey): Promise<boolean>;\n\n  /** Check if entity exists */\n  exists(id: TKey): Promise<boolean>;\n}\n\n/**\n * Generic validator interface\n *\n * @category Reference\n */\nexport interface Validator<T> {\n  /** Validate value */\n  validate(value: unknown): value is T;\n\n  /** Get validation errors */\n  getErrors?(value: unknown): string[];\n\n  /** Get validation schema */\n  getSchema?(): unknown;\n}\n\n/**\n * Generic transformer interface\n *\n * @category Reference\n */\nexport interface Transformer<TInput, TOutput> {\n  /** Transform input to output */\n  transform(input: TInput): TOutput | Promise<TOutput>;\n\n  /** Reverse transform output to input */\n  reverse?(output: TOutput): TInput | Promise<TInput>;\n}\n\n/**\n * Generic service interface\n *\n * @category Reference\n */\nexport interface Service<TConfig = unknown> {\n  /** Service name */\n  readonly name: string;\n  /** Service configuration */\n  readonly config: TConfig;\n  /** Service status */\n  readonly status:\n    | \"idle\"\n    | \"starting\"\n    | \"running\"\n    | \"stopping\"\n    | \"stopped\"\n    | \"error\";\n\n  /** Start service */\n  start(): Promise<void>;\n\n  /** Stop service */\n  stop(): Promise<void>;\n\n  /** Restart service */\n  restart?(): Promise<void>;\n\n  /** Get health status */\n  getHealth?(): Promise<{\n    healthy: boolean;\n    details?: Record<string, unknown>;\n  }>;\n}\n\n/**\n * Generic observer pattern\n *\n * @category Reference\n */\nexport interface Observer<TEvent = unknown> {\n  /** Handle event */\n  notify(event: TEvent): void | Promise<void>;\n}\n\n/**\n * Generic observable pattern\n *\n * @category Reference\n */\nexport interface Observable<TEvent = unknown> {\n  /** Subscribe to events */\n  subscribe(observer: Observer<TEvent>): () => void;\n\n  /** Unsubscribe from events */\n  unsubscribe(observer: Observer<TEvent>): void;\n\n  /** Emit event */\n  emit(event: TEvent): void;\n}\n\n/**\n * Generic state machine interface\n *\n * @category Reference\n */\nexport interface StateMachine<TState, TEvent> {\n  /** Current state */\n  readonly currentState: TState;\n\n  /** Transition to new state */\n  transition(event: TEvent): TState;\n\n  /** Check if transition is valid */\n  canTransition(event: TEvent): boolean;\n\n  /** Get available transitions */\n  getAvailableTransitions(): TEvent[];\n}\n\n/**\n * Helper type to make properties optional conditionally\n *\n * @category Reference\n */\nexport type ConditionalOptional<\n  T,\n  K extends keyof T,\n  Condition extends boolean,\n> = Condition extends true ? Omit<T, K> & Partial<Pick<T, K>> : T;\n\n/**\n * Helper type to extract promise result type\n *\n * @category Reference\n */\nexport type PromiseResult<T> = T extends Promise<infer U> ? U : T;\n\n/**\n * Helper type to create a union of all possible keys\n *\n * @category Reference\n */\nexport type AllKeys<T> = T extends unknown ? keyof T : never;\n\n/**\n * Helper type to create a deep partial type\n *\n * @category Reference\n */\nexport type DeepPartial<T> = {\n  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];\n};\n\n/**\n * Helper type to create a deep readonly type\n *\n * @category Reference\n */\nexport type DeepReadonly<T> = {\n  readonly [P in keyof T]: T[P] extends object ? DeepReadonly<T[P]> : T[P];\n};\n\n/**\n * Helper type to create a required type with specific keys\n *\n * @category Reference\n */\nexport type RequireKeys<T, K extends keyof T> = Required<Pick<T, K>> &\n  Omit<T, K>;\n\n/**\n * Helper type to create an optional type with specific keys\n *\n * @category Reference\n */\nexport type OptionalKeys<T, K extends keyof T> = Partial<Pick<T, K>> &\n  Omit<T, K>;\n\n/**\n * Helper type to exclude null and undefined\n *\n * @category Reference\n */\nexport type NonNullable<T> = T extends null | undefined ? never : T;\n\n/**\n * Helper type to create a type with only specific keys\n *\n * @category Reference\n */\nexport type PickByType<T, U> = {\n  [K in keyof T as T[K] extends U ? K : never]: T[K];\n};\n\n/**\n * Helper type to omit keys by type\n *\n * @category Reference\n */\nexport type OmitByType<T, U> = {\n  [K in keyof T as T[K] extends U ? never : K]: T[K];\n};\n\n/**\n * Helper type for branded types\n *\n * @category Reference\n */\nexport type Brand<T, B> = T & { readonly __brand: B };\n\n/**\n * Helper type for nominal types\n *\n * @category Reference\n */\nexport type Nominal<T, N extends string> = T & { readonly __nominal: N };\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/generics.ts"],"sourcesContent":["/**\n * Defines generic types and interfaces for SDK infrastructure.\n *\n * @remarks\n * This module provides reusable type definitions and interfaces that form\n * the foundation of the SDK's architecture. It includes patterns for requests,\n * responses, caching, middleware, repositories, and other common software\n * engineering abstractions.\n *\n * @category Types\n * @module types/generics\n */\n\nimport type { Address, Hash } from \"viem\";\n\n/**\n * Represents a standardized request structure for SDK operations.\n *\n * @remarks\n * Provides consistent request handling across all SDK methods with\n * typed parameters and optional configuration.\n *\n * @typeParam TParams - Type of request parameters\n * @typeParam TOptions - Type of optional configuration\n *\n * @category Reference\n */\nexport interface GenericRequest<TParams = unknown, TOptions = unknown> {\n  /** Request parameters */\n  params: TParams;\n  /** Additional request options */\n  options?: TOptions;\n}\n\n/**\n * Represents a standardized response structure for SDK operations.\n *\n * @remarks\n * Provides consistent response handling with success/error states\n * and optional metadata for additional context.\n *\n * @typeParam TData - Type of response data\n * @typeParam TMeta - Type of response metadata\n *\n * @category Reference\n */\nexport interface GenericResponse<TData = unknown, TMeta = unknown> {\n  /** Response data */\n  data: TData;\n  /** Response metadata */\n  meta?: TMeta;\n  /** Success status */\n  success: boolean;\n  /** Error information if not successful */\n  error?: {\n    code: string;\n    message: string;\n    details?: unknown;\n  };\n}\n\n/**\n * Represents the result of an asynchronous blockchain operation.\n *\n * @remarks\n * Includes transaction details when the operation involves\n * blockchain state changes.\n *\n * @typeParam T - Type of the operation result\n *\n * @category Reference\n */\nexport interface AsyncResult<T> {\n  /** Operation result */\n  result: T;\n  /** Transaction hash if applicable */\n  transactionHash?: Hash;\n  /** Block number if applicable */\n  blockNumber?: bigint;\n  /** Gas used if applicable */\n  gasUsed?: bigint;\n}\n\n/**\n * Generic contract interaction parameters\n *\n * @category Reference\n */\nexport interface ContractCall<\n  TArgs extends readonly unknown[] = readonly unknown[],\n> {\n  /** Contract method name */\n  method: string;\n  /** Method arguments */\n  args: TArgs;\n  /** Call options */\n  options?: {\n    /** Gas limit */\n    gas?: bigint;\n    /** Gas price */\n    gasPrice?: bigint;\n    /** Value to send */\n    value?: bigint;\n  };\n}\n\n/**\n * Generic contract event filter\n *\n * @category Reference\n */\nexport interface EventFilter<TEventArgs = unknown> {\n  /** Event name */\n  event: string;\n  /** Event arguments filter */\n  args?: TEventArgs;\n  /** From block */\n  fromBlock?: bigint;\n  /** To block */\n  toBlock?: bigint;\n  /** Address filter */\n  address?: Address | Address[];\n}\n\n/**\n * Generic event log\n *\n * @category Reference\n */\nexport interface EventLog<TArgs = unknown> {\n  /** Event name */\n  event: string;\n  /** Event arguments */\n  args: TArgs;\n  /** Block number */\n  blockNumber: bigint;\n  /** Transaction hash */\n  transactionHash: Hash;\n  /** Log index */\n  logIndex: number;\n  /** Transaction index */\n  transactionIndex: number;\n  /** Contract address */\n  address: Address;\n}\n\n/**\n * Generic controller context for dependency injection\n *\n * @category Reference\n */\nexport interface ControllerContext<TClient = unknown, TConfig = unknown> {\n  /** Client instance */\n  client: TClient;\n  /** Configuration */\n  config?: TConfig;\n  /** Additional context */\n  [key: string]: unknown;\n}\n\n/**\n * Generic controller interface\n *\n * @category Reference\n */\nexport interface Controller<TContext = unknown> {\n  /** Controller context */\n  readonly context: TContext;\n}\n\n/**\n * Generic storage provider interface\n *\n * @category Reference\n */\nexport interface StorageProvider<TConfig = unknown, TOptions = unknown> {\n  /** Provider name */\n  readonly name: string;\n  /** Provider configuration */\n  readonly config: TConfig;\n\n  /** Upload data */\n  upload(\n    data: Uint8Array,\n    options?: TOptions,\n  ): Promise<{\n    url: string;\n    size: number;\n    checksum?: string;\n  }>;\n\n  /** Download data */\n  download(\n    url: string,\n    options?: TOptions,\n  ): Promise<{\n    data: Uint8Array;\n    size: number;\n    checksum?: string;\n  }>;\n\n  /** Delete data */\n  delete?(url: string, options?: TOptions): Promise<boolean>;\n\n  /** Check if data exists */\n  exists?(url: string, options?: TOptions): Promise<boolean>;\n}\n\n/**\n * Defines a generic caching interface with TTL support.\n *\n * @remarks\n * Provides standard cache operations for performance optimization\n * and reducing redundant computations or network requests.\n *\n * @typeParam TKey - Type of cache keys\n * @typeParam TValue - Type of cached values\n *\n * @category Reference\n */\nexport interface Cache<TKey = string, TValue = unknown> {\n  /** Get value from cache */\n  get(key: TKey): Promise<TValue | undefined>;\n\n  /** Set value in cache */\n  set(key: TKey, value: TValue, ttl?: number): Promise<void>;\n\n  /** Delete value from cache */\n  delete(key: TKey): Promise<boolean>;\n\n  /** Clear all cache */\n  clear(): Promise<void>;\n\n  /** Check if key exists */\n  has(key: TKey): Promise<boolean>;\n}\n\n/**\n * Configures retry behavior for resilient operations.\n *\n * @remarks\n * Supports exponential backoff, jitter, and custom retry conditions\n * for handling transient failures gracefully.\n *\n * @typeParam TError - Type of errors to handle\n *\n * @category Reference\n */\nexport interface RetryConfig<TError = Error> {\n  /** Maximum retry attempts */\n  maxAttempts: number;\n  /** Base delay in milliseconds */\n  baseDelay: number;\n  /** Backoff multiplier */\n  backoffMultiplier?: number;\n  /** Maximum delay */\n  maxDelay?: number;\n  /** Jitter factor */\n  jitter?: number;\n  /** Retry condition */\n  shouldRetry?: (error: TError, attempt: number) => boolean;\n}\n\n/**\n * Generic rate limiter configuration\n *\n * @category Reference\n */\nexport interface RateLimiterConfig {\n  /** Requests per time window */\n  requestsPerWindow: number;\n  /** Time window in milliseconds */\n  windowMs: number;\n  /** Burst allowance */\n  burstLimit?: number;\n}\n\n/**\n * Defines middleware for request/response processing pipelines.\n *\n * @remarks\n * Middleware can transform requests, responses, and handle errors\n * in a composable chain of responsibility pattern.\n *\n * @typeParam TRequest - Type of requests to process\n * @typeParam TResponse - Type of responses to process\n *\n * @category Reference\n */\nexport interface Middleware<TRequest = unknown, TResponse = unknown> {\n  /** Middleware name */\n  readonly name: string;\n\n  /** Process request */\n  request?(req: TRequest): Promise<TRequest>;\n\n  /** Process response */\n  response?(res: TResponse): Promise<TResponse>;\n\n  /** Handle errors */\n  error?(error: Error, req: TRequest): Promise<TResponse | void>;\n}\n\n/**\n * Generic plugin interface\n *\n * @category Reference\n */\nexport interface Plugin<TConfig = unknown> {\n  /** Plugin name */\n  readonly name: string;\n  /** Plugin version */\n  readonly version: string;\n  /** Plugin configuration */\n  readonly config: TConfig;\n\n  /** Initialize plugin */\n  init?(): Promise<void>;\n\n  /** Cleanup plugin */\n  cleanup?(): Promise<void>;\n}\n\n/**\n * Generic factory interface\n *\n * @category Reference\n */\nexport interface Factory<T, TParams = unknown> {\n  /** Create instance */\n  create(params: TParams): T;\n\n  /** Create multiple instances */\n  createMany?(params: TParams[]): T[];\n\n  /** Validate parameters */\n  validate?(params: TParams): boolean;\n}\n\n/**\n * Defines a repository pattern for data access abstraction.\n *\n * @remarks\n * Provides CRUD operations with filtering, sorting, and pagination\n * for consistent data access across different storage backends.\n *\n * @typeParam TEntity - Type of entities managed by the repository\n * @typeParam TKey - Type of entity identifiers\n *\n * @category Reference\n */\nexport interface Repository<TEntity, TKey = string | number> {\n  /** Find by ID */\n  findById(id: TKey): Promise<TEntity | undefined>;\n\n  /** Find all entities */\n  findAll(options?: {\n    limit?: number;\n    offset?: number;\n    filter?: Partial<TEntity>;\n    sort?: Array<{ field: keyof TEntity; direction: \"asc\" | \"desc\" }>;\n  }): Promise<{\n    entities: TEntity[];\n    total: number;\n    hasMore: boolean;\n  }>;\n\n  /** Create entity */\n  create(entity: Omit<TEntity, \"id\">): Promise<TEntity>;\n\n  /** Update entity */\n  update(id: TKey, updates: Partial<TEntity>): Promise<TEntity>;\n\n  /** Delete entity */\n  delete(id: TKey): Promise<boolean>;\n\n  /** Check if entity exists */\n  exists(id: TKey): Promise<boolean>;\n}\n\n/**\n * Generic validator interface\n *\n * @category Reference\n */\nexport interface Validator<T> {\n  /** Validate value */\n  validate(value: unknown): value is T;\n\n  /** Get validation errors */\n  getErrors?(value: unknown): string[];\n\n  /** Get validation schema */\n  getSchema?(): unknown;\n}\n\n/**\n * Generic transformer interface\n *\n * @category Reference\n */\nexport interface Transformer<TInput, TOutput> {\n  /** Transform input to output */\n  transform(input: TInput): TOutput | Promise<TOutput>;\n\n  /** Reverse transform output to input */\n  reverse?(output: TOutput): TInput | Promise<TInput>;\n}\n\n/**\n * Generic service interface\n *\n * @category Reference\n */\nexport interface Service<TConfig = unknown> {\n  /** Service name */\n  readonly name: string;\n  /** Service configuration */\n  readonly config: TConfig;\n  /** Service status */\n  readonly status:\n    | \"idle\"\n    | \"starting\"\n    | \"running\"\n    | \"stopping\"\n    | \"stopped\"\n    | \"error\";\n\n  /** Start service */\n  start(): Promise<void>;\n\n  /** Stop service */\n  stop(): Promise<void>;\n\n  /** Restart service */\n  restart?(): Promise<void>;\n\n  /** Get health status */\n  getHealth?(): Promise<{\n    healthy: boolean;\n    details?: Record<string, unknown>;\n  }>;\n}\n\n/**\n * Implements the observer in the observer pattern.\n *\n * @remarks\n * Receives notifications about events from observable subjects\n * for decoupled event handling.\n *\n * @typeParam TEvent - Type of events to observe\n *\n * @category Reference\n */\nexport interface Observer<TEvent = unknown> {\n  /** Handle event */\n  notify(event: TEvent): void | Promise<void>;\n}\n\n/**\n * Implements the subject in the observer pattern.\n *\n * @remarks\n * Manages observers and emits events to all subscribed observers\n * for event-driven architectures.\n *\n * @typeParam TEvent - Type of events to emit\n *\n * @category Reference\n */\nexport interface Observable<TEvent = unknown> {\n  /** Subscribe to events */\n  subscribe(observer: Observer<TEvent>): () => void;\n\n  /** Unsubscribe from events */\n  unsubscribe(observer: Observer<TEvent>): void;\n\n  /** Emit event */\n  emit(event: TEvent): void;\n}\n\n/**\n * Generic state machine interface\n *\n * @category Reference\n */\nexport interface StateMachine<TState, TEvent> {\n  /** Current state */\n  readonly currentState: TState;\n\n  /** Transition to new state */\n  transition(event: TEvent): TState;\n\n  /** Check if transition is valid */\n  canTransition(event: TEvent): boolean;\n\n  /** Get available transitions */\n  getAvailableTransitions(): TEvent[];\n}\n\n/**\n * Helper type to make properties optional conditionally\n *\n * @category Reference\n */\nexport type ConditionalOptional<\n  T,\n  K extends keyof T,\n  Condition extends boolean,\n> = Condition extends true ? Omit<T, K> & Partial<Pick<T, K>> : T;\n\n/**\n * Helper type to extract promise result type\n *\n * @category Reference\n */\nexport type PromiseResult<T> = T extends Promise<infer U> ? U : T;\n\n/**\n * Helper type to create a union of all possible keys\n *\n * @category Reference\n */\nexport type AllKeys<T> = T extends unknown ? keyof T : never;\n\n/**\n * Helper type to create a deep partial type\n *\n * @category Reference\n */\nexport type DeepPartial<T> = {\n  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];\n};\n\n/**\n * Helper type to create a deep readonly type\n *\n * @category Reference\n */\nexport type DeepReadonly<T> = {\n  readonly [P in keyof T]: T[P] extends object ? DeepReadonly<T[P]> : T[P];\n};\n\n/**\n * Helper type to create a required type with specific keys\n *\n * @category Reference\n */\nexport type RequireKeys<T, K extends keyof T> = Required<Pick<T, K>> &\n  Omit<T, K>;\n\n/**\n * Helper type to create an optional type with specific keys\n *\n * @category Reference\n */\nexport type OptionalKeys<T, K extends keyof T> = Partial<Pick<T, K>> &\n  Omit<T, K>;\n\n/**\n * Helper type to exclude null and undefined\n *\n * @category Reference\n */\nexport type NonNullable<T> = T extends null | undefined ? never : T;\n\n/**\n * Helper type to create a type with only specific keys\n *\n * @category Reference\n */\nexport type PickByType<T, U> = {\n  [K in keyof T as T[K] extends U ? K : never]: T[K];\n};\n\n/**\n * Helper type to omit keys by type\n *\n * @category Reference\n */\nexport type OmitByType<T, U> = {\n  [K in keyof T as T[K] extends U ? never : K]: T[K];\n};\n\n/**\n * Helper type for branded types\n *\n * @category Reference\n */\nexport type Brand<T, B> = T & { readonly __brand: B };\n\n/**\n * Helper type for nominal types\n *\n * @category Reference\n */\nexport type Nominal<T, N extends string> = T & { readonly __nominal: N };\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/generics.d.ts

@@ -1,6 +1,25 @@
+/**
+ * Defines generic types and interfaces for SDK infrastructure.
+ *
+ * @remarks
+ * This module provides reusable type definitions and interfaces that form
+ * the foundation of the SDK's architecture. It includes patterns for requests,
+ * responses, caching, middleware, repositories, and other common software
+ * engineering abstractions.
+ *
+ * @category Types
+ * @module types/generics
+ */
 import type { Address, Hash } from "viem";
 /**
- * Generic request pattern for all SDK operations
+ * Represents a standardized request structure for SDK operations.
+ *
+ * @remarks
+ * Provides consistent request handling across all SDK methods with
+ * typed parameters and optional configuration.
+ *
+ * @typeParam TParams - Type of request parameters
+ * @typeParam TOptions - Type of optional configuration
  *
  * @category Reference
  */
@@ -11,7 +30,14 @@ export interface GenericRequest<TParams = unknown, TOptions = unknown> {
     options?: TOptions;
 }
 /**
- * Generic response pattern for all SDK operations
+ * Represents a standardized response structure for SDK operations.
+ *
+ * @remarks
+ * Provides consistent response handling with success/error states
+ * and optional metadata for additional context.
+ *
+ * @typeParam TData - Type of response data
+ * @typeParam TMeta - Type of response metadata
  *
  * @category Reference
  */
@@ -30,7 +56,13 @@ export interface GenericResponse<TData = unknown, TMeta = unknown> {
     };
 }
 /**
- * Generic async operation result
+ * Represents the result of an asynchronous blockchain operation.
+ *
+ * @remarks
+ * Includes transaction details when the operation involves
+ * blockchain state changes.
+ *
+ * @typeParam T - Type of the operation result
  *
  * @category Reference
  */
@@ -57,7 +89,7 @@ export interface ContractCall<TArgs extends readonly unknown[] = readonly unknow
     /** Call options */
     options?: {
         /** Gas limit */
-        gasLimit?: bigint;
+        gas?: bigint;
         /** Gas price */
         gasPrice?: bigint;
         /** Value to send */
@@ -152,7 +184,14 @@ export interface StorageProvider<TConfig = unknown, TOptions = unknown> {
     exists?(url: string, options?: TOptions): Promise<boolean>;
 }
 /**
- * Generic cache interface
+ * Defines a generic caching interface with TTL support.
+ *
+ * @remarks
+ * Provides standard cache operations for performance optimization
+ * and reducing redundant computations or network requests.
+ *
+ * @typeParam TKey - Type of cache keys
+ * @typeParam TValue - Type of cached values
  *
  * @category Reference
  */
@@ -169,7 +208,13 @@ export interface Cache<TKey = string, TValue = unknown> {
     has(key: TKey): Promise<boolean>;
 }
 /**
- * Generic retry configuration
+ * Configures retry behavior for resilient operations.
+ *
+ * @remarks
+ * Supports exponential backoff, jitter, and custom retry conditions
+ * for handling transient failures gracefully.
+ *
+ * @typeParam TError - Type of errors to handle
  *
  * @category Reference
  */
@@ -201,7 +246,14 @@ export interface RateLimiterConfig {
     burstLimit?: number;
 }
 /**
- * Generic middleware interface
+ * Defines middleware for request/response processing pipelines.
+ *
+ * @remarks
+ * Middleware can transform requests, responses, and handle errors
+ * in a composable chain of responsibility pattern.
+ *
+ * @typeParam TRequest - Type of requests to process
+ * @typeParam TResponse - Type of responses to process
  *
  * @category Reference
  */
@@ -246,7 +298,14 @@ export interface Factory<T, TParams = unknown> {
     validate?(params: TParams): boolean;
 }
 /**
- * Generic repository interface for data access
+ * Defines a repository pattern for data access abstraction.
+ *
+ * @remarks
+ * Provides CRUD operations with filtering, sorting, and pagination
+ * for consistent data access across different storage backends.
+ *
+ * @typeParam TEntity - Type of entities managed by the repository
+ * @typeParam TKey - Type of entity identifiers
  *
  * @category Reference
  */
@@ -325,7 +384,13 @@ export interface Service<TConfig = unknown> {
     }>;
 }
 /**
- * Generic observer pattern
+ * Implements the observer in the observer pattern.
+ *
+ * @remarks
+ * Receives notifications about events from observable subjects
+ * for decoupled event handling.
+ *
+ * @typeParam TEvent - Type of events to observe
  *
  * @category Reference
  */
@@ -334,7 +399,13 @@ export interface Observer<TEvent = unknown> {
     notify(event: TEvent): void | Promise<void>;
 }
 /**
- * Generic observable pattern
+ * Implements the subject in the observer pattern.
+ *
+ * @remarks
+ * Manages observers and emits events to all subscribed observers
+ * for event-driven architectures.
+ *
+ * @typeParam TEvent - Type of events to emit
  *
  * @category Reference
  */

package/dist/types/index.cjs

@@ -24,7 +24,9 @@ __export(types_exports, {
   fetchAndValidateSchema: () => import_schemaValidation.fetchAndValidateSchema,
   hasStorageConfig: () => import_config.hasStorageConfig,
   isAPIResponse: () => import_external_apis.isAPIResponse,
+  isAddressOnlyConfig: () => import_config.isAddressOnlyConfig,
   isChainConfig: () => import_config.isChainConfig,
+  isReadOnlyConfig: () => import_config.isReadOnlyConfig,
   isReplicateAPIResponse: () => import_external_apis.isReplicateAPIResponse,
   isVanaChain: () => import_chains.isVanaChain,
   isVanaChainId: () => import_chains.isVanaChainId,
@@ -48,7 +50,9 @@ var import_external_apis = require("./external-apis");
   fetchAndValidateSchema,
   hasStorageConfig,
   isAPIResponse,
+  isAddressOnlyConfig,
   isChainConfig,
+  isReadOnlyConfig,
   isReplicateAPIResponse,
   isVanaChain,
   isVanaChainId,

package/dist/types/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["// Configuration types\nexport type {\n  BaseConfig,\n  BaseConfigWithStorage,\n  WalletConfig,\n  WalletConfigWithStorage,\n  ChainConfig,\n  ChainConfigWithStorage,\n  VanaConfig,\n  VanaConfigWithStorage,\n  RuntimeConfig,\n  StorageConfig,\n  ConfigValidationOptions,\n  ConfigValidationResult,\n  RelayerCallbacks,\n  DownloadRelayerCallbacks,\n  StorageRequiredMarker,\n} from \"./config\";\n\nexport { isWalletConfig, isChainConfig, hasStorageConfig } from \"./config\";\n\n// Chain types\nexport type { VanaChainId, VanaChain } from \"./chains\";\n\nexport { isVanaChainId, isVanaChain } from \"./chains\";\n\n// Contract types\nexport type {\n  VanaContractName,\n  ContractInfo,\n  ContractDeployment,\n  VanaContractInstance,\n  ContractAddresses,\n  ContractMethodParams,\n  ContractMethodReturnType,\n} from \"./contracts\";\n\n// Note: VanaContract and ContractAbis are exported directly from src/index.ts\n// to avoid circular dependencies. Do not re-export them here.\n\n// Storage types\nexport type {\n  StorageProvider,\n  StorageUploadResult,\n  StorageFile,\n  StorageListOptions,\n  StorageProviderConfig,\n} from \"./storage\";\n\nexport { StorageError } from \"./storage\";\n\n// Data types\nexport type {\n  UserFile,\n  FileMetadata,\n  UploadParams,\n  FilePermissionParams,\n  LegacyPermissionParams,\n  EncryptedUploadParams,\n  UnencryptedUploadParams,\n  UploadResult,\n  UploadFileParams,\n  UploadFileResult,\n  UploadEncryptedFileResult,\n  EncryptionInfo,\n  GetUserFilesParams,\n  GetFileParams,\n  DownloadFileParams,\n  DownloadFileResult,\n  DeleteFileParams,\n  DeleteFileResult,\n  FileAccessPermissions,\n  FileSharingConfig,\n  BatchUploadParams,\n  BatchUploadResult,\n  SchemaMetadata,\n  CompleteSchema,\n  Schema,\n  Refiner,\n  AddSchemaParams,\n  AddSchemaResult,\n  AddRefinerParams,\n  AddRefinerResult,\n  UpdateSchemaIdParams,\n  UpdateSchemaIdResult,\n  TrustedServer,\n  GetUserTrustedServersParams,\n} from \"./data\";\n\n// Schema types\nexport type {\n  CreateSchemaParams,\n  CreateSchemaResult,\n} from \"../controllers/schemas\";\n\n// Schema validation types\nexport type { DataSchema } from \"../utils/schemaValidation\";\nexport {\n  SchemaValidationError,\n  SchemaValidator,\n  validateDataSchemaAgainstMetaSchema,\n  validateDataAgainstSchema,\n  fetchAndValidateSchema,\n} from \"../utils/schemaValidation\";\n\n// Permission types\nexport type {\n  OnChainPermissionGrant,\n  GetUserPermissionsOptions,\n  GrantPermissionParams,\n  RevokePermissionParams,\n  CheckPermissionParams,\n  PermissionCheckResult,\n  PermissionGrantDomain,\n  PermissionGrantMessage,\n  PermissionInputMessage,\n  SimplifiedPermissionMessage,\n  GrantFile,\n  PermissionGrantTypedData,\n  RevokePermissionTypedData,\n  GenericTypedData,\n  TypedDataPrimaryType,\n  SpecificTypedData,\n  PermissionOperation,\n  PermissionStatus,\n  QueryPermissionsParams,\n  PermissionQueryResult,\n  PermissionAnalytics,\n  PermissionEvent,\n  GrantedPermission,\n  Server,\n  AddAndTrustServerParams,\n  TrustServerParams,\n  UntrustServerParams,\n  AddAndTrustServerInput,\n  TrustServerInput,\n  UntrustServerInput,\n  AddAndTrustServerTypedData,\n  TrustServerTypedData,\n  UntrustServerTypedData,\n  PermissionInfo,\n  RevokePermissionInput,\n  TrustedServerInfo,\n  PaginatedTrustedServers,\n  TrustedServerQueryOptions,\n  BatchServerInfoResult,\n  ServerTrustStatus,\n  ServerInfo,\n  Grantee,\n  GranteeInfo,\n  RegisterGranteeParams,\n  RegisterGranteeInput,\n  RegisterGranteeTypedData,\n  GranteeQueryOptions,\n  PaginatedGrantees,\n  ServerFilesAndPermissionParams,\n  ServerFilesAndPermissionTypedData,\n  Permission,\n} from \"./permissions\";\n\n// Personal server types\nexport type {\n  PostRequestParams,\n  CreateOperationParams,\n  InitPersonalServerParams,\n  PersonalServerIdentity,\n} from \"./personal\";\n\n// Server API types (auto-generated via fetch-server-types.ts)\nexport type * from \"../generated/server/server-exports\";\n\n// External API types\nexport type {\n  ReplicateAPIResponse,\n  ReplicateStatus,\n  PinataUploadResponse,\n  PinataPin,\n  PinataListResponse,\n  APIResponse,\n} from \"./external-apis\";\n\nexport {\n  isReplicateAPIResponse,\n  isAPIResponse,\n  safeParseJSON,\n  parseReplicateOutput,\n} from \"./external-apis\";\n\n// Relayer types\nexport type {\n  RelayerStorageResponse,\n  RelayerTransactionResponse,\n  RelayerStoreParams,\n  RelayerSubmitParams,\n  RelayerStatus,\n  RelayerConfig,\n  RelayerRequestOptions,\n  RelayerErrorResponse,\n  RelayerQueueInfo,\n  RelayerTransactionStatus,\n  RelayerMetrics,\n  RelayerWebhookConfig,\n  RelayerWebhookPayload,\n} from \"./relayer\";\n\n// Utility types\nexport type {\n  PartialExcept,\n  RequiredExcept,\n  Awaited,\n  MaybePromise,\n  MaybeArray,\n  PaginationParams,\n  PaginationResult,\n  BlockRange,\n  TransactionOptions,\n  TransactionReceipt,\n  ApiResponse,\n  CacheConfig,\n  ValidationResult,\n  StatusInfo,\n  RateLimitInfo,\n  UploadProgress,\n  NetworkInfo,\n  GasEstimate,\n  TimeRange,\n} from \"./utils\";\n\n// Generic types for extensibility\nexport type {\n  GenericRequest,\n  GenericResponse,\n  AsyncResult,\n  ContractCall,\n  EventFilter,\n  EventLog,\n  ControllerContext,\n  Controller,\n  Cache,\n  RetryConfig,\n  RateLimiterConfig,\n  Middleware,\n  Plugin,\n  Factory,\n  Repository,\n  Validator,\n  Transformer,\n  Service,\n  Observer,\n  Observable,\n  StateMachine,\n  ConditionalOptional,\n  PromiseResult,\n  AllKeys,\n  DeepPartial,\n  DeepReadonly,\n  RequireKeys,\n  OptionalKeys,\n  NonNullable,\n  PickByType,\n  OmitByType,\n  Brand,\n  Nominal,\n} from \"./generics\";\n\n// Re-export viem types that are commonly used\nexport type {\n  Address,\n  Hash,\n  Abi,\n  Chain,\n  WalletClient,\n  PublicClient,\n  Account,\n  GetContractReturnType,\n} from \"viem\";\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAmBA,oBAAgE;AAKhE,oBAA2C;AAyB3C,qBAA6B;AAgD7B,8BAMO;AA8EP,2BAKO;","names":[]}
+{"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["/**\n * Centralized type exports for the Vana SDK.\n *\n * @remarks\n * This module re-exports all public types from their respective modules,\n * providing a single import point for SDK consumers. Types are organized\n * by category for easy discovery and usage.\n *\n * **Import Strategy:**\n * - Import types from this module for application code\n * - Import from specific modules only for advanced use cases\n * - Avoid importing from internal paths\n *\n * @example\n * ```typescript\n * // Recommended: Import from types module\n * import type { VanaConfig, UserFile, GrantPermissionParams } from '@opendatalabs/vana-sdk';\n *\n * // Alternative: Import from specific category\n * import type { StorageProvider } from '@opendatalabs/vana-sdk';\n * ```\n *\n * @category Types\n * @module types\n */\n\n// Configuration types\nexport type {\n  BaseConfig,\n  BaseConfigWithStorage,\n  WalletConfig,\n  WalletConfigWithStorage,\n  ChainConfig,\n  ChainConfigWithStorage,\n  VanaConfig,\n  VanaConfigWithStorage,\n  VanaConfigWithWallet,\n  VanaConfigReadOnly,\n  VanaConfigAddressOnly,\n  VanaConfigWithWalletWithStorage,\n  VanaConfigReadOnlyWithStorage,\n  VanaConfigAddressOnlyWithStorage,\n  RuntimeConfig,\n  StorageConfig,\n  ConfigValidationOptions,\n  ConfigValidationResult,\n  DownloadRelayerCallbacks,\n  StorageRequiredMarker,\n  RelayerRequiredMarker,\n} from \"./config\";\n\nexport {\n  isWalletConfig,\n  isChainConfig,\n  isReadOnlyConfig,\n  isAddressOnlyConfig,\n  hasStorageConfig,\n} from \"./config\";\n\n// Chain types\nexport type { VanaChainId, VanaChain } from \"./chains\";\n\nexport { isVanaChainId, isVanaChain } from \"./chains\";\n\n// Contract types\nexport type {\n  VanaContractName,\n  ContractInfo,\n  ContractDeployment,\n  VanaContractInstance,\n  ContractAddresses,\n  ContractMethodParams,\n  ContractMethodReturnType,\n} from \"./contracts\";\n\n// Note: VanaContract and ContractAbis are exported directly from src/index.ts\n// to avoid circular dependencies. Do not re-export them here.\n\n// Storage types\nexport type {\n  StorageProvider,\n  StorageUploadResult,\n  StorageFile,\n  StorageListOptions,\n  StorageProviderConfig,\n} from \"./storage\";\n\nexport { StorageError } from \"./storage\";\n\n// Data types\nexport type {\n  UserFile,\n  FileMetadata,\n  UploadParams,\n  FilePermissionParams,\n  LegacyPermissionParams,\n  EncryptedUploadParams,\n  UnencryptedUploadParams,\n  UploadResult,\n  UploadFileParams,\n  UploadFileResult,\n  UploadEncryptedFileResult,\n  EncryptionInfo,\n  GetUserFilesParams,\n  GetFileParams,\n  EncryptFileOptions,\n  EncryptFileResult,\n  DecryptFileOptions,\n  UploadFileWithPermissionsParams,\n  AddFilePermissionParams,\n  DecryptFileWithPermissionOptions,\n  DownloadFileParams,\n  DownloadFileResult,\n  DeleteFileParams,\n  DeleteFileResult,\n  FileAccessPermissions,\n  FileSharingConfig,\n  BatchUploadParams,\n  BatchUploadResult,\n  SchemaMetadata,\n  CompleteSchema,\n  Schema,\n  Refiner,\n  AddSchemaParams,\n  AddSchemaResult,\n  AddRefinerParams,\n  AddRefinerResult,\n  UpdateSchemaIdParams,\n  UpdateSchemaIdResult,\n  TrustedServer,\n  GetUserTrustedServersParams,\n} from \"./data\";\n\n// Schema types\nexport type {\n  CreateSchemaParams,\n  CreateSchemaResult,\n} from \"../controllers/schemas\";\n\n// Schema validation types\nexport type { DataSchema } from \"../utils/schemaValidation\";\nexport {\n  SchemaValidationError,\n  SchemaValidator,\n  validateDataSchemaAgainstMetaSchema,\n  validateDataAgainstSchema,\n  fetchAndValidateSchema,\n} from \"../utils/schemaValidation\";\n\n// Permission types\nexport type {\n  OnChainPermissionGrant,\n  GetUserPermissionsOptions,\n  GrantPermissionParams,\n  RevokePermissionParams,\n  CheckPermissionParams,\n  PermissionCheckResult,\n  PermissionGrantDomain,\n  PermissionGrantMessage,\n  PermissionInputMessage,\n  SimplifiedPermissionMessage,\n  GrantFile,\n  PermissionGrantTypedData,\n  RevokePermissionTypedData,\n  GenericTypedData,\n  TypedDataPrimaryType,\n  SpecificTypedData,\n  PermissionOperation,\n  PermissionStatus,\n  QueryPermissionsParams,\n  PermissionQueryResult,\n  PermissionAnalytics,\n  PermissionEvent,\n  GrantedPermission,\n  Server,\n  AddAndTrustServerParams,\n  TrustServerParams,\n  UntrustServerParams,\n  AddAndTrustServerInput,\n  TrustServerInput,\n  UntrustServerInput,\n  AddAndTrustServerTypedData,\n  TrustServerTypedData,\n  UntrustServerTypedData,\n  PermissionInfo,\n  RevokePermissionInput,\n  TrustedServerInfo,\n  PaginatedTrustedServers,\n  TrustedServerQueryOptions,\n  BatchServerInfoResult,\n  ServerTrustStatus,\n  ServerInfo,\n  Grantee,\n  GranteeInfo,\n  RegisterGranteeParams,\n  RegisterGranteeInput,\n  RegisterGranteeTypedData,\n  GranteeQueryOptions,\n  PaginatedGrantees,\n  ServerFilesAndPermissionParams,\n  ServerFilesAndPermissionTypedData,\n  Permission,\n} from \"./permissions\";\n\n// Runtime Permissions types\nexport type {\n  RuntimePermissionParams,\n  RuntimeGrantFile,\n  RuntimePermission,\n  RuntimePermissionResult,\n} from \"./runtimePermissions\";\n\n// Access Settlement types\nexport type {\n  OperationInvoice,\n  PaymentSettlementResult,\n  SettleWithNativeParams,\n  SettleWithTokenParams,\n} from \"./accessSettlement\";\n\n// Personal server types\nexport type {\n  PostRequestParams,\n  CreateOperationParams,\n  DownloadArtifactParams,\n  InitPersonalServerParams,\n  PersonalServerIdentity,\n} from \"./personal\";\n\n// Operations types\nexport type {\n  Operation,\n  Artifact,\n  PollingOptions,\n  TransactionResult,\n  TransactionReceipt as OperationTransactionReceipt,\n  TransactionWaitOptions,\n} from \"./operations\";\n\n// Server API types (auto-generated via fetch-server-types.ts)\nexport type * from \"../generated/server/server-exports\";\n\n// External API types\nexport type {\n  ReplicateAPIResponse,\n  ReplicateStatus,\n  PinataUploadResponse,\n  PinataPin,\n  PinataListResponse,\n  APIResponse,\n} from \"./external-apis\";\n\nexport {\n  isReplicateAPIResponse,\n  isAPIResponse,\n  safeParseJSON,\n  parseReplicateOutput,\n} from \"./external-apis\";\n\n// Relayer types\nexport type {\n  RelayerStorageResponse,\n  RelayerTransactionResponse,\n  RelayerStoreParams,\n  RelayerSubmitParams,\n  RelayerStatus,\n  RelayerConfig,\n  UnifiedRelayerRequest,\n  UnifiedRelayerResponse,\n  SignedRelayerRequest,\n  DirectRelayerRequest,\n  RelayerRequestOptions,\n  RelayerErrorResponse,\n  RelayerQueueInfo,\n  RelayerTransactionStatus,\n  RelayerMetrics,\n  RelayerWebhookConfig,\n  RelayerWebhookPayload,\n} from \"./relayer\";\n\n// Utility types\nexport type {\n  PartialExcept,\n  RequiredExcept,\n  Awaited,\n  MaybePromise,\n  MaybeArray,\n  PaginationParams,\n  PaginationResult,\n  BlockRange,\n  ApiResponse,\n  CacheConfig,\n  ValidationResult,\n  StatusInfo,\n  RateLimitInfo,\n  UploadProgress,\n  NetworkInfo,\n  GasEstimate,\n  TimeRange,\n} from \"./utils\";\n\n// Operation store types\nexport type {\n  IOperationStore,\n  StoredOperation,\n  IRelayerStateStore,\n  OperationState,\n} from \"./operationStore\";\n\n// Options types\nexport type {\n  ConsistencyOptions,\n  DataSource,\n  PaginationOptions,\n  ListOptions,\n  WriteOptions,\n  LegacyTransactionOptions,\n} from \"./options\";\n\n// Generic types for extensibility\nexport type {\n  GenericRequest,\n  GenericResponse,\n  AsyncResult,\n  ContractCall,\n  EventFilter,\n  EventLog,\n  ControllerContext,\n  Controller,\n  Cache,\n  RetryConfig,\n  RateLimiterConfig,\n  Middleware,\n  Plugin,\n  Factory,\n  Repository,\n  Validator,\n  Transformer,\n  Service,\n  Observer,\n  Observable,\n  StateMachine,\n  ConditionalOptional,\n  PromiseResult,\n  AllKeys,\n  DeepPartial,\n  DeepReadonly,\n  RequireKeys,\n  OptionalKeys,\n  NonNullable,\n  PickByType,\n  OmitByType,\n  Brand,\n  Nominal,\n} from \"./generics\";\n\n// Re-export viem types that are commonly used\nexport type {\n  Address,\n  Hash,\n  Abi,\n  Chain,\n  WalletClient,\n  PublicClient,\n  Account,\n  GetContractReturnType,\n} from \"viem\";\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAmDA,oBAMO;AAKP,oBAA2C;AAyB3C,qBAA6B;AAsD7B,8BAMO;AAyGP,2BAKO;","names":[]}

package/dist/types/index.d.ts

@@ -1,20 +1,50 @@
-export type { BaseConfig, BaseConfigWithStorage, WalletConfig, WalletConfigWithStorage, ChainConfig, ChainConfigWithStorage, VanaConfig, VanaConfigWithStorage, RuntimeConfig, StorageConfig, ConfigValidationOptions, ConfigValidationResult, RelayerCallbacks, DownloadRelayerCallbacks, StorageRequiredMarker, } from "./config";
-export { isWalletConfig, isChainConfig, hasStorageConfig } from "./config";
+/**
+ * Centralized type exports for the Vana SDK.
+ *
+ * @remarks
+ * This module re-exports all public types from their respective modules,
+ * providing a single import point for SDK consumers. Types are organized
+ * by category for easy discovery and usage.
+ *
+ * **Import Strategy:**
+ * - Import types from this module for application code
+ * - Import from specific modules only for advanced use cases
+ * - Avoid importing from internal paths
+ *
+ * @example
+ * ```typescript
+ * // Recommended: Import from types module
+ * import type { VanaConfig, UserFile, GrantPermissionParams } from '@opendatalabs/vana-sdk';
+ *
+ * // Alternative: Import from specific category
+ * import type { StorageProvider } from '@opendatalabs/vana-sdk';
+ * ```
+ *
+ * @category Types
+ * @module types
+ */
+export type { BaseConfig, BaseConfigWithStorage, WalletConfig, WalletConfigWithStorage, ChainConfig, ChainConfigWithStorage, VanaConfig, VanaConfigWithStorage, VanaConfigWithWallet, VanaConfigReadOnly, VanaConfigAddressOnly, VanaConfigWithWalletWithStorage, VanaConfigReadOnlyWithStorage, VanaConfigAddressOnlyWithStorage, RuntimeConfig, StorageConfig, ConfigValidationOptions, ConfigValidationResult, DownloadRelayerCallbacks, StorageRequiredMarker, RelayerRequiredMarker, } from "./config";
+export { isWalletConfig, isChainConfig, isReadOnlyConfig, isAddressOnlyConfig, hasStorageConfig, } from "./config";
 export type { VanaChainId, VanaChain } from "./chains";
 export { isVanaChainId, isVanaChain } from "./chains";
 export type { VanaContractName, ContractInfo, ContractDeployment, VanaContractInstance, ContractAddresses, ContractMethodParams, ContractMethodReturnType, } from "./contracts";
 export type { StorageProvider, StorageUploadResult, StorageFile, StorageListOptions, StorageProviderConfig, } from "./storage";
 export { StorageError } from "./storage";
-export type { UserFile, FileMetadata, UploadParams, FilePermissionParams, LegacyPermissionParams, EncryptedUploadParams, UnencryptedUploadParams, UploadResult, UploadFileParams, UploadFileResult, UploadEncryptedFileResult, EncryptionInfo, GetUserFilesParams, GetFileParams, DownloadFileParams, DownloadFileResult, DeleteFileParams, DeleteFileResult, FileAccessPermissions, FileSharingConfig, BatchUploadParams, BatchUploadResult, SchemaMetadata, CompleteSchema, Schema, Refiner, AddSchemaParams, AddSchemaResult, AddRefinerParams, AddRefinerResult, UpdateSchemaIdParams, UpdateSchemaIdResult, TrustedServer, GetUserTrustedServersParams, } from "./data";
+export type { UserFile, FileMetadata, UploadParams, FilePermissionParams, LegacyPermissionParams, EncryptedUploadParams, UnencryptedUploadParams, UploadResult, UploadFileParams, UploadFileResult, UploadEncryptedFileResult, EncryptionInfo, GetUserFilesParams, GetFileParams, EncryptFileOptions, EncryptFileResult, DecryptFileOptions, UploadFileWithPermissionsParams, AddFilePermissionParams, DecryptFileWithPermissionOptions, DownloadFileParams, DownloadFileResult, DeleteFileParams, DeleteFileResult, FileAccessPermissions, FileSharingConfig, BatchUploadParams, BatchUploadResult, SchemaMetadata, CompleteSchema, Schema, Refiner, AddSchemaParams, AddSchemaResult, AddRefinerParams, AddRefinerResult, UpdateSchemaIdParams, UpdateSchemaIdResult, TrustedServer, GetUserTrustedServersParams, } from "./data";
 export type { CreateSchemaParams, CreateSchemaResult, } from "../controllers/schemas";
 export type { DataSchema } from "../utils/schemaValidation";
 export { SchemaValidationError, SchemaValidator, validateDataSchemaAgainstMetaSchema, validateDataAgainstSchema, fetchAndValidateSchema, } from "../utils/schemaValidation";
 export type { OnChainPermissionGrant, GetUserPermissionsOptions, GrantPermissionParams, RevokePermissionParams, CheckPermissionParams, PermissionCheckResult, PermissionGrantDomain, PermissionGrantMessage, PermissionInputMessage, SimplifiedPermissionMessage, GrantFile, PermissionGrantTypedData, RevokePermissionTypedData, GenericTypedData, TypedDataPrimaryType, SpecificTypedData, PermissionOperation, PermissionStatus, QueryPermissionsParams, PermissionQueryResult, PermissionAnalytics, PermissionEvent, GrantedPermission, Server, AddAndTrustServerParams, TrustServerParams, UntrustServerParams, AddAndTrustServerInput, TrustServerInput, UntrustServerInput, AddAndTrustServerTypedData, TrustServerTypedData, UntrustServerTypedData, PermissionInfo, RevokePermissionInput, TrustedServerInfo, PaginatedTrustedServers, TrustedServerQueryOptions, BatchServerInfoResult, ServerTrustStatus, ServerInfo, Grantee, GranteeInfo, RegisterGranteeParams, RegisterGranteeInput, RegisterGranteeTypedData, GranteeQueryOptions, PaginatedGrantees, ServerFilesAndPermissionParams, ServerFilesAndPermissionTypedData, Permission, } from "./permissions";
-export type { PostRequestParams, CreateOperationParams, InitPersonalServerParams, PersonalServerIdentity, } from "./personal";
+export type { RuntimePermissionParams, RuntimeGrantFile, RuntimePermission, RuntimePermissionResult, } from "./runtimePermissions";
+export type { OperationInvoice, PaymentSettlementResult, SettleWithNativeParams, SettleWithTokenParams, } from "./accessSettlement";
+export type { PostRequestParams, CreateOperationParams, DownloadArtifactParams, InitPersonalServerParams, PersonalServerIdentity, } from "./personal";
+export type { Operation, Artifact, PollingOptions, TransactionResult, TransactionReceipt as OperationTransactionReceipt, TransactionWaitOptions, } from "./operations";
 export type * from "../generated/server/server-exports";
 export type { ReplicateAPIResponse, ReplicateStatus, PinataUploadResponse, PinataPin, PinataListResponse, APIResponse, } from "./external-apis";
 export { isReplicateAPIResponse, isAPIResponse, safeParseJSON, parseReplicateOutput, } from "./external-apis";
-export type { RelayerStorageResponse, RelayerTransactionResponse, RelayerStoreParams, RelayerSubmitParams, RelayerStatus, RelayerConfig, RelayerRequestOptions, RelayerErrorResponse, RelayerQueueInfo, RelayerTransactionStatus, RelayerMetrics, RelayerWebhookConfig, RelayerWebhookPayload, } from "./relayer";
-export type { PartialExcept, RequiredExcept, Awaited, MaybePromise, MaybeArray, PaginationParams, PaginationResult, BlockRange, TransactionOptions, TransactionReceipt, ApiResponse, CacheConfig, ValidationResult, StatusInfo, RateLimitInfo, UploadProgress, NetworkInfo, GasEstimate, TimeRange, } from "./utils";
+export type { RelayerStorageResponse, RelayerTransactionResponse, RelayerStoreParams, RelayerSubmitParams, RelayerStatus, RelayerConfig, UnifiedRelayerRequest, UnifiedRelayerResponse, SignedRelayerRequest, DirectRelayerRequest, RelayerRequestOptions, RelayerErrorResponse, RelayerQueueInfo, RelayerTransactionStatus, RelayerMetrics, RelayerWebhookConfig, RelayerWebhookPayload, } from "./relayer";
+export type { PartialExcept, RequiredExcept, Awaited, MaybePromise, MaybeArray, PaginationParams, PaginationResult, BlockRange, ApiResponse, CacheConfig, ValidationResult, StatusInfo, RateLimitInfo, UploadProgress, NetworkInfo, GasEstimate, TimeRange, } from "./utils";
+export type { IOperationStore, StoredOperation, IRelayerStateStore, OperationState, } from "./operationStore";
+export type { ConsistencyOptions, DataSource, PaginationOptions, ListOptions, WriteOptions, LegacyTransactionOptions, } from "./options";
 export type { GenericRequest, GenericResponse, AsyncResult, ContractCall, EventFilter, EventLog, ControllerContext, Controller, Cache, RetryConfig, RateLimiterConfig, Middleware, Plugin, Factory, Repository, Validator, Transformer, Service, Observer, Observable, StateMachine, ConditionalOptional, PromiseResult, AllKeys, DeepPartial, DeepReadonly, RequireKeys, OptionalKeys, NonNullable, PickByType, OmitByType, Brand, Nominal, } from "./generics";
 export type { Address, Hash, Abi, Chain, WalletClient, PublicClient, Account, GetContractReturnType, } from "viem";

package/dist/types/index.js

@@ -1,4 +1,10 @@
-import { isWalletConfig, isChainConfig, hasStorageConfig } from "./config";
+import {
+  isWalletConfig,
+  isChainConfig,
+  isReadOnlyConfig,
+  isAddressOnlyConfig,
+  hasStorageConfig
+} from "./config";
 import { isVanaChainId, isVanaChain } from "./chains";
 import { StorageError } from "./storage";
 import {
@@ -21,7 +27,9 @@ export {
   fetchAndValidateSchema,
   hasStorageConfig,
   isAPIResponse,
+  isAddressOnlyConfig,
   isChainConfig,
+  isReadOnlyConfig,
   isReplicateAPIResponse,
   isVanaChain,
   isVanaChainId,

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["// Configuration types\nexport type {\n  BaseConfig,\n  BaseConfigWithStorage,\n  WalletConfig,\n  WalletConfigWithStorage,\n  ChainConfig,\n  ChainConfigWithStorage,\n  VanaConfig,\n  VanaConfigWithStorage,\n  RuntimeConfig,\n  StorageConfig,\n  ConfigValidationOptions,\n  ConfigValidationResult,\n  RelayerCallbacks,\n  DownloadRelayerCallbacks,\n  StorageRequiredMarker,\n} from \"./config\";\n\nexport { isWalletConfig, isChainConfig, hasStorageConfig } from \"./config\";\n\n// Chain types\nexport type { VanaChainId, VanaChain } from \"./chains\";\n\nexport { isVanaChainId, isVanaChain } from \"./chains\";\n\n// Contract types\nexport type {\n  VanaContractName,\n  ContractInfo,\n  ContractDeployment,\n  VanaContractInstance,\n  ContractAddresses,\n  ContractMethodParams,\n  ContractMethodReturnType,\n} from \"./contracts\";\n\n// Note: VanaContract and ContractAbis are exported directly from src/index.ts\n// to avoid circular dependencies. Do not re-export them here.\n\n// Storage types\nexport type {\n  StorageProvider,\n  StorageUploadResult,\n  StorageFile,\n  StorageListOptions,\n  StorageProviderConfig,\n} from \"./storage\";\n\nexport { StorageError } from \"./storage\";\n\n// Data types\nexport type {\n  UserFile,\n  FileMetadata,\n  UploadParams,\n  FilePermissionParams,\n  LegacyPermissionParams,\n  EncryptedUploadParams,\n  UnencryptedUploadParams,\n  UploadResult,\n  UploadFileParams,\n  UploadFileResult,\n  UploadEncryptedFileResult,\n  EncryptionInfo,\n  GetUserFilesParams,\n  GetFileParams,\n  DownloadFileParams,\n  DownloadFileResult,\n  DeleteFileParams,\n  DeleteFileResult,\n  FileAccessPermissions,\n  FileSharingConfig,\n  BatchUploadParams,\n  BatchUploadResult,\n  SchemaMetadata,\n  CompleteSchema,\n  Schema,\n  Refiner,\n  AddSchemaParams,\n  AddSchemaResult,\n  AddRefinerParams,\n  AddRefinerResult,\n  UpdateSchemaIdParams,\n  UpdateSchemaIdResult,\n  TrustedServer,\n  GetUserTrustedServersParams,\n} from \"./data\";\n\n// Schema types\nexport type {\n  CreateSchemaParams,\n  CreateSchemaResult,\n} from \"../controllers/schemas\";\n\n// Schema validation types\nexport type { DataSchema } from \"../utils/schemaValidation\";\nexport {\n  SchemaValidationError,\n  SchemaValidator,\n  validateDataSchemaAgainstMetaSchema,\n  validateDataAgainstSchema,\n  fetchAndValidateSchema,\n} from \"../utils/schemaValidation\";\n\n// Permission types\nexport type {\n  OnChainPermissionGrant,\n  GetUserPermissionsOptions,\n  GrantPermissionParams,\n  RevokePermissionParams,\n  CheckPermissionParams,\n  PermissionCheckResult,\n  PermissionGrantDomain,\n  PermissionGrantMessage,\n  PermissionInputMessage,\n  SimplifiedPermissionMessage,\n  GrantFile,\n  PermissionGrantTypedData,\n  RevokePermissionTypedData,\n  GenericTypedData,\n  TypedDataPrimaryType,\n  SpecificTypedData,\n  PermissionOperation,\n  PermissionStatus,\n  QueryPermissionsParams,\n  PermissionQueryResult,\n  PermissionAnalytics,\n  PermissionEvent,\n  GrantedPermission,\n  Server,\n  AddAndTrustServerParams,\n  TrustServerParams,\n  UntrustServerParams,\n  AddAndTrustServerInput,\n  TrustServerInput,\n  UntrustServerInput,\n  AddAndTrustServerTypedData,\n  TrustServerTypedData,\n  UntrustServerTypedData,\n  PermissionInfo,\n  RevokePermissionInput,\n  TrustedServerInfo,\n  PaginatedTrustedServers,\n  TrustedServerQueryOptions,\n  BatchServerInfoResult,\n  ServerTrustStatus,\n  ServerInfo,\n  Grantee,\n  GranteeInfo,\n  RegisterGranteeParams,\n  RegisterGranteeInput,\n  RegisterGranteeTypedData,\n  GranteeQueryOptions,\n  PaginatedGrantees,\n  ServerFilesAndPermissionParams,\n  ServerFilesAndPermissionTypedData,\n  Permission,\n} from \"./permissions\";\n\n// Personal server types\nexport type {\n  PostRequestParams,\n  CreateOperationParams,\n  InitPersonalServerParams,\n  PersonalServerIdentity,\n} from \"./personal\";\n\n// Server API types (auto-generated via fetch-server-types.ts)\nexport type * from \"../generated/server/server-exports\";\n\n// External API types\nexport type {\n  ReplicateAPIResponse,\n  ReplicateStatus,\n  PinataUploadResponse,\n  PinataPin,\n  PinataListResponse,\n  APIResponse,\n} from \"./external-apis\";\n\nexport {\n  isReplicateAPIResponse,\n  isAPIResponse,\n  safeParseJSON,\n  parseReplicateOutput,\n} from \"./external-apis\";\n\n// Relayer types\nexport type {\n  RelayerStorageResponse,\n  RelayerTransactionResponse,\n  RelayerStoreParams,\n  RelayerSubmitParams,\n  RelayerStatus,\n  RelayerConfig,\n  RelayerRequestOptions,\n  RelayerErrorResponse,\n  RelayerQueueInfo,\n  RelayerTransactionStatus,\n  RelayerMetrics,\n  RelayerWebhookConfig,\n  RelayerWebhookPayload,\n} from \"./relayer\";\n\n// Utility types\nexport type {\n  PartialExcept,\n  RequiredExcept,\n  Awaited,\n  MaybePromise,\n  MaybeArray,\n  PaginationParams,\n  PaginationResult,\n  BlockRange,\n  TransactionOptions,\n  TransactionReceipt,\n  ApiResponse,\n  CacheConfig,\n  ValidationResult,\n  StatusInfo,\n  RateLimitInfo,\n  UploadProgress,\n  NetworkInfo,\n  GasEstimate,\n  TimeRange,\n} from \"./utils\";\n\n// Generic types for extensibility\nexport type {\n  GenericRequest,\n  GenericResponse,\n  AsyncResult,\n  ContractCall,\n  EventFilter,\n  EventLog,\n  ControllerContext,\n  Controller,\n  Cache,\n  RetryConfig,\n  RateLimiterConfig,\n  Middleware,\n  Plugin,\n  Factory,\n  Repository,\n  Validator,\n  Transformer,\n  Service,\n  Observer,\n  Observable,\n  StateMachine,\n  ConditionalOptional,\n  PromiseResult,\n  AllKeys,\n  DeepPartial,\n  DeepReadonly,\n  RequireKeys,\n  OptionalKeys,\n  NonNullable,\n  PickByType,\n  OmitByType,\n  Brand,\n  Nominal,\n} from \"./generics\";\n\n// Re-export viem types that are commonly used\nexport type {\n  Address,\n  Hash,\n  Abi,\n  Chain,\n  WalletClient,\n  PublicClient,\n  Account,\n  GetContractReturnType,\n} from \"viem\";\n"],"mappings":"AAmBA,SAAS,gBAAgB,eAAe,wBAAwB;AAKhE,SAAS,eAAe,mBAAmB;AAyB3C,SAAS,oBAAoB;AAgD7B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AA8EP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;","names":[]}
+{"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["/**\n * Centralized type exports for the Vana SDK.\n *\n * @remarks\n * This module re-exports all public types from their respective modules,\n * providing a single import point for SDK consumers. Types are organized\n * by category for easy discovery and usage.\n *\n * **Import Strategy:**\n * - Import types from this module for application code\n * - Import from specific modules only for advanced use cases\n * - Avoid importing from internal paths\n *\n * @example\n * ```typescript\n * // Recommended: Import from types module\n * import type { VanaConfig, UserFile, GrantPermissionParams } from '@opendatalabs/vana-sdk';\n *\n * // Alternative: Import from specific category\n * import type { StorageProvider } from '@opendatalabs/vana-sdk';\n * ```\n *\n * @category Types\n * @module types\n */\n\n// Configuration types\nexport type {\n  BaseConfig,\n  BaseConfigWithStorage,\n  WalletConfig,\n  WalletConfigWithStorage,\n  ChainConfig,\n  ChainConfigWithStorage,\n  VanaConfig,\n  VanaConfigWithStorage,\n  VanaConfigWithWallet,\n  VanaConfigReadOnly,\n  VanaConfigAddressOnly,\n  VanaConfigWithWalletWithStorage,\n  VanaConfigReadOnlyWithStorage,\n  VanaConfigAddressOnlyWithStorage,\n  RuntimeConfig,\n  StorageConfig,\n  ConfigValidationOptions,\n  ConfigValidationResult,\n  DownloadRelayerCallbacks,\n  StorageRequiredMarker,\n  RelayerRequiredMarker,\n} from \"./config\";\n\nexport {\n  isWalletConfig,\n  isChainConfig,\n  isReadOnlyConfig,\n  isAddressOnlyConfig,\n  hasStorageConfig,\n} from \"./config\";\n\n// Chain types\nexport type { VanaChainId, VanaChain } from \"./chains\";\n\nexport { isVanaChainId, isVanaChain } from \"./chains\";\n\n// Contract types\nexport type {\n  VanaContractName,\n  ContractInfo,\n  ContractDeployment,\n  VanaContractInstance,\n  ContractAddresses,\n  ContractMethodParams,\n  ContractMethodReturnType,\n} from \"./contracts\";\n\n// Note: VanaContract and ContractAbis are exported directly from src/index.ts\n// to avoid circular dependencies. Do not re-export them here.\n\n// Storage types\nexport type {\n  StorageProvider,\n  StorageUploadResult,\n  StorageFile,\n  StorageListOptions,\n  StorageProviderConfig,\n} from \"./storage\";\n\nexport { StorageError } from \"./storage\";\n\n// Data types\nexport type {\n  UserFile,\n  FileMetadata,\n  UploadParams,\n  FilePermissionParams,\n  LegacyPermissionParams,\n  EncryptedUploadParams,\n  UnencryptedUploadParams,\n  UploadResult,\n  UploadFileParams,\n  UploadFileResult,\n  UploadEncryptedFileResult,\n  EncryptionInfo,\n  GetUserFilesParams,\n  GetFileParams,\n  EncryptFileOptions,\n  EncryptFileResult,\n  DecryptFileOptions,\n  UploadFileWithPermissionsParams,\n  AddFilePermissionParams,\n  DecryptFileWithPermissionOptions,\n  DownloadFileParams,\n  DownloadFileResult,\n  DeleteFileParams,\n  DeleteFileResult,\n  FileAccessPermissions,\n  FileSharingConfig,\n  BatchUploadParams,\n  BatchUploadResult,\n  SchemaMetadata,\n  CompleteSchema,\n  Schema,\n  Refiner,\n  AddSchemaParams,\n  AddSchemaResult,\n  AddRefinerParams,\n  AddRefinerResult,\n  UpdateSchemaIdParams,\n  UpdateSchemaIdResult,\n  TrustedServer,\n  GetUserTrustedServersParams,\n} from \"./data\";\n\n// Schema types\nexport type {\n  CreateSchemaParams,\n  CreateSchemaResult,\n} from \"../controllers/schemas\";\n\n// Schema validation types\nexport type { DataSchema } from \"../utils/schemaValidation\";\nexport {\n  SchemaValidationError,\n  SchemaValidator,\n  validateDataSchemaAgainstMetaSchema,\n  validateDataAgainstSchema,\n  fetchAndValidateSchema,\n} from \"../utils/schemaValidation\";\n\n// Permission types\nexport type {\n  OnChainPermissionGrant,\n  GetUserPermissionsOptions,\n  GrantPermissionParams,\n  RevokePermissionParams,\n  CheckPermissionParams,\n  PermissionCheckResult,\n  PermissionGrantDomain,\n  PermissionGrantMessage,\n  PermissionInputMessage,\n  SimplifiedPermissionMessage,\n  GrantFile,\n  PermissionGrantTypedData,\n  RevokePermissionTypedData,\n  GenericTypedData,\n  TypedDataPrimaryType,\n  SpecificTypedData,\n  PermissionOperation,\n  PermissionStatus,\n  QueryPermissionsParams,\n  PermissionQueryResult,\n  PermissionAnalytics,\n  PermissionEvent,\n  GrantedPermission,\n  Server,\n  AddAndTrustServerParams,\n  TrustServerParams,\n  UntrustServerParams,\n  AddAndTrustServerInput,\n  TrustServerInput,\n  UntrustServerInput,\n  AddAndTrustServerTypedData,\n  TrustServerTypedData,\n  UntrustServerTypedData,\n  PermissionInfo,\n  RevokePermissionInput,\n  TrustedServerInfo,\n  PaginatedTrustedServers,\n  TrustedServerQueryOptions,\n  BatchServerInfoResult,\n  ServerTrustStatus,\n  ServerInfo,\n  Grantee,\n  GranteeInfo,\n  RegisterGranteeParams,\n  RegisterGranteeInput,\n  RegisterGranteeTypedData,\n  GranteeQueryOptions,\n  PaginatedGrantees,\n  ServerFilesAndPermissionParams,\n  ServerFilesAndPermissionTypedData,\n  Permission,\n} from \"./permissions\";\n\n// Runtime Permissions types\nexport type {\n  RuntimePermissionParams,\n  RuntimeGrantFile,\n  RuntimePermission,\n  RuntimePermissionResult,\n} from \"./runtimePermissions\";\n\n// Access Settlement types\nexport type {\n  OperationInvoice,\n  PaymentSettlementResult,\n  SettleWithNativeParams,\n  SettleWithTokenParams,\n} from \"./accessSettlement\";\n\n// Personal server types\nexport type {\n  PostRequestParams,\n  CreateOperationParams,\n  DownloadArtifactParams,\n  InitPersonalServerParams,\n  PersonalServerIdentity,\n} from \"./personal\";\n\n// Operations types\nexport type {\n  Operation,\n  Artifact,\n  PollingOptions,\n  TransactionResult,\n  TransactionReceipt as OperationTransactionReceipt,\n  TransactionWaitOptions,\n} from \"./operations\";\n\n// Server API types (auto-generated via fetch-server-types.ts)\nexport type * from \"../generated/server/server-exports\";\n\n// External API types\nexport type {\n  ReplicateAPIResponse,\n  ReplicateStatus,\n  PinataUploadResponse,\n  PinataPin,\n  PinataListResponse,\n  APIResponse,\n} from \"./external-apis\";\n\nexport {\n  isReplicateAPIResponse,\n  isAPIResponse,\n  safeParseJSON,\n  parseReplicateOutput,\n} from \"./external-apis\";\n\n// Relayer types\nexport type {\n  RelayerStorageResponse,\n  RelayerTransactionResponse,\n  RelayerStoreParams,\n  RelayerSubmitParams,\n  RelayerStatus,\n  RelayerConfig,\n  UnifiedRelayerRequest,\n  UnifiedRelayerResponse,\n  SignedRelayerRequest,\n  DirectRelayerRequest,\n  RelayerRequestOptions,\n  RelayerErrorResponse,\n  RelayerQueueInfo,\n  RelayerTransactionStatus,\n  RelayerMetrics,\n  RelayerWebhookConfig,\n  RelayerWebhookPayload,\n} from \"./relayer\";\n\n// Utility types\nexport type {\n  PartialExcept,\n  RequiredExcept,\n  Awaited,\n  MaybePromise,\n  MaybeArray,\n  PaginationParams,\n  PaginationResult,\n  BlockRange,\n  ApiResponse,\n  CacheConfig,\n  ValidationResult,\n  StatusInfo,\n  RateLimitInfo,\n  UploadProgress,\n  NetworkInfo,\n  GasEstimate,\n  TimeRange,\n} from \"./utils\";\n\n// Operation store types\nexport type {\n  IOperationStore,\n  StoredOperation,\n  IRelayerStateStore,\n  OperationState,\n} from \"./operationStore\";\n\n// Options types\nexport type {\n  ConsistencyOptions,\n  DataSource,\n  PaginationOptions,\n  ListOptions,\n  WriteOptions,\n  LegacyTransactionOptions,\n} from \"./options\";\n\n// Generic types for extensibility\nexport type {\n  GenericRequest,\n  GenericResponse,\n  AsyncResult,\n  ContractCall,\n  EventFilter,\n  EventLog,\n  ControllerContext,\n  Controller,\n  Cache,\n  RetryConfig,\n  RateLimiterConfig,\n  Middleware,\n  Plugin,\n  Factory,\n  Repository,\n  Validator,\n  Transformer,\n  Service,\n  Observer,\n  Observable,\n  StateMachine,\n  ConditionalOptional,\n  PromiseResult,\n  AllKeys,\n  DeepPartial,\n  DeepReadonly,\n  RequireKeys,\n  OptionalKeys,\n  NonNullable,\n  PickByType,\n  OmitByType,\n  Brand,\n  Nominal,\n} from \"./generics\";\n\n// Re-export viem types that are commonly used\nexport type {\n  Address,\n  Hash,\n  Abi,\n  Chain,\n  WalletClient,\n  PublicClient,\n  Account,\n  GetContractReturnType,\n} from \"viem\";\n"],"mappings":"AAmDA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAKP,SAAS,eAAe,mBAAmB;AAyB3C,SAAS,oBAAoB;AAsD7B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAyGP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;","names":[]}

package/dist/types/operationStore.cjs

@@ -0,0 +1,17 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 operationStore_exports = {};
+module.exports = __toCommonJS(operationStore_exports);
+//# sourceMappingURL=operationStore.cjs.map

package/dist/types/operationStore.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/operationStore.ts"],"sourcesContent":["/**\n * Operation storage interfaces for queuing and managing asynchronous operations.\n *\n * @module\n */\n\nimport type { Hash, TransactionReceipt } from \"viem\";\nimport type { UnifiedRelayerRequest } from \"./relayer\";\n\n/**\n * The state of an asynchronous, relayed operation.\n *\n * @remarks\n * This is the data the application backend is responsible for persisting.\n * It serves as a complete recovery log for a given operation.\n *\n * @category Operations\n */\nexport interface OperationState {\n  status: \"pending\" | \"confirmed\" | \"failed\";\n  transactionHash: Hash;\n  originalRequest: UnifiedRelayerRequest;\n  nonce?: number;\n  retryCount: number;\n  lastAttemptedGas: { maxFeePerGas?: string; maxPriorityFeePerGas?: string };\n  submittedAt: number; // Unix timestamp (ms)\n  finalReceipt?: TransactionReceipt;\n  error?: string;\n}\n\n/**\n * Simple storage interface for operation state tracking.\n *\n * @remarks\n * This interface is used by the relayer handler to track operation state\n * in a stateful mode. Implementations can use any backend storage system.\n *\n * @category Operations\n */\nexport interface IRelayerStateStore {\n  /**\n   * Gets the state of an operation.\n   *\n   * @param operationId - The operation ID\n   * @returns The operation state or null if not found\n   */\n  get(operationId: string): Promise<OperationState | null>;\n\n  /**\n   * Sets the state of an operation.\n   *\n   * @param operationId - The operation ID\n   * @param state - The operation state to store\n   */\n  set(operationId: string, state: OperationState): Promise<void>;\n}\n\n/**\n * Represents a stored operation in the queue.\n */\nexport interface StoredOperation {\n  /** Unique identifier for the operation */\n  id: string;\n  /** Current status of the operation */\n  status: \"queued\" | \"processing\" | \"submitted\" | \"completed\" | \"failed\";\n  /** Serialized transaction or operation data */\n  data: string;\n  /** Number of retry attempts */\n  retryCount?: number;\n  /** Timestamp when the operation was created */\n  createdAt?: number;\n  /** Additional metadata */\n  metadata?: any;\n}\n\n/**\n * Interface for operation storage backends.\n *\n * @remarks\n * Implementations of this interface provide persistent storage for queued\n * operations in a distributed relayer system. This allows operations to\n * be processed asynchronously and recovered after failures.\n *\n * Common implementations include:\n * - PostgreSQL for production environments\n * - MongoDB for document-based storage\n * - DynamoDB for serverless deployments\n * - In-memory storage for testing\n *\n * @example\n * ```typescript\n * class PostgresOperationStore implements IOperationStore {\n *   async storeOperation(operation) {\n *     await this.db.query(\n *       'INSERT INTO operations (id, status, data) VALUES ($1, $2, $3)',\n *       [operation.id, 'queued', operation.data]\n *     );\n *   }\n *\n *   async getQueuedOperations(options) {\n *     const result = await this.db.query(\n *       'SELECT * FROM operations WHERE status = $1 LIMIT $2',\n *       ['queued', options.limit || 100]\n *     );\n *     return result.rows;\n *   }\n * }\n * ```\n *\n * @category Storage\n */\nexport interface IOperationStore {\n  /**\n   * Stores a new operation in the queue.\n   *\n   * @param operation - The operation to store\n   * @returns Promise that resolves when the operation is stored\n   */\n  storeOperation(operation: {\n    id: string;\n    data: any;\n    metadata?: any;\n  }): Promise<void>;\n\n  /**\n   * Retrieves queued operations for processing.\n   *\n   * @param options - Query options\n   * @returns Promise resolving to an array of queued operations\n   */\n  getQueuedOperations(options?: { limit?: number }): Promise<StoredOperation[]>;\n\n  /**\n   * Updates the status of an operation.\n   *\n   * @param operationId - The ID of the operation to update\n   * @param status - The new status\n   * @param metadata - Optional metadata to store with the update\n   * @returns Promise that resolves when the status is updated\n   */\n  updateStatus(\n    operationId: string,\n    status: string,\n    metadata?: any,\n  ): Promise<void>;\n\n  /**\n   * Gets operations currently being processed.\n   *\n   * @param options - Query options\n   * @returns Promise resolving to an array of processing operations\n   */\n  getProcessingOperations?(options?: {\n    limit?: number;\n  }): Promise<StoredOperation[]>;\n\n  /**\n   * Gets failed operations.\n   *\n   * @param options - Query options\n   * @returns Promise resolving to an array of failed operations\n   */\n  getFailedOperations?(options?: {\n    limit?: number;\n  }): Promise<StoredOperation[]>;\n\n  /**\n   * Gets the status of a specific operation.\n   *\n   * @param operationId - The ID of the operation to check\n   * @returns Promise resolving to the operation or null if not found\n   */\n  getOperation?(operationId: string): Promise<StoredOperation | null>;\n\n  /**\n   * Deletes an operation from storage.\n   *\n   * @param operationId - The ID of the operation to delete\n   * @returns Promise that resolves when the operation is deleted\n   */\n  deleteOperation?(operationId: string): Promise<void>;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/operationStore.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Operation storage interfaces for queuing and managing asynchronous operations.
+ *
+ * @module
+ */
+import type { Hash, TransactionReceipt } from "viem";
+import type { UnifiedRelayerRequest } from "./relayer";
+/**
+ * The state of an asynchronous, relayed operation.
+ *
+ * @remarks
+ * This is the data the application backend is responsible for persisting.
+ * It serves as a complete recovery log for a given operation.
+ *
+ * @category Operations
+ */
+export interface OperationState {
+    status: "pending" | "confirmed" | "failed";
+    transactionHash: Hash;
+    originalRequest: UnifiedRelayerRequest;
+    nonce?: number;
+    retryCount: number;
+    lastAttemptedGas: {
+        maxFeePerGas?: string;
+        maxPriorityFeePerGas?: string;
+    };
+    submittedAt: number;
+    finalReceipt?: TransactionReceipt;
+    error?: string;
+}
+/**
+ * Simple storage interface for operation state tracking.
+ *
+ * @remarks
+ * This interface is used by the relayer handler to track operation state
+ * in a stateful mode. Implementations can use any backend storage system.
+ *
+ * @category Operations
+ */
+export interface IRelayerStateStore {
+    /**
+     * Gets the state of an operation.
+     *
+     * @param operationId - The operation ID
+     * @returns The operation state or null if not found
+     */
+    get(operationId: string): Promise<OperationState | null>;
+    /**
+     * Sets the state of an operation.
+     *
+     * @param operationId - The operation ID
+     * @param state - The operation state to store
+     */
+    set(operationId: string, state: OperationState): Promise<void>;
+}
+/**
+ * Represents a stored operation in the queue.
+ */
+export interface StoredOperation {
+    /** Unique identifier for the operation */
+    id: string;
+    /** Current status of the operation */
+    status: "queued" | "processing" | "submitted" | "completed" | "failed";
+    /** Serialized transaction or operation data */
+    data: string;
+    /** Number of retry attempts */
+    retryCount?: number;
+    /** Timestamp when the operation was created */
+    createdAt?: number;
+    /** Additional metadata */
+    metadata?: any;
+}
+/**
+ * Interface for operation storage backends.
+ *
+ * @remarks
+ * Implementations of this interface provide persistent storage for queued
+ * operations in a distributed relayer system. This allows operations to
+ * be processed asynchronously and recovered after failures.
+ *
+ * Common implementations include:
+ * - PostgreSQL for production environments
+ * - MongoDB for document-based storage
+ * - DynamoDB for serverless deployments
+ * - In-memory storage for testing
+ *
+ * @example
+ * ```typescript
+ * class PostgresOperationStore implements IOperationStore {
+ *   async storeOperation(operation) {
+ *     await this.db.query(
+ *       'INSERT INTO operations (id, status, data) VALUES ($1, $2, $3)',
+ *       [operation.id, 'queued', operation.data]
+ *     );
+ *   }
+ *
+ *   async getQueuedOperations(options) {
+ *     const result = await this.db.query(
+ *       'SELECT * FROM operations WHERE status = $1 LIMIT $2',
+ *       ['queued', options.limit || 100]
+ *     );
+ *     return result.rows;
+ *   }
+ * }
+ * ```
+ *
+ * @category Storage
+ */
+export interface IOperationStore {
+    /**
+     * Stores a new operation in the queue.
+     *
+     * @param operation - The operation to store
+     * @returns Promise that resolves when the operation is stored
+     */
+    storeOperation(operation: {
+        id: string;
+        data: any;
+        metadata?: any;
+    }): Promise<void>;
+    /**
+     * Retrieves queued operations for processing.
+     *
+     * @param options - Query options
+     * @returns Promise resolving to an array of queued operations
+     */
+    getQueuedOperations(options?: {
+        limit?: number;
+    }): Promise<StoredOperation[]>;
+    /**
+     * Updates the status of an operation.
+     *
+     * @param operationId - The ID of the operation to update
+     * @param status - The new status
+     * @param metadata - Optional metadata to store with the update
+     * @returns Promise that resolves when the status is updated
+     */
+    updateStatus(operationId: string, status: string, metadata?: any): Promise<void>;
+    /**
+     * Gets operations currently being processed.
+     *
+     * @param options - Query options
+     * @returns Promise resolving to an array of processing operations
+     */
+    getProcessingOperations?(options?: {
+        limit?: number;
+    }): Promise<StoredOperation[]>;
+    /**
+     * Gets failed operations.
+     *
+     * @param options - Query options
+     * @returns Promise resolving to an array of failed operations
+     */
+    getFailedOperations?(options?: {
+        limit?: number;
+    }): Promise<StoredOperation[]>;
+    /**
+     * Gets the status of a specific operation.
+     *
+     * @param operationId - The ID of the operation to check
+     * @returns Promise resolving to the operation or null if not found
+     */
+    getOperation?(operationId: string): Promise<StoredOperation | null>;
+    /**
+     * Deletes an operation from storage.
+     *
+     * @param operationId - The ID of the operation to delete
+     * @returns Promise that resolves when the operation is deleted
+     */
+    deleteOperation?(operationId: string): Promise<void>;
+}

package/dist/types/operationStore.js

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

package/dist/types/operationStore.js.map

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