@dashevo/dapi-client 0.22.15 → 0.23.0-alpha.1

package/README.md

@@ -1,8 +1,8 @@
 # DAPI Client
 
 [![NPM Version](https://img.shields.io/npm/v/@dashevo/dapi-client)](https://www.npmjs.com/package/@dashevo/dapi-client)
-[![Build Status](https://github.com/dashevo/js-dapi-client/actions/workflows/test_and_release.yml/badge.svg)](https://github.com/dashevo/js-dapi-client/actions/workflows/test_and_release.yml)
-[![Release Date](https://img.shields.io/github/release-date/dashevo/js-dapi-client)](https://github.com/dashevo/js-dapi-client/releases/latest)
+[![Build Status](https://github.com/dashevo/platform/actions/workflows/release.yml/badge.svg)](https://github.com/dashevo/platform/actions/workflows/release.yml)
+[![Release Date](https://img.shields.io/github/release-date/dashevo/platform)](https://github.com/dashevo/platform/releases/latest)
 [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen)](https://github.com/RichardLitt/standard-readme)
 
 Client library used to access Dash DAPI endpoints

package/lib/dapiAddressProvider/ListDAPIAddressProvider.js

@@ -26,7 +26,7 @@ class ListDAPIAddressProvider {
     const liveAddress = sample(liveAddresses);
 
     if (liveAddress === undefined) {
-      return liveAddress;
+      return undefined;
     }
 
     // This is a temporary fix for a localhost masternode.
@@ -34,7 +34,11 @@ class ListDAPIAddressProvider {
     // not really possible to bind to that address, so that workaround is introduced.
     const network = networks.get(this.options.network);
     if (network && network.regtestEnabled) {
+      const randomNodeIndex = Math.floor(Math.random() * liveAddresses.length);
+
       liveAddress.host = '127.0.0.1';
+      liveAddress.httpPort = 3000 + randomNodeIndex * 100;
+      liveAddress.grpcPort = 3010 + randomNodeIndex * 100;
     }
 
     return liveAddress;

package/lib/methods/platform/PlatformMethodsFacade.js

@@ -2,7 +2,6 @@ const broadcastStateTransitionFactory = require('./broadcastStateTransition/broa
 const getDataContractFactory = require('./getDataContract/getDataContractFactory');
 const getDocumentsFactory = require('./getDocuments/getDocumentsFactory');
 const getIdentityFactory = require('./getIdentity/getIdentityFactory');
-const getIdentityIdsByPublicKeyHashesFactory = require('./getIdentityIdsByPublicKeyHashes/getIdentityIdsByPublicKeyHashesFactory');
 const getIdentitiesByPublicKeyHashesFactory = require('./getIdentitiesByPublicKeyHashes/getIdentitiesByPublicKeyHashesFactory');
 const waitForStateTransitionResultFactory = require('./waitForStateTransitionResult/waitForStateTransitionResultFactory');
 const getConsensusParamsFactory = require('./getConsensusParams/getConsensusParamsFactory');
@@ -16,7 +15,6 @@ class PlatformMethodsFacade {
     this.getDataContract = getDataContractFactory(grpcTransport);
     this.getDocuments = getDocumentsFactory(grpcTransport);
     this.getIdentity = getIdentityFactory(grpcTransport);
-    this.getIdentityIdsByPublicKeyHashes = getIdentityIdsByPublicKeyHashesFactory(grpcTransport);
     this.getIdentitiesByPublicKeyHashes = getIdentitiesByPublicKeyHashesFactory(grpcTransport);
     this.waitForStateTransitionResult = waitForStateTransitionResultFactory(grpcTransport);
     this.getConsensusParams = getConsensusParamsFactory(grpcTransport);

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

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

package/lib/transport/GrpcTransport/createGrpcTransportError.js

@@ -47,37 +47,37 @@ function createGrpcTransportError(grpcError, dapiAddress) {
   // Extract error code and data
   let data = {};
   let { code } = grpcError;
+
   const message = grpcError.details || grpcError.message;
 
-  if (grpcError.metadata) {
-    let encodedData;
+  let metadata = {};
 
+  if (grpcError.metadata) {
+    // In cases of gRPC-Web client we get plain map instead of Metadata instance
+    metadata = grpcError.metadata;
     if (grpcError.metadata instanceof Metadata) {
-      const cboredMetaData = grpcError.metadata.get('drive-error-data-bin');
-      if (cboredMetaData && cboredMetaData.length > 0) {
-        [encodedData] = cboredMetaData;
-      }
-
-      // since gRPC doesn't allow to use custom error codes
-      // DAPI pass them as a part of metadata
-      const metaCode = grpcError.metadata.get('code');
-      if (metaCode && metaCode.length > 0) {
-        [code] = metaCode;
-      }
-    } else {
-      if (grpcError.metadata['drive-error-data-bin']) {
-        encodedData = Buffer.from(grpcError.metadata['drive-error-data-bin'], 'base64');
-      }
-
-      const metaCode = grpcError.metadata.code;
-      if (metaCode !== undefined) {
-        code = Number(metaCode);
-      }
+      metadata = grpcError.metadata.getMap();
     }
+  }
 
-    if (encodedData) {
-      data = cbor.decode(encodedData);
-    }
+  // Error data
+  const driveErrorData = metadata['drive-error-data-bin'];
+  if (driveErrorData) {
+    const encodedData = Buffer.from(driveErrorData, 'base64');
+    data = cbor.decode(encodedData);
+  }
+
+  // Error code
+  const driveErrorCode = metadata.code;
+  if (driveErrorCode) {
+    code = Number(driveErrorCode);
+  }
+
+  // Error stack
+  const driveErrorStack = metadata['stack-bin'];
+  if (driveErrorStack) {
+    const encodedStack = Buffer.from(driveErrorStack, 'base64');
+    data.stack = cbor.decode(encodedStack);
   }
 
   // Specialized classes
@@ -102,13 +102,6 @@ function createGrpcTransportError(grpcError, dapiAddress) {
   }
 
   if (code === GrpcErrorCodes.INTERNAL) {
-    if (grpcError.metadata) {
-      const metaStack = grpcError.metadata.get('stack-bin');
-      if (metaStack && metaStack.length > 0) {
-        data.stack = cbor.decode(metaStack[0]);
-      }
-    }
-
     return new InternalServerError(
       code,
       message,

package/lib/transport/JsonRpcTransport/JsonRpcTransport.js

@@ -84,14 +84,14 @@ class JsonRpcTransport {
         throw error;
       }
 
-      address.markAsBanned();
-
       const responseError = this.createJsonTransportError(error, address);
 
       if (!(responseError instanceof RetriableResponseError)) {
         throw responseError;
       }
 
+      address.markAsBanned();
+
       if (options.retries === 0) {
         throw new MaxRetriesReachedError(responseError);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-client",
-  "version": "0.22.15",
+  "version": "0.23.0-alpha.1",
   "description": "Client library used to access Dash DAPI endpoints",
   "main": "lib/index.js",
   "contributors": [
@@ -26,13 +26,13 @@
     }
   ],
   "dependencies": {
-    "@dashevo/dapi-grpc": "~0.22.15",
-    "@dashevo/dash-spv": "~1.1.8",
-    "@dashevo/dashcore-lib": "~0.19.39",
-    "@dashevo/dpp": "~0.22.15",
-    "@dashevo/grpc-common": "~0.22.15",
+    "@dashevo/dapi-grpc": "~0.23.0-alpha.1",
+    "@dashevo/dash-spv": "~0.23.0-alpha.1",
+    "@dashevo/dashcore-lib": "~0.19.44",
+    "@dashevo/dpp": "~0.23.0-alpha.1",
+    "@dashevo/grpc-common": "~0.23.0-alpha.1",
     "@grpc/grpc-js": "^1.3.7",
-    "axios": "^0.21.1",
+    "axios": "^0.27.2",
     "bs58": "^4.0.1",
     "cbor": "^8.0.0",
     "lodash.sample": "^4.2.1",
@@ -54,7 +54,7 @@
     "eslint-plugin-import": "^2.24.2",
     "eslint-plugin-jsdoc": "^27.0.0",
     "events": "^3.3.0",
-    "karma": "^6.3.4",
+    "karma": "^6.4.1",
     "karma-chai": "^0.1.0",
     "karma-chrome-launcher": "^3.1.0",
     "karma-firefox-launcher": "^2.1.1",

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

@@ -1,45 +0,0 @@
-const cbor = require('cbor');
-
-const AbstractResponse = require('../response/AbstractResponse');
-
-class GetIdentityIdsByPublicKeyHashesResponse extends AbstractResponse {
-  /**
-   * @param {Buffer[]} identityIds
-   * @param {Metadata} metadata
-   * @param {Proof} [proof]
-   */
-  constructor(identityIds, metadata, proof = undefined) {
-    super(metadata, proof);
-
-    this.identityIds = identityIds;
-  }
-
-  /**
-   * @returns {Array<Buffer[]>}
-   */
-  getIdentityIds() {
-    return this.identityIds;
-  }
-
-  /**
-   * @param proto
-   * @returns {GetIdentityIdsByPublicKeyHashesResponse}
-   */
-  static createFromProto(proto) {
-    const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto(proto);
-
-    return new GetIdentityIdsByPublicKeyHashesResponse(
-      proto.getIdentityIdsList().map((identityIdsSerialized) => {
-        const identityIds = cbor.decode(identityIdsSerialized);
-
-        return identityIds.map((identityId) => (
-          (identityId.length > 0 ? Buffer.from(identityId) : null)
-        ));
-      }),
-      metadata,
-      proof,
-    );
-  }
-}
-
-module.exports = GetIdentityIdsByPublicKeyHashesResponse;

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

@@ -1,63 +0,0 @@
-const {
-  v0: {
-    PlatformPromiseClient,
-    GetIdentityIdsByPublicKeyHashesRequest,
-  },
-} = require('@dashevo/dapi-grpc');
-
-const GetIdentityIdsByPublicKeyHashesResponse = require('./GetIdentityIdsByPublicKeyHashesResponse');
-const InvalidResponseError = require('../response/errors/InvalidResponseError');
-
-/**
- * @param {GrpcTransport} grpcTransport
- * @returns {getIdentityIdsByPublicKeyHashes}
- */
-function getIdentityIdsByPublicKeyHashesFactory(grpcTransport) {
-  /**
-   * Fetch the identities by public key hashes
-   *
-   * @typedef {getIdentityIdsByPublicKeyHashes}
-   * @param {Buffer[]} publicKeyHashes
-   * @param {DAPIClientOptions & {prove: boolean}} [options]
-   * @returns {Promise<GetIdentityIdsByPublicKeyHashesResponse>}
-   */
-  async function getIdentityIdsByPublicKeyHashes(publicKeyHashes, options = {}) {
-    const getIdentityIdsByPublicKeyHashesRequest = new GetIdentityIdsByPublicKeyHashesRequest();
-    getIdentityIdsByPublicKeyHashesRequest.setPublicKeyHashesList(
-      publicKeyHashes,
-    );
-    getIdentityIdsByPublicKeyHashesRequest.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 getIdentityIdsByPublicKeyHashesResponse = await grpcTransport.request(
-          PlatformPromiseClient,
-          'getIdentityIdsByPublicKeyHashes',
-          getIdentityIdsByPublicKeyHashesRequest,
-          options,
-        );
-
-        return GetIdentityIdsByPublicKeyHashesResponse
-          .createFromProto(getIdentityIdsByPublicKeyHashesResponse);
-      } 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 getIdentityIdsByPublicKeyHashes;
-}
-
-module.exports = getIdentityIdsByPublicKeyHashesFactory;