@dashevo/dapi-client 0.22.0-dev.3 → 0.22.0-dev.7

package/README.md

@@ -12,7 +12,7 @@ Platform via the decentralized API ([DAPI](https://github.com/dashevo/dapi))
 hosted on Dash masternodes.
 
  - `DAPI-Client` provides automatic server (masternode) discovery using either a default seed node or a user-supplied one
- - `DAPI-Client` maps to DAPI's [RPC](https://github.com/dashevo/dapi/tree/master/lib/rpcServer/commands) and [gRPC](https://github.com/dashevo/dapi/tree/master/lib/grpcServer/handlers) endpoints
+ - `DAPI-Client` maps to DAPI's [RPC](https://github.com/dashevo/platform/tree/master/packages/dapi/lib/rpcServer/commands) and [gRPC](https://github.com/dashevo/platform/tree/master/packages/dapi/lib/grpcServer/handlers) endpoints
 
 ## Table of Contents
 - [Install](#install)
@@ -101,12 +101,12 @@ client.core.getBestBlockHash(options).then((r) => {
 
 ## Documentation
 
-More extensive documentation available at https://dashevo.github.io/js-dapi-client/.
+More extensive documentation available at https://dashevo.github.io/platform/DAPI-Client/.
 
 
 ## Contributing
 
-Feel free to dive in! [Open an issue](https://github.com/dashevo/js-dapi-client/issues/new/choose) or submit PRs.
+Feel free to dive in! [Open an issue](https://github.com/dashevo/platform/issues/new/choose) or submit PRs.
 
 ## License
 

package/lib/methods/core/CoreMethodsFacade.js

@@ -8,6 +8,7 @@ const getMnListDiffFactory = require('./getMnListDiffFactory');
 const getStatusFactory = require('./getStatusFactory');
 const getTransactionFactory = require('./getTransaction/getTransactionFactory');
 const subscribeToTransactionsWithProofsFactory = require('./subscribeToTransactionsWithProofsFactory');
+const subscribeToBlockHeadersWithChainLocksFactory = require('./subscribeToBlockHeadersWithChainLocksFactory');
 
 class CoreMethodsFacade {
   /**
@@ -27,6 +28,9 @@ class CoreMethodsFacade {
     this.subscribeToTransactionsWithProofs = subscribeToTransactionsWithProofsFactory(
       grpcTransport,
     );
+    this.subscribeToBlockHeadersWithChainLocks = subscribeToBlockHeadersWithChainLocksFactory(
+      grpcTransport,
+    );
   }
 }
 

package/lib/methods/core/subscribeToBlockHeadersWithChainLocksFactory.js

@@ -0,0 +1,69 @@
+const {
+  v0: {
+    BlockHeadersWithChainLocksRequest,
+    CorePromiseClient,
+  },
+} = require('@dashevo/dapi-grpc');
+
+const DAPIClientError = require('../../errors/DAPIClientError');
+
+/**
+ * @param {GrpcTransport} grpcTransport
+ * @returns {subscribeToBlockHeadersWithChainLocks}
+ */
+function subscribeToBlockHeadersWithChainLocksFactory(grpcTransport) {
+  /**
+   * @typedef {subscribeToBlockHeadersWithChainLocks}
+   * @param {DAPIClientOptions & subscribeToBlockHeadersWithChainLocksOptions} [options]
+   * @returns {
+   *    EventEmitter|!grpc.web.ClientReadableStream<!BlockHeadersWithChainLocksResponse>
+   * }
+   */
+  async function subscribeToBlockHeadersWithChainLocks(options = { }) {
+    // eslint-disable-next-line no-param-reassign
+    options = {
+      count: 0,
+      // Override global timeout option
+      // and timeout for this method by default
+      timeout: undefined,
+      ...options,
+    };
+
+    if (options.fromBlockHeight === 0) {
+      throw new DAPIClientError('Invalid argument: minimum value for `fromBlockHeight` is 1');
+    }
+
+    const request = new BlockHeadersWithChainLocksRequest();
+
+    if (options.fromBlockHeight !== undefined) {
+      request.setFromBlockHeight(options.fromBlockHeight);
+    }
+
+    if (options.fromBlockHash) {
+      request.setFromBlockHash(
+        Buffer.from(options.fromBlockHash, 'hex'),
+      );
+    }
+
+    request.setCount(options.count);
+
+    return grpcTransport.request(
+      CorePromiseClient,
+      'subscribeToBlockHeadersWithChainLocks',
+      request,
+      options,
+    );
+  }
+
+  return subscribeToBlockHeadersWithChainLocks;
+}
+
+/**
+ * @typedef {object} subscribeToBlockHeadersWithChainLocksOptions
+ * @property {string} [fromBlockHash] - Specifies block hash to start syncing from
+ * @property {number} [fromBlockHeight] - Specifies block height to start syncing from
+ * @property {number} [count=0] - Number of blocks to sync,
+ *                                if set to 0 syncing is continuously sends new data as well
+ */
+
+module.exports = subscribeToBlockHeadersWithChainLocksFactory;

package/lib/methods/platform/getIdentitiesByPublicKeyHashes/GetIdentitiesByPublicKeyHashesResponse.js

@@ -1,3 +1,5 @@
+const cbor = require('cbor');
+
 const AbstractResponse = require('../response/AbstractResponse');
 
 class GetIdentitiesByPublicKeyHashesResponse extends AbstractResponse {
@@ -13,7 +15,7 @@ class GetIdentitiesByPublicKeyHashesResponse extends AbstractResponse {
   }
 
   /**
-   * @returns {Buffer[]}
+   * @returns {Array<Buffer[]>}
    */
   getIdentities() {
     return this.identities;
@@ -27,8 +29,13 @@ class GetIdentitiesByPublicKeyHashesResponse extends AbstractResponse {
     const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto(proto);
 
     return new GetIdentitiesByPublicKeyHashesResponse(
-      proto.getIdentitiesList()
-        .map((identity) => (identity.length > 0 ? Buffer.from(identity) : null)),
+      proto.getIdentitiesList().map((identitiesSerialized) => {
+        const identities = cbor.decode(identitiesSerialized);
+
+        return identities.map((identity) => (
+          (identity.length > 0 ? Buffer.from(identity) : null)
+        ));
+      }),
       metadata,
       proof,
     );

package/lib/methods/platform/getIdentityIdsByPublicKeyHashes/GetIdentityIdsByPublicKeyHashesResponse.js

@@ -1,3 +1,5 @@
+const cbor = require('cbor');
+
 const AbstractResponse = require('../response/AbstractResponse');
 
 class GetIdentityIdsByPublicKeyHashesResponse extends AbstractResponse {
@@ -13,7 +15,7 @@ class GetIdentityIdsByPublicKeyHashesResponse extends AbstractResponse {
   }
 
   /**
-   * @returns {Buffer[]}
+   * @returns {Array<Buffer[]>}
    */
   getIdentityIds() {
     return this.identityIds;
@@ -27,8 +29,13 @@ class GetIdentityIdsByPublicKeyHashesResponse extends AbstractResponse {
     const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto(proto);
 
     return new GetIdentityIdsByPublicKeyHashesResponse(
-      proto.getIdentityIdsList()
-        .map((identityId) => (identityId.length > 0 ? Buffer.from(identityId) : null)),
+      proto.getIdentityIdsList().map((identityIdsSerialized) => {
+        const identityIds = cbor.decode(identityIdsSerialized);
+
+        return identityIds.map((identityId) => (
+          (identityId.length > 0 ? Buffer.from(identityId) : null)
+        ));
+      }),
       metadata,
       proof,
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-client",
-  "version": "0.22.0-dev.3",
+  "version": "0.22.0-dev.7",
   "description": "Client library used to access Dash DAPI endpoints",
   "main": "lib/DAPIClient.js",
   "contributors": [
@@ -26,10 +26,10 @@
     }
   ],
   "dependencies": {
-    "@dashevo/dapi-grpc": "~0.22.0-dev.3",
-    "@dashevo/dashcore-lib": "~0.19.28",
-    "@dashevo/dpp": "~0.22.0-dev.3",
-    "@dashevo/grpc-common": "~0.22.0-dev.3",
+    "@dashevo/dapi-grpc": "~0.22.0-dev.7",
+    "@dashevo/dashcore-lib": "~0.19.29",
+    "@dashevo/dpp": "~0.22.0-dev.7",
+    "@dashevo/grpc-common": "~0.22.0-dev.7",
     "@grpc/grpc-js": "^1.3.7",
     "axios": "^0.21.1",
     "bs58": "^4.0.1",