Improve api for Caveat Enforcer actions and Client

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

@@ -5,45 +5,16 @@ import * as ERC20StreamingEnforcer from '../DelegationFramework/ERC20StreamingEn
 import * as MultiTokenPeriodEnforcer from '../DelegationFramework/MultiTokenPeriodEnforcer';
 import * as NativeTokenPeriodTransferEnforcer from '../DelegationFramework/NativeTokenPeriodTransferEnforcer';
 import * as NativeTokenStreamingEnforcer from '../DelegationFramework/NativeTokenStreamingEnforcer';
-import type { DeleGatorEnvironment } from '../types';
+import { hashDelegation } from '../delegation';
+import type { DeleGatorEnvironment, Delegation } from '../types';
 
 /**
- * Shared base params for all enforcer actions
+ * Parameters for all caveat enforcer actions.
  */
-export type BaseCaveatParams = {
-  delegationHash: Hex;
-  delegationManager?: Address;
-  enforcerAddress?: Address;
-  terms: Hex;
+export type CaveatEnforcerParams = {
+  delegation: Delegation;
 };
 
-/**
- * Parameters for ERC20 period transfer enforcer.
- */
-export type ERC20PeriodTransferParams = BaseCaveatParams;
-
-/**
- * Parameters for ERC20 streaming enforcer.
- */
-export type ERC20StreamingParams = BaseCaveatParams;
-
-/**
- * Parameters for MultiTokenPeriodEnforcer.
- */
-export type MultiTokenPeriodParams = {
-  args: Hex;
-} & BaseCaveatParams;
-
-/**
- * Parameters for native token period transfer enforcer.
- */
-export type NativeTokenPeriodTransferParams = BaseCaveatParams;
-
-/**
- * Parameters for native token streaming enforcer.
- */
-export type NativeTokenStreamingParams = BaseCaveatParams;
-
 /**
  * Return type for period-based transfer enforcers
  */
@@ -60,46 +31,65 @@ export type StreamingResult = {
   availableAmount: bigint;
 };
 
+
+
+
+
 /**
- * Resolves the delegation manager address from parameters or environment.
+ * Finds a caveat that matches the specified enforcer address
+ * @param delegation - The delegation to search
+ * @param enforcerAddress - The enforcer address to match
+ * @returns The matching caveat
+ * @throws Error if no matching caveat is found
+ * @throws Error if multiple matching caveats are found
+ */
+function findMatchingCaveat(
+  delegation: Delegation,
+  enforcerAddress: Address,
+): { terms: Hex; args: Hex } {
+  const matchingCaveats = delegation.caveats.filter(
+    (caveat) => caveat.enforcer.toLowerCase() === enforcerAddress.toLowerCase(),
+  );
+
+  if (matchingCaveats.length === 0) {
+    throw new Error(`No caveat found with enforcer matching ${enforcerAddress}`);
+  }
+
+  if (matchingCaveats.length > 1) {
+    throw new Error(`Multiple caveats found with enforcer matching ${enforcerAddress}`);
+  }
+
+  return {
+    terms: matchingCaveats[0].terms,
+    args: matchingCaveats[0].args,
+  };
+}
+
+/**
+ * Gets the delegation manager address from environment.
  *
- * @param params - The parameters object.
- * @param params.delegationManager - The delegation manager address.
  * @param environment - The delegator environment.
- * @returns The resolved delegation manager address.
+ * @returns The delegation manager address.
  */
-function resolveDelegationManager(
-  params: { delegationManager?: Address },
-  environment: DeleGatorEnvironment,
-): Address {
-  const delegationManager =
-    params.delegationManager ?? environment.DelegationManager;
-
-  if (!delegationManager) {
+function getDelegationManager(environment: DeleGatorEnvironment): Address {
+  if (!environment.DelegationManager) {
     throw new Error('Delegation manager address not found');
   }
 
-  return delegationManager;
+  return environment.DelegationManager;
 }
 
 /**
- * Resolves the enforcer address from parameters or environment.
+ * Gets the enforcer address from environment.
  *
  * @param enforcerName - The name of the enforcer.
- * @param params - The parameters object.
- * @param params.enforcerAddress - The enforcer address.
  * @param environment - The delegator environment.
- * @returns The resolved enforcer address.
+ * @returns The enforcer address.
  */
-function resolveEnforcerAddress(
+function getEnforcerAddress(
   enforcerName: keyof DeleGatorEnvironment['caveatEnforcers'],
-  params: { enforcerAddress?: Address },
   environment: DeleGatorEnvironment,
 ): Address {
-  if (params.enforcerAddress) {
-    return params.enforcerAddress;
-  }
-
   const enforcerAddress = environment.caveatEnforcers[enforcerName];
   if (!enforcerAddress) {
     throw new Error(`${enforcerName} not found in environment`);
@@ -119,21 +109,23 @@ function resolveEnforcerAddress(
 export async function getErc20PeriodTransferEnforcerAvailableAmount(
   client: PublicClient,
   environment: DeleGatorEnvironment,
-  params: ERC20PeriodTransferParams,
+  params: CaveatEnforcerParams,
 ): Promise<PeriodTransferResult> {
-  const delegationManager = resolveDelegationManager(params, environment);
-  const enforcerAddress = resolveEnforcerAddress(
+  const delegationManager = getDelegationManager(environment);
+  const enforcerAddress = getEnforcerAddress(
     'ERC20PeriodTransferEnforcer',
-    params,
     environment,
   );
 
+  const delegationHash = hashDelegation(params.delegation);
+  const { terms } = findMatchingCaveat(params.delegation, enforcerAddress);
+
   return ERC20PeriodTransferEnforcer.read.getAvailableAmount({
     client,
     contractAddress: enforcerAddress,
-    delegationHash: params.delegationHash,
+    delegationHash,
     delegationManager,
-    terms: params.terms,
+    terms,
   });
 }
 
@@ -148,21 +140,23 @@ export async function getErc20PeriodTransferEnforcerAvailableAmount(
 export async function getErc20StreamingEnforcerAvailableAmount(
   client: PublicClient,
   environment: DeleGatorEnvironment,
-  params: ERC20StreamingParams,
+  params: CaveatEnforcerParams,
 ): Promise<StreamingResult> {
-  const delegationManager = resolveDelegationManager(params, environment);
-  const enforcerAddress = resolveEnforcerAddress(
+  const delegationManager = getDelegationManager(environment);
+  const enforcerAddress = getEnforcerAddress(
     'ERC20StreamingEnforcer',
-    params,
     environment,
   );
 
+  const delegationHash = hashDelegation(params.delegation);
+  const { terms } = findMatchingCaveat(params.delegation, enforcerAddress);
+
   return ERC20StreamingEnforcer.read.getAvailableAmount({
     client,
     contractAddress: enforcerAddress,
     delegationManager,
-    delegationHash: params.delegationHash,
-    terms: params.terms,
+    delegationHash,
+    terms,
   });
 }
 
@@ -177,22 +171,24 @@ export async function getErc20StreamingEnforcerAvailableAmount(
 export async function getMultiTokenPeriodEnforcerAvailableAmount(
   client: PublicClient,
   environment: DeleGatorEnvironment,
-  params: MultiTokenPeriodParams,
+  params: CaveatEnforcerParams,
 ): Promise<PeriodTransferResult> {
-  const delegationManager = resolveDelegationManager(params, environment);
-  const enforcerAddress = resolveEnforcerAddress(
+  const delegationManager = getDelegationManager(environment);
+  const enforcerAddress = getEnforcerAddress(
     'MultiTokenPeriodEnforcer',
-    params,
     environment,
   );
 
+  const delegationHash = hashDelegation(params.delegation);
+  const { terms, args } = findMatchingCaveat(params.delegation, enforcerAddress);
+
   return MultiTokenPeriodEnforcer.read.getAvailableAmount({
     client,
     contractAddress: enforcerAddress,
-    delegationHash: params.delegationHash,
+    delegationHash,
     delegationManager,
-    terms: params.terms,
-    args: params.args,
+    terms,
+    args,
   });
 }
 
@@ -207,21 +203,23 @@ export async function getMultiTokenPeriodEnforcerAvailableAmount(
 export async function getNativeTokenPeriodTransferEnforcerAvailableAmount(
   client: PublicClient,
   environment: DeleGatorEnvironment,
-  params: NativeTokenPeriodTransferParams,
+  params: CaveatEnforcerParams,
 ): Promise<PeriodTransferResult> {
-  const delegationManager = resolveDelegationManager(params, environment);
-  const enforcerAddress = resolveEnforcerAddress(
+  const delegationManager = getDelegationManager(environment);
+  const enforcerAddress = getEnforcerAddress(
     'NativeTokenPeriodTransferEnforcer',
-    params,
     environment,
   );
 
+  const delegationHash = hashDelegation(params.delegation);
+  const { terms } = findMatchingCaveat(params.delegation, enforcerAddress);
+
   return NativeTokenPeriodTransferEnforcer.read.getAvailableAmount({
     client,
     contractAddress: enforcerAddress,
-    delegationHash: params.delegationHash,
+    delegationHash,
     delegationManager,
-    terms: params.terms,
+    terms,
   });
 }
 
@@ -236,21 +234,23 @@ export async function getNativeTokenPeriodTransferEnforcerAvailableAmount(
 export async function getNativeTokenStreamingEnforcerAvailableAmount(
   client: PublicClient,
   environment: DeleGatorEnvironment,
-  params: NativeTokenStreamingParams,
+  params: CaveatEnforcerParams,
 ): Promise<StreamingResult> {
-  const delegationManager = resolveDelegationManager(params, environment);
-  const enforcerAddress = resolveEnforcerAddress(
+  const delegationManager = getDelegationManager(environment);
+  const enforcerAddress = getEnforcerAddress(
     'NativeTokenStreamingEnforcer',
-    params,
     environment,
   );
 
+  const delegationHash = hashDelegation(params.delegation);
+  const { terms } = findMatchingCaveat(params.delegation, enforcerAddress);
+
   return NativeTokenStreamingEnforcer.read.getAvailableAmount({
     client,
     contractAddress: enforcerAddress,
     delegationManager,
-    delegationHash: params.delegationHash,
-    terms: params.terms,
+    delegationHash,
+    terms,
   });
 }
 
@@ -271,7 +271,7 @@ export const caveatEnforcerActions =
      * @returns Promise resolving to the period transfer result.
      */
     getErc20PeriodTransferEnforcerAvailableAmount: async (
-      params: ERC20PeriodTransferParams,
+      params: CaveatEnforcerParams,
     ): Promise<PeriodTransferResult> => {
       return getErc20PeriodTransferEnforcerAvailableAmount(
         client,
@@ -287,7 +287,7 @@ export const caveatEnforcerActions =
      * @returns Promise resolving to the streaming result.
      */
     getErc20StreamingEnforcerAvailableAmount: async (
-      params: ERC20StreamingParams,
+      params: CaveatEnforcerParams,
     ): Promise<StreamingResult> => {
       return getErc20StreamingEnforcerAvailableAmount(
         client,
@@ -303,7 +303,7 @@ export const caveatEnforcerActions =
      * @returns Promise resolving to the period transfer result.
      */
     getMultiTokenPeriodEnforcerAvailableAmount: async (
-      params: MultiTokenPeriodParams,
+      params: CaveatEnforcerParams,
     ): Promise<PeriodTransferResult> => {
       return getMultiTokenPeriodEnforcerAvailableAmount(
         client,
@@ -319,7 +319,7 @@ export const caveatEnforcerActions =
      * @returns Promise resolving to the period transfer result.
      */
     getNativeTokenPeriodTransferEnforcerAvailableAmount: async (
-      params: NativeTokenPeriodTransferParams,
+      params: CaveatEnforcerParams,
     ): Promise<PeriodTransferResult> => {
       return getNativeTokenPeriodTransferEnforcerAvailableAmount(
         client,
@@ -335,7 +335,7 @@ export const caveatEnforcerActions =
      * @returns Promise resolving to the streaming result.
      */
     getNativeTokenStreamingEnforcerAvailableAmount: async (
-      params: NativeTokenStreamingParams,
+      params: CaveatEnforcerParams,
     ): Promise<StreamingResult> => {
       return getNativeTokenStreamingEnforcerAvailableAmount(
         client,

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

@@ -10,19 +10,14 @@ export {
   getMultiTokenPeriodEnforcerAvailableAmount,
   getNativeTokenPeriodTransferEnforcerAvailableAmount,
   getNativeTokenStreamingEnforcerAvailableAmount,
-  // Client extension exports
-  createCaveatEnforcerClient,
+  // Action builder
   caveatEnforcerActions,
-  type CaveatEnforcerClient,
   // Parameter types
-  type ERC20PeriodTransferParams,
-  type ERC20StreamingParams,
-  type MultiTokenPeriodParams,
-  type NativeTokenPeriodTransferParams,
-  type NativeTokenStreamingParams,
+  type CaveatEnforcerParams,
   // Result types
   type PeriodTransferResult,
   type StreamingResult,
+
 } from './getCaveatAvailableAmount';
 
 export { isValid7702Implementation } from './isValid7702Implementation';

packages/delegation-toolkit/src/index.ts

@@ -61,3 +61,9 @@ export { redeemDelegations } from './write';
 export * as contracts from './contracts';
 
 export * as actions from './actions';
+
+// Export the caveat enforcer client
+export {
+  createCaveatEnforcerClient,
+  type CaveatEnforcerClient,
+} from './actions';