inbox_tracker: add comment

OffchainLabs · Mar 25, 2024 · d806f4d · d806f4d
1 parent 543be5d
commit d806f4d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/arbnode/inbox_tracker.go b/arbnode/inbox_tracker.go
@@ -228,6 +228,8 @@ func (t *InboxTracker) GetBatchCount() (uint64, error) {
 	return count, nil
 }
 
+// err will return unexpected/internal errors
+// bool will be false if batch not found (meaning, block not yet posted on a batch)
 func (t *InboxTracker) FindInboxBatchContainingMessage(pos arbutil.MessageIndex) (uint64, bool, error) {
 	batchCount, err := t.GetBatchCount()
 	if err != nil {