package resdb

Get desktop application:
View/edit binary Protocol Buffers messages

• repeated BatchClientRequest.ClientRequest client_requests = 1

• uint64 createtime = 2

• uint64 local_id = 3

Used in: BatchClientRequest

• optional Request request = 1

• optional SignatureInfo signature = 2

• int32 id = 3

• repeated bytes response = 1

• repeated SignatureInfo signatures = 2

• int32 proxy_id = 3

• uint64 seq = 4

• uint64 current_view = 5

• uint64 createtime = 6

• uint64 local_id = 7

• repeated ClientTransactions transactions = 1

• uint64 min_seq = 2

• uint64 max_seq = 3

• repeated BatchUserRequest.UserRequest user_requests = 1

• uint64 createtime = 2

• uint64 local_id = 3

• uint64 seq = 4

• optional Certs committed_certs = 5

• bytes hash = 6

• int32 proxy_id = 7

Used in: BatchUserRequest

• optional Request request = 1

• optional SignatureInfo signature = 2

• int32 id = 3

• repeated bytes response = 1

• repeated SignatureInfo signatures = 2

• int32 proxy_id = 3

• uint64 seq = 4

• uint64 current_view = 5

• uint64 createtime = 6

• uint64 local_id = 7

• bytes hash = 8

• int32 primary_id = 9

• optional Block.Header header = 1

• bytes transaction_data = 2

• optional HashValue hash = 3

• uint64 min_seq = 4

• uint64 max_seq = 5

• uint64 miner = 6

• uint64 block_time = 7

• uint64 mining_time = 8

Used in: Block

• uint64 height = 1

• optional HashValue pre_hash = 2

• optional HashValue merkle_hash = 3

• uint64 nonce = 4

CertificateInfo is published from the adminisotr and will be written to a cert file.

Used in: ReplicaInfo

• optional KeyInfo admin_public_key = 1

  the public key owned by the administor.

• optional CertificateKey public_key = 3

  public key info with certificate.

• int64 node_id = 4

Used in: CertificateInfo, ClientCertInfo, ClientCertResponse, HeartBeatInfo

• optional CertificateKeyInfo public_key_info = 1

  the public key of current node.

• optional SignatureInfo certificate = 2

  the certificate of `public_key_info`.

Used in: CertificateKey

• optional KeyInfo key = 1

• int64 node_id = 2

• CertificateKeyInfo.Type type = 3

• string ip = 4

• int32 port = 5

  the ip:port the replica uses, if it is a client node, can be ignored.

Used in: CertificateKeyInfo

• REPLICA = 0

• CLIENT = 1

Used in: BatchUserRequest, Request

• repeated SignatureInfo committed_certs = 1

• uint64 seq = 1

• bytes hash = 2

• optional SignatureInfo hash_signature = 3

• repeated bytes hashs = 4

• repeated uint64 seqs = 5

• uint64 primary_id = 6

• uint64 view = 7

• optional CertificateKey public_key = 1

• optional ReplicaInfo client_info = 2

• repeated CertificateKey public_keys = 1

• repeated ReplicaInfo replicas = 2

• string value = 1

• string value = 1

Used in: BatchClientTransactions

• bytes transaction_data = 1

• uint64 seq = 2

• uint64 create_time = 3

• bytes resp_str = 1

• bytes last_hash = 1

  the last updated checkpoint hash value.

• bytes current_hash = 2

  the current request value hash.

• bytes last_block_hash = 3

  the hash value of last block.

256 bits hash value

Used in: Block, Block.Header

• repeated uint64 bits = 1

• repeated CertificateKey public_keys = 1

• repeated int64 node_version = 8

• uint32 primary = 2

• uint64 version = 3

• int32 sender = 4

• string ip = 5

• int32 port = 6

• int64 hb_version = 7

Used in: Items

• string key = 1

• optional ValueInfo value_info = 2

Used in: KVResponse

• repeated Item item = 1

• KVRequest.CMD cmd = 1

• string key = 2

• bytes value = 3

• int32 version = 4

• string min_key = 5

  For get key range

• string max_key = 6

• int32 min_version = 7

  For get history for a key

• int32 max_version = 8

• int32 top_number = 9

  For top history

• bytes smart_contract_request = 10

• string sql_query = 11

  NEW: raw SQL text for SQL commands (cmd == SQL)

Used in: KVRequest

• NONE = 0

• SET = 1

• GET = 2

• GETALLVALUES = 3

• GETRANGE = 4

• SET_WITH_VERSION = 5

• GET_WITH_VERSION = 6

• GET_ALL_ITEMS = 7

• GET_KEY_RANGE = 8

• GET_HISTORY = 9

• GET_TOP = 10

• SQL = 11

  NEW: SQL command type

• string key = 1

• bytes value = 2

• optional ValueInfo value_info = 3

• optional Items items = 4

• bytes smart_contract_response = 10

• string sql_response = 11

  NEW: response payload for SQL commands

Used in: CertificateInfo, CertificateKeyInfo, SignatureKeyInfo, Transaction

• bytes key = 1

• SignatureInfo.HashType hash_type = 2

• LoggingInfo.Type type = 1

• int64 seq = 2

• bytes request = 3

• bytes signature = 4

Used in: LoggingInfo

• NONE = 0

• ASSIGN = 1

• ADD = 2

• FETCH = 3

• COMMIT = 4

• CLEAR = 5

• None = 0

• TPORT_TYPE = 1

• ENVIRONMENT_EC2 = 2

• TCP = 3

• optional ReplicaInfo replica_info = 1

• uint64 view_number = 1

• repeated Request request = 2

• repeated ViewChangeMessage viewchange_messages = 3

• NONE = 0

• TYPE_COMMITTED_BLOCK = 101

• TYPE_SHIFT_MSG = 102

Used in: ViewChangeMessage

• uint64 seq = 1

• repeated PreparedProof proof = 2

Used in: PreparedMessage

• optional Request request = 1

• optional SignatureInfo signature = 2

• uint64 min_seq = 1

• uint64 max_seq = 2

• repeated Request transactions = 1

• uint64 max_seq = 2

• uint64 min_seq = 1

• uint64 max_seq = 2

• repeated Request request = 1

• repeated SignatureInfo signature = 2

Used in: Request, ResConfigData

• repeated ReplicaInfo replica_info = 1

• int32 region_id = 2

Used in: ClientCertInfo, ClientCertResponse, NewReplicaRequest, RegionInfo, ReplicaState, Request

• int64 id = 1

• optional string ip = 2

• optional int32 port = 3

• optional CertificateInfo certificate_info = 4

  include the private/public key, public key of admin and the certificate published by admin.

Used in: ReplicaStates

• int64 view = 1

• optional ReplicaInfo replica_info = 2

• optional ResConfigData replica_config = 3

• repeated ReplicaState state = 1

The request message containing requested numbers

Used in: BatchClientRequest.ClientRequest, BatchUserRequest.UserRequest, NewViewMessage, PreparedProof, QueryResponse, RecoveryResponse, RequestWithProof, RequestWithProof.RequestData

• int32 type = 1

• bytes data = 2

• optional ReplicaInfo client_info = 3

• uint64 current_view = 4

• uint64 seq = 5

• bytes hash = 6

• int32 sender_id = 7

• int64 proxy_id = 8

  the replica which receives the client request.

• bool is_system_request = 9

  whether is system information related

• uint64 current_executed_seq = 10

  request, like CMD:ADDREPLICA.

• bool need_response = 11

• int32 ret = 12

• optional SignatureInfo data_signature = 13

• optional RegionInfo region_info = 14

• optional Certs committed_certs = 15

• bool is_recovery = 16

• int32 primary_id = 17

• repeated bytes hashs = 18

• repeated uint64 seqs = 19

• int32 user_type = 20

• int64 user_seq = 21

• int64 queuing_time = 22

• int64 uid = 23

• int64 create_time = 24

• int64 commit_time = 25

• bytes data_hash = 26

• bool force_recovery = 27

• TYPE_NONE = 0

• TYPE_HEART_BEAT = 1

• TYPE_CLIENT_REQUEST = 2

• TYPE_PRE_PREPARE = 3

• TYPE_PREPARE = 4

• TYPE_COMMIT = 5

• TYPE_CLIENT_CERT = 6

• TYPE_RESPONSE = 7

• TYPE_RECOVERY_DATA = 8

• TYPE_RECOVERY_DATA_RESP = 9

• TYPE_CHECKPOINT = 10

• TYPE_QUERY = 11

• TYPE_REPLICA_STATE = 12

  get replica state.

• TYPE_NEW_TXNS = 14

  new transactions sent by proxy,

• TYPE_GEO_REQUEST = 15

  with batch transactions.

• TYPE_VIEWCHANGE = 16

• TYPE_NEWVIEW = 17

• TYPE_CUSTOM_QUERY = 18

• TYPE_CUSTOM_CONSENSUS = 19

• TYPE_STATUS_SYNC = 20

• NUM_OF_TYPE = 21

  the total number of types.

• repeated RequestWithProof requests = 1

Used in: RequestSet

• optional Request request = 1

  The committed request.

• repeated RequestWithProof.RequestData proofs = 2

  proof from distinct replicas.

• uint64 seq = 3

Used in: RequestWithProof

• optional Request request = 1

• optional SignatureInfo signature = 2

Used in: ReplicaState

• repeated RegionInfo region = 1

• int32 self_region_id = 2

• optional storage.LevelDBInfo leveldb_info = 4

• optional storage.DuckDBInfo duckdb_info = 25

• optional bool enable_viewchange = 5

• optional int32 view_change_timeout_ms = 10

• optional bool not_need_signature = 6

  when delivering messages, it should be signed or not.

• optional bool is_performance_running = 7

  if it is running a performance benchmark.

• optional int32 max_process_txn = 8

  max client transactions in flight.

• optional int32 client_batch_num = 11

  batch size of transaction for each client request

• optional int32 worker_num = 12

  batch size of transaction for each client request

• optional int32 input_worker_num = 13

• optional int32 output_worker_num = 14

• optional int32 tcp_batch_num = 15

• optional bool require_txn_validation = 16

  for python sdk

• optional bool recovery_enabled = 17

  whether to enable recovery locally

• optional string recovery_path = 18

• optional int32 recovery_buffer_size = 19

• optional int32 recovery_ckpt_time_s = 20

• optional bool enable_resview = 23

• optional bool enable_faulty_switch = 24

• optional bool use_chain_hotstuff = 9

  for hotstuff.

• optional int32 max_client_complaint_num = 21

• optional int32 duplicate_check_frequency_useconds = 22

Network message used to deliver Requests between replicas and client.

• bytes data = 1

• optional SignatureInfo signature = 2

• Response.Result result = 1

• repeated ResponseData resp = 2

  signature for each resp.

Used in: Response

• OK = 0

• ERROR = -1

The response message containing response

Used in: Response

• bytes data = 1

• optional SignatureInfo signature = 2

  signature for each resp.

• bytes public_key = 1

• bytes private_key = 2

• SignatureInfo.HashType hash_type = 3

Used in: BatchClientRequest.ClientRequest, BatchClientResponse, BatchUserRequest.UserRequest, BatchUserResponse, CertificateKey, Certs, CheckPointData, PreparedProof, RecoveryResponse, Request, RequestWithProof.RequestData, ResDBMessage, ResponseData, StableCheckPoint

• SignatureInfo.HashType hash_type = 1

• int64 node_id = 2

• bytes signature = 3

Used in: KeyInfo, SecretKey, SignatureInfo

• NONE = 0

• RSA = 1

• ED25519 = 2

• CMAC_AES = 3

• ECDSA = 4

Used to construct SignatureVerifier.

• optional KeyInfo admin_public_key = 1

  the public key owned by the administor.

• optional KeyInfo private_key = 2

  the private key from the user, used to sign messages.

• int64 node_id = 3

  the unique id of the replica or client.

• uint64 height = 1

• int32 shift_idx = 2

• int32 sender = 3

Used in: ViewChangeMessage

• uint64 seq = 1

• bytes hash = 2

• repeated SignatureInfo signatures = 3

• int32 view = 1

• int32 primary_id = 2

• SystemInfoRequest.Type type = 1

• bytes request = 2

Used in: SystemInfoRequest

• NONE = 0

• ADD_REPLICA = 1

• int32 seq = 1

(message has no fields)

• bytes data = 1

• optional KeyInfo public_key = 2

• bytes signature = 3

Used in: Item, KVResponse

• bytes value = 2

• int32 version = 3

Used in: NewViewMessage

• uint64 view_number = 1

• optional StableCheckPoint stable_ckpt = 2

• repeated PreparedMessage prepared_msg = 3