From 5fb0f903db813bb0596cab27925059d36b54e481 Mon Sep 17 00:00:00 2001 From: Joe Pegler Date: Thu, 19 Sep 2024 12:18:54 +0100 Subject: [PATCH] chore: tsdoc - getInstalledExecutors --- .../decorators/erc7579/getInstalledExecutors.ts | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/sdk/clients/decorators/erc7579/getInstalledExecutors.ts b/src/sdk/clients/decorators/erc7579/getInstalledExecutors.ts index af1e634e..6a63bd4a 100644 --- a/src/sdk/clients/decorators/erc7579/getInstalledExecutors.ts +++ b/src/sdk/clients/decorators/erc7579/getInstalledExecutors.ts @@ -15,6 +15,22 @@ export type GetInstalledExecutorsParameters< cursor?: Hex } +/** + * Retrieves the installed executors for a given smart account. + * + * @param client - The client instance. + * @param parameters - Parameters including the smart account, page size, and cursor. + * @returns A tuple containing an array of executor addresses and the next cursor. + * @throws {AccountNotFoundError} If the account is not found. + * + * @example + * import { getInstalledExecutors } from '@biconomy/sdk' + * + * const [executors, nextCursor] = await getInstalledExecutors(nexusClient, { + * pageSize: 10n + * }) + * console.log(executors, nextCursor) // ['0x...', '0x...'], '0x...' + */ export async function getInstalledExecutors< TSmartAccount extends SmartAccount | undefined >(