wip

Author: benesjan

yarn-project/pxe/src/tagging/sync/sync_tagged_logs.ts

@@ -24,11 +24,11 @@ export async function syncTaggedLogs(
   capsuleDataProvider: CapsuleDataProvider,
 ): Promise<void> {
   // # Explanation of how the algorithm works
-  // When we perform the sync we will look at logs that correspond to the tagging index range (LI, ..., FI, ..., NI]
+  // When we perform the sync we will look at logs that correspond to the tagging index range (LI, NI]
   //
   // LI is the highest index that was used in a tx that is included in a block at least 24 hours ago.
-  // FI is the highest index that was used in a tx that has been included in a finalized block.
-  // NI is the index that is WINDOW_LEN ahead of FI.
+  // NI is the index that is WINDOW_LEN ahead of the highest index that was used in a tx that is included in
+  // a finalized block.
   //
   // "(" denotes an open end of the range - the index is not included in the range.
   // "]" denotes a closed end of the range - the index is included in the range.
@@ -49,6 +49,12 @@ export async function syncTaggedLogs(
   //
   // Therefore, once we see that index I has been used in a block that is at least 24 hours old, we can safely stop
   // syncing logs for all indexes <= I and set LI = I.
+  //
+  // ## Explanation of NI
+  //
+  // When a sender chooses a tagging index, they will select an index that is at most WINDOW_LEN greater than
+  // the highest finalized index. If that index was already used, they will throw an error. For this reason we have
+  // don't have to look further than NI.
 }
 
 async function storePendingTaggedLogs(