@dashevo/dapi-client 0.25.0-dev.15 → 0.25.0-dev.16

package/lib/BlockHeadersProvider/BlockHeadersProvider.js

@@ -1,6 +1,4 @@
 const EventEmitter = require('events');
-const { configure: configureDashcore } = require('@dashevo/dashcore-lib');
-const X11 = require('wasm-x11-hash');
 const { SpvChain, SPVError } = require('@dashevo/dash-spv');
 
 const BlockHeadersReader = require('./BlockHeadersReader');
@@ -51,7 +49,6 @@ class BlockHeadersProvider extends EventEmitter {
     this.spvChain = new SpvChain(this.options.network, 100);
 
     this.state = STATES.IDLE;
-    this.wasmX11Ready = false;
 
     this.errorHandler = this.errorHandler.bind(this);
     this.headersHandler = this.headersHandler.bind(this);
@@ -79,13 +76,7 @@ class BlockHeadersProvider extends EventEmitter {
    * @private
    */
   async init() {
-    if (!this.wasmX11Ready) {
-      const x11Hash = await X11();
-      configureDashcore({
-        x11hash: x11Hash,
-      });
-      this.wasmX11Ready = true;
-    }
+    await SpvChain.wasmX11Ready();
 
     if (!this.blockHeadersReader) {
       this.blockHeadersReader = new BlockHeadersReader(
@@ -113,12 +104,18 @@ class BlockHeadersProvider extends EventEmitter {
    * Initializes SPV chain with a list of headers and a known lastSyncedHeaderHeight
    *
    * @param headers
-   * @param lastSyncedHeaderHeight
+   * @param firstHeaderHeight
    */
-  initializeWith(headers, lastSyncedHeaderHeight) {
-    const firstHeaderHeight = lastSyncedHeaderHeight - headers.length + 1;
-    this.spvChain.reset(firstHeaderHeight);
-    this.spvChain.addHeaders(headers, firstHeaderHeight);
+  async initializeChainWith(headers, firstHeaderHeight) {
+    await SpvChain.wasmX11Ready();
+
+    if (headers.length === 0) {
+      // If there are no headers, initialize chain from genesis
+      this.spvChain.initialize();
+    } else {
+      this.spvChain.initialize(headers[0], firstHeaderHeight);
+      this.spvChain.addHeaders(headers);
+    }
   }
 
   /**
@@ -130,7 +127,8 @@ class BlockHeadersProvider extends EventEmitter {
   ensureChainRoot(height) {
     // Flush spv chain in case header at specified height was not found
     if (!this.spvChain.hashesByHeight.has(height - 1)) {
-      this.spvChain.reset(height);
+      this.spvChain.reset();
+      this.spvChain.pendingStartBlockHeight = height;
     }
   }
 

package/lib/methods/platform/PlatformMethodsFacade.js

@@ -1,5 +1,6 @@
 const broadcastStateTransitionFactory = require('./broadcastStateTransition/broadcastStateTransitionFactory');
 const getDataContractFactory = require('./getDataContract/getDataContractFactory');
+const getDataContractHistoryFactory = require('./getDataContractHistory/getDataContractHistoryFactory');
 const getDocumentsFactory = require('./getDocuments/getDocumentsFactory');
 const getIdentityFactory = require('./getIdentity/getIdentityFactory');
 const getIdentitiesByPublicKeyHashesFactory = require('./getIdentitiesByPublicKeyHashes/getIdentitiesByPublicKeyHashesFactory');
@@ -13,6 +14,7 @@ class PlatformMethodsFacade {
   constructor(grpcTransport) {
     this.broadcastStateTransition = broadcastStateTransitionFactory(grpcTransport);
     this.getDataContract = getDataContractFactory(grpcTransport);
+    this.getDataContractHistory = getDataContractHistoryFactory(grpcTransport);
     this.getDocuments = getDocumentsFactory(grpcTransport);
     this.getIdentity = getIdentityFactory(grpcTransport);
     this.getIdentitiesByPublicKeyHashes = getIdentitiesByPublicKeyHashesFactory(grpcTransport);

package/lib/methods/platform/getDataContractHistory/GetDataContractHistoryResponse.js

@@ -0,0 +1,55 @@
+const AbstractResponse = require('../response/AbstractResponse');
+const InvalidResponseError = require('../response/errors/InvalidResponseError');
+
+class GetDataContractHistoryResponse extends AbstractResponse {
+  /**
+   * @param {object.<number, Buffer>} dataContractHistory
+   * @param {Metadata} metadata
+   * @param {Proof} [proof]
+   */
+  constructor(dataContractHistory, metadata, proof = undefined) {
+    super(metadata, proof);
+
+    this.dataContractHistory = dataContractHistory;
+  }
+
+  /**
+   * @returns {object.<number, Buffer>}
+   */
+  getDataContractHistory() {
+    return this.dataContractHistory;
+  }
+
+  /**
+   * @param proto
+   * @returns {GetDataContractHistoryResponse}
+   */
+  static createFromProto(proto) {
+    // History is something that we need to call a method to get a list of entries on
+    const dataContractHistory = proto.getDataContractHistory();
+    const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto(proto);
+
+    if (!dataContractHistory && !proof) {
+      throw new InvalidResponseError('DataContract is not defined');
+    }
+
+    const history = {};
+
+    if (dataContractHistory) {
+      const dataContractHistoryEntries = dataContractHistory.getDataContractEntriesList();
+
+      // eslint-disable-next-line no-restricted-syntax
+      for (const historyEntry of dataContractHistoryEntries) {
+        history[historyEntry.getDate()] = historyEntry.getValue();
+      }
+    }
+
+    return new GetDataContractHistoryResponse(
+      history,
+      metadata,
+      proof,
+    );
+  }
+}
+
+module.exports = GetDataContractHistoryResponse;

package/lib/methods/platform/getDataContractHistory/getDataContractHistoryFactory.js

@@ -0,0 +1,81 @@
+const {
+  v0: {
+    PlatformPromiseClient,
+    GetDataContractHistoryRequest,
+  },
+} = require('@dashevo/dapi-grpc');
+
+const GetDataContractHistoryResponse = require('./GetDataContractHistoryResponse');
+const InvalidResponseError = require('../response/errors/InvalidResponseError');
+
+/**
+ * @param {GrpcTransport} grpcTransport
+ * @returns {getDataContractHistory}
+ */
+function getDataContractHistoryFactory(grpcTransport) {
+  /**
+   * Fetch Data Contract by id
+   *
+   * @typedef {getDataContractHistory}
+   * @param {Buffer} contractId
+   * @param {number} [startAtMs]
+   * @param {number} [limit]
+   * @param {number} [offset]
+   * @param {DAPIClientOptions & {prove: boolean}} [options]
+   * @returns {Promise<GetDataContractHistoryResponse>}
+   */
+  async function getDataContractHistory(
+    contractId,
+    startAtMs = 0,
+    limit = 10,
+    offset = 0,
+    options = {},
+  ) {
+    const getDataContractHistoryRequest = new GetDataContractHistoryRequest();
+
+    // need to convert objects inherited from Buffer to pure buffer as google protobuf
+    // doesn't support extended buffers
+    // https://github.com/protocolbuffers/protobuf/blob/master/js/binary/utils.js#L1049
+    if (Buffer.isBuffer(contractId)) {
+      // eslint-disable-next-line no-param-reassign
+      contractId = Buffer.from(contractId);
+    }
+
+    getDataContractHistoryRequest.setId(contractId);
+    getDataContractHistoryRequest.setStartAtMs(startAtMs);
+    getDataContractHistoryRequest.setLimit(limit);
+    getDataContractHistoryRequest.setOffset(offset);
+    getDataContractHistoryRequest.setProve(!!options.prove);
+
+    let lastError;
+
+    // TODO: simple retry before the dapi versioning is properly implemented
+    for (let i = 0; i < 3; i += 1) {
+      try {
+        // eslint-disable-next-line no-await-in-loop
+        const getDataContractHistoryResponse = await grpcTransport.request(
+          PlatformPromiseClient,
+          'getDataContractHistory',
+          getDataContractHistoryRequest,
+          options,
+        );
+
+        return GetDataContractHistoryResponse.createFromProto(getDataContractHistoryResponse);
+      } catch (e) {
+        if (e instanceof InvalidResponseError) {
+          lastError = e;
+        } else {
+          throw e;
+        }
+      }
+    }
+
+    // If we made it past the cycle it means that the retry didn't work,
+    // and we're throwing the last error encountered
+    throw lastError;
+  }
+
+  return getDataContractHistory;
+}
+
+module.exports = getDataContractHistoryFactory;

package/lib/methods/platform/getDocuments/GetDocumentsResponse.js

@@ -26,8 +26,11 @@ class GetDocumentsResponse extends AbstractResponse {
   static createFromProto(proto) {
     const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto(proto);
 
+    const documents = proto.getDocuments();
+
     return new GetDocumentsResponse(
-      proto.getDocumentsList().map((document) => Buffer.from(document)),
+      documents !== undefined
+        ? documents.getDocumentsList().map((document) => Buffer.from(document)) : [],
       metadata,
       proof,
     );

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

@@ -26,8 +26,11 @@ class GetIdentitiesByPublicKeyHashesResponse extends AbstractResponse {
   static createFromProto(proto) {
     const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto(proto);
 
+    const identitiesList = proto.getIdentities();
+
     return new GetIdentitiesByPublicKeyHashesResponse(
-      proto.getIdentitiesList_asU8().map((identity) => Buffer.from(identity)),
+      identitiesList !== undefined
+        ? identitiesList.getIdentitiesList_asU8().map((identity) => Buffer.from(identity)) : [],
       metadata,
       proof,
     );

package/lib/transport/JsonRpcTransport/requestJsonRpc.js

@@ -65,12 +65,13 @@ async function requestJsonRpc(protocol, host, port, selfSigned, method, params,
   if (typeof requestTimeoutId !== 'undefined') {
     clearTimeout(requestTimeoutId);
   }
-  const data = await response.json();
 
   if (!response.ok) {
     throw new WrongHttpCodeError(requestInfo, response.status, response.statusText);
   }
 
+  const data = await response.json();
+
   if (data.error) {
     throw new JsonRpcError(requestInfo, data.error);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-client",
-  "version": "0.25.0-dev.15",
+  "version": "0.25.0-dev.16",
   "description": "Client library used to access Dash DAPI endpoints",
   "main": "lib/index.js",
   "contributors": [
@@ -26,12 +26,12 @@
     }
   ],
   "dependencies": {
-    "@dashevo/dapi-grpc": "0.25.0-dev.15",
-    "@dashevo/dash-spv": "0.25.0-dev.15",
-    "@dashevo/dashcore-lib": "~0.20.6",
-    "@dashevo/dpp": "0.25.0-dev.15",
-    "@dashevo/grpc-common": "0.25.0-dev.15",
-    "@dashevo/wasm-dpp": "0.25.0-dev.15",
+    "@dashevo/dapi-grpc": "0.25.0-dev.16",
+    "@dashevo/dash-spv": "0.25.0-dev.16",
+    "@dashevo/dashcore-lib": "~0.20.9",
+    "@dashevo/dpp": "0.25.0-dev.16",
+    "@dashevo/grpc-common": "0.25.0-dev.16",
+    "@dashevo/wasm-dpp": "0.25.0-dev.16",
     "bs58": "^4.0.1",
     "cbor": "^8.0.0",
     "lodash": "^4.17.21",