feat(consensus): add consensus message (#19483)

Co-authored-by: Likhita Polavarapu <78951027+likhita-809@users.noreply.github.com>

CHANGELOG.md

@@ -53,6 +53,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i
 * (types) [#18768](https://github.com/cosmos/cosmos-sdk/pull/18768) Add MustValAddressFromBech32 function.
 * (gRPC) [#19049](https://github.com/cosmos/cosmos-sdk/pull/19049) Add debug log prints for each gRPC request.
 * (server) [#19280](https://github.com/cosmos/cosmos-sdk/pull/19280) Adds in-place testnet CLI command.
+* (x/consensus) [#19483](https://github.com/cosmos/cosmos-sdk/pull/19483) Add consensus messages registration to consensus module.
 
 ### Improvements
 

proto/cosmos/consensus/v1/consensus.proto

@@ -0,0 +1,23 @@
+// Since: cosmos-sdk 0.51
+syntax = "proto3";
+package cosmos.consensus.v1;
+
+import "tendermint/types/params.proto";
+
+option go_package = "github.com/cosmos/cosmos-sdk/x/consensus/types";
+
+// ConsensusMsgParams is the Msg/Params request type. This is a consensus message that is sent from cometbft.
+message ConsensusMsgParams {
+  // params defines the x/consensus parameters to be passed from comet.
+  //
+  // NOTE: All parameters must be supplied.
+  tendermint.types.VersionParams   version   = 1;
+  tendermint.types.BlockParams     block     = 2;
+  tendermint.types.EvidenceParams  evidence  = 3;
+  tendermint.types.ValidatorParams validator = 4;
+  tendermint.types.ABCIParams      abci      = 5;
+}
+
+// ConsensusMsgParamsResponse defines the response structure for executing a
+// ConsensusMsgParams message.
+message ConsensusMsgParamsResponse {}

x/consensus/README.md

@@ -4,4 +4,72 @@ sidebar_position: 1
 
 # `x/consensus`
 
+## Abstract 
+
 Functionality to modify CometBFT's ABCI consensus params.
+
+## Contents
+
+* [State](#state)
+* [Params](#params)
+* [Keepers](#keepers)
+* [Messages](#messages)
+* [Consensus Messages](#consensus-messages)
+* [Events](#events)
+    * [Message Events](#message-events)
+
+
+## State
+
+The `x/consensus` module keeps state of the consensus params from cometbft.:
+
+## Params
+
+The consensus module stores it's params in state with the prefix of `0x05`,
+it can be updated with governance or the address with authority.
+
+* Params: `0x05 | ProtocolBuffer(cometbft.ConsensusParams)`
+
+```protobuf reference
+https://github.com/cosmos/cosmos-sdk/blob/381de6452693a9338371223c232fba0c42773a4b/proto/cosmos/consensus/v1/consensus.proto#L11-L18
+```
+
+## Keepers
+
+The consensus module provides methods to Set and Get consensus params. It is recommended to use the `x/consensus` module keeper to get consensus params instead of accessing them through the context.
+
+## Messages
+
+### UpdateParams
+
+Update consensus params.
+
+```protobuf reference
+https://github.com/cosmos/cosmos-sdk/blob/381de6452693a9338371223c232fba0c42773a4b/proto/cosmos/consensus/v1/tx.proto#L12-L47
+```
+
+The message will fail under the following conditions:
+
+* The signer is not the set authority 
+* Not all values are set
+
+## Consensus Messages
+
+The consensus module has a consensus message that is used to set the consensus params when the chain initializes. It is similar to the `UpdateParams` message but it is only used once at the start of the chain.
+
+```protobuf reference
+https://github.com/cosmos/cosmos-sdk/blob/381de6452693a9338371223c232fba0c42773a4b/proto/cosmos/consensus/v1/consensus.proto#L9-L24
+```
+
+## Events
+
+The consensus module emits the following events:
+
+### Message Events
+
+#### MsgUpdateParams
+
+| Type   | Attribute Key | Attribute Value     |
+|--------|---------------|---------------------|
+| string | authority     | msg.Signer          |
+| string | parameters    | consensus Parmeters |

x/consensus/keeper/keeper.go

@@ -86,3 +86,21 @@ func (k Keeper) UpdateParams(ctx context.Context, msg *types.MsgUpdateParams) (*
 
 	return &types.MsgUpdateParamsResponse{}, nil
 }
+
+// SetParams sets the consensus parameters on init of a chain. This is a consensus message. It can only be called by the consensus server
+// This is used in the consensus message handler set in module.go.
+func (k Keeper) SetParams(ctx context.Context, req *types.ConsensusMsgParams) (*types.ConsensusMsgParamsResponse, error) {
+	consensusParams, err := req.ToProtoConsensusParams()
+	if err != nil {
+		return nil, err
+	}
+	if err := cmttypes.ConsensusParamsFromProto(consensusParams).ValidateBasic(); err != nil {
+		return nil, err
+	}
+
+	if err := k.ParamsStore.Set(ctx, consensusParams); err != nil {
+		return nil, err
+	}
+
+	return &types.ConsensusMsgParamsResponse{}, nil
+}

x/consensus/keeper/keeper_test.go

@@ -69,6 +69,7 @@ func (s *KeeperTestSuite) TestGRPCQueryConsensusParams() {
 					Block:     defaultConsensusParams.Block,
 					Validator: defaultConsensusParams.Validator,
 					Evidence:  defaultConsensusParams.Evidence,
+					Abci:      defaultConsensusParams.Abci,
 				}
 				_, err := s.consensusParamsKeeper.UpdateParams(s.ctx, input)
 				s.Require().NoError(err)
@@ -79,6 +80,7 @@ func (s *KeeperTestSuite) TestGRPCQueryConsensusParams() {
 					Validator: defaultConsensusParams.Validator,
 					Evidence:  defaultConsensusParams.Evidence,
 					Version:   defaultConsensusParams.Version,
+					Abci:      defaultConsensusParams.Abci,
 				},
 			},
 			true,
@@ -150,6 +152,7 @@ func (s *KeeperTestSuite) TestUpdateParams() {
 				Block:     defaultConsensusParams.Block,
 				Validator: defaultConsensusParams.Validator,
 				Evidence:  defaultConsensusParams.Evidence,
+				Abci:      defaultConsensusParams.Abci,
 			},
 			expErr:    false,
 			expErrMsg: "",
@@ -161,6 +164,7 @@ func (s *KeeperTestSuite) TestUpdateParams() {
 				Block:     &cmtproto.BlockParams{MaxGas: -10, MaxBytes: -10},
 				Validator: defaultConsensusParams.Validator,
 				Evidence:  defaultConsensusParams.Evidence,
+				Abci:      defaultConsensusParams.Abci,
 			},
 			expErr:    true,
 			expErrMsg: "block.MaxBytes must be -1 or greater than 0. Got -10",
@@ -172,6 +176,7 @@ func (s *KeeperTestSuite) TestUpdateParams() {
 				Block:     defaultConsensusParams.Block,
 				Validator: defaultConsensusParams.Validator,
 				Evidence:  defaultConsensusParams.Evidence,
+				Abci:      defaultConsensusParams.Abci,
 			},
 			expErr:    true,
 			expErrMsg: "invalid authority",
@@ -183,6 +188,7 @@ func (s *KeeperTestSuite) TestUpdateParams() {
 				Block:     defaultConsensusParams.Block,
 				Validator: defaultConsensusParams.Validator,
 				Evidence:  nil,
+				Abci:      defaultConsensusParams.Abci,
 			},
 			expErr:    true,
 			expErrMsg: "all parameters must be present",
@@ -194,6 +200,7 @@ func (s *KeeperTestSuite) TestUpdateParams() {
 				Block:     nil,
 				Validator: defaultConsensusParams.Validator,
 				Evidence:  defaultConsensusParams.Evidence,
+				Abci:      defaultConsensusParams.Abci,
 			},
 			expErr:    true,
 			expErrMsg: "all parameters must be present",
@@ -205,6 +212,7 @@ func (s *KeeperTestSuite) TestUpdateParams() {
 				Block:     defaultConsensusParams.Block,
 				Validator: nil,
 				Evidence:  defaultConsensusParams.Evidence,
+				Abci:      defaultConsensusParams.Abci,
 			},
 			expErr:    true,
 			expErrMsg: "all parameters must be present",
@@ -233,3 +241,109 @@ func (s *KeeperTestSuite) TestUpdateParams() {
 		})
 	}
 }
+
+func (s *KeeperTestSuite) TestSetParams() {
+	defaultConsensusParams := cmttypes.DefaultConsensusParams().ToProto()
+	testCases := []struct {
+		name      string
+		input     *types.ConsensusMsgParams
+		expErr    bool
+		expErrMsg string
+	}{
+		{
+			name: "valid params",
+			input: &types.ConsensusMsgParams{
+				Abci:      defaultConsensusParams.Abci,
+				Version:   &cmtproto.VersionParams{App: 1},
+				Block:     defaultConsensusParams.Block,
+				Validator: defaultConsensusParams.Validator,
+				Evidence:  defaultConsensusParams.Evidence,
+			},
+			expErr:    false,
+			expErrMsg: "",
+		},
+		{
+			name: "invalid  params",
+			input: &types.ConsensusMsgParams{
+				Abci:      defaultConsensusParams.Abci,
+				Version:   &cmtproto.VersionParams{App: 1},
+				Block:     &cmtproto.BlockParams{MaxGas: -10, MaxBytes: -10},
+				Validator: defaultConsensusParams.Validator,
+				Evidence:  defaultConsensusParams.Evidence,
+			},
+			expErr:    true,
+			expErrMsg: "block.MaxBytes must be -1 or greater than 0. Got -10",
+		},
+		{
+			name: "nil version params",
+			input: &types.ConsensusMsgParams{
+				Abci:      defaultConsensusParams.Abci,
+				Version:   nil,
+				Block:     defaultConsensusParams.Block,
+				Validator: defaultConsensusParams.Validator,
+				Evidence:  defaultConsensusParams.Evidence,
+			},
+			expErr:    true,
+			expErrMsg: "all parameters must be present",
+		},
+		{
+			name: "nil evidence params",
+			input: &types.ConsensusMsgParams{
+				Abci:      defaultConsensusParams.Abci,
+				Version:   &cmtproto.VersionParams{App: 1},
+				Block:     defaultConsensusParams.Block,
+				Validator: defaultConsensusParams.Validator,
+				Evidence:  nil,
+			},
+			expErr:    true,
+			expErrMsg: "all parameters must be present",
+		},
+		{
+			name: "nil block params",
+			input: &types.ConsensusMsgParams{
+				Abci:      defaultConsensusParams.Abci,
+				Version:   &cmtproto.VersionParams{App: 1},
+				Block:     nil,
+				Validator: defaultConsensusParams.Validator,
+				Evidence:  defaultConsensusParams.Evidence,
+			},
+			expErr:    true,
+			expErrMsg: "all parameters must be present",
+		},
+		{
+			name: "nil validator params",
+			input: &types.ConsensusMsgParams{
+				Abci:      defaultConsensusParams.Abci,
+				Version:   &cmtproto.VersionParams{App: 1},
+				Block:     defaultConsensusParams.Block,
+				Validator: nil,
+				Evidence:  defaultConsensusParams.Evidence,
+			},
+			expErr:    true,
+			expErrMsg: "all parameters must be present",
+		},
+	}
+
+	for _, tc := range testCases {
+		tc := tc
+		s.Run(tc.name, func() {
+			s.SetupTest()
+			_, err := s.consensusParamsKeeper.SetParams(s.ctx, tc.input)
+			if tc.expErr {
+				s.Require().Error(err)
+				s.Require().Contains(err.Error(), tc.expErrMsg)
+			} else {
+				s.Require().NoError(err)
+
+				res, err := s.consensusParamsKeeper.Params(s.ctx, &types.QueryParamsRequest{})
+				s.Require().NoError(err)
+
+				s.Require().Equal(tc.input.Abci, res.Params.Abci)
+				s.Require().Equal(tc.input.Block, res.Params.Block)
+				s.Require().Equal(tc.input.Evidence, res.Params.Evidence)
+				s.Require().Equal(tc.input.Validator, res.Params.Validator)
+				s.Require().Equal(tc.input.Version, res.Params.Version)
+			}
+		})
+	}
+}

x/consensus/module.go

@@ -74,3 +74,8 @@ func (am AppModule) RegisterServices(registrar grpc.ServiceRegistrar) error {
 
 // ConsensusVersion implements HasConsensusVersion.
 func (AppModule) ConsensusVersion() uint64 { return ConsensusVersion }
+
+// RegisterConsensusMessages registers the consensus module's messages.
+func (am AppModule) RegisterConsensusMessages(builder any) {
+	// std.RegisterConsensusHandler(builder ,am.keeper.SetParams) // TODO uncomment when api is available
+}

x/consensus/types/consensus.go

@@ -0,0 +1,42 @@
+package types
+
+import (
+	"errors"
+
+	cmtproto "github.com/cometbft/cometbft/proto/tendermint/types"
+	cmttypes "github.com/cometbft/cometbft/types"
+)
+
+func (msg ConsensusMsgParams) ToProtoConsensusParams() (cmtproto.ConsensusParams, error) {
+	if msg.Evidence == nil || msg.Block == nil || msg.Validator == nil || msg.Version == nil {
+		return cmtproto.ConsensusParams{}, errors.New("all parameters must be present")
+	}
+
+	cp := cmtproto.ConsensusParams{
+		Block: &cmtproto.BlockParams{
+			MaxBytes: msg.Block.MaxBytes,
+			MaxGas:   msg.Block.MaxGas,
+		},
+		Evidence: &cmtproto.EvidenceParams{
+			MaxAgeNumBlocks: msg.Evidence.MaxAgeNumBlocks,
+			MaxAgeDuration:  msg.Evidence.MaxAgeDuration,
+			MaxBytes:        msg.Evidence.MaxBytes,
+		},
+		Validator: &cmtproto.ValidatorParams{
+			PubKeyTypes: msg.Validator.PubKeyTypes,
+		},
+		Version: cmttypes.DefaultConsensusParams().ToProto().Version, // Version is stored in x/upgrade
+	}
+
+	if msg.Abci != nil {
+		cp.Abci = &cmtproto.ABCIParams{
+			VoteExtensionsEnableHeight: msg.Abci.VoteExtensionsEnableHeight,
+		}
+	}
+
+	if msg.Version != nil {
+		cp.Version.App = msg.Version.App
+	}
+
+	return cp, nil
+}