package cometbft.abci.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

ABCIApplication is a service for an ABCI application.

• rpc Echo (RequestEcho, ResponseEcho)

  types.proto:463

  Echo returns back the same message it is sent.

• rpc Flush (RequestFlush, ResponseFlush)

  types.proto:465

  Flush flushes the write buffer.

• rpc Info (RequestInfo, ResponseInfo)

  types.proto:467

  Info returns information about the application state.

• rpc SetOption (RequestSetOption, ResponseSetOption)

  types.proto:469

  SetOption sets a parameter in the application.

• rpc DeliverTx (RequestDeliverTx, ResponseDeliverTx)

  types.proto:471

  DeliverTx applies a transaction.

• rpc CheckTx (RequestCheckTx, ResponseCheckTx)

  types.proto:473

  CheckTx validates a transaction.

• rpc Query (RequestQuery, ResponseQuery)

  types.proto:475

  Query queries the application state.

• rpc Commit (RequestCommit, ResponseCommit)

  types.proto:477

  Commit commits a block of transactions.

• rpc InitChain (RequestInitChain, ResponseInitChain)

  types.proto:479

  InitChain initializes the blockchain.

• rpc BeginBlock (RequestBeginBlock, ResponseBeginBlock)

  types.proto:481

  BeginBlock signals the beginning of a block.

• rpc EndBlock (RequestEndBlock, ResponseEndBlock)

  types.proto:483

  EndBlock signals the end of a block, returns changes to the validator set.

• rpc ListSnapshots (RequestListSnapshots, ResponseListSnapshots)

  types.proto:485

  ListSnapshots lists all the available snapshots.

• rpc OfferSnapshot (RequestOfferSnapshot, ResponseOfferSnapshot)

  types.proto:487

  OfferSnapshot sends a snapshot offer.

• rpc LoadSnapshotChunk (RequestLoadSnapshotChunk, ResponseLoadSnapshotChunk)

  types.proto:489

  LoadSnapshotChunk returns a chunk of snapshot.

• rpc ApplySnapshotChunk (RequestApplySnapshotChunk, ResponseApplySnapshotChunk)

  types.proto:491

  ApplySnapshotChunk applies a chunk of snapshot.

BlockParams contains limits on the block size.

Used in: ConsensusParams

• int64 max_bytes = 1

  Note: must be greater than 0

• int64 max_gas = 2

  Note: must be greater or equal to -1

Type of the transaction check request.

Used in: RequestCheckTx

• NEW = 0

  New

• RECHECK = 1

  Recheck (2nd, 3rd, etc.)

ConsensusParams contains all consensus-relevant parameters that can be adjusted by the abci app

Used in: RequestInitChain, ResponseEndBlock, ResponseInitChain

• optional BlockParams block = 1

• optional types.v1beta1.EvidenceParams evidence = 2

• optional types.v1beta1.ValidatorParams validator = 3

• optional types.v1beta1.VersionParams version = 4

Event allows application developers to attach additional information to ResponseBeginBlock, ResponseEndBlock, ResponseCheckTx and ResponseDeliverTx. Later, transactions may be queried using these events.

Used in: ResponseBeginBlock, ResponseCheckTx, ResponseDeliverTx, ResponseEndBlock

• string type = 1

• repeated EventAttribute attributes = 2

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

Used in: Event

• bytes key = 1

• bytes value = 2

• bool index = 3

  nondeterministic

Evidence of a misbehavior committed by a validator.

Used in: RequestBeginBlock

• EvidenceType 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 evidence.

Used in: Evidence

• UNKNOWN = 0

  Unknown

• DUPLICATE_VOTE = 1

  Duplicate vote

• LIGHT_CLIENT_ATTACK = 2

  Light client attack

LastCommitInfo contains votes for the particular round.

Used in: RequestBeginBlock

• int32 round = 1

• repeated VoteInfo votes = 2

Request represents a request to the ABCI application.

• oneof value

  Sum of all possible messages.

  • RequestEcho echo = 1

  • RequestFlush flush = 2

  • RequestInfo info = 3

  • RequestSetOption set_option = 4

  • RequestInitChain init_chain = 5

  • RequestQuery query = 6

  • RequestBeginBlock begin_block = 7

  • RequestCheckTx check_tx = 8

  • RequestDeliverTx deliver_tx = 9

  • RequestEndBlock end_block = 10

  • RequestCommit commit = 11

  • RequestListSnapshots list_snapshots = 12

  • RequestOfferSnapshot offer_snapshot = 13

  • RequestLoadSnapshotChunk load_snapshot_chunk = 14

  • RequestApplySnapshotChunk apply_snapshot_chunk = 15

Applies a snapshot chunk

Used as request type in: ABCIApplication.ApplySnapshotChunk, v1beta2.ABCIApplication.ApplySnapshotChunk, v1beta3.ABCI.ApplySnapshotChunk

Used as field type in: Request, v1beta2.Request, v1beta3.Request

• uint32 index = 1

• bytes chunk = 2

• string sender = 3

RequestBeginBlock indicates the beginning of committing the block.

Used as request type in: ABCIApplication.BeginBlock

Used as field type in: Request

• bytes hash = 1

• optional types.v1beta1.Header header = 2

• optional LastCommitInfo last_commit_info = 3

• repeated Evidence byzantine_validators = 4

RequestCheckTx is a request to check the transaction.

Used as request type in: ABCIApplication.CheckTx, v1beta2.ABCIApplication.CheckTx, v1beta3.ABCI.CheckTx

Used as field type in: Request, v1beta2.Request, v1beta3.Request

• bytes tx = 1

• CheckTxType type = 2

RequestCommit is a request to commit the pending application state.

Used as request type in: ABCIApplication.Commit, v1beta2.ABCIApplication.Commit, v1beta3.ABCI.Commit

Used as field type in: Request, v1beta2.Request, v1beta3.Request

(message has no fields)

RequestDeliverTx is a request to apply the transaction.

Used as request type in: ABCIApplication.DeliverTx, v1beta2.ABCIApplication.DeliverTx

Used as field type in: Request, v1beta2.Request

• bytes tx = 1

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

Used as request type in: ABCIApplication.Echo, v1beta2.ABCIApplication.Echo, v1beta3.ABCI.Echo

Used as field type in: Request, v1beta2.Request, v1beta3.Request

• string message = 1

RequestEndBlock indicates the end of committing the block.

Used as request type in: ABCIApplication.EndBlock, v1beta2.ABCIApplication.EndBlock

Used as field type in: Request, v1beta2.Request

• int64 height = 1

RequestFlush is a request to flush the write buffer.

Used as request type in: ABCIApplication.Flush, v1beta2.ABCIApplication.Flush, v1beta3.ABCI.Flush

Used as field type in: Request, v1beta2.Request, v1beta3.Request

(message has no fields)

RequestInfo is a request for the ABCI application version.

Used as request type in: ABCIApplication.Info

Used as field type in: Request

• string version = 1

• uint64 block_version = 2

• uint64 p2p_version = 3

RequestInitChain is a request to initialize the blockchain.

Used as request type in: ABCIApplication.InitChain

Used as field type in: Request

• optional google.protobuf.Timestamp time = 1

• string chain_id = 2

• optional ConsensusParams consensus_params = 3

• repeated ValidatorUpdate validators = 4

• bytes app_state_bytes = 5

• int64 initial_height = 6

lists available snapshots

Used as request type in: ABCIApplication.ListSnapshots, v1beta2.ABCIApplication.ListSnapshots, v1beta3.ABCI.ListSnapshots

Used as field type in: Request, v1beta2.Request, v1beta3.Request

(message has no fields)

loads a snapshot chunk

Used as request type in: ABCIApplication.LoadSnapshotChunk, v1beta2.ABCIApplication.LoadSnapshotChunk, v1beta3.ABCI.LoadSnapshotChunk

Used as field type in: Request, v1beta2.Request, v1beta3.Request

• uint64 height = 1

• uint32 format = 2

• uint32 chunk = 3

offers a snapshot to the application

Used as request type in: ABCIApplication.OfferSnapshot, v1beta2.ABCIApplication.OfferSnapshot, v1beta3.ABCI.OfferSnapshot

Used as field type in: Request, v1beta2.Request, v1beta3.Request

• optional Snapshot snapshot = 1

  snapshot offered by peers

• bytes app_hash = 2

  light client-verified app hash for snapshot height

RequestQuery is a request to query the application state.

Used as request type in: ABCIApplication.Query, v1beta2.ABCIApplication.Query, v1beta3.ABCI.Query

Used as field type in: Request, v1beta2.Request, v1beta3.Request

• bytes data = 1

• string path = 2

• int64 height = 3

• bool prove = 4

nondeterministic

Used as request type in: ABCIApplication.SetOption

Used as field type in: Request

• string key = 1

• string value = 2

Response represents a response from the ABCI application.

• oneof value

  Sum of all possible messages.

  • ResponseException exception = 1

  • ResponseEcho echo = 2

  • ResponseFlush flush = 3

  • ResponseInfo info = 4

  • ResponseSetOption set_option = 5

  • ResponseInitChain init_chain = 6

  • ResponseQuery query = 7

  • ResponseBeginBlock begin_block = 8

  • ResponseCheckTx check_tx = 9

  • ResponseDeliverTx deliver_tx = 10

  • ResponseEndBlock end_block = 11

  • ResponseCommit commit = 12

  • ResponseListSnapshots list_snapshots = 13

  • ResponseOfferSnapshot offer_snapshot = 14

  • ResponseLoadSnapshotChunk load_snapshot_chunk = 15

  • ResponseApplySnapshotChunk apply_snapshot_chunk = 16

ResponseApplySnapshotChunk returns a result of applying the specified chunk.

Used as response type in: ABCIApplication.ApplySnapshotChunk, v1beta2.ABCIApplication.ApplySnapshotChunk, v1beta3.ABCI.ApplySnapshotChunk

Used as field type in: Response, v1beta2.Response, v1beta3.Response

• ResponseApplySnapshotChunk.Result result = 1

• repeated uint32 refetch_chunks = 2

  Chunks to refetch and reapply

• repeated string reject_senders = 3

  Chunk senders to reject and ban

The status code.

Used in: ResponseApplySnapshotChunk

• UNKNOWN = 0

  Unknown result, abort all snapshot restoration

• ACCEPT = 1

  Chunk successfully accepted

• ABORT = 2

  Abort all snapshot restoration

• RETRY = 3

  Retry chunk (combine with refetch and reject)

• RETRY_SNAPSHOT = 4

  Retry snapshot (combine with refetch and reject)

• REJECT_SNAPSHOT = 5

  Reject this snapshot, try others

ResponseBeginBlock contains a list of block-level events.

Used as response type in: ABCIApplication.BeginBlock

Used as field type in: Response, state.v1beta1.ABCIResponses

• repeated Event events = 1

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

Used as response type in: ABCIApplication.CheckTx

Used as field type in: Response, rpc.grpc.v1beta1.ResponseBroadcastTx

• 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

• string codespace = 8

• string sender = 9

• int64 priority = 10

• string mempool_error = 11

  mempool_error is set by CometBFT. ABCI applications creating a ResponseCheckTX should not set mempool_error.

ResponseCommit indicates how much blocks should CometBFT retain.

Used as response type in: ABCIApplication.Commit, v1beta2.ABCIApplication.Commit

Used as field type in: Response, v1beta2.Response

• bytes data = 2

  reserve 1

• int64 retain_height = 3

ResponseDeliverTx contains a result of committing the given transaction and a list of events.

Used as response type in: ABCIApplication.DeliverTx

Used as field type in: Response, TxResult, rpc.grpc.v1beta1.ResponseBroadcastTx, state.v1beta1.ABCIResponses

• 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

ResponseEcho indicates that the connection is still alive.

Used as response type in: ABCIApplication.Echo, v1beta2.ABCIApplication.Echo, v1beta3.ABCI.Echo

Used as field type in: Response, v1beta2.Response, v1beta3.Response

• string message = 1

ResponseEndBlock contains updates to consensus params and/or validator set changes, if any.

Used as response type in: ABCIApplication.EndBlock

Used as field type in: Response, state.v1beta1.ABCIResponses

• repeated ValidatorUpdate validator_updates = 1

• optional ConsensusParams consensus_param_updates = 2

• repeated Event events = 3

nondeterministic

Used in: Response, v1beta2.Response, v1beta3.Response

• string error = 1

ResponseFlush indicates that the ABCI application state was flushed?

Used as response type in: ABCIApplication.Flush, v1beta2.ABCIApplication.Flush, v1beta3.ABCI.Flush

Used as field type in: Response, v1beta2.Response, v1beta3.Response

(message has no fields)

ResponseInfo contains the ABCI application version information.

Used as response type in: ABCIApplication.Info, v1beta2.ABCIApplication.Info, v1beta3.ABCI.Info

Used as field type in: Response, v1beta2.Response, v1beta3.Response

• string data = 1

• string version = 2

• uint64 app_version = 3

• int64 last_block_height = 4

• bytes last_block_app_hash = 5

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

Used as response type in: ABCIApplication.InitChain

Used as field type in: Response

• optional ConsensusParams consensus_params = 1

• repeated ValidatorUpdate validators = 2

• bytes app_hash = 3

ResponseListSnapshots contains the list of snapshots.

Used as response type in: ABCIApplication.ListSnapshots, v1beta2.ABCIApplication.ListSnapshots, v1beta3.ABCI.ListSnapshots

Used as field type in: Response, v1beta2.Response, v1beta3.Response

• repeated Snapshot snapshots = 1

ResponseLoadSnapshotChunk returns a snapshot's chunk.

Used as response type in: ABCIApplication.LoadSnapshotChunk, v1beta2.ABCIApplication.LoadSnapshotChunk, v1beta3.ABCI.LoadSnapshotChunk

Used as field type in: Response, v1beta2.Response, v1beta3.Response

• bytes chunk = 1

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

Used as response type in: ABCIApplication.OfferSnapshot, v1beta2.ABCIApplication.OfferSnapshot, v1beta3.ABCI.OfferSnapshot

Used as field type in: Response, v1beta2.Response, v1beta3.Response

• ResponseOfferSnapshot.Result result = 1

The status code.

Used in: ResponseOfferSnapshot

• UNKNOWN = 0

  Unknown result, abort all snapshot restoration

• ACCEPT = 1

  Snapshot accepted, apply chunks

• ABORT = 2

  Abort all snapshot restoration

• REJECT = 3

  Reject this specific snapshot, try others

• REJECT_FORMAT = 4

  Reject all snapshots of this format, try others

• REJECT_SENDER = 5

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

ResponseQuery contains the ABCI application data along with a proof.

Used as response type in: ABCIApplication.Query, v1beta2.ABCIApplication.Query, v1beta3.ABCI.Query

Used as field type in: Response, v1beta2.Response, v1beta3.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

nondeterministic

Used as response type in: ABCIApplication.SetOption

Used as field type in: Response

• uint32 code = 1

• string log = 3

  bytes data = 2;

• string info = 4

Snapshot of the ABCI application state.

Used in: RequestOfferSnapshot, ResponseListSnapshots

• 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 ResponseDeliverTx result = 4

Validator in the validator set.

Used in: Evidence, VoteInfo, v1beta2.ExtendedVoteInfo, v1beta2.Misbehavior, v1beta3.ExtendedVoteInfo, v1beta3.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: RequestInitChain, ResponseEndBlock, ResponseInitChain, v1beta2.RequestInitChain, v1beta2.ResponseEndBlock, v1beta2.ResponseInitChain, v1beta3.RequestInitChain, v1beta3.ResponseFinalizeBlock, v1beta3.ResponseInitChain, state.v1beta3.ResponseEndBlock

• optional crypto.v1.PublicKey pub_key = 1

• int64 power = 2

VoteInfo contains the information about the vote.

Used in: LastCommitInfo, v1beta2.CommitInfo

• optional Validator validator = 1

• bool signed_last_block = 2