chore: tsdoc - getActiveHook

bcnmy · Sep 19, 2024 · 140f9dc · 140f9dc
1 parent ba9897c
commit 140f9dc
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/src/sdk/clients/decorators/erc7579/accountId.ts b/src/sdk/clients/decorators/erc7579/accountId.ts
@@ -25,7 +25,7 @@ import { AccountNotFoundError } from "../../../account/utils/AccountNotFound"
  *
  * @example
  * import { accountId } from '@biconomy/sdk'
- * 
+ *
  * const id = await accountId(nexusClient)
  * console.log(id) // 'example_account_id'
  */

diff --git a/src/sdk/clients/decorators/erc7579/getActiveHook.ts b/src/sdk/clients/decorators/erc7579/getActiveHook.ts
@@ -11,6 +11,20 @@ export type GetActiveHookParameters<
   TSmartAccount extends SmartAccount | undefined
 > = GetSmartAccountParameter<TSmartAccount>
 
+/**
+ * Retrieves the active hook for a given smart account.
+ *
+ * @param client - The client instance.
+ * @param parameters - Parameters for getting the smart account.
+ * @returns The address of the active hook as a hexadecimal string.
+ * @throws {AccountNotFoundError} If the account is not found.
+ *
+ * @example
+ * import { getActiveHook } from '@biconomy/sdk'
+ *
+ * const activeHook = await getActiveHook(nexusClient)
+ * console.log(activeHook) // '0x...'
+ */
 export async function getActiveHook<
   TSmartAccount extends SmartAccount | undefined
 >(