Add QueueStorage documentation

OffchainLabs · Jul 19, 2023 · 14cb1da · 14cb1da
1 parent 91a8843
commit 14cb1da
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/arbnode/dataposter/data_poster.go b/arbnode/dataposter/data_poster.go
@@ -496,6 +496,11 @@ type queuedTransaction[Meta any] struct {
 	NextReplacement time.Time
 }
 
+// Implements queue-alike storage that can
+// - Insert item at specified index
+// - Update item with the condition that existing value equals assumed value
+// - Delete all the items up to specified index (prune)
+// - Calculate length
 // Note: one of the implementation of this interface (Redis storage) does not
 // support duplicate values.
 type QueueStorage[Item any] interface {