refactor(templates)!: remove ValidateBasic() and use address codec (#…

…4058)

changelog.md

@@ -13,6 +13,8 @@
 
 ### Changes
 
+- [#4058](https://github.com/ignite/cli/pull/4058) Simplify scaffolded modules by including `ValidateBasic()` logic in message handler.
+- [#4058](https://github.com/ignite/cli/pull/4058) Use `address.Codec` instead of `AccAddressFromBech32`.
 - [#3993](https://github.com/ignite/cli/pull/3993) Oracle scaffolding was deprecated and has been removed
 - [#3959](https://github.com/ignite/cli/pull/3959) Remove app name prefix from the `.gitignore` file
 - [#3962](https://github.com/ignite/cli/pull/3962) Rename all RPC endpoints and autocli commands generated for `map`/`list`/`single` types

ignite/pkg/cosmostestutil/sample/sample_test.go

@@ -3,13 +3,14 @@ package cosmostestutilsample
 import (
 	"testing"
 
-	sdk "github.com/cosmos/cosmos-sdk/types"
+	addresscodec "github.com/cosmos/cosmos-sdk/codec/address"
 	"github.com/stretchr/testify/require"
 )
 
 func TestAccAddress(t *testing.T) {
 	got := AccAddress()
 	require.NotEmpty(t, got)
-	_, err := sdk.AccAddressFromBech32(got)
+	exampleAccountAddress := addresscodec.NewBech32Codec("cosmos")
+	_, err := exampleAccountAddress.StringToBytes(got)
 	require.NoError(t, err)
 }

ignite/templates/ibc/files/packet/component/x/{{moduleName}}/keeper/{{packetName}}.go.plush

@@ -21,7 +21,7 @@ func (k Keeper) Transmit<%= packetName.UpperCamel %>Packet(
 	timeoutHeight clienttypes.Height,
     timeoutTimestamp uint64,
 ) (uint64, error) {
-    channelCap, ok := k.scopedKeeper.GetCapability(ctx, host.ChannelCapabilityPath(sourcePort, sourceChannel))
+    channelCap, ok := k.ScopedKeeper().GetCapability(ctx, host.ChannelCapabilityPath(sourcePort, sourceChannel))
     if !ok {
         return 0, errorsmod.Wrap(channeltypes.ErrChannelCapabilityNotFound, "module does not own channel capability")
     }
@@ -37,9 +37,6 @@ func (k Keeper) Transmit<%= packetName.UpperCamel %>Packet(
 // OnRecv<%= packetName.UpperCamel %>Packet processes packet reception
 func (k Keeper) OnRecv<%= packetName.UpperCamel %>Packet(ctx sdk.Context, packet channeltypes.Packet, data types.<%= packetName.UpperCamel %>PacketData) (packetAck types.<%= packetName.UpperCamel %>PacketAck, err error) {
 	// validate packet data upon receiving
-	if err := data.ValidateBasic(); err != nil {
-		return packetAck, err
-	}
 
 	// TODO: packet reception logic
 

ignite/templates/ibc/files/packet/component/x/{{moduleName}}/types/packet_{{packetName}}.go.plush

@@ -1,13 +1,5 @@
 package types
 
-// ValidateBasic is used for validating the packet
-func (p <%= packetName.UpperCamel %>PacketData) ValidateBasic() error {
-
-	// TODO: Validate the packet data
-
-	return nil
-}
-
 // GetBytes is a helper for serialising
 func (p <%= packetName.UpperCamel %>PacketData) GetBytes() ([]byte, error) {
 	var modulePacket <%= title(moduleName) %>PacketData

ignite/templates/ibc/files/packet/messages/x/{{moduleName}}/client/cli/tx_{{packetName}}.go.plush

@@ -50,9 +50,7 @@ func CmdSend<%= packetName.UpperCamel %>() *cobra.Command {
             }
 
 			msg := types.NewMsgSend<%= packetName.UpperCamel %>(<%= MsgSigner.LowerCamel %>, srcPort, srcChannel, timeoutTimestamp<%= for (i, field) in fields { %>, arg<%= field.Name.UpperCamel %><% } %>)
-			if err := msg.ValidateBasic(); err != nil {
-				return err
-			}
+
 			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
 		},
 	}

ignite/templates/ibc/files/packet/messages/x/{{moduleName}}/keeper/msg_server_{{packetName}}.go.plush

@@ -1,16 +1,34 @@
 package keeper
 
 import (
+    "fmt"
 	"context"
 
+	errorsmod "cosmossdk.io/errors"
     "<%= ModulePath %>/x/<%= moduleName %>/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 	clienttypes "github.com/cosmos/ibc-go/v8/modules/core/02-client/types"
 )
 
 
 func (k msgServer) Send<%= packetName.UpperCamel %>(goCtx context.Context,  msg *types.MsgSend<%= packetName.UpperCamel %>) (*types.MsgSend<%= packetName.UpperCamel %>Response, error) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
+    // validate incoming message
+    if _, err := k.addressCodec.StringToBytes(msg.<%= MsgSigner.UpperCamel %>); err != nil {
+        return nil, errorsmod.Wrap(sdkerrors.ErrInvalidAddress, fmt.Sprintf("invalid address: %s", err))
+    }
+
+	if msg.Port == "" {
+		return nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet port")
+	}
+
+    if msg.ChannelID == "" {
+		return nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet channel")
+	}
+
+	if msg.TimeoutTimestamp == 0 {
+		return nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet timeout")
+	}
 
     // TODO: logic before transmitting the packet
 
@@ -20,6 +38,7 @@ func (k msgServer) Send<%= packetName.UpperCamel %>(goCtx context.Context,  msg
     packet.<%= field.Name.UpperCamel %> = msg.<%= field.Name.UpperCamel %><% } %>
 
     // Transmit the packet
+	ctx := sdk.UnwrapSDKContext(goCtx)
     _, err := k.Transmit<%= packetName.UpperCamel %>Packet(
         ctx,
         packet,
@@ -33,4 +52,4 @@ func (k msgServer) Send<%= packetName.UpperCamel %>(goCtx context.Context,  msg
     }
 
 	return &types.MsgSend<%= packetName.UpperCamel %>Response{}, nil
-}
+}

ignite/templates/ibc/files/packet/messages/x/{{moduleName}}/keeper/msg_server_{{packetName}}_test.go.plush

@@ -0,0 +1,84 @@
+package keeper_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	channeltypes "github.com/cosmos/ibc-go/v8/modules/core/04-channel/types"
+
+	keepertest "<%= ModulePath %>/testutil/keeper"
+    "<%= ModulePath %>/x/<%= moduleName %>/keeper"
+	"<%= ModulePath %>/x/<%= moduleName %>/types"
+)
+
+func TestMsgServerSend<%= packetName.UpperCamel %>(t *testing.T) {
+	k, ctx, addressCodec := keepertest.<%= title(moduleName) %>Keeper(t)
+	<%= MsgSigner.LowerCamel %>, err := addressCodec.BytesToString([]byte("signerAddr__________________"))
+	require.NoError(t, err)
+	srv := keeper.NewMsgServerImpl(k)
+
+	tests := []struct {
+		name string
+		msg  types.MsgSend<%= packetName.UpperCamel %>
+		err  error
+	}{
+		{
+			name: "invalid address",
+			msg: types.MsgSend<%= packetName.UpperCamel %>{
+				<%= MsgSigner.UpperCamel %>: "invalid address",
+				Port:             "port",
+				ChannelID:        "channel-0",
+				TimeoutTimestamp: 100,
+			},
+			err: sdkerrors.ErrInvalidAddress,
+		}, {
+			name: "invalid port",
+			msg: types.MsgSend<%= packetName.UpperCamel %>{
+				<%= MsgSigner.UpperCamel %>: <%= MsgSigner.LowerCamel %>,
+				Port:             "",
+				ChannelID:        "channel-0",
+				TimeoutTimestamp: 100,
+			},
+			err: sdkerrors.ErrInvalidRequest,
+		}, {
+			name: "invalid channel",
+			msg: types.MsgSend<%= packetName.UpperCamel %>{
+				<%= MsgSigner.UpperCamel %>: <%= MsgSigner.LowerCamel %>,
+				Port:             "port",
+				ChannelID:        "",
+				TimeoutTimestamp: 100,
+			},
+			err: sdkerrors.ErrInvalidRequest,
+		}, {
+			name: "invalid timeout",
+			msg: types.MsgSend<%= packetName.UpperCamel %>{
+				<%= MsgSigner.UpperCamel %>: <%= MsgSigner.LowerCamel %>,
+				Port:             "port",
+				ChannelID:        "channel-0",
+				TimeoutTimestamp: 0,
+			},
+			err: sdkerrors.ErrInvalidRequest,
+		}, {
+			name: "valid message",
+			msg: types.MsgSend<%= packetName.UpperCamel %>{
+				<%= MsgSigner.UpperCamel %>: <%= MsgSigner.LowerCamel %>,
+				Port:             "port",
+				ChannelID:        "channel-0",
+				TimeoutTimestamp: 100,
+			},
+			err: channeltypes.ErrChannelCapabilityNotFound,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_, err = srv.Send<%= packetName.UpperCamel %>(ctx, &tt.msg)
+			if tt.err != nil {
+				require.ErrorContains(t, err, tt.err.Error())
+				return
+			}
+			require.NoError(t, err)
+		})
+	}
+}

ignite/templates/ibc/files/packet/messages/x/{{moduleName}}/types/messages_{{packetName}}.go.plush

@@ -1,13 +1,5 @@
 package types
 
-import (
-	errorsmod "cosmossdk.io/errors"
-	sdk "github.com/cosmos/cosmos-sdk/types"
-	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
-)
-
-var _ sdk.Msg = &MsgSend<%= packetName.UpperCamel %>{}
-
 func NewMsgSend<%= packetName.UpperCamel %>(
     <%= MsgSigner.LowerCamel %> string,
     port string,
@@ -22,21 +14,4 @@ func NewMsgSend<%= packetName.UpperCamel %>(
 		TimeoutTimestamp: timeoutTimestamp,<%= for (field) in fields { %>
         <%= field.Name.UpperCamel %>: <%= field.Name.LowerCamel %>,<% } %>
 	}
-}
-
-func (msg *MsgSend<%= packetName.UpperCamel %>) ValidateBasic() error {
-    _, err := sdk.AccAddressFromBech32(msg.<%= MsgSigner.UpperCamel %>)
-    if err != nil {
-        return errorsmod.Wrapf(sdkerrors.ErrInvalidAddress, "invalid <%= MsgSigner.LowerCamel %> address (%s)", err)
-    }
-	if msg.Port == "" {
-		return errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet port")
-	}
-	if msg.ChannelID == "" {
-		return errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet channel")
-	}
-	if msg.TimeoutTimestamp == 0 {
-		return errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet timeout")
-	}
-    return nil
-}
+}

ignite/templates/message/files/message/x/{{moduleName}}/keeper/msg_server_{{msgName}}.go.plush

@@ -9,6 +9,10 @@ import (
 
 
 func (k msgServer) <%= MsgName.UpperCamel %>(ctx context.Context,  msg *types.Msg<%= MsgName.UpperCamel %>) (*types.Msg<%= MsgName.UpperCamel %>Response, error) {
+	if _, err := k.addressCodec.StringToBytes(msg.<%= MsgSigner.UpperCamel %>); err != nil {
+		return nil, errorsmod.Wrap(err, "invalid authority address")
+	}
+
     // TODO: Handle the message
 
 	return &types.Msg<%= MsgName.UpperCamel %>Response{}, nil

ignite/templates/message/files/message/x/{{moduleName}}/types/message_{{msgName}}.go.plush

@@ -1,25 +1,8 @@
 package types
 
-import (
-	errorsmod "cosmossdk.io/errors"
-	sdk "github.com/cosmos/cosmos-sdk/types"
-	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
-)
-
-var _ sdk.Msg = &Msg<%= MsgName.UpperCamel %>{}
-
 func NewMsg<%= MsgName.UpperCamel %>(<%= MsgSigner.LowerCamel %> string<%= for (field) in Fields { %>, <%= field.Name.LowerCamel %> <%= field.DataType() %><% } %>) *Msg<%= MsgName.UpperCamel %> {
   return &Msg<%= MsgName.UpperCamel %>{
 		<%= MsgSigner.UpperCamel %>: <%= MsgSigner.LowerCamel %>,<%= for (field) in Fields { %>
     <%= field.Name.UpperCamel %>: <%= field.Name.LowerCamel %>,<% } %>
 	}
-}
-
-func (msg *Msg<%= MsgName.UpperCamel %>) ValidateBasic() error {
-  _, err := sdk.AccAddressFromBech32(msg.<%= MsgSigner.UpperCamel %>)
-  	if err != nil {
-  		return errorsmod.Wrapf(sdkerrors.ErrInvalidAddress, "invalid <%= MsgSigner.LowerCamel %> address (%s)", err)
-  	}
-  return nil
-}
-
+}