chore(api!): mark MsgModuleQuerySafe requests field as non-nullable (#…

…6598) * Mark MsgModuleQuerySafe requests field as non-nullable * fix e2e tests and docs * add changelog and update migration docs * Update 13-v8-to-v9.md --------- Co-authored-by: DimitrisJim <[email protected]> Co-authored-by: Carlos Rodriguez <[email protected]>
cosmos · Jun 28, 2024 · b083e37 · b083e37
1 parent 44f98ec
commit b083e37
Show file tree

Hide file tree

Showing 10 changed files with 55 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -58,6 +58,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (apps/27-interchain-accounts) [\#6433](https://github.com/cosmos/ibc-go/pull/6433) Use UNORDERED as the default ordering for new ICA channels.
 * (apps/transfer) [\#6440](https://github.com/cosmos/ibc-go/pull/6440) Remove `GetPrefixedDenom`.
 * (apps/transfer) [\#6508](https://github.com/cosmos/ibc-go/pull/6508) Remove the `DenomTrace` type.
+* (apps/27-interchain-accounts) [\#6598](https://github.com/cosmos/ibc-go/pull/6598) Mark the `requests` repeated field of `MsgModuleQuerySafe` non-nullable.
 * (23-commmitment) [\#6633](https://github.com/cosmos/ibc-go/pull/6633) MerklePath has been changed to use `repeated bytes` in favour of `repeated strings`.
 
 ### State Machine Breaking

diff --git a/docs/docs/02-apps/02-interchain-accounts/05-messages.md b/docs/docs/02-apps/02-interchain-accounts/05-messages.md
@@ -130,7 +130,7 @@ balanceQuery := banktypes.NewQueryBalanceRequest("cosmos1...", "uatom")
 queryBz, err := balanceQuery.Marshal()
 
 // signer of message must be the interchain account on the host
-queryMsg := icahosttypes.NewMsgModuleQuerySafe("cosmos2...", []*icahosttypes.QueryRequest{
+queryMsg := icahosttypes.NewMsgModuleQuerySafe("cosmos2...", []icahosttypes.QueryRequest{
   {
     Path: "/cosmos.bank.v1beta1.Query/Balance",
     Data: queryBz,

diff --git a/docs/docs/05-migrations/13-v8-to-v9.md b/docs/docs/05-migrations/13-v8-to-v9.md
@@ -95,6 +95,16 @@ func (k Keeper) RegisterInterchainAccount(
 ) error {
 ```
 
+The `requests` repeated field of `MsgModuleQuerySafe` has been marked non-nullable, and therefore the signature of the constructor function `NewMsgModuleQuerySafe` has been updated:
+
+```diff
+func NewMsgModuleQuerySafe(
+  signer string, 
+- requests []*QueryRequest,
++ requests []QueryRequest,
+) *MsgModuleQuerySafe {
+```
+
 ## Relayers
 
 - Renaming of event attribute keys in [#5603](https://github.com/cosmos/ibc-go/pull/5603).

diff --git a/e2e/tests/interchain_accounts/query_test.go b/e2e/tests/interchain_accounts/query_test.go
@@ -82,7 +82,7 @@ func (s *InterchainAccountsQueryTestSuite) TestInterchainAccountsQuery() {
 			queryBz, err := balanceQuery.Marshal()
 			s.Require().NoError(err)
 
-			queryMsg := icahosttypes.NewMsgModuleQuerySafe(hostAccount, []*icahosttypes.QueryRequest{
+			queryMsg := icahosttypes.NewMsgModuleQuerySafe(hostAccount, []icahosttypes.QueryRequest{
 				{
 					Path: "/cosmos.bank.v1beta1.Query/Balance",
 					Data: queryBz,

diff --git a/modules/apps/27-interchain-accounts/host/keeper/msg_server_test.go b/modules/apps/27-interchain-accounts/host/keeper/msg_server_test.go
@@ -32,7 +32,7 @@ func (suite *KeeperTestSuite) TestModuleQuerySafe() {
 					Data: balanceQueryBz,
 				}
 
-				msg = types.NewMsgModuleQuerySafe(suite.chainA.GetSimApp().ICAHostKeeper.GetAuthority(), []*types.QueryRequest{&queryReq})
+				msg = types.NewMsgModuleQuerySafe(suite.chainA.GetSimApp().ICAHostKeeper.GetAuthority(), []types.QueryRequest{queryReq})
 
 				balance := suite.chainA.GetSimApp().BankKeeper.GetBalance(suite.chainA.GetContext(), suite.chainA.SenderAccount.GetAddress(), sdk.DefaultBondDenom)
 
@@ -64,7 +64,7 @@ func (suite *KeeperTestSuite) TestModuleQuerySafe() {
 					Data: paramsQueryBz,
 				}
 
-				msg = types.NewMsgModuleQuerySafe(suite.chainA.GetSimApp().ICAHostKeeper.GetAuthority(), []*types.QueryRequest{&queryReq, &paramsQueryReq})
+				msg = types.NewMsgModuleQuerySafe(suite.chainA.GetSimApp().ICAHostKeeper.GetAuthority(), []types.QueryRequest{queryReq, paramsQueryReq})
 
 				balance := suite.chainA.GetSimApp().BankKeeper.GetBalance(suite.chainA.GetContext(), suite.chainA.SenderAccount.GetAddress(), sdk.DefaultBondDenom)
 
@@ -102,7 +102,7 @@ func (suite *KeeperTestSuite) TestModuleQuerySafe() {
 					Data: paramsQueryBz,
 				}
 
-				msg = types.NewMsgModuleQuerySafe(suite.chainA.GetSimApp().ICAHostKeeper.GetAuthority(), []*types.QueryRequest{&queryReq, &paramsQueryReq})
+				msg = types.NewMsgModuleQuerySafe(suite.chainA.GetSimApp().ICAHostKeeper.GetAuthority(), []types.QueryRequest{queryReq, paramsQueryReq})
 			},
 			ibcerrors.ErrInvalidRequest,
 		},
@@ -117,7 +117,7 @@ func (suite *KeeperTestSuite) TestModuleQuerySafe() {
 					Data: balanceQueryBz,
 				}
 
-				msg = types.NewMsgModuleQuerySafe(suite.chainA.GetSimApp().ICAHostKeeper.GetAuthority(), []*types.QueryRequest{&queryReq})
+				msg = types.NewMsgModuleQuerySafe(suite.chainA.GetSimApp().ICAHostKeeper.GetAuthority(), []types.QueryRequest{queryReq})
 			},
 			ibcerrors.ErrInvalidRequest,
 		},

diff --git a/modules/apps/27-interchain-accounts/host/keeper/relay_test.go b/modules/apps/27-interchain-accounts/host/keeper/relay_test.go
@@ -286,7 +286,7 @@ func (suite *KeeperTestSuite) TestOnRecvPacket() {
 				queryBz, err := balanceQuery.Marshal()
 				suite.Require().NoError(err)
 
-				msg := types.NewMsgModuleQuerySafe(interchainAccountAddr, []*types.QueryRequest{
+				msg := types.NewMsgModuleQuerySafe(interchainAccountAddr, []types.QueryRequest{
 					{
 						Path: "/cosmos.bank.v1beta1.Query/Balance",
 						Data: queryBz,

diff --git a/modules/apps/27-interchain-accounts/host/types/msgs.go b/modules/apps/27-interchain-accounts/host/types/msgs.go
@@ -35,7 +35,7 @@ func (msg MsgUpdateParams) ValidateBasic() error {
 }
 
 // NewMsgModuleQuerySafe creates a new MsgModuleQuerySafe instance
-func NewMsgModuleQuerySafe(signer string, requests []*QueryRequest) *MsgModuleQuerySafe {
+func NewMsgModuleQuerySafe(signer string, requests []QueryRequest) *MsgModuleQuerySafe {
 	return &MsgModuleQuerySafe{
 		Signer:   signer,
 		Requests: requests,

diff --git a/modules/apps/27-interchain-accounts/host/types/msgs_test.go b/modules/apps/27-interchain-accounts/host/types/msgs_test.go
@@ -77,7 +77,7 @@ func TestMsgUpdateParamsGetSigners(t *testing.T) {
 }
 
 func TestMsgModuleQuerySafeValidateBasic(t *testing.T) {
-	queryRequest := &types.QueryRequest{
+	queryRequest := types.QueryRequest{
 		Path: "/cosmos.bank.v1beta1.Query/Balance",
 		Data: []byte{},
 	}
@@ -89,17 +89,17 @@ func TestMsgModuleQuerySafeValidateBasic(t *testing.T) {
 	}{
 		{
 			"success: valid signer address",
-			types.NewMsgModuleQuerySafe(sdk.AccAddress(ibctesting.TestAccAddress).String(), []*types.QueryRequest{queryRequest}),
+			types.NewMsgModuleQuerySafe(sdk.AccAddress(ibctesting.TestAccAddress).String(), []types.QueryRequest{queryRequest}),
 			nil,
 		},
 		{
 			"failure: invalid signer address",
-			types.NewMsgModuleQuerySafe("signer", []*types.QueryRequest{queryRequest}),
+			types.NewMsgModuleQuerySafe("signer", []types.QueryRequest{queryRequest}),
 			ibcerrors.ErrInvalidAddress,
 		},
 		{
 			"failure: empty query requests",
-			types.NewMsgModuleQuerySafe(sdk.AccAddress(ibctesting.TestAccAddress).String(), []*types.QueryRequest{}),
+			types.NewMsgModuleQuerySafe(sdk.AccAddress(ibctesting.TestAccAddress).String(), []types.QueryRequest{}),
 			ibcerrors.ErrInvalidRequest,
 		},
 	}
@@ -135,7 +135,7 @@ func TestMsgModuleQuerySafeGetSigners(t *testing.T) {
 		tc := tc
 
 		t.Run(tc.name, func(t *testing.T) {
-			msg := types.NewMsgModuleQuerySafe(tc.address.String(), []*types.QueryRequest{})
+			msg := types.NewMsgModuleQuerySafe(tc.address.String(), []types.QueryRequest{})
 			encodingCfg := moduletestutil.MakeTestEncodingConfig(ica.AppModuleBasic{})
 			signers, _, err := encodingCfg.Codec.GetMsgV1Signers(msg)
 			if tc.expPass {

diff --git a/modules/apps/27-interchain-accounts/host/types/tx.pb.go b/modules/apps/27-interchain-accounts/host/types/tx.pb.go
diff --git a/proto/ibc/applications/interchain_accounts/host/v1/tx.proto b/proto/ibc/applications/interchain_accounts/host/v1/tx.proto
@@ -47,7 +47,7 @@ message MsgModuleQuerySafe {
   string signer = 1;
 
   // requests defines the module safe queries to execute.
-  repeated QueryRequest requests = 2;
+  repeated QueryRequest requests = 2 [(gogoproto.nullable) = false];
 }
 
 // MsgModuleQuerySafeResponse defines the response for Msg/ModuleQuerySafe