chore: tsdoc - writeContract

Author: joepegler

src/sdk/clients/decorators/smartAccount/writeContract.ts

@@ -15,6 +15,29 @@ import type { SmartAccount } from "viem/account-abstraction"
 import { getAction } from "viem/utils"
 import { sendTransaction } from "./sendTransaction"
 
+/**
+ * Executes a write operation on a smart contract using a smart account.
+ *
+ * @param client - The client instance.
+ * @param parameters - Parameters for the contract write operation.
+ * @returns The transaction hash as a hexadecimal string.
+ * @throws {Error} If the 'to' address is missing in the request.
+ *
+ * @example
+ * import { writeContract } from '@biconomy/sdk'
+ * import { encodeFunctionData } from 'viem'
+ *
+ * const encodedCall = encodeFunctionData({
+ *   abi: CounterAbi,
+ *   functionName: "incrementNumber"
+ * })
+ * const call = {
+ *   to: '0x61f70428b61864B38D9B45b7B032c700B960acCD',
+ *   data: encodedCall
+ * }
+ * const hash = await writeContract(nexusClient, call)
+ * console.log(hash) // '0x...'
+ */
 export async function writeContract<
   TChain extends Chain | undefined,
   TAccount extends SmartAccount | undefined,