@oceanprotocol/lib 4.0.2 → 4.1.0

package/CHANGELOG.md

@@ -4,11 +4,36 @@ 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.1.0](https://github.com/oceanprotocol/ocean.js/compare/v4.0.3...v4.1.0)
+
+- Feature/paid compute [`#1924`](https://github.com/oceanprotocol/ocean.js/pull/1924)
+- Escrow contract integration [`#1910`](https://github.com/oceanprotocol/ocean.js/pull/1910)
+- Updating ComputeExamples.md [`95caa93`](https://github.com/oceanprotocol/ocean.js/commit/95caa93c8d44ee7a276d2bf65864a58bf4030f57)
+- Merge 3746bd826b24e56abec0a2ee4640aeb4ea648d20 into 261c665f4f434b0f8eba9fed952dab1adf0321f5 [`f2a8129`](https://github.com/oceanprotocol/ocean.js/commit/f2a8129533ee61e5903df892e0b10b54f4c506a6)
+- Updating ComputeExamples.md [`68d5386`](https://github.com/oceanprotocol/ocean.js/commit/68d53864a90ce34cccf7d54065d4aff947c37a86)
+
+#### [v4.0.3](https://github.com/oceanprotocol/ocean.js/compare/v4.0.2...v4.0.3)
+
+> 28 April 2025
+
+- 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)
+- Release 4.0.3 [`f00bb95`](https://github.com/oceanprotocol/ocean.js/commit/f00bb955957ed1b69a01200bc73b2857da91117e)
+
 #### [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 +42,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 +51,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:
@@ -184,12 +183,11 @@ Next, we define the metadata that will describe our data asset. This is what we
     },
     services: [
       {
-        id: 'testFakeId',
+        id: 'db164c1b981e4d2974e90e61bda121512e6909c1035c908d68933ae4cfaba6b0',
         type: 'access',
-        description: 'Download service',
         files: '',
-        datatokenAddress: '0x0',
-        serviceEndpoint: 'http://172.15.0.4:8030',
+        datatokenAddress: '0xa15024b732A8f2146423D14209eFd074e61964F3',
+        serviceEndpoint: 'http://127.0.0.1:8001',
         timeout: 0
       }
     ]
@@ -208,9 +206,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 +222,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 +487,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 +532,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 +556,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 +595,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 +656,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 +707,10 @@ Now we need to encrypt file(s) using provider
       encryptedDDO,
       isAssetValid.hash
     )
-  
 ```
+<!--
+  }).timeout(40000)
+-->
 
 ## 9. Consume a dispenser data asset
 
@@ -793,8 +813,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 +870,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