@dashevo/dapi-grpc 0.25.0-dev.2 → 0.25.0-dev.21

package/protos/platform/v0/platform.proto

@@ -1,4 +1,6 @@
 syntax = "proto3";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
 
 package org.dash.platform.dapi.v0;
 
@@ -7,25 +9,38 @@ import "google/protobuf/timestamp.proto";
 service Platform {
   rpc broadcastStateTransition (BroadcastStateTransitionRequest) returns (BroadcastStateTransitionResponse);
   rpc getIdentity (GetIdentityRequest) returns (GetIdentityResponse);
+  rpc getIdentities (GetIdentitiesRequest) returns (GetIdentitiesResponse);
+  rpc getIdentityKeys (GetIdentityKeysRequest) returns (GetIdentityKeysResponse);
+//  rpc getIdentitiesKeys (GetIdentitiesKeysRequest) returns (GetIdentitiesKeysResponse);
+  rpc getIdentityBalance(GetIdentityRequest) returns (GetIdentityBalanceResponse);
+  rpc getIdentityBalanceAndRevision(GetIdentityRequest)
+          returns (GetIdentityBalanceAndRevisionResponse);
+  rpc getProofs (GetProofsRequest) returns (GetProofsResponse);
   rpc getDataContract (GetDataContractRequest) returns (GetDataContractResponse);
+  rpc getDataContractHistory (GetDataContractHistoryRequest) returns (GetDataContractHistoryResponse);
+  rpc getDataContracts (GetDataContractsRequest) returns (GetDataContractsResponse);
   rpc getDocuments (GetDocumentsRequest) returns (GetDocumentsResponse);
   rpc getIdentitiesByPublicKeyHashes (GetIdentitiesByPublicKeyHashesRequest) returns (GetIdentitiesByPublicKeyHashesResponse);
+  rpc getIdentityByPublicKeyHashes (GetIdentityByPublicKeyHashesRequest) returns (GetIdentityByPublicKeyHashesResponse);
   rpc waitForStateTransitionResult (WaitForStateTransitionResultRequest) returns (WaitForStateTransitionResultResponse);
   rpc getConsensusParams (GetConsensusParamsRequest) returns (GetConsensusParamsResponse);
 }
 
 message Proof {
-  bytes merkle_proof = 1;
+  bytes grovedb_proof = 1;
   bytes quorum_hash = 2;
   bytes signature = 3;
   uint32 round = 4;
+  bytes block_id_hash = 5;
+  uint32 quorum_type = 6;    
 }
 
 message ResponseMetadata {
-  int64 height = 1;
+  uint64 height = 1;
   uint32 core_chain_locked_height = 2;
   uint64 time_ms = 3;
   uint32 protocol_version = 4;
+  string chain_id = 5;
 }
 
 message StateTransitionBroadcastError {
@@ -48,19 +63,237 @@ message GetIdentityRequest {
 }
 
 message GetIdentityResponse {
-  bytes identity = 1;
-  Proof proof = 2;
+  oneof result {
+    bytes identity = 1;
+    Proof proof = 2;
+  }
+  ResponseMetadata metadata = 3;
+}
+
+message GetIdentitiesRequest {
+  repeated bytes ids = 1;
+  bool prove = 2;
+}
+
+message GetIdentitiesResponse {
+  message IdentityValue {
+    bytes value = 1;
+  }
+
+  message IdentityEntry {
+    bytes key = 1;
+    IdentityValue value = 2;
+  }
+
+  message Identities {
+    repeated IdentityEntry identity_entries = 1;
+  }
+
+  oneof result {
+    Identities identities = 1;
+    Proof proof = 2;
+  }
+  ResponseMetadata metadata = 3;
+}
+
+message GetIdentityBalanceResponse {
+  oneof result {
+    google.protobuf.UInt64Value balance = 1;
+    Proof proof = 2;
+  }
+  ResponseMetadata metadata = 3;
+}
+
+message GetIdentityBalanceAndRevisionResponse {
+  message BalanceAndRevision {
+    google.protobuf.UInt64Value balance = 1;
+    google.protobuf.UInt64Value revision = 2;
+  }
+
+  oneof result {
+    BalanceAndRevision balance_and_revision = 1;
+    Proof proof = 2;
+  }
+  ResponseMetadata metadata = 3;
+}
+
+message KeyRequestType {
+  oneof request {
+    AllKeys all_keys = 1;
+    SpecificKeys specific_keys = 2;
+    SearchKey search_key = 3;
+  }
+}
+
+message AllKeys {
+}
+
+message SpecificKeys {
+  repeated uint32 key_ids = 1;
+}
+
+message SearchKey {
+  map<uint32, SecurityLevelMap> purpose_map = 1;
+}
+
+message SecurityLevelMap {
+  enum KeyKindRequestType {
+    CURRENT_KEY_OF_KIND_REQUEST = 0;
+    ALL_KEYS_OF_KIND_REQUEST = 1;
+  }
+  map<uint32, KeyKindRequestType> security_level_map = 1;
+}
+
+message GetIdentityKeysRequest {
+  bytes identity_id = 1;
+  KeyRequestType request_type = 2;
+  google.protobuf.UInt32Value limit = 3;
+  google.protobuf.UInt32Value offset = 4;
+  bool prove = 5;
+}
+
+message GetIdentityKeysResponse {
+  message Keys {
+    repeated bytes keys_bytes = 1;
+  }
+  oneof result {
+    Keys keys = 1;
+    Proof proof = 2;
+  }
+  ResponseMetadata metadata = 3;
+}
+
+
+message GetIdentitiesKeysRequest {
+  repeated bytes identity_ids = 1;
+  KeyRequestType request_type = 2;
+  google.protobuf.UInt32Value limit = 3;
+  google.protobuf.UInt32Value offset = 4;
+  bool prove = 5;
+
+  message SecurityLevelMap {
+    enum KeyKindRequestType {
+      CURRENT_KEY_OF_KIND_REQUEST = 0;
+    }
+    map<uint32, KeyKindRequestType> security_level_map = 1;
+  }
+}
+
+message GetIdentitiesKeysResponse {
+  message PublicKey {
+    bytes value = 1;
+  }
+
+  message PublicKeyEntry {
+    bytes key = 1;
+    PublicKey value = 2;
+  }
+
+  message PublicKeyEntries {
+    repeated PublicKeyEntry public_key_entries = 1;
+  }
+
+  oneof result {
+    PublicKeyEntries public_keys = 1;
+    Proof proof = 2;
+  }
   ResponseMetadata metadata = 3;
 }
 
- message GetDataContractRequest {
+message GetProofsRequest {
+  message DocumentRequest {
+    bytes contract_id = 1;
+    string document_type = 2;
+    bool document_type_keeps_history = 3;
+    bytes document_id = 4;
+  }
+
+  message IdentityRequest {
+    enum Type {
+      FULL_IDENTITY = 0;
+      BALANCE = 1;
+      KEYS = 2;
+    }
+    bytes identity_id = 1;
+    Type request_type = 2;
+  }
+
+  message ContractRequest {
+    bytes contract_id = 1;
+  }
+
+  repeated IdentityRequest identities = 1;
+  repeated ContractRequest contracts = 2;
+  repeated DocumentRequest documents = 3;
+}
+
+message GetProofsResponse {
+  Proof proof = 1;
+  ResponseMetadata metadata = 2;
+}
+
+message GetDataContractRequest {
   bytes id = 1;
   bool prove = 2;
 }
 
 message GetDataContractResponse {
-  bytes data_contract = 1;
-  Proof proof = 2;
+  oneof result {
+    bytes data_contract = 1;
+    Proof proof = 2;
+  }
+  ResponseMetadata metadata = 3;
+}
+
+message GetDataContractsRequest {
+  repeated bytes ids = 1;
+  bool prove = 2;
+}
+
+message GetDataContractsResponse {
+  message DataContractValue {
+    bytes value = 1;
+  }
+
+  message DataContractEntry {
+    bytes key = 1;
+    DataContractValue value = 2;
+  }
+
+  message DataContracts {
+    repeated DataContractEntry data_contract_entries = 1;
+  }
+
+  oneof result {
+    DataContracts data_contracts = 1;
+    Proof proof = 2;
+  }
+  ResponseMetadata metadata = 3;
+}
+
+message GetDataContractHistoryRequest {
+  bytes id = 1;
+  google.protobuf.UInt32Value limit = 2;
+  google.protobuf.UInt32Value offset = 3;
+  uint64 start_at_ms = 4;
+  bool prove = 5;
+}
+
+message GetDataContractHistoryResponse {
+  message DataContractHistoryEntry {
+    uint64 date = 1;
+    bytes value = 2;
+  }
+
+  message DataContractHistory {
+    repeated DataContractHistoryEntry data_contract_entries = 1;
+  }
+
+  oneof result {
+    DataContractHistory data_contract_history = 1;
+    Proof proof = 2;
+  }
+
   ResponseMetadata metadata = 3;
 }
 
@@ -73,17 +306,23 @@ message GetDocumentsRequest {
 
   uint32 limit = 5;
 
-    oneof start {
-      bytes start_after = 6;
-      bytes start_at = 7;
-    }
+  oneof start {
+    bytes start_after = 6;
+    bytes start_at = 7;
+  }
 
   bool prove = 8;
 }
 
 message GetDocumentsResponse {
-  repeated bytes documents = 1;
-  Proof proof = 2;
+  message Documents {
+    repeated bytes documents = 1;
+  }
+
+  oneof result {
+    Documents documents = 1;
+    Proof proof = 2;
+  }
   ResponseMetadata metadata = 3;
 }
 
@@ -93,8 +332,27 @@ message GetIdentitiesByPublicKeyHashesRequest {
 }
 
 message GetIdentitiesByPublicKeyHashesResponse {
-  repeated bytes identities = 1;
-  Proof proof = 2;
+  message Identities {
+    repeated bytes identities = 1;
+  }
+
+  oneof result {
+    Identities identities = 1;
+    Proof proof = 2;
+  }
+  ResponseMetadata metadata = 3;
+}
+
+message GetIdentityByPublicKeyHashesRequest {
+  bytes public_key_hash = 1;
+  bool prove = 2;
+}
+
+message GetIdentityByPublicKeyHashesResponse {
+  oneof result {
+    bytes identity = 1;
+    Proof proof = 2;
+  }
   ResponseMetadata metadata = 3;
 }
 
@@ -104,7 +362,7 @@ message WaitForStateTransitionResultRequest {
 }
 
 message WaitForStateTransitionResultResponse {
-  oneof responses {
+  oneof result {
     StateTransitionBroadcastError error = 1;
     Proof proof = 2;
   }

package/scripts/build.sh

@@ -1,4 +1,12 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC2250
+#
+
+SKIP_GRPC_PROTO_BUILD=${SKIP_GRPC_PROTO_BUILD:-0}
+if [[ "${SKIP_GRPC_PROTO_BUILD}" == "1" ]]; then
+  echo WARN: Skipping GRPC protobuf definitions rebuild
+  exit 0
+fi
 
 CORE_PROTO_PATH="$PWD/protos/core/v0"
 CORE_CLIENTS_PATH="$PWD/clients/core/v0"
@@ -20,25 +28,27 @@ PLATFORM_PYTHON_OUT_PATH="$PLATFORM_CLIENTS_PATH/python"
 
 PROTOC_IMAGE="rvolosatovs/protoc:4.0.0"
 
+set -ex
+
 #################################################
 # Generate JavaScript client for `Core` service #
 #################################################
 
-rm -rf "$CORE_WEB_OUT_PATH/*"
+rm -rf "${CORE_WEB_OUT_PATH:?}/*" || true
 
 docker run -v "$CORE_PROTO_PATH:$CORE_PROTO_PATH" \
-           -v "$CORE_WEB_OUT_PATH:$CORE_WEB_OUT_PATH" \
-           --rm \
-           "$PROTOC_IMAGE" \
-           --js_out="import_style=commonjs:$CORE_WEB_OUT_PATH" \
-           --ts_out="service=grpc-web:$CORE_WEB_OUT_PATH" \
-           -I="$CORE_PROTO_PATH" \
-           "core.proto"
+  -v "$CORE_WEB_OUT_PATH:$CORE_WEB_OUT_PATH" \
+  --rm \
+  "$PROTOC_IMAGE" \
+  --js_out="import_style=commonjs:$CORE_WEB_OUT_PATH" \
+  --ts_out="service=grpc-web:$CORE_WEB_OUT_PATH" \
+  -I="$CORE_PROTO_PATH" \
+  "core.proto"
 
 # Clean node message classes
 
-rm -rf "$CORE_CLIENTS_PATH/nodejs/*_protoc.js"
-rm -rf "$CORE_CLIENTS_PATH/nodejs/*_pbjs.js"
+rm -rf "$CORE_CLIENTS_PATH/nodejs/*_protoc.js" || true
+rm -rf "$CORE_CLIENTS_PATH/nodejs/*_pbjs.js" || true
 
 # Copy compiled modules with message classes
 
@@ -56,21 +66,21 @@ pbjs \
 # Generate JavaScript client for `Platform` service #
 #####################################################
 
-rm -rf "$PLATFORM_WEB_OUT_PATH/*"
+rm -rf "${PLATFORM_WEB_OUT_PATH:?}/*" || true
 
 docker run -v "$PLATFORM_PROTO_PATH:$PLATFORM_PROTO_PATH" \
-           -v "$PLATFORM_WEB_OUT_PATH:$PLATFORM_WEB_OUT_PATH" \
-           --rm \
-           "$PROTOC_IMAGE" \
-           --js_out="import_style=commonjs:$PLATFORM_WEB_OUT_PATH" \
-           --ts_out="service=grpc-web:$PLATFORM_WEB_OUT_PATH" \
-           -I="$PLATFORM_PROTO_PATH" \
-           "platform.proto"
+  -v "$PLATFORM_WEB_OUT_PATH:$PLATFORM_WEB_OUT_PATH" \
+  --rm \
+  "$PROTOC_IMAGE" \
+  --js_out="import_style=commonjs:$PLATFORM_WEB_OUT_PATH" \
+  --ts_out="service=grpc-web:$PLATFORM_WEB_OUT_PATH" \
+  -I="$PLATFORM_PROTO_PATH" \
+  "platform.proto"
 
 # Clean node message classes
 
-rm -rf "$PLATFORM_CLIENTS_PATH/nodejs/*_protoc.js"
-rm -rf "$PLATFORM_CLIENTS_PATH/nodejs/*_pbjs.js"
+rm -rf "$PLATFORM_CLIENTS_PATH/nodejs/*_protoc.js" || true
+rm -rf "$PLATFORM_CLIENTS_PATH/nodejs/*_pbjs.js" || true
 
 # Copy compiled modules with message classes
 
@@ -87,98 +97,101 @@ pbjs \
 # Generate Java client for `Core` #
 ###################################
 
-rm -rf "$CORE_JAVA_OUT_PATH/*"
+rm -rf "${CORE_JAVA_OUT_PATH:?}/*" || true
 
 docker run -v "$CORE_PROTO_PATH:$CORE_PROTO_PATH" \
-           -v "$CORE_JAVA_OUT_PATH:$CORE_JAVA_OUT_PATH" \
-           --rm \
-           "$PROTOC_IMAGE" \
-           --plugin=protoc-gen-grpc=/usr/bin/protoc-gen-grpc-java \
-           --grpc-java_out="$CORE_JAVA_OUT_PATH" \
-           --proto_path="$CORE_PROTO_PATH" \
-           -I="$CORE_PROTO_PATH" \
-           "core.proto"
+  -v "$CORE_JAVA_OUT_PATH:$CORE_JAVA_OUT_PATH" \
+  --rm \
+  "$PROTOC_IMAGE" \
+  --plugin=protoc-gen-grpc=/usr/bin/protoc-gen-grpc-java \
+  --grpc-java_out="$CORE_JAVA_OUT_PATH" \
+  --proto_path="$CORE_PROTO_PATH" \
+  -I="$CORE_PROTO_PATH" \
+  "core.proto"
 
 #######################################
 # Generate Java client for `Platform` #
 #######################################
 
-rm -rf "$PLATFORM_JAVA_OUT_PATH/*"
+rm -rf "${PLATFORM_JAVA_OUT_PATH:?}/*" || true
 
 docker run -v "$PLATFORM_PROTO_PATH:$PLATFORM_PROTO_PATH" \
-           -v "$PLATFORM_JAVA_OUT_PATH:$PLATFORM_JAVA_OUT_PATH" \
-           --rm \
-           "$PROTOC_IMAGE" \
-           --plugin=protoc-gen-grpc=/usr/bin/protoc-gen-grpc-java \
-           --grpc-java_out="$PLATFORM_JAVA_OUT_PATH" \
-           --proto_path="$PLATFORM_PROTO_PATH" \
-           -I="$PLATFORM_PROTO_PATH" \
-           "platform.proto"
+  -v "$PLATFORM_JAVA_OUT_PATH:$PLATFORM_JAVA_OUT_PATH" \
+  --rm \
+  "$PROTOC_IMAGE" \
+  --plugin=protoc-gen-grpc=/usr/bin/protoc-gen-grpc-java \
+  --grpc-java_out="$PLATFORM_JAVA_OUT_PATH" \
+  --proto_path="$PLATFORM_PROTO_PATH" \
+  -I="$PLATFORM_PROTO_PATH" \
+  "platform.proto"
 
 ##########################################
 # Generate Objective-C client for `Core` #
 ##########################################
 
-rm -rf "$CORE_OBJ_C_OUT_PATH/*"
+rm -rf "${CORE_OBJ_C_OUT_PATH:?}/*" || true
 
 docker run -v "$CORE_PROTO_PATH:$CORE_PROTO_PATH" \
-           -v "$CORE_OBJ_C_OUT_PATH:$CORE_OBJ_C_OUT_PATH" \
-           --rm \
-           "$PROTOC_IMAGE" \
-           --plugin=protoc-gen-grpc=/usr/bin/grpc_objective_c_plugin \
-           --objc_out="$CORE_OBJ_C_OUT_PATH" \
-           --grpc_out="$CORE_OBJ_C_OUT_PATH" \
-           --proto_path="$CORE_PROTO_PATH" \
-           -I="$CORE_PROTO_PATH" \
-           "core.proto"
+  -v "$CORE_OBJ_C_OUT_PATH:$CORE_OBJ_C_OUT_PATH" \
+  --rm \
+  "$PROTOC_IMAGE" \
+  --plugin=protoc-gen-grpc=/usr/bin/grpc_objective_c_plugin \
+  --objc_out="$CORE_OBJ_C_OUT_PATH" \
+  --grpc_out="$CORE_OBJ_C_OUT_PATH" \
+  --proto_path="$CORE_PROTO_PATH" \
+  -I="$CORE_PROTO_PATH" \
+  "core.proto"
 
 ##############################################
 # Generate Objective-C client for `Platform` #
 ##############################################
 
-rm -rf "$PLATFORM_OBJ_C_OUT_PATH/*"
+rm -rf "${PLATFORM_OBJ_C_OUT_PATH:?}/*" || true
 
 docker run -v "$PLATFORM_PROTO_PATH:$PLATFORM_PROTO_PATH" \
-           -v "$PLATFORM_OBJ_C_OUT_PATH:$PLATFORM_OBJ_C_OUT_PATH" \
-           --rm \
-           "$PROTOC_IMAGE" \
-           --plugin=protoc-gen-grpc=/usr/bin/grpc_objective_c_plugin \
-           --objc_out="$PLATFORM_OBJ_C_OUT_PATH" \
-           --grpc_out="$PLATFORM_OBJ_C_OUT_PATH" \
-           --proto_path="$PLATFORM_PROTO_PATH" \
-           -I="$PLATFORM_PROTO_PATH" \
-           "platform.proto"
+  -v "$PLATFORM_OBJ_C_OUT_PATH:$PLATFORM_OBJ_C_OUT_PATH" \
+  --rm \
+  "$PROTOC_IMAGE" \
+  --plugin=protoc-gen-grpc=/usr/bin/grpc_objective_c_plugin \
+  --objc_out="$PLATFORM_OBJ_C_OUT_PATH" \
+  --grpc_out="$PLATFORM_OBJ_C_OUT_PATH" \
+  --proto_path="$PLATFORM_PROTO_PATH" \
+  -I="$PLATFORM_PROTO_PATH" \
+  "platform.proto"
 
 #####################################
 # Generate Python client for `Core` #
 #####################################
 
-rm -rf "$CORE_PYTHON_OUT_PATH/*"
+rm -rf "${CORE_PYTHON_OUT_PATH:?}/*" || true
 
 docker run -v "$CORE_PROTO_PATH:$CORE_PROTO_PATH" \
-           -v "$CORE_PYTHON_OUT_PATH:$CORE_PYTHON_OUT_PATH" \
-           --rm \
-           "$PROTOC_IMAGE" \
-           --plugin=protoc-gen-grpc=/usr/bin/grpc_python_plugin \
-           --python_out="$CORE_PYTHON_OUT_PATH" \
-           --grpc_out="$CORE_PYTHON_OUT_PATH" \
-           --proto_path="$CORE_PROTO_PATH" \
-           -I="$CORE_PROTO_PATH" \
-           "core.proto"
+  -v "$CORE_PYTHON_OUT_PATH:$CORE_PYTHON_OUT_PATH" \
+  --rm \
+  "$PROTOC_IMAGE" \
+  --plugin=protoc-gen-grpc=/usr/bin/grpc_python_plugin \
+  --python_out="$CORE_PYTHON_OUT_PATH" \
+  --grpc_out="$CORE_PYTHON_OUT_PATH" \
+  --proto_path="$CORE_PROTO_PATH" \
+  -I="$CORE_PROTO_PATH" \
+  "core.proto"
 
 #########################################
 # Generate Python client for `Platform` #
 #########################################
 
-rm -rf "$PLATFORM_PYTHON_OUT_PATH/*"
+rm -rf "${PLATFORM_PYTHON_OUT_PATH:?}/*" || true
 
 docker run -v "$PLATFORM_PROTO_PATH:$PLATFORM_PROTO_PATH" \
-          -v "$PLATFORM_PYTHON_OUT_PATH:$PLATFORM_PYTHON_OUT_PATH" \
-          --rm \
-          "$PROTOC_IMAGE" \
-          --plugin=protoc-gen-grpc=/usr/bin/grpc_python_plugin \
-          --python_out="$PLATFORM_PYTHON_OUT_PATH" \
-          --grpc_out="$PLATFORM_PYTHON_OUT_PATH" \
-          --proto_path="$PLATFORM_PROTO_PATH" \
-          -I="$PLATFORM_PROTO_PATH" \
-          "platform.proto"
+  -v "$PLATFORM_PYTHON_OUT_PATH:$PLATFORM_PYTHON_OUT_PATH" \
+  --rm \
+  "$PROTOC_IMAGE" \
+  --plugin=protoc-gen-grpc=/usr/bin/grpc_python_plugin \
+  --python_out="$PLATFORM_PYTHON_OUT_PATH" \
+  --grpc_out="$PLATFORM_PYTHON_OUT_PATH" \
+  --proto_path="$PLATFORM_PROTO_PATH" \
+  -I="$PLATFORM_PROTO_PATH" \
+  "platform.proto"
+
+# Patch generated protobuf files
+exec "${PWD}/scripts/patch-protobuf-js.sh"

package/scripts/patch-protobuf-js.sh

@@ -1,21 +1,22 @@
 #!/bin/bash
+# shellcheck disable=SC2250
+set -e
 
 files=$(find "$PWD/clients/core/v0/web" "$PWD/clients/core/v0/nodejs" "$PWD/clients/platform/v0/web" "$PWD/clients/platform/v0/nodejs" -name "*_pb.js" -o -name "*_protoc.js")
 OS=$(uname)
 
 function replace_in_file() {
-    if [ "$OS" = 'Darwin' ]; then
-        # for MacOS
-        sed -i '' -e "$1" "$2"
-    else
-        # for Linux and Windows
-        sed -i'' -e "$1" "$2"
-    fi
+  if [[ "$OS" = 'Darwin' ]]; then
+    # for MacOS
+    sed -i '' -e "$1" "$2"
+  else
+    # for Linux and Windows
+    sed -i'' -e "$1" "$2"
+  fi
 }
 
 # Loop over the files
-for file in $files
-do
+for file in $files; do
 
   replace_in_file 's/var global = Function('\''return this'\'')();/const proto = {};/g' "$file"
   if grep -qrE "[^a-zA-Z]Function\(" "$file"; then