consolidations: return request type byte at start of output

Author: fjl

src/consolidations/main.eas

@@ -29,6 +29,8 @@
 #define INPUT_SIZE 96    ;; the size of (source ++ target)
 #define RECORD_SIZE 116  ;; the size of (address ++ source ++ target)
 
+#define REQUEST_TYPE 0x02
+
 ;; -----------------------------------------------------------------------------
 ;; PROGRAM START ---------------------------------------------------------------
 ;; -----------------------------------------------------------------------------
@@ -213,7 +215,13 @@ read_requests:
   push MAX_PER_BLOCK    ;; [count, head_idx, tail_idx]
 
 begin_loop:
-  push0                 ;; [i, count, head_idx, tail_idx]
+  ;; Store request type prefix into the output buffer.
+  push1 REQUEST_TYPE    ;; [type, count, head_idx, tail_idx]
+  push 0                ;; [offset, type, count, head_idx, tail_idx]
+  mstore8               ;; [count, head_idx, tail_idx]
+
+  ;; Push initial loop index.
+  push 0                ;; [i, count, head_idx, tail_idx]
 
 accum_loop:
   ;; This loop will read each request and byte bang it into a RECORD_SIZE byte chunk.
@@ -227,7 +235,9 @@ accum_loop:
   ;; Precompute record_offset = i*RECORD_SIZE.
   dup1                  ;; [i, i, count, head_idx, tail_idx]
   push RECORD_SIZE      ;; [size, i, i, count, head_idx, tail_idx]
-  mul                   ;; [record_offset, i, count, head_idx, tail_idx]
+  mul                   ;; [offset, i, count, head_idx, tail_idx]
+  push 1                ;; [1, offset, i, count, head_idx, tail_idx]
+  add                   ;; [record_offset, i, count, head_idx, tail_idx]
 
   ;; Determine the storage slot of the address for this iteration. This value is
   ;; also the base for the other storage slots containing the source and the target
@@ -389,7 +399,9 @@ store_excess:
 
   ;; Return the requests.
   push RECORD_SIZE      ;; [record_size, count]
-  mul                   ;; [size]
+  mul                   ;; [size, count]
+  push 1                ;; [1, size, count]
+  add                   ;; [size+1, count]
   push0                 ;; [0, size]
   return                ;; []
 

test/Consolidation.t.sol.in

@@ -49,11 +49,10 @@ contract ConsolidationTest is Test {
     assertExcess(0);
 
     bytes memory req = getRequests();
-    assertEq(req.length, 116);
-    assertEq(toFixed(req, 20, 52), toFixed(data, 0, 32));
-    assertEq(toFixed(req, 52, 84), toFixed(data, 32, 64));
-    assertEq(toFixed(req, 84, 116), toFixed(data, 64, 96));
-    assertStorage(count_slot, 0, "unexpected request count");
+    assertEq(req.length, 117);
+    assertEq(uint8(req[0]), 0x02);
+    assertEq(slice(req, 21, 117), data, "wrong output request data");
+    assertStorage(count_slot, 0, "unexpected request count in storage");
     assertExcess(0);
   }
 
@@ -192,9 +191,9 @@ contract ConsolidationTest is Test {
   // uint8(index), repeating.
   function checkConsolidations(uint256 startIndex, uint256 count) internal returns (uint256) {
     bytes memory requests = getRequests();
-    assertEq(requests.length, count*116);
+    assertEq(requests.length, count*116 + 1);
     for (uint256 i = 0; i < count; i++) {
-      uint256 offset = i*116;
+      uint256 offset = i*116 + 1;
       assertEq(toFixed(requests, offset, offset+20) >> 96, uint256(startIndex+i), "unexpected request address returned");
       assertEq(toFixed(requests, offset+20, offset+52), toFixed(makeConsolidation(startIndex+i), 0, 32), "unexpected source[0:32] returned");
       assertEq(toFixed(requests, offset+52, offset+84), toFixed(makeConsolidation(startIndex+i), 32, 64), "unexpected source[32:48] ++ target[0:16] returned");