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

package/dist/controllers/base.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Base controller class providing common functionality for all controllers.
+ *
+ * @remarks
+ * This abstract class establishes the foundation for all Vana SDK controllers,
+ * providing shared utilities like wallet validation and context management.
+ * All controllers should extend this base class to ensure consistency and
+ * shared behavior across the SDK.
+ *
+ * The class follows the Single Responsibility Principle by handling only
+ * the core controller concerns while leaving specific functionality to
+ * implementing classes.
+ *
+ * @category Controllers
+ */
+import type { WalletClient } from "viem";
+import type { ControllerContext } from "../types/controller-context";
+import type { TransactionOptions } from "../types/operations";
+/**
+ * Abstract base controller that all Vana SDK controllers extend.
+ *
+ * @remarks
+ * Provides common functionality and patterns used across all controllers,
+ * including wallet validation and context management. This ensures
+ * consistency and reduces code duplication throughout the SDK.
+ *
+ * Key features:
+ * - Wallet client validation with TypeScript assertion signatures
+ * - Consistent error handling for read-only scenarios
+ * - Shared context management patterns
+ * - Type-safe wallet operations
+ *
+ * @example
+ * ```typescript
+ * class MyController extends BaseController {
+ *   async performWalletOperation() {
+ *     this.assertWallet(); // Ensures wallet is available
+ *     // Now this.context.walletClient is guaranteed to be available
+ *     const address = await this.context.walletClient.getAddresses();
+ *     return address[0];
+ *   }
+ * }
+ * ```
+ */
+export declare abstract class BaseController {
+    protected readonly context: ControllerContext;
+    /**
+     * Creates a new controller instance with the provided context.
+     *
+     * @param context - The controller context containing clients and configuration
+     */
+    constructor(context: ControllerContext);
+    /**
+     * Asserts that a wallet client with an account is available for operations requiring signing.
+     *
+     * @remarks
+     * This method uses TypeScript assertion signatures to narrow the type of
+     * `this.context` to guarantee that `walletClient` with an account is available
+     * after the call succeeds. This provides compile-time safety for wallet operations
+     * while enabling clear error messages for read-only scenarios.
+     *
+     * The assertion signature ensures that after calling this method,
+     * TypeScript knows that `this.context.walletClient` is definitely available
+     * with a configured account.
+     *
+     * @throws {ReadOnlyError} When no wallet client is configured
+     * @throws {Error} When wallet client exists but no account is configured
+     *
+     * @example
+     * ```typescript
+     * async performWalletOperation() {
+     *   this.assertWallet(); // Type assertion + runtime check
+     *
+     *   // TypeScript now knows walletClient and account are available
+     *   const account = this.context.walletClient.account;
+     *   const address = typeof account === 'string' ? account : account.address;
+     * }
+     * ```
+     */
+    protected assertWallet(): asserts this is {
+        context: ControllerContext & {
+            walletClient: WalletClient;
+        };
+    };
+    /**
+     * Helper to safely spread transaction options for viem compatibility.
+     * Handles EIP-1559 vs legacy gas pricing correctly.
+     *
+     * @param options - Transaction options to spread
+     * @returns Properly formatted options for viem
+     * @internal
+     */
+    protected spreadTransactionOptions(options?: TransactionOptions): any;
+}

package/dist/controllers/base.js

@@ -0,0 +1,92 @@
+import { ReadOnlyError } from "../errors";
+class BaseController {
+  /**
+   * Creates a new controller instance with the provided context.
+   *
+   * @param context - The controller context containing clients and configuration
+   */
+  constructor(context) {
+    this.context = context;
+  }
+  /**
+   * Asserts that a wallet client with an account is available for operations requiring signing.
+   *
+   * @remarks
+   * This method uses TypeScript assertion signatures to narrow the type of
+   * `this.context` to guarantee that `walletClient` with an account is available
+   * after the call succeeds. This provides compile-time safety for wallet operations
+   * while enabling clear error messages for read-only scenarios.
+   *
+   * The assertion signature ensures that after calling this method,
+   * TypeScript knows that `this.context.walletClient` is definitely available
+   * with a configured account.
+   *
+   * @throws {ReadOnlyError} When no wallet client is configured
+   * @throws {Error} When wallet client exists but no account is configured
+   *
+   * @example
+   * ```typescript
+   * async performWalletOperation() {
+   *   this.assertWallet(); // Type assertion + runtime check
+   *
+   *   // TypeScript now knows walletClient and account are available
+   *   const account = this.context.walletClient.account;
+   *   const address = typeof account === 'string' ? account : account.address;
+   * }
+   * ```
+   */
+  assertWallet() {
+    if (!this.context.walletClient) {
+      const stack = new Error().stack;
+      const callingMethod = stack?.split("\n")[2]?.match(/at \w+\.(\w+)/)?.[1] ?? "this operation";
+      throw new ReadOnlyError(
+        callingMethod,
+        "Initialize the SDK with a walletClient to perform this operation"
+      );
+    }
+    if (!this.context.walletClient.account) {
+      const stack = new Error().stack;
+      const callingMethod = stack?.split("\n")[2]?.match(/at \w+\.(\w+)/)?.[1] ?? "this operation";
+      throw new Error(
+        `No wallet account connected. Cannot perform ${callingMethod} without an account.`
+      );
+    }
+  }
+  /**
+   * Helper to safely spread transaction options for viem compatibility.
+   * Handles EIP-1559 vs legacy gas pricing correctly.
+   *
+   * @param options - Transaction options to spread
+   * @returns Properly formatted options for viem
+   * @internal
+   */
+  spreadTransactionOptions(options) {
+    if (!options) return {};
+    const baseOptions = {
+      ...options.nonce !== void 0 && { nonce: options.nonce },
+      ...options.gas !== void 0 && { gas: options.gas }
+    };
+    if (options.maxFeePerGas !== void 0 || options.maxPriorityFeePerGas !== void 0) {
+      return {
+        ...baseOptions,
+        ...options.maxFeePerGas !== void 0 && {
+          maxFeePerGas: options.maxFeePerGas
+        },
+        ...options.maxPriorityFeePerGas !== void 0 && {
+          maxPriorityFeePerGas: options.maxPriorityFeePerGas
+        }
+      };
+    }
+    if (options.gasPrice !== void 0) {
+      return {
+        ...baseOptions,
+        gasPrice: options.gasPrice
+      };
+    }
+    return baseOptions;
+  }
+}
+export {
+  BaseController
+};
+//# sourceMappingURL=base.js.map

package/dist/controllers/base.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/controllers/base.ts"],"sourcesContent":["/**\n * Base controller class providing common functionality for all controllers.\n *\n * @remarks\n * This abstract class establishes the foundation for all Vana SDK controllers,\n * providing shared utilities like wallet validation and context management.\n * All controllers should extend this base class to ensure consistency and\n * shared behavior across the SDK.\n *\n * The class follows the Single Responsibility Principle by handling only\n * the core controller concerns while leaving specific functionality to\n * implementing classes.\n *\n * @category Controllers\n */\n\nimport type { WalletClient } from \"viem\";\nimport type { ControllerContext } from \"../types/controller-context\";\nimport type { TransactionOptions } from \"../types/operations\";\nimport { ReadOnlyError } from \"../errors\";\n\n/**\n * Abstract base controller that all Vana SDK controllers extend.\n *\n * @remarks\n * Provides common functionality and patterns used across all controllers,\n * including wallet validation and context management. This ensures\n * consistency and reduces code duplication throughout the SDK.\n *\n * Key features:\n * - Wallet client validation with TypeScript assertion signatures\n * - Consistent error handling for read-only scenarios\n * - Shared context management patterns\n * - Type-safe wallet operations\n *\n * @example\n * ```typescript\n * class MyController extends BaseController {\n *   async performWalletOperation() {\n *     this.assertWallet(); // Ensures wallet is available\n *     // Now this.context.walletClient is guaranteed to be available\n *     const address = await this.context.walletClient.getAddresses();\n *     return address[0];\n *   }\n * }\n * ```\n */\nexport abstract class BaseController {\n  /**\n   * Creates a new controller instance with the provided context.\n   *\n   * @param context - The controller context containing clients and configuration\n   */\n  constructor(protected readonly context: ControllerContext) {}\n\n  /**\n   * Asserts that a wallet client with an account is available for operations requiring signing.\n   *\n   * @remarks\n   * This method uses TypeScript assertion signatures to narrow the type of\n   * `this.context` to guarantee that `walletClient` with an account is available\n   * after the call succeeds. This provides compile-time safety for wallet operations\n   * while enabling clear error messages for read-only scenarios.\n   *\n   * The assertion signature ensures that after calling this method,\n   * TypeScript knows that `this.context.walletClient` is definitely available\n   * with a configured account.\n   *\n   * @throws {ReadOnlyError} When no wallet client is configured\n   * @throws {Error} When wallet client exists but no account is configured\n   *\n   * @example\n   * ```typescript\n   * async performWalletOperation() {\n   *   this.assertWallet(); // Type assertion + runtime check\n   *\n   *   // TypeScript now knows walletClient and account are available\n   *   const account = this.context.walletClient.account;\n   *   const address = typeof account === 'string' ? account : account.address;\n   * }\n   * ```\n   */\n  protected assertWallet(): asserts this is {\n    context: ControllerContext & { walletClient: WalletClient };\n  } {\n    if (!this.context.walletClient) {\n      // Get the calling method name from the stack trace for better error messages\n      const stack = new Error().stack;\n      const callingMethod =\n        stack?.split(\"\\n\")[2]?.match(/at \\w+\\.(\\w+)/)?.[1] ?? \"this operation\";\n\n      throw new ReadOnlyError(\n        callingMethod,\n        \"Initialize the SDK with a walletClient to perform this operation\",\n      );\n    }\n\n    if (!this.context.walletClient.account) {\n      // Get the calling method name from the stack trace for better error messages\n      const stack = new Error().stack;\n      const callingMethod =\n        stack?.split(\"\\n\")[2]?.match(/at \\w+\\.(\\w+)/)?.[1] ?? \"this operation\";\n\n      throw new Error(\n        `No wallet account connected. Cannot perform ${callingMethod} without an account.`,\n      );\n    }\n  }\n\n  /**\n   * Helper to safely spread transaction options for viem compatibility.\n   * Handles EIP-1559 vs legacy gas pricing correctly.\n   *\n   * @param options - Transaction options to spread\n   * @returns Properly formatted options for viem\n   * @internal\n   */\n  protected spreadTransactionOptions(options?: TransactionOptions) {\n    if (!options) return {};\n\n    const baseOptions: any = {\n      ...(options.nonce !== undefined && { nonce: options.nonce }),\n      ...(options.gas !== undefined && { gas: options.gas }),\n    };\n\n    // EIP-1559 and legacy gasPrice are mutually exclusive in viem\n    // If EIP-1559 params are provided, use them and exclude gasPrice\n    if (\n      options.maxFeePerGas !== undefined ||\n      options.maxPriorityFeePerGas !== undefined\n    ) {\n      return {\n        ...baseOptions,\n        ...(options.maxFeePerGas !== undefined && {\n          maxFeePerGas: options.maxFeePerGas,\n        }),\n        ...(options.maxPriorityFeePerGas !== undefined && {\n          maxPriorityFeePerGas: options.maxPriorityFeePerGas,\n        }),\n      };\n    }\n\n    // Otherwise, use legacy gasPrice if provided\n    if (options.gasPrice !== undefined) {\n      return {\n        ...baseOptions,\n        gasPrice: options.gasPrice,\n      };\n    }\n\n    return baseOptions;\n  }\n}\n"],"mappings":"AAmBA,SAAS,qBAAqB;AA4BvB,MAAe,eAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMnC,YAA+B,SAA4B;AAA5B;AAAA,EAA6B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6BlD,eAER;AACA,QAAI,CAAC,KAAK,QAAQ,cAAc;AAE9B,YAAM,QAAQ,IAAI,MAAM,EAAE;AAC1B,YAAM,gBACJ,OAAO,MAAM,IAAI,EAAE,CAAC,GAAG,MAAM,eAAe,IAAI,CAAC,KAAK;AAExD,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,QAAI,CAAC,KAAK,QAAQ,aAAa,SAAS;AAEtC,YAAM,QAAQ,IAAI,MAAM,EAAE;AAC1B,YAAM,gBACJ,OAAO,MAAM,IAAI,EAAE,CAAC,GAAG,MAAM,eAAe,IAAI,CAAC,KAAK;AAExD,YAAM,IAAI;AAAA,QACR,+CAA+C,aAAa;AAAA,MAC9D;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUU,yBAAyB,SAA8B;AAC/D,QAAI,CAAC,QAAS,QAAO,CAAC;AAEtB,UAAM,cAAmB;AAAA,MACvB,GAAI,QAAQ,UAAU,UAAa,EAAE,OAAO,QAAQ,MAAM;AAAA,MAC1D,GAAI,QAAQ,QAAQ,UAAa,EAAE,KAAK,QAAQ,IAAI;AAAA,IACtD;AAIA,QACE,QAAQ,iBAAiB,UACzB,QAAQ,yBAAyB,QACjC;AACA,aAAO;AAAA,QACL,GAAG;AAAA,QACH,GAAI,QAAQ,iBAAiB,UAAa;AAAA,UACxC,cAAc,QAAQ;AAAA,QACxB;AAAA,QACA,GAAI,QAAQ,yBAAyB,UAAa;AAAA,UAChD,sBAAsB,QAAQ;AAAA,QAChC;AAAA,MACF;AAAA,IACF;AAGA,QAAI,QAAQ,aAAa,QAAW;AAClC,aAAO;AAAA,QACL,GAAG;AAAA,QACH,UAAU,QAAQ;AAAA,MACpB;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AACF;","names":[]}

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

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