History

Julien Robert 22fb753099 build(deps): bump proto-builder and regen protos (#21215 )		2024-08-08 08:45:15 +00:00
..
exported	refactor! : bump comet to v1 (#19726 )	2024-05-06 14:12:00 +00:00
keeper	refactor: remove comet info from consensus as it will be stored in context for v2 (#21120 )	2024-07-31 20:21:23 +00:00
proto	refactor: remove comet info from consensus as it will be stored in context for v2 (#21120 )	2024-07-31 20:21:23 +00:00
types	build(deps): bump proto-builder and regen protos (#21215 )	2024-08-08 08:45:15 +00:00
autocli.go	feat(client/v2): support gov proposals (#18461 )	2023-11-15 11:16:25 +00:00
CHANGELOG.md	chore(consensus): add cometInfo to consensus (#20615 )	2024-06-13 14:52:56 +00:00
depinject.go	chore: remove auth from consensus (#20839 )	2024-07-02 12:36:21 +00:00
go.mod	build(deps): Bump cosmossdk.io/log from 1.3.1 to 1.4.0 (#21205 )	2024-08-08 05:51:07 +00:00
go.sum	build(deps): Bump cosmossdk.io/log from 1.3.1 to 1.4.0 (#21205 )	2024-08-08 05:51:07 +00:00
module.go	refactor(core,types,runtime,x): make HasName not mandatory (#20984 )	2024-07-19 08:58:47 +00:00
README.md	chore: fix spelling errors (#19545 )	2024-02-24 15:30:31 +00:00
sonar-project.properties	chore: force reload sonar cloud (#20480 )	2024-05-29 11:12:09 +00:00

README.md

sidebar_position
1

`x/consensus`

Abstract

Functionality to modify CometBFT's ABCI consensus params.

State
Params
Keepers
Messages
Consensus Messages
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)

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.

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.

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 Parameters