Improvments/add range for bid suggestion (#135)

* Add range for bid suggestion * Fix getBidSuggetions returns object when all is param * Update services/validation-service.js Co-authored-by: Nikola Todorovic <[email protected]> * Version bump * New version build * Update package-lock --------- Co-authored-by: Nikola Todorovic <[email protected]>
OriginTrail · Apr 10, 2024 · 93d0633 · 93d0633
1 parent 4f1981e
commit 93d0633
Show file tree

Hide file tree

Showing 8 changed files with 74 additions and 26 deletions.
diff --git a/constants.js b/constants.js
@@ -199,6 +199,17 @@ const DEFAULT_GAS_PRICE = {
     OTP: '1',
 };
 
+const LOW_BID_SUGGESTION = 'low';
+const MED_BID_SUGGESTION = 'med';
+const HIGH_BID_SUGGESTION = 'high';
+const ALL_BID_SUGGESTION = 'all';
+const BID_SUGGESTION_RANGE_ENUM = [
+    LOW_BID_SUGGESTION,
+    MED_BID_SUGGESTION,
+    HIGH_BID_SUGGESTION,
+    ALL_BID_SUGGESTION,
+];
+
 module.exports = {
     MAX_FILE_SIZE,
     DID_PREFIX,
@@ -225,4 +236,9 @@ module.exports = {
     DEFAULT_PROXIMITY_SCORE_FUNCTIONS_PAIR_IDS,
     DEFAULT_PARAMETERS,
     DEFAULT_GAS_PRICE,
+    LOW_BID_SUGGESTION,
+    MED_BID_SUGGESTION,
+    HIGH_BID_SUGGESTION,
+    ALL_BID_SUGGESTION,
+    BID_SUGGESTION_RANGE_ENUM,
 };
diff --git a/dist/dkg.min.js b/dist/dkg.min.js
diff --git a/managers/network-operations-manager.js b/managers/network-operations-manager.js
@@ -14,27 +14,35 @@ class NetworkOperationsManager {
      * @returns {BigInt} Suggested bid for publishing Knowledge Asset with given parameters.
      */
     async getBidSuggestion(publicAssertionId, sizeInBytes, options = {}) {
-        const { blockchain, endpoint, port, epochsNum, hashFunctionId, authToken } =
-            this.inputService.getBidSuggestionArguments(options);
+        const {
+            blockchain,
+            endpoint,
+            port,
+            epochsNum,
+            hashFunctionId,
+            authToken,
+            bidSuggestionRange,
+        } = this.inputService.getBidSuggestionArguments(options);
 
         const contentAssetStorageAddress = await this.blockchainService.getContractAddress(
             'ContentAssetStorage',
             blockchain,
         );
 
-        return BigInt(
-            await this.nodeApiService.getBidSuggestion(
-                endpoint,
-                port,
-                authToken,
-                blockchain.name,
-                epochsNum,
-                sizeInBytes,
-                contentAssetStorageAddress,
-                publicAssertionId,
-                hashFunctionId,
-            ),
+        const response = await this.nodeApiService.getBidSuggestion(
+            endpoint,
+            port,
+            authToken,
+            blockchain.name,
+            epochsNum,
+            sizeInBytes,
+            contentAssetStorageAddress,
+            publicAssertionId,
+            hashFunctionId,
+            bidSuggestionRange,
         );
+
+        return typeof response === 'string' ? BigInt(response) : response;
     }
 }
 module.exports = NetworkOperationsManager;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "dkg.js",
-    "version": "6.2.0",
+    "version": "6.2.1",
     "description": "Javascript library for interaction with the OriginTrail Decentralized Knowledge Graph",
     "main": "index.js",
     "scripts": {

diff --git a/services/input-service.js b/services/input-service.js
@@ -2,6 +2,7 @@ const {
     DEFAULT_PARAMETERS,
     DEFAULT_PROXIMITY_SCORE_FUNCTIONS_PAIR_IDS,
     BLOCKCHAINS,
+    LOW_BID_SUGGESTION,
 } = require('../constants');
 
 class InputService {
@@ -17,6 +18,7 @@ class InputService {
             epochsNum: this.getEpochsNum(options),
             hashFunctionId: this.getHashFunctionId(options),
             authToken: this.getAuthToken(options),
+            bidSuggestionRange: this.getBidSuggestionRange(options),
         };
     }
 
@@ -200,6 +202,10 @@ class InputService {
     getAuthToken(options) {
         return options.auth?.token ?? this.config?.auth?.token ?? null;
     }
+
+    getBidSuggestionRange(options) {
+        return options.bidSuggestionRange ?? LOW_BID_SUGGESTION;
+    }
 }
 
 module.exports = InputService;
diff --git a/services/node-api-service/implementations/http-service.js b/services/node-api-service/implementations/http-service.js
@@ -31,19 +31,24 @@ class HttpService {
         contentAssetStorageAddress,
         firstAssertionId,
         hashFunctionId,
+        bidSuggestionRange,
     ) {
         try {
+            const params = {
+                blockchain,
+                epochsNumber,
+                assertionSize,
+                contentAssetStorageAddress,
+                firstAssertionId,
+                hashFunctionId,
+            };
+            if (bidSuggestionRange != null) {
+                params.bidSuggestionRange = bidSuggestionRange;
+            }
             const response = await axios({
                 method: 'get',
                 url: `${endpoint}:${port}/bid-suggestion`,
-                params: {
-                    blockchain,
-                    epochsNumber,
-                    assertionSize,
-                    contentAssetStorageAddress,
-                    firstAssertionId,
-                    hashFunctionId,
-                },
+                params,
                 headers: this.prepareRequestConfig(authToken),
             });
 

diff --git a/services/validation-service.js b/services/validation-service.js
@@ -7,6 +7,7 @@ const {
     OPERATIONS,
     GET_OUTPUT_FORMATS,
     QUERY_TYPES,
+    BID_SUGGESTION_RANGE_ENUM,
 } = require('../constants.js');
 const { nodeSupported } = require('./utilities.js');
 
@@ -402,5 +403,17 @@ class ValidationService {
         this.validateRequiredParam('newOwner', newOwner);
         this.validateParamType('newOwner', newOwner, 'string');
     }
+
+    validateGetBidSuggestion(bidSuggestionRange) {
+        this.validateBidSuggestionRange(bidSuggestionRange);
+    }
+
+    validateBidSuggestionRange(bidSuggestionRange) {
+        if (!BID_SUGGESTION_RANGE_ENUM.includes(bidSuggestionRange)) {
+            throw Error(
+                `Invalid bidSuggestionRange parametar: supported parametars ${BID_SUGGESTION_RANGE_ENUM}`,
+            );
+        }
+    }
 }
 module.exports = ValidationService;