chore: Add quick explanatory comment to outbox suggested by @benesjan (…

…#5247)
AztecProtocol · Mar 15, 2024 · 56e8451 · 56e8451
1 parent 4f337c7
commit 56e8451
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/l1-contracts/slither_output.md b/l1-contracts/slither_output.md
@@ -137,10 +137,10 @@ src/core/messagebridge/NewInbox.sol#L41
 
 
  - [ ] ID-13
-[NewOutbox.constructor(address)._rollup](src/core/messagebridge/NewOutbox.sol#L30) lacks a zero-check on :
-		- [ROLLUP_CONTRACT = _rollup](src/core/messagebridge/NewOutbox.sol#L31)
+[NewOutbox.constructor(address)._rollup](src/core/messagebridge/NewOutbox.sol#L31) lacks a zero-check on :
+		- [ROLLUP_CONTRACT = _rollup](src/core/messagebridge/NewOutbox.sol#L32)
 
-src/core/messagebridge/NewOutbox.sol#L30
+src/core/messagebridge/NewOutbox.sol#L31
 
 
 ## reentrancy-events
@@ -245,10 +245,10 @@ src/core/messagebridge/Inbox.sol#L21-L231
 
 
  - [ ] ID-25
-The following public functions could be turned into external in [NewOutbox](src/core/messagebridge/NewOutbox.sol#L18-L131) contract:
-	[NewOutbox.constructor(address)](src/core/messagebridge/NewOutbox.sol#L30-L32)
+The following public functions could be turned into external in [NewOutbox](src/core/messagebridge/NewOutbox.sol#L18-L132) contract:
+	[NewOutbox.constructor(address)](src/core/messagebridge/NewOutbox.sol#L31-L33)
 
-src/core/messagebridge/NewOutbox.sol#L18-L131
+src/core/messagebridge/NewOutbox.sol#L18-L132
 
 
  - [ ] ID-26
@@ -359,9 +359,9 @@ src/core/Rollup.sol#L41
 Impact: Optimization
 Confidence: High
  - [ ] ID-40
-In a function [NewOutbox.insert(uint256,bytes32,uint256)](src/core/messagebridge/NewOutbox.sol#L43-L63) variable [NewOutbox.roots](src/core/messagebridge/NewOutbox.sol#L28) is read multiple times
+In a function [NewOutbox.insert(uint256,bytes32,uint256)](src/core/messagebridge/NewOutbox.sol#L44-L64) variable [NewOutbox.roots](src/core/messagebridge/NewOutbox.sol#L29) is read multiple times
 
-src/core/messagebridge/NewOutbox.sol#L43-L63
+src/core/messagebridge/NewOutbox.sol#L44-L64
 
 
  - [ ] ID-41

diff --git a/l1-contracts/src/core/messagebridge/NewOutbox.sol b/l1-contracts/src/core/messagebridge/NewOutbox.sol
@@ -19,6 +19,7 @@ contract NewOutbox is INewOutbox {
   using Hash for DataStructures.L2ToL1Msg;
 
   struct RootData {
+    // This is the outhash specified by header.globalvariables.outHash of any given block.
     bytes32 root;
     uint256 height;
     mapping(uint256 => bool) nullified;