@dashevo/dapi-grpc 1.8.0 → 2.0.0-rc.1

package/.eslintrc

@@ -1,5 +1,8 @@
 {
   "extends": "airbnb-base",
+  "env": {
+    "es2020": true
+  },
   "rules": {
     "import/no-extraneous-dependencies": ["error", { "packageDir": "." }],
     "no-plusplus": 0,

package/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "dapi-grpc"
 description = "GRPC client for Dash Platform"
-version = "1.8.0"
+version = "2.0.0-rc.1"
 authors = [
   "Samuel Westrich <sam@dash.org>",
   "Igor Markin <igor.markin@dash.org>",
@@ -15,41 +15,61 @@ license = "MIT"
 
 [features]
 default = ["core", "platform", "client"]
+# Internal Drive endpoints. Used by DAPI
+drive = ["platform"]
 core = []
 platform = []
 # Re-export Dash Platform protobuf types as `dapi_grpc::platform::proto`
 # Note: client needs tls and tls-roots to connect to testnet which uses TLS.
 tenderdash-proto = []
-client = [
-  "tonic/channel",
-  "tonic/transport",
-  "tonic/tls",
-  "tonic/tls-roots",
-  "tonic/tls-webpki-roots",
+
+# Client support.
+client = ["platform"]
+
+# Build tonic server code. Includes all client features and adds server-specific dependencies.
+server = [
   "platform",
+  "tenderdash-proto/server",
+  "client",
+  "drive",
+  "tonic/router",
 ]
-server = ["tonic/channel", "tonic/transport", "platform"]
-serde = ["dep:serde", "dep:serde_bytes"]
+
+serde = ["dep:serde", "dep:serde_bytes", "tenderdash-proto/serde"]
 mocks = ["serde", "dep:serde_json"]
 
 [dependencies]
+tenderdash-proto = { git = "https://github.com/dashpay/rs-tenderdash-abci", version = "1.4.0", tag = "v1.4.0", default-features = false }
+
 prost = { version = "0.13" }
 futures-core = "0.3.30"
-tonic = { version = "0.12.3", features = [
+tonic = { version = "0.13.0", features = [
   "codegen",
   "prost",
+  "tls-ring",
 ], default-features = false }
-serde = { version = "1.0.197", optional = true, features = ["derive"] }
+serde = { version = "1.0.219", optional = true, features = ["derive"] }
 serde_bytes = { version = "0.11.12", optional = true }
 serde_json = { version = "1.0", optional = true }
-tenderdash-proto = { git = "https://github.com/dashpay/rs-tenderdash-abci", version = "1.2.1", tag = "v1.2.1+1.3.0", default-features = false, features = [
-  "grpc",
-] }
 dapi-grpc-macros = { path = "../rs-dapi-grpc-macros" }
 platform-version = { path = "../rs-platform-version" }
 
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+getrandom = { version = "0.2", features = ["js"] }
+
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+tonic = { version = "0.13.0", features = [
+  "codegen",
+  "prost",
+  "channel",
+  "transport",
+  "tls-native-roots",
+  "tls-webpki-roots",
+  "tls-ring",
+], default-features = false }
+
 [build-dependencies]
-tonic-build = { version = "0.12.3" }
+tonic-build = { version = "0.13.0" }
 
 [lib]
 

package/build.rs

@@ -2,7 +2,6 @@ use std::{
     collections::HashSet,
     fs::{create_dir_all, remove_dir_all},
     path::PathBuf,
-    process::exit,
 };
 
 use tonic_build::Builder;
@@ -14,9 +13,24 @@ const SERDE_WITH_STRING: &str =
     r#"#[cfg_attr(feature = "serde", serde(with = "crate::deserialization::from_to_string"))]"#;
 
 fn main() {
+    #[cfg(feature = "server")]
+    generate_code(ImplType::Server);
+    #[cfg(feature = "client")]
+    generate_code(ImplType::Client);
+
+    if std::env::var("CARGO_CFG_TARGET_ARCH")
+        .unwrap_or_default()
+        .eq("wasm32")
+    {
+        generate_code(ImplType::Wasm);
+    }
+}
+
+fn generate_code(typ: ImplType) {
     let core = MappingConfig::new(
         PathBuf::from("protos/core/v0/core.proto"),
         PathBuf::from("src/core"),
+        &typ,
     );
 
     configure_core(core)
@@ -26,14 +40,26 @@ fn main() {
     let platform = MappingConfig::new(
         PathBuf::from("protos/platform/v0/platform.proto"),
         PathBuf::from("src/platform"),
+        &typ,
     );
 
     configure_platform(platform)
         .generate()
         .expect("generate platform proto");
 
+    let drive = MappingConfig::new(
+        PathBuf::from("protos/drive/v0/drive.proto"),
+        PathBuf::from("src/drive"),
+        &typ,
+    );
+
+    configure_drive(drive)
+        .generate()
+        .expect("generate platform proto");
+
     println!("cargo:rerun-if-changed=./protos");
     println!("cargo:rerun-if-env-changed=CARGO_FEATURE_SERDE");
+    println!("cargo:rerun-if-env-changed=CARGO_CFG_TARGET_ARCH");
 }
 
 struct MappingConfig {
@@ -47,7 +73,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; 30] = [
+    const VERSIONED_REQUESTS: [&str; 41] = [
         "GetDataContractHistoryRequest",
         "GetDataContractRequest",
         "GetDataContractsRequest",
@@ -59,10 +85,10 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetIdentityContractNonceRequest",
         "GetIdentityBalanceAndRevisionRequest",
         "GetIdentityBalanceRequest",
+        "GetIdentityByNonUniquePublicKeyHashRequest",
         "GetIdentityByPublicKeyHashRequest",
         "GetIdentityKeysRequest",
         "GetIdentityRequest",
-        "GetProofsRequest",
         "WaitForStateTransitionResultRequest",
         "GetProtocolVersionUpgradeStateRequest",
         "GetProtocolVersionUpgradeVoteStatusRequest",
@@ -78,14 +104,28 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetEvonodesProposedEpochBlocksByIdsRequest",
         "GetEvonodesProposedEpochBlocksByRangeRequest",
         "GetStatusRequest",
+        "GetIdentityTokenBalancesRequest",
+        "GetIdentitiesTokenBalancesRequest",
+        "GetIdentityTokenInfosRequest",
+        "GetIdentitiesTokenInfosRequest",
+        "GetTokenDirectPurchasePricesRequest",
+        "GetTokenStatusesRequest",
+        "GetTokenTotalSupplyRequest",
+        "GetGroupInfoRequest",
+        "GetGroupInfosRequest",
+        "GetGroupActionsRequest",
+        "GetGroupActionSignersRequest",
     ];
 
     // The following responses are excluded as they don't support proofs:
     // - "GetConsensusParamsResponse"
     // - "GetStatusResponse"
     //
+    // The following responses are excluded as they need custom proof handling:
+    // - "GetIdentityByNonUniquePublicKeyHashResponse"
+    //
     //  "GetEvonodesProposedEpochBlocksResponse" is used for 2 Requests
-    const VERSIONED_RESPONSES: [&str; 29] = [
+    const VERSIONED_RESPONSES: [&str; 39] = [
         "GetDataContractHistoryResponse",
         "GetDataContractResponse",
         "GetDataContractsResponse",
@@ -100,7 +140,6 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetIdentityByPublicKeyHashResponse",
         "GetIdentityKeysResponse",
         "GetIdentityResponse",
-        "GetProofsResponse",
         "WaitForStateTransitionResultResponse",
         "GetEpochsInfoResponse",
         "GetProtocolVersionUpgradeStateResponse",
@@ -115,6 +154,17 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetVotePollsByEndDateResponse",
         "GetTotalCreditsInPlatformResponse",
         "GetEvonodesProposedEpochBlocksResponse",
+        "GetIdentityTokenBalancesResponse",
+        "GetIdentitiesTokenBalancesResponse",
+        "GetIdentityTokenInfosResponse",
+        "GetIdentitiesTokenInfosResponse",
+        "GetTokenDirectPurchasePricesResponse",
+        "GetTokenStatusesResponse",
+        "GetTokenTotalSupplyResponse",
+        "GetGroupInfoResponse",
+        "GetGroupInfosResponse",
+        "GetGroupActionsResponse",
+        "GetGroupActionSignersResponse",
     ];
 
     check_unique(&VERSIONED_REQUESTS).expect("VERSIONED_REQUESTS");
@@ -174,6 +224,19 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
     platform
 }
 
+fn configure_drive(drive: MappingConfig) -> MappingConfig {
+    drive
+        .message_attribute(".", r#"#[derive( ::dapi_grpc_macros::Mockable)]"#)
+        .type_attribute(
+            ".",
+            r#"#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]"#,
+        )
+        .type_attribute(
+            ".",
+            r#"#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]"#,
+        )
+}
+
 /// Check for duplicate messages in the list.
 fn check_unique(messages: &[&'static str]) -> Result<(), String> {
     let mut hashset: HashSet<&'static str> = HashSet::new();
@@ -210,6 +273,43 @@ fn configure_core(core: MappingConfig) -> MappingConfig {
     core
 }
 
+#[allow(unused)]
+enum ImplType {
+    Server,
+    Client,
+    Wasm,
+}
+
+impl ImplType {
+    // Configure the builder based on the implementation type.
+    pub fn configure(&self, builder: Builder) -> Builder {
+        match self {
+            Self::Server => builder
+                .build_client(true)
+                .build_server(true)
+                .build_transport(true),
+            Self::Client => builder
+                .build_client(true)
+                .build_server(false)
+                .build_transport(true),
+            Self::Wasm => builder
+                .build_client(true)
+                .build_server(false)
+                .build_transport(false),
+        }
+    }
+
+    /// Get the directory name for the implementation type.
+    fn dirname(&self) -> String {
+        match self {
+            Self::Server => "server",
+            Self::Client => "client",
+            Self::Wasm => "wasm",
+        }
+        .to_string()
+    }
+}
+
 impl MappingConfig {
     /// Create a new MappingConfig instance.
     ///
@@ -220,31 +320,18 @@ impl MappingConfig {
     ///
     /// 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 {
+    fn new(protobuf_file: PathBuf, out_dir: PathBuf, typ: &ImplType) -> Self {
         let protobuf_file = abs_path(&protobuf_file);
 
-        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_suffix = typ.dirname();
 
         let out_dir = abs_path(&out_dir.join(out_dir_suffix));
 
-        let builder = tonic_build::configure()
-            .build_server(build_server)
-            .build_client(build_client)
-            .build_transport(build_server || build_client)
+        let builder = typ
+            .configure(tonic_build::configure())
             .out_dir(out_dir.clone())
             .protoc_arg("--experimental_allow_proto3_optional");
 
@@ -262,6 +349,14 @@ impl MappingConfig {
         self
     }
 
+    #[allow(unused)]
+    fn includes(mut self, includes: &[PathBuf]) -> Self {
+        for include in includes {
+            self.proto_includes.push(abs_path(include));
+        }
+        self
+    }
+
     #[allow(unused)]
     fn field_attribute(mut self, path: &str, attribute: &str) -> Self {
         self.builder = self.builder.field_attribute(path, attribute);

package/clients/drive/v0/nodejs/DrivePromiseClient.js

@@ -0,0 +1,111 @@
+const grpc = require('@grpc/grpc-js');
+const { promisify } = require('util');
+
+const {
+  convertObjectToMetadata,
+  utils: {
+    isObject,
+  },
+  client: {
+    interceptors: {
+      jsonToProtobufInterceptorFactory,
+    },
+    converters: {
+      jsonToProtobufFactory,
+      protobufToJsonFactory,
+    },
+  },
+} = require('@dashevo/grpc-common');
+
+const { URL } = require('url');
+const {
+  org: {
+    dash: {
+      platform: {
+        drive: {
+          v0: {
+            GetProofsRequest: PBJSGetProofsRequest,
+            GetProofsResponse: PBJSGetProofsResponse,
+          },
+        },
+      },
+    },
+  },
+} = require('./drive_pbjs');
+
+const {
+  GetProofsResponse: ProtocGetProofsResponse,
+} = require('./drive_protoc');
+
+const getDriveDefinition = require('../../../../lib/getDriveDefinition');
+
+const DriveNodeJSClient = getDriveDefinition(0);
+
+class DrivePromiseClient {
+  /**
+   * @param {string} hostname
+   * @param {?Object} credentials
+   * @param {?Object} options
+   */
+  constructor(hostname, credentials, options = {}) {
+    if (credentials !== undefined) {
+      throw new Error('"credentials" option is not supported yet');
+    }
+
+    const url = new URL(hostname);
+    const { protocol, host: strippedHostname } = url;
+
+    // See this issue https://github.com/nodejs/node/issues/3176
+    // eslint-disable-next-line no-param-reassign
+    credentials = protocol.replace(':', '') === 'https' ? grpc.credentials.createSsl() : grpc.credentials.createInsecure();
+
+    this.client = new DriveNodeJSClient(strippedHostname, credentials, options);
+
+    this.client.getProofs = promisify(
+      this.client.getProofs.bind(this.client),
+    );
+
+    this.protocolVersion = undefined;
+  }
+
+  /**
+   *
+   * @param {!GetProofsRequest} request
+   * @param {?Object<string, string>} metadata
+   * @param {CallOptions} [options={}]
+   * @returns {Promise<!GetProofsResponse>}
+   */
+  getProofs(request, metadata = {}, options = {}) {
+    if (!isObject(metadata)) {
+      throw new Error('metadata must be an object');
+    }
+
+    return this.client.getProofs(
+      request,
+      convertObjectToMetadata(metadata),
+      {
+        interceptors: [
+          jsonToProtobufInterceptorFactory(
+            jsonToProtobufFactory(
+              ProtocGetProofsResponse,
+              PBJSGetProofsResponse,
+            ),
+            protobufToJsonFactory(
+              PBJSGetProofsRequest,
+            ),
+          ),
+        ],
+        ...options,
+      },
+    );
+  }
+
+  /**
+   * @param {string} protocolVersion
+   */
+  setProtocolVersion(protocolVersion) {
+    this.protocolVersion = protocolVersion;
+  }
+}
+
+module.exports = DrivePromiseClient;