Protocol Documentation

Table of Contents

Top

tendermint/abci/types.proto

CommitInfo

FieldTypeLabelDescription
roundint32
quorum_hashbytes
block_signaturebytes
threshold_vote_extensionstendermint.types.VoteExtensionrepeated

Event

Event carries application attributes in ResponseProcessProposal and ExecTxResult.

Later, transactions may be queried using these events.

FieldTypeLabelDescription
typestring
attributesEventAttributerepeated

EventAttribute

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

FieldTypeLabelDescription
keystring
valuestring
indexboolnondeterministic

ExecTxResult

ExecTxResult contains results of executing one individual transaction.

FieldTypeLabelDescription
codeuint32Response code within codespace; by convention, 0 means success.
databytesResult bytes, if any (arbitrary data, not interpreted by Tenderdash).
logstringThe output of the application's logger. May be non-deterministic.
infostringAdditional information. May be non-deterministic.
gas_usedint64Amount of gas consumed by transaction.
eventsEventrepeatedType & Key-Value events for indexing transactions (e.g. by account).
codespacestringNamespace for the code.

ExtendVoteExtension

Provides a vote extension for signing. type and extension fields are mandatory for filling

FieldTypeLabelDescription
typetendermint.types.VoteExtensionTypeVote extension type can be either DEFAULT, THRESHOLD_RECOVER or THRESHOLD_RECOVER_RAW. The Tenderdash supports only THRESHOLD_RECOVER and THRESHOLD_RECOVER_RAW at this moment.
extensionbytesDeterministic or (Non-Deterministic) extension provided by the sending validator's Application.

For THRESHOLD_RECOVER_RAW, it MUST be 32 bytes.

Sign request ID that will be used to sign the vote extensions. Only applicable for THRESHOLD_RECOVER_RAW vote extension type.

Tenderdash will use SHA256 checksum of sign_request_id when generating quorum signatures of THRESHOLD_RECOVER_RAW vote extensions. It MUST NOT be set for any other vote extension types. | | sign_request_id | bytes | optional | If not set, Tenderdash will generate it based on height and round.

If set, it SHOULD be unique per voting round, and it MUST start with dpevote or \x06plwdtx prefix.

Use with caution - it can have severe security consequences. |

ExtendedVoteInfo

ExtendedVoteInfo

FieldTypeLabelDescription
validatorValidatorThe validator that sent the vote.
signed_last_blockboolIndicates whether the validator signed the last block, allowing for rewards based on validator availability.
vote_extensionbytesNon-deterministic extension provided by the sending validator's application.

Misbehavior

FieldTypeLabelDescription
typeMisbehaviorType
validatorValidatorThe offending validator
heightint64The height when the offense occurred
timegoogle.protobuf.TimestampThe corresponding time where the offense occurred
total_voting_powerint64Total voting power of the validator set in case the ABCI application does not store historical validators. https://github.com/tendermint/tendermint/issues/4581

QuorumHashUpdate

FieldTypeLabelDescription
quorum_hashbytes

Request

Request types

FieldTypeLabelDescription
echoRequestEcho
flushRequestFlush
infoRequestInfo
init_chainRequestInitChain
queryRequestQuery
check_txRequestCheckTx
list_snapshotsRequestListSnapshots
offer_snapshotRequestOfferSnapshot
load_snapshot_chunkRequestLoadSnapshotChunk
apply_snapshot_chunkRequestApplySnapshotChunk
prepare_proposalRequestPrepareProposal
process_proposalRequestProcessProposal
extend_voteRequestExtendVote
verify_vote_extensionRequestVerifyVoteExtension
finalize_blockRequestFinalizeBlock

RequestApplySnapshotChunk

Applies a snapshot chunk.

  • The application can choose to refetch chunks and/or ban P2P peers as appropriate. Tenderdash will not do this unless instructed by the application.
  • The application may want to verify each chunk, e.g. by attaching chunk hashes in Snapshot.Metadata and/or incrementally verifying contents against AppHash.
  • On ACCEPT, Tenderdash enqueues ResponseApplySnapshotChunk.next_chunks and continues applying chunks. Restoration finishes only when the application returns COMPLETE_SNAPSHOT; an ACCEPT without next_chunks does not signal completion.
  • After COMPLETE_SNAPSHOT, Tenderdash makes an ABCI Info call to verify that LastBlockAppHash, LastBlockHeight and AppVersion match the expected values. It then switches to block sync or consensus and joins the network.
  • If Tenderdash is unable to retrieve the next chunk after some time (e.g. because no suitable peers are available), it will reject the snapshot and try a different one via OfferSnapshot. The application should be prepared to reset and accept it or abort as appropriate.
FieldTypeLabelDescription
chunk_idbytesApplication-defined chunk identifier: Snapshot.hash for the first chunk, then identifiers returned in ResponseApplySnapshotChunk.next_chunks.
chunkbytesThe binary chunk contents, as returned by LoadSnapshotChunk.
senderstringThe P2P ID of the node who sent this chunk.

RequestCheckTx

Check if transaction is valid.

  • Technically optional - not involved in processing blocks.
  • Guardian of the mempool: every node runs CheckTx before letting a transaction into its local mempool.
  • The transaction may come from an external user or another node
  • CheckTx validates the transaction against the current state of the application, for example, checking signatures and account balances, but does not apply any of the state changes described in the transaction.
  • Transactions where ResponseCheckTx.Code != 0 will be rejected - they will not be broadcast to other nodes or included in a proposal block.
  • Tenderdash attributes no other value to the response code
FieldTypeLabelDescription
txbytesThe request transaction bytes.
typeCheckTxTypeType or transaction check to execute.

RequestEcho

Echo a string to test an abci client/server implementation

FieldTypeLabelDescription
messagestringA string to echo back

RequestExtendVote

Return the vote_extensions vector for the block and round processed last. Before a validator signs a non-nil precommit, Tenderdash requests the extensions to attach to that vote. It may also call ExtendVote on any node after rejecting a commit vector, to learn the expected vector without signing or broadcasting. The call must be free of side effects. Threshold-recoverable extensions must be deterministic and match the vector accepted at commit-level VerifyVoteExtension. See the ExtendVote contract.

FieldTypeLabelDescription
hashbytesThe header hash of the proposed block that the vote extensions is to refer to.
heightint64Height of the proposed block (for sanity check).
roundint32Round number for the block.

RequestFinalizeBlock

Persist the decided candidate for the block and the round processed last. Tenderdash calls this after processing and accepting the commit extension vector. The application must persist the candidate before returning; execution results and events are provided through proposal processing, not ResponseFinalizeBlock. The response contains retention and next-block scheduling hints only. Use retain_height with care: pruning blocks can prevent replay and bootstrapping. See the FinalizeBlock contract and commit and apply.

FieldTypeLabelDescription
commitCommitInfoInfo about the current commit
misbehaviorMisbehaviorrepeatedList of information about validators that acted incorrectly.
hashbytesThe block header's hash. Present for convenience (can be derived from the block header).
heightint64The height of the finalized block.
roundint32Round number for the block
blocktendermint.types.BlockThe block that was finalized
block_idtendermint.types.BlockIDThe block ID that was finalized

RequestFlush

Signals that messages queued on the client should be flushed to the server. It is called periodically by the client implementation to ensure asynchronous requests are actually sent, and is called immediately to make a synchronous request, which returns when the Flush response comes back.

RequestInfo

Return information about the application's last committed state. Used during startup reconciliation and by RPC queries. Persist the reported height and application hash in FinalizeBlock. See the startup handshake.

FieldTypeLabelDescription
versionstringThe Tenderdash software semantic version.
block_versionuint64The Tenderdash Block Protocol version.
p2p_versionuint64The Tenderdash P2P Protocol version.
abci_versionstringThe Tenderdash ABCI semantic version.

RequestInitChain

Called once upon genesis.

  • If ResponseInitChain.Validators is empty, the initial validator set will be the RequestInitChain.Validators
  • If ResponseInitChain.Validators is not empty, it will be the initial validator set (regardless of what is in RequestInitChain.Validators).
  • This allows the app to decide if it wants to accept the initial validator set proposed by Tenderdash (ie. in the genesis file), or if it wants to use a different one (perhaps computed based on some application specific information in the genesis file).
FieldTypeLabelDescription
timegoogle.protobuf.TimestampGenesis time
chain_idstringID of the blockchain.
consensus_paramstendermint.types.ConsensusParamsInitial consensus-critical parameters.
validator_setValidatorSetUpdateInitial genesis validators, sorted by voting power.
app_state_bytesbytesSerialized initial application state. JSON bytes.
initial_heightint64Height of the initial block (typically 1).
initial_core_heightuint32Initial core chain lock height.

RequestListSnapshots

Lists available snapshots

  • Used during state sync to discover available snapshots on peers.
  • See Snapshot data type for details.

RequestLoadSnapshotChunk

Used during state sync to retrieve snapshot chunks from peers.

FieldTypeLabelDescription
heightuint64The height of the snapshot the chunks belongs to.
versionuint32The application-specific format of the snapshot the chunk belongs to.
chunk_idbytesApplication-defined chunk identifier: Snapshot.hash for the first chunk, then identifiers returned in ResponseApplySnapshotChunk.next_chunks.

RequestOfferSnapshot

Offers a snapshot to the application.

  • OfferSnapshot is called when bootstrapping a node using state sync. The application may accept or reject snapshots as appropriate. Upon accepting, Tenderdash will retrieve and apply snapshot chunks via ApplySnapshotChunk. The application may also choose to reject a snapshot in the chunk response, in which case it should be prepared to accept further OfferSnapshot calls.
  • Only AppHash can be trusted, as it has been verified by the light client. Any other data can be spoofed by adversaries, so applications should employ additional verification schemes to avoid denial-of-service attacks. The verified AppHash is automatically checked against the restored application at the end of snapshot restoration.
  • For more information, see the Snapshot data type or the state sync section.
FieldTypeLabelDescription
snapshotSnapshotThe snapshot offered for restoration.
app_hashbytesThe light client-verified app hash for this height, from the blockchain. 32 bytes.

RequestPrepareProposal

Prepare and execute a new block proposal, potentially altering its transactions. Return same-block application/results hashes and next-state commitments. ADDED transactions enter the proposal without being added to the mempool; REMOVED transactions are removed from both. Changes to validators and consensus parameters from height H take effect at H+1. Preparation may be non-deterministic. See the PrepareProposal contract for transaction constraints, response validation and the exact conditions for preparing a fresh block.

FieldTypeLabelDescription
max_tx_bytesint64Currently configured maximum size in bytes taken by the modified transactions. The modified transactions cannot exceed this size.
txsbytesrepeatedPreliminary list of transactions that have been picked as part of the block to propose. Sent to the app for possible modifications.
local_last_commitCommitInfoInfo about the last commit, obtained locally from Tenderdash's data structures.
misbehaviorMisbehaviorrepeatedList of information about validators that acted incorrectly.
heightint64The height of the block that will be proposed.
timegoogle.protobuf.TimestampTimestamp of the block that that will be proposed.
next_validators_hashbytesMerkle root of the next validator set.
roundint32Round number for the block.
core_chain_locked_heightuint32Core chain lock height to be used when signing this block.
proposer_pro_tx_hashbytesProTxHash of the original proposer of the block.
proposed_app_versionuint64Proposer's latest available app protocol version.
versiontendermint.version.ConsensusApp and block version used to generate the block. App version included in the block can be modified by setting ResponsePrepareProposal.app_version.
quorum_hashbytesquorum_hash contains hash of validator quorum that will sign the block

RequestProcessProposal

Execute a proposed block deterministically against the last committed state. Return its status, same-block application/results hashes and next-state commitments. Keep execution speculative until FinalizeBlock. Processing can repeat for the same block and round after another execution context has replaced it. See the ProcessProposal contract and application requirements.

FieldTypeLabelDescription
txsbytesrepeatedList of transactions that have been picked as part of the proposed
proposed_last_commitCommitInfoInfo about the last commit, obtained from the information in the proposed block.
misbehaviorMisbehaviorrepeatedList of information about validators that acted incorrectly.
hashbytesThe block header's hash of the proposed block. It is computed as a Merkle tree from the header fields.
heightint64The height of the proposed block.
roundint32Round number for the block
timegoogle.protobuf.TimestampTimestamp included in the proposed block.
next_validators_hashbytesMerkle root of the next validator set.
core_chain_locked_heightuint32Core chain lock height to be used when signing this block.
core_chain_lock_updatetendermint.types.CoreChainLockNext core-chain-lock-update for validation in ABCI.
proposer_pro_tx_hashbytesProTxHash of the original proposer of the block.
proposed_app_versionuint64Proposer's latest available app protocol version.
versiontendermint.version.ConsensusApp and block version used to generate the block. App version MUST be verified by the app.
quorum_hashbytesquorum_hash contains hash of validator quorum that will sign the block

RequestQuery

Query for data from the application at current or past height.

  • Optionally return Merkle proof.
  • Merkle proof includes self-describing type field to support many types of Merkle trees and encoding formats.
FieldTypeLabelDescription
databytesRaw query bytes. Can be used with or in lieu of Path.
pathstringPath field of the request URI. Can be used with or in lieu of data. Apps MUST interpret /store as a query by key on the underlying store. The key SHOULD be specified in the data field. Apps SHOULD allow queries over specific types like /accounts/... or /votes/...
heightint64The block height for which you want the query (default=0 returns data for the latest committed block). Note that this is the height of the block containing the application's Merkle root hash, which represents the state as it was after committing the block at Height-1.
proveboolReturn Merkle proof with response if possible.

RequestVerifyVoteExtension

Verify the vote extension

Tenderdash calls it for two kinds of request, told apart by validator_pro_tx_hash:

  • Precommit verification (validator_pro_tx_hash set): the vote extensions of one validator's Precommit, exactly as its Application returned them from ExtendVote.
  • Commit verification (validator_pro_tx_hash empty): the extension vector of a commit, after ProcessProposal of the committed block with the same hash, height and round (the commit round). The vector holds only the threshold-recoverable extensions (THRESHOLD_RECOVER and THRESHOLD_RECOVER_RAW), in the order ExtendVote returned them; extensions of any other type never appear in a commit. It can be empty.

Usage

  • RequestVerifyVoteExtension.vote_extensions can be empty. For a Precommit, the Application's interpretation of it should be that the Application running at the process that sent the vote chose not to extend it. Tenderdash will always call RequestVerifyVoteExtension, even for 0 length vote extensions.
  • For a Precommit, if ResponseVerifyVoteExtension.status is REJECT, Tenderdash will reject the whole received vote. See the Requirements section to understand the potential liveness implications of this.
  • For a commit, the Application MUST compare the vector with the threshold-recoverable subset of the extensions it expects for that block, in order, and return REJECT if they differ: a commit whose block signature is valid can still carry a stripped, duplicated or replayed vector. Tenderdash requires ACCEPT before it saves the block and commit or calls FinalizeBlock. What REJECT does depends on the path:
    • consensus: the commit is discarded without blaming its sender. A commit whose block the node already holds is checked first and never changes the round. A commit for a later round whose block has not arrived moves the node to that round on its threshold signature alone; it is checked when the block arrives, then the commits other peers sent meanwhile. Copies of a commit already waiting are dropped. If the node's own commit is rejected, nothing is persisted and the node waits for a peer's commit. The block is processed again only for a commit of a round other than the one processed last. After a rejection, Tenderdash calls ExtendVote for the block and round, and refuses, without processing the block again or calling the Application, a later commit of that round that would need the block processed again, when its vector differs from the one returned or equals it and was rejected. Consensus WAL replay follows these rules;
    • block sync: the block is not applied; the peer that served it is dropped and the height is requested again;
    • handshake catch-up (application behind the block store): the commit is already in the block store, so the node fails to start; there is no automatic recovery, and the operator has to roll back or re-sync the node.
  • Any status other than ACCEPT, including UNKNOWN, counts as REJECT. An error from the ABCI call itself, as opposed to a status, is fatal on every path.
  • The implementation of VerifyVoteExtension MUST be deterministic. Moreover, the value of ResponseVerifyVoteExtension.status MUST exclusively depend on the parameters passed in the call to RequestVerifyVoteExtension, the block processed by ProcessProposal, and the last committed Application state (see Requirements section).
  • For a Precommit, application implementers SHOULD always set ResponseVerifyVoteExtension.status to ACCEPT, unless they really know what the potential liveness implications of returning REJECT are.

When does Tenderdash call it?

When a validator p is in Tenderdash consensus height h and receives, from another validator q, a Precommit message for a block (not nil) at height h:

  1. If the Precommit message does not contain a vote extensions with a valid signature, Tenderdash discards the message as invalid.
  • a 0-length vote extensions is valid as long as its accompanying signature is also valid.
  1. Else, p's Tenderdash calls RequestVerifyVoteExtension.
  2. The Application returns accept or reject via ResponseVerifyVoteExtension.status.
  3. If the Application returns
  • accept, p's Tenderdash will keep the received vote, together with its corresponding vote extension in its internal data structures. Threshold-recoverable extensions are recovered into CommitInfo when the commit is assembled.
  • reject, p's Tenderdash will deem the Precommit message invalid and discard it.

Whenever a process is about to save a block and its commit, in consensus, block sync or replay, it first calls RequestVerifyVoteExtension for the commit, once ProcessProposal has processed the block. This includes commits the process assembled from its own +2/3 precommits.

FieldTypeLabelDescription
hashbytesThe header hash of the propsed block that the vote extensions refers to.
validator_pro_tx_hashbytesProTxHash of the validator that signed the extensions; empty for commit verification.
heightint64Height of the block (for sanity check).
roundint32Round of the vote; for commit verification, the commit round.
vote_extensionsExtendVoteExtensionrepeatedApplication-specific information signed by Tenderdash. Can have 0 length.

Response

FieldTypeLabelDescription
exceptionResponseException
echoResponseEcho
flushResponseFlush
infoResponseInfo
init_chainResponseInitChain
queryResponseQuery
check_txResponseCheckTx
list_snapshotsResponseListSnapshots
offer_snapshotResponseOfferSnapshot
load_snapshot_chunkResponseLoadSnapshotChunk
apply_snapshot_chunkResponseApplySnapshotChunk
prepare_proposalResponsePrepareProposal
process_proposalResponseProcessProposal
extend_voteResponseExtendVote
verify_vote_extensionResponseVerifyVoteExtension
finalize_blockResponseFinalizeBlock

ResponseApplySnapshotChunk

FieldTypeLabelDescription
resultResponseApplySnapshotChunk.ResultThe result of applying this chunk.
refetch_chunksbytesrepeatedIdentifiers of chunks to discard, refetch and reapply, regardless of result.
reject_sendersstringrepeatedReject the given P2P senders, regardless of Result. Any chunks already applied will not be refetched unless explicitly requested, but queued chunks from these senders will be discarded, and new chunks or other snapshots rejected.
next_chunksbytesrepeatedChunk identifiers to enqueue after ACCEPT; ignored for other results.

ResponseCheckTx

FieldTypeLabelDescription
codeuint32Response code.
databytesResult bytes, if any.
infostringAdditional information. May be non-deterministic.
gas_wantedint64Amount of gas requested for transaction.
codespacestringNamespace for the code.
senderstringThe transaction's sender (e.g. the signer).
priorityint64The transaction's priority (for mempool ordering).

ResponseEcho

FieldTypeLabelDescription
messagestringThe input string.

ResponseException

nondeterministic

FieldTypeLabelDescription
errorstring

ResponseExtendVote

FieldTypeLabelDescription
vote_extensionsExtendVoteExtensionrepeatedOptional information signed by Tenderdash.

ResponseFinalizeBlock

FieldTypeLabelDescription
retain_heightint64Blocks below this height may be removed. Defaults to 0 (retain all).
propose_next_block_immediatelyboolWhen true, this node does not wait for transactions (create-empty-blocks-interval) before proposing at the next height, in round 0 or, on consensus version 2, in a round entered after a silent proposer's round was skipped: the application has block-driven work pending, for example withdrawal transactions to sign. A hint for the local node only, consumed once; a node that restarts in between falls back to the configured wait. Defaults to false.

ResponseFlush

ResponseInfo

FieldTypeLabelDescription
datastringSome arbitrary information.
versionstringThe application software semantic version.
app_versionuint64The application protocol version.
last_block_heightint64Last height persisted by FinalizeBlock.
last_block_app_hashbytesApplication hash at the last persisted height. 32 bytes.

ResponseInitChain

FieldTypeLabelDescription
consensus_paramstendermint.types.ConsensusParamsInitial consensus-critical parameters (optional).
app_hashbytesInitial application hash. 32 bytes.
validator_set_updateValidatorSetUpdateInitial validator set (optional).
next_core_chain_lock_updatetendermint.types.CoreChainLockInitial core chain lock update.
initial_core_heightuint32Initial height of core lock.
genesis_timegoogle.protobuf.TimestampoptionalOverride genesis time with provided time.

ResponseListSnapshots

FieldTypeLabelDescription
snapshotsSnapshotrepeatedList of local state snapshots.

ResponseLoadSnapshotChunk

FieldTypeLabelDescription
chunkbytesThe binary chunk contents, in an arbitray format. Chunk messages cannot be larger than 16 MB including metadata, so 10 MB is a good starting point.

ResponseOfferSnapshot

FieldTypeLabelDescription
resultResponseOfferSnapshot.ResultThe result of the snapshot offer.

ResponsePrepareProposal

FieldTypeLabelDescription
tx_recordsTxRecordrepeatedPossibly modified list of transactions that have been picked as part of the proposed block.
app_hashbytesThe Merkle root hash of the application state. 32 bytes.
tx_resultsExecTxResultrepeatedList of structures containing the data resulting from executing the transactions.
consensus_param_updatestendermint.types.ConsensusParamsChanges to consensus-critical gas, size, and other parameters that will be applied at next height.
core_chain_lock_updatetendermint.types.CoreChainLockCore chain lock that will be used for next block.
validator_set_updateValidatorSetUpdateChanges to validator set that will be applied at next height.
app_versionuint64Application version that was used to create the current proposal.

ResponseProcessProposal

FieldTypeLabelDescription
statusResponseProcessProposal.ProposalStatusenum that signals if the application finds the proposal valid.
app_hashbytesThe Merkle root hash of the application state. 32 bytes.
tx_resultsExecTxResultrepeatedList of structures containing the data resulting from executing the transactions.
consensus_param_updatestendermint.types.ConsensusParamsChanges to consensus-critical gas, size, and other parameters.
validator_set_updateValidatorSetUpdateChanges to validator set (set voting power to 0 to remove).
eventsEventrepeatedType & Key-Value events for indexing

ResponseQuery

FieldTypeLabelDescription
codeuint32Response code.
logstringThe output of the application's logger. May be non-deterministic.
infostringAdditional information. May be non-deterministic.
indexint64The index of the key in the tree.
keybytesThe key of the matching data.
valuebytesThe value of the matching data.
proof_opstendermint.crypto.ProofOpsSerialized proof for the value data, if requested, to be verified against the app_hash for the given Height.
heightint64The block height from which data was derived. Note that this is the height of the block containing the application's Merkle root hash, which represents the state as it was after committing the block at Height-1.
codespacestringNamespace for the code.

ResponseVerifyVoteExtension

FieldTypeLabelDescription
statusResponseVerifyVoteExtension.VerifyStatusenum signaling if the application accepts the vote extension

Snapshot

FieldTypeLabelDescription
heightuint64The height at which the snapshot was taken
versionuint32The application-specific snapshot version
hashbytesArbitrary snapshot hash, equal only if identical
metadatabytesArbitrary application metadata

ThresholdPublicKeyUpdate

FieldTypeLabelDescription
threshold_public_keytendermint.crypto.PublicKey

TxRecord

FieldTypeLabelDescription
actionTxRecord.TxActionWhat should Tenderdash do with this transaction?
txbytesTransaction contents.

TxResult

TxResult contains results of executing the transaction.

One usage is indexing transaction results.

FieldTypeLabelDescription
heightint64
indexuint32
txbytes
resultExecTxResult

Validator

Validator

FieldTypeLabelDescription
powerint64The voting power
pro_tx_hashbytes

ValidatorSetUpdate

ValidatorSetUpdate represents a change in the validator set. It can be used to add, remove, or update a validator.

Validator set update consists of multiple ValidatorUpdate records, each of them can be used to add, remove, or update a validator, according to the following rules:

  1. If a validator with the same public key already exists in the validator set and power is greater than 0, the existing validator will be updated with the new power.
  2. If a validator with the same public key already exists in the validator set and power is 0, the existing validator will be removed from the validator set.
  3. If a validator with the same public key does not exist in the validator set and the power is greater than 0, a new validator will be added to the validator set.
  4. As a special case, if quorum hash has changed, all existing validators will be removed before applying the new validator set update.
FieldTypeLabelDescription
validator_updatesValidatorUpdaterepeated
threshold_public_keytendermint.crypto.PublicKey
quorum_hashbytes

ValidatorUpdate

ValidatorUpdate

FieldTypeLabelDescription
pub_keytendermint.crypto.PublicKey
powerint64
pro_tx_hashbytes
node_addressstringnode_address is an URI containing address of validator (proto://node_id@ip_address:port), for example: tcp://f2dbd9b0a1f541a7c44d34a58674d0262f5feca5@12.34.5.6:1234

VoteInfo

VoteInfo

FieldTypeLabelDescription
validatorValidator
signed_last_blockbool

CheckTxType

Type of transaction check

NameNumberDescription
NEW0NEW is the default and means that a full check of the tranasaction is required.
RECHECK1RECHECK is used when the mempool is initiating a normal recheck of a transaction.

MisbehaviorType

NameNumberDescription
UNKNOWN0
DUPLICATE_VOTE1
LIGHT_CLIENT_ATTACK2

ResponseApplySnapshotChunk.Result

NameNumberDescription
UNKNOWN0Unknown result, abort all snapshot restoration
ACCEPT1Chunk successfully accepted
ABORT2Abort all snapshot restoration
RETRY3Retry chunk (combine with refetch and reject)
RETRY_SNAPSHOT4Retry snapshot (combine with refetch and reject)
REJECT_SNAPSHOT5Reject this snapshot, try others
COMPLETE_SNAPSHOT6Complete this snapshot, no more chunks

ResponseOfferSnapshot.Result

NameNumberDescription
UNKNOWN0Unknown result, abort all snapshot restoration
ACCEPT1Snapshot accepted, apply chunks
ABORT2Abort all snapshot restoration
REJECT3Reject this specific snapshot, try others
REJECT_FORMAT4Reject all snapshots of this format, try others
REJECT_SENDER5Reject all snapshots from the sender(s), try others

ResponseProcessProposal.ProposalStatus

NameNumberDescription
UNKNOWN0Unspecified error occurred
ACCEPT1Proposal accepted
REJECT2Proposal is not valid

ResponseVerifyVoteExtension.VerifyStatus

NameNumberDescription
UNKNOWN0
ACCEPT1
REJECT2

TxRecord.TxAction

TxAction contains App-provided information on what to do with a transaction that is part of a raw proposal

NameNumberDescription
UNKNOWN0Unknown action
UNMODIFIED1The Application did not modify this transaction.
ADDED2The Application added this transaction.
REMOVED3The Application wants this transaction removed from the proposal and the mempool.
DELAYED4The Application wants this transaction removed from the proposal but not the mempool.

ABCIApplication

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)