Mark priority mempool as deprecated (#262)

* Add Deprecated comment to package * Add log warning * Update comment in config template * Linting
cometbft · Feb 7, 2023 · 40e68c4 · 40e68c4
1 parent 387d34c
commit 40e68c4
Show file tree

Hide file tree

Showing 11 changed files with 15 additions and 9 deletions.
diff --git a/config/config.go b/config/config.go
@@ -24,7 +24,7 @@ const (
 	// DefaultLogLevel defines a default log level as INFO.
 	DefaultLogLevel = "info"
 
-	// Mempool versions. V1 is prioritized mempool, v0 is regular mempool.
+	// Mempool versions. V1 is prioritized mempool (deprecated), v0 is regular mempool.
 	// Default is v0.
 	MempoolV0 = "v0"
 	MempoolV1 = "v1"
@@ -156,6 +156,9 @@ func (cfg *Config) ValidateBasic() error {
 
 func (cfg *Config) CheckDeprecated() []string {
 	var warnings []string
+	if cfg.Mempool.Version == MempoolV1 {
+		warnings = append(warnings, "prioritized mempool detected. This version of the mempool will be removed in the next major release.")
+	}
 	if cfg.DeprecatedFastSyncConfig != nil {
 		warnings = append(warnings, "[fastsync] table detected. This section has been renamed to [blocksync]. The values in this deprecated section will be disregarded.")
 	}
@@ -704,7 +707,7 @@ func DefaultFuzzConnConfig() *FuzzConnConfig {
 type MempoolConfig struct {
 	// Mempool version to use:
 	//  1) "v0" - (default) FIFO mempool.
-	//  2) "v1" - prioritized mempool.
+	//  2) "v1" - prioritized mempool (deprecated; will be removed in the next release).
 	Version string `mapstructure:"version"`
 	// RootDir is the root directory for all data. This should be configured via
 	// the $CMTHOME env variable or --home cmd flag rather than overriding this

diff --git a/config/toml.go b/config/toml.go
@@ -344,7 +344,7 @@ dial_timeout = "{{ .P2P.DialTimeout }}"
 
 # Mempool version to use:
 #   1) "v0" - (default) FIFO mempool.
-#   2) "v1" - prioritized mempool.
+#   2) "v1" - prioritized mempool (deprecated; will be removed in the next release).
 version = "{{ .Mempool.Version }}"
 
 recheck = {{ .Mempool.Recheck }}

diff --git a/consensus/byzantine_test.go b/consensus/byzantine_test.go
@@ -24,7 +24,7 @@ import (
 
 	cfg "github.com/cometbft/cometbft/config"
 	mempoolv0 "github.com/cometbft/cometbft/mempool/v0"
-	mempoolv1 "github.com/cometbft/cometbft/mempool/v1"
+	mempoolv1 "github.com/cometbft/cometbft/mempool/v1" //nolint:staticcheck // SA1019 Priority mempool deprecated but still supported in this release.
 	"github.com/cometbft/cometbft/p2p"
 	cmtcons "github.com/cometbft/cometbft/proto/tendermint/consensus"
 	cmtproto "github.com/cometbft/cometbft/proto/tendermint/types"

diff --git a/consensus/common_test.go b/consensus/common_test.go
@@ -30,7 +30,7 @@ import (
 	cmtsync "github.com/cometbft/cometbft/libs/sync"
 	mempl "github.com/cometbft/cometbft/mempool"
 	mempoolv0 "github.com/cometbft/cometbft/mempool/v0"
-	mempoolv1 "github.com/cometbft/cometbft/mempool/v1"
+	mempoolv1 "github.com/cometbft/cometbft/mempool/v1" //nolint:staticcheck // SA1019 Priority mempool deprecated but still supported in this release.
 	"github.com/cometbft/cometbft/p2p"
 	"github.com/cometbft/cometbft/privval"
 	cmtproto "github.com/cometbft/cometbft/proto/tendermint/types"

diff --git a/consensus/reactor_test.go b/consensus/reactor_test.go
@@ -30,7 +30,7 @@ import (
 	cmtsync "github.com/cometbft/cometbft/libs/sync"
 	mempl "github.com/cometbft/cometbft/mempool"
 	mempoolv0 "github.com/cometbft/cometbft/mempool/v0"
-	mempoolv1 "github.com/cometbft/cometbft/mempool/v1"
+	mempoolv1 "github.com/cometbft/cometbft/mempool/v1" //nolint:staticcheck // SA1019 Priority mempool deprecated but still supported in this release.
 	"github.com/cometbft/cometbft/p2p"
 	p2pmock "github.com/cometbft/cometbft/p2p/mock"
 	cmtcons "github.com/cometbft/cometbft/proto/tendermint/consensus"

diff --git a/mempool/v1/mempool.go b/mempool/v1/mempool.go
@@ -1,3 +1,4 @@
+// Deprecated: Priority mempool will be removed in the next major release.
 package v1
 
 import (

diff --git a/mempool/v1/reactor.go b/mempool/v1/reactor.go
@@ -1,3 +1,4 @@
+// Deprecated: Priority mempool will be removed in the next major release.
 package v1
 
 import (

diff --git a/mempool/v1/tx.go b/mempool/v1/tx.go
@@ -1,3 +1,4 @@
+// Deprecated: Priority mempool will be removed in the next major release.
 package v1
 
 import (

diff --git a/node/node.go b/node/node.go
@@ -29,7 +29,7 @@ import (
 	"github.com/cometbft/cometbft/light"
 	mempl "github.com/cometbft/cometbft/mempool"
 	mempoolv0 "github.com/cometbft/cometbft/mempool/v0"
-	mempoolv1 "github.com/cometbft/cometbft/mempool/v1"
+	mempoolv1 "github.com/cometbft/cometbft/mempool/v1" //nolint:staticcheck // SA1019 Priority mempool deprecated but still supported in this release.
 	"github.com/cometbft/cometbft/p2p"
 	"github.com/cometbft/cometbft/p2p/pex"
 	"github.com/cometbft/cometbft/privval"

diff --git a/node/node_test.go b/node/node_test.go
@@ -22,7 +22,7 @@ import (
 	cmtrand "github.com/cometbft/cometbft/libs/rand"
 	mempl "github.com/cometbft/cometbft/mempool"
 	mempoolv0 "github.com/cometbft/cometbft/mempool/v0"
-	mempoolv1 "github.com/cometbft/cometbft/mempool/v1"
+	mempoolv1 "github.com/cometbft/cometbft/mempool/v1" //nolint:staticcheck // SA1019 Priority mempool deprecated but still supported in this release.
 	"github.com/cometbft/cometbft/p2p"
 	"github.com/cometbft/cometbft/p2p/conn"
 	p2pmock "github.com/cometbft/cometbft/p2p/mock"

diff --git a/test/fuzz/mempool/v1/checktx.go b/test/fuzz/mempool/v1/checktx.go
@@ -7,7 +7,7 @@ import (
 	mempl "github.com/cometbft/cometbft/mempool"
 	"github.com/cometbft/cometbft/proxy"
 
-	mempoolv1 "github.com/cometbft/cometbft/mempool/v1"
+	mempoolv1 "github.com/cometbft/cometbft/mempool/v1" //nolint:staticcheck // SA1019 Priority mempool deprecated but still supported in this release.
 )
 
 var mempool mempl.Mempool