@dashevo/dapi-grpc 0.24.0-dev.6 → 0.25.0-dev.10

package/Cargo.toml

@@ -0,0 +1,39 @@
+[package]
+name = "dapi-grpc"
+description = "GRPC client for Dash Platform"
+version = "0.25.0-dev.6"
+authors = [
+    "Samuel Westrich <sam@dash.org>",
+    "Igor Markin <igor.markin@dash.org>",
+    "Łukasz Klimek <lukasz.klimek@dash.org>",
+    "Anton Suprunchuk <anton.suprunchuk@dash.org>",
+    "Ivan Shumkov <shumkov@dash.org>",
+]
+edition = "2021"
+license = "MIT"
+
+[dependencies]
+prost = { version = "0.11.9" }
+prost-types = { version = "0.11.9" }
+
+[build-dependencies]
+prost-build = { version = "0.11" }
+
+[features]
+default = ["core", "platform"]
+core = ["core_v0"]
+platform = ["platform_v0"]
+
+core_v0 = []
+platform_v0 = []
+
+[lib]
+
+[[example]]
+name = "core_example"
+path = "clients/core/v0/rust/core_example.rs"
+
+
+[[example]]
+name = "platform_example"
+path = "clients/platform/v0/rust/platform_example.rs"

package/README.md

@@ -1,8 +1,8 @@
 # DAPI GRPC
 
-[![Build Status](https://github.com/dashevo/platform/actions/workflows/release.yml/badge.svg)](https://github.com/dashevo/platform/actions/workflows/release.yml)
+[![Build Status](https://github.com/dashpay/platform/actions/workflows/release.yml/badge.svg)](https://github.com/dashpay/platform/actions/workflows/release.yml)
 [![NPM version](https://img.shields.io/npm/v/@dashevo/dapi-grpc.svg)](https://npmjs.org/package/@dashevo/dapi-grpc)
-[![Release Date](https://img.shields.io/github/release-date/dashevo/platform)](https://github.com/dashevo/platform/releases/latest)
+[![Release Date](https://img.shields.io/github/release-date/dashpay/platform)](https://github.com/dashpay/platform/releases/latest)
 [![license](https://img.shields.io/github/license/dashevo/dapi-grpc.svg)](LICENSE)
 
 Decentralized API GRPC definition files and generated clients
@@ -135,7 +135,7 @@ Available methods :
 
 ## Contributing
 
-Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.
+Feel free to dive in! [Open an issue](https://github.com/dashpay/platform/issues/new/choose) or submit PRs.
 
 ## License
 

package/browser.js

@@ -1,10 +1,18 @@
-const core = require('./clients/core/v0/web/core_grpc_web_pb');
-const platform = require('./clients/platform/v0/web/platform_grpc_web_pb');
+const { grpc: { Metadata } } = require('@improbable-eng/grpc-web');
+const CorePromiseClient = require('./clients/core/v0/web/CorePromiseClient');
+const PlatformPromiseClient = require('./clients/platform/v0/web/PlatformPromiseClient');
+
+const coreMessages = require('./clients/core/v0/web/core_pb');
+const platformMessages = require('./clients/platform/v0/web/platform_pb');
+const parseMetadata = require('./lib/utils/parseMetadata');
 
 module.exports = {
   v0: {
-
-    ...core,
-    ...platform,
+    ...coreMessages,
+    ...platformMessages,
+    CorePromiseClient,
+    PlatformPromiseClient,
   },
+  parseMetadata,
+  Metadata,
 };

package/build.rs

@@ -0,0 +1,65 @@
+use std::{
+    collections::HashMap,
+    fs::{create_dir_all, remove_dir_all},
+    path::PathBuf,
+};
+
+fn main() {
+    generate().expect("failed to compile protobuf definitions");
+
+    println!("cargo:rerun-if-changed=./protos");
+    println!("cargo:rerun-if-changed=./src/core/proto");
+    println!("cargo:rerun-if-changed=./src/platform/proto");
+}
+
+/// Generate Rust definitions from Protobuf definitions
+pub fn generate() -> Result<(), std::io::Error> {
+    // Mapping between protobuf files => output directory
+    let mut input = HashMap::<PathBuf, PathBuf>::new();
+    input.insert(
+        PathBuf::from("protos/core/v0/core.proto"),
+        PathBuf::from("src/core/proto"),
+    );
+    input.insert(
+        PathBuf::from("protos/platform/v0/platform.proto"),
+        PathBuf::from("src/platform/proto"),
+    );
+
+    let proto_includes = vec![abs_path(&PathBuf::from("protos"))];
+
+    for (proto, dest) in input {
+        let proto = abs_path(&proto);
+        let dest = abs_path(&dest);
+        // Remove old compiled files; ignore errors
+        if dest.exists() {
+            remove_dir_all(&dest)?;
+        }
+        create_dir_all(&dest)?;
+
+        generate1(&[proto], &proto_includes, &dest)?;
+    }
+
+    Ok(())
+}
+
+/// Run single generation process.
+///
+/// All paths must be absolute
+fn generate1(
+    files: &[PathBuf],
+    proto_includes: &[PathBuf],
+    out_dir: &PathBuf,
+) -> Result<(), std::io::Error> {
+    let mut pb = prost_build::Config::new();
+    pb.out_dir(out_dir);
+    pb.format(true);
+    pb.compile_protos(files, proto_includes)
+}
+
+fn abs_path(path: &PathBuf) -> PathBuf {
+    if path.is_absolute() {
+        return path.to_owned();
+    }
+
+    PathBuf::from(env!("CARGO_MANIFEST_DIR")).join(path)
+}

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

@@ -73,8 +73,9 @@ class CorePromiseClient {
     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 === 'https' ? grpc.credentials.createSsl() : grpc.credentials.createInsecure();
+    credentials = protocol.replace(':', '') === 'https' ? grpc.credentials.createSsl() : grpc.credentials.createInsecure();
 
     this.client = new CoreNodeJSClient(strippedHostname, credentials, options);
 

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

@@ -13,39 +13,39 @@
 
 var jspb = require('google-protobuf');
 var goog = jspb;
-var global = Function('return this')();
-
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeaders', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeadersWithChainLocksRequest', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeadersWithChainLocksRequest.FromBlockCase', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeadersWithChainLocksResponse', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeadersWithChainLocksResponse.ResponsesCase', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.BloomFilter', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.BroadcastTransactionRequest', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.BroadcastTransactionResponse', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetBlockRequest', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetBlockRequest.BlockCase', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetBlockResponse', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetEstimatedTransactionFeeRequest', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetEstimatedTransactionFeeResponse', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusRequest', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Chain', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Masternode', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Masternode.Status', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Network', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.NetworkFee', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Status', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Time', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Version', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetTransactionRequest', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetTransactionResponse', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.InstantSendLockMessages', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.RawTransactions', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.TransactionsWithProofsRequest', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.TransactionsWithProofsRequest.FromBlockCase', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.TransactionsWithProofsResponse', null, global);
-goog.exportSymbol('proto.org.dash.platform.dapi.v0.TransactionsWithProofsResponse.ResponsesCase', null, global);
+const proto = {};
+
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeaders', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeadersWithChainLocksRequest', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeadersWithChainLocksRequest.FromBlockCase', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeadersWithChainLocksResponse', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.BlockHeadersWithChainLocksResponse.ResponsesCase', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.BloomFilter', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.BroadcastTransactionRequest', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.BroadcastTransactionResponse', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetBlockRequest', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetBlockRequest.BlockCase', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetBlockResponse', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetEstimatedTransactionFeeRequest', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetEstimatedTransactionFeeResponse', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusRequest', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Chain', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Masternode', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Masternode.Status', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Network', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.NetworkFee', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Status', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Time', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetStatusResponse.Version', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetTransactionRequest', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.GetTransactionResponse', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.InstantSendLockMessages', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.RawTransactions', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.TransactionsWithProofsRequest', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.TransactionsWithProofsRequest.FromBlockCase', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.TransactionsWithProofsResponse', null, { proto });
+goog.exportSymbol('proto.org.dash.platform.dapi.v0.TransactionsWithProofsResponse.ResponsesCase', null, { proto });
 /**
  * Generated by JsPbCodeGenerator.
  * @param {Array=} opt_data Optional initial data array, typically from a

package/clients/core/v0/rust/README.md

@@ -0,0 +1,3 @@
+# Rust bindings
+
+Rust definitions can be found in [dapi-grpc/src](../../../../src/) directory.

package/clients/core/v0/rust/core_example.rs

@@ -0,0 +1,14 @@
+use dapi_grpc::core::v0 as core;
+use prost::Message;
+
+fn main() {
+    let request = core::GetBlockRequest {
+        block: Some(core::get_block_request::Block::Height(123)),
+    };
+    let mut buffer = Vec::<u8>::new();
+    request.encode(&mut buffer).expect("failed to encode data");
+
+    let decoded = core::GetBlockRequest::decode(buffer.as_ref()).expect("failed to decode data");
+
+    assert_eq!(request, decoded);
+}

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

@@ -0,0 +1,159 @@
+const { promisify } = require('util');
+const GrpcError = require('@dashevo/grpc-common/lib/server/error/GrpcError');
+
+const { CoreClient } = require('./core_pb_service');
+
+/**
+ * Function rewires @imporbable-eng/grpc-web stream
+ * to comply with the EventEmitter interface
+ * @param stream
+ * @return {!grpc.web.ClientReadableStream}
+ */
+const rewireStream = (stream) => {
+  const defaultOnFunction = stream.on.bind(stream);
+
+  // Rewire default on function to comply with EventEmitter interface
+  stream.on = ((type, handler) => {
+   if (type === 'error') { // Handle `error` event using `end` event
+      return stream.on('end', (payload) => {
+        if (payload) {
+          const { code, details, metadata } = payload;
+          if (code !== 0) {
+            const error = new GrpcError(code, details);
+            // It is important to assign metadata to the error object
+            // instead of passing it as GrpcError constructor argument
+            // Otherwise it will be converted to grpc-js metadata
+            // Which is not compatible with web
+            error.metadata = metadata;
+            handler(error);
+          }
+        }
+      });
+    } else {
+      // `data` event could be processed normally
+      return defaultOnFunction(type, handler);
+    }
+  });
+
+  // Assign an empty function to `once` method
+  // because @imporbable-eng/grpc-web doesn't expose it and
+  // stream cancellation detaches all handlers internally
+  stream.removeListener = () => {}
+}
+
+class CorePromiseClient {
+  /**
+   * @param {string} hostname
+   * @param {?Object} credentials
+   * @param {?Object} options
+   */
+  constructor(hostname, credentials , options = {}) {
+    this.client = new CoreClient(hostname, options)
+  }
+
+  /**
+   * @param {!GetStatusRequest} getStatusRequest
+   * @param {?Object<string, string>} metadata
+   * @return {Promise<!GetStatusResponse>}
+   */
+  getStatus(getStatusRequest, metadata = {}) {
+    return promisify(
+      this.client.getStatus.bind(this.client),
+    )(
+      getStatusRequest,
+      metadata,
+    );
+  }
+
+  /**
+   * @param {!GetBlockRequest} getBlockRequest
+   * @param {?Object<string, string>} metadata
+   * @return {Promise<!GetBlockResponse>}
+   */
+  getBlock(getBlockRequest, metadata = {}) {
+    return promisify(
+      this.client.getBlock.bind(this.client),
+    )(
+      getBlockRequest,
+      metadata,
+    );
+  }
+
+  /**
+   * @param {!BroadcastTransactionRequest} broadcastTransactionRequest
+   * @param {?Object<string, string>} metadata
+   * @return {Promise<!BroadcastTransactionResponse>}
+   */
+  broadcastTransaction(broadcastTransactionRequest, metadata = {}) {
+    return promisify(
+      this.client.broadcastTransaction.bind(this.client),
+    )(
+      broadcastTransactionRequest,
+      metadata,
+    );
+  }
+
+  /**
+   * @param {!GetTransactionRequest} getTransactionRequest
+   * @param {?Object<string, string>} metadata
+   * @return {Promise<!GetTransactionResponse>}
+   */
+  getTransaction(getTransactionRequest, metadata = {}) {
+    return promisify(
+      this.client.getTransaction.bind(this.client),
+    )(
+      getTransactionRequest,
+      metadata,
+    );
+  }
+
+  /**
+   * @param {!GetEstimatedTransactionFeeRequest} getEstimatedTransactionFeeRequest
+   * @param {?Object<string, string>} metadata
+   * @returns {Promise<!GetEstimatedTransactionFeeResponse>}
+   */
+  getEstimatedTransactionFee(getEstimatedTransactionFeeRequest, metadata = {}) {
+    return promisify(
+      this.client.getEstimatedTransactionFee.bind(this.client),
+    )(
+      getEstimatedTransactionFeeRequest,
+      metadata,
+    );
+  }
+
+  /**
+   * @param {!BlockHeadersWithChainLocksRequest} blockHeadersWithChainLocksRequest
+   * @param {?Object<string, string>} metadata
+   * @return {!grpc.web.ClientReadableStream<!BlockHeadersWithChainLocksResponse>|undefined}
+   */
+  subscribeToBlockHeadersWithChainLocks(
+    blockHeadersWithChainLocksRequest,
+    metadata = {},
+  ) {
+    const stream = this.client.subscribeToBlockHeadersWithChainLocks(
+      blockHeadersWithChainLocksRequest,
+      metadata,
+    )
+
+    rewireStream(stream);
+
+    return stream;
+  }
+
+  /**
+   * @param {TransactionsWithProofsRequest} transactionsWithProofsRequest The request proto
+   * @param {?Object<string, string>} metadata User defined call metadata
+   * @return {!grpc.web.ClientReadableStream<!TransactionsWithProofsResponse>|undefined}
+   */
+  subscribeToTransactionsWithProofs(transactionsWithProofsRequest, metadata = {}) {
+    const stream = this.client.subscribeToTransactionsWithProofs(
+      transactionsWithProofsRequest,
+      metadata
+    )
+
+    rewireStream(stream);
+    return stream;
+  }
+}
+
+module.exports = CorePromiseClient;