package hashdb.v1

Get desktop application:
View/edit binary Protocol Buffers messages

* Define all methods implementes by the gRPC Get: get the value for a specific key Set: set the value for a specific key SetProgram: set the byte data for a specific key GetProgram: get the byte data for a specific key Flush: wait for all the pendings writes to the DB are done

• rpc GetLatestStateRoot (google.protobuf.Empty, GetLatestStateRootResponse)

  hashdb.proto:24

  message GetLatestStateRootResponse

  hashdb.proto:249

  * @dev GetLatestStateRootResponse @param {latest_root} - latest state root @param {result} - result code

  • optional Fea latest_root = 1

  • optional ResultCode result = 2

• rpc Set (SetRequest, SetResponse)

  hashdb.proto:25

  message SetRequest

  hashdb.proto:66

  * @dev SetRequest @param {old_root} - merkle-tree root @param {key} - key to set @param {value} - scalar value to set (HEX string format) @param {persistence} - indicates if it should be stored only in CACHE, in the SQL DATABASE, or it is just TEMPORARY and should be deleted at the flush of this batch UUID @param {details} - indicates if it should return all response parameters (true) or just the new root (false) @param {get_db_read_log} - indicates if it should return the DB reads generated during the execution of the request @param {batch_uuid} - indicates a unique identifier of the current batch or session; data for this batch can be stored in memory until flushed to database @param {tx_index} - current transaction ordinal index: 0, 1, 2... @param {block_index} - current block ordinal index: 0, 1, 2...

  • optional Fea old_root = 1

  • optional Fea key = 2

  • string value = 3

  • Persistence persistence = 4

  • bool details = 5

  • bool get_db_read_log = 6

  • string batch_uuid = 7

  • uint64 tx_index = 8

  • uint64 block_index = 9

  message SetResponse

  hashdb.proto:272

  * @dev SetResponse @param {old_root} - merkle-tree root @param {new_root} - merkle-tree new root @param {key} - key to look for @param {siblings} - array of siblings @param {ins_key} - key found @param {ins_value} - value found (HEX string format) @param {is_old0} - is new insert or delete @param {old_value} - old value (HEX string format) @param {new_value} - new value (HEX string format) @param {mode} @param {proof_hash_counter} @param {db_read_log} - list of db records read during the execution of the request @param {result} - result code @param {sibling_left_child} - on delete not found, use children to hash intermediate node (to be sure that it's a intermediate) @param {sibling_right_child} - on delete not found, use children to hash intermediate node (to be sure that it's a intermediate)

  • optional Fea old_root = 1

  • optional Fea new_root = 2

  • optional Fea key = 3

  • map<uint64, SiblingList> siblings = 4

  • optional Fea ins_key = 5

  • string ins_value = 6

  • bool is_old0 = 7

  • string old_value = 8

  • string new_value = 9

  • string mode = 10

  • uint64 proof_hash_counter = 11

  • map<string, FeList> db_read_log = 12

  • optional ResultCode result = 13

  • optional Fea sibling_left_child = 14

  • optional Fea sibling_right_child = 15

• rpc Get (GetRequest, GetResponse)

  hashdb.proto:26

  message GetRequest

  hashdb.proto:86

  * @dev GetRequest @param {root} - merkle-tree root @param {key} - key to look for @param {details} - indicates if it should return all response parameters (true) or just the new root (false) @param {get_db_read_log} - indicates if it should return the DB reads generated during the execution of the request @param {batch_uuid} - indicates a unique identifier of the current batch or session; data for this batch can be stored in memory until flushed to database

  • optional Fea root = 1

  • optional Fea key = 2

  • bool details = 3

  • bool get_db_read_log = 4

  • string batch_uuid = 5

  message GetResponse

  hashdb.proto:303

  * @dev GetResponse @param {root} - merkle-tree root @param {key} - key to look for @param {siblings} - array of siblings @param {ins_key} - key found @param {ins_value} - value found (HEX string format) @param {is_old0} - is new insert or delete @param {value} - value retrieved (HEX string format) @param {proof_hash_counter} @param {db_read_log} - list of db records read during the execution of the request @param {result} - result code

  • optional Fea root = 1

  • optional Fea key = 2

  • map<uint64, SiblingList> siblings = 3

  • optional Fea ins_key = 4

  • string ins_value = 5

  • bool is_old0 = 6

  • string value = 7

  • uint64 proof_hash_counter = 8

  • map<string, FeList> db_read_log = 9

  • optional ResultCode result = 10

• rpc SetProgram (SetProgramRequest, SetProgramResponse)

  hashdb.proto:27

  message SetProgramRequest

  hashdb.proto:103

  * @dev SetProgramRequest @param {key} - key to set @param {data} - Program data to store @param {persistence} - indicates if it should be stored only in CACHE, in the SQL DATABASE, or it is just TEMPORARY and should be deleted at the flush of this batch UUID @param {batch_uuid} - indicates a unique identifier of the current batch or session; data for this batch can be stored in memory until flushed to database @param {tx_index} - current transaction ordinal index: 0, 1, 2... @param {block_index} - current block ordinal index: 0, 1, 2...

  • optional Fea key = 1

  • bytes data = 2

  • Persistence persistence = 3

  • string batch_uuid = 4

  • uint64 tx_index = 5

  • uint64 block_index = 6

  message SetProgramResponse

  hashdb.proto:320

  * @dev SetProgramResponse @param {result} - result code

  • optional ResultCode result = 1

• rpc GetProgram (GetProgramRequest, GetProgramResponse)

  hashdb.proto:28

  message GetProgramRequest

  hashdb.proto:117

  * @dev GetProgramRequest @param {key} - key to get program data @param {batch_uuid} - indicates a unique identifier of the current batch or session; data for this batch can be stored in memory until flushed to database

  • optional Fea key = 1

  • string batch_uuid = 2

  message GetProgramResponse

  hashdb.proto:329

  * @dev GetProgramResponse @param {data} - program data retrieved @param {result} - result code

  • bytes data = 1

  • optional ResultCode result = 2

• rpc LoadDB (LoadDBRequest, google.protobuf.Empty)

  hashdb.proto:29

  message LoadDBRequest

  hashdb.proto:128

  * @dev LoadDBRequest @param {input_db} - list of db records (MT) to load in the database @param {persistent} - indicates if it should be stored in the SQL database (true) or only in the memory cache (false) @param {state_root} - current (old) state root made up of the provided db records

  • map<string, FeList> input_db = 1

  • bool persistent = 2

  • optional Fea state_root = 3

• rpc LoadProgramDB (LoadProgramDBRequest, google.protobuf.Empty)

  hashdb.proto:30

  message LoadProgramDBRequest

  hashdb.proto:139

  * @dev LoadProgramDBRequest @param {input_program_db} - list of db records (program) to load in the database @param {persistent} - indicates if it should be stored in the SQL database (true) or only in the memory cache (false)

  • map<string, bytes> input_program_db = 1

  • bool persistent = 2

• rpc FinishTx (FinishTxRequest, google.protobuf.Empty)

  hashdb.proto:31

  message FinishTxRequest

  hashdb.proto:162

  * @dev FinishTxRequest @param {batch_uuid} - indicates a unique identifier of the current batch or session which tx will be finished @param {new_state_root} - state root at this point of the execution @param {persistence} - indicates if it should be stored only in CACHE, in the SQL DATABASE, or it is just TEMPORARY and should be deleted at the flush of this batch UUID

  • string batch_uuid = 1

  • string new_state_root = 2

  • Persistence persistence = 3

• rpc StartBlock (StartBlockRequest, google.protobuf.Empty)

  hashdb.proto:32

  message StartBlockRequest

  hashdb.proto:174

  * @dev StartBlockRequest @param {batch_uuid} - indicates a unique identifier of the current batch or session which block started @param {new_state_root} - state root at this point of the execution @param {persistence} - indicates if it should be stored only in CACHE, in the SQL DATABASE, or it is just TEMPORARY and should be deleted at the flush of this batch UUID

  • string batch_uuid = 1

  • string old_state_root = 2

  • Persistence persistence = 3

• rpc FinishBlock (FinishBlockRequest, google.protobuf.Empty)

  hashdb.proto:33

  message FinishBlockRequest

  hashdb.proto:186

  * @dev FinishBlockRequest @param {batch_uuid} - indicates a unique identifier of the current batch or session which block will be finished @param {new_state_root} - state root at this point of the execution @param {persistence} - indicates if it should be stored only in CACHE, in the SQL DATABASE, or it is just TEMPORARY and should be deleted at the flush of this batch UUID

  • string batch_uuid = 1

  • string new_state_root = 2

  • Persistence persistence = 3

• rpc Flush (FlushRequest, FlushResponse)

  hashdb.proto:34

  message FlushRequest

  hashdb.proto:150

  * @dev FlushRequest @param {batch_uuid} - indicates a unique identifier of the current batch or session which data will be flushed to cache (and database if required) @param {new_state_root} - state root at this point of the execution @param {persistence} - indicates if it should be stored only in CACHE, in the SQL DATABASE, or it is just TEMPORARY and should be deleted at the flush of this batch UUID

  • string batch_uuid = 1

  • string new_state_root = 2

  • Persistence persistence = 3

  message FlushResponse

  hashdb.proto:340

  * @dev FlushResponse @param {flush_id} - id assigned to this flush data @param {stored_flush_id} - id of the last flush data sent to database @param {result} - result code

  • uint64 flush_id = 1

  • uint64 stored_flush_id = 2

  • optional ResultCode result = 3

• rpc GetFlushStatus (google.protobuf.Empty, GetFlushStatusResponse)

  hashdb.proto:35

  message GetFlushStatusResponse

  hashdb.proto:357

  * @dev GetFlushStatusResponse @param {stored_flush_id} - id of the last flush data sent to database @param {sending_flush_id} - id of the flush data being sent now to database @param {last_flush_id} - id assigned to the last call to flush @param {pending_to_flush_nodes} - number of SMT nodes pending to flush @param {pending_to_flush_program} - number of SC programs pending to flush @param {storing_nodes} - number of SMT nodes being stored in the hash database @param {storing_program} - number of SC programs being stored in the hash database @param {prover_id} - id assigned to this instance of the prover process

  • uint64 stored_flush_id = 1

  • uint64 storing_flush_id = 2

  • uint64 last_flush_id = 3

  • uint64 pending_to_flush_nodes = 4

  • uint64 pending_to_flush_program = 5

  • uint64 storing_nodes = 6

  • uint64 storing_program = 7

  • string prover_id = 8

• rpc GetFlushData (GetFlushDataRequest, GetFlushDataResponse)

  hashdb.proto:36

  message GetFlushDataRequest

  hashdb.proto:196

  * @dev GetFlushDataRequest @param {flush_id} - last stored flush ID got using this method, or 0 if it never was called before

  • uint64 flush_id = 1

  message GetFlushDataResponse

  hashdb.proto:376

  * @dev GetFlushDataResponse @param {stored_flush_id} - id of the last flush data sent to database @param {nodes} - data to insert in the nodes table @param {program} - data to insert in the program table @param {nodes_state_root} - nodes state root to update in the nodes table @param {result} - result code

  • uint64 stored_flush_id = 1

  • map<string, string> nodes = 2

  • map<string, string> program = 3

  • string nodes_state_root = 4

  • optional ResultCode result = 5

• rpc ConsolidateState (ConsolidateStateRequest, ConsolidateStateResponse)

  hashdb.proto:37

  message ConsolidateStateRequest

  hashdb.proto:205

  * @dev ConsolidateStateRequest @param {virtual_state_root} - virtual state root to consolidate (and previous virtual state roots, too) @param {persistence} - indicates if it should be stored only in CACHE, in the SQL DATABASE, or it is just TEMPORARY and should be deleted at the flush of this batch UUID

  • optional Fea virtual_state_root = 1

  • Persistence persistence = 2

  message ConsolidateStateResponse

  hashdb.proto:391

  * @dev ConsolidateStateResponse @param {consolidated_state_root} - consolidated state root at the point of the execution of virtual_state_root @param {flush_id} - id assigned to this flush data @param {stored_flush_id} - id of the last flush data sent to database @param {result} - result code

  • optional Fea consolidated_state_root = 1

  • uint64 flush_id = 2

  • uint64 stored_flush_id = 3

  • optional ResultCode result = 4

• rpc Purge (PurgeRequest, PurgeResponse)

  hashdb.proto:38

  message PurgeRequest

  hashdb.proto:216

  * @dev PurgeRequest @param {batch_uuid} - indicates a unique identifier of the current batch or session which data will be purged @param {new_state_root} - state root at this point of the execution @param {persistence} - indicates if it should be stored only in CACHE, in the SQL DATABASE, or it is just TEMPORARY and should be deleted at the flush of this batch UUID

  • string batch_uuid = 1

  • optional Fea new_state_root = 2

  • Persistence persistence = 3

  message PurgeResponse

  hashdb.proto:402

  * @dev PurgeResponse @param {result} - result code

  • optional ResultCode result = 1

• rpc ReadTree (ReadTreeRequest, ReadTreeResponse)

  hashdb.proto:39

  message ReadTreeRequest

  hashdb.proto:227

  * @dev ReadTreeRequest @param {state_root} - state root at this point of the execution @param {keys} - list of keys to get their values for

  • optional Fea state_root = 1

  • repeated Fea keys = 2

  message ReadTreeResponse

  hashdb.proto:412

  * @dev ReadTreeResponse @param {key_value} - list of key-value pairs requested to be read @param {hash_value} - list of hash-value pairs required to get the key-value pairs @param {result} - result code

  • repeated KeyValue key_value = 1

  • repeated HashValueGL hash_value = 2

  • optional ResultCode result = 3

• rpc CancelBatch (CancelBatchRequest, CancelBatchResponse)

  hashdb.proto:40

  message CancelBatchRequest

  hashdb.proto:236

  * @dev CancelBatchRequest @param {batch_uuid} - indicates a unique identifier of the current batch or session which data will be deleted

  • string batch_uuid = 1

  message CancelBatchResponse

  hashdb.proto:422

  * @dev CancelBatchResponse @param {result} - result code

  • optional ResultCode result = 1

• rpc ResetDB (google.protobuf.Empty, ResetDBResponse)

  hashdb.proto:41

  message ResetDBResponse

  hashdb.proto:430

  * @dev ResetDBResponse @param {result} - result code

  • optional ResultCode result = 1

* @dev FE (Field Element) List @param {fe} - list of Fe

Used in: GetResponse, LoadDBRequest, SetResponse

• repeated uint64 fe = 1

* @dev Array of 4 FE @param {fe0} - Field Element value for pos 0 @param {fe1} - Field Element value for pos 1 @param {fe2} - Field Element value for pos 2 @param {fe3} - Field Element value for pos 3

Used in: ConsolidateStateRequest, ConsolidateStateResponse, GetLatestStateRootResponse, GetProgramRequest, GetRequest, GetResponse, HashValueGL, KeyValue, LoadDBRequest, PurgeRequest, ReadTreeRequest, SetProgramRequest, SetRequest, SetResponse

• uint64 fe0 = 1

• uint64 fe1 = 2

• uint64 fe2 = 3

• uint64 fe3 = 4

* @dev Array of 12 FE @param {fex} - Field Element value for pos x

Used in: HashValueGL

• uint64 fe0 = 1

• uint64 fe1 = 2

• uint64 fe2 = 3

• uint64 fe3 = 4

• uint64 fe4 = 5

• uint64 fe5 = 6

• uint64 fe6 = 7

• uint64 fe7 = 8

• uint64 fe8 = 9

• uint64 fe9 = 10

• uint64 fe10 = 11

• uint64 fe11 = 12

* @dev HashValueGL @param {hash} - Hash @param {value} - Value

Used in: ReadTreeResponse

• optional Fea hash = 1

• optional Fea12 value = 2

* @dev KeyValue @param {key} - key @param {value} - Value

Used in: ReadTreeResponse

• optional Fea key = 1

• string value = 2

Used in: ConsolidateStateRequest, FinishBlockRequest, FinishTxRequest, FlushRequest, PurgeRequest, SetProgramRequest, SetRequest, StartBlockRequest

• PERSISTENCE_CACHE_UNSPECIFIED = 0

• PERSISTENCE_DATABASE = 1

• PERSISTENCE_TEMPORARY = 2

* @dev Result code @param {code} - result code

Used in: CancelBatchResponse, ConsolidateStateResponse, FlushResponse, GetFlushDataResponse, GetLatestStateRootResponse, GetProgramResponse, GetResponse, PurgeResponse, ReadTreeResponse, ResetDBResponse, SetProgramResponse, SetResponse

• ResultCode.Code code = 1

Used in: ResultCode

• CODE_UNSPECIFIED = 0

• CODE_SUCCESS = 1

• CODE_DB_KEY_NOT_FOUND = 2

  Requested key was not found in database

• CODE_DB_ERROR = 3

  Error connecting to database, or processing request

• CODE_INTERNAL_ERROR = 4

• CODE_SMT_INVALID_DATA_SIZE = 14

  Invalid size for the data of MT node

* @dev Siblings List @param {sibling} - list of siblings

Used in: GetResponse, SetResponse

• repeated uint64 sibling = 1

• string v0_0_1 = 1