feat: decouple cosmos-db (backport #874) (#887)

Co-authored-by: cool-developer <[email protected]>
Co-authored-by: Cool Developer <[email protected]>

.golangci.yml

@@ -7,7 +7,6 @@ linters:
   disable-all: true
   enable:
     - bodyclose
-    - depguard
     - dogsled
     - errcheck
     - exportloopref

Makefile

@@ -36,7 +36,7 @@ format:
 
 # look into .golangci.yml for enabling / disabling linters
 golangci_lint_cmd=golangci-lint
-golangci_version=v1.51.2
+golangci_version=v1.55.2
 
 lint:
 	@echo "--> Running linter"

basic_test.go

@@ -8,10 +8,11 @@ import (
 	"testing"
 
 	"cosmossdk.io/log"
-	db "github.com/cosmos/cosmos-db"
-	iavlrand "github.com/cosmos/iavl/internal/rand"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	dbm "github.com/cosmos/iavl/db"
+	iavlrand "github.com/cosmos/iavl/internal/rand"
 )
 
 func TestBasic(t *testing.T) {
@@ -236,7 +237,7 @@ func TestUnit(t *testing.T) {
 	expectRemove(t11, 3, "((1 2) (4 5))")
 }
 
-func TestRemove(t *testing.T) {
+func TestRemove(_ *testing.T) {
 	keyLen, dataLen := 16, 40
 
 	size := 10000
@@ -432,7 +433,7 @@ func TestIterateRange(t *testing.T) {
 }
 
 func TestPersistence(t *testing.T) {
-	db := db.NewMemDB()
+	db := dbm.NewMemDB()
 
 	// Create some random key value pairs
 	records := make(map[string]string)
@@ -495,7 +496,7 @@ func TestProof(t *testing.T) {
 }
 
 func TestTreeProof(t *testing.T) {
-	db := db.NewMemDB()
+	db := dbm.NewMemDB()
 	tree := NewMutableTree(db, 100, false, log.NewNopLogger())
 	hash := tree.Hash()
 	assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", hex.EncodeToString(hash))

batch.go

@@ -3,7 +3,7 @@ package iavl
 import (
 	"sync"
 
-	dbm "github.com/cosmos/cosmos-db"
+	dbm "github.com/cosmos/iavl/db"
 )
 
 // BatchWithFlusher is a wrapper

batch_test.go

@@ -7,8 +7,9 @@ import (
 	"path/filepath"
 	"testing"
 
-	dbm "github.com/cosmos/cosmos-db"
 	"github.com/stretchr/testify/require"
+
+	dbm "github.com/cosmos/iavl/db"
 )
 
 func cleanupDBDir(dir, name string) {
@@ -27,16 +28,16 @@ func makeKey(n uint16) []byte {
 }
 
 func TestBatchWithFlusher(t *testing.T) {
-	testedBackends := []dbm.BackendType{
-		dbm.GoLevelDBBackend,
+	testedBackends := []string{
+		"goleveldb",
 	}
 
 	for _, backend := range testedBackends {
 		testBatchWithFlusher(t, backend)
 	}
 }
 
-func testBatchWithFlusher(t *testing.T, backend dbm.BackendType) {
+func testBatchWithFlusher(t *testing.T, backend string) {
 	name := fmt.Sprintf("test_%x", randstr(12))
 	dir := t.TempDir()
 	db, err := dbm.NewDB(name, backend, dir)

benchmarks/bench_test.go

@@ -12,8 +12,8 @@ import (
 	"cosmossdk.io/log"
 	"github.com/stretchr/testify/require"
 
-	db "github.com/cosmos/cosmos-db"
 	"github.com/cosmos/iavl"
+	dbm "github.com/cosmos/iavl/db"
 )
 
 const historySize = 20
@@ -26,7 +26,7 @@ func randBytes(length int) []byte {
 	return key
 }
 
-func prepareTree(b *testing.B, db db.DB, size, keyLen, dataLen int) (*iavl.MutableTree, [][]byte) {
+func prepareTree(b *testing.B, db dbm.DB, size, keyLen, dataLen int) (*iavl.MutableTree, [][]byte) {
 	t := iavl.NewMutableTree(db, size, false, log.NewNopLogger())
 	keys := make([][]byte, size)
 
@@ -147,7 +147,7 @@ func runIterationSlow(b *testing.B, t *iavl.MutableTree, expectedSize int) {
 	}
 }
 
-func iterate(b *testing.B, itr db.Iterator, expectedSize int) {
+func iterate(b *testing.B, itr dbm.Iterator, expectedSize int) {
 	b.StartTimer()
 	keyValuePairs := make([][][]byte, 0, expectedSize)
 	for i := 0; i < expectedSize && itr.Valid(); i++ {
@@ -259,7 +259,7 @@ func BenchmarkRandomBytes(b *testing.B) {
 }
 
 type benchmark struct {
-	dbType              db.BackendType
+	dbType              string
 	initSize, blockSize int
 	keyLen, dataLen     int
 }
@@ -330,7 +330,7 @@ func runBenchmarks(b *testing.B, benchmarks []benchmark) {
 
 		// prepare a dir for the db and cleanup afterwards
 		dirName := fmt.Sprintf("./%s-db", prefix)
-		if bb.dbType == db.RocksDBBackend {
+		if bb.dbType == "rocksdb" {
 			_ = os.Mkdir(dirName, 0o755)
 		}
 
@@ -343,11 +343,11 @@ func runBenchmarks(b *testing.B, benchmarks []benchmark) {
 
 		// note that "" leads to nil backing db!
 		var (
-			d   db.DB
+			d   dbm.DB
 			err error
 		)
 		if bb.dbType != "nodb" {
-			d, err = db.NewDB("test", bb.dbType, dirName)
+			d, err = dbm.NewDB("test", bb.dbType, dirName)
 
 			if err != nil {
 				if strings.Contains(err.Error(), "unknown db_backend") {
@@ -376,7 +376,7 @@ func memUseMB() float64 {
 	return mb
 }
 
-func runSuite(b *testing.B, d db.DB, initSize, blockSize, keyLen, dataLen int) {
+func runSuite(b *testing.B, d dbm.DB, initSize, blockSize, keyLen, dataLen int) {
 	// measure mem usage
 	runtime.GC()
 	init := memUseMB()

benchmarks/cosmos-exim/main.go

@@ -7,7 +7,9 @@ import (
 
 	"cosmossdk.io/log"
 	tmdb "github.com/cosmos/cosmos-db"
+
 	"github.com/cosmos/iavl"
+	idbm "github.com/cosmos/iavl/db"
 )
 
 // stores is the list of stores in the CosmosHub database
@@ -91,7 +93,7 @@ func runExport(dbPath string) (int64, map[string][]*iavl.ExportNode, error) {
 	if err != nil {
 		return 0, nil, err
 	}
-	tree := iavl.NewMutableTree(tmdb.NewPrefixDB(ldb, []byte("s/k:main/")), 0, false, log.NewNopLogger())
+	tree := iavl.NewMutableTree(idbm.NewWrapper(tmdb.NewPrefixDB(ldb, []byte("s/k:main/"))), 0, false, log.NewNopLogger())
 	version, err := tree.LoadVersion(0)
 	if err != nil {
 		return 0, nil, err
@@ -103,7 +105,7 @@ func runExport(dbPath string) (int64, map[string][]*iavl.ExportNode, error) {
 	totalStats := Stats{}
 	for _, name := range stores {
 		db := tmdb.NewPrefixDB(ldb, []byte("s/k:"+name+"/"))
-		tree := iavl.NewMutableTree(db, 0, false, log.NewNopLogger())
+		tree := iavl.NewMutableTree(idbm.NewWrapper(db), 0, false, log.NewNopLogger())
 
 		stats := Stats{}
 		export := make([]*iavl.ExportNode, 0, 100000)
@@ -168,7 +170,7 @@ func runImport(version int64, exports map[string][]*iavl.ExportNode) error {
 		if err != nil {
 			return err
 		}
-		newTree := iavl.NewMutableTree(newDB, 0, false, log.NewNopLogger())
+		newTree := iavl.NewMutableTree(idbm.NewWrapper(newDB), 0, false, log.NewNopLogger())
 		importer, err := newTree.Import(version)
 		if err != nil {
 			return err

cmd/iaviewer/main.go

@@ -14,6 +14,7 @@ import (
 	dbm "github.com/cosmos/cosmos-db"
 
 	"github.com/cosmos/iavl"
+	idbm "github.com/cosmos/iavl/db"
 )
 
 // TODO: make this configurable?
@@ -122,7 +123,7 @@ func ReadTree(dir string, version int, prefix []byte) (*iavl.MutableTree, error)
 		db = dbm.NewPrefixDB(db, prefix)
 	}
 
-	tree := iavl.NewMutableTree(db, DefaultCacheSize, false, log.NewLogger(os.Stdout))
+	tree := iavl.NewMutableTree(idbm.NewWrapper(db), DefaultCacheSize, false, log.NewLogger(os.Stdout))
 	ver, err := tree.LoadVersion(int64(version))
 	fmt.Printf("Got version: %d\n", ver)
 	return tree, err