feat(ctb): Add the nonce and txHash into the ScheduledTransactions struct (#18097)

* feat(ctb): Add the nonce and txHash into the ScheduledTransactions struct

* chore(ctb): bump the semver on SaferSafes

* feat(ctb): txHash at start of struct

* semver-lock

* fix ITimelockGuard to match

---------

Co-authored-by: Alberto Cuesta Cañada <[email protected]>

Author: maurelian

packages/contracts-bedrock/interfaces/safe/ITimelockGuard.sol

@@ -12,10 +12,13 @@ interface ITimelockGuard {
         Cancelled,
         Executed
     }
+
     struct ScheduledTransaction {
+        bytes32 txHash;
         uint256 executionTime;
         TransactionState state;
         ExecTransactionParams params;
+        uint256 nonce;
     }
 
     struct ExecTransactionParams {

packages/contracts-bedrock/snapshots/abi/SaferSafes.json

@@ -305,6 +305,11 @@
     "outputs": [
       {
         "components": [
+          {
+            "internalType": "bytes32",
+            "name": "txHash",
+            "type": "bytes32"
+          },
           {
             "internalType": "uint256",
             "name": "executionTime",
@@ -366,6 +371,11 @@
             "internalType": "struct TimelockGuard.ExecTransactionParams",
             "name": "params",
             "type": "tuple"
+          },
+          {
+            "internalType": "uint256",
+            "name": "nonce",
+            "type": "uint256"
           }
         ],
         "internalType": "struct TimelockGuard.ScheduledTransaction[]",
@@ -475,6 +485,11 @@
     "outputs": [
       {
         "components": [
+          {
+            "internalType": "bytes32",
+            "name": "txHash",
+            "type": "bytes32"
+          },
           {
             "internalType": "uint256",
             "name": "executionTime",
@@ -536,6 +551,11 @@
             "internalType": "struct TimelockGuard.ExecTransactionParams",
             "name": "params",
             "type": "tuple"
+          },
+          {
+            "internalType": "uint256",
+            "name": "nonce",
+            "type": "uint256"
           }
         ],
         "internalType": "struct TimelockGuard.ScheduledTransaction",

packages/contracts-bedrock/snapshots/semver-lock.json

@@ -208,8 +208,8 @@
     "sourceCodeHash": "0x7fc4789b082bc8ecd29c4c75a06058f0ff0b72f1c1028a42db6f1c35269c8865"
   },
   "src/safe/SaferSafes.sol:SaferSafes": {
-    "initCodeHash": "0x2bee3bc687583bae2cb88edcf25ebe277b8d34b30bf9faac55ae6ec80080b8b9",
-    "sourceCodeHash": "0xed36bffcde1bf806a9bd9b599296f4818a6c123f5277d2f3e68635cb3f22973d"
+    "initCodeHash": "0xb4e7885e5f181e9223ecdbc4cfc8b5887fd2c22359e4c8bb4dee53f7dd193876",
+    "sourceCodeHash": "0x31f453780466a9d3e498a7981f66c92c3d0b76e1ee80c19e374d9692bcfbd931"
   },
   "src/universal/OptimismMintableERC20.sol:OptimismMintableERC20": {
     "initCodeHash": "0x3c85eed0d017dca8eda6396aa842ddc12492587b061e8c756a8d32c4610a9658",

packages/contracts-bedrock/src/safe/SaferSafes.sol

@@ -26,8 +26,8 @@ import { ISemver } from "interfaces/universal/ISemver.sol";
 ///      compatibility restrictions in the LivenessModule2 and TimelockGuard contracts.
 contract SaferSafes is LivenessModule2, TimelockGuard, ISemver {
     /// @notice Semantic version.
-    /// @custom:semver 1.8.0
-    string public constant version = "1.8.0";
+    /// @custom:semver 1.9.0
+    string public constant version = "1.9.0";
 
     /// @notice Error for when the liveness response period is insufficient.
     error SaferSafes_InsufficientLivenessResponsePeriod();

packages/contracts-bedrock/src/safe/TimelockGuard.sol

@@ -88,13 +88,17 @@ abstract contract TimelockGuard is BaseGuard {
     }
 
     /// @notice Scheduled transaction
+    /// @custom:field txHash The hash of the transaction.
     /// @custom:field executionTime The timestamp when execution becomes valid.
     /// @custom:field state The state of the transaction.
     /// @custom:field params The parameters of the transaction.
+    /// @custom:field nonce The nonce of the transaction.
     struct ScheduledTransaction {
+        bytes32 txHash;
         uint256 executionTime;
         TransactionState state;
         ExecTransactionParams params;
+        uint256 nonce;
     }
 
     /// @notice Parameters for the Safe's execTransaction function
@@ -564,8 +568,13 @@ abstract contract TimelockGuard is BaseGuard {
         uint256 executionTime = block.timestamp + _currentSafeState(_safe).timelockDelay;
 
         // Schedule the transaction and add it to the pending transactions set
-        _currentSafeState(_safe).scheduledTransactions[txHash] =
-            ScheduledTransaction({ executionTime: executionTime, state: TransactionState.Pending, params: _params });
+        _currentSafeState(_safe).scheduledTransactions[txHash] = ScheduledTransaction({
+            txHash: txHash,
+            executionTime: executionTime,
+            state: TransactionState.Pending,
+            params: _params,
+            nonce: _nonce
+        });
         _currentSafeState(_safe).pendingTxHashes.add(txHash);
 
         emit TransactionScheduled(_safe, txHash, executionTime);

packages/contracts-bedrock/test/safe/TimelockGuard.t.sol

@@ -505,9 +505,11 @@ contract TimelockGuard_ScheduledTransaction_Test is TimelockGuard_TestInit {
 
         TimelockGuard.ScheduledTransaction memory scheduledTransaction =
             timelockGuard.scheduledTransaction(safe, dummyTx.hash);
+        assertEq(scheduledTransaction.txHash, dummyTx.hash);
         assertEq(scheduledTransaction.executionTime, INIT_TIME + TIMELOCK_DELAY);
         assert(scheduledTransaction.state == TimelockGuard.TransactionState.Pending);
         assertEq(keccak256(abi.encode(scheduledTransaction.params)), keccak256(abi.encode(dummyTx.params)));
+        assertEq(scheduledTransaction.nonce, dummyTx.nonce);
     }
 }
 
@@ -525,9 +527,13 @@ contract TimelockGuard_PendingTransactions_Test is TimelockGuard_TestInit {
         dummyTx.scheduleTransaction(timelockGuard);
 
         TimelockGuard.ScheduledTransaction[] memory pendingTransactions = timelockGuard.pendingTransactions(safe);
+        // verify the pending transaction is the one we scheduled
         assertEq(pendingTransactions.length, 1);
-        // ensure the hash of the transaction params are the same
+        assertEq(pendingTransactions[0].txHash, dummyTx.hash);
+        assertEq(pendingTransactions[0].executionTime, INIT_TIME + TIMELOCK_DELAY);
+        assert(pendingTransactions[0].state == TimelockGuard.TransactionState.Pending);
         assertEq(pendingTransactions[0].params.to, dummyTx.params.to);
+        assertEq(pendingTransactions[0].nonce, dummyTx.nonce);
         assertEq(keccak256(abi.encode(pendingTransactions[0].params)), keccak256(abi.encode(dummyTx.params)));
     }