Fix jsdoc comments in getCaveatAvailableAmount.ts

Author: jeffsmale90

packages/delegation-toolkit/src/actions/getCaveatAvailableAmount.ts

@@ -33,8 +33,10 @@ export type StreamingResult = {
 
 /**
  * Finds a caveat that matches the specified enforcer address.
- * @param delegation - The delegation to search.
- * @param enforcerAddress - The enforcer address to match.
+ * @param config - The configuration object.
+ * @param config.delegation - The delegation to search.
+ * @param config.enforcerAddress - The enforcer address to match.
+ * @param config.enforcerName - The name of the enforcer.
  * @returns The matching caveat.
  * @throws Error if no matching caveat is found.
  * @throws Error if multiple matching caveats are found.
@@ -89,8 +91,9 @@ function getDelegationManager(environment: DeleGatorEnvironment): Address {
 /**
  * Gets the enforcer address from environment.
  *
- * @param enforcerName - The name of the enforcer.
- * @param environment - The delegator environment.
+ * @param config - The configuration object.
+ * @param config.enforcerName - The name of the enforcer.
+ * @param config.environment - The delegator environment.
  * @returns The enforcer address.
  */
 function getEnforcerAddress({
@@ -380,3 +383,27 @@ export const caveatEnforcerActions =
       );
     },
   });
+
+/**
+ * Type for client extended with caveat enforcer actions.
+ */
+export type CaveatEnforcerClient = PublicClient &
+  ReturnType<ReturnType<typeof caveatEnforcerActions>>;
+
+/**
+ * Create a viem client extended with caveat enforcer actions.
+ *
+ * @param params - The parameters object.
+ * @param params.client - The viem public client.
+ * @param params.environment - The delegator environment.
+ * @returns The extended client with caveat enforcer actions.
+ */
+export function createCaveatEnforcerClient({
+  client,
+  environment,
+}: {
+  client: PublicClient;
+  environment: DeleGatorEnvironment;
+}): CaveatEnforcerClient {
+  return client.extend(caveatEnforcerActions({ environment }));
+}

packages/delegation-toolkit/test/actions/caveatEnforcerClient.test.ts

@@ -2,7 +2,6 @@ import { type PublicClient, createPublicClient, http, type Hex } from 'viem';
 import { sepolia } from 'viem/chains';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
-import { randomAddress, randomBytes } from '../utils';
 import {
   createCaveatEnforcerClient,
   type CaveatEnforcerClient,
@@ -24,6 +23,7 @@ import {
 } from '../../src/contracts';
 import { getDelegationHashOffchain } from '../../src/delegation';
 import type { DeleGatorEnvironment } from '../../src/types';
+import { randomAddress, randomBytes } from '../utils';
 
 // Helper function to generate random bytes32
 const randomBytes32 = (): Hex => randomBytes(32);

packages/delegation-toolkit/test/caveatUtils.test.ts

@@ -3,6 +3,10 @@ import { sepolia } from 'viem/chains';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
 import { randomAddress, randomBytes } from './utils';
+import {
+  createCaveatEnforcerClient,
+  type CaveatEnforcerClient,
+} from '../src/actions/caveatEnforcerClient';
 import {
   getErc20PeriodTransferEnforcerAvailableAmount,
   getErc20StreamingEnforcerAvailableAmount,
@@ -11,10 +15,6 @@ import {
   getNativeTokenStreamingEnforcerAvailableAmount,
   type CaveatEnforcerParams,
 } from '../src/actions/getCaveatAvailableAmount';
-import {
-  createCaveatEnforcerClient,
-  type CaveatEnforcerClient,
-} from '../src/actions/caveatEnforcerClient';
 import {
   ERC20PeriodTransferEnforcer,
   MultiTokenPeriodEnforcer,