Add Erc7710WalletClient type, and improve example documentation

Author: jeffsmale90

packages/smart-accounts-kit/src/actions/index.ts

@@ -99,6 +99,26 @@ export {
 
 export type { DelegatedCall } from './erc7710RedeemDelegationAction';
 
+/**
+ * Extends a viem client with ERC-7715 provider actions.
+ *
+ * @returns A function that decorates a client with ERC-7715 provider actions.
+ *
+ * @example
+ * ```typescript
+ * const providerClient = createClient({
+ *   chain: sepolia,
+ *   transport: custom(window.ethereum),
+ * }).extend(erc7715ProviderActions());
+ *
+ * await providerClient.requestExecutionPermissions({
+ *   requests: [permissionRequest],
+ * });
+ *
+ * const supported = await providerClient.getSupportedExecutionPermissions();
+ * const granted = await providerClient.getGrantedExecutionPermissions();
+ * ```
+ */
 export const erc7715ProviderActions = () => (client: Client) => ({
   requestExecutionPermissions: async (
     parameters: RequestExecutionPermissionsParameters,
@@ -121,15 +141,15 @@ export const erc7715ProviderActions = () => (client: Client) => ({
 });
 
 /**
- * Type for a viem Client extended with ERC-7710 provider actions.
- * Use this to type variables that will be assigned an extended client later.
+ * Type for a viem Client extended with ERC-7715 provider actions.
+ * Use this to type variables for deferred initialization.
  *
  * @example
  * ```typescript
  * let client: Erc7715Client | null = null;
  *
  * function setupClient() {
- *   client = createWalletClient({
+ *   client = createClient({
  *     chain: sepolia,
  *     transport: custom(window.ethereum),
  *   }).extend(erc7715ProviderActions());
@@ -139,6 +159,58 @@ export const erc7715ProviderActions = () => (client: Client) => ({
 export type Erc7715Client = Client &
   ReturnType<ReturnType<typeof erc7715ProviderActions>>;
 
+/**
+ * Type for a viem WalletClient extended with ERC-7710 wallet actions.
+ * Use this to type variables for deferred initialization.
+ *
+ * @example
+ * ```typescript
+ * let walletClient: Erc7710WalletClient | null = null;
+ *
+ * function setupClient() {
+ *   walletClient = createWalletClient({
+ *     account,
+ *     chain: sepolia,
+ *     transport: custom(window.ethereum),
+ *   }).extend(erc7710WalletActions());
+ * }
+ * ```
+ */
+export type Erc7710WalletClient = WalletClient &
+  ReturnType<ReturnType<typeof erc7710WalletActions>>;
+
+/**
+ * Extends a viem wallet client with ERC-7710 wallet actions.
+ *
+ * @returns A function that decorates a wallet client with ERC-7710 wallet actions.
+ *
+ * @example
+ * ```typescript
+ * const walletClient = createWalletClient({
+ *   account,
+ *   chain: sepolia,
+ *   transport: custom(window.ethereum),
+ * }).extend(erc7710WalletActions());
+ *
+ * await walletClient.sendTransactionWithDelegation({
+ *   account,
+ *   chain: sepolia,
+ *   to: recipient,
+ *   value: 0n,
+ *   data: callData,
+ *   permissionContext,
+ *   delegationManager: environment.DelegationManager,
+ * });
+ *
+ * await walletClient.redelegatePermissionContext({
+ *   environment,
+ *   permissionContext,
+ *   to: anotherDelegate,
+ *   // optional when client.chain is configured
+ *   chainId: sepolia.id,
+ * });
+ * ```
+ */
 export const erc7710WalletActions = () => (client: WalletClient) => ({
   sendTransactionWithDelegation: async (
     args: SendTransactionWithDelegationParameters,
@@ -151,6 +223,33 @@ export const erc7710WalletActions = () => (client: WalletClient) => ({
   ) => redelegatePermissionContextOpenAction(client, parameters),
 });
 
+/**
+ * Extends a viem bundler client with ERC-7710 bundler actions.
+ *
+ * @returns A function that decorates a bundler client with ERC-7710 bundler actions.
+ *
+ * @example
+ * ```typescript
+ * const bundlerClient = createBundlerClient({
+ *   account: smartAccount,
+ *   chain: sepolia,
+ *   transport: http(bundlerUrl),
+ * }).extend(erc7710BundlerActions());
+ *
+ * const userOpHash = await bundlerClient.sendUserOperationWithDelegation({
+ *   publicClient,
+ *   calls: [
+ *     {
+ *       to: recipient,
+ *       data: callData,
+ *       value: 0n,
+ *       permissionContext,
+ *       delegationManager: environment.DelegationManager,
+ *     },
+ *   ],
+ * });
+ * ```
+ */
 export const erc7710BundlerActions = () => (client: Client) => ({
   sendUserOperationWithDelegation: async (
     args: SendUserOperationWithDelegationParameters,