dkg.js 6.0.13 → 6.0.14

package/examples/demo.js

@@ -26,6 +26,35 @@ function divider() {
 }
 
 (async () => {
+    const content = {
+        public: {
+            '@context': ['https://schema.org'],
+            '@id': 'uuid:1',
+            company: 'OT',
+            user: {
+                '@id': 'uuid:user:1',
+            },
+            city: {
+                '@id': 'uuid:belgrade',
+            },
+        },
+        private: {
+            '@context': ['https://schema.org'],
+            '@graph': [
+                {
+                    '@id': 'uuid:user:1',
+                    name: 'Adam',
+                    lastname: 'Smith',
+                },
+                {
+                    '@id': 'uuid:belgrade',
+                    title: 'Belgrade',
+                    postCode: '11000',
+                },
+            ],
+        },
+    };
+
     divider();
 
     const nodeInfo = await DkgClient.node.info();
@@ -34,37 +63,53 @@ function divider() {
 
     divider();
 
-    const createAssetResult = await DkgClient.asset.create(
-        {
-            public: {
-                '@context': ['https://schema.org'],
-                '@id': 'uuid:1',
-                company: 'OT',
-                user: {
-                    '@id': 'uuid:user:1',
-                },
-                city: {
-                    '@id': 'uuid:belgrade',
-                },
-            },
-            private: {
-                '@context': ['https://schema.org'],
-                '@graph': [
-                    {
-                        '@id': 'uuid:user:1',
-                        name: 'Adam',
-                        lastname: 'Smith',
-                    },
-                    {
-                        '@id': 'uuid:belgrade',
-                        title: 'Belgrade',
-                        postCode: '11000',
-                    },
-                ],
-            },
-        },
+    const assertions = await DkgClient.assertion.formatGraph(content);
+    console.log('======================== ASSERTIONS FORMATTED');
+    console.log(JSON.stringify(assertions));
+
+    divider();
+
+    const publicAssertionId = await DkgClient.assertion.getPublicAssertionId(content);
+    console.log('======================== PUBLIC ASSERTION ID (MERKLE ROOT) CALCULATED');
+    console.log(publicAssertionId);
+
+    divider();
+
+    const publicAssertionSize = await DkgClient.assertion.getSizeInBytes(content);
+    console.log('======================== PUBLIC ASSERTION SIZE CALCULATED');
+    console.log(publicAssertionSize);
+
+    divider();
+
+    const bidSuggestion = await DkgClient.network.getBidSuggestion(
+        publicAssertionId,
+        publicAssertionSize,
         { epochsNum: 2 },
     );
+    console.log('======================== BID SUGGESTION CALCULATED');
+    console.log(bidSuggestion);
+
+    divider();
+
+    const increaseAllowanceResult = await DkgClient.asset.increaseAllowance(bidSuggestion);
+    console.log('======================== ALLOWANCE INCREASED');
+    console.log(increaseAllowanceResult);
+
+    divider();
+
+    const decreaseAllowanceResult = await DkgClient.asset.decreaseAllowance(bidSuggestion);
+    console.log('======================== ALLOWANCE DECREASED');
+    console.log(decreaseAllowanceResult);
+
+    divider();
+
+    const setAllowanceResult = await DkgClient.asset.setAllowance(bidSuggestion);
+    console.log('======================== ALLOWANCE SET');
+    console.log(setAllowanceResult);
+
+    divider();
+
+    const createAssetResult = await DkgClient.asset.create(content, { epochsNum: 2 });
     console.log('======================== ASSET CREATED');
     console.log(createAssetResult);
 
@@ -187,7 +232,7 @@ function divider() {
     divider();
 
     queryResult = await DkgClient.graph.query(
-        'construct { ?s ?p ?o } where { ?s ?p ?o . <uuid:1> ?p ?o }',
+        'construct { ?s ?p ?o } where { ?s ?p ?o . <uuid:user:1> ?p ?o }',
         'CONSTRUCT',
         { graphState: 'HISTORICAL', graphLocation: 'LOCAL_KG' },
     );

package/index.js

@@ -1,7 +1,9 @@
 // managers
+const AssertionOperationsManager = require('./managers/assertion-operations-manager.js');
 const AssetOperationsManager = require('./managers/asset-operations-manager.js');
 const BlockchainOperationsManager = require('./managers/blockchain-operations-manager');
 const GraphOperationsManager = require('./managers/graph-operations-manager.js');
+const NetworkOperationsManager = require('./managers/network-operations-manager.js');
 const NodeOperationsManager = require('./managers/node-operations-manager.js');
 
 const BaseServiceManager = require('./services/base-service-manager.js');
@@ -11,10 +13,12 @@ class DkgClient {
         const baseServiceManager = new BaseServiceManager(config);
         const services = baseServiceManager.getServices();
 
-        this.asset = new AssetOperationsManager(config, services);
-        this.blockchain = new BlockchainOperationsManager(config, services);
-        this.graph = new GraphOperationsManager(config, services);
-        this.node = new NodeOperationsManager(config, services);
+        this.assertion = new AssertionOperationsManager(services);
+        this.asset = new AssetOperationsManager(services);
+        this.blockhain = new BlockchainOperationsManager(services);
+        this.node = new NodeOperationsManager(services);
+        this.graph = new GraphOperationsManager(services);
+        this.network = new NetworkOperationsManager(services);
     }
 }
 module.exports = DkgClient;

package/managers/assertion-operations-manager.js

@@ -0,0 +1,68 @@
+const { assertionMetadata, calculateRoot, formatGraph } = require('assertion-tools');
+
+class AssertionOperationsManager {
+    constructor(services) {
+        this.nodeApiService = services.nodeApiService;
+        this.inputService = services.inputService;
+    }
+
+    /**
+     * Formats the content provided, producing both a public and, if available, a private assertion.
+     * 
+     * @param {Object} content - The content object containing optional public and private properties.
+     * @returns {Promise<Object>} a promise that resolves with an object containing the 
+     * formatted public assertion and, if available, the private assertion.
+     */
+     async formatGraph(content) {
+        return formatGraph(content);
+    }
+
+    /**
+     * Calculates and returns the Merkle root of the public assertion from the provided content.
+     * 
+     * @param {Object} content - The content object containing optional public and private properties.
+     * @returns {Promise<String>} a promise that resolves with a string representing the 
+     * Merkle root of the formatted public assertion.
+     */
+    async getPublicAssertionId(content) {
+        const assertions = await formatGraph(content);
+        return calculateRoot(assertions.public);
+    }
+
+    /**
+     * Calculates and returns the size in bytes of the public assertion from the provided content.
+     * 
+     * @param {Object} content - The content object containing optional public and private properties.
+     * @returns {Promise<Number>} a promise that resolves with a number representing the 
+     * size in bytes of the formatted public assertion.
+     */
+    async getSizeInBytes(content) {
+        const assertions = await formatGraph(content);
+        return assertionMetadata.getAssertionSizeInBytes(assertions.public);
+    }
+
+    /**
+     * Calculates and returns the number of triples of the public assertion from the provided content.
+     * 
+     * @param {Object} content - The content object containing optional public and private properties.
+     * @returns {Promise<Number>} a promise that resolves with a number representing the 
+     * number of triples of the formatted public assertion.
+     */
+    async getTriplesNumber(content) {
+        const assertions = await formatGraph(content);
+        return assertionMetadata.getAssertionTriplesNumber(assertions.public);
+    }
+
+    /**
+     * Calculates and returns the number of chunks of the public assertion from the provided content.
+     * 
+     * @param {Object} content - The content object containing optional public and private properties.
+     * @returns {Promise<Number>} a promise that resolves with a number representing the 
+     * number of chunks of the formatted public assertion.
+     */
+    async getChunksNumber(content) {
+        const assertions = await formatGraph(content);
+        return assertionMetadata.getAssertionChunksNumber(assertions.public);
+    }
+}
+module.exports = AssertionOperationsManager;

package/managers/asset-operations-manager.js

@@ -1,7 +1,6 @@
-const { assertionMetadata, formatAssertion, calculateRoot } = require('assertion-tools');
+const { assertionMetadata, calculateRoot, formatGraph } = require('assertion-tools');
 const { ethers, ZeroHash } = require('ethers');
 const {
-    isEmptyObject,
     deriveUAL,
     getOperationStatusObject,
     resolveUAL,
@@ -24,17 +23,68 @@ const emptyHooks = require('../util/empty-hooks');
 const { STORE_TYPES, ASSET_STATES } = require('../constants');
 
 class AssetOperationsManager {
-    constructor(config, services) {
+    constructor(services) {
         this.nodeApiService = services.nodeApiService;
         this.validationService = services.validationService;
         this.blockchainService = services.blockchainService;
         this.inputService = services.inputService;
     }
 
+    /**
+     * Sets allowance to a given quantity of tokens.
+     * @async
+     * @param {BigInt} tokenAmount - The amount of tokens (Wei) to set the allowance.
+     * @param {Object} [options={}] - Additional options for increasing allowance - currently only blockchain option expected.
+     * @returns {Object} Object containing hash of blockchain transaction and status.
+     */
+    async setAllowance(tokenAmount, options = {}) {
+        const blockchain = this.inputService.getBlockchain(options);
+
+        this.validationService.validateSetAllowance(blockchain);
+
+        const serviceAgreementV1Address = await this.blockchainService.getContractAddress(
+            'ServiceAgreementV1',
+            blockchain,
+        );
+
+        const currentAllowance = BigInt(
+                await this.blockchainService.callContractFunction(
+                'Token',
+                'allowance',
+                [blockchain.publicKey, serviceAgreementV1Address],
+                blockchain,
+            )
+        );
+
+        const allowanceDifference = tokenAmount - currentAllowance;
+
+        let receipt;
+        if (allowanceDifference > 0) {
+            receipt = await this.blockchainService.executeContractFunction(
+                'Token',
+                'increaseAllowance',
+                [serviceAgreementV1Address, allowanceDifference],
+                blockchain,
+            );
+        } else if (allowanceDifference < 0) {
+            receipt = await this.blockchainService.executeContractFunction(
+                'Token',
+                'decreaseAllowance',
+                [serviceAgreementV1Address, -allowanceDifference],
+                blockchain,
+            );
+        }
+
+        return {
+            transactionHash: receipt.transactionHash,
+            status: receipt.status,
+        };
+    }
+
     /**
      * Increases allowance for a set quantity of tokens.
      * @async
-     * @param {number} tokenAmount - The amount of tokens to increase the allowance for.
+     * @param {BigInt} tokenAmount - The amount of tokens (Wei) to increase the allowance for.
      * @param {Object} [options={}] - Additional options for increasing allowance - currently only blockchain option expected.
      * @returns {Object} Object containing hash of blockchain transaction and status.
      */
@@ -64,7 +114,7 @@ class AssetOperationsManager {
     /**
      * Decreases allowance for a set quantity of tokens.
      * @async
-     * @param {number} tokenAmount - The amount of tokens to decrease the allowance for.
+     * @param {BigInt} tokenAmount - The amount of tokens (Wei) to decrease the allowance for.
      * @param {Object} [options={}] - Additional options for decreasing allowance - currently only blockchain option expected.
      * @returns {Object} Object containing hash of blockchain transaction and status.
      */
@@ -101,6 +151,12 @@ class AssetOperationsManager {
         };
     }
 
+    /**
+     * Gets current allowance in Wei.
+     * @async
+     * @param {Object} [options={}] - Additional options for decreasing allowance - currently only blockchain option expected.
+     * @returns {BigInt} Current allowance (Wei).
+     */
     async getCurrentAllowance(options = {}) {
         const blockchain = this.inputService.getBlockchain(options);
 
@@ -116,7 +172,7 @@ class AssetOperationsManager {
             blockchain,
         );
 
-        return allowance;
+        return BigInt(allowance);
     }
 
     /**
@@ -167,25 +223,10 @@ class AssetOperationsManager {
             authToken,
         );
 
-        let privateAssertion;
-        let privateAssertionId;
-        if (jsonContent.private && !isEmptyObject(jsonContent.private)) {
-            privateAssertion = await formatAssertion(jsonContent.private);
-            privateAssertionId = calculateRoot(privateAssertion);
-        }
-        const publicGraph = {
-            '@graph': [
-                jsonContent.public && !isEmptyObject(jsonContent.public)
-                    ? jsonContent.public
-                    : null,
-                jsonContent.private && !isEmptyObject(jsonContent.private)
-                    ? {
-                          [PRIVATE_ASSERTION_PREDICATE]: privateAssertionId,
-                      }
-                    : null,
-            ],
-        };
-        const publicAssertion = await formatAssertion(publicGraph);
+        const {
+            public: publicAssertion,
+            private: privateAssertion,
+        } = await formatGraph(jsonContent);
         const publicAssertionSizeInBytes =
             assertionMetadata.getAssertionSizeInBytes(publicAssertion);
 
@@ -247,7 +288,7 @@ class AssetOperationsManager {
         if (privateAssertion?.length) {
             assertions.push({
                 ...resolvedUAL,
-                assertionId: privateAssertionId,
+                assertionId: calculateRoot(privateAssertion),
                 assertion: privateAssertion,
                 storeType: STORE_TYPES.TRIPLE,
             });
@@ -640,25 +681,10 @@ class AssetOperationsManager {
 
         const { tokenId } = resolveUAL(UAL);
 
-        let privateAssertion;
-        let privateAssertionId;
-        if (jsonContent.private && !isEmptyObject(jsonContent.private)) {
-            privateAssertion = await formatAssertion(jsonContent.private);
-            privateAssertionId = calculateRoot(privateAssertion);
-        }
-        const publicGraph = {
-            '@graph': [
-                jsonContent.public && !isEmptyObject(jsonContent.public)
-                    ? jsonContent.public
-                    : null,
-                jsonContent.private && !isEmptyObject(jsonContent.private)
-                    ? {
-                          [PRIVATE_ASSERTION_PREDICATE]: privateAssertionId,
-                      }
-                    : null,
-            ],
-        };
-        const publicAssertion = await formatAssertion(publicGraph);
+        const {
+            public: publicAssertion,
+            private: privateAssertion
+        } = await formatGraph(jsonContent);
         const publicAssertionSizeInBytes =
             assertionMetadata.getAssertionSizeInBytes(publicAssertion);
 
@@ -720,7 +746,7 @@ class AssetOperationsManager {
         if (privateAssertion?.length) {
             assertions.push({
                 ...resolvedUAL,
-                assertionId: privateAssertionId,
+                assertionId: calculateRoot(privateAssertion),
                 assertion: privateAssertion,
                 storeType: STORE_TYPES.PENDING,
             });
@@ -778,12 +804,22 @@ class AssetOperationsManager {
         };
     }
 
+    /**
+     * Wait for the finalization of an asset update operation.
+     * @async
+     * @param {string} UAL - The Universal Asset Locator of the asset.
+     * @param {Object} [options={}] - Optional parameters for waiting.
+     * @param {string} [options.blockchain] - The blockchain to monitor the update on.
+     * @param {number} [options.frequency] - The polling frequency in seconds.
+     * @param {number} [options.maxNumberOfRetries] - The maximum number of retries before giving up.
+     * @returns {Object} - An object containing the UAL and operation status.
+     */
     async waitFinalization(UAL, options = {}) {
         const blockchain = this.inputService.getBlockchain(options);
         const frequency = this.inputService.getFrequency(options);
         const maxNumberOfRetries = this.inputService.getMaxNumberOfRetries(options);
 
-        this.validationService.validateWaitAssetUpdateFinalization(UAL, blockchain);
+        this.validationService.validateWaitAssetUpdateFinalization(UAL, blockchain, frequency, maxNumberOfRetries);
 
         const { tokenId } = resolveUAL(UAL);
         const response = {
@@ -823,6 +859,13 @@ class AssetOperationsManager {
         };
     }
 
+    /**
+     * Cancel a previously initiated update operation for an asset.
+     * @async
+     * @param {string} UAL - The Universal Asset Locator of the asset.
+     * @param {Object} [options={}] - Optional parameters for blockchain service.
+     * @returns {Object} - An object containing the UAL and operation status.
+     */
     async cancelUpdate(UAL, options = {}) {
         const blockchain = this.inputService.getBlockchain(options);
 
@@ -970,6 +1013,13 @@ class AssetOperationsManager {
         };
     }
 
+    /**
+     * Burn an asset on a specified blockchain.
+     * @async
+     * @param {string} UAL - The Universal Asset Locator of the asset.
+     * @param {Object} [options={}] - Optional parameters for blockchain service.
+     * @returns {Object} An object containing the UAL and operation status.
+     */
     async burn(UAL, options = {}) {
         const blockchain = this.inputService.getBlockchain(options);
 
@@ -984,6 +1034,14 @@ class AssetOperationsManager {
         };
     }
 
+    /**
+     * Extend the storing period of an asset on a specified blockchain.
+     * @async
+     * @param {string} UAL - The Universal Asset Locator of the asset.
+     * @param {number} epochsNumber - Nmber of epochs for the extension.
+     * @param {Object} [options={}] - Additional options for asset storing period extension.
+     * @returns {Object} An object containing the UAL and operation status.
+     */
     async extendStoringPeriod(UAL, epochsNumber, options = {}) {
         const blockchain = this.inputService.getBlockchain(options);
         const tokenAmount = this.inputService.getTokenAmount(options);
@@ -1043,6 +1101,13 @@ class AssetOperationsManager {
         };
     }
 
+    /**
+     * Add tokens for an asset on the specified blockchain to a ongoing publishing operation.
+     * @async
+     * @param {string} UAL - The Universal Asset Locator of the asset.
+     * @param {Object} [options={}] - Additional options for adding tokens.
+     * @returns {Object} An object containing the UAL and operation status.
+     */
     async addTokens(UAL, options = {}) {
         const blockchain = this.inputService.getBlockchain(options);
         const tokenAmount = this.inputService.getTokenAmount(options);
@@ -1097,6 +1162,13 @@ class AssetOperationsManager {
         };
     }
 
+    /**
+     * Add tokens for an asset on the specified blockchain to a ongoing update operation.
+     * @async
+     * @param {string} UAL - The Universal Asset Locator of the asset.
+     * @param {Object} [options={}] - Additional options for adding tokens.
+     * @returns {Object} An object containing the UAL and operation status.
+     */
     async addUpdateTokens(UAL, options = {}) {
         const blockchain = this.inputService.getBlockchain(options);
         const tokenAmount = this.inputService.getTokenAmount(options);

package/managers/blockchain-operations-manager.js

@@ -1,16 +1,28 @@
 
 class BlockchainOperationsManager {
 
-    constructor(config, services) {
+    constructor(services) {
         this.blockchainService = services.blockchainService;
         this.inputService = services.inputService;
     }
 
+    /**
+     * Retrieve the current gas price.
+     * @async
+     * @param {Object} [options={}]  - Optional parameters for blockchain service.
+     * @returns {Promise<string>} - A promise that resolves to the current gas price.
+     */
     async getGasPrice(options = {}){
         const blockchain = this.inputService.getBlockchain(options);
         return this.blockchainService.getGasPrice(blockchain);
     }
 
+    /**
+     * Retrieve the wallet balances.
+     * @async
+     * @param {Object} [options={}] - Optional parameters for blockchain service.
+     * @returns {Promise<Object>} - A promise that resolves to an object containing wallet balances.
+     */
     async getWalletBalances(options = {}){
         const blockchain = this.inputService.getBlockchain(options);
         return this.blockchainService.getWalletBalances(blockchain);

package/managers/graph-operations-manager.js

@@ -2,7 +2,7 @@ const { OPERATIONS } = require('../constants');
 const { deriveRepository } = require('../services/utilities.js');
 
 class GraphOperationsManager {
-    constructor(config, services) {
+    constructor(services) {
         this.nodeApiService = services.nodeApiService;
         this.validationService = services.validationService;
         this.inputService = services.inputService;

package/managers/network-operations-manager.js

@@ -0,0 +1,47 @@
+class NetworkOperationsManager {
+    constructor(services) {
+        this.inputService = services.inputService;
+        this.blockchainService = services.blockchainService;
+        this.nodeApiService = services.nodeApiService;
+    }
+
+    /**
+     * Sends request to the DKG node in order to get suggested bid for given parameters.
+     * @async
+     * @param {string} publicAssertionId - Merkle Root of the data.
+     * @param {number} sizeInBytes - Size of the data in bytes.
+     * @param {Object} [options={}] - Additional options for getting bid suggestion.
+     * @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 contentAssetStorageAddress = await this.blockchainService.getContractAddress(
+            'ContentAssetStorage',
+            blockchain,
+        );
+
+        return BigInt(
+            await this.nodeApiService.getBidSuggestion(
+                endpoint,
+                port,
+                authToken,
+                blockchain.name.startsWith('otp') ? 'otp' : blockchain.name,
+                epochsNum,
+                sizeInBytes,
+                contentAssetStorageAddress,
+                publicAssertionId,
+                hashFunctionId,
+            )
+        )
+    }
+    
+}
+module.exports = NetworkOperationsManager;

package/managers/node-operations-manager.js

@@ -1,5 +1,5 @@
 class NodeOperationsManager {
-    constructor(config, services) {
+    constructor(services) {
         this.nodeApiService = services.nodeApiService;
         this.inputService = services.inputService;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "dkg.js",
-    "version": "6.0.13",
+    "version": "6.0.14",
     "description": "Javascript library for interaction with the OriginTrail Decentralized Knowledge Graph",
     "main": "index.js",
     "scripts": {
@@ -29,7 +29,7 @@
     },
     "homepage": "https://github.com/OriginTrail/dkg.js/tree/main#readme",
     "dependencies": {
-        "assertion-tools": "^2.0.4",
+        "assertion-tools": "^2.1.0",
         "axios": "^0.27.2",
         "dkg-evm-module": "^4.0.4",
         "ethers": "^6.1.0",

package/services/blockchain-service/implementations/node-blockchain-service.js

@@ -1,5 +1,5 @@
 const Web3 = require('web3');
-const { WEBSOCKET_PROVIDER_OPTIONS } = require('../../../constants.js');
+const { TRANSACTION_RETRY_ERRORS, WEBSOCKET_PROVIDER_OPTIONS } = require('../../../constants.js');
 const BlockchainServiceBase = require('../blockchain-service-base.js');
 
 class NodeBlockchainService extends BlockchainServiceBase {
@@ -83,8 +83,7 @@ class NodeBlockchainService extends BlockchainServiceBase {
                 if (
                     !transactionRetried &&
                     blockchain.handleNotMinedError &&
-                    (e.message.includes('Transaction was not mined') ||
-                        e.message.includes('already known'))
+                    TRANSACTION_RETRY_ERRORS.some((errorMsg) => e.message.toLowerCase().includes(errorMsg))
                 ) {
                     transactionRetried = true;
                     // eslint-disable-next-line no-param-reassign

package/services/input-service.js

@@ -5,6 +5,17 @@ class InputService {
         this.config = config;
     }
 
+    getBidSuggestionArguments(options) {
+        return {
+            blockchain: this.getBlockchain(options),
+            endpoint: this.getEndpoint(options),
+            port: this.getPort(options),
+            epochsNum: this.getEpochsNum(options),
+            hashFunctionId: this.getHashFunctionId(options),
+            authToken: this.getAuthToken(options),
+        }
+    }
+
     getAssetCreateArguments(options) {
         return {
             blockchain: this.getBlockchain(options),

package/services/utilities.js

@@ -1,17 +1,15 @@
 const jsonld = require('jsonld');
 const { GRAPH_LOCATIONS, GRAPH_STATES, OT_NODE_TRIPLE_STORE_REPOSITORIES } = require('../constants.js');
 
+function isEmptyObject(obj) {
+    return Object.keys(obj).length === 0 && obj.constructor === Object;
+}
+
 module.exports = {
     nodeSupported() {
         return typeof window === 'undefined';
     },
-    isEmptyObject(object) {
-        // eslint-disable-next-line no-unreachable-loop
-        for (const key in object) {
-            return false;
-        }
-        return true;
-    },
+    isEmptyObject,
     toNumber(hex) {
         return parseInt(hex.slice(2), 16);
     },