chore: rename authority to signer in MsgUpdateParams (#4486)

* chore: rename authority to signer * fix e2e * rename field * renamed variables and tests
cosmos · Aug 29, 2023 · 5916683 · 5916683
1 parent 674d832
commit 5916683
Show file tree

Hide file tree

Showing 31 changed files with 358 additions and 361 deletions.
diff --git a/docs/apps/transfer/params.md b/docs/apps/transfer/params.md
@@ -75,8 +75,8 @@ To change the parameter values, you must make a governance proposal that execute
 
 // MsgUpdateParams is the Msg/UpdateParams request type.
 message MsgUpdateParams {
-  // authority is the address that controls the module (defaults to x/gov unless overwritten).
-  string authority = 1;
+  // signer address (it may be the the address that controls the module, which defaults to x/gov unless overwritten).
+  string signer = 1;
 
   // params defines the transfer parameters to update.
   //

diff --git a/docs/ibc/light-clients/setup.md b/docs/ibc/light-clients/setup.md
@@ -115,7 +115,7 @@ where `proposal.json` contains:
   "messages": [
     {
       "@type": "/ibc.core.client.v1.MsgUpdateParams",
-      "authority": "cosmos1...", // The gov module account address
+      "signer": "cosmos1...", // The gov module account address
       "params": {
         "allowed_clients": ["06-solomachine", "07-tendermint", "0x-new-client"]
       }

diff --git a/e2e/tests/interchain_accounts/params_test.go b/e2e/tests/interchain_accounts/params_test.go
@@ -71,8 +71,8 @@ func (s *InterchainAccountsParamsTestSuite) TestControllerEnabledParam() {
 			s.Require().NotNil(authority)
 
 			msg := controllertypes.MsgUpdateParams{
-				Authority: authority.String(),
-				Params:    controllertypes.NewParams(false),
+				Signer: authority.String(),
+				Params: controllertypes.NewParams(false),
 			}
 			s.ExecuteGovProposalV1(ctx, &msg, chainA, controllerAccount, 1)
 		} else {
@@ -128,8 +128,8 @@ func (s *InterchainAccountsParamsTestSuite) TestHostEnabledParam() {
 			s.Require().NotNil(authority)
 
 			msg := hosttypes.MsgUpdateParams{
-				Authority: authority.String(),
-				Params:    hosttypes.NewParams(false, []string{hosttypes.AllowAllHostMsgs}),
+				Signer: authority.String(),
+				Params: hosttypes.NewParams(false, []string{hosttypes.AllowAllHostMsgs}),
 			}
 			s.ExecuteGovProposalV1(ctx, &msg, chainB, chainBUser, 1)
 		} else {

diff --git a/modules/apps/27-interchain-accounts/controller/keeper/msg_server.go b/modules/apps/27-interchain-accounts/controller/keeper/msg_server.go
@@ -75,8 +75,8 @@ func (s msgServer) SendTx(goCtx context.Context, msg *types.MsgSendTx) (*types.M
 
 // UpdateParams defines an rpc handler method for MsgUpdateParams. Updates the ica/controller submodule's parameters.
 func (k Keeper) UpdateParams(goCtx context.Context, msg *types.MsgUpdateParams) (*types.MsgUpdateParamsResponse, error) {
-	if k.GetAuthority() != msg.Authority {
-		return nil, errorsmod.Wrapf(ibcerrors.ErrUnauthorized, "expected %s, got %s", k.GetAuthority(), msg.Authority)
+	if k.GetAuthority() != msg.Signer {
+		return nil, errorsmod.Wrapf(ibcerrors.ErrUnauthorized, "expected %s, got %s", k.GetAuthority(), msg.Signer)
 	}
 
 	ctx := sdk.UnwrapSDKContext(goCtx)

diff --git a/modules/apps/27-interchain-accounts/controller/keeper/msg_server_test.go b/modules/apps/27-interchain-accounts/controller/keeper/msg_server_test.go
@@ -204,34 +204,34 @@ func (suite *KeeperTestSuite) TestSubmitTx() {
 
 // TestUpdateParams tests UpdateParams rpc handler
 func (suite *KeeperTestSuite) TestUpdateParams() {
-	validAuthority := suite.chainA.GetSimApp().TransferKeeper.GetAuthority()
+	signer := suite.chainA.GetSimApp().TransferKeeper.GetAuthority()
 	testCases := []struct {
 		name    string
 		msg     *types.MsgUpdateParams
 		expPass bool
 	}{
 		{
-			"success: valid authority and default params",
-			types.NewMsgUpdateParams(validAuthority, types.NewParams(!types.DefaultControllerEnabled)),
+			"success: valid signer and default params",
+			types.NewMsgUpdateParams(signer, types.NewParams(!types.DefaultControllerEnabled)),
 			true,
 		},
 		{
-			"failure: malformed authority address",
+			"failure: malformed signer address",
 			types.NewMsgUpdateParams(ibctesting.InvalidID, types.DefaultParams()),
 			false,
 		},
 		{
-			"failure: empty authority address",
+			"failure: empty signer address",
 			types.NewMsgUpdateParams("", types.DefaultParams()),
 			false,
 		},
 		{
-			"failure: whitespace authority address",
+			"failure: whitespace signer address",
 			types.NewMsgUpdateParams("    ", types.DefaultParams()),
 			false,
 		},
 		{
-			"failure: unauthorized authority address",
+			"failure: unauthorized signer address",
 			types.NewMsgUpdateParams(ibctesting.TestAccAddress, types.DefaultParams()),
 			false,
 		},

diff --git a/modules/apps/27-interchain-accounts/controller/types/msgs.go b/modules/apps/27-interchain-accounts/controller/types/msgs.go
@@ -92,16 +92,16 @@ func (msg MsgSendTx) GetSigners() []sdk.AccAddress {
 }
 
 // NewMsgUpdateParams creates a new MsgUpdateParams instance
-func NewMsgUpdateParams(authority string, params Params) *MsgUpdateParams {
+func NewMsgUpdateParams(signer string, params Params) *MsgUpdateParams {
 	return &MsgUpdateParams{
-		Authority: authority,
-		Params:    params,
+		Signer: signer,
+		Params: params,
 	}
 }
 
 // ValidateBasic implements sdk.Msg
 func (msg MsgUpdateParams) ValidateBasic() error {
-	_, err := sdk.AccAddressFromBech32(msg.Authority)
+	_, err := sdk.AccAddressFromBech32(msg.Signer)
 	if err != nil {
 		return errorsmod.Wrapf(ibcerrors.ErrInvalidAddress, "string could not be parsed as address: %v", err)
 	}
@@ -111,7 +111,7 @@ func (msg MsgUpdateParams) ValidateBasic() error {
 
 // GetSigners implements sdk.Msg
 func (msg MsgUpdateParams) GetSigners() []sdk.AccAddress {
-	accAddr, err := sdk.AccAddressFromBech32(msg.Authority)
+	accAddr, err := sdk.AccAddressFromBech32(msg.Signer)
 	if err != nil {
 		panic(err)
 	}

diff --git a/modules/apps/27-interchain-accounts/controller/types/msgs_test.go b/modules/apps/27-interchain-accounts/controller/types/msgs_test.go
@@ -203,9 +203,9 @@ func TestMsgUpdateParamsValidateBasic(t *testing.T) {
 		msg     *types.MsgUpdateParams
 		expPass bool
 	}{
-		{"success: valid authority and valid params", types.NewMsgUpdateParams(ibctesting.TestAccAddress, types.DefaultParams()), true},
-		{"failure: invalid authority with valid params", types.NewMsgUpdateParams("invalidAddress", types.DefaultParams()), false},
-		{"failure: empty authority with valid params", types.NewMsgUpdateParams("", types.DefaultParams()), false},
+		{"success: valid signer and valid params", types.NewMsgUpdateParams(ibctesting.TestAccAddress, types.DefaultParams()), true},
+		{"failure: invalid signer with valid params", types.NewMsgUpdateParams("invalidAddress", types.DefaultParams()), false},
+		{"failure: empty signer with valid params", types.NewMsgUpdateParams("", types.DefaultParams()), false},
 	}
 
 	for i, tc := range testCases {
@@ -231,8 +231,8 @@ func TestMsgUpdateParamsGetSigners(t *testing.T) {
 
 	for _, tc := range testCases {
 		msg := types.MsgUpdateParams{
-			Authority: tc.address.String(),
-			Params:    types.DefaultParams(),
+			Signer: tc.address.String(),
+			Params: types.DefaultParams(),
 		}
 		if tc.expPass {
 			require.Equal(t, []sdk.AccAddress{tc.address}, msg.GetSigners())

diff --git a/modules/apps/27-interchain-accounts/controller/types/tx.pb.go b/modules/apps/27-interchain-accounts/controller/types/tx.pb.go
diff --git a/modules/apps/27-interchain-accounts/host/keeper/msg_server.go b/modules/apps/27-interchain-accounts/host/keeper/msg_server.go
@@ -25,8 +25,8 @@ func NewMsgServerImpl(keeper *Keeper) types.MsgServer {
 
 // UpdateParams updates the host submodule's params.
 func (m msgServer) UpdateParams(goCtx context.Context, msg *types.MsgUpdateParams) (*types.MsgUpdateParamsResponse, error) {
-	if m.authority != msg.Authority {
-		return nil, errorsmod.Wrapf(ibcerrors.ErrUnauthorized, "expected %s, got %s", m.authority, msg.Authority)
+	if m.GetAuthority() != msg.Signer {
+		return nil, errorsmod.Wrapf(ibcerrors.ErrUnauthorized, "expected %s, got %s", m.GetAuthority(), msg.Signer)
 	}
 
 	ctx := sdk.UnwrapSDKContext(goCtx)

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
@@ -17,8 +17,8 @@ func (suite *KeeperTestSuite) TestUpdateParams() {
 			true,
 		},
 		{
-			"invalid authority address",
-			types.NewMsgUpdateParams("authority", types.DefaultParams()),
+			"invalid signer address",
+			types.NewMsgUpdateParams("signer", types.DefaultParams()),
 			false,
 		},
 	}

diff --git a/modules/apps/27-interchain-accounts/host/types/msgs.go b/modules/apps/27-interchain-accounts/host/types/msgs.go
@@ -11,16 +11,16 @@ import (
 var _ sdk.Msg = (*MsgUpdateParams)(nil)
 
 // NewMsgUpdateParams creates a new MsgUpdateParams instance
-func NewMsgUpdateParams(authority string, params Params) *MsgUpdateParams {
+func NewMsgUpdateParams(signer string, params Params) *MsgUpdateParams {
 	return &MsgUpdateParams{
-		Authority: authority,
-		Params:    params,
+		Signer: signer,
+		Params: params,
 	}
 }
 
 // ValidateBasic implements sdk.Msg
 func (msg MsgUpdateParams) ValidateBasic() error {
-	_, err := sdk.AccAddressFromBech32(msg.Authority)
+	_, err := sdk.AccAddressFromBech32(msg.Signer)
 	if err != nil {
 		return errorsmod.Wrapf(ibcerrors.ErrInvalidAddress, "string could not be parsed as address: %v", err)
 	}
@@ -30,7 +30,7 @@ func (msg MsgUpdateParams) ValidateBasic() error {
 
 // GetSigners implements sdk.Msg
 func (msg MsgUpdateParams) GetSigners() []sdk.AccAddress {
-	accAddr, err := sdk.AccAddressFromBech32(msg.Authority)
+	accAddr, err := sdk.AccAddressFromBech32(msg.Signer)
 	if err != nil {
 		panic(err)
 	}

diff --git a/modules/apps/27-interchain-accounts/host/types/msgs_test.go b/modules/apps/27-interchain-accounts/host/types/msgs_test.go
@@ -18,18 +18,18 @@ func TestMsgUpdateParamsValidateBasic(t *testing.T) {
 		expPass bool
 	}{
 		{
-			"success: valid authority address",
+			"success: valid signer address",
 			types.NewMsgUpdateParams(sdk.AccAddress(ibctesting.TestAccAddress).String(), types.DefaultParams()),
 			true,
 		},
 		{
-			"failure: invalid authority address",
-			types.NewMsgUpdateParams("authority", types.DefaultParams()),
+			"failure: invalid signer address",
+			types.NewMsgUpdateParams("signer", types.DefaultParams()),
 			false,
 		},
 		{
 			"failure: invalid allowed message",
-			types.NewMsgUpdateParams("authority", types.Params{
+			types.NewMsgUpdateParams("signer", types.Params{
 				AllowMessages: []string{""},
 			}),
 			false,