@opendatalabs/vana-sdk 2.3.0 → 3.0.0

package/dist/index.node.d.ts

@@ -1,216 +1,24 @@
 /**
  * @module Node
- * Node.js-specific implementation of the Vana SDK
- */
-import { VanaCore } from "./core";
-import type { VanaConfig, VanaConfigWithStorage, StorageRequiredMarker, RelayerRequiredMarker } from "./types";
-import type { IOperationStore, IRelayerStateStore } from "./types/operationStore";
-import type { IAtomicStore } from "./types/atomicStore";
-import type { PublicClient } from "viem";
-/**
- * Node.js-specific configuration interface with operation store support
- *
- * @category Configuration
- */
-export type VanaNodeConfig = VanaConfig & {
-    operationStore?: IOperationStore | IRelayerStateStore;
-    atomicStore?: IAtomicStore;
-};
-/**
- * Node.js configuration with storage requirements
- *
- * @category Configuration
- */
-export type VanaNodeConfigWithStorage = VanaConfigWithStorage & {
-    operationStore?: IOperationStore | IRelayerStateStore;
-    atomicStore?: IAtomicStore;
-};
-/**
- * Internal implementation class for Node.js environments.
- * This class is not exported directly - use the Vana factory function instead.
- */
-declare class VanaNodeImpl extends VanaCore {
-    readonly operationStore?: IOperationStore | IRelayerStateStore;
-    readonly atomicStore?: IAtomicStore;
-    constructor(config: VanaNodeConfig);
-}
-/**
- * Creates a new Vana SDK instance configured for Node.js environments.
+ * Node.js entry point for the Vana SDK.
  *
  * @remarks
- * This is the primary entry point for Node.js applications using the Vana SDK. The function
- * automatically detects your configuration type and provides compile-time type safety:
- * - **With storage configured**: All methods including file upload/download are available
- * - **Without storage**: Storage-dependent methods throw runtime errors and are excluded from TypeScript
- *
- * The Node.js version provides enhanced capabilities including native file system access,
- * server-side cryptographic operations, and support for personal server deployment.
- * It includes all browser capabilities plus Node.js-specific optimizations and utilities.
- *
- * @param config - Configuration object containing wallet, storage, and relayer settings
- * @returns A fully configured Vana SDK instance for Node.js use
- * @throws {InvalidConfigurationError} When configuration parameters are invalid or missing
- * @example
- * ```typescript
- * import { Vana } from '@opendatalabs/vana-sdk/node';
- * import { createWalletClient, http } from 'viem';
- * import { privateKeyToAccount } from 'viem/accounts';
- * import { IPFSStorage, PinataStorage } from '@opendatalabs/vana-sdk/node';
- * import { mokshaTestnet } from '@opendatalabs/vana-sdk/node';
- *
- * // Server setup with private key
- * const account = privateKeyToAccount('0x...');
- * const walletClient = createWalletClient({
- *   account,
- *   chain: mokshaTestnet,
- *   transport: http('https://rpc.moksha.vana.org')
- * });
- *
- * const vana = Vana({
- *   walletClient,
- *   storage: {
- *     providers: {
- *       ipfs: new IPFSStorage({
- *         gateway: 'https://gateway.pinata.cloud',
- *         timeout: 30000
- *       }),
- *       pinata: new PinataStorage({
- *         apiKey: process.env.PINATA_KEY,
- *         secretKey: process.env.PINATA_SECRET
- *       })
- *     },
- *     defaultProvider: 'pinata'
- *   },
- *   relayerCallbacks: {
- *     async submitPermissionGrant(typedData, signature) {
- *       // Server-side relayer implementation
- *       return await submitToCustomRelayer(typedData, signature);
- *     }
- *   }
- * });
- *
- * // Server operations
- * const uploadResult = await vana.data.upload({
- *   content: await fs.readFile('./user-data.json'),
- *   filename: 'user-data.json',
- *   schemaId: 1
- * });
- *
- * // Personal server setup
- * await vana.server.setupPersonalServer({
- *   serverUrl: 'https://my-server.example.com',
- *   capabilities: ['data_processing', 'ml_inference']
- * });
- * ```
- *
- * @example
- * ```typescript
- * // CLI tool or script usage
- * const vana = Vana({
- *   chainId: 14800, // Moksha testnet
- *   account: privateKeyToAccount(process.env.PRIVATE_KEY),
- *   rpcUrl: process.env.RPC_URL,
- *   storage: {
- *     providers: { ipfs: new IPFSStorage() },
- *     defaultProvider: 'ipfs'
- *   }
- * });
- *
- * // Batch operations for data processing
- * const userFiles = await vana.data.getUserFiles({
- *   owner: process.env.USER_ADDRESS
- * });
- *
- * for (const file of userFiles) {
- *   const decrypted = await vana.data.decryptFile(file);
- *   // Process file data...
- * }
- * ```
- *
- * @example
- * ```typescript
- * // Express.js server integration
- * import express from 'express';
- * import { handleRelayerOperation } from '@opendatalabs/vana-sdk/node';
- *
- * const app = express();
- *
- * app.post('/api/relay', async (req, res) => {
- *   try {
- *     const result = await handleRelayerOperation(
- *       vana,
- *       req.body
- *     );
- *     res.json(result);
- *   } catch (error) {
- *     res.status(500).json({ error: error.message });
- *   }
- * });
- * ```
- *
- * @see {@link https://docs.vana.org/docs/sdk/server-setup | Server Setup Guide} for Node.js-specific features
- * @see {@link VanaCore} for the underlying implementation details
- * @category Core SDK
+ * Exposes the platform adapter, ECIES crypto, storage providers, smart-contract
+ * helpers, ABIs, addresses, chain configurations, and shared types.
  */
-export declare function Vana(config: VanaNodeConfigWithStorage & {
-    operationStore: IOperationStore;
-}): VanaNodeImpl & StorageRequiredMarker & RelayerRequiredMarker;
-export declare function Vana(config: VanaNodeConfig & {
-    operationStore: IOperationStore;
-}): VanaNodeImpl & RelayerRequiredMarker;
-export declare function Vana(config: VanaNodeConfigWithStorage): VanaNodeImpl & StorageRequiredMarker;
-export declare function Vana(config: VanaNodeConfig): VanaNodeImpl;
-/**
- * The type of a Vana SDK instance in Node.js environments.
- * Uses InstanceType to properly expose all public methods from the class hierarchy.
- *
- * @see {@link Vana}
- */
-export type VanaInstance = InstanceType<typeof VanaNodeImpl>;
-export default Vana;
-export { VanaCore, VanaCoreFactory } from "./core";
-export { DistributedNonceManager } from "./core/nonceManager";
-export { InMemoryNonceManager } from "./core/inMemoryNonceManager";
-export { SystemHealthChecker } from "./core/health";
-export type { SystemHealthCheckerConfig, HealthStatus, ComponentHealth, NonceHealth, QueueHealth, } from "./core/health";
-export { RedisAtomicStore } from "./lib/redisAtomicStore";
-export type { RedisAtomicStoreConfig } from "./lib/redisAtomicStore";
 export type * from "./types";
-export type { IAtomicStore } from "./types/atomicStore";
-export type { IOperationStore, StoredOperation, IRelayerStateStore, OperationState, } from "./types/operationStore";
-export { isReplicateAPIResponse, isAPIResponse, safeParseJSON, parseReplicateOutput, } from "./types/external-apis";
-export type { VanaContract } from "./generated/abi";
-export { EnhancedTransactionResponse, canEnhanceResponse, enhanceResponse, } from "./client/enhancedResponse";
 export * from "./errors";
-export { PermissionsController } from "./controllers/permissions";
-export { DataController } from "./controllers/data";
-export { ServerController } from "./controllers/server";
-export { ProtocolController } from "./controllers/protocol";
-export { SchemaController } from "./controllers/schemas";
-export { OperationsController } from "./controllers/operations";
-export { StakingController } from "./controllers/staking";
-export type { EntityInfo, StakerEntityInfo, StakerEntitySummary, } from "./controllers/staking";
 export * from "./contracts/contractController";
-export * from "./utils/encryption";
-export * from "./utils/formatters";
-export * from "./utils/grantFiles";
-export * from "./utils/grantValidation";
-export * from "./utils/grants";
-export * from "./utils/ipfs";
-export * from "./utils/schemaValidation";
-export * from "./utils/signatureCache";
-export * from "./storage";
+export { getAbi } from "./generated/abi";
+export type { VanaContract, VanaContract as VanaContractAbi, } from "./generated/abi";
 export { getContractAddress, CONTRACTS } from "./generated/addresses";
-export { chains } from "./config/chains";
-export { type ServiceEndpoints, mainnetServices, mokshaServices, getServiceEndpoints, getDefaultPersonalServerUrl, } from "./config/default-services";
 export { vanaMainnet, mokshaTestnet, moksha, type VanaChainConfig, getChainConfig, getAllChains, } from "./chains";
 export * from "./chains";
-export { getAbi } from "./generated/abi";
-export type { VanaContract as VanaContractAbi } from "./generated/abi";
-export { BaseController, RetryUtility, RateLimiter, MemoryCache, EventEmitter, MiddlewarePipeline, AsyncQueue, CircuitBreaker, } from "./core/generics";
-export { handleRelayerOperation, type RelayerOperationOptions, } from "./server/relayerHandler";
-export type { UnifiedRelayerRequest, UnifiedRelayerResponse, } from "./types/relayer";
-export type { Operation, TransactionResult, TransactionReceipt, PollingOptions, TransactionWaitOptions, } from "./types/operations";
+export { chains } from "./config/chains";
+export { type ServiceEndpoints, mainnetServices, mokshaServices, getServiceEndpoints, } from "./config/default-services";
+export * from "./storage/index";
+export { createVanaStorageProvider } from "./storage/default";
+export type { VanaStorageProviderOptions } from "./storage/default";
 export { NodePlatformAdapter } from "./platform/node";
 export { BrowserPlatformAdapter } from "./platform/browser";
 export { NodeECIESUint8Provider as NodeECIESProvider } from "./crypto/ecies/node";
@@ -219,11 +27,15 @@ export { ECIESError, isECIESEncrypted, serializeECIES, deserializeECIES, } from
 export type { ECIESProvider, ECIESEncrypted, ECIESOptions, } from "./crypto/ecies";
 export { detectPlatform, createPlatformAdapter, createPlatformAdapterFor, isPlatformSupported, getPlatformCapabilities, } from "./platform/utils";
 export { createNodePlatformAdapter, createBrowserPlatformAdapter, createPlatformAdapterSafe, } from "./platform/browser-safe";
-export { ApiClient } from "./core/apiClient";
-export type { ApiClientConfig, HttpMethod, RequestOptions, } from "./core/apiClient";
-export { VanaNodeImpl };
-export interface VanaWithStores {
-    readonly operationStore?: IOperationStore | IRelayerStateStore;
-    readonly atomicStore?: IAtomicStore;
-    readonly publicClient: PublicClient;
-}
+export { deriveMasterKey, deriveScopeKey, recoverServerOwner, MASTER_KEY_MESSAGE, } from "./crypto/keys/derive";
+export { encryptWithPassword, decryptWithPassword, } from "./crypto/envelope/openpgp";
+export { parseWeb3SignedHeader, verifyWeb3Signed, type Web3SignedPayload, type VerifiedAuth, } from "./auth/web3-signed";
+export { buildWeb3SignedHeader, computeBodyHash, type Web3SignedSignFn, } from "./auth/web3-signed-builder";
+export { MissingAuthError, InvalidSignatureError, ExpiredTokenError, } from "./auth/errors";
+export { generatePkceVerifier, computePkceChallenge, verifyPkceChallenge, assertValidPkceVerifier, PKCE_VERIFIER_PATTERN, PKCE_CHALLENGE_PATTERN, } from "./auth/pkce";
+export { InMemoryTokenStore, type TokenStore, type TokenRecord, } from "./auth/token-store";
+export { fileRegistrationDomain, grantRegistrationDomain, grantRevocationDomain, serverRegistrationDomain, builderRegistrationDomain, FILE_REGISTRATION_TYPES, GRANT_REGISTRATION_TYPES, GRANT_REVOCATION_TYPES, SERVER_REGISTRATION_TYPES, BUILDER_REGISTRATION_TYPES, type DataPortabilityContracts, type DataPortabilityGatewayConfig, type FileRegistrationMessage, type GrantRegistrationMessage, type GrantRevocationMessage, type ServerRegistrationMessage, type BuilderRegistrationMessage, } from "./protocol/eip712";
+export { ScopeSchema, parseScope, scopeToPathSegments, scopeMatchesPattern, scopeCoveredByGrant, type Scope, type ParsedScope, } from "./protocol/scopes";
+export { DataFileEnvelopeSchema, createDataFileEnvelope, IngestResponseSchema, type DataFileEnvelope, type IngestResponse, } from "./protocol/data-file";
+export { createGatewayClient, type GatewayEnvelope, type GatewayProof, type Builder, type Schema, type ServerInfo, type GatewayGrantResponse, type GrantListItem, type FileRecord, type FileListResult, type RegisterServerParams, type RegisterServerResult, type RegisterFileParams, type CreateGrantParams, type RevokeGrantParams, type GatewayClient, } from "./protocol/gateway";
+export { PSError, parsePSError, type PSErrorCode } from "./types/ps-errors";