@dashevo/dapi-grpc 1.0.0-pr.1825.9 → 1.0.0-pr.1883.1

package/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "dapi-grpc"
 description = "GRPC client for Dash Platform"
-version = "1.0.0-pr.1825.9"
+version = "1.0.0-pr.1883.1"
 authors = [
   "Samuel Westrich <sam@dash.org>",
   "Igor Markin <igor.markin@dash.org>",
@@ -14,10 +14,7 @@ rust-version = "1.76"
 license = "MIT"
 
 [features]
-# Enable all features by default, otherwise different crates
-# triggier bulding proto with different feature set that overwrites
-# previous results and causes build errors
-default = ["core", "platform", "client", "serde", "server"]
+default = ["core", "platform", "client"]
 core = []
 platform = []
 # Re-export Dash Platform protobuf types as `dapi_grpc::platform::proto`
@@ -33,7 +30,7 @@ client = [
 ]
 server = ["tonic/channel", "tonic/transport", "platform"]
 serde = ["dep:serde", "dep:serde_bytes"]
-mocks = ["dep:serde_json"]
+mocks = ["serde", "dep:serde_json"]
 
 [dependencies]
 prost = { version = "0.12.3" }
@@ -64,4 +61,9 @@ name = "platform_example"
 path = "clients/platform/v0/rust/platform_example.rs"
 
 [package.metadata.cargo-machete]
-ignored = ["platform-version", "serde_bytes", "futures-core"]
+ignored = [
+  "platform-version",
+  "serde_bytes",
+  "futures-core",
+  "dapi-grpc-macros",
+]

package/build.rs

@@ -1,14 +1,21 @@
 use std::{
     fs::{create_dir_all, remove_dir_all},
     path::PathBuf,
+    process::exit,
 };
 
 use tonic_build::Builder;
 
+const SERDE_WITH_BYTES: &str = r#"#[cfg_attr(feature = "serde", serde(with = "serde_bytes"))]"#;
+const SERDE_WITH_BASE64: &str =
+    r#"#[cfg_attr(feature = "serde", serde(with = "crate::deserialization::vec_base64string"))]"#;
+const SERDE_WITH_STRING: &str =
+    r#"#[cfg_attr(feature = "serde", serde(with = "crate::deserialization::from_to_string"))]"#;
+
 fn main() {
     let core = MappingConfig::new(
         PathBuf::from("protos/core/v0/core.proto"),
-        PathBuf::from("src/core/proto"),
+        PathBuf::from("src/core"),
     );
 
     configure_core(core)
@@ -17,7 +24,7 @@ fn main() {
 
     let platform = MappingConfig::new(
         PathBuf::from("protos/platform/v0/platform.proto"),
-        PathBuf::from("src/platform/proto"),
+        PathBuf::from("src/platform"),
     );
 
     configure_platform(platform)
@@ -39,7 +46,7 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
     // Derive features for versioned messages
     //
     // "GetConsensusParamsRequest" is excluded as this message does not support proofs
-    const VERSIONED_REQUESTS: [&str; 18] = [
+    const VERSIONED_REQUESTS: [&str; 19] = [
         "GetDataContractHistoryRequest",
         "GetDataContractRequest",
         "GetDataContractsRequest",
@@ -58,10 +65,11 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetProtocolVersionUpgradeStateRequest",
         "GetProtocolVersionUpgradeVoteStatusRequest",
         "GetPathElementsRequest",
+        "GetIdentitiesContractKeysRequest",
     ];
 
     //  "GetConsensusParamsResponse" is excluded as this message does not support proofs
-    const VERSIONED_RESPONSES: [&str; 19] = [
+    const VERSIONED_RESPONSES: [&str; 20] = [
         "GetDataContractHistoryResponse",
         "GetDataContractResponse",
         "GetDataContractsResponse",
@@ -81,6 +89,7 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetProtocolVersionUpgradeStateResponse",
         "GetProtocolVersionUpgradeVoteStatusResponse",
         "GetPathElementsResponse",
+        "GetIdentitiesContractKeysResponse",
     ];
 
     // Derive VersionedGrpcMessage on requests
@@ -104,73 +113,83 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
     }
 
     // All messages can be mocked.
-    platform = platform.message_attribute(".", r#"#[derive( ::dapi_grpc_macros::Mockable)]"#);
+    let platform = platform.message_attribute(".", r#"#[derive( ::dapi_grpc_macros::Mockable)]"#);
 
-    #[cfg(feature = "serde")]
     let platform = platform
         .type_attribute(
             ".",
-            r#"#[derive(::serde::Serialize, ::serde::Deserialize)]"#,
-        )
-        .type_attribute(".", r#"#[serde(rename_all = "snake_case")]"#)
-        .field_attribute("id", r#"#[serde(with = "serde_bytes")]"#)
-        .field_attribute("identity_id", r#"#[serde(with = "serde_bytes")]"#)
-        .field_attribute(
-            "ids",
-            r#"#[serde(with = "crate::deserialization::vec_base64string")]"#,
-        )
-        .field_attribute(
-            "ResponseMetadata.height",
-            r#"#[serde(with = "crate::deserialization::from_to_string")]"#,
-        )
-        .field_attribute(
-            "ResponseMetadata.time_ms",
-            r#"#[serde(with = "crate::deserialization::from_to_string")]"#,
+            r#"#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]"#,
         )
-        .field_attribute(
-            "start_at_ms",
-            r#"#[serde(with = "crate::deserialization::from_to_string")]"#,
-        )
-        .field_attribute("public_key_hash", r#"#[serde(with = "serde_bytes")]"#)
-        .field_attribute(
-            "public_key_hashes",
-            r#"#[serde(with = "crate::deserialization::vec_base64string")]"#,
+        .type_attribute(
+            ".",
+            r#"#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]"#,
         )
+        .field_attribute("id", SERDE_WITH_BYTES)
+        .field_attribute("identity_id", SERDE_WITH_BYTES)
+        .field_attribute("ids", SERDE_WITH_BASE64)
+        .field_attribute("ResponseMetadata.height", SERDE_WITH_STRING)
+        .field_attribute("ResponseMetadata.time_ms", SERDE_WITH_STRING)
+        .field_attribute("start_at_ms", SERDE_WITH_STRING)
+        .field_attribute("public_key_hash", SERDE_WITH_BYTES)
+        .field_attribute("public_key_hashes", SERDE_WITH_BASE64)
         // Get documents fields
-        .field_attribute("data_contract_id", r#"#[serde(with = "serde_bytes")]"#)
-        .field_attribute("where", r#"#[serde(with = "serde_bytes")]"#)
-        .field_attribute("order_by", r#"#[serde(with = "serde_bytes")]"#)
+        .field_attribute("data_contract_id", SERDE_WITH_BYTES)
+        .field_attribute("where", SERDE_WITH_BYTES)
+        .field_attribute("order_by", SERDE_WITH_BYTES)
         // Proof fields
-        .field_attribute("Proof.grovedb_proof", r#"#[serde(with = "serde_bytes")]"#)
-        .field_attribute("Proof.quorum_hash", r#"#[serde(with = "serde_bytes")]"#)
-        .field_attribute("Proof.signature", r#"#[serde(with = "serde_bytes")]"#)
-        .field_attribute("Proof.block_id_hash", r#"#[serde(with = "serde_bytes")]"#);
+        .field_attribute("Proof.grovedb_proof", SERDE_WITH_BYTES)
+        .field_attribute("Proof.quorum_hash", SERDE_WITH_BYTES)
+        .field_attribute("Proof.signature", SERDE_WITH_BYTES)
+        .field_attribute("Proof.block_id_hash", SERDE_WITH_BYTES);
 
+    #[allow(clippy::let_and_return)]
     platform
 }
 
-fn configure_core(mut core: MappingConfig) -> MappingConfig {
+fn configure_core(core: MappingConfig) -> MappingConfig {
     // All messages can be mocked.
-    core = core.message_attribute(".", r#"#[derive( ::dapi_grpc_macros::Mockable)]"#);
+    let core = core.message_attribute(".", r#"#[derive(::dapi_grpc_macros::Mockable)]"#);
 
     // Serde support
-    #[cfg(feature = "serde")]
     let core = core.type_attribute(
         ".",
-        r#"#[derive(::serde::Serialize, ::serde::Deserialize)]"#,
+        r#"#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]"#,
     );
 
+    #[allow(clippy::let_and_return)]
     core
 }
 
 impl MappingConfig {
+    /// Create a new MappingConfig instance.
+    ///
+    /// ## Arguments
+    ///
+    /// * `protobuf_file` - Path to the protobuf file to use as input.
+    /// * `out_dir` - Output directory where subdirectories for generated files will be created.
+    /// Depending on the features, either `client`, `server` or `client_server` subdirectory
+    /// will be created inside `out_dir`.
     fn new(protobuf_file: PathBuf, out_dir: PathBuf) -> Self {
         let protobuf_file = abs_path(&protobuf_file);
-        let out_dir = abs_path(&out_dir);
 
         let build_server = cfg!(feature = "server");
         let build_client = cfg!(feature = "client");
 
+        // Depending on the features, we need to build the server, client or both.
+        // We save these artifacts in separate directories to avoid overwriting the generated files
+        // when another crate requires different features.
+        let out_dir_suffix = match (build_server, build_client) {
+            (true, true) => "client_server",
+            (true, false) => "server",
+            (false, true) => "client",
+            (false, false) => {
+                println!("WARNING: At least one of the features 'server' or 'client' must be enabled; dapi-grpc will not generate any files.");
+                exit(0)
+            }
+        };
+
+        let out_dir = abs_path(&out_dir.join(out_dir_suffix));
+
         let builder = tonic_build::configure()
             .build_server(build_server)
             .build_client(build_client)

package/clients/core/v0/nodejs/CorePromiseClient.js

@@ -30,6 +30,8 @@ const {
             GetMasternodeStatusResponse: PBJSGetMasternodeStatusResponse,
             GetBlockRequest: PBJSGetBlockRequest,
             GetBlockResponse: PBJSGetBlockResponse,
+            GetBestBlockHeightRequest: PBJSGetBestBlockHeightRequest,
+            GetBestBlockHeightResponse: PBJSGetBestBlockHeightResponse,
             BroadcastTransactionRequest: PBJSBroadcastTransactionRequest,
             BroadcastTransactionResponse: PBJSBroadcastTransactionResponse,
             GetTransactionRequest: PBJSGetTransactionRequest,
@@ -40,6 +42,8 @@ const {
             GetEstimatedTransactionFeeResponse: PBJSGetEstimatedTransactionFeeResponse,
             TransactionsWithProofsRequest: PBJSTransactionsWithProofsRequest,
             TransactionsWithProofsResponse: PBJSTransactionsWithProofsResponse,
+            MasternodeListRequest: PBJSMasternodeListRequest,
+            MasternodeListResponse: PBJSMasternodeListResponse,
           },
         },
       },
@@ -51,11 +55,13 @@ const {
   GetBlockchainStatusResponse: ProtocGetBlockchainStatusResponse,
   GetMasternodeStatusResponse: ProtocGetMasternodeStatusResponse,
   GetBlockResponse: ProtocGetBlockResponse,
+  GetBestBlockHeightResponse: ProtocGetBestBlockHeightResponse,
   BroadcastTransactionResponse: ProtocBroadcastTransactionResponse,
   GetTransactionResponse: ProtocGetTransactionResponse,
   BlockHeadersWithChainLocksResponse: ProtocBlockHeadersWithChainLocksResponse,
   GetEstimatedTransactionFeeResponse: ProtocGetEstimatedTransactionFeeResponse,
   TransactionsWithProofsResponse: ProtocTransactionsWithProofsResponse,
+  MasternodeListResponse: ProtocMasternodeListResponse,
 } = require('./core_protoc');
 
 const getCoreDefinition = require('../../../../lib/getCoreDefinition');
@@ -94,6 +100,10 @@ class CorePromiseClient {
       this.client.getBlock.bind(this.client),
     );
 
+    this.client.getBestBlockHeight = promisify(
+      this.client.getBestBlockHeight.bind(this.client),
+    );
+
     this.client.broadcastTransaction = promisify(
       this.client.broadcastTransaction.bind(this.client),
     );
@@ -169,6 +179,37 @@ class CorePromiseClient {
     );
   }
 
+  /**
+   * @param {!GetBestBlockHeightRequest} getBestBlockHeightRequest
+   * @param {?Object<string, string>} metadata
+   * @param {CallOptions} [options={}]
+   * @return {Promise<!GetBestBlockHeightResponse>}
+   */
+  getBestBlockHeight(getBestBlockHeightRequest, metadata = {}, options = {}) {
+    if (!isObject(metadata)) {
+      throw new Error('metadata must be an object');
+    }
+
+    return this.client.getBestBlockHeight(
+      getBestBlockHeightRequest,
+      convertObjectToMetadata(metadata),
+      {
+        interceptors: [
+          jsonToProtobufInterceptorFactory(
+            jsonToProtobufFactory(
+              ProtocGetBestBlockHeightResponse,
+              PBJSGetBestBlockHeightResponse,
+            ),
+            protobufToJsonFactory(
+              PBJSGetBestBlockHeightRequest,
+            ),
+          ),
+        ],
+        ...options,
+      },
+    );
+  }
+
   /**
    * @param {!GetMasternodeStatusRequest} getMasternodeStatusRequest
    * @param {?Object<string, string>} metadata
@@ -360,6 +401,38 @@ class CorePromiseClient {
       },
     );
   }
+
+  /**
+   * @param {MasternodeListRequest} masternodeListRequest The request proto
+   * @param {?Object<string, string>} metadata User defined call metadata
+   * @param {CallOptions} [options={}]
+   * @return {!grpc.web.ClientReadableStream<!MasternodeListResponse>|undefined}
+   *     The XHR Node Readable Stream
+   */
+  subscribeToMasternodeList(masternodeListRequest, metadata = {}, options = {}) {
+    if (!isObject(metadata)) {
+      throw new Error('metadata must be an object');
+    }
+
+    return this.client.subscribeToMasternodeList(
+      masternodeListRequest,
+      convertObjectToMetadata(metadata),
+      {
+        interceptors: [
+          jsonToProtobufInterceptorFactory(
+            jsonToProtobufFactory(
+              ProtocMasternodeListResponse,
+              PBJSMasternodeListResponse,
+            ),
+            protobufToJsonFactory(
+              PBJSMasternodeListRequest,
+            ),
+          ),
+        ],
+        ...options,
+      },
+    );
+  }
 }
 
 module.exports = CorePromiseClient;