Add SignedPermission struct

coinbase · Oct 9, 2024 · 5bfa1b4 · 5bfa1b4
1 parent 9670fb0
commit 5bfa1b4
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 16 deletions.
diff --git a/src/SpendPermissions.sol b/src/SpendPermissions.sol
@@ -31,6 +31,14 @@ contract SpendPermissions {
         uint160 allowance;
     }
 
+    /// @notice A signed permit to approve a recurring allowance.
+    struct SignedPermission {
+        /// @dev Recurring allowance parameters.
+        RecurringAllowance recurringAllowance;
+        /// @dev User signature to validate via EIP-1271.
+        bytes signature;
+    }
+
     /// @notice Cycle parameters and spend usage.
     struct CycleUsage {
         /// @dev Start time of the cycle (unix seconds).
@@ -150,26 +158,25 @@ contract SpendPermissions {
     /// @param recipient Address to withdraw tokens to.
     /// @param value Amount of token attempting to withdraw (wei).
     function withdraw(bytes calldata context, address recipient, uint160 value) external {
-        (RecurringAllowance memory recurringAllowance, bytes memory signature) =
-            abi.decode(context, (RecurringAllowance, bytes));
-        permit(recurringAllowance, signature);
-        withdraw(recurringAllowance, recipient, value);
+        SignedPermission memory signedPermission = abi.decode(context, (SignedPermission));
+        permit(signedPermission);
+        withdraw(signedPermission.recurringAllowance, recipient, value);
     }
 
     /// @notice Approve a recurring allowance via a signature from the account.
     ///
-    /// @param recurringAllowance Details of the recurring allowance.
-    /// @param signature Signed hash of the recurring allowance data.
-    function permit(RecurringAllowance memory recurringAllowance, bytes memory signature) public {
+    /// @param signedPermission Signed recurring allowance permission.
+    function permit(SignedPermission memory signedPermission) public {
         // validate signature over recurring allowance data
         if (
-            IERC1271(recurringAllowance.account).isValidSignature(getHash(recurringAllowance), signature)
-                != IERC1271.isValidSignature.selector
+            IERC1271(signedPermission.recurringAllowance.account).isValidSignature(
+                getHash(signedPermission.recurringAllowance), signedPermission.signature
+            ) != IERC1271.isValidSignature.selector
         ) {
             revert UnauthorizedRecurringAllowance();
         }
 
-        _approve(recurringAllowance);
+        _approve(signedPermission.recurringAllowance);
     }
 
     /// @notice Withdraw tokens using a recurring allowance.

diff --git a/src/SpendPermissionsPaymaster.sol b/src/SpendPermissionsPaymaster.sol
@@ -55,8 +55,9 @@ contract SpendPermissionsPaymaster is SpendPermissions, Ownable2Step, IPaymaster
         requireSender(entryPoint())
         returns (bytes memory postOpContext, uint256 validationData)
     {
-        (RecurringAllowance memory recurringAllowance, bytes memory signature, uint256 withdrawAmount) =
-            abi.decode(userOp.paymasterAndData[20:], (RecurringAllowance, bytes, uint256));
+        (SignedPermission memory signedPermission, uint256 withdrawAmount) =
+            abi.decode(userOp.paymasterAndData[20:], (SignedPermission, uint256));
+        RecurringAllowance memory recurringAllowance = signedPermission.recurringAllowance;
 
         // require withdraw amount not less than max gas cost
         if (withdrawAmount < maxGasCost) {
@@ -74,8 +75,8 @@ contract SpendPermissionsPaymaster is SpendPermissions, Ownable2Step, IPaymaster
         }
 
         // apply permit if signature length non-zero
-        if (signature.length > 0) {
-            permit(recurringAllowance, signature);
+        if (signedPermission.signature.length > 0) {
+            permit(signedPermission);
         }
 
         // check total spend value does not overflow max value

diff --git a/test/src/SpendPermissions/Debug.t.sol b/test/src/SpendPermissions/Debug.t.sol
@@ -29,6 +29,7 @@ contract DebugTest is Test, Base {
     }
 
     function test_withdraw(address recipient) public {
+        vm.assume(recipient != address(spendPermissions));
         SpendPermissions.RecurringAllowance memory recurringAllowance = _createRecurringAllowance();
 
         vm.prank(address(account));

diff --git a/test/src/SpendPermissionsPaymaster/Debug.t.sol b/test/src/SpendPermissionsPaymaster/Debug.t.sol
@@ -49,7 +49,9 @@ contract DebugTest is Test, Base {
 
         vm.assertEq(account.isValidSignature(hash, signature), IERC1271.isValidSignature.selector);
 
-        bytes memory paymasterData = abi.encode(recurringAllowance, signature, allowance);
+        SpendPermissions.SignedPermission memory signedPermission =
+            SpendPermissions.SignedPermission(recurringAllowance, signature);
+        bytes memory paymasterData = abi.encode(signedPermission, allowance);
 
         userOp.paymasterAndData = abi.encodePacked(address(spendPermissions), paymasterData);
 
@@ -79,7 +81,9 @@ contract DebugTest is Test, Base {
 
         vm.assertEq(account.isValidSignature(hash, signature), IERC1271.isValidSignature.selector);
 
-        spendPermissions.permit(recurringAllowance, signature);
+        SpendPermissions.SignedPermission memory signedPermission =
+            SpendPermissions.SignedPermission(recurringAllowance, signature);
+        spendPermissions.permit(signedPermission);
 
         vm.assertTrue(spendPermissions.isAuthorized(recurringAllowance));