@dashevo/dapi-client 0.22.0-dev.5 → 0.22.0-dev.6

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-client",
-  "version": "0.22.0-dev.5",
+  "version": "0.22.0-dev.6",
   "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.5",
+    "@dashevo/dapi-grpc": "~0.22.0-dev.6",
     "@dashevo/dashcore-lib": "~0.19.28",
-    "@dashevo/dpp": "~0.22.0-dev.5",
-    "@dashevo/grpc-common": "~0.22.0-dev.5",
+    "@dashevo/dpp": "~0.22.0-dev.6",
+    "@dashevo/grpc-common": "~0.22.0-dev.6",
     "@grpc/grpc-js": "^1.3.7",
     "axios": "^0.21.1",
     "bs58": "^4.0.1",