refactor: audit x/bank package changes in 0.47 release

x/bank/keeper/grpc_query.go

@@ -4,7 +4,7 @@ import (
 	"context"
 
 	"cosmossdk.io/math"
-
+	gogotypes "github.com/cosmos/gogoproto/types"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
@@ -262,12 +262,16 @@ func (k BaseKeeper) SendEnabled(goCtx context.Context, req *types.QuerySendEnabl
 	} else {
 		store := k.getSendEnabledPrefixStore(ctx)
 		var err error
+
 		resp.Pagination, err = query.FilteredPaginate(
 			store,
 			req.Pagination,
 			func(key []byte, value []byte, accumulate bool) (bool, error) {
 				if accumulate {
-					resp.SendEnabled = append(resp.SendEnabled, types.NewSendEnabled(string(key), types.IsTrueB(value)))
+					var enabled gogotypes.BoolValue
+					k.cdc.MustUnmarshal(value, &enabled)
+
+					resp.SendEnabled = append(resp.SendEnabled, types.NewSendEnabled(string(key), enabled.Value))
 				}
 				return true, nil
 			},
@@ -276,5 +280,6 @@ func (k BaseKeeper) SendEnabled(goCtx context.Context, req *types.QuerySendEnabl
 			return nil, status.Error(codes.Internal, err.Error())
 		}
 	}
+
 	return resp, nil
 }

x/bank/keeper/send.go

@@ -3,6 +3,8 @@ package keeper
 import (
 	"fmt"
 
+	gogotypes "github.com/cosmos/gogoproto/types"
+
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/store/prefix"
 	storetypes "github.com/cosmos/cosmos-sdk/store/types"
@@ -100,12 +102,16 @@ func (k BaseSendKeeper) GetParams(ctx sdk.Context) (params types.Params) {
 
 // SetParams sets the total set of bank parameters.
 //
-//nolint:staticcheck // params.SendEnabled is deprecated but it should be here regardless.
+// Note: params.SendEnabled is deprecated but it should be here regardless.
+//
+//nolint:staticcheck
 func (k BaseSendKeeper) SetParams(ctx sdk.Context, params types.Params) error {
-	// normally SendEnabled is deprecated but we still support it for backwards compatibility
-	// using params.Validate() would fail due to the SendEnabled deprecation
+	// Normally SendEnabled is deprecated but we still support it for backwards
+	// compatibility. Using params.Validate() would fail due to the SendEnabled
+	// deprecation.
 	if len(params.SendEnabled) > 0 {
 		k.SetAllSendEnabled(ctx, params.SendEnabled)
+
 		// override params without SendEnabled
 		params = types.NewParams(params.DefaultSendEnabled)
 	}
@@ -115,6 +121,7 @@ func (k BaseSendKeeper) SetParams(ctx sdk.Context, params types.Params) error {
 	if err != nil {
 		return err
 	}
+
 	store.Set(types.ParamsKey, bz)
 	return nil
 }
@@ -139,21 +146,15 @@ func (k BaseSendKeeper) InputOutputCoins(ctx sdk.Context, inputs []types.Input,
 		if err != nil {
 			return err
 		}
-		ctx.EventManager().EmitEvent(
-			sdk.NewEvent(
-				sdk.EventTypeMessage,
-				sdk.NewAttribute(types.AttributeKeySender, in.Address),
-			),
-		)
 	}
 
 	for _, out := range outputs {
 		outAddress, err := sdk.AccAddressFromBech32(out.Address)
 		if err != nil {
 			return err
 		}
-		err = k.addCoins(ctx, outAddress, out.Coins)
-		if err != nil {
+
+		if err := k.addCoins(ctx, outAddress, out.Coins); err != nil {
 			return err
 		}
 
@@ -211,10 +212,6 @@ func (k BaseSendKeeper) SendCoins(ctx sdk.Context, fromAddr sdk.AccAddress, toAd
 			sdk.NewAttribute(types.AttributeKeySender, fromAddrString),
 			sdk.NewAttribute(sdk.AttributeKeyAmount, amt.String()),
 		),
-		sdk.NewEvent(
-			sdk.EventTypeMessage,
-			sdk.NewAttribute(types.AttributeKeySender, fromAddrString),
-		),
 	})
 
 	return nil
@@ -255,15 +252,15 @@ func (k BaseSendKeeper) subUnlockedCoins(ctx sdk.Context, addr sdk.AccAddress, a
 		}
 	}
 
-	// emit coin spent event
 	ctx.EventManager().EmitEvent(
 		types.NewCoinSpentEvent(addr, amt),
 	)
+
 	return nil
 }
 
-// addCoins increase the addr balance by the given amt. Fails if the provided amt is invalid.
-// It emits a coin received event.
+// addCoins increase the addr balance by the given amt. Fails if the provided
+// amt is invalid. It emits a coin received event.
 func (k BaseSendKeeper) addCoins(ctx sdk.Context, addr sdk.AccAddress, amt sdk.Coins) error {
 	if !amt.IsValid() {
 		return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, amt.String())
@@ -343,6 +340,7 @@ func (k BaseSendKeeper) setBalance(ctx sdk.Context, addr sdk.AccAddress, balance
 		if err != nil {
 			return err
 		}
+
 		accountStore.Set([]byte(balance.Denom), amount)
 
 		// Store a reverse index from denomination to account address with a
@@ -356,28 +354,23 @@ func (k BaseSendKeeper) setBalance(ctx sdk.Context, addr sdk.AccAddress, balance
 	return nil
 }
 
-// IsSendEnabledCoins checks the coins provide and returns an ErrSendDisabled if
-// any of the coins are not configured for sending.  Returns nil if sending is enabled
-// for all provided coin
+// IsSendEnabledCoins checks the coins provided and returns an ErrSendDisabled
+// if any of the coins are not configured for sending. Returns nil if sending is
+// enabled for all provided coins.
 func (k BaseSendKeeper) IsSendEnabledCoins(ctx sdk.Context, coins ...sdk.Coin) error {
 	if len(coins) == 0 {
 		return nil
 	}
+
 	store := ctx.KVStore(k.storeKey)
-	haveDefault := false
-	var defaultVal bool
-	getDefault := func() bool {
-		if !haveDefault {
-			defaultVal = k.GetParams(ctx).DefaultSendEnabled
-			haveDefault = true
-		}
-		return defaultVal
-	}
+	defaultVal := k.GetParams(ctx).DefaultSendEnabled
+
 	for _, coin := range coins {
-		if !k.getSendEnabledOrDefault(store, coin.Denom, getDefault) {
+		if !k.getSendEnabledOrDefault(store, coin.Denom, defaultVal) {
 			return types.ErrSendDisabled.Wrapf("%s transfers are currently disabled", coin.Denom)
 		}
 	}
+
 	return nil
 }
 
@@ -399,7 +392,7 @@ func (k BaseSendKeeper) GetBlockedAddresses() map[string]bool {
 
 // IsSendEnabledDenom returns the current SendEnabled status of the provided denom.
 func (k BaseSendKeeper) IsSendEnabledDenom(ctx sdk.Context, denom string) bool {
-	return k.getSendEnabledOrDefault(ctx.KVStore(k.storeKey), denom, func() bool { return k.GetParams(ctx).DefaultSendEnabled })
+	return k.getSendEnabledOrDefault(ctx.KVStore(k.storeKey), denom, k.GetParams(ctx).DefaultSendEnabled)
 }
 
 // GetSendEnabledEntry gets a SendEnabled entry for the given denom.
@@ -409,6 +402,7 @@ func (k BaseSendKeeper) GetSendEnabledEntry(ctx sdk.Context, denom string) (type
 	if !found {
 		return types.SendEnabled{}, false
 	}
+
 	return types.SendEnabled{Denom: denom, Enabled: sendEnabled}, true
 }
 
@@ -429,8 +423,9 @@ func (k BaseSendKeeper) SetAllSendEnabled(ctx sdk.Context, sendEnableds []*types
 // setSendEnabledEntry sets SendEnabled for the given denom to the give value in the provided store.
 func (k BaseSendKeeper) setSendEnabledEntry(store sdk.KVStore, denom string, value bool) {
 	key := types.CreateSendEnabledKey(denom)
-	val := types.ToBoolB(value)
-	store.Set(key, []byte{val})
+
+	bz := k.cdc.MustMarshal(&gogotypes.BoolValue{Value: value})
+	store.Set(key, bz)
 }
 
 // DeleteSendEnabled deletes the SendEnabled flags for one or more denoms.
@@ -456,8 +451,11 @@ func (k BaseSendKeeper) IterateSendEnabledEntries(ctx sdk.Context, cb func(denom
 
 	for ; iterator.Valid(); iterator.Next() {
 		denom := string(iterator.Key())
-		val := types.IsTrueB(iterator.Value())
-		if cb(denom, val) {
+
+		var enabled gogotypes.BoolValue
+		k.cdc.MustUnmarshal(iterator.Value(), &enabled)
+
+		if cb(denom, enabled.Value) {
 			break
 		}
 	}
@@ -471,10 +469,12 @@ func (k BaseSendKeeper) GetAllSendEnabledEntries(ctx sdk.Context) []types.SendEn
 		rv = append(rv, types.SendEnabled{Denom: denom, Enabled: sendEnabled})
 		return false
 	})
+
 	return rv
 }
 
-// getSendEnabled returns whether send is enabled and whether that flag was set for a denom.
+// getSendEnabled returns whether send is enabled and whether that flag was set
+// for a denom.
 //
 // Example usage:
 //
@@ -488,25 +488,25 @@ func (k BaseSendKeeper) getSendEnabled(store sdk.KVStore, denom string) (bool, b
 	if !store.Has(key) {
 		return false, false
 	}
-	v := store.Get(key)
-	if len(v) != 1 {
-		return false, false
-	}
-	switch v[0] {
-	case types.TrueB:
-		return true, true
-	case types.FalseB:
-		return false, true
-	default:
+
+	bz := store.Get(key)
+	if len(bz) == 0 {
 		return false, false
 	}
+
+	var enabled gogotypes.BoolValue
+	k.cdc.MustUnmarshal(bz, &enabled)
+
+	return enabled.Value, true
 }
 
-// getSendEnabledOrDefault gets the send_enabled value for a denom. If it's not in the store, this will return the result of the getDefault function.
-func (k BaseSendKeeper) getSendEnabledOrDefault(store sdk.KVStore, denom string, getDefault func() bool) bool {
+// getSendEnabledOrDefault gets the SendEnabled value for a denom. If it's not
+// in the store, this will return defaultVal.
+func (k BaseSendKeeper) getSendEnabledOrDefault(store sdk.KVStore, denom string, defaultVal bool) bool {
 	sendEnabled, found := k.getSendEnabled(store, denom)
 	if found {
 		return sendEnabled
 	}
-	return getDefault()
+
+	return defaultVal
 }

x/bank/module.go

@@ -6,15 +6,14 @@ import (
 	"fmt"
 	"time"
 
+	modulev1 "cosmossdk.io/api/cosmos/bank/module/v1"
+	"cosmossdk.io/core/appmodule"
+	"cosmossdk.io/depinject"
 	gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
 	"github.com/spf13/cobra"
 	abci "github.com/tendermint/tendermint/abci/types"
 	"golang.org/x/exp/maps"
 
-	modulev1 "cosmossdk.io/api/cosmos/bank/module/v1"
-	"cosmossdk.io/core/appmodule"
-	"cosmossdk.io/depinject"
-
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/codec"
 	codectypes "github.com/cosmos/cosmos-sdk/codec/types"

x/bank/types/genesis.go

@@ -107,31 +107,38 @@ func GetGenesisStateFromAppState(cdc codec.JSONCodec, appState map[string]json.R
 	return &genesisState
 }
 
-// MigrateSendEnabled moves the SendEnabled info from Params into the GenesisState.SendEnabled field and removes them from Params.
-// If the Params.SendEnabled slice is empty, this is a noop.
-// If the main SendEnabled slice already has entries, the Params.SendEnabled entries are added.
-// In case of the same demon in both, preference is given to the existing (main GenesisState field) entry.
+// MigrateSendEnabled moves the SendEnabled info from Params into the
+// GenesisState.SendEnabled field and removes them from Params. If the
+// Params.SendEnabled slice is empty, this is a noop.
+//
+// If the main SendEnabled slice already has entries, the Params.SendEnabled
+// entries are added. In case of the same demon in both, preference is given to
+// the existing (main GenesisState field) entry.
 func (g *GenesisState) MigrateSendEnabled() {
 	g.SendEnabled = g.GetAllSendEnabled()
 	g.Params.SendEnabled = nil
 }
 
-// GetAllSendEnabled returns all the SendEnabled entries from both the SendEnabled field and the Params.
-// If a denom has an entry in both, the entry in the SendEnabled field takes precedence over one in Params.
+// GetAllSendEnabled returns all the SendEnabled entries from both the SendEnabled
+// field and the Params. If a denom has an entry in both, the entry in the
+// SendEnabled field takes precedence over one in Params.
 func (g GenesisState) GetAllSendEnabled() []SendEnabled {
 	if len(g.Params.SendEnabled) == 0 {
 		return g.SendEnabled
 	}
+
 	rv := make([]SendEnabled, len(g.SendEnabled))
 	knownSendEnabled := map[string]bool{}
 	for i, se := range g.SendEnabled {
 		rv[i] = se
 		knownSendEnabled[se.Denom] = true
 	}
+
 	for _, se := range g.Params.SendEnabled {
 		if _, known := knownSendEnabled[se.Denom]; !known {
 			rv = append(rv, *se)
 		}
 	}
+
 	return rv
 }

x/bank/types/keys.go

@@ -37,13 +37,6 @@ var (
 	ParamsKey = []byte{0x05}
 )
 
-const (
-	// TrueB is a byte with value 1 that represents true.
-	TrueB = byte(0x01)
-	// FalseB is a byte with value 0 that represents false.
-	FalseB = byte(0x00)
-)
-
 // AddressAndDenomFromBalancesStore returns an account address and denom from a balances prefix
 // store. The key must not contain the prefix BalancesPrefix as the prefix store
 // iterator discards the actual prefix.
@@ -94,16 +87,3 @@ func CreateSendEnabledKey(denom string) []byte {
 	copy(key[len(SendEnabledPrefix):], denom)
 	return key
 }
-
-// IsTrueB returns true if the provided byte slice has exactly one byte, and it is equal to TrueB.
-func IsTrueB(bz []byte) bool {
-	return len(bz) == 1 && bz[0] == TrueB
-}
-
-// ToBoolB returns TrueB if v is true, and FalseB if it's false.
-func ToBoolB(v bool) byte {
-	if v {
-		return TrueB
-	}
-	return FalseB
-}