chore: tsdoc - uninstallModules

bcnmy · Sep 19, 2024 · 1cffbc2 · 1cffbc2
1 parent 2b9fe68
commit 1cffbc2
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/src/sdk/clients/decorators/erc7579/uninstallModules.ts b/src/sdk/clients/decorators/erc7579/uninstallModules.ts
@@ -26,6 +26,25 @@ export type UninstallModulesParameters<
   nonce?: bigint
 }
 
+/**
+ * Uninstalls multiple modules from a smart account.
+ *
+ * @param client - The client instance.
+ * @param parameters - Parameters including the smart account, modules to uninstall, and optional gas settings.
+ * @returns The hash of the user operation as a hexadecimal string.
+ * @throws {AccountNotFoundError} If the account is not found.
+ *
+ * @example
+ * import { uninstallModules } from '@biconomy/sdk'
+ *
+ * const userOpHash = await uninstallModules(nexusClient, {
+ *   modules: [
+ *     { type: 'executor', address: '0x...', context: '0x' },
+ *     { type: 'validator', address: '0x...', context: '0x' }
+ *   ]
+ * })
+ * console.log(userOpHash) // '0x...'
+ */
 export async function uninstallModules<
   TSmartAccount extends SmartAccount | undefined
 >(