readme for default gud

block/base/config.go

@@ -9,7 +9,7 @@ import (
 	"github.com/skip-mev/pob/block"
 )
 
-// LaneConfig defines the basic functionality needed for a lane.
+// LaneConfig defines the basic configurations needed for a lane.
 type LaneConfig struct {
 	Logger      log.Logger
 	TxEncoder   sdk.TxEncoder

block/base/mempool.go

@@ -11,7 +11,7 @@ import (
 )
 
 type (
-	// ConstructorMempool defines a mempool that orders transactions based on the
+	// Mempool defines a mempool that orders transactions based on the
 	// txPriority. The mempool is a wrapper on top of the SDK's Priority Nonce mempool.
 	// It include's additional helper functions that allow users to determine if a
 	// transaction is already in the mempool and to compare the priority of two
@@ -79,7 +79,7 @@ func DefaultTxPriority() TxPriority[string] {
 	}
 }
 
-// NewMempool returns a new ConstructorMempool.
+// NewMempool returns a new Mempool.
 func NewMempool[C comparable](txPriority TxPriority[C], txEncoder sdk.TxEncoder, maxTx int) *Mempool[C] {
 	return &Mempool[C]{
 		index: NewPriorityMempool(

block/mempool.go

@@ -14,7 +14,7 @@ import (
 var _ Mempool = (*LanedMempool)(nil)
 
 type (
-	// LanedMempool defines the Block SDK mempool interface.
+	// Mempool defines the Block SDK mempool interface.
 	Mempool interface {
 		sdkmempool.Mempool
 
@@ -40,7 +40,7 @@ type (
 	}
 )
 
-// NewLanedMempool returns a new Block SDK mempool. The laned mempool is
+// NewLanedMempool returns a new Block SDK LanedMempool. The laned mempool is
 // comprised of a registry of lanes. Each lane is responsible for selecting
 // transactions according to its own selection logic. The lanes are ordered
 // according to their priority. The first lane in the registry has the highest