feat(dapi): getContestedResourceVoteStateRequest implementation

packages/dapi-grpc/clients/platform/v0/nodejs/PlatformPromiseClient.js

@@ -64,6 +64,8 @@ const {
             GetStatusResponse: PBJSGetStatusResponse,
             GetIdentityBalanceRequest: PBJSGetIdentityBalanceRequest,
             GetIdentityBalanceResponse: PBJSGetIdentityBalanceResponse,
+            GetContestedResourceVoteStateRequest: PBJSGetContestedResourceVoteStateRequest,
+            GetContestedResourceVoteStateResponse: PBJSGetContestedResourceVoteStateResponse,
           },
         },
       },
@@ -91,6 +93,7 @@ const {
   GetTotalCreditsInPlatformResponse: ProtocGetTotalCreditsInPlatformResponse,
   GetStatusResponse: ProtocGetStatusResponse,
   GetIdentityBalanceResponse: ProtocGetIdentityBalanceResponse,
+  GetContestedResourceVoteStateResponse: ProtocGetContestedResourceVoteStateResponse,
 } = require('./platform_protoc');
 
 const getPlatformDefinition = require('../../../../lib/getPlatformDefinition');
@@ -193,6 +196,10 @@ class PlatformPromiseClient {
       this.client.getIdentityBalance.bind(this.client),
     );
 
+    this.client.getContestedResourceVoteState = promisify(
+      this.client.getContestedResourceVoteState.bind(this.client),
+    );
+
     this.protocolVersion = undefined;
   }
 
@@ -798,6 +805,35 @@ class PlatformPromiseClient {
     );
   }
 
+  getContestedResourceVoteState(
+    getContestedResourceVoteStateRequest,
+    metadata = {},
+    options = {},
+  ) {
+    if (!isObject(metadata)) {
+      throw new Error('metadata must be an object');
+    }
+
+    return this.client.getContestedResourceVoteState(
+      getContestedResourceVoteStateRequest,
+      convertObjectToMetadata(metadata),
+      {
+        interceptors: [
+          jsonToProtobufInterceptorFactory(
+            jsonToProtobufFactory(
+              ProtocGetContestedResourceVoteStateResponse,
+              PBJSGetContestedResourceVoteStateResponse,
+            ),
+            protobufToJsonFactory(
+              PBJSGetContestedResourceVoteStateRequest,
+            ),
+          ),
+        ],
+        ...options,
+      },
+    );
+  }
+
   /**
    * @param {string} protocolVersion
    */

packages/js-dapi-client/lib/methods/platform/PlatformMethodsFacade.js

@@ -16,6 +16,7 @@ const getIdentityKeysFactory = require('./getIdentityKeys/getIdentityKeysFactory
 const getTotalCreditsInPlatformFactory = require('./getTotalCreditsInPlatform/getTotalCreditsInPlatformFactory');
 const getStatusFactory = require('./getStatus/getStatusFactory');
 const getIdentityBalanceFactory = require('./getIdentityBalance/getIdentityBalanceFactory');
+const getContestedResourceVoteStateFactory = require('./getContestedResourceVoteState/getContestedResourceVoteStateFactory');
 
 class PlatformMethodsFacade {
   /**
@@ -42,6 +43,7 @@ class PlatformMethodsFacade {
     this.getTotalCreditsInPlatform = getTotalCreditsInPlatformFactory(grpcTransport);
     this.getStatus = getStatusFactory(grpcTransport);
     this.getIdentityBalance = getIdentityBalanceFactory(grpcTransport);
+    this.getContestedResourceVoteState = getContestedResourceVoteStateFactory(grpcTransport);
   }
 }
 

packages/js-dapi-client/lib/methods/platform/getContestedResourceVoteState/GetContestedResourceVoteStateResponse.js

@@ -0,0 +1,47 @@
+const AbstractResponse = require('../response/AbstractResponse');
+const InvalidResponseError = require('../response/errors/InvalidResponseError');
+
+class GetContestedResourceVoteStateResponse extends AbstractResponse {
+  /**
+   * @param {object} contestedResourceContenders
+   * @param {Metadata} metadata
+   * @param {Proof} [proof]
+   */
+  constructor(contestedResourceContenders, metadata, proof = undefined) {
+    super(metadata, proof);
+
+    this.contestedResourceContenders = contestedResourceContenders;
+  }
+
+  /**
+   * @returns {object}
+   */
+  getContestedResourceContenders() {
+    return this.contestedResourceContenders;
+  }
+
+  /**
+   * @param proto
+   * @returns {GetContestedResourceVoteStateResponse}
+   */
+  static createFromProto(proto) {
+    // eslint-disable-next-line
+    const contestedResourceContenders = proto.getV0().getContestedResourceContenders();
+
+    const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto(
+      proto,
+    );
+
+    if ((typeof contestedResourceContenders === 'undefined' || contestedResourceContenders === null) && !proof) {
+      throw new InvalidResponseError('Contested Resource Contenders data is not defined');
+    }
+
+    return new GetContestedResourceVoteStateResponse(
+      contestedResourceContenders.toObject(),
+      metadata,
+      proof,
+    );
+  }
+}
+
+module.exports = GetContestedResourceVoteStateResponse;

packages/js-dapi-client/lib/methods/platform/getContestedResourceVoteState/getContestedResourceVoteStateFactory.js

@@ -0,0 +1,96 @@
+const {
+  v0: {
+    PlatformPromiseClient,
+    GetContestedResourceVoteStateRequest,
+  },
+} = require('@dashevo/dapi-grpc');
+
+const GetContestedResourceVoteStateResponse = require('./GetContestedResourceVoteStateResponse');
+const InvalidResponseError = require('../response/errors/InvalidResponseError');
+
+/**
+ * @param {GrpcTransport} grpcTransport
+ * @returns {getContestedResourceVoteStateRequest}
+ */
+function getContestedResourceVoteStateFactory(grpcTransport) {
+  /**
+   * Fetch the version upgrade votes status
+   * @typedef {getContestedResourceVoteState}
+   * @param contractId
+   * @param documentTypeName
+   * @param indexName
+   * @param resultType
+   * @param indexValuesList
+   * @param startAtIdentifierInfo
+   * @param allowIncludeLockedAndAbstainingVoteTally
+   * @param count
+   * @param {DAPIClientOptions & {prove: boolean}} [options]
+   * @returns {Promise<gрetContestedResourceVoteStateResponse>}
+   */
+  async function getContestedResourceVoteState(
+    contractId,
+    documentTypeName,
+    indexName,
+    resultType,
+    indexValuesList,
+    startAtIdentifierInfo,
+    allowIncludeLockedAndAbstainingVoteTally,
+    count,
+    options = {},
+  ) {
+    const { GetContestedResourceVoteStateRequestV0 } = GetContestedResourceVoteStateRequest;
+
+    // eslint-disable-next-line max-len
+    const getContestedResourceVoteStateRequest = new GetContestedResourceVoteStateRequest();
+
+    if (Buffer.isBuffer(contractId)) {
+      // eslint-disable-next-line no-param-reassign
+      contractId = Buffer.from(contractId);
+    }
+
+    getContestedResourceVoteStateRequest.setV0(
+      new GetContestedResourceVoteStateRequestV0()
+        .setContractId(contractId)
+        .setDocumentTypeName(documentTypeName)
+        .setIndexName(indexName)
+        .setResultType(resultType)
+        .setIndexValuesList(indexValuesList)
+        .setStartAtIdentifierInfo(startAtIdentifierInfo)
+        .setAllowIncludeLockedAndAbstainingVoteTally(allowIncludeLockedAndAbstainingVoteTally)
+        .setCount(count)
+        .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 getContestedResourceVoteStateResponse = await grpcTransport.request(
+          PlatformPromiseClient,
+          'getContestedResourceVoteState',
+          getContestedResourceVoteStateRequest,
+          options,
+        );
+
+        return GetContestedResourceVoteStateResponse
+          .createFromProto(getContestedResourceVoteStateResponse);
+      } 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 getContestedResourceVoteState;
+}
+
+module.exports = getContestedResourceVoteStateFactory;