@etherkit/viem-tx-tracker 0.0.3 → 0.0.5

package/dist/TrackedWalletClient.d.ts

@@ -1,17 +1,84 @@
 import { type Account, type Chain, type PublicClient, type Transport, type WalletClient } from 'viem';
-import type { TrackedWalletClient } from './types.js';
+import type { PopulatedMetadata, TrackedWalletClient, TrackedWalletClientAutoPopulate } from './types.js';
+/**
+ * Infer transport type from WalletClient
+ */
+type InferTransport<T> = T extends WalletClient<infer TTransport, any, any> ? TTransport : Transport;
+/**
+ * Infer chain type from WalletClient
+ */
+type InferChain<T> = T extends WalletClient<any, infer TChain, any> ? TChain : Chain | undefined;
+/**
+ * Infer account type from WalletClient
+ */
+type InferAccount<T> = T extends WalletClient<any, any, infer TAccount> ? TAccount : Account | undefined;
+/**
+ * Builder interface returned by createTrackedWalletClient for the curried API.
+ */
+export interface TrackedWalletClientBuilder<TMetadata> {
+    /**
+     * Create the tracked wallet client using the provided wallet and public clients.
+     *
+     * @param walletClient - The underlying viem WalletClient
+     * @param publicClient - A PublicClient for nonce fetching and tx verification
+     * @returns A TrackedWalletClient instance
+     */
+    using<TClient extends WalletClient>(walletClient: TClient, publicClient: PublicClient): TrackedWalletClient<TMetadata, InferTransport<TClient>, InferChain<TClient>, InferAccount<TClient>>;
+}
+/**
+ * Builder interface returned by createTrackedWalletClient with populateMetadata: true.
+ * This builder returns a TrackedWalletClientAutoPopulate that auto-populates operation, functionName and args.
+ * TMetadata must be a type where FunctionCallMetadata is assignable to it.
+ */
+export interface TrackedWalletClientAutoPopulateBuilder<TMetadata> {
+    /**
+     * Create the tracked wallet client using the provided wallet and public clients.
+     * writeContract and writeContractSync will automatically populate operation, functionName and args.
+     *
+     * @param walletClient - The underlying viem WalletClient
+     * @param publicClient - A PublicClient for nonce fetching and tx verification
+     * @returns A TrackedWalletClientAutoPopulate instance
+     */
+    using<TClient extends WalletClient>(walletClient: TClient, publicClient: PublicClient): TrackedWalletClientAutoPopulate<TMetadata, InferTransport<TClient>, InferChain<TClient>, InferAccount<TClient>>;
+}
 /**
  * Create a tracked wallet client that wraps a viem WalletClient.
  *
  * The tracked client provides the same API as WalletClient but with:
- * - Optional metadata field for transaction tracking
+ * - Metadata field for transaction tracking (required unless TMetadata includes undefined)
  * - Automatic nonce fetching (with 'pending' by default)
  * - Post-broadcast transaction verification
- * - TODO: Event emission for tracking
+ * - Event emission for tracking
+ *
+ * @typeParam TMetadata - The metadata type. Use `MyMeta | undefined` to make metadata optional.
+ * @returns A builder with a `.using()` method to provide the wallet and public clients
+ *
+ * @example
+ * ```typescript
+ * // Standard mode with required metadata
+ * const tracked = createTrackedWalletClient<{purpose: string}>()
+ *   .using(walletClient, publicClient);
+ *
+ * // Standard mode with optional metadata
+ * const tracked = createTrackedWalletClient<{purpose: string} | undefined>()
+ *   .using(walletClient, publicClient);
+ *
+ * // Auto-populate mode - functionName and args are auto-populated
+ * const tracked = createTrackedWalletClient({ populateMetadata: true })
+ *   .using(walletClient, publicClient);
  *
- * @param walletClient - The underlying viem WalletClient
- * @param publicClient - A PublicClient for nonce fetching and tx verification
- * @returns A TrackedWalletClient instance
+ * // Auto-populate mode with extended metadata
+ * type MyMetadata = OperationMetadata & { purpose: string };
+ * const tracked = createTrackedWalletClient<MyMetadata>({ populateMetadata: true })
+ *   .using(walletClient, publicClient);
+ * ```
  */
-export declare function createTrackedWalletClient<TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined>(walletClient: WalletClient<TTransport, TChain, TAccount>, publicClient: PublicClient): TrackedWalletClient<TTransport, TChain, TAccount>;
+export declare function createTrackedWalletClient<TMetadata>(): TrackedWalletClientBuilder<TMetadata>;
+export declare function createTrackedWalletClient(options: {
+    populateMetadata: true;
+}): TrackedWalletClientAutoPopulateBuilder<PopulatedMetadata>;
+export declare function createTrackedWalletClient<TMetadata>(options: {
+    populateMetadata: true;
+}): TrackedWalletClientAutoPopulateBuilder<TMetadata>;
+export {};
 //# sourceMappingURL=TrackedWalletClient.d.ts.map

package/dist/TrackedWalletClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TrackedWalletClient.d.ts","sourceRoot":"","sources":["../src/TrackedWalletClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,KAAK,OAAO,EAEZ,KAAK,KAAK,EAIV,KAAK,YAAY,EAGjB,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EAMX,mBAAmB,EAGnB,MAAM,YAAY,CAAC;AA+CpB;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CACxC,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAE1D,YAAY,EAAE,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EACxD,YAAY,EAAE,YAAY,GACxB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAwXnD"}
+{"version":3,"file":"TrackedWalletClient.d.ts","sourceRoot":"","sources":["../src/TrackedWalletClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,KAAK,OAAO,EAEZ,KAAK,KAAK,EAIV,KAAK,YAAY,EAGjB,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EAIX,iBAAiB,EAIjB,mBAAmB,EACnB,+BAA+B,EAG/B,MAAM,YAAY,CAAC;AA+CpB;;GAEG;AACH,KAAK,cAAc,CAAC,CAAC,IACpB,CAAC,SAAS,YAAY,CAAC,MAAM,UAAU,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7E;;GAEG;AACH,KAAK,UAAU,CAAC,CAAC,IAChB,CAAC,SAAS,YAAY,CAAC,GAAG,EAAE,MAAM,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;AAE7E;;GAEG;AACH,KAAK,YAAY,CAAC,CAAC,IAClB,CAAC,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC,GAC7C,QAAQ,GACR,OAAO,GAAG,SAAS,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,0BAA0B,CAAC,SAAS;IACpD;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,SAAS,YAAY,EACjC,YAAY,EAAE,OAAO,EACrB,YAAY,EAAE,YAAY,GACxB,mBAAmB,CACrB,SAAS,EACT,cAAc,CAAC,OAAO,CAAC,EACvB,UAAU,CAAC,OAAO,CAAC,EACnB,YAAY,CAAC,OAAO,CAAC,CACrB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC,CAAC,SAAS;IAChE;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,SAAS,YAAY,EACjC,YAAY,EAAE,OAAO,EACrB,YAAY,EAAE,YAAY,GACxB,+BAA+B,CACjC,SAAS,EACT,cAAc,CAAC,OAAO,CAAC,EACvB,UAAU,CAAC,OAAO,CAAC,EACnB,YAAY,CAAC,OAAO,CAAC,CACrB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,wBAAgB,yBAAyB,CACxC,SAAS,KACL,0BAA0B,CAAC,SAAS,CAAC,CAAC;AAG3C,wBAAgB,yBAAyB,CAAC,OAAO,EAAE;IAClD,gBAAgB,EAAE,IAAI,CAAC;CACvB,GAAG,sCAAsC,CAAC,iBAAiB,CAAC,CAAC;AAG9D,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,OAAO,EAAE;IAC7D,gBAAgB,EAAE,IAAI,CAAC;CACvB,GAAG,sCAAsC,CAAC,SAAS,CAAC,CAAC"}