cosmos-sdk/x/consensus
dependabot[bot] 3bb9528e59
build(deps): Bump github.com/prometheus/common from 0.57.0 to 0.58.0 (#21532)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
2024-09-04 07:53:53 +00:00
..
exported refactor(x/consensus): audit QA v0.52 (#21416) 2024-08-27 11:22:47 +00:00
keeper docs(core): add core documentation and principles (#21511) 2024-09-03 22:20:05 +00:00
proto refactor: remove consensus messages (#21248) 2024-08-12 14:19:13 +00:00
types refactor(x/consensus): audit QA v0.52 (#21416) 2024-08-27 11:22:47 +00:00
autocli.go refactor(cli): Standardize Use field convention and update readme (#21369) 2024-08-21 08:36:34 +00:00
CHANGELOG.md refactor(x/consensus): audit QA (#21151) 2024-08-09 15:20:42 +00:00
depinject.go chore: remove auth from consensus (#20839) 2024-07-02 12:36:21 +00:00
go.mod build(deps): Bump github.com/prometheus/common from 0.57.0 to 0.58.0 (#21532) 2024-09-04 07:53:53 +00:00
go.sum build(deps): Bump github.com/prometheus/common from 0.57.0 to 0.58.0 (#21532) 2024-09-04 07:53:53 +00:00
module.go refactor: remove consensus messages (#21248) 2024-08-12 14:19:13 +00:00
README.md refactor(x/consensus): audit QA v0.52 (#21416) 2024-08-27 11:22:47 +00:00
sonar-project.properties chore: force reload sonar cloud (#20480) 2024-05-29 11:12:09 +00:00

sidebar_position
1

x/consensus

Abstract

Functionality to modify CometBFT's ABCI consensus params.

Contents

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/release/v0.52.x/x/consensus/proto/cosmos/consensus/v1/consensus.proto#L9-L15

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/release/v0.52.x/x/consensus/proto/cosmos/consensus/v1/tx.proto#L23-L44

The message will fail under the following conditions:

  • The signer is not the set authority
  • Not all values are set

Events

The consensus module emits the following events:

Message Events

MsgUpdateParams

Type Attribute Key Attribute Value
string authority msg.Signer
string parameters consensus Parameters