@oceanprotocol/lib 4.0.0-next.0 → 4.0.0

package/.mocharc.json

@@ -0,0 +1,8 @@
+{
+  "require": ["source-map-support/register", "mock-local-storage"],
+  "extension": ["ts"],
+  "timeout": 200000,
+  "bail": true,
+  "exit": true,
+  "fullTrace": true
+}

package/CHANGELOG.md

@@ -4,7 +4,76 @@ 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.0-next.0](https://github.com/oceanprotocol/ocean.js/compare/v3.4.3...v4.0.0-next.0)
+#### [v4.0.0](https://github.com/oceanprotocol/ocean.js/compare/v4.0.0-next.1...v4.0.0)
+
+- Release 4.0 [`#1922`](https://github.com/oceanprotocol/ocean.js/pull/1922)
+- add policy server option to getDownloadUrl [`#1917`](https://github.com/oceanprotocol/ocean.js/pull/1917)
+- 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)
+- 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)
+
+> 8 January 2025
+
+- 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)
+- rename waitForAqua as waitForIndexer [`6381795`](https://github.com/oceanprotocol/ocean.js/commit/6381795c957f301b93461d84a14ff59991b58738)
+- Release 3.4.6 [`edd3581`](https://github.com/oceanprotocol/ocean.js/commit/edd3581df80e59f7f6ce64c9e1ae5e4553835f92)
+- make retries and interval bigger & configurable [`2b6e537`](https://github.com/oceanprotocol/ocean.js/commit/2b6e537f4e2a06603cfb62c61a2af5f471b4a699)
+
+#### [v3.4.5](https://github.com/oceanprotocol/ocean.js/compare/v3.4.4...v3.4.5)
+
+> 19 December 2024
+
+- 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)
+- done [`60d0272`](https://github.com/oceanprotocol/ocean.js/commit/60d027294a2893410860f1180ff47177e12e45de)
+- 4th pass [`bf94e10`](https://github.com/oceanprotocol/ocean.js/commit/bf94e102e53dd07eac6c671ef222b96e34ffca7f)
+- Release 3.4.5 [`a1ee835`](https://github.com/oceanprotocol/ocean.js/commit/a1ee835294b6a51721c3c215dd3c16f741b0573b)
+
+#### [v3.4.4](https://github.com/oceanprotocol/ocean.js/compare/v3.4.3...v3.4.4)
+
+> 20 November 2024
+
+- Remove checks from publishing. ADded chain ID check for ordering. [`#1875`](https://github.com/oceanprotocol/ocean.js/pull/1875)
+- Release 3.4.4 [`fa242a5`](https://github.com/oceanprotocol/ocean.js/commit/fa242a5095d16327adf2d53830a643350fcdfa84)
 
 #### [v3.4.3](https://github.com/oceanprotocol/ocean.js/compare/v3.4.2...v3.4.3)
 
@@ -257,7 +326,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Merge 04deabccd3ffbc8d3620e42a8b1bc4a2d5019e54 into 543f71f7cda1b3d0099cc26975d34b89bead7452 [`c33663c`](https://github.com/oceanprotocol/ocean.js/commit/c33663cfdbf501c407d3e1e17f56b17761f9e556)
 - set min gas fee 30 gwei on priority fees for polygon and  mumbai as well [`04deabc`](https://github.com/oceanprotocol/ocean.js/commit/04deabccd3ffbc8d3620e42a8b1bc4a2d5019e54)
 
-#### [v3.0.0](https://github.com/oceanprotocol/ocean.js/compare/v3.0.0-next.5...v3.0.0)
+### [v3.0.0](https://github.com/oceanprotocol/ocean.js/compare/v3.0.0-next.5...v3.0.0)
 
 > 29 May 2023
 
@@ -533,7 +602,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - put back paid env test [`219d4b4`](https://github.com/oceanprotocol/ocean.js/commit/219d4b4a1e1a2bba04cfaa2e26808b0f4a1fa717)
 - update asset timeouts [`9fc8a8e`](https://github.com/oceanprotocol/ocean.js/commit/9fc8a8ebb316d0aefcce6d38f83aeb6f4fc5734d)
 
-#### [v2.0.0](https://github.com/oceanprotocol/ocean.js/compare/v2.0.0-next.3...v2.0.0)
+### [v2.0.0](https://github.com/oceanprotocol/ocean.js/compare/v2.0.0-next.3...v2.0.0)
 
 > 7 September 2022
 
@@ -685,7 +754,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - update to new schema & compute fixes [`#1510`](https://github.com/oceanprotocol/ocean.js/pull/1510)
 - Release 1.1.0 [`112c27e`](https://github.com/oceanprotocol/ocean.js/commit/112c27edab58ef0681ea3e87fb09978411924753)
 
-#### [v1.0.0](https://github.com/oceanprotocol/ocean.js/compare/v1.0.0-next.45...v1.0.0)
+### [v1.0.0](https://github.com/oceanprotocol/ocean.js/compare/v1.0.0-next.45...v1.0.0)
 
 > 8 June 2022
 

package/CodeExamples.md

@@ -79,7 +79,7 @@ Start by importing all of the necessary dependencies
 import fs from 'fs'
 
 import { ethers, providers, Signer } from 'ethers'
-import { SHA256 } from 'crypto-js'
+import crypto from 'crypto-js'
 import { homedir } from 'os'
 import {
   approve,
@@ -109,8 +109,9 @@ import {
   getEventFromTx,
   DDO,
   LoggerInstance
-} from '@oceanprotocol/lib'
+} from '../../src/index.js'
 ```
+const { SHA256 } = crypto
 
 <!--
 describe('Marketplace flow tests
@@ -165,7 +166,7 @@ Next, we define the metadata that will describe our data asset. This is what we
 ```Typescript
   const genericAsset: DDO = {
     '@context': ['https://w3id.org/did/v1'],
-    id: '',
+    id: 'did:op',
     version: '4.1.0',
     chainId: 8996,
     nftAddress: '0x0',
@@ -504,7 +505,7 @@ Now we can make the contract call
     )
     console.log(`Consumer ${FRE_NFT_SYMBOL} balance after swap: ${consumerDTBalance}`)
 
-    const resolvedDDO = await aquarius.waitForAqua(fixedDDO.id)
+    const resolvedDDO = await aquarius.waitForIndexer(fixedDDO.id)
     assert(resolvedDDO, 'Cannot fetch DDO from Aquarius')
 
 ```
@@ -726,7 +727,7 @@ Now we need to encrypt file(s) using provider
       `Consumer ${DISP_NFT_SYMBOL} balance after dispense: ${consumerDTBalance}`
     )
 
-    const resolvedDDO = await aquarius.waitForAqua(fixedDDO.id)
+    const resolvedDDO = await aquarius.waitForIndexer(fixedDDO.id)
     assert(resolvedDDO, 'Cannot fetch DDO from Aquarius')
 
     datatoken = new Datatoken(consumerAccount, await consumerAccount.getChainId())
@@ -821,7 +822,7 @@ Let's start by using the `setData` method to update the nft key value store with
         data
       )
     } catch (e) {
-      console.log('e = ', e)
+      console.log('error = ', e)
       assert.fail('Failed to set data in NFT ERC725 key value store', e)
     }
 ```

package/ComputeExamples.md

@@ -119,7 +119,6 @@ Start by importing all of the necessary dependencies
 import fs from 'fs'
 import { homedir } from 'os'
 
-import { SHA256 } from 'crypto-js'
 import { ethers, providers, Signer } from 'ethers'
 import {
   ProviderInstance,
@@ -144,9 +143,12 @@ import {
   configHelperNetworks,
   ConfigHelper,
   getEventFromTx,
-  amountToUnits
-} from '@oceanprotocol/lib'
+  amountToUnits,
+  isDefined
+} from '../../src/index.js'
 ```
+import crypto from 'crypto-js'
+const { SHA256 } = crypto
 
 ### 4.2. Constants and variables
 
@@ -275,15 +277,18 @@ let resolvedAlgorithmDdo: DDO
 
 let computeJobId: string
 let agreementId: string
+
+let computeRoutePath: string
+let hasFreeComputeSupport: boolean
 ```
 
 ### 4.3 Helper methods
 
 Now we define the helper methods which we will use later to publish the dataset and algorithm, and also order them
 
-Add a `createAsset()`function.
+Add a `createAssetHelper()`function.
 ```Typescript
-async function createAsset(
+async function createAssetHelper(
   name: string,
   symbol: string,
   owner: Signer,
@@ -503,7 +508,7 @@ you need to mint oceans to mentioned accounts only if you are using barge to tes
 
   ### 6.1 Publish a dataset (create NFT + Datatoken) and set dataset metadata
 ```Typescript
-    datasetId = await createAsset(
+    datasetId = await createAssetHelper(
       'D1Min',
       'D1M',
       publisherAccount,
@@ -520,7 +525,7 @@ Now, let's check that we successfully published a dataset (create NFT + Datatoke
 
   ### 6.2 Publish an algorithm (create NFT + Datatoken) and set algorithm metadata
 ```Typescript
-    algorithmId = await createAsset(
+    algorithmId = await createAssetHelper(
       'D1Min',
       'D1M',
       publisherAccount,
@@ -539,8 +544,8 @@ Now, let's check that we successfully published a algorithm (create NFT + Datato
 
   ### 7.1 Resolve published datasets and algorithms
 ```Typescript
-    resolvedDatasetDdo = await aquariusInstance.waitForAqua(datasetId)
-    resolvedAlgorithmDdo = await aquariusInstance.waitForAqua(algorithmId)
+    resolvedDatasetDdo = await aquariusInstance.waitForIndexer(datasetId)
+    resolvedAlgorithmDdo = await aquariusInstance.waitForIndexer(algorithmId)
 ```
 <!--
     assert(resolvedDatasetDdo, 'Cannot fetch DDO from Aquarius')
@@ -594,7 +599,7 @@ Now, let's check that we successfully published a algorithm (create NFT + Datato
 let's check the free compute environment
 ```Typescript
     const computeEnv = computeEnvs[resolvedDatasetDdo.chainId].find(
-      (ce) => ce.priceMin === 0
+      (ce) => ce.priceMin === 0 || isDefined(ce.free)
     )
     console.log('Free compute environment = ', computeEnv)
 ```
@@ -602,111 +607,135 @@ let's check the free compute environment
     assert(computeEnv, 'Cannot find the free compute env')
 -->
 
-Let's have 5 minute of compute access
-```Typescript
-    const mytime = new Date()
-    const computeMinutes = 5
-    mytime.setMinutes(mytime.getMinutes() + computeMinutes)
-    const computeValidUntil = Math.floor(mytime.getTime() / 1000)
-
-    const assets: ComputeAsset[] = [
-      {
-        documentId: resolvedDatasetDdo.id,
-        serviceId: resolvedDatasetDdo.services[0].id
+    computeRoutePath = await ProviderInstance.getComputeStartRoutes(providerUrl, true)
+    if (isDefined(computeRoutePath)) {
+      hasFreeComputeSupport = true
+  Let's have 5 minute of compute access
+  ```Typescript
+      const mytime = new Date()
+      const computeMinutes = 5
+      mytime.setMinutes(mytime.getMinutes() + computeMinutes)
+      const computeValidUntil = Math.floor(mytime.getTime() / 1000)
+
+      const assets: ComputeAsset[] = [
+        {
+          documentId: resolvedDatasetDdo.id,
+          serviceId: resolvedDatasetDdo.services[0].id
+        }
+      ]
+      const dtAddressArray = [resolvedDatasetDdo.services[0].datatokenAddress]
+      const algo: ComputeAlgorithm = {
+        documentId: resolvedAlgorithmDdo.id,
+        serviceId: resolvedAlgorithmDdo.services[0].id
       }
-    ]
-    const dtAddressArray = [resolvedDatasetDdo.services[0].datatokenAddress]
-    const algo: ComputeAlgorithm = {
-      documentId: resolvedAlgorithmDdo.id,
-      serviceId: resolvedAlgorithmDdo.services[0].id
-    }
 
-    const providerInitializeComputeResults = await ProviderInstance.initializeCompute(
-      assets,
-      algo,
-      computeEnv.id,
-      computeValidUntil,
-      providerUrl,
-      await consumerAccount.getAddress()
-    )
-```
-<!--
-    assert(!('error' in providerInitializeComputeResults), 'Cannot order algorithm')
--->
-```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],
+      const providerInitializeComputeResults = await ProviderInstance.initializeCompute(
+        assets,
+        algo,
+        computeEnv.id,
+        computeValidUntil,
+        providerUrl,
+        consumerAccount
+      )
+  ```
+  <!--
+      assert(!('error' in providerInitializeComputeResults), 'Cannot order algorithm')
+  -->
+  ```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
+        )
+      }
 
-    const computeJobs = await ProviderInstance.computeStart(
-      providerUrl,
-      consumerAccount,
-      computeEnv.id,
-      assets[0],
-      algo
-    )
+      const computeJobs = await ProviderInstance.freeComputeStart(
+        providerUrl,
+        consumerAccount,
+        computeEnv.id,
+        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
+  ```
+  <!--
+      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,
+        'Route path for free compute is not defined (perhaps because provider does not support it yet?)'
+      )
+      hasFreeComputeSupport = false
+    }
   
 ```
 
 ## 11. Check compute status and get download compute results URL
   ### 11.1 Check compute status
-You can also add various delays so you see the various states of the compute job
-```Typescript
-    const jobStatus = await ProviderInstance.computeStatus(
-      providerUrl,
-      await consumerAccount.getAddress(),
-      computeJobId,
-      agreementId
-    )
-```
-<!--
-    assert(jobStatus, 'Cannot retrieve compute status!')
--->
-Now, let's see the current status of the previously started computer job
-```Typescript
-    console.log('Current status of the compute job: ', jobStatus)
+    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(
+        providerUrl,
+        await consumerAccount.getAddress(),
+        computeJobId,
+        agreementId
+      )
+  ```
+  <!--
+      assert(jobStatus, 'Cannot retrieve compute status!')
+  -->
+  Now, let's see the current status of the previously started computer job
+  ```Typescript
+      console.log('Current status of the compute job: ', jobStatus)
+    }
   
 ```
 
   ### 11.2 Get download compute results URL
-```Typescript
-    await sleep(10000)
-    const downloadURL = await ProviderInstance.getComputeResultUrl(
-      providerUrl,
-      consumerAccount,
-      computeJobId,
-      0
-    )
-```
-<!--
-    assert(downloadURL, 'Provider getComputeResultUrl failed!')
--->
-Let's check the compute results url for the specified index
-```Typescript
-    console.log(`Compute results URL: ${downloadURL}`)
+    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(
+        providerUrl,
+        consumerAccount,
+        computeJobId,
+        0
+      )
+  ```
+  <!--
+      assert(downloadURL, 'Provider getComputeResultUrl failed!')
+  -->
+  Let's check the compute results url for the specified index
+  ```Typescript
+      console.log(`Compute results URL: ${downloadURL}`)
+    }
   
 ```
 

package/README.md

@@ -51,6 +51,15 @@ npm install @oceanprotocol/lib
 - Visit the [Ocean Protocol website](https://docs.oceanprotocol.com/) for general information about Ocean Protocol.
 - If you have any difficulties or if you have further questions about how to use ocean.js please reach out to us on [Discord](https://discord.gg/TnXjkR5).
 - If you notice any bugs or issues with ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
+- Developers using this library should ensure their tsconfig.json includes the necessary options:
+```
+{
+  "moduleResolution": "node",
+  "esModuleInterop": true,
+  "allowSyntheticDefaultImports": true
+}
+```
+- If using Next.js, they may need "moduleResolution": "bundler" for better compatibility.
 
 ## 🦑 Development