package cometbft.types.v1

Get desktop application:
View/edit binary Protocol Buffers messages

ABCIParams is deprecated and its contents moved to FeatureParams

Used in: ConsensusParams

• int64 vote_extensions_enable_height = 1

  vote_extensions_enable_height has been deprecated. Instead, use FeatureParams.vote_extensions_enable_height.

Block defines the structure of a block in the CometBFT blockchain.

Used in: blocksync.v1.BlockResponse, services.block.v1.GetByHeightResponse

• optional Header header = 1

• optional Data data = 2

• optional EvidenceList evidence = 3

• optional Commit last_commit = 4

BlockID defines the unique ID of a block as its hash and its `PartSetHeader`.

Used in: consensus.v1.VoteSetBits, consensus.v1.VoteSetMaj23, services.block.v1.GetByHeightResponse, state.v1.State, BlockMeta, Commit, ExtendedCommit, Header, Proposal, Vote

• bytes hash = 1

• optional PartSetHeader part_set_header = 2

BlockIdFlag indicates which BlockID the signature is for

Used in: abci.v1.ExtendedVoteInfo, abci.v1.VoteInfo, CommitSig, ExtendedCommitSig

• BLOCK_ID_FLAG_UNKNOWN = 0

  Indicates an error condition

• BLOCK_ID_FLAG_ABSENT = 1

  The vote was not received

• BLOCK_ID_FLAG_COMMIT = 2

  Voted for the block that received the majority

• BLOCK_ID_FLAG_NIL = 3

  Voted for nil

BlockMeta contains meta information about a block.

• optional BlockID block_id = 1

• int64 block_size = 2

• optional Header header = 3

• int64 num_txs = 4

BlockParams define limits on the block size and gas.

Used in: ConsensusParams

• int64 max_bytes = 1

  Maximum size of a block, in bytes. Must be greater or equal to -1 and cannot be greater than the hard-coded maximum block size, which is 100MB. If set to -1, the limit is the hard-coded maximum block size.

• int64 max_gas = 2

  Maximum gas wanted by transactions included in a block. Must be greater or equal to -1. If set to -1, no limit is enforced.

CanonicalBlockID is a canonical representation of a BlockID, which gets serialized and signed.

Used in: CanonicalProposal, CanonicalVote

• bytes hash = 1

• optional CanonicalPartSetHeader part_set_header = 2

CanonicalPartSetHeader is a canonical representation of a PartSetHeader, which gets serialized and signed.

Used in: CanonicalBlockID

• uint32 total = 1

• bytes hash = 2

CanonicalProposal is a canonical representation of a Proposal, which gets serialized and signed.

• SignedMsgType type = 1

  type alias for byte

• sfixed64 height = 2

  canonicalization requires fixed size encoding here

• sfixed64 round = 3

  canonicalization requires fixed size encoding here

• int64 pol_round = 4

• optional CanonicalBlockID block_id = 5

• optional google.protobuf.Timestamp timestamp = 6

• string chain_id = 7

CanonicalVote is a canonical representation of a Vote, which gets serialized and signed.

• SignedMsgType type = 1

  type alias for byte

• sfixed64 height = 2

  canonicalization requires fixed size encoding here

• sfixed64 round = 3

  canonicalization requires fixed size encoding here

• optional CanonicalBlockID block_id = 4

• optional google.protobuf.Timestamp timestamp = 5

• string chain_id = 6

CanonicalVoteExtension provides us a way to serialize a vote extension from a particular validator such that we can sign over those serialized bytes.

• bytes extension = 1

• sfixed64 height = 2

• sfixed64 round = 3

• string chain_id = 4

Commit contains the evidence that a block was committed by a set of validators.

Used in: Block, SignedHeader

• int64 height = 1

• int32 round = 2

• optional BlockID block_id = 3

• repeated CommitSig signatures = 4

CommitSig is a part of the Vote included in a Commit.

Used in: Commit

• BlockIDFlag block_id_flag = 1

• bytes validator_address = 2

• optional google.protobuf.Timestamp timestamp = 3

• bytes signature = 4

ConsensusParams contains consensus critical parameters that determine the validity of blocks.

Used in: abci.v1.FinalizeBlockResponse, abci.v1.InitChainRequest, abci.v1.InitChainResponse, abci.v1beta3.RequestInitChain, abci.v1beta3.ResponseFinalizeBlock, abci.v1beta3.ResponseInitChain, services.block_results.v1.GetBlockResultsResponse, state.v1.ConsensusParamsInfo, state.v1.ResponseEndBlock, state.v1.State, state.v1beta3.ConsensusParamsInfo, state.v1beta3.ResponseEndBlock, state.v1beta3.State

• optional BlockParams block = 1

• optional EvidenceParams evidence = 2

• optional ValidatorParams validator = 3

• optional VersionParams version = 4

• optional ABCIParams abci = 5

  Use FeatureParams.vote_extensions_enable_height instead

• optional SynchronyParams synchrony = 6

• optional FeatureParams feature = 7

Data contains the set of transactions included in the block

Used in: Block

• repeated bytes txs = 1

  Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid. We're just agreeing on the order first. This means that block.AppHash does not include these txs.

DuplicateVoteEvidence contains evidence of a validator signed two conflicting votes.

Used in: Evidence

• optional Vote vote_a = 1

• optional Vote vote_b = 2

• int64 total_voting_power = 3

• int64 validator_power = 4

• optional google.protobuf.Timestamp timestamp = 5

EventDataRoundState is emitted with each new round step.

Used in: consensus.v1.WALMessage

• int64 height = 1

• int32 round = 2

• string step = 3

Evidence is a generic type for wrapping evidence of misbehavior by a validator.

Used in: EvidenceList

• oneof sum

  The type of evidence.

  • DuplicateVoteEvidence duplicate_vote_evidence = 1

  • LightClientAttackEvidence light_client_attack_evidence = 2

EvidenceList is a list of evidence.

Used in: Block

• repeated Evidence evidence = 1

EvidenceParams determine the validity of evidences of Byzantine behavior.

Used in: ConsensusParams

• int64 max_age_num_blocks = 1

  Maximum age of evidence, in blocks. The recommended formula for calculating it is max_age_duration / {average block time}.

• optional google.protobuf.Duration max_age_duration = 2

  Maximum age of evidence, in time. The recommended value of is should correspond to the application's "unbonding period" or other similar mechanism for handling Nothing-At-Stake attacks. See: https://github.com/ethereum/wiki/wiki/Proof-of-Stake-FAQ#what-is-the-nothing-at-stake-problem-and-how-can-it-be-fixed.

• int64 max_bytes = 3

  Maximum size in bytes of evidence allowed to be included in a block. It should fall comfortably under the maximum size of a block.

ExtendedCommit is a Commit with ExtendedCommitSig.

Used in: blocksync.v1.BlockResponse

• int64 height = 1

• int32 round = 2

• optional BlockID block_id = 3

• repeated ExtendedCommitSig extended_signatures = 4

ExtendedCommitSig retains all the same fields as CommitSig but adds vote extension-related fields. We use two signatures to ensure backwards compatibility. That is the digest of the original signature is still the same in prior versions

Used in: ExtendedCommit

• BlockIDFlag block_id_flag = 1

• bytes validator_address = 2

• optional google.protobuf.Timestamp timestamp = 3

• bytes signature = 4

• bytes extension = 5

  Vote extension data

• bytes extension_signature = 6

  Vote extension signature

FeatureParams configure the height from which features of CometBFT are enabled.

Used in: ConsensusParams

• optional google.protobuf.Int64Value vote_extensions_enable_height = 1

  First height during which vote extensions will be enabled. During the specified height, and for all subsequent heights, precommit messages that do not contain valid extension data will be considered invalid. Prior to this height, or when this height is set to 0, vote extensions will not be used or accepted by validators on the network. Once enabled, vote extensions will be created by the application in ExtendVote, validated by the application in VerifyVoteExtension, and used by the application in PrepareProposal, when proposing the next block. Cannot be set to heights lower or equal to the current blockchain height.

• optional google.protobuf.Int64Value pbts_enable_height = 2

  Height at which Proposer-Based Timestamps (PBTS) will be enabled. From the specified height, and for all subsequent heights, the PBTS algorithm will be used to produce and validate block timestamps. Prior to this height, or when this height is set to 0, the legacy BFT Time algorithm is used to produce and validate timestamps. Cannot be set to heights lower or equal to the current blockchain height.

HashedParams is a subset of ConsensusParams. It is hashed into the Header.ConsensusHash.

• int64 block_max_bytes = 1

• int64 block_max_gas = 2

Header defines the structure of a block header.

Used in: Block, BlockMeta, SignedHeader

• optional version.v1.Consensus version = 1

  basic block info

• string chain_id = 2

• int64 height = 3

• optional google.protobuf.Timestamp time = 4

• optional BlockID last_block_id = 5

  prev block info

• bytes last_commit_hash = 6

  hashes of block data

  commit from validators from the last block

• bytes data_hash = 7

  transactions

• bytes validators_hash = 8

  hashes from the app output from the prev block

  validators for the current block

• bytes next_validators_hash = 9

  validators for the next block

• bytes consensus_hash = 10

  consensus params for current block

• bytes app_hash = 11

  state after txs from the previous block

• bytes last_results_hash = 12

  root hash of all results from the txs from the previous block

• bytes evidence_hash = 13

  consensus info

  evidence included in the block

• bytes proposer_address = 14

  original proposer of the block

LightBlock is a combination of SignedHeader and ValidatorSet. It is used by light clients.

Used in: LightClientAttackEvidence

• optional SignedHeader signed_header = 1

• optional ValidatorSet validator_set = 2

LightClientAttackEvidence contains evidence of a set of validators attempting to mislead a light client.

Used in: Evidence

• optional LightBlock conflicting_block = 1

• int64 common_height = 2

• repeated Validator byzantine_validators = 3

• int64 total_voting_power = 4

• optional google.protobuf.Timestamp timestamp = 5

Part of the block.

Used in: consensus.v1.BlockPart

• uint32 index = 1

• bytes bytes = 2

• optional crypto.v1.Proof proof = 3

Header of the parts set for a block.

Used in: consensus.v1.NewValidBlock, BlockID

• uint32 total = 1

• bytes hash = 2

Block proposal.

Used in: consensus.v1.Proposal, privval.v1.SignProposalRequest, privval.v1.SignedProposalResponse, privval.v1beta2.SignProposalRequest, privval.v1beta2.SignedProposalResponse

• SignedMsgType type = 1

• int64 height = 2

• int32 round = 3

• int32 pol_round = 4

• optional BlockID block_id = 5

• optional google.protobuf.Timestamp timestamp = 6

• bytes signature = 7

SignedHeader contains a Header(H) and Commit(H+1) with signatures of validators who signed it.

Used in: LightBlock

• optional Header header = 1

• optional Commit commit = 2

SignedMsgType is a type of signed message in the consensus.

Used in: consensus.v1.HasVote, consensus.v1.VoteSetBits, consensus.v1.VoteSetMaj23, CanonicalProposal, CanonicalVote, Proposal, Vote

• SIGNED_MSG_TYPE_UNKNOWN = 0

  Unknown

• SIGNED_MSG_TYPE_PREVOTE = 1

  Prevote

• SIGNED_MSG_TYPE_PRECOMMIT = 2

  Precommit

• SIGNED_MSG_TYPE_PROPOSAL = 32

  Proposal

SimpleValidator is a Validator, which is serialized and hashed in consensus. Address is removed because it's redundant with the pubkey. Proposer priority is removed because it changes every round.

• optional crypto.v1.PublicKey pub_key = 1

• int64 voting_power = 2

SynchronyParams determine the validity of block timestamps. These parameters are part of the Proposer-Based Timestamps (PBTS) algorithm. For more information on the relationship of the synchrony parameters to block timestamps validity, refer to the PBTS specification: https://github.com/tendermint/spec/blob/master/spec/consensus/proposer-based-timestamp/README.md

Used in: ConsensusParams

• optional google.protobuf.Duration precision = 1

  Bound for how skewed a proposer's clock may be from any validator on the network while still producing valid proposals.

• optional google.protobuf.Duration message_delay = 2

  Bound for how long a proposal message may take to reach all validators on a network and still be considered valid.

TxProof represents a Merkle proof of the presence of a transaction in the Merkle tree.

• bytes root_hash = 1

• bytes data = 2

• optional crypto.v1.Proof proof = 3

Validator represents a node participating in the consensus protocol.

Used in: LightClientAttackEvidence, ValidatorSet

• bytes address = 1

• optional crypto.v1.PublicKey pub_key = 2

• int64 voting_power = 3

• int64 proposer_priority = 4

ValidatorParams restrict the public key types validators can use. NOTE: uses ABCI public keys naming, not Amino names.

Used in: ConsensusParams

• repeated string pub_key_types = 1

ValidatorSet defines a set of validators.

Used in: state.v1.State, state.v1.ValidatorsInfo, LightBlock

• repeated Validator validators = 1

• optional Validator proposer = 2

• int64 total_voting_power = 3

VersionParams contain the version of specific components of CometBFT.

Used in: ConsensusParams

• uint64 app = 1

  The ABCI application version. It was named app_version in CometBFT 0.34.

Vote represents a prevote or precommit vote from validators for consensus.

Used in: consensus.v1.Vote, privval.v1.SignVoteRequest, privval.v1.SignedVoteResponse, privval.v1beta2.SignVoteRequest, privval.v1beta2.SignedVoteResponse, DuplicateVoteEvidence

• SignedMsgType type = 1

• int64 height = 2

• int32 round = 3

• optional BlockID block_id = 4

  zero if vote is nil.

• optional google.protobuf.Timestamp timestamp = 5

• bytes validator_address = 6

• int32 validator_index = 7

• bytes signature = 8

  Vote signature by the validator if they participated in consensus for the associated block.

• bytes extension = 9

  Vote extension provided by the application. Only valid for precommit messages.

• bytes extension_signature = 10

  Vote extension signature by the validator if they participated in consensus for the associated block. Only valid for precommit messages.