feat: add CaveatType enum and integrate into core caveat builder (#179)

* feat: add CaveatType enum and integrate into core caveat builder

* feat: reintroduce CaveatType enum and update core caveat builder integration

* feat: remove CaveatTypeParam type definition for simplification

* feat: refactor CoreCaveatMap type definition for improved type resolution

* fix: update import path for CaveatType in coreCaveatBuilder

* feat: update CaveatMapLookup to use _CoreCaveatMap for improved type safety

* feat: simplify CaveatMapLookup type definition for clarity

* feat: remove unused import of Caveat from coreCaveatBuilder for cleaner code

* feat: update CoreCaveatMap to directly reference _CoreCaveatMap for improved type clarity

* feat: add tests for caveat builders using CaveatType enum for improved coverage

* feat: rename _CoreCaveatMap to CoreCaveatMapByString for clarity and update CoreCaveatMap type definition

Author: mj-kiwi

packages/smart-accounts-kit/src/caveatBuilder/coreCaveatBuilder.ts

@@ -83,12 +83,13 @@ import {
 } from './specificActionERC20TransferBatchBuilder';
 import { timestamp, timestampBuilder } from './timestampBuilder';
 import { valueLte, valueLteBuilder } from './valueLteBuilder';
+import type { CaveatType } from '../constants';
 
 // While we could derive CoreCaveatMap from the createCaveatBuilder function,
 // doing so would significantly complicate type resolution. By explicitly
 // declaring the return type of createCaveatBuilder, we ensure the caveat
 // map remains synchronized with the actual implementation.
-type CoreCaveatMap = {
+type CoreCaveatMapByString = {
   allowedMethods: typeof allowedMethodsBuilder;
   allowedTargets: typeof allowedTargetsBuilder;
   deployed: typeof deployedBuilder;
@@ -122,6 +123,10 @@ type CoreCaveatMap = {
   ownershipTransfer: typeof ownershipTransferBuilder;
 };
 
+type CoreCaveatMap = CoreCaveatMapByString & {
+  [K in CaveatType as `${K}`]: CoreCaveatMapByString[`${K}`];
+};
+
 /**
  * A caveat builder type that includes all core caveat types pre-configured.
  * This type represents a fully configured caveat builder with all the standard

packages/smart-accounts-kit/src/constants.ts

@@ -53,3 +53,42 @@ export enum ScopeType {
   OwnershipTransfer = 'ownershipTransfer',
   FunctionCall = 'functionCall',
 }
+
+/**
+ * Caveat types for enforcer functions used in delegations.
+ * Can be used when defining caveats either via CaveatBuilder.addCaveat
+ * or in the caveats array in createDelegation.
+ */
+export enum CaveatType {
+  AllowedMethods = 'allowedMethods',
+  AllowedTargets = 'allowedTargets',
+  Deployed = 'deployed',
+  AllowedCalldata = 'allowedCalldata',
+  Erc20BalanceChange = 'erc20BalanceChange',
+  Erc721BalanceChange = 'erc721BalanceChange',
+  Erc1155BalanceChange = 'erc1155BalanceChange',
+  ValueLte = 'valueLte',
+  LimitedCalls = 'limitedCalls',
+  Id = 'id',
+  Nonce = 'nonce',
+  Timestamp = 'timestamp',
+  BlockNumber = 'blockNumber',
+  Erc20TransferAmount = 'erc20TransferAmount',
+  Erc20Streaming = 'erc20Streaming',
+  NativeTokenStreaming = 'nativeTokenStreaming',
+  Erc721Transfer = 'erc721Transfer',
+  NativeTokenTransferAmount = 'nativeTokenTransferAmount',
+  NativeBalanceChange = 'nativeBalanceChange',
+  Redeemer = 'redeemer',
+  NativeTokenPayment = 'nativeTokenPayment',
+  ArgsEqualityCheck = 'argsEqualityCheck',
+  SpecificActionERC20TransferBatch = 'specificActionERC20TransferBatch',
+  Erc20PeriodTransfer = 'erc20PeriodTransfer',
+  NativeTokenPeriodTransfer = 'nativeTokenPeriodTransfer',
+  ExactCalldataBatch = 'exactCalldataBatch',
+  ExactCalldata = 'exactCalldata',
+  ExactExecution = 'exactExecution',
+  ExactExecutionBatch = 'exactExecutionBatch',
+  MultiTokenPeriod = 'multiTokenPeriod',
+  OwnershipTransfer = 'ownershipTransfer',
+}

packages/smart-accounts-kit/src/index.ts

@@ -37,7 +37,12 @@ export {
   getSmartAccountsEnvironment,
 } from './smartAccountsEnvironment';
 
-export { Implementation, TransferWindow, ScopeType } from './constants';
+export {
+  Implementation,
+  TransferWindow,
+  ScopeType,
+  CaveatType,
+} from './constants';
 
 export { createExecution, ExecutionMode } from './executions';