feat: accept delegation chain as either encoded Hex or decoded Delegation[] (#140)

* Standardize delegations and permissionContext parameters
- Adds new PermissionContext type that describes either a decoded Delegation[] or abi encoded Hex string, added to public API
- Rename permissionsContext parameter in ERC7710 action to permissionContext (singular)
- Accept PermissionContext in ERC-7710 actions and DelegationManager redeem paths
- encodeDelegations/decodeDelegations now both accept PermissionContext

* Remove unused internal functions
- prepDelegationHashForPasskeySign
- getCaveatArrayPacketHash
- deployWithSimpleFactory

* Update CHANGELOG.md

* Add test coverage for encodeDelegations and decodeDelegations inputs that won't get transformed. Added validation for invalid Hex inputs.

* Override environment and use expected DelegationManager address in new tests

* Linting

Author: jeffsmale90

packages/delegator-e2e/test/actions/erc7710sendTransactionWithDelegation.test.ts

@@ -38,7 +38,7 @@ let aliceSmartAccount: MetaMaskSmartAccount<Implementation.Hybrid>;
 let bob: Account;
 let bobPrivateKey: Hex;
 let aliceCounterContractAddress: Address;
-let permissionsContext: Hex;
+let permissionContext: Hex;
 let signedDelegation: Delegation;
 
 beforeEach(async () => {
@@ -75,7 +75,7 @@ beforeEach(async () => {
     signature: await aliceSmartAccount.signDelegation({ delegation }),
   };
 
-  permissionsContext = encodeDelegations([signedDelegation]);
+  permissionContext = encodeDelegations([signedDelegation]);
 });
 
 /*
@@ -113,7 +113,7 @@ test('maincase: Bob redeems the delegation in order to increment() on the counte
       abi: CounterMetadata.abi,
       functionName: 'increment',
     }),
-    permissionsContext,
+    permissionContext,
     delegationManager,
   });
 
@@ -183,7 +183,7 @@ test('Bob redelegates to Carol, who redeems the delegation to call increment() o
         abi: CounterMetadata.abi,
         functionName: 'increment',
       }),
-      permissionsContext: redelegatedPermissionsContext,
+      permissionContext: redelegatedPermissionsContext,
       delegationManager,
     },
   );
@@ -253,7 +253,7 @@ test('Bob sends a native value transaction with delegation', async () => {
     signature: await aliceSmartAccount.signDelegation({ delegation }),
   };
 
-  const permissionsContext = encodeDelegations([signedDelegation]);
+  const permissionContext = encodeDelegations([signedDelegation]);
 
   const bobWalletClient = createWalletClient({
     account: bob,
@@ -268,7 +268,7 @@ test('Bob sends a native value transaction with delegation', async () => {
     chain,
     to: recipient,
     value: maxAmount,
-    permissionsContext,
+    permissionContext,
     delegationManager,
   });
 

packages/delegator-e2e/test/actions/erc7710sendUserOperationWithDelegation.test.ts

@@ -34,7 +34,7 @@ import { expectUserOperationToSucceed } from '../utils/assertions';
 let aliceSmartAccount: MetaMaskSmartAccount<Implementation.Hybrid>;
 let bobSmartAccount: MetaMaskSmartAccount<Implementation.Hybrid>;
 let aliceCounterContractAddress: Address;
-let permissionsContext: Hex;
+let permissionContext: Hex;
 let signedDelegation: Delegation;
 
 const bundlerClient = sponsoredBundlerClient.extend(erc7710BundlerActions());
@@ -81,7 +81,7 @@ beforeEach(async () => {
     signature: await aliceSmartAccount.signDelegation({ delegation }),
   };
 
-  permissionsContext = encodeDelegations([signedDelegation]);
+  permissionContext = encodeDelegations([signedDelegation]);
 });
 
 /*
@@ -114,7 +114,7 @@ test('maincase: Bob redeems the delegation in order to call increment() on the c
           functionName: 'increment',
         }),
         value: 0n,
-        permissionsContext,
+        permissionContext,
         delegationManager: aliceSmartAccount.environment.DelegationManager,
       },
     ],
@@ -158,7 +158,7 @@ test('Bob redeems the delegation in order to call increment() on the counter con
           functionName: 'increment',
         }),
         value: 0n,
-        permissionsContext,
+        permissionContext,
         delegationManager: aliceSmartAccount.environment.DelegationManager,
       },
       {
@@ -217,7 +217,7 @@ test('Bob redeems the delegation, and deploys Alices smart account via dependenc
           functionName: 'increment',
         }),
         value: 0n,
-        permissionsContext,
+        permissionContext,
         delegationManager: aliceSmartAccount.environment.DelegationManager,
       },
     ],
@@ -268,7 +268,7 @@ test('Bob redeems the delegation, with dependencies, even though Alices account
           functionName: 'increment',
         }),
         value: 0n,
-        permissionsContext,
+        permissionContext,
         delegationManager: aliceSmartAccount.environment.DelegationManager,
       },
     ],

packages/delegator-e2e/test/caveats/nativeTokenPayment.test.ts

@@ -117,11 +117,11 @@ test('maincase: Bob redeems the delegation with a permissions context allowing p
     }),
   };
 
-  const permissionsContext = encodeDelegations([signedPaymentDelegation]);
+  const permissionContext = encodeDelegations([signedPaymentDelegation]);
 
   await runTest_expectSuccess(
     delegationRequiringNativeTokenPayment,
-    permissionsContext,
+    permissionContext,
     recipient,
     requiredValue,
   );
@@ -164,11 +164,11 @@ test('Bob attempts to redeem the delegation without an argsEqualityCheckEnforcer
     }),
   };
 
-  const permissionsContext = encodeDelegations([signedPaymentDelegation]);
+  const permissionContext = encodeDelegations([signedPaymentDelegation]);
 
   await runTest_expectFailure(
     delegationRequiringNativeTokenPayment,
-    permissionsContext,
+    permissionContext,
     recipient,
     'NativeTokenPaymentEnforcer:missing-argsEqualityCheckEnforcer',
   );
@@ -192,11 +192,11 @@ test('Bob attempts to redeem the delegation without providing a valid permission
     signature: '0x',
   };
 
-  const permissionsContext = '0x' as const;
+  const permissionContext = '0x' as const;
 
   await runTest_expectFailure(
     delegationRequiringNativeTokenPayment,
-    permissionsContext,
+    permissionContext,
     recipient,
     undefined, // The NativeTokenPaymentEnforcer rejects when it fails to decode the permissions context
   );
@@ -251,11 +251,11 @@ test('Bob attempts to redeem with invalid terms length', async () => {
     }),
   };
 
-  const permissionsContext = encodeDelegations([signedPaymentDelegation]);
+  const permissionContext = encodeDelegations([signedPaymentDelegation]);
 
   await runTest_expectFailure(
     delegationRequiringNativeTokenPayment,
-    permissionsContext,
+    permissionContext,
     recipient,
     'NativeTokenPaymentEnforcer:invalid-terms-length',
   );
@@ -281,27 +281,27 @@ test('Bob attempts to redeem with empty allowance delegations', async () => {
   };
 
   // Create empty allowance delegations array
-  const permissionsContext = encodeDelegations([]);
+  const permissionContext = encodeDelegations([]);
 
   await runTest_expectFailure(
     delegationRequiringNativeTokenPayment,
-    permissionsContext,
+    permissionContext,
     recipient,
     'NativeTokenPaymentEnforcer:invalid-allowance-delegations-length',
   );
 });
 
 const runTest_expectSuccess = async (
   delegation: Delegation,
-  permissionsContext: Hex,
+  permissionContext: Hex,
   recipient: Address,
   requiredValue: bigint,
 ) => {
   const balanceBefore = await publicClient.getBalance({
     address: recipient,
   });
 
-  const userOpHash = await submitUserOpForTest(delegation, permissionsContext);
+  const userOpHash = await submitUserOpForTest(delegation, permissionContext);
 
   const receipt = await sponsoredBundlerClient.waitForUserOperationReceipt({
     hash: userOpHash,
@@ -321,7 +321,7 @@ const runTest_expectSuccess = async (
 
 const runTest_expectFailure = async (
   delegation: Delegation,
-  permissionsContext: Hex,
+  permissionContext: Hex,
   recipient: Address,
   expectedError: string | undefined,
 ) => {
@@ -330,7 +330,7 @@ const runTest_expectFailure = async (
   });
 
   const rejects = expect(
-    submitUserOpForTest(delegation, permissionsContext),
+    submitUserOpForTest(delegation, permissionContext),
   ).rejects;
 
   if (expectedError) {
@@ -350,7 +350,7 @@ const runTest_expectFailure = async (
 
 const submitUserOpForTest = async (
   delegation: Delegation,
-  permissionsContext: Hex,
+  permissionContext: Hex,
 ) => {
   const signedDelegation = {
     ...delegation,
@@ -359,7 +359,7 @@ const submitUserOpForTest = async (
 
   // we need to assign the permissions context to the caveat in order for it to process the payment
   // here we assume that the first caveat is the nativeTokenPayment caveat
-  signedDelegation.caveats[0].args = permissionsContext;
+  signedDelegation.caveats[0].args = permissionContext;
 
   const execution = createExecution({
     target: zeroAddress,

packages/smart-accounts-kit/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Introduce `PermissionContext` to represent a delegation chain (ABI-encoded `Hex` or decoded `Delegation[]`). ([#140](https://github.com/MetaMask/smart-accounts-kit/pull/140))
+  - **Breaking**: Replace usages of raw `Hex` _or_ `Delegation[]` with `PermissionContext`, and rename `permissionsContext` to `permissionContext` (note the singular "permission") where applicable:
+    - `SendTransactionWithDelegation`: `permissionsContext: Hex` → `permissionContext: PermissionContext`
+    - `SendUserOperationWithDelegation`: within `calls: DelegatedCall`, `permissionsContext: Hex` → `permissionContext: PermissionContext`
+    - `redeemDelegations`: parameter `Delegation[]` → `PermissionContext`
+    - `encodeDelegations` and `decodeDelegations` now accept `PermissionContext` (if the input is already the expected type, the input is returned)
+    - `encode`, `execute`, and `simulate` functions for `DelegationManager.redeemDelegations` from `@metamask/smart-accounts-kit/contracts`: parameter `delegations: Delegation[]` → `delegations: PermissionContext`
+
 ### Fixed
 
 - Allow scope type to be specified either as `ScopeType` enum, or string literal ([#133](https://github.com/MetaMask/smart-accounts-kit/pull/133))

packages/smart-accounts-kit/src/DelegationFramework/DelegationManager/methods/redeemDelegations.ts

@@ -6,11 +6,11 @@ import { simulateContract, writeContract } from 'viem/actions';
 import { encodeDelegations } from '../../../delegation';
 import { encodeExecutionCalldatas } from '../../../executions';
 import type { ExecutionMode, ExecutionStruct } from '../../../executions';
-import type { Delegation } from '../../../types';
+import type { PermissionContext } from '../../../types';
 import type { InitializedClient } from '../../types';
 
 export type EncodeRedeemDelegationsParameters = {
-  delegations: Delegation[][];
+  delegations: PermissionContext[];
   modes: ExecutionMode[];
   executions: ExecutionStruct[][];
 };

packages/smart-accounts-kit/src/actions/erc7710RedeemDelegationAction.ts

@@ -17,16 +17,19 @@ import type {
   SmartAccount,
 } from 'viem/account-abstraction';
 
+import { encodeDelegations } from '../delegation';
 import {
   createExecution,
   encodeExecutionCalldatas,
   ExecutionMode,
 } from '../executions';
 import { getSmartAccountsEnvironment } from '../smartAccountsEnvironment';
-import type { Call } from '../types';
+import type { Call, PermissionContext } from '../types';
 
 export type DelegatedCall = Call &
-  OneOf<{ permissionsContext: Hex; delegationManager: Hex } | object>;
+  OneOf<
+    { permissionContext: PermissionContext; delegationManager: Hex } | object
+  >;
 
 export type SendTransactionWithDelegationParameters<
   TChain extends Chain | undefined = Chain | undefined,
@@ -35,7 +38,7 @@ export type SendTransactionWithDelegationParameters<
   TRequest extends SendTransactionRequest<TChain, TChainOverride> =
     SendTransactionRequest<TChain, TChainOverride>,
 > = SendTransactionParameters<TChain, TAccount, TChainOverride, TRequest> & {
-  permissionsContext: Hex;
+  permissionContext: PermissionContext;
   delegationManager: Hex;
 };
 
@@ -85,15 +88,15 @@ export async function sendTransactionWithDelegationAction<
     abi: DelegationManager,
     functionName: 'redeemDelegations',
     args: [
-      [args.permissionsContext],
+      [encodeDelegations(args.permissionContext)],
       [ExecutionMode.SingleDefault],
       encodeExecutionCalldatas([executions]),
     ],
   });
 
   const {
     value: _value,
-    permissionsContext: _permissionsContext,
+    permissionContext: _permissionContext,
     delegationManager: _delegationManager,
     ...rest
   } = args;
@@ -141,7 +144,7 @@ export type SendUserOperationWithDelegationParameters<
  *         functionName: 'increment',
  *       }),
  *       value: 0n,
- *       permissionsContext: '0x...',
+ *       permissionContext: '0x...',
  *       delegationManager: '0x...',
  *     },
  *   ],
@@ -215,6 +218,22 @@ export async function sendUserOperationWithDelegationAction<
     ];
   }
 
+  parameters.calls = parameters.calls.map((call) => {
+    if (!('permissionContext' in call)) {
+      return call;
+    }
+
+    const { permissionContext } = call;
+    if (!permissionContext) {
+      return call;
+    }
+
+    return {
+      ...call,
+      permissionContext: encodeDelegations(permissionContext),
+    };
+  });
+
   return client.sendUserOperation(
     parameters as unknown as SendUserOperationParameters,
   );

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

@@ -1,6 +1,5 @@
 import {
   type Hex,
-  encodePacked,
   encodeAbiParameters,
   parseAbiParameters,
   keccak256,
@@ -33,22 +32,6 @@ export const getCaveatPacketHash = (input: Caveat): Hex => {
   return keccak256(encoded);
 };
 
-/**
- * Calculates the hash of an array of Caveats.
- *
- * @param input - The array of Caveats.
- * @returns The keccak256 hash of the encoded Caveat array packet.
- */
-export const getCaveatArrayPacketHash = (input: Caveat[]): Hex => {
-  let encoded: Hex = '0x';
-
-  for (const caveat of input) {
-    const caveatPacketHash = getCaveatPacketHash(caveat);
-    encoded = encodePacked(['bytes', 'bytes32'], [encoded, caveatPacketHash]);
-  }
-  return keccak256(encoded);
-};
-
 /**
  * Creates a caveat.
  *