refactor: remove .Type() and .Route() from msgs (backport #14751)

CHANGELOG.md

@@ -35,6 +35,12 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 # Changelog
 
+## Unreleased 
+
+### Improvements
+
+* (x/auth/tx) [#14751](https://github.com/cosmos/cosmos-sdk/pull/14751) Remove `.Type()` and `Route()` methods from all msgs and `legacytx.LegacyMsg` interface.
+
 ## [v0.47.0](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.0) - 2023-03-14
 
 ### Features

baseapp/baseapp.go

@@ -850,11 +850,8 @@ func createEvents(events sdk.Events, msg sdk.Msg) sdk.Events {
 
 	// verify that events have no module attribute set
 	if _, found := events.GetAttributes(sdk.AttributeKeyModule); !found {
-		// here we assume that routes module name is the second element of the route
-		// e.g. "cosmos.bank.v1beta1.MsgSend" => "bank"
-		moduleName := strings.Split(eventMsgName, ".")
-		if len(moduleName) > 1 {
-			msgEvent = msgEvent.AppendAttributes(sdk.NewAttribute(sdk.AttributeKeyModule, moduleName[1]))
+		if moduleName := sdk.GetModuleNameFromTypeURL(eventMsgName); moduleName != "" {
+			msgEvent = msgEvent.AppendAttributes(sdk.NewAttribute(sdk.AttributeKeyModule, moduleName))
 		}
 	}
 

docs/docs/building-modules/02-messages-and-queries.md

@@ -63,8 +63,6 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/types/tx_msg.go#L14-L26
 
 It extends `proto.Message` and contains the following methods:
 
-* `Route() string`: Name of the route for this message. Typically all `message`s in a module have the same route, which is most often the module's name.
-* `Type() string`: Type of the message, used primarily in [events](../core/08-events.md). This should return a message-specific `string`, typically the denomination of the message itself.
 * [`ValidateBasic() error`](../basics/01-tx-lifecycle.md#ValidateBasic).
 * `GetSignBytes() []byte`: Return the canonical byte representation of the message. Used to generate a signature.
 * `GetSigners() []AccAddress`: Return the list of signers. The Cosmos SDK will make sure that each `message` contained in a transaction is signed by all the signers listed in the list returned by this method.

docs/docs/core/08-events.md

@@ -57,7 +57,6 @@ The following examples show how to query Events using the Cosmos SDK.
 | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `tx.height=23`                                   | Query all transactions at height 23                                                                                                                      |
 | `message.action='/cosmos.bank.v1beta1.Msg/Send'` | Query all transactions containing a x/bank `Send` [Service `Msg`](../building-modules/03-msg-services.md). Note the `'`s around the value.                  |
-| `message.action='send'`                          | Query all transactions containing a x/bank `Send` [legacy `Msg`](../building-modules/03-msg-services.md#legacy-amino-msgs). Note the `'`s around the value. |
 | `message.module='bank'`                          | Query all transactions containing messages from the x/bank module. Note the `'`s around the value.                                                       |
 | `create_validator.validator='cosmosval1...'`     | x/staking-specific Event, see [x/staking SPEC](../modules/staking/README.md).                                                         |
 

testutil/testdata/tx.go

@@ -77,8 +77,6 @@ func NewTestMsg(addrs ...sdk.AccAddress) *TestMsg {
 
 var _ sdk.Msg = (*TestMsg)(nil)
 
-func (msg *TestMsg) Route() string { return "TestMsg" }
-func (msg *TestMsg) Type() string  { return "Test message" }
 func (msg *TestMsg) GetSignBytes() []byte {
 	bz, err := json.Marshal(msg.Signers)
 	if err != nil {

types/simulation/types.go

@@ -76,10 +76,10 @@ type OperationMsg struct {
 }
 
 // NewOperationMsgBasic creates a new operation message from raw input.
-func NewOperationMsgBasic(route, name, comment string, ok bool, msg []byte) OperationMsg {
+func NewOperationMsgBasic(moduleName, msgType, comment string, ok bool, msg []byte) OperationMsg {
 	return OperationMsg{
-		Route:   route,
-		Name:    name,
+		Route:   moduleName,
+		Name:    msgType,
 		Comment: comment,
 		OK:      ok,
 		Msg:     msg,
@@ -88,18 +88,22 @@ func NewOperationMsgBasic(route, name, comment string, ok bool, msg []byte) Oper
 
 // NewOperationMsg - create a new operation message from sdk.Msg
 func NewOperationMsg(msg sdk.Msg, ok bool, comment string, cdc *codec.ProtoCodec) OperationMsg {
-	if legacyMsg, okType := msg.(legacytx.LegacyMsg); okType {
-		return NewOperationMsgBasic(legacyMsg.Route(), legacyMsg.Type(), comment, ok, legacyMsg.GetSignBytes())
+	msgType := sdk.MsgTypeURL(msg)
+	moduleName := sdk.GetModuleNameFromTypeURL(msgType)
+	if moduleName == "" {
+		moduleName = msgType
 	}
 
-	bz := cdc.MustMarshalJSON(msg)
+	if legacyMsg, okType := msg.(legacytx.LegacyMsg); okType {
+		return NewOperationMsgBasic(moduleName, msgType, comment, ok, legacyMsg.GetSignBytes())
+	}
 
-	return NewOperationMsgBasic(sdk.MsgTypeURL(msg), sdk.MsgTypeURL(msg), comment, ok, bz)
+	return NewOperationMsgBasic(moduleName, msgType, comment, ok, cdc.MustMarshalJSON(msg))
 }
 
 // NoOpMsg - create a no-operation message
-func NoOpMsg(route, msgType, comment string) OperationMsg {
-	return NewOperationMsgBasic(route, msgType, comment, false, nil)
+func NoOpMsg(moduleName, msgType, comment string) OperationMsg {
+	return NewOperationMsgBasic(moduleName, msgType, comment, false, nil)
 }
 
 // log entry text for this operation msg

types/tx_msg.go

@@ -3,6 +3,7 @@ package types
 import (
 	"encoding/json"
 	fmt "fmt"
+	strings "strings"
 
 	"github.com/cosmos/gogoproto/proto"
 
@@ -102,3 +103,15 @@ func GetMsgFromTypeURL(cdc codec.Codec, input string) (Msg, error) {
 
 	return msg, nil
 }
+
+// GetModuleNameFromTypeURL assumes that module name is the second element of the msg type URL
+// e.g. "cosmos.bank.v1beta1.MsgSend" => "bank"
+// It returns an empty string if the input is not a valid type URL
+func GetModuleNameFromTypeURL(input string) string {
+	moduleName := strings.Split(input, ".")
+	if len(moduleName) > 1 {
+		return moduleName[1]
+	}
+
+	return ""
+}

types/tx_msg_test.go

@@ -25,8 +25,6 @@ func (s *testMsgSuite) TestMsg() {
 	msg := testdata.NewTestMsg(accAddr)
 	s.Require().NotNil(msg)
 	s.Require().True(accAddr.Equals(msg.GetSigners()[0]))
-	s.Require().Equal("TestMsg", msg.Route())
-	s.Require().Equal("Test message", msg.Type())
 	s.Require().Nil(msg.ValidateBasic())
 	s.Require().NotPanics(func() { msg.GetSignBytes() })
 }

x/auth/migrations/legacytx/stdsign.go

@@ -17,22 +17,14 @@ import (
 	"github.com/cosmos/cosmos-sdk/types/tx/signing"
 )
 
-// LegacyMsg defines the old interface a message must fulfill, containing
-// Amino signing method and legacy router info.
+// LegacyMsg defines the old interface a message must fulfill,
+// containing Amino signing method.
 // Deprecated: Please use `Msg` instead.
 type LegacyMsg interface {
 	sdk.Msg
 
 	// Get the canonical byte representation of the Msg.
 	GetSignBytes() []byte
-
-	// Return the message type.
-	// Must be alphanumeric or empty.
-	Route() string
-
-	// Returns a human-readable string for the message, intended for utilization
-	// within tags
-	Type() string
 }
 
 // StdSignDoc is replay-prevention structure.

x/auth/types/msgs.go

@@ -3,23 +3,27 @@ package types
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
 )
 
-var _ sdk.Msg = &MsgUpdateParams{}
+var (
+	_ sdk.Msg            = &MsgUpdateParams{}
+	_ legacytx.LegacyMsg = &MsgUpdateParams{}
+)
 
 // GetSignBytes implements the LegacyMsg interface.
 func (msg MsgUpdateParams) GetSignBytes() []byte {
 	return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&msg))
 }
 
 // GetSigners returns the expected signers for a MsgUpdateParams message.
-func (msg *MsgUpdateParams) GetSigners() []sdk.AccAddress {
+func (msg MsgUpdateParams) GetSigners() []sdk.AccAddress {
 	addr, _ := sdk.AccAddressFromBech32(msg.Authority)
 	return []sdk.AccAddress{addr}
 }
 
 // ValidateBasic does a sanity check on the provided data.
-func (msg *MsgUpdateParams) ValidateBasic() error {
+func (msg MsgUpdateParams) ValidateBasic() error {
 	if _, err := sdk.AccAddressFromBech32(msg.Authority); err != nil {
 		return sdkerrors.Wrap(err, "invalid authority address")
 	}

x/auth/vesting/types/msgs.go

@@ -5,22 +5,18 @@ import (
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
 )
 
-// TypeMsgCreateVestingAccount defines the type value for a MsgCreateVestingAccount.
-const TypeMsgCreateVestingAccount = "msg_create_vesting_account"
+var (
+	_ sdk.Msg = &MsgCreateVestingAccount{}
+	_ sdk.Msg = &MsgCreatePermanentLockedAccount{}
+	_ sdk.Msg = &MsgCreatePeriodicVestingAccount{}
 
-// TypeMsgCreatePermanentLockedAccount defines the type value for a MsgCreatePermanentLockedAccount.
-const TypeMsgCreatePermanentLockedAccount = "msg_create_permanent_locked_account"
-
-// TypeMsgCreatePeriodicVestingAccount defines the type value for a MsgCreateVestingAccount.
-const TypeMsgCreatePeriodicVestingAccount = "msg_create_periodic_vesting_account"
-
-var _ sdk.Msg = &MsgCreateVestingAccount{}
-
-var _ sdk.Msg = &MsgCreatePermanentLockedAccount{}
-
-var _ sdk.Msg = &MsgCreatePeriodicVestingAccount{}
+	_ legacytx.LegacyMsg = &MsgCreateVestingAccount{}
+	_ legacytx.LegacyMsg = &MsgCreatePermanentLockedAccount{}
+	_ legacytx.LegacyMsg = &MsgCreatePeriodicVestingAccount{}
+)
 
 // NewMsgCreateVestingAccount returns a reference to a new MsgCreateVestingAccount.
 //
@@ -35,12 +31,6 @@ func NewMsgCreateVestingAccount(fromAddr, toAddr sdk.AccAddress, amount sdk.Coin
 	}
 }
 
-// Route returns the message route for a MsgCreateVestingAccount.
-func (msg MsgCreateVestingAccount) Route() string { return RouterKey }
-
-// Type returns the message type for a MsgCreateVestingAccount.
-func (msg MsgCreateVestingAccount) Type() string { return TypeMsgCreateVestingAccount }
-
 // ValidateBasic Implements Msg.
 func (msg MsgCreateVestingAccount) ValidateBasic() error {
 	if _, err := sdk.AccAddressFromBech32(msg.FromAddress); err != nil {
@@ -88,12 +78,6 @@ func NewMsgCreatePermanentLockedAccount(fromAddr, toAddr sdk.AccAddress, amount
 	}
 }
 
-// Route returns the message route for a MsgCreatePermanentLockedAccount.
-func (msg MsgCreatePermanentLockedAccount) Route() string { return RouterKey }
-
-// Type returns the message type for a MsgCreatePermanentLockedAccount.
-func (msg MsgCreatePermanentLockedAccount) Type() string { return TypeMsgCreatePermanentLockedAccount }
-
 // ValidateBasic Implements Msg.
 func (msg MsgCreatePermanentLockedAccount) ValidateBasic() error {
 	if _, err := sdk.AccAddressFromBech32(msg.FromAddress); err != nil {
@@ -138,12 +122,6 @@ func NewMsgCreatePeriodicVestingAccount(fromAddr, toAddr sdk.AccAddress, startTi
 	}
 }
 
-// Route returns the message route for a MsgCreatePeriodicVestingAccount.
-func (msg MsgCreatePeriodicVestingAccount) Route() string { return RouterKey }
-
-// Type returns the message type for a MsgCreatePeriodicVestingAccount.
-func (msg MsgCreatePeriodicVestingAccount) Type() string { return TypeMsgCreatePeriodicVestingAccount }
-
 // GetSigners returns the expected signers for a MsgCreatePeriodicVestingAccount.
 func (msg MsgCreatePeriodicVestingAccount) GetSigners() []sdk.AccAddress {
 	from, err := sdk.AccAddressFromBech32(msg.FromAddress)

x/authz/msgs.go

@@ -66,16 +66,6 @@ func (msg MsgGrant) ValidateBasic() error {
 	return msg.Grant.ValidateBasic()
 }
 
-// Type implements the LegacyMsg.Type method.
-func (msg MsgGrant) Type() string {
-	return sdk.MsgTypeURL(&msg)
-}
-
-// Route implements the LegacyMsg.Route method.
-func (msg MsgGrant) Route() string {
-	return sdk.MsgTypeURL(&msg)
-}
-
 // GetSignBytes implements the LegacyMsg.GetSignBytes method.
 func (msg MsgGrant) GetSignBytes() []byte {
 	return sdk.MustSortJSON(authzcodec.ModuleCdc.MustMarshalJSON(&msg))
@@ -157,16 +147,6 @@ func (msg MsgRevoke) ValidateBasic() error {
 	return nil
 }
 
-// Type implements the LegacyMsg.Type method.
-func (msg MsgRevoke) Type() string {
-	return sdk.MsgTypeURL(&msg)
-}
-
-// Route implements the LegacyMsg.Route method.
-func (msg MsgRevoke) Route() string {
-	return sdk.MsgTypeURL(&msg)
-}
-
 // GetSignBytes implements the LegacyMsg.GetSignBytes method.
 func (msg MsgRevoke) GetSignBytes() []byte {
 	return sdk.MustSortJSON(authzcodec.ModuleCdc.MustMarshalJSON(&msg))
@@ -235,16 +215,6 @@ func (msg MsgExec) ValidateBasic() error {
 	return nil
 }
 
-// Type implements the LegacyMsg.Type method.
-func (msg MsgExec) Type() string {
-	return sdk.MsgTypeURL(&msg)
-}
-
-// Route implements the LegacyMsg.Route method.
-func (msg MsgExec) Route() string {
-	return sdk.MsgTypeURL(&msg)
-}
-
 // GetSignBytes implements the LegacyMsg.GetSignBytes method.
 func (msg MsgExec) GetSignBytes() []byte {
 	return sdk.MustSortJSON(authzcodec.ModuleCdc.MustMarshalJSON(&msg))

x/authz/simulation/operations_test.go

@@ -69,10 +69,11 @@ func (suite *SimTestSuite) TestWeightedOperations() {
 	expected := []struct {
 		weight     int
 		opMsgRoute string
+		opMsgName  string
 	}{
-		{simulation.WeightGrant, simulation.TypeMsgGrant},
-		{simulation.WeightExec, simulation.TypeMsgExec},
-		{simulation.WeightRevoke, simulation.TypeMsgRevoke},
+		{simulation.WeightGrant, authz.ModuleName, simulation.TypeMsgGrant},
+		{simulation.WeightExec, authz.ModuleName, simulation.TypeMsgExec},
+		{simulation.WeightRevoke, authz.ModuleName, simulation.TypeMsgRevoke},
 	}
 
 	require := suite.Require()
@@ -83,12 +84,9 @@ func (suite *SimTestSuite) TestWeightedOperations() {
 		// the following checks are very much dependent from the ordering of the output given
 		// by WeightedOperations. if the ordering in WeightedOperations changes some tests
 		// will fail
-		require.Equal(expected[i].weight, w.Weight(),
-			"weight should be the same. %v", op.Comment)
-		require.Equal(expected[i].opMsgRoute, op.Route,
-			"route should be the same. %v", op.Comment)
-		require.Equal(expected[i].opMsgRoute, op.Name,
-			"operation Msg name should be the same %v", op.Comment)
+		require.Equal(expected[i].weight, w.Weight(), "weight should be the same. %v", op.Comment)
+		require.Equal(expected[i].opMsgRoute, op.Route, "route should be the same. %v", op.Comment)
+		require.Equal(expected[i].opMsgName, op.Name, "operation Msg name should be the same %v", op.Comment)
 	}
 }