From d806f4d38ca421554a51dd6f002ddc06d65a26a4 Mon Sep 17 00:00:00 2001
From: Tsahi Zidenberg <tsahi@offchainlabs.com>
Date: Mon, 25 Mar 2024 15:45:04 -0600
Subject: [PATCH] inbox_tracker: add comment

---
 arbnode/inbox_tracker.go | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/arbnode/inbox_tracker.go b/arbnode/inbox_tracker.go
index 4d892ac4cc..b758e95e62 100644
--- 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 {