support msg.value in ECDSAMetaTransactionContext

Author: ItsNickBarry

contracts/meta/_ECDSAMetaTransactionContext.sol

@@ -14,7 +14,9 @@ abstract contract _ECDSAMetaTransactionContext is
     using ECDSA for bytes32;
 
     bytes32 internal constant EIP_712_TYPE_HASH =
-        keccak256('ECDSAMetaTransaction(bytes msgData,uint256 nonce)');
+        keccak256(
+            'ECDSAMetaTransaction(bytes msgData,uint256 msgValue,uint256 nonce)'
+        );
 
     bytes32
         internal constant ECDSA_META_TRANSACTION_CONTEXT_TRANSIENT_STORAGE_SLOT =
@@ -139,11 +141,16 @@ abstract contract _ECDSAMetaTransactionContext is
         unchecked {
             bytes calldata msgData = msg.data[:split];
             uint256 nonce = uint256(bytes32(msg.data[split:split + 32]));
+            bytes calldata signature = msg.data[split + 32:];
 
-            // TODO: include msg.sender in hash to restrict forwarder
-            // TODO: include msg.value
+            // TODO: include msg.sender in hash to restrict forwarder?
             bytes32 structHash = keccak256(
-                abi.encode(EIP_712_TYPE_HASH, keccak256(msgData), nonce)
+                abi.encode(
+                    EIP_712_TYPE_HASH,
+                    keccak256(msgData),
+                    msg.value,
+                    nonce
+                )
             );
 
             bytes32 domainSeparator = EIP712.calculateDomainSeparator_01100();
@@ -176,8 +183,6 @@ abstract contract _ECDSAMetaTransactionContext is
                 signedHash := keccak256(pointer, 66)
             }
 
-            bytes calldata signature = msg.data[split + 32:];
-
             // TODO: see what happens if split calldata v r s
             address signer = signedHash.tryRecover(signature);
 

lib/erc20_permit.ts

@@ -107,19 +107,22 @@ const signECDSAMetaTransaction = async (
   instance: IERC5267,
   signer: SignerWithAddress,
   msgData: BytesLike,
+  msgValue: bigint,
   nonce: bigint,
 ): Promise<Signature> => {
   const domain = await getDomain(instance);
 
   const types = {
     ECDSAMetaTransaction: [
       { name: 'msgData', type: 'bytes' },
+      { name: 'msgValue', type: 'uint256' },
       { name: 'nonce', type: 'uint256' },
     ],
   };
 
   const values = {
     msgData,
+    msgValue,
     nonce,
   };
 

test/meta/ECDSAMetaTransactionContext.ts

@@ -43,16 +43,20 @@ describe('ECDSAMetaTransactionContext', () => {
 
   // TODO: test multiple calls in same tx to validate that transient storage is used correctly
 
+  // TODO: test msg.value revert cases
+
   describe('__internal', () => {
     describe('#_msgSender()', () => {
       it('returns signer if signature is valid', async () => {
         const data = instance.$_msgSender.fragment.selector;
         const nonce = 1n;
+        const value = 0n;
 
         const signature = await signECDSAMetaTransaction(
           instance,
           signer,
           data,
+          value,
           nonce,
         );
 
@@ -94,11 +98,13 @@ describe('ECDSAMetaTransactionContext', () => {
       it('returns message data without suffix if signature is valid', async () => {
         const nonSuffixedData = instance.$_msgData.fragment.selector;
         const nonce = 1n;
+        const value = 0n;
 
         const signature = await signECDSAMetaTransaction(
           instance,
           signer,
           nonSuffixedData,
+          value,
           nonce,
         );