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

package/dist/contracts/contractController.d.ts

@@ -0,0 +1,79 @@
+import type { Abi } from "abitype";
+import { type GetContractReturnType, type PublicClient, type WalletClient } from "viem";
+import { type ContractAbis, type VanaContract } from "../generated/abi";
+import type { VanaChainId, ContractInfo } from "../types/index";
+import { createClient } from "../core/client";
+export declare const contractCacheForTesting: Map<string, {
+    address: `0x${string}`;
+    abi: Abi;
+}>;
+/**
+ * Gets a typed contract instance for the specified contract name with full type inference.
+ * This function provides complete type safety following viem's patterns.
+ *
+ * @param contract - Name of the contract to instantiate (must be a const assertion for full typing)
+ * @param client - Optional viem client instance
+ * @returns A fully typed contract instance with methods corresponding to the contract's ABI
+ * @example
+ * ```typescript
+ * // Full type inference with const assertion
+ * const dataRegistry = getContractController("DataRegistry" as const, client);
+ *
+ * // Now dataRegistry has full type inference for all methods
+ * const result = await dataRegistry.read.getFileCount(); // Type: bigint
+ * await dataRegistry.write.addFile([url, proof]); // Typed parameters
+ * ```
+ */
+export declare function getContractController<T extends VanaContract>(contract: T, client?: PublicClient | WalletClient | ReturnType<typeof createClient>): GetContractReturnType<ContractAbis[T]>;
+/**
+ * Gets contract information (address and ABI) without creating a contract instance.
+ * Useful for cases where you need contract details but don't want to create a client connection.
+ *
+ * @param contract - Name of the contract
+ * @param chainId - Chain ID (defaults to Vana mainnet)
+ * @returns Contract information with typed ABI
+ * @example
+ * ```typescript
+ * const info = getContractInfo("DataRegistry" as const, 14800);
+ * console.log(info.address); // Typed as Address
+ * console.log(info.abi); // Fully typed ABI
+ * ```
+ */
+export declare function getContractInfo<T extends VanaContract>(contract: T, chainId?: VanaChainId): ContractInfo<ContractAbis[T]>;
+/**
+ * Type-safe contract factory that creates contract instances with full type inference.
+ * This provides an alternative API that's more explicit about typing.
+ */
+export declare class ContractFactory {
+    private readonly client;
+    private readonly chainId;
+    constructor(client: PublicClient | WalletClient | ReturnType<typeof createClient>);
+    /**
+     * Creates a typed contract instance
+     *
+     * @param contract - Contract name (use const assertion for full typing)
+     * @returns Fully typed contract instance
+     */
+    create<T extends VanaContract>(contract: T): GetContractReturnType<ContractAbis[T]>;
+    /**
+     * Gets contract information without creating an instance
+     *
+     * @param contract - Contract name
+     * @returns Contract information with typed ABI
+     */
+    getInfo<T extends VanaContract>(contract: T): ContractInfo<ContractAbis[T]>;
+    /**
+     * Lists all available contracts for the current chain
+     *
+     * @returns Array of contract names available on this chain
+     */
+    getAvailableContracts(): VanaContract[];
+}
+/**
+ * Clears the contract cache. Useful for testing or when chain configurations change.
+ *
+ * @param contract - Optional specific contract to clear, or clear all if not provided
+ * @param chainId - Optional specific chain to clear, or clear all if not provided
+ */
+export declare function clearContractCache(contract?: VanaContract, chainId?: number): void;
+export type { GetContractReturnType } from "viem";

package/dist/contracts/contractController.js

@@ -0,0 +1,100 @@
+import {
+  getContract
+} from "viem";
+import { getAbi } from "../generated/abi";
+import { getContractAddress, CONTRACT_ADDRESSES } from "../config/addresses";
+import { createClient } from "../core/client";
+import { vanaMainnet } from "../config/chains";
+const contractCache = /* @__PURE__ */ new Map();
+const contractCacheForTesting = contractCache;
+function createCacheKey(contract, chainId) {
+  return `${contract}:${chainId}`;
+}
+function getContractController(contract, client = createClient()) {
+  const chainId = client.chain?.id ?? vanaMainnet.id;
+  const cacheKey = createCacheKey(contract, chainId);
+  let controller = contractCache.get(cacheKey);
+  if (!controller) {
+    controller = getContract({
+      address: getContractAddress(chainId, contract),
+      abi: getAbi(contract),
+      client
+    });
+    contractCache.set(cacheKey, controller);
+  }
+  return controller;
+}
+function getContractInfo(contract, chainId = vanaMainnet.id) {
+  return {
+    address: getContractAddress(chainId, contract),
+    abi: getAbi(contract)
+  };
+}
+class ContractFactory {
+  client;
+  chainId;
+  constructor(client) {
+    this.client = client;
+    try {
+      this.chainId = client.chain?.id ?? vanaMainnet.id;
+    } catch {
+      this.chainId = vanaMainnet.id;
+    }
+  }
+  /**
+   * Creates a typed contract instance
+   *
+   * @param contract - Contract name (use const assertion for full typing)
+   * @returns Fully typed contract instance
+   */
+  create(contract) {
+    return getContractController(contract, this.client);
+  }
+  /**
+   * Gets contract information without creating an instance
+   *
+   * @param contract - Contract name
+   * @returns Contract information with typed ABI
+   */
+  getInfo(contract) {
+    return getContractInfo(contract, this.chainId);
+  }
+  /**
+   * Lists all available contracts for the current chain
+   *
+   * @returns Array of contract names available on this chain
+   */
+  getAvailableContracts() {
+    const chainAddresses = CONTRACT_ADDRESSES[this.chainId];
+    if (!chainAddresses) return [];
+    return Object.keys(chainAddresses);
+  }
+}
+function clearContractCache(contract, chainId) {
+  if (contract && chainId) {
+    const cacheKey = createCacheKey(contract, chainId);
+    contractCache.delete(cacheKey);
+  } else if (contract) {
+    for (const key of contractCache.keys()) {
+      if (key.startsWith(`${contract}:`)) {
+        contractCache.delete(key);
+      }
+    }
+  } else if (chainId) {
+    for (const key of contractCache.keys()) {
+      if (key.endsWith(`:${chainId}`)) {
+        contractCache.delete(key);
+      }
+    }
+  } else {
+    contractCache.clear();
+  }
+}
+export {
+  ContractFactory,
+  clearContractCache,
+  contractCacheForTesting,
+  getContractController,
+  getContractInfo
+};
+//# sourceMappingURL=contractController.js.map

package/dist/contracts/contractController.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/contracts/contractController.ts"],"sourcesContent":["import type { Abi } from \"abitype\";\nimport {\n  getContract,\n  type GetContractReturnType,\n  type PublicClient,\n  type WalletClient,\n} from \"viem\";\nimport { type ContractAbis, getAbi, type VanaContract } from \"../generated/abi\";\nimport type { VanaChainId, ContractInfo } from \"../types/index\";\nimport { getContractAddress, CONTRACT_ADDRESSES } from \"../config/addresses\";\nimport { createClient } from \"../core/client\";\nimport { vanaMainnet } from \"../config/chains\";\n\n// Cache for contract instances - keyed by contract name and chain ID\nconst contractCache = new Map<string, GetContractReturnType<Abi>>();\n\n// Export cache for testing\nexport const contractCacheForTesting = contractCache;\n\n/**\n * Creates a cache key for contract instances\n *\n * @param contract - The contract name to create a cache key for\n * @param chainId - The chain ID to include in the cache key\n * @returns A string cache key combining contract name and chain ID\n */\nfunction createCacheKey(contract: VanaContract, chainId: number): string {\n  return `${contract}:${chainId}`;\n}\n\n/**\n * Gets a typed contract instance for the specified contract name with full type inference.\n * This function provides complete type safety following viem's patterns.\n *\n * @param contract - Name of the contract to instantiate (must be a const assertion for full typing)\n * @param client - Optional viem client instance\n * @returns A fully typed contract instance with methods corresponding to the contract's ABI\n * @example\n * ```typescript\n * // Full type inference with const assertion\n * const dataRegistry = getContractController(\"DataRegistry\" as const, client);\n *\n * // Now dataRegistry has full type inference for all methods\n * const result = await dataRegistry.read.getFileCount(); // Type: bigint\n * await dataRegistry.write.addFile([url, proof]); // Typed parameters\n * ```\n */\nexport function getContractController<T extends VanaContract>(\n  contract: T,\n  client:\n    | PublicClient\n    | WalletClient\n    | ReturnType<typeof createClient> = createClient(),\n): GetContractReturnType<ContractAbis[T]> {\n  const chainId = client.chain?.id ?? vanaMainnet.id;\n  const cacheKey = createCacheKey(contract, chainId);\n\n  let controller = contractCache.get(cacheKey);\n\n  if (!controller) {\n    controller = getContract({\n      address: getContractAddress(chainId, contract),\n      abi: getAbi(contract),\n      client,\n    }) as GetContractReturnType<ContractAbis[T]>;\n\n    contractCache.set(cacheKey, controller);\n  }\n\n  return controller as GetContractReturnType<ContractAbis[T]>;\n}\n\n/**\n * Gets contract information (address and ABI) without creating a contract instance.\n * Useful for cases where you need contract details but don't want to create a client connection.\n *\n * @param contract - Name of the contract\n * @param chainId - Chain ID (defaults to Vana mainnet)\n * @returns Contract information with typed ABI\n * @example\n * ```typescript\n * const info = getContractInfo(\"DataRegistry\" as const, 14800);\n * console.log(info.address); // Typed as Address\n * console.log(info.abi); // Fully typed ABI\n * ```\n */\nexport function getContractInfo<T extends VanaContract>(\n  contract: T,\n  chainId: VanaChainId = vanaMainnet.id as VanaChainId,\n): ContractInfo<ContractAbis[T]> {\n  return {\n    address: getContractAddress(chainId, contract),\n    abi: getAbi(contract),\n  };\n}\n\n/**\n * Type-safe contract factory that creates contract instances with full type inference.\n * This provides an alternative API that's more explicit about typing.\n */\nexport class ContractFactory {\n  private readonly client:\n    | PublicClient\n    | WalletClient\n    | ReturnType<typeof createClient>;\n  private readonly chainId: number;\n\n  constructor(\n    client: PublicClient | WalletClient | ReturnType<typeof createClient>,\n  ) {\n    this.client = client;\n    try {\n      this.chainId = client.chain?.id ?? vanaMainnet.id;\n    } catch {\n      this.chainId = vanaMainnet.id;\n    }\n  }\n\n  /**\n   * Creates a typed contract instance\n   *\n   * @param contract - Contract name (use const assertion for full typing)\n   * @returns Fully typed contract instance\n   */\n  create<T extends VanaContract>(\n    contract: T,\n  ): GetContractReturnType<ContractAbis[T]> {\n    return getContractController(contract, this.client);\n  }\n\n  /**\n   * Gets contract information without creating an instance\n   *\n   * @param contract - Contract name\n   * @returns Contract information with typed ABI\n   */\n  getInfo<T extends VanaContract>(contract: T): ContractInfo<ContractAbis[T]> {\n    return getContractInfo(contract, this.chainId as VanaChainId);\n  }\n\n  /**\n   * Lists all available contracts for the current chain\n   *\n   * @returns Array of contract names available on this chain\n   */\n  getAvailableContracts(): VanaContract[] {\n    // Return all contract names that have addresses on this chain\n    const chainAddresses = CONTRACT_ADDRESSES[this.chainId];\n    if (!chainAddresses) return [];\n\n    return Object.keys(chainAddresses) as VanaContract[];\n  }\n}\n\n/**\n * Clears the contract cache. Useful for testing or when chain configurations change.\n *\n * @param contract - Optional specific contract to clear, or clear all if not provided\n * @param chainId - Optional specific chain to clear, or clear all if not provided\n */\nexport function clearContractCache(\n  contract?: VanaContract,\n  chainId?: number,\n): void {\n  if (contract && chainId) {\n    const cacheKey = createCacheKey(contract, chainId);\n    contractCache.delete(cacheKey);\n  } else if (contract) {\n    // Clear all instances of this contract across all chains\n    for (const key of contractCache.keys()) {\n      if (key.startsWith(`${contract}:`)) {\n        contractCache.delete(key);\n      }\n    }\n  } else if (chainId) {\n    // Clear all contracts for this chain\n    for (const key of contractCache.keys()) {\n      if (key.endsWith(`:${chainId}`)) {\n        contractCache.delete(key);\n      }\n    }\n  } else {\n    // Clear entire cache\n    contractCache.clear();\n  }\n}\n\n// Function is already exported above, no need for redundant export\n\n// Type-only exports for enhanced type safety\nexport type { GetContractReturnType } from \"viem\";\n"],"mappings":"AACA;AAAA,EACE;AAAA,OAIK;AACP,SAA4B,cAAiC;AAE7D,SAAS,oBAAoB,0BAA0B;AACvD,SAAS,oBAAoB;AAC7B,SAAS,mBAAmB;AAG5B,MAAM,gBAAgB,oBAAI,IAAwC;AAG3D,MAAM,0BAA0B;AASvC,SAAS,eAAe,UAAwB,SAAyB;AACvE,SAAO,GAAG,QAAQ,IAAI,OAAO;AAC/B;AAmBO,SAAS,sBACd,UACA,SAGsC,aAAa,GACX;AACxC,QAAM,UAAU,OAAO,OAAO,MAAM,YAAY;AAChD,QAAM,WAAW,eAAe,UAAU,OAAO;AAEjD,MAAI,aAAa,cAAc,IAAI,QAAQ;AAE3C,MAAI,CAAC,YAAY;AACf,iBAAa,YAAY;AAAA,MACvB,SAAS,mBAAmB,SAAS,QAAQ;AAAA,MAC7C,KAAK,OAAO,QAAQ;AAAA,MACpB;AAAA,IACF,CAAC;AAED,kBAAc,IAAI,UAAU,UAAU;AAAA,EACxC;AAEA,SAAO;AACT;AAgBO,SAAS,gBACd,UACA,UAAuB,YAAY,IACJ;AAC/B,SAAO;AAAA,IACL,SAAS,mBAAmB,SAAS,QAAQ;AAAA,IAC7C,KAAK,OAAO,QAAQ;AAAA,EACtB;AACF;AAMO,MAAM,gBAAgB;AAAA,EACV;AAAA,EAIA;AAAA,EAEjB,YACE,QACA;AACA,SAAK,SAAS;AACd,QAAI;AACF,WAAK,UAAU,OAAO,OAAO,MAAM,YAAY;AAAA,IACjD,QAAQ;AACN,WAAK,UAAU,YAAY;AAAA,IAC7B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OACE,UACwC;AACxC,WAAO,sBAAsB,UAAU,KAAK,MAAM;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QAAgC,UAA4C;AAC1E,WAAO,gBAAgB,UAAU,KAAK,OAAsB;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,wBAAwC;AAEtC,UAAM,iBAAiB,mBAAmB,KAAK,OAAO;AACtD,QAAI,CAAC,eAAgB,QAAO,CAAC;AAE7B,WAAO,OAAO,KAAK,cAAc;AAAA,EACnC;AACF;AAQO,SAAS,mBACd,UACA,SACM;AACN,MAAI,YAAY,SAAS;AACvB,UAAM,WAAW,eAAe,UAAU,OAAO;AACjD,kBAAc,OAAO,QAAQ;AAAA,EAC/B,WAAW,UAAU;AAEnB,eAAW,OAAO,cAAc,KAAK,GAAG;AACtC,UAAI,IAAI,WAAW,GAAG,QAAQ,GAAG,GAAG;AAClC,sBAAc,OAAO,GAAG;AAAA,MAC1B;AAAA,IACF;AAAA,EACF,WAAW,SAAS;AAElB,eAAW,OAAO,cAAc,KAAK,GAAG;AACtC,UAAI,IAAI,SAAS,IAAI,OAAO,EAAE,GAAG;AAC/B,sBAAc,OAAO,GAAG;AAAA,MAC1B;AAAA,IACF;AAAA,EACF,OAAO;AAEL,kBAAc,MAAM;AAAA,EACtB;AACF;","names":[]}

package/dist/contracts/tests/contractController.test.d.ts

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

package/dist/controllers/__tests__/schemas-edge-cases.test.d.ts

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

package/dist/controllers/data-error-handling.test.d.ts

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