@opendatalabs/vana-sdk 0.1.0-alpha.4584bee → 0.1.0-alpha.47bbd13

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/blockchain.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 blockchain_exports = {};
+module.exports = __toCommonJS(blockchain_exports);
+//# sourceMappingURL=blockchain.cjs.map

package/dist/types/blockchain.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/blockchain.ts"],"sourcesContent":["/**\n * Defines core blockchain interaction types.\n *\n * @remarks\n * This module provides fundamental types for blockchain transactions,\n * including transaction requests, confirmation options, and results.\n * These types form the basis for all blockchain interactions in the SDK.\n *\n * @category Types\n * @module types/blockchain\n */\n\nimport type { Hash, Address } from \"viem\";\n\n/**\n * Represents a submitted blockchain transaction awaiting confirmation.\n *\n * @remarks\n * Returned immediately after transaction submission, before confirmation.\n * Use `waitForTransactionEvents` to wait for confirmation and retrieve events.\n *\n * @category Blockchain\n */\nexport interface TransactionRequest {\n  /** Transaction hash */\n  hash: Hash;\n  /** Account that initiated the transaction */\n  from: Address;\n  /** Contract that was called */\n  contractName: string;\n  /** Function that was called */\n  functionName: string;\n  /** Function arguments (for debugging/logging) */\n  args?: readonly unknown[];\n}\n\n/**\n * Configures transaction confirmation waiting behavior.\n *\n * @remarks\n * Controls how long and how often to check for transaction confirmation.\n * Adjust based on network congestion and application requirements.\n *\n * @category Blockchain\n */\nexport interface TransactionWaitOptions {\n  /** Number of confirmations to wait for (default: 1) */\n  confirmations?: number;\n  /** Timeout in milliseconds (default: 30000) */\n  timeout?: number;\n  /** Polling interval in milliseconds (default: 4000) */\n  pollingInterval?: number;\n}\n\n/**\n * Represents a confirmed blockchain transaction with metadata.\n *\n * @remarks\n * Contains essential transaction information after confirmation including\n * gas usage, block number, and function details. Extended by specific\n * result types with parsed events.\n *\n * @category Blockchain\n */\nexport interface TransactionResult {\n  /** Transaction hash */\n  transactionHash: Hash;\n  /** Block number where transaction was included */\n  blockNumber: bigint;\n  /** Gas used by the transaction */\n  gasUsed: bigint;\n  /** Account that initiated the transaction */\n  from: Address;\n  /** Contract that was called */\n  contractName: string;\n  /** Function that was called */\n  functionName: string;\n}\n\n/**\n * @remarks\n * Event typing strategy:\n * - Event arguments are dynamically typed based on contract mappings\n * - `parseTransaction` returns `expectedEvents` with typed args for mapped functions\n * - `allEvents` contains all parsed events from the transaction\n * - This approach lets the mapping file drive types rather than requiring\n *   specific result interfaces per event type\n *\n * @internal\n */\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/blockchain.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Defines core blockchain interaction types.
+ *
+ * @remarks
+ * This module provides fundamental types for blockchain transactions,
+ * including transaction requests, confirmation options, and results.
+ * These types form the basis for all blockchain interactions in the SDK.
+ *
+ * @category Types
+ * @module types/blockchain
+ */
+import type { Hash, Address } from "viem";
+/**
+ * Represents a submitted blockchain transaction awaiting confirmation.
+ *
+ * @remarks
+ * Returned immediately after transaction submission, before confirmation.
+ * Use `waitForTransactionEvents` to wait for confirmation and retrieve events.
+ *
+ * @category Blockchain
+ */
+export interface TransactionRequest {
+    /** Transaction hash */
+    hash: Hash;
+    /** Account that initiated the transaction */
+    from: Address;
+    /** Contract that was called */
+    contractName: string;
+    /** Function that was called */
+    functionName: string;
+    /** Function arguments (for debugging/logging) */
+    args?: readonly unknown[];
+}
+/**
+ * Configures transaction confirmation waiting behavior.
+ *
+ * @remarks
+ * Controls how long and how often to check for transaction confirmation.
+ * Adjust based on network congestion and application requirements.
+ *
+ * @category Blockchain
+ */
+export interface TransactionWaitOptions {
+    /** Number of confirmations to wait for (default: 1) */
+    confirmations?: number;
+    /** Timeout in milliseconds (default: 30000) */
+    timeout?: number;
+    /** Polling interval in milliseconds (default: 4000) */
+    pollingInterval?: number;
+}
+/**
+ * Represents a confirmed blockchain transaction with metadata.
+ *
+ * @remarks
+ * Contains essential transaction information after confirmation including
+ * gas usage, block number, and function details. Extended by specific
+ * result types with parsed events.
+ *
+ * @category Blockchain
+ */
+export interface TransactionResult {
+    /** Transaction hash */
+    transactionHash: Hash;
+    /** Block number where transaction was included */
+    blockNumber: bigint;
+    /** Gas used by the transaction */
+    gasUsed: bigint;
+    /** Account that initiated the transaction */
+    from: Address;
+    /** Contract that was called */
+    contractName: string;
+    /** Function that was called */
+    functionName: string;
+}
+/**
+ * @remarks
+ * Event typing strategy:
+ * - Event arguments are dynamically typed based on contract mappings
+ * - `parseTransaction` returns `expectedEvents` with typed args for mapped functions
+ * - `allEvents` contains all parsed events from the transaction
+ * - This approach lets the mapping file drive types rather than requiring
+ *   specific result interfaces per event type
+ *
+ * @internal
+ */

package/dist/types/blockchain.js

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

package/dist/types/blockchain.js.map

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

package/dist/types/chains-additional.test.d.ts

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

package/dist/types/chains.cjs

@@ -0,0 +1,36 @@
+"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 chains_exports = {};
+__export(chains_exports, {
+  isVanaChain: () => isVanaChain,
+  isVanaChainId: () => isVanaChainId
+});
+module.exports = __toCommonJS(chains_exports);
+function isVanaChainId(chainId) {
+  return chainId === 14800 || chainId === 1480;
+}
+function isVanaChain(chain) {
+  return isVanaChainId(chain.id);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  isVanaChain,
+  isVanaChainId
+});
+//# sourceMappingURL=chains.cjs.map

package/dist/types/chains.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/chains.ts"],"sourcesContent":["import type { Chain } from \"viem\";\n\n/**\n * Represents the supported Vana network chain identifiers.\n *\n * @remarks\n * The Vana protocol operates on two primary networks:\n * - `14800`: Moksha testnet for development and testing\n * - `1480`: Vana mainnet for production deployment\n *\n * Use these chain IDs when configuring the SDK or checking network compatibility.\n *\n * @category Blockchain\n * @see {@link https://docs.vana.org/docs/networks | Network Documentation}\n */\nexport type VanaChainId = 14800 | 1480;\n\n/**\n * Extends viem's Chain type with Vana-specific chain constraints.\n *\n * @remarks\n * Ensures type safety for Vana-specific chains by restricting the chain ID\n * to supported networks. This type provides full viem Chain compatibility\n * while guaranteeing the chain is a valid Vana network.\n *\n * @category Blockchain\n */\nexport type VanaChain = Chain & {\n  id: VanaChainId;\n};\n\n/**\n * Maps Vana chain IDs to their complete chain configurations.\n *\n * @remarks\n * Provides type-safe access to chain configurations indexed by chain ID.\n * Use this for dynamic chain selection based on runtime chain ID values.\n *\n * @category Blockchain\n * @example\n * ```typescript\n * const configs: ChainConfig = {\n *   14800: mokshaTestnet,\n *   1480: vanaMainnet\n * };\n * const chain = configs[chainId];\n * ```\n */\nexport type ChainConfig = {\n  [K in VanaChainId]: VanaChain;\n};\n\n/**\n * Validates whether a chain ID represents a supported Vana network.\n *\n * @remarks\n * Type guard for runtime validation of chain IDs from external sources.\n * Use when accepting user input or processing network configurations.\n *\n * @param chainId - The chain ID to validate\n * @returns `true` if the chain ID is a supported Vana network, `false` otherwise\n *\n * @example\n * ```typescript\n * const chainId = parseInt(process.env.CHAIN_ID);\n *\n * if (!isVanaChainId(chainId)) {\n *   throw new Error(`Unsupported chain ID: ${chainId}`);\n * }\n *\n * // TypeScript now knows chainId is VanaChainId\n * const config = getChainConfig(chainId);\n * ```\n *\n * @category Blockchain\n */\nexport function isVanaChainId(chainId: number): chainId is VanaChainId {\n  return chainId === 14800 || chainId === 1480;\n}\n\n/**\n * Validates whether a Chain object represents a supported Vana network.\n *\n * @remarks\n * Type guard for validating viem Chain objects as Vana chains.\n * Ensures both type safety and runtime validation for chain compatibility.\n *\n * @param chain - The chain object to validate\n * @returns `true` if the chain is a supported Vana network, `false` otherwise\n *\n * @example\n * ```typescript\n * import { mainnet, mokshaTestnet } from 'viem/chains';\n *\n * if (isVanaChain(chain)) {\n *   // TypeScript knows this is a VanaChain\n *   console.log(`Connected to Vana network: ${chain.id}`);\n * } else {\n *   console.error('Please connect to a Vana network');\n * }\n * ```\n *\n * @category Blockchain\n */\nexport function isVanaChain(chain: Chain): chain is VanaChain {\n  return isVanaChainId(chain.id);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA4EO,SAAS,cAAc,SAAyC;AACrE,SAAO,YAAY,SAAS,YAAY;AAC1C;AA0BO,SAAS,YAAY,OAAkC;AAC5D,SAAO,cAAc,MAAM,EAAE;AAC/B;","names":[]}

package/dist/types/chains.d.ts

@@ -0,0 +1,98 @@
+import type { Chain } from "viem";
+/**
+ * Represents the supported Vana network chain identifiers.
+ *
+ * @remarks
+ * The Vana protocol operates on two primary networks:
+ * - `14800`: Moksha testnet for development and testing
+ * - `1480`: Vana mainnet for production deployment
+ *
+ * Use these chain IDs when configuring the SDK or checking network compatibility.
+ *
+ * @category Blockchain
+ * @see {@link https://docs.vana.org/docs/networks | Network Documentation}
+ */
+export type VanaChainId = 14800 | 1480;
+/**
+ * Extends viem's Chain type with Vana-specific chain constraints.
+ *
+ * @remarks
+ * Ensures type safety for Vana-specific chains by restricting the chain ID
+ * to supported networks. This type provides full viem Chain compatibility
+ * while guaranteeing the chain is a valid Vana network.
+ *
+ * @category Blockchain
+ */
+export type VanaChain = Chain & {
+    id: VanaChainId;
+};
+/**
+ * Maps Vana chain IDs to their complete chain configurations.
+ *
+ * @remarks
+ * Provides type-safe access to chain configurations indexed by chain ID.
+ * Use this for dynamic chain selection based on runtime chain ID values.
+ *
+ * @category Blockchain
+ * @example
+ * ```typescript
+ * const configs: ChainConfig = {
+ *   14800: mokshaTestnet,
+ *   1480: vanaMainnet
+ * };
+ * const chain = configs[chainId];
+ * ```
+ */
+export type ChainConfig = {
+    [K in VanaChainId]: VanaChain;
+};
+/**
+ * Validates whether a chain ID represents a supported Vana network.
+ *
+ * @remarks
+ * Type guard for runtime validation of chain IDs from external sources.
+ * Use when accepting user input or processing network configurations.
+ *
+ * @param chainId - The chain ID to validate
+ * @returns `true` if the chain ID is a supported Vana network, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * const chainId = parseInt(process.env.CHAIN_ID);
+ *
+ * if (!isVanaChainId(chainId)) {
+ *   throw new Error(`Unsupported chain ID: ${chainId}`);
+ * }
+ *
+ * // TypeScript now knows chainId is VanaChainId
+ * const config = getChainConfig(chainId);
+ * ```
+ *
+ * @category Blockchain
+ */
+export declare function isVanaChainId(chainId: number): chainId is VanaChainId;
+/**
+ * Validates whether a Chain object represents a supported Vana network.
+ *
+ * @remarks
+ * Type guard for validating viem Chain objects as Vana chains.
+ * Ensures both type safety and runtime validation for chain compatibility.
+ *
+ * @param chain - The chain object to validate
+ * @returns `true` if the chain is a supported Vana network, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * import { mainnet, mokshaTestnet } from 'viem/chains';
+ *
+ * if (isVanaChain(chain)) {
+ *   // TypeScript knows this is a VanaChain
+ *   console.log(`Connected to Vana network: ${chain.id}`);
+ * } else {
+ *   console.error('Please connect to a Vana network');
+ * }
+ * ```
+ *
+ * @category Blockchain
+ */
+export declare function isVanaChain(chain: Chain): chain is VanaChain;