package cometbft.abci.v1

Get desktop application:
View/edit binary Protocol Buffers messages

ABCIService is a service for an ABCI application.

• rpc Echo (EchoRequest, EchoResponse)

  service.proto:11

  Echo returns back the same message it is sent.

• rpc Flush (FlushRequest, FlushResponse)

  service.proto:13

  Flush flushes the write buffer.

• rpc Info (InfoRequest, InfoResponse)

  service.proto:15

  Info returns information about the application state.

• rpc CheckTx (CheckTxRequest, CheckTxResponse)

  service.proto:17

  CheckTx validates a transaction.

• rpc Query (QueryRequest, QueryResponse)

  service.proto:19

  Query queries the application state.

• rpc Commit (CommitRequest, CommitResponse)

  service.proto:21

  Commit commits a block of transactions.

• rpc InitChain (InitChainRequest, InitChainResponse)

  service.proto:23

  InitChain initializes the blockchain.

• rpc ListSnapshots (ListSnapshotsRequest, ListSnapshotsResponse)

  service.proto:25

  ListSnapshots lists all the available snapshots.

• rpc OfferSnapshot (OfferSnapshotRequest, OfferSnapshotResponse)

  service.proto:27

  OfferSnapshot sends a snapshot offer.

• rpc LoadSnapshotChunk (LoadSnapshotChunkRequest, LoadSnapshotChunkResponse)

  service.proto:29

  LoadSnapshotChunk returns a chunk of snapshot.

• rpc ApplySnapshotChunk (ApplySnapshotChunkRequest, ApplySnapshotChunkResponse)

  service.proto:31

  ApplySnapshotChunk applies a chunk of snapshot.

• rpc PrepareProposal (PrepareProposalRequest, PrepareProposalResponse)

  service.proto:33

  PrepareProposal returns a proposal for the next block.

• rpc ProcessProposal (ProcessProposalRequest, ProcessProposalResponse)

  service.proto:35

  ProcessProposal validates a proposal.

• rpc ExtendVote (ExtendVoteRequest, ExtendVoteResponse)

  service.proto:37

  ExtendVote extends a vote with application-injected data (vote extensions).

• rpc VerifyVoteExtension (VerifyVoteExtensionRequest, VerifyVoteExtensionResponse)

  service.proto:39

  VerifyVoteExtension verifies a vote extension.

• rpc FinalizeBlock (FinalizeBlockRequest, FinalizeBlockResponse)

  service.proto:41

  FinalizeBlock finalizes a block.

Request to apply a snapshot chunk.

Used as request type in: ABCIService.ApplySnapshotChunk

Used as field type in: Request

• uint32 index = 1

• bytes chunk = 2

• string sender = 3

ApplySnapshotChunkResponse returns a result of applying the specified chunk.

Used as response type in: ABCIService.ApplySnapshotChunk

Used as field type in: Response

• ApplySnapshotChunkResult result = 1

• repeated uint32 refetch_chunks = 2

  Chunks to refetch and reapply

• repeated string reject_senders = 3

  Chunk senders to reject and ban

The result of applying a snapshot chunk.

Used in: ApplySnapshotChunkResponse

• APPLY_SNAPSHOT_CHUNK_RESULT_UNKNOWN = 0

  Unknown result, abort all snapshot restoration

• APPLY_SNAPSHOT_CHUNK_RESULT_ACCEPT = 1

  Chunk successfully accepted

• APPLY_SNAPSHOT_CHUNK_RESULT_ABORT = 2

  Abort all snapshot restoration

• APPLY_SNAPSHOT_CHUNK_RESULT_RETRY = 3

  Retry chunk (combine with refetch and reject)

• APPLY_SNAPSHOT_CHUNK_RESULT_RETRY_SNAPSHOT = 4

  Retry snapshot (combine with refetch and reject)

• APPLY_SNAPSHOT_CHUNK_RESULT_REJECT_SNAPSHOT = 5

  Reject this snapshot, try others

CheckTxRequest is a request to check that the transaction is valid.

Used as request type in: ABCIService.CheckTx

Used as field type in: Request

• bytes tx = 1

• CheckTxType type = 3

CheckTxResponse shows if the transaction was deemed valid by the ABCI application.

Used as response type in: ABCIService.CheckTx

Used as field type in: Response

• uint32 code = 1

• bytes data = 2

• string log = 3

  nondeterministic

• string info = 4

  nondeterministic

• int64 gas_wanted = 5

• int64 gas_used = 6

• repeated Event events = 7

  nondeterministic

• string codespace = 8

Type of the transaction check request. This enumeration is incompatible with the CheckTxType definition in cometbft.abci.v1beta1 and therefore shall not be used in encoding with the same field number.

Used in: CheckTxRequest

• CHECK_TX_TYPE_UNKNOWN = 0

  Unknown

• CHECK_TX_TYPE_RECHECK = 1

  Recheck (2nd, 3rd, etc.)

• CHECK_TX_TYPE_CHECK = 2

  Check (1st time)

CommitInfo contains votes for the particular round.

Used in: ExtendVoteRequest, FinalizeBlockRequest, ProcessProposalRequest

• int32 round = 1

• repeated VoteInfo votes = 2

CommitRequest is a request to commit the pending application state.

Used as request type in: ABCIService.Commit

Used as field type in: Request

(message has no fields)

CommitResponse indicates how much blocks should CometBFT retain.

Used as response type in: ABCIService.Commit

Used as field type in: Response

• int64 retain_height = 3

EchoRequest is a request to "echo" the given string.

Used as request type in: ABCIService.Echo

Used as field type in: Request

• string message = 1

EchoResponse indicates that the connection is still alive.

Used as response type in: ABCIService.Echo

Used as field type in: Response

• string message = 1

Event allows application developers to attach additional information to ResponseFinalizeBlock and ResponseCheckTx. Up to 0.37, this could also be used in ResponseBeginBlock, ResponseEndBlock, and ResponseDeliverTx. Later, transactions may be queried using these events.

Used in: CheckTxResponse, ExecTxResult, FinalizeBlockResponse, services.block_results.v1.GetBlockResultsResponse, state.v1.ResponseBeginBlock, state.v1.ResponseEndBlock

• string type = 1

• repeated EventAttribute attributes = 2

EventAttribute is a single key-value pair, associated with an event.

Used in: Event

• string key = 1

• string value = 2

• bool index = 3

  nondeterministic

nondeterministic

Used in: Response

• string error = 1

ExecTxResult contains results of executing one individual transaction. * Its structure is equivalent to #ResponseDeliverTx which will be deprecated/deleted

Used in: FinalizeBlockResponse, TxResult, services.block_results.v1.GetBlockResultsResponse, state.v1.LegacyABCIResponses

• uint32 code = 1

• bytes data = 2

• string log = 3

  nondeterministic

• string info = 4

  nondeterministic

• int64 gas_wanted = 5

• int64 gas_used = 6

• repeated Event events = 7

  nondeterministic

• string codespace = 8

ExtendVoteRequest extends a precommit vote with application-injected data.

Used as request type in: ABCIService.ExtendVote

Used as field type in: Request

• bytes hash = 1

  the hash of the block that this vote may be referring to

• int64 height = 2

  the height of the extended vote

• optional google.protobuf.Timestamp time = 3

  info of the block that this vote may be referring to

• repeated bytes txs = 4

• optional CommitInfo proposed_last_commit = 5

• repeated Misbehavior misbehavior = 6

• bytes next_validators_hash = 7

• bytes proposer_address = 8

  address of the public key of the original proposer of the block.

ExtendVoteResponse contains the vote extension that the application would like to attach to its next precommit vote.

Used as response type in: ABCIService.ExtendVote

Used as field type in: Response

• bytes vote_extension = 1

ExtendedCommitInfo is similar to CommitInfo except that it is only used in the PrepareProposal request such that Tendermint can provide vote extensions to the application.

Used in: PrepareProposalRequest

• int32 round = 1

  The round at which the block proposer decided in the previous height.

• repeated ExtendedVoteInfo votes = 2

  List of validators' addresses in the last validator set with their voting information, including vote extensions.

ExtendedVoteInfo extends VoteInfo with the vote extensions (non-deterministic).

Used in: ExtendedCommitInfo

• optional Validator validator = 1

  The validator that sent the vote.

• bytes vote_extension = 3

  Non-deterministic extension provided by the sending validator's application.

• bytes extension_signature = 4

  Vote extension signature created by CometBFT

• types.v1.BlockIDFlag block_id_flag = 5

  block_id_flag indicates whether the validator voted for a block, nil, or did not vote at all

FinalizeBlockRequest is a request to finalize the block.

Used as request type in: ABCIService.FinalizeBlock

Used as field type in: Request

• repeated bytes txs = 1

• optional CommitInfo decided_last_commit = 2

• repeated Misbehavior misbehavior = 3

• bytes hash = 4

  Merkle root hash of the fields of the decided block.

• int64 height = 5

• optional google.protobuf.Timestamp time = 6

• bytes next_validators_hash = 7

• bytes proposer_address = 8

  address of the public key of the original proposer of the block.

FinalizeBlockResponse contains the result of executing the block.

Used as response type in: ABCIService.FinalizeBlock

Used as field type in: Response, state.v1.ABCIResponsesInfo

• repeated Event events = 1

  set of block events emitted as part of executing the block

  nondeterministic

• repeated ExecTxResult tx_results = 2

  the result of executing each transaction including the events the particular transaction emitted. This should match the order of the transactions delivered in the block itself

• repeated ValidatorUpdate validator_updates = 3

  a list of updates to the validator set. These will reflect the validator set at current height + 2.

• optional types.v1.ConsensusParams consensus_param_updates = 4

  updates to the consensus params, if any.

• bytes app_hash = 5

  app_hash is the hash of the applications' state which is used to confirm that execution of the transactions was deterministic. It is up to the application to decide which algorithm to use.

FlushRequest is a request to flush the write buffer.

Used as request type in: ABCIService.Flush

Used as field type in: Request

(message has no fields)

FlushResponse indicates that the write buffer was flushed.

Used as response type in: ABCIService.Flush

Used as field type in: Response

(message has no fields)

InfoRequest is a request for the ABCI application version.

Used as request type in: ABCIService.Info

Used as field type in: Request

• string version = 1

• uint64 block_version = 2

• uint64 p2p_version = 3

• string abci_version = 4

InfoResponse contains the ABCI application version information.

Used as response type in: ABCIService.Info

Used as field type in: Response

• string data = 1

• string version = 2

• uint64 app_version = 3

• int64 last_block_height = 4

• bytes last_block_app_hash = 5

InitChainRequest is a request to initialize the blockchain.

Used as request type in: ABCIService.InitChain

Used as field type in: Request

• optional google.protobuf.Timestamp time = 1

• string chain_id = 2

• optional types.v1.ConsensusParams consensus_params = 3

• repeated ValidatorUpdate validators = 4

• bytes app_state_bytes = 5

• int64 initial_height = 6

InitChainResponse contains the ABCI application's hash and updates to the validator set and/or the consensus params, if any.

Used as response type in: ABCIService.InitChain

Used as field type in: Response

• optional types.v1.ConsensusParams consensus_params = 1

• repeated ValidatorUpdate validators = 2

• bytes app_hash = 3

Request to list available snapshots.

Used as request type in: ABCIService.ListSnapshots

Used as field type in: Request

(message has no fields)

ListSnapshotsResponse contains the list of snapshots.

Used as response type in: ABCIService.ListSnapshots

Used as field type in: Response

• repeated Snapshot snapshots = 1

Request to load a snapshot chunk.

Used as request type in: ABCIService.LoadSnapshotChunk

Used as field type in: Request

• uint64 height = 1

• uint32 format = 2

• uint32 chunk = 3

LoadSnapshotChunkResponse returns a snapshot's chunk.

Used as response type in: ABCIService.LoadSnapshotChunk

Used as field type in: Response

• bytes chunk = 1

Misbehavior is a type of misbehavior committed by a validator.

Used in: ExtendVoteRequest, FinalizeBlockRequest, PrepareProposalRequest, ProcessProposalRequest

• MisbehaviorType type = 1

• optional Validator validator = 2

  The offending validator

• int64 height = 3

  The height when the offense occurred

• optional google.protobuf.Timestamp time = 4

  The corresponding time where the offense occurred

• int64 total_voting_power = 5

  Total voting power of the validator set in case the ABCI application does not store historical validators. https://github.com/tendermint/tendermint/issues/4581

The type of misbehavior committed by a validator.

Used in: Misbehavior

• MISBEHAVIOR_TYPE_UNKNOWN = 0

  Unknown

• MISBEHAVIOR_TYPE_DUPLICATE_VOTE = 1

  Duplicate vote

• MISBEHAVIOR_TYPE_LIGHT_CLIENT_ATTACK = 2

  Light client attack

Request offering a snapshot to the application.

Used as request type in: ABCIService.OfferSnapshot

Used as field type in: Request

• optional Snapshot snapshot = 1

  snapshot offered by peers

• bytes app_hash = 2

  light client-verified app hash for snapshot height

OfferSnapshotResponse indicates the ABCI application decision whenever to provide a snapshot to the requester or not.

Used as response type in: ABCIService.OfferSnapshot

Used as field type in: Response

• OfferSnapshotResult result = 1

The result of offering a snapshot.

Used in: OfferSnapshotResponse

• OFFER_SNAPSHOT_RESULT_UNKNOWN = 0

  Unknown result, abort all snapshot restoration

• OFFER_SNAPSHOT_RESULT_ACCEPT = 1

  Snapshot accepted, apply chunks

• OFFER_SNAPSHOT_RESULT_ABORT = 2

  Abort all snapshot restoration

• OFFER_SNAPSHOT_RESULT_REJECT = 3

  Reject this specific snapshot, try others

• OFFER_SNAPSHOT_RESULT_REJECT_FORMAT = 4

  Reject all snapshots of this format, try others

• OFFER_SNAPSHOT_RESULT_REJECT_SENDER = 5

  Reject all snapshots from the sender(s), try others

PrepareProposalRequest is a request for the ABCI application to prepare a new block proposal.

Used as request type in: ABCIService.PrepareProposal

Used as field type in: Request

• int64 max_tx_bytes = 1

  the modified transactions cannot exceed this size.

• repeated bytes txs = 2

  txs is an array of transactions that will be included in a block, sent to the app for possible modifications.

• optional ExtendedCommitInfo local_last_commit = 3

• repeated Misbehavior misbehavior = 4

• int64 height = 5

• optional google.protobuf.Timestamp time = 6

• bytes next_validators_hash = 7

• bytes proposer_address = 8

  address of the public key of the validator proposing the block.

PrepareProposalResponse contains a list of transactions, which will form a block.

Used as response type in: ABCIService.PrepareProposal

Used as field type in: Response

• repeated bytes txs = 1

ProcessProposalRequest is a request for the ABCI application to process a proposal received from another validator.

Used as request type in: ABCIService.ProcessProposal

Used as field type in: Request

• repeated bytes txs = 1

• optional CommitInfo proposed_last_commit = 2

• repeated Misbehavior misbehavior = 3

• bytes hash = 4

  Merkle root hash of the fields of the proposed block.

• int64 height = 5

• optional google.protobuf.Timestamp time = 6

• bytes next_validators_hash = 7

• bytes proposer_address = 8

  address of the public key of the original proposer of the block.

ProcessProposalResponse indicates the ABCI application's decision whenever the given proposal should be accepted or not.

Used as response type in: ABCIService.ProcessProposal

Used as field type in: Response

• ProcessProposalStatus status = 1

ProcessProposalStatus is the status of the proposal processing.

Used in: ProcessProposalResponse

• PROCESS_PROPOSAL_STATUS_UNKNOWN = 0

  Unknown

• PROCESS_PROPOSAL_STATUS_ACCEPT = 1

  Accepted

• PROCESS_PROPOSAL_STATUS_REJECT = 2

  Rejected

QueryRequest is a request to query the application state.

Used as request type in: ABCIService.Query

Used as field type in: Request

• bytes data = 1

• string path = 2

• int64 height = 3

• bool prove = 4

QueryResponse contains the ABCI application data along with a proof.

Used as response type in: ABCIService.Query

Used as field type in: Response

• uint32 code = 1

• string log = 3

  bytes data = 2; // use "value" instead.

  nondeterministic

• string info = 4

  nondeterministic

• int64 index = 5

• bytes key = 6

• bytes value = 7

• optional crypto.v1.ProofOps proof_ops = 8

• int64 height = 9

• string codespace = 10

Request represents a request to the ABCI application.

• oneof value

  Sum of all possible messages.

  • EchoRequest echo = 1

  • FlushRequest flush = 2

  • InfoRequest info = 3

  • InitChainRequest init_chain = 5

  • QueryRequest query = 6

  • CheckTxRequest check_tx = 8

  • CommitRequest commit = 11

  • ListSnapshotsRequest list_snapshots = 12

  • OfferSnapshotRequest offer_snapshot = 13

  • LoadSnapshotChunkRequest load_snapshot_chunk = 14

  • ApplySnapshotChunkRequest apply_snapshot_chunk = 15

  • PrepareProposalRequest prepare_proposal = 16

  • ProcessProposalRequest process_proposal = 17

  • ExtendVoteRequest extend_vote = 18

  • VerifyVoteExtensionRequest verify_vote_extension = 19

  • FinalizeBlockRequest finalize_block = 20

Response represents a response from the ABCI application.

• oneof value

  Sum of all possible messages.

  • ExceptionResponse exception = 1

  • EchoResponse echo = 2

  • FlushResponse flush = 3

  • InfoResponse info = 4

  • InitChainResponse init_chain = 6

  • QueryResponse query = 7

  • CheckTxResponse check_tx = 9

  • CommitResponse commit = 12

  • ListSnapshotsResponse list_snapshots = 13

  • OfferSnapshotResponse offer_snapshot = 14

  • LoadSnapshotChunkResponse load_snapshot_chunk = 15

  • ApplySnapshotChunkResponse apply_snapshot_chunk = 16

  • PrepareProposalResponse prepare_proposal = 17

  • ProcessProposalResponse process_proposal = 18

  • ExtendVoteResponse extend_vote = 19

  • VerifyVoteExtensionResponse verify_vote_extension = 20

  • FinalizeBlockResponse finalize_block = 21

Snapshot of the ABCI application state.

Used in: ListSnapshotsResponse, OfferSnapshotRequest

• uint64 height = 1

  The height at which the snapshot was taken

• uint32 format = 2

  The application-specific snapshot format

• uint32 chunks = 3

  Number of chunks in the snapshot

• bytes hash = 4

  Arbitrary snapshot hash, equal only if identical

• bytes metadata = 5

  Arbitrary application metadata

TxResult contains results of executing the transaction. One usage is indexing transaction results.

• int64 height = 1

• uint32 index = 2

• bytes tx = 3

• optional ExecTxResult result = 4

Validator in the validator set.

Used in: ExtendedVoteInfo, Misbehavior, VoteInfo

• bytes address = 1

  The first 20 bytes of SHA256(public key)

• int64 power = 3

  PubKey pub_key = 2 [(gogoproto.nullable)=false];

  The voting power

ValidatorUpdate is a singular update to a validator set.

Used in: FinalizeBlockResponse, InitChainRequest, InitChainResponse, services.block_results.v1.GetBlockResultsResponse, state.v1.ResponseEndBlock

• optional crypto.v1.PublicKey pub_key = 1

• int64 power = 2

VerifyVoteExtensionRequest is a request for the application to verify a vote extension produced by a different validator.

Used as request type in: ABCIService.VerifyVoteExtension

Used as field type in: Request

• bytes hash = 1

  the hash of the block that this received vote corresponds to

• bytes validator_address = 2

  the validator that signed the vote extension

• int64 height = 3

• bytes vote_extension = 4

VerifyVoteExtensionResponse indicates the ABCI application's decision whenever the vote extension should be accepted or not.

Used as response type in: ABCIService.VerifyVoteExtension

Used as field type in: Response

• VerifyVoteExtensionStatus status = 1

VerifyVoteExtensionStatus is the status of the vote extension verification.

Used in: VerifyVoteExtensionResponse

• VERIFY_VOTE_EXTENSION_STATUS_UNKNOWN = 0

  Unknown

• VERIFY_VOTE_EXTENSION_STATUS_ACCEPT = 1

  Accepted

• VERIFY_VOTE_EXTENSION_STATUS_REJECT = 2

  Rejecting the vote extension will reject the entire precommit by the sender. Incorrectly implementing this thus has liveness implications as it may affect CometBFT's ability to receive 2/3+ valid votes to finalize the block. Honest nodes should never be rejected.

VoteInfo contains the information about the vote.

Used in: CommitInfo

• optional Validator validator = 1

• types.v1.BlockIDFlag block_id_flag = 3