feat(accounts): use gogoproto API instead of protov2.

CHANGELOG.md

@@ -84,6 +84,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (simulation) [#17911](https://github.com/cosmos/cosmos-sdk/pull/17911) Fix all problems with executing command `make test-sim-custom-genesis-fast` for simulation test.
 * (simulation) [#18196](https://github.com/cosmos/cosmos-sdk/pull/18196) Fix the problem of `validator set is empty after InitGenesis` in simulation test.
 * (baseapp) [#18551](https://github.com/cosmos/cosmos-sdk/pull/18551) Fix SelectTxForProposal the calculation method of tx bytes size is inconsistent with CometBFT
+* (baseapp) [#18653](https://github.com/cosmos/cosmos-sdk/pull/18653) Fix protocompat hybrid handler merging on gogoproto handlers for messages with custom types.
 
 ### API Breaking Changes
 

baseapp/internal/protocompat/protocompat.go

@@ -6,6 +6,7 @@ import (
 	"reflect"
 
 	gogoproto "github.com/cosmos/gogoproto/proto"
+	"github.com/golang/protobuf/proto" // nolint: staticcheck // needed because gogoproto.Merge does not work consistently. See NOTE: comments.
 	"google.golang.org/grpc"
 	proto2 "google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/reflect/protoreflect"
@@ -125,14 +126,18 @@ func makeGogoHybridHandler(prefMethod protoreflect.MethodDescriptor, cdc codec.B
 			}
 			resp, err := method.Handler(handler, ctx, func(msg any) error {
 				// merge! ref: https://github.com/cosmos/cosmos-sdk/issues/18003
-				gogoproto.Merge(msg.(gogoproto.Message), inReq)
+				// NOTE: using gogoproto.Merge will fail for some reason unknown to me, but
+				// using proto.Merge with gogo messages seems to work fine.
+				proto.Merge(msg.(gogoproto.Message), inReq)
 				return nil
 			}, nil)
 			if err != nil {
 				return err
 			}
 			// merge resp, ref: https://github.com/cosmos/cosmos-sdk/issues/18003
-			gogoproto.Merge(outResp.(gogoproto.Message), resp.(gogoproto.Message))
+			// NOTE: using gogoproto.Merge will fail for some reason unknown to me, but
+			// using proto.Merge with gogo messages seems to work fine.
+			proto.Merge(outResp.(gogoproto.Message), resp.(gogoproto.Message))
 			return nil
 		}, nil
 	}
@@ -165,14 +170,19 @@ func makeGogoHybridHandler(prefMethod protoreflect.MethodDescriptor, cdc codec.B
 			// we can just call the handler after making a copy of the message, for safety reasons.
 			resp, err := method.Handler(handler, ctx, func(msg any) error {
 				// ref: https://github.com/cosmos/cosmos-sdk/issues/18003
-				gogoproto.Merge(msg.(gogoproto.Message), m)
+				asGogoProto := msg.(gogoproto.Message)
+				// NOTE: using gogoproto.Merge will fail for some reason unknown to me, but
+				// using proto.Merge with gogo messages seems to work fine.
+				proto.Merge(asGogoProto, m)
 				return nil
 			}, nil)
 			if err != nil {
 				return err
 			}
 			// merge on the resp, ref: https://github.com/cosmos/cosmos-sdk/issues/18003
-			gogoproto.Merge(outResp.(gogoproto.Message), resp.(gogoproto.Message))
+			// NOTE: using gogoproto.Merge will fail for some reason unknown to me, but
+			// using proto.Merge with gogo messages seems to work fine.
+			proto.Merge(outResp.(gogoproto.Message), resp.(gogoproto.Message))
 			return nil
 		default:
 			panic("unreachable")

codec/unknownproto/unknown_fields.go

@@ -44,12 +44,7 @@ func RejectUnknownFields(bz []byte, msg proto.Message, allowUnknownNonCriticals
 		return hasUnknownNonCriticals, nil
 	}
 
-	desc, ok := msg.(descriptorIface)
-	if !ok {
-		return hasUnknownNonCriticals, fmt.Errorf("%T does not have a Descriptor() method", msg)
-	}
-
-	fieldDescProtoFromTagNum, _, err := getDescriptorInfo(desc, msg)
+	fieldDescProtoFromTagNum, _, err := getDescriptorInfo(msg)
 	if err != nil {
 		return hasUnknownNonCriticals, err
 	}
@@ -345,7 +340,11 @@ func unnestDesc(mdescs []*descriptorpb.DescriptorProto, indices []int) *descript
 
 // Invoking descriptorpb.ForMessage(proto.Message.(Descriptor).Descriptor()) is incredibly slow
 // for every single message, thus the need for a hand-rolled custom version that's performant and cacheable.
-func extractFileDescMessageDesc(desc descriptorIface) (*descriptorpb.FileDescriptorProto, *descriptorpb.DescriptorProto, error) {
+func extractFileDescMessageDesc(msg proto.Message) (*descriptorpb.FileDescriptorProto, *descriptorpb.DescriptorProto, error) {
+	desc, ok := msg.(descriptorIface)
+	if !ok {
+		return nil, nil, fmt.Errorf("%T does not have a Descriptor() method", msg)
+	}
 	gzippedPb, indices := desc.Descriptor()
 
 	protoFileToDescMu.RLock()
@@ -391,7 +390,8 @@ var (
 )
 
 // getDescriptorInfo retrieves the mapping of field numbers to their respective field descriptors.
-func getDescriptorInfo(desc descriptorIface, msg proto.Message) (map[int32]*descriptorpb.FieldDescriptorProto, *descriptorpb.DescriptorProto, error) {
+func getDescriptorInfo(msg proto.Message) (map[int32]*descriptorpb.FieldDescriptorProto, *descriptorpb.DescriptorProto, error) {
+	// we immediately check if the desc is present in the desc
 	key := reflect.ValueOf(msg).Type()
 
 	descprotoCacheMu.RLock()
@@ -403,7 +403,7 @@ func getDescriptorInfo(desc descriptorIface, msg proto.Message) (map[int32]*desc
 	}
 
 	// Now compute and cache the index.
-	_, md, err := extractFileDescMessageDesc(desc)
+	_, md, err := extractFileDescMessageDesc(msg)
 	if err != nil {
 		return nil, nil, err
 	}

proto/cosmos/accounts/interfaces/account_abstraction/v1/interface.proto

@@ -5,6 +5,8 @@
 import "google/protobuf/any.proto";
 import "cosmos/accounts/v1/account_abstraction.proto";
 
+option go_package = "cosmossdk.io/x/accounts/interfaces/account_abstraction/v1";
+
 // MsgAuthenticate is a message that an x/account account abstraction implementer
 // must handle to authenticate a state transition.
 message MsgAuthenticate {

proto/cosmos/accounts/testing/counter/v1/counter.proto

@@ -2,6 +2,8 @@
 
 package cosmos.accounts.testing.counter.v1;
 
+option go_package = "cosmossdk.io/x/accounts/testing/counter/v1";
+
 // MsgInit defines a message which initializes the counter with a given amount.
 message MsgInit {
   // initial_value is the initial amount to set the counter to.

proto/cosmos/accounts/testing/rotation/v1/partial.proto

@@ -2,6 +2,8 @@
 
 package cosmos.accounts.testing.rotation.v1;
 
+option go_package = "cosmossdk.io/x/accounts/testing/rotation/v1";
+
 // MsgInit is the init message used to create a new account
 // abstraction implementation that we use for testing, this account
 // also allows for rotating the public key.

proto/cosmos/accounts/v1/query.proto

@@ -4,6 +4,8 @@
 
 option go_package = "cosmossdk.io/x/accounts/v1";
 
+import "google/protobuf/any.proto";
+
 // Query defines the Query service for the x/accounts module.
 service Query {
   // AccountQuery runs an account query.
@@ -19,13 +21,13 @@
   // target defines the account to be queried.
   string target = 1;
   // request defines the query message being sent to the account.
-  bytes request = 2;
+  google.protobuf.Any request = 2;
 }
 
 // AccountQueryResponse is the response type for the Query/AccountQuery RPC method.
 message AccountQueryResponse {
   // response defines the query response of the account.
-  bytes response = 1;
+  google.protobuf.Any response = 1;
 }
 
 // SchemaResponse is the response type for the Query/Schema RPC method.

proto/cosmos/accounts/v1/tx.proto

@@ -4,6 +4,7 @@
 
 option go_package = "cosmossdk.io/x/accounts/v1";
 
+import "google/protobuf/any.proto";
 import "cosmos/msg/v1/msg.proto";
 import "cosmos/accounts/v1/account_abstraction.proto";
 
@@ -30,18 +31,16 @@
   string sender = 1;
   // account_type is the type of the account to be created.
   string account_type = 2;
-  // message is the message to be sent to the account, it's up to the account
-  // implementation to decide what encoding format should be used to interpret
-  // this message.
-  bytes message = 3;
+  // message is the message to be sent to the account.
+  google.protobuf.Any message = 3;
 }
 
 // MsgInitResponse defines the Create response type for the Msg/Create RPC method.
 message MsgInitResponse {
   // account_address is the address of the newly created account.
   string account_address = 1;
   // response is the response returned by the account implementation.
-  bytes response = 2;
+  google.protobuf.Any response = 2;
 }
 
 // MsgExecute defines the Execute request type for the Msg/Execute RPC method.
@@ -51,14 +50,14 @@
   string sender = 1;
   // target is the address of the account to be executed.
   string target = 2;
-  // message is the message to be sent to the account, it's up to the account
-  bytes message = 3;
+  // message is the message to be sent to the account.
+  google.protobuf.Any message = 3;
 }
 
 // MsgExecuteResponse defines the Execute response type for the Msg/Execute RPC method.
 message MsgExecuteResponse {
   // response is the response returned by the account implementation.
-  bytes response = 1;
+  google.protobuf.Any response = 1;
 }
 
 // -------- Account Abstraction ---------

simapp/app.go

@@ -287,9 +287,10 @@ func NewSimApp(
 		runtime.EventService{},
 		runtime.BranchService{},
 		app.AuthKeeper.AddressCodec(),
-		appCodec.InterfaceRegistry().SigningContext(),
+		appCodec,
 		app.MsgServiceRouter(),
 		app.GRPCQueryRouter(),
+		appCodec.InterfaceRegistry(),
 		accountstd.AddAccount("counter", counter.NewAccount),
 		accountstd.AddAccount("aa_minimal", account_abstraction.NewMinimalAbstractedAccount),
 		accountstd.AddAccount("aa_full", account_abstraction.NewFullAbstractedAccount),