chore: deleted public client from caveatEnforcerClient

Author: hanzel98

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

@@ -1,4 +1,4 @@
-import type { PublicClient } from 'viem';
+import type { Client, Transport, Chain, Account } from 'viem';
 
 import type { DeleGatorEnvironment } from '../types';
 import {
@@ -10,25 +10,34 @@ import {
 
 /**
  * Type for client extended with caveat enforcer actions.
+ * This extends the base Client type to avoid pollution from PublicClient actions.
  */
-export type CaveatEnforcerClient = PublicClient &
+export type CaveatEnforcerClient<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+> = Client<TTransport, TChain, TAccount> &
   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.client - The viem client (can be any client type).
  * @param params.environment - The delegator environment.
  * @returns The extended client with caveat enforcer actions.
  */
-export function createCaveatEnforcerClient({
+export function createCaveatEnforcerClient<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+>({
   client,
   environment,
 }: {
-  client: PublicClient;
+  client: Client<TTransport, TChain, TAccount>;
   environment: DeleGatorEnvironment;
-}): CaveatEnforcerClient {
+}): CaveatEnforcerClient<TTransport, TChain, TAccount> {
   return client.extend(caveatEnforcerActions({ environment }));
 }
 

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

@@ -1,4 +1,4 @@
-import type { Address, Hex, PublicClient } from 'viem';
+import type { Address, Hex, Client } from 'viem';
 
 import { getDelegationHashOffchain } from '../delegation';
 import * as ERC20PeriodTransferEnforcer from '../DelegationFramework/ERC20PeriodTransferEnforcer';
@@ -114,13 +114,13 @@ function getEnforcerAddress({
 /**
  * Get available amount for ERC20 period transfer enforcer.
  *
- * @param client - The viem public client.
+ * @param client - The viem client.
  * @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,
+  client: Client,
   environment: DeleGatorEnvironment,
   params: CaveatEnforcerParams,
 ): Promise<PeriodTransferResult> {
@@ -151,13 +151,13 @@ export async function getErc20PeriodTransferEnforcerAvailableAmount(
 /**
  * Get available amount for ERC20 streaming enforcer.
  *
- * @param client - The viem public client.
+ * @param client - The viem client.
  * @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,
+  client: Client,
   environment: DeleGatorEnvironment,
   params: CaveatEnforcerParams,
 ): Promise<StreamingResult> {
@@ -187,13 +187,13 @@ export async function getErc20StreamingEnforcerAvailableAmount(
 /**
  * Get available amount for multi-token period enforcer.
  *
- * @param client - The viem public client.
+ * @param client - The viem client.
  * @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,
+  client: Client,
   environment: DeleGatorEnvironment,
   params: CaveatEnforcerParams,
 ): Promise<PeriodTransferResult> {
@@ -224,13 +224,13 @@ export async function getMultiTokenPeriodEnforcerAvailableAmount(
 /**
  * Get available amount for native token period transfer enforcer.
  *
- * @param client - The viem public client.
+ * @param client - The viem client.
  * @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,
+  client: Client,
   environment: DeleGatorEnvironment,
   params: CaveatEnforcerParams,
 ): Promise<PeriodTransferResult> {
@@ -260,13 +260,13 @@ export async function getNativeTokenPeriodTransferEnforcerAvailableAmount(
 /**
  * Get available amount for native token streaming enforcer.
  *
- * @param client - The viem public client.
+ * @param client - The viem client.
  * @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,
+  client: Client,
   environment: DeleGatorEnvironment,
   params: CaveatEnforcerParams,
 ): Promise<StreamingResult> {
@@ -302,7 +302,7 @@ export async function getNativeTokenStreamingEnforcerAvailableAmount(
  */
 export const caveatEnforcerActions =
   ({ environment }: { environment: DeleGatorEnvironment }) =>
-  (client: PublicClient) => ({
+  (client: Client) => ({
     /**
      * Get available amount for ERC20 period transfer enforcer.
      *