@etherkit/viem-tx-tracker 0.0.3 → 0.0.5

package/src/index.ts

@@ -2,4 +2,8 @@
 export type * from './types.js';
 
 // Factory
-export {createTrackedWalletClient} from './TrackedWalletClient.js';
+export {
+	createTrackedWalletClient,
+	type TrackedWalletClientBuilder,
+	type TrackedWalletClientAutoPopulateBuilder,
+} from './TrackedWalletClient.js';

package/src/types.ts

@@ -15,6 +15,53 @@ import type {
 	WriteContractParameters,
 } from 'viem';
 
+/**
+ * Metadata for contract function calls.
+ * Auto-populated by writeContract when populateMetadata: true.
+ */
+export type FunctionCallMetadata = {
+	type: 'functionCall';
+	functionName: string;
+	args?: readonly unknown[];
+};
+
+/**
+ * Metadata for unknown/untyped operations.
+ * Used as a fallback for sendTransaction/sendRawTransaction
+ * when using the default PopulatedMetadata type.
+ */
+export type UnknownTypeMetadata = {
+	type: 'unknown';
+	name: string;
+	data: any[];
+};
+
+/**
+ * Default metadata type when using populateMetadata: true.
+ * A discriminated union that allows either:
+ * - FunctionCallMetadata (auto-populated by writeContract)
+ * - UnknownTypeMetadata (for sendTransaction/sendRawTransaction)
+ *
+ * Users can provide their own TMetadata type that excludes 'unknown'
+ * if they want to enforce specific operation types.
+ */
+export type PopulatedMetadata = FunctionCallMetadata | UnknownTypeMetadata;
+
+/**
+ * Options for creating a tracked wallet client.
+ */
+export interface CreateTrackedWalletClientOptions<
+	TPopulate extends boolean = false,
+> {
+	/**
+	 * When true, writeContract and writeContractSync automatically populate
+	 * operation, functionName and args in the metadata from the contract call parameters.
+	 * TMetadata must be a type where FunctionCallMetadata is assignable to it
+	 * (e.g., PopulatedMetadata, FunctionCallMetadata, or a union including FunctionCallMetadata).
+	 */
+	populateMetadata?: TPopulate;
+}
+
 /**
  * Block tags that can be used to specify nonce fetching strategy
  */
@@ -28,47 +75,34 @@ export type BlockTag = 'latest' | 'pending' | 'earliest' | 'safe' | 'finalized';
  */
 export type NonceOption = number | BlockTag;
 
-export type ExpectedUpdate =
-	| {
-			address: `0x${string}`;
-			event: {topics: `0x${string}`[]};
-	  }
-	| {
-			address: `0x${string}`;
-			call: {data: `0x${string}`; result: `0x${string}`};
-	  };
-
 /**
- * Metadata that can be attached to a transaction for tracking purposes.
- * All fields are optional and extensible.
+ * Conditional type that makes metadata required or optional based on TMetadata.
+ * If TMetadata includes undefined (e.g., `MyMeta | undefined`), metadata is optional.
+ * Otherwise, metadata is required.
  */
-export interface TransactionMetadata {
-	id?: string;
-	name?: string;
-	args?: any[];
-	description?: string;
-	expectedUpdate?: ExpectedUpdate;
-	[key: string]: unknown;
-}
+export type MetadataField<TMetadata> = undefined extends TMetadata
+	? {metadata?: TMetadata}
+	: {metadata: TMetadata};
 
 /**
  * A tracked transaction record with all relevant information for tracking.
+ * The metadata field type matches what was provided to the TrackedWalletClient.
  */
-export interface TrackedTransaction<
-	M extends TransactionMetadata = TransactionMetadata,
-> {
+export interface TrackedTransaction<TMetadata> {
 	chainId?: number;
 	readonly hash: `0x${string}`;
 	readonly from: `0x${string}`;
 	nonce?: number;
 	readonly broadcastTimestampMs: number;
-	readonly metadata: M;
+	readonly metadata: TMetadata;
 }
 
 /**
- * Extended WriteContractParameters with optional metadata and flexible nonce.
+ * Extended WriteContractParameters with metadata and flexible nonce.
+ * Metadata is required unless TMetadata includes undefined.
  */
 export type TrackedWriteContractParameters<
+	TMetadata,
 	TAbi extends Abi | readonly unknown[] = Abi,
 	TFunctionName extends ContractFunctionName<TAbi, 'nonpayable' | 'payable'> =
 		ContractFunctionName<TAbi, 'nonpayable' | 'payable'>,
@@ -92,10 +126,97 @@ export type TrackedWriteContractParameters<
 	'nonce'
 > & {
 	/**
-	 * Optional metadata to attach to the transaction for tracking.
+	 * Nonce option:
+	 * - number: exact nonce to use
+	 * - BlockTag ('latest', 'pending', etc.): fetch nonce using this block tag
+	 * - undefined: fetch nonce using 'pending' (default)
 	 */
-	metadata?: TransactionMetadata;
+	nonce?: NonceOption;
+} & MetadataField<TMetadata>;
 
+/**
+ * The fields that are auto-populated by writeContract.
+ * These are excluded from user-provided metadata for writeContract.
+ */
+export type AutoPopulatedFields = 'type' | 'functionName' | 'args';
+
+/**
+ * Type that explicitly forbids auto-populated fields.
+ * Uses never to make TypeScript error when these properties are provided.
+ */
+export type ForbiddenAutoPopulateFields = {
+	type?: never;
+	functionName?: never;
+	args?: never;
+};
+
+/**
+ * Metadata type for writeContract when auto-population is enabled.
+ * Excludes operation, functionName and args since they will be auto-populated,
+ * and explicitly forbids them to cause TypeScript errors if provided.
+ *
+ * User provides the remaining fields (e.g., purpose, priority), and the
+ * auto-populated fields (operation, functionName, args) are added at runtime.
+ */
+export type WriteContractAutoPopulateMetadata<TMetadata> = Omit<
+	TMetadata,
+	AutoPopulatedFields
+> &
+	ForbiddenAutoPopulateFields;
+
+/**
+ * Metadata field for writeContract when auto-population is enabled.
+ * Excludes operation, functionName and args since they will be auto-populated.
+ *
+ * If the remaining fields (after removing auto-populated fields) are all optional,
+ * the metadata field itself becomes optional.
+ */
+export type WriteContractAutoPopulateMetadataField<TMetadata> =
+	// Check if there are any remaining required keys after removing auto-populated fields
+	keyof Omit<TMetadata, AutoPopulatedFields> extends never
+		? // No other fields - metadata is optional (can be omitted entirely)
+			{metadata?: WriteContractAutoPopulateMetadata<TMetadata>}
+		: // Check if all remaining fields are optional
+			Partial<Omit<TMetadata, AutoPopulatedFields>> extends Omit<
+					TMetadata,
+					AutoPopulatedFields
+			  >
+			? // All remaining fields are optional - metadata field is optional
+				{metadata?: WriteContractAutoPopulateMetadata<TMetadata>}
+			: // Some fields are required - metadata field is required
+				{metadata: WriteContractAutoPopulateMetadata<TMetadata>};
+
+/**
+ * Extended WriteContractParameters with auto-populated metadata.
+ * operation, functionName and args are excluded from the metadata since they're auto-populated.
+ *
+ * User provides any additional fields required by their TMetadata (e.g., purpose, priority),
+ * and the auto-populated fields are merged at runtime.
+ */
+export type TrackedWriteContractAutoPopulateParameters<
+	TMetadata,
+	TAbi extends Abi | readonly unknown[] = Abi,
+	TFunctionName extends ContractFunctionName<TAbi, 'nonpayable' | 'payable'> =
+		ContractFunctionName<TAbi, 'nonpayable' | 'payable'>,
+	TArgs extends ContractFunctionArgs<
+		TAbi,
+		'nonpayable' | 'payable',
+		TFunctionName
+	> = ContractFunctionArgs<TAbi, 'nonpayable' | 'payable', TFunctionName>,
+	TChain extends Chain | undefined = Chain | undefined,
+	TAccount extends Account | undefined = Account | undefined,
+	TChainOverride extends Chain | undefined = Chain | undefined,
+> = Omit<
+	WriteContractParameters<
+		TAbi,
+		TFunctionName,
+		TArgs,
+		TChain,
+		TAccount,
+		TChainOverride
+	>,
+	'nonce'
+> & {
 	/**
 	 * Nonce option:
 	 * - number: exact nonce to use
@@ -103,12 +224,14 @@ export type TrackedWriteContractParameters<
 	 * - undefined: fetch nonce using 'pending' (default)
 	 */
 	nonce?: NonceOption;
-};
+} & WriteContractAutoPopulateMetadataField<TMetadata>;
 
 /**
- * Extended SendTransactionParameters with optional metadata and flexible nonce.
+ * Extended SendTransactionParameters with metadata and flexible nonce.
+ * Metadata is required unless TMetadata includes undefined.
  */
 export type TrackedSendTransactionParameters<
+	TMetadata,
 	TChain extends Chain | undefined = Chain | undefined,
 	TAccount extends Account | undefined = Account | undefined,
 	TChainOverride extends Chain | undefined = Chain | undefined,
@@ -116,11 +239,6 @@ export type TrackedSendTransactionParameters<
 	SendTransactionParameters<TChain, TAccount, TChainOverride>,
 	'nonce'
 > & {
-	/**
-	 * Optional metadata to attach to the transaction for tracking.
-	 */
-	metadata?: TransactionMetadata;
-
 	/**
 	 * Nonce option:
 	 * - number: exact nonce to use
@@ -128,28 +246,27 @@ export type TrackedSendTransactionParameters<
 	 * - undefined: fetch nonce using 'pending' (default)
 	 */
 	nonce?: NonceOption;
-};
+} & MetadataField<TMetadata>;
 
 /**
- * Parameters for sendRawTransaction with optional metadata.
+ * Parameters for sendRawTransaction with metadata.
  * The serialized transaction already contains from/nonce which will be decoded.
+ * Metadata is required unless TMetadata includes undefined.
  */
-export interface TrackedRawTransactionParameters {
+export type TrackedRawTransactionParameters<TMetadata> = {
 	/**
 	 * The RLP-encoded signed transaction.
 	 */
 	serializedTransaction: TransactionSerialized;
-
-	/**
-	 * Optional metadata to attach to the transaction for tracking.
-	 */
-	metadata?: TransactionMetadata;
-}
+} & MetadataField<TMetadata>;
 
 /**
  * A wallet client wrapper that tracks transactions with metadata.
+ * TMetadata is the first type parameter and is mandatory - it determines
+ * whether metadata is required or optional on transaction calls.
  */
 export interface TrackedWalletClient<
+	TMetadata,
 	TTransport extends Transport = Transport,
 	TChain extends Chain | undefined = Chain | undefined,
 	TAccount extends Account | undefined = Account | undefined,
@@ -169,7 +286,7 @@ export interface TrackedWalletClient<
 	// ============================================
 
 	/**
-	 * Write to a contract with optional metadata tracking.
+	 * Write to a contract with metadata tracking.
 	 * Returns immediately after broadcast with the transaction hash.
 	 */
 	writeContract<
@@ -183,6 +300,7 @@ export interface TrackedWalletClient<
 		TChainOverride extends Chain | undefined = undefined,
 	>(
 		args: TrackedWriteContractParameters<
+			TMetadata,
 			TAbi,
 			TFunctionName,
 			TArgs,
@@ -193,19 +311,26 @@ export interface TrackedWalletClient<
 	): Promise<Hash>;
 
 	/**
-	 * Send a transaction with optional metadata tracking.
+	 * Send a transaction with metadata tracking.
 	 * Returns immediately after broadcast with the transaction hash.
 	 */
 	sendTransaction<TChainOverride extends Chain | undefined = undefined>(
-		args: TrackedSendTransactionParameters<TChain, TAccount, TChainOverride>,
+		args: TrackedSendTransactionParameters<
+			TMetadata,
+			TChain,
+			TAccount,
+			TChainOverride
+		>,
 	): Promise<Hash>;
 
 	/**
-	 * Send a signed raw transaction with optional metadata tracking.
+	 * Send a signed raw transaction with metadata tracking.
 	 * The nonce and from address are decoded from the serialized transaction.
 	 * Returns immediately after broadcast with the transaction hash.
 	 */
-	sendRawTransaction(args: TrackedRawTransactionParameters): Promise<Hash>;
+	sendRawTransaction(
+		args: TrackedRawTransactionParameters<TMetadata>,
+	): Promise<Hash>;
 
 	// ============================================
 	// Sync methods (wait for confirmation, return receipt)
@@ -226,6 +351,154 @@ export interface TrackedWalletClient<
 		TChainOverride extends Chain | undefined = undefined,
 	>(
 		args: TrackedWriteContractParameters<
+			TMetadata,
+			TAbi,
+			TFunctionName,
+			TArgs,
+			TChain,
+			TAccount,
+			TChainOverride
+		>,
+	): Promise<TransactionReceipt>;
+
+	/**
+	 * Send a transaction and wait for confirmation.
+	 * Returns the transaction receipt after the transaction is confirmed.
+	 */
+	sendTransactionSync<TChainOverride extends Chain | undefined = undefined>(
+		args: TrackedSendTransactionParameters<
+			TMetadata,
+			TChain,
+			TAccount,
+			TChainOverride
+		>,
+	): Promise<TransactionReceipt>;
+
+	/**
+	 * Send a signed raw transaction and wait for confirmation.
+	 * Returns the transaction receipt after the transaction is confirmed.
+	 */
+	sendRawTransactionSync(
+		args: TrackedRawTransactionParameters<TMetadata>,
+	): Promise<TransactionReceipt>;
+
+	// ============================================
+	// Event subscription methods
+	// ============================================
+
+	/**
+	 * Subscribe to transaction broadcast events.
+	 * Called immediately after a transaction is successfully broadcast.
+	 * @param listener - Callback function receiving TrackedTransaction with TMetadata
+	 * @returns Unsubscribe function
+	 */
+	onTransactionBroadcasted(
+		listener: (event: TrackedTransaction<TMetadata>) => void,
+	): () => void;
+
+	/**
+	 * Unsubscribe from transaction broadcast events.
+	 * @param listener - The same listener function passed to onTransactionBroadcasted
+	 */
+	offTransactionBroadcasted(
+		listener: (event: TrackedTransaction<TMetadata>) => void,
+	): void;
+}
+
+/**
+ * A wallet client wrapper that tracks transactions with auto-populated metadata.
+ * TMetadata must be a type where FunctionCallMetadata is assignable to it.
+ * writeContract and writeContractSync automatically populate operation, functionName and args.
+ */
+export interface TrackedWalletClientAutoPopulate<
+	TMetadata,
+	TTransport extends Transport = Transport,
+	TChain extends Chain | undefined = Chain | undefined,
+	TAccount extends Account | undefined = Account | undefined,
+> {
+	/**
+	 * The underlying wallet client.
+	 */
+	readonly walletClient: WalletClient<TTransport, TChain, TAccount>;
+
+	/**
+	 * The public client used for nonce fetching and tx verification.
+	 */
+	readonly publicClient: PublicClient;
+
+	// ============================================
+	// Async methods (return hash immediately after broadcast)
+	// ============================================
+
+	/**
+	 * Write to a contract with metadata tracking.
+	 * functionName and args are automatically populated from the contract call.
+	 * Returns immediately after broadcast with the transaction hash.
+	 */
+	writeContract<
+		const TAbi extends Abi | readonly unknown[],
+		TFunctionName extends ContractFunctionName<TAbi, 'nonpayable' | 'payable'>,
+		TArgs extends ContractFunctionArgs<
+			TAbi,
+			'nonpayable' | 'payable',
+			TFunctionName
+		>,
+		TChainOverride extends Chain | undefined = undefined,
+	>(
+		args: TrackedWriteContractAutoPopulateParameters<
+			TMetadata,
+			TAbi,
+			TFunctionName,
+			TArgs,
+			TChain,
+			TAccount,
+			TChainOverride
+		>,
+	): Promise<Hash>;
+
+	/**
+	 * Send a transaction with metadata tracking.
+	 * Returns immediately after broadcast with the transaction hash.
+	 */
+	sendTransaction<TChainOverride extends Chain | undefined = undefined>(
+		args: TrackedSendTransactionParameters<
+			TMetadata,
+			TChain,
+			TAccount,
+			TChainOverride
+		>,
+	): Promise<Hash>;
+
+	/**
+	 * Send a signed raw transaction with metadata tracking.
+	 * The nonce and from address are decoded from the serialized transaction.
+	 * Returns immediately after broadcast with the transaction hash.
+	 */
+	sendRawTransaction(
+		args: TrackedRawTransactionParameters<TMetadata>,
+	): Promise<Hash>;
+
+	// ============================================
+	// Sync methods (wait for confirmation, return receipt)
+	// ============================================
+
+	/**
+	 * Write to a contract and wait for confirmation.
+	 * functionName and args are automatically populated from the contract call.
+	 * Returns the transaction receipt after the transaction is confirmed.
+	 */
+	writeContractSync<
+		const TAbi extends Abi | readonly unknown[],
+		TFunctionName extends ContractFunctionName<TAbi, 'nonpayable' | 'payable'>,
+		TArgs extends ContractFunctionArgs<
+			TAbi,
+			'nonpayable' | 'payable',
+			TFunctionName
+		>,
+		TChainOverride extends Chain | undefined = undefined,
+	>(
+		args: TrackedWriteContractAutoPopulateParameters<
+			TMetadata,
 			TAbi,
 			TFunctionName,
 			TArgs,
@@ -240,7 +513,12 @@ export interface TrackedWalletClient<
 	 * Returns the transaction receipt after the transaction is confirmed.
 	 */
 	sendTransactionSync<TChainOverride extends Chain | undefined = undefined>(
-		args: TrackedSendTransactionParameters<TChain, TAccount, TChainOverride>,
+		args: TrackedSendTransactionParameters<
+			TMetadata,
+			TChain,
+			TAccount,
+			TChainOverride
+		>,
 	): Promise<TransactionReceipt>;
 
 	/**
@@ -248,7 +526,7 @@ export interface TrackedWalletClient<
 	 * Returns the transaction receipt after the transaction is confirmed.
 	 */
 	sendRawTransactionSync(
-		args: TrackedRawTransactionParameters,
+		args: TrackedRawTransactionParameters<TMetadata>,
 	): Promise<TransactionReceipt>;
 
 	// ============================================
@@ -258,11 +536,11 @@ export interface TrackedWalletClient<
 	/**
 	 * Subscribe to transaction broadcast events.
 	 * Called immediately after a transaction is successfully broadcast.
-	 * @param listener - Callback function receiving TrackedTransaction
+	 * @param listener - Callback function receiving TrackedTransaction with TMetadata
 	 * @returns Unsubscribe function
 	 */
 	onTransactionBroadcasted(
-		listener: (event: TrackedTransaction) => void,
+		listener: (event: TrackedTransaction<TMetadata>) => void,
 	): () => void;
 
 	/**
@@ -270,6 +548,6 @@ export interface TrackedWalletClient<
 	 * @param listener - The same listener function passed to onTransactionBroadcasted
 	 */
 	offTransactionBroadcasted(
-		listener: (event: TrackedTransaction) => void,
+		listener: (event: TrackedTransaction<TMetadata>) => void,
 	): void;
 }