@oceanprotocol/lib 4.0.2 → 4.0.3

package/CHANGELOG.md

@@ -4,11 +4,25 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v4.0.3](https://github.com/oceanprotocol/ocean.js/compare/v4.0.2...v4.0.3)
+
+- Dependencies update [`#1938`](https://github.com/oceanprotocol/ocean.js/pull/1938)
+- use main branch for node checkout [`#1936`](https://github.com/oceanprotocol/ocean.js/pull/1936)
+- Further integrate ddo-js [`#1935`](https://github.com/oceanprotocol/ocean.js/pull/1935)
+- Make integration tests use Ocean Node not Provider or Aquarius [`#1932`](https://github.com/oceanprotocol/ocean.js/pull/1932)
+- update CODEOWNERS [`#1933`](https://github.com/oceanprotocol/ocean.js/pull/1933)
+- Bump release-it from 15.6.1 to 18.1.2 [`#1921`](https://github.com/oceanprotocol/ocean.js/pull/1921)
+- Bump esbuild and tsx [`#1925`](https://github.com/oceanprotocol/ocean.js/pull/1925)
+- Bump serialize-javascript and mocha [`#1915`](https://github.com/oceanprotocol/ocean.js/pull/1915)
+
 #### [v4.0.2](https://github.com/oceanprotocol/ocean.js/compare/v4.0.1...v4.0.2)
 
+> 27 March 2025
+
 - Bump axios from 1.7.9 to 1.8.3 [`#1926`](https://github.com/oceanprotocol/ocean.js/pull/1926)
 - update to ddo.js v0.0.2 [`#1931`](https://github.com/oceanprotocol/ocean.js/pull/1931)
 - Updating codeowners [`#1929`](https://github.com/oceanprotocol/ocean.js/pull/1929)
+- Release 4.0.2 [`b6a78b6`](https://github.com/oceanprotocol/ocean.js/commit/b6a78b64c684af7c9f360e22ecb7a0fa839e8907)
 
 #### [v4.0.1](https://github.com/oceanprotocol/ocean.js/compare/v4.0.0...v4.0.1)
 
@@ -17,7 +31,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - moving the getChainId call [`#1928`](https://github.com/oceanprotocol/ocean.js/pull/1928)
 - Release 4.0.1 [`519e378`](https://github.com/oceanprotocol/ocean.js/commit/519e378c3cfd6df0ece6e503c89c796a0c76027d)
 
-### [v4.0.0](https://github.com/oceanprotocol/ocean.js/compare/v3.4.6...v4.0.0)
+### [v4.0.0](https://github.com/oceanprotocol/ocean.js/compare/v4.0.0-next.1...v4.0.0)
 
 > 18 March 2025
 
@@ -26,9 +40,35 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - add missing exports, refactor addresses file [`#1904`](https://github.com/oceanprotocol/ocean.js/pull/1904)
 - Use serviceIndex instead of hardcoded indexes. [`#1905`](https://github.com/oceanprotocol/ocean.js/pull/1905)
 - Bump path-to-regexp and express [`#1893`](https://github.com/oceanprotocol/ocean.js/pull/1893)
-- Release 4.0.0 [`9a3f920`](https://github.com/oceanprotocol/ocean.js/commit/9a3f9209a49ed6181df695d57d32ed725ee962d2)
-- fix ci.yml, fix typo on test file [`bde6f0a`](https://github.com/oceanprotocol/ocean.js/commit/bde6f0a7e9f1c7cc635b78c5b045caed16be65ca)
-- fix policy server [`19bfe3e`](https://github.com/oceanprotocol/ocean.js/commit/19bfe3eedf00809379bf49ec506e32285499242c)
+- make retries and interval bigger & configurable on waitForAqua [`#1895`](https://github.com/oceanprotocol/ocean.js/pull/1895)
+- Bump eslint-config-prettier from 9.0.0 to 9.1.0 [`#1884`](https://github.com/oceanprotocol/ocean.js/pull/1884)
+- Add back check for access list factory. [`#1889`](https://github.com/oceanprotocol/ocean.js/pull/1889)
+- Remove circular dependencies, fix imports and improve build [`#1881`](https://github.com/oceanprotocol/ocean.js/pull/1881)
+- chore: remove redundant words in comment [`#1890`](https://github.com/oceanprotocol/ocean.js/pull/1890)
+- Bump @truffle/hdwallet-provider from 2.1.10 to 2.1.15 [`#1886`](https://github.com/oceanprotocol/ocean.js/pull/1886)
+- Bump nyc from 15.1.0 to 17.1.0 [`#1883`](https://github.com/oceanprotocol/ocean.js/pull/1883)
+- Bump @types/crypto-js from 4.1.2 to 4.2.2 [`#1882`](https://github.com/oceanprotocol/ocean.js/pull/1882)
+- Bump actions/download-artifact from 2 to 4.1.7 in /.github/workflows [`#1844`](https://github.com/oceanprotocol/ocean.js/pull/1844)
+- Remove node:16 docker image from workflow. [`#1879`](https://github.com/oceanprotocol/ocean.js/pull/1879)
+- Bump rollup from 2.61.1 to 2.79.2 [`#1866`](https://github.com/oceanprotocol/ocean.js/pull/1866)
+- Remove checks from publishing. ADded chain ID check for ordering. [`#1875`](https://github.com/oceanprotocol/ocean.js/pull/1875)
+- done [`60d0272`](https://github.com/oceanprotocol/ocean.js/commit/60d027294a2893410860f1180ff47177e12e45de)
+- rename waitForAqua as waitForIndexer [`6381795`](https://github.com/oceanprotocol/ocean.js/commit/6381795c957f301b93461d84a14ff59991b58738)
+- 4th pass [`bf94e10`](https://github.com/oceanprotocol/ocean.js/commit/bf94e102e53dd07eac6c671ef222b96e34ffca7f)
+
+#### [v4.0.0-next.1](https://github.com/oceanprotocol/ocean.js/compare/v4.0.0-next.0...v4.0.0-next.1)
+
+> 12 November 2024
+
+- add datasets on ComputeAsset, new start compute fn [`8563429`](https://github.com/oceanprotocol/ocean.js/commit/85634293306fca9aaa3ab5ae06a114149ccc8911)
+- support for consumer signature on initialize compute [`71c5923`](https://github.com/oceanprotocol/ocean.js/commit/71c59230db99a08a6c28df66c26e32ca61c71089)
+- add file object types [`cd936c2`](https://github.com/oceanprotocol/ocean.js/commit/cd936c24a989633d3d8e71b908a375802d2e2970)
+
+#### [v4.0.0-next.0](https://github.com/oceanprotocol/ocean.js/compare/v3.4.6...v4.0.0-next.0)
+
+> 12 November 2024
+
+- Release 4.0.0-next.0 [`658cfe8`](https://github.com/oceanprotocol/ocean.js/commit/658cfe83ff855a83eb97e3cbf1276bed6022a1a6)
 
 #### [v3.4.6](https://github.com/oceanprotocol/ocean.js/compare/v3.4.5...v3.4.6)
 

package/CodeExamples.md

@@ -105,11 +105,10 @@ import {
   ConfigHelper,
   configHelperNetworks,
   amountToUnits,
-  ValidateMetadata,
   getEventFromTx,
-  DDO,
   LoggerInstance
 } from '../../src/index.js'
+import { DDO, ValidateMetadata } from '@oceanprotocol/ddo-js'
 ```
 const { SHA256 } = crypto
 
@@ -136,7 +135,7 @@ Now we define the variables which we will need later
   let dispenserNftAddress: string
   let dispenserDatatokenAddress: string
   let dispenserAddress: string
-  let fixedDDO
+  let fixedDDO: DDO
 ```
 
 We also define some constants that we will use:
@@ -208,9 +207,11 @@ Next, we define the metadata that will describe our data asset. This is what we
     const config = new ConfigHelper().getConfig(
       parseInt(String((await publisherAccount.provider.getNetwork()).chainId))
     )
-    config.providerUri = process.env.PROVIDER_URL || config.providerUri
-    aquarius = new Aquarius(config?.metadataCacheUri)
-    providerUrl = config?.providerUri
+    if (process.env.OCEAN_NODE_URL) {
+      config.oceanNodeUri = process.env.OCEAN_NODE_URL
+    }
+    aquarius = new Aquarius(config?.oceanNodeUri)
+    providerUrl = config?.oceanNodeUri
     addresses = JSON.parse(
       // eslint-disable-next-line security/detect-non-literal-fs-filename
       fs.readFileSync(
@@ -222,7 +223,7 @@ Next, we define the metadata that will describe our data asset. This is what we
 ```
 As we go along it's a good idea to console log the values so that you check they are right
 ```Typescript
-    console.log(`Aquarius URL: ${config.metadataCacheUri}`)
+    console.log(`Indexer URL: ${config.oceanNodeUri}`)
     console.log(`Provider URL: ${providerUrl}`)
     console.log(`Deployed contracts address: ${addresses}`)
     console.log(`Publisher account address: ${await publisherAccount.getAddress()}`)
@@ -487,9 +488,11 @@ Before we call the contract we have to call `approve` so that the contract can m
       consumerAccount,
       await consumerAccount.getChainId()
     )
+
 ```
 Now we can make the contract call
 ```Typescript
+
     await fixedRate.buyDatatokens(freId, '1', '2')
 
     consumerOCEANBalance = await balance(
@@ -530,6 +533,17 @@ Next, we need to initialize the provider
       validUntil: initializeData.providerFee.validUntil
     }
 
+    console.log(`Provider fee amount: ${providerFees.providerFeeAmount}`)
+
+    const approveTx = await approve(
+      consumerAccount,
+      config,
+      await consumerAccount.getAddress(),
+      freDatatokenAddress,
+      providerFees.providerFeeAddress,
+      providerFees.providerFeeAmount
+    )
+
     datatoken = new Datatoken(consumerAccount, await consumerAccount.getChainId())
 
 ```
@@ -543,6 +557,8 @@ Lets now make the payment
     )
     const orderTx = await tx.wait()
     const orderStartedTx = getEventFromTx(orderTx, 'OrderStarted')
+    console.log(`Order started, tx: ${orderStartedTx.transactionHash}`)
+
 ```
 Now we can get the url
 ```Typescript
@@ -580,8 +596,10 @@ Lets check that the download URL was successfully received
       LoggerInstance.error('Download failed', e)
       assert.fail('Download failed')
     }
-  
 ```
+<!--
+  }).timeout(40000)
+-->
 
 ## 8. Publish Data NFT and a Datatoken with a dispenser
 
@@ -639,9 +657,10 @@ Lets check that we managed to received all of those values without any problems
     console.log(`Dispenser NFT address: ${dispenserNftAddress}`)
     console.log(`Dispenser Datatoken address: ${dispenserDatatokenAddress}`)
     console.log(`Dispenser address: ${dispenserAddress}`)
-  
 ```
-
+<!--
+  }).timeout(40000)
+-->
   ### 8.2 Set metadata in the dispenser NFT
 ```Typescript
     const nft = new Nft(
@@ -689,8 +708,10 @@ Now we need to encrypt file(s) using provider
       encryptedDDO,
       isAssetValid.hash
     )
-  
 ```
+<!--
+  }).timeout(40000)
+-->
 
 ## 9. Consume a dispenser data asset
 
@@ -793,8 +814,10 @@ Let's check we received the download URL ok
     } catch (e) {
       assert.fail('Download failed')
     }
-  
 ```
+<!--
+  }).timeout(40000)
+-->
 
 ## 10. Using ERC725 Key-Value Store
 
@@ -848,7 +871,9 @@ Use the `getData` method to get the data stored in the nft key value store
 ```
 
 That's it! Note the simplicity. All data was stored and retrieved from on-chain. We don't need Ocean Provider or Ocean Aquarius for these use cases (though the latter can help for fast querying & retrieval).
-  
+<!--
+  }).timeout(40000)
+-->
 
 
 ## Editing this file

package/ComputeExamples.md

@@ -12,7 +12,7 @@ Here are the steps:
 7. [Resolve published datasets and algorithms](#7-resolve-assets)
 8. [Send datatokens to consumer](#8-send-datatokens-to-consumer)
 9. [Consumer fetches compute environment](#9-get-compute-environments)
-10. [Consumer starts a compute job using a free C2D environment](#10-consumer-starts-a-compute-job)
+10. [Consumer starts a free compute job using a free C2D environment](#10-consumer-starts-a-compute-job)
 11. [Check compute status and get download compute results url](#11-check-compute-status-and-get-download-compute-results-url)
 
 Let's go through each step.
@@ -136,7 +136,6 @@ import {
   ComputeAsset,
   Config,
   Files,
-  DDO,
   NftCreateData,
   DatatokenCreateParams,
   sendTx,
@@ -148,6 +147,7 @@ import {
 } from '../../src/index.js'
 ```
 import crypto from 'crypto-js'
+import { DDO } from '@oceanprotocol/ddo-js'
 const { SHA256 } = crypto
 
 ### 4.2. Constants and variables
@@ -342,7 +342,7 @@ async function createAssetHelper(
   assetUrl.nftAddress = nftAddress
   ddo.services[0].files = await ProviderInstance.encrypt(assetUrl, chain, providerUrl)
   ddo.services[0].datatokenAddress = datatokenAddressAsset
-  ddo.services[0].serviceEndpoint = 'http://172.15.0.4:8030' // put back proviederUrl
+  ddo.services[0].serviceEndpoint = providerUrl
 
   ddo.nftAddress = nftAddress
   ddo.id = 'did:op:' + SHA256(ethers.utils.getAddress(nftAddress) + chain.toString(10))
@@ -353,7 +353,7 @@ async function createAssetHelper(
     nftAddress,
     await owner.getAddress(),
     0,
-    'http://172.15.0.4:8030', // put back proviederUrl
+    providerUrl,
     '',
     ethers.utils.hexlify(2),
     encryptedResponse,
@@ -428,9 +428,11 @@ We need to load the configuration. Add the following code into your `run(){ }` f
     const config = new ConfigHelper().getConfig(
       parseInt(String((await publisherAccount.provider.getNetwork()).chainId))
     )
-    config.providerUri = process.env.PROVIDER_URL || config.providerUri
-    aquariusInstance = new Aquarius(config?.metadataCacheUri)
-    providerUrl = config?.providerUri
+    if (process.env.OCEAN_NODE_URL) {
+      config.oceanNodeUri = process.env.OCEAN_NODE_URL
+    }
+    aquariusInstance = new Aquarius(config?.oceanNodeUri)
+    providerUrl = config?.oceanNodeUri
     addresses = JSON.parse(
       // eslint-disable-next-line security/detect-non-literal-fs-filename
       fs.readFileSync(
@@ -443,7 +445,7 @@ We need to load the configuration. Add the following code into your `run(){ }` f
 ```
 As we go along it's a good idea to console log the values so that you check they are right. At the end of your `run(){ ... }` function add the following logs:
 ```Typescript
-    console.log(`Aquarius URL: ${config.metadataCacheUri}`)
+    console.log(`Indexer URL: ${config.oceanNodeUri}`)
     console.log(`Provider URL: ${providerUrl}`)
     console.log(`Deployed contracts address: ${addresses}`)
     console.log(`Publisher account address: ${publisherAccount}`)
@@ -489,8 +491,10 @@ you need to mint oceans to mentioned accounts only if you are using barge to tes
       await publisherAccount.getAddress(),
       amountToUnits(null, null, '1000', 18)
     )
-  
 ```
+<!--
+  }).timeout(40000) ///
+--->
 
   ### 5.2 Send some OCEAN to consumer account
 ```Typescript
@@ -520,8 +524,10 @@ you need to mint oceans to mentioned accounts only if you are using barge to tes
 Now, let's check that we successfully published a dataset (create NFT + Datatoken)
 ```Typescript
     console.log(`dataset id: ${datasetId}`)
-  
 ```
+<!--
+  }).timeout(40000)
+-->
 
   ### 6.2 Publish an algorithm (create NFT + Datatoken) and set algorithm metadata
 ```Typescript
@@ -537,9 +543,10 @@ Now, let's check that we successfully published a dataset (create NFT + Datatoke
 Now, let's check that we successfully published a algorithm (create NFT + Datatoken)
 ```Typescript
     console.log(`algorithm id: ${algorithmId}`)
-  
 ```
-
+<!--
+  }).timeout(40000)
+-->
 ## 7. Resolve assets
 
   ### 7.1 Resolve published datasets and algorithms
@@ -550,8 +557,8 @@ Now, let's check that we successfully published a algorithm (create NFT + Datato
 <!--
     assert(resolvedDatasetDdo, 'Cannot fetch DDO from Aquarius')
     assert(resolvedAlgorithmDdo, 'Cannot fetch DDO from Aquarius')
+  }).timeout(80000)
 -->
-  
 
 ## 8. Send datatokens to consumer
 
@@ -574,8 +581,10 @@ Now, let's check that we successfully published a algorithm (create NFT + Datato
       '10',
       await consumerAccount.getAddress()
     )
-  
 ```
+<!--
+  }).timeout(40000)
+-->
 
 ## 9. Get compute environments
 
@@ -585,21 +594,24 @@ Now, let's check that we successfully published a algorithm (create NFT + Datato
 ```
 <!--
     assert(computeEnvs, 'No Compute environments found')
+  }).timeout(40000)
 -->
-  
 
-## 10. Consumer starts a compute job
+## 10. Consumer starts a free compute job
 
   ### 10.1 Start a compute job using a free C2D environment
+<!--
     datatoken = new Datatoken(
       consumerAccount,
       (await consumerAccount.provider.getNetwork()).chainId
     )
+-->
 
 let's check the free compute environment
 ```Typescript
-    const computeEnv = computeEnvs[resolvedDatasetDdo.chainId].find(
-      (ce) => ce.priceMin === 0 || isDefined(ce.free)
+    const computeEnv = computeEnvs.find(
+      (ce) =>
+        !ce?.fees || ce.fees.find((fee) => fee.symbol === 'OCEAN' && fee.amount === '0')
     )
     console.log('Free compute environment = ', computeEnv)
 ```
@@ -607,9 +619,12 @@ let's check the free compute environment
     assert(computeEnv, 'Cannot find the free compute env')
 -->
 
+<!--
     computeRoutePath = await ProviderInstance.getComputeStartRoutes(providerUrl, true)
     if (isDefined(computeRoutePath)) {
       hasFreeComputeSupport = true
+  -->
+
   Let's have 5 minute of compute access
   ```Typescript
       const mytime = new Date()
@@ -617,6 +632,9 @@ let's check the free compute environment
       mytime.setMinutes(mytime.getMinutes() + computeMinutes)
       const computeValidUntil = Math.floor(mytime.getTime() / 1000)
 
+  ```
+  Let's prepare the dataset and algorithm assets to be used in the compute job
+  ```Typescript
       const assets: ComputeAsset[] = [
         {
           documentId: resolvedDatasetDdo.id,
@@ -624,41 +642,49 @@ let's check the free compute environment
         }
       ]
       const dtAddressArray = [resolvedDatasetDdo.services[0].datatokenAddress]
+
       const algo: ComputeAlgorithm = {
         documentId: resolvedAlgorithmDdo.id,
-        serviceId: resolvedAlgorithmDdo.services[0].id
+        serviceId: resolvedAlgorithmDdo.services[0].id,
+        meta: resolvedAlgorithmDdo.metadata.algorithm
       }
-
-      const providerInitializeComputeResults = await ProviderInstance.initializeCompute(
-        assets,
-        algo,
-        computeEnv.id,
-        computeValidUntil,
-        providerUrl,
-        consumerAccount
-      )
   ```
+
   <!--
-      assert(!('error' in providerInitializeComputeResults), 'Cannot order algorithm')
+      // const providerInitializeComputeResults = await ProviderInstance.initializeCompute(
+      //   assets,
+      //   algo,
+      //   computeEnv.id,
+      //   computeValidUntil,
+      //   providerUrl,
+      //   consumerAccount
+      // )
+      // console.log('providerInitializeComputeResults = ', providerInitializeComputeResults)
+      //
+      //
+      // assert(!('error' in providerInitializeComputeResults), 'Cannot order algorithm')
+      //
+      //
+      // algo.transferTxId = await handleOrder(
+      //   providerInitializeComputeResults.algorithm,
+      //   resolvedAlgorithmDdo.services[0].datatokenAddress,
+      //   consumerAccount,
+      //   computeEnv.consumerAddress,
+      //   0
+      // )
+      // for (let i = 0; i < providerInitializeComputeResults.datasets.length; i++) {
+      //   assets[i].transferTxId = await handleOrder(
+      //     providerInitializeComputeResults.datasets[i],
+      //     dtAddressArray[i],
+      //     consumerAccount,
+      //     computeEnv.consumerAddress,
+      //     0
+      //   )
+      // }
   -->
-  ```Typescript
-      algo.transferTxId = await handleOrder(
-        providerInitializeComputeResults.algorithm,
-        resolvedAlgorithmDdo.services[0].datatokenAddress,
-        consumerAccount,
-        computeEnv.consumerAddress,
-        0
-      )
-      for (let i = 0; i < providerInitializeComputeResults.datasets.length; i++) {
-        assets[i].transferTxId = await handleOrder(
-          providerInitializeComputeResults.datasets[i],
-          dtAddressArray[i],
-          consumerAccount,
-          computeEnv.consumerAddress,
-          0
-        )
-      }
 
+  Let's start the free compute job
+  ```Typescript
       const computeJobs = await ProviderInstance.freeComputeStart(
         providerUrl,
         consumerAccount,
@@ -666,16 +692,19 @@ let's check the free compute environment
         assets,
         algo
       )
-
   ```
+
   <!--
       assert(computeJobs, 'Cannot start compute job')
   -->
+
   Let's save the compute job it, we re going to use later
   ```Typescript
       computeJobId = computeJobs[0].jobId
       // eslint-disable-next-line prefer-destructuring
       agreementId = computeJobs[0].agreementId
+  ```
+  <!--
     } else {
       assert(
         computeRoutePath === null,
@@ -683,17 +712,19 @@ let's check the free compute environment
       )
       hasFreeComputeSupport = false
     }
-  
-```
+  }).timeout(40000)
+-->
 
 ## 11. Check compute status and get download compute results URL
   ### 11.1 Check compute status
+<!--
     if (!hasFreeComputeSupport) {
       assert(
         computeRoutePath === null,
         'Compute route path for free compute is not defined (perhaps because provider does not support it yet?)'
       )
     } else {
+  -->
   You can also add various delays so you see the various states of the compute job
   ```Typescript
       const jobStatus = await ProviderInstance.computeStatus(
@@ -709,17 +740,22 @@ let's check the free compute environment
   Now, let's see the current status of the previously started computer job
   ```Typescript
       console.log('Current status of the compute job: ', jobStatus)
+  ```
+  <!--
     }
-  
-```
+  }).timeout(40000)
+-->
 
   ### 11.2 Get download compute results URL
+<!--
     if (!hasFreeComputeSupport) {
       assert(
         computeRoutePath === null,
         'Compute route path for free compute is not defined (perhaps because provider does not support it yet?)'
       )
     } else {
+  -->
+
   ```Typescript
       await sleep(10000)
       const downloadURL = await ProviderInstance.getComputeResultUrl(
@@ -735,10 +771,12 @@ let's check the free compute environment
   Let's check the compute results url for the specified index
   ```Typescript
       console.log(`Compute results URL: ${downloadURL}`)
+  ```
+  <!--
     }
-  
-```
-
+  }).timeout(40000)
+})
+-->
 
 ## Editing this file
 Please note that ComputeExamples.md is an autogenerated file, you should not edit it directly.