docs(fast-inbox): describe streaming inbox behavior without transition or spec references (A-1385)

Author: spalladino

l1-contracts/src/core/libraries/compressed-data/CheckpointLog.sol

@@ -34,7 +34,7 @@ struct TempCheckpointLog {
   bytes32 attestationsHash;
   bytes32 payloadDigest;
   Slot slotNumber;
-  // Streaming Inbox consumption counts (AZIP-22 Fast Inbox). `inboxMsgTotal` is the cumulative Inbox message count
+  // Streaming Inbox consumption counts. `inboxMsgTotal` is the cumulative Inbox message count
   // consumed as of this checkpoint (the child's parent-total origin); `inboxConsumedBucket` is the bucket sequence
   // number the header's rolling hash corresponds to. Declared next to the slot number so the three share one storage
   // slot (4 + 8 + 8 of 32 bytes): propose writes and reads that slot for the slot-progression check anyway.

l1-contracts/src/core/libraries/rollup/EpochProofLib.sol

@@ -290,7 +290,7 @@ library EpochProofLib {
         );
       }
 
-      // Boundary anchoring for the Inbox rolling-hash chain (AZIP-22 Fast Inbox), mirroring previousArchive/endArchive:
+      // Boundary anchoring for the Inbox rolling-hash chain, mirroring previousArchive/endArchive:
       // both ends of the claimed chain segment must match the rolling hashes recorded at propose for checkpoints
       // _start - 1 and _end. The start needs this to be sound - the previous checkpoint's header is not among this
       // proof's public inputs, so nothing else pins where the segment begins. The end is already pinned transitively
@@ -343,7 +343,7 @@ library EpochProofLib {
 
       publicInputs[2] = _args.outHash;
 
-      // Inbox rolling-hash chain segment consumed across the epoch (AZIP-22 Fast Inbox). The start is validated above
+      // Inbox rolling-hash chain segment consumed across the epoch. The start is validated above
       // against the record written at propose for checkpoint _start - 1; the end is pinned transitively through the
       // stored checkpoint header hashes (see the anchoring block in assertAcceptable).
       publicInputs[3] = _args.previousInboxRollingHash;

l1-contracts/src/core/libraries/rollup/ProposeLib.sol

@@ -34,7 +34,7 @@ struct ProposeArgs {
   bytes32 archive;
   OracleInput oracleInput;
   ProposedHeader header;
-  // Sequence number of the Inbox bucket the header's `inboxRollingHash` corresponds to (AZIP-22 Fast Inbox).
+  // Sequence number of the Inbox bucket the header's `inboxRollingHash` corresponds to.
   // Unsigned lookup aid kept out of the attested payload digest: a wrong hint can only revert, never change what is
   // accepted, since integrity comes from the rolling-hash equality check against the committee-signed header.
   uint256 bucketHint;
@@ -269,8 +269,8 @@ library ProposeLib {
     uint256 checkpointNumber = tips.getPending() + 1;
     tips = tips.updatePending(checkpointNumber);
 
-    // Validate the streaming Inbox consumption against the parent checkpoint's consumed position (AZIP-22 Fast
-    // Inbox). The parent is checkpointNumber - 1, always available: checkpoint 0 carries the {0,0,0} genesis base
+    // Validate the streaming Inbox consumption against the parent checkpoint's consumed position.
+    // The parent is checkpointNumber - 1, always available: checkpoint 0 carries the {0,0,0} genesis base
     // case written at initialization. rollupStore.tips is not committed until below, so the parent read still sees
     // the parent as the pending tip. The returned cumulative total is stored in this checkpoint's record so its
     // child validates against it and, since temp-log records rewind with the pending chain on a prune, the record

l1-contracts/src/core/libraries/rollup/STFLib.sol

@@ -134,7 +134,7 @@ library STFLib {
           excessMana: 0, manaUsed: 0, ethPerFeeAsset: _initialEthPerFeeAsset, congestionCost: 0, proverCost: 0
         }),
         // Genesis Inbox consumption base case, matching the Inbox's genesis bucket-0 sentinel {0, 0, 0}, so
-        // checkpoint 1 validates its consumption against it (AZIP-22 Fast Inbox).
+        // checkpoint 1 validates its consumption against it.
         inboxRollingHash: bytes32(0),
         inboxMsgTotal: 0,
         inboxConsumedBucket: 0
@@ -311,7 +311,7 @@ library STFLib {
   }
 
   /**
-   * @notice Retrieves the cumulative Inbox message count consumed as of a checkpoint (AZIP-22 Fast Inbox)
+   * @notice Retrieves the cumulative Inbox message count consumed as of a checkpoint
    * @dev Gas-efficient accessor reading only the streaming-inbox consumed total. Reverts if the checkpoint is stale.
    * @param _checkpointNumber The checkpoint number to get the consumed total for
    * @return The cumulative Inbox message count consumed as of the checkpoint
@@ -321,7 +321,7 @@ library STFLib {
   }
 
   /**
-   * @notice Retrieves the Inbox rolling hash a checkpoint committed to (AZIP-22 Fast Inbox)
+   * @notice Retrieves the Inbox rolling hash a checkpoint committed to
    * @dev Gas-efficient accessor reading only the streaming-inbox rolling hash. Reverts if the checkpoint is stale.
    * @param _checkpointNumber The checkpoint number to get the rolling hash for
    * @return The consensus Inbox rolling hash recorded for the checkpoint

l1-contracts/src/core/messagebridge/Inbox.sol

@@ -135,7 +135,7 @@ contract Inbox is IInbox {
       currentTree = trees[inProgress];
     }
 
-    // Compact cumulative message index (AZIP-22 Fast Inbox): the zero-based position of this message in the Inbox's
+    // Compact cumulative message index: the zero-based position of this message in the Inbox's
     // insertion order, equal to the number of messages inserted before it. It is embedded in the leaf preimage and
     // matches the streaming L1-to-L2 tree's leaf count, so consumers do not need per-checkpoint tree geometry.
     uint256 index = totalMessagesInserted;

l1-contracts/test/Inbox.t.sol

@@ -93,7 +93,7 @@ contract InboxTest is Test {
 
   function testFuzzInsert(DataStructures.L1ToL2Msg memory _message) public checkInvariant {
     Inbox.InboxState memory stateBefore = inbox.getState();
-    // Compact cumulative index (AZIP-22 Fast Inbox): the message's index is the count inserted before it.
+    // Compact cumulative index: the message's index is the count inserted before it.
     uint256 globalLeafIndex = stateBefore.totalMessagesInserted;
     DataStructures.L1ToL2Msg memory message = _boundMessage(_message, globalLeafIndex);
 

l1-contracts/test/InboxBuckets.t.sol

@@ -132,7 +132,7 @@ contract InboxBucketsTest is Test {
       recipient: recipient,
       content: content,
       secretHash: secretHash,
-      // Compact cumulative index (AZIP-22 Fast Inbox): the first message against a fresh Inbox has index 0.
+      // Compact cumulative index: the first message against a fresh Inbox has index 0.
       index: inbox.getState().totalMessagesInserted
     });
     bytes32 leaf = Hash.sha256ToField(message);

l1-contracts/test/Rollup.t.sol

@@ -470,7 +470,7 @@ contract RollupTest is RollupBase {
       interim.feeAmount = interim.manaUsed * interim.minFee + interim.portalBalance;
       header.accumulatedFees = interim.feeAmount;
 
-      // Streaming Inbox (AZIP-22 Fast Inbox): nothing is seeded here, so reference the genesis bucket (hash 0).
+      // Streaming Inbox: nothing is seeded here, so reference the genesis bucket (hash 0).
       header.inboxRollingHash = bytes32(0);
 
       // Assert that balance have NOT been increased by proposing the checkpoint
@@ -937,7 +937,7 @@ contract RollupTest is RollupBase {
   }
 
   // The epoch-proof anchoring pins the rolling-hash chain start to the record written at propose for checkpoint
-  // start - 1 (AZIP-22 Fast Inbox), mirroring previousArchive. A wrong previousInboxRollingHash must be rejected.
+  // start - 1, mirroring previousArchive. A wrong previousInboxRollingHash must be rejected.
   function testGetEpochProofPublicInputsRejectsWrongPreviousInboxRollingHash() public setUpFor("empty_checkpoint_1") {
     _proposeCheckpoint("empty_checkpoint_1", 1);
 
@@ -965,7 +965,7 @@ contract RollupTest is RollupBase {
   }
 
   // The end of the rolling-hash chain segment is pinned to the hash recorded at propose for the epoch's last
-  // checkpoint (AZIP-22 Fast Inbox), mirroring endArchive. A wrong endInboxRollingHash must be rejected here rather
+  // checkpoint, mirroring endArchive. A wrong endInboxRollingHash must be rejected here rather
   // than surfacing as a generic proof-verification failure.
   function testGetEpochProofPublicInputsRejectsWrongEndInboxRollingHash() public setUpFor("empty_checkpoint_1") {
     _proposeCheckpoint("empty_checkpoint_1", 1);

l1-contracts/test/RollupFieldRange.t.sol

@@ -175,7 +175,7 @@ contract RollupFieldRangeTest is RollupBase {
 
     vm.blobhashes(this.getBlobHashes(full.checkpoint.blobCommitments));
 
-    // Streaming Inbox (AZIP-22 Fast Inbox): nothing is seeded here, so reference the genesis bucket (hash 0).
+    // Streaming Inbox: nothing is seeded here, so reference the genesis bucket (hash 0).
     header.inboxRollingHash = bytes32(0);
 
     ProposeArgs memory args =

l1-contracts/test/base/RollupBase.sol

@@ -78,8 +78,8 @@ contract RollupBase is DecoderBase {
       previousArchive: parentCheckpointLog.archive,
       endArchive: endFull.checkpoint.archive,
       outHash: endFull.checkpoint.header.outHash,
-      // Anchor the rolling-hash chain start to the record written at propose for checkpoint start - 1 (AZIP-22 Fast
-      // Inbox). The end value is unchecked on L1 but supplied for completeness.
+      // Anchor the rolling-hash chain start to the record written at propose for checkpoint start - 1.
+      // The end value is unchecked on L1 but supplied for completeness.
       previousInboxRollingHash: proposedHeaders[startCheckpointNumber - 1].inboxRollingHash,
       endInboxRollingHash: proposedHeaders[endCheckpointNumber].inboxRollingHash,
       proverId: _prover
@@ -172,7 +172,7 @@ contract RollupBase is DecoderBase {
     // Legacy frontier root for the header's inHash field. Unchecked at propose post-flip, but kept because the
     // fixtures were generated with it as part of the header hash.
     full.checkpoint.header.inHash = rollup.getInbox().getRoot(full.checkpoint.checkpointNumber);
-    // Streaming Inbox (AZIP-22 Fast Inbox): reference the newest bucket so the checkpoint consumes all messages
+    // Streaming Inbox: reference the newest bucket so the checkpoint consumes all messages
     // seeded above and the mandatory-consumption assert is trivially satisfied (a wrong ref could only revert).
     uint256 bucketHint = rollup.getInbox().getCurrentBucketSeq();
     full.checkpoint.header.inboxRollingHash = rollup.getInbox().getBucket(bucketHint).rollingHash;