chore: Db linting

.golangci.yml

@@ -22,7 +22,6 @@ linters:
     - misspell
     - nakedret
     - nolintlint
-    - prealloc
     - revive
     - staticcheck
     - structcheck

CHANGELOG.md

@@ -49,10 +49,12 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### API Breaking Changes
 
 * (x/staking) [#12102](https://github.com/cosmos/cosmos-sdk/pull/12102) Staking keeper now is passed by reference instead of copy. Keeper's SetHooks no longer returns keeper. It updates the keeper in place instead.
+* (linting) [#12141](https://github.com/cosmos/cosmos-sdk/pull/12141) Fix usability related linting for database.  This means removing the infix Prefix from `prefix.NewPrefixWriter` and such so that it is `prefix.NewWriter` and making `db.DBConnection` and such into `db.Connection`
+
 
 ### Bug Fixes
 
-* (linting) [#12135](https://github.com/cosmos/cosmos-sdk/pull/12135/) Fix variable naming issues per enabled linters.  Run gofumpt to ensure easy reviews of ongoing linting work. 
+* (linting) [#12135](https://github.com/cosmos/cosmos-sdk/pull/12135) Fix variable naming issues per enabled linters.  Run gofumpt to ensure easy reviews of ongoing linting work. 
 * (linting) [#12132](https://github.com/cosmos/cosmos-sdk/pull/12132) Change sdk.Int to math.Int, run `gofumpt -w -l .`, and `golangci-lint run ./... --fix`
 * (cli) [#12127](https://github.com/cosmos/cosmos-sdk/pull/12127) Fix the CLI not always taking into account `--fee-payer` and `--fee-granter` flags.
 * (migrations) [#12028](https://github.com/cosmos/cosmos-sdk/pull/12028) Fix v0.45->v0.46 in-place store migrations.

client/debug/main.go

@@ -17,10 +17,13 @@ import (
 	"github.com/cosmos/cosmos-sdk/types/errors"
 	"github.com/cosmos/cosmos-sdk/version"
 
-	legacybech32 "github.com/cosmos/cosmos-sdk/types/bech32/legacybech32"
+	legacybech32 "github.com/cosmos/cosmos-sdk/types/bech32/legacybech32" //nolint:staticcheck // we do old keys, they're keys after all.
 )
 
-var flagPubkeyType = "type"
+var (
+	flagPubkeyType = "type"
+	ed             = "ed25519"
+)
 
 // Cmd creates a main CLI command
 func Cmd() *cobra.Command {
@@ -69,7 +72,7 @@ $ %s debug pubkey '{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AurroA7jvfP
 }
 
 func bytesToPubkey(bz []byte, keytype string) (cryptotypes.PubKey, bool) {
-	if keytype == "ed25519" {
+	if keytype == ed {
 		if len(bz) == ed25519.PubKeySize {
 			return &ed25519.PubKey{Key: bz}, true
 		}
@@ -102,17 +105,17 @@ func getPubKeyFromRawString(pkstr string, keytype string) (cryptotypes.PubKey, e
 		}
 	}
 
-	pk, err := legacybech32.UnmarshalPubKey(legacybech32.AccPK, pkstr)
+	pk, err := legacybech32.UnmarshalPubKey(legacybech32.AccPK, pkstr) //nolint:staticcheck // we do old keys, they're keys after all.
 	if err == nil {
 		return pk, nil
 	}
 
-	pk, err = legacybech32.UnmarshalPubKey(legacybech32.ValPK, pkstr)
+	pk, err = legacybech32.UnmarshalPubKey(legacybech32.ValPK, pkstr) //nolint:staticcheck // we do old keys, they're keys after all.
 	if err == nil {
 		return pk, nil
 	}
 
-	pk, err = legacybech32.UnmarshalPubKey(legacybech32.ConsPK, pkstr)
+	pk, err = legacybech32.UnmarshalPubKey(legacybech32.ConsPK, pkstr) //nolint:staticcheck // we do old keys, they're keys after all.
 	if err == nil {
 		return pk, nil
 	}
@@ -138,7 +141,7 @@ $ %s debug pubkey-raw cosmos1e0jnq2sun3dzjh8p2xq95kk0expwmd7shwjpfg
 				return err
 			}
 			pubkeyType = strings.ToLower(pubkeyType)
-			if pubkeyType != "secp256k1" && pubkeyType != "ed25519" {
+			if pubkeyType != "secp256k1" && pubkeyType != ed {
 				return errors.Wrapf(errors.ErrInvalidType, "invalid pubkey type, expected oneof ed25519 or secp256k1")
 			}
 
@@ -149,8 +152,8 @@ $ %s debug pubkey-raw cosmos1e0jnq2sun3dzjh8p2xq95kk0expwmd7shwjpfg
 
 			var consensusPub string
 			edPK, ok := pk.(*ed25519.PubKey)
-			if ok && pubkeyType == "ed25519" {
-				consensusPub, err = legacybech32.MarshalPubKey(legacybech32.ConsPK, edPK)
+			if ok && pubkeyType == ed {
+				consensusPub, err = legacybech32.MarshalPubKey(legacybech32.ConsPK, edPK) //nolint:staticcheck // we do old keys, they're keys after all.
 				if err != nil {
 					return err
 				}
@@ -163,11 +166,11 @@ $ %s debug pubkey-raw cosmos1e0jnq2sun3dzjh8p2xq95kk0expwmd7shwjpfg
 			if err != nil {
 				return err
 			}
-			accPub, err := legacybech32.MarshalPubKey(legacybech32.AccPK, pk)
+			accPub, err := legacybech32.MarshalPubKey(legacybech32.AccPK, pk) //nolint:staticcheck // we do old keys, they're keys after all.
 			if err != nil {
 				return err
 			}
-			valPub, err := legacybech32.MarshalPubKey(legacybech32.ValPK, pk)
+			valPub, err := legacybech32.MarshalPubKey(legacybech32.ValPK, pk) //nolint:staticcheck // we do old keys, they're keys after all.
 			if err != nil {
 				return err
 			}
@@ -182,7 +185,7 @@ $ %s debug pubkey-raw cosmos1e0jnq2sun3dzjh8p2xq95kk0expwmd7shwjpfg
 			return nil
 		},
 	}
-	cmd.Flags().StringP(flagPubkeyType, "t", "ed25519", "Pubkey type to decode (oneof secp256k1, ed25519)")
+	cmd.Flags().StringP(flagPubkeyType, "t", ed, "Pubkey type to decode (oneof secp256k1, ed25519)")
 	return cmd
 }
 

codec/proto_codec.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"strings"
 
-	legacyproto "github.com/golang/protobuf/proto"
+	legacyproto "github.com/golang/protobuf/proto" //nolint:staticcheck // we're aware this is deprecated and using it anyhow.
 	"google.golang.org/grpc/encoding"
 	"google.golang.org/protobuf/proto"
 

crypto/keys/secp256k1/internal/secp256k1/curve.go

@@ -30,6 +30,7 @@
 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+//nolint // this file shouldn't be linted because we want to use it in its original and unmodified form.
 package secp256k1
 
 import (

crypto/keys/secp256k1/internal/secp256k1/scalar_mult_cgo.go

@@ -21,7 +21,7 @@ extern int secp256k1_ext_scalar_mul(const secp256k1_context* ctx, const unsigned
 */
 import "C"
 
-func (BitCurve *BitCurve) ScalarMult(Bx, By *big.Int, scalar []byte) (*big.Int, *big.Int) {
+func (bitCurve *BitCurve) ScalarMult(bx, by *big.Int, scalar []byte) (*big.Int, *big.Int) {
 	// Ensure scalar is exactly 32 bytes. We pad always, even if
 	// scalar is 32 bytes long, to avoid a timing side channel.
 	if len(scalar) > 32 {
@@ -34,8 +34,8 @@ func (BitCurve *BitCurve) ScalarMult(Bx, By *big.Int, scalar []byte) (*big.Int,
 
 	// Do the multiplication in C, updating point.
 	point := make([]byte, 64)
-	readBits(Bx, point[:32])
-	readBits(By, point[32:])
+	readBits(bx, point[:32])
+	readBits(by, point[32:])
 
 	pointPtr := (*C.uchar)(unsafe.Pointer(&point[0]))
 	scalarPtr := (*C.uchar)(unsafe.Pointer(&scalar[0]))

db/README.md

@@ -6,7 +6,7 @@ Databases supporting mappings of arbitrary byte sequences.
 
 The database interface types consist of objects to encapsulate the singular connection to the DB, transactions being made to it, historical version state, and iteration.
 
-### `DBConnection`
+### `Connection`
 
 This interface represents a connection to a versioned key-value database. All versioning operations are performed using methods on this type.
 

db/adapter.go

@@ -1,11 +1,11 @@
 package db
 
-type readerRWAdapter struct{ DBReader }
+type readerRWAdapter struct{ Reader }
 
 // ReaderAsReadWriter returns a ReadWriter that forwards to a reader and errors if writes are
 // attempted. Can be used to pass a Reader when a ReadWriter is expected
 // but no writes will actually occur.
-func ReaderAsReadWriter(r DBReader) DBReadWriter {
+func ReaderAsReadWriter(r Reader) ReadWriter {
 	return readerRWAdapter{r}
 }
 

db/badgerdb/db.go

@@ -22,10 +22,10 @@ import (
 var versionsFilename = "versions.csv"
 
 var (
-	_ db.DBConnection = (*BadgerDB)(nil)
-	_ db.DBReader     = (*badgerTxn)(nil)
-	_ db.DBWriter     = (*badgerWriter)(nil)
-	_ db.DBReadWriter = (*badgerWriter)(nil)
+	_ db.Connection = (*BadgerDB)(nil)
+	_ db.Reader     = (*badgerTxn)(nil)
+	_ db.Writer     = (*badgerWriter)(nil)
+	_ db.ReadWriter = (*badgerWriter)(nil)
 )
 
 // BadgerDB is a connection to a BadgerDB key-value database.
@@ -164,14 +164,14 @@ func writeVersionsFile(vm *versionManager, path string) error {
 	return w.WriteAll(rows)
 }
 
-func (b *BadgerDB) Reader() db.DBReader {
+func (b *BadgerDB) Reader() db.Reader {
 	b.mtx.RLock()
 	ts := b.vmgr.lastTs
 	b.mtx.RUnlock()
 	return &badgerTxn{txn: b.db.NewTransactionAt(ts, false), db: b}
 }
 
-func (b *BadgerDB) ReaderAt(version uint64) (db.DBReader, error) {
+func (b *BadgerDB) ReaderAt(version uint64) (db.Reader, error) {
 	b.mtx.RLock()
 	defer b.mtx.RUnlock()
 	ts, has := b.vmgr.versionTs(version)
@@ -181,15 +181,15 @@ func (b *BadgerDB) ReaderAt(version uint64) (db.DBReader, error) {
 	return &badgerTxn{txn: b.db.NewTransactionAt(ts, false), db: b}, nil
 }
 
-func (b *BadgerDB) ReadWriter() db.DBReadWriter {
+func (b *BadgerDB) ReadWriter() db.ReadWriter {
 	atomic.AddInt32(&b.openWriters, 1)
 	b.mtx.RLock()
 	ts := b.vmgr.lastTs
 	b.mtx.RUnlock()
 	return &badgerWriter{badgerTxn{txn: b.db.NewTransactionAt(ts, true), db: b}, false}
 }
 
-func (b *BadgerDB) Writer() db.DBWriter {
+func (b *BadgerDB) Writer() db.Writer {
 	// Badger has a WriteBatch, but it doesn't support conflict detection
 	return b.ReadWriter()
 }
@@ -201,7 +201,7 @@ func (b *BadgerDB) Close() error {
 	return b.db.Close()
 }
 
-// Versions implements DBConnection.
+// Versions implements Connection.
 // Returns a VersionSet that is valid until the next call to SaveVersion or DeleteVersion.
 func (b *BadgerDB) Versions() (db.VersionSet, error) {
 	b.mtx.RLock()
@@ -219,12 +219,12 @@ func (b *BadgerDB) save(target uint64) (uint64, error) {
 	return b.vmgr.Save(target)
 }
 
-// SaveNextVersion implements DBConnection.
+// SaveNextVersion implements Connection.
 func (b *BadgerDB) SaveNextVersion() (uint64, error) {
 	return b.save(0)
 }
 
-// SaveVersion implements DBConnection.
+// SaveVersion implements Connection.
 func (b *BadgerDB) SaveVersion(target uint64) error {
 	if target == 0 {
 		return db.ErrInvalidVersion

db/badgerdb/db_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/db/dbtest"
 )
 
-func load(t *testing.T, dir string) db.DBConnection {
+func load(t *testing.T, dir string) db.Connection {
 	d, err := NewDB(dir)
 	require.NoError(t, err)
 	return d

db/dbtest/benchmark.go

@@ -21,7 +21,7 @@ func BytesToInt64(buf []byte) int64 {
 	return int64(binary.BigEndian.Uint64(buf))
 }
 
-func BenchmarkRangeScans(b *testing.B, db dbm.DBReadWriter, dbSize int64) {
+func BenchmarkRangeScans(b *testing.B, db dbm.ReadWriter, dbSize int64) {
 	b.StopTimer()
 
 	rangeSize := int64(10000)
@@ -40,7 +40,7 @@ func BenchmarkRangeScans(b *testing.B, db dbm.DBReadWriter, dbSize int64) {
 	b.StartTimer()
 
 	for i := 0; i < b.N; i++ {
-		start := rand.Int63n(dbSize - rangeSize) // nolint: gosec
+		start := rand.Int63n(dbSize - rangeSize)
 		end := start + rangeSize
 		iter, err := db.Iterator(Int64ToBytes(start), Int64ToBytes(end))
 		require.NoError(b, err)
@@ -53,7 +53,7 @@ func BenchmarkRangeScans(b *testing.B, db dbm.DBReadWriter, dbSize int64) {
 	}
 }
 
-func BenchmarkRandomReadsWrites(b *testing.B, db dbm.DBReadWriter) {
+func BenchmarkRandomReadsWrites(b *testing.B, db dbm.ReadWriter) {
 	b.StopTimer()
 
 	// create dummy data
@@ -67,7 +67,7 @@ func BenchmarkRandomReadsWrites(b *testing.B, db dbm.DBReadWriter) {
 
 	for i := 0; i < b.N; i++ {
 		{
-			idx := rand.Int63n(numItems) // nolint: gosec
+			idx := rand.Int63n(numItems)
 			internal[idx]++
 			val := internal[idx]
 			idxBytes := Int64ToBytes(idx)
@@ -80,7 +80,7 @@ func BenchmarkRandomReadsWrites(b *testing.B, db dbm.DBReadWriter) {
 		}
 
 		{
-			idx := rand.Int63n(numItems) // nolint: gosec
+			idx := rand.Int63n(numItems)
 			valExp := internal[idx]
 			idxBytes := Int64ToBytes(idx)
 			valBytes, err := db.Get(idxBytes)

db/dbtest/testcases.go

@@ -11,7 +11,7 @@ import (
 	dbm "github.com/cosmos/cosmos-sdk/db"
 )
 
-type Loader func(*testing.T, string) dbm.DBConnection
+type Loader func(*testing.T, string) dbm.Connection
 
 func ikey(i int) []byte { return []byte(fmt.Sprintf("key-%03d", i)) }
 func ival(i int) []byte { return []byte(fmt.Sprintf("val-%03d", i)) }
@@ -20,10 +20,9 @@ func DoTestGetSetHasDelete(t *testing.T, load Loader) {
 	t.Helper()
 	db := load(t, t.TempDir())
 
-	var txn dbm.DBReadWriter
-	var view dbm.DBReader
+	var txn dbm.ReadWriter
+	view := db.Reader()
 
-	view = db.Reader()
 	require.NotNil(t, view)
 
 	// A nonexistent key should return nil.
@@ -261,11 +260,11 @@ func DoTestVersioning(t *testing.T, load Loader) {
 	require.False(t, has)
 	require.NoError(t, view.Discard())
 
-	view, err = db.ReaderAt(versions.Last() + 1)
+	view, err = db.ReaderAt(versions.Last() + 1) //nolint:staticcheck // we nolint here because we are checking for the absence of an error.
 	require.Equal(t, dbm.ErrVersionDoesNotExist, err, "should fail to read a nonexistent version")
 
 	require.NoError(t, db.DeleteVersion(v2), "should delete version v2")
-	view, err = db.ReaderAt(v2)
+	view, err = db.ReaderAt(v2) //nolint:staticcheck // we nolint here because we are checking for the absence of an error.
 	require.Equal(t, dbm.ErrVersionDoesNotExist, err)
 
 	// Ensure latest version is accurate
@@ -298,9 +297,9 @@ func DoTestTransactions(t *testing.T, load Loader, multipleWriters bool) {
 	t.Helper()
 	db := load(t, t.TempDir())
 	// Both methods should work in a DBWriter context
-	writerFuncs := []func() dbm.DBWriter{
+	writerFuncs := []func() dbm.Writer{
 		db.Writer,
-		func() dbm.DBWriter { return db.ReadWriter() },
+		func() dbm.Writer { return db.ReadWriter() },
 	}
 
 	for _, getWriter := range writerFuncs {
@@ -397,7 +396,7 @@ func DoTestRevert(t *testing.T, load Loader, reload bool) {
 	t.Helper()
 	dirname := t.TempDir()
 	db := load(t, dirname)
-	var txn dbm.DBWriter
+	var txn dbm.Writer
 
 	initContents := func() {
 		txn = db.Writer()

db/dbtest/util.go

@@ -39,7 +39,7 @@ func AssertKeyPanics(t *testing.T, itr dbm.Iterator) {
 	assert.Panics(t, func() { itr.Key() }, "checkKeyPanics expected panic but didn't")
 }
 
-func AssertValue(t *testing.T, db dbm.DBReader, key, valueWanted []byte) {
+func AssertValue(t *testing.T, db dbm.Reader, key, valueWanted []byte) {
 	t.Helper()
 	valueGot, err := db.Get(key)
 	assert.NoError(t, err)