@opendatalabs/vana-sdk 0.1.0-alpha.ffe4659 → 2.1.0

package/dist/tests/fakes/fake-pgp-port.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Fake PGP implementation for testing
+ *
+ * This provides predictable, fast PGP operations for tests
+ * without needing to mock complex OpenPGP internals.
+ */
+import type { PgpPort, PgpEncryptInput, PgpDecryptInput, PgpResult, PgpKeyPair, PgpKeyPairOptions } from "../../platform/ports/pgp-port";
+export declare class FakePgpPort implements PgpPort {
+    encrypt(input: PgpEncryptInput): Promise<PgpResult>;
+    decrypt(input: PgpDecryptInput): Promise<PgpResult>;
+    generateKeyPair(options?: PgpKeyPairOptions): Promise<PgpKeyPair>;
+}
+export declare const fakePgpPort: FakePgpPort;

package/dist/tests/grantValidation-edge-cases.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/grantValidation-unreachable-branch.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/helper-methods.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/helpers/platformTestHelpers.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Shared platform testing utilities following TypeScript best practices.
+ *
+ * These utilities eliminate the need for 'as any' assertions in platform detection tests
+ * by providing type-safe mock objects and environment setup helpers.
+ *
+ * @module platformTestHelpers
+ */
+export interface NodeEnvironmentGlobals {
+    readonly process: {
+        readonly versions: {
+            readonly node: string;
+        };
+    };
+}
+export interface BrowserEnvironmentGlobals {
+    readonly window: Record<string, unknown>;
+    readonly document: Record<string, unknown>;
+}
+/**
+ * Type-safe platform environment manager for tests.
+ *
+ * This class provides methods to set up different platform environments
+ * without using 'as any' assertions, following official TypeScript best practices.
+ */
+export declare class PlatformTestHelper {
+    private readonly originalState;
+    constructor();
+    /**
+     * Configure globals for Node.js environment detection
+     *
+     * @param nodeVersion - Node.js version string to use
+     */
+    setupNodeEnvironment(nodeVersion?: string): void;
+    /**
+     * Configure globals for browser environment detection
+     */
+    setupBrowserEnvironment(): void;
+    /**
+     * Configure ambiguous environment (should default to Node)
+     */
+    setupAmbiguousEnvironment(): void;
+    /**
+     * Set up browser environment with crypto support
+     *
+     * @param cryptoOverrides - Optional crypto properties to override
+     */
+    setupBrowserWithCrypto(cryptoOverrides?: Partial<Crypto>): void;
+    /**
+     * Set up Node environment with specific process properties
+     *
+     * @param processOverrides - Optional process properties to override
+     */
+    setupNodeWithProcess(processOverrides?: Partial<typeof process>): void;
+    /**
+     * Restore original global state
+     */
+    restore(): void;
+    private captureOriginalState;
+    private restoreGlobal;
+    private clearNodeGlobals;
+    private clearBrowserGlobals;
+    private clearAllGlobals;
+}
+/**
+ * Creates a type-safe mock crypto object for testing.
+ *
+ * @param overrides - Properties to override in the base mock crypto implementation
+ * @returns A mock Crypto object with stubbed SubtleCrypto methods
+ */
+export declare function createMockCrypto(overrides?: Partial<Crypto>): Crypto;
+/**
+ * Creates a type-safe mock Node.js process object for testing.
+ *
+ * @param overrides - Properties to override in the base process mock
+ * @returns A mock process object with platform, version, and environment information
+ */
+export declare function createMockProcess(overrides?: Partial<typeof process>): typeof process;
+/**
+ * Creates a type-safe mock Window object for browser testing.
+ *
+ * @param overrides - Properties to override in the base window mock
+ * @returns A mock window object with document, location, and navigator properties
+ */
+export declare function createMockWindow(overrides?: Partial<Window>): Window & typeof globalThis;
+/**
+ * Creates a type-safe mock Document object for browser testing.
+ *
+ * @param overrides - Properties to override in the base document mock
+ * @returns A mock document object with DOM manipulation methods
+ */
+export declare function createMockDocument(overrides?: Partial<Document>): Document;
+/**
+ * Utility for creating properly typed fetch mocks
+ *
+ * @returns A Vitest mock function typed as the global fetch function
+ */
+export declare function createMockFetch(): typeof fetch;
+/**
+ * Utility for stubbing globals with proper typing using Vitest
+ */
+export declare class VitestGlobalStubber {
+    private stubs;
+    stubGlobal<T>(name: string, value: T): void;
+    restoreAllGlobals(): void;
+}

package/dist/tests/helpers/typedMocks.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Type-safe mock utilities following TypeScript best practices.
+ * These helpers eliminate the need for type assertions in tests.
+ */
+import { vi } from "vitest";
+/**
+ * Creates a typed mock function matching the signature of the provided type.
+ *
+ * @returns A vitest mock function typed to match the specified function signature
+ * @example
+ * ```typescript
+ * const fetchMock = typedFn<typeof fetch>();
+ * vi.stubGlobal('fetch', fetchMock);
+ * ```
+ */
+export declare const typedFn: <T extends (...args: unknown[]) => unknown>() => ReturnType<typeof vi.fn> & T;
+/**
+ * Creates a mock object that satisfies a specific interface.
+ *
+ * @param partial - Partial implementation to use as the mock, with only required methods
+ * @returns A mock object cast to the full interface type
+ * @example
+ * ```typescript
+ * const mockClient = createMock<WalletClient>({
+ *   getChainId: typedFn<WalletClient['getChainId']>(),
+ * });
+ * ```
+ */
+export declare function createMock<T>(partial: Partial<T>): T;
+/**
+ * Stubs a global property with type safety.
+ *
+ * @param key - The name of the global property to stub
+ * @param value - The mock value to use as the stub implementation
+ * @example
+ * ```typescript
+ * stubGlobal('fetch', typedFn<typeof fetch>());
+ * ```
+ */
+export declare function stubGlobal<K extends keyof typeof globalThis>(key: K, value: (typeof globalThis)[K]): void;
+/**
+ * Removes a global property for testing scenarios.
+ *
+ * @param key - The name of the global property to remove from globalThis
+ * @example
+ * ```typescript
+ * removeGlobal('Buffer');
+ * ```
+ */
+export declare function removeGlobal(key: keyof typeof globalThis): void;
+/**
+ * Restores a global property to its original value.
+ *
+ * @param key - The name of the global property to restore
+ * @param value - The original value to restore for the property
+ * @example
+ * ```typescript
+ * const original = globalThis.Buffer;
+ * removeGlobal('Buffer');
+ * // ... test ...
+ * restoreGlobal('Buffer', original);
+ * ```
+ */
+export declare function restoreGlobal<K extends keyof typeof globalThis>(key: K, value: (typeof globalThis)[K]): void;

package/dist/tests/index-browser.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/index-node.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/mocks/platformAdapter.d.ts

@@ -0,0 +1,12 @@
+import type { VanaPlatformAdapter } from "../../platform/interface";
+/**
+ * Shared mock platform adapter for test files
+ * This provides a consistent mock implementation across all tests
+ *
+ * @returns A mock VanaPlatformAdapter instance with mocked methods
+ */
+export declare const createMockPlatformAdapter: () => VanaPlatformAdapter;
+/**
+ * Default mock platform adapter instance for convenience
+ */
+export declare const mockPlatformAdapter: VanaPlatformAdapter;

package/dist/tests/new-permissions-methods.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/no-buffer-browser.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/permissions-grantee.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/permissions-revoke-relayer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/permissions-schema-validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/permissions-server-files.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/permissions-transaction-options.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/permissions-trust-servers.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/permissions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/personal.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/platform-browser.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/platform-crypto-expanded.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/platform-crypto.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/platform-index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/platform-node.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/platform-shared-utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/platform-updated.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/protocol-additional-methods.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/protocol.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/read-only-mode.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/relayer-integration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/relayer-unified.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/schemas.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/server-relayer-handler.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/setup.d.ts

@@ -0,0 +1,7 @@
+export declare const consoleMocks: {
+    getLogCalls: () => unknown[];
+    getWarnCalls: () => unknown[];
+    getErrorCalls: () => unknown[];
+    getDebugCalls: () => unknown[];
+    getInfoCalls: () => unknown[];
+};

package/dist/tests/signatureFormatter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/trusted-server-queries.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/typedDataConverter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/types-contracts.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/types-data.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/types-external-apis.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/types-generics.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/types-permissions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/types-upload-params.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/types.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils-formatters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils-grantFiles-edge-cases.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils-grantFiles-validation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils-grantFiles.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils-grantValidation-consolidated.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils-grants.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils-ipfs-additional.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utils-ipfs.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Test suite for IPFS utilities
+ */
+export {};

package/dist/tests/utils-schemaValidation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/vana.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/wallet-crypto-compatibility.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/atomicStore.cjs

@@ -0,0 +1,31 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var atomicStore_exports = {};
+__export(atomicStore_exports, {
+  hasNonceSupport: () => hasNonceSupport
+});
+module.exports = __toCommonJS(atomicStore_exports);
+function hasNonceSupport(store) {
+  return "atomicAssignNonce" in store && typeof store.atomicAssignNonce === "function";
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  hasNonceSupport
+});
+//# sourceMappingURL=atomicStore.cjs.map

package/dist/types/atomicStore.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/atomicStore.ts"],"sourcesContent":["/**\n * Atomic storage primitives for distributed state management.\n *\n * @module\n */\n\n/**\n * Interface for atomic storage operations required by the SDK's distributed components.\n *\n * @remarks\n * Implementations of this interface MUST guarantee atomicity for all operations.\n * These primitives are used by the SDK's internal components to coordinate\n * distributed state in multi-instance deployments (e.g., serverless functions).\n *\n * The SDK provides a reference Redis implementation, but you can implement\n * this interface using any storage backend that supports atomic operations:\n * - PostgreSQL with advisory locks\n * - DynamoDB with conditional writes\n * - MongoDB with findAndModify\n * - Zookeeper or etcd for coordination\n *\n * @example\n * ```typescript\n * // Using the Redis reference implementation\n * import { RedisAtomicStore } from './lib/redisAtomicStore';\n *\n * const atomicStore = new RedisAtomicStore({\n *   redis: process.env.REDIS_URL\n * });\n *\n * const vana = Vana({\n *   privateKey: process.env.RELAYER_PRIVATE_KEY,\n *   atomicStore\n * });\n * ```\n *\n * @category Storage\n */\nexport interface IAtomicStore {\n  /**\n   * Atomically increments a counter and returns the new value.\n   *\n   * @remarks\n   * This operation MUST be atomic. If the key doesn't exist, it should be\n   * initialized to 0 before incrementing. The operation must return the\n   * value after incrementing.\n   *\n   * This is used primarily for nonce assignment where atomicity is critical\n   * to prevent conflicts under concurrent load.\n   *\n   * @param key - The key to increment\n   * @returns The new value after incrementing\n   *\n   * @example\n   * ```typescript\n   * // First call returns 1\n   * const nonce1 = await store.incr('nonce:0x123:1480');\n   * // Second call returns 2\n   * const nonce2 = await store.incr('nonce:0x123:1480');\n   * ```\n   */\n  incr(key: string): Promise<number>;\n\n  /**\n   * Attempts to acquire a distributed lock with automatic expiration.\n   *\n   * @remarks\n   * This operation MUST be atomic and follow the \"SET NX EX\" semantics:\n   * - Only succeeds if the lock doesn't exist (NX - \"Not eXists\")\n   * - Automatically expires after the specified TTL (EX - \"EXpire\")\n   * - Returns a unique lock ID on success for safe release\n   *\n   * The lock ID should be a unique value (e.g., UUID or timestamp+random)\n   * that prevents accidental release by other processes.\n   *\n   * @param key - The lock key\n   * @param ttlSeconds - Time-to-live in seconds (automatic expiration)\n   * @returns A unique lock ID if acquired, null if lock is already held\n   *\n   * @example\n   * ```typescript\n   * const lockId = await store.acquireLock('nonce:lock:0x123', 5);\n   * if (lockId) {\n   *   try {\n   *     // Critical section - only one process can be here\n   *     await performCriticalOperation();\n   *   } finally {\n   *     await store.releaseLock('nonce:lock:0x123', lockId);\n   *   }\n   * }\n   * ```\n   */\n  acquireLock(key: string, ttlSeconds: number): Promise<string | null>;\n\n  /**\n   * Releases a previously acquired lock.\n   *\n   * @remarks\n   * This operation MUST be atomic and safe. It should only succeed if the\n   * provided lockId matches the current lock value. This prevents accidental\n   * release of locks acquired by other processes.\n   *\n   * Implementations should use compare-and-delete semantics or a Lua script\n   * (in Redis) to ensure atomicity.\n   *\n   * @param key - The lock key\n   * @param lockId - The unique ID returned by acquireLock\n   *\n   * @example\n   * ```typescript\n   * const lockId = await store.acquireLock('lock:key', 5);\n   * if (lockId) {\n   *   // ... do work ...\n   *   await store.releaseLock('lock:key', lockId);\n   * }\n   * ```\n   */\n  releaseLock(key: string, lockId: string): Promise<void>;\n\n  /**\n   * Gets the value associated with a key.\n   *\n   * @remarks\n   * This is a simple read operation. It should return null if the key\n   * doesn't exist.\n   *\n   * @param key - The key to retrieve\n   * @returns The stored value, or null if not found\n   *\n   * @example\n   * ```typescript\n   * const lastUsedNonce = await store.get('lastNonce:0x123:1480');\n   * ```\n   */\n  get(key: string): Promise<string | null>;\n\n  /**\n   * Sets a key-value pair.\n   *\n   * @remarks\n   * This is a simple write operation. It should overwrite any existing value.\n   *\n   * @param key - The key to set\n   * @param value - The value to store\n   *\n   * @example\n   * ```typescript\n   * await store.set('lastNonce:0x123:1480', '42');\n   * ```\n   */\n  set(key: string, value: string): Promise<void>;\n\n  /**\n   * Sets a key-value pair with expiration.\n   *\n   * @remarks\n   * This operation sets a value with automatic expiration after the specified TTL.\n   * Useful for temporary state that should be automatically cleaned up.\n   *\n   * @param key - The key to set\n   * @param value - The value to store\n   * @param ttlSeconds - Time-to-live in seconds\n   *\n   * @example\n   * ```typescript\n   * // Store operation state for 24 hours\n   * await store.setWithTTL('operation:123', JSON.stringify(state), 86400);\n   * ```\n   */\n  setWithTTL?(key: string, value: string, ttlSeconds: number): Promise<void>;\n\n  /**\n   * Deletes a key.\n   *\n   * @remarks\n   * This operation removes a key from storage. Should be idempotent\n   * (no error if key doesn't exist).\n   *\n   * @param key - The key to delete\n   *\n   * @example\n   * ```typescript\n   * await store.delete('temp:data:123');\n   * ```\n   */\n  delete?(key: string): Promise<void>;\n\n  /**\n   * Executes an atomic script (e.g., Lua in Redis, stored procedure in SQL).\n   *\n   * @remarks\n   * This is an optional method that allows execution of atomic scripts\n   * for complex operations that require multiple steps to be atomic.\n   * Not all stores support this - simple stores may omit it.\n   *\n   * For Redis: executes a Lua script\n   * For PostgreSQL: executes a stored procedure or CTE\n   * For DynamoDB: might use TransactWrite\n   *\n   * @param script - The script to execute\n   * @param keys - Array of keys the script will operate on\n   * @param args - Array of arguments to pass to the script\n   * @returns The script's return value\n   *\n   * @example\n   * ```typescript\n   * const result = await store.eval(\n   *   'return redis.call(\"INCR\", KEYS[1])',\n   *   ['counter:users'],\n   *   []\n   * );\n   * ```\n   */\n  eval?(script: string, keys: string[], args: string[]): Promise<any>;\n}\n\n/**\n * Extended atomic store interface with nonce support.\n *\n * @remarks\n * Some atomic stores (like Redis) provide optimized atomic nonce assignment\n * through native scripting capabilities. This interface extends the base\n * IAtomicStore with this optional optimization.\n *\n * @internal\n */\nexport interface IAtomicStoreWithNonceSupport extends IAtomicStore {\n  /**\n   * Atomically assigns a nonce with gap prevention.\n   *\n   * @param key - The storage key for the last used nonce\n   * @param pendingCount - The current pending transaction count from blockchain\n   * @returns The assigned nonce\n   */\n  atomicAssignNonce(key: string, pendingCount: number): Promise<number>;\n}\n\n/**\n * Type guard to check if an atomic store supports optimized nonce assignment.\n *\n * @param store - The atomic store to check\n * @returns True if the store supports atomicAssignNonce\n *\n * @internal\n */\nexport function hasNonceSupport(\n  store: IAtomicStore,\n): store is IAtomicStoreWithNonceSupport {\n  return (\n    \"atomicAssignNonce\" in store &&\n    typeof (store as IAtomicStoreWithNonceSupport).atomicAssignNonce ===\n      \"function\"\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAqPO,SAAS,gBACd,OACuC;AACvC,SACE,uBAAuB,SACvB,OAAQ,MAAuC,sBAC7C;AAEN;","names":[]}