fix: lint issues, formatting

Author: hanzel98

packages/delegation-toolkit/package.json

@@ -125,6 +125,7 @@
     "@metamask/eslint-config": "^12.0.0",
     "@metamask/eslint-config-nodejs": "^12.0.0",
     "@metamask/eslint-config-typescript": "^12.0.0",
+    "@metamask/utils": "^11.4.0",
     "@types/node": "^20.10.6",
     "@types/sinon": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^5.42.1",

packages/delegation-toolkit/src/DelegationFramework/DelegationManager/read.ts

@@ -1,5 +1,5 @@
+import { read as disabledDelegations } from './methods/disabledDelegations';
 import { read as getAnyDelegate } from './methods/getAnyDelegate';
 import { read as getRootAuthority } from './methods/getRootAuthority';
-import { read as disabledDelegations } from './methods/disabledDelegations';
 
 export { getAnyDelegate, getRootAuthority, disabledDelegations };

packages/delegation-toolkit/src/DelegationFramework/ERC20PeriodTransferEnforcer/methods/getAvailableAmount.ts

@@ -17,14 +17,15 @@ export const read = async ({
   delegationManager,
   terms,
 }: ReadGetAvailableAmountParameters) => {
-  const result = await readContract(client, {
-    address: contractAddress,
-    abi: ERC20PeriodTransferEnforcer.abi,
-    functionName: 'getAvailableAmount',
-    args: [delegationHash, delegationManager, terms],
-  });
-
-  const [availableAmount, isNewPeriod, currentPeriod] = result;
+  const [availableAmount, isNewPeriod, currentPeriod] = await readContract(
+    client,
+    {
+      address: contractAddress,
+      abi: ERC20PeriodTransferEnforcer.abi,
+      functionName: 'getAvailableAmount',
+      args: [delegationHash, delegationManager, terms],
+    },
+  );
 
   return {
     availableAmount,

packages/delegation-toolkit/src/DelegationFramework/ERC20StreamingEnforcer/methods/getAvailableAmount.ts

@@ -35,7 +35,7 @@ export const read = async ({
   // Check if state exists (startTime != 0)
   if (startTime !== 0n) {
     // State exists, calculate available amount using the stored state
-    const availableAmount = _getAvailableAmount({
+    const availableAmount = getAvailableAmount({
       initialAmount,
       maxAmount,
       amountPerSecond,
@@ -66,7 +66,7 @@ export const read = async ({
   ] = decodedTerms;
 
   // Simulate using decoded terms with spent = 0
-  const availableAmount = _getAvailableAmount({
+  const availableAmount = getAvailableAmount({
     initialAmount: decodedInitialAmount,
     maxAmount: decodedMaxAmount,
     amountPerSecond: decodedAmountPerSecond,
@@ -81,9 +81,18 @@ export const read = async ({
 };
 
 /**
- * Replicates the internal _getAvailableAmount logic from the smart contract
+ * Replicates the internal _getAvailableAmount logic from the smart contract.
+ *
+ * @param allowance - The allowance object containing all parameters.
+ * @param allowance.initialAmount - The initial amount available.
+ * @param allowance.maxAmount - The maximum amount allowed.
+ * @param allowance.amountPerSecond - The amount streamed per second.
+ * @param allowance.startTime - The start time of the streaming.
+ * @param allowance.spent - The amount already spent.
+ * @param allowance.currentTimestamp - The current timestamp.
+ * @returns The available amount that can be spent.
  */
-function _getAvailableAmount(allowance: {
+function getAvailableAmount(allowance: {
   initialAmount: bigint;
   maxAmount: bigint;
   amountPerSecond: bigint;

packages/delegation-toolkit/src/DelegationFramework/MultiTokenPeriodEnforcer/methods/getAvailableAmount.ts

@@ -19,14 +19,15 @@ export const read = async ({
   terms,
   args,
 }: ReadGetAvailableAmountParameters) => {
-  const result = await readContract(client, {
-    address: contractAddress,
-    abi: MultiTokenPeriodEnforcer.abi,
-    functionName: 'getAvailableAmount',
-    args: [delegationHash, delegationManager, terms, args],
-  });
-
-  const [availableAmount, isNewPeriod, currentPeriod] = result;
+  const [availableAmount, isNewPeriod, currentPeriod] = await readContract(
+    client,
+    {
+      address: contractAddress,
+      abi: MultiTokenPeriodEnforcer.abi,
+      functionName: 'getAvailableAmount',
+      args: [delegationHash, delegationManager, terms, args],
+    },
+  );
 
   return {
     availableAmount,

packages/delegation-toolkit/src/DelegationFramework/NativeTokenPeriodTransferEnforcer/methods/getAvailableAmount.ts

@@ -17,14 +17,15 @@ export const read = async ({
   delegationManager,
   terms,
 }: ReadGetAvailableAmountParameters) => {
-  const result = await readContract(client, {
-    address: contractAddress,
-    abi: NativeTokenPeriodTransferEnforcer.abi,
-    functionName: 'getAvailableAmount',
-    args: [delegationHash, delegationManager, terms],
-  });
-
-  const [availableAmount, isNewPeriod, currentPeriod] = result;
+  const [availableAmount, isNewPeriod, currentPeriod] = await readContract(
+    client,
+    {
+      address: contractAddress,
+      abi: NativeTokenPeriodTransferEnforcer.abi,
+      functionName: 'getAvailableAmount',
+      args: [delegationHash, delegationManager, terms],
+    },
+  );
 
   return {
     availableAmount,

packages/delegation-toolkit/src/DelegationFramework/NativeTokenStreamingEnforcer/methods/getAvailableAmount.ts

@@ -35,7 +35,7 @@ export const read = async ({
   // Check if state exists (startTime != 0)
   if (startTime !== 0n) {
     // State exists, calculate available amount using the stored state
-    const availableAmount = _getAvailableAmount({
+    const availableAmount = getAvailableAmount({
       initialAmount,
       maxAmount,
       amountPerSecond,
@@ -65,7 +65,7 @@ export const read = async ({
   ] = decodedTerms;
 
   // Simulate using decoded terms with spent = 0
-  const availableAmount = _getAvailableAmount({
+  const availableAmount = getAvailableAmount({
     initialAmount: decodedInitialAmount,
     maxAmount: decodedMaxAmount,
     amountPerSecond: decodedAmountPerSecond,
@@ -80,9 +80,18 @@ export const read = async ({
 };
 
 /**
- * Replicates the internal _getAvailableAmount logic from the smart contract
+ * Replicates the internal _getAvailableAmount logic from the smart contract.
+ *
+ * @param allowance - The allowance object containing all parameters.
+ * @param allowance.initialAmount - The initial amount available.
+ * @param allowance.maxAmount - The maximum amount allowed.
+ * @param allowance.amountPerSecond - The amount streamed per second.
+ * @param allowance.startTime - The start time of the streaming.
+ * @param allowance.spent - The amount already spent.
+ * @param allowance.currentTimestamp - The current timestamp.
+ * @returns The available amount that can be spent.
  */
-function _getAvailableAmount(allowance: {
+function getAvailableAmount(allowance: {
   initialAmount: bigint;
   maxAmount: bigint;
   amountPerSecond: bigint;

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

@@ -2,80 +2,88 @@ import type { Address, Hex, PublicClient } from 'viem';
 
 import * as ERC20PeriodTransferEnforcer from '../DelegationFramework/ERC20PeriodTransferEnforcer';
 import * as ERC20StreamingEnforcer from '../DelegationFramework/ERC20StreamingEnforcer';
+import * as MultiTokenPeriodEnforcer from '../DelegationFramework/MultiTokenPeriodEnforcer';
 import * as NativeTokenPeriodTransferEnforcer from '../DelegationFramework/NativeTokenPeriodTransferEnforcer';
 import * as NativeTokenStreamingEnforcer from '../DelegationFramework/NativeTokenStreamingEnforcer';
-import * as MultiTokenPeriodEnforcer from '../DelegationFramework/MultiTokenPeriodEnforcer';
 import type { DeleGatorEnvironment } from '../types';
 
 /**
  * Configuration for caveat enforcer client
  */
-export interface CaveatEnforcerClientConfig {
+export type CaveatEnforcerClientConfig = {
   environment: DeleGatorEnvironment;
-}
+};
 
 /**
  * Shared base params for all enforcer actions
  */
-export interface BaseCaveatParams {
+export type BaseCaveatParams = {
   delegationHash: Hex;
   delegationManager?: Address;
   enforcerAddress?: Address;
   terms: Hex;
-}
+};
 
 /**
- * Parameters for ERC20 period transfer enforcer
+ * Parameters for ERC20 period transfer enforcer.
  */
-export interface ERC20PeriodTransferParams extends BaseCaveatParams {}
+export type ERC20PeriodTransferParams = Record<string, never> &
+  BaseCaveatParams;
 
 /**
- * Parameters for ERC20 streaming enforcer
+ * Parameters for ERC20 streaming enforcer.
  */
-export interface ERC20StreamingParams extends BaseCaveatParams {}
+export type ERC20StreamingParams = Record<string, never> & BaseCaveatParams;
 
 /**
- * Parameters for MultiTokenPeriodEnforcer
+ * Parameters for MultiTokenPeriodEnforcer.
  */
-export interface MultiTokenPeriodParams extends BaseCaveatParams {
+export type MultiTokenPeriodParams = {
   args: Hex;
-}
+} & BaseCaveatParams;
 
 /**
- * Parameters for native token period transfer enforcer
+ * Parameters for native token period transfer enforcer.
  */
-export interface NativeTokenPeriodTransferParams extends BaseCaveatParams {}
+export type NativeTokenPeriodTransferParams = Record<string, never> &
+  BaseCaveatParams;
 
 /**
- * Parameters for native token streaming enforcer
+ * Parameters for native token streaming enforcer.
  */
-export interface NativeTokenStreamingParams extends BaseCaveatParams {}
+export type NativeTokenStreamingParams = Record<string, never> &
+  BaseCaveatParams;
 
 /**
  * Return type for period-based transfer enforcers
  */
-export interface PeriodTransferResult {
+export type PeriodTransferResult = {
   availableAmount: bigint;
   isNewPeriod: boolean;
   currentPeriod: bigint;
-}
+};
 
 /**
  * Return type for streaming enforcers
  */
-export interface StreamingResult {
+export type StreamingResult = {
   availableAmount: bigint;
-}
+};
 
 /**
- * Resolves the delegation manager address from parameters or environment
+ * Resolves the delegation manager address from parameters or environment.
+ *
+ * @param params - The parameters object.
+ * @param params.delegationManager - The delegation manager address.
+ * @param environment - The delegator environment.
+ * @returns The resolved delegation manager address.
  */
 function resolveDelegationManager(
   params: { delegationManager?: Address },
   environment: DeleGatorEnvironment,
 ): Address {
   const delegationManager =
-    params.delegationManager || environment.DelegationManager;
+    params.delegationManager ?? environment.DelegationManager;
 
   if (!delegationManager) {
     throw new Error('Delegation manager address not found');
@@ -85,7 +93,13 @@ function resolveDelegationManager(
 }
 
 /**
- * Resolves the enforcer address from parameters or environment
+ * Resolves the enforcer address from parameters or 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.
  */
 function resolveEnforcerAddress(
   enforcerName: keyof DeleGatorEnvironment['caveatEnforcers'],
@@ -105,12 +119,18 @@ function resolveEnforcerAddress(
 }
 
 /**
- * Caveat enforcer actions for extending viem clients
+ * Caveat enforcer actions for extending viem clients.
+ *
+ * @param config - The configuration for caveat enforcers.
+ * @returns The client extension with caveat enforcer actions.
  */
 export const caveatEnforcerActions =
   (config: CaveatEnforcerClientConfig) => (client: PublicClient) => ({
     /**
-     * Get available amount for ERC20 period transfer enforcer
+     * 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,
@@ -135,7 +155,10 @@ export const caveatEnforcerActions =
     },
 
     /**
-     * Get available amount for ERC20 streaming enforcer
+     * 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,
@@ -160,7 +183,10 @@ export const caveatEnforcerActions =
     },
 
     /**
-     * Get available amount for multi-token period enforcer
+     * 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,
@@ -186,7 +212,10 @@ export const caveatEnforcerActions =
     },
 
     /**
-     * Get available amount for native token period transfer enforcer
+     * 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,
@@ -211,7 +240,10 @@ export const caveatEnforcerActions =
     },
 
     /**
-     * Get available amount for native token streaming enforcer
+     * 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,
@@ -237,13 +269,17 @@ export const caveatEnforcerActions =
   });
 
 /**
- * Type for client extended with caveat enforcer actions
+ * 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
+ * Create a viem client extended with caveat enforcer actions.
+ *
+ * @param client - The viem public client.
+ * @param config - The configuration for caveat enforcers.
+ * @returns The extended client with caveat enforcer actions.
  */
 export function createCaveatEnforcerClient(
   client: PublicClient,