chore: tsdoc - installModule

src/sdk/clients/decorators/erc7579/installModule.ts

@@ -18,6 +18,26 @@ export type InstallModuleParameters<
   nonce?: bigint
 }
 
+/**
+ * Installs a module on a given smart account.
+ *
+ * @param client - The client instance.
+ * @param parameters - Parameters including the smart account, module to install, 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 { installModule } from '@biconomy/sdk'
+ *
+ * const userOpHash = await installModule(nexusClient, {
+ *   module: {
+ *     type: 'executor',
+ *     address: '0x...',
+ *     context: '0x'
+ *   }
+ * })
+ * console.log(userOpHash) // '0x...'
+ */
 export async function installModule<
   TSmartAccount extends SmartAccount | undefined
 >(