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

package/lib/methods/platform/PlatformMethodsFacade.js

@@ -15,6 +15,7 @@ const getIdentityNonceFactory = require('./getIdentityNonce/getIdentityNonceFact
 const getIdentityKeysFactory = require('./getIdentityKeys/getIdentityKeysFactory');
 const getTotalCreditsInPlatformFactory = require('./getTotalCreditsInPlatform/getTotalCreditsInPlatformFactory');
 const getStatusFactory = require('./getStatus/getStatusFactory');
+const getIdentityBalanceFactory = require('./getIdentityBalance/getIdentityBalanceFactory');
 
 class PlatformMethodsFacade {
   /**
@@ -40,6 +41,7 @@ class PlatformMethodsFacade {
     this.getIdentityKeys = getIdentityKeysFactory(grpcTransport);
     this.getTotalCreditsInPlatform = getTotalCreditsInPlatformFactory(grpcTransport);
     this.getStatus = getStatusFactory(grpcTransport);
+    this.getIdentityBalance = getIdentityBalanceFactory(grpcTransport);
   }
 }
 

package/lib/methods/platform/getEpochsInfo/getEpochsInfoFactory.js

@@ -28,7 +28,7 @@ function getEpochsInfoFactory(grpcTransport) {
     const getEpochInfosRequest = new GetEpochsInfoRequest();
     getEpochInfosRequest.setV0(
       new GetEpochsInfoRequestV0()
-        .setStartEpoch(new UInt32Value([startEpoch]))
+        .setStartEpoch(typeof startEpoch === 'number' ? new UInt32Value([startEpoch]) : undefined)
         .setCount(count)
         .setAscending(!!options.ascending)
         .setProve(!!options.prove),

package/lib/methods/platform/getIdentityBalance/GetIdentityBalanceResponse.js

@@ -0,0 +1,43 @@
+const AbstractResponse = require('../response/AbstractResponse');
+const InvalidResponseError = require('../response/errors/InvalidResponseError');
+
+class GetIdentityBalanceResponse extends AbstractResponse {
+  /**
+   * @param {number} balance
+   * @param {Metadata} metadata
+   * @param {Proof} [proof]
+   */
+  constructor(balance, metadata, proof = undefined) {
+    super(metadata, proof);
+
+    this.balance = balance;
+  }
+
+  /**
+   * @returns {number}
+   */
+  getBalance() {
+    return this.balance;
+  }
+
+  /**
+   * @param proto
+   * @returns {GetIdentityBalanceResponse}
+   */
+  static createFromProto(proto) {
+    const balance = proto.getV0().getBalance();
+    const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto(proto);
+
+    if ((balance === null || balance === undefined) && !proof) {
+      throw new InvalidResponseError('Balance is not defined');
+    }
+
+    return new GetIdentityBalanceResponse(
+      balance,
+      metadata,
+      proof,
+    );
+  }
+}
+
+module.exports = GetIdentityBalanceResponse;

package/lib/methods/platform/getIdentityBalance/getIdentityBalanceFactory.js

@@ -0,0 +1,71 @@
+const {
+  v0: {
+    PlatformPromiseClient,
+    GetIdentityBalanceRequest,
+  },
+} = require('@dashevo/dapi-grpc');
+
+const GetIdentityBalanceResponse = require('./GetIdentityBalanceResponse');
+const InvalidResponseError = require('../response/errors/InvalidResponseError');
+
+/**
+ * @param {GrpcTransport} grpcTransport
+ * @returns {getIdentityBalance}
+ */
+function getIdentityBalanceFactory(grpcTransport) {
+  /**
+   * Fetch the identity balance by id
+   * @typedef {getIdentityBalance}
+   * @param {Buffer} id
+   * @param {DAPIClientOptions & {prove: boolean}} [options]
+   * @returns {Promise<GetIdentityBalanceResponse>}
+   */
+  async function getIdentityBalance(id, options = {}) {
+    const { GetIdentityBalanceRequestV0 } = GetIdentityBalanceRequest;
+    const getIdentityBalanceRequest = new GetIdentityBalanceRequest();
+    // 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(id)) {
+      // eslint-disable-next-line no-param-reassign
+      id = Buffer.from(id);
+    }
+
+    getIdentityBalanceRequest.setV0(
+      new GetIdentityBalanceRequestV0()
+        .setId(id)
+        .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 getIdentityBalanceResponse = await grpcTransport.request(
+          PlatformPromiseClient,
+          'getIdentityBalance',
+          getIdentityBalanceRequest,
+          options,
+        );
+
+        return GetIdentityBalanceResponse.createFromProto(getIdentityBalanceResponse);
+      } 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 getIdentityBalance;
+}
+
+module.exports = getIdentityBalanceFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-client",
-  "version": "1.3.0-dev.5",
+  "version": "1.3.0-dev.6",
   "description": "Client library used to access Dash DAPI endpoints",
   "main": "lib/index.js",
   "contributors": [
@@ -26,11 +26,11 @@
     }
   ],
   "dependencies": {
-    "@dashevo/dapi-grpc": "1.3.0-dev.5",
-    "@dashevo/dash-spv": "2.3.0-dev.5",
+    "@dashevo/dapi-grpc": "1.3.0-dev.6",
+    "@dashevo/dash-spv": "2.3.0-dev.6",
     "@dashevo/dashcore-lib": "~0.21.3",
-    "@dashevo/grpc-common": "1.3.0-dev.5",
-    "@dashevo/wasm-dpp": "1.3.0-dev.5",
+    "@dashevo/grpc-common": "1.3.0-dev.6",
+    "@dashevo/wasm-dpp": "1.3.0-dev.6",
     "bs58": "^4.0.1",
     "cbor": "^8.0.0",
     "google-protobuf": "^3.12.2",