From 25c06be481996fb43670381acf66c53c118508ff Mon Sep 17 00:00:00 2001
From: Domino Valdano <2644901+reductionista@users.noreply.github.com>
Date: Thu, 13 Feb 2025 21:48:33 -0800
Subject: [PATCH] Add docstring to lp.Replay()

---
 pkg/solana/logpoller/log_poller.go | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/pkg/solana/logpoller/log_poller.go b/pkg/solana/logpoller/log_poller.go
index d0c67d62e..73a59882e 100644
--- a/pkg/solana/logpoller/log_poller.go
+++ b/pkg/solana/logpoller/log_poller.go
@@ -213,6 +213,12 @@ func (lp *Service) UnregisterFilter(ctx context.Context, name string) error {
 	return lp.filters.UnregisterFilter(ctx, name)
 }
 
+// Replay submits a new replay request. If there was already a new replay request
+// submitted since the last replay completed, it will be updated to the earlier of the
+// two requested fromBlock's. The expectation is that, on the next timer tick of the
+// LogPoller run loop it will backfill all filters starting from fromBlock. If there
+// are new filters in the backfill queue, with an earlier StartingBlock, then they
+// will get backfilled from there instead.
 func (lp *Service) Replay(ctx context.Context, fromBlock int64) error {
 	ctx, cancel := lp.eng.Ctx(ctx)
 	defer cancel()