chore: caveat enforcer configs, and extend

Author: hanzel98

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

@@ -7,13 +7,6 @@ import * as NativeTokenPeriodTransferEnforcer from '../DelegationFramework/Nativ
 import * as NativeTokenStreamingEnforcer from '../DelegationFramework/NativeTokenStreamingEnforcer';
 import type { DeleGatorEnvironment } from '../types';
 
-/**
- * Configuration for caveat enforcer client
- */
-export type CaveatEnforcerClientConfig = {
-  environment: DeleGatorEnvironment;
-};
-
 /**
  * Shared base params for all enforcer actions
  */
@@ -119,23 +112,20 @@ function resolveEnforcerAddress(
  * Get available amount for ERC20 period transfer enforcer.
  *
  * @param client - The viem public client.
- * @param config - The configuration for caveat enforcers.
+ * @param environment - The delegator environment.
  * @param params - The parameters for the ERC20 period transfer enforcer.
  * @returns Promise resolving to the period transfer result.
  */
 export async function getErc20PeriodTransferEnforcerAvailableAmount(
   client: PublicClient,
-  config: CaveatEnforcerClientConfig,
+  environment: DeleGatorEnvironment,
   params: ERC20PeriodTransferParams,
 ): Promise<PeriodTransferResult> {
-  const delegationManager = resolveDelegationManager(
-    params,
-    config.environment,
-  );
+  const delegationManager = resolveDelegationManager(params, environment);
   const enforcerAddress = resolveEnforcerAddress(
     'ERC20PeriodTransferEnforcer',
     params,
-    config.environment,
+    environment,
   );
 
   return ERC20PeriodTransferEnforcer.read.getAvailableAmount({
@@ -151,23 +141,20 @@ export async function getErc20PeriodTransferEnforcerAvailableAmount(
  * Get available amount for ERC20 streaming enforcer.
  *
  * @param client - The viem public client.
- * @param config - The configuration for caveat enforcers.
+ * @param environment - The delegator environment.
  * @param params - The parameters for the ERC20 streaming enforcer.
  * @returns Promise resolving to the streaming result.
  */
 export async function getErc20StreamingEnforcerAvailableAmount(
   client: PublicClient,
-  config: CaveatEnforcerClientConfig,
+  environment: DeleGatorEnvironment,
   params: ERC20StreamingParams,
 ): Promise<StreamingResult> {
-  const delegationManager = resolveDelegationManager(
-    params,
-    config.environment,
-  );
+  const delegationManager = resolveDelegationManager(params, environment);
   const enforcerAddress = resolveEnforcerAddress(
     'ERC20StreamingEnforcer',
     params,
-    config.environment,
+    environment,
   );
 
   return ERC20StreamingEnforcer.read.getAvailableAmount({
@@ -183,23 +170,20 @@ export async function getErc20StreamingEnforcerAvailableAmount(
  * Get available amount for multi-token period enforcer.
  *
  * @param client - The viem public client.
- * @param config - The configuration for caveat enforcers.
+ * @param environment - The delegator environment.
  * @param params - The parameters for the multi-token period enforcer.
  * @returns Promise resolving to the period transfer result.
  */
 export async function getMultiTokenPeriodEnforcerAvailableAmount(
   client: PublicClient,
-  config: CaveatEnforcerClientConfig,
+  environment: DeleGatorEnvironment,
   params: MultiTokenPeriodParams,
 ): Promise<PeriodTransferResult> {
-  const delegationManager = resolveDelegationManager(
-    params,
-    config.environment,
-  );
+  const delegationManager = resolveDelegationManager(params, environment);
   const enforcerAddress = resolveEnforcerAddress(
     'MultiTokenPeriodEnforcer',
     params,
-    config.environment,
+    environment,
   );
 
   return MultiTokenPeriodEnforcer.read.getAvailableAmount({
@@ -216,23 +200,20 @@ export async function getMultiTokenPeriodEnforcerAvailableAmount(
  * Get available amount for native token period transfer enforcer.
  *
  * @param client - The viem public client.
- * @param config - The configuration for caveat enforcers.
+ * @param environment - The delegator environment.
  * @param params - The parameters for the native token period transfer enforcer.
  * @returns Promise resolving to the period transfer result.
  */
 export async function getNativeTokenPeriodTransferEnforcerAvailableAmount(
   client: PublicClient,
-  config: CaveatEnforcerClientConfig,
+  environment: DeleGatorEnvironment,
   params: NativeTokenPeriodTransferParams,
 ): Promise<PeriodTransferResult> {
-  const delegationManager = resolveDelegationManager(
-    params,
-    config.environment,
-  );
+  const delegationManager = resolveDelegationManager(params, environment);
   const enforcerAddress = resolveEnforcerAddress(
     'NativeTokenPeriodTransferEnforcer',
     params,
-    config.environment,
+    environment,
   );
 
   return NativeTokenPeriodTransferEnforcer.read.getAvailableAmount({
@@ -248,23 +229,20 @@ export async function getNativeTokenPeriodTransferEnforcerAvailableAmount(
  * Get available amount for native token streaming enforcer.
  *
  * @param client - The viem public client.
- * @param config - The configuration for caveat enforcers.
+ * @param environment - The delegator environment.
  * @param params - The parameters for the native token streaming enforcer.
  * @returns Promise resolving to the streaming result.
  */
 export async function getNativeTokenStreamingEnforcerAvailableAmount(
   client: PublicClient,
-  config: CaveatEnforcerClientConfig,
+  environment: DeleGatorEnvironment,
   params: NativeTokenStreamingParams,
 ): Promise<StreamingResult> {
-  const delegationManager = resolveDelegationManager(
-    params,
-    config.environment,
-  );
+  const delegationManager = resolveDelegationManager(params, environment);
   const enforcerAddress = resolveEnforcerAddress(
     'NativeTokenStreamingEnforcer',
     params,
-    config.environment,
+    environment,
   );
 
   return NativeTokenStreamingEnforcer.read.getAvailableAmount({
@@ -280,112 +258,113 @@ export async function getNativeTokenStreamingEnforcerAvailableAmount(
  * Caveat enforcer actions for extending viem clients.
  *
  * @param params - The parameters object.
- * @param params.client - The viem public client.
- * @param params.config - The configuration for caveat enforcers.
- * @returns The client extension with caveat enforcer actions.
+ * @param params.environment - The delegator environment.
+ * @returns A function that takes a client and returns the client extension with caveat enforcer actions.
  */
-export const caveatEnforcerActions = ({
-  client,
-  config,
-}: {
-  client: PublicClient;
-  config: CaveatEnforcerClientConfig;
-}) => ({
-  /**
-   * Get available amount for ERC20 period transfer enforcer.
-   *
-   * @param params - The parameters for the ERC20 period transfer enforcer.
-   * @returns Promise resolving to the period transfer result.
-   */
-  getErc20PeriodTransferEnforcerAvailableAmount: async (
-    params: ERC20PeriodTransferParams,
-  ): Promise<PeriodTransferResult> => {
-    return getErc20PeriodTransferEnforcerAvailableAmount(
-      client,
-      config,
-      params,
-    );
-  },
-
-  /**
-   * Get available amount for ERC20 streaming enforcer.
-   *
-   * @param params - The parameters for the ERC20 streaming enforcer.
-   * @returns Promise resolving to the streaming result.
-   */
-  getErc20StreamingEnforcerAvailableAmount: async (
-    params: ERC20StreamingParams,
-  ): Promise<StreamingResult> => {
-    return getErc20StreamingEnforcerAvailableAmount(client, config, params);
-  },
-
-  /**
-   * Get available amount for multi-token period enforcer.
-   *
-   * @param params - The parameters for the multi-token period enforcer.
-   * @returns Promise resolving to the period transfer result.
-   */
-  getMultiTokenPeriodEnforcerAvailableAmount: async (
-    params: MultiTokenPeriodParams,
-  ): Promise<PeriodTransferResult> => {
-    return getMultiTokenPeriodEnforcerAvailableAmount(client, config, params);
-  },
-
-  /**
-   * Get available amount for native token period transfer enforcer.
-   *
-   * @param params - The parameters for the native token period transfer enforcer.
-   * @returns Promise resolving to the period transfer result.
-   */
-  getNativeTokenPeriodTransferEnforcerAvailableAmount: async (
-    params: NativeTokenPeriodTransferParams,
-  ): Promise<PeriodTransferResult> => {
-    return getNativeTokenPeriodTransferEnforcerAvailableAmount(
-      client,
-      config,
-      params,
-    );
-  },
-
-  /**
-   * Get available amount for native token streaming enforcer.
-   *
-   * @param params - The parameters for the native token streaming enforcer.
-   * @returns Promise resolving to the streaming result.
-   */
-  getNativeTokenStreamingEnforcerAvailableAmount: async (
-    params: NativeTokenStreamingParams,
-  ): Promise<StreamingResult> => {
-    return getNativeTokenStreamingEnforcerAvailableAmount(
-      client,
-      config,
-      params,
-    );
-  },
-});
+export const caveatEnforcerActions =
+  ({ environment }: { environment: DeleGatorEnvironment }) =>
+  (client: PublicClient) => ({
+    /**
+     * Get available amount for ERC20 period transfer enforcer.
+     *
+     * @param params - The parameters for the ERC20 period transfer enforcer.
+     * @returns Promise resolving to the period transfer result.
+     */
+    getErc20PeriodTransferEnforcerAvailableAmount: async (
+      params: ERC20PeriodTransferParams,
+    ): Promise<PeriodTransferResult> => {
+      return getErc20PeriodTransferEnforcerAvailableAmount(
+        client,
+        environment,
+        params,
+      );
+    },
+
+    /**
+     * Get available amount for ERC20 streaming enforcer.
+     *
+     * @param params - The parameters for the ERC20 streaming enforcer.
+     * @returns Promise resolving to the streaming result.
+     */
+    getErc20StreamingEnforcerAvailableAmount: async (
+      params: ERC20StreamingParams,
+    ): Promise<StreamingResult> => {
+      return getErc20StreamingEnforcerAvailableAmount(
+        client,
+        environment,
+        params,
+      );
+    },
+
+    /**
+     * Get available amount for multi-token period enforcer.
+     *
+     * @param params - The parameters for the multi-token period enforcer.
+     * @returns Promise resolving to the period transfer result.
+     */
+    getMultiTokenPeriodEnforcerAvailableAmount: async (
+      params: MultiTokenPeriodParams,
+    ): Promise<PeriodTransferResult> => {
+      return getMultiTokenPeriodEnforcerAvailableAmount(
+        client,
+        environment,
+        params,
+      );
+    },
+
+    /**
+     * Get available amount for native token period transfer enforcer.
+     *
+     * @param params - The parameters for the native token period transfer enforcer.
+     * @returns Promise resolving to the period transfer result.
+     */
+    getNativeTokenPeriodTransferEnforcerAvailableAmount: async (
+      params: NativeTokenPeriodTransferParams,
+    ): Promise<PeriodTransferResult> => {
+      return getNativeTokenPeriodTransferEnforcerAvailableAmount(
+        client,
+        environment,
+        params,
+      );
+    },
+
+    /**
+     * Get available amount for native token streaming enforcer.
+     *
+     * @param params - The parameters for the native token streaming enforcer.
+     * @returns Promise resolving to the streaming result.
+     */
+    getNativeTokenStreamingEnforcerAvailableAmount: async (
+      params: NativeTokenStreamingParams,
+    ): Promise<StreamingResult> => {
+      return getNativeTokenStreamingEnforcerAvailableAmount(
+        client,
+        environment,
+        params,
+      );
+    },
+  });
 
 /**
  * Type for client extended with caveat enforcer actions.
  */
 export type CaveatEnforcerClient = PublicClient &
-  ReturnType<typeof caveatEnforcerActions>;
+  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.config - The configuration for caveat enforcers.
+ * @param params.environment - The delegator environment.
  * @returns The extended client with caveat enforcer actions.
  */
 export function createCaveatEnforcerClient({
   client,
-  config,
+  environment,
 }: {
   client: PublicClient;
-  config: CaveatEnforcerClientConfig;
+  environment: DeleGatorEnvironment;
 }): CaveatEnforcerClient {
-  return client.extend((extendedClient) =>
-    caveatEnforcerActions({ client: extendedClient, config }),
-  );
+  return client.extend(caveatEnforcerActions({ environment }));
 }

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

@@ -14,7 +14,6 @@ export {
   createCaveatEnforcerClient,
   caveatEnforcerActions,
   type CaveatEnforcerClient,
-  type CaveatEnforcerClientConfig,
   // Parameter types
   type ERC20PeriodTransferParams,
   type ERC20StreamingParams,