refactor: separated scopes, and deleted enums

Author: hanzel98

packages/delegation-toolkit/src/caveatBuilder/scope/erc20PeriodicScope.ts

@@ -0,0 +1,33 @@
+import { createCaveatBuilder } from '../coreCaveatBuilder';
+import type { CoreCaveatBuilder } from '../coreCaveatBuilder';
+import type { Erc20PeriodTransferBuilderConfig } from '../erc20PeriodTransferBuilder';
+import type { DeleGatorEnvironment } from 'src/types';
+
+export type Erc20PeriodicScopeConfig = {
+  type: 'erc20-periodic';
+} & Erc20PeriodTransferBuilderConfig;
+
+/**
+ * Creates a caveat builder configured for ERC20 token periodic transfers with recurring limits.
+ *
+ * @param environment - The DeleGator environment.
+ * @param config - Configuration object containing ERC20 periodic transfer parameters.
+ * @returns A configured caveat builder with ERC20 period transfer and value limit caveats.
+ * @throws Error if any of the ERC20 periodic transfer parameters are invalid.
+ * @throws Error if the environment is not properly configured.
+ */
+export function createErc20PeriodicCaveatBuilder(
+  environment: DeleGatorEnvironment,
+  config: Erc20PeriodicScopeConfig,
+): CoreCaveatBuilder {
+  return createCaveatBuilder(environment)
+    .addCaveat('valueLte', {
+      maxValue: 0n,
+    })
+    .addCaveat('erc20PeriodTransfer', {
+      tokenAddress: config.tokenAddress,
+      periodAmount: config.periodAmount,
+      periodDuration: config.periodDuration,
+      startDate: config.startDate,
+    });
+}

packages/delegation-toolkit/src/caveatBuilder/scope/erc20Scope.ts

@@ -0,0 +1,34 @@
+import { createCaveatBuilder } from '../coreCaveatBuilder';
+import type { CoreCaveatBuilder } from '../coreCaveatBuilder';
+import type { Erc20StreamingBuilderConfig } from '../erc20StreamingBuilder';
+import type { DeleGatorEnvironment } from 'src/types';
+
+export type Erc20StreamingScopeConfig = {
+  type: 'erc20-streaming';
+} & Erc20StreamingBuilderConfig;
+
+/**
+ * Creates a caveat builder configured for ERC20 token streaming with time-based limits.
+ *
+ * @param environment - The DeleGator environment.
+ * @param config - Configuration object containing ERC20 streaming parameters.
+ * @returns A configured caveat builder with ERC20 streaming and value limit caveats.
+ * @throws Error if any of the ERC20 streaming parameters are invalid.
+ * @throws Error if the environment is not properly configured.
+ */
+export function createErc20StreamingCaveatBuilder(
+  environment: DeleGatorEnvironment,
+  config: Erc20StreamingScopeConfig,
+): CoreCaveatBuilder {
+  return createCaveatBuilder(environment)
+    .addCaveat('valueLte', {
+      maxValue: 0n,
+    })
+    .addCaveat('erc20Streaming', {
+      tokenAddress: config.tokenAddress,
+      initialAmount: config.initialAmount,
+      maxAmount: config.maxAmount,
+      amountPerSecond: config.amountPerSecond,
+      startTime: config.startTime,
+    });
+}

packages/delegation-toolkit/src/caveatBuilder/scope/erc20StreamingScope.ts

@@ -0,0 +1,31 @@
+import { createCaveatBuilder } from '../coreCaveatBuilder';
+import type { CoreCaveatBuilder } from '../coreCaveatBuilder';
+import type { Erc20TransferAmountBuilderConfig } from '../erc20TransferAmountBuilder';
+import type { DeleGatorEnvironment } from 'src/types';
+
+export type Erc20TransferScopeConfig = {
+  type: 'erc20-transfer';
+} & Erc20TransferAmountBuilderConfig;
+
+/**
+ * Creates a caveat builder configured for ERC20 token transfers with amount limits.
+ *
+ * @param environment - The DeleGator environment.
+ * @param config - Configuration object containing ERC20 transfer parameters.
+ * @returns A configured caveat builder with ERC20 transfer amount and value limit caveats.
+ * @throws Error if any of the ERC20 transfer parameters are invalid.
+ * @throws Error if the environment is not properly configured.
+ */
+export function createErc20TransferCaveatBuilder(
+  environment: DeleGatorEnvironment,
+  config: Erc20TransferScopeConfig,
+): CoreCaveatBuilder {
+  return createCaveatBuilder(environment)
+    .addCaveat('valueLte', {
+      maxValue: 0n,
+    })
+    .addCaveat('erc20TransferAmount', {
+      tokenAddress: config.tokenAddress,
+      maxAmount: config.maxAmount,
+    });
+}

packages/delegation-toolkit/src/caveatBuilder/scope/erc20TransferScope.ts

@@ -1,4 +1,15 @@
-import { type Erc20ScopeConfig, createErc20CaveatBuilder } from './erc20Scope';
+import {
+  type Erc20PeriodicScopeConfig,
+  createErc20PeriodicCaveatBuilder,
+} from './erc20PeriodicScope';
+import {
+  type Erc20StreamingScopeConfig,
+  createErc20StreamingCaveatBuilder,
+} from './erc20StreamingScope';
+import {
+  type Erc20TransferScopeConfig,
+  createErc20TransferCaveatBuilder,
+} from './erc20TransferScope';
 import {
   type Erc721ScopeConfig,
   createErc721CaveatBuilder,
@@ -8,19 +19,35 @@ import {
   type FunctionCallScopeConfig,
 } from './functionCallScope';
 import {
-  createNativeTokenCaveatBuilder,
-  type NativeTokenScopeConfig,
-} from './nativeTokenScope';
+  type NativeTokenPeriodicScopeConfig,
+  createNativeTokenPeriodicCaveatBuilder,
+} from './nativeTokenPeriodicScope';
+import {
+  type NativeTokenStreamingScopeConfig,
+  createNativeTokenStreamingCaveatBuilder,
+} from './nativeTokenStreamingScope';
+import {
+  type NativeTokenTransferScopeConfig,
+  createNativeTokenTransferCaveatBuilder,
+} from './nativeTokenTransferScope';
 import {
   createOwnershipCaveatBuilder,
   type OwnershipScopeConfig,
 } from './ownershipScope';
+import type { ScopeType } from './scopeTypes';
 import type { DeleGatorEnvironment } from '../../types';
 
+// Export the type for external use
+export type { ScopeType };
+
 export type ScopeConfig =
-  | Erc20ScopeConfig
+  | Erc20TransferScopeConfig
+  | Erc20StreamingScopeConfig
+  | Erc20PeriodicScopeConfig
+  | NativeTokenTransferScopeConfig
+  | NativeTokenStreamingScopeConfig
+  | NativeTokenPeriodicScopeConfig
   | Erc721ScopeConfig
-  | NativeTokenScopeConfig
   | OwnershipScopeConfig
   | FunctionCallScopeConfig;
 
@@ -29,15 +56,20 @@ export const createCaveatBuilderFromScope = (
   scopeConfig: ScopeConfig,
 ) => {
   switch (scopeConfig.type) {
-    case 'erc20':
-      return createErc20CaveatBuilder(
-        environment,
-        scopeConfig as Erc20ScopeConfig,
-      );
+    case 'erc20-transfer':
+      return createErc20TransferCaveatBuilder(environment, scopeConfig);
+    case 'erc20-streaming':
+      return createErc20StreamingCaveatBuilder(environment, scopeConfig);
+    case 'erc20-periodic':
+      return createErc20PeriodicCaveatBuilder(environment, scopeConfig);
+    case 'nativeToken-transfer':
+      return createNativeTokenTransferCaveatBuilder(environment, scopeConfig);
+    case 'nativeToken-streaming':
+      return createNativeTokenStreamingCaveatBuilder(environment, scopeConfig);
+    case 'nativeToken-periodic':
+      return createNativeTokenPeriodicCaveatBuilder(environment, scopeConfig);
     case 'erc721':
       return createErc721CaveatBuilder(environment, scopeConfig);
-    case 'nativeToken':
-      return createNativeTokenCaveatBuilder(environment, scopeConfig);
     case 'ownership':
       return createOwnershipCaveatBuilder(environment, scopeConfig);
     case 'functionCall':

packages/delegation-toolkit/src/caveatBuilder/scope/index.ts

@@ -0,0 +1,32 @@
+import { createCaveatBuilder } from '../coreCaveatBuilder';
+import type { CoreCaveatBuilder } from '../coreCaveatBuilder';
+import type { NativeTokenPeriodTransferBuilderConfig } from '../nativeTokenPeriodTransferBuilder';
+import type { DeleGatorEnvironment } from 'src/types';
+
+export type NativeTokenPeriodicScopeConfig = {
+  type: 'nativeToken-periodic';
+} & NativeTokenPeriodTransferBuilderConfig;
+
+/**
+ * Creates a caveat builder configured for native token periodic transfers with recurring limits.
+ *
+ * @param environment - The DeleGator environment.
+ * @param config - Configuration object containing native token periodic transfer parameters.
+ * @returns A configured caveat builder with native token period transfer and exact calldata caveats.
+ * @throws Error if any of the native token periodic transfer parameters are invalid.
+ * @throws Error if the environment is not properly configured.
+ */
+export function createNativeTokenPeriodicCaveatBuilder(
+  environment: DeleGatorEnvironment,
+  config: NativeTokenPeriodicScopeConfig,
+): CoreCaveatBuilder {
+  return createCaveatBuilder(environment)
+    .addCaveat('exactCalldata', {
+      calldata: '0x',
+    })
+    .addCaveat('nativeTokenPeriodTransfer', {
+      periodAmount: config.periodAmount,
+      periodDuration: config.periodDuration,
+      startDate: config.startDate,
+    });
+}